Arize Phoenix TS
    Preparing search index...

    Interface JSONSchema

    Structured Outputs configuration options, including a JSON Schema.

    interface JSONSchema {
        description?: string;
        name: string;
        schema?: { [key: string]: unknown };
        strict?: boolean | null;
    }
    Index

    Properties

    description? name schema? strict?

    Properties

    description?: string

    A description of what the response format is for, used by the model to determine how to respond in the format.

    name: string

    The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

    schema?: { [key: string]: unknown }

    The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.

    strict?: boolean | null

    Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true. To learn more, read the Structured Outputs guide.

    Settings

    Member Visibility

    On This Page

    Properties