获取切片列表
更新时间：2024-11-13
接口描述
获取知识库列表
权限说明
Authorization需要填写密钥。
接口定义
| Path | /v2/knowledgeBase?Action=DescribeChunks |
|---|---|
| Method | POST |
| Content-Type | application/json |
| Authorization | 请求签名(此签名为应用工作台密钥) |
请求结构
POST /v2/knowledgeBase?Action=DescribeChunks HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"documentId": "文档id"
"marker": "切片起始位置id"，
"maxKeys": 10,
"type": "RAW" # 根据切片类型获取切片列表
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 字段 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| documentId | string | 是 | 文档ID |
| marker | string | 否 | 起始位置 |
| maxKeys | int | 否 | 数据大小，默认10，最大值100 |
| type | string | 否 | 根据类型获取切片列表(RAW | NEW | COPY)，RAW：原文切片，NEW：新增切片，COPY：复制切片 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 字段 | 类型 | 必然存在 | 说明 |
|---|---|---|---|
| requestId | string | 是 | 请求ID |
| data | []dict | 是 | 切片列表 |
| data / id | string | 是 | 切片ID |
| data / type | string | 是 | 切片类型 (RAW | NEW | COPY) |
| data / knowledgeBaseId | string | 是 | 切片所属知识库ID |
| data / documentId | string | 是 | 切片所属文档ID |
| data / content | string | 是 | 切片内容(需要截断) |
| data / wordCount | int | 是 | 切片内字符数量 |
| data / tokenCount | int | 是 | 切片内token数量 |
| data / enabled | bool | 是 | 是否生效 |
| data / status | string | 是 | 切片状态(Indexed | Indexing) |
| data / statusMessage | string | 是 | 切片状态详细描述 |
| data / createTime | time.Time | 是 | 创建时间 |
| data / updateTime | time.TIme | 是 | 更新时间 |
| marker | string | 是 | 起始位置 |
| isTruncated | bool | 是 | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | string | 是 | nextMarker下次查询的起始位置 |
| maxKeys | int | 是 | 本次查询包含的最大结果集数量 |
请求curl 示例
curl --location 'https://qianfan.baidubce.com/v2/knowledgeBase?Action=DescribeChunks' \
--header 'Authorization: Bearer string' \
--header 'Content-Type: application/json' \
--data '{
"documentId": "c2f128b4-e9ed-46df-a1b7-034e77ce8c89",
"marker": "cfdc5bba-f047-4e81-a5fa-06d40c0fd846",
"maxKeys": 10,
"type": "RAW"
}'正确响应示例
HTTP/1.1 200 OK
{
"requestId": "733690dd-1168-4458-82a7-b47169be37c4",
"data": [
{
"id": "96f692b9-fc2d-4da1-943f-9922d46e5576",
"type": "RAW",
"knowledgeBaseId": "5e817931-4bc2-4cfe-b40c-0fe9371234b8",
"documentId": "c2f188b4-e9ed-46df-a1b7-034e77ce8c89",
"content": "你好",
"wordCount": 166,
"tokenCount": 127,
"enabled": true,
"status": "indexed",
"statusMessage": "None",
"createTime": 1721307226,
"updateTime": 1721307227
}
],
"marker": "cfdc5bba-f047-4e81-a5fa-06d40c0fd846",
"isTruncated": false,
"nextMarker": "d3f97da1-e9a1-4ae1-91d9-e55e87db382a",
"maxKeys": 2
}错误响应示例
HTTP/1.1 401
{
"requestId": "ae2225f7-1c2e-427a-a1ad-5413b762957d",
"code": "PermissionDeniedError",
"message": "没有权限"
}