查看文档详细信息
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| KbUuid |
string |
是 |
知识库 ID。 |
kb-*** |
| DocumentName |
string |
是 |
文档名称。 |
test.md |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。 |
67E910F2-4B62-5B0C-ACA3-7547695C**** |
| Data |
object |
返回结构体。 |
|
| KbUuid |
string |
知识库 ID。 |
kb-*** |
| Name |
string |
文档名称。 |
test.md |
| Description |
string |
文档描述。 |
abc |
| FileExt |
string |
文档扩展类型。 |
md |
| DocumentLoaderName |
string |
文档加载器名称。 |
ADBPGLoader |
| TextSplitterName |
string |
文档分词器名称。 |
ChineseRecursiveTextSplitter |
| FileSize |
integer |
文档大小，单位为字节。 |
20307 |
| DocsCount |
integer |
知识块数量。 |
123 |
| State |
integer |
文档状态，返回值如下：
|
0 |
| GmtCreate |
string |
文档创建时间。 |
2026-04-22 22:59:35 |
| GmtModified |
string |
文档修改时间。 |
2026-04-24 21:22:53 |
| Summary |
string |
文档摘要。 |
This is a test document. |
| Keywords |
string |
文档关键词。 |
["test","abc"] |
| Success |
boolean |
请求是否成功，返回值如下：
|
true |
| ErrorCode |
string |
错误码，请求异常时返回。 |
KnowledgeBaseNotFound |
| ErrorMessage |
string |
调用失败时，返回的错误信息。 |
Resource not found kb-*** |
示例
正常返回示例
JSON格式
{
"RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
"Data": {
"KbUuid": "kb-***",
"Name": "test.md",
"Description": "abc",
"FileExt": "md",
"DocumentLoaderName": "ADBPGLoader",
"TextSplitterName": "ChineseRecursiveTextSplitter",
"FileSize": 20307,
"DocsCount": 123,
"State": 0,
"GmtCreate": "2026-04-22 22:59:35",
"GmtModified": "2026-04-24 21:22:53",
"Summary": "This is a test document.",
"Keywords": "[\"test\",\"abc\"]"
},
"Success": true,
"ErrorCode": "KnowledgeBaseNotFound",
"ErrorMessage": "Resource not found kb-***\n"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。