Interface StructuredOutputToolMetadata

Metadata about the implicit structured output tool ChatHeroku generates when ChatHeroku.withStructuredOutput binds a schema.

interface StructuredOutputToolMetadata {
    name: string;
    description?: string;
    schema: Record<string, any>;
}

Properties

name: string

Name of the synthetic tool that enforces the schema

description?: string

Optional human-readable description of the structured output

schema: Record<string, any>

JSON schema that the model must satisfy