# 问答统计 #### 功能介绍 获取指定时间范围内的问题答复统计，支持按周期统计。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=CBS&api=CollectReplyRates)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI GET https://{endpoint}/v1/{project_id}/qabots/{qabot_id}/requests/reply-rates?start_time={start_time}\&end_time={end_time}\&interval={interval}\&time_zone={time_zone}\&domain={domian} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | endpoint | 是 | String | 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从[终端节点](https://support.huaweicloud.com/api-cbs/cbs_03_0102.html)中获取。 例如，CBS服务在"华北-北京四"区域的"endpoint"为"cbs-ext.cn-north-4.myhuaweicloud.com"。 | | project_id | 是 | String | 项目ID，用于资源隔离。请参见[获取项目ID](https://support.huaweicloud.com/api-cbs/cbs_03_0069.html)。 | | qabot_id | 是 | String | qabot编号，UUID格式，如：303a0a00-c88a-43e3-aa2f-d5b8b9832b02。 获取方法： 登录对话机器人服务控制台，在智能问答机器人列表中查看qabot_id。 ![](https://support.huaweicloud.com/api-cbs/zh-cn_image_0000001166713691.png "点击放大") | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain | 否 | String | 问题类别。 | | end_time | 否 | String | 查询的结束时间，long，UTC时间，采用毫秒时间戳，默认值为当前时间的毫秒数。 | | interval | 否 | String | 统计周期目前支持year，month，week，day。 | | start_time | 否 | String | 查询的起始时间，long，UTC时间，采用毫秒时间戳，默认值为0。 | | time_zone | 否 | String | 请求所在时区，例如：中国东八区为"+08:00"；美国西五区为"-05:00"；默认为"UTC"。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 用于获取操作API的权限。[获取Token接口](https://support.huaweicloud.com/api-cbs/cbs_03_0006.html)响应消息头中X-Subject-Token的值即为Token。 | | Content-Type | 是 | String | 消息体的类型（格式），参数值为"application/json"。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | startutc | Long | 统计开始时间。调用失败时无此字段。 | | endutc | Long | 统计结束时间。调用失败时无此字段。 | | interval | String | 统计周期目前支持year、month、week、day。调用失败时无此字段。 | | time_zone | String | 所在时区，例如：中国东八区为"+08:00"；美国西五区为"-05:00"；默认为"UTC"。调用失败时无此字段。 | | total | [ReplyRatesTotal] object | 总计答复率统计数据。调用失败时无此字段。 | | intervals | Array of [ReplyRatesIntervals] object | 按时间间隔答复率统计数据。调用失败时无此字段。 | 表5ReplyRatesTotal | 参数 | 参数类型 | 描述 | |:---|:---|:---| | question_count | Long | 用户提问总数。 | | direct_count | Long | 直接回答个数。 | | recommend_count | Long | 推荐回答个数。 | | notmatch_count | Long | 未匹配个数。 | | direct_rate | Double | 直接回答比率，保留小数点后三位。 | | recommend_rate | Double | 推荐回答比率，保留小数点后三位。 | | notmatch_rate | Double | 未匹配比率，保留小数点后三位。 | | dialog_count | Long | 多轮对话次数。 | | dialog_rate | Double | 多轮对话比例。 | | invalid_count | Long | 无效问题次数。 | | invalid_rate | Double | 无效问题比例。 | | chat_count | Long | 闲聊匹配次数。 | | chat_rate | Double | 闲聊比例。 | 表6ReplyRatesIntervals | 名称 | 参数类型 | 说明 | |:---|:---|:---| | start | String | 间隔周期开始时间。 | | question_count | Long | 间隔周期用户提问总数。 | | direct_count | Long | 间隔周期直接回答个数。 | | recommend_count | Long | 间隔周期推荐回答个数。 | | notmatch_count | Long | 间隔周期未匹配个数。 | | invalid_count | Long | 间隔周期无效问题个数。 | | chat_count | Long | 间隔周期闲聊匹配个数。 | | direct_rate | Double | 间隔周期直接回答比率，保留小数点后三位。 | | recommend_rate | Double | 间隔周期推荐回答比率，保留小数点后三位。 | | notmatch_rate | Double | 间隔周期未匹配比率，保留小数点后三位。 | | chat_rate | Double | 间隔周期闲聊匹配比率，保留小数点后三位。 | | invalid_rate | Double | 间隔周期无效问题比率，保留小数点后三位。 | | dialog_count | Long | 多轮会话次数。 | | dialog_rate | Double | 多轮会话比例。 | **状态码： 400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 调用失败时的错误码。 调用成功时无此字段。 | | error_msg | String | 调用失败时的错误信息。 调用成功时无此字段。 | #### 请求示例 - 获取指定时间范围内的问题答复统计 ``` GET https://cbs-ext.cn-north-4.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/requests/reply-rates?interval=day&time_zone=%2B08%3A00 Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... ``` - Python语言请求代码示例 ``` import requests url = "https://{endpoint}/v1/{project_id}/qabots/{qabot_id}/requests/reply-rates?start_time={start_time}&end_time={end_time}&interval={interval}&time_zone={time_zone}" token = "用户获取得到的实际token值" headers = {'Content-Type': 'application/json', 'X-Auth-Token': token} response = requests.get(url, headers=headers, json=body, verify=False) print(response.text) ``` - Java语言请求代码示例 ``` import java.io.BufferedReader; import java.io.InputStream; import java.io.InputStreamReader; import java.net.HttpURLConnection; import java.net.URL; public class CBSDemo { public void cbsDemo() { try { //endpoint、projectId、qabot_id等需要替换成实际信息。 URL url = new URL("https://{endpoint}/v1/{project_id}/qabots/{qabot_id}/requests/reply-rates?start_time={start_time}&end_time={end_time}&interval={interval}&time_zone={time_zone}"); String token = "用户获取得到的实际token值"; HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setDoInput(true); connection.setDoOutput(false); connection.addRequestProperty("Content-Type", "application/json"); connection.addRequestProperty("X-Auth-Token", token); InputStream is = connection.getInputStream(); BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8")); while (br.ready()) { System.out.println(br.readLine()); } } catch (Exception e) { e.printStackTrace(); } } public static void main(String[] args) { CBSDemo CBSDemo = new CBSDemo(); CBSDemo.cbsDemo(); } } ``` #### 响应示例 **状态码：200** 成功响应示例 ``` { "interval":"day", "startutc":1613059200000, "endutc":1613720547615, "time_zone":"+08:00", "total": { "question_count":179, "direct_count":86, "recommend_count":4, "notmatch_count":85, "chat_count":0, "invalid_count":2, "dialog_count":2, "direct_rate":0.480, "recommend_rate":0.022, "notmatch_rate":0.475, "dialog_rate":0.011, "chat_rate":0.000, "invalid_rate":0.011 }, "intervals":[ { "start":"2021-02-14", "question_count":28, "direct_count":7, "recommend_count":0, "notmatch_count":21, "chat_count":0, "invalid_count":0, "dialog_count":0, "direct_rate":0.250, "recommend_rate":0.000, "notmatch_rate":0.750, "dialog_rate":0.000, "chat_rate":0.000, "invalid_rate":0.000 }, { "start":"2021-02-15", "question_count":2, "direct_count":0, "recommend_count":0, "notmatch_count":2, "chat_count":0, "invalid_count":0, "dialog_count":0, "direct_rate":0.000, "recommend_rate":0.000, "notmatch_rate":1.000, "dialog_rate":0.000, "chat_rate":0.000, "invalid_rate":0.000 }, { "start":"2021-02-19", "question_count":149, "direct_count":79, "recommend_count":4, "notmatch_count":62, "chat_count":0, "invalid_count":2, "dialog_count":2, "direct_rate":0.530, "recommend_rate":0.027, "notmatch_rate":0.416, "dialog_rate":0.013, "chat_rate":0.000, "invalid_rate":0.013 } ] } ``` **状态码：400** 失败响应示例 ``` { "error_code":"CBS.0021", "error_msg":"request parameter error" } ``` #### 状态码 状态码请参见[状态码](https://support.huaweicloud.com/api-cbs/cbs_03_0054.html)。 #### 错误码 错误码请参见[错误码](https://support.huaweicloud.com/api-cbs/cbs_03_0053.html)。