Package com.google.cloud.discoveryengine.v1

Interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getIgnoreAdversarialQuery()
      Specifies whether to filter out adversarial queries.
      boolean getIgnoreNonSummarySeekingQuery()
      Specifies whether to filter out queries that are not summary-seeking.
      boolean getIncludeCitations()
      Specifies whether to include citations in the summary.
      String getLanguageCode()
      Language code for Summary.
      com.google.protobuf.ByteString getLanguageCodeBytes()
      Language code for Summary.
      int getSummaryResultCount()
      The number of top results to generate the summary from.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getSummaryResultCount

        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 five results can be used to generate a summary.
        int32 summary_result_count = 1;
        Returns:
        The summaryResultCount.

      • getIncludeCitations

        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;
        Returns:
        The includeCitations.

      • 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 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;
        Returns:
        The ignoreAdversarialQuery.

      • getIgnoreNonSummarySeekingQuery

        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;
        Returns:
        The ignoreNonSummarySeekingQuery.

      • getLanguageCode

        String getLanguageCode()
         Language code for Summary. Use language tags defined by
 [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
        string language_code = 6;
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        com.google.protobuf.ByteString getLanguageCodeBytes()
         Language code for Summary. Use language tags defined by
 [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
        string language_code = 6;
        Returns:
        The bytes for languageCode.