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
70 lines
2.0 KiB
Markdown
70 lines
2.0 KiB
Markdown
# azure/openai (Azure OpenAI)
|
|
|
|
This example demonstrates how to use Azure OpenAI with promptfoo, including text generation and vision capabilities.
|
|
|
|
You can run this example with:
|
|
|
|
```bash
|
|
npx promptfoo@latest init --example azure/openai
|
|
cd azure/openai
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
This example requires the following environment variables:
|
|
|
|
- `AZURE_API_KEY` - Your Azure OpenAI API key
|
|
- `AZURE_OPENAI_API_KEY` - Alternative environment variable for your Azure OpenAI API key
|
|
|
|
You can set these in a `.env` file or directly in your environment.
|
|
|
|
## Prerequisites
|
|
|
|
1. An Azure account with access to Azure OpenAI Service
|
|
2. Deployments for one or more Azure OpenAI models:
|
|
- Text models: gpt-5.1, gpt-4o
|
|
- Vision models: gpt-4o (or other vision-capable models)
|
|
3. Your Azure OpenAI endpoint URL
|
|
|
|
## Setup Instructions
|
|
|
|
1. Update the `apiHost` in the configuration files to your Azure OpenAI endpoint
|
|
2. Set `AZURE_API_KEY` in your environment
|
|
3. Update the deployment names to match your actual deployments
|
|
|
|
## Available Examples
|
|
|
|
### Basic Text Generation
|
|
|
|
```bash
|
|
npx promptfoo@latest eval
|
|
# or
|
|
npx promptfoo@latest eval -c promptfooconfig.yaml
|
|
```
|
|
|
|
### Vision Models
|
|
|
|
```bash
|
|
npx promptfoo@latest eval -c promptfooconfig.vision.yaml
|
|
```
|
|
|
|
Demonstrates three ways to provide images to vision models:
|
|
|
|
- **URL**: Direct link to an image on the web
|
|
- **Local file**: Using `file://` paths (automatically converted to base64)
|
|
- **Base64**: Pre-encoded image data URI
|
|
|
|
## Troubleshooting
|
|
|
|
If you get a 401 error:
|
|
|
|
- Ensure your `AZURE_API_KEY` is set correctly
|
|
- Verify your endpoint URL is correct (no https://)
|
|
- Check that your deployment supports the requested capabilities
|
|
|
|
## Additional Resources
|
|
|
|
- [Azure OpenAI Provider Documentation](https://promptfoo.dev/docs/providers/azure/)
|
|
- [Azure OpenAI Service Documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/)
|
|
- [Azure OpenAI Vision Documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/gpt-with-vision)
|