GoogleCloudAiplatformV1Schema

import type { GoogleCloudAiplatformV1Schema } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";

Defines the schema of input and output data. This is a subset of the OpenAPI 3.0 Schema Object.

interface GoogleCloudAiplatformV1Schema {

additionalProperties?: any;

anyOf?: GoogleCloudAiplatformV1Schema[];

default?: any;

defs?: {

[key: string]: GoogleCloudAiplatformV1Schema;

};

description?: string;

enum?: string[];

example?: any;

format?: string;

items?: GoogleCloudAiplatformV1Schema;

maximum?: number;

maxItems?: bigint;

maxLength?: bigint;

maxProperties?: bigint;

minimum?: number;

minItems?: bigint;

minLength?: bigint;

minProperties?: bigint;

nullable?: boolean;

pattern?: string;

properties?: {

[key: string]: GoogleCloudAiplatformV1Schema;

};

propertyOrdering?: string[];

ref?: string;

required?: string[];

title?: string;

type?:

| "TYPE_UNSPECIFIED"

| "STRING"

| "NUMBER"

| "INTEGER"

| "BOOLEAN"

| "ARRAY"

| "OBJECT"

| "NULL";

}

§Properties

additionalProperties?: any

[src]

Optional. If type is OBJECT, specifies how to handle properties not defined in properties. If it is a boolean false, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.

anyOf?: GoogleCloudAiplatformV1Schema[]

[src]

Optional. The instance must be valid against any (one or more) of the subschemas listed in any_of.

default?: any

[src]

Optional. Default value to use if the field is not specified.

defs?: {

[key: string]: GoogleCloudAiplatformV1Schema;

}

[src]

Optional. defs provides a map of schema definitions that can be reused by ref elsewhere in the schema. Only allowed at root level of the schema.

description?: string

[src]

Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.

enum?: string[]

[src]

Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set format to enum and provide the list of possible values in enum. For example:

To define directions: {type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]} 2. To define apartment numbers: {type:INTEGER, format:enum, enum:["101", "201", "301"]}

example?: any

[src]

Optional. Example of an instance of this schema.

format?: string

[src]

Optional. The format of the data. For NUMBER type, format can be float or double. For INTEGER type, format can be int32 or int64. For STRING type, format can be email, byte, date, date-time, password, and other formats to further refine the data type.

items?: GoogleCloudAiplatformV1Schema

[src]

Optional. If type is ARRAY, items specifies the schema of elements in the array.

maximum?: number

[src]

Optional. If type is INTEGER or NUMBER, maximum specifies the maximum allowed value.

maxItems?: bigint

[src]

Optional. If type is ARRAY, max_items specifies the maximum number of items in an array.

maxLength?: bigint

[src]

Optional. If type is STRING, max_length specifies the maximum length of the string.

maxProperties?: bigint

[src]

Optional. If type is OBJECT, max_properties specifies the maximum number of properties that can be provided.

minimum?: number

[src]

Optional. If type is INTEGER or NUMBER, minimum specifies the minimum allowed value.

minItems?: bigint

[src]

Optional. If type is ARRAY, min_items specifies the minimum number of items in an array.

minLength?: bigint

[src]

Optional. If type is STRING, min_length specifies the minimum length of the string.

minProperties?: bigint

[src]

Optional. If type is OBJECT, min_properties specifies the minimum number of properties that can be provided.

nullable?: boolean

[src]

Optional. Indicates if the value of this field can be null.

pattern?: string

[src]

Optional. If type is STRING, pattern specifies a regular expression that the string must match.

properties?: {

[key: string]: GoogleCloudAiplatformV1Schema;

}

[src]

Optional. If type is OBJECT, properties is a map of property names to schema definitions for each property of the object.

propertyOrdering?: string[]

[src]

Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.

ref?: string

[src]

Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in defs. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring

required?: string[]

[src]

Optional. If type is OBJECT, required lists the names of properties that must be present.

title?: string

[src]

Optional. Title for the schema.

[src]

Optional. Data type of the schema field.