Interface StructuredOutputSchema

JSON output schema for structured content repsonses. This schema dictates the format that an AI should use when responding to your instructions.

Export

Interface

StructuredOutputSchema

Hierarchy

  • StructuredOutputSchema

Properties

_default?: object

Memberof

StructuredOutputSchema

_enum?: string[]

When using type string and format enum pass a collection of enum values here.

Memberof

StructuredOutputSchema

Memberof

StructuredOutputSchema

description?: string

Provide a description of the schema to help the AI understand the schema.

Memberof

StructuredOutputSchema

example?: object

Memberof

StructuredOutputSchema

format?: string

Format for string types. Can be null, date-time or enum.

Memberof

StructuredOutputSchema

Memberof

StructuredOutputSchema

maxItems?: number

Memberof

StructuredOutputSchema

maxLength?: number

Memberof

StructuredOutputSchema

maxProperties?: number

Memberof

StructuredOutputSchema

maximum?: number

Memberof

StructuredOutputSchema

minItems?: number

Memberof

StructuredOutputSchema

minLength?: number

Memberof

StructuredOutputSchema

minProperties?: number

Memberof

StructuredOutputSchema

minimum?: number

Memberof

StructuredOutputSchema

nullable?: boolean

Memberof

StructuredOutputSchema

pattern?: string

Memberof

StructuredOutputSchema

properties?: {
    [key: string]: StructuredOutputSchema;
}

Properties of an OBJECT schema. These are key value pairs where the key is the property name and the value is the schema for that property.

Memberof

StructuredOutputSchema

Type declaration

propertyOrdering?: string[]

Pass an array of property names to specify the order of properties in the generated JSON object if required.

Memberof

StructuredOutputSchema

required?: string[]

Memberof

StructuredOutputSchema

title?: string

Memberof

StructuredOutputSchema

Primitive JSON schema types with a fallback CUSTOM for unknown values.

Memberof

StructuredOutputSchema