https://github.com/SpellcraftAI/nextjs-openai

Hooks and components for working with OpenAI streams.
https://github.com/SpellcraftAI/nextjs-openai

nextjs openai

Last synced: about 1 month ago
JSON representation

Hooks and components for working with OpenAI streams.

• Host: GitHub
• URL: https://github.com/SpellcraftAI/nextjs-openai
• Owner: SpellcraftAI
• License: mit
• Created: 2023-01-20T14:10:56.000Z (almost 2 years ago)
• Default Branch: canary
• Last Pushed: 2023-05-12T10:35:28.000Z (over 1 year ago)
• Last Synced: 2024-11-18T04:43:31.492Z (about 1 month ago)
• Topics: nextjs, openai
• Language: TypeScript
• Homepage: https://nextjs-openai.vercel.app
• Size: 811 KB
• Stars: 238
• Watchers: 6
• Forks: 18
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OpenAI for Next.js

[**Github**](https://github.com/SpellcraftAI/nextjs-openai) |

[**NPM**](https://npmjs.com/package/nextjs-openai) |

[**Demo**](https://nextjs-openai.vercel.app) |

[**Docs**](https://nextjs-openai.vercel.app/docs)

Adds hooks and components for working with OpenAI streams.



### Installation

`nextjs-openai` includes frontend tools, and `openai-streams` includes tools for

working with OpenAI streams in your API Routes.

```bash

yarn add nextjs-openai openai-streams

# -or-

npm i --save nextjs-openai openai-streams

```

### Hooks

`useBuffer()` and `useTextBuffer()` are used to load an incrementing buffer of

data (and text) from a given URL.

```tsx

import { useTextBuffer } from "nextjs-openai";

export default function Demo() {

  const { buffer, refresh, cancel, done } = useTextBuffer({ 

    url: "/api/demo"

  });

  

  return (

    


      

      Refresh

      Cancel

    

  );

}

```


### Components

`` and `` render text from a stream buffer

using a fade-in animation.

```tsx

import { StreamingTextURL } from "nextjs-openai";

export default function Demo() {

  return (

    

  );

}

```

### Sending data and advanced usage

If you would like to change the type of network request made with

`` or the `useBuffer()` and `useTextBuffer()` hooks, you can

set the `{ method, data }` options.

`{ data }` is sent as the POST request body by default. To use a GET request,

set `{ method = "GET" }` and manually set the URL search params on `{ url }`.

See

[`src/pages/index.tsx`](https://github.com/SpellcraftAI/nextjs-openai/blob/master/src/pages/index.tsx)

for a live example.

#### With ``

```tsx

import { StreamingTextURL } from "nextjs-openai";

export default function Home() {

  const [data, setData] = useState({ name: "John" });

  // ...

  return (

    

  );

}

```

#### With `useTextBuffer()`

```tsx

import { useTextBuffer, StreamingText } from "nextjs-openai";

export default function Home() {

  const [data, setData] = useState({ name: "John" });

  const { buffer, refresh, cancel } = useTextBuffer({

    url: "/api/demo",

    throttle: 100,

    data,

    /**

     * Optional: Override params for `fetch(url, params)`.

     */

    options: {

      headers: {

        // ...

      }

    }

  });

  // ...

  return (

    

  );

}

```

### API Routes

Use `openai-streams` to work with streams in your API Routes.

#### Edge Runtime

```ts

import { OpenAI } from "openai-streams";

export default async function handler() {

  const stream = await OpenAI(

    "completions",

    {

      model: "text-davinci-003",

      prompt: "Write a happy sentence.\n\n",

      max_tokens: 25

    },

  );

  return new Response(stream);

}

export const config = {

  runtime: "edge"

};

```

#### Node <18

If you are not using Edge Runtime, import the `NodeJS.Readable` version from

`openai-streams/node`.

```ts

import type { NextApiRequest, NextApiResponse } from "next";

import { OpenAI } from "openai-streams/node";

export default async function test (_: NextApiRequest, res: NextApiResponse) {

  const stream = await OpenAI(

    "completions",

    {

      model: "text-davinci-003",

      prompt: "Write a happy sentence.\n\n",

      max_tokens: 25

    }

  );

  stream.pipe(res);

}

```