基于API创建一个插件

创建插件

创建插件的步骤如下：

1. 登录Agent开发平台。
2. 单击左侧导航栏“工作台”，在“插件”页签，单击右上角“创建插件”。
3. 在“创建插件”页面，填写插件名称与插件描述，设置是否“仅我可见”（设置后仅插件创建者可见）。单击图片可上传插件图标，单击“下一步”。
4. 在“配置信息”页面，参照表1完成信息配置。

   表1 插件信息配置说明

   参数名称	参数说明
   插件URL	插件服务的请求URL地址。 URL协议只支持HTTP和HTTPS。 系统会校验URL地址是否为标准的URL格式。 URL对应的IP默认不应为内网，否则会导致注册失败。
   请求方式	插件服务的请求方式，POST或GET。
   权限校验	选择调用API时是否需要通过鉴权才可以调用。 无需鉴权：API可以公开访问，不需要任何形式的身份验证或授权。 API Key：在调用API时提供一个唯一的API Key进行鉴权。 需填写密钥位置，即密钥是从Header中读取还是Query中读取。并设置API Key的密钥鉴权参数名和密钥值。
   请求头	填写API的请求头信息，例如： Key：Content-Type Value：application/json

   图1 API请求信息配置示例
   
   

   自定义插件使用HTTP服务，不增加鉴权方式可能存在安全风险。

5. 单击“下一步”，在“参数信息”页面，参照表2完成参数配置。

   表2 插件参数配置说明

   参数类型	参数名称	参数说明
   请求参数	参数封装	开启后，会将请求参数封装为一个列表（数组）结构，可适配入参为数组格式的插件接口。 示例：原参数列表：{"a":"string", "b":1}，开启封装后的参数列表：[{"a":"string", "b":1}]
   	参数名称	参数的名称，参数名称会作为大模型解析参数含义的依据。
   	中文名称	该参数的中文名称。
   	参数类型	该参数值的数据类型，String、Integer、Number等多种类型支持选择。
   	位置	当前参数在请求信息中的位置，可选Body、Headers或Query。
   	默认值	参数的默认值。
   	描述	参数的描述，尽可能准确的描述参数的含义和要求，可提升Agent提取参数的准确率。
   	参数校验	可设置当前参数的校验规则。
   	必填	指定该参数是否为必填项。
   响应参数	参数封装	开启后，会将请求参数封装为一个列表（数组）结构，可适配入参为数组格式的插件接口。 示例：原参数列表：{"a":"string", "b":1}，开启封装后的参数列表：[{"a":"string", "b":1}]
   	参数名称	响应参数的名称，参数名称会作为大模型解析大模型输出结果的依据。
   	参数描述	响应参数的名称，参数描述会作为大模型解析大模型输出结果的依据。
   	参数类型	该参数值的数据类型，String、Integer、Number等多种类型支持选择。
   	是否提取	开启后则该参数必须提取到，关闭则该参数允许为空或者使用默认值。

   图2 填写API请求、响应参数