public sealed class SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec : IMessage<SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec>, IEquatable<SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec>, IDeepCloneable<SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec>, IBufferMessage, IMessageReference documentation and code samples for the Discovery Engine v1 API class SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec.
Specification to enable natural language understanding capabilities for search requests.
Implements
IMessageSearchRequestTypesNaturalLanguageQueryUnderstandingSpec, IEquatableSearchRequestTypesNaturalLanguageQueryUnderstandingSpec, IDeepCloneableSearchRequestTypesNaturalLanguageQueryUnderstandingSpec, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
NaturalLanguageQueryUnderstandingSpec()
public NaturalLanguageQueryUnderstandingSpec()NaturalLanguageQueryUnderstandingSpec(NaturalLanguageQueryUnderstandingSpec)
public NaturalLanguageQueryUnderstandingSpec(SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchRequestTypesNaturalLanguageQueryUnderstandingSpec |
Properties
AllowedFieldNames
public RepeatedField<string> AllowedFieldNames { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
ExtractedFilterBehavior
public SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec.Types.ExtractedFilterBehavior ExtractedFilterBehavior { get; set; }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][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition]
is set to
[FilterExtractionCondition.ENABLED][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition.ENABLED].
| Property Value | |
|---|---|
| Type | Description |
SearchRequestTypesNaturalLanguageQueryUnderstandingSpecTypesExtractedFilterBehavior |
|
FilterExtractionCondition
public SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec.Types.FilterExtractionCondition FilterExtractionCondition { get; set; }The condition under which filter extraction should occur.
Server behavior defaults to DISABLED.
| Property Value | |
|---|---|
| Type | Description |
SearchRequestTypesNaturalLanguageQueryUnderstandingSpecTypesFilterExtractionCondition |
|
GeoSearchQueryDetectionFieldNames
public RepeatedField<string> GeoSearchQueryDetectionFieldNames { get; }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][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|