open-guardrail-openai

OpenAI SDK adapter for open-guardrail.

Guard chat completion inputs and outputs with zero config changes.

Install

npm install open-guardrail-openai open-guardrail openai

Quick Start

import OpenAI from 'openai';
import { pipe, promptInjection, pii } from 'open-guardrail';
import { createGuardedOpenAI } from 'open-guardrail-openai';

const openai = new OpenAI();

const guarded = createGuardedOpenAI(openai, {
  input: pipe(promptInjection({ action: 'block' })),
  output: pipe(pii({ entities: ['email'], action: 'mask' })),
});

// Use exactly like the normal OpenAI client
const res = await guarded.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: 'Hello!' }],
});

Low-Level API

import { guardedCompletions } from 'open-guardrail-openai';

const safeCreate = guardedCompletions(
  openai.chat.completions.create.bind(openai.chat.completions),
  { input: myInputPipeline, output: myOutputPipeline },
);

const res = await safeCreate({ model: 'gpt-4o', messages });

Error Handling

import { GuardrailBlockedError } from 'open-guardrail-openai';

try {
  await guarded.chat.completions.create({ ... });
} catch (err) {
  if (err instanceof GuardrailBlockedError) {
    console.log(err.stage);  // 'input' | 'output'
    console.log(err.result); // PipelineResult
  }
}

License

MIT