文档首页 > > API参考> 问答机器人> 其他问答API> 获取问题提示

获取问题提示

分享
更新时间:2020/08/17 GMT+08:00

功能介绍

获取用户输入问题的提示问题列表。

URI

  • URI格式
    POST /v1/{project_id}/qabots/{qabot_id}/suggestions
  • 参数说明
    表1 URI参数说明

    名称

    是否必选

    说明

    project_id

    项目ID,用于资源隔离。请参见获取项目ID

    qabot_id

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

    进入问答机器人的Console界面,在“机器人名称/ID”列显示对应的qabot_id。

请求消息

请求参数如表2所示。

表2 参数说明

名称

参数类型

是否必选

说明

question

String

用户输入的问题,如果输入的question为空字符串返回结果为空。

top

Integer

最多提示条数,默认为5,取值范围[1,1000]。

响应消息

响应参数如表3所示。
表3 响应参数

名称

参数类型

说明

questions

String

调用成功时的返回结果。

调用失败时无此字段。

error_code

String

调用失败时的错误码。

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

示例

  • 请求示例
    POST https://{endpoint}/v1/41551a23c2be484cb0070631e323ee52/qabots/b36a01da-7fc2-43f8-8990-218e57a94420/suggestions
    
    Request Header:
        Content-Type: application/json
        X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
    
    Request Body:
    {
        "question":"桌面云",
        "top":2
    }
  • 响应示例
    • 成功响应示例
      {
          "questions":[
             "桌面云打不开",
             "桌面云无法登录"
          ]
      }
    • 失败响应示例
      {
        "error_code": "CBS.0022",
        "error_msg": "question can not be null"
      }

状态码

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问