- 0.79.0 (latest)
- 0.78.0
- 0.77.0
- 0.76.0
- 0.74.0
- 0.72.0
- 0.71.0
- 0.70.0
- 0.69.0
- 0.68.0
- 0.66.0
- 0.64.0
- 0.63.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAllowedFieldNames(int index)
public abstract String getAllowedFieldNames(int index)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.
repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The allowedFieldNames at the given index. |
getAllowedFieldNamesBytes(int index)
public abstract ByteString getAllowedFieldNamesBytes(int index)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.
repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the allowedFieldNames at the given index. |
getAllowedFieldNamesCount()
public abstract int getAllowedFieldNamesCount()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.
repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of allowedFieldNames. |
getAllowedFieldNamesList()
public abstract List<String> getAllowedFieldNamesList()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.
repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the allowedFieldNames. |
getExtractedFilterBehavior()
public abstract SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior 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.
.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior extracted_filter_behavior = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior |
The extractedFilterBehavior. |
getExtractedFilterBehaviorValue()
public abstract int getExtractedFilterBehaviorValue() 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.
.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior extracted_filter_behavior = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for extractedFilterBehavior. |
getFilterExtractionCondition()
public abstract SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition getFilterExtractionCondition() The condition under which filter extraction should occur.
Server behavior defaults to DISABLED.
.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition filter_extraction_condition = 1;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition |
The filterExtractionCondition. |
getFilterExtractionConditionValue()
public abstract int getFilterExtractionConditionValue() The condition under which filter extraction should occur.
Server behavior defaults to DISABLED.
.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition filter_extraction_condition = 1;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for filterExtractionCondition. |
getGeoSearchQueryDetectionFieldNames(int index)
public abstract String getGeoSearchQueryDetectionFieldNames(int index) 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.
repeated string geo_search_query_detection_field_names = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The geoSearchQueryDetectionFieldNames at the given index. |
getGeoSearchQueryDetectionFieldNamesBytes(int index)
public abstract ByteString getGeoSearchQueryDetectionFieldNamesBytes(int index) 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.
repeated string geo_search_query_detection_field_names = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the geoSearchQueryDetectionFieldNames at the given index. |
getGeoSearchQueryDetectionFieldNamesCount()
public abstract int getGeoSearchQueryDetectionFieldNamesCount() 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.
repeated string geo_search_query_detection_field_names = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The count of geoSearchQueryDetectionFieldNames. |
getGeoSearchQueryDetectionFieldNamesList()
public abstract List<String> getGeoSearchQueryDetectionFieldNamesList() 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.
repeated string geo_search_query_detection_field_names = 2;
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the geoSearchQueryDetectionFieldNames. |