Skip to content

Commit e40e9cf

Browse files
hsubox76hsubox76
committed
revert docs
1 parent e28f20a commit e40e9cf

7 files changed

+791
-61
lines changed

‎docs-devsite/_toc.yaml

+559
Large diffs are not rendered by default.

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export declare interface FunctionDeclaration
2424
| --- | --- | --- |
2525
| [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. |
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) | [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. |
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. |
2828

2929
## FunctionDeclaration.description
3030

@@ -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?: ObjectSchemaInterface;
56+
parameters?: FunctionDeclarationSchema;
5757
```

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

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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+
# FunctionDeclarationSchema interface
13+
Schema for parameters passed to [FunctionDeclaration.parameters](./vertexai-preview.functiondeclaration.md#functiondeclarationparameters)<!-- -->.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface FunctionDeclarationSchema
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [description](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschemadescription) | string | Optional. Description of the parameter. |
26+
| [properties](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschemaproperties) | { \[k: string\]: [FunctionDeclarationSchemaProperty](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemaproperty_interface)<!-- -->; } | The format of the parameter. |
27+
| [required](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschemarequired) | string\[\] | Optional. Array of required parameters. |
28+
| [type](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschematype) | [FunctionDeclarationSchemaType](./vertexai-preview.md#functiondeclarationschematype) | The type of the parameter. |
29+
30+
## FunctionDeclarationSchema.description
31+
32+
Optional. Description of the parameter.
33+
34+
<b>Signature:</b>
35+
36+
```typescript
37+
description?: string;
38+
```
39+
40+
## FunctionDeclarationSchema.properties
41+
42+
The format of the parameter.
43+
44+
<b>Signature:</b>
45+
46+
```typescript
47+
properties: {
48+
[k: string]: FunctionDeclarationSchemaProperty;
49+
};
50+
```
51+
52+
## FunctionDeclarationSchema.required
53+
54+
Optional. Array of required parameters.
55+
56+
<b>Signature:</b>
57+
58+
```typescript
59+
required?: string[];
60+
```
61+
62+
## FunctionDeclarationSchema.type
63+
64+
The type of the parameter.
65+
66+
<b>Signature:</b>
67+
68+
```typescript
69+
type: FunctionDeclarationSchemaType;
70+
```

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

+125
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
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+
# FunctionDeclarationSchemaProperty interface
13+
Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface FunctionDeclarationSchemaProperty
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [description](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertydescription) | string | Optional. The description of the property. |
26+
| [enum](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertyenum) | string\[\] | Optional. The enum of the property. |
27+
| [example](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertyexample) | unknown | Optional. The example of the property. |
28+
| [format](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertyformat) | string | Optional. The format of the property. |
29+
| [items](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertyitems) | [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface) | Optional. The items of the property. [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface) |
30+
| [nullable](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertynullable) | boolean | Optional. Whether the property is nullable. |
31+
| [properties](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertyproperties) | { \[k: string\]: [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface)<!-- -->; } | Optional. Map of [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface)<!-- -->. |
32+
| [required](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertyrequired) | string\[\] | Optional. Array of required property. |
33+
| [type](./vertexai-preview.functiondeclarationschemaproperty.md#functiondeclarationschemapropertytype) | [FunctionDeclarationSchemaType](./vertexai-preview.md#functiondeclarationschematype) | Optional. The type of the property. [FunctionDeclarationSchemaType](./vertexai-preview.md#functiondeclarationschematype)<!-- -->. |
34+
35+
## FunctionDeclarationSchemaProperty.description
36+
37+
Optional. The description of the property.
38+
39+
<b>Signature:</b>
40+
41+
```typescript
42+
description?: string;
43+
```
44+
45+
## FunctionDeclarationSchemaProperty.enum
46+
47+
Optional. The enum of the property.
48+
49+
<b>Signature:</b>
50+
51+
```typescript
52+
enum?: string[];
53+
```
54+
55+
## FunctionDeclarationSchemaProperty.example
56+
57+
Optional. The example of the property.
58+
59+
<b>Signature:</b>
60+
61+
```typescript
62+
example?: unknown;
63+
```
64+
65+
## FunctionDeclarationSchemaProperty.format
66+
67+
Optional. The format of the property.
68+
69+
<b>Signature:</b>
70+
71+
```typescript
72+
format?: string;
73+
```
74+
75+
## FunctionDeclarationSchemaProperty.items
76+
77+
Optional. The items of the property. [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface)
78+
79+
<b>Signature:</b>
80+
81+
```typescript
82+
items?: FunctionDeclarationSchema;
83+
```
84+
85+
## FunctionDeclarationSchemaProperty.nullable
86+
87+
Optional. Whether the property is nullable.
88+
89+
<b>Signature:</b>
90+
91+
```typescript
92+
nullable?: boolean;
93+
```
94+
95+
## FunctionDeclarationSchemaProperty.properties
96+
97+
Optional. Map of [FunctionDeclarationSchema](./vertexai-preview.functiondeclarationschema.md#functiondeclarationschema_interface)<!-- -->.
98+
99+
<b>Signature:</b>
100+
101+
```typescript
102+
properties?: {
103+
[k: string]: FunctionDeclarationSchema;
104+
};
105+
```
106+
107+
## FunctionDeclarationSchemaProperty.required
108+
109+
Optional. Array of required property.
110+
111+
<b>Signature:</b>
112+
113+
```typescript
114+
required?: string[];
115+
```
116+
117+
## FunctionDeclarationSchemaProperty.type
118+
119+
Optional. The type of the property. [FunctionDeclarationSchemaType](./vertexai-preview.md#functiondeclarationschematype)<!-- -->.
120+
121+
<b>Signature:</b>
122+
123+
```typescript
124+
type?: FunctionDeclarationSchemaType;
125+
```

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

+2-13
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ export interface GenerationConfig
2626
| [frequencyPenalty](./vertexai-preview.generationconfig.md#generationconfigfrequencypenalty) | number | |
2727
| [maxOutputTokens](./vertexai-preview.generationconfig.md#generationconfigmaxoutputtokens) | number | |
2828
| [presencePenalty](./vertexai-preview.generationconfig.md#generationconfigpresencepenalty) | number | |
29-
| [responseMimeType](./vertexai-preview.generationconfig.md#generationconfigresponsemimetype) | string | Output response MIME type of the generated candidate text. Supported MIME types are <code>text/plain</code> (default, text output) and <code>application/json</code> (JSON response in the candidates). |
30-
| [responseSchema](./vertexai-preview.generationconfig.md#generationconfigresponseschema) | [TypedSchema](./vertexai-preview.md#typedschema) \| [SchemaRequest](./vertexai-preview.schemarequest.md#schemarequest_interface) | Output response schema of the generated candidate text. This value can be a class generated with a [Schema](./vertexai-preview.schema.md#schema_class) static method like <code>Schema.string()</code> or <code>Schema.object()</code> or it can be a plain JS object matching the [SchemaRequest](./vertexai-preview.schemarequest.md#schemarequest_interface) interface. <br/>Note: This only applies when the specified <code>responseMIMEType</code> supports a schema; currently this is limited to <code>application/json</code>. |
29+
| [responseMimeType](./vertexai-preview.generationconfig.md#generationconfigresponsemimetype) | string | Output response mimetype of the generated candidate text. Supported mimetypes are <code>text/plain</code> (default, text output) and <code>application/json</code> (JSON response in the candidates). The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. |
3130
| [stopSequences](./vertexai-preview.generationconfig.md#generationconfigstopsequences) | string\[\] | |
3231
| [temperature](./vertexai-preview.generationconfig.md#generationconfigtemperature) | number | |
3332
| [topK](./vertexai-preview.generationconfig.md#generationconfigtopk) | number | |
@@ -67,24 +66,14 @@ presencePenalty?: number;
6766

6867
## GenerationConfig.responseMimeType
6968

70-
Output response MIME type of the generated candidate text. Supported MIME types are `text/plain` (default, text output) and `application/json` (JSON response in the candidates).
69+
Output response mimetype of the generated candidate text. Supported mimetypes are `text/plain` (default, text output) and `application/json` (JSON response in the candidates). The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
7170

7271
<b>Signature:</b>
7372

7473
```typescript
7574
responseMimeType?: string;
7675
```
7776

78-
## GenerationConfig.responseSchema
79-
80-
Output response schema of the generated candidate text. This value can be a class generated with a [Schema](./vertexai-preview.schema.md#schema_class) static method like `Schema.string()` or `Schema.object()` or it can be a plain JS object matching the [SchemaRequest](./vertexai-preview.schemarequest.md#schemarequest_interface) interface. <br/>Note: This only applies when the specified `responseMIMEType` supports a schema; currently this is limited to `application/json`<!-- -->.
81-
82-
<b>Signature:</b>
83-
84-
```typescript
85-
responseSchema?: TypedSchema | SchemaRequest;
86-
```
87-
8877
## GenerationConfig.stopSequences
8978

9079
<b>Signature:</b>

0 commit comments

Comments
 (0)