Skip to content

JsonSchemaDefinitionDict

Dictionary Type

JsonSchemaDefinitionDict

Bases: TypedDict

Dictionary form of JsonSchemaDefinition.

Attributes

description instance-attribute
description: str | None

A description of the JSON schema.

name instance-attribute
name: str | None

The name of the JSON schema.

schema instance-attribute
schema: Required[str]

The JSON schema to constrain the model's output. For more information, see JSON Schema Reference.