public static final class SearchRequest.ContentSearchSpec.SummarySpec.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder> implements SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
A specification for configuring a summary returned in a search response.Protobuf type
google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpecgetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>public SearchRequest.ContentSearchSpec.SummarySpec.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>public SearchRequest.ContentSearchSpec.SummarySpec getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic SearchRequest.ContentSearchSpec.SummarySpec build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic SearchRequest.ContentSearchSpec.SummarySpec buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic SearchRequest.ContentSearchSpec.SummarySpec.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>public SearchRequest.ContentSearchSpec.SummarySpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>public SearchRequest.ContentSearchSpec.SummarySpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>public SearchRequest.ContentSearchSpec.SummarySpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeFrom(SearchRequest.ContentSearchSpec.SummarySpec other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>IOExceptionpublic 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;getSummaryResultCount in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;value - The summaryResultCount to set.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;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;getIncludeCitations in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;value - The includeCitations to set.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;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;getIgnoreAdversarialQuery in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;value - The ignoreAdversarialQuery to set.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;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;getIgnoreNonSummarySeekingQuery in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;value - The ignoreNonSummarySeekingQuery to set.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;public 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;getLanguageCode in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;getLanguageCodeBytes in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;value - The languageCode to set.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;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;value - The bytes for languageCode to set.public final SearchRequest.ContentSearchSpec.SummarySpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>public final SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>Copyright © 2024 Google LLC. All rights reserved.