Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hsubox76 committed Sep 19, 2024
1 parent 9d327c9 commit 442a708
Show file tree
Hide file tree
Showing 23 changed files with 907 additions and 808 deletions.
7 changes: 4 additions & 3 deletions common/api-review/vertexai-preview.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export class ArraySchema extends Schema {
constructor(schemaParams: SchemaParams, items: TypedSchema);
// (undocumented)
items: TypedSchema;
// (undocumented)
// @internal (undocumented)
toJSON(): SchemaRequest;
}

Expand Down Expand Up @@ -491,7 +491,7 @@ export class ObjectSchema extends Schema {
properties: {
[k: string]: TypedSchema;
};
// (undocumented)
// @internal (undocumented)
toJSON(): SchemaRequest;
}

Expand Down Expand Up @@ -593,6 +593,7 @@ export abstract class Schema implements SchemaInterface {
}): ObjectSchema;
// (undocumented)
static string(stringParams?: SchemaParams): StringSchema;
// @internal
toJSON(): SchemaRequest;
type: SchemaType;
}
Expand Down Expand Up @@ -664,7 +665,7 @@ export class StringSchema extends Schema {
constructor(schemaParams?: SchemaParams, enumValues?: string[]);
// (undocumented)
enum?: string[];
// (undocumented)
// @internal (undocumented)
toJSON(): SchemaRequest;
}

Expand Down
559 changes: 0 additions & 559 deletions docs-devsite/_toc.yaml

This file was deleted.

57 changes: 57 additions & 0 deletions docs-devsite/vertexai-preview.arrayschema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# ArraySchema class
Schema class for "array" types. The `items` param should refer to the type of item that can be a member of the array.

<b>Signature:</b>

```typescript
export declare class ArraySchema extends Schema
```
<b>Extends:</b> [Schema](./vertexai-preview.schema.md#schema_class)
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(schemaParams, items)](./vertexai-preview.arrayschema.md#arrayschemaconstructor) | | Constructs a new instance of the <code>ArraySchema</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [items](./vertexai-preview.arrayschema.md#arrayschemaitems) | | [TypedSchema](./vertexai-preview.md#typedschema) | |
## ArraySchema.(constructor)
Constructs a new instance of the `ArraySchema` class
<b>Signature:</b>
```typescript
constructor(schemaParams: SchemaParams, items: TypedSchema);
```
#### Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | |
| items | [TypedSchema](./vertexai-preview.md#typedschema) | |
## ArraySchema.items
<b>Signature:</b>
```typescript
items: TypedSchema;
```
43 changes: 43 additions & 0 deletions docs-devsite/vertexai-preview.booleanschema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# BooleanSchema class
Schema class for "boolean" types.

<b>Signature:</b>

```typescript
export declare class BooleanSchema extends Schema
```
<b>Extends:</b> [Schema](./vertexai-preview.schema.md#schema_class)
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(schemaParams)](./vertexai-preview.booleanschema.md#booleanschemaconstructor) | | Constructs a new instance of the <code>BooleanSchema</code> class |
## BooleanSchema.(constructor)
Constructs a new instance of the `BooleanSchema` class
<b>Signature:</b>
```typescript
constructor(schemaParams?: SchemaParams);
```
#### Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | |
4 changes: 2 additions & 2 deletions docs-devsite/vertexai-preview.functiondeclaration.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export declare interface FunctionDeclaration
| --- | --- | --- |
| [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. |
| [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. |
| [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. |
| [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. |

## FunctionDeclaration.description

Expand Down Expand Up @@ -53,5 +53,5 @@ Optional. Describes the parameters to this function in JSON Schema Object format
<b>Signature:</b>

```typescript
parameters?: FunctionDeclarationSchema;
parameters?: ObjectSchemaInterface;
```
70 changes: 0 additions & 70 deletions docs-devsite/vertexai-preview.functiondeclarationschema.md

This file was deleted.

125 changes: 0 additions & 125 deletions docs-devsite/vertexai-preview.functiondeclarationschemaproperty.md

This file was deleted.

15 changes: 13 additions & 2 deletions docs-devsite/vertexai-preview.generationconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ export interface GenerationConfig
| [frequencyPenalty](./vertexai-preview.generationconfig.md#generationconfigfrequencypenalty) | number | |
| [maxOutputTokens](./vertexai-preview.generationconfig.md#generationconfigmaxoutputtokens) | number | |
| [presencePenalty](./vertexai-preview.generationconfig.md#generationconfigpresencepenalty) | number | |
| [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. |
| [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). |
| [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>. |
| [stopSequences](./vertexai-preview.generationconfig.md#generationconfigstopsequences) | string\[\] | |
| [temperature](./vertexai-preview.generationconfig.md#generationconfigtemperature) | number | |
| [topK](./vertexai-preview.generationconfig.md#generationconfigtopk) | number | |
Expand Down Expand Up @@ -66,14 +67,24 @@ presencePenalty?: number;

## GenerationConfig.responseMimeType

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

<b>Signature:</b>

```typescript
responseMimeType?: string;
```

## GenerationConfig.responseSchema

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`<!-- -->.

<b>Signature:</b>

```typescript
responseSchema?: TypedSchema | SchemaRequest;
```

## GenerationConfig.stopSequences

<b>Signature:</b>
Expand Down
Loading

0 comments on commit 442a708

Please sign in to comment.