简介
你可以通过任何语言的HTTP请求,通过我们的官方Python绑定,我们的官方Node.js库,或社区维护的库,与API进行交互。
要安装官方的Python绑定,请运行以下命令。
要安装官方的Node.js库,在你的Node.js项目目录下运行以下命令。
验证
OpenAI的API使用API密钥进行认证。请访问您的API密钥页面,检索您将在请求中使用的API密钥。
请记住,您的API密钥是一个秘密!不要与他人分享,也不要在任何客户端代码(浏览器、应用程序)中公开。不要与他人分享,也不要在任何客户端代码(浏览器、应用程序)中暴露出来。生产请求必须通过你自己的后台服务器,你的API密钥可以从环境变量或密钥管理服务中安全地加载。
所有的API请求应该在授权HTTP头中包括你的API密钥,如下所示。
Authorization: Bearer YOUR_API_KEY
关于组织的请求
对于属于多个组织的用户,你可以通过一个头来指定API请求使用哪个组织。这些API请求的用量将计入指定组织的订阅配额。
curl命令的例子:
使用openai
Python软件包的例子:
import os
import openai
openai.organization = "org-1kqjreHsYnuOOga5pi4zsNXS"
openai.api_key = os.getenv("OPENAI_API_KEY")
openai.Model.list()
使用openai
Node.js包的例子:
import { Configuration, OpenAIApi } from "openai";
const configuration = new Configuration({
organization: "org-1kqjreHsYnuOOga5pi4zsNXS",
apiKey: process.env.OPENAI_API_KEY,
});
const openai = new OpenAIApi(configuration);
const response = await openai.listEngines();
发起请求
你可以把下面的命令粘贴到你的终端,运行你的第一个API请求。确保将YOUR_API_KEY
替换为你的秘密API密钥。
curl https://api.openai.com/v1/chat/completions \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-d '{
"model": "gpt-3.5-turbo",
"messages": [{"role": "user", "content": "Say this is a test!"}],
"temperature": 0.7
}'
这个请求查询gpt-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":"\n\nThis is a test!"
},
"finish_reason":"stop",
"index":0
}
]
}
现在你已经生成了你的第一个聊天完成度。我们可以看到finish_reason是stop,这意味着API返回了由模型生成的完整完成度。在上面的请求中,我们只生成了一条消息,但你可以设置n参数来生成多条消息的选择。在这个例子中,gpt-3.5-turbo被用于更多的传统文本完成任务。该模型也为聊天应用进行了优化。