nextjs openai

Openai for Next.js

github | npm |演示|文档

添加了用于使用OpenAI流的钩子和组件。

安装

nextjs-openai包括前端工具， openai-streams包括用于在API路由中使用OpenAI流的工具。

yarn add nextjs-openai openai-streams

# -or-

npm i --save nextjs-openai openai-streams

钩子

useBuffer()和useTextBuffer()用于从给定的URL加载数据（和文本）的增量缓冲区。

 import { useTextBuffer } from "nextjs-openai" ;

export default function Demo ( ) {
  const { buffer , refresh , cancel , done } = useTextBuffer ( { 
    url : "/api/demo"
  } ) ;
  
  return (
    < div >
      < StreamingText buffer = { buffer } fade = { 600 } / >
      < button onClick = { refresh } disabled = { ! done } > Refresh < / button >
      < button onClick = { cancel } disabled = { done } > Cancel < / button >
    < / div >
  ) ;
}

成分

<StreamingText>和<StreamingTextURL>使用淡入淡出的动画从流缓冲区渲染文本。

 import { StreamingTextURL } from "nextjs-openai" ;

export default function Demo ( ) {
  return (
    < StreamingTextURL 
      url = "/api/demo" 
      fade = { 600 } 
      throttle = { 100 } 
    / >
  ) ;
}

发送数据和高级用法

如果您想更改使用<StreamingTextURL>或useBuffer()和useTextBuffer()挂钩的网络请求类型，则可以设置{ method, data }选项。

{ data }默认情况下以邮政请求主体发送。要使用get请求，请设置{ method = "GET" } ，然后在{ url }上手动设置URL搜索参数。

_{有关实时示例，请参见src/pages/index.tsx 。}

使用<StreamingTextURL>

 import { StreamingTextURL } from "nextjs-openai" ;

export default function Home ( ) {
  const [ data , setData ] = useState ( { name : "John" } ) ;
  // ...
  return (
    < StreamingTextURL url = "/api/demo" data = { data } >
  );
} 

使用useTextBuffer()

 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 (
    < StreamingText buffer = { buffer } >
  );
}

API路线

使用openai-streams在API路线中使用流。

边缘运行时

 import { OpenAI } from "openai-streams" ;

export default async function handler ( ) {
  const stream = await OpenAI (
    "completions" ,
    {
      model : "text-davinci-003" ,
      prompt : "Write a happy sentence.nn" ,
      max_tokens : 25
    } ,
  ) ;

  return new Response ( stream ) ;
}

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

节点<18

如果您不使用Edge Runtime，请从openai-streams/node导入NodeJS.Readable版本。

 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.nn" ,
      max_tokens : 25
    }
  ) ;

  stream . pipe ( res ) ;
}