Class GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec

Specification to enable natural language understanding capabilities for search requests.

Inheritance
object
GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec : IDirectResponseSchema

Properties

AllowedFieldNames

Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.

Declaration
[JsonProperty("allowedFieldNames")]
public virtual IList<string> AllowedFieldNames { get; set; }
Property Value
Type Description
IList<string>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExtractedFilterBehavior

Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is HARD_FILTER. For multi-datastore search, the default behavior is SOFT_BOOST. Location-based filters are always applied as hard filters, and the SOFT_BOOST setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.

Declaration
[JsonProperty("extractedFilterBehavior")]
public virtual string ExtractedFilterBehavior { get; set; }
Property Value
Type Description
string

FilterExtractionCondition

The condition under which filter extraction should occur. Server behavior defaults to DISABLED.

Declaration
[JsonProperty("filterExtractionCondition")]
public virtual string FilterExtractionCondition { get; set; }
Property Value
Type Description
string

GeoSearchQueryDetectionFieldNames

Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to ENABLED. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.

Declaration
[JsonProperty("geoSearchQueryDetectionFieldNames")]
public virtual IList<string> GeoSearchQueryDetectionFieldNames { get; set; }
Property Value
Type Description
IList<string>

Implements