Interface GroundingMetadata

Metadata returned to client when grounding is enabled.

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

Properties

groundingChunks? groundingSupports? retrievalMetadata? retrievalQueries? searchEntryPoint? webSearchQueries?

Properties

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.

OptionalsearchEntryPoint

searchEntryPoint?: SearchEntryPoint

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

OptionalwebSearchQueries

webSearchQueries?: string[]

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

Settings

On This Page

Properties