Skip to content

Commit

Permalink
Fix reference docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dlarocque committed Jun 24, 2024
1 parent af865bb commit c6ad517
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
12 changes: 6 additions & 6 deletions docs-devsite/vertexai-preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,13 +385,13 @@ export declare const enum VertexAIErrorCode

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

4 changes: 2 additions & 2 deletions docs-devsite/vertexai-preview.vertexaierror.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>VertexAIError</code> class. |
## Properties
Expand All @@ -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.
<b>Signature:</b>
Expand Down
2 changes: 1 addition & 1 deletion packages/vertexai/src/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions packages/vertexai/src/types/error.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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. */
Expand All @@ -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'
}

0 comments on commit c6ad517

Please sign in to comment.