介绍

您可以通过任何语言的 HTTP 请求、我们的官方 Python 绑定、我们的官方 Node.js 库或社区维护的库与 API 交互。

要安装官方 Python 绑定，请运行以下命令：

pip install openai

要安装官方 Node.js 库，请在 Node.js 项目目录中运行以下命令：

npm install openai

验证

OpenAI API 使用 API 密钥进行身份验证。访问您的API 密钥页面以检索您将在请求中使用的 API 密钥。

请记住，您的 API 密钥是秘密的！不要与他人共享或在任何客户端代码（浏览器、应用程序）中公开它。生产请求必须通过您自己的后端服务器进行路由，您的 API 密钥可以从环境变量或密钥管理服务中安全加载。

所有 API 请求都应在 HTTP 标头中包含您的 API 密钥，Authorization如下所示：

Authorization: Bearer OPENAI_API_KEY

请求组织

对于属于多个组织的用户，您可以传递一个标头来指定哪个组织用于 API 请求。来自这些 API 请求的使用将计入指定组织的订阅配额。

卷曲命令示例：

curl https://api.openai.com/v1/models

  -H "Authorization: Bearer $OPENAI_API_KEY"

  -H "OpenAI-Organization: org-wz7FeUF4KSIM2Jvv98ssOps2"

Python 包的示例openai：

import os

import openai

openai.organization = "org-wz7FeUF4KSIM2Jvv98ssOps2"

openai.api_key = os.getenv("OPENAI_API_KEY")

openai.Model.list()

Node.js 包的示例openai：

import { Configuration, OpenAIApi } from "openai";

const configuration = new Configuration({

    organization: "org-wz7FeUF4KSIM2Jvv98ssOps2",

    apiKey: process.env.OPENAI_API_KEY,

});

const openai = new OpenAIApi(configuration);

const response = await openai.listEngines();

组织 ID 可以在您的组织设置页面上找到。

发出请求

您可以将下面的命令粘贴到您的终端中以运行您的第一个 API 请求。确保替换$OPENAI_API_KEY为您的秘密 API 密钥。

curl https://api.openai.com/v1/chat/completions

  -H "Content-Type: application/json"

  -H "Authorization: Bearer $OPENAI_API_KEY"

  -d '{

     "model": "gpt-3.5-turbo",

     "messages": [{"role": "user", "content": "Say this is a test!"}],

     "temperature": 0.7

   }'

此请求查询模型以完成以提示“ Say this is a testgpt-3.5-turbo ”开头的文本。您应该会收到类似于以下内容的响应：

 {

   "id":"chatcmpl-abc123",

   "object":"chat.completion",

   "created":1677858242,

   "model":"gpt-3.5-turbo-0301",

   "usage":{

      "prompt_tokens":13,

      "completion_tokens":7,

      "total_tokens":20

   },

   "choices":[

      {

         "message":{

            "role":"assistant",

            "content":"nnThis is a test!"

         },

         "finish_reason":"stop",

         "index":0

      }

   ]

}

现在你已经生成了你的第一个聊天完成。我们可以看到finish_reasonisstop这意味着 API 返回了模型生成的完整完成。在上面的请求中，我们只生成了一条消息，但是您可以设置参数n来生成多条消息选择。在这个例子中，gpt-3.5-turbo更多的是用于传统的文本完成任务。该模型还针对聊天应用程序进行了优化。