知识库知识库外部开放接口
获取文档切片列表
分页获取指定文档的切片列表。
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| spaceId | int64 | 否 | 知识库空间 ID。 | 123456 |
| docId | int64 | 是 | 文档 ID。 | 987654 |
| pageNum | int32 | 否 | 页码,范围 1 到 500。 | 1 |
| pageSize | int32 | 否 | 每页数量,范围 1 到 1000。 | 50 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。 | 200 |
| msg | string | 响应说明。成功通常为 ok;失败时为错误原因。 | ok |
| message | string | 兼容字段,部分异常场景可能返回错误说明。 | |
| data | object | 切片分页结果。 | |
| └spaceId | int64 | 所属空间 ID。 | 123456 |
| └docId | int64 | 文档 ID。 | 987654 |
| └docName | string | 文档名称。 | 退款规则 |
| └parentId | int64 | 父目录 ID;根目录通常为 0。 | 0 |
| └recallTime | int64 | 召回请求时间,毫秒时间戳。 | 1781245600000 |
| └pageCount | int32 | 总页数。 | 10 |
| └pageIndex | int32 | 当前页码。 | 1 |
| └pageSize | int32 | 每页数量。 | 20 |
| └dataCount | int32 | 总数据量。 | 200 |
| └llmRagParaKnowledgeList | object[] | 段落切片列表。 | |
| └docUniqueId | string | 文档唯一 ID。 | doc_123 |
| └paraUniqueId | string | 段落唯一 ID。 | para_123 |
| └occurTime | int64 | 段落排序时间。 | 1781245600000 |
| └createTime | int64 | 段落创建时间。 | 1781245600000 |
| └keyWords | string | 段落关键词。 | 退款,售后 |
| └pageIndex | int32 | 段落所在页码。 | 1 |
| └pageUrl | string | 段落对应图片地址;PDF 文档场景可能返回。 | https://example.com/page.png |
| └pageMd5 | string | 段落对应图片 MD5。 | 9e107d9d372bb6826bd81d3542a419d6 |
| └llmRagFaqKnowledgeList | object[] | FAQ 切片列表。 | |
| └docUniqueId | string | 文档唯一 ID。 | doc_123 |
| └paraUniqueId | string | 段落唯一 ID。 | para_123 |
| └faqUniqueId | string | FAQ 切片唯一 ID。 | faq_123 |
| └occurTime | int64 | 段落排序时间。 | 1781245600000 |
| └createTime | int64 | 切片创建时间。 | 1781245600000 |
| └originKnowledgeValue | string | 切片原始内容。 | |
| └ngramWords | string | 切片 ngram 词。 | 退款,售后 |
| └knowledgeValueTokenLength | int32 | 切片 token 长度。 | 128 |
| └knowledgeValueLength | int32 | 切片字符长度。 | 512 |
| └docId | string | 文档 ID。 | 987654 |
| └inMaskQuestions | boolean | 是否命中屏蔽问题。 | false |
| └maskStatus | boolean | 是否处于屏蔽状态。 | false |
| └maskQuestionUniqueId | string | 屏蔽问题唯一 ID。 | question_123 |
| └userName | string | 操作人姓名或账号。 | zhangsan |
| └modifiedCount | int32 | 修改次数。 | 1 |
| └maskQuestions | object[] | 屏蔽问题列表。 | |
| └questionUniqueId | string | 屏蔽问题唯一 ID。 | question_123 |
| └question | string | 屏蔽问题文本。 | 这个问题不参与召回 |
错误码
| 状态码 | 描述 |
|---|---|
| 400 | 请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。 |
| 401 | OPENAPI_AUTH 鉴权失败。常见业务码:405 AUTH_FAILED。 |
| 404 | 资源不存在。常见业务码:404 NOT_FOUND、408 SPACE_NOT_EXISTS。 |
| 500 | 服务内部异常。常见业务码:500 ERROR。 |
postEndpoint
/api/athena/openApi/external/docSliceListcurl -X POST "https://b.163.com/api/athena/openApi/external/docSliceList" \ -H "Content-Type: application/json" \ -d '{ "docId": 987654 }'{
"code": 200,
"msg": "ok",
"message": "string",
"data": {
"spaceId": 123456,
"docId": 987654,
"docName": "退款规则",
"parentId": 0,
"recallTime": 1781245600000,
"pageCount": 10,
"pageIndex": 1,
"pageSize": 20,
"dataCount": 200,
"llmRagParaKnowledgeList": [
{
"docUniqueId": "doc_123",
"paraUniqueId": "para_123",
"occurTime": 1781245600000,
"createTime": 1781245600000,
"keyWords": "退款,售后",
"pageIndex": 1,
"pageUrl": "https://example.com/page.png",
"pageMd5": "9e107d9d372bb6826bd81d3542a419d6"
}
],
"llmRagFaqKnowledgeList": [
{
"docUniqueId": "doc_123",
"paraUniqueId": "para_123",
"faqUniqueId": "faq_123",
"occurTime": 1781245600000,
"createTime": 1781245600000,
"originKnowledgeValue": "string",
"ngramWords": "退款,售后",
"knowledgeValueTokenLength": 128,
"knowledgeValueLength": 512,
"docId": "987654",
"inMaskQuestions": false,
"maskStatus": false,
"maskQuestionUniqueId": "question_123",
"userName": "zhangsan",
"modifiedCount": 1,
"maskQuestions": [
{
"questionUniqueId": "question_123",
"question": "这个问题不参与召回"
}
]
}
]
}
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}这篇文档有帮助吗?