Package com.google.cloud.discoveryengine.v1beta

Interface AnswerQueryRequestOrBuilder

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

  • Method Details

    • getServingConfig

      String getServingConfig()
       Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.
      string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The servingConfig.

    • getServingConfigBytes

      com.google.protobuf.ByteString getServingConfigBytes()
       Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.
      string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for servingConfig.

    • hasQuery

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

    • getQuery

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

    • getQueryOrBuilder

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

    • getSession

      String getSession()
       The session resource name. Not required.

 When session field is not set, the API is in sessionless mode.

 We support auto session mode: users can use the wildcard symbol `-` as
 session ID.  A new ID will be automatically generated and assigned.
      string session = 3 [(.google.api.resource_reference) = { ... }
      Returns:
      The session.

    • getSessionBytes

      com.google.protobuf.ByteString getSessionBytes()
       The session resource name. Not required.

 When session field is not set, the API is in sessionless mode.

 We support auto session mode: users can use the wildcard symbol `-` as
 session ID.  A new ID will be automatically generated and assigned.
      string session = 3 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for session.

    • hasSafetySpec

      boolean hasSafetySpec()
       Model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SafetySpec safety_spec = 4;
      Returns:
      Whether the safetySpec field is set.

    • getSafetySpec

      AnswerQueryRequest.SafetySpec getSafetySpec()
       Model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SafetySpec safety_spec = 4;
      Returns:
      The safetySpec.

    • getSafetySpecOrBuilder

      AnswerQueryRequest.SafetySpecOrBuilder getSafetySpecOrBuilder()
       Model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SafetySpec safety_spec = 4;

    • hasRelatedQuestionsSpec

      boolean hasRelatedQuestionsSpec()
       Related questions specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;
      Returns:
      Whether the relatedQuestionsSpec field is set.

    • getRelatedQuestionsSpec

      AnswerQueryRequest.RelatedQuestionsSpec getRelatedQuestionsSpec()
       Related questions specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;
      Returns:
      The relatedQuestionsSpec.

    • getRelatedQuestionsSpecOrBuilder

      AnswerQueryRequest.RelatedQuestionsSpecOrBuilder getRelatedQuestionsSpecOrBuilder()
       Related questions specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;

    • hasGroundingSpec

      boolean hasGroundingSpec()
       Optional. Grounding specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.GroundingSpec grounding_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the groundingSpec field is set.

    • getGroundingSpec

      AnswerQueryRequest.GroundingSpec getGroundingSpec()
       Optional. Grounding specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.GroundingSpec grounding_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The groundingSpec.

    • getGroundingSpecOrBuilder

      AnswerQueryRequest.GroundingSpecOrBuilder getGroundingSpecOrBuilder()
       Optional. Grounding specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.GroundingSpec grounding_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

    • hasAnswerGenerationSpec

      boolean hasAnswerGenerationSpec()
       Answer generation specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;
      Returns:
      Whether the answerGenerationSpec field is set.

    • getAnswerGenerationSpec

      AnswerQueryRequest.AnswerGenerationSpec getAnswerGenerationSpec()
       Answer generation specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;
      Returns:
      The answerGenerationSpec.

    • getAnswerGenerationSpecOrBuilder

      AnswerQueryRequest.AnswerGenerationSpecOrBuilder getAnswerGenerationSpecOrBuilder()
       Answer generation specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;

    • hasSearchSpec

      boolean hasSearchSpec()
       Search specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec search_spec = 8;
      Returns:
      Whether the searchSpec field is set.

    • getSearchSpec

      AnswerQueryRequest.SearchSpec getSearchSpec()
       Search specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec search_spec = 8;
      Returns:
      The searchSpec.

    • getSearchSpecOrBuilder

      AnswerQueryRequest.SearchSpecOrBuilder getSearchSpecOrBuilder()
       Search specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec search_spec = 8;

    • hasQueryUnderstandingSpec

      boolean hasQueryUnderstandingSpec()
       Query understanding specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;
      Returns:
      Whether the queryUnderstandingSpec field is set.

    • getQueryUnderstandingSpec

      AnswerQueryRequest.QueryUnderstandingSpec getQueryUnderstandingSpec()
       Query understanding specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;
      Returns:
      The queryUnderstandingSpec.

    • getQueryUnderstandingSpecOrBuilder

      AnswerQueryRequest.QueryUnderstandingSpecOrBuilder getQueryUnderstandingSpecOrBuilder()
       Query understanding specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;

    • getAsynchronousMode

      @Deprecated boolean getAsynchronousMode()
      Deprecated.
      google.cloud.discoveryengine.v1beta.AnswerQueryRequest.asynchronous_mode is deprecated. See google/cloud/discoveryengine/v1beta/conversational_search_service.proto;l=861
       Deprecated: This field is deprecated. Streaming Answer API will be
 supported.

 Asynchronous mode control.

 If enabled, the response will be returned with answer/session resource
 name without final answer. The API users need to do the polling to get
 the latest status of answer/session by calling
 [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetAnswer]
 or
 [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
 method.
      bool asynchronous_mode = 10 [deprecated = true];
      Returns:
      The asynchronousMode.

    • getUserPseudoId

      String getUserPseudoId()
       A unique identifier for tracking visitors. For example, this could be
 implemented with an HTTP cookie, which should be able to uniquely identify
 a visitor on a single device. This unique identifier should not change if
 the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
      string user_pseudo_id = 12;
      Returns:
      The userPseudoId.

    • getUserPseudoIdBytes

      com.google.protobuf.ByteString getUserPseudoIdBytes()
       A unique identifier for tracking visitors. For example, this could be
 implemented with an HTTP cookie, which should be able to uniquely identify
 a visitor on a single device. This unique identifier should not change if
 the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
      string user_pseudo_id = 12;
      Returns:
      The bytes for userPseudoId.

    • 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 = 13;

    • 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 = 13;

    • 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 = 13;

    • 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 = 13;

    • 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 = 13;