public static interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getIgnoreAdversarialQuery()
public abstract 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. |
getIgnoreNonSummarySeekingQuery()
public abstract 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 abstract 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 abstract 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 abstract 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. |
getSummaryResultCount()
public abstract 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 | |
---|---|
Type | Description |
int | The summaryResultCount. |