Write reference documentation

Author: dlarocque

common/api-review/vertexai.api.md

@@ -18,16 +18,16 @@ export class ArraySchema extends Schema {
     toJSON(): SchemaRequest;
 }
 
-// @public (undocumented)
+// @public
 export type Backend = GoogleAIBackend | VertexAIBackend;
 
-// @public (undocumented)
+// @public
 export const BackendType: {
     readonly VERTEX_AI: "VERTEX_AI";
     readonly GOOGLE_AI: "GOOGLE_AI";
 };
 
-// @public (undocumented)
+// @public
 export type BackendType = (typeof BackendType)[keyof typeof BackendType];
 
 // @public
@@ -254,25 +254,20 @@ export interface FunctionResponsePart {
 // @public
 export interface GenAI {
     app: FirebaseApp;
-    // (undocumented)
     backend: Backend;
-    // @deprecated (undocumented)
+    // @deprecated
     location: string;
 }
 
 // @public
-class GenAIError extends FirebaseError {
+export class GenAIError extends FirebaseError {
     constructor(code: GenAIErrorCode, message: string, customErrorData?: CustomErrorData | undefined);
     // (undocumented)
     readonly code: GenAIErrorCode;
     // (undocumented)
     readonly customErrorData?: CustomErrorData | undefined;
 }
 
-export { GenAIError }
-
-export { GenAIError as VertexAIError }
-
 // @public
 const enum GenAIErrorCode {
     API_NOT_ENABLED = "api-not-enabled",
@@ -295,7 +290,7 @@ export { GenAIErrorCode }
 export { GenAIErrorCode as VertexAIErrorCode }
 
 // @public
-abstract class GenAIModel {
+export abstract class GenAIModel {
     // @internal
     protected constructor(genAI: GenAI, modelName: string);
     // @internal (undocumented)
@@ -305,13 +300,8 @@ abstract class GenAIModel {
     static normalizeModelName(modelName: string, backendType: BackendType): string;
     }
 
-export { GenAIModel }
-
-export { GenAIModel as VertexAIModel }
-
-// @public (undocumented)
+// @public
 export interface GenAIOptions {
-    // (undocumented)
     backend: Backend;
 }
 
@@ -431,12 +421,12 @@ export function getImagenModel(genAI: GenAI, modelParams: ImagenModelParams, req
 // @public
 export function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
 
-// @public (undocumented)
+// @public
 export type GoogleAIBackend = {
     backendType: typeof BackendType.GOOGLE_AI;
 };
 
-// @public (undocumented)
+// @public
 export function googleAIBackend(): GoogleAIBackend;
 
 // @public @deprecated (undocumented)
@@ -601,9 +591,6 @@ export interface InlineDataPart {
     videoMetadata?: VideoMetadata;
 }
 
-// @public (undocumented)
-export type InstanceIdentifier = Backend;
-
 // @public
 export class IntegerSchema extends Schema {
     constructor(schemaParams?: SchemaParams);
@@ -871,15 +858,21 @@ export interface UsageMetadata {
 // @public (undocumented)
 export type VertexAI = GenAI;
 
-// @public (undocumented)
+// @public
 export type VertexAIBackend = {
     backendType: typeof BackendType.VERTEX_AI;
     location: string;
 };
 
-// @public (undocumented)
+// @public
 export function vertexAIBackend(location?: string): VertexAIBackend;
 
+// @public
+export const VertexAIError: typeof GenAIError;
+
+// @public
+export const VertexAIModel: typeof GenAIModel;
+
 // @public
 export interface VertexAIOptions {
     // (undocumented)

docs-devsite/vertexai.genai.md

@@ -12,6 +12,8 @@ https://github.com/firebase/firebase-js-sdk
 # GenAI interface
 An instance of the Firebase GenAI SDK.
 
+Do not create this instance directly. Instead, use <code>[getGenAI()](./vertexai.md#getgenai_65c48ee)</code>.
+
 <b>Signature:</b>
 
 ```typescript
@@ -23,8 +25,8 @@ export interface GenAI
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [app](./vertexai.genai.md#genaiapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this <code>[GenAI](./vertexai.genai.md#genai_interface)</code> instance is associated with. |
-|  [backend](./vertexai.genai.md#genaibackend) | [Backend](./vertexai.md#backend) |  |
-|  [location](./vertexai.genai.md#genailocation) | string |  |
+|  [backend](./vertexai.genai.md#genaibackend) | [Backend](./vertexai.md#backend) | A <code>[Backend](./vertexai.md#backend)</code> instance that specifies the backend configuration. |
+|  [location](./vertexai.genai.md#genailocation) | string | The location configured for this GenAI service instance, relevant for Vertex AI backends. |
 
 ## GenAI.app
 
@@ -38,6 +40,8 @@ app: FirebaseApp;
 
 ## GenAI.backend
 
+A <code>[Backend](./vertexai.md#backend)</code> instance that specifies the backend configuration.
+
 <b>Signature:</b>
 
 ```typescript
@@ -51,6 +55,8 @@ backend: Backend;
 > This is here to maintain backwards-compatibility. Use `GenAI.backend.location` instead.
 > 
 
+The location configured for this GenAI service instance, relevant for Vertex AI backends.
+
 <b>Signature:</b>
 
 ```typescript

docs-devsite/vertexai.genaioptions.md

@@ -10,6 +10,8 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # GenAIOptions interface
+Options interface for initializing the GenAI service using <code>[getGenAI()](./vertexai.md#getgenai_65c48ee)</code>.
+
 <b>Signature:</b>
 
 ```typescript
@@ -20,10 +22,12 @@ export interface GenAIOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [backend](./vertexai.genaioptions.md#genaioptionsbackend) | [Backend](./vertexai.md#backend) |  |
+|  [backend](./vertexai.genaioptions.md#genaioptionsbackend) | [Backend](./vertexai.md#backend) | The backend configuration to use for the GenAI service instance. Use <code>[googleAIBackend()](./vertexai.md#googleaibackend)</code> or <code>[vertexAIBackend()](./vertexai.md#vertexaibackend_d0a4534)</code> to create this configuration. |
 
 ## GenAIOptions.backend
 
+The backend configuration to use for the GenAI service instance. Use <code>[googleAIBackend()](./vertexai.md#googleaibackend)</code> or <code>[vertexAIBackend()](./vertexai.md#vertexaibackend_d0a4534)</code> to create this configuration.
+
 <b>Signature:</b>
 
 ```typescript