Skip to content

Commit c01003c

Browse files
dlarocquedlarocque
committed
Regenerate reference docs
1 parent 0af2f34 commit c01003c

File tree

3 files changed

+72
-35
lines changed

3 files changed

+72
-35
lines changed

‎docs-devsite/vertexai-preview.httperrordetails.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# HTTPErrorDetails interface
13+
Details object that contains data originating from a bad HTTP response.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface HTTPErrorDetails
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [errorDetails](./vertexai-preview.httperrordetails.md#httperrordetailserrordetails) | [ErrorDetails](./vertexai-preview.errordetails.md#errordetails_interface)<!-- -->\[\] | Optional additional details about the error. |
26+
| [status](./vertexai-preview.httperrordetails.md#httperrordetailsstatus) | number | HTTP status code of the error response. |
27+
| [statusText](./vertexai-preview.httperrordetails.md#httperrordetailsstatustext) | string | HTTP status text of the error response. |
28+
29+
## HTTPErrorDetails.errorDetails
30+
31+
Optional additional details about the error.
32+
33+
<b>Signature:</b>
34+
35+
```typescript
36+
errorDetails?: ErrorDetails[];
37+
```
38+
39+
## HTTPErrorDetails.status
40+
41+
HTTP status code of the error response.
42+
43+
<b>Signature:</b>
44+
45+
```typescript
46+
status: number;
47+
```
48+
49+
## HTTPErrorDetails.statusText
50+
51+
HTTP status text of the error response.
52+
53+
<b>Signature:</b>
54+
55+
```typescript
56+
statusText: string;
57+
```

‎docs-devsite/vertexai-preview.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The Vertex AI For Firebase Web SDK.
2727
| --- | --- |
2828
| [ChatSession](./vertexai-preview.chatsession.md#chatsession_class) | ChatSession class that enables sending chat messages and stores history of sent and received messages so far. |
2929
| [GenerativeModel](./vertexai-preview.generativemodel.md#generativemodel_class) | Class for generative model APIs. |
30-
| [VertexAIError](./vertexai-preview.vertexaierror.md#vertexaierror_class) | Error class for the Firebase VertexAI SDK. |
30+
| [VertexAIError](./vertexai-preview.vertexaierror.md#vertexaierror_class) | Error class for the Vertex AI for Firebase SDK. |
3131

3232
## Enumerations
3333

@@ -77,6 +77,7 @@ The Vertex AI For Firebase Web SDK.
7777
| [GenerativeContentBlob](./vertexai-preview.generativecontentblob.md#generativecontentblob_interface) | Interface for sending an image. |
7878
| [GroundingAttribution](./vertexai-preview.groundingattribution.md#groundingattribution_interface) | |
7979
| [GroundingMetadata](./vertexai-preview.groundingmetadata.md#groundingmetadata_interface) | Metadata returned to client when grounding is enabled. |
80+
| [HTTPErrorDetails](./vertexai-preview.httperrordetails.md#httperrordetails_interface) | Details object that contains data originating from a bad HTTP response. |
8081
| [InlineDataPart](./vertexai-preview.inlinedatapart.md#inlinedatapart_interface) | Content part interface if the part represents an image. |
8182
| [ModelParams](./vertexai-preview.modelparams.md#modelparams_interface) | Params passed to [getGenerativeModel()](./vertexai-preview.md#getgenerativemodel_e3037c9)<!-- -->. |
8283
| [PromptFeedback](./vertexai-preview.promptfeedback.md#promptfeedback_interface) | If the prompt was blocked, this will be populated with <code>blockReason</code> and the relevant <code>safetyRatings</code>. |

‎docs-devsite/vertexai-preview.vertexaierror.md‎

Lines changed: 13 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# VertexAIError class
13-
Error class for the Firebase VertexAI SDK.
13+
Error class for the Vertex AI for Firebase SDK.
1414

1515
<b>Signature:</b>
1616

@@ -23,18 +23,16 @@ export declare class VertexAIError extends FirebaseError
2323
2424
| Constructor | Modifiers | Description |
2525
| --- | --- | --- |
26-
| [(constructor)(code, message, status, statusText, errorDetails)](./vertexai-preview.vertexaierror.md#vertexaierrorconstructor) | | Creates a new VertexAIError instance. |
26+
| [(constructor)(code, message, httpErrorDetails, generateContentResponse)](./vertexai-preview.vertexaierror.md#vertexaierrorconstructor) | | Creates a new VertexAIError instance. |
2727
2828
## Properties
2929
3030
| Property | Modifiers | Type | Description |
3131
| --- | --- | --- | --- |
3232
| [code](./vertexai-preview.vertexaierror.md#vertexaierrorcode) | | [VertexAIErrorCode](./vertexai-preview.md#vertexaierrorcode) | |
33-
| [errorDetails](./vertexai-preview.vertexaierror.md#vertexaierrorerrordetails) | | [ErrorDetails](./vertexai-preview.errordetails.md#errordetails_interface)<!-- -->\[\] \| undefined | |
33+
| [generateContentResponse](./vertexai-preview.vertexaierror.md#vertexaierrorgeneratecontentresponse) | | [GenerateContentResponse](./vertexai-preview.generatecontentresponse.md#generatecontentresponse_interface) \| undefined | |
34+
| [httpErrorDetails](./vertexai-preview.vertexaierror.md#vertexaierrorhttperrordetails) | | [HTTPErrorDetails](./vertexai-preview.httperrordetails.md#httperrordetails_interface) \| undefined | |
3435
| [message](./vertexai-preview.vertexaierror.md#vertexaierrormessage) | | string | |
35-
| [stack](./vertexai-preview.vertexaierror.md#vertexaierrorstack) | | string | Stack trace of the error. |
36-
| [status](./vertexai-preview.vertexaierror.md#vertexaierrorstatus) | | number \| undefined | |
37-
| [statusText](./vertexai-preview.vertexaierror.md#vertexaierrorstatustext) | | string \| undefined | |
3836
3937
## VertexAIError.(constructor)
4038
@@ -43,7 +41,7 @@ Creates a new VertexAIError instance.
4341
<b>Signature:</b>
4442
4543
```typescript
46-
constructor(code: VertexAIErrorCode, message: string, status?: number | undefined, statusText?: string | undefined, errorDetails?: ErrorDetails[] | undefined);
44+
constructor(code: VertexAIErrorCode, message: string, httpErrorDetails?: HTTPErrorDetails | undefined, generateContentResponse?: GenerateContentResponse | undefined);
4745
```
4846
4947
#### Parameters
@@ -52,9 +50,8 @@ constructor(code: VertexAIErrorCode, message: string, status?: number | undefine
5250
| --- | --- | --- |
5351
| code | [VertexAIErrorCode](./vertexai-preview.md#vertexaierrorcode) | The error code from [VertexAIErrorCode](./vertexai-preview.md#vertexaierrorcode)<!-- -->. |
5452
| message | string | A human-readable message describing the error. |
55-
| status | number \| undefined | Optional HTTP status code of the error response. |
56-
| statusText | string \| undefined | Optional HTTP status text of the error response. |
57-
| errorDetails | [ErrorDetails](./vertexai-preview.errordetails.md#errordetails_interface)<!-- -->\[\] \| undefined | Optional additional details about the error. |
53+
| httpErrorDetails | [HTTPErrorDetails](./vertexai-preview.httperrordetails.md#httperrordetails_interface) \| undefined | |
54+
| generateContentResponse | [GenerateContentResponse](./vertexai-preview.generatecontentresponse.md#generatecontentresponse_interface) \| undefined | Optional response from a [GenerateContentRequest](./vertexai-preview.generatecontentrequest.md#generatecontentrequest_interface)<!-- -->. |
5855
5956
## VertexAIError.code
6057
@@ -64,44 +61,26 @@ constructor(code: VertexAIErrorCode, message: string, status?: number | undefine
6461
readonly code: VertexAIErrorCode;
6562
```
6663
67-
## VertexAIError.errorDetails
64+
## VertexAIError.generateContentResponse
6865
6966
<b>Signature:</b>
7067
7168
```typescript
72-
readonly errorDetails?: ErrorDetails[] | undefined;
69+
readonly generateContentResponse?: GenerateContentResponse | undefined;
7370
```
7471
75-
## VertexAIError.message
76-
77-
<b>Signature:</b>
78-
79-
```typescript
80-
readonly message: string;
81-
```
82-
83-
## VertexAIError.stack
84-
85-
Stack trace of the error.
72+
## VertexAIError.httpErrorDetails
8673
8774
<b>Signature:</b>
8875
8976
```typescript
90-
readonly stack?: string;
77+
readonly httpErrorDetails?: HTTPErrorDetails | undefined;
9178
```
9279
93-
## VertexAIError.status
94-
95-
<b>Signature:</b>
96-
97-
```typescript
98-
readonly status?: number | undefined;
99-
```
100-
101-
## VertexAIError.statusText
80+
## VertexAIError.message
10281
10382
<b>Signature:</b>
10483
10584
```typescript
106-
readonly statusText?: string | undefined;
85+
readonly message: string;
10786
```

0 commit comments

Comments
 (0)