examples/openai-structured-output/README.md
This example demonstrates how to define JSON schemas for OpenAI's Structured Output feature in two different ways:
file://You can run this example with:
npx promptfoo@latest init --example openai-structured-output
cd openai-structured-output
This example requires:
OPENAI_API_KEY - Your OpenAI API keyThis example includes several files that demonstrate different approaches:
| File | Description |
|---|---|
promptfooconfig.chat.yaml | Chat API config using both inline and external schemas |
promptfooconfig.responses.yaml | Responses API config using both inline and external schemas |
schema.responses.yaml | External schema file for Responses API |
schema.chat.json | External schema file for Chat API |
cd openai-structured-output
promptfoo eval -c promptfooconfig.chat.yaml
promptfoo eval -c promptfooconfig.responses.yaml