查看语义条目列表¶

分页列出知识库中的业务定义条目。

GET https://moi.matrixorigin.cn/newmoi/semantic-models/{model_id}/entries

调用前准备¶

先查询知识库列表取得知识库 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求参数¶

请求示例

curl "https://moi.matrixorigin.cn/newmoi/semantic-models/$MODEL_ID/entries?kind=metric&page_size=20" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

路径参数

字段	类型	必填	说明
`model_id`	integer	是	知识库 ID。

查询参数

字段	类型	必填	说明
`kind`	string	否	条目类型筛选条件；可用值及其配置字段见创建语义条目。
`page_size`	integer	否	单页条数，范围为 `1` 至 `100`；不传时为 `20`。
`page_token`	string	否	上一页响应中的 `next_page_token`。

成功响应¶

成功时返回 200。保存 data.items[].id，后续更新和删除接口均使用它。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "items": [
      {
        "id": 501,
        "kind": "metric",
        "key": "total_rows",
        "tables": ["orders"],
        "spec": {
          "expr": "COUNT(*)"
        },
        "created_at": 1735632000,
        "updated_at": 1735632000
      }
    ],
    "total": 1,
    "next_page_token": ""
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。

查询结果

下面表格展开响应示例中 data 对象；每一行是该对象的一个字段。

字段	类型	说明
`items`	array of object	当前页的语义条目。
`total`	integer	匹配筛选条件的条目总数。
`next_page_token`	string	下一页令牌；为空时没有下一页。

语义条目

下面表格展开响应示例中 data.items 数组的每一项；每一行是该数组项的一个字段。

字段	类型	说明
`id`	integer	条目 ID。
`kind`	string	条目类型。
`key`	string	知识库内的稳定引用键。
`tables`	array of string	关联表名称；未设置时可能省略。
`spec`	object	`json.RawMessage` 类型专属配置对象；结构严格由 `data.items[].kind` 决定。各 kind 的固定字段、`join_columns[]` 子字段和 `sql_resultset` 嵌套字段见创建语义条目。
`created_at`	integer	创建时间的 Unix 时间戳。
`updated_at`	integer	更新时间的 Unix 时间戳。

条目定义

下面表格展开响应示例中 data.items[].spec 对象；实际字段随 kind 变化。

字段	类型	说明
`expr`	string	示例中指标条目的计算表达式。

读取下一页

响应中的 data.next_page_token 非空时，将其作为 page_token 传入下一页请求；为空时表示已读取到最后一页。

错误响应¶

响应示例

{
  "code": "ErrParamInvalid",
  "msg": "page_size is invalid",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	面向调用者的错误信息。
`data`	null	发生错误时为 `null`。

后续操作¶

需要新增时创建语义条目；选定已有条目后可更新语义条目或删除语义条目。

最后更新于 2026 年 9 月 3 日