入门文档（docs）
插件（Plugins)
介绍(Introduction)

聊天插件 alpha版本 Chat Plugins Limited Alpha

概览 Introduction

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

  • 插件可以使 ChatGPT 执行以下操作：
  • 检索实时信息；例如，体育比分、股票价格、最新新闻等。
  • 检索知识库信息；例如，公司文档、个人笔记等。
  • 代表用户执行操作；例如，预订航班、订餐等。

插件处于有限的alpha版本，并且可能尚未对您可用。 请加入等待名单 (opens in a new tab)以获得访问权限。 在alpha版本中，我们将与用户和开发人员密切合作迭代插件系统，该系统可能会发生重大变化。 如果您想在阅读文档并学习更多插件内容时有一个示例正在运行，则可以使用我们的插件快速入门存储库 (opens in a new tab)。

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

AI 模型作为一个智能 API 调用者。给定一个 API 规范和一个自然语言描述何时使用该 API，模型积极调用 API 执行操作。例如，如果用户问：“我应该在巴黎呆几晚？” 模型可能会选择调用酒店预订插件 API，接收 API 响应，并生成结合 API 数据和其自然语言功能的用户界面答案。

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

Plugin flow

建立插件时，了解端到端流程非常重要。

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

    • 文件包含插件的元数据（名称、徽标等）、所需身份验证的详细信息（身份验证类型、OAuth网址等）以及要公开的Endpoint(Completion)的OpenAPI规范。
    • 插件模型将查看OpenAPI描述字段，这些字段可用于提供不同字段的自然语言描述。
    • 我们建议您在开始时只公开1-2个 Endpoint(Completion)，并使用最少的参数以最小化文本长度。插件描述、API请求和API响应都会插入到与ChatGPT的对话中并且会影响模型的上下文限制。

  2. 在 ChatGPT UI (opens in a new tab) 中注册您的插件。

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

  3. 用户激活您的插件

    • 用户必须在ChatGPT UI中手动激活您的插件。（ChatGPT默认不会使用您的插件。）
    • 在alpha测试期间，插件开发者可以与15个额外的用户共享其插件（目前只有其他开发者可以安装未验证的插件）。随着时间的推移，我们将推出一种提交插件审核以暴露给所有ChatGPT用户的方式。
    • 如果需要身份验证，则用户将通过OAuth重定向到您的插件；您还可以选择在此处创建新帐户。
    • 未来，我们希望构建功能，以帮助用户发现有用的、流行的插件。

  4. 用户开始对话

    • OpenAI将向ChatGPT注入插件的简洁说明，这对最终用户是不可见的。其中包括插件描述、端点以及示例。
    • 当用户提出相关问题时，如果API调用似乎相关，则模型可能会选择从您的插件调用API；对于POST请求，我们要求开发者构建用户确认流程。
    • 模型将API结果合并到其响应中，并将其返回给用户。
    • 模型可能会在其回复中包含从API调用返回的链接。这些将显示为丰富预览（使用 OpenGraph protocol (opens in a new tab)，其中包括站点名称、标题、描述、图像和URL字段）
    • 模型还可以在其响应中输出Markdown（例如来自您的API的图像URL）。在ChatGPT UI中将呈现Markdown。

目前，我们将在插件会话头中发送用户的国家和州/省份信息（例如，若您在加利福尼亚州，则会显示为{"openai-subdivision-1-iso-code": "US-CA"}）。对于更多的数据源，用户必须通过同意屏幕进行选择。这对于购物、餐厅、天气等方面非常有用。您可以在我们的插件使用条款 (opens in a new tab)中了解更多信息。

生产最佳实践(Production Best Practices)验证(Authentication)