add deprecation notices in docs

Author: dlarocque

common/api-review/ai.api.md

@@ -13,7 +13,7 @@ import { FirebaseError } from '@firebase/util';
 export interface AI {
     app: FirebaseApp;
     backend: Backend;
-    // @deprecated
+    // @deprecated (undocumented)
     location: string;
 }
 
@@ -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 (undocumented)
 export function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
 
 // @public
@@ -916,7 +916,7 @@ export interface UsageMetadata {
     totalTokenCount: number;
 }
 
-// @public
+// @public @deprecated (undocumented)
 export type VertexAI = AI;
 
 // @public
@@ -925,10 +925,10 @@ export class VertexAIBackend extends Backend {
     readonly location: string;
 }
 
-// @public
+// @public @deprecated (undocumented)
 export const VertexAIError: typeof AIError;
 
-// @public
+// @public @deprecated (undocumented)
 export const VertexAIModel: typeof AIModel;
 
 // @public

docs-devsite/ai.ai.md

@@ -26,7 +26,7 @@ export interface AI
 |  --- | --- | --- |
 |  [app](./ai.ai.md#aiapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [AI](./ai.ai.md#ai_interface) instance is associated with. |
 |  [backend](./ai.ai.md#aibackend) | [Backend](./ai.backend.md#backend_class) | A [Backend](./ai.backend.md#backend_class) instance that specifies the configuration for the target backend, either the Gemini Developer API (using [GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class)<!-- -->) or the Vertex AI Gemini API (using [VertexAIBackend](./ai.vertexaibackend.md#vertexaibackend_class)<!-- -->). |
-|  [location](./ai.ai.md#ailocation) | string | The location configured for this AI service instance, relevant for Vertex AI backends. |
+|  [location](./ai.ai.md#ailocation) | string |  |
 
 ## AI.app
 
@@ -54,8 +54,8 @@ backend: Backend;
 > 
 > use `AI.backend.location` instead.
 > 
-
-The location configured for this AI service instance, relevant for Vertex AI backends.
+> The location configured for this AI service instance, relevant for Vertex AI backends.
+> 
 
 <b>Signature:</b>
 

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) |  |
 |  <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) |  |
+|  [VertexAIModel](./ai.md#vertexaimodel) |  |
 
 ## 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) |  |
 
 ## function(app, ...)
 
@@ -200,9 +200,12 @@ const ai = getAI(app, { backend: new VertexAIBackend() });
 
 ### getVertexAI(app, options) {:#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.
+> 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.
+> 
 
 <b>Signature:</b>
 
@@ -319,9 +322,12 @@ ResponseModality: {
 
 ## VertexAIError
 
-Error class for the Firebase AI SDK.
-
-For more information, refer to the documentation for the new [AIError](./ai.aierror.md#aierror_class)<!-- -->.
+> 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)<!-- -->.
+> 
+> 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.
-
-For more information, refer to the documentation for the new [AIModel](./ai.aimodel.md#aimodel_class)<!-- -->.
+> 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)<!-- -->.
+> 
+> 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.
-
-For more information, refer to the documentation for the new [AI](./ai.ai.md#ai_interface) interface.
+> 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)<!-- -->.
+> 
+> An instance of the Firebase AI SDK.
+> 
 
 <b>Signature:</b>
 

packages/ai/src/api.ts

@@ -41,19 +41,23 @@ export { Backend, VertexAIBackend, GoogleAIBackend } from './backend';
 export { AIErrorCode as VertexAIErrorCode };
 
 /**
+ * @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}.
+ * 
  * Base class for Firebase AI model APIs.
  *
- * For more information, refer to the documentation for the new {@link AIModel}.
- *
  * @public
  */
 export const VertexAIModel = AIModel;
 
 /**
+ * @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}.
+ * 
  * Error class for the Firebase AI SDK.
- *
- * For more information, refer to the documentation for the new {@link AIError}.
- *
+ * 
  * @public
  */
 export const VertexAIError = AIError;
@@ -65,7 +69,9 @@ declare module '@firebase/component' {
 }
 
 /**
- * It is recommended to use the new {@link getAI | getAI()}.
+ * @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}.
  *
  * Returns a {@link VertexAI} instance for the given app, configured to use the
  * Vertex AI Gemini API. This instance will be

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

@@ -21,9 +21,11 @@ import { Backend } from './backend';
 export * from './types';
 
 /**
- * An instance of the Firebase AI SDK.
+ * @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}.
  *
- * For more information, refer to the documentation for the new {@link AI} interface.
+ * An instance of the Firebase AI SDK.
  *
  * @public
  */
@@ -57,9 +59,9 @@ export interface AI {
    */
   backend: Backend;
   /**
-   * The location configured for this AI service instance, relevant for Vertex AI backends.
-   *
    * @deprecated use `AI.backend.location` instead.
+   * 
+   * The location configured for this AI service instance, relevant for Vertex AI backends.
    */
   location: string;
 }