Skip to content

Commit 6715987

Browse files
committed
Refresh PR
1 parent 4be5b0e commit 6715987

File tree

76 files changed

+4073
-139
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+4073
-139
lines changed

docs-devsite/_toc.yaml

Lines changed: 73 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -455,105 +455,124 @@ toc:
455455
path: /docs/reference/js/storage.uploadtask.md
456456
- title: UploadTaskSnapshot
457457
path: /docs/reference/js/storage.uploadtasksnapshot.md
458-
- title: vertexai-preview
459-
path: /docs/reference/js/vertexai-preview.md
458+
- title: vertexai
459+
path: /docs/reference/js/vertexai.md
460460
section:
461+
- title: ArraySchema
462+
path: /docs/reference/js/vertexai.arrayschema.md
461463
- title: BaseParams
462-
path: /docs/reference/js/vertexai-preview.baseparams.md
464+
path: /docs/reference/js/vertexai.baseparams.md
465+
- title: BooleanSchema
466+
path: /docs/reference/js/vertexai.booleanschema.md
463467
- title: ChatSession
464-
path: /docs/reference/js/vertexai-preview.chatsession.md
468+
path: /docs/reference/js/vertexai.chatsession.md
465469
- title: Citation
466-
path: /docs/reference/js/vertexai-preview.citation.md
470+
path: /docs/reference/js/vertexai.citation.md
467471
- title: CitationMetadata
468-
path: /docs/reference/js/vertexai-preview.citationmetadata.md
472+
path: /docs/reference/js/vertexai.citationmetadata.md
469473
- title: Content
470-
path: /docs/reference/js/vertexai-preview.content.md
474+
path: /docs/reference/js/vertexai.content.md
471475
- title: CountTokensRequest
472-
path: /docs/reference/js/vertexai-preview.counttokensrequest.md
476+
path: /docs/reference/js/vertexai.counttokensrequest.md
473477
- title: CountTokensResponse
474-
path: /docs/reference/js/vertexai-preview.counttokensresponse.md
478+
path: /docs/reference/js/vertexai.counttokensresponse.md
475479
- title: CustomErrorData
476-
path: /docs/reference/js/vertexai-preview.customerrordata.md
480+
path: /docs/reference/js/vertexai.customerrordata.md
477481
- title: Date_2
478-
path: /docs/reference/js/vertexai-preview.date_2.md
482+
path: /docs/reference/js/vertexai.date_2.md
479483
- title: EnhancedGenerateContentResponse
480-
path: /docs/reference/js/vertexai-preview.enhancedgeneratecontentresponse.md
484+
path: /docs/reference/js/vertexai.enhancedgeneratecontentresponse.md
481485
- title: ErrorDetails
482-
path: /docs/reference/js/vertexai-preview.errordetails.md
486+
path: /docs/reference/js/vertexai.errordetails.md
483487
- title: FileData
484-
path: /docs/reference/js/vertexai-preview.filedata.md
488+
path: /docs/reference/js/vertexai.filedata.md
485489
- title: FileDataPart
486-
path: /docs/reference/js/vertexai-preview.filedatapart.md
490+
path: /docs/reference/js/vertexai.filedatapart.md
487491
- title: FunctionCall
488-
path: /docs/reference/js/vertexai-preview.functioncall.md
492+
path: /docs/reference/js/vertexai.functioncall.md
489493
- title: FunctionCallingConfig
490-
path: /docs/reference/js/vertexai-preview.functioncallingconfig.md
494+
path: /docs/reference/js/vertexai.functioncallingconfig.md
491495
- title: FunctionCallPart
492-
path: /docs/reference/js/vertexai-preview.functioncallpart.md
496+
path: /docs/reference/js/vertexai.functioncallpart.md
493497
- title: FunctionDeclaration
494-
path: /docs/reference/js/vertexai-preview.functiondeclaration.md
495-
- title: FunctionDeclarationSchema
496-
path: /docs/reference/js/vertexai-preview.functiondeclarationschema.md
497-
- title: FunctionDeclarationSchemaProperty
498-
path: >-
499-
/docs/reference/js/vertexai-preview.functiondeclarationschemaproperty.md
498+
path: /docs/reference/js/vertexai.functiondeclaration.md
500499
- title: FunctionDeclarationsTool
501-
path: /docs/reference/js/vertexai-preview.functiondeclarationstool.md
500+
path: /docs/reference/js/vertexai.functiondeclarationstool.md
502501
- title: FunctionResponse
503-
path: /docs/reference/js/vertexai-preview.functionresponse.md
502+
path: /docs/reference/js/vertexai.functionresponse.md
504503
- title: FunctionResponsePart
505-
path: /docs/reference/js/vertexai-preview.functionresponsepart.md
504+
path: /docs/reference/js/vertexai.functionresponsepart.md
506505
- title: GenerateContentCandidate
507-
path: /docs/reference/js/vertexai-preview.generatecontentcandidate.md
506+
path: /docs/reference/js/vertexai.generatecontentcandidate.md
508507
- title: GenerateContentRequest
509-
path: /docs/reference/js/vertexai-preview.generatecontentrequest.md
508+
path: /docs/reference/js/vertexai.generatecontentrequest.md
510509
- title: GenerateContentResponse
511-
path: /docs/reference/js/vertexai-preview.generatecontentresponse.md
510+
path: /docs/reference/js/vertexai.generatecontentresponse.md
512511
- title: GenerateContentResult
513-
path: /docs/reference/js/vertexai-preview.generatecontentresult.md
512+
path: /docs/reference/js/vertexai.generatecontentresult.md
514513
- title: GenerateContentStreamResult
515-
path: /docs/reference/js/vertexai-preview.generatecontentstreamresult.md
514+
path: /docs/reference/js/vertexai.generatecontentstreamresult.md
516515
- title: GenerationConfig
517-
path: /docs/reference/js/vertexai-preview.generationconfig.md
516+
path: /docs/reference/js/vertexai.generationconfig.md
518517
- title: GenerativeContentBlob
519-
path: /docs/reference/js/vertexai-preview.generativecontentblob.md
518+
path: /docs/reference/js/vertexai.generativecontentblob.md
520519
- title: GenerativeModel
521-
path: /docs/reference/js/vertexai-preview.generativemodel.md
520+
path: /docs/reference/js/vertexai.generativemodel.md
522521
- title: GroundingAttribution
523-
path: /docs/reference/js/vertexai-preview.groundingattribution.md
522+
path: /docs/reference/js/vertexai.groundingattribution.md
524523
- title: GroundingMetadata
525-
path: /docs/reference/js/vertexai-preview.groundingmetadata.md
524+
path: /docs/reference/js/vertexai.groundingmetadata.md
526525
- title: InlineDataPart
527-
path: /docs/reference/js/vertexai-preview.inlinedatapart.md
526+
path: /docs/reference/js/vertexai.inlinedatapart.md
527+
- title: IntegerSchema
528+
path: /docs/reference/js/vertexai.integerschema.md
528529
- title: ModelParams
529-
path: /docs/reference/js/vertexai-preview.modelparams.md
530+
path: /docs/reference/js/vertexai.modelparams.md
531+
- title: NumberSchema
532+
path: /docs/reference/js/vertexai.numberschema.md
533+
- title: ObjectSchema
534+
path: /docs/reference/js/vertexai.objectschema.md
535+
- title: ObjectSchemaInterface
536+
path: /docs/reference/js/vertexai.objectschemainterface.md
530537
- title: PromptFeedback
531-
path: /docs/reference/js/vertexai-preview.promptfeedback.md
538+
path: /docs/reference/js/vertexai.promptfeedback.md
532539
- title: RequestOptions
533-
path: /docs/reference/js/vertexai-preview.requestoptions.md
540+
path: /docs/reference/js/vertexai.requestoptions.md
534541
- title: RetrievedContextAttribution
535-
path: /docs/reference/js/vertexai-preview.retrievedcontextattribution.md
542+
path: /docs/reference/js/vertexai.retrievedcontextattribution.md
536543
- title: SafetyRating
537-
path: /docs/reference/js/vertexai-preview.safetyrating.md
544+
path: /docs/reference/js/vertexai.safetyrating.md
538545
- title: SafetySetting
539-
path: /docs/reference/js/vertexai-preview.safetysetting.md
546+
path: /docs/reference/js/vertexai.safetysetting.md
547+
- title: Schema
548+
path: /docs/reference/js/vertexai.schema.md
549+
- title: SchemaInterface
550+
path: /docs/reference/js/vertexai.schemainterface.md
551+
- title: SchemaParams
552+
path: /docs/reference/js/vertexai.schemaparams.md
553+
- title: SchemaRequest
554+
path: /docs/reference/js/vertexai.schemarequest.md
555+
- title: SchemaShared
556+
path: /docs/reference/js/vertexai.schemashared.md
540557
- title: Segment
541-
path: /docs/reference/js/vertexai-preview.segment.md
558+
path: /docs/reference/js/vertexai.segment.md
542559
- title: StartChatParams
543-
path: /docs/reference/js/vertexai-preview.startchatparams.md
560+
path: /docs/reference/js/vertexai.startchatparams.md
561+
- title: StringSchema
562+
path: /docs/reference/js/vertexai.stringschema.md
544563
- title: TextPart
545-
path: /docs/reference/js/vertexai-preview.textpart.md
564+
path: /docs/reference/js/vertexai.textpart.md
546565
- title: ToolConfig
547-
path: /docs/reference/js/vertexai-preview.toolconfig.md
566+
path: /docs/reference/js/vertexai.toolconfig.md
548567
- title: UsageMetadata
549-
path: /docs/reference/js/vertexai-preview.usagemetadata.md
568+
path: /docs/reference/js/vertexai.usagemetadata.md
550569
- title: VertexAI
551-
path: /docs/reference/js/vertexai-preview.vertexai.md
570+
path: /docs/reference/js/vertexai.vertexai.md
552571
- title: VertexAIError
553-
path: /docs/reference/js/vertexai-preview.vertexaierror.md
572+
path: /docs/reference/js/vertexai.vertexaierror.md
554573
- title: VertexAIOptions
555-
path: /docs/reference/js/vertexai-preview.vertexaioptions.md
574+
path: /docs/reference/js/vertexai.vertexaioptions.md
556575
- title: VideoMetadata
557-
path: /docs/reference/js/vertexai-preview.videometadata.md
576+
path: /docs/reference/js/vertexai.videometadata.md
558577
- title: WebAttribution
559-
path: /docs/reference/js/vertexai-preview.webattribution.md
578+
path: /docs/reference/js/vertexai.webattribution.md

docs-devsite/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ https://github.com/firebase/firebase-js-sdk
2727
| [@firebase/performance](./performance.md#performance_package) | The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment. |
2828
| [@firebase/remote-config](./remote-config.md#remote-config_package) | The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environment. |
2929
| [@firebase/storage](./storage.md#storage_package) | Cloud Storage for Firebase |
30-
| [@firebase/vertexai-preview](./vertexai-preview.md#vertexai-preview_package) | The Vertex AI in Firebase Web SDK. |
30+
| [@firebase/vertexai](./vertexai.md#vertexai_package) | The Vertex AI in Firebase Web SDK. |
3131

docs-devsite/vertexai.arrayschema.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+
# ArraySchema class
13+
Schema class for "array" types. The `items` param should refer to the type of item that can be a member of the array.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class ArraySchema extends Schema
19+
```
20+
<b>Extends:</b> [Schema](./vertexai.schema.md#schema_class)
21+
22+
## Constructors
23+
24+
| Constructor | Modifiers | Description |
25+
| --- | --- | --- |
26+
| [(constructor)(schemaParams, items)](./vertexai.arrayschema.md#arrayschemaconstructor) | | Constructs a new instance of the <code>ArraySchema</code> class |
27+
28+
## Properties
29+
30+
| Property | Modifiers | Type | Description |
31+
| --- | --- | --- | --- |
32+
| [items](./vertexai.arrayschema.md#arrayschemaitems) | | [TypedSchema](./vertexai.md#typedschema) | |
33+
34+
## ArraySchema.(constructor)
35+
36+
Constructs a new instance of the `ArraySchema` class
37+
38+
<b>Signature:</b>
39+
40+
```typescript
41+
constructor(schemaParams: SchemaParams, items: TypedSchema);
42+
```
43+
44+
#### Parameters
45+
46+
| Parameter | Type | Description |
47+
| --- | --- | --- |
48+
| schemaParams | [SchemaParams](./vertexai.schemaparams.md#schemaparams_interface) | |
49+
| items | [TypedSchema](./vertexai.md#typedschema) | |
50+
51+
## ArraySchema.items
52+
53+
<b>Signature:</b>
54+
55+
```typescript
56+
items: TypedSchema;
57+
```

docs-devsite/vertexai.baseparams.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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+
# BaseParams interface
13+
Base parameters for a number of methods.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface BaseParams
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [generationConfig](./vertexai.baseparams.md#baseparamsgenerationconfig) | [GenerationConfig](./vertexai.generationconfig.md#generationconfig_interface) | |
26+
| [safetySettings](./vertexai.baseparams.md#baseparamssafetysettings) | [SafetySetting](./vertexai.safetysetting.md#safetysetting_interface)<!-- -->\[\] | |
27+
28+
## BaseParams.generationConfig
29+
30+
<b>Signature:</b>
31+
32+
```typescript
33+
generationConfig?: GenerationConfig;
34+
```
35+
36+
## BaseParams.safetySettings
37+
38+
<b>Signature:</b>
39+
40+
```typescript
41+
safetySettings?: SafetySetting[];
42+
```
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
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+
# BooleanSchema class
13+
Schema class for "boolean" types.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class BooleanSchema extends Schema
19+
```
20+
<b>Extends:</b> [Schema](./vertexai.schema.md#schema_class)
21+
22+
## Constructors
23+
24+
| Constructor | Modifiers | Description |
25+
| --- | --- | --- |
26+
| [(constructor)(schemaParams)](./vertexai.booleanschema.md#booleanschemaconstructor) | | Constructs a new instance of the <code>BooleanSchema</code> class |
27+
28+
## BooleanSchema.(constructor)
29+
30+
Constructs a new instance of the `BooleanSchema` class
31+
32+
<b>Signature:</b>
33+
34+
```typescript
35+
constructor(schemaParams?: SchemaParams);
36+
```
37+
38+
#### Parameters
39+
40+
| Parameter | Type | Description |
41+
| --- | --- | --- |
42+
| schemaParams | [SchemaParams](./vertexai.schemaparams.md#schemaparams_interface) | |
43+

0 commit comments

Comments
 (0)