Package com.google.cloud.discoveryengine.v1beta

Interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AnswerQueryRequest.AnswerGenerationSpec, AnswerQueryRequest.AnswerGenerationSpec.Builder
Enclosing class:
AnswerQueryRequest
public static interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasModelSpec

      boolean hasModelSpec()
       Answer generation model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;
      Returns:
      Whether the modelSpec field is set.

    • getModelSpec

      AnswerQueryRequest.AnswerGenerationSpec.ModelSpec getModelSpec()
       Answer generation model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;
      Returns:
      The modelSpec.

    • getModelSpecOrBuilder

      AnswerQueryRequest.AnswerGenerationSpec.ModelSpecOrBuilder getModelSpecOrBuilder()
       Answer generation model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;

    • hasPromptSpec

      boolean hasPromptSpec()
       Answer generation prompt specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;
      Returns:
      Whether the promptSpec field is set.

    • getPromptSpec

      AnswerQueryRequest.AnswerGenerationSpec.PromptSpec getPromptSpec()
       Answer generation prompt specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;
      Returns:
      The promptSpec.

    • getPromptSpecOrBuilder

      AnswerQueryRequest.AnswerGenerationSpec.PromptSpecOrBuilder getPromptSpecOrBuilder()
       Answer generation prompt specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;

    • getIncludeCitations

      boolean getIncludeCitations()
       Specifies whether to include citation metadata in the answer. The default
 value is `false`.
      bool include_citations = 3;
      Returns:
      The includeCitations.

    • getAnswerLanguageCode

      String getAnswerLanguageCode()
       Language code for Answer. Use language tags defined by
 [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 Note: This is an experimental feature.
      string answer_language_code = 4;
      Returns:
      The answerLanguageCode.

    • getAnswerLanguageCodeBytes

      com.google.protobuf.ByteString getAnswerLanguageCodeBytes()
       Language code for Answer. Use language tags defined by
 [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 Note: This is an experimental feature.
      string answer_language_code = 4;
      Returns:
      The bytes for answerLanguageCode.

    • getIgnoreAdversarialQuery

      boolean getIgnoreAdversarialQuery()
       Specifies whether to filter out adversarial queries. The default value
 is `false`.

 Google employs search-query classification to detect adversarial
 queries. No answer is returned if the search query is classified as an
 adversarial query. For example, a user might ask a question regarding
 negative comments about the company or submit a query designed to
 generate unsafe, policy-violating output. If this field is set to
 `true`, we skip generating answers for adversarial queries and return
 fallback messages instead.
      bool ignore_adversarial_query = 5;
      Returns:
      The ignoreAdversarialQuery.

    • getIgnoreNonAnswerSeekingQuery

      boolean getIgnoreNonAnswerSeekingQuery()
       Specifies whether to filter out queries that are not answer-seeking.
 The default value is `false`.

 Google employs search-query classification to detect answer-seeking
 queries. No answer is returned if the search query is classified as a
 non-answer seeking query. If this field is set to `true`, we skip
 generating answers for non-answer seeking queries and return
 fallback messages instead.
      bool ignore_non_answer_seeking_query = 6;
      Returns:
      The ignoreNonAnswerSeekingQuery.

    • hasIgnoreLowRelevantContent

      boolean hasIgnoreLowRelevantContent()
       Specifies whether to filter out queries that have low relevance.

 If this field is set to `false`, all search results are used regardless
 of relevance to generate answers. If set to `true` or unset, the behavior
 will be determined automatically by the service.
      optional bool ignore_low_relevant_content = 7;
      Returns:
      Whether the ignoreLowRelevantContent field is set.

    • getIgnoreLowRelevantContent

      boolean getIgnoreLowRelevantContent()
       Specifies whether to filter out queries that have low relevance.

 If this field is set to `false`, all search results are used regardless
 of relevance to generate answers. If set to `true` or unset, the behavior
 will be determined automatically by the service.
      optional bool ignore_low_relevant_content = 7;
      Returns:
      The ignoreLowRelevantContent.

    • getIgnoreJailBreakingQuery

      boolean getIgnoreJailBreakingQuery()
       Optional. Specifies whether to filter out jail-breaking queries. The
 default value is `false`.

 Google employs search-query classification to detect jail-breaking
 queries. No summary is returned if the search query is classified as a
 jail-breaking query. A user might add instructions to the query to
 change the tone, style, language, content of the answer, or ask the
 model to act as a different entity, e.g. "Reply in the tone of a
 competing company's CEO". If this field is set to `true`, we skip
 generating summaries for jail-breaking queries and return fallback
 messages instead.
      bool ignore_jail_breaking_query = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The ignoreJailBreakingQuery.