API 接口

介绍

您可以通过来自任何开发语言的HTTP请求与API进行交互:我们官方提供的Python库、Node.js库, 以及社区维护的库.

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

pip install openai

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

npm install openai

认证

我们建议完成快速入门教程,通过动手的交互式示例熟悉关键概念。 快速入门教程 通过构建快速示例应用程序进行学习

提示和完成

完成终结点位于 API 的中心。它为我们的模型提供了一个简单的界面,非常灵活和强大。您输入一些文本作为提示,模型将生成一个文本补全,尝试匹配您为其提供的任何上下文或模式。例如,如果您向 API 提供提示“为冰淇淋店编写标语”,它将返回类似“我们每勺都提供微笑!

设计提示本质上是“编程”模型的方式,通常是通过提供一些说明或一些示例。这与大多数其他 NLP 服务不同,后者是为单个任务设计的,例如情绪分类或命名实体识别。相反,完成端点几乎可用于任何任务,包括内容或代码生成、摘要、扩展、对话、创意写作、风格迁移等。

认证

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

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

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

Authorization: Bearer YOUR_API_KEY

概述

OpenAI API 几乎可以应用于任何涉及理解或生成自然语言或代码的任务。我们提供一系列具有不同权重级别的 models,适用于不同的任务,并能够微调您自己的定制模型。这些模型可用于从内容生成到语义搜索和分类的所有内容。

关键概念

我们建议完成快速入门教程,通过动手的交互式示例熟悉关键概念。 快速入门教程 通过构建快速示例应用程序进行学习

提示和完成

完成终结点位于 API 的中心。它为我们的模型提供了一个简单的界面,非常灵活和强大。您输入一些文本作为提示,模型将生成一个文本补全,尝试匹配您为其提供的任何上下文或模式。例如,如果您向 API 提供提示“为冰淇淋店编写标语”,它将返回类似“我们每勺都提供微笑!

设计提示本质上是“编程”模型的方式,通常是通过提供一些说明或一些示例。这与大多数其他 NLP 服务不同,后者是为单个任务设计的,例如情绪分类或命名实体识别。相反,完成端点几乎可用于任何任务,包括内容或代码生成、摘要、扩展、对话、创意写作、风格迁移等。

令 牌

我们的模型通过将文本分解为标记来理解和处理文本。标记可以是单词,也可以只是字符块。例如,单词“汉堡包”被分解为标记“”,“”和“”,而像“”这样的简短而常见的单词是单个令牌。许多标记以空格开头,例如“”和“”。

给定 API 请求中处理的令牌数量取决于输入和输出的长度。根据粗略的经验法则,对于英文文本,1 个标记大约是 4 个字符或 0.75 个单词。要记住的一个限制是,文本提示和生成的完成组合不得超过模型的最大上下文长度(对于大多数模型,这是 2048 个标记,或大约 1500 个单词)。查看我们的分词器工具,详细了解文本如何转换为分词。

模型

该 API 由一组具有不同功能和价位的模型提供支持。我们的基本 GPT-3 模型称为达芬奇、居里、巴贝奇和艾达。我们的 Codex 系列是 GPT-3 的后代,经过自然语言和代码训练。要了解更多信息,请访问我们的模型文档。

后续步骤

在开始构建应用程序时,请记住我们的使用策略。 探索我们的示例库以获取灵感。 跳转到我们的指南之一,开始构建。