Package com.google.cloud.discoveryengine.v1beta

Class ConverseConversationRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.ConverseConversationRequest
All Implemented Interfaces:
ConverseConversationRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ConverseConversationRequest extends com.google.protobuf.GeneratedMessage implements ConverseConversationRequestOrBuilder
 Request message for
 [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation]
 method.
Protobuf type google.cloud.discoveryengine.v1beta.ConverseConversationRequest
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • QUERY_FIELD_NUMBER

      public static final int QUERY_FIELD_NUMBER
      See Also:

    • SERVING_CONFIG_FIELD_NUMBER

      public static final int SERVING_CONFIG_FIELD_NUMBER
      See Also:

    • CONVERSATION_FIELD_NUMBER

      public static final int CONVERSATION_FIELD_NUMBER
      See Also:

    • SAFE_SEARCH_FIELD_NUMBER

      public static final int SAFE_SEARCH_FIELD_NUMBER
      See Also:

    • USER_LABELS_FIELD_NUMBER

      public static final int USER_LABELS_FIELD_NUMBER
      See Also:

    • SUMMARY_SPEC_FIELD_NUMBER

      public static final int SUMMARY_SPEC_FIELD_NUMBER
      See Also:

    • FILTER_FIELD_NUMBER

      public static final int FILTER_FIELD_NUMBER
      See Also:

    • BOOST_SPEC_FIELD_NUMBER

      public static final int BOOST_SPEC_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Required. The resource name of the Conversation to get. Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
 Use
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
 to activate auto session mode, which automatically creates a new
 conversation inside a ConverseConversation session.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getName in interface ConverseConversationRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The resource name of the Conversation to get. Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
 Use
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
 to activate auto session mode, which automatically creates a new
 conversation inside a ConverseConversation session.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getNameBytes in interface ConverseConversationRequestOrBuilder
      Returns:
      The bytes for name.

    • hasQuery

      public boolean hasQuery()
       Required. Current user input.
      .google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasQuery in interface ConverseConversationRequestOrBuilder
      Returns:
      Whether the query field is set.

    • getQuery

      public TextInput getQuery()
       Required. Current user input.
      .google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuery in interface ConverseConversationRequestOrBuilder
      Returns:
      The query.

    • getQueryOrBuilder

      public TextInputOrBuilder getQueryOrBuilder()
       Required. Current user input.
      .google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryOrBuilder in interface ConverseConversationRequestOrBuilder

    • getServingConfig

      public String getServingConfig()
       The resource name of the Serving Config to use. Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
 If this is not set, the default serving config will be used.
      string serving_config = 3 [(.google.api.resource_reference) = { ... }
      Specified by:
      getServingConfig in interface ConverseConversationRequestOrBuilder
      Returns:
      The servingConfig.

    • getServingConfigBytes

      public com.google.protobuf.ByteString getServingConfigBytes()
       The resource name of the Serving Config to use. Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
 If this is not set, the default serving config will be used.
      string serving_config = 3 [(.google.api.resource_reference) = { ... }
      Specified by:
      getServingConfigBytes in interface ConverseConversationRequestOrBuilder
      Returns:
      The bytes for servingConfig.

    • hasConversation

      public boolean hasConversation()
       The conversation to be used by auto session only. The name field will be
 ignored as we automatically assign new name for the conversation in auto
 session.
      .google.cloud.discoveryengine.v1beta.Conversation conversation = 5;
      Specified by:
      hasConversation in interface ConverseConversationRequestOrBuilder
      Returns:
      Whether the conversation field is set.

    • getConversation

      public Conversation getConversation()
       The conversation to be used by auto session only. The name field will be
 ignored as we automatically assign new name for the conversation in auto
 session.
      .google.cloud.discoveryengine.v1beta.Conversation conversation = 5;
      Specified by:
      getConversation in interface ConverseConversationRequestOrBuilder
      Returns:
      The conversation.

    • getConversationOrBuilder

      public ConversationOrBuilder getConversationOrBuilder()
       The conversation to be used by auto session only. The name field will be
 ignored as we automatically assign new name for the conversation in auto
 session.
      .google.cloud.discoveryengine.v1beta.Conversation conversation = 5;
      Specified by:
      getConversationOrBuilder in interface ConverseConversationRequestOrBuilder

    • getSafeSearch

      public boolean getSafeSearch()
       Whether to turn on safe search.
      bool safe_search = 6;
      Specified by:
      getSafeSearch in interface ConverseConversationRequestOrBuilder
      Returns:
      The safeSearch.

    • getUserLabelsCount

      public int getUserLabelsCount()
      Description copied from interface: ConverseConversationRequestOrBuilder
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 7;
      Specified by:
      getUserLabelsCount in interface ConverseConversationRequestOrBuilder

    • containsUserLabels

      public boolean containsUserLabels(String key)
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 7;
      Specified by:
      containsUserLabels in interface ConverseConversationRequestOrBuilder

    • getUserLabels

      @Deprecated public Map<String,String> getUserLabels()
      Deprecated.
      Use getUserLabelsMap() instead.
      Specified by:
      getUserLabels in interface ConverseConversationRequestOrBuilder

    • getUserLabelsMap

      public Map<String,String> getUserLabelsMap()
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 7;
      Specified by:
      getUserLabelsMap in interface ConverseConversationRequestOrBuilder

    • getUserLabelsOrDefault

      public String getUserLabelsOrDefault(String key, String defaultValue)
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 7;
      Specified by:
      getUserLabelsOrDefault in interface ConverseConversationRequestOrBuilder

    • getUserLabelsOrThrow

      public String getUserLabelsOrThrow(String key)
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 7;
      Specified by:
      getUserLabelsOrThrow in interface ConverseConversationRequestOrBuilder

    • hasSummarySpec

      public boolean hasSummarySpec()
       A specification for configuring the summary returned in the response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;
      Specified by:
      hasSummarySpec in interface ConverseConversationRequestOrBuilder
      Returns:
      Whether the summarySpec field is set.

    • getSummarySpec

      public SearchRequest.ContentSearchSpec.SummarySpec getSummarySpec()
       A specification for configuring the summary returned in the response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;
      Specified by:
      getSummarySpec in interface ConverseConversationRequestOrBuilder
      Returns:
      The summarySpec.

    • getSummarySpecOrBuilder

      public SearchRequest.ContentSearchSpec.SummarySpecOrBuilder getSummarySpecOrBuilder()
       A specification for configuring the summary returned in the response.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;
      Specified by:
      getSummarySpecOrBuilder in interface ConverseConversationRequestOrBuilder

    • getFilter

      public String getFilter()
       The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered. Filter
 expression is case-sensitive. This will be used to filter search results
 which may affect the summary response.

 If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to a
 key property defined in the Vertex AI Search backend -- this mapping is
 defined by the customer in their schema. For example a media customer might
 have a field 'name' in their schema. In this case the filter would look
 like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 9;
      Specified by:
      getFilter in interface ConverseConversationRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered. Filter
 expression is case-sensitive. This will be used to filter search results
 which may affect the summary response.

 If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to a
 key property defined in the Vertex AI Search backend -- this mapping is
 defined by the customer in their schema. For example a media customer might
 have a field 'name' in their schema. In this case the filter would look
 like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 9;
      Specified by:
      getFilterBytes in interface ConverseConversationRequestOrBuilder
      Returns:
      The bytes for filter.

    • hasBoostSpec

      public boolean hasBoostSpec()
       Boost specification to boost certain documents in search results which may
 affect the converse response. For more information on boosting, see
 [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
      Specified by:
      hasBoostSpec in interface ConverseConversationRequestOrBuilder
      Returns:
      Whether the boostSpec field is set.

    • getBoostSpec

      public SearchRequest.BoostSpec getBoostSpec()
       Boost specification to boost certain documents in search results which may
 affect the converse response. For more information on boosting, see
 [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
      Specified by:
      getBoostSpec in interface ConverseConversationRequestOrBuilder
      Returns:
      The boostSpec.

    • getBoostSpecOrBuilder

      public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
       Boost specification to boost certain documents in search results which may
 affect the converse response. For more information on boosting, see
 [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
      Specified by:
      getBoostSpecOrBuilder in interface ConverseConversationRequestOrBuilder

    • 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 ConverseConversationRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ConverseConversationRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ConverseConversationRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ConverseConversationRequest.Builder newBuilder()

    • newBuilder

      public static ConverseConversationRequest.Builder newBuilder(ConverseConversationRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ConverseConversationRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ConverseConversationRequest> 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 ConverseConversationRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder