OpenAI 接口文档-(中文版)-(一)

介绍 Introduction

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

若要安装官方 Python 绑定,请运行以下命令:

pip install openai

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

npm install openai

认证

OpenAI API 使用 API 密钥进行身份验证。访问您的 API 密钥页面,检索您将在请求中使用的 API 密钥https://platform.openai.com/account/api-keys

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

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

Authorization: Bearer OPENAI_API_KEY

请求组织

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

示例 curl 命令:

curl https://api.openai.com/v1/models \-H "Authorization: Bearer $OPENAI_API_KEY" \-H "OpenAI-Organization: org-9IDA3AdSqPmLz47IRWkb82tK"

Python 包的示例:openai

import os
import openai
openai.organization = "org-9IDA3AdSqPmLz47IRWkb82tK"
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-9IDA3AdSqPmLz47IRWkb82tK",apiKey: process.env.OPENAI_API_KEY,
});
const openai = new OpenAIApi(configuration);
const response = await openai.listEngines();

提出请求 Making requests

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

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}'

此请求查询模型以完成以提示“说这是一个测试”开头的文本。您应该收到类似于以下内容的回复: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}]
}

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

模型 Models

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

列出模型 List models

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","owned_by": "organization-owner","permission": [...]},{"id": "model-id-1","object": "model","owned_by": "organization-owner","permission": [...]},{"id": "model-id-2","object": "model","owned_by": "openai","permission": [...]},],"object": "list"
}

检索模型 Retrieve model

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

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

示例请求

text-davinci-003

curl https://api.openai.com/v1/models/text-davinci-003 \-H "Authorization: Bearer $OPENAI_API_KEY"

路径参数

模型 model

string

必填

用于此请求的模型的 ID

响应

{"id": "text-davinci-003","object": "model","owned_by": "openai","permission": [...]
}

补全 Completions

给定提示,模型将返回一个或多个预测完成,还可以返回每个位置的替代令牌的概率。

创建补全 Create completion

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

为提供的提示和参数创建补全

//以text-davinci-003为例,下同

示例请求

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}'

参数

{"model": "text-davinci-003","prompt": "Say this is a test","max_tokens": 7,"temperature": 0,"top_p": 1,"n": 1,"stream": false,"logprobs": null,"stop": "\n"
}

响应

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

请求正文

模型 model
字符串
必填

要使用的模型的 ID。可以使用列表模型 API 查看所有可用模型,或参阅模型概述了解它们的描述。

提示 promt
字符串或数组
自选
默认为 <|endoftext|>

用于生成完成、编码为字符串、字符串数组、标记数组或标记数组数组的提示。

请注意,<|endoftext|> 是模型在训练期间看到的文档分隔符,因此如果未指定提示,模型将生成,就像从新文档的开头一样。

后缀 suffix
字符串
自选
默认值为空

完成插入文本后的后缀。

max_tokens
整数
自选
默认值为 16

完成时要生成的最大令牌数。

提示加号的令牌计数不能超过模型的上下文长度。大多数模型的上下文长度为 2048 个令牌(最新模型除外,它支持 4096)。max_tokens

温度 temperature
自选
默认值为 1

使用什么采样温度,介于 0 和 2 之间。较高的值(如 0.8)将使输出更加随机,而较低的值(如 0.2)将使其更加集中和确定。

我们通常建议更改此设置,但不要同时更改两者。top_p

top_p
自选
默认值为 1

使用温度采样的替代方法称为核心采样,其中模型考虑具有top_p概率质量的令牌的结果。因此,0.1 意味着只考虑包含前 10% 概率质量的代币。

我们通常建议更改此设置,但不要同时更改两者。temperature

n
整数
自选
默认值为 1

为每个提示生成的完成次数。

注意:由于此参数会生成许多完成,因此它会快速消耗令牌配额。请谨慎使用,并确保对 和 进行合理的设置。max_tokensstop

流 stream
布尔
自选
默认为 false

是否流式传输回部分进度。如果设置,令牌将在可用时作为纯数据服务器发送的事件发送,流由消息终止。data: [DONE]

对数 logprobs
整数
自选
默认值为空

包括最可能的令牌的日志概率,以及所选令牌。例如,如果为 5,则 API 将返回 5 个最可能的令牌的列表。API 将始终返回采样令牌的 ,因此响应中最多可能有元素。logprobslogprobslogproblogprobs+1

的最大值为 5。如果您需要更多,请通过我们的帮助中心与我们联系并描述您的使用案例。logprobs

回显 echo
布尔
自选
默认为 false

除了完成之外,还回显提示

停用词 stop
字符串或数组
自选
默认值为空

最多 4 个序列,其中 API 将停止生成更多令牌。返回的文本将不包含停止序列。

presence_penalty
自选
默认值为 0

介于 -2.0 和 2.0 之间的数字。正值会根据新标记到目前为止是否出现在文本中来惩罚它们,从而增加模型讨论新主题的可能性。

查看有关频率和状态处罚的更多信息。

frequency_penalty
自选
默认值为 0

介于 -2.0 和 2.0 之间的数字。正值会根据新标记到目前为止在文本中的现有频率来惩罚新标记,从而降低模型逐字重复同一行的可能性。

查看有关频率和状态处罚的更多信息。

best_of
整数
自选
默认值为 1

在服务器端生成完成并返回“最佳”(每个令牌的日志概率最高的那个)。无法流式传输结果。best_of

与 一起使用时,控制候选完成次数并指定要返回的完成次数 – 必须大于 。nbest_ofnbest_ofn

注意:由于此参数会生成许多完成,因此它会快速消耗令牌配额。请谨慎使用,并确保对 和 进行合理的设置。max_tokensstop

logit_bias
地图
自选
默认值为空

修改完成中出现指定令牌的可能性。

接受将令牌(由其在 GPT 标记器中的令牌 ID 指定)映射到 -100 到 100 之间的关联偏差值的 json 对象。您可以使用此分词器工具(适用于 GPT-2 和 GPT-3)将文本转换为令牌 ID。在数学上,偏差在采样之前被添加到模型生成的对数中。确切的效果因模型而异,但介于 -1 和 1 之间的值应降低或增加选择的可能性;像 -100 或 100 这样的值应该会导致禁止或排他性选择相关令牌。

例如,您可以传递以防止生成 <|endoftext|> 令牌。{"50256": -100}

用户
字符串
自选

代表最终用户的唯一标识符,可帮助 OpenAI 监控和检测滥用行为。了解更多。

聊天 Chat

给定聊天对话,模型将返回聊天完成响应。

创建聊天补全 Create chat completion 

试用版

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

为聊天消息创建补全

实例请求

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": "Hello!"}]}'

参数

{"model": "gpt-3.5-turbo","messages": [{"role": "user", "content": "Hello!"}]
}

响应

{"id": "chatcmpl-123","object": "chat.completion","created": 1677652288,"choices": [{"index": 0,"message": {"role": "assistant","content": "\n\nHello there, how may I assist you today?",},"finish_reason": "stop"}],"usage": {"prompt_tokens": 9,"completion_tokens": 12,"total_tokens": 21}
}

请求正文

字符串
必填

要使用的模型的 ID。有关哪些模型与聊天 API 配合使用的详细信息,请参阅模型终端节点兼容性表。

消息
数组
必填

要为其生成聊天完成的消息,采用聊天格式。

温度
自选
默认值为 1

使用什么采样温度,介于 0 和 2 之间。较高的值(如 0.8)将使输出更加随机,而较低的值(如 0.2)将使其更加集中和确定。

我们通常建议更改此设置,但不要同时更改两者。top_p

top_p
自选
默认值为 1

使用温度采样的替代方法称为核心采样,其中模型考虑具有top_p概率质量的令牌的结果。因此,0.1 意味着只考虑包含前 10% 概率质量的代币。

我们通常建议更改此设置,但不要同时更改两者。temperature

n
整数
自选
默认值为 1

要为每个输入消息生成的聊天完成选项数。

布尔
自选
默认为 false

如果设置,将发送部分消息增量,就像在 ChatGPT 中一样。令牌将在可用时作为纯数据服务器发送的事件发送,流由消息终止。有关示例代码,请参阅 OpenAI 说明书。data: [DONE]

字符串或数组
自选
默认值为空

最多 4 个序列,其中 API 将停止生成更多令牌。

max_tokens
整数
自选
默认为 inf

要在聊天完成中生成的最大令牌数。

输入令牌和生成的令牌的总长度受模型上下文长度的限制。

presence_penalty
自选
默认值为 0

介于 -2.0 和 2.0 之间的数字。正值会根据新标记到目前为止是否出现在文本中来惩罚它们,从而增加模型讨论新主题的可能性。

查看有关频率和状态处罚的更多信息。

frequency_penalty
自选
默认值为 0

介于 -2.0 和 2.0 之间的数字。正值会根据新标记到目前为止在文本中的现有频率来惩罚新标记,从而降低模型逐字重复同一行的可能性。

查看有关频率和状态处罚的更多信息。

logit_bias
地图
自选
默认值为空

修改完成中出现指定令牌的可能性。

接受将令牌(由其在分词器中的令牌 ID 指定)映射到 -100 到 100 之间的关联偏差值的 json 对象。在数学上,偏差在采样之前被添加到模型生成的对数中。确切的效果因模型而异,但介于 -1 和 1 之间的值应降低或增加选择的可能性;像 -100 或 100 这样的值应该会导致禁止或排他性选择相关令牌。

用户
字符串
自选

代表最终用户的唯一标识符,可帮助 OpenAI 监控和检测滥用行为。了解更多。

编辑

给定提示和指令,模型将返回提示的编辑版本。

创建编辑

发布 https://api.openai.com/v1/edits

为提供的输入、指令和参数创建新的编辑。

示例请求

curl https://api.openai.com/v1/edits \-H "Content-Type: application/json" \-H "Authorization: Bearer $OPENAI_API_KEY" \-d '{"model": "text-davinci-edit-001","input": "What day of the wek is it?","instruction": "Fix the spelling mistakes"}'

参数

{"model": "text-davinci-edit-001","input": "What day of the wek is it?","instruction": "Fix the spelling mistakes",
}

响应

{"object": "edit","created": 1589478378,"choices": [{"text": "What day of the week is it?","index": 0,}],"usage": {"prompt_tokens": 25,"completion_tokens": 32,"total_tokens": 57}
}

请求正文

模型 model
字符串
必填

要使用的模型的 ID。可以将 or 用于此终结点。text-davinci-edit-001code-davinci-edit-001

输入 input
字符串
自选
默认为''

要用作编辑起点的输入文本。

指令 instruction
字符串
必填

告知模型如何编辑提示的说明。

n
整数
自选
默认值为 1

要为输入和指令生成的编辑次数。

温度 temperature
自选
默认值为 1

使用什么采样温度,介于 0 和 2 之间。较高的值(如 0.8)将使输出更加随机,而较低的值(如 0.2)将使其更加集中和确定。

我们通常建议更改此设置,但不要同时更改两者。top_p

top_p
自选
默认值为 1

使用温度采样的替代方法称为核心采样,其中模型考虑具有top_p概率质量的令牌的结果。因此,0.1 意味着只考虑包含前 10% 概率质量的代币。

我们通常建议更改此设置,但不要同时更改两者。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/9331.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

又一新闻,Meta研发了超越chatGPT的新平台LLAMA

一、Meta 全新大语言模型 LLaMA 正通过种子公开发放 2 月 24 日&#xff0c;Meta 公司发布了新的大模型系列 —— LLaMA&#xff08;Large Language Model Meta AI&#xff09;。Meta 宣称&#xff0c;LLaMA 规模仅为竞争对手 ChatGPT 的“十分之一”&#xff0c;但性能却优于 …

chatGPT真有那么神吗?

ChatGPT热度依旧霸榜&#xff0c;接连被许多名人点赞了&#xff01;国外微软的比尔盖茨、纳德拉、特斯拉的马斯克&#xff0c;国内的李彦宏、周鸿祎、张朝阳&#xff0c;甚至不是科技圈的作者郑渊洁&#xff0c;也因为ChatGPT的出现&#xff0c;开始相信“作家有可能在未来会失…

LLM:Prompt-Tuning/Instruction-tuning微调新范式

背景 Pre-training Fine-tuning 模式&#xff1a;先在Pre-training阶段通过一个模型在大规模无监督语料上预先训练一个预训练语言模型&#xff08;Pre-trained Language Model&#xff0c;PLM&#xff09;&#xff08;e.g. GPT、EMLO、BERT&#xff09;&#xff0c;然后在Fine…

剪枝与重参第五课:前置知识

目录 前置知识前言1.CIFAR10数据集1.1 简介1.2 数据集的获取1.3 数据集的加载 2.VGG网络搭建2.1 VGGNet2.2 VGG网络实现 3.Batch Normalize3.1 简介3.2 BN层实现 4.L1&L2正则4.1 L1正则化(Lasso回归)4.2 L2正则化(岭回归)4.3 思考 5.train5.1 parse_opt5.2 train5.3 test5.…

分享:从ChatGPT给到的数据库故障案例,看开发协同未来趋势

欢迎访问 OceanBase 官网获取更多信息&#xff1a;https://www.oceanbase.com/ 本文来自OceanBase社区分享&#xff0c;仅限交流探讨。原作者陈小伟。 我是陈小伟&#xff0c; 2019 年加入 OceanBase&#xff0c;目前负责 OceanBase 开发者中心的研发。 OceanBase ODC 这几年从…

login登录页

目录 顶部导航条&#xff1a;复用head组件账号密码登录表单 顶部导航条&#xff1a;复用head组件 <v-head goBack"true" title"登录"></v-head>账号密码登录表单 label标签不会向用户呈现任何特殊效果。不过&#xff0c;如果你在label标签内点…

ChatGPT大解密:带您探讨机器学习背后的秘密、利用与发展

一、什么是机器学习&#xff1f;二、ChatGPT 的运作原理三、ChatGPT 生活利用1、自然语言处理2、翻译3、自动回复 四、ChatGPT vs 其他相关技术五、ChatGPT 的未来1、未来发展2、职业取代3、客服人员4、翻译人员5、语言学家6、机遇与挑战 六、结语 这篇文章&#xff0c;将带着各…

32篇年度最佳AI论文;Python编译器Codon开源;ChatGPT的前世今生

1. 2022年最佳AI论文32篇&#xff1a;DALLE 2、Stable Diffusion、ChatGPT等入选 大模型和文生图、跨模态是今年毫无疑问的热点&#xff0c;此外也有多篇GAN等视觉领域的文章。GitHub上还有这些论文的短视频和文字解读、代码链接等。 从论文的主要贡献机构来看&#xff08;有些…

ChatGPT 到底给微软赚了多少钱?答:至少 900 亿美元!

整理 | 朱珂欣 出品 | CSDN程序人生&#xff08;ID&#xff1a;coder_life&#xff09; 在 AI 的赛道上&#xff0c;微软手握 ChatGPT 这张「王炸」&#xff0c;可谓是最大赢家。 据彭博社报道&#xff0c;近日&#xff0c;秉承着对生成式 AI 前景的期待 &#xff0c;国际性…

谷歌迎着ChatGPT炮火发布Bard!CEO下令全员测试,保卫搜索刻不容缓

鱼羊 衡宇 发自 凹非寺量子位 | 公众号 QbitAI 被ChatGPT逼到墙角的谷歌&#xff0c;终于要正面反击了&#xff1a; 谷歌版ChatGPT&#xff0c;已确定发布。 谷歌CEO皮查伊亲自撰文宣布&#xff1a;将推出对话人工智能服务Bard。 就在今天&#xff0c;Bard将向测试人员开放&…

面对ChatGPT的挑战,谷歌CEO怒发Bard调教指南:别慌,咱向来是弯道超车

新智元报道 编辑&#xff1a;编辑部 【新智元导读】谷歌被唱衰多日&#xff0c;劈柴终于出手了&#xff01;他发备忘录鼓励员工&#xff1a;别怕&#xff0c;「迟到也能赢」是咱们公司老传统了。 谷歌CEO劈柴反击了&#xff01;他告诉员工&#xff1a;别慌&#xff0c;咱们迟…

谷歌真被ChatGPT搞慌了!两位创始人紧急回归制定战术,搜索广告根基不容有失...

衡宇 发自 凹非寺量子位 | 公众号 QbitAI 谷歌是真的慌了。 一边节流&#xff1a;12000名打工人年关遭裁员&#xff0c;如今又被曝制定防守战略&#xff1a; 并且紧急召唤了两位创始人。 △谷歌创始人佩奇&#xff08;左图&#xff09;和布林&#xff08;右图&#xff09; 就在…

微软和谷歌又要“打”起来了!网友:太好了

整理 | 郑丽媛 出品 | CSDN&#xff08;ID&#xff1a;CSDNnews&#xff09; 停战 6 年后&#xff0c;微软和谷歌又要“打”起来了。 作为在搜索引擎、浏览器等许多领域均有涉及的两大科技巨头&#xff0c;微软和谷歌多年来一直纷争不断&#xff1a;今天你起诉我侵犯专利&#…

谷歌google bard vs chatgpt给我的最大感受,速度真快,注册简单,多种答案提供。。。

上一篇写了注册百度和Google&#xff0c;最后还是谷歌的速度战胜了&#xff0c;最终在长达3天的等待中得到了拿到了测试名额。 成功注册bard后&#xff0c;映入眼帘的就是提示下面的话&#xff0c;我做了翻译&#xff1a; Bard is an experiment As you try Bard, please re…

重磅发布!微软推出首款 ChatGPT 版搜索引擎

点击“开发者技术前线”&#xff0c;选择“星标” 让一部分开发者看到未来 转自&#xff1a;机器之心 一夜之间&#xff0c;全球最大的科技公司仿佛都回到了自己年轻时的样子。 在谷歌宣布「实验性对话式人工智能服务」Bard 之后仅 24 小时&#xff0c;北京时间 2 月 8 日凌晨两…

【ChatGPT】比尔·盖茨最新分享:ChatGPT的发展,不止于此

✅作者简介&#xff1a;在读博士&#xff0c;伪程序媛&#xff0c;人工智能领域学习者&#xff0c;深耕机器学习&#xff0c;交叉学科实践者&#xff0c;周更前沿文章解读&#xff0c;提供科研小工具&#xff0c;分享科研经验&#xff0c;欢迎交流&#xff01; &#x1f4cc;个…

体验了微软的ChatGPT后 我觉得谷歌、百度麻烦了

前言 首先我这里已经拿到bing的搜索机器人使用名单,如果你不知道如何申请可以直接看文章的最底部 这里是我mac版本的bing的使用体验 可以看到这里提问,还有辅助提问,甚至还有每个回答下面此回答的来源链接 如何申请bing的AI体验 直接使用Microsoft Edege浏览器输入 https:/…

微软、Google、Twitter、Facebook登录

文章目录 微软、Google、Twitter、Facebook登录1.背景2.微软登录(1&#xff09;官方文档地址&#xff08;2&#xff09;时序图a、步骤10b、步骤12 3、谷歌登录&#xff08;1&#xff09;官方文档地址&#xff08;2&#xff09;时序图&#xff08;3&#xff09;步骤说明步骤7 5、…

全新推出Bard,谷歌google或许可以靠它打败微软OpenAI ChatGPT

目录 前言Bard优势Bard新功能更直观的Bard互动Bard深度集成google search“Help me write” in Gmail谷歌地图路线的全新沉浸式视图谷歌照片全新Magic Editor体验Bard与其他服务的结合谷歌为Android开发者推出AI编码机器人其他 总结参考资料其它资料下载 前言 截止到目前&…

【历史上的今天】11 月 19 日:Microsoft Office 首次发布;谷歌开源 Chrome OS;Twitter 创始人出生

整理 | 王启隆 透过「历史上的今天」&#xff0c;从过去看未来&#xff0c;从现在亦可以改变未来。 今天是 2021 年 11 月 19 日&#xff0c;在 5 年前的今天&#xff0c;世界首个光子神经网络诞生&#xff1b;来自普林斯顿大学的 Alexander N. Tait 等科学家在 arXiv 上发表了…