SchemaShared interface

bookmark_border Stay organized with collections Save and categorize content based on your preferences.

Basic Schema properties shared across several Schema-related types.

Signature:

export interface SchemaShared<T> 

Properties

SchemaShared.anyOf

An array of Schema. The generated data must be valid against any of the schemas listed in this array. This allows specifying multiple possible structures or types for a single field.

Signature:

anyOf?: T[];

SchemaShared.description

Optional. The description of the property.

Signature:

description?: string;

SchemaShared.enum

Optional. The enum of the property.

Signature:

enum?: string[];

SchemaShared.example

Optional. The example of the property.

Signature:

example?: unknown;

SchemaShared.format

Optional. The format of the property. When using the Gemini Developer API (GoogleAIBackend), this must be either 'enum' or 'date-time', otherwise requests will fail.

Signature:

format?: string;

SchemaShared.items

Optional. The items of the property.

Signature:

items?: T;

SchemaShared.maximum

The maximum value of a numeric type.

Signature:

maximum?: number;

SchemaShared.maxItems

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

Signature:

maxItems?: number;

SchemaShared.minimum

The minimum value of a numeric type.

Signature:

minimum?: number;

SchemaShared.minItems

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

Signature:

minItems?: number;

SchemaShared.nullable

Optional. Whether the property is nullable.

Signature:

nullable?: boolean;

SchemaShared.properties

Optional. Map of Schema objects.

Signature:

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

SchemaShared.propertyOrdering

A hint suggesting the order in which the keys should appear in the generated JSON string.

Signature:

propertyOrdering?: string[];

SchemaShared.title

The title of the property. This helps document the schema's purpose but does not typically constrain the generated value. It can subtly guide the model by clarifying the intent of a field.

Signature:

title?: string;