React Native Firebase
    Preparing search index...

    Interface GroundingMetadata

    Metadata returned when grounding is enabled.

    Currently, only Grounding with Google Search is supported (see GoogleSearchTool).

    Important: If using Grounding with Google Search, you are required to comply with the "Grounding with Google Search" usage requirements for your chosen API provider: Gemini Developer API or Vertex AI Gemini API (see Service Terms section within the Service Specific Terms).

    interface GroundingMetadata {
        googleMapsWidgetContextToken?: string;
        groundingChunks?: GroundingChunk[];
        groundingSupports?: GroundingSupport[];
        retrievalQueries?: string[];
        searchEntryPoint?: SearchEntrypoint;
        webSearchQueries?: string[];
    }
    Index

    Properties

    googleMapsWidgetContextToken? groundingChunks? groundingSupports? retrievalQueries? searchEntryPoint? webSearchQueries?

    Properties

    googleMapsWidgetContextToken?: string

    Resource name of the Google Maps widget context token that can be used with the PlacesContextElement widget in order to render contextual data. Only populated in the case that grounding with Google Maps is enabled.

    groundingChunks?: GroundingChunk[]

    A list of GroundingChunk objects. Each chunk represents a piece of retrieved content (for example, from a web page). that the model used to ground its response.

    groundingSupports?: GroundingSupport[]

    A list of GroundingSupport objects. Each object details how specific segments of the model's response are supported by the groundingChunks.

    retrievalQueries?: string[]

    Use GroundingSupport instead.

    searchEntryPoint?: SearchEntrypoint

    Google Search entry point for web searches. This contains an HTML/CSS snippet that must be embedded in an app to display a Google Search entry point for follow-up web searches related to a model's "Grounded Response".

    webSearchQueries?: string[]

    A list of web search queries that the model performed to gather the grounding information. These can be used to allow users to explore the search results themselves.

    Settings

    Member Visibility

    On This Page

    Properties