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

Constructors

Constructor	Modifiers	Description
(constructor)(schemaParams)		Constructs a new instance of the <code>Schema</code> class

Properties

Property	Type	Description
description	string	Optional. The description of the property.
example	unknown	Optional. The example of the property.
format	string	Optional. The format of the property. Supported formats:

<ul> <li>for NUMBER type: "float", "double"</li> <li>for INTEGER type: "int32", "int64"</li> <li>for STRING type: "email", "byte", etc</li> </ul> | | [items](./ai.schema.md#schemaitems) | | [SchemaInterface](./ai.schemainterface.md#schemainterface_interface) | Optional. The items of the property. | | [maxItems](./ai.schema.md#schemamaxitems) | | number | The maximum number of items (elements) in a schema of [SchemaType](./ai.md#schematype) <code>array</code>. | | [minItems](./ai.schema.md#schemaminitems) | | number | The minimum number of items (elements) in a schema of [SchemaType](./ai.md#schematype) <code>array</code>. | | [nullable](./ai.schema.md#schemanullable) | | boolean | Optional. Whether the property is nullable. Defaults to false. | | [type](./ai.schema.md#schematype) | | [SchemaType](./ai.md#schematype) | Optional. The type of the property. This can only be undefined when using <code>anyOf</code> schemas, which do not have an explicit type in the [OpenAPI specification](https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type). |

Methods

Method	Modifiers	Description
anyOf(anyOfParams)	<code>static</code>
array(arrayParams)	<code>static</code>
boolean(booleanParams)	<code>static</code>
enumString(stringParams)	<code>static</code>
integer(integerParams)	<code>static</code>
number(numberParams)	<code>static</code>
object(objectParams)	<code>static</code>
string(stringParams)	<code>static</code>

Schema.(constructor)

Constructs a new instance of the Schema class

Signature:

typescript

constructor(schemaParams: SchemaInterface);

Parameters

Parameter	Type	Description
schemaParams	SchemaInterface

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:

<ul> <li>for NUMBER type: "float", "double"</li> <li>for INTEGER type: "int32", "int64"</li> <li>for STRING type: "email", "byte", etc</li> </ul>

Signature:

typescript

format?: string;

Schema.items

Optional. The items of the property.

Signature:

typescript

items?: SchemaInterface;

Schema.maxItems

The maximum number of items (elements) in a schema of SchemaType array.

Signature:

typescript

maxItems?: number;

Schema.minItems

The minimum number of items (elements) in a schema of SchemaType array.

Signature:

typescript

minItems?: number;

Schema.nullable

Optional. Whether the property is nullable. Defaults to false.

Signature:

typescript

nullable: boolean;

Schema.type

Optional. The type of the property. This can only be undefined when using anyOf schemas, which do not have an explicit type in the OpenAPI specification.

Signature:

typescript

type?: SchemaType;

Schema.anyOf()

Signature:

typescript

static anyOf(anyOfParams: SchemaParams & {
        anyOf: TypedSchema[];
    }): AnyOfSchema;

Parameters

Parameter	Type	Description
anyOfParams	SchemaParams & { anyOf: TypedSchema<!-- -->[]; }

Returns:

AnyOfSchema

Schema.array()

Signature:

typescript

static array(arrayParams: SchemaParams & {
        items: Schema;
    }): ArraySchema;

Parameters

Parameter	Type	Description
arrayParams	SchemaParams & { items: Schema<!-- -->; }

Returns:

ArraySchema

Schema.boolean()

Signature:

typescript

static boolean(booleanParams?: SchemaParams): BooleanSchema;

Parameters

Parameter	Type	Description
booleanParams	SchemaParams

Returns:

BooleanSchema

Schema.enumString()

Signature:

typescript

static enumString(stringParams: SchemaParams & {
        enum: string[];
    }): StringSchema;

Parameters

Parameter	Type	Description
stringParams	SchemaParams & { enum: string[]; }

Returns:

StringSchema

Schema.integer()

Signature:

typescript

static integer(integerParams?: SchemaParams): IntegerSchema;

Parameters

Parameter	Type	Description
integerParams	SchemaParams

Returns:

IntegerSchema

Schema.number()

Signature:

typescript

static number(numberParams?: SchemaParams): NumberSchema;

Parameters

Parameter	Type	Description
numberParams	SchemaParams

Returns:

NumberSchema

Schema.object()

Signature:

typescript

static object(objectParams: SchemaParams & {
        properties: {
            [k: string]: Schema;
        };
        optionalProperties?: string[];
    }): ObjectSchema;

Parameters

Parameter	Type	Description
objectParams	SchemaParams & { properties: { [k: string]: Schema<!-- -->; }; optionalProperties?: string[]; }

Returns:

ObjectSchema

Schema.string()

Signature:

typescript

static string(stringParams?: SchemaParams): StringSchema;

Parameters

Parameter	Type	Description
stringParams	SchemaParams

Returns:

StringSchema