Package com.google.cloud.discoveryengine.v1beta

Interface ConverseConversationRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ConverseConversationRequest, ConverseConversationRequest.Builder
@Generated public interface ConverseConversationRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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) = { ... }
      Returns:
      The name.

    • getNameBytes

      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) = { ... }
      Returns:
      The bytes for name.

    • hasQuery

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

    • getQuery

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

    • getQueryOrBuilder

      TextInputOrBuilder getQueryOrBuilder()
       Required. Current user input.
      .google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

    • getServingConfig

      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) = { ... }
      Returns:
      The servingConfig.

    • getServingConfigBytes

      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) = { ... }
      Returns:
      The bytes for servingConfig.

    • hasConversation

      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;
      Returns:
      Whether the conversation field is set.

    • getConversation

      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;
      Returns:
      The conversation.

    • getConversationOrBuilder

      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;

    • getSafeSearch

      boolean getSafeSearch()
       Whether to turn on safe search.
      bool safe_search = 6;
      Returns:
      The safeSearch.

    • getUserLabelsCount

      int getUserLabelsCount()
       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;

    • containsUserLabels

      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;

    • getUserLabels

      @Deprecated Map<String,String> getUserLabels()
      Deprecated.
      Use getUserLabelsMap() instead.

    • getUserLabelsMap

      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;

    • getUserLabelsOrDefault

      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;

    • getUserLabelsOrThrow

      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;

    • hasSummarySpec

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

    • getSummarySpec

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

    • getSummarySpecOrBuilder

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

    • getFilter

      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;
      Returns:
      The filter.

    • getFilterBytes

      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;
      Returns:
      The bytes for filter.

    • hasBoostSpec

      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;
      Returns:
      Whether the boostSpec field is set.

    • getBoostSpec

      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;
      Returns:
      The boostSpec.

    • getBoostSpecOrBuilder

      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;