The StructuredOutputField object

One value to extract from a call (an entry of an assistant's structured_output_config), or one parameter of a custom tool (an entry of its input_schema).

{
  "name": "budget",
  "type": "string",
  "description": "Books a slot in the agenda.",
  "required": false,
  "enum_options": ["enum option"]
}

Returned by

Fields

namestring
Name of the value (e.g. 'email', 'budget'). In an assistant's structured_output_config, its key in the call attempt's structured_output; in a custom tool's input_schema, the name of the parameter passed to the tool.
Example "budget"at least 1 character
typeenum (6 values)
Type of the extracted value.
"string"
Free text.
"number"
A JSON number.
"boolean"
true or false.
"enum"
One of enum_options. With fewer than 2 options, extracted as free text.
"date"
A date, as an ISO 8601 string (YYYY-MM-DD).
"datetime"
A date and time, as an ISO 8601 string.
descriptionstringoptional
What the value is, in plain words, for the LLM that fills it in (e.g. 'The budget the prospect mentions, in euros').
requiredboolean
When false (the default), the value may be null or missing when the conversation did not provide it.
Default false
enum_optionsarray of stringoptional
The allowed values when type is 'enum'. With fewer than 2 options the field is extracted as a free string.