https://platform.openai.com/docs/plugins/introduction
学习如何构建一个允许ChatGPT智能调用API的插件。

一、介绍

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

插件可以让ChatGPT做以下事情:

• 实时信息检索;例如，体育比分、股票价格、最新消息等。
• 知识库信息检索;例如，公司文件、个人笔记等。
• 代表用户执行操作;例如，订机票、订餐等。

插件处于有限的alpha阶段，您可能还无法使用。请加入等候名单进入。在测试期间，我们将与用户和开发人员密切合作，对插件系统进行迭代，这可能会有很大的发展。

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

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

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

二、插件流

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

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

• 该文件包括关于插件的元数据(名称、logo等)、关于所需身份验证的详细信息(认证类型、OAuth url等)，以及用于您想要公开的端点的OpenAPI规范。
• 模型将看到OpenAPI描述字段，该字段可用于为不同的字段提供自然语言描述。
• 我们建议在开始时只暴露1-2个端点，并使用最少数量的参数，以最小化文本的长度。插件描述、API请求和API响应都被插入到与ChatGPT的对话中。这违反了模型的上下文限制。

2.2 在ChatGPT UI中注册你的插件

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

2.3 用户激活你的插件

• 用户必须在ChatGPT UI中手动激活插件。(ChatGPT默认不使用你的插件。)
• 在alpha测试期间，插件开发者将能够与另外15个用户共享他们的插件(目前只有其他开发者可以安装未经验证的插件)。随着时间的推移，我们将推出一种方法，将您的插件提交给所有ChatGPT的用户群进行审查。
• 如果需要认证，用户将通过OAuth重定向到您的插件;您也可以选择在这里创建新帐户。
• 在未来，我们希望构建功能来帮助用户发现有用和流行的插件。

2.4 用户开始对话

• OpenAI将在ChatGPT的消息中注入插件的紧凑描述，最终用户不可见。这将包括插件描述、端点和示例。
• 当用户问一个相关的问题时，模型可能会选择从你的插件中调用一个API调用，如果它看起来是相关的;对于POST请求，我们要求开发人员构建一个用户确认流程。
• 该模型将把API结果合并到对用户的响应中。
• 该模型可能在响应中包含API调用返回的链接。这些将显示为丰富的预览(使用OpenGraph协议，其中我们提取site_name，title，description，image 和 url字段)”

目前，我们将在Plugin对话header中发送用户的国家和州(例如，如果你在加利福尼亚，它看起来像{"openai-subdivision-1-iso-code": "US-CA"}。对于更多的数据来源，用户将不得不通过同意屏幕进行选择。这对于购物、餐厅、天气等都很有用。您可以在我们的开发人员使用条款中阅读更多信息。