Package com.google.cloud.discoveryengine.v1

Interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchRequest.NaturalLanguageQueryUnderstandingSpec, SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder
Enclosing class:
SearchRequest
public static interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getFilterExtractionConditionValue

      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:
      The enum numeric value on the wire for filterExtractionCondition.

    • getFilterExtractionCondition

      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:
      The filterExtractionCondition.

    • getGeoSearchQueryDetectionFieldNamesList

      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][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Returns:
      A list containing the geoSearchQueryDetectionFieldNames.

    • getGeoSearchQueryDetectionFieldNamesCount

      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][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Returns:
      The count of geoSearchQueryDetectionFieldNames.

    • getGeoSearchQueryDetectionFieldNames

      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][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Parameters:
      index - The index of the element to return.
      Returns:
      The geoSearchQueryDetectionFieldNames at the given index.

    • getGeoSearchQueryDetectionFieldNamesBytes

      com.google.protobuf.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][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the geoSearchQueryDetectionFieldNames at the given index.

    • getExtractedFilterBehaviorValue

      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][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition]
 is set to
 [FilterExtractionCondition.ENABLED][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition.ENABLED].
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior extracted_filter_behavior = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for extractedFilterBehavior.

    • getExtractedFilterBehavior

      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][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition]
 is set to
 [FilterExtractionCondition.ENABLED][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition.ENABLED].
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior extracted_filter_behavior = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The extractedFilterBehavior.

    • getAllowedFieldNamesList

      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:
      A list containing the allowedFieldNames.

    • getAllowedFieldNamesCount

      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:
      The count of allowedFieldNames.

    • getAllowedFieldNames

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowedFieldNames at the given index.

    • getAllowedFieldNamesBytes

      com.google.protobuf.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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the allowedFieldNames at the given index.