配置插件
配置插件的步骤如下:
- 在“高级配置 > 插件”,单击“添加”。
图1 配置插件
- 在“添加插件”窗口,选择预置插件或个人插件,单击进行添加,最后单击“确定”。若想创建插件可单击右上角“创建插件”,创建插件的步骤请参见创建插件。
图2 添加插件
- 添加插件后,可在“高级配置”中查看当前已添加的插件。
创建插件
创建插件的步骤如下:
- 登录ModelArts Studio大模型开发平台,进入所需空间。
- 在左侧导航栏中选择“Agent开发”,将跳转至Agent开发平台。
- 单击左侧导航栏“工作台”,在“插件”页签,单击右上角“创建插件”。
- 配置插件的基本信息,输入插件名称和插件描述等信息。配置完成后,单击“下一步”。
表1 插件基本信息表 参数名称
说明
插件名称
待创建插件的名称。
名称必须以中文或者英文开头。
插件名称长度为1 ~ 200个字符,并且字符只允许为下面的类型:
- 中文
- 字母(A-Z或a-z)
- 数字(0-9)
- 特殊字符:_和-
- 空格
插件描述
待创建插件的功能描述。
插件描述的长度为1 ~ 1600个字符。
- 配置插件的配置信息,配置插件URL和请求方式等参数信息。配置完成后,单击“下一步”。
风险提示:自定义插件使用HTTP服务,或不增加鉴权方式可能存在安全风险。
表2 插件配置信息表 参数名称
说明
插件URL
插件服务的请求URL地址。
- URL协议只支持HTTP和HTTPS。
- 系统会校验URL地址是否为标准的URL格式。
- URL对应的IP默认不应为内网,否则会导致注册失败。仅在非商用环境部署时,才允许支持内网URL,且需要通过相关的服务的启动配置项关闭内网屏蔽。
请求方式
插件服务的请求方式,POST或GET。
权限校验
插件服务的鉴权方式,支持以下三种:
- 无需鉴权:不使用鉴权时会存在安全风险。
- 用户级鉴权:用户级鉴权可以使用Header鉴权或Query鉴权的方式,需要提供密钥鉴权参数名和密钥来源参数名。
- API Key:API Key鉴权可以使用Header鉴权或Query鉴权的方式,需要提供密钥鉴权参数名和密钥值。
请求头
插件服务的请求头。添加请求的数据格式等说明,敏感信息请通过权限校验的方式实现。
- 配置插件的参数信息,配置请求参数和响应参数信息。
- 请求参数
表3 请求参数信息 参数名称
说明
参数名称
参数的名称,长度为1 ~ 50个字符,参数名称会作为大模型解析参数含义的依据。
参数描述
参数的名称,长度为1 ~ 200个字符,参数名称会作为大模型解析参数含义的依据。
参数类型
该参数值的数据类型,当前支持三种类型。
- String:字符串类型
- Integer:四字节整型
- Number:八字节浮点数
请求方式
默认以Body方式请求。
是否必填
指定该参数是否为必填项。
- 打开开关:必填
- 关闭开关:非必填
默认值
参数的默认值,如果插件服务的入参生成缺失,默认值会在大模型解析时被使用。
- 请求参数
- 配置完成后,单击“确定”,即可完成插件的创建。