openai-edge

OpenAI Edge

A TypeScript module for querying OpenAI's API from an edge function environment i.e. using fetch (a standard Web API) instead of axios.

Edge functions are very fast and, unlike lambda functions, allow streaming data to the client.

Installation

yarn add openai-edge

or

npm install openai-edge

Methods

This module offers a subset of the methods available in the official Node package. The syntax and types are essentially the same but the methods return the standard Fetch Promise<Response>.

• openai.createCompletion
• openai.createImage (since v0.2.0)

Examples

Streaming text completion from a Next.js Edge API Route:

import type { NextRequest } from "next/server"
import { Configuration, OpenAIApi } from "openai-edge"

const configuration = new Configuration({
  apiKey: process.env.OPENAI_API_KEY,
})
const openai = new OpenAIApi(configuration)

const handler = async (req: NextRequest) => {
  const { searchParams } = new URL(req.url)

  try {
    const completion = await openai.createCompletion({
      model: "text-davinci-003",
      prompt: searchParams.get("prompt") ?? "Say this is a test",
      max_tokens: 7,
      temperature: 0,
      stream: true,
    })

    return new Response(completion.body, {
      headers: {
        "Access-Control-Allow-Origin": "*",
        "Content-Type": "text/event-stream;charset=utf-8",
        "Cache-Control": "no-cache, no-transform",
        "X-Accel-Buffering": "no",
      },
    })
  } catch (error: any) {
    console.error(error)

    return new Response(JSON.stringify(error), {
      status: 400,
      headers: {
        "content-type": "application/json",
      },
    })
  }
}

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

export default handler