diff --git a/docs-devsite/vertexai-preview.md b/docs-devsite/vertexai-preview.md index 1ac53d7f2b1..57fbab35909 100644 --- a/docs-devsite/vertexai-preview.md +++ b/docs-devsite/vertexai-preview.md @@ -385,13 +385,13 @@ export declare const enum VertexAIErrorCode | Member | Value | Description | | --- | --- | --- | -| ERROR | "error" | A generic error occured. | +| ERROR | "error" | A generic error occurred. | | FETCH\_ERROR | "fetch-error" | An error occurred while performing a fetch. | | INVALID\_CONTENT | "invalid-content" | An error associated with a Content object. | -| NO\_API\_KEY | "no-api-key" | An error occured due to a missing api key. | -| NO\_MODEL | "no-model" | An error occurred due to a missing model. | -| NO\_PROJECT\_ID | "no-project-id" | An error occured due to a missing project id. | -| PARSE\_FAILED | "parse-failed" | An error occured while parsing. | +| NO\_API\_KEY | "no-api-key" | An error occurred due to a missing Firebase API key. | +| NO\_MODEL | "no-model" | An error occurred due to a model name not being specified during initialization. | +| NO\_PROJECT\_ID | "no-project-id" | An error occurred due to a missing project ID. | +| PARSE\_FAILED | "parse-failed" | An error occurred while parsing. | | REQUEST\_ERROR | "request-error" | An error occurred in a request. | -| RESPONSE\_ERROR | "response-error" | An error occured in a response. | +| RESPONSE\_ERROR | "response-error" | An error occurred in a response. | diff --git a/docs-devsite/vertexai-preview.vertexaierror.md b/docs-devsite/vertexai-preview.vertexaierror.md index 4365715da29..05a12c62b8e 100644 --- a/docs-devsite/vertexai-preview.vertexaierror.md +++ b/docs-devsite/vertexai-preview.vertexaierror.md @@ -23,7 +23,7 @@ export declare class VertexAIError extends FirebaseError | Constructor | Modifiers | Description | | --- | --- | --- | -| [(constructor)(code, message, customErrorData)](./vertexai-preview.vertexaierror.md#vertexaierrorconstructor) | | Creates a new VertexAIError instance. | +| [(constructor)(code, message, customErrorData)](./vertexai-preview.vertexaierror.md#vertexaierrorconstructor) | | Constructs a new instance of the VertexAIError class. | ## Properties @@ -35,7 +35,7 @@ export declare class VertexAIError extends FirebaseError ## VertexAIError.(constructor) -Creates a new VertexAIError instance. +Constructs a new instance of the `VertexAIError` class. Signature: diff --git a/packages/vertexai/src/errors.ts b/packages/vertexai/src/errors.ts index 44ad849dd9b..7cb7a30020b 100644 --- a/packages/vertexai/src/errors.ts +++ b/packages/vertexai/src/errors.ts @@ -26,7 +26,7 @@ import { VERTEX_TYPE } from './constants'; */ export class VertexAIError extends FirebaseError { /** - * Creates a new VertexAIError instance. + * Constructs a new instance of the `VertexAIError` class. * * @param code - The error code from {@link VertexAIErrorCode}. * @param message - A human-readable message describing the error. diff --git a/packages/vertexai/src/types/error.ts b/packages/vertexai/src/types/error.ts index 07aed862e55..ecc30de5a3e 100644 --- a/packages/vertexai/src/types/error.ts +++ b/packages/vertexai/src/types/error.ts @@ -63,13 +63,13 @@ export interface CustomErrorData { * @public */ export const enum VertexAIErrorCode { - /** A generic error occured. */ + /** A generic error occurred. */ ERROR = 'error', /** An error occurred in a request. */ REQUEST_ERROR = 'request-error', - /** An error occured in a response. */ + /** An error occurred in a response. */ RESPONSE_ERROR = 'response-error', /** An error occurred while performing a fetch. */ @@ -78,15 +78,15 @@ export const enum VertexAIErrorCode { /** An error associated with a Content object. */ INVALID_CONTENT = 'invalid-content', - /** An error occured due to a missing api key. */ + /** An error occurred due to a missing Firebase API key. */ NO_API_KEY = 'no-api-key', - /** An error occurred due to a missing model. */ + /** An error occurred due to a model name not being specified during initialization. */ NO_MODEL = 'no-model', - /** An error occured due to a missing project id. */ + /** An error occurred due to a missing project ID. */ NO_PROJECT_ID = 'no-project-id', - /** An error occured while parsing. */ + /** An error occurred while parsing. */ PARSE_FAILED = 'parse-failed' }