基于API创建一个插件

创建插件

1. 登录Versatile智能体平台，在左侧导航栏“个人空间”区域，选择进入所需空间。

   如果已选择团队空间，界面显示为实际的团队空间名称，而非“个人空间”。

   图1 选择团队空间
   

2. 在左侧导航栏中选择“开发中心 > 组件库 > 我的插件”，单击左上角“创建插件”。
3. 在“创建插件”页面，配置插件信息。
   1. 在“基本信息”步骤中设置插件的基础信息，请参照表1完成信息配置，并单击“下一步”进入配置信息页面。

      表1 基本信息

      参数	说明
      插件图标	单击默认图标按钮，可上传本地图片作为插件的自定义图标。
      插件名称	用于标识当前插件的名称，便于在智能体、工作流和资产中心中快速搜索和定位。例如：查询天气。 命名规则： 命名要求：可以包含中文、英文、数字、特殊字符等； 长度限制：1~64个字符。
      插件英文名称	插件的英文名称，用于在大模型调用时快速搜索和定位该插件。 命名规则： 命名要求：字母、数字和下划线（_）的组合，不允许使用其他特殊字符或空格； 长度限制：1~64个字符。
      插件描述	描述当前插件的类型、功能和适用场景，帮助用户快速了解插件的作用和用途。
      仅我可见	该功能默认关闭。开启后，仅插件的创建者可见。此设置在插件创建后无法修改。

   2. 在“配置信息”步骤中配置插件信息，请参照表2完成配置。

      表2 配置信息

      参数	说明
      协议	API服务接口通信协议。 https http
      主机地址	提供API服务的服务器地址。 以https://console.ulanqab.huawei.com/v1/chat/completions为例，主机地址为console.ulanqab.huawei.com
      基准URL	基准URL（Base URL）是指域名的根路径，默认为/。 如果插件中存在多个工具，基准URL可以填写这些工具共用的URL部分。 以https://console.ulanqab.huawei.com/v1/chat/completions和https://console.ulanqab.huawei.com/v1/chat/workflows为例，基准URL可以填写为/v1/chat。
      权限校验	选择调用API时是否需要鉴权。 无需鉴权：API可以公开访问，不需要任何形式的身份验证或授权。 API Key：在调用API时提供一个唯一的API Key进行鉴权。需配置以下信息 需填写密钥位置，并设置API Key的密钥鉴权参数名和密钥值。 密钥位置：密钥是从Header中读取还是从Query中读取。 参数名称：API Key的鉴权参数名称。 参数值：API Key的具体值

4. 配置完单击“确定”。插件创建成功后，单击新创建的插件进入详情页面，请参考创建工具为插件添加工具。

创建工具

添加API服务下的具体接口作为插件的工具。

1. 在“我的插件”页面，单击需要添加工具的插件进入详情页面。
2. 在“工具信息”页签中，单击左侧的“新建”。
3. 在“添加工具”弹框中配置工具名称、工具英文名称、工具描述，参数如表3所示。

   表3 基本信息参数说明

   参数	说明
   工具名称	用于标识当前工具的名称，便于在智能体、工作流和资产中心中快速搜索和定位。
   工具英文名称	工具的英文名称。 命名规则： 命名要求：可以包含大小写字母、数字、下划线； 长度限制：1~64个字符。
   工具描述	描述当前工具的功能和适用场景，帮助用户快速了解工具的作用。

4. 单击“下一步”，根据表4进行参数配置。

   表4 参数配置说明

   参数		说明
   工具URL	请求方式	服务的请求方式，支持POST或GET。
   	工具path	所调用API接口的访问地址或相关资源链接。如果已配置基准URL，则工具path应填写基准URL之后的部分；如果未配置基准URL，则工具path应为从主机地址之后的完整路径。 例如：https://console.ulanqab.huawei.com/v1/chat/completions 基准URL为 /v1/chat 工具path为 /completions
   请求参数	参数封装	开启后，会将请求参数封装为一个列表（数组）结构，可适配入参为数组格式的插件接口。 例如： 原参数列表：{"a":"string", "b":1}； 开启封装后的参数列表：[{"a":"string", "b":1}]。
   	请求头(Header)	HTTP请求消息的组成部分之一，请求头负责通知服务器有关于客户端请求的信息。 单击参数列表右侧的“添加参数”可以新增参数，参数配置说明请参见表5。
   	请求体(Body)	HTTP请求消息的组成部分之一，请求体呈现发送给服务器的数据。 单击参数列表右侧的“添加参数”可以新增参数，参数配置说明请参见表5。
   	查询参数(Query)	HTTP请求消息的组成部分之一，用于向服务器传递额外的参数信息。这些参数通常以键值对的形式出现，并且附在URL的路径后面，通过?分隔。 例如，在 /items?id=123 中，查询参数为ID，值为123。 单击参数列表右侧的“添加参数”可以新增参数，参数配置说明请参见表5。
   	路径参数(Path)	自动解析工具path中包含的路径参数。工具path中支持可变参数配置。例如：/weather/weatherInfo{path_1}/{path_2}。
   响应参数	流式响应	该按钮默认关闭，开启后流式响应将逐步发送数据，减少延迟，支持实时传输、按需加载和中断，优化资源利用，提升用户体验。 说明： 单击“查看流式响应样”例按钮，可以查看流式响应的示例。 开启流式响应后，插件仍可配置输出参数；如果不配置响应参数，系统将默认传递后端返回的结果。
   	参数封装	开启后，会将响应参数封装为一个列表（数组）结构，可适配出参为数组格式的插件接口。 例如： 原参数列表：{"a":"string", "b":1}； 开启封装后的参数列表：[{"a":"string", "b":1}]。
   	参数名称	设置响应参数的名称。 命名规则：仅支持字母、数字或下划线。 说明： 单击参数列表右侧的“添加参数”，可以添加响应参数。 单击右侧的，可以删除添加的响应参数。
   	描述	设置响应参数的详细描述信息，确保准确说明参数的含义、用途和格式要求，以提高大模型对参数识别和提取的准确性。
   	参数类型	设置响应参数的数据类型。在下拉框中设置响应参数的数据类型。
   	必填	设置该参数是否为必填项。

   表5 参数配置说明

   参数	说明
   参数名称	设置请求参数的名称，参数名称会作为大模型解析参数含义的依据。 命名规则：仅支持字母、数字、下划线或短横线。 说明： 单击参数列表右侧的“添加参数”按钮，可以添加请求参数。 单击右侧的，可以删除添加的请求参数。
   中文名称	设置参数的中文名称，便于用户理解参数含义。
   参数类型	设置请求参数的数据类型。 注意： 请求头（Header）中，所有参数的值必须是字符串类型，不能设置其他类型。
   默认值	设置参数的默认值，当参数未提供时使用该值。
   描述	设置请求参数的详细描述信息，准确说明参数的含义、用途和格式要求，以提高大模型对参数识别和提取的准确性。
   参数校验	设置当前参数是否需要进行校验。 校验规则： 参数名称：需要校验的参数名称。 校验类型： 字符最大长度 枚举值 时间日期 校验规则：可设置指定格式和自定义格式。 指定格式：选择系统预置的标准校验规则。当校验类型为时间日期时，支持指定格式。 自定义格式：根据实际需求自定义校验规则。
   必填	设置该参数是否为必填项。

5. 单击“工具调测”按钮，输入请求参数值，单击“开始调测”检查调测结果。
6. 确保输出符合预期，再单击“自动解析”按钮，系统将自动生成响应参数。
7. 工具调试完成后，单击“确定”。

更多操作

工具创建完成后，您可以在工具列表中查看每个工具的调试状态、智能体引用数和工作流引用数。您可以执行如表6的操作。