查询文档详情

查询一个来源文档的当前分段版本、索引版本和分段内容。编辑分段前先用此接口保存当前版本和索引版本。

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

调用前准备

先查询数据源列表取得来源记录 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

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

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

• $MODEL_ID：知识库 ID。

• $SOURCE_ROW_ID：来源记录 ID。

• $SEGMENT_VERSION_ID：要读取的分段版本 ID；不传时读取当前版本。

路径参数

参数	类型	说明
model_id	integer	知识库 ID。
source_row_id	string	来源记录 ID。

查询参数

参数	类型	是否必填	说明
segment_version_id	string	否	要读取的分段版本 ID；不传时读取当前版本。

请求示例

curl "https://moi.matrixorigin.cn/newmoi/semantic-models/$MODEL_ID/sources/$SOURCE_ROW_ID/document?segment_version_id=$SEGMENT_VERSION_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

成功时返回 200。data 返回文档预览、版本列表和所选版本的分段内容。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "source": {
      "row_id": "src_01",
      "model_id": 401,
      "source_type": "file",
      "ingest_status": "ready"
    },
    "preview": {
      "available": true,
      "content": "产品说明"
    },
    "file_info": {
      "tags": ["product"],
      "enabled": true,
      "effective_enabled": true,
      "index_version": 2,
      "segment_version_id": "ver_02"
    },
    "segment_status": {
      "available": true,
      "total": 1
    },
    "current_segment_version_id": "ver_02",
    "current_index_version": 2,
    "segment_versions": [
      {
        "version_id": "ver_02",
        "current": true,
        "index_version": 2,
        "chunk_count": 1
      }
    ],
    "segments": [
      {
        "segment_id": "seg_01",
        "segment_type": "text",
        "level": "chunk",
        "content": "产品说明",
        "enabled": true
      }
    ]
  }
}

响应字段如下。

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

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data.source	object	来源记录。
data.preview.available	boolean	预览内容是否可用。
data.preview.content	string	预览内容；可用时返回。
data.preview.reason	string	预览不可用原因；按情况返回。
data.file_info	object	文件标签、过期和启用信息。
data.file_info.effective_enabled	boolean	当前实际生效状态。
data.segment_status.available	boolean	分段是否可用。
data.segment_status.total	integer	分段数量。
data.current_segment_version_id	string	当前分段版本 ID。
data.current_index_version	integer	当前索引版本。
data.segment_versions	object（对象数组）	所有可用分段版本。
data.segment_versions[].version_id	string	分段版本 ID。
data.segment_versions[].current	boolean	是否为当前分段版本。
data.segments	object（对象数组）	所选版本中的分段。
data.segments[].segment_id	string	分段 ID。
data.segments[].content	string	分段内容。
data.segments[].enabled	boolean	分段是否启用。

错误响应

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

常见 HTTP 错误

HTTP 状态码	错误代码	常见原因	建议操作
400	ErrParamInvalid	model_id 无效或 source_row_id 为空。	从来源列表取得路径 ID。
401	ErrUnauthorized	API Key 无效或已失效。	检查 API Key。
403	ErrForbidden	调用者没有读取来源文档的权限。	检查工作区和对象授权。
404	ErrNotFound	知识库或来源不存在，或当前调用者不可见。	重新确认路径 ID。
500	ErrServer	服务未能读取文档或分段。	保留脱敏后的响应信息后重试。

后续操作

需要补充内容时创建分段；修改已有分段时更新分段。

最后更新于 2026 年 8 月 22 日