查询切片列表 - Knowledge Studio

POST

/api/v1/indices/rag/index/chunklist

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/chunklist" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "indexId": "your_index_id",
    "pageNum": 1,
    "pageSize": 10
  }'

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "total": 106,
    "nodes": [
      {
        "score": 0,
        "text": "这是切片的文本内容示例...",
        "metadata": {
          "_id": "llm-xxxxxxxxxxxx_your_kb_id_file_xxxxxxxx_0_0",
          "doc_id": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
          "doc_name": "sample_document",
          "title": "产品概述",
          "content": "这是切片的文本内容示例...",
          "hier_title": "产品概述|功能介绍",
          "doc_url": "https://oss-example.aliyuncs.com/...",
          "file_path": "https://oss-example.aliyuncs.com/.../docJson/sample.json",
          "image_url": [],
          "_chunk_id": 0,
          "_block_id": 0,
          "pipeline_id": "your_kb_id",
          "workspace_id": "llm-xxxxxxxxxxxx",
          "_chunk_status": 0,
          "_chunk_status_message": "成功",
          "is_displayed_chunk_content": true
        }
      }
    ],
    "isDowngrade": false
  },
  "success": true,
  "message": "success",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}

Authorizations

string

header

required

DashScope API Key，在控制台 API Key 页面获取。

Body

application/json

string

required

知识库 ID，即 createIndex 接口返回的 data.id。

integer

页码，从 1 开始，默认为 1。

integer

每页返回的切片数量，默认为 20，最大 100。

string

按文档 ID 过滤，仅返回该文档下的切片。文档 ID 可通过查询文档列表接口获取。

Response

200-application/json

string

响应码，成功时为 Success。

integer

HTTP 状态码。

object

业务数据。

Show child attributes

integer

切片总数。

object[]

切片节点列表。

Show child attributes

number

相关性分数（列表查询时通常为 0）。

string

切片文本内容。

object

切片元数据。

Show child attributes

string

切片全局唯一标识。

string

所属文档 ID。

string

所属文档名称。

string

切片标题。

string

层级标题（按 | 分隔的标题路径）。

string

切片内容。

string

文档原始访问地址。

string

切片解析产物的 OSS 路径。

string[]

切片关联的图片地址。

integer

文档内切片序号。

integer

块序号。

string

所属知识库 ID。

string

所属业务空间 ID。

integer

切片处理状态码（0 表示成功）。

string

切片处理状态描述。

boolean

是否参与知识库检索。

string

切片在知识库中的唯一编号。

integer

切片来源类型。

boolean

是否发生检索降级。

boolean

请求是否成功。

string

响应消息。

string

请求唯一标识，排查问题时请提供此 ID。

string

请求状态，成功时为 SUCCESS。

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/chunklist" \ -H "Authorization: Bearer $DASHSCOPE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "indexId": "your_index_id", "pageNum": 1, "pageSize": 10 }'

{ "code": "Success", "status_code": 200, "data": { "total": 106, "nodes": [ { "score": 0, "text": "这是切片的文本内容示例...", "metadata": { "_id": "llm-xxxxxxxxxxxx_your_kb_id_file_xxxxxxxx_0_0", "doc_id": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx", "doc_name": "sample_document", "title": "产品概述", "content": "这是切片的文本内容示例...", "hier_title": "产品概述|功能介绍", "doc_url": "https://oss-example.aliyuncs.com/...", "file_path": "https://oss-example.aliyuncs.com/.../docJson/sample.json", "image_url": [], "_chunk_id": 0, "_block_id": 0, "pipeline_id": "your_kb_id", "workspace_id": "llm-xxxxxxxxxxxx", "_chunk_status": 0, "_chunk_status_message": "成功", "is_displayed_chunk_content": true } } ], "isDowngrade": false }, "success": true, "message": "success", "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "status": "SUCCESS" }