Introduction介绍

（注意以下所有url中的：https://api.openai.com，需要替换为：https://api.zhizengzeng.com/）

一. Introduction 介绍

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

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

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

二. Authentication 认证

1. OpenAI-API-KEY

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

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

所有 API 请求都应在授权 HTTP 标头中包含您的 API 密钥，如下所示：
(注意Bearer OPENAI_API_KEY，Bearer的后面是有一个空格的)

2. OpenAI-Organization（可选）

Requesting organization 请求组织

对于属于多个组织的用户，您可以传递标头来指定 API 请求使用哪个组织。这些 API 请求的使用情况将计为指定组织的使用情况。

curl命令示例：

使用 openai Python包 的示例：

使用 openai Node.js包 的示例：

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

三. Making requests 提出请求

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

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

{
   "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":"\n\nThis is a test!"
         },
         "finish_reason":"stop",
         "index":0
      }
   ]
}

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

四. stream 流式

OpenAI API 提供了将响应流式传输回客户端的能力，以便允许某些请求得到部分结果。为了实现这一点，我们遵循服务器发送事件标准。我们的官方 Node 和 Python 库包含帮助程序，可以使解析这些事件变得更简单。

聊天完成 API 和助手 API 都支持流式处理。本节重点介绍流式传输如何用于聊天完成。在此处详细了解 Assistant API 中的流式传输工作原理。

在 Python 中，流请求如下所示：

在 Node / Typescript 中，流请求如下所示：

解析服务器发送的事件
解析服务器发送的事件并非易事，应谨慎执行。像换行之类的简单策略可能会导致解析错误。我们建议尽可能使用现有的客户端库。

一. Introduction 介绍#

二. Authentication 认证#

1. OpenAI-API-KEY#

2. OpenAI-Organization（可选）#