Class SummarySpec (0.11.10)

SummarySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A specification for configuring a summary returned in a search response.

Attributes

NameDescription
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 five results can be used to generate a summary.
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.
model_prompt_spec google.cloud.discoveryengine_v1.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_v1.types.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec
If specified, the spec will be used to modify the model specification provided to the LLM.

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.