Package com.google.cloud.discoveryengine.v1

Class SearchRequest.NaturalLanguageQueryUnderstandingSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec
All Implemented Interfaces:
SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
SearchRequest
public static final class SearchRequest.NaturalLanguageQueryUnderstandingSpec extends com.google.protobuf.GeneratedMessage implements SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
 Specification to enable natural language understanding capabilities for
 search requests.
Protobuf type google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec
See Also:

  • Field Details

    • FILTER_EXTRACTION_CONDITION_FIELD_NUMBER

      public static final int FILTER_EXTRACTION_CONDITION_FIELD_NUMBER
      See Also:

    • GEO_SEARCH_QUERY_DETECTION_FIELD_NAMES_FIELD_NUMBER

      public static final int GEO_SEARCH_QUERY_DETECTION_FIELD_NAMES_FIELD_NUMBER
      See Also:

    • EXTRACTED_FILTER_BEHAVIOR_FIELD_NUMBER

      public static final int EXTRACTED_FILTER_BEHAVIOR_FIELD_NUMBER
      See Also:

    • ALLOWED_FIELD_NAMES_FIELD_NUMBER

      public static final int ALLOWED_FIELD_NAMES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getFilterExtractionConditionValue

      public 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;
      Specified by:
      getFilterExtractionConditionValue in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      The enum numeric value on the wire for filterExtractionCondition.

    • getFilterExtractionCondition

      public 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;
      Specified by:
      getFilterExtractionCondition in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      The filterExtractionCondition.

    • getGeoSearchQueryDetectionFieldNamesList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getGeoSearchQueryDetectionFieldNamesList in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      A list containing the geoSearchQueryDetectionFieldNames.

    • getGeoSearchQueryDetectionFieldNamesCount

      public 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;
      Specified by:
      getGeoSearchQueryDetectionFieldNamesCount in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      The count of geoSearchQueryDetectionFieldNames.

    • getGeoSearchQueryDetectionFieldNames

      public 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;
      Specified by:
      getGeoSearchQueryDetectionFieldNames in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The geoSearchQueryDetectionFieldNames at the given index.

    • getGeoSearchQueryDetectionFieldNamesBytes

      public 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;
      Specified by:
      getGeoSearchQueryDetectionFieldNamesBytes in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the geoSearchQueryDetectionFieldNames at the given index.

    • getExtractedFilterBehaviorValue

      public 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];
      Specified by:
      getExtractedFilterBehaviorValue in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      The enum numeric value on the wire for extractedFilterBehavior.

    • getExtractedFilterBehavior

      public 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];
      Specified by:
      getExtractedFilterBehavior in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      The extractedFilterBehavior.

    • getAllowedFieldNamesList

      public com.google.protobuf.ProtocolStringList 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];
      Specified by:
      getAllowedFieldNamesList in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      A list containing the allowedFieldNames.

    • getAllowedFieldNamesCount

      public 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];
      Specified by:
      getAllowedFieldNamesCount in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      The count of allowedFieldNames.

    • getAllowedFieldNames

      public 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];
      Specified by:
      getAllowedFieldNames in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowedFieldNames at the given index.

    • getAllowedFieldNamesBytes

      public 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];
      Specified by:
      getAllowedFieldNamesBytes in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the allowedFieldNames at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilder()

    • newBuilder

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilder(SearchRequest.NaturalLanguageQueryUnderstandingSpec prototype)

    • toBuilder

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchRequest.NaturalLanguageQueryUnderstandingSpec> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchRequest.NaturalLanguageQueryUnderstandingSpec> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder