Package com.google.cloud.discoveryengine.v1beta

Class AnswerQueryRequest.AnswerGenerationSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AnswerQueryRequest.AnswerGenerationSpec.Builder>
com.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.Builder
All Implemented Interfaces:
AnswerQueryRequest.AnswerGenerationSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AnswerQueryRequest.AnswerGenerationSpec
public static final class AnswerQueryRequest.AnswerGenerationSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<AnswerQueryRequest.AnswerGenerationSpec.Builder> implements AnswerQueryRequest.AnswerGenerationSpecOrBuilder
 Answer generation specification.
Protobuf type google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec

  • 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.Builder<AnswerQueryRequest.AnswerGenerationSpec.Builder>

    • clear

      public AnswerQueryRequest.AnswerGenerationSpec.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<AnswerQueryRequest.AnswerGenerationSpec.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<AnswerQueryRequest.AnswerGenerationSpec.Builder>

    • getDefaultInstanceForType

      public AnswerQueryRequest.AnswerGenerationSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public AnswerQueryRequest.AnswerGenerationSpec build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public AnswerQueryRequest.AnswerGenerationSpec buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public AnswerQueryRequest.AnswerGenerationSpec.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AnswerQueryRequest.AnswerGenerationSpec.Builder>

    • mergeFrom

      public AnswerQueryRequest.AnswerGenerationSpec.Builder mergeFrom(AnswerQueryRequest.AnswerGenerationSpec other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<AnswerQueryRequest.AnswerGenerationSpec.Builder>

    • mergeFrom

      public AnswerQueryRequest.AnswerGenerationSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AnswerQueryRequest.AnswerGenerationSpec.Builder>
      Throws:
      IOException

    • hasModelSpec

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

    • getModelSpec

      public AnswerQueryRequest.AnswerGenerationSpec.ModelSpec getModelSpec()
       Answer generation model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;
      Specified by:
      getModelSpec in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder
      Returns:
      The modelSpec.

    • setModelSpec

      public AnswerQueryRequest.AnswerGenerationSpec.Builder setModelSpec(AnswerQueryRequest.AnswerGenerationSpec.ModelSpec value)
       Answer generation model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;

    • setModelSpec

      public AnswerQueryRequest.AnswerGenerationSpec.Builder setModelSpec(AnswerQueryRequest.AnswerGenerationSpec.ModelSpec.Builder builderForValue)
       Answer generation model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;

    • mergeModelSpec

      public AnswerQueryRequest.AnswerGenerationSpec.Builder mergeModelSpec(AnswerQueryRequest.AnswerGenerationSpec.ModelSpec value)
       Answer generation model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;

    • clearModelSpec

      public AnswerQueryRequest.AnswerGenerationSpec.Builder clearModelSpec()
       Answer generation model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;

    • getModelSpecBuilder

      public AnswerQueryRequest.AnswerGenerationSpec.ModelSpec.Builder getModelSpecBuilder()
       Answer generation model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;

    • getModelSpecOrBuilder

      public AnswerQueryRequest.AnswerGenerationSpec.ModelSpecOrBuilder getModelSpecOrBuilder()
       Answer generation model specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;
      Specified by:
      getModelSpecOrBuilder in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

    • hasPromptSpec

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

    • getPromptSpec

      public AnswerQueryRequest.AnswerGenerationSpec.PromptSpec getPromptSpec()
       Answer generation prompt specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;
      Specified by:
      getPromptSpec in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder
      Returns:
      The promptSpec.

    • setPromptSpec

      public AnswerQueryRequest.AnswerGenerationSpec.Builder setPromptSpec(AnswerQueryRequest.AnswerGenerationSpec.PromptSpec value)
       Answer generation prompt specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;

    • setPromptSpec

      public AnswerQueryRequest.AnswerGenerationSpec.Builder setPromptSpec(AnswerQueryRequest.AnswerGenerationSpec.PromptSpec.Builder builderForValue)
       Answer generation prompt specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;

    • mergePromptSpec

      public AnswerQueryRequest.AnswerGenerationSpec.Builder mergePromptSpec(AnswerQueryRequest.AnswerGenerationSpec.PromptSpec value)
       Answer generation prompt specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;

    • clearPromptSpec

      public AnswerQueryRequest.AnswerGenerationSpec.Builder clearPromptSpec()
       Answer generation prompt specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;

    • getPromptSpecBuilder

      public AnswerQueryRequest.AnswerGenerationSpec.PromptSpec.Builder getPromptSpecBuilder()
       Answer generation prompt specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;

    • getPromptSpecOrBuilder

      public AnswerQueryRequest.AnswerGenerationSpec.PromptSpecOrBuilder getPromptSpecOrBuilder()
       Answer generation prompt specification.
      .google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;
      Specified by:
      getPromptSpecOrBuilder in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

    • getIncludeCitations

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

    • setIncludeCitations

      public AnswerQueryRequest.AnswerGenerationSpec.Builder setIncludeCitations(boolean value)
       Specifies whether to include citation metadata in the answer. The default
 value is `false`.
      bool include_citations = 3;
      Parameters:
      value - The includeCitations to set.
      Returns:
      This builder for chaining.

    • clearIncludeCitations

      public AnswerQueryRequest.AnswerGenerationSpec.Builder clearIncludeCitations()
       Specifies whether to include citation metadata in the answer. The default
 value is `false`.
      bool include_citations = 3;
      Returns:
      This builder for chaining.

    • getAnswerLanguageCode

      public 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;
      Specified by:
      getAnswerLanguageCode in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder
      Returns:
      The answerLanguageCode.

    • getAnswerLanguageCodeBytes

      public 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;
      Specified by:
      getAnswerLanguageCodeBytes in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder
      Returns:
      The bytes for answerLanguageCode.

    • setAnswerLanguageCode

      public AnswerQueryRequest.AnswerGenerationSpec.Builder setAnswerLanguageCode(String value)
       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;
      Parameters:
      value - The answerLanguageCode to set.
      Returns:
      This builder for chaining.

    • clearAnswerLanguageCode

      public AnswerQueryRequest.AnswerGenerationSpec.Builder clearAnswerLanguageCode()
       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:
      This builder for chaining.

    • setAnswerLanguageCodeBytes

      public AnswerQueryRequest.AnswerGenerationSpec.Builder setAnswerLanguageCodeBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for answerLanguageCode to set.
      Returns:
      This builder for chaining.

    • getIgnoreAdversarialQuery

      public 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;
      Specified by:
      getIgnoreAdversarialQuery in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder
      Returns:
      The ignoreAdversarialQuery.

    • setIgnoreAdversarialQuery

      public AnswerQueryRequest.AnswerGenerationSpec.Builder setIgnoreAdversarialQuery(boolean value)
       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;
      Parameters:
      value - The ignoreAdversarialQuery to set.
      Returns:
      This builder for chaining.

    • clearIgnoreAdversarialQuery

      public AnswerQueryRequest.AnswerGenerationSpec.Builder clearIgnoreAdversarialQuery()
       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:
      This builder for chaining.

    • getIgnoreNonAnswerSeekingQuery

      public 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;
      Specified by:
      getIgnoreNonAnswerSeekingQuery in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder
      Returns:
      The ignoreNonAnswerSeekingQuery.

    • setIgnoreNonAnswerSeekingQuery

      public AnswerQueryRequest.AnswerGenerationSpec.Builder setIgnoreNonAnswerSeekingQuery(boolean value)
       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;
      Parameters:
      value - The ignoreNonAnswerSeekingQuery to set.
      Returns:
      This builder for chaining.

    • clearIgnoreNonAnswerSeekingQuery

      public AnswerQueryRequest.AnswerGenerationSpec.Builder clearIgnoreNonAnswerSeekingQuery()
       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:
      This builder for chaining.

    • hasIgnoreLowRelevantContent

      public 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;
      Specified by:
      hasIgnoreLowRelevantContent in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder
      Returns:
      Whether the ignoreLowRelevantContent field is set.

    • getIgnoreLowRelevantContent

      public 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;
      Specified by:
      getIgnoreLowRelevantContent in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder
      Returns:
      The ignoreLowRelevantContent.

    • setIgnoreLowRelevantContent

      public AnswerQueryRequest.AnswerGenerationSpec.Builder setIgnoreLowRelevantContent(boolean value)
       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;
      Parameters:
      value - The ignoreLowRelevantContent to set.
      Returns:
      This builder for chaining.

    • clearIgnoreLowRelevantContent

      public AnswerQueryRequest.AnswerGenerationSpec.Builder clearIgnoreLowRelevantContent()
       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:
      This builder for chaining.

    • getIgnoreJailBreakingQuery

      public 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];
      Specified by:
      getIgnoreJailBreakingQuery in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder
      Returns:
      The ignoreJailBreakingQuery.

    • setIgnoreJailBreakingQuery

      public AnswerQueryRequest.AnswerGenerationSpec.Builder setIgnoreJailBreakingQuery(boolean value)
       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];
      Parameters:
      value - The ignoreJailBreakingQuery to set.
      Returns:
      This builder for chaining.

    • clearIgnoreJailBreakingQuery

      public AnswerQueryRequest.AnswerGenerationSpec.Builder clearIgnoreJailBreakingQuery()
       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:
      This builder for chaining.