This preview documentation is deprecated as of October 27, 2023. For GA documentation, go to the Vertex AI Search documentation.
Changes in GA:
Name:Discovery for Media is renamed to Vertex AI Search for media. Vertex AI Search includes media recommendations and media search.
Google Cloud Console page: Use the Agent Builder page in the console. The Discovery Engine console page is deprecated.
API reference: Continue to use the discoveryengine.googleapis.com service. The API remains the same but the documentation has moved. Go to the up-to-date, GA version of the Discovery Engine API reference in the Vertex AI Search documentation.
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.
includeCitations
boolean
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.
ignoreAdversarialQuery
boolean
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.
ignoreNonSummarySeekingQuery
boolean
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.
languageCode
string
Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-02-13 UTC."],[[["This document outlines the JSON configuration for customizing summaries in search responses, enabling control over various aspects of the generated summaries."],["The `summaryResultCount` field determines how many top search results are used to create a summary, with a maximum of five results being allowed."],["The `includeCitations` field allows you to enable or disable inline citations within the summary, indicating which search result the information was extracted from."],["`ignoreAdversarialQuery` and `ignoreNonSummarySeekingQuery` fields can be set to filter out specific types of search queries, such as adversarial or non-summary-seeking queries."],["The `languageCode` field allows specifying the language of the generated summary using [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags, and it is an experimental feature."]]],[]]
