refdocs

Author: dlarocque

common/api-review/vertexai.api.md

@@ -501,7 +501,7 @@ export enum HarmSeverity {
     HARM_SEVERITY_LOW = "HARM_SEVERITY_LOW",
     HARM_SEVERITY_MEDIUM = "HARM_SEVERITY_MEDIUM",
     HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE",
-    HARM_SEVERITY_UNSUPPORTED = "HARM_SEVERITY_UNSPECIFIED"
+    HARM_SEVERITY_UNSUPPORTED = "HARM_SEVERITY_UNSUPPORTED"
 }
 
 // @beta

docs-devsite/_toc.yaml

@@ -520,6 +520,8 @@ toc:
     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
@@ -604,8 +606,6 @@ toc:
     path: /docs/reference/js/vertexai.toolconfig.md
   - title: UsageMetadata
     path: /docs/reference/js/vertexai.usagemetadata.md
-  - title: VertexAIModel
-    path: /docs/reference/js/vertexai.vertexaimodel.md
   - title: VertexAIOptions
     path: /docs/reference/js/vertexai.vertexaioptions.md
   - title: VideoMetadata

docs-devsite/vertexai.vertexaimodel.md docs-devsite/vertexai.genaimodel.mddocs-devsite/vertexai.vertexaimodel.md renamed to docs-devsite/vertexai.genaimodel.md

@@ -9,7 +9,7 @@ overwritten. Changes should be made in the source code at
 https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
-# VertexAIModel class
+# GenAIModel class
 Base class for Vertex AI in Firebase 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.
@@ -24,9 +24,9 @@ export declare abstract class GenAIModel
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [model](./vertexai.vertexaimodel.md#vertexaimodelmodel) |  | 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.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>). |
 
-## VertexAIModel.model
+## GenAIModel.model
 
 The fully qualified model resource name to use for generating images (for example, `publishers/google/models/imagen-3.0-generate-002`<!-- -->).
 

docs-devsite/vertexai.generativemodel.md

@@ -17,7 +17,7 @@ Class for generative model APIs.
 ```typescript
 export declare class GenerativeModel extends GenAIModel 
 ```
-<b>Extends:</b> GenAIModel
+<b>Extends:</b> [GenAIModel](./vertexai.genaimodel.md#genaimodel_class)
 
 ## Constructors
 

docs-devsite/vertexai.imagenmodel.md

@@ -22,7 +22,7 @@ This class provides methods for generating images using the Imagen model.
 ```typescript
 export declare class ImagenModel extends GenAIModel 
 ```
-<b>Extends:</b> GenAIModel
+<b>Extends:</b> [GenAIModel](./vertexai.genaimodel.md#genaimodel_class)
 
 ## Constructors
 

docs-devsite/vertexai.md

@@ -35,6 +35,7 @@ The Vertex AI in Firebase Web SDK.
 |  [BooleanSchema](./vertexai.booleanschema.md#booleanschema_class) | Schema class for "boolean" types. |
 |  [ChatSession](./vertexai.chatsession.md#chatsession_class) | ChatSession class that enables sending chat messages and stores history of sent and received messages so far. |
 |  [GenAIError](./vertexai.genaierror.md#genaierror_class) | Error class for the Vertex AI in Firebase SDK. |
+|  [GenAIModel](./vertexai.genaimodel.md#genaimodel_class) | Base class for Vertex AI in Firebase model APIs. |
 |  [GenerativeModel](./vertexai.generativemodel.md#generativemodel_class) | Class for generative model APIs. |
 |  [ImagenImageFormat](./vertexai.imagenimageformat.md#imagenimageformat_class) | <b><i>(Public Preview)</i></b> Defines the image format for images generated by Imagen.<!-- -->Use this class to specify the desired format (JPEG or PNG) and compression quality for images generated by Imagen. This is typically included as part of <code>[ImagenModelParams](./vertexai.imagenmodelparams.md#imagenmodelparams_interface)</code>. |
 |  [ImagenModel](./vertexai.imagenmodel.md#imagenmodel_class) | <b><i>(Public Preview)</i></b> Class for Imagen model APIs.<!-- -->This class provides methods for generating images using the Imagen model. |
@@ -43,7 +44,6 @@ The Vertex AI in Firebase Web SDK.
 |  [ObjectSchema](./vertexai.objectschema.md#objectschema_class) | Schema class for "object" types. The <code>properties</code> param must be a map of <code>Schema</code> objects. |
 |  [Schema](./vertexai.schema.md#schema_class) | Parent class encompassing all Schema types, with static methods that allow building specific Schema types. This class can be converted with <code>JSON.stringify()</code> into a JSON string accepted by Vertex AI REST endpoints. (This string conversion is automatically done when calling SDK methods.) |
 |  [StringSchema](./vertexai.stringschema.md#stringschema_class) | Schema class for "string" types. Can be used with or without enum values. |
-|  [VertexAIModel](./vertexai.vertexaimodel.md#vertexaimodel_class) | Base class for Vertex AI in Firebase model APIs. |
 
 ## Enumerations
 
@@ -147,7 +147,6 @@ The Vertex AI in Firebase Web SDK.
 |  [TypedSchema](./vertexai.md#typedschema) | A type that includes all specific Schema types. |
 |  [VertexAI](./vertexai.md#vertexai) |  |
 |  [VertexAIBackend](./vertexai.md#vertexaibackend) |  |
-|  [VertexAIErrorCode](./vertexai.md#vertexaierrorcode) |  |
 
 ## function(app, ...)
 
@@ -395,14 +394,6 @@ export type VertexAIBackend = {
 };
 ```
 
-## VertexAIErrorCode
-
-<b>Signature:</b>
-
-```typescript
-export type VertexAIErrorCode = GenAIErrorCode;
-```
-
 ## BlockReason
 
 Reason that a prompt was blocked.
@@ -582,7 +573,7 @@ export declare enum HarmSeverity
 |  HARM\_SEVERITY\_LOW | <code>&quot;HARM_SEVERITY_LOW&quot;</code> | Low level of harm severity. |
 |  HARM\_SEVERITY\_MEDIUM | <code>&quot;HARM_SEVERITY_MEDIUM&quot;</code> | Medium level of harm severity. |
 |  HARM\_SEVERITY\_NEGLIGIBLE | <code>&quot;HARM_SEVERITY_NEGLIGIBLE&quot;</code> | Negligible level of harm severity. |
-|  HARM\_SEVERITY\_UNSPECIFIED | <code>&quot;HARM_SEVERITY_UNSPECIFIED&quot;</code> | Unspecified level of harm severity. |
+|  HARM\_SEVERITY\_UNSUPPORTED | <code>&quot;HARM_SEVERITY_UNSUPPORTED&quot;</code> | Harm severity is not supported. The GoogleAI backend does not support <code>HarmSeverity</code>, so this value is used as a fallback. |
 
 ## ImagenAspectRatio