ListChunks 列出切片-表格存储 Tablestore(Tablestore)-阿里云帮助中心

使用 ListChunks 接口分页查询指定文档的切片列表。

前提条件

已创建 AgentStorage 实例且状态为 normal，并获取实例访问地址（endpoint）和实例名。
已创建 API Key。
待查询的知识库与文档已存在。

请求参数

参数	类型	说明
`knowledgeBaseName`	string	知识库名称（必填）
`subspace`	string	子空间名称。开启 subspace 时必填
`docId`	string	文档 ID。与 `ossKey` 二选一
`ossKey`	string	OSS 路径。与 `docId` 二选一
`maxResults`	int	返回数量。默认为 10，最大 1000
`nextToken`	string	翻页 token

请求示例

使用 API Key 认证时，通过 x-ots-instancename 和 x-ots-apikey 请求头传入实例名和 API Key。

curl -X POST https://<endpoint>/ListChunks \
  -H "x-ots-instancename: <instance-name>" \
  -H "x-ots-apikey: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "knowledgeBaseName": "product_docs_kb",
  "subspace": "default",
  "ossKey": "oss://example-bucket/docs/manual.pdf",
  "maxResults": 10
}'

响应

字段	类型	说明
`chunkDetails[].subspace`	string	所属子空间
`chunkDetails[].chunkId`	int	切片 ID
`chunkDetails[].content`	string	切片内容
`chunkDetails[].title`	string	切片标题
`chunkDetails[].chunkType`	string	切片类型，如 `TEXT
`chunkDetails[].status`	string	active`（可检索）或 `inactive`（不可检索）
`chunkDetails[].docId`	string	所属文档 ID
`chunkDetails[].ossKey`	string	所属文档 OSS 路径
`chunkDetails[].createdAt`	int	创建时间戳
`chunkDetails[].updatedAt`	int	更新时间戳
`nextToken`	string	翻页 token，为空表示最后一页

{
    "code": "SUCCESS",
    "data": {
        "chunkDetails": [
            {
                "subspace": "default",
                "docId": "fc6ed97f-28ad-4dc0-9b73-bf4a7d67ab65",
                "ossKey": "oss://example-bucket/docs/manual.pdf",
                "chunkId": 0,
                "content": "产品安装步骤：1. 下载并解压安装包。2. 按安装向导完成安装。3. 启动产品，确认显示安装成功页面。",
                "title": "产品安装步骤",
                "chunkType": "TEXT",
                "status": "active",
                "createdAt": 1787636596495
            }
        ],
        "nextToken": ""
    },
    "message": "succeed"
}