跳到主要内容

插件应用到生产环境

速率限制​

考虑对您公开的 API 端点实施速率限制。虽然目前规模有限，但 ChatGPT 被广泛使用，您应该会收到大量请求。您可以监控请求的数量并相应地设置限制。

更新您的插件​

在插件获得批准并可供 ChatGPT 用户访问后，您可能需要随时更新清单（manifest）文件。 ChatGPT 将在发出请求时定期获取 OpenAPI 规范。要手动更新清单（manifest）文件，请导航至插件商店并再次执行“Develop your own plugin（开发您自己的插件）”流程。

插件条款​

为了注册插件，您必须同意插件条款。

域名验证和安全​

为确保插件只能对它们控制的资源执行操作，OpenAI 对插件的清单（manifest）和 API 规范强制执行要求。

定义插件的根域名​

清单（manifest）文件定义了向用户显示的信息（如 logo 和联系信息）以及插件的 OpenAPI 规范的 URL。获取清单（manifest）时，将按照以下规则作为插件的根域名：

  • 如果将 www. 作为子域名，则根域名为从清单（manifest）文件所在的域名中删除 www. 后的部分
  • 其他情况，根域名与清单（manifest）文件所在的域名相同。

关于重定向的说明：如果在解析清单（manifest）时有任何重定向，则只允许重定向到当前域名的子级域名（child subdomain）。唯一的例外是从 www 子域名可以重定向到没有 www 的域名。

根域名的示例：

  • ✅https://example.com/.well-known/ai-plugin.json
    • 根域名：example.com
  • ✅https://www.example.com/.well-known/ai-plugin.json
    • 根域名：example.com
  • ✅ https://www.example.com/.well-known/ai-plugin.json →重定向至 https://example.com/.well-known/ai-plugin.json
    • 根域名：example.com
  • ✅ https://foo.example.com/.well-known/ai-plugin.json →重定向至 https://bar.foo.example.com/.well-known/ai-plugin.json
    • 根域名：bar.foo.example.com
  • ✅ https://foo.example.com/.well-known/ai-plugin.json →重定向至 https://bar.foo.example.com/baz/ai-plugin.json
    • 根域名：bar.foo.example.com
  • ❌ https://foo.example.com/.well-known/ai-plugin.json →重定向至 https://example.com/.well-known/ai-plugin.json
    • 不允许重定向到父级域名
  • ❌ https://foo.example.com/.well-known/ai-plugin.json→重定向至 https://bar.example.com/.well-known/ai-plugin.json
    • 不允许重定向到同一级别的子域名
  • ❌ https://example.com/.well-known/ai-plugin.json →重定向至 https://example2.com/.well-known/ai-plugin.json
    • 不允许重定向到另一个域名

清单（Manifest）验证​

清单（manifest）本身中的特定字段必须满足以下要求：

  • api.url- 提供给 OpenAPI 规范的 URL，必须托管在根域的同一级别或子域中。
  • legal_info- 提供的 URL 的二级域名必须与根域名的二级（second-level domain）域相同。
  • contact_info- 电子邮件地址的二级域名应与根域名的二级域相同。

解析 API 规范​

清单（manifest）中的字段提供了指向 OpenAPI 规范的链接，该规范定义了插件可以调用的 API。OpenAPI 允许指定多个服务器 Base URL。以下逻辑用于选择服务器 URL：api.url

  • 如果存在其域与根域完全匹配的服务器 URL，则使用该 URL
  • 否则，请使用作为根域名的子域名的第一个服务器 URL。
  • 如果上述两种情况都不适用，则默认为 API 规范所在的域名。例如，如果规范托管在 api.example.com 上，则 api.example.com 将用作 OpenAPI 规范中路由的基本 URL。

注意：请避免使用重定向来托管 API 规范和任何 API Endpoint（指具体的某个 API），因为不能保证始终遵循重定向。

使用 TLS 和 HTTPS​

插件的所有流量（例如，获取 ai-plugin.json 文件、OpenAPI 规范、API 调用）必须使用 TLS 1.2 或更高版本和有效的公共证书（public certificate）。

IP 出口范围​

ChatGPT 将从 CIDR 块 23.102.140.112/28 中的 IP 地址调用您的插件。您可能希望将这些 IP 地址明确列入允许列表。

对于 OpenAI 的网页浏览插件，将通过 23.98.142.176/28 IP 地址块对网站进行调用。

常见问题​

如何使用插件数据？​

插件将 ChatGPT 连接到外部应用程序。如果用户启用了插件，ChatGPT 可能会将他们的部分对话以及他们的国家或州发送到您的插件。

如果对我的 API 的请求失败会怎样？​

如果 API 请求失败，模型可能会重试请求多达 10 次，然后才会让用户知道它无法从该插件获得响应。

我可以邀请人们试用我的插件吗？​

可以，所有未经验证的插件最多可由 15 位用户安装。在发布时，只有其他具有访问权限的开发人员才能安装该插件。我们计划随着时间的推移扩大访问范围，并最终推出一个流程来提交您的插件以供审核，然后再提供给所有用户。