将API添加为ChatGPT插件的最快方式
目录
- 简介
- 如何使用Zoopload创建和公开API
- 2.1 创建项目
- 2.2 创建Manifest文件
- 2.3 创建Open API文档
- 将API公开为Chat GPT插件
- 3.1 创建Manifest文件路由
- 3.2 创建Open API文档路由
- 3.3 创建API路由
- 插件开发及测试
- 总结
- FAQ
简介
在本视频中,我将向您展示如何轻松公开现有的API,或者创建一个新的API并使用Zoopload作为Chat GPT插件来公开。要实现这个目标,我们需要进行一些操作。首先,我们需要在一个已知URL上的域中创建一个端点,以提供一个清单文件。其次,我们需要一个开放式API文档,而Zoopload则使用开放式API。当然,我们还需要一些API。我创建了一个演示API,只是一个简单的API,允许我检查网球俱乐部网球场上的得分和参与者。我在不到五分钟的时间内使用Zoopload和Chat GPT创建了这个API。如果您想知道我是如何做到这一点的,请查看下面的链接,了解如何在不到五分钟的时间内使用Chat GPT和Zoopload创建演示API。现在,我想向您展示如何将API公开为Chat GPT插件。我们要进入Zoopload,创建一个新项目,并将其命名为Chat GPT插件。接下来,我们将首先创建一个处理程序,用来提供清单文件。我们可以通过进入路由文件并点击"添加路由"来实现这一点。该清单文件必须位于特定的域上的特定位置。这个位置是 ".well-known
/ AI plugin.json
"。.well-known
是一个常用的最佳实践,用于域上的已知位置。您经常会在这里找到JWKS和其他常见文件。OpenAI决定将他们的清单文件放在这个位置上。我们设置好了路由,现在我们只需要一种方法来提供清单文件。我将为此创建一个名为manifest
的新模块,并使用它从Zoopload直接创建和提供清单文件。我之前创建了一些代码,现在只需将它粘贴到这里并进行替换。我将解释一下这段代码的作用。代码中的对象简单地表示了OpenAI需要的清单。它非常简单直接,您需要为人类提供一个名称、为模型提供一个名称,以及一些其他信息。此外,它还需要知道定义此API的Open API规范的位置。你可以在代码中看到它位于/openapi
路径下。最后,清单中还包括一些其他内容,比如用于插件的徽标等。我们大部分工作都已经完成了,现在只需保存文件。由于我发送的是一个对象,Zoopload会自动添加content type为application/json
,并将对象序列化为JSON格式,因此我们的工作就完成了。保存后,稍等片刻,保存成功后我们可以进行测试。在测试页面中,我们可以看到清单文件已准备就绪,位于正确的位置,可以供Chat GPT使用。现在,我需要的另一件事是提供Open API文档。这个Open API文档将作为Chat GPT了解此API的方式。我们可以添加另一个简单的路由,将其命名为openapi
,并使用我们的openapi
处理程序。这样,它就会将此文件作为一个Open API文件提供。我将保存更改,这实在太简单了。现在,如果我进行测试,我们将看到Open API文档已成功提供。最后,我需要的是一个实际的API。如果您有自己的API的Open API文档并且有一个API,那太好了。如果没有,请在下面的链接中查看如何使用Chat GPT和Zoopload快速创建演示API。我已经有了Open API文档,所以我要做的是将其导入。文档名为tennis.openapi.json
。您会注意到它说,“我发现了这两个操作,但它们不在这个传入的Open API文档中,我将保留它们,并将创建一个名为quartz
的新操作。”现在,我们回到路由设计器,我们可以看到新的操作已经导入并继承了Open API文件中的所有元数据。我将保存更改。这个过程非常酷的一点是,它不仅适用于Chat GPT,而且由于我使用的是Zoopload,实际上还具有完整功能的开发者门户网站。它需要一些时间进行初始加载,但一旦所有内容都被缓存,加载就会非常快。这里提供了完整的API使用文档,甚至还可以切换到深色模式。这些都是免费提供的,因为您正在使用Zoopload。现在,我们准备就绪,我已经拥有了与Chat GPT连接所需的一切。让我们来测试一下。现在,如果我进入Chat GPT,我可以看到插件商店。我想开发自己的插件,它要求我提供域名。我将使用我们的工作副本URL。通常,您不会使用工作副本,而是将真正的Zoopload部署到为开发目的设置的实际域名。我们现在使用这个工作副本也完全可以。Chat GPT将会访问我的域名,下载清单文件和Open API规范,验证它们,并确认我们拥有有效的插件。我只需点击"install for me",继续安装插件。检查一下,这个插件现在已启用。我要输入一个问题,比如"在第五个场地的比分是多少?"现在,这将调用我的API,获取响应并将其添加到对话的上下文中。接下来,我们等待片刻。在五号场地,目前的比分如下:John得分3分,Jane得分16分。看起来Jane目前在比赛中领先。您认为谁会赢呢?让我们看看Chat GPT有多聪明。哦,它对预测运动比赛并不太擅长,这有点让人遗憾,因为如果它擅长,我会将其用于其他用途。不管怎样,这就是使用Zoopload将API作为Chat GPT插件添加的简单方法。同样,如果您想了解如何在不到五分钟的时间内使用Chat GPT和Zoopload创建演示API,请查看下面的链接。
如何使用Zoopload创建和公开API
为了将API公开为Chat GPT插件,首先需要使用Zoopload来创建和公开API。下面是如何使用Zoopload完成这些步骤的详细说明。
2.1 创建项目
在Zoopload中,首先需要创建一个新项目。命名该项目为"Chat GPT插件"。
2.2 创建Manifest文件
在项目中,我们需要创建一个Manifest文件。这个Manifest文件将包含一些必要的信息,例如名称、模型和API定义的位置。将Manifest文件存储在特定的URL位置,便于Chat GPT访问。
2.3 创建Open API文档
将API定义为Open API文档。这个文档将包含API的所有细节,包括端点、操作和参数。确保Open API文档符合规范,并保存在可以被Chat GPT访问的地方。
将API公开为Chat GPT插件
一旦API和Manifest文件都准备好了,我们就可以将API公开为Chat GPT插件。下面是如何进行的步骤。
3.1 创建Manifest文件路由
在Zoopload中,创建一个新的路由来提供Manifest文件。在路由中设置文件的位置为.well-known/ai/plugin.json
,这是Chat GPT查找Manifest文件的标准位置。
3.2 创建Open API文档路由
创建另一个路由以提供Open API文档。在这个路由中,将Open API文档作为一个文件提供,并将其URL设置为/openapi
。
3.3 创建API路由
使用Zoopload创建API的路由。将API定义和功能添加到路由中。确保API路径和操作的定义与Open API文档中的定义一致。
插件开发及测试
现在,我们已经完成了API的公开过程,可以进行插件的开发和测试了。在Chat GPT中,使用Zoopload提供的Manifest文件和Gateway文件来安装并启用插件。测试插件是否按预期工作。
总结
使用Zoopload将API公开为Chat GPT插件非常简单。通过创建Manifest文件、Open API文档和API路由,我们可以轻松地将API集成到Chat GPT中。通过从Zoopload安装插件,并进行适当的测试,我们可以确保插件正常工作。现在,您可以根据自己的需求和API来开发自己的Chat GPT插件,为用户提供更多功能和便利。
FAQ
问:如何在Zoopload中创建一个新的项目?
答:在Zoopload的控制台中,找到"创建项目"选项。点击它,然后按照指示步骤进行操作,即可轻松地创建新的项目。
问:如何在Zoopload中创建Manifest文件?
答:在项目中,找到"创建文件"选项。选择Manifest文件,并填写必要的信息,例如名称、模型和API定义的位置。保存文件后,它将自动在正确的位置进行保存。
问:如何在Zoopload中创建Open API文档?
答:在项目中,找到"创建文件"选项。选择Open API文档,并按照规范填写API的详细信息。保存文件后,将在指定的位置进行保存。
问:如何安装和启用Chat GPT插件?
答:在Chat GPT中,转到插件商店。选择要安装的插件,并按照指示进行操作。一旦插件安装成功,您可以在Chat GPT中启用它。
问:Chat GPT插件如何与API进行交互?
答:Chat GPT插件会请求API的数据。它将根据API的定义发送请求并接收响应。插件可以使用API返回的数据来丰富对话,并根据需要改变聊天内容。
问:如何测试Chat GPT插件的功能?
答:在Chat GPT中,通过与插件进行交互,并观察响应的结果来测试插件的功能。确保插件按预期工作,并提供正确的响应。