Skip to content

Commit a6b28b5

Browse files
committed
Fix reference docs
1 parent 646340f commit a6b28b5

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

docs-devsite/vertexai-preview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -385,13 +385,13 @@ export declare const enum VertexAIErrorCode
385385

386386
| Member | Value | Description |
387387
| --- | --- | --- |
388-
| ERROR | <code>&quot;error&quot;</code> | A generic error occured. |
388+
| ERROR | <code>&quot;error&quot;</code> | A generic error occurred. |
389389
| FETCH\_ERROR | <code>&quot;fetch-error&quot;</code> | An error occurred while performing a fetch. |
390390
| INVALID\_CONTENT | <code>&quot;invalid-content&quot;</code> | An error associated with a Content object. |
391-
| NO\_API\_KEY | <code>&quot;no-api-key&quot;</code> | An error occured due to a missing api key. |
392-
| NO\_MODEL | <code>&quot;no-model&quot;</code> | An error occurred due to a missing model. |
393-
| NO\_PROJECT\_ID | <code>&quot;no-project-id&quot;</code> | An error occured due to a missing project id. |
394-
| PARSE\_FAILED | <code>&quot;parse-failed&quot;</code> | An error occured while parsing. |
391+
| NO\_API\_KEY | <code>&quot;no-api-key&quot;</code> | An error occurred due to a missing Firebase API key. |
392+
| NO\_MODEL | <code>&quot;no-model&quot;</code> | An error occurred due to a model name not being specified during initialization. |
393+
| NO\_PROJECT\_ID | <code>&quot;no-project-id&quot;</code> | An error occurred due to a missing project ID. |
394+
| PARSE\_FAILED | <code>&quot;parse-failed&quot;</code> | An error occurred while parsing. |
395395
| REQUEST\_ERROR | <code>&quot;request-error&quot;</code> | An error occurred in a request. |
396-
| RESPONSE\_ERROR | <code>&quot;response-error&quot;</code> | An error occured in a response. |
396+
| RESPONSE\_ERROR | <code>&quot;response-error&quot;</code> | An error occurred in a response. |
397397

docs-devsite/vertexai-preview.vertexaierror.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export declare class VertexAIError extends FirebaseError
2323
2424
| Constructor | Modifiers | Description |
2525
| --- | --- | --- |
26-
| [(constructor)(code, message, customErrorData)](./vertexai-preview.vertexaierror.md#vertexaierrorconstructor) | | Creates a new VertexAIError instance. |
26+
| [(constructor)(code, message, customErrorData)](./vertexai-preview.vertexaierror.md#vertexaierrorconstructor) | | Constructs a new instance of the <code>VertexAIError</code> class. |
2727
2828
## Properties
2929
@@ -35,7 +35,7 @@ export declare class VertexAIError extends FirebaseError
3535
3636
## VertexAIError.(constructor)
3737
38-
Creates a new VertexAIError instance.
38+
Constructs a new instance of the `VertexAIError` class.
3939
4040
<b>Signature:</b>
4141

packages/vertexai/src/errors.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import { VERTEX_TYPE } from './constants';
2626
*/
2727
export class VertexAIError extends FirebaseError {
2828
/**
29-
* Creates a new VertexAIError instance.
29+
* Constructs a new instance of the `VertexAIError` class.
3030
*
3131
* @param code - The error code from {@link VertexAIErrorCode}.
3232
* @param message - A human-readable message describing the error.

packages/vertexai/src/types/error.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ export interface CustomErrorData {
6363
* @public
6464
*/
6565
export const enum VertexAIErrorCode {
66-
/** A generic error occured. */
66+
/** A generic error occurred. */
6767
ERROR = 'error',
6868

6969
/** An error occurred in a request. */
7070
REQUEST_ERROR = 'request-error',
7171

72-
/** An error occured in a response. */
72+
/** An error occurred in a response. */
7373
RESPONSE_ERROR = 'response-error',
7474

7575
/** An error occurred while performing a fetch. */
@@ -78,15 +78,15 @@ export const enum VertexAIErrorCode {
7878
/** An error associated with a Content object. */
7979
INVALID_CONTENT = 'invalid-content',
8080

81-
/** An error occured due to a missing api key. */
81+
/** An error occurred due to a missing Firebase API key. */
8282
NO_API_KEY = 'no-api-key',
8383

84-
/** An error occurred due to a missing model. */
84+
/** An error occurred due to a model name not being specified during initialization. */
8585
NO_MODEL = 'no-model',
8686

87-
/** An error occured due to a missing project id. */
87+
/** An error occurred due to a missing project ID. */
8888
NO_PROJECT_ID = 'no-project-id',
8989

90-
/** An error occured while parsing. */
90+
/** An error occurred while parsing. */
9191
PARSE_FAILED = 'parse-failed'
9292
}

0 commit comments

Comments
 (0)