chore: import upstream snapshot with attribution
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
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
This commit is contained in:
@@ -0,0 +1,79 @@
|
||||
# n8n-agent (n8n AI Agent Evaluation)
|
||||
|
||||
You can run this example with:
|
||||
|
||||
```bash
|
||||
npx promptfoo@latest init --example n8n-agent
|
||||
```
|
||||
|
||||
This example demonstrates how to evaluate n8n AI agents and workflows using the n8n provider.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. A self-hosted n8n instance with a webhook-triggered workflow
|
||||
2. An AI agent workflow that accepts messages and returns responses
|
||||
|
||||
## Setup
|
||||
|
||||
1. Create an n8n workflow with a Webhook trigger node
|
||||
2. Add your AI agent logic (e.g., AI Agent node, OpenAI node)
|
||||
3. Configure the workflow to return the agent's response
|
||||
4. Update `promptfooconfig.yaml` with your webhook URL:
|
||||
|
||||
```yaml
|
||||
providers:
|
||||
- id: n8n:https://your-n8n-instance.com/webhook/your-agent-id
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
||||
```bash
|
||||
export N8N_API_KEY=your-api-key # If your webhook requires authentication
|
||||
```
|
||||
|
||||
## Running the Example
|
||||
|
||||
```bash
|
||||
# Run the evaluation
|
||||
npx promptfoo eval
|
||||
|
||||
# View results
|
||||
npx promptfoo view
|
||||
```
|
||||
|
||||
## Configuration Options
|
||||
|
||||
- `url`: Webhook URL (alternative to specifying in provider path)
|
||||
- `method`: HTTP method (default: `POST`); `GET` sends rendered body fields as query parameters
|
||||
- `headers`: Additional request headers
|
||||
- `body`: Custom request body template with Nunjucks support; prefer object form for JSON payloads
|
||||
- `transformResponse`: JavaScript expression to extract output
|
||||
- `sessionHeader`: Request header name for the session ID
|
||||
- `sessionParser`: JavaScript expression to extract a session ID
|
||||
- `sessionField`: Request body field for a supplied session ID
|
||||
|
||||
For multi-turn runs, pass `sessionId` in test variables or use a multi-turn strategy so sessions
|
||||
remain scoped to one conversation. Keep webhook credentials in environment-backed headers rather
|
||||
than embedding them in webhook URLs. The provider uses a fingerprinted display ID and skips
|
||||
response caching so tokenized URLs and session-bearing requests do not enter response-cache
|
||||
diagnostics or storage; URLs still remain in configuration and outbound requests.
|
||||
|
||||
## Response Formats
|
||||
|
||||
The provider automatically handles common n8n response formats:
|
||||
|
||||
```javascript
|
||||
{ "output": "Response text" }
|
||||
{ "response": "Agent response" }
|
||||
{ "message": { "content": "Hello" } }
|
||||
[{ "json": { "output": "Result" } }]
|
||||
```
|
||||
|
||||
For custom formats, use `transformResponse`:
|
||||
|
||||
```yaml
|
||||
config:
|
||||
transformResponse: 'json.data.agentMessage'
|
||||
```
|
||||
|
||||
For more information, see the [n8n Provider documentation](/docs/providers/n8n).
|
||||
@@ -0,0 +1,43 @@
|
||||
# yaml-language-server: $schema=https://promptfoo.dev/config-schema.json
|
||||
description: 'n8n AI agent evaluation'
|
||||
|
||||
prompts:
|
||||
- '{{query}}'
|
||||
|
||||
providers:
|
||||
- id: n8n:https://your-n8n-instance.com/webhook/your-agent-id
|
||||
config:
|
||||
headers:
|
||||
Authorization: 'Bearer {{env.N8N_API_KEY}}'
|
||||
body:
|
||||
message: '{{prompt}}'
|
||||
userId: '{{userId}}'
|
||||
|
||||
tests:
|
||||
- vars:
|
||||
query: What are your business hours?
|
||||
userId: test-user-1
|
||||
assert:
|
||||
- type: contains-any
|
||||
value:
|
||||
- hours
|
||||
- open
|
||||
- available
|
||||
|
||||
- vars:
|
||||
query: What's the status of my order #12345?
|
||||
userId: test-user-2
|
||||
assert:
|
||||
- type: javascript
|
||||
value: |
|
||||
const toolCalls = context.providerResponse?.metadata?.toolCalls || [];
|
||||
return toolCalls.some(tc => tc.name === 'order_lookup');
|
||||
- type: contains
|
||||
value: '12345'
|
||||
|
||||
- vars:
|
||||
query: I need help resetting my password
|
||||
userId: test-user-3
|
||||
assert:
|
||||
- type: llm-rubric
|
||||
value: The response should acknowledge the request and provide clear next steps
|
||||
Reference in New Issue
Block a user