DescribeKnowledgeBaseStats-阿里云帮助中心

Retrieves the statistics of a knowledge base.

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 parameters

Parameter	Type	Required	Description	Example
KbUuid	string	Yes	The ID of the knowledge base.	kb-***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The unique ID of the request. Use this ID to troubleshoot errors.	67E910F2-4B62-5B0C-ACA3-7547695C****
Data	object	The object that contains the knowledge base statistics.
KbUuid	string	The ID of the knowledge base.	kb-***
TotalFileSize	integer	The total size of all files in the knowledge base, in bytes.	4194588751
DocumentCount	integer	The number of documents in the knowledge base.	100
TotalChunkCount	integer	The total number of knowledge chunks in the knowledge base.	10
KbHits	integer	The number of hits for the knowledge base.	18
Success	boolean	Indicates whether the request succeeded. A value of `true` indicates success, and a value of `false` indicates failure.	true
ErrorCode	string	The error code returned if the request fails.	Permission denied.
ErrorMessage	string	The error message returned if the request fails.	Knowledge base limit exceeded. Current: xxx

Examples

Success response

JSON format

{
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Data": {
    "KbUuid": "kb-***",
    "TotalFileSize": 4194588751,
    "DocumentCount": 100,
    "TotalChunkCount": 10,
    "KbHits": 18
  },
  "Success": true,
  "ErrorCode": "Permission denied.",
  "ErrorMessage": "Knowledge base limit exceeded. Current: xxx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.