Google Cloud Discovery Engine V1 Client - Class NaturalLanguageQueryUnderstandingSpec (1.11.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class NaturalLanguageQueryUnderstandingSpec.

Specification to enable natural language understanding capabilities for search requests.

Generated from protobuf message google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ SearchRequest

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ filter_extraction_condition int

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

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 int

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 array

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.

getFilterExtractionCondition

The condition under which filter extraction should occur.

Server behavior defaults to DISABLED.

Returns
Type Description
int Enum of type FilterExtractionCondition.

setFilterExtractionCondition

The condition under which filter extraction should occur.

Server behavior defaults to DISABLED.

Parameter
Name Description
var int

Enum of type FilterExtractionCondition.

Returns
Type Description
$this

getGeoSearchQueryDetectionFieldNames

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setGeoSearchQueryDetectionFieldNames

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getExtractedFilterBehavior

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.

Returns
Type Description
int Enum of type ExtractedFilterBehavior.

setExtractedFilterBehavior

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.

Parameter
Name Description
var int

Enum of type ExtractedFilterBehavior.

Returns
Type Description
$this

getAllowedFieldNames

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAllowedFieldNames

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this