切片管理

查询切片列表

分页查询知识库中的切片

POST

/api/v1/indices/pipeline/{pipeline_id}/chunklist

cURL

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

{
  "total": 50,
  "code": "Success",
  "status_code": 200,
  "nodes": [
    {
      "node": {
        "id_": "llm-xxxxxxxxxxxx_your_kb_id_file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx_0_0",
        "text": "这是切片的文本内容示例...",
        "metadata": {
          "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": "成功"
        }
      },
      "score": 0,
      "class_name": "NodeWithScore"
    }
  ],
  "success": true,
  "message": "success",
  "downgrade": false,
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}

Authorizations

string

header

required

DashScope API Key，在控制台 API Key 页面（https://rag.console.aliyun.com/settings/apikey）获取。

Path Parameters

string

required

知识库 ID（与知识库的 id 字段相同）。

Body

application/json

integer

default1

页码，从 1 开始。

Required range:x >= 1

integer

default20

每页返回的切片数量。

Required range:1 <= x <= 100

string

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

Response

200-application/json

string

响应码，成功时为 Success。

integer

HTTP 状态码。

string

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

integer

切片总数。

object[]

切片节点列表。

Show child attributes

number

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

object

Show child attributes

string

切片全局限定标识（workspace + 知识库 + 文件 + 块号）。

string

切片文本内容。

object

Show child attributes

string

所属文档 ID。

string

所属文档名称。

string

切片标题。

string

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

string

切片内容（与 text 一致）。

string

文档原始访问地址。

string

切片解析产物（docJson）的 OSS 路径。

string[]

切片关联的图片地址。

integer

文档内切片序号。

integer

块序号。

string

所属知识库 ID。

string

所属业务空间 ID。

integer

切片处理状态码。

string

切片处理状态描述。

boolean

是否发生检索降级。

cURL

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

{
  "total": 50,
  "code": "Success",
  "status_code": 200,
  "nodes": [
    {
      "node": {
        "id_": "llm-xxxxxxxxxxxx_your_kb_id_file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx_0_0",
        "text": "这是切片的文本内容示例...",
        "metadata": {
          "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": "成功"
        }
      },
      "score": 0,
      "class_name": "NodeWithScore"
    }
  ],
  "success": true,
  "message": "success",
  "downgrade": false,
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}