knowledge-catalog-discovery

用法

所有脚本均可使用 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 文件加载环境变量。除非技能执行因缺少环境变量而失败，否则不要要求用户设置变量。

脚本

lookup_context

获取一个或多个数据资源的丰富元数据及其关系。

参数

名称	类型	描述	必填	默认值
resources	array	必填。最多包含 10 个资源名称的列表。资源可以属于不同项目，但必须都属于同一位置。	是

---

lookup_entry

从 Catalog 获取特定数据资源（例如表格／数据集／视图）的元数据

参数

名称	类型	描述	必填	默认值
entry	string	必填。Entry 的资源名称，格式如下：projects/{project}/locations/{location}/entryGroups/{entryGroup}/entries/{entry}。	是
view	integer

			## 参数：view

			**类型：** Integer

			**描述：** 可选。指定要返回的条目部分及其方面。

			**可能的值：**

			*   1 (BASIC)：返回不含方面的条目。
			*   2 (FULL)：返回所有必需方面和非必需方面的键。（默认）
			*   3 (CUSTOM)：返回条目以及 aspect_types 字段中请求的方面（最多 100 个方面）。aspect_types 不为空时，始终使用此视图。
			*   4 (ALL)：返回条目以及必需和可选方面（最多 100 个方面）
			 | 否 | `2` |

| aspectTypes | array | 可选。将返回的方面限制为指定的方面类型。仅在与 CUSTOM 视图配合使用时有效。 | 否 | [] |

---

search_aspect_types

搜索与查询相关的方面类型。

参数

名称	类型	描述	必填	默认值
query	string	用于匹配方面类型的查询。	是
pageSize	integer	搜索结果页中返回的方面类型数量。	否	5
orderBy	string	指定结果排序方式。支持的值包括：relevance、last_modified_timestamp、last_modified_timestamp asc	否	relevance

---

search_entries

根据提供的搜索查询，在 Catalog 中搜索数据资源（例如表格／数据集／视图）。

参数

名称	类型	描述	必填	默认值
query	string	用于搜索条目的查询字符串，遵循 Dataplex 搜索语法。支持逻辑运算符（AND、OR、NOT）和分组。例如，要查找可能已重命名的表格，可以使用 'type:table (name:books OR fiction)'。这样比多次单独调用更高效。警告：不带特定筛选条件（例如 type:table）进行宽泛搜索可能会很慢，并消耗大量资源。进行探索性搜索时，始终使用 pageSize 参数限制返回结果的数量。	是
scope	string	scope 会将搜索范围限制为特定项目或组织。格式必须为：organizations/<org_id> 或 projects/<project_id> 或 projects/<project_number>。	否	``
pageSize	integer	搜索结果页中的结果数量。	否	5
orderBy	string	指定结果排序方式。支持的值包括：relevance、last_modified_timestamp、last_modified_timestamp asc	否	relevance

---