Skip to content

Commit 0b8615d

Browse files
hsubox76hsubox76
committed
redo docs
1 parent 5d5c425 commit 0b8615d

23 files changed

+1648
-252
lines changed

‎common/api-review/vertexai-preview.api.md

Lines changed: 742 additions & 0 deletions
Large diffs are not rendered by default.

‎docs-devsite/_toc.yaml

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -458,8 +458,12 @@ toc:
458458
- title: vertexai-preview
459459
path: /docs/reference/js/vertexai-preview.md
460460
section:
461+
- title: ArraySchema
462+
path: /docs/reference/js/vertexai-preview.arrayschema.md
461463
- title: BaseParams
462464
path: /docs/reference/js/vertexai-preview.baseparams.md
465+
- title: BooleanSchema
466+
path: /docs/reference/js/vertexai-preview.booleanschema.md
463467
- title: ChatSession
464468
path: /docs/reference/js/vertexai-preview.chatsession.md
465469
- title: Citation
@@ -492,11 +496,6 @@ toc:
492496
path: /docs/reference/js/vertexai-preview.functioncallpart.md
493497
- title: FunctionDeclaration
494498
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
500499
- title: FunctionDeclarationsTool
501500
path: /docs/reference/js/vertexai-preview.functiondeclarationstool.md
502501
- title: FunctionResponse
@@ -525,8 +524,16 @@ toc:
525524
path: /docs/reference/js/vertexai-preview.groundingmetadata.md
526525
- title: InlineDataPart
527526
path: /docs/reference/js/vertexai-preview.inlinedatapart.md
527+
- title: IntegerSchema
528+
path: /docs/reference/js/vertexai-preview.integerschema.md
528529
- title: ModelParams
529530
path: /docs/reference/js/vertexai-preview.modelparams.md
531+
- title: NumberSchema
532+
path: /docs/reference/js/vertexai-preview.numberschema.md
533+
- title: ObjectSchema
534+
path: /docs/reference/js/vertexai-preview.objectschema.md
535+
- title: ObjectSchemaInterface
536+
path: /docs/reference/js/vertexai-preview.objectschemainterface.md
530537
- title: PromptFeedback
531538
path: /docs/reference/js/vertexai-preview.promptfeedback.md
532539
- title: RequestOptions
@@ -537,10 +544,22 @@ toc:
537544
path: /docs/reference/js/vertexai-preview.safetyrating.md
538545
- title: SafetySetting
539546
path: /docs/reference/js/vertexai-preview.safetysetting.md
547+
- title: Schema
548+
path: /docs/reference/js/vertexai-preview.schema.md
549+
- title: SchemaInterface
550+
path: /docs/reference/js/vertexai-preview.schemainterface.md
551+
- title: SchemaParams
552+
path: /docs/reference/js/vertexai-preview.schemaparams.md
553+
- title: SchemaRequest
554+
path: /docs/reference/js/vertexai-preview.schemarequest.md
555+
- title: SchemaShared
556+
path: /docs/reference/js/vertexai-preview.schemashared.md
540557
- title: Segment
541558
path: /docs/reference/js/vertexai-preview.segment.md
542559
- title: StartChatParams
543560
path: /docs/reference/js/vertexai-preview.startchatparams.md
561+
- title: StringSchema
562+
path: /docs/reference/js/vertexai-preview.stringschema.md
544563
- title: TextPart
545564
path: /docs/reference/js/vertexai-preview.textpart.md
546565
- title: ToolConfig

‎docs-devsite/vertexai-preview.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-preview.schema.md#schema_class)
21+
22+
## Constructors
23+
24+
| Constructor | Modifiers | Description |
25+
| --- | --- | --- |
26+
| [(constructor)(schemaParams, items)](./vertexai-preview.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-preview.arrayschema.md#arrayschemaitems) | | [TypedSchema](./vertexai-preview.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-preview.schemaparams.md#schemaparams_interface) | |
49+
| items | [TypedSchema](./vertexai-preview.md#typedschema) | |
50+
51+
## ArraySchema.items
52+
53+
<b>Signature:</b>
54+
55+
```typescript
56+
items: TypedSchema;
57+
```

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

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-preview.schema.md#schema_class)
21+
22+
## Constructors
23+
24+
| Constructor | Modifiers | Description |
25+
| --- | --- | --- |
26+
| [(constructor)(schemaParams)](./vertexai-preview.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-preview.schemaparams.md#schemaparams_interface) | |
43+

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,18 @@ export declare interface FunctionDeclaration
2222

2323
| Property | Type | Description |
2424
| --- | --- | --- |
25-
| [description](./vertexai-preview.functiondeclaration.md#functiondeclarationdescription) | string | Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. |
25+
| [description](./vertexai-preview.functiondeclaration.md#functiondeclarationdescription) | string | Description and purpose of the function. Model uses it to decide how and whether to call the function. |
2626
| [name](./vertexai-preview.functiondeclaration.md#functiondeclarationname) | string | The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a max length of 64. |
27-
| [parameters](./vertexai-preview.functiondeclaration.md#functiondeclarationparameters) | [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface) | Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. Parameter names are case-sensitive. For a function with no parameters, this can be left unset. |
27+
| [parameters](./vertexai-preview.functiondeclaration.md#functiondeclarationparameters) | [ObjectSchemaInterface](./vertexai-preview.objectschemainterface.md#objectschemainterface_interface) | Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. Parameter names are case-sensitive. For a function with no parameters, this can be left unset. |
2828

2929
## FunctionDeclaration.description
3030

31-
Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
31+
Description and purpose of the function. Model uses it to decide how and whether to call the function.
3232

3333
<b>Signature:</b>
3434

3535
```typescript
36-
description?: string;
36+
description: string;
3737
```
3838

3939
## FunctionDeclaration.name
@@ -53,5 +53,5 @@ Optional. Describes the parameters to this function in JSON Schema Object format
5353
<b>Signature:</b>
5454

5555
```typescript
56-
parameters?: FunctionDeclarationSchema;
56+
parameters?: ObjectSchemaInterface;
5757
```

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

Lines changed: 0 additions & 70 deletions
This file was deleted.

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

Lines changed: 0 additions & 125 deletions
This file was deleted.

0 commit comments

Comments
 (0)