update docs

dlarocque · dlarocque · commit 20256e5b767d · 2025-06-20T11:38:52.000-04:00
diff --git a/docs-devsite/ai.groundingchunk.md b/docs-devsite/ai.groundingchunk.md
@@ -12,6 +12,8 @@ https://github.com/firebase/firebase-js-sdk
 # GroundingChunk interface
 Represents a chunk of retrieved data that supports a claim in the model's response. This is part of the grounding information provided when grounding is enabled.
 
+When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
+
 <b>Signature:</b>
 
 ```typescript
diff --git a/docs-devsite/ai.groundingmetadata.md b/docs-devsite/ai.groundingmetadata.md
@@ -12,6 +12,8 @@ https://github.com/firebase/firebase-js-sdk
 # GroundingMetadata interface
 Metadata returned to client when grounding is enabled.
 
+If using Grounding with Google Search, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
+
 <b>Signature:</b>
 
 ```typescript
@@ -23,16 +25,17 @@ export interface GroundingMetadata
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [groundingAttributions](./ai.groundingmetadata.md#groundingmetadatagroundingattributions) | [GroundingAttribution](./ai.groundingattribution.md#groundingattribution_interface)<!-- -->\[\] |  |
-|  [groundingChunks](./ai.groundingmetadata.md#groundingmetadatagroundingchunks) | [GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface)<!-- -->\[\] | A list of [GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface) objects. Each chunk represents a piece of retrieved content (e.g. from a web page). that the model used to ground its response. |
-|  [groundingSupports](./ai.groundingmetadata.md#groundingmetadatagroundingsupports) | [GroundingSupport](./ai.groundingsupport.md#groundingsupport_interface)<!-- -->\[\] | A list of [GroundingSupport](./ai.groundingsupport.md#groundingsupport_interface) objects. Each object details how specific segments of the model's response are supported by the <code>groundingChunks</code>. |
+|  [groundingChunks](./ai.groundingmetadata.md#groundingmetadatagroundingchunks) | [GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface)<!-- -->\[\] | A list of [GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface) objects. Each chunk represents a piece of retrieved content (e.g. from a web page). that the model used to ground its response.<!-- -->When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search". |
+|  [groundingSupports](./ai.groundingmetadata.md#groundingmetadatagroundingsupports) | [GroundingSupport](./ai.groundingsupport.md#groundingsupport_interface)<!-- -->\[\] | A list of [GroundingSupport](./ai.groundingsupport.md#groundingsupport_interface) objects. Each object details how specific segments of the model's response are supported by the <code>groundingChunks</code>.<!-- -->When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search". |
 |  [retrievalQueries](./ai.groundingmetadata.md#groundingmetadataretrievalqueries) | string\[\] |  |
-|  [searchEntryPoint](./ai.groundingmetadata.md#groundingmetadatasearchentrypoint) | [SearchEntrypoint](./ai.searchentrypoint.md#searchentrypoint_interface) | Google search entry for the following web searches. An HTML/CSS snippet that can be embedded in a web page to display a Google Search Entry point for follow-up web searches related to the model's response. |
-|  [webSearchQueries](./ai.groundingmetadata.md#groundingmetadatawebsearchqueries) | 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. |
+|  [searchEntryPoint](./ai.groundingmetadata.md#groundingmetadatasearchentrypoint) | [SearchEntrypoint](./ai.searchentrypoint.md#searchentrypoint_interface) | 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 the model's "Grounded Response".<!-- -->When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search". |
+|  [webSearchQueries](./ai.groundingmetadata.md#groundingmetadatawebsearchqueries) | 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.<!-- -->When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search". |
 
 ## GroundingMetadata.groundingAttributions
 
 > Warning: This API is now obsolete.
 > 
+> Use [GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface) instead.
 > 
 
 <b>Signature:</b>
@@ -45,6 +48,8 @@ groundingAttributions: GroundingAttribution[];
 
 A list of [GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface) objects. Each chunk represents a piece of retrieved content (e.g. from a web page). that the model used to ground its response.
 
+When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
+
 <b>Signature:</b>
 
 ```typescript
@@ -55,6 +60,8 @@ groundingChunks?: GroundingChunk[];
 
 A list of [GroundingSupport](./ai.groundingsupport.md#groundingsupport_interface) objects. Each object details how specific segments of the model's response are supported by the `groundingChunks`<!-- -->.
 
+When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
+
 <b>Signature:</b>
 
 ```typescript
@@ -65,7 +72,7 @@ groundingSupports?: GroundingSupport[];
 
 > Warning: This API is now obsolete.
 > 
-> Use [GroundingMetadata.groundingSupports](./ai.groundingmetadata.md#groundingmetadatagroundingsupports) instead.
+> Use [GroundingSupport](./ai.groundingsupport.md#groundingsupport_interface) instead.
 > 
 
 <b>Signature:</b>
@@ -76,7 +83,9 @@ retrievalQueries?: string[];
 
 ## GroundingMetadata.searchEntryPoint
 
-Google search entry for the following web searches. An HTML/CSS snippet that can be embedded in a web page to display a Google Search Entry point for follow-up web searches related to the model's response.
+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 the model's "Grounded Response".
+
+When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
 
 <b>Signature:</b>
 
@@ -88,6 +97,8 @@ searchEntryPoint?: SearchEntrypoint;
 
 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.
 
+When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
+
 <b>Signature:</b>
 
 ```typescript
diff --git a/docs-devsite/ai.groundingsupport.md b/docs-devsite/ai.groundingsupport.md
@@ -12,6 +12,8 @@ https://github.com/firebase/firebase-js-sdk
 # GroundingSupport interface
 Provides information about how a specific segment of the model's response is supported by the retrieved grounding chunks.
 
+When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
+
 <b>Signature:</b>
 
 ```typescript
diff --git a/docs-devsite/ai.md b/docs-devsite/ai.md
@@ -98,9 +98,9 @@ The Firebase AI Web SDK.
 |  [GoogleSearch](./ai.googlesearch.md#googlesearch_interface) | Configuration for the [GoogleSearchTool](./ai.googlesearchtool.md#googlesearchtool_interface)<!-- -->. |
 |  [GoogleSearchTool](./ai.googlesearchtool.md#googlesearchtool_interface) | A tool that allows the generative model to connect to Google Search to access and incorporate up-to-date information from the web into its responses.<!-- -->When this tool is used, the model's responses may include "Grounded Results" which are subject to the Grounding with Google Search terms outlined in the [Service Specific Terms](https://cloud.google.com/terms/service-terms)<!-- -->. |
 |  [GroundingAttribution](./ai.groundingattribution.md#groundingattribution_interface) |  |
-|  [GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface) | Represents a chunk of retrieved data that supports a claim in the model's response. This is part of the grounding information provided when grounding is enabled. |
-|  [GroundingMetadata](./ai.groundingmetadata.md#groundingmetadata_interface) | Metadata returned to client when grounding is enabled. |
-|  [GroundingSupport](./ai.groundingsupport.md#groundingsupport_interface) | Provides information about how a specific segment of the model's response is supported by the retrieved grounding chunks. |
+|  [GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface) | Represents a chunk of retrieved data that supports a claim in the model's response. This is part of the grounding information provided when grounding is enabled.<!-- -->When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search". |
+|  [GroundingMetadata](./ai.groundingmetadata.md#groundingmetadata_interface) | Metadata returned to client when grounding is enabled.<!-- -->If using Grounding with Google Search, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search". |
+|  [GroundingSupport](./ai.groundingsupport.md#groundingsupport_interface) | Provides information about how a specific segment of the model's response is supported by the retrieved grounding chunks.<!-- -->When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search". |
 |  [ImagenGCSImage](./ai.imagengcsimage.md#imagengcsimage_interface) | An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.<!-- -->This feature is not available yet. |
 |  [ImagenGenerationConfig](./ai.imagengenerationconfig.md#imagengenerationconfig_interface) | <b><i>(Public Preview)</i></b> Configuration options for generating images with Imagen.<!-- -->See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images-imagen) for more details. |
 |  [ImagenGenerationResponse](./ai.imagengenerationresponse.md#imagengenerationresponse_interface) | <b><i>(Public Preview)</i></b> The response from a request to generate images with Imagen. |
@@ -120,7 +120,7 @@ The Firebase AI Web SDK.
 |  [SchemaParams](./ai.schemaparams.md#schemaparams_interface) | Params passed to [Schema](./ai.schema.md#schema_class) static methods to create specific [Schema](./ai.schema.md#schema_class) classes. |
 |  [SchemaRequest](./ai.schemarequest.md#schemarequest_interface) | Final format for [Schema](./ai.schema.md#schema_class) params passed to backend requests. |
 |  [SchemaShared](./ai.schemashared.md#schemashared_interface) | Basic [Schema](./ai.schema.md#schema_class) properties shared across several Schema-related types. |
-|  [SearchEntrypoint](./ai.searchentrypoint.md#searchentrypoint_interface) | Google search entry point. |
+|  [SearchEntrypoint](./ai.searchentrypoint.md#searchentrypoint_interface) | Google search entry point.<!-- -->When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search". |
 |  [Segment](./ai.segment.md#segment_interface) | Represents a specific segment within a [Content](./ai.content.md#content_interface) object, often used to pinpoint the exact location of text or data that grounding information refers to. |
 |  [StartChatParams](./ai.startchatparams.md#startchatparams_interface) | Params for [GenerativeModel.startChat()](./ai.generativemodel.md#generativemodelstartchat)<!-- -->. |
 |  [TextPart](./ai.textpart.md#textpart_interface) | Content part interface if the part represents a text string. |
@@ -129,7 +129,7 @@ The Firebase AI Web SDK.
 |  [VertexAIOptions](./ai.vertexaioptions.md#vertexaioptions_interface) | Options when initializing the Firebase AI SDK. |
 |  [VideoMetadata](./ai.videometadata.md#videometadata_interface) | Describes the input video content. |
 |  [WebAttribution](./ai.webattribution.md#webattribution_interface) |  |
-|  [WebGroundingChunk](./ai.webgroundingchunk.md#webgroundingchunk_interface) | A grounding chunk from the web. |
+|  [WebGroundingChunk](./ai.webgroundingchunk.md#webgroundingchunk_interface) | A grounding chunk from the web.<!-- -->When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search". |
 
 ## Variables
 
diff --git a/docs-devsite/ai.searchentrypoint.md b/docs-devsite/ai.searchentrypoint.md
@@ -12,6 +12,8 @@ https://github.com/firebase/firebase-js-sdk
 # SearchEntrypoint interface
 Google search entry point.
 
+When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
+
 <b>Signature:</b>
 
 ```typescript
diff --git a/docs-devsite/ai.webgroundingchunk.md b/docs-devsite/ai.webgroundingchunk.md
@@ -12,6 +12,8 @@ https://github.com/firebase/firebase-js-sdk
 # WebGroundingChunk interface
 A grounding chunk from the web.
 
+When using this feature, you are required to comply with the [Service Specific Terms](https://cloud.google.com/terms/service-terms) for "Grounding with Google Search".
+
 <b>Signature:</b>
 
 ```typescript
diff --git a/packages/ai/src/types/responses.ts b/packages/ai/src/types/responses.ts
@@ -173,43 +173,55 @@ export interface Citation {
 /**
  * Metadata returned to client when grounding is enabled.
  *
+ * If using Grounding with Google Search, you are required to comply with the {@link https://cloud.google.com/terms/service-terms | Service Specific Terms} for "Grounding with Google Search".
+ *
  * @public
  */
 export interface GroundingMetadata {
   /**
-   * Google search entry for the following web searches.
-   * An HTML/CSS snippet that can be embedded in a web page to display a Google Search Entry point
-   * for follow-up web searches related to the model's response.
+   * 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 the model's "Grounded Response".
+   *
+   * When using this feature, you are required to comply with the {@link https://cloud.google.com/terms/service-terms | Service Specific Terms} for "Grounding with Google Search".
    */
   searchEntryPoint?: SearchEntrypoint;
   /**
    * A list of {@link GroundingChunk} objects. Each chunk represents a piece of retrieved content
    * (e.g. from a web page). that the model used to ground its response.
+   *
+   * When using this feature, you are required to comply with the {@link https://cloud.google.com/terms/service-terms | Service Specific Terms} for "Grounding with Google Search".
    */
   groundingChunks?: GroundingChunk[];
   /**
    * A list of {@link GroundingSupport} objects. Each object details how specific
    * segments of the model's response are supported by the `groundingChunks`.
+   *
+   * When using this feature, you are required to comply with the {@link https://cloud.google.com/terms/service-terms | Service Specific Terms} for "Grounding with Google Search".
    */
   groundingSupports?: GroundingSupport[];
   /**
    * 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.
+   *
+   * When using this feature, you are required to comply with the {@link https://cloud.google.com/terms/service-terms | Service Specific Terms} for "Grounding with Google Search".
    */
   webSearchQueries?: string[];
   /**
-   * @deprecated Use {@link GroundingMetadata.groundingSupports} instead.
+   * @deprecated Use {@link GroundingSupport} instead.
    */
   retrievalQueries?: string[];
   /**
-   * @deprecated
+   * @deprecated Use {@link GroundingChunk} instead.
    */
   groundingAttributions: GroundingAttribution[];
 }
 
 /**
  * Google search entry point.
  *
+ * When using this feature, you are required to comply with the {@link https://cloud.google.com/terms/service-terms | Service Specific Terms} for "Grounding with Google Search".
+ *
  * @public
  */
 export interface SearchEntrypoint {
@@ -235,6 +247,8 @@ export interface SearchEntrypoint {
  * Represents a chunk of retrieved data that supports a claim in the model's response.
  * This is part of the grounding information provided when grounding is enabled.
  *
+ * When using this feature, you are required to comply with the {@link https://cloud.google.com/terms/service-terms | Service Specific Terms} for "Grounding with Google Search".
+ *
  * @public
  */
 export interface GroundingChunk {
@@ -247,6 +261,8 @@ export interface GroundingChunk {
 /**
  * A grounding chunk from the web.
  *
+ * When using this feature, you are required to comply with the {@link https://cloud.google.com/terms/service-terms | Service Specific Terms} for "Grounding with Google Search".
+ *
  * @public
  */
 export interface WebGroundingChunk {
@@ -275,6 +291,8 @@ export interface WebGroundingChunk {
  * Provides information about how a specific segment of the model's response
  * is supported by the retrieved grounding chunks.
  *
+ * When using this feature, you are required to comply with the {@link https://cloud.google.com/terms/service-terms | Service Specific Terms} for "Grounding with Google Search".
+ *
  * @public
  */
 export interface GroundingSupport {
