wehub-resource-sync
0d3cb498a3
CI / Shell Format Check (push) Has been cancelled
CI / Check Ruby (3.4) (push) Has been cancelled
CI / CI Config (push) Has been cancelled
CI / Test on Node ${{ matrix.node }} and ${{ matrix.os }}${{ matrix.shard && format(' (shard {0}/3)', matrix.shard) || '' }} (push) Has been cancelled
CI / Build on Node ${{ matrix.node }} (push) Has been cancelled
CI / Style Check (push) Has been cancelled
CI / Generate Assets (push) Has been cancelled
CI / Check Python (3.14) (push) Has been cancelled
CI / Check Python (3.9) (push) Has been cancelled
CI / Build Docs (push) Has been cancelled
CI / Code Scan Action (push) Has been cancelled
CI / Site tests (push) Has been cancelled
CI / webui tests (push) Has been cancelled
CI / Run Integration Tests (push) Has been cancelled
CI / Run Smoke Tests (push) Has been cancelled
CI / Go Tests (push) Has been cancelled
CI / Share Test (push) Has been cancelled
CI / Redteam (Production API) (push) Has been cancelled
CI / Redteam (Staging API) (push) Has been cancelled
CI / GitHub Actions Lint (push) Has been cancelled
CI / Check Ruby (3.0) (push) Has been cancelled
release-please / release-please (push) Has been cancelled
release-please / build (push) Has been cancelled
release-please / publish-npm (push) Has been cancelled
release-please / publish-npm-backfill (push) Has been cancelled
release-please / docker (push) Has been cancelled
release-please / publish-code-scan-action (push) Has been cancelled
release-please / attest-code-scan-action (push) Has been cancelled
Deploy local.promptfoo.app / Deploy to Cloudflare Pages (push) Has been cancelled
Test and Publish Multi-arch Docker Image / test (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-amd64 platform:linux/amd64 runner:ubuntu-latest]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-arm64 platform:linux/arm64 runner:ubuntu-24.04-arm]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / merge-docker-digests (push) Has been cancelled
Test and Publish Multi-arch Docker Image / Attest Multi-arch Image (push) Has been cancelled
Validate Renovate Config / Validate Renovate Configuration (push) Has been cancelled
46 lines
1.6 KiB
Markdown
46 lines
1.6 KiB
Markdown
# openai-structured-output (OpenAI Structured Output Example)
|
|
|
|
This example demonstrates how to define JSON schemas for OpenAI's Structured Output feature in two different ways:
|
|
|
|
1. **Inline schema definition** - defined directly in the config file
|
|
2. **External schema file** - stored in a separate JSON or YAML file and referenced with `file://`
|
|
|
|
## Usage
|
|
|
|
You can run this example with:
|
|
|
|
```bash
|
|
npx promptfoo@latest init --example openai-structured-output
|
|
cd openai-structured-output
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
This example requires:
|
|
|
|
- `OPENAI_API_KEY` - Your OpenAI API key
|
|
|
|
## Example Structure
|
|
|
|
This 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 |
|
|
|
|
## Running the Example
|
|
|
|
```bash
|
|
cd openai-structured-output
|
|
promptfoo eval -c promptfooconfig.chat.yaml
|
|
promptfoo eval -c promptfooconfig.responses.yaml
|
|
```
|
|
|
|
## Additional Resources
|
|
|
|
- [OpenAI Structured Output Announcement](https://openai.com/index/introducing-structured-outputs-in-the-api/)
|
|
- [promptfoo Documentation](https://promptfoo.dev)
|