diff --git a/.changeset/tricky-geese-shout.md b/.changeset/tricky-geese-shout.md new file mode 100644 index 00000000000..a0b70b4405c --- /dev/null +++ b/.changeset/tricky-geese-shout.md @@ -0,0 +1,5 @@ +--- +'@firebase/vertexai': patch +--- + +Label `GroundingAttribution` as deprecated. diff --git a/common/api-review/vertexai.api.md b/common/api-review/vertexai.api.md index cfe2bcc4c66..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; @@ -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.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/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..437d33e9a47 100644 --- a/packages/vertexai/src/types/responses.ts +++ b/packages/vertexai/src/types/responses.ts @@ -153,10 +153,14 @@ export interface Citation { export interface GroundingMetadata { webSearchQueries?: string[]; retrievalQueries?: string[]; + /** + * @deprecated + */ groundingAttributions: GroundingAttribution[]; } /** + * @deprecated * @public */ export interface GroundingAttribution {