查询知识库详情

按知识库 ID 查询模型定义和来源数量。更新或删除前应先用此接口确认当前状态。

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

调用前准备

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

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:目标工作区 ID,通过 X-Workspace-ID Header 传递。

  • $MODEL_ID:要查询的知识库 ID。

路径参数

参数

类型

说明

model_id

integer

知识库 ID。

请求示例

curl "https://moi.matrixorigin.cn/newmoi/semantic-models/$MODEL_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

成功时返回 200data 为知识库定义和来源数量。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 401,
    "name": "product_docs",
    "description": "产品文档",
    "tables": [],
    "files": [],
    "source_counts": {
      "files": 2,
      "tables": 1,
      "total": 3
    },
    "created_at": 1735632000,
    "updated_at": 1735718400
  }
}

响应字段如下。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.id

integer

知识库 ID。

data.name

string

知识库名称。

data.description

string

知识库说明;未设置时可能省略。

data.tables

JSON

兼容的旧式表来源定义。

data.files

JSON

兼容的旧式文件来源定义;未设置时可能省略。

data.source_counts

object

当前来源数量。

data.source_counts.files

integer

文件来源数。

data.source_counts.tables

integer

表来源数。

data.source_counts.total

integer

来源总数。

data.created_at

integer

Unix 时间戳。

data.updated_at

integer

Unix 时间戳。

错误响应

{
  "code": "ErrNotFound",
  "msg": "resource not found",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

model_id 不是有效整数。

使用响应中的知识库 id

401

ErrUnauthorized

API Key 无效或已失效。

检查 API Key。

403

ErrForbidden

调用者没有读取该知识库的权限。

检查工作区和对象授权。

404

ErrNotFound

知识库不存在或当前调用者不可见。

重新列出知识库并确认 ID。

500

ErrServer

服务未能读取知识库。

保留脱敏后的响应信息后重试。

后续操作

需要修改属性时更新知识库;接入数据时添加数据源

最后更新于