NaturalLanguageQueryUnderstandingSpec(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)Specification to enable natural language understanding capabilities for search requests.
Attributes |
|
|---|---|
| Name | Description |
filter_extraction_condition |
google.cloud.discoveryengine_v1.types.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition
The condition under which filter extraction should occur. Server behavior defaults to DISABLED.
|
geo_search_query_detection_field_names |
MutableSequence[str]
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.
|
extracted_filter_behavior |
google.cloud.discoveryengine_v1.types.SearchRequest.NaturalLanguageQueryUnderstandingSpec.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.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition
is set to
FilterExtractionCondition.ENABLED.
|
allowed_field_names |
MutableSequence[str]
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. |
Classes
ExtractedFilterBehavior
ExtractedFilterBehavior(value)Enum describing how extracted filters are applied to the search.
FilterExtractionCondition
FilterExtractionCondition(value)Enum describing under which condition filter extraction should occur.