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
90 lines
1.8 KiB
Markdown
90 lines
1.8 KiB
Markdown
# openai-chatkit (OpenAI ChatKit Workflow Evaluation)
|
|
|
|
Evaluate ChatKit workflows built with OpenAI's Agent Builder using browser automation.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
npx promptfoo@latest init --example openai-chatkit
|
|
cd openai-chatkit
|
|
```
|
|
|
|
## Prerequisites
|
|
|
|
1. Install Playwright browser:
|
|
|
|
```bash
|
|
npx playwright install chromium
|
|
```
|
|
|
|
2. Get your workflow ID from Agent Builder:
|
|
- Open [platform.openai.com](https://platform.openai.com) > Agent Builder
|
|
- Click **Publish** on your workflow
|
|
- Copy the workflow ID (e.g., `wf_68ffb83dbfc88190a38103c2bb9f421003f913035dbdb131`)
|
|
|
|
3. Update `promptfooconfig.yaml` with your workflow ID
|
|
|
|
## Environment Variables
|
|
|
|
- `OPENAI_API_KEY` - Your OpenAI API key
|
|
|
|
## Run the Eval
|
|
|
|
```bash
|
|
npx promptfoo@latest eval --max-concurrency 4
|
|
```
|
|
|
|
View results:
|
|
|
|
```bash
|
|
npx promptfoo@latest view
|
|
```
|
|
|
|
## Multi-Turn Conversations
|
|
|
|
For workflows that ask follow-up questions, enable stateful mode:
|
|
|
|
```yaml
|
|
providers:
|
|
- id: openai:chatkit:wf_YOUR_WORKFLOW_ID
|
|
config:
|
|
stateful: true
|
|
|
|
tests:
|
|
- vars:
|
|
message: 'I want to plan a party'
|
|
- vars:
|
|
message: 'For 20 people with a $500 budget'
|
|
```
|
|
|
|
Run with `--max-concurrency 1` for stateful mode.
|
|
|
|
## Using with Simulated User
|
|
|
|
Test multi-turn conversations automatically:
|
|
|
|
```yaml
|
|
providers:
|
|
- id: openai:chatkit:wf_YOUR_WORKFLOW_ID
|
|
config:
|
|
stateful: true
|
|
|
|
defaultTest:
|
|
provider:
|
|
id: 'promptfoo:simulated-user'
|
|
config:
|
|
maxTurns: 5
|
|
|
|
tests:
|
|
- vars:
|
|
instructions: |
|
|
You are planning a birthday party.
|
|
Answer questions naturally and provide details when asked.
|
|
```
|
|
|
|
## Learn More
|
|
|
|
- [ChatKit Provider Documentation](https://www.promptfoo.dev/docs/providers/openai-chatkit/)
|
|
- [Simulated User Provider](https://www.promptfoo.dev/docs/providers/simulated-user/)
|
|
- [OpenAI Agent Builder](https://platform.openai.com/docs/guides/chatkit)
|