Skip to content

Commit 7b3d822

Browse files
committed
Add generated reference docs
1 parent ed0e0d4 commit 7b3d822

File tree

4 files changed

+37
-1
lines changed

4 files changed

+37
-1
lines changed

common/api-review/vertexai.api.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ import { FirebaseApp } from '@firebase/app';
99
import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
1010
import { FirebaseError } from '@firebase/util';
1111

12+
// @public
13+
export enum ApiVersion {
14+
V1 = "v1",
15+
V1BETA = "v1beta"
16+
}
17+
1218
// @public
1319
export class ArraySchema extends Schema {
1420
constructor(schemaParams: SchemaParams, items: TypedSchema);
@@ -505,6 +511,7 @@ export interface PromptFeedback {
505511

506512
// @public
507513
export interface RequestOptions {
514+
apiVersion?: ApiVersion;
508515
baseUrl?: string;
509516
timeout?: number;
510517
}

docs-devsite/vertexai.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ The Vertex AI in Firebase Web SDK.
4040

4141
| Enumeration | Description |
4242
| --- | --- |
43+
| [ApiVersion](./vertexai.md#apiversion) | API versions for the Vertex AI in Firebase endpoint. |
4344
| [BlockReason](./vertexai.md#blockreason) | Reason that a prompt was blocked. |
4445
| [FinishReason](./vertexai.md#finishreason) | Reason that a candidate finished. |
4546
| [FunctionCallingMode](./vertexai.md#functioncallingmode) | |
@@ -217,6 +218,23 @@ A type that includes all specific Schema types.
217218
export type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanSchema | ObjectSchema | ArraySchema;
218219
```
219220

221+
## ApiVersion
222+
223+
API versions for the Vertex AI in Firebase endpoint.
224+
225+
<b>Signature:</b>
226+
227+
```typescript
228+
export declare enum ApiVersion
229+
```
230+
231+
## Enumeration Members
232+
233+
| Member | Value | Description |
234+
| --- | --- | --- |
235+
| V1 | <code>&quot;v1&quot;</code> | The stable channel for version 1 of the API. |
236+
| V1BETA | <code>&quot;v1beta&quot;</code> | The beta channel for version 1 of the API. |
237+
220238
## BlockReason
221239

222240
Reason that a prompt was blocked.

docs-devsite/vertexai.requestoptions.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,20 @@ export interface RequestOptions
2222

2323
| Property | Type | Description |
2424
| --- | --- | --- |
25+
| [apiVersion](./vertexai.requestoptions.md#requestoptionsapiversion) | [ApiVersion](./vertexai.md#apiversion) | API version for endpoint. Defaults to <code>"v1beta"</code> (<code>[ApiVersion.V1BETA](./vertexai.md#apiversionv1beta_enummember)</code>). |
2526
| [baseUrl](./vertexai.requestoptions.md#requestoptionsbaseurl) | string | Base url for endpoint. Defaults to https://firebasevertexai.googleapis.com |
2627
| [timeout](./vertexai.requestoptions.md#requestoptionstimeout) | number | Request timeout in milliseconds. Defaults to 180 seconds (180000ms). |
2728

29+
## RequestOptions.apiVersion
30+
31+
API version for endpoint. Defaults to <code>"v1beta"</code> (<code>[ApiVersion.V1BETA](./vertexai.md#apiversionv1beta_enummember)</code>).
32+
33+
<b>Signature:</b>
34+
35+
```typescript
36+
apiVersion?: ApiVersion;
37+
```
38+
2839
## RequestOptions.baseUrl
2940

3041
Base url for endpoint. Defaults to https://firebasevertexai.googleapis.com

packages/vertexai/src/types/enums.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export type Role = (typeof POSSIBLE_ROLES)[number];
2828
export const POSSIBLE_ROLES = ['user', 'model', 'function', 'system'] as const;
2929

3030
/**
31-
* Supported API versions for the Vertex AI in Firebase endpoint.
31+
* API versions for the Vertex AI in Firebase endpoint.
3232
* @public
3333
*/
3434
export enum ApiVersion {

0 commit comments

Comments
 (0)