com.google.cloud.discoveryengine.v1alpha

Class SearchRequest.ContentSearchSpec.SummarySpec.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>

com.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.Builder

All Implemented Interfaces:

SearchRequest.ContentSearchSpec.SummarySpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SearchRequest.ContentSearchSpec.SummarySpec

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.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec

Method Summary

Modifier and Type	Method and Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchRequest.ContentSearchSpec.SummarySpec	build()
SearchRequest.ContentSearchSpec.SummarySpec	buildPartial()
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clear()
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clearIgnoreAdversarialQuery() Specifies whether to filter out adversarial queries.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clearIgnoreLowRelevantContent() Specifies whether to filter out queries that have low relevance.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clearIgnoreNonSummarySeekingQuery() Specifies whether to filter out queries that are not summary-seeking.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clearIncludeCitations() Specifies whether to include citations in the summary.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clearLanguageCode() Language code for Summary.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clearModelPromptSpec() If specified, the spec will be used to modify the prompt provided to the LLM.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clearModelSpec() If specified, the spec will be used to modify the model specification provided to the LLM.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clearSummaryResultCount() The number of top results to generate the summary from.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clearUseSemanticChunks() If true, answer will be generated from most relevant chunks from top search results.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	clone()
SearchRequest.ContentSearchSpec.SummarySpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getIgnoreAdversarialQuery() Specifies whether to filter out adversarial queries.
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.ModelPromptSpec.Builder	getModelPromptSpecBuilder() 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.ModelSpec.Builder	getModelSpecBuilder() 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.
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.
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()
SearchRequest.ContentSearchSpec.SummarySpec.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SearchRequest.ContentSearchSpec.SummarySpec.Builder	mergeFrom(com.google.protobuf.Message other)
SearchRequest.ContentSearchSpec.SummarySpec.Builder	mergeFrom(SearchRequest.ContentSearchSpec.SummarySpec other)
SearchRequest.ContentSearchSpec.SummarySpec.Builder	mergeModelPromptSpec(SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec value) If specified, the spec will be used to modify the prompt provided to the LLM.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	mergeModelSpec(SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec value) If specified, the spec will be used to modify the model specification provided to the LLM.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setIgnoreAdversarialQuery(boolean value) Specifies whether to filter out adversarial queries.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setIgnoreLowRelevantContent(boolean value) Specifies whether to filter out queries that have low relevance.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setIgnoreNonSummarySeekingQuery(boolean value) Specifies whether to filter out queries that are not summary-seeking.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setIncludeCitations(boolean value) Specifies whether to include citations in the summary.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setLanguageCode(String value) Language code for Summary.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setLanguageCodeBytes(com.google.protobuf.ByteString value) Language code for Summary.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setModelPromptSpec(SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec.Builder builderForValue) If specified, the spec will be used to modify the prompt provided to the LLM.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setModelPromptSpec(SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec value) If specified, the spec will be used to modify the prompt provided to the LLM.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setModelSpec(SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec.Builder builderForValue) If specified, the spec will be used to modify the model specification provided to the LLM.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setModelSpec(SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec value) If specified, the spec will be used to modify the model specification provided to the LLM.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setSummaryResultCount(int value) The number of top results to generate the summary from.
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SearchRequest.ContentSearchSpec.SummarySpec.Builder	setUseSemanticChunks(boolean value) If true, answer will be generated from most relevant chunks from top search results.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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>

clear

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear 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

build

public SearchRequest.ContentSearchSpec.SummarySpec build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

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

clone

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>

setField

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                    Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>

clearField

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>

clearOneof

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>

setRepeatedField

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                            int index,
                                                                            Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>

addRepeatedField

public SearchRequest.ContentSearchSpec.SummarySpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                            Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>

mergeFrom

public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>

mergeFrom

public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeFrom(SearchRequest.ContentSearchSpec.SummarySpec other)

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>

mergeFrom

public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>

Throws:

IOException

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][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
 

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 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.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
 

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 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.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode]
 is set to
 [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
 

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.

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;

Specified by:

getIgnoreLowRelevantContent in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

The ignoreLowRelevantContent.

setIgnoreLowRelevantContent

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setIgnoreLowRelevantContent(boolean value)

 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;

Parameters:

value - The ignoreLowRelevantContent to set.

Returns:

This builder for chaining.

clearIgnoreLowRelevantContent

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearIgnoreLowRelevantContent()

 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:

This builder for chaining.

hasModelPromptSpec

public boolean hasModelPromptSpec()

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

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

Specified by:

hasModelPromptSpec in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

Whether the modelPromptSpec field is set.

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.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec model_prompt_spec = 5;

Specified by:

getModelPromptSpec in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

The modelPromptSpec.

setModelPromptSpec

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setModelPromptSpec(SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec value)

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

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

setModelPromptSpec

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setModelPromptSpec(SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec.Builder builderForValue)

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

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

mergeModelPromptSpec

public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeModelPromptSpec(SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec value)

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

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

clearModelPromptSpec

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearModelPromptSpec()

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

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

getModelPromptSpecBuilder

public SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec.Builder getModelPromptSpecBuilder()

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

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

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.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec model_prompt_spec = 5;

Specified by:

getModelPromptSpecOrBuilder in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

getLanguageCode

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

Specified by:

getLanguageCode in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

The languageCode.

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).
 Note: This is an experimental feature.
 

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).
 Note: This is an experimental feature.
 

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).
 Note: This is an experimental feature.
 

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).
 Note: This is an experimental feature.
 

string language_code = 6;

Parameters:

value - The bytes for languageCode to set.

Returns:

This builder for chaining.

hasModelSpec

public boolean hasModelSpec()

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

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

Specified by:

hasModelSpec in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

Whether the modelSpec field is set.

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.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec model_spec = 7;

Specified by:

getModelSpec in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

The modelSpec.

setModelSpec

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setModelSpec(SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec value)

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

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

setModelSpec

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setModelSpec(SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec.Builder builderForValue)

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

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

mergeModelSpec

public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeModelSpec(SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec value)

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

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

clearModelSpec

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearModelSpec()

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

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

getModelSpecBuilder

public SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec.Builder getModelSpecBuilder()

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

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

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.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec model_spec = 7;

Specified by:

getModelSpecOrBuilder in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

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;

Specified by:

getUseSemanticChunks in interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

Returns:

The useSemanticChunks.

setUseSemanticChunks

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setUseSemanticChunks(boolean value)

 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;

Parameters:

value - The useSemanticChunks to set.

Returns:

This builder for chaining.

clearUseSemanticChunks

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearUseSemanticChunks()

 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:

This builder for chaining.

setUnknownFields

public final SearchRequest.ContentSearchSpec.SummarySpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>

mergeUnknownFields

public final SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SummarySpec.Builder>