SuperAPI AI 工具集

knowledge-catalog-discovery

数据与分析

查看项目

更新于 10-16 14:59

技能介绍

用途

knowledge-catalog-discovery 用于在 Knowledge Catalog 中发现和探索数据资产。当需要搜索条目、查询特定元数据时,可以使用该技能提供的脚本。

主要能力

该技能包含以下脚本:

  • lookup_context:获取一个或多个数据资产的丰富元数据及其关系。参数 resources 为必填,是最多 10 个资源名称的列表;这些资源可以属于不同项目,但必须属于同一位置。
  • lookup_entry:从 Catalog 中获取数据资产(例如表/数据集/视图)的特定元数据。参数 entry 为必填,格式为 projects/{project}/locations/{location}/entryGroups/{entryGroup}/entries/{entry}。可选参数 view 指定返回条目及其方面的哪些部分,取值包括 1(BASIC,不返回方面)、2(FULL,返回所有必需方面和非必需方面的键,默认)、3(CUSTOM,返回 aspect_types 字段中请求的条目和方面,最多 100 个,当 aspect_types 非空时始终使用此视图)、4(ALL,返回条目以及必需和可选方面,最多 100 个)。可选参数 aspectTypes 用于将返回的方面限制为提供的方面类型,仅在与 CUSTOM 视图一起使用时有效,默认为空数组。
  • search_aspect_types:搜索与查询相关的方面类型。参数 query 为必填。可选参数 pageSize 为搜索页面中返回的方面类型数量,默认 5;orderBy 指定结果排序,支持 relevance、last_modified_timestamp、last_modified_timestamp asc,默认 relevance。
  • search_entries:根据提供的搜索查询在 Catalog 中搜索数据资产(例如表/数据集/视图)。参数 query 为必填,遵循 Dataplex 搜索语法,支持逻辑运算符(AND、OR、NOT)和分组。例如,要查找可能被重命名的表,可以使用 'type:table (name:books OR fiction)'。这比多次单独调用更高效。注意:在没有特定过滤器(例如 type:table)的情况下执行宽泛搜索可能很慢并消耗大量资源;进行探索性搜索时,应始终使用 pageSize 参数限制返回结果数量。可选参数 scope 将搜索空间限制为特定项目或组织,格式必须为 organizations/<org_id> 或 projects/<project_id> 或 projects/<project_number>。可选参数 pageSize 为搜索页面中的结果数量,默认 5;orderBy 指定结果排序,支持 relevance、last_modified_timestamp、last_modified_timestamp asc,默认 relevance。

使用方式

所有脚本均可使用 Node.js 执行。将 <param_name> 和 <param_value> 替换为实际值。

Bash: node <skill_dir>/scripts/<script_name>.js '{"<param_name>": "<param_value>"}'

PowerShell: node <skill_dir>/scripts/<script_name>.js '{"<param_name>": "<param_value>"}'

注意:脚本会自动从多个 .env 文件加载环境变量。除非技能执行因缺少环境变量而失败,否则不要要求用户设置变量。

适用场景

适用于需要在 Knowledge Catalog 中检索数据资产元数据、探索数据资产关系、按条件搜索条目或方面类型的场景。

限制

lookup_context 的资源数量最多为 10 个,且所有资源必须属于同一位置。宽泛搜索可能较慢且消耗大量资源,建议使用 pageSize 限制结果数量。其余限制信息暂未提供。