查询知识库文件列表
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
polardb:DescribeKnowledgeBaseFiles |
get |
*全部资源
|
无 | 无 |
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID |
cn-beijing |
| KnowledgeBaseId |
string |
是 |
知识库唯一标识 |
pkb-xxxxx |
| PageNumber |
integer |
否 |
页码 |
1 |
| PageSize |
integer |
否 |
每页记录数 |
20 |
| SourceType |
string |
否 |
来源类型 |
OSS |
| Keyword |
string |
否 |
文件名关键词 |
财报 |
| FileIds |
string |
否 |
文件 ID 列表，多个以英文逗号分隔 |
doc_a,doc_b |
| LinkId |
string |
否 |
同步链路唯一标识 |
pkbl-2ze123456789abc |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
CED079B7-A408-41A1-BFF1-EC608E****** |
| PageNumber |
integer |
页码。 |
1 |
| PageSize |
integer |
每页记录数，取值为 30、50 或 100。 默认值为 30。 |
30 |
| TotalRecordCount |
integer |
总记录数。 |
9 |
| PageRecordCount |
integer |
本页记录数。 |
9 |
| Items |
array<object> |
文件列表。 |
|
|
array<object> |
文件详情。 |
||
| FileId |
string |
文件 ID |
5b2dbb13-xxxx-xxxx-xxxx-a55fe8daec8f |
| KnowledgeSpaceId |
string |
知识空间 ID |
pks-xxxxxx |
| KnowledgeBaseId |
string |
知识库 ID |
pkb-xxxxxx |
| FileName |
string |
文件名 |
财报.pdf |
| OSSPath |
string |
OSS 文件路径 |
oss://test-bucket-example/pks-xxxx/pkb-xxxx/财报.pdf |
| FileSize |
integer |
文件大小(字节) |
318881 |
| FileType |
string |
文件类型 |
|
| ShardCount |
integer |
分片数量 |
10 |
| ShardingStrategyConfig |
object |
文档当前生效的分块策略配置。存量对象未保存完整配置时可能为空。 |
|
| DefaultStrategy |
object |
默认分块策略类型。取值：hybrid 或 hierarchical。 |
|
| Type |
string |
默认分块策略类型。取值：hybrid 或 hierarchical。 |
hybrid |
| Parameters |
object |
参数列表 |
|
| MaxTokens |
integer |
单个分片的最大 Token 数量。 |
512 |
| MergePeers |
boolean |
是否合并同一标题下相邻的小分片。 |
true |
| Rules |
array<object> |
按顺序匹配的覆盖规则列表。 |
|
|
array<object> |
规则详情。 |
||
| Match |
object |
内容类型。当前支持 table。 |
|
| ContentType |
string |
内容类型。当前支持 table。 |
table |
| Strategy |
object |
分片策略 |
|
| Type |
string |
规则命中后的分块策略类型。 |
hierarchical |
| Parameters |
object |
参数列表。 |
|
| MaxTokens |
integer |
命中内容的单个分片最大 Token 数量。 |
512 |
| MarkdownTables |
string |
Markdown 表格处理模式。取值：auto、on 或 off。 |
auto |
| InheritSpaceStrategy |
boolean |
是否继承知识空间分块策略。 |
true |
| Status |
string |
状态 |
COMPLETED |
| ErrorMessage |
string |
错误信息 |
Not Support. |
| Metadata |
object |
文档元数据 |
{} |
| SourceType |
string |
来源类型 |
OSS |
| UploadTime |
string |
上传时间 时间采用 ISO 8601 格式，时区为 UTC（格式：YYYY-MM-DDTHH:mm:ssZ）。 |
2026-06-15T22:28:53Z |
| UpdatedAt |
string |
更新时间 时间采用 ISO 8601 格式，时区为 UTC（格式：YYYY-MM-DDTHH:mm:ssZ）。 |
2026-06-15T22:28:53Z |
示例
正常返回示例
JSON格式
{
"RequestId": "CED079B7-A408-41A1-BFF1-EC608E******",
"PageNumber": 1,
"PageSize": 30,
"TotalRecordCount": 9,
"PageRecordCount": 9,
"Items": [
{
"FileId": "5b2dbb13-xxxx-xxxx-xxxx-a55fe8daec8f",
"KnowledgeSpaceId": "pks-xxxxxx",
"KnowledgeBaseId": "pkb-xxxxxx",
"FileName": "财报.pdf",
"OSSPath": "oss://test-bucket-example/pks-xxxx/pkb-xxxx/财报.pdf",
"FileSize": 318881,
"FileType": "pdf",
"ShardCount": 10,
"ShardingStrategyConfig": {
"DefaultStrategy": {
"Type": "hybrid",
"Parameters": {
"MaxTokens": 512,
"MergePeers": true
}
},
"Rules": [
{
"Match": {
"ContentType": "table"
},
"Strategy": {
"Type": "hierarchical",
"Parameters": {
"MaxTokens": 512,
"MarkdownTables": "auto"
}
}
}
]
},
"InheritSpaceStrategy": true,
"Status": "COMPLETED",
"ErrorMessage": "Not Support.",
"Metadata": {},
"SourceType": "OSS",
"UploadTime": "2026-06-15T22:28:53Z",
"UpdatedAt": "2026-06-15T22:28:53Z"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。