Interface ResolvedStructuredReply

interface ResolvedStructuredReply {
    name: string;
    description?: string;
    zod?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
    jsonSchema: JsonSchemaObject;
    maxRetries: number;
    onExhausted: "error" | "return_invalid";
    streamDeltas: boolean;
    instruction: string;
    checkValue(value): StructuredCheck;
}

Methods

checkValue

Properties

name description? zod? jsonSchema maxRetries onExhausted streamDeltas instruction

Methods

checkValue

Properties

name

name: string

Optional description

description?: string

Optional zod

zod?: ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

The Zod schema when the spec gave one: the gateway lowers it per provider.

jsonSchema

jsonSchema: JsonSchemaObject

maxRetries

maxRetries: number

onExhausted

onExhausted: "error" | "return_invalid"

streamDeltas

streamDeltas: boolean

instruction

instruction: string

The instruction the system prompt carries: the schema in words the model follows.

Settings

Member Visibility

Theme

On This Page

checkValuenamedescriptionzodjsonSchemamaxRetriesonExhaustedstreamDeltasinstruction