Interface GroundingMetadata

Metadata returned to client when grounding is enabled.

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

Properties

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

Properties

OptionalgoogleMapsWidgetContextToken

googleMapsWidgetContextToken?: string

Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. This field is not supported in Gemini API.

OptionalgroundingChunks

groundingChunks?: GroundingChunk[]

List of supporting references retrieved from specified grounding source.

OptionalgroundingSupports

groundingSupports?: GroundingSupport[]

Optional. List of grounding support.

OptionalretrievalMetadata

retrievalMetadata?: RetrievalMetadata

Optional. Output only. Retrieval metadata.

OptionalretrievalQueries

retrievalQueries?: string[]

Optional. Queries executed by the retrieval tools. 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. List of source flagging uris. This is currently populated only for Google Maps grounding. This field is not supported in Gemini API.

OptionalwebSearchQueries

webSearchQueries?: string[]

Optional. Web search queries for the following-up web search.

Settings

On This Page

Properties