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,24 @@
|
||||
# provider-custom/typescript (Custom Provider Typescript)
|
||||
|
||||
You can run this example with:
|
||||
|
||||
```bash
|
||||
npx promptfoo@latest init --example provider-custom/typescript
|
||||
cd provider-custom/typescript
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
This example uses a custom API provider in `customProvider.ts`. It also uses CSV test cases.
|
||||
|
||||
Run:
|
||||
|
||||
```bash
|
||||
promptfoo eval
|
||||
```
|
||||
|
||||
Full command-line equivalent:
|
||||
|
||||
```bash
|
||||
promptfoo eval --prompts prompts.txt --tests vars.csv --providers openai:chat --output output.json --providers customProvider.js
|
||||
```
|
||||
@@ -0,0 +1,60 @@
|
||||
import promptfoo from 'promptfoo';
|
||||
import type { ApiProvider, ProviderOptions, ProviderResponse } from 'promptfoo';
|
||||
|
||||
// import promptfoo from '../../dist/src/index.js';
|
||||
// import type { ApiProvider, ProviderOptions, ProviderResponse } from '../../src/types/providers';
|
||||
|
||||
export default class CustomApiProvider implements ApiProvider {
|
||||
protected providerId: string;
|
||||
public config: any;
|
||||
|
||||
constructor(options: ProviderOptions) {
|
||||
// The caller may override Provider ID (e.g. when using multiple instances of the same provider)
|
||||
this.providerId = options.id || 'custom provider';
|
||||
|
||||
// The config object contains any options passed to the provider in the config file.
|
||||
this.config = options.config;
|
||||
}
|
||||
|
||||
id(): string {
|
||||
return this.providerId;
|
||||
}
|
||||
|
||||
async callApi(prompt: string): Promise<ProviderResponse> {
|
||||
const body = {
|
||||
model: 'gpt-4.1-mini',
|
||||
messages: [
|
||||
{
|
||||
role: 'user',
|
||||
content: prompt,
|
||||
},
|
||||
],
|
||||
max_tokens: Number.parseInt(this.config?.max_tokens, 10) || 1024,
|
||||
temperature: Number.parseFloat(this.config?.temperature) || 0,
|
||||
};
|
||||
|
||||
// Fetch the data from the API using promptfoo's cache. You can use your own fetch implementation if preferred.
|
||||
const { data, cached: _cached } = await promptfoo.cache.fetchWithCache(
|
||||
'https://api.openai.com/v1/chat/completions',
|
||||
{
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
Authorization: `Bearer ${process.env.OPENAI_API_KEY}`,
|
||||
},
|
||||
body: JSON.stringify(body),
|
||||
},
|
||||
10_000 /* 10 second timeout */,
|
||||
);
|
||||
|
||||
const ret: ProviderResponse = {
|
||||
output: data.choices[0].message.content,
|
||||
tokenUsage: {
|
||||
total: data.usage.total_tokens,
|
||||
prompt: data.usage.prompt_tokens,
|
||||
completion: data.usage.completion_tokens,
|
||||
},
|
||||
};
|
||||
return ret;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
# yaml-language-server: $schema=https://promptfoo.dev/config-schema.json
|
||||
description: Custom provider implementation using TypeScript
|
||||
|
||||
prompts:
|
||||
- file://prompts.txt
|
||||
|
||||
providers:
|
||||
- id: file://customProvider.ts
|
||||
label: 'My custom provider'
|
||||
|
||||
tests: file://vars.csv
|
||||
# To compare two of the same provider, you can do the following:
|
||||
#
|
||||
# providers:
|
||||
# - id: customProvider.js
|
||||
# label: custom-provider-hightemp
|
||||
# config:
|
||||
# temperature: 1.0
|
||||
# - id: customProvider.js
|
||||
# label: custom-provider-lowtemp
|
||||
# config:
|
||||
# temperature: 0
|
||||
@@ -0,0 +1,3 @@
|
||||
Rephrase this in French: {{body}}
|
||||
---
|
||||
Rephrase this like a pirate: {{body}}
|
||||
@@ -0,0 +1,3 @@
|
||||
body
|
||||
Hello world
|
||||
I'm hungry
|
||||
|
Reference in New Issue
Block a user