public static final class SearchRequest.ContentSearchSpec.SummarySpec extends com.google.protobuf.GeneratedMessageV3 implements SearchRequest.ContentSearchSpec.SummarySpecOrBuilder
A specification for configuring a summary returned in a search response.Protobuf type
google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec| Modifier and Type | Class and Description |
|---|---|
static class |
SearchRequest.ContentSearchSpec.SummarySpec.Builder
A specification for configuring a summary returned in a search
response.
|
static class |
SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec
Specification of the prompt to use with the model.
|
static interface |
SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpecOrBuilder |
static class |
SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec
Specification of the model.
|
static interface |
SearchRequest.ContentSearchSpec.SummarySpec.ModelSpecOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER |
static int |
IGNORE_JAIL_BREAKING_QUERY_FIELD_NUMBER |
static int |
IGNORE_LOW_RELEVANT_CONTENT_FIELD_NUMBER |
static int |
IGNORE_NON_SUMMARY_SEEKING_QUERY_FIELD_NUMBER |
static int |
INCLUDE_CITATIONS_FIELD_NUMBER |
static int |
LANGUAGE_CODE_FIELD_NUMBER |
static int |
MODEL_PROMPT_SPEC_FIELD_NUMBER |
static int |
MODEL_SPEC_FIELD_NUMBER |
static int |
SUMMARY_RESULT_COUNT_FIELD_NUMBER |
static int |
USE_SEMANTIC_CHUNKS_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static SearchRequest.ContentSearchSpec.SummarySpec |
getDefaultInstance() |
SearchRequest.ContentSearchSpec.SummarySpec |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getIgnoreAdversarialQuery()
Specifies whether to filter out adversarial queries.
|
boolean |
getIgnoreJailBreakingQuery()
Optional.
|
boolean |
getIgnoreLowRelevantContent()
Specifies whether to filter out queries that have low relevance.
|
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.
|
SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec |
getModelPromptSpec()
If specified, the spec will be used to modify the prompt provided to
the LLM.
|
SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpecOrBuilder |
getModelPromptSpecOrBuilder()
If specified, the spec will be used to modify the prompt provided to
the LLM.
|
SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec |
getModelSpec()
If specified, the spec will be used to modify the model specification
provided to the LLM.
|
SearchRequest.ContentSearchSpec.SummarySpec.ModelSpecOrBuilder |
getModelSpecOrBuilder()
If specified, the spec will be used to modify the model specification
provided to the LLM.
|
com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SummarySpec> |
getParserForType() |
int |
getSerializedSize() |
int |
getSummaryResultCount()
The number of top results to generate the summary from.
|
boolean |
getUseSemanticChunks()
If true, answer will be generated from most relevant chunks from top
search results.
|
int |
hashCode() |
boolean |
hasModelPromptSpec()
If specified, the spec will be used to modify the prompt provided to
the LLM.
|
boolean |
hasModelSpec()
If specified, the spec will be used to modify the model specification
provided to the LLM.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static SearchRequest.ContentSearchSpec.SummarySpec.Builder |
newBuilder() |
static SearchRequest.ContentSearchSpec.SummarySpec.Builder |
newBuilder(SearchRequest.ContentSearchSpec.SummarySpec prototype) |
SearchRequest.ContentSearchSpec.SummarySpec.Builder |
newBuilderForType() |
protected SearchRequest.ContentSearchSpec.SummarySpec.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static SearchRequest.ContentSearchSpec.SummarySpec |
parseDelimitedFrom(InputStream input) |
static SearchRequest.ContentSearchSpec.SummarySpec |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SearchRequest.ContentSearchSpec.SummarySpec |
parseFrom(byte[] data) |
static SearchRequest.ContentSearchSpec.SummarySpec |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SearchRequest.ContentSearchSpec.SummarySpec |
parseFrom(ByteBuffer data) |
static SearchRequest.ContentSearchSpec.SummarySpec |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SearchRequest.ContentSearchSpec.SummarySpec |
parseFrom(com.google.protobuf.ByteString data) |
static SearchRequest.ContentSearchSpec.SummarySpec |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SearchRequest.ContentSearchSpec.SummarySpec |
parseFrom(com.google.protobuf.CodedInputStream input) |
static SearchRequest.ContentSearchSpec.SummarySpec |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SearchRequest.ContentSearchSpec.SummarySpec |
parseFrom(InputStream input) |
static SearchRequest.ContentSearchSpec.SummarySpec |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SummarySpec> |
parser() |
SearchRequest.ContentSearchSpec.SummarySpec.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int SUMMARY_RESULT_COUNT_FIELD_NUMBER
public static final int INCLUDE_CITATIONS_FIELD_NUMBER
public static final int IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER
public static final int IGNORE_NON_SUMMARY_SEEKING_QUERY_FIELD_NUMBER
public static final int IGNORE_LOW_RELEVANT_CONTENT_FIELD_NUMBER
public static final int IGNORE_JAIL_BREAKING_QUERY_FIELD_NUMBER
public static final int MODEL_PROMPT_SPEC_FIELD_NUMBER
public static final int LANGUAGE_CODE_FIELD_NUMBER
public static final int MODEL_SPEC_FIELD_NUMBER
public static final int USE_SEMANTIC_CHUNKS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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;getSummaryResultCount in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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 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 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 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;getIgnoreLowRelevantContent in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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];
getIgnoreJailBreakingQuery in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;
hasModelPromptSpec in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;
getModelPromptSpec in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;
getModelPromptSpecOrBuilder in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;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). Note: This is an experimental feature.
string language_code = 6;getLanguageCodeBytes in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;
hasModelSpec in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;
getModelSpec in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;
getModelSpecOrBuilder in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic 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;getUseSemanticChunks in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(InputStream input) throws IOException
IOExceptionpublic static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SearchRequest.ContentSearchSpec.SummarySpec parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static SearchRequest.ContentSearchSpec.SummarySpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilder()
public static SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilder(SearchRequest.ContentSearchSpec.SummarySpec prototype)
public SearchRequest.ContentSearchSpec.SummarySpec.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static SearchRequest.ContentSearchSpec.SummarySpec getDefaultInstance()
public static com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SummarySpec> parser()
public com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SummarySpec> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public SearchRequest.ContentSearchSpec.SummarySpec getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.