SchemaShared interface

Basic Schema properties shared across several Schema-related types.

Signature:

export interface SchemaShared<T>

Properties

Property Type Description
description string Optional. The description of the property.
enum string[] Optional. The enum of the property.
example unknown Optional. The example of the property.
format string 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.
items T Optional. The items of the property.
nullable boolean Optional. Whether the property is nullable.
properties { [k: string]: T; } Optional. Map of Schema objects.

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.nullable

Optional. Whether the property is nullable.

Signature:

nullable?: boolean;

SchemaShared.properties

Optional. Map of Schema objects.

Signature:

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