diff --git a/.changeset/slimy-mirrors-nail.md b/.changeset/slimy-mirrors-nail.md new file mode 100644 index 00000000000..56877ee8ba2 --- /dev/null +++ b/.changeset/slimy-mirrors-nail.md @@ -0,0 +1,6 @@ +--- +'firebase': major +'@firebase/ai': major +--- + +Remove GroundingAttribution diff --git a/common/api-review/ai.api.md b/common/api-review/ai.api.md index ba93f2765fb..c835bfb24b3 100644 --- a/common/api-review/ai.api.md +++ b/common/api-review/ai.api.md @@ -489,18 +489,6 @@ export interface GoogleSearchTool { googleSearch: GoogleSearch; } -// @public @deprecated (undocumented) -export interface GroundingAttribution { - // (undocumented) - confidenceScore?: number; - // (undocumented) - retrievedContext?: RetrievedContextAttribution; - // (undocumented) - segment: Segment; - // (undocumented) - web?: WebAttribution; -} - // @public export interface GroundingChunk { web?: WebGroundingChunk; @@ -508,8 +496,6 @@ export interface GroundingChunk { // @public export interface GroundingMetadata { - // @deprecated (undocumented) - groundingAttributions: GroundingAttribution[]; groundingChunks?: GroundingChunk[]; groundingSupports?: GroundingSupport[]; // @deprecated (undocumented) diff --git a/docs-devsite/_toc.yaml b/docs-devsite/_toc.yaml index 495567e6092..e2486c01d75 100644 --- a/docs-devsite/_toc.yaml +++ b/docs-devsite/_toc.yaml @@ -80,8 +80,6 @@ toc: path: /docs/reference/js/ai.googlesearch.md - title: GoogleSearchTool path: /docs/reference/js/ai.googlesearchtool.md - - title: GroundingAttribution - path: /docs/reference/js/ai.groundingattribution.md - title: GroundingChunk path: /docs/reference/js/ai.groundingchunk.md - title: GroundingMetadata diff --git a/docs-devsite/ai.groundingattribution.md b/docs-devsite/ai.groundingattribution.md deleted file mode 100644 index a0895550bf1..00000000000 --- a/docs-devsite/ai.groundingattribution.md +++ /dev/null @@ -1,62 +0,0 @@ -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 %} - -# GroundingAttribution interface -> Warning: This API is now obsolete. -> -> - -Signature: - -```typescript -export interface GroundingAttribution -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [confidenceScore](./ai.groundingattribution.md#groundingattributionconfidencescore) | number | | -| [retrievedContext](./ai.groundingattribution.md#groundingattributionretrievedcontext) | [RetrievedContextAttribution](./ai.retrievedcontextattribution.md#retrievedcontextattribution_interface) | | -| [segment](./ai.groundingattribution.md#groundingattributionsegment) | [Segment](./ai.segment.md#segment_interface) | | -| [web](./ai.groundingattribution.md#groundingattributionweb) | [WebAttribution](./ai.webattribution.md#webattribution_interface) | | - -## GroundingAttribution.confidenceScore - -Signature: - -```typescript -confidenceScore?: number; -``` - -## GroundingAttribution.retrievedContext - -Signature: - -```typescript -retrievedContext?: RetrievedContextAttribution; -``` - -## GroundingAttribution.segment - -Signature: - -```typescript -segment: Segment; -``` - -## GroundingAttribution.web - -Signature: - -```typescript -web?: WebAttribution; -``` diff --git a/docs-devsite/ai.groundingmetadata.md b/docs-devsite/ai.groundingmetadata.md index 52c963eb581..a9605aaf1dd 100644 --- a/docs-devsite/ai.groundingmetadata.md +++ b/docs-devsite/ai.groundingmetadata.md @@ -26,26 +26,12 @@ 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 (for example, 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 groundingChunks. | | [retrievalQueries](./ai.groundingmetadata.md#groundingmetadataretrievalqueries) | string\[\] | | | [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 a model's “Grounded 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. | -## GroundingMetadata.groundingAttributions - -> Warning: This API is now obsolete. -> -> Use [GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface) instead. -> - -Signature: - -```typescript -groundingAttributions: GroundingAttribution[]; -``` - ## GroundingMetadata.groundingChunks A list of [GroundingChunk](./ai.groundingchunk.md#groundingchunk_interface) objects. Each chunk represents a piece of retrieved content (for example, from a web page). that the model used to ground its response. diff --git a/docs-devsite/ai.md b/docs-devsite/ai.md index 2f695e88cf8..7f6698b9249 100644 --- a/docs-devsite/ai.md +++ b/docs-devsite/ai.md @@ -96,7 +96,6 @@ The Firebase AI Web SDK. | [GenerativeContentBlob](./ai.generativecontentblob.md#generativecontentblob_interface) | Interface for sending an image. | | [GoogleSearch](./ai.googlesearch.md#googlesearch_interface) | Specifies the Google Search configuration. | | [GoogleSearchTool](./ai.googlesearchtool.md#googlesearchtool_interface) | A tool that allows a Gemini model to connect to Google Search to access and incorporate up-to-date information from the web into its responses.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](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or Vertex AI Gemini API (see [Service Terms](https://cloud.google.com/terms/service-terms) section within the Service Specific 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 when grounding is enabled.Currently, only Grounding with Google Search is supported (see [GoogleSearchTool](./ai.googlesearchtool.md#googlesearchtool_interface)).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](https://ai.google.dev/gemini-api/terms#grounding-with-google-search) or Vertex AI Gemini API (see [Service Terms](https://cloud.google.com/terms/service-terms) section within the Service Specific Terms). | | [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. | diff --git a/packages/ai/src/types/responses.ts b/packages/ai/src/types/responses.ts index 5fab203600d..f85c8034e00 100644 --- a/packages/ai/src/types/responses.ts +++ b/packages/ai/src/types/responses.ts @@ -212,10 +212,6 @@ export interface GroundingMetadata { * @deprecated Use {@link GroundingSupport} instead. */ retrievalQueries?: string[]; - /** - * @deprecated Use {@link GroundingChunk} instead. - */ - groundingAttributions: GroundingAttribution[]; } /** @@ -334,17 +330,6 @@ export interface Segment { text: string; } -/** - * @deprecated - * @public - */ -export interface GroundingAttribution { - segment: Segment; - confidenceScore?: number; - web?: WebAttribution; - retrievedContext?: RetrievedContextAttribution; -} - /** * @public */