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
51 lines
1.2 KiB
Markdown
51 lines
1.2 KiB
Markdown
# provider-http/streaming (HTTP Provider Streaming Example)
|
|
|
|
This example shows how to use OpenAI's streaming API via HTTP provider.
|
|
|
|
You can run this example with:
|
|
|
|
```bash
|
|
npx promptfoo@latest init --example provider-http/streaming
|
|
cd provider-http/streaming
|
|
```
|
|
|
|
⚠️ **Streaming is not recommended for evaluations**
|
|
|
|
Promptfoo supports streaming HTTP targets, but evals wait for full responses before scoring. That means:
|
|
|
|
- No progressive display during evals
|
|
- Extra parsing complexity for streaming formats (SSE/chunked)
|
|
- Similar end-to-end latency vs. non-streaming
|
|
|
|
## Environment Variables
|
|
|
|
Required:
|
|
|
|
- `OPENAI_API_KEY` - Your OpenAI API key from `https://platform.openai.com/api-keys`
|
|
|
|
You can set it in your shell or in a project-level `.env` file (recommended):
|
|
|
|
```bash
|
|
export OPENAI_API_KEY="your-openai-api-key"
|
|
# or in .env
|
|
OPENAI_API_KEY=your-openai-api-key
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
1. Set your API key (or ensure `.env` is populated)
|
|
|
|
2. Run the evaluation (recommended):
|
|
|
|
```bash
|
|
npx promptfoo@latest eval -c examples/provider-http/streaming/promptfooconfig.yaml
|
|
```
|
|
|
|
3. View results (optional):
|
|
|
|
```bash
|
|
npx promptfoo@latest view
|
|
```
|
|
|
|
For more HTTP provider configuration options, see the docs: `https://promptfoo.dev/docs/providers/http`.
|