-
Notifications
You must be signed in to change notification settings - Fork 888
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
17 changed files
with
556 additions
and
166 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@firebase/vertexai-preview': patch | ||
--- | ||
|
||
Add a new VertexAI error type |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
Project: /docs/reference/js/_project.yaml | ||
Book: /docs/reference/_book.yaml | ||
page_type: reference | ||
|
||
{% comment %} | ||
DO NOT EDIT THIS FILE! | ||
This is generated by the JS SDK team, and any local changes will be | ||
overwritten. Changes should be made in the source code at | ||
https://github.com/firebase/firebase-js-sdk | ||
{% endcomment %} | ||
|
||
# ErrorDetails interface | ||
Details object that may be included in an error response. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface ErrorDetails | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| ["@type"](./vertexai-preview.errordetails.md#errordetails"@type") | string | | | ||
| [domain](./vertexai-preview.errordetails.md#errordetailsdomain) | string | The domain where the error occured. | | ||
| [metadata](./vertexai-preview.errordetails.md#errordetailsmetadata) | Record<string, unknown> | Additonal metadata about the error. | | ||
| [reason](./vertexai-preview.errordetails.md#errordetailsreason) | string | The reason for the error. | | ||
|
||
## ErrorDetails."@type" | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
'@type'?: string; | ||
``` | ||
|
||
## ErrorDetails.domain | ||
|
||
The domain where the error occured. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
domain?: string; | ||
``` | ||
|
||
## ErrorDetails.metadata | ||
|
||
Additonal metadata about the error. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
metadata?: Record<string, unknown>; | ||
``` | ||
|
||
## ErrorDetails.reason | ||
|
||
The reason for the error. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
reason?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
Project: /docs/reference/js/_project.yaml | ||
Book: /docs/reference/_book.yaml | ||
page_type: reference | ||
|
||
{% comment %} | ||
DO NOT EDIT THIS FILE! | ||
This is generated by the JS SDK team, and any local changes will be | ||
overwritten. Changes should be made in the source code at | ||
https://github.com/firebase/firebase-js-sdk | ||
{% endcomment %} | ||
|
||
# VertexAIError class | ||
Error class for the Firebase VertexAI SDK. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare class VertexAIError extends FirebaseError | ||
``` | ||
<b>Extends:</b> [FirebaseError](./util.firebaseerror.md#firebaseerror_class) | ||
## Constructors | ||
| Constructor | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [(constructor)(code, message, status, statusText, errorDetails)](./vertexai-preview.vertexaierror.md#vertexaierrorconstructor) | | Creates a new VertexAIError instance. | | ||
## Properties | ||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [code](./vertexai-preview.vertexaierror.md#vertexaierrorcode) | | [VertexAIErrorCode](./vertexai-preview.md#vertexaierrorcode) | | | ||
| [errorDetails](./vertexai-preview.vertexaierror.md#vertexaierrorerrordetails) | | [ErrorDetails](./vertexai-preview.errordetails.md#errordetails_interface)<!-- -->\[\] \| undefined | | | ||
| [message](./vertexai-preview.vertexaierror.md#vertexaierrormessage) | | string | | | ||
| [stack](./vertexai-preview.vertexaierror.md#vertexaierrorstack) | | string | Stack trace of the error. | | ||
| [status](./vertexai-preview.vertexaierror.md#vertexaierrorstatus) | | number \| undefined | | | ||
| [statusText](./vertexai-preview.vertexaierror.md#vertexaierrorstatustext) | | string \| undefined | | | ||
## VertexAIError.(constructor) | ||
Creates a new VertexAIError instance. | ||
<b>Signature:</b> | ||
```typescript | ||
constructor(code: VertexAIErrorCode, message: string, status?: number | undefined, statusText?: string | undefined, errorDetails?: ErrorDetails[] | undefined); | ||
``` | ||
#### Parameters | ||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| code | [VertexAIErrorCode](./vertexai-preview.md#vertexaierrorcode) | The error code from [VertexAIErrorCode](./vertexai-preview.md#vertexaierrorcode)<!-- -->. | | ||
| message | string | A human-readable message describing the error. | | ||
| status | number \| undefined | Optional HTTP status code of the error response. | | ||
| statusText | string \| undefined | Optional HTTP status text of the error response. | | ||
| errorDetails | [ErrorDetails](./vertexai-preview.errordetails.md#errordetails_interface)<!-- -->\[\] \| undefined | Optional additional details about the error. | | ||
## VertexAIError.code | ||
<b>Signature:</b> | ||
```typescript | ||
readonly code: VertexAIErrorCode; | ||
``` | ||
## VertexAIError.errorDetails | ||
<b>Signature:</b> | ||
```typescript | ||
readonly errorDetails?: ErrorDetails[] | undefined; | ||
``` | ||
## VertexAIError.message | ||
<b>Signature:</b> | ||
```typescript | ||
readonly message: string; | ||
``` | ||
## VertexAIError.stack | ||
Stack trace of the error. | ||
<b>Signature:</b> | ||
```typescript | ||
readonly stack?: string; | ||
``` | ||
## VertexAIError.status | ||
<b>Signature:</b> | ||
```typescript | ||
readonly status?: number | undefined; | ||
``` | ||
## VertexAIError.statusText | ||
<b>Signature:</b> | ||
```typescript | ||
readonly statusText?: string | undefined; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.