Class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec
A specification for configuring a summary returned in a search response.
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1beta.Data
Assembly: Google.Apis.DiscoveryEngine.v1beta.dll
Syntax
public class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec : IDirectResponseSchema
Properties
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
IgnoreAdversarialQuery
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.
Declaration
[JsonProperty("ignoreAdversarialQuery")]
public virtual bool? IgnoreAdversarialQuery { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IgnoreJailBreakingQuery
Optional. Specifies whether to filter out jail-breaking queries. The default value is false
. Google
employs search-query classification to detect jail-breaking queries. No summary is returned if the search
query is classified as a jail-breaking query. A user might add instructions to the query to change the tone,
style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the
tone of a competing company's CEO". If this field is set to true
, we skip generating summaries for
jail-breaking queries and return fallback messages instead.
Declaration
[JsonProperty("ignoreJailBreakingQuery")]
public virtual bool? IgnoreJailBreakingQuery { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IgnoreLowRelevantContent
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.
Declaration
[JsonProperty("ignoreLowRelevantContent")]
public virtual bool? IgnoreLowRelevantContent { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IgnoreNonSummarySeekingQuery
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.
Declaration
[JsonProperty("ignoreNonSummarySeekingQuery")]
public virtual bool? IgnoreNonSummarySeekingQuery { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IncludeCitations
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.
Declaration
[JsonProperty("includeCitations")]
public virtual bool? IncludeCitations { get; set; }
Property Value
Type | Description |
---|---|
bool? |
LanguageCode
Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
Declaration
[JsonProperty("languageCode")]
public virtual string LanguageCode { get; set; }
Property Value
Type | Description |
---|---|
string |
ModelPromptSpec
If specified, the spec will be used to modify the prompt provided to the LLM.
Declaration
[JsonProperty("modelPromptSpec")]
public virtual GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec ModelPromptSpec { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec |
ModelSpec
If specified, the spec will be used to modify the model specification provided to the LLM.
Declaration
[JsonProperty("modelSpec")]
public virtual GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec ModelSpec { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec |
SummaryResultCount
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.
Declaration
[JsonProperty("summaryResultCount")]
public virtual int? SummaryResultCount { get; set; }
Property Value
Type | Description |
---|---|
int? |
UseSemanticChunks
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.
Declaration
[JsonProperty("useSemanticChunks")]
public virtual bool? UseSemanticChunks { get; set; }
Property Value
Type | Description |
---|---|
bool? |