View Source GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec (google_api_discovery_engine v0.3.0)
A specification for configuring a summary returned in a search response.
Attributes
-
ignoreAdversarialQuery
(type:boolean()
, default:nil
) - Specifies whether to filter out adversarial queries. The default value isfalse
. 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 totrue
, we skip generating summaries for adversarial queries and return fallback messages instead. -
ignoreNonSummarySeekingQuery
(type:boolean()
, default:nil
) - Specifies whether to filter out queries that are not summary-seeking. The default value isfalse
. 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
andWho is the best soccer player in the world?
are summary-seeking queries, butSFO airport
andworld cup 2026
are not. They are most likely navigational queries. If this field is set totrue
, we skip generating summaries for non-summary seeking queries and return fallback messages instead. -
includeCitations
(type:boolean()
, default:nil
) - Specifies whether to include citations in the summary. The default value isfalse
. When this field is set totrue
, 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. -
languageCode
(type:String.t
, default:nil
) - Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature. -
modelPromptSpec
(type:GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec.t
, default:nil
) - If specified, the spec will be used to modify the prompt provided to the LLM. -
modelSpec
(type:GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec.t
, default:nil
) - If specified, the spec will be used to modify the model specification provided to the LLM. -
summaryResultCount
(type:integer()
, default:nil
) - The number of top results to generate the summary from. If the number of results returned is less thansummaryResultCount
, the summary is generated from all of the results. At most 10 results can be used to generate a summary.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec{ ignoreAdversarialQuery: boolean() | nil, ignoreNonSummarySeekingQuery: boolean() | nil, includeCitations: boolean() | nil, languageCode: String.t() | nil, modelPromptSpec: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec.t() | nil, modelSpec: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec.t() | nil, summaryResultCount: integer() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.