获取切片详情
更新时间:2024-11-13
接口描述
获取指定切片详情
权限说明
Authorization需要填写密钥。
接口定义
Path | /v2/knowledgeBase?Action=DescribeChunk |
---|---|
Method | POST |
Content-Type | application/json |
Authorization | 请求签名(此签名为应用工作台密钥) |
请求结构
POST /v2/knowledgeBase?Action=DescribeChunk HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"chunkId": "chunkID"
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
chunkId | string | 是 | 切片ID |
响应头域
除公共头域外,无其它特殊头域。
响应参数
字段 | 类型 | 必然存在 | 说明 |
---|---|---|---|
requestId | string | 是 | 请求ID |
id | string | 是 | 切片ID |
type | string | 是 | 切片类型(RAW | NEW | COPY) |
knowledgeBaseId | string | 是 | 切片所属知识库ID |
documentId | string | 是 | 切片所属文档ID |
content | string | 是 | 切片内容 |
wordCount | int | 是 | 切片内字符数量 |
tokenCount | int | 是 | 切片内token数量 |
enabled | bool | 是 | 是否生效 |
status | string | 是 | 切片状态(Indexing | Indexed) |
statusMessage | string | 是 | 切片状态详细描述 |
imageUrls | list[string] | 否 | 图片地址 |
createTime | time.Time | 是 | 创建时间 |
updateTime | time.TIme | 是 | 更新时间 |
请求curl 示例
curl --location 'https://qianfan.baidubce.com/v2/knowledgeBase?Action=DescribeChunk' \
--header 'Authorization: Bearer string' \
--header 'Content-Type: application/json' \
--data '{
"chunkId": "32d372f7-f112-49e1-a9bc-2001ea15e1a4"
}'
正确响应示例
HTTP/1.1 200 OK
{
"requestId": "dd734b63-6c12-4e40-af29-c472ef376054",
"id": "32d372f7-f112-49e1-a9bc-2001ea15e1a4",
"type": "NEW",
"knowledgeBaseId": "5e827931-4bc2-4cfe-b40c-0fe9371234b8",
"documentId": "c2f288b4-e9ed-46df-a1b7-034e77ce8c89",
"content": "你好",
"wordCount": 10,
"tokenCount": 10,
"enabled": true,
"status": "indexed",
"statusMessage": "None",
"createTime": 1721311575,
"updateTime": 1721359186
}
错误响应示例
HTTP/1.1 401
{
"requestId": "ae2225f7-1c2e-427a-a1ad-5413b762957d",
"code": "PermissionDeniedError",
"message": "没有权限"
}