一、Rate limits
考虑在您公开的API端点上实现速率限制。虽然目前的规模有限,但ChatGPT被广泛使用,您应该会收到大量的请求。您可以监视请求的数量并相应地设置限制。
二、Updating your plugin
在一个插件被批准并且ChatGPT用户可以访问之后,您可能需要随着时间的推移更新清单文件。ChatGPT将在发出请求时定期获取OpenAPI规范。要手动更新清单文件,请导航到插件商店并再次执行“开发自己的插件”流程。
三、Plugin terms
为了注册一个插件,你必须同意插件条款。
四、Domain verification and security
为了确保插件只能对它们控制的资源执行操作,OpenAI对插件的清单和API规范进行了强制要求。
五、Defining the plugin's root domain
manifest文件定义了显示给用户的信息(比如logo和联系方式)以及插件OpenAPI规范所在的URL。当获取manifest时,插件的根域将按照以下规则建立:
- 如果域名有www。作为子域,那么根域就会去掉www。来自承载清单的域。
- 否则,根域与承载清单的域相同。
关于重定向的注意事项:
如果在解析清单中有任何重定向,则只允许子子域重定向。唯一的例外是从一个www子域重定向到一个没有www的子域。
根域的例子如下:
六、Manifest validation
manifest中的特定字段必须满足以下要求:
api.url
—— 提供给OpenAPI规范的url必须驻留在根域的同一级别或子域上。legal_info
— 提供的URL的二级域必须与根域的二级域相同。contact_info
— 邮件地址的二级域与根域的二级域保持一致。
七、Resolving the API spec
清单中的api.url
字段提供了一个到OpenAPI规范的链接,该规范定义了插件可以调用的api。OpenAPI允许指定多个基于服务器的url。选择服务器URL的逻辑如下:
- 如果存在一个服务器URL,其域与根域完全匹配,则使用该URL
- 否则,使用根域的子域的第一个服务器URL。
- 如果以上两种情况都不适用,则默认到API规范所在的域。例如,如果规范托管在
api.example.com
上,那么api.example.com
将被用作OpenAPI规范中路由的基URL。
注意:请避免使用重定向来承载API规范和任何API端点,因为不能保证总是遵循重定向。
八、Use TLS and HTTPS
插件的所有流量(例如,获取ai-plugin.json
文件,OpenAPI规范,API调用)必须使用有效的公共证书TLS 1.2或更高版本。
九、IP egress ranges
ChatGPT将从CIDR块23.102.140.112/28
中的IP地址调用您的插件。您可能希望显式地允许列出这些IP地址。
对于OpenAI的网页浏览插件,对网站的调用将从23.98.142.176/28
IP地址块进行。
十、FAQ
10.1 如何使用插件数据?
插件将ChatGPT连接到外部应用程序。如果用户启用了某个插件,ChatGPT可能会将他们的部分对话以及他们所在的国家或州发送到您的插件。
10.2 如果对API的请求失败了会发生什么?
如果API请求失败,在让用户知道无法从该插件获得响应之前,模型可能会重试该请求多达10次。
10.3 我可以邀请别人试用我的插件吗?
是的,所有未经验证的插件最多可以由15个用户安装。在发布时,只有其他有权限的开发人员才能安装该插件。我们计划随着时间的推移扩大访问权限,并最终推出一个流程,在向所有用户开放之前提交插件进行审查。