openai的API是干吗的的进一步展开说明

# OpenAI-API-中文版

## 一. 介绍

如果您想使用我们的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要求都将计入指定组织的定阅配额。

以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”开始的文本。您应当会收到类似以下内容的响应：

“`
{
“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
}
]
}
“`

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

## 四. 模型

### 列出模型

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

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

要求示例：

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

响应：

“`
{
“data”: [
{
“id”: “model-id-0”,
“object”: “model”,
“owner”: “organization-owner”,
“ready”: false
},
{
“id”: “model-id⑴”,
“object”: “model”,
“owner”: “organization-owner”,
“ready”: false
},
{
“id”: “model-id⑵”,
“object”: “model”,
“owner”: “openai”,
“ready”: true
}
],
“object”: “list”
}
“`

### 检索模型

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”
“`

响应：

“`
{
“id”: “text-davinci-003”,
“object”: “model”,
“owner”: “openai”,
“ready”: true
}
“`

## 五. 完成

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

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

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

要求示例：

“`
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
}’
“`

响应：

“`
{
“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, required）: 要使用的模型的ID。您可使用List Models API查看所有可用模型，或参阅模型概述以了解它们的描写。

– prompt（string or array, optional, defaults to

openai的API是干吗的的常见问答Q&A