open-guardrail-vercel-ai

Vercel AI SDK middleware adapter for open-guardrail.

Install

npm install open-guardrail-vercel-ai open-guardrail ai

Usage

import { createGuardrailMiddleware } from 'open-guardrail-vercel-ai';
import { pipe, promptInjection, pii, toxicity } from 'open-guardrail';
import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';

const middleware = createGuardrailMiddleware({
  input: pipe(
    promptInjection({ action: 'block' }),
    pii({ entities: ['email', 'phone'], action: 'mask' }),
  ),
  output: pipe(
    toxicity({ action: 'block' }),
  ),
  onBlocked: (result, stage) => {
    console.log(`Blocked at ${stage}:`, result.action);
  },
});

const result = await generateText({
  model: openai('gpt-4o'),
  messages: [{ role: 'user', content: 'Hello' }],
  experimental_middleware: middleware,
});

API

createGuardrailMiddleware(options)

| Option | Type | Description | |--------|------|-------------| | input | Pipeline | Guards applied to user input (transformParams) | | output | Pipeline | Guards applied to model output (wrapGenerate) | | onBlocked | (result, stage) => void | Callback when a guard blocks |

Throws GuardrailBlockedError when a guard blocks.

License

MIT