Skip to content

语义与搜索

本页路径均相对 /openapi/v1/workspaces/{workspaceId}/management/;鉴权和幂等约定见调用约定。

维度值搜索

方法与路径 用途
GET searchable-dimensions/{id}/ 查看维度值搜索状态、关联的就绪模型及 revision
POST searchable-dimensions/preview/ 校验低基数证据、可用模型及测试值,返回 planToken
POST searchable-dimensions/apply/ 按预检结果保存并启动后续验收;需 Idempotency-Key

开启前先读取详情,然后预检:

{
  "dimensionId": 12,
  "revision": "<当前修订值>",
  "cardinalityEvidence": {
    "upperBound": 200,
    "source": "database-distinct-count",
    "basis": "全量去重计数"
  },
  "probeValue": "北京"
}

采样不能证明低基数。将原参数与 planToken 一起提交到 apply/,并设置 Idempotency-Key。保存后读取操作状态,检查相关模型同步、普通词典任务及分词探针;证据不足时状态可能为 unknown。不能通过普通 dimensions/ 写入接口直接开启 isKeyword。

别名、同义词与数据集

方法与路径 用途
GET aliases/{type}/{id}/ 读取维度或基础指标别名及 revision;type 为 dimension 或 measure
POST aliases/preview/、PATCH aliases/{type}/{id}/ 预检并局部添加、移除别名
dimension-value-synonyms/ 维度值同义词的列表、详情、预检、创建、修改与删除
datasets/ 自定义数据集的列表、详情、预检、创建、修改与删除

别名预检需指定 type、id、revision、add 和 remove;提交时传相同的 add、remove、planToken 和 Idempotency-Key。维度值同义词创建的 changes 包含 dimensionId、word、synonyms;原值必须已经存在于该维度当前词典中。详情及修改、删除仅针对归属本工作区维度的关键词同义词。

同义词和数据集遵循普通资源的预检与提交;列表支持 offset、limit 分页并返回 count。数据集预检和提交的 changes.memberUid 必须是当前工作区成员,用于按其数据权限验证问法和列选择;它不是写入操作人。数据集引用的模型必须属于当前工作区。提交后应结合操作状态和实际问法检查词典与查询效果。