快捷導(dǎo)航

chatgpt-api使用指南詳解教程【官方泄露版】

更新時(shí)間：2023年02月20日 10:58:04 作者：新缸中之腦

chatgpt-api是?OpenAI?ChatGPT?的非官方的?Node.js?包裝器，?chatgpt-api不再需要任何瀏覽器破解它使用泄露出來(lái)的OpenAI官方ChatGPT?在后臺(tái)使用的模型，這篇文章主要介紹了chatgpt-api使用指南【官方泄露版】,需要的朋友可以參考下

1、安裝chatgpt-api

確保你使用的是 node >= 18 以便 fetch 可用（node >= 14也可以，但你需要安裝 fetch polyfill）。

使用如下命令安裝 chatgpt-api ：

npm install chatgpt

2、chatgpt-api使用方法

首先注冊(cè)獲取 OpenAI API 密鑰并將其存儲(chǔ)在你的環(huán)境中。

下面是簡(jiǎn)單的一次性對(duì)話：

import { ChatGPTAPI } from 'chatgpt'

async function example() {
  const api = new ChatGPTAPI({
    apiKey: process.env.OPENAI_API_KEY
  })

  const res = await api.sendMessage('Hello World!')
  console.log(res.text)
}

如果你想進(jìn)行持續(xù)多輪的對(duì)話，需要傳遞 parentMessageid 和 conversationid：

const api = new ChatGPTAPI({ apiKey: process.env.OPENAI_API_KEY })

// send a message and wait for the response
let res = await api.sendMessage('What is OpenAI?')
console.log(res.text)

// send a follow-up
res = await api.sendMessage('Can you expand on that?', {
  conversationId: res.conversationId,
  parentMessageId: res.id
})
console.log(res.text)

// send another follow-up
res = await api.sendMessage('What were we talking about?', {
  conversationId: res.conversationId,
  parentMessageId: res.id
})
console.log(res.text)

可以通過(guò) onProgress 處理程序添加流式響應(yīng)：

const res = await api.sendMessage('Write a 500 word essay on frogs.', {
  // print the partial response as the AI is "typing"
  onProgress: (partialResponse) => console.log(partialResponse.text)
})

// print the full text at the end
console.log(res.text)

也可以使用 timeoutMs 選項(xiàng)添加超時(shí)設(shè)置：

// timeout after 2 minutes (which will also abort the underlying HTTP request)
const response = await api.sendMessage(
  'write me a really really long essay on frogs',
  {
    timeoutMs: 2 * 60 * 1000
  }
)

如果想查看有關(guān)實(shí)際發(fā)送到 OpenAI 完成 API 的內(nèi)容的更多信息，請(qǐng)?jiān)?ChatGPT API 構(gòu)造函數(shù)中設(shè)置 debug: true 選項(xiàng)：

const api = new ChatGPTAPI({
  apiKey: process.env.OPENAI_API_KEY,
  debug: true
})

你會(huì)注意到我們正在使用反向工程得到的 promptPrefix 和 promptSuffix。你可以通過(guò) sendMessage 的選項(xiàng)自定義這些：

const res = await api.sendMessage('what is the answer to the universe?', {
  promptPrefix: `You are ChatGPT, a large language model trained by OpenAI. You answer as concisely as possible for each response (e.g. don't be verbose). It is very important that you answer as concisely as possible, so please remember this. If you are generating a list, do not have too many items. Keep the number of items short.
Current date: ${new Date().toISOString()}\n\n`
})

請(qǐng)注意，我們會(huì)自動(dòng)處理將先前的消息附加到提示并嘗試優(yōu)化可用token（默認(rèn)為 4096）。

在CommonJS中可以使用動(dòng)態(tài)導(dǎo)入：

async function example() {
  // To use ESM in CommonJS, you can use a dynamic import
  const { ChatGPTAPI } = await import('chatgpt')

  const api = new ChatGPTAPI({ apiKey: process.env.OPENAI_API_KEY })

  const res = await api.sendMessage('Hello World!')
  console.log(res.text)
}

完整的使用文檔可以在這里查看。