Skip to content

Commit

Permalink
Update reference documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dlarocque committed Jun 24, 2024
1 parent b9caefe commit af865bb
Show file tree
Hide file tree
Showing 4 changed files with 75 additions and 74 deletions.
68 changes: 68 additions & 0 deletions docs-devsite/vertexai-preview.customerrordata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
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 %}

# CustomErrorData interface
Details object that contains data originating from a bad HTTP response.

<b>Signature:</b>

```typescript
export interface CustomErrorData
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [errorDetails](./vertexai-preview.customerrordata.md#customerrordataerrordetails) | [ErrorDetails](./vertexai-preview.errordetails.md#errordetails_interface)<!-- -->\[\] | Optional additional details about the error. |
| [response](./vertexai-preview.customerrordata.md#customerrordataresponse) | [GenerateContentResponse](./vertexai-preview.generatecontentresponse.md#generatecontentresponse_interface) | Response from a [GenerateContentRequest](./vertexai-preview.generatecontentrequest.md#generatecontentrequest_interface) |
| [status](./vertexai-preview.customerrordata.md#customerrordatastatus) | number | HTTP status code of the error response. |
| [statusText](./vertexai-preview.customerrordata.md#customerrordatastatustext) | string | HTTP status text of the error response. |

## CustomErrorData.errorDetails

Optional additional details about the error.

<b>Signature:</b>

```typescript
errorDetails?: ErrorDetails[];
```

## CustomErrorData.response

Response from a [GenerateContentRequest](./vertexai-preview.generatecontentrequest.md#generatecontentrequest_interface)

<b>Signature:</b>

```typescript
response?: GenerateContentResponse;
```

## CustomErrorData.status

HTTP status code of the error response.

<b>Signature:</b>

```typescript
status?: number;
```

## CustomErrorData.statusText

HTTP status text of the error response.

<b>Signature:</b>

```typescript
statusText?: string;
```
57 changes: 0 additions & 57 deletions docs-devsite/vertexai-preview.httperrordetails.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs-devsite/vertexai-preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ The Vertex AI For Firebase Web SDK.
| [Content](./vertexai-preview.content.md#content_interface) | Content type for both prompts and response candidates. |
| [CountTokensRequest](./vertexai-preview.counttokensrequest.md#counttokensrequest_interface) | Params for calling [GenerativeModel.countTokens()](./vertexai-preview.generativemodel.md#generativemodelcounttokens) |
| [CountTokensResponse](./vertexai-preview.counttokensresponse.md#counttokensresponse_interface) | Response from calling [GenerativeModel.countTokens()](./vertexai-preview.generativemodel.md#generativemodelcounttokens)<!-- -->. |
| [CustomErrorData](./vertexai-preview.customerrordata.md#customerrordata_interface) | Details object that contains data originating from a bad HTTP response. |
| [Date\_2](./vertexai-preview.date_2.md#date_2_interface) | Protobuf google.type.Date |
| [EnhancedGenerateContentResponse](./vertexai-preview.enhancedgeneratecontentresponse.md#enhancedgeneratecontentresponse_interface) | Response object wrapped with helper methods. |
| [ErrorDetails](./vertexai-preview.errordetails.md#errordetails_interface) | Details object that may be included in an error response. |
Expand All @@ -77,7 +78,6 @@ The Vertex AI For Firebase Web SDK.
| [GenerativeContentBlob](./vertexai-preview.generativecontentblob.md#generativecontentblob_interface) | Interface for sending an image. |
| [GroundingAttribution](./vertexai-preview.groundingattribution.md#groundingattribution_interface) | |
| [GroundingMetadata](./vertexai-preview.groundingmetadata.md#groundingmetadata_interface) | Metadata returned to client when grounding is enabled. |
| [HTTPErrorDetails](./vertexai-preview.httperrordetails.md#httperrordetails_interface) | Details object that contains data originating from a bad HTTP response. |
| [InlineDataPart](./vertexai-preview.inlinedatapart.md#inlinedatapart_interface) | Content part interface if the part represents an image. |
| [ModelParams](./vertexai-preview.modelparams.md#modelparams_interface) | Params passed to [getGenerativeModel()](./vertexai-preview.md#getgenerativemodel_e3037c9)<!-- -->. |
| [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>. |
Expand Down
22 changes: 6 additions & 16 deletions docs-devsite/vertexai-preview.vertexaierror.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,14 @@ export declare class VertexAIError extends FirebaseError
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(code, message, httpErrorDetails, generateContentResponse)](./vertexai-preview.vertexaierror.md#vertexaierrorconstructor) | | Creates a new VertexAIError instance. |
| [(constructor)(code, message, customErrorData)](./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) | |
| [generateContentResponse](./vertexai-preview.vertexaierror.md#vertexaierrorgeneratecontentresponse) | | [GenerateContentResponse](./vertexai-preview.generatecontentresponse.md#generatecontentresponse_interface) \| undefined | |
| [httpErrorDetails](./vertexai-preview.vertexaierror.md#vertexaierrorhttperrordetails) | | [HTTPErrorDetails](./vertexai-preview.httperrordetails.md#httperrordetails_interface) \| undefined | |
| [customErrorData](./vertexai-preview.vertexaierror.md#vertexaierrorcustomerrordata) | | [CustomErrorData](./vertexai-preview.customerrordata.md#customerrordata_interface) \| undefined | |
| [message](./vertexai-preview.vertexaierror.md#vertexaierrormessage) | | string | |
## VertexAIError.(constructor)
Expand All @@ -41,7 +40,7 @@ Creates a new VertexAIError instance.
<b>Signature:</b>
```typescript
constructor(code: VertexAIErrorCode, message: string, httpErrorDetails?: HTTPErrorDetails | undefined, generateContentResponse?: GenerateContentResponse | undefined);
constructor(code: VertexAIErrorCode, message: string, customErrorData?: CustomErrorData | undefined);
```
#### Parameters
Expand All @@ -50,8 +49,7 @@ constructor(code: VertexAIErrorCode, message: string, httpErrorDetails?: HTTPErr
| --- | --- | --- |
| code | [VertexAIErrorCode](./vertexai-preview.md#vertexaierrorcode) | The error code from [VertexAIErrorCode](./vertexai-preview.md#vertexaierrorcode)<!-- -->. |
| message | string | A human-readable message describing the error. |
| httpErrorDetails | [HTTPErrorDetails](./vertexai-preview.httperrordetails.md#httperrordetails_interface) \| undefined | |
| generateContentResponse | [GenerateContentResponse](./vertexai-preview.generatecontentresponse.md#generatecontentresponse_interface) \| undefined | Optional response from a [GenerateContentRequest](./vertexai-preview.generatecontentrequest.md#generatecontentrequest_interface)<!-- -->. |
| customErrorData | [CustomErrorData](./vertexai-preview.customerrordata.md#customerrordata_interface) \| undefined | Optional error data. |
## VertexAIError.code
Expand All @@ -61,20 +59,12 @@ constructor(code: VertexAIErrorCode, message: string, httpErrorDetails?: HTTPErr
readonly code: VertexAIErrorCode;
```
## VertexAIError.generateContentResponse
## VertexAIError.customErrorData
<b>Signature:</b>
```typescript
readonly generateContentResponse?: GenerateContentResponse | undefined;
```
## VertexAIError.httpErrorDetails
<b>Signature:</b>
```typescript
readonly httpErrorDetails?: HTTPErrorDetails | undefined;
readonly customErrorData?: CustomErrorData | undefined;
```
## VertexAIError.message
Expand Down

0 comments on commit af865bb

Please sign in to comment.