openai-edge-streaming v1.1.0

openai-edge-streaming@1.1.0

This unofficial OpenAI library provides convenient access to the OpenAI API. This library can be used in browser (not recommended as you would expose your API key), edge, and server environments. It improves upon the official library by:

1. Adding support for usage in Next.js Edge Runtime by passing useFetch: true
2. Adds streaming support for the /chat/completions endpoint with openai.chat.createCompletionStream method. See example usage in a ChatGPT clone here
3. Reorganizing OpenAI's endpoints into namespaces
4. Simplifying usage with less imports

Authored by: https://www.konfigthis.com/

Installing

npm

npm install openai-edge-streaming --save

yarn

yarn add openai-edge-streaming

Usage in Next.js Edge Runtime

If you are using openai-edge-streaming in a Next.js Edge runtime make sure to set useFetch: true like so:

import { Openai } from "openai-edge-streaming"

export const config = {
    runtime: "edge",
};

export default async function handler(req: Request): Promise<Response> {
    const openai = new Openai({
        useFetch: true, // useFetch must be "true" for openai-edge-streaming to work in Next.js edge runtime
    })
    return new Response(JSON.stringify({ message: "This is from openai-edge-streaming" }), { status: 200 })
}

Getting Started

import { Openai } from "openai-edge-streaming"

const openai = new Openai({
    // Defining the base path is optional and defaults to https://api.openai.com/v1
    // basePath: "https://api.openai.com/v1",
    apiKey: process.env.OPENAI_API_KEY,
})

const createResponse = await openai.answers.create({
        "model": "model_example",
        "question": "What is the capital of Japan?",
        "examples": [["What is the capital of Canada?","Ottawa"],["Which province is Ottawa in?","Ontario"]],
        "examples_context": "Ottawa, Canada's capital, is located in the east of southern Ontario, near the city of Montréal and the U.S. border.",
        "documents": ["Japan is an island country in East Asia, located in the northwest Pacific Ocean.","Tokyo is the capital and most populous prefecture of Japan."],
        "search_model": "ada",
        "max_rerank": 200,
        "temperature": 0,
        "max_tokens": 16,
        "n": 1,
        "return_metadata": false,
        "return_prompt": false,
        "expand": [],
        "user": "user-1234",
    })

console.log(createResponse)

Documentation for API Endpoints

All URIs are relative to https://api.openai.com/v1