乐享知识库接口文档 请求URL
GET https://lxapi.lexiangla.com/cgi-bin/v1/ai/entries/:id/chunks
请求头
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Authorization | 是 | 接口调用凭证 access_token 值格式:"Bearer access_token" 示例值:"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS" |
| x-staff-id | 是 | 发起请求的成员帐号,该成员需对目标知识节点有查看权限。 |
路径参数
| 参数 | 是否必须 | 说明 |
|---|---|---|
| id | 是 | 知识节点 ID(kb_entry id) |
参数说明
| 参数 | 是否必须 | 默认值 | 说明 |
|---|---|---|---|
| page_size | 否 | 20 | 每页返回的父子切片组数量,取值范围 1 ~ 50 |
| page_token | 否 | 无 | 分页游标,首次请求不传;翻页时传入上一页响应中的 next_page_token。翻页时 page_size 需与首次请求保持一致,游标有效期 30 分钟 |
响应
200 Ok 状态码
切片已就绪(status 为 ready):
{
"code": 0,
"message": "success",
"request_id": "10f012cd-xxxxb-42b0-bc46-a33a2c779f2a",
"data": {
"status": "ready",
"groups": [
{
"parent": {
"chunk_id": "p_0001",
"content": "第一段父切片完整内容……"
},
"children": [
{
"chunk_id": "c_0001",
"content": "第一个子切片内容……",
"index": 0,
"parent_id": "p_0001"
},
{
"chunk_id": "c_0002",
"content": "第二个子切片内容……",
"index": 1,
"parent_id": "p_0001"
}
]
}
],
"next_page_token": "eyJlbnRyeV9pZCI6Inh4eCJ9",
"total_parent_count": 12,
"total_child_count": 37
}
}
切片未就绪(status 不为 ready,以解析中为例):
{
"code": 0,
"message": "success",
"request_id": "10f012cd-xxxxb-42b0-bc46-a33a2c779f2a",
"data": {
"status": "parsing",
"groups": null
}
}
参数说明
| 参数 | 说明 |
|---|---|
| code | 状态码:0表示成功,非0表示失败 |
| message | 状态信息:success表示成功,其他值为失败信息 |
| request_id | 请求的唯一标识ID |
| data.status | 切片处理状态,取值: ready: 切片已就绪, groups 有效,groups 为空数组表示文档确实没有切片;parsing: 文档解析、导入或重新切片中, groups 为 null;failed: 文档解析或导入失败, groups 为 null;not_imported: 文档尚未导入知识库, groups 为 null |
| data.groups | 父子切片组数组,仅 status 为 ready 时有效,其他状态为 null |
| data.groups[].parent | 父切片 |
| data.groups[].parent.chunk_id | 父切片 ID |
| data.groups[].parent.content | 父切片正文 |
| data.groups[].children | 该父切片下的子切片列表 |
| data.groups[].children[].chunk_id | 子切片 ID |
| data.groups[].children[].content | 子切片正文 |
| data.groups[].children[].index | 子切片在文档中的序号 |
| data.groups[].children[].parent_id | 所属父切片 ID,与 data.groups[].parent.chunk_id 一致 |
| data.next_page_token | 下一页游标,不存在时表示已是最后一页。仅 status 为 ready 时返回 |
| data.total_parent_count | 文档父切片总数(全部分页合计)。仅 status 为 ready 时返回 |
| data.total_child_count | 文档子切片总数(全部分页合计)。仅 status 为 ready 时返回 |
← 获取 Skill 列表 AI 搜索 →