更新时间:2026-11-03 GMT+08:00
分享

创建自定义工具

在数据智能平台中,支持通过多种方式创建自定义工具。

  • 自定义参数创建工具:通过填写表单参数或导入已有工具的OpenAPI Schema创建单个工具。适用于配置较为简单的场景。
  • 导入工具配置包批量创建工具:将跨环境或空间导出的原始工具配置包执行导入操作,系统将自动解析包内的工具定义,批量生成对应的自定义工具。适用于自定义工具的批量创建,以及跨环境或跨空间的配置迁移场景。

约束与限制

配额与限制

  • 每个工作空间下支持创建的自定义工具的数量上限为100个。
  • 每个自定义工具支持接入的API数量上限为100个。
  • API中自定义参数嵌套层级不得超过10层。

Server URL配置灵活

同一自定义工具支持接入不同Server URL的API。

例如,当某个API的服务器地址与工具默认地址不一致时(如文件上传服务使用独立服务器),可在接入API时根据业务实际需求,为其单独配置Server URL,以覆盖工具默认的Server URL。

通过自定义参数方式创建工具

  1. 登录数据智能平台并选择目标工作空间。
  2. 在左侧导航栏选择“工具 > 自定义工具”,进入自定义工具页面。
  3. 在页面右上角单击“创建工具”,右侧滑出“创建工具”窗口。

    表1 自定义工具基本信息

    字段

    描述

    名称

    工具的中文名称,在同一工作空间下须保持唯一,建议使用能清晰表达工具用途的名称,便于识别与管理。

    必填,只能包含中英文、数字、中划线(-)及下划线(_),首尾字符不能为中划线或下划线,长度须控制在2至128个字符之间。

    Server Url

    工具级Server URL,定义当前工具下全部API接口默认共享的基础访问地址,用于与各接口路径拼接,生成完整的请求URL。

    必填,该字段须为合法的URL格式。例如,https://api.example.com。

    描述

    用于简要说明工具的用途、功能特点或使用注意事项。

    非必填,长度不能超过2048个字符。

    鉴权方法

    用于验证API调用方身份和权限的机制。非必填,支持以下鉴权类型。

    • 无:表示无鉴权,无需身份验证,适用于公开或测试接口。
    • Token/API Key:通过请求头或参数传递密钥,适用于需识别调用方身份的接口。

    当鉴权类型选择“Token/API Key”时,需进一步配置以下必填项:

    • 位置:指定鉴权信息的放置位置,可选Header(请求头)或Query(请求参数)。
    • 键:填写鉴权字段名称,例如Authorization。
    • 值:填写对应的鉴权密钥,即API Key或Token值。

  4. 参考表1中的字段说明,配置自定义工具的基本信息。
  5. 参考为自定义工具接入API中的操作步骤,选择合适的方式,为自定义工具接入API。
  6. 检查并确认所有信息无误后,单击“确定”,完成自定义工具基本信息及API接口的创建。

通过导入工具配置包批量创建工具

  1. 登录数据智能平台并选择目标工作空间。
  2. 在左侧导航栏选择“工具 > 自定义工具”,进入自定义工具页面。
  3. 在页面右上角单击“导入”,弹出“导入”窗口。
  4. 从本地选择导入文件并配置重名处理策略后,单击“下一步”。

    表2 基本信息

    参数

    说明

    文件位置

    仅支持选择本地。

    从本地选择文件

    选择本机上已准备好的工具ZIP配置包。

    关于工具配置包的导出方法,详见 导出工具配置包。

    重名处理策略

    导入时如果检测到工具名称重复,系统将根据您选择的策略进行处理。

    • 覆盖:表示系统将用新配置替换已有同名工具。
    • 跳过:表示系统将保留已有工具,忽略新导入的同名配置。

  5. 系统将自动解析包内的工具定义并导入,请确认执行结果后,单击“确定”。

相关文档