"API Structured Outputs" - "A new feature by OpenAI ensuring model outputs match provided JSON schemas."
## Understanding API Structured Outputs
API Structured Outputs is a feature introduced by OpenAI on August 6, 2024, that ensures the outputs generated by models perfectly match the JSON schema provided by developers. This feature is particularly useful for applications that require consistent data formats and is activated by setting 'strict: true' in API calls.
## Reliability Improvements with API Structured Outputs
API Structured Outputs significantly improves reliability by ensuring that model outputs match the provided JSON schema perfectly. In evaluations involving complex JSON schemas, the new models achieved a 100% score, whereas the previous gpt-4-0613 model scored less than 40%. This demonstrates the feature's effectiveness in handling structured data requirements.
## Activating API Structured Outputs
Developers can activate API Structured Outputs by setting 'strict: true' in their API calls. This setting ensures that the model outputs strictly adhere to the defined response format or function definitions, making it suitable for applications that require precise data structures.
## Compatibility of API Structured Outputs
API Structured Outputs is compatible with both the Chat Completions API and the Assistants API. This compatibility ensures that the outputs from these APIs follow specific schemas, making it easier for developers to build robust applications that rely on consistent data formats.
## Use Cases for API Structured Outputs
The main use cases for API Structured Outputs include building reliable applications, production-level deployments, and various scenarios such as data input, information retrieval, question-answering systems, and multi-step workflows. This feature is particularly beneficial for applications that require structured data and high reliability.
## Resources for API Structured Outputs
Developers can find more information about API Structured Outputs in the OpenAI Cookbook, which provides an introduction and examples, and in developer community announcements. Additionally, third-party resources like Medium articles and DataCamp tutorials offer detailed guides on how to use this feature effectively.
Updated: 2025-03-26