DescribeKnowledgeBaseStats - 获取知识库的统计信息

更新时间:
复制 MD 格式

获取知识库的统计信息

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

KbUuid

string

知识库 ID

kb-***

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

本次调用的唯一 ID。出现错误后,您可以根据该 ID 排查问题。

67E910F2-4B62-5B0C-ACA3-7547695C****

Data

object

返回的结构体

KbUuid

string

知识库 ID

kb-***

TotalFileSize

integer

知识库中的文件总大小,单位:字节

4194588751

DocumentCount

integer

知识库文档数

100

TotalChunkCount

integer

知识库总知识块数目

10

KbHits

integer

知识库命中数

18

Success

boolean

请求是否成功,返回值如下:true:请求成功 false:请求失败

true

ErrorCode

string

错误码,请求异常时返回。

Permission denied.

ErrorMessage

string

调用失败时,返回的错误信息。

Knowledge base limit exceeded. Current: xxx

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情