openai-self v1.1.9

openai-self

背景

基于openai开放api封装，旨在可以更加简单的调用openai的api接口

安装

npm i openai-self

开始

若node运行时，建议node版本大于16，低版本可能异常报错

  const OpenAI = require('openai-self');

const openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY || '', // openai的api_Key：必填，可前往openai官网申请 // proxy: 'http://127.0.0.1:21882', // 代理服务器地址：非必填，科学上网时需要。格式：'protocol://agent-ip:port' // sourceDir: '', // 内容缓存地址：非必填，默认值为./openai_cache // organizationId: '' // 组织机构Id：非必填 }); openai.getModels((res) => {console.log(res)}) // 获取openai所用可用引擎并打印到控制台

### 接口说明

[openai api文档官网入口](https://platform.openai.com/docs/api-reference)

调用方法             |   封装接口       |       参数         |   说明
:-------------------| :---------------| :-----------------| :--------------
getModels           | /v1/models      | 无                | 获取openai所有可用模型信息
createNomalCompletions | /v1/completions | 1. msg: 类型-string，必填,对话消息；<br/>2. option：类型-object，非必填，具体参数参考openai官网对该接口的支持;<br/> 3. callback：类型-function， 回调函数，非必填<br/>               | 与openai对话，默认模型为‘text-davinci-003’，默认最大token数为350
createChatCompletions | /v1/chat/completions | 1. msg: 类型-string 或 array，必填,对话消息；数组类型格式参照官网<br/>2. option：类型-object，非必填，具体参数参考openai官网对该接口的支持;<br/> 3. callback：类型-function， 回调函数，非必填<br/>               | 与openai对话，默认模型为‘gpt-3.5-turbo’，默认最大token数为350
generateImage         | /v1/images/generations | 1. msg: 类型-string 必填,生成图片要求描述；<br/>2. option：类型-object，非必填，具体参数参考openai官网对该接口的支持;<br/> 3. callback：类型-function， 回调函数，非必填<br/> | 根据描述生成图片
createTranscription   | /v1/audio/transcriptions | 1. file： 类型-string 或 stream，必填；<br/> 2. option：类型-object，非必填，具体参数参考openai官网对该接口的支持;<br/> 3. callback：类型-function， 回调函数，非必填<br/> | 解析语音文件转换成文字
createCustomRequest | any             | 1. url: 类型-string，必填；<br/>2. config：类型-object，非必填，具体参数参考axios的config参数;<br/> 3. callback：类型-function， 回调函数，非必填<br/> | 自定义调用接口

### 工具方法
> 以下方法在浏览器中无法使用
调用方法             |      参数                  |      返回        | 说明
:-------------------| :--------------------------| :--------------- | :--------------
createInSourceDir   | dir: String类型，必填       | 布尔值： 创建结果 | 相对于sourceDir创建文件夹
getSourceDir        | 无      | sourceDir的相对路径 | 返回sourceDir的相对路径
clearContext        | context: String类型，非必填 | 无 | 清除聊天产生的上下文文件，传参，删除固定context.json文件，不传参，则删除sourceDir/context文件下所有json文件
clearSourceDir      | dir: String类型，非必填     | 无 | 清除聊天产生的文件，传参，删除sourceDir/dir目录下的文件，不传参，则删除sourceDir目录下所有文件
### 示例

> 使用commonJS规范导入模块时，推荐回调函数式写法，否则可能引起异常；
> 使用ES6规范导入模块时, async/await 和 回调函数接收返回数据都可以；

- getModels()
```javascript
  // 第一种用法
  openai.getModels((res) => {console.log(res)})
  // 第二种用法：仅支持import导入模块时使用
  console.log(await openai.getModels()) // 获取openai所用可用引擎
  

• createNomalCompletions()

  // 第一种使用方法: 通过callback处理数据
  openai.createNomalCompletions('你好', (res) => { console.log(res) })
  // 第二种使用方法: async/await
  console.log(await openai.createNomalCompletions('你好'))
  // 第三种使用方法：传入options，具体参数参考openai官网对该接口的支持
  const params = {
    // model: 'text-davinci-003', //默认模型：text-davinci-003
    prompt: 'Hello',
    max_tokens： 100
  }
  console.log(await openai.createNomalCompletions(params))

• createChatCompletions()

  // 第一种使用方法: 通过callback处理数据
  openai.createChatCompletions('你好', (res) => {console.log(res)})
  // 第二种使用方法: async/await
  console.log(await openai.createChatCompletions('你好'))
  // 第三种使用方法：传入options，具体参数参考openai官网对该接口的支持
  const params = {
    // model: 'gpt-3.5-turbo', //默认模型：gpt-3.5-turbo
    // messages: [{role: "user", "content": "Hello!"}]
    max_tokens： 100
  }
  console.log(await openai.createChatCompletions('你好', params))

  // 关联上下文
  const chatParams = {
    context: 'test-key', // 新增参数：关联上下文参数，以此字段为文件名存放聊天数据；注意：如果传入n参数，n>1时，context参数不再生效，也不再具有关联上下文功能
    max_tokens: 500
  }
  // 需要删除聊天数据需主动调用delectContext
  openai.clearContext(chatParams.context)

  openai.createChatCompletions('你好', chatParams)
  openai.createChatCompletions('请记住，我的名字叫毛蛋', chatParams)
  openai.createChatCompletions('请问我叫什么名字', chatParams, (res) => {console.log(res.content)}) // ==> 您告诉过我您的名字是毛蛋。

• createCustomRequest()

  // 第一种使用方法: 通过callback处理数据
  openai.createCustomRequest('/v1/models', (res) => { console.log(res) })
  // 第二种使用方法: async/await
  console.log(await openai.createCustomRequest('/v1/models'))
  // 第三种使用方法：传入config对象，具体参数参照axios的config参数
  const params = {
    model: "text-davinci-003",
    prompt: "Hello"
  }
  console.log(await openai.createCustomRequest({method: 'post', url: '/v1/completions', data: params}))

• generateImage()

  // 具体使用方法，参考以上几种示例 
  const param = {
    local: true // 新增参数：是否本地保存图片，开启之后，图片会保存到sourceDir/image目录下，并且返回本地保存地址
  }
  console.log(await openai.generateImage('A cute baby sea otter', param))
  console.log(await openai.generateImage({prompt: 'A cute baby sea otter'}))
  openai.generateImage('A cute baby sea otter', param, (res) => { console.log(res) })

• createTranscription()

  // 具体使用方法，参考以上几种示例 
  const param = {
    file: './openai_source/audio/Nomeolvides.mp3' // 本地音频资源地址或者直接传stream流
  }
  console.log(await openai.createTranscription(param))
  openai.createTranscription('./openai_source/audio/Nomeolvides.mp3', (res) => { console.dir(res) })