View Source ExOpenAI.Components.ResponseFormatJsonSchema (ex_openai.ex v2.0.0-beta2)

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

Fields

:json_schema - required - {:%{}, [], [{{:optional, [], [:description]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:required, [], [:name]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:optional, [], [:schema]}, {{:., [], [ExOpenAI.Components.ResponseFormatJsonSchemaSchema, :t]}, [], []}}, {{:optional, [], [:strict]}, {:|, [], [{:boolean, [], []}, {:any, [], []}]}}]}
Structured Outputs configuration options, including a JSON Schema.
:type - required - :json_schema
The type of response format being defined. Always json_schema.
Allowed values: "json_schema"

Summary

Types

t()

Types

t()

@type t() :: %ExOpenAI.Components.ResponseFormatJsonSchema{
  json_schema: %{
    optional(:description) => String.t(),
    :name => String.t(),
    optional(:schema) => ExOpenAI.Components.ResponseFormatJsonSchemaSchema.t(),
    optional(:strict) => boolean() | any()
  },
  type: :json_schema
}