Package com.google.cloud.discoveryengine.v1

Class SearchRequest.ContentSearchSpec.SummarySpec.Builder

    • Method Detail

      • 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.Builder<SearchRequest.ContentSearchSpec.SummarySpec.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.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>

      • getDefaultInstanceForType

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>

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

      • setSummaryResultCount

        public SearchRequest.ContentSearchSpec.SummarySpec.Builder setSummaryResultCount​(int value)
         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;
        Parameters:
        value - The summaryResultCount to set.
        Returns:
        This builder for chaining.

      • clearSummaryResultCount

        public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearSummaryResultCount()
         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:
        This builder for chaining.

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

      • setIncludeCitations

        public SearchRequest.ContentSearchSpec.SummarySpec.Builder setIncludeCitations​(boolean value)
         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;
        Parameters:
        value - The includeCitations to set.
        Returns:
        This builder for chaining.

      • clearIncludeCitations

        public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearIncludeCitations()
         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:
        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 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.

      • setIgnoreAdversarialQuery

        public SearchRequest.ContentSearchSpec.SummarySpec.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 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;
        Parameters:
        value - The ignoreAdversarialQuery to set.
        Returns:
        This builder for chaining.

      • clearIgnoreAdversarialQuery

        public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearIgnoreAdversarialQuery()
         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:
        This builder for chaining.

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

      • setIgnoreNonSummarySeekingQuery

        public SearchRequest.ContentSearchSpec.SummarySpec.Builder setIgnoreNonSummarySeekingQuery​(boolean value)
         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;
        Parameters:
        value - The ignoreNonSummarySeekingQuery to set.
        Returns:
        This builder for chaining.

      • clearIgnoreNonSummarySeekingQuery

        public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearIgnoreNonSummarySeekingQuery()
         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:
        This builder for chaining.

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

      • setLanguageCode

        public SearchRequest.ContentSearchSpec.SummarySpec.Builder setLanguageCode​(String value)
         Language code for Summary. Use language tags defined by
 [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
        string language_code = 6;
        Parameters:
        value - The languageCode to set.
        Returns:
        This builder for chaining.

      • clearLanguageCode

        public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearLanguageCode()
         Language code for Summary. Use language tags defined by
 [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
        string language_code = 6;
        Returns:
        This builder for chaining.

      • setLanguageCodeBytes

        public SearchRequest.ContentSearchSpec.SummarySpec.Builder setLanguageCodeBytes​(com.google.protobuf.ByteString value)
         Language code for Summary. Use language tags defined by
 [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
        string language_code = 6;
        Parameters:
        value - The bytes for languageCode to set.
        Returns:
        This builder for chaining.