查看数据列表¶
分页查询知识库中的数据源及其处理状态。返回的来源记录 ID 是后续详情、治理、分段和删除接口的入参。
GET https://api.moi.matrixorigin.cn/v5/semantic-models/{model_id}/sources
调用前准备¶
先查询知识库列表取得知识库 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。
请求参数¶
curl "https://api.moi.matrixorigin.cn/v5/semantic-models/$MODEL_ID/sources?page=1&page_size=20" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
知识库 ID。 |
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
integer |
否 |
页码,必须为正整数。 |
|
integer |
否 |
单页条数,范围为 |
成功响应¶
成功时返回 200。保存 data.items[].row_id;后续详情、治理、分段和删除接口均使用它。
{
"code": "OK",
"msg": "OK",
"data": {
"items": [
{
"row_id": "src_01",
"source_type": "file",
"model_id": 401,
"resource_id": "file_01",
"display_name": "product-guide.pdf",
"path": ["docs", "product-guide.pdf"],
"ingest_status": "ready",
"enabled": true,
"effective_enabled": true,
"segment_version_id": "ver_02",
"index_version": 2,
"governance_status": "managed"
}
],
"total": 1,
"page": 1,
"page_size": 20,
"legacy_backfill_required": false
}
}
本文中,类型后的 [] 表示数组,例如 string[] 是字符串数组;字段路径中的 [] 表示数组中的每一项,例如 data.items[].row_id 表示 data.items 数组中每一项的 row_id 字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
object |
响应数据。 |
下面表格展开响应示例中 data 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
array of object |
当前页来源记录。 |
|
integer |
匹配条件的来源总数。 |
|
integer |
当前页码。 |
|
integer |
当前页大小。 |
|
boolean |
是否需要补齐旧来源关系。 |
下面表格展开响应示例中 data.items 数组的每一项;每一行是该数组项的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
来源记录 ID。 |
|
string 或 null |
来源 ID。 |
|
string |
来源类型: |
|
integer |
所属知识库 ID。 |
|
string |
来源资源 ID。 |
|
string 或 null |
原始资源 ID。 |
|
string 或 null |
知识库侧资源 ID。 |
|
string 或 null |
原始文件 ID。 |
|
string 或 null |
知识库文件 ID。 |
|
integer 或 null |
原始表 ID。 |
|
integer 或 null |
知识库表 ID。 |
|
string |
显示名称。 |
|
array of string |
来源路径。 |
|
string 或 null |
原始来源路径。 |
|
string 或 null |
数据库名称。 |
|
string 或 null |
表名称。 |
|
integer 或 null |
文件大小。 |
|
integer 或 null |
表行数。 |
|
string |
来源处理状态。 |
|
boolean |
配置的启用状态。 |
|
integer 或 null |
到期时间。 |
|
boolean |
是否已到期。 |
|
boolean |
实际生效状态。 |
|
boolean |
到期后是否强制启用。 |
|
string |
当前分段版本;未生成时可能为空。 |
|
integer |
当前索引版本;未生成时可能为空。 |
|
string 或 null |
创建者 ID。 |
|
string 或 null |
最后更新者 ID。 |
|
integer 或 null |
最近更新时间。 |
|
string |
处理错误摘要;无错误时可能为空。 |
|
string |
来源治理状态。 |
|
string 或 null |
历史来源标记。 |
读取下一页
根据 data.total 和请求时的 page_size 计算最后一页,再依次增加 page。
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "page_size is invalid",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
面向调用者的错误信息。 |
|
null |
发生错误时为 |
后续操作¶
legacy_backfill_required 标记为需要补齐时,先补齐历史数据源关系;否则可更新数据源治理设置或删除数据源。