OpenAI-API 接口文档(中文版)(openai接口取消不要钱)

openai接口取消不要钱的进一步展开说明

# OpenAI API中文版使用指南

## 介绍

如果你想使用OpenAI的API，你可以通过HTTP要求与API进行交互，支持任何语言。同时，也能够使用官方提供的Python绑定、Node.js库或社区保护的库来进行调用。

如果你想安装官方的Python绑定，可以运行以下命令：

“`
pip install openai
“`

如果你想安装官方的Node.js库，在你的Node.js项目目录中运行以下命令：

“`
npm install openai
“`

## 认证

1. OpenAI-API-KEY

OpenAI的API使用API密钥进行身份验证。请到你的API密钥页面获得你在要求中所使用的API密钥。

请注意，你的API密钥是机密的！不要与其他人分享，也不要在任何客户端代码（浏览器、利用程序）中公然它。生产要求一定要通过你自己的后台服务器路由，其中你的API密钥可以从环境变量或密钥管理服务中安全加载。

在所有API要求的Authorization HTTP标头中都需要包括你的API密钥，以下所示：

“`
Authorization: Bearer OPENAI_API_KEY
“`

2. OpenAI-Organization

对属于多个组织的用户，你可以通过传递一个表头来指定用于API要求的组织。这些API要求的使用将计入指定组织的定阅配额。

通过curl命令示例：

“`
curl https://api.openai.com/v1/models
-H “Authorization: Bearer $OPENAI_API_KEY”
-H “OpenAI-Organization: org-gth0C8mT2wnKealyCkSRrpQk”
“`

使用openai Python包的示例：

“`python
import os
import openai

openai.organization = “org-gth0C8mT2wnKealyCkSRrpQk”
openai.api_key = os.getenv(“OPENAI_API_KEY”)
openai.Model.list()
“`

使用openai Node.js包的示例：

“`javascript
import { Configuration, OpenAIApi } from “openai”;

const configuration = new Configuration({
organization: “org-gth0C8mT2wnKealyCkSRrpQk”,
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⑶.5-turbo”,
“messages”: [{“role”: “user”, “content”: “Say this is a test!”}],
“temperature”: 0.7
}’
“`

这个要求将查询`gpt⑶.5-turbo`模型，以完成从提示`Say this is a test`开始的文本。你应当会收到类似以下内容的响应：

“`json
{
“id”: “chatcmpl-abc123”,
“object”: “chat.completion”,
“created”: 1677858242,
“model”: “gpt⑶.5-turbo-0301”,
“usage”: {
“prompt_tokens”: 13,
“completion_tokens”: 7,
“total_tokens”: 20
},
“choices”: [
{
“message”: {
“role”: “assistant”,
“content”: “This is a test!”
},
“finish_reason”: “stop”,
“index”: 0
}
]
}
“`

现在你已生成了第一个聊天室完成。我们可以看到`finish_reason`是`stop`，这意味着API返回了模型生成的完全完成。在上面的要求中，我们只生成了一条消息，但是你可使用`n`参数来生成多个消息选项。在这个示例中，`gpt⑶.5-turbo`被用于更传统的文本完成任务。该模型也优化了聊天利用。

## 模型

列出并描写API中可用的各种模型。你可以参考模型文档以了解可用的模型和它们之间的差异。

1. 罗列模型

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

列出当前可用的模型，并提供有关每一个模型的基本信息，例如所有者和可用性。

要求演示：

“`
curl https://api.openai.com/v1/models
-H “Authorization: Bearer $OPENAI_API_KEY”
“`

响应：

“`json
{
“data”: [
{
“id”: “model-id-0”,
“object”: “model”,
“owned_by”: “organization-owner”,
“permission”: […]
},
{
“id”: “model-id⑴”,
“object”: “model”,
“owned_by”: “organization-owner”,
“permission”: […]
},
{
“id”: “model-id⑵”,
“object”: “model”,
“owned_by”: “openai”,
“permission”: […]
},
],
“object”: “list”
}
“`

2. 检索模型

GET https://api.openai.com/v1/models/{model}

检索模型实例，提供有关模型的基本信息，例如所有者和权限。

其中， model 是必填的字符串类型，用于此要求的模型的ID。

要求演示：

“`
curl https://api.openai.com/v1/models/text-davinci-003
-H “Authorization: Bearer $OPENAI_API_KEY”
“`

响应：

“`json
{
“id”: “text-davinci-003”,
“object”: “model”,
“owned_by”: “openai”,
“permission”: […]
}
“`

## 文本生成

给定一个提示，模型将返回一个或多个预测的完成，并且还可以在每一个位置返回替换令牌的几率。

POST https://api.openai.com/v1/completions

为给定的提示和参数创建完成。

要求演示：

“`shell
curl https://api.openai.com/v1/completions
-H “Content-Type: application/json”
-H “Authorization: Bearer $OPENAI_API_KEY”
-d ‘{
“model”: “text-davinci-003”,
“prompt”: “Say this is a test”,
“max_tokens”: 7,
“temperature”: 0
}’
“`

响应：

“`json
{
“id”: “cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7”,
“object”: “text_completion”,
“created”: 1589478378,
“model”: “text-davinci-003”,
“choices”: [
{
“text”: “This is indeed a test”,
“index”: 0,
“logprobs”: null,
“finish_reason”: “length”
}
],
“usage”: {
“prompt_tokens”: 5,
“completion_tokens”: 7,
“total_tokens”: 12
}
}
“`

Request body(入参详解)

– model（string，必填）：要使用的模型的ID。
– prompt（string or array，选填，默许为

openai接口取消不要钱的常见问答Q&A