七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
知识库知识库外部开放接口

获取文档切片列表

分页获取指定文档的切片列表。

请求体

名称类型必填描述示例值
spaceIdint64否知识库空间 ID。123456
docIdint64是文档 ID。987654
pageNumint32否页码,范围 1 到 500。1
pageSizeint32否每页数量,范围 1 到 1000。50

返回参数

名称类型描述示例值
codeint32业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。200
msgstring响应说明。成功通常为 ok;失败时为错误原因。ok
messagestring兼容字段,部分异常场景可能返回错误说明。
dataobject切片分页结果。
└spaceIdint64所属空间 ID。123456
└docIdint64文档 ID。987654
└docNamestring文档名称。退款规则
└parentIdint64父目录 ID;根目录通常为 0。0
└recallTimeint64召回请求时间,毫秒时间戳。1781245600000
└pageCountint32总页数。10
└pageIndexint32当前页码。1
└pageSizeint32每页数量。20
└dataCountint32总数据量。200
└llmRagParaKnowledgeListobject[]段落切片列表。
└docUniqueIdstring文档唯一 ID。doc_123
└paraUniqueIdstring段落唯一 ID。para_123
└occurTimeint64段落排序时间。1781245600000
└createTimeint64段落创建时间。1781245600000
└keyWordsstring段落关键词。退款,售后
└pageIndexint32段落所在页码。1
└pageUrlstring段落对应图片地址;PDF 文档场景可能返回。https://example.com/page.png
└pageMd5string段落对应图片 MD5。9e107d9d372bb6826bd81d3542a419d6
└llmRagFaqKnowledgeListobject[]FAQ 切片列表。
└docUniqueIdstring文档唯一 ID。doc_123
└paraUniqueIdstring段落唯一 ID。para_123
└faqUniqueIdstringFAQ 切片唯一 ID。faq_123
└occurTimeint64段落排序时间。1781245600000
└createTimeint64切片创建时间。1781245600000
└originKnowledgeValuestring切片原始内容。
└ngramWordsstring切片 ngram 词。退款,售后
└knowledgeValueTokenLengthint32切片 token 长度。128
└knowledgeValueLengthint32切片字符长度。512
└docIdstring文档 ID。987654
└inMaskQuestionsboolean是否命中屏蔽问题。false
└maskStatusboolean是否处于屏蔽状态。false
└maskQuestionUniqueIdstring屏蔽问题唯一 ID。question_123
└userNamestring操作人姓名或账号。zhangsan
└modifiedCountint32修改次数。1
└maskQuestionsobject[]屏蔽问题列表。
└questionUniqueIdstring屏蔽问题唯一 ID。question_123
└questionstring屏蔽问题文本。这个问题不参与召回

错误码

状态码描述
400请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。
401OPENAPI_AUTH 鉴权失败。常见业务码:405 AUTH_FAILED。
404资源不存在。常见业务码:404 NOT_FOUND、408 SPACE_NOT_EXISTS。
500服务内部异常。常见业务码:500 ERROR。
postEndpoint
/api/athena/openApi/external/docSliceList
POST
/api/athena/openApi/external/docSliceList
curl -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"
}

这篇文档有帮助吗?