查询语义条目¶

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

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

调用前准备¶

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

下方示例使用：

$AI_STUDIO_API_KEY：实际个人访问令牌，通过 X-API-Key Header 传递。
$WORKSPACE_ID：目标工作区 ID，通过 X-Workspace-ID Header 传递。
$MODEL_ID：要查询的知识库 ID。

路径参数¶

参数	类型	说明
`model_id`	integer	知识库 ID。

查询参数¶

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

请求示例¶

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"

成功响应¶

成功时返回 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": ""
  }
}

响应字段如下。

字段路径中的 [] 表示数组中的每一项。例如，data.items[].id 表示 data.items 数组中每一项的 id 字段。

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data.items`	object（对象数组）	当前页的语义条目。
`data.items[].id`	integer	条目 ID。
`data.items[].kind`	string	条目类型。
`data.items[].key`	string	知识库内的稳定引用键。
`data.items[].tables`	array[string]	关联表名称；未设置时可能省略。
`data.items[].spec`	object	与 `data.items[].kind` 对应的类型专属配置对象；字段见创建语义条目。
`data.items[].created_at`	integer	创建时间的 Unix 时间戳。
`data.items[].updated_at`	integer	更新时间的 Unix 时间戳。
`data.total`	integer	匹配筛选条件的条目总数。
`data.next_page_token`	string	下一页令牌；为空时没有下一页。

读取下一页¶

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

错误响应¶

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

常见 HTTP 错误¶

HTTP 状态码	错误代码	常见原因	建议操作
`400`	`ErrParamInvalid`	`model_id`、`kind` 或 `page_size` 无效。	修正参数后重试。
`401`	`ErrUnauthorized`	API Key 无效或已失效。	检查 API Key。
`403`	`ErrForbidden`	调用者没有读取权限。	检查工作区和对象授权。
`404`	`ErrNotFound`	知识库不存在或不可见。	重新确认 `model_id`。
`500`	`ErrServer`	服务未能读取条目。	保留脱敏后的响应信息后重试。

后续操作¶

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

最后更新于 2026 年 8 月 22 日