Skip to content

Commit 898f4b3

Browse files
committed
Update vertex docs
1 parent 670eba6 commit 898f4b3

File tree

83 files changed

+1535
-3140
lines changed

Some content is hidden

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

83 files changed

+1535
-3140
lines changed

docs-devsite/_toc.yaml

Lines changed: 55 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -469,144 +469,106 @@ toc:
469469
path: /docs/reference/js/storage.uploadtask.md
470470
- title: UploadTaskSnapshot
471471
path: /docs/reference/js/storage.uploadtasksnapshot.md
472-
- title: vertexai
473-
path: /docs/reference/js/vertexai.md
472+
- title: vertexai-preview
473+
path: /docs/reference/js/vertexai-preview.md
474474
section:
475-
- title: ArraySchema
476-
path: /docs/reference/js/vertexai.arrayschema.md
477475
- title: BaseParams
478-
path: /docs/reference/js/vertexai.baseparams.md
479-
- title: BooleanSchema
480-
path: /docs/reference/js/vertexai.booleanschema.md
476+
path: /docs/reference/js/vertexai-preview.baseparams.md
481477
- title: ChatSession
482-
path: /docs/reference/js/vertexai.chatsession.md
478+
path: /docs/reference/js/vertexai-preview.chatsession.md
483479
- title: Citation
484-
path: /docs/reference/js/vertexai.citation.md
480+
path: /docs/reference/js/vertexai-preview.citation.md
485481
- title: CitationMetadata
486-
path: /docs/reference/js/vertexai.citationmetadata.md
482+
path: /docs/reference/js/vertexai-preview.citationmetadata.md
487483
- title: Content
488-
path: /docs/reference/js/vertexai.content.md
484+
path: /docs/reference/js/vertexai-preview.content.md
489485
- title: CountTokensRequest
490-
path: /docs/reference/js/vertexai.counttokensrequest.md
486+
path: /docs/reference/js/vertexai-preview.counttokensrequest.md
491487
- title: CountTokensResponse
492-
path: /docs/reference/js/vertexai.counttokensresponse.md
488+
path: /docs/reference/js/vertexai-preview.counttokensresponse.md
493489
- title: CustomErrorData
494-
path: /docs/reference/js/vertexai.customerrordata.md
490+
path: /docs/reference/js/vertexai-preview.customerrordata.md
495491
- title: Date_2
496-
path: /docs/reference/js/vertexai.date_2.md
492+
path: /docs/reference/js/vertexai-preview.date_2.md
497493
- title: EnhancedGenerateContentResponse
498-
path: /docs/reference/js/vertexai.enhancedgeneratecontentresponse.md
494+
path: /docs/reference/js/vertexai-preview.enhancedgeneratecontentresponse.md
499495
- title: ErrorDetails
500-
path: /docs/reference/js/vertexai.errordetails.md
496+
path: /docs/reference/js/vertexai-preview.errordetails.md
501497
- title: FileData
502-
path: /docs/reference/js/vertexai.filedata.md
498+
path: /docs/reference/js/vertexai-preview.filedata.md
503499
- title: FileDataPart
504-
path: /docs/reference/js/vertexai.filedatapart.md
500+
path: /docs/reference/js/vertexai-preview.filedatapart.md
505501
- title: FunctionCall
506-
path: /docs/reference/js/vertexai.functioncall.md
502+
path: /docs/reference/js/vertexai-preview.functioncall.md
507503
- title: FunctionCallingConfig
508-
path: /docs/reference/js/vertexai.functioncallingconfig.md
504+
path: /docs/reference/js/vertexai-preview.functioncallingconfig.md
509505
- title: FunctionCallPart
510-
path: /docs/reference/js/vertexai.functioncallpart.md
506+
path: /docs/reference/js/vertexai-preview.functioncallpart.md
511507
- title: FunctionDeclaration
512-
path: /docs/reference/js/vertexai.functiondeclaration.md
508+
path: /docs/reference/js/vertexai-preview.functiondeclaration.md
509+
- title: FunctionDeclarationSchema
510+
path: /docs/reference/js/vertexai-preview.functiondeclarationschema.md
511+
- title: FunctionDeclarationSchemaProperty
512+
path: /docs/reference/js/vertexai-preview.functiondeclarationschemaproperty.md
513513
- title: FunctionDeclarationsTool
514-
path: /docs/reference/js/vertexai.functiondeclarationstool.md
514+
path: /docs/reference/js/vertexai-preview.functiondeclarationstool.md
515515
- title: FunctionResponse
516-
path: /docs/reference/js/vertexai.functionresponse.md
516+
path: /docs/reference/js/vertexai-preview.functionresponse.md
517517
- title: FunctionResponsePart
518-
path: /docs/reference/js/vertexai.functionresponsepart.md
518+
path: /docs/reference/js/vertexai-preview.functionresponsepart.md
519519
- title: GenerateContentCandidate
520-
path: /docs/reference/js/vertexai.generatecontentcandidate.md
520+
path: /docs/reference/js/vertexai-preview.generatecontentcandidate.md
521521
- title: GenerateContentRequest
522-
path: /docs/reference/js/vertexai.generatecontentrequest.md
522+
path: /docs/reference/js/vertexai-preview.generatecontentrequest.md
523523
- title: GenerateContentResponse
524-
path: /docs/reference/js/vertexai.generatecontentresponse.md
524+
path: /docs/reference/js/vertexai-preview.generatecontentresponse.md
525525
- title: GenerateContentResult
526-
path: /docs/reference/js/vertexai.generatecontentresult.md
526+
path: /docs/reference/js/vertexai-preview.generatecontentresult.md
527527
- title: GenerateContentStreamResult
528-
path: /docs/reference/js/vertexai.generatecontentstreamresult.md
528+
path: /docs/reference/js/vertexai-preview.generatecontentstreamresult.md
529529
- title: GenerationConfig
530-
path: /docs/reference/js/vertexai.generationconfig.md
530+
path: /docs/reference/js/vertexai-preview.generationconfig.md
531531
- title: GenerativeContentBlob
532-
path: /docs/reference/js/vertexai.generativecontentblob.md
532+
path: /docs/reference/js/vertexai-preview.generativecontentblob.md
533533
- title: GenerativeModel
534-
path: /docs/reference/js/vertexai.generativemodel.md
534+
path: /docs/reference/js/vertexai-preview.generativemodel.md
535535
- title: GroundingAttribution
536-
path: /docs/reference/js/vertexai.groundingattribution.md
536+
path: /docs/reference/js/vertexai-preview.groundingattribution.md
537537
- title: GroundingMetadata
538-
path: /docs/reference/js/vertexai.groundingmetadata.md
539-
- title: ImagenGCSImage
540-
path: /docs/reference/js/vertexai.imagengcsimage.md
541-
- title: ImagenGenerationConfig
542-
path: /docs/reference/js/vertexai.imagengenerationconfig.md
543-
- title: ImagenGenerationResponse
544-
path: /docs/reference/js/vertexai.imagengenerationresponse.md
545-
- title: ImagenImageFormat
546-
path: /docs/reference/js/vertexai.imagenimageformat.md
547-
- title: ImagenInlineImage
548-
path: /docs/reference/js/vertexai.imageninlineimage.md
549-
- title: ImagenModel
550-
path: /docs/reference/js/vertexai.imagenmodel.md
551-
- title: ImagenModelParams
552-
path: /docs/reference/js/vertexai.imagenmodelparams.md
553-
- title: ImagenSafetySettings
554-
path: /docs/reference/js/vertexai.imagensafetysettings.md
538+
path: /docs/reference/js/vertexai-preview.groundingmetadata.md
539+
- title: HybridParams
540+
path: /docs/reference/js/vertexai-preview.hybridparams.md
555541
- title: InlineDataPart
556-
path: /docs/reference/js/vertexai.inlinedatapart.md
557-
- title: IntegerSchema
558-
path: /docs/reference/js/vertexai.integerschema.md
559-
- title: ModalityTokenCount
560-
path: /docs/reference/js/vertexai.modalitytokencount.md
542+
path: /docs/reference/js/vertexai-preview.inlinedatapart.md
561543
- title: ModelParams
562-
path: /docs/reference/js/vertexai.modelparams.md
563-
- title: NumberSchema
564-
path: /docs/reference/js/vertexai.numberschema.md
565-
- title: ObjectSchema
566-
path: /docs/reference/js/vertexai.objectschema.md
567-
- title: ObjectSchemaInterface
568-
path: /docs/reference/js/vertexai.objectschemainterface.md
544+
path: /docs/reference/js/vertexai-preview.modelparams.md
569545
- title: PromptFeedback
570-
path: /docs/reference/js/vertexai.promptfeedback.md
546+
path: /docs/reference/js/vertexai-preview.promptfeedback.md
571547
- title: RequestOptions
572-
path: /docs/reference/js/vertexai.requestoptions.md
548+
path: /docs/reference/js/vertexai-preview.requestoptions.md
573549
- title: RetrievedContextAttribution
574-
path: /docs/reference/js/vertexai.retrievedcontextattribution.md
550+
path: /docs/reference/js/vertexai-preview.retrievedcontextattribution.md
575551
- title: SafetyRating
576-
path: /docs/reference/js/vertexai.safetyrating.md
552+
path: /docs/reference/js/vertexai-preview.safetyrating.md
577553
- title: SafetySetting
578-
path: /docs/reference/js/vertexai.safetysetting.md
579-
- title: Schema
580-
path: /docs/reference/js/vertexai.schema.md
581-
- title: SchemaInterface
582-
path: /docs/reference/js/vertexai.schemainterface.md
583-
- title: SchemaParams
584-
path: /docs/reference/js/vertexai.schemaparams.md
585-
- title: SchemaRequest
586-
path: /docs/reference/js/vertexai.schemarequest.md
587-
- title: SchemaShared
588-
path: /docs/reference/js/vertexai.schemashared.md
554+
path: /docs/reference/js/vertexai-preview.safetysetting.md
589555
- title: Segment
590-
path: /docs/reference/js/vertexai.segment.md
556+
path: /docs/reference/js/vertexai-preview.segment.md
591557
- title: StartChatParams
592-
path: /docs/reference/js/vertexai.startchatparams.md
593-
- title: StringSchema
594-
path: /docs/reference/js/vertexai.stringschema.md
558+
path: /docs/reference/js/vertexai-preview.startchatparams.md
595559
- title: TextPart
596-
path: /docs/reference/js/vertexai.textpart.md
560+
path: /docs/reference/js/vertexai-preview.textpart.md
597561
- title: ToolConfig
598-
path: /docs/reference/js/vertexai.toolconfig.md
562+
path: /docs/reference/js/vertexai-preview.toolconfig.md
599563
- title: UsageMetadata
600-
path: /docs/reference/js/vertexai.usagemetadata.md
564+
path: /docs/reference/js/vertexai-preview.usagemetadata.md
601565
- title: VertexAI
602-
path: /docs/reference/js/vertexai.vertexai.md
566+
path: /docs/reference/js/vertexai-preview.vertexai.md
603567
- title: VertexAIError
604-
path: /docs/reference/js/vertexai.vertexaierror.md
605-
- title: VertexAIModel
606-
path: /docs/reference/js/vertexai.vertexaimodel.md
568+
path: /docs/reference/js/vertexai-preview.vertexaierror.md
607569
- title: VertexAIOptions
608-
path: /docs/reference/js/vertexai.vertexaioptions.md
570+
path: /docs/reference/js/vertexai-preview.vertexaioptions.md
609571
- title: VideoMetadata
610-
path: /docs/reference/js/vertexai.videometadata.md
572+
path: /docs/reference/js/vertexai-preview.videometadata.md
611573
- title: WebAttribution
612-
path: /docs/reference/js/vertexai.webattribution.md
574+
path: /docs/reference/js/vertexai-preview.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](./vertexai.md#vertexai_package) | The Vertex AI in Firebase Web SDK. |
30+
| [@firebase/vertexai-preview](./vertexai-preview.md#vertexai-preview_package) | The Vertex AI in Firebase Web SDK. |
3131

docs-devsite/vertexai.baseparams.md renamed to docs-devsite/vertexai-preview.baseparams.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ export interface BaseParams
2222

2323
| Property | Type | Description |
2424
| --- | --- | --- |
25-
| [generationConfig](./vertexai.baseparams.md#baseparamsgenerationconfig) | [GenerationConfig](./vertexai.generationconfig.md#generationconfig_interface) | |
26-
| [safetySettings](./vertexai.baseparams.md#baseparamssafetysettings) | [SafetySetting](./vertexai.safetysetting.md#safetysetting_interface)<!-- -->\[\] | |
25+
| [generationConfig](./vertexai-preview.baseparams.md#baseparamsgenerationconfig) | [GenerationConfig](./vertexai-preview.generationconfig.md#generationconfig_interface) | |
26+
| [safetySettings](./vertexai-preview.baseparams.md#baseparamssafetysettings) | [SafetySetting](./vertexai-preview.safetysetting.md#safetysetting_interface)<!-- -->\[\] | |
2727

2828
## BaseParams.generationConfig
2929

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
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+
# ChatSession class
13+
ChatSession class that enables sending chat messages and stores history of sent and received messages so far.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class ChatSession
19+
```
20+
21+
## Constructors
22+
23+
| Constructor | Modifiers | Description |
24+
| --- | --- | --- |
25+
| [(constructor)(apiSettings, model, chromeAdapter, params, requestOptions)](./vertexai-preview.chatsession.md#chatsessionconstructor) | | Constructs a new instance of the <code>ChatSession</code> class |
26+
27+
## Properties
28+
29+
| Property | Modifiers | Type | Description |
30+
| --- | --- | --- | --- |
31+
| [model](./vertexai-preview.chatsession.md#chatsessionmodel) | | string | |
32+
| [params](./vertexai-preview.chatsession.md#chatsessionparams) | | [StartChatParams](./vertexai-preview.startchatparams.md#startchatparams_interface) \| undefined | |
33+
| [requestOptions](./vertexai-preview.chatsession.md#chatsessionrequestoptions) | | [RequestOptions](./vertexai-preview.requestoptions.md#requestoptions_interface) \| undefined | |
34+
35+
## Methods
36+
37+
| Method | Modifiers | Description |
38+
| --- | --- | --- |
39+
| [getHistory()](./vertexai-preview.chatsession.md#chatsessiongethistory) | | Gets the chat history so far. Blocked prompts are not added to history. Neither blocked candidates nor the prompts that generated them are added to history. |
40+
| [sendMessage(request)](./vertexai-preview.chatsession.md#chatsessionsendmessage) | | Sends a chat message and receives a non-streaming [GenerateContentResult](./vertexai-preview.generatecontentresult.md#generatecontentresult_interface) |
41+
| [sendMessageStream(request)](./vertexai-preview.chatsession.md#chatsessionsendmessagestream) | | Sends a chat message and receives the response as a [GenerateContentStreamResult](./vertexai-preview.generatecontentstreamresult.md#generatecontentstreamresult_interface) containing an iterable stream and a response promise. |
42+
43+
## ChatSession.(constructor)
44+
45+
Constructs a new instance of the `ChatSession` class
46+
47+
<b>Signature:</b>
48+
49+
```typescript
50+
constructor(apiSettings: ApiSettings, model: string, chromeAdapter: ChromeAdapter, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
51+
```
52+
53+
#### Parameters
54+
55+
| Parameter | Type | Description |
56+
| --- | --- | --- |
57+
| apiSettings | ApiSettings | |
58+
| model | string | |
59+
| chromeAdapter | ChromeAdapter | |
60+
| params | [StartChatParams](./vertexai-preview.startchatparams.md#startchatparams_interface) \| undefined | |
61+
| requestOptions | [RequestOptions](./vertexai-preview.requestoptions.md#requestoptions_interface) \| undefined | |
62+
63+
## ChatSession.model
64+
65+
<b>Signature:</b>
66+
67+
```typescript
68+
model: string;
69+
```
70+
71+
## ChatSession.params
72+
73+
<b>Signature:</b>
74+
75+
```typescript
76+
params?: StartChatParams | undefined;
77+
```
78+
79+
## ChatSession.requestOptions
80+
81+
<b>Signature:</b>
82+
83+
```typescript
84+
requestOptions?: RequestOptions | undefined;
85+
```
86+
87+
## ChatSession.getHistory()
88+
89+
Gets the chat history so far. Blocked prompts are not added to history. Neither blocked candidates nor the prompts that generated them are added to history.
90+
91+
<b>Signature:</b>
92+
93+
```typescript
94+
getHistory(): Promise<Content[]>;
95+
```
96+
<b>Returns:</b>
97+
98+
Promise&lt;[Content](./vertexai-preview.content.md#content_interface)<!-- -->\[\]&gt;
99+
100+
## ChatSession.sendMessage()
101+
102+
Sends a chat message and receives a non-streaming [GenerateContentResult](./vertexai-preview.generatecontentresult.md#generatecontentresult_interface)
103+
104+
<b>Signature:</b>
105+
106+
```typescript
107+
sendMessage(request: string | Array<string | Part>): Promise<GenerateContentResult>;
108+
```
109+
110+
#### Parameters
111+
112+
| Parameter | Type | Description |
113+
| --- | --- | --- |
114+
| request | string \| Array&lt;string \| [Part](./vertexai-preview.md#part)<!-- -->&gt; | |
115+
116+
<b>Returns:</b>
117+
118+
Promise&lt;[GenerateContentResult](./vertexai-preview.generatecontentresult.md#generatecontentresult_interface)<!-- -->&gt;
119+
120+
## ChatSession.sendMessageStream()
121+
122+
Sends a chat message and receives the response as a [GenerateContentStreamResult](./vertexai-preview.generatecontentstreamresult.md#generatecontentstreamresult_interface) containing an iterable stream and a response promise.
123+
124+
<b>Signature:</b>
125+
126+
```typescript
127+
sendMessageStream(request: string | Array<string | Part>): Promise<GenerateContentStreamResult>;
128+
```
129+
130+
#### Parameters
131+
132+
| Parameter | Type | Description |
133+
| --- | --- | --- |
134+
| request | string \| Array&lt;string \| [Part](./vertexai-preview.md#part)<!-- -->&gt; | |
135+
136+
<b>Returns:</b>
137+
138+
Promise&lt;[GenerateContentStreamResult](./vertexai-preview.generatecontentstreamresult.md#generatecontentstreamresult_interface)<!-- -->&gt;
139+

docs-devsite/vertexai.citation.md renamed to docs-devsite/vertexai-preview.citation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ export interface Citation
2222

2323
| Property | Type | Description |
2424
| --- | --- | --- |
25-
| [endIndex](./vertexai.citation.md#citationendindex) | number | |
26-
| [license](./vertexai.citation.md#citationlicense) | string | |
27-
| [publicationDate](./vertexai.citation.md#citationpublicationdate) | Date | |
28-
| [startIndex](./vertexai.citation.md#citationstartindex) | number | |
29-
| [title](./vertexai.citation.md#citationtitle) | string | |
30-
| [uri](./vertexai.citation.md#citationuri) | string | |
25+
| [endIndex](./vertexai-preview.citation.md#citationendindex) | number | |
26+
| [license](./vertexai-preview.citation.md#citationlicense) | string | |
27+
| [publicationDate](./vertexai-preview.citation.md#citationpublicationdate) | Date | |
28+
| [startIndex](./vertexai-preview.citation.md#citationstartindex) | number | |
29+
| [title](./vertexai-preview.citation.md#citationtitle) | string | |
30+
| [uri](./vertexai-preview.citation.md#citationuri) | string | |
3131

3232
## Citation.endIndex
3333

docs-devsite/vertexai.citationmetadata.md renamed to docs-devsite/vertexai-preview.citationmetadata.md

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

1212
# CitationMetadata interface
13-
Citation metadata that may be found on a <code>[GenerateContentCandidate](./vertexai.generatecontentcandidate.md#generatecontentcandidate_interface)</code>.
13+
Citation metadata that may be found on a [GenerateContentCandidate](./vertexai-preview.generatecontentcandidate.md#generatecontentcandidate_interface)<!-- -->.
1414

1515
<b>Signature:</b>
1616

@@ -22,7 +22,7 @@ export interface CitationMetadata
2222

2323
| Property | Type | Description |
2424
| --- | --- | --- |
25-
| [citations](./vertexai.citationmetadata.md#citationmetadatacitations) | [Citation](./vertexai.citation.md#citation_interface)<!-- -->\[\] | |
25+
| [citations](./vertexai-preview.citationmetadata.md#citationmetadatacitations) | [Citation](./vertexai-preview.citation.md#citation_interface)<!-- -->\[\] | |
2626

2727
## CitationMetadata.citations
2828

0 commit comments

Comments
 (0)