Skip to content

Deprecate GroundingAttribution #8832

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 20, 2025
Merged

Deprecate GroundingAttribution #8832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3086ed0
Deprecate `GroundingAttribution`
dlarocque Mar 6, 2025
e05f542
Add changeset
dlarocque Mar 6, 2025
fe6f415
Adjust chanageset to a patch
dlarocque Mar 6, 2025
f2a2bcf
Reword :)
dlarocque Mar 6, 2025
3a0299c
Add `@deprecated` to `GroudingAttribution` interface.
dlarocque Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tricky-geese-shout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@firebase/vertexai': patch
---

Label `GroundingAttribution` as deprecated.
4 changes: 2 additions & 2 deletions common/api-review/vertexai.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ export function getImagenModel(vertexAI: VertexAI, modelParams: ImagenModelParam
// @public
export function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;

// @public (undocumented)
// @public @deprecated (undocumented)
export interface GroundingAttribution {
// (undocumented)
confidenceScore?: number;
Expand All @@ -366,7 +366,7 @@ export interface GroundingAttribution {

// @public
export interface GroundingMetadata {
// (undocumented)
// @deprecated (undocumented)
groundingAttributions: GroundingAttribution[];
// (undocumented)
retrievalQueries?: string[];
Expand Down
3 changes: 3 additions & 0 deletions docs-devsite/vertexai.groundingattribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# GroundingAttribution interface
> Warning: This API is now obsolete.
>
>

<b>Signature:</b>

Expand Down
4 changes: 4 additions & 0 deletions docs-devsite/vertexai.groundingmetadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ export interface GroundingMetadata

## GroundingMetadata.groundingAttributions

> Warning: This API is now obsolete.
>
>

<b>Signature:</b>

```typescript
Expand Down
4 changes: 4 additions & 0 deletions packages/vertexai/src/types/responses.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,10 +153,14 @@ export interface Citation {
export interface GroundingMetadata {
webSearchQueries?: string[];
retrievalQueries?: string[];
/**
* @deprecated
*/
groundingAttributions: GroundingAttribution[];
}

/**
* @deprecated
* @public
*/
export interface GroundingAttribution {
Expand Down
Loading