Interface Schema (1.9.0)

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.

Package

@google-cloud/vertexai

Properties

description

description?: string;

Optional. The description of the property.

enum

enum?: string[];

Optional. The enum of the property.

example

example?: unknown;

Optional. The example of the property.

format

format?: string;

Optional. The format of the property.

items

items?: Schema;

Optional. The items of the property. Schema

nullable

nullable?: boolean;

Optional. Whether the property is nullable.

properties

properties?: {
        [k: string]: Schema;
    };

Optional. Map of Schema.

required

required?: string[];

Optional. Array of required property.

type

type?: SchemaType;

Optional. The type of the property. SchemaType.