Interface ChatOpenAIStructuredOutputMethodOptions<IncludeRaw>

interface ChatOpenAIStructuredOutputMethodOptions<IncludeRaw> {
    includeRaw?: IncludeRaw;
    method?: string;
    name?: string;
    strict?: boolean;
}

Type Parameters

  • IncludeRaw extends boolean

Hierarchy

  • StructuredOutputMethodOptions<IncludeRaw>
    • ChatOpenAIStructuredOutputMethodOptions

Properties

includeRaw? method? name? strict?

Properties

OptionalincludeRaw

includeRaw?: IncludeRaw

Optionalmethod

method?: string

Optionalname

name?: string

Optionalstrict

strict?: boolean

strict: If true and method = "function_calling", model output is guaranteed to exactly match the schema. If true, the input schema will also be validated according to https://platform.openai.com/docs/guides/structured-outputs/supported-schemas. If false, input schema will not be validated and model output will not be validated. If undefined, strict argument will not be passed to the model.

Version

0.2.6

Note

Planned breaking change in version 0.3.0: strict will default to true when method is "function_calling" as of version 0.3.0.

Settings

Member Visibility

On This Page

Properties