如何构建允许 ChatGPT 智能调用您的 API 插件

OpenAI 插件将 ChatGPT 连接到第三方应用程序。这些插件使 ChatGPT 能够与开发人员定义的 API 进行交互，从而增强 ChatGPT 的功能并允许其执行范围广泛的操作。

• 插件可以允许 ChatGPT 执行以下操作：

• 检索实时信息；例如，体育比分、股票价格、最新消息等。

• 检索知识库信息；例如，公司文件、个人笔记等。

• 代表用户执行操作；例如，订机票、订餐等。

件处于有限的 alpha 阶段，您可能还无法访问。请加入候补名单以获得访问权限。在 alpha 期间，我们将与用户和开发人员密切合作，对插件系统进行迭代，这可能会发生重大变化。

如果您想在阅读文档时运行一个示例并了解有关插件的更多信息，您可以从我们的插件快速入门 repo开始。

插件开发人员公开一个或多个 API 端点，并附有标准化的清单文件和 OpenAPI 规范。这些定义了插件的功能，允许 ChatGPT 使用文件并调用开发人员定义的 API。

AI 模型充当智能 API 调用者。给定 API 规范和何时使用 API 的自然语言描述，模型会主动调用 API 来执行操作。例如，如果用户问“我应该在巴黎住几晚？”，模型可能会选择调用酒店预订插件 API，接收 API 响应，并结合 API 数据生成面向用户的答案及其自然语言能力。

随着时间的推移，我们预计该系统将不断发展以适应更高级的用例。

1. 创建清单文件并将其托管在******.com/.well-known/ai-plugin.json

• 该文件包括有关您的插件的元数据（名称、徽标等）、有关所需身份验证的详细信息（身份验证类型、OAuth URL 等）以及您要公开的端点的 OpenAPI 规范。

• 该模型将看到 OpenAPI 描述字段，可用于为不同字段提供自然语言描述。

• 我们建议在开始时仅公开 1-2 个端点，并使用最少数量的参数来最小化文本的长度。插件描述、API 请求和 API 响应都被插入到与 ChatGPT 的对话中。这不利于模型的上下文限制。

2. 在ChatGPT UI中注册您的插件

• 从顶部下拉菜单中选择插件型号，然后选择“插件”、“插件商店”，最后选择“安装未经验证的插件”或“开发您自己的插件”。

• 如果需要身份验证，请提供 OAuth 2client_id和client_secret/或 API 密钥。

3. 用户激活您的插件

• 用户必须在 ChatGPT UI 中手动激活您的插件。（默认情况下，ChatGPT 不会使用您的插件。）

• 在 alpha 期间，插件开发者将能够与 15 个额外的用户共享他们的插件（目前只有其他开发者可以安装未经验证的插件）。随着时间的推移，我们将推出一种提交您的插件以供审核的方式，以便向 ChatGPT 的所有用户群公开。

• 如果需要身份验证，用户将通过 OAuth 重定向到您的插件；您也可以选择在这里创建新帐户。

• 未来，我们希望构建功能来帮助用户发现有用和流行的插件。

4. 用户开始对话

• OpenAI 将在发送给 ChatGPT 的消息中插入对您的插件的简洁描述，最终用户看不到。这将包括插件描述、端点和示例。

• 当用户提出相关问题时，如果看起来相关，模型可能会选择从您的插件调用 API 调用；对于 POST 请求，我们要求开发人员构建用户确认流程。

• 该模型会将 API 结果合并到其对用户的响应中。

• 该模型可能在其响应中包含从 API 调用返回的链接。这些将显示为丰富的预览（使用OpenGraph 协议，我们在其中提取站点名称、标题、描述、图像和 url 字段）”

• 该模型还可以输出 markdown（如来自 API 的图像 URL），ChatGPT UI 将在 UI 中呈现 markdown。

目前，我们将在插件对话标题中发送用户的国家和州（例如，如果您在加利福尼亚，它看起来像 。对于{"openai-subdivision-1-iso-code": "US-CA"}更多数据源，用户必须通过同意屏幕选择加入。这对购物、餐厅、天气等。您可以在我们的开发者使用条款中阅读更多内容。