Class SearchRequest.ContentSearchSpec.SummarySpec.Builder (0.27.0)

public static final class SearchRequest.ContentSearchSpec.SummarySpec.Builder extends 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.v1.SearchRequest.ContentSearchSpec.SummarySpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

build()

public SearchRequest.ContentSearchSpec.SummarySpec build()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec

buildPartial()

public SearchRequest.ContentSearchSpec.SummarySpec buildPartial()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec

clear()

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clear()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

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

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

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

This builder for chaining.

clearLanguageCode()

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearLanguageCode()

Language code for Summary. Use language tags defined by BCP47.

string language_code = 6;

Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

clearSummaryResultCount()

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clearSummaryResultCount()

The number of top results to generate the summary from. If the number of results returned is less than summaryResultCount, the summary is generated from all of the results.

At most five results can be used to generate a summary.

int32 summary_result_count = 1;

Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder

This builder for chaining.

clone()

public SearchRequest.ContentSearchSpec.SummarySpec.Builder clone()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

getDefaultInstanceForType()

public SearchRequest.ContentSearchSpec.SummarySpec getDefaultInstanceForType()
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
boolean

The ignoreAdversarialQuery.

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
TypeDescription
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
TypeDescription
boolean

The includeCitations.

getLanguageCode()

public String getLanguageCode()

Language code for Summary. Use language tags defined by BCP47.

string language_code = 6;

Returns
TypeDescription
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Language code for Summary. Use language tags defined by BCP47.

string language_code = 6;

Returns
TypeDescription
ByteString

The bytes for languageCode.

getSummaryResultCount()

public int getSummaryResultCount()

The number of top results to generate the summary from. If the number of results returned is less than summaryResultCount, the summary is generated from all of the results.

At most five results can be used to generate a summary.

int32 summary_result_count = 1;

Returns
TypeDescription
int

The summaryResultCount.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchRequest.ContentSearchSpec.SummarySpec other)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeFrom(SearchRequest.ContentSearchSpec.SummarySpec other)
Parameter
NameDescription
otherSearchRequest.ContentSearchSpec.SummarySpec
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.ContentSearchSpec.SummarySpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

setIgnoreAdversarialQuery(boolean value)

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;

Parameter
NameDescription
valueboolean

The ignoreAdversarialQuery to set.

Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder

This builder for chaining.

setIgnoreNonSummarySeekingQuery(boolean value)

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;

Parameter
NameDescription
valueboolean

The ignoreNonSummarySeekingQuery to set.

Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder

This builder for chaining.

setIncludeCitations(boolean value)

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;

Parameter
NameDescription
valueboolean

The includeCitations to set.

Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder

This builder for chaining.

setLanguageCode(String value)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setLanguageCode(String value)

Language code for Summary. Use language tags defined by BCP47.

string language_code = 6;

Parameter
NameDescription
valueString

The languageCode to set.

Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder

This builder for chaining.

setLanguageCodeBytes(ByteString value)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setLanguageCodeBytes(ByteString value)

Language code for Summary. Use language tags defined by BCP47.

string language_code = 6;

Parameter
NameDescription
valueByteString

The bytes for languageCode to set.

Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides

setSummaryResultCount(int value)

public SearchRequest.ContentSearchSpec.SummarySpec.Builder setSummaryResultCount(int value)

The number of top results to generate the summary from. If the number of results returned is less than summaryResultCount, the summary is generated from all of the results.

At most five results can be used to generate a summary.

int32 summary_result_count = 1;

Parameter
NameDescription
valueint

The summaryResultCount to set.

Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.ContentSearchSpec.SummarySpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.ContentSearchSpec.SummarySpec.Builder
Overrides