Chat Plugins 有限Alpha版
原文:Chat Plugins – Introduction
了解如何构建一个插件,使ChatGPT可以智能地调用您的API。
简介
OpenAI插件将ChatGPT连接到第三方应用程序。这些插件使ChatGPT能够与开发人员定义的API交互,增强ChatGPT的功能,并允许它执行各种操作。
插件可以让ChatGPT执行以下操作:
- 获取实时信息,例如体育比分、股票价格、最新新闻等。
- 获取知识库信息,例如公司文档、个人笔记等。
- 代表用户执行操作,例如预订航班、订购食物等。
插件处于有限的Alpha版,可能尚不可用。请加入等待列表以获得访问权限。在Alpha版期间,我们将与用户和开发人员紧密合作,对插件系统进行迭代,该系统可能会发生重大变化。
插件开发人员公开一个或多个API端点,附带一个标准化的清单文件和一个OpenAPI规范。这些定义了插件的功能,允许ChatGPT消耗这些文件并调用开发人员定义的API。
AI模型充当智能API调用器。给定API规范和何时使用API的自然语言描述,模型主动调用API执行操作。例如,如果用户问“在巴黎住几晚应该住哪里?”,模型可以选择调用酒店预订插件API,接收API响应,并生成一个结合API数据和其自然语言能力的用户面向的答案。
随着时间的推移,我们预计系统将发展以适应更高级的用例。
插件流程
构建插件时,了解端到端流程非常重要。
1. 创建清单文件并将其托管在yourdomain.com/.well-known/ai-plugin.json
- 文件包括有关插件的元数据(名称、标志等)、所需身份验证的详细信息(身份验证类型、OAuth URL等)和您想要公开的端点的OpenAPI规范。
- 模型将看到OpenAPI描述字段,可以用于为不同字段提供自然语言描述。
- 我们建议一开始仅公开1-2个端点,最少的参数数量以最小化文本长度。插件描述、API请求和API响应都将插入到ChatGPT的对话中。这会消耗模型的上下文限制。
2. 在ChatGPT UI中注册您的插件
- 从顶部下拉菜单中选择插件模型,然后选择“插件”、“插件商店”,最后选择“安装未经验证的插件”或“开发自己的插件”。
- 如果需要身份验证,请提供OAuth 2 client_id和client_secret或API密钥。
3. 用户激活您的插件
- 用户必须在ChatGPT UI中手动激活您的插件。(ChatGPT不会默认使用您的插件。)
- 在Alpha版期间,插件开发人员将能够与15个附加用户共享其插件(目前只有其他开发人员可以安装未经验证的插件)。随着时间的推移,我们将推出一种提交您的插件以供所有ChatGPT用户使用的审核方式。
- 如果需要身份验证,用户将通过OAuth被重定向到您的插件;您还可以选择在此处创建新帐户。
- 未来,我们希望构建一些功能,帮助用户发现有用和受欢迎的插件。
4. 用户开始对话
- OpenAI将在消息中向ChatGPT注入您的插件的简明描述,对终端用户不可见。这将包括插件描述、端点和示例。
- 当用户提出相关问题时,如果模型认为相关,它可能会选择从您的插件调用API调用;对于POST请求,我们要求开发人员构建用户确认流程。
- 模型将把API结果合并到对用户的响应中。
- 模型可能在其响应中包含从API调用返回的链接。这些将显示为丰富的预览(使用OpenGraph协议,我们提取site_name、title、description、image和url字段)
目前,我们将在插件会话头中发送用户的国家和州(例如,如果您在加利福尼亚州,它将看起来像{“openai-subdivision-1-iso-code”: “US-CA”})。对于更多数据源,用户将必须通过同意屏幕进行选择。这对于购物、餐馆、天气等非常有用。您可以在我们的开发者使用条款中阅读更多信息。