Package com.google.cloud.discoveryengine.v1beta

Class AnswerQueryRequest.AnswerGenerationSpec

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

  • Field Details

    • MODEL_SPEC_FIELD_NUMBER

      public static final int MODEL_SPEC_FIELD_NUMBER
      See Also:

    • PROMPT_SPEC_FIELD_NUMBER

      public static final int PROMPT_SPEC_FIELD_NUMBER
      See Also:

    • INCLUDE_CITATIONS_FIELD_NUMBER

      public static final int INCLUDE_CITATIONS_FIELD_NUMBER
      See Also:

    • ANSWER_LANGUAGE_CODE_FIELD_NUMBER

      public static final int ANSWER_LANGUAGE_CODE_FIELD_NUMBER
      See Also:

    • IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER

      public static final int IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER
      See Also:

    • IGNORE_NON_ANSWER_SEEKING_QUERY_FIELD_NUMBER

      public static final int IGNORE_NON_ANSWER_SEEKING_QUERY_FIELD_NUMBER
      See Also:

    • IGNORE_LOW_RELEVANT_CONTENT_FIELD_NUMBER

      public static final int IGNORE_LOW_RELEVANT_CONTENT_FIELD_NUMBER
      See Also:

    • IGNORE_JAIL_BREAKING_QUERY_FIELD_NUMBER

      public static final int IGNORE_JAIL_BREAKING_QUERY_FIELD_NUMBER
      See Also:

  • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static AnswerQueryRequest.AnswerGenerationSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static AnswerQueryRequest.AnswerGenerationSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AnswerQueryRequest.AnswerGenerationSpec.Builder newBuilder()

    • newBuilder

      public static AnswerQueryRequest.AnswerGenerationSpec.Builder newBuilder(AnswerQueryRequest.AnswerGenerationSpec prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static AnswerQueryRequest.AnswerGenerationSpec getDefaultInstance()

    • parser

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

    • getParserForType

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