Skip to content

Commit 442a708

Browse files
hsubox76hsubox76
committed
fix docs
1 parent 9d327c9 commit 442a708

23 files changed

+907
-808
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export class ArraySchema extends Schema {
1414
constructor(schemaParams: SchemaParams, items: TypedSchema);
1515
// (undocumented)
1616
items: TypedSchema;
17-
// (undocumented)
17+
// @internal (undocumented)
1818
toJSON(): SchemaRequest;
1919
}
2020

@@ -491,7 +491,7 @@ export class ObjectSchema extends Schema {
491491
properties: {
492492
[k: string]: TypedSchema;
493493
};
494-
// (undocumented)
494+
// @internal (undocumented)
495495
toJSON(): SchemaRequest;
496496
}
497497

@@ -593,6 +593,7 @@ export abstract class Schema implements SchemaInterface {
593593
}): ObjectSchema;
594594
// (undocumented)
595595
static string(stringParams?: SchemaParams): StringSchema;
596+
// @internal
596597
toJSON(): SchemaRequest;
597598
type: SchemaType;
598599
}
@@ -664,7 +665,7 @@ export class StringSchema extends Schema {
664665
constructor(schemaParams?: SchemaParams, enumValues?: string[]);
665666
// (undocumented)
666667
enum?: string[];
667-
// (undocumented)
668+
// @internal (undocumented)
668669
toJSON(): SchemaRequest;
669670
}
670671

‎docs-devsite/_toc.yaml

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

‎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: 2 additions & 2 deletions
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) | [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

@@ -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.

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

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ 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 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. |
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>. |
3031
| [stopSequences](./vertexai-preview.generationconfig.md#generationconfigstopsequences) | string\[\] | |
3132
| [temperature](./vertexai-preview.generationconfig.md#generationconfigtemperature) | number | |
3233
| [topK](./vertexai-preview.generationconfig.md#generationconfigtopk) | number | |
@@ -66,14 +67,24 @@ presencePenalty?: number;
6667

6768
## GenerationConfig.responseMimeType
6869

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.
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).
7071

7172
<b>Signature:</b>
7273

7374
```typescript
7475
responseMimeType?: string;
7576
```
7677

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+
7788
## GenerationConfig.stopSequences
7889

7990
<b>Signature:</b>

0 commit comments

Comments
 (0)