public sealed class SearchRequest.Types.ContentSearchSpec.Types.SummarySpec : IMessage<SearchRequest.Types.ContentSearchSpec.Types.SummarySpec>, IEquatable<SearchRequest.Types.ContentSearchSpec.Types.SummarySpec>, IDeepCloneable<SearchRequest.Types.ContentSearchSpec.Types.SummarySpec>, IBufferMessage, IMessageReference documentation and code samples for the Discovery Engine v1 API class SearchRequest.Types.ContentSearchSpec.Types.SummarySpec.
A specification for configuring a summary returned in a search response.
Implements
IMessageSearchRequestTypesContentSearchSpecTypesSummarySpec, IEquatableSearchRequestTypesContentSearchSpecTypesSummarySpec, IDeepCloneableSearchRequestTypesContentSearchSpecTypesSummarySpec, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
SummarySpec()
public SummarySpec()SummarySpec(SummarySpec)
public SummarySpec(SearchRequest.Types.ContentSearchSpec.Types.SummarySpec other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchRequestTypesContentSearchSpecTypesSummarySpec |
Properties
IgnoreAdversarialQuery
public bool IgnoreAdversarialQuery { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
IgnoreLowRelevantContent
public bool IgnoreLowRelevantContent { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
IgnoreNonSummarySeekingQuery
public bool IgnoreNonSummarySeekingQuery { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
IncludeCitations
public bool IncludeCitations { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
LanguageCode
public string LanguageCode { get; set; }Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ModelPromptSpec
public SearchRequest.Types.ContentSearchSpec.Types.SummarySpec.Types.ModelPromptSpec ModelPromptSpec { get; set; }If specified, the spec will be used to modify the prompt provided to the LLM.
| Property Value | |
|---|---|
| Type | Description |
SearchRequestTypesContentSearchSpecTypesSummarySpecTypesModelPromptSpec |
|
ModelSpec
public SearchRequest.Types.ContentSearchSpec.Types.SummarySpec.Types.ModelSpec ModelSpec { get; set; }If specified, the spec will be used to modify the model specification provided to the LLM.
| Property Value | |
|---|---|
| Type | Description |
SearchRequestTypesContentSearchSpecTypesSummarySpecTypesModelSpec |
|
SummaryResultCount
public int SummaryResultCount { get; set; }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.v1.SearchRequest.ContentSearchSpec.search_result_mode] is set to [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
| Property Value | |
|---|---|
| Type | Description |
int |
|
UseSemanticChunks
public bool UseSemanticChunks { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|