Package com.google.cloud.discoveryengine.v1

Class SearchRequest.ContentSearchSpec.SummarySpec

    • Field Detail

      • SUMMARY_RESULT_COUNT_FIELD_NUMBER

        public static final int SUMMARY_RESULT_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDE_CITATIONS_FIELD_NUMBER

        public static final int INCLUDE_CITATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER

        public static final int IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IGNORE_NON_SUMMARY_SEEKING_QUERY_FIELD_NUMBER

        public static final int IGNORE_NON_SUMMARY_SEEKING_QUERY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LANGUAGE_CODE_FIELD_NUMBER

        public static final int LANGUAGE_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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 five results can be used to generate a summary.
        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.

      • 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].
        string language_code = 6;
        Specified by:
        getLanguageCodeBytes in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
        Returns:
        The bytes for languageCode.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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

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

      • getDefaultInstanceForType

        public SearchRequest.ContentSearchSpec.SummarySpec getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder