文档首页 > > API参考> 问答机器人> 问答统计API>

热点问题统计

热点问题统计

分享
更新时间:2021/03/23 GMT+08:00

功能介绍

获取热点问题列表。

按标准问被用户问及的频率降序排列

URI

  • URI格式

    GET /v1/{project_id}/qabots/{qabot_id}/qa-pairs/hots?start_time={start_time}&end_time={end_time}&top={top}&domain_id={domain_id}

  • 参数说明
表1 URI参数说明

名称

是否必选

说明

project_id

来自公有云的Project ID,用于资源隔离。

qabot_id

qabot编号,UUID格式,如:303a0a00-c88a-43e3-aa2f-d5b8b9832b02。

获取方法:

登录对话机器人服务控制台,在智能问答机器人列表中查看qabot_id。

start_time

查询的起始时间,long,utc时间,默认值为0。

end_time

查询的结束时间,long,utc时间,默认值为当前时间的毫秒数。

top

热点问题最多显示的个数,默认值为10,取值范围1-20

exclude

true:根据问答对信息展示热点问题(如:热点问题对应的问答对“你好”发生了修改,变成了 “你好啊”,此时热点问题也将返回 “你好啊”;但是如果这个问题对被删除,则“你好”不会被展示在热点问中)

false: 不根据问答对信息展示热点问题。

domain_id

统计的目标问题类别id。

请求消息

GET https://cbs-ext.cn-north-4.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/qa-pairs/hots 
Request Header: 
Content-Type: application/json 
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应消息

响应参数如表2所示。

表2 响应参数

名称

参数类型

说明

questions

Array of Object

指定时间范围内,热点问题列表,具体参见表3

调用失败时无此字段。

error_code

String

调用失败时的错误码,具体参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

表3 questions字段数据结构

名称

参数类型

说明

qa_pair_id

String

问答对Id。

st_question

String

标准问题。

domain

String

标准问题所属领域。

freq

long

热点问题频次。

示例

热点问题统计。

  • 请求示例
    GET https://cbs-ext.cn-north-4.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/qa-pairs/hots
    
    Request Header:  
    Content-Type: application/json
    X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  • Python语言请求代码示例
    import requests
    url = "https://{endpoint}/v1/{project_id}/qabots/{qabot_id}/qa-pairs/hots?start_time={start_time}&end_time={end_time}&top={top}&domain={domain}"
    token = "用户获取得到的实际token值"
    headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
    
    response = requests.get(url, headers=headers, json=body, verify=False)
    print(response.text)
  • 响应示例
    • 成功响应示例
      {
            "questions":
       [
              {
                   "qa_pair_id":"xxxxxxxxxxx",
                   "st_question":"桌面云打不开",
                   "domain":"桌面云"
               },
              {
                    "qa_pair_id":"xxxxxxxxxxx",
                    "st_question":"桌面云无法登陆",
                    "domain":"桌面云"
               }
         ]
      }

    • 失败响应示例
      {
          "error_code":"CBS.0021",
          "error_msg":"request parameter error"
      }

状态码

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品