SummarySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)A specification for configuring a summary returned in a search response.
Attributes |
|
|---|---|
| Name | Description |
summary_result_count |
int
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.
|
include_citations |
bool
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.
|
ignore_adversarial_query |
bool
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.
|
ignore_non_summary_seeking_query |
bool
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.
|
ignore_low_relevant_content |
bool
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.
|
ignore_jail_breaking_query |
bool
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.
|
model_prompt_spec |
google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec
If specified, the spec will be used to modify the prompt provided to the LLM. |
language_code |
str
Language code for Summary. Use language tags defined by BCP47 __.
Note: This is an experimental feature.
|
model_spec |
google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec
If specified, the spec will be used to modify the model specification provided to the LLM. |
use_semantic_chunks |
bool
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. |
Classes
ModelPromptSpec
ModelPromptSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)Specification of the prompt to use with the model.
ModelSpec
ModelSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)Specification of the model.