SuperAPI AI 工具集

omni-model-explorer

数据与分析

查看项目

更新于 10-15 21:39

技能介绍

用途:在构建、查询或修改 Omni 语义模型前,先通过 REST API 了解模型中存在哪些内容。资料建议从共享模型(Shared model)入手,它包含受治理的分析层。

主要能力: 自上而下探索:列出模型 → 选择模型 → 列出主题 → 查看主题 → 探索视图与字段。 列出模型:GET /api/v1/models,返回 id、name、connectionId、modelKind(SCHEMA 或 SHARED);加 ?include=activeBranches 可看各模型活动分支及其 branchId。 列出主题:GET /api/v1/models/{modelId}/topics,返回主题名、基础视图、标签、描述。 查看主题:GET /api/v1/models/{modelId}/topic/{topicName},返回 base_view_name、views[](含 dimensions[]、measures[])、relationships[]、default_filters、ai_context。 读取 YAML:GET /api/v1/models/{modelId}/yaml,可用 fileName 指定文件或正则过滤,可用 branchId 指定分支;mode 参数 combined 合并 schema 与 shared,extension 仅显示 shared 自定义。 字段影响分析:在 omni-model-builder 创建移除或重命名字段的分支后,GET /api/v1/models/{modelId}/content-validator?branchId={branchId} 获取引用损坏的仪表盘与图块,并搜索 YAML 中其他引用,汇总影响范围报告。不要逐个翻页检查查询,content-validator 会一次完成。

使用方式:先设置环境变量 OMNI_BASE_URL 与 OMNI_API_KEY。不确定端点或参数时,获取 OpenAPI 规范:curl -L "$OMNI_BASE_URL/openapi.json" -H "Authorization: Bearer $OMNI_API_KEY"。API 密钥可在组织管理员的 Settings > API Keys 或用户个人账户生成。

关键概念:视图对应数据库表,含维度(可分组字段)与度量(聚合);主题把视图连接为可查询单元,有基础视图、连接视图、默认过滤与 AI 上下文;关系定义 join_from_view、join_to_view、on_sql、relationship_type(one_to_one、many_to_one、one_to_many、many_to_many)、join_type(always_left、inner、full_outer)。字段命名 view_name.field_name,日期粒度用 orders.created_at[week]。计算字段用 calc_name 与 sql_expression,而非 name/sql。

适用场景:回答"有哪些数据"、"表之间如何关联"、"某视图有哪些度量",以及在字段迁移或删除前评估影响。

限制:需要有效 API 密钥与权限;具体端点与参数以 OpenAPI 规范为准;资料未说明速率限制、错误码与收费信息。