UpdateDocument-阿里云帮助中心

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
KbUuid	string	Yes	The ID of the knowledge base.	kb-***
DocumentName	string	Yes	The document name.	test.md
NewDescription	string	Yes	The new document description.	test123

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The unique ID of the request. Use this ID for troubleshooting.	67E910F2-4B62-5B0C-ACA3-7547695C****
Data	OneMetaKnowledgeBaseDocument	The response object.
Success	boolean	Indicates whether the request was successful. Valid values: true: The request succeeded. false: The request failed.	true
ErrorCode	string	The error code for a failed request.	KnowledgeBaseNotFound
ErrorMessage	string	The error message for a failed request.	Resource not found kb-***

Examples

Success response

JSON format

{
  "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-***"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.