5.2 KiB
Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference
{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}
GroundingMetadata interface
Metadata returned when grounding is enabled.
Currently, only Grounding with Google Search and Grounding with Google Maps are supported (see GoogleSearchTool and GoogleMapsTool, respectively).
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 Agent Platform Gemini API (see Service Terms section within the Service Specific Terms).
Important: If using Grounding with Google Maps, you are required to comply with the "Grounding with Google Maps" usage requirements for your chosen API provider: Gemini Developer API or Agent Platform Gemini API (see Service Terms section within the Service Specific Terms).
Signature:
export interface GroundingMetadata
Properties
| Property | Type | Description |
|---|---|---|
| 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[] | |
| 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. |
GroundingMetadata.googleMapsWidgetContextToken
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.
Signature:
googleMapsWidgetContextToken?: string;
GroundingMetadata.groundingChunks
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.
Signature:
groundingChunks?: GroundingChunk[];
GroundingMetadata.groundingSupports
A list of GroundingSupport objects. Each object details how specific segments of the model's response are supported by the groundingChunks.
Signature:
groundingSupports?: GroundingSupport[];
GroundingMetadata.retrievalQueries
Warning: This API is now obsolete.
Use GroundingSupport instead.
Signature:
retrievalQueries?: string[];
GroundingMetadata.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".
Signature:
searchEntryPoint?: SearchEntrypoint;
GroundingMetadata.webSearchQueries
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.
Signature:
webSearchQueries?: string[];