问答请求

功能介绍

问答服务的输入为用户提问，输出是与输入最匹配的Top N(默认为top5)个知识点，知识点按得分从高到低排序。

说明：

返回知识点如果含有答案字段（answer），则表示返回匹配成功结果，如果没有答案字段，则表示推荐结果。

URI

• URI格式

  POST /v1/{project_id}/qabots/{qabot_id}/requests

• 参数说明

  表1 URI参数说明

  名称	是否必选	说明
  project_id	是	项目ID，用于资源隔离。
  qabot_id	是	qabot编号，UUID格式，如：303a0a00-c88a-43e3-aa2f-d5b8b9832b02。

请求消息

请求参数如表2所示。

响应消息

示例

• 请求示例

  POST https://{endpoint}/v1/1604d8170cd84440a81281e5a3a04f8b/qabots/303a0a00-c88a-43e3-aa2f-d5b8b9832b02/requests
  Request Header:
  Content-Type: application/json
  X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  Request Body:
  {
      "user_id": "z00123456",
      "session_id": "xxxxxxxxxxxxxxxxxx",
      "operate_type":3,      
      "question": "桌面云无法登陆"
  }

• 响应示例
  • 成功响应示例

    1. 关闭内置阈值处理（设置threshold_enable = false），按top个数返回结果数量。

    { 
        "request_id": "303a0a00-c88a",
        "question": "桌面云打不开",
        "answers": [
            {
                "qa_pair_id":"123",
                "st_question":"桌面云打开不了",
                "answer":"用户账号不对",
                "score":0.952,
                "domain":"桌面云"
         },
         {
                "qa_pair_id":"123",
                "st_question":"桌面云打开不了了",
                "answer":"用户账号不对",        
                "score":0.901,
                "domain":"桌面云"
            },
            {
                "qa_pair_id":"123",
                "st_question":"桌面云是啥",
                "answer":"桌面云是可以远程办公的系统",      
                "score":0.352,
                "domain":"桌面云"
            },
         {
                "qa_pair_id":"123",
                "st_question":"电脑桌面打不开",
                "answer":"请检查下显示器是否开启",    
                "score":0.352,
                "domain":"桌面云"
            },
        ]
    }

    2. 开启内部阈值处理。

    表6 内部阈值处理

    序列	处理条件	结果
    例1	分值最高的问答对分数高于设定阈值θ（默认模型为0.4）。	只返分值最高的问答对。表示精确匹配。
    例2	分值最高的问答对分数高于θ低于 θ/2。	返回该问答对和分值高于θ/3的若干个推荐问（推荐问为去除答案的问答对）。
    例3	分值最高的问答对分数高于低于 θ/2高于 θ/3。	返回分值处于θ/2~ θ/3 的推荐问。

    例1：

    { 
        "request_id": "303a0a00-c88a",
        "question": "桌面云打不开",
        "answers": [
            {
                "qa_pair_id":"123",
                "st_question":"桌面云打开不了",
                "answer":"用户账号不对",
                "top_score_question":"桌面云打开不了",
                "score":0.952,
                "domain":"桌面云"
            }
        ]
    }

    例2：

    { 
        "request_id": "303a0a00-c88a",
        "question": "桌面云打不开",
        "answers": [
            {
                "qa_pair_id":"123",
                "st_question":"桌面云打开不了",
                "top_score_question":"桌面云打开不了",
                "answer":"用户账号不对",
                "score":0.352,
                "domain":"桌面云"
            }
        {
                "qa_pair_id":"123",
                "st_question":"桌面云打开不了了",     
                "score":0.301,
                "domain":"桌面云"
            },
            {
                "qa_pair_id":"123",
                "st_question":"桌面云是啥",    
                "score":0.252,
                "domain":"桌面云"
            }
        ]
    }

    例3：

    { 
        "request_id": "303a0a00-c88a",
        "question": "桌面云打不开",
        "answers": [
        {
                "qa_pair_id":"123",
                "st_question":"桌面云打开不了了",     
                "score":0.291,
                "domain":"桌面云"
            },
            {
                "qa_pair_id":"123",
                "st_question":"桌面云是啥",    
                "score":0.252,
                "domain":"桌面云"
            }
        ]
    }

    3. 闲聊兜底或无答案回复。

    { 
        "request_id": "303a0a00-c88a",
        "question": "你好",
        "answers": [
        {
                "answer":"您好，请问有什么可以帮您的吗?"
                
            }
        ]
    }

  • 失败响应示例

    {
      "error_code": "CBS.0022",
      "error_msg": "session_id can not be null"
    }

状态码

状态码请参见状态码。