本文提供了创建自定义插件的整体流程,通过本文档开发商可以学习到如何创建自定义插件和发布自定义插件。
1)已经入驻淘宝开放平台,未入驻请参考AI应用开发商-接入指南。
2)已经了解OpenAPI规范。
3)已经了解插件库的功能概述。
1. 登录淘宝开放平台,依次选择 AI 实验室 > 插件库 > 我的插件,如下图所示:
2. 在我的插件界面,点击创建插件按钮,创建新的插件。
3. 在创建插件界面,填写插件的基本信息,然后单击确认,进入插件配置界面,如下图所示:
1)类型:必选项,插件类型,可参考概述。
2)名称:必填项,最多32个字符,插件的名称,例如:“商家信息管理”。
3)Logo:插件logo图,只支持JPG和PNG格式,若不上传新图片则使用默认图片。
4)描述:必填项,最多60个字符,用来描述插件的用途和详细介绍,例如:“该接口用作商家信息管理”。
5)URL:必填项,同一个插件下不同能力项的URL,例如:“https://mock.apifox.cn/m1/4582879-0-default
”。
6)鉴权方法:必选项,用于验证用户的身份和权限,以防止未经授权的访问和操作,鉴权方法请参考鉴权方式。
7)关联应用:是否调用已上架应用的接口能力,若开启后,用户在运行工作流且调用插件时需要确认订购和授权,授权过程请参考授权链路。
说明:开启关联应用后,插件可以配置应用已上架到服务市场后提供的接口能力,即在插件中调用含TOP API服务的接口。
7.1)Appkey:必填项,需要输入服务市场对应应用的Appkey。
7.2)服务Code:必填项,会根据Appkey自动查询并生成。
注意:
1)请规范填写插件的名称和描述,否则会影响大模型对插件的理解。同时URL中不能包含域名清单中的域名。
2)在关联应用前,需要在服务市场上架一个价格0元且订阅周期为1季度的默认规格,如需了解具体配置内容,请咨询运营小二。
目前支持两种方式创建插件能力项,可根据实际情况选择合适的创建方式:
1. 在能力管理列表界面,点击Schema管理,进入Schema管理能力界面。
?
2. 在Schema管理能力界面,请点击查看导入范文,查看Schema导入模板。
3. 在输入框中添加 JSON 结构,然后点击解析。
说明:如果你不知道怎么设置JSON结构数据,请参考OpenAPI规范。
4. 解析成功后,在能力项管理列表界面会自动生成能力项,如下图所示:
注意:自动生成的能力项初始状态都是异常,需要调试通过后,才能使用。
5. 选择某项能力,点击调试,进入能力项调试界面。
6. 在能力调试界面输入相关参数,然后单击调试,调试成功后单击完成,返回能力项管理列表界面。
7. 调试成功后,该项能力会显示正常,最后点击启用。
1. 能力管理列表界面点击新增能力,进入能力项新增界面。
2. 在能力项基础界面,输入能力项基本信息,然后点击下一步,进入设置入参界面。
1)名称:必填项,能力项的名称,例如:“查询商家基本信息”。
2)标识:必填项,能力项的标识,必须以字母开始且仅支持数字和字母,例如:“userInfo”。
3)描述:必填项,能力项的描述,最少10个字符,最多60个字符,例如:“用于查询商家基本信息”。
4)路径:必填项,能力项的接口访问路径,例如:“/mock/getData
”。
5)请求方法:接口请求方式,支持GET、POST、PUT、DELETE四种。
注意:标识、路径和请求方式设置以后,后续不可更改。
3. 在设置入参界面,单击添加入参,填写入参参数后,单击下一步,进入设置出参界面。
1)名称:必填项、接口的入参参数的名称,例如:“test”。
2)说明:必填项、接口入参参数说明,例如“商家的userID”。
3)类型:必填项、接口入参参数类型,目前支持关联业务字段、String、Long、Number和Boolean。
4)示例:必填项、入参参数的示例值。
5)传入方法:入参参数的传入方法,包括Query String、Head、Body和Path。
6)是否必填:设置是否在填写入参时必填。
4. 在设置出参界面,添加出参参数。
4.1. 方式一:手动添加出参
单击添加出参,填写出参参数后,单击下一步,进入调试能力界面。
4.2. 方式二:根据入参生成json
4.2.1. 点击根据入参生成json,然后在生成界面输入入参参数的值,然后点击确定。
?
4.2.2. 在参数正确的清下,会自动生成出参Json架构,然后点击解析。
4.2.3. 在生成的JSON结构中,补充参数说明,最后点击下一步,进入调试能力界面。
5. 调试能力界面,输入入参参数的值,点击调试。
若调试成功,调试结果会显示成功并返回调用结果,最后单击完成,如下图所示:
注意:再填写入参过程中,不支持数组和对象两种数据。
6. 能力项添加成功后,会在能力管理列表界面中展示,最后启用即可。
1. 在插件详情界面,单击发布插件。
2. 在提示框中点击确定按钮,发布目标插件。
注意:
1)发布插件到市场时,仅支持发布已启用的插件。
2)发布成功后,插件的启用或关闭能力将实时同步到市场。
恭喜您,通过本文内容已经完成了自定义插件的创建,发布成功后,您可在工作流中通过插件节点进行使用。