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
68 lines
2.0 KiB
Markdown
68 lines
2.0 KiB
Markdown
---
|
|
sidebar_label: Envoy AI Gateway
|
|
description: "Connect to AI models through Envoy AI Gateway's OpenAI-compatible proxy with unified API management and routing capabilities"
|
|
---
|
|
|
|
# Envoy AI Gateway
|
|
|
|
[Envoy AI Gateway](https://aigateway.envoyproxy.io/) is an open-source AI gateway that provides a unified proxy layer for accessing various AI model providers. It offers [OpenAI-compatible](/docs/providers/openai/) endpoints.
|
|
|
|
## Setup
|
|
|
|
1. Deploy and configure your Envoy AI Gateway following the [official setup guide](https://aigateway.envoyproxy.io/docs/getting-started/basic-usage)
|
|
2. Configure your gateway URL either via environment variable or in your config
|
|
3. Set up authentication if required by your gateway configuration
|
|
|
|
## Provider Format
|
|
|
|
The Envoy provider uses this format:
|
|
|
|
- `envoy:<model_name>` - Connects to your gateway using the specified model name
|
|
|
|
## Configuration
|
|
|
|
### Basic Configuration
|
|
|
|
```yaml title="promptfooconfig.yaml"
|
|
# yaml-language-server: $schema=https://promptfoo.dev/config-schema.json
|
|
providers:
|
|
- id: envoy:my-model
|
|
config:
|
|
apiBaseUrl: 'https://your-envoy-gateway.com/v1'
|
|
```
|
|
|
|
### With Environment Variable
|
|
|
|
Set your gateway URL as an environment variable:
|
|
|
|
```bash
|
|
export ENVOY_API_BASE_URL="https://your-envoy-gateway.com"
|
|
```
|
|
|
|
Then use the provider without specifying the URL:
|
|
|
|
```yaml
|
|
providers:
|
|
- id: envoy:my-model
|
|
```
|
|
|
|
### Authenticating via header
|
|
|
|
Envoy authentication is usually done with an `x-api-key` header. Here's an example of how to configure that:
|
|
|
|
```yaml
|
|
providers:
|
|
- id: envoy:my-model
|
|
config:
|
|
apiBaseUrl: 'https://your-envoy-gateway.com/v1'
|
|
headers:
|
|
x-api-key: 'foobar'
|
|
```
|
|
|
|
## See Also
|
|
|
|
- [OpenAI Provider](/docs/providers/openai) - Compatible API format used by Envoy AI Gateway
|
|
- [Configuration Reference](/docs/configuration/reference.md) - Full configuration options for providers
|
|
- [Envoy AI Gateway Documentation](https://aigateway.envoyproxy.io/docs/) - Official gateway documentation
|
|
- [Envoy AI Gateway GitHub](https://github.com/envoyproxy/ai-gateway) - Source code and examples
|