Class SearchRequest.ContentSearchSpec.SummarySpec (0.48.0)

Version 0.48.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class SearchRequest.ContentSearchSpec.SummarySpec extends GeneratedMessageV3 implements SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

A specification for configuring a summary returned in a search response.

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequest.ContentSearchSpec.SummarySpec

Implements

SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER

public static final int IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER

Field Value
Type	Description
int

IGNORE_LOW_RELEVANT_CONTENT_FIELD_NUMBER

public static final int IGNORE_LOW_RELEVANT_CONTENT_FIELD_NUMBER

Field Value
Type	Description
int

IGNORE_NON_SUMMARY_SEEKING_QUERY_FIELD_NUMBER

public static final int IGNORE_NON_SUMMARY_SEEKING_QUERY_FIELD_NUMBER

Field Value
Type	Description
int

INCLUDE_CITATIONS_FIELD_NUMBER

public static final int INCLUDE_CITATIONS_FIELD_NUMBER

Field Value
Type	Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER

Field Value
Type	Description
int

MODEL_PROMPT_SPEC_FIELD_NUMBER

public static final int MODEL_PROMPT_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

MODEL_SPEC_FIELD_NUMBER

public static final int MODEL_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

SUMMARY_RESULT_COUNT_FIELD_NUMBER

public static final int SUMMARY_RESULT_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

USE_SEMANTIC_CHUNKS_FIELD_NUMBER

public static final int USE_SEMANTIC_CHUNKS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.ContentSearchSpec.SummarySpec getDefaultInstance()

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilder()

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder

newBuilder(SearchRequest.ContentSearchSpec.SummarySpec prototype)

public static SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilder(SearchRequest.ContentSearchSpec.SummarySpec prototype)

Parameter
Name	Description
prototype	SearchRequest.ContentSearchSpec.SummarySpec

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.ContentSearchSpec.SummarySpec parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.SummarySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.ContentSearchSpec.SummarySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.ContentSearchSpec.SummarySpec> parser()

Returns
Type	Description
Parser<SummarySpec>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public SearchRequest.ContentSearchSpec.SummarySpec getDefaultInstanceForType()

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec

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;

Returns
Type	Description
boolean	The ignoreAdversarialQuery.

getIgnoreLowRelevantContent()

public 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;

Returns
Type	Description
boolean	The ignoreLowRelevantContent.

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;

Returns
Type	Description
boolean	The ignoreNonSummarySeekingQuery.

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;

Returns
Type	Description
boolean	The includeCitations.

getLanguageCode()

public String getLanguageCode()

Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.

string language_code = 6;

Returns
Type	Description
String	The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.

string language_code = 6;

Returns
Type	Description
ByteString	The bytes for languageCode.

getModelPromptSpec()

public SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec getModelPromptSpec()

If specified, the spec will be used to modify the prompt provided to the LLM.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec model_prompt_spec = 5;

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec	The modelPromptSpec.

getModelPromptSpecOrBuilder()

public SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpecOrBuilder getModelPromptSpecOrBuilder()

If specified, the spec will be used to modify the prompt provided to the LLM.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec model_prompt_spec = 5;

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpecOrBuilder

getModelSpec()

public SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec getModelSpec()

If specified, the spec will be used to modify the model specification provided to the LLM.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec model_spec = 7;

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec	The modelSpec.

getModelSpecOrBuilder()

public SearchRequest.ContentSearchSpec.SummarySpec.ModelSpecOrBuilder getModelSpecOrBuilder()

If specified, the spec will be used to modify the model specification provided to the LLM.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec model_spec = 7;

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec.ModelSpecOrBuilder

getParserForType()

public Parser<SearchRequest.ContentSearchSpec.SummarySpec> getParserForType()

Returns
Type	Description
Parser<SummarySpec>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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 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 is set to CHUNKS.

int32 summary_result_count = 1;

Returns
Type	Description
int	The summaryResultCount.

getUseSemanticChunks()

public 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;

Returns
Type	Description
boolean	The useSemanticChunks.

hasModelPromptSpec()

public boolean hasModelPromptSpec()

If specified, the spec will be used to modify the prompt provided to the LLM.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec model_prompt_spec = 5;

Returns
Type	Description
boolean	Whether the modelPromptSpec field is set.

hasModelSpec()

public boolean hasModelSpec()

If specified, the spec will be used to modify the model specification provided to the LLM.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec model_spec = 7;

Returns
Type	Description
boolean	Whether the modelSpec field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilderForType()

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.ContentSearchSpec.SummarySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public SearchRequest.ContentSearchSpec.SummarySpec.Builder toBuilder()

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException