更新文档的描述信息
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| KbUuid |
string |
是 |
知识库 ID。 |
kb-*** |
| DocumentName |
string |
是 |
文档名称。 |
test.md |
| NewDescription |
string |
是 |
新的文档描述。 |
test123 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
本次调用的唯一 ID。出现错误后,您可以根据该 ID 排查问题。 |
67E910F2-4B62-5B0C-ACA3-7547695C**** |
| Data | OneMetaKnowledgeBaseDocument |
返回结构体。 |
|
| Success |
boolean |
请求是否成功,取值
|
true |
| ErrorCode |
string |
错误码,请求异常时返回。 |
KnowledgeBaseNotFound |
| ErrorMessage |
string |
调用失败时,返回的错误信息。 |
Resource not found kb-*** |
示例
正常返回示例
JSON格式
{
"RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
"Data": {
"KbUuid": "",
"Name": "",
"Description": "",
"FileExt": "",
"DocumentLoaderName": "",
"TextSplitterName": "",
"GmtCreate": "",
"GmtModified": "",
"FileSize": 0,
"DocsCount": 0,
"State": 0,
"Summary": "",
"Keywords": ""
},
"Success": true,
"ErrorCode": "KnowledgeBaseNotFound",
"ErrorMessage": "Resource not found kb-***"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。
该文章对您有帮助吗?