Convert GenAI to new Firebase AI naming

Author: dlarocque

common/api-review/vertexai.api.md

@@ -9,6 +9,62 @@ import { FirebaseApp } from '@firebase/app';
 import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
 import { FirebaseError } from '@firebase/util';
 
+// @public
+export interface AI {
+    app: FirebaseApp;
+    backend: Backend;
+    // @deprecated
+    location: string;
+}
+
+// @public
+export class AIError extends FirebaseError {
+    constructor(code: AIErrorCode, message: string, customErrorData?: CustomErrorData | undefined);
+    // (undocumented)
+    readonly code: AIErrorCode;
+    // (undocumented)
+    readonly customErrorData?: CustomErrorData | undefined;
+}
+
+// @public
+const enum AIErrorCode {
+    API_NOT_ENABLED = "api-not-enabled",
+    ERROR = "error",
+    FETCH_ERROR = "fetch-error",
+    INVALID_CONTENT = "invalid-content",
+    INVALID_SCHEMA = "invalid-schema",
+    NO_API_KEY = "no-api-key",
+    NO_APP_ID = "no-app-id",
+    NO_MODEL = "no-model",
+    NO_PROJECT_ID = "no-project-id",
+    PARSE_FAILED = "parse-failed",
+    REQUEST_ERROR = "request-error",
+    RESPONSE_ERROR = "response-error",
+    UNSUPPORTED = "unsupported"
+}
+
+export { AIErrorCode }
+
+export { AIErrorCode as VertexAIErrorCode }
+
+// @public
+export abstract class AIModel {
+    // @internal
+    protected constructor(ai: AI, modelName: string);
+    // Warning: (ae-forgotten-export) The symbol "ApiSettings" needs to be exported by the entry point index.d.ts
+    //
+    // @internal (undocumented)
+    protected _apiSettings: ApiSettings;
+    readonly model: string;
+    // @internal
+    static normalizeModelName(modelName: string, backendType: BackendType): string;
+    }
+
+// @public
+export interface AIOptions {
+    backend: Backend;
+}
+
 // @public
 export class ArraySchema extends Schema {
     constructor(schemaParams: SchemaParams, items: TypedSchema);
@@ -53,7 +109,6 @@ export class BooleanSchema extends Schema {
 
 // @public
 export class ChatSession {
-    // Warning: (ae-forgotten-export) The symbol "ApiSettings" needs to be exported by the entry point index.d.ts
     constructor(apiSettings: ApiSettings, model: string, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
     getHistory(): Promise<Content[]>;
     // (undocumented)
@@ -251,60 +306,6 @@ export interface FunctionResponsePart {
     text?: never;
 }
 
-// @public
-export interface GenAI {
-    app: FirebaseApp;
-    backend: Backend;
-    // @deprecated
-    location: string;
-}
-
-// @public
-export class GenAIError extends FirebaseError {
-    constructor(code: GenAIErrorCode, message: string, customErrorData?: CustomErrorData | undefined);
-    // (undocumented)
-    readonly code: GenAIErrorCode;
-    // (undocumented)
-    readonly customErrorData?: CustomErrorData | undefined;
-}
-
-// @public
-const enum GenAIErrorCode {
-    API_NOT_ENABLED = "api-not-enabled",
-    ERROR = "error",
-    FETCH_ERROR = "fetch-error",
-    INVALID_CONTENT = "invalid-content",
-    INVALID_SCHEMA = "invalid-schema",
-    NO_API_KEY = "no-api-key",
-    NO_APP_ID = "no-app-id",
-    NO_MODEL = "no-model",
-    NO_PROJECT_ID = "no-project-id",
-    PARSE_FAILED = "parse-failed",
-    REQUEST_ERROR = "request-error",
-    RESPONSE_ERROR = "response-error",
-    UNSUPPORTED = "unsupported"
-}
-
-export { GenAIErrorCode }
-
-export { GenAIErrorCode as VertexAIErrorCode }
-
-// @public
-export abstract class GenAIModel {
-    // @internal
-    protected constructor(genAI: GenAI, modelName: string);
-    // @internal (undocumented)
-    protected _apiSettings: ApiSettings;
-    readonly model: string;
-    // @internal
-    static normalizeModelName(modelName: string, backendType: BackendType): string;
-    }
-
-// @public
-export interface GenAIOptions {
-    backend: Backend;
-}
-
 // @public
 export interface GenerateContentCandidate {
     // (undocumented)
@@ -389,8 +390,8 @@ export interface GenerativeContentBlob {
 }
 
 // @public
-export class GenerativeModel extends GenAIModel {
-    constructor(genAI: GenAI, modelParams: ModelParams, requestOptions?: RequestOptions);
+export class GenerativeModel extends AIModel {
+    constructor(ai: AI, modelParams: ModelParams, requestOptions?: RequestOptions);
     countTokens(request: CountTokensRequest | string | Array<string | Part>): Promise<CountTokensResponse>;
     generateContent(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentResult>;
     generateContentStream(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentStreamResult>;
@@ -410,13 +411,13 @@ export class GenerativeModel extends GenAIModel {
 }
 
 // @public
-export function getGenAI(app?: FirebaseApp, options?: GenAIOptions): GenAI;
+export function getAI(app?: FirebaseApp, options?: AIOptions): AI;
 
 // @public
-export function getGenerativeModel(genAI: GenAI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
+export function getGenerativeModel(ai: AI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
 
 // @beta
-export function getImagenModel(genAI: GenAI, modelParams: ImagenModelParams, requestOptions?: RequestOptions): ImagenModel;
+export function getImagenModel(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions): ImagenModel;
 
 // @public
 export function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
@@ -539,8 +540,8 @@ export interface ImagenInlineImage {
 }
 
 // @beta
-export class ImagenModel extends GenAIModel {
-    constructor(genAI: GenAI, modelParams: ImagenModelParams, requestOptions?: RequestOptions | undefined);
+export class ImagenModel extends AIModel {
+    constructor(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions | undefined);
     generateImages(prompt: string): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
     // @internal
     generateImagesGCS(prompt: string, gcsURI: string): Promise<ImagenGenerationResponse<ImagenGCSImage>>;
@@ -856,7 +857,7 @@ export interface UsageMetadata {
 }
 
 // @public
-export type VertexAI = GenAI;
+export type VertexAI = AI;
 
 // @public
 export type VertexAIBackend = {
@@ -868,10 +869,10 @@ export type VertexAIBackend = {
 export function vertexAIBackend(location?: string): VertexAIBackend;
 
 // @public
-export const VertexAIError: typeof GenAIError;
+export const VertexAIError: typeof AIError;
 
 // @public
-export const VertexAIModel: typeof GenAIModel;
+export const VertexAIModel: typeof AIModel;
 
 // @public
 export interface VertexAIOptions {

docs-devsite/_toc.yaml

@@ -472,6 +472,14 @@ toc:
 - title: vertexai
   path: /docs/reference/js/vertexai.md
   section:
+  - title: AI
+    path: /docs/reference/js/vertexai.ai.md
+  - title: AIError
+    path: /docs/reference/js/vertexai.aierror.md
+  - title: AIModel
+    path: /docs/reference/js/vertexai.aimodel.md
+  - title: AIOptions
+    path: /docs/reference/js/vertexai.aioptions.md
   - title: ArraySchema
     path: /docs/reference/js/vertexai.arrayschema.md
   - title: BaseParams
@@ -516,14 +524,6 @@ toc:
     path: /docs/reference/js/vertexai.functionresponse.md
   - title: FunctionResponsePart
     path: /docs/reference/js/vertexai.functionresponsepart.md
-  - title: GenAI
-    path: /docs/reference/js/vertexai.genai.md
-  - title: GenAIError
-    path: /docs/reference/js/vertexai.genaierror.md
-  - title: GenAIModel
-    path: /docs/reference/js/vertexai.genaimodel.md
-  - title: GenAIOptions
-    path: /docs/reference/js/vertexai.genaioptions.md
   - title: GenerateContentCandidate
     path: /docs/reference/js/vertexai.generatecontentcandidate.md
   - title: GenerateContentRequest

docs-devsite/index.md

@@ -27,5 +27,5 @@ https://github.com/firebase/firebase-js-sdk
 |  [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment. |
 |  [@firebase/remote-config](./remote-config.md#remote-config_package) | The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environment. |
 |  [@firebase/storage](./storage.md#storage_package) | Cloud Storage for Firebase |
-|  [@firebase/vertexai](./vertexai.md#vertexai_package) | The Vertex AI in Firebase Web SDK. |
+|  [@firebase/vertexai](./vertexai.md#vertexai_package) | The Firebase AI Web SDK. |
 

docs-devsite/vertexai.ai.md

@@ -0,0 +1,64 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# AI interface
+An instance of the Firebase AI SDK.
+
+Do not create this instance directly. Instead, use [getAI()](./vertexai.md#getai_a94a413)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export interface AI 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [app](./vertexai.ai.md#aiapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [AI](./vertexai.ai.md#ai_interface) instance is associated with. |
+|  [backend](./vertexai.ai.md#aibackend) | [Backend](./vertexai.md#backend) | A [Backend](./vertexai.md#backend) instance that specifies the backend configuration. |
+|  [location](./vertexai.ai.md#ailocation) | string | The location configured for this AI service instance, relevant for Vertex AI backends. |
+
+## AI.app
+
+The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [AI](./vertexai.ai.md#ai_interface) instance is associated with.
+
+<b>Signature:</b>
+
+```typescript
+app: FirebaseApp;
+```
+
+## AI.backend
+
+A [Backend](./vertexai.md#backend) instance that specifies the backend configuration.
+
+<b>Signature:</b>
+
+```typescript
+backend: Backend;
+```
+
+## AI.location
+
+> Warning: This API is now obsolete.
+> 
+> use `AI.backend.location` instead.
+> 
+
+The location configured for this AI service instance, relevant for Vertex AI backends.
+
+<b>Signature:</b>
+
+```typescript
+location: string;
+```

docs-devsite/vertexai.genaierror.md renamed to docs-devsite/vertexai.aierror.md

@@ -9,56 +9,56 @@ overwritten. Changes should be made in the source code at
 https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
-# GenAIError class
-Error class for the Vertex AI in Firebase SDK.
+# AIError class
+Error class for the Firebase AI SDK.
 
 <b>Signature:</b>
 
 ```typescript
-export declare class GenAIError extends FirebaseError 
+export declare class AIError extends FirebaseError 
 ```
 <b>Extends:</b> [FirebaseError](./util.firebaseerror.md#firebaseerror_class)
 
 ## Constructors
 
 |  Constructor | Modifiers | Description |
 |  --- | --- | --- |
-|  [(constructor)(code, message, customErrorData)](./vertexai.genaierror.md#genaierrorconstructor) |  | Constructs a new instance of the <code>GenAIError</code> class. |
+|  [(constructor)(code, message, customErrorData)](./vertexai.aierror.md#aierrorconstructor) |  | Constructs a new instance of the <code>AIError</code> class. |
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [code](./vertexai.genaierror.md#genaierrorcode) |  | [GenAIErrorCode](./vertexai.md#genaierrorcode) |  |
-|  [customErrorData](./vertexai.genaierror.md#genaierrorcustomerrordata) |  | [CustomErrorData](./vertexai.customerrordata.md#customerrordata_interface) \| undefined |  |
+|  [code](./vertexai.aierror.md#aierrorcode) |  | [AIErrorCode](./vertexai.md#aierrorcode) |  |
+|  [customErrorData](./vertexai.aierror.md#aierrorcustomerrordata) |  | [CustomErrorData](./vertexai.customerrordata.md#customerrordata_interface) \| undefined |  |
 
-## GenAIError.(constructor)
+## AIError.(constructor)
 
-Constructs a new instance of the `GenAIError` class.
+Constructs a new instance of the `AIError` class.
 
 <b>Signature:</b>
 
 ```typescript
-constructor(code: GenAIErrorCode, message: string, customErrorData?: CustomErrorData | undefined);
+constructor(code: AIErrorCode, message: string, customErrorData?: CustomErrorData | undefined);
 ```
 
 #### Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  code | [GenAIErrorCode](./vertexai.md#genaierrorcode) | The error code from [GenAIErrorCode](./vertexai.md#genaierrorcode)<!-- -->. |
+|  code | [AIErrorCode](./vertexai.md#aierrorcode) | The error code from [AIErrorCode](./vertexai.md#aierrorcode)<!-- -->. |
 |  message | string | A human-readable message describing the error. |
 |  customErrorData | [CustomErrorData](./vertexai.customerrordata.md#customerrordata_interface) \| undefined | Optional error data. |
 
-## GenAIError.code
+## AIError.code
 
 <b>Signature:</b>
 
 ```typescript
-readonly code: GenAIErrorCode;
+readonly code: AIErrorCode;
 ```
 
-## GenAIError.customErrorData
+## AIError.customErrorData
 
 <b>Signature:</b>
 

docs-devsite/vertexai.genaimodel.md renamed to docs-devsite/vertexai.aimodel.md

@@ -9,24 +9,24 @@ overwritten. Changes should be made in the source code at
 https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
-# GenAIModel class
-Base class for Vertex AI in Firebase model APIs.
+# AIModel class
+Base class for Firebase AI model APIs.
 
-The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `GenAIModel` class.
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AIModel` class.
 
 <b>Signature:</b>
 
 ```typescript
-export declare abstract class GenAIModel 
+export declare abstract class AIModel 
 ```
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [model](./vertexai.genaimodel.md#genaimodelmodel) |  | string | The fully qualified model resource name to use for generating images (for example, <code>publishers/google/models/imagen-3.0-generate-002</code>). |
+|  [model](./vertexai.aimodel.md#aimodelmodel) |  | string | The fully qualified model resource name to use for generating images (for example, <code>publishers/google/models/imagen-3.0-generate-002</code>). |
 
-## GenAIModel.model
+## AIModel.model
 
 The fully qualified model resource name to use for generating images (for example, `publishers/google/models/imagen-3.0-generate-002`<!-- -->).