获取指定知识库中的文件，以及它们的详细信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
sfm:ListIndexFileDetails |
list |
*全部资源
|
无 | 无 |
请求语法
POST /{WorkspaceId}/index/list_index_file_detail HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| WorkspaceId |
string |
是 |
知识库所属的业务空间 ID。获取方式请参见如何使用业务空间。 |
llm-3z7uw7fwz0vexxxx |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| IndexId |
string |
否 |
知识库 ID，即 CreateIndex 接口返回的 |
79c0alxxxx |
| DocumentStatus |
string |
否 |
即通过文件导入状态对接口返回的文件列表进行过滤。取值范围：
默认值为空，即不使用文件导入状态对结果进行过滤。 |
FINISH |
| DocumentName |
string |
否 |
即通过文件名称对接口返回的文件详情列表进行过滤。默认值为空，即不使用文件名称对结果进行过滤。 |
翻译平台运维文档 |
| PageNumber |
integer |
否 |
指定要查询的页码。起始值为 1。默认值为 1。 |
1 |
| PageSize |
integer |
否 |
指定分页查询时每页展示的文件数量 ，最大值 10。 |
10 |
| EnableNameLike |
string |
否 |
是否开启文件名称的模糊匹配，与
默认值为 false。 枚举值：
|
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
35A267BF-xxxx-54DB-8394-AA3B0742D833 |
| Code |
string |
错误状态码。 |
InvalidParameter |
| Message |
string |
错误信息。 |
Required parameter(%s) missing or invalid, please check the request parameters. |
| Success |
boolean |
接口调用是否成功，可能值：
|
true |
| Data |
object |
接口业务数据字段。 |
|
| Documents |
array<object> |
返回知识库中的文件列表，按文件导入时间倒序排序（与控制台一致）。 |
|
|
object |
文件对象。 |
||
| Status |
string |
文件导入状态。可能值为：
|
RUNNING |
| EnableHeaders |
string |
Excel 文件表头是否支持拼装。 |
true |
| Message |
string |
文件导入错误信息。 |
check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid |
| Size |
integer |
文件大小，单位字节 Byte。 |
996764 |
| SourceId |
string |
类目 ID。 |
cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx |
| DocumentType |
string |
文件格式类型。可能值为： pdf、docx、doc、txt、md、pptx、ppt、png、jpg、jpeg、bmp、gif、EXCEL。 |
|
| Id |
string |
文件 ID。 |
doc_c134aa2073204a5d936d870bf960f56axxxxxxxx |
| Code |
string |
文件导入错误状态码。 |
110002 |
| Name |
string |
文件名称。 |
翻译平台运维文档 |
| ChunkSize |
string |
分段长度，即文本切片的字符数。 |
600 |
| OverlapSize |
string |
分段重叠长度。 |
100 |
| ChunkMode |
string |
自定义切分。 |
DashSplitter |
| GmtModified |
integer |
文件导入知识库的时间，采用 Unix timestamp 格式。 |
1744856423000 |
| separator |
string |
分句标识符。 |
" " |
| MetaExtractInfo |
string |
文档提取的 Meta 信息。 |
{ "doc_summary": ["Example 1."], "health_rule": ["Example 2"] } |
| IndexId |
string |
知识库 ID。 |
79c0alxxxx |
| TotalCount |
integer |
返回结果的总条数。 |
2437 |
| PageNumber |
integer |
返回指定的页码。 |
1 |
| PageSize |
integer |
返回指定的每页条数。 |
10 |
| Status |
string |
接口返回的状态码。 |
200 |
示例
正常返回示例
JSON格式
{
"RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
"Code": "InvalidParameter\n",
"Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
"Success": true,
"Data": {
"Documents": [
{
"Status": "RUNNING",
"EnableHeaders": "true",
"Message": "check fileUrlKey[file_path] / fileNameKey[null] / fileExtensionKey[file_extension] is invalid",
"Size": 996764,
"SourceId": "cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx\n",
"DocumentType": "pdf",
"Id": "doc_c134aa2073204a5d936d870bf960f56axxxxxxxx\n",
"Code": "110002",
"Name": "翻译平台运维文档\n",
"ChunkSize": "600",
"OverlapSize": "100",
"ChunkMode": "DashSplitter",
"GmtModified": 1744856423000,
"separator": "\" \"",
"MetaExtractInfo": "{\n \"doc_summary\": [\"Example 1.\"],\n \"health_rule\": [\"Example 2\"]\n}"
}
],
"IndexId": "79c0alxxxx",
"TotalCount": 2437,
"PageNumber": 1,
"PageSize": 10
},
"Status": "200"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。