add deprecation notices in docs

Author: dlarocque

common/api-review/ai.api.md

@@ -423,7 +423,7 @@ export function getGenerativeModel(ai: AI, modelParams: ModelParams, requestOpti
 // @beta
 export function getImagenModel(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions): ImagenModel;
 
-// @public
+// @public @deprecated
 export function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
 
 // @public
@@ -916,7 +916,7 @@ export interface UsageMetadata {
     totalTokenCount: number;
 }
 
-// @public
+// @public @deprecated
 export type VertexAI = AI;
 
 // @public
@@ -925,10 +925,10 @@ export class VertexAIBackend extends Backend {
     readonly location: string;
 }
 
-// @public
+// @public @deprecated
 export const VertexAIError: typeof AIError;
 
-// @public
+// @public @deprecated
 export const VertexAIModel: typeof AIModel;
 
 // @public

docs-devsite/ai.md

@@ -18,7 +18,7 @@ The Firebase AI Web SDK.
 |  --- | --- |
 |  <b>function(app, ...)</b> |
 |  [getAI(app, options)](./ai.md#getai_a94a413) | Returns the default [AI](./ai.ai.md#ai_interface) instance that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. If no instance exists, initializes a new instance with the default settings. |
-|  [getVertexAI(app, options)](./ai.md#getvertexai_04094cf) | It is recommended to use the new [getAI()](./ai.md#getai_a94a413)<!-- -->.<!-- -->Returns a [VertexAI](./ai.md#vertexai) instance for the given app, configured to use the Vertex AI Gemini API. This instance will be configured to use the Vertex AI Gemini API. |
+|  [getVertexAI(app, options)](./ai.md#getvertexai_04094cf) | Returns a [VertexAI](./ai.md#vertexai) instance for the given app, configured to use the Vertex AI Gemini API. This instance will be configured to use the Vertex AI Gemini API. |
 |  <b>function(ai, ...)</b> |
 |  [getGenerativeModel(ai, modelParams, requestOptions)](./ai.md#getgenerativemodel_80bd839) | Returns a [GenerativeModel](./ai.generativemodel.md#generativemodel_class) class with methods for inference and other functionality. |
 |  [getImagenModel(ai, modelParams, requestOptions)](./ai.md#getimagenmodel_e1f6645) | <b><i>(Public Preview)</i></b> Returns an [ImagenModel](./ai.imagenmodel.md#imagenmodel_class) class with methods for using Imagen.<!-- -->Only Imagen 3 models (named <code>imagen-3.0-*</code>) are supported. |
@@ -132,8 +132,8 @@ The Firebase AI Web SDK.
 |  [BackendType](./ai.md#backendtype) | An enum-like object containing constants that represent the supported backends for the Firebase AI SDK. This determines which backend service (Vertex AI Gemini API or Gemini Developer API) the SDK will communicate with.<!-- -->These values are assigned to the <code>backendType</code> property within the specific backend configuration objects ([GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class) or [VertexAIBackend](./ai.vertexaibackend.md#vertexaibackend_class)<!-- -->) to identify which service to target. |
 |  [POSSIBLE\_ROLES](./ai.md#possible_roles) | Possible roles. |
 |  [ResponseModality](./ai.md#responsemodality) | <b><i>(Public Preview)</i></b> Generation modalities to be returned in generation responses. |
-|  [VertexAIError](./ai.md#vertexaierror) | Error class for the Firebase AI SDK.<!-- -->For more information, refer to the documentation for the new [AIError](./ai.aierror.md#aierror_class)<!-- -->. |
-|  [VertexAIModel](./ai.md#vertexaimodel) | Base class for Firebase AI model APIs.<!-- -->For more information, refer to the documentation for the new [AIModel](./ai.aimodel.md#aimodel_class)<!-- -->. |
+|  [VertexAIError](./ai.md#vertexaierror) | Error class for the Firebase AI SDK. |
+|  [VertexAIModel](./ai.md#vertexaimodel) | Base class for Firebase AI model APIs. |
 
 ## Type Aliases
 
@@ -145,7 +145,7 @@ The Firebase AI Web SDK.
 |  [Role](./ai.md#role) | Role is the producer of the content. |
 |  [Tool](./ai.md#tool) | Defines a tool that model can call to access external knowledge. |
 |  [TypedSchema](./ai.md#typedschema) | A type that includes all specific Schema types. |
-|  [VertexAI](./ai.md#vertexai) | An instance of the Firebase AI SDK.<!-- -->For more information, refer to the documentation for the new [AI](./ai.ai.md#ai_interface) interface. |
+|  [VertexAI](./ai.md#vertexai) | An instance of the Firebase AI SDK. |
 
 ## function(app, ...)
 
@@ -200,7 +200,10 @@ const ai = getAI(app, { backend: new VertexAIBackend() });
 
 ### getVertexAI(app, options) {:#getvertexai_04094cf}
 
-It is recommended to use the new [getAI()](./ai.md#getai_a94a413)<!-- -->.
+> Warning: This API is now obsolete.
+> 
+> Use the new [getAI()](./ai.md#getai_a94a413) instead. The Vertex AI in Firebase SDK has been replaced with the Firebase AI SDK to accommodate the evolving set of supported features and services. For migration details, see the [migration guide](https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk)<!-- -->.
+> 
 
 Returns a [VertexAI](./ai.md#vertexai) instance for the given app, configured to use the Vertex AI Gemini API. This instance will be configured to use the Vertex AI Gemini API.
 
@@ -319,9 +322,12 @@ ResponseModality: {
 
 ## VertexAIError
 
-Error class for the Firebase AI SDK.
+> Warning: This API is now obsolete.
+> 
+> Use the new [AIError](./ai.aierror.md#aierror_class) instead. The Vertex AI in Firebase SDK has been replaced with the Firebase AI SDK to accommodate the evolving set of supported features and services. For migration details, see the [migration guide](https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk)<!-- -->.
+> 
 
-For more information, refer to the documentation for the new [AIError](./ai.aierror.md#aierror_class)<!-- -->.
+Error class for the Firebase AI SDK.
 
 <b>Signature:</b>
 
@@ -331,9 +337,12 @@ VertexAIError: typeof AIError
 
 ## VertexAIModel
 
-Base class for Firebase AI model APIs.
+> Warning: This API is now obsolete.
+> 
+> Use the new [AIModel](./ai.aimodel.md#aimodel_class) instead. The Vertex AI in Firebase SDK has been replaced with the Firebase AI SDK to accommodate the evolving set of supported features and services. For migration details, see the [migration guide](https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk)<!-- -->.
+> 
 
-For more information, refer to the documentation for the new [AIModel](./ai.aimodel.md#aimodel_class)<!-- -->.
+Base class for Firebase AI model APIs.
 
 <b>Signature:</b>
 
@@ -406,9 +415,12 @@ export type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanS
 
 ## VertexAI
 
-An instance of the Firebase AI SDK.
+> Warning: This API is now obsolete.
+> 
+> Use the new [AI](./ai.ai.md#ai_interface) instead. The Vertex AI in Firebase SDK has been replaced with the Firebase AI SDK to accommodate the evolving set of supported features and services. For migration details, see the [migration guide](https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk)<!-- -->.
+> 
 
-For more information, refer to the documentation for the new [AI](./ai.ai.md#ai_interface) interface.
+An instance of the Firebase AI SDK.
 
 <b>Signature:</b>
 

packages/ai/src/api.ts

@@ -43,7 +43,9 @@ export { AIErrorCode as VertexAIErrorCode };
 /**
  * Base class for Firebase AI model APIs.
  *
- * For more information, refer to the documentation for the new {@link AIModel}.
+ * @deprecated Use the new {@link AIModel} instead. The Vertex AI in Firebase SDK has been
+ * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
+ * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
  *
  * @public
  */
@@ -52,7 +54,9 @@ export const VertexAIModel = AIModel;
 /**
  * Error class for the Firebase AI SDK.
  *
- * For more information, refer to the documentation for the new {@link AIError}.
+ * @deprecated Use the new {@link AIError} instead. The Vertex AI in Firebase SDK has been
+ * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
+ * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
  *
  * @public
  */
@@ -65,12 +69,14 @@ declare module '@firebase/component' {
 }
 
 /**
- * It is recommended to use the new {@link getAI | getAI()}.
- *
  * Returns a {@link VertexAI} instance for the given app, configured to use the
  * Vertex AI Gemini API. This instance will be
  * configured to use the Vertex AI Gemini API.
  *
+ * @deprecated Use the new {@link getAI | getAI()} instead. The Vertex AI in Firebase SDK has been
+ * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
+ * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
+ *
  * @param app - The {@link @firebase/app#FirebaseApp} to use.
  * @param options - Options to configure the Vertex AI instance, including the location.
  *

packages/ai/src/constants.ts

@@ -17,9 +17,6 @@
 
 import { version } from '../package.json';
 
-// TODO (v12): Remove this
-export const VERTEX_TYPE = 'vertexAI';
-
 export const AI_TYPE = 'AI';
 
 export const DEFAULT_LOCATION = 'us-central1';

packages/ai/src/public-types.ts

@@ -23,7 +23,9 @@ export * from './types';
 /**
  * An instance of the Firebase AI SDK.
  *
- * For more information, refer to the documentation for the new {@link AI} interface.
+ * @deprecated Use the new {@link AI | AI} instead. The Vertex AI in Firebase SDK has been
+ * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
+ * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
  *
  * @public
  */