From 3086ed06af9692aeec189d3e672211a4bc6a5469 Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Thu, 6 Mar 2025 14:15:10 -0500 Subject: [PATCH 1/5] Deprecate `GroundingAttribution` --- common/api-review/vertexai.api.md | 2 +- docs-devsite/vertexai.groundingmetadata.md | 4 ++++ packages/vertexai/src/types/responses.ts | 3 +++ 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/common/api-review/vertexai.api.md b/common/api-review/vertexai.api.md index cfe2bcc4c66..411a4519ea0 100644 --- a/common/api-review/vertexai.api.md +++ b/common/api-review/vertexai.api.md @@ -366,7 +366,7 @@ export interface GroundingAttribution { // @public export interface GroundingMetadata { - // (undocumented) + // @deprecated (undocumented) groundingAttributions: GroundingAttribution[]; // (undocumented) retrievalQueries?: string[]; diff --git a/docs-devsite/vertexai.groundingmetadata.md b/docs-devsite/vertexai.groundingmetadata.md index 186f00d29a7..24686da39ba 100644 --- a/docs-devsite/vertexai.groundingmetadata.md +++ b/docs-devsite/vertexai.groundingmetadata.md @@ -28,6 +28,10 @@ export interface GroundingMetadata ## GroundingMetadata.groundingAttributions +> Warning: This API is now obsolete. +> +> + Signature: ```typescript diff --git a/packages/vertexai/src/types/responses.ts b/packages/vertexai/src/types/responses.ts index 5685ed68ad6..08b48fc2794 100644 --- a/packages/vertexai/src/types/responses.ts +++ b/packages/vertexai/src/types/responses.ts @@ -153,6 +153,9 @@ export interface Citation { export interface GroundingMetadata { webSearchQueries?: string[]; retrievalQueries?: string[]; + /** + * @deprecated + */ groundingAttributions: GroundingAttribution[]; } From e05f5420e80c7b46b613433f14f6d3a48f53029e Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Thu, 6 Mar 2025 14:21:40 -0500 Subject: [PATCH 2/5] Add changeset --- .changeset/tricky-geese-shout.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/tricky-geese-shout.md diff --git a/.changeset/tricky-geese-shout.md b/.changeset/tricky-geese-shout.md new file mode 100644 index 00000000000..05683843d9e --- /dev/null +++ b/.changeset/tricky-geese-shout.md @@ -0,0 +1,5 @@ +--- +'@firebase/vertexai': minor +--- + +Deprecate `GroundingAttribution`. From fe6f4157f1473f8fd94d6e2e732f6e35d06eeefd Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Thu, 6 Mar 2025 15:18:46 -0500 Subject: [PATCH 3/5] Adjust chanageset to a patch --- .changeset/tricky-geese-shout.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.changeset/tricky-geese-shout.md b/.changeset/tricky-geese-shout.md index 05683843d9e..bf5310c88c6 100644 --- a/.changeset/tricky-geese-shout.md +++ b/.changeset/tricky-geese-shout.md @@ -1,5 +1,5 @@ --- -'@firebase/vertexai': minor +'@firebase/vertexai': patch --- -Deprecate `GroundingAttribution`. +Mark `GroundingAttribution` as deprecated. From f2a2bcffd4b27ed73c842ef17d0c22a2d018708c Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Thu, 6 Mar 2025 15:19:17 -0500 Subject: [PATCH 4/5] Reword :) --- .changeset/tricky-geese-shout.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/tricky-geese-shout.md b/.changeset/tricky-geese-shout.md index bf5310c88c6..a0b70b4405c 100644 --- a/.changeset/tricky-geese-shout.md +++ b/.changeset/tricky-geese-shout.md @@ -2,4 +2,4 @@ '@firebase/vertexai': patch --- -Mark `GroundingAttribution` as deprecated. +Label `GroundingAttribution` as deprecated. From 3a0299c66e9d387f70386ba27d5f0ae644be43ce Mon Sep 17 00:00:00 2001 From: Daniel La Rocque Date: Mon, 17 Mar 2025 13:25:01 -0400 Subject: [PATCH 5/5] Add `@deprecated` to `GroudingAttribution` interface. --- common/api-review/vertexai.api.md | 2 +- docs-devsite/vertexai.groundingattribution.md | 3 +++ packages/vertexai/src/types/responses.ts | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/common/api-review/vertexai.api.md b/common/api-review/vertexai.api.md index 411a4519ea0..f5aca03c1bd 100644 --- a/common/api-review/vertexai.api.md +++ b/common/api-review/vertexai.api.md @@ -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; diff --git a/docs-devsite/vertexai.groundingattribution.md b/docs-devsite/vertexai.groundingattribution.md index b72d8150635..b3a3b6257c3 100644 --- a/docs-devsite/vertexai.groundingattribution.md +++ b/docs-devsite/vertexai.groundingattribution.md @@ -10,6 +10,9 @@ https://github.com/firebase/firebase-js-sdk {% endcomment %} # GroundingAttribution interface +> Warning: This API is now obsolete. +> +> Signature: diff --git a/packages/vertexai/src/types/responses.ts b/packages/vertexai/src/types/responses.ts index 08b48fc2794..437d33e9a47 100644 --- a/packages/vertexai/src/types/responses.ts +++ b/packages/vertexai/src/types/responses.ts @@ -160,6 +160,7 @@ export interface GroundingMetadata { } /** + * @deprecated * @public */ export interface GroundingAttribution {