ChatGpt插件开发
  • 介绍
  • 快速开始
  • 插件认证
  • 插件示例
  • 生产环境中的插件
  • 插件审核
  • 插件政策
Powered by GitBook
On this page

介绍

Next快速开始

Last updated 2 years ago

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

插件可以让ChatGPT执行以下操作:

  • 检索实时信息,例如体育比分,股票价格,最新新闻等。

  • 检索知识库信息,例如公司文档,个人笔记等。

  • 代表用户执行操作,例如预订航班,订购食品等。

插件处于有限的 alpha 版本,可能无法访问。请加入以获取访问权限。在 alpha 版本期间,我们将与用户和开发人员密切合作,对插件系统进行迭代,该系统可能会有显著变化。

如果您想在阅读文档并学习插件的更多知识时运行示例,您可以从我们的插件快速入门存储库开始。

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

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

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

插件流程

要建立一个插件,理解端到端的流程非常重要。

  1. 创建一个清单文件并将其托管在 您的域名.com/.well-known/ai-plugin.json。 这个文件包括有关您的插件(名称,标志等)的元数据,所需的身份验证详细信息(身份验证类型,OAuth网址等)以及您想要公开的端点的OpenAPI规范。 模型将查看OpenAPI描述字段,可用于为不同字段提供自然语言描述。 我们建议在开始时仅公开1-2个端点,使用最少的参数来最小化文本长度。 插件描述,API请求和API响应都插入到与ChatGPT的对话中。这会计入模型的上下文限制。

  2. 在ChatGPT UI中注册你的插件。 从顶部下拉菜单中选择插件模型,然后选择“插件”、“插件商店”,最后选择“安装未经验证的插件”或“开发自己的插件”。 如果需要身份验证,请提供OAuth 2客户端ID和客户端秘钥或API密钥。

  3. 用户激活您的插件。 用户必须在ChatGPT用户界面中手动激活您的插件。(ChatGPT不会默认使用您的插件。)

    在Alpha测试期间,插件开发人员将能够与15个其他用户共享他们的插件(目前只有其他开发人员可以安装未经验证的插件)。随着时间的推移,我们将推出一种提交您的插件进行审查的方式,以向ChatGPT所有用户暴露。

    如果需要认证,用户将通过OAuth重定向到您的插件;您还可以选择在此处创建新帐户。

    未来,我们希望构建功能,帮助用户发现有用和受欢迎的插件。

  4. 用户开始一次对话。 OpenAI将向ChatGPT发送一条包含您插件简介、端点和示例的消息,对最终用户不可见。 当用户提出相关问题时,如果看起来相关,模型可能会选择从您的插件调用API调用;对于POST请求,我们要求开发人员建立用户确认流程。 模型将将API结果合并到其对用户的响应中。 模型可能会在其响应中包含API调用返回的链接。这些链接将显示为丰富的预览(使用OpenGraph协议,我们提取site_name、title、description、image和url字段)。 模型还可以输出markdown(例如来自您的API的图像URL),ChatGPT UI将在UI中呈现markdown。

目前,我们将在插件对话头中发送用户的国家和州(例如,如果您在加利福尼亚,它看起来会像这样:{"openai-subdivision-1-iso-code": "US-CA"})。对于更多的数据源,用户需要通过同意屏幕选择参与。这对于购物、餐厅、天气等非常有用。您可以在我们的开发者使用条款中了解更多信息。

等待列表