From bd6486997c3062ab4f8949f30d3810a60440cf50 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Tue, 24 Sep 2024 10:20:00 -0700 Subject: [PATCH] remove other added docs --- docs-devsite/vertexai-preview.arrayschema.md | 57 ---- .../vertexai-preview.booleanschema.md | 43 --- .../vertexai-preview.integerschema.md | 43 --- docs-devsite/vertexai-preview.numberschema.md | 43 --- docs-devsite/vertexai-preview.objectschema.md | 71 ----- .../vertexai-preview.objectschemainterface.md | 43 --- docs-devsite/vertexai-preview.schema.md | 250 ------------------ .../vertexai-preview.schemainterface.md | 36 --- docs-devsite/vertexai-preview.schemaparams.md | 21 -- .../vertexai-preview.schemarequest.md | 47 ---- docs-devsite/vertexai-preview.schemashared.md | 103 -------- docs-devsite/vertexai-preview.stringschema.md | 57 ---- 12 files changed, 814 deletions(-) delete mode 100644 docs-devsite/vertexai-preview.arrayschema.md delete mode 100644 docs-devsite/vertexai-preview.booleanschema.md delete mode 100644 docs-devsite/vertexai-preview.integerschema.md delete mode 100644 docs-devsite/vertexai-preview.numberschema.md delete mode 100644 docs-devsite/vertexai-preview.objectschema.md delete mode 100644 docs-devsite/vertexai-preview.objectschemainterface.md delete mode 100644 docs-devsite/vertexai-preview.schema.md delete mode 100644 docs-devsite/vertexai-preview.schemainterface.md delete mode 100644 docs-devsite/vertexai-preview.schemaparams.md delete mode 100644 docs-devsite/vertexai-preview.schemarequest.md delete mode 100644 docs-devsite/vertexai-preview.schemashared.md delete mode 100644 docs-devsite/vertexai-preview.stringschema.md diff --git a/docs-devsite/vertexai-preview.arrayschema.md b/docs-devsite/vertexai-preview.arrayschema.md deleted file mode 100644 index a9e76e651af..00000000000 --- a/docs-devsite/vertexai-preview.arrayschema.md +++ /dev/null @@ -1,57 +0,0 @@ -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. - -Signature: - -```typescript -export declare class ArraySchema extends Schema -``` -Extends: [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 ArraySchema 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 - -Signature: - -```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 - -Signature: - -```typescript -items: TypedSchema; -``` diff --git a/docs-devsite/vertexai-preview.booleanschema.md b/docs-devsite/vertexai-preview.booleanschema.md deleted file mode 100644 index f85a2a7f2bf..00000000000 --- a/docs-devsite/vertexai-preview.booleanschema.md +++ /dev/null @@ -1,43 +0,0 @@ -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. - -Signature: - -```typescript -export declare class BooleanSchema extends Schema -``` -Extends: [Schema](./vertexai-preview.schema.md#schema_class) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(schemaParams)](./vertexai-preview.booleanschema.md#booleanschemaconstructor) | | Constructs a new instance of the BooleanSchema class | - -## BooleanSchema.(constructor) - -Constructs a new instance of the `BooleanSchema` class - -Signature: - -```typescript -constructor(schemaParams?: SchemaParams); -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | | - diff --git a/docs-devsite/vertexai-preview.integerschema.md b/docs-devsite/vertexai-preview.integerschema.md deleted file mode 100644 index 5b683e8d3e0..00000000000 --- a/docs-devsite/vertexai-preview.integerschema.md +++ /dev/null @@ -1,43 +0,0 @@ -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 %} - -# IntegerSchema class -Schema class for "integer" types. - -Signature: - -```typescript -export declare class IntegerSchema extends Schema -``` -Extends: [Schema](./vertexai-preview.schema.md#schema_class) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(schemaParams)](./vertexai-preview.integerschema.md#integerschemaconstructor) | | Constructs a new instance of the IntegerSchema class | - -## IntegerSchema.(constructor) - -Constructs a new instance of the `IntegerSchema` class - -Signature: - -```typescript -constructor(schemaParams?: SchemaParams); -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | | - diff --git a/docs-devsite/vertexai-preview.numberschema.md b/docs-devsite/vertexai-preview.numberschema.md deleted file mode 100644 index 5470ab42c54..00000000000 --- a/docs-devsite/vertexai-preview.numberschema.md +++ /dev/null @@ -1,43 +0,0 @@ -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 %} - -# NumberSchema class -Schema class for "number" types. - -Signature: - -```typescript -export declare class NumberSchema extends Schema -``` -Extends: [Schema](./vertexai-preview.schema.md#schema_class) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(schemaParams)](./vertexai-preview.numberschema.md#numberschemaconstructor) | | Constructs a new instance of the NumberSchema class | - -## NumberSchema.(constructor) - -Constructs a new instance of the `NumberSchema` class - -Signature: - -```typescript -constructor(schemaParams?: SchemaParams); -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | | - diff --git a/docs-devsite/vertexai-preview.objectschema.md b/docs-devsite/vertexai-preview.objectschema.md deleted file mode 100644 index c1287955597..00000000000 --- a/docs-devsite/vertexai-preview.objectschema.md +++ /dev/null @@ -1,71 +0,0 @@ -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 %} - -# ObjectSchema class -Schema class for "object" types. The `properties` param must be a map of Schema. - -Signature: - -```typescript -export declare class ObjectSchema extends Schema -``` -Extends: [Schema](./vertexai-preview.schema.md#schema_class) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(schemaParams, properties, optionalProperties)](./vertexai-preview.objectschema.md#objectschemaconstructor) | | Constructs a new instance of the ObjectSchema class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [optionalProperties](./vertexai-preview.objectschema.md#objectschemaoptionalproperties) | | string\[\] | | -| [properties](./vertexai-preview.objectschema.md#objectschemaproperties) | | { \[k: string\]: [TypedSchema](./vertexai-preview.md#typedschema); } | | - -## ObjectSchema.(constructor) - -Constructs a new instance of the `ObjectSchema` class - -Signature: - -```typescript -constructor(schemaParams: SchemaParams, properties: { - [k: string]: TypedSchema; - }, optionalProperties?: string[]); -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | | -| properties | { \[k: string\]: [TypedSchema](./vertexai-preview.md#typedschema); } | | -| optionalProperties | string\[\] | | - -## ObjectSchema.optionalProperties - -Signature: - -```typescript -optionalProperties: string[]; -``` - -## ObjectSchema.properties - -Signature: - -```typescript -properties: { - [k: string]: TypedSchema; - }; -``` diff --git a/docs-devsite/vertexai-preview.objectschemainterface.md b/docs-devsite/vertexai-preview.objectschemainterface.md deleted file mode 100644 index 4bc9ebfc3d1..00000000000 --- a/docs-devsite/vertexai-preview.objectschemainterface.md +++ /dev/null @@ -1,43 +0,0 @@ -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 %} - -# ObjectSchemaInterface interface -Interface for [ObjectSchema](./vertexai-preview.objectschema.md#objectschema_class) class. - -Signature: - -```typescript -export interface ObjectSchemaInterface extends SchemaInterface -``` -Extends: [SchemaInterface](./vertexai-preview.schemainterface.md#schemainterface_interface) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [optionalProperties](./vertexai-preview.objectschemainterface.md#objectschemainterfaceoptionalproperties) | string\[\] | | -| [type](./vertexai-preview.objectschemainterface.md#objectschemainterfacetype) | [SchemaType.OBJECT](./vertexai-preview.md#schematypeobject_enummember) | | - -## ObjectSchemaInterface.optionalProperties - -Signature: - -```typescript -optionalProperties?: string[]; -``` - -## ObjectSchemaInterface.type - -Signature: - -```typescript -type: SchemaType.OBJECT; -``` diff --git a/docs-devsite/vertexai-preview.schema.md b/docs-devsite/vertexai-preview.schema.md deleted file mode 100644 index 25c3fc5e067..00000000000 --- a/docs-devsite/vertexai-preview.schema.md +++ /dev/null @@ -1,250 +0,0 @@ -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 %} - -# Schema class -Parent class encompassing all Schema types, with static methods that allow building specific Schema types. This class can be converted with `JSON.stringify()` into a JSON string accepted by Vertex AI REST endpoints. (This string conversion is automatically done when calling SDK methods.) - -Signature: - -```typescript -export declare abstract class Schema implements SchemaInterface -``` -Implements: [SchemaInterface](./vertexai-preview.schemainterface.md#schemainterface_interface) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(schemaParams)](./vertexai-preview.schema.md#schemaconstructor) | | Constructs a new instance of the Schema class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [description](./vertexai-preview.schema.md#schemadescription) | | string | Optional. The description of the property. | -| [example](./vertexai-preview.schema.md#schemaexample) | | unknown | Optional. The example of the property. | -| [format](./vertexai-preview.schema.md#schemaformat) | | string | Optional. The format of the property. Supported formats:
| -| [nullable](./vertexai-preview.schema.md#schemanullable) | | boolean | Optional. Whether the property is nullable. Defaults to false. | -| [type](./vertexai-preview.schema.md#schematype) | | [SchemaType](./vertexai-preview.md#schematype) | Optional. The type of the property. [SchemaType](./vertexai-preview.md#schematype). | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [array(arrayParams)](./vertexai-preview.schema.md#schemaarray) | static | | -| [boolean(booleanParams)](./vertexai-preview.schema.md#schemaboolean) | static | | -| [enumString(stringParams)](./vertexai-preview.schema.md#schemaenumstring) | static | | -| [integer(integerParams)](./vertexai-preview.schema.md#schemainteger) | static | | -| [number(numberParams)](./vertexai-preview.schema.md#schemanumber) | static | | -| [object(objectParams)](./vertexai-preview.schema.md#schemaobject) | static | | -| [string(stringParams)](./vertexai-preview.schema.md#schemastring) | static | | - -## Schema.(constructor) - -Constructs a new instance of the `Schema` class - -Signature: - -```typescript -constructor(schemaParams: SchemaInterface); -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| schemaParams | [SchemaInterface](./vertexai-preview.schemainterface.md#schemainterface_interface) | | - -## Schema.description - -Optional. The description of the property. - -Signature: - -```typescript -description?: string; -``` - -## Schema.example - -Optional. The example of the property. - -Signature: - -```typescript -example?: unknown; -``` - -## Schema.format - -Optional. The format of the property. Supported formats:
- -Signature: - -```typescript -format?: string; -``` - -## Schema.nullable - -Optional. Whether the property is nullable. Defaults to false. - -Signature: - -```typescript -nullable: boolean; -``` - -## Schema.type - -Optional. The type of the property. [SchemaType](./vertexai-preview.md#schematype). - -Signature: - -```typescript -type: SchemaType; -``` - -## Schema.array() - -Signature: - -```typescript -static array(arrayParams: SchemaParams & { - items: Schema; - }): ArraySchema; -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| arrayParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) & { items: [Schema](./vertexai-preview.schema.md#schema_class); } | | - -Returns: - -[ArraySchema](./vertexai-preview.arrayschema.md#arrayschema_class) - -## Schema.boolean() - -Signature: - -```typescript -static boolean(booleanParams?: SchemaParams): BooleanSchema; -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| booleanParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | | - -Returns: - -[BooleanSchema](./vertexai-preview.booleanschema.md#booleanschema_class) - -## Schema.enumString() - -Signature: - -```typescript -static enumString(stringParams: SchemaParams & { - enum: string[]; - }): StringSchema; -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| stringParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) & { enum: string\[\]; } | | - -Returns: - -[StringSchema](./vertexai-preview.stringschema.md#stringschema_class) - -## Schema.integer() - -Signature: - -```typescript -static integer(integerParams?: SchemaParams): IntegerSchema; -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| integerParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | | - -Returns: - -[IntegerSchema](./vertexai-preview.integerschema.md#integerschema_class) - -## Schema.number() - -Signature: - -```typescript -static number(numberParams?: SchemaParams): NumberSchema; -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| numberParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | | - -Returns: - -[NumberSchema](./vertexai-preview.numberschema.md#numberschema_class) - -## Schema.object() - -Signature: - -```typescript -static object(objectParams: SchemaParams & { - properties: { - [k: string]: Schema; - }; - optionalProperties?: string[]; - }): ObjectSchema; -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| objectParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) & { properties: { \[k: string\]: [Schema](./vertexai-preview.schema.md#schema_class); }; optionalProperties?: string\[\]; } | | - -Returns: - -[ObjectSchema](./vertexai-preview.objectschema.md#objectschema_class) - -## Schema.string() - -Signature: - -```typescript -static string(stringParams?: SchemaParams): StringSchema; -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| stringParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | | - -Returns: - -[StringSchema](./vertexai-preview.stringschema.md#stringschema_class) - diff --git a/docs-devsite/vertexai-preview.schemainterface.md b/docs-devsite/vertexai-preview.schemainterface.md deleted file mode 100644 index 306493e4097..00000000000 --- a/docs-devsite/vertexai-preview.schemainterface.md +++ /dev/null @@ -1,36 +0,0 @@ -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 %} - -# SchemaInterface interface -Interface for [Schema](./vertexai-preview.schema.md#schema_class) class. - -Signature: - -```typescript -export interface SchemaInterface extends SchemaShared -``` -Extends: [SchemaShared](./vertexai-preview.schemashared.md#schemashared_interface)<[SchemaInterface](./vertexai-preview.schemainterface.md#schemainterface_interface)> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [type](./vertexai-preview.schemainterface.md#schemainterfacetype) | [SchemaType](./vertexai-preview.md#schematype) | The type of the property. [SchemaType](./vertexai-preview.md#schematype). | - -## SchemaInterface.type - -The type of the property. [SchemaType](./vertexai-preview.md#schematype). - -Signature: - -```typescript -type: SchemaType; -``` diff --git a/docs-devsite/vertexai-preview.schemaparams.md b/docs-devsite/vertexai-preview.schemaparams.md deleted file mode 100644 index d57b88c803d..00000000000 --- a/docs-devsite/vertexai-preview.schemaparams.md +++ /dev/null @@ -1,21 +0,0 @@ -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 %} - -# SchemaParams interface -Params passed to [Schema](./vertexai-preview.schema.md#schema_class) static methods to create specific [Schema](./vertexai-preview.schema.md#schema_class) classes. - -Signature: - -```typescript -export interface SchemaParams extends SchemaShared -``` -Extends: [SchemaShared](./vertexai-preview.schemashared.md#schemashared_interface)<[SchemaInterface](./vertexai-preview.schemainterface.md#schemainterface_interface)> - diff --git a/docs-devsite/vertexai-preview.schemarequest.md b/docs-devsite/vertexai-preview.schemarequest.md deleted file mode 100644 index e011cfb29b6..00000000000 --- a/docs-devsite/vertexai-preview.schemarequest.md +++ /dev/null @@ -1,47 +0,0 @@ -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 %} - -# SchemaRequest interface -Final format for [Schema](./vertexai-preview.schema.md#schema_class) params passed to backend requests. - -Signature: - -```typescript -export interface SchemaRequest extends SchemaShared -``` -Extends: [SchemaShared](./vertexai-preview.schemashared.md#schemashared_interface)<[SchemaRequest](./vertexai-preview.schemarequest.md#schemarequest_interface)> - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [required](./vertexai-preview.schemarequest.md#schemarequestrequired) | string\[\] | Optional. Array of required property. | -| [type](./vertexai-preview.schemarequest.md#schemarequesttype) | [SchemaType](./vertexai-preview.md#schematype) | The type of the property. [SchemaType](./vertexai-preview.md#schematype). | - -## SchemaRequest.required - -Optional. Array of required property. - -Signature: - -```typescript -required?: string[]; -``` - -## SchemaRequest.type - -The type of the property. [SchemaType](./vertexai-preview.md#schematype). - -Signature: - -```typescript -type: SchemaType; -``` diff --git a/docs-devsite/vertexai-preview.schemashared.md b/docs-devsite/vertexai-preview.schemashared.md deleted file mode 100644 index 43063b3f1fc..00000000000 --- a/docs-devsite/vertexai-preview.schemashared.md +++ /dev/null @@ -1,103 +0,0 @@ -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 %} - -# SchemaShared interface -Basic [Schema](./vertexai-preview.schema.md#schema_class) properties shared across several Schema-related types. - -Signature: - -```typescript -export interface SchemaShared -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [description](./vertexai-preview.schemashared.md#schemashareddescription) | string | Optional. The description of the property. | -| [enum](./vertexai-preview.schemashared.md#schemasharedenum) | string\[\] | Optional. The enum of the property. | -| [example](./vertexai-preview.schemashared.md#schemasharedexample) | unknown | Optional. The example of the property. | -| [format](./vertexai-preview.schemashared.md#schemasharedformat) | string | Optional. The format of the property. | -| [items](./vertexai-preview.schemashared.md#schemashareditems) | T | Optional. The items of the property. | -| [nullable](./vertexai-preview.schemashared.md#schemasharednullable) | boolean | Optional. Whether the property is nullable. | -| [properties](./vertexai-preview.schemashared.md#schemasharedproperties) | { \[k: string\]: T; } | Optional. Map of Schemas. | - -## SchemaShared.description - -Optional. The description of the property. - -Signature: - -```typescript -description?: string; -``` - -## SchemaShared.enum - -Optional. The enum of the property. - -Signature: - -```typescript -enum?: string[]; -``` - -## SchemaShared.example - -Optional. The example of the property. - -Signature: - -```typescript -example?: unknown; -``` - -## SchemaShared.format - -Optional. The format of the property. - -Signature: - -```typescript -format?: string; -``` - -## SchemaShared.items - -Optional. The items of the property. - -Signature: - -```typescript -items?: T; -``` - -## SchemaShared.nullable - -Optional. Whether the property is nullable. - -Signature: - -```typescript -nullable?: boolean; -``` - -## SchemaShared.properties - -Optional. Map of Schemas. - -Signature: - -```typescript -properties?: { - [k: string]: T; - }; -``` diff --git a/docs-devsite/vertexai-preview.stringschema.md b/docs-devsite/vertexai-preview.stringschema.md deleted file mode 100644 index 4701b90838a..00000000000 --- a/docs-devsite/vertexai-preview.stringschema.md +++ /dev/null @@ -1,57 +0,0 @@ -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 %} - -# StringSchema class -Schema class for "string" types. Can be used with or without enum values. - -Signature: - -```typescript -export declare class StringSchema extends Schema -``` -Extends: [Schema](./vertexai-preview.schema.md#schema_class) - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(schemaParams, enumValues)](./vertexai-preview.stringschema.md#stringschemaconstructor) | | Constructs a new instance of the StringSchema class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [enum](./vertexai-preview.stringschema.md#stringschemaenum) | | string\[\] | | - -## StringSchema.(constructor) - -Constructs a new instance of the `StringSchema` class - -Signature: - -```typescript -constructor(schemaParams?: SchemaParams, enumValues?: string[]); -``` - -#### Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| schemaParams | [SchemaParams](./vertexai-preview.schemaparams.md#schemaparams_interface) | | -| enumValues | string\[\] | | - -## StringSchema.enum - -Signature: - -```typescript -enum?: string[]; -```