Package com.google.cloud.discoveryengine.v1beta

Class SearchRequest.ContentSearchSpec.SummarySpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec
All Implemented Interfaces:
SearchRequest.ContentSearchSpec.SummarySpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
SearchRequest.ContentSearchSpec
public static final class SearchRequest.ContentSearchSpec.SummarySpec extends com.google.protobuf.GeneratedMessage implements SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
 A specification for configuring a summary returned in a search
 response.
Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec
See Also:

  • Field Details

    • SUMMARY_RESULT_COUNT_FIELD_NUMBER

      public static final int SUMMARY_RESULT_COUNT_FIELD_NUMBER
      See Also:

    • INCLUDE_CITATIONS_FIELD_NUMBER

      public static final int INCLUDE_CITATIONS_FIELD_NUMBER
      See Also:

    • IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER

      public static final int IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER
      See Also:

    • IGNORE_NON_SUMMARY_SEEKING_QUERY_FIELD_NUMBER

      public static final int IGNORE_NON_SUMMARY_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:

    • MODEL_PROMPT_SPEC_FIELD_NUMBER

      public static final int MODEL_PROMPT_SPEC_FIELD_NUMBER
      See Also:

    • LANGUAGE_CODE_FIELD_NUMBER

      public static final int LANGUAGE_CODE_FIELD_NUMBER
      See Also:

    • MODEL_SPEC_FIELD_NUMBER

      public static final int MODEL_SPEC_FIELD_NUMBER
      See Also:

    • USE_SEMANTIC_CHUNKS_FIELD_NUMBER

      public static final int USE_SEMANTIC_CHUNKS_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

    • getSummaryResultCount

      public int getSummaryResultCount()
       The number of top results to generate the summary from. If the number
 of results returned is less than `summaryResultCount`, the summary is
 generated from all of the results.

 At most 10 results for documents mode, or 50 for chunks mode, can be
 used to generate a summary. The chunks mode is used when
 [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
      int32 summary_result_count = 1;
      Specified by:
      getSummaryResultCount in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      Returns:
      The summaryResultCount.

    • getIncludeCitations

      public boolean getIncludeCitations()
       Specifies whether to include citations in the summary. The default
 value is `false`.

 When this field is set to `true`, summaries include in-line citation
 numbers.

 Example summary including citations:

 BigQuery is Google Cloud's fully managed and completely serverless
 enterprise data warehouse [1]. BigQuery supports all data types, works
 across clouds, and has built-in machine learning and business
 intelligence, all within a unified platform [2, 3].

 The citation numbers refer to the returned search results and are
 1-indexed. For example, [1] means that the sentence is attributed to
 the first search result. [2, 3] means that the sentence is attributed
 to both the second and third search results.
      bool include_citations = 2;
      Specified by:
      getIncludeCitations in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      Returns:
      The includeCitations.

    • 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 summary 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 summaries for adversarial queries and return
 fallback messages instead.
      bool ignore_adversarial_query = 3;
      Specified by:
      getIgnoreAdversarialQuery in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      Returns:
      The ignoreAdversarialQuery.

    • getIgnoreNonSummarySeekingQuery

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

 Google employs search-query classification to detect summary-seeking
 queries. No summary is returned if the search query is classified as a
 non-summary seeking query. For example, `why is the sky blue` and `Who
 is the best soccer player in the world?` are summary-seeking queries,
 but `SFO airport` and `world cup 2026` are not. They are most likely
 navigational queries. If this field is set to `true`, we skip
 generating summaries for non-summary seeking queries and return
 fallback messages instead.
      bool ignore_non_summary_seeking_query = 4;
      Specified by:
      getIgnoreNonSummarySeekingQuery in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      Returns:
      The ignoreNonSummarySeekingQuery.

    • getIgnoreLowRelevantContent

      public boolean getIgnoreLowRelevantContent()
       Specifies whether to filter out queries that have low relevance. The
 default value is `false`.

 If this field is set to `false`, all search results are used regardless
 of relevance to generate answers. If set to `true`, only queries with
 high relevance search results will generate answers.
      bool ignore_low_relevant_content = 9;
      Specified by:
      getIgnoreLowRelevantContent in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      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 = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIgnoreJailBreakingQuery in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      Returns:
      The ignoreJailBreakingQuery.

    • hasModelPromptSpec

      public boolean hasModelPromptSpec()
       If specified, the spec will be used to modify the prompt provided to
 the LLM.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec model_prompt_spec = 5;
      Specified by:
      hasModelPromptSpec in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      Returns:
      Whether the modelPromptSpec field is set.

    • getModelPromptSpec

      public SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec getModelPromptSpec()
       If specified, the spec will be used to modify the prompt provided to
 the LLM.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec model_prompt_spec = 5;
      Specified by:
      getModelPromptSpec in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      Returns:
      The modelPromptSpec.

    • getModelPromptSpecOrBuilder

      public SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpecOrBuilder getModelPromptSpecOrBuilder()
       If specified, the spec will be used to modify the prompt provided to
 the LLM.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec model_prompt_spec = 5;
      Specified by:
      getModelPromptSpecOrBuilder in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

    • getLanguageCode

      public String getLanguageCode()
       Language code for Summary. Use language tags defined by
 [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 Note: This is an experimental feature.
      string language_code = 6;
      Specified by:
      getLanguageCode in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      Returns:
      The languageCode.

    • getLanguageCodeBytes

      public com.google.protobuf.ByteString getLanguageCodeBytes()
       Language code for Summary. Use language tags defined by
 [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 Note: This is an experimental feature.
      string language_code = 6;
      Specified by:
      getLanguageCodeBytes in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      Returns:
      The bytes for languageCode.

    • hasModelSpec

      public boolean hasModelSpec()
       If specified, the spec will be used to modify the model specification
 provided to the LLM.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec model_spec = 7;
      Specified by:
      hasModelSpec in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      Returns:
      Whether the modelSpec field is set.

    • getModelSpec

      public SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec getModelSpec()
       If specified, the spec will be used to modify the model specification
 provided to the LLM.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec model_spec = 7;
      Specified by:
      getModelSpec in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      Returns:
      The modelSpec.

    • getModelSpecOrBuilder

      public SearchRequest.ContentSearchSpec.SummarySpec.ModelSpecOrBuilder getModelSpecOrBuilder()
       If specified, the spec will be used to modify the model specification
 provided to the LLM.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec model_spec = 7;
      Specified by:
      getModelSpecOrBuilder in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

    • getUseSemanticChunks

      public boolean getUseSemanticChunks()
       If true, answer will be generated from most relevant chunks from top
 search results. This feature will improve summary quality.
 Note that with this feature enabled, not all top search results
 will be referenced and included in the reference list, so the citation
 source index only points to the search results listed in the reference
 list.
      bool use_semantic_chunks = 8;
      Specified by:
      getUseSemanticChunks in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
      Returns:
      The useSemanticChunks.

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

    • parseFrom

      public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchRequest.ContentSearchSpec.SummarySpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchRequest.ContentSearchSpec.SummarySpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilder()

    • newBuilder

      public static SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilder(SearchRequest.ContentSearchSpec.SummarySpec prototype)

    • toBuilder

      public SearchRequest.ContentSearchSpec.SummarySpec.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchRequest.ContentSearchSpec.SummarySpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SummarySpec> parser()

    • getParserForType

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