Interface GroundingMetadata

Information for various kinds of grounding.

interface GroundingMetadata {
    googleMapsWidgetContextToken?: string;
    groundingChunks?: GroundingChunk[];
    groundingSupports?: GroundingSupport[];
    imageSearchQueries?: string[];
    retrievalMetadata?: RetrievalMetadata;
    retrievalQueries?: string[];
    searchEntryPoint?: SearchEntryPoint;
    sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
    webSearchQueries?: string[];
}

Properties

googleMapsWidgetContextToken? groundingChunks? groundingSupports? imageSearchQueries? retrievalMetadata? retrievalQueries? searchEntryPoint? sourceFlaggingUris? webSearchQueries?

Properties

OptionalgoogleMapsWidgetContextToken

googleMapsWidgetContextToken?: string

Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. This field is not supported in Gemini API.

OptionalgroundingChunks

groundingChunks?: GroundingChunk[]

A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.

OptionalgroundingSupports

groundingSupports?: GroundingSupport[]

List of grounding support.

OptionalimageSearchQueries

imageSearchQueries?: string[]

Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled.

OptionalretrievalMetadata

retrievalMetadata?: RetrievalMetadata

Metadata related to retrieval in the grounding flow.

OptionalretrievalQueries

retrievalQueries?: string[]

Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. This field is not supported in Gemini API.

OptionalsearchEntryPoint

searchEntryPoint?: SearchEntryPoint

Optional. Google search entry for the following-up web searches.

OptionalsourceFlaggingUris

sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[]

Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. This field is not supported in Gemini API.

OptionalwebSearchQueries

webSearchQueries?: string[]

Web search queries for the following-up web search.

Settings

On This Page

Properties