如何将OpenAI集成到项目中

1,688 阅读2分钟

前言

在如今的技术领域中,人工智能(AI)正在迅速改变着我们的工作方式。OpenAI 提供了强大的 AI 模型,可以帮助开发者在他们的项目中实现各种智能功能。所以如何才能把openAI集成到我们的项目供我们使用呢?下面通过一个简单的例子讲解!

step1: 获取API密钥

github.com/chatanywher…

大家可以通过上面这个链接进入申请免费的API密钥

image.png

step2:安装OpenAI客户端库

在你的项目目录中打开终端并运行以下命令:

npm install openai
  • 这条命令使用 Node.js 的包管理器 npm 安装 OpenAI 客户端库,并将其添加到项目的 node_modules 目录中。
  • 这样,您就可以在项目中使用 OpenAI 提供的 API 进行开发。

step3: 引入 OpenAI 客户端库

在JavaScript 中,添加代码引入 OpenAI 客户端库:

const OpenAI = require('openai');

step4: 实例化 OpenAI 客户端

实例化OpenAI 客户端库

const client = new OpenAI({
  apiKey: 'your-api-key',  // 替换为您的实际 API 密钥
  baseURL: 'https://api.chatanywhere.tech/v1'
});
  • baseURL 是 OpenAI API 的基础 URL,指向 API 请求的地址。

step5: 调用 OpenAI API

  1. 调用OpenAI的功能和方法
  2. 传递所需参数
async function main() {
  const chatCompletion = await client.chat.completions.create({
    messages: [{ role: 'user', content: '你是谁?' }],
    model: 'gpt-3.5-turbo'
  });
  console.log(chatCompletion.choices[0]);
}
  • client.chat.completions.create 是一个 API 调用,用于生成聊天完成结果。

参数

messages 参数

  • 类型:数组

  • 内容:包含对话消息的对象,每个对象代表一条消息。

  • 格式:每个对象有两个字段:

    • role:消息的角色,常见的角色包括:

      • 'user':表示用户发送的消息。
      • 'system':表示系统消息,通常用于设定对话的背景或规则。
      • 'assistant':表示 AI 助理的回复。
    • content:消息的内容,即文本字符串。

model 参数

  • 类型:字符串

  • 内容:指定使用的 OpenAI 模型的名称。

  • 说明

    :不同的模型有不同的能力和性能,常用的模型包括:

    • gpt-3.5-turbo:一个高效的语言模型,适用于各种对话和生成任务。
    • text-davinci-003:功能更强大的模型,适用于更复杂和高级的任务。

最后返回结果

image.png

通过上述简单案例的讲解,我们已经将OpenAI集成到我们的项目之中,并调用了他的聊天API,获取到了返回结果!

OpenAI 客户端库不仅提供了用于生成聊天完成结果的方法 还包括许多其他功能和方法来满足不同的需求。大家可以前往官方文档进行查看

Introduction - OpenAI API

持续关注小编,小编后续会总结举例一些比较常用的API!