OpenAI ChatGPT插件快速开发手册 - 介绍

Chat Plugins Beta

学习如何构建一个插件，使ChatGPT能够智能地调用您的API。

介绍

OpenAI插件将ChatGPT与第三方应用程序连接起来。这些插件使ChatGPT能够与开发人员定义的API进行交互，增强ChatGPT的功能，使其能够执行各种各样的操作。插件使ChatGPT能够执行以下操作：

• 获取实时信息，例如体育比分、股票价格、最新新闻等。
• 获取知识库信息，例如公司文档、个人笔记等。
• 协助用户执行操作，例如预订航班、订购食物等。

插件目前处于测试阶段，开发者访问权限可能对您不可用。请加入等待列表以获取开发者访问权限。在测试阶段，我们将与用户和开发者密切合作，不断改进插件系统，可能会有显著的演变。

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

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

AI模型充当智能的API调用者。

根据API规范和关于何时使用API的自然语言描述，模型主动调用API执行操作。例如，如果用户问道：“在巴黎停留几个晚上应该住在哪里？”模型可能选择调用酒店预订插件API，接收API响应，并生成一个结合了API数据和自然语言能力的面向用户的回答。

随着时间的推移，我们预计该系统将逐渐适应更多高级用例。

插件流程

要构建一个插件，了解端到端的流程很重要。

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

   • 该文件包含有关插件的元数据（名称、徽标等）、所需的身份验证详细信息（身份验证类型、OAuth URL等）以及您想要公开的端点的OpenAPI规范。
   • 模型将看到OpenAPI描述字段，这些字段可用于为不同字段提供自然语言描述。

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

   • 从顶部下拉菜单中选择插件模型，然后选择“插件”、“插件商店”，最后选择“开发您自己的插件”。
   • 如果需要身份验证，提供OAuth 2的client_id和client_secret或API密钥。

3. 用户激活您的插件。

   • 用户必须在ChatGPT UI中手动激活您的插件。（ChatGPT不会默认使用您的插件。）
   • 您将能够与其他100名用户共享您的插件（只有其他开发者可以安装未经验证的插件）。
   • 如果需要OAuth，用户将通过OAuth被重定向到您的插件以进行登录。

4. 用户开始对话。

   • OpenAI将在消息中向ChatGPT注入有关您插件的简洁描述，对终端用户不可见。这将包括插件描述、端点和示例。
   • 当用户提出相关问题时，如果模型认为相关，它可能选择调用您插件的API调用；对于POST请求，我们要求开发人员构建用户确认流程以避免破坏性操作。
   • 模型将API调用结果并入其对用户的响应中。
   • 模型可能在其响应中包含从API调用返回的链接。这些链接将显示为丰富的预览（使用OpenGraph协议，我们提取site_name、title、description、image和url字段）。
   • 模型还可以将来自您的API的数据格式化为Markdown，ChatGPT UI将自动呈现Markdown。

下一步

既然您了解了插件的基本知识，您可能想要：

• 开始构建一个插件
• 探索示例插件
• 阅读有关将插件投入生产的重要步骤
• 了解插件审查流程