OpenPipe Node API Library


This library wraps TypeScript or Javascript OpenAI API calls and logs additional data to the configured OPENPIPE_BASE_URL for further processing.

It is fully compatible with OpenAI's sdk and logs both streaming and non-streaming requests and responses.

Installation

``sh
npm install --save openpipe


or


yarn add openpipe
`

Import

$3

`js
// import OpenAI from "openai"
import OpenAI from "openpipe/openai";
`

$3

`js
// const OpenAI = require("openai")
const OpenAI = require("openpipe/openai").default;
`

Usage

1. Create a project at https://app.openpipe.ai
2. Find your project's API key at https://app.openpipe.ai/settings
3. Configure the OpenPipe client as shown below.

`js
// import OpenAI from "openai"
import OpenAI from "openpipe/openai";

// Fully compatible with original OpenAI initialization
const openai = new OpenAI({
apiKey: "my api key", // defaults to process.env["OPENAI_API_KEY"]
// openpipe key is optional
openpipe: {
apiKey: "my api key", // defaults to process.env["OPENPIPE_API_KEY"]
baseUrl: "my url", // defaults to process.env["OPENPIPE_BASE_URL"] or https://api.openpipe.ai/api/v1 if not set
},
});

async function main() {
// Allows optional openpipe object
const completion = await openai.chat.completions.create({
messages: [{ role: "user", content: "Say this is a test" }],
model: "gpt-4o",
// optional
store: true,
metadata: {
prompt_id: "extract_user_intent",
any_key: "any_value",
},
});

console.log(completion.choices);
}

main();
``