@re-ai/volc-knowledge/docs/参考文档/切片/list.md

火山引擎知识库接口接入SDK

# 查看知识库切片列表接口文档
## 一、接口概述
`/api/knowledge/point/list`接口用于查看指定知识库下的切片列表，默认按照`point_id`从小到大排序。通过该接口，用户能够获取知识库中切片的详细信息，包括所属文档、加工后的知识内容等。

## 二、前提条件
在使用该接口前，需完成“签名鉴权方式”页面的注册账号、实名认证、AK/SK密钥获取和签名获取，以获得调用API接口的权限。

## 三、请求接口
|参数|详情|描述|
|---|---|---|
|URI|`/api/knowledge/point/list`|统一资源标识符|
|请求方法|POST|客户端对向量数据库服务器请求的操作类型|
|请求头|`Content-Type: application/json`<br>`Authorization: HMAC-SHA256 ***`|请求消息类型<br>鉴权|

## 四、请求参数
|参数|类型|是否必选|默认值|参数说明|
|---|---|---|---|---|
|collection_name|string|否|--|知识库的名字|
|project|string|否|default|知识库所属项目，在【访问控制】-【资源管理】-【项目】中创建|
|resource_id|string|否|--|知识库的唯一id，可选择直接传resource_id，或同时传name和project作为知识库的唯一标识|
|offset|int|否|0|表示从结果的第几个后开始取，取值需大于等于0|
|limit|int|否|-1|表示获取多少个结果，-1表示获取所有，最大值不超过100，每次返回最多不超过100|
|doc_ids|list|否|--|对doc进行筛选，不传或为null表示不筛选doc，传入的size为0将返回空结果，限制list长度，最大长度为100|

## 五、响应消息
|参数|参数说明|
|---|---|
|code|状态码|
|message|返回信息|
|request_id|标识每个请求的唯一标识符|
|data|包含知识点详细列表，包括知识库名字、总结果数、本次返回结果数量、切片列表（每个切片包含所属知识库名、知识点id、所属文档信息、处理时间、父标题、知识内容等）|

## 六、状态码说明
|状态码|http状态码|返回信息|状态码说明|
|---|---|---|---|
|0|200|success|成功|
|1000001|401|unauthorized|鉴权失败|
|1000002|403|no permission|权限不足|
|1000003|400|invalid request：%s|非法参数|
|1000005|400|collection not exist|collection不存在|

## 七、完整示例
### （一）请求消息
```bash
curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: HMAC-SHA256 ***' \
  https://api-knowledgebase.mlp.cn-beijing.volces.com/api/knowledge/point/list \
  -d '{
    "collection_name": "test_collection_name",
    "project": ""
}'
```

### （二）响应消息
1. **执行成功返回**
```json
{
    "code": 0,
    "data": {
        "collection_name": "api0828",
        "total_num": 1,
        "count": 1,
        "point_list": [
            {
                "collection_name": "api0828",
                "point_id": "_sys_auto_gen_doc_id-17691607628519396693-0",
                "process_time": 1724848725,
                "content": "讲解模块:讲解模块：xxxxxx\n子模块:子模块：xxxxx\n问题示例:问题示例：xxxxxx\n记忆化 —— 讲解要点:\n□ 要点1\n□ 要点2\n□ 要点3",
                "chunk_id": 0,
                "doc_info": {
                    "doc_id": "_sys_auto_gen_doc_id-17691607628519396693",
                    "doc_name": "演示表格.xlsx",
                    "create_time": 1724848720,
                    "doc_type": "xlsx",
                    "source": "tos_fe"
                },
                "chunk_type": "structured",
                "table_chunk_fields": [
                    {
                        "field_name": "讲解模块",
                        "field_value": "讲解模块：xxxxxx"
                    },
                    {
                        "field_name": "子模块",
                        "field_value": "子模块：xxxxx"
                    },
                    {
                        "field_name": "问题示例",
                        "field_value": "问题示例：xxxxxx"
                    },
                    {
                        "field_name": "记忆化 —— 讲解要点",
                        "field_value": "□ 要点1\n□ 要点2\n□ 要点3"
                    }
                ]
            }
        ]
    },
    "message": "success",
    "request_id": "02172484891424400000000000000000000ffff0a00705414b331"
}
```
2. **执行失败返回**
```json
HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
{"code":1000003, "message":"invalid request：%s", "request_id": "021695029757920fd001de6666600000000000000000002569b8f"}
```