获取文件切片详情
更新时间 2026-02-02 16:56:05
最近更新时间: 2026-02-02 16:56:05
本文介绍获取文件切片详情。
接口描述
获取某个文件的切片详情
请求方法
GET
接口要求
无
URI
/openapi/v1/documents/chunks-detail
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| Content-Type | 是 | String | json格式 | application/json | |
| tenantId | 是 | String | 租户ID | 562b89493b1a40e1b97ea05e50dd8170 | |
| ctyun-eop-request-id | 是 | String | 用户请求 id，由用户构造，用户可以通过 uuid 等方法自行生成唯一字符串，用于日志请求追踪 | 33dfa732-b27b-464f-b15a-21ed6845afd5 | |
| eop-date | 是 | String | 请求时间，由用户构造，形如 yyyymmddTHHMMSSZ。 | 20211221T163014Z | |
| host | 是 | String | 终端节点域名，固定字段 | kqa-global.ctapi.ctyun.cn | |
| Eop-Authorization | 是 | String | 由天翼云官网 accessKey 和 securityKey 经签名后生成，参与签名生成的字段包括天翼云官网 accessKey 、securityKey、平台应用的appkey（非必须），用户请求id（非必须），请求时间，终端节点域名（非必须）以及请求体内容。 |
请求头Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| id | 是 | Int | 知识库文件id | 1443 |
请求代码示例
Curl -X GET "https://kqa-global.ctapi.ctyun.cn/openapi/v1/documents/chunks-detail?id=1443"
-H "Content-Type: application/json"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "tenantId:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:kqa-global.ctapi.ctyun.cn"状态码
返回值说明
1.请求成功返回响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | String | 返回状态，返回200表示成功 | 200 | |
| message | String | 返回Success | Success | |
| returnObj | Object | 接口返回结果 | returnObj表 |
returnObj表
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| infoBaseId | Int | 知识库ID | 1443 | |
| fileId | String | 文件ID | 23 | |
| fileName | String | 文件名 | 微积分.pdf | |
| chunks | Array[Object] | 切分片段 | chunk |
chunk表
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| chunkId | String | 文档片段ID | 1 | |
| chunkText | String | 文档片段文本 | ||
| contentId | String | 内容ID | ||
| contentText | String | 内容文本 | ||
| docTitle | String | 文档标题 | ||
| subTitle | String | 子标题 |
2.请求失败返回响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | String | 错误码，放置API对应的错误码 | 40001 | |
| message | String | 失败信息 | 缺少鉴权信息 | |
| error | String | 返回对应的错误码 | KQA_40001 |
返回值示例
1.请求成功返回值示例
{
"statusCode": 200,
"error": null,
"message": "Success",
"returnObj": {
"fileId": "1443",
"infobaseId": "428",
"fileName": "ppt4.png",
"chunks": [
{
"chunkId": "1",
"chunkText": "ppt4.png\n- 对齐方式：所有板块对齐整齐，确保整体布局的协调性。\n### 情感与氛围\n整张图片传递了一种平静、有序的信息传达效果。通过简洁的设计语言和清晰的结构安排，让读者能够快速获取所需信息并产生共鸣。\n### 总结\n这是一张介绍某位著名作家生平及代表作的图文结合型海报。通过四个板块详细介绍了该作家的职业经历、创作历程以及其代表作《月亮与六便士》，旨在向观众展示这位伟大作家的独特魅力及其作品的价值所在。",
"contentId": "3",
"contentText": "- 对齐方式：所有板块对齐整齐，确保整体布局的协调性。\n### 情感与氛围\n整张图片传递了一种平静、有序的信息传达效果。通过简洁的设计语言和清晰的结构安排，让读者能够快速获取所需信息并产生共鸣。\n### 总结\n这是一张介绍某位著名作家生平及代表作的图文结合型海报。通过四个板块详细介绍了该作家的职业经历、创作历程以及其代表作《月亮与六便士》，旨在向观众展示这位伟大作家的独特魅力及其作品的价值所在。",
"subTitle": "",
"docTitle": "ppt4.png"
}
]
}
}2.请求失败返回值示例
data:{
"statusCode": "40004",
"error": "KQA_40004",
"message": "接口执行异常"
}状态码
| http状态码 | 描述 |
| 200 | 表示请求成功 |
错误码说明
| 错误码 | 错误信息 | 错误描述 |
| 40004 | 业务异常 | 业务异常，详情见message |
