8 答案挖掘对接

8.1 添加历史消息

接口地址

/v10/tenants/{tenantId}/unknown-question/answer-mining/chat

接口请求示例

curl -X POST \
  http://robot.easemob.com/v10/tenants/9/unknown-question/answer-mining/chat \
  -H 'Content-type: application/json' \
  -H 'token:eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjaGl4aWFveXUyMTFAMTYzLmNvbSIsImlzcyI6ImVhc2Vtb2Itcm9ib3QiLCJ0ZW5hbnRJZCI6OSwiZXhwIjoxNTIxMTY5MzM4LCJpYXQiOjE1MjA1NjQ1MzgsInVzZXJJZCI6IjFmYmNhNjE5LTZlMWItNDg2Yi1hOTdhLWE4MDc0ZjRlNzIxMSIsImp0aSI6IjQ0ZmFiYzk5LWI5MzctNDZmZi05ZTcyLTAzNDYyOWE5MDllMSIsInVzZXJuYW1lIjoiY2hpeGlhb3l1MjExQDE2My5jb20ifQ.2c7noYiWadTT84gnN4rmuyFcVRquJjt7RgaxMJgt5KE'
  -d '{
    "tenantId":9,
    "sessionId":"faeb66ce-3e5b-4dba-a879-b6e59900d4c2",
    "reset":false,
    "visitorId":"ccac956a-f9c7-4ecf-8496-881e65edf1ea",
    "agentId":"fa096ff0-cefd-4f17-bb43-e2a549aeaf07",
    "visitorNickName":"John",
    "agentNickName":"Jane",
    "messages":[
      {
        "msgId":"52f57fa0-ae96-451d-a4b7-cb715bf97326",
        "userType":"VISITOR",
        "text":"How'\''s the weather",
        "createDateTime": "2018-03-13T06:42:55.000Z"
      },
      {
        "msgId":"3022bf85-1540-4a65-9cd7-84e22ed84a75",
        "userType":"AGENT",
        "text":"Sunny",
        "createDateTime": "2018-03-13T06:42:56.000Z"
      }
    ]
  }'

请求参数说明
- tenantId:Number - 租户ID
- sessionId:String - 会话ID
- reset:Bool - 会话重置标记
- visitorId:String - 访客ID
- agentId:String - 客服ID
- visitorNickName:String - (可选)访客昵称
- agentNickName:String - (可选)客服昵称
- messages:Array of Object - 会话消息队列
  - msgId:String - 消息ID
  - userType:String - 用户类型，"VISITOR" 或 "AGENT"
  - text:String - 消息文本
  - createDateTime:String - 创建时间，格式为yyyy-MM-dd'T'HH:mm:ss'.'SSS'Z'
接口返回的ResponseBody

{
    "status": "OK",
    "errorCode": null,
    "errorDescription": null,
    "entity": true,
    "first": null,
    "last": null,
    "size": null,
    "number": null,
    "numberOfElements": null,
    "totalPages": null,
    "totalElements": null
}

接口返回参数说明
- true - 删除成功
- false - 删除失败

8.2 消息历史

接口地址

/v10/tenants/{tenantId}/unknown-question/answer-mining/chat/history/{sessionId}

接口请求示例

curl -X GET \
  http://robot.easemob.com/v10/tenants/9/unknown-question/answer-mining/chat/history/faeb66ce-3e5b-4dba-a879-b6e59900d4c2 \
  -H 'Content-type: application/json' \
  -H 'token:eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjaGl4aWFveXUyMTFAMTYzLmNvbSIsImlzcyI6ImVhc2Vtb2Itcm9ib3QiLCJ0ZW5hbnRJZCI6OSwiZXhwIjoxNTIxMTY5MzM4LCJpYXQiOjE1MjA1NjQ1MzgsInVzZXJJZCI6IjFmYmNhNjE5LTZlMWItNDg2Yi1hOTdhLWE4MDc0ZjRlNzIxMSIsImp0aSI6IjQ0ZmFiYzk5LWI5MzctNDZmZi05ZTcyLTAzNDYyOWE5MDllMSIsInVzZXJuYW1lIjoiY2hpeGlhb3l1MjExQDE2My5jb20ifQ.2c7noYiWadTT84gnN4rmuyFcVRquJjt7RgaxMJgt5KE'

请求参数说明
- tenantId:Number - 租户ID
- sessionId - 会话ID
接口返回的ResponseBody

{
    "status": "OK",
    "errorCode": null,
    "errorDescription": null,
    "entity": [
      {
        "tenantId": 9,
        "sessionId": "faeb66ce-3e5b-4dba-a879-b6e59900d4c2",
        "msgId":"52f57fa0-ae96-451d-a4b7-cb715bf97326",
        "userId": "ccac956a-f9c7-4ecf-8496-881e65edf1ea",
        "userType":"VISITOR",
        "nickName": "John",
        "contentType": "TEXT",
        "content": {
          "msg": "How&#39;s the weather",
          "type": "TEXT"
        },
        "ignored": false,
        "createDateTime": "2018-03-13T014:42:55.000Z",
        "timestamp": 1520923375,
        "orderId": 0
      },
      {
        "tenantId": 9,
        "sessionId": "faeb66ce-3e5b-4dba-a879-b6e59900d4c2",
        "msgId":"3022bf85-1540-4a65-9cd7-84e22ed84a75",
        "userId": "fa096ff0-cefd-4f17-bb43-e2a549aeaf07",
        "userType":"AGENT",
        "nickName": "Jane",
        "contentType": "TEXT",
        "content": {
          "msg": "Sunny",
          "type": "TEXT"
        },
        "ignored": false,
        "createDateTime": "2018-03-13T14:42:56.000Z",
        "timestamp": 1520923376,
        "orderId": 1
      }
    ],
    "first": null,
    "last": null,
    "size": null,
    "number": null,
    "numberOfElements": null,
    "totalPages": null,
    "totalElements": null
}

接口返回参数说明
- tenantId:Number - 租户ID
- sessionId:String - 会话ID
- msgId:String - 消息ID
- userId:String - 访客ID/客服ID，取决于userType
- userType:String - 用户类型，"VISITOR" 或 "AGENT"
- nickName:String - 访客昵称/客服昵称，取决于userType
- contentType:String - 内容类型，目前支持 "TEXT"
- content:Object - 内容
  - msg:String - 消息文本
  - type:String - 消息类型，目前支持 "TEXT"
- ignored:Number - 忽略标识
- createDateTime:String - 创建时间，格式为yyyy-MM-dd'T'HH:mm:ss'.'SSS'Z'
- timestamp:Number - 时间戳
- orderId:Number - 消息顺序号

8.3 搜索问答

接口地址

/v10/tenants/{tenantId}/unknown-question/answer-mining/qa

接口请求示例

curl -X GET \
  http://robot.easemob.com/v10/tenants/9/unknown-question/answer-mining/qa?ignored=false&question=&answer=&start_time=&end_time=&page=1&size= \
  -H 'Content-type: application/json' \
  -H 'token:eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjaGl4aWFveXUyMTFAMTYzLmNvbSIsImlzcyI6ImVhc2Vtb2Itcm9ib3QiLCJ0ZW5hbnRJZCI6OSwiZXhwIjoxNTIxMTY5MzM4LCJpYXQiOjE1MjA1NjQ1MzgsInVzZXJJZCI6IjFmYmNhNjE5LTZlMWItNDg2Yi1hOTdhLWE4MDc0ZjRlNzIxMSIsImp0aSI6IjQ0ZmFiYzk5LWI5MzctNDZmZi05ZTcyLTAzNDYyOWE5MDllMSIsInVzZXJuYW1lIjoiY2hpeGlhb3l1MjExQDE2My5jb20ifQ.2c7noYiWadTT84gnN4rmuyFcVRquJjt7RgaxMJgt5KE'

请求参数说明
- tenantId:Number - 租户ID
- ignored - 搜索已忽略问答对，默认值false
- question:String - (可选)包含问题
- answer:String - (可选)包含答案
- start_time:String - (可选)起始时间，格式为yyyy-MM-dd HH:mm:ss
- end_time:String - (可选)截止时间，格式为yyyy-MM-dd HH:mm:ss
- page:Number - (可选)页码
- size:Number - (可选)页容量，默认值20
接口返回的ResponseBody

{
    "status": "OK",
    "errorCode": null,
    "errorDescription": null,
    "entity": [{
        "tenantId": 9,
        "sessionId": "faeb66ce-3e5b-4dba-a879-b6e59900d4c2",
        "msgId": "52f57fa0-ae96-451d-a4b7-cb715bf97326",
        "visitorId": "ccac956a-f9c7-4ecf-8496-881e65edf1ea",
        "agentId": "fa096ff0-cefd-4f17-bb43-e2a549aeaf07",
        "visitorNickName": "John",
        "agentNickName": "Jane",
        "questions": ["How&#39;s the weather"],
        "answers": ["Sunny"],
        "ignored": false,
        "deleted": false,
        "createDateTime": "2018-03-13T14:42:55.000Z",
        "timestamp": 1520923375000,
        "orderId": 0,
        "docId": "9_bbdf9189-6f94-4b10-b587-94bd16ef76d2"
    }],
    "first": null,
    "last": null,
    "size": null,
    "number": null,
    "numberOfElements": null,
    "totalPages": null,
    "totalElements": null
}

接口返回参数说明
- tenantId:Number - 租户ID
- sessionId:String - 会话ID
- msgId:String - 消息ID
- visitorId:String - 访客ID
- agentId:String - 坐席ID
- visitorNickName:String - 访客昵称
- agentNickName:String - 坐席昵称
- questions: Array of String - 访客问题
- answers: Array of String - 坐席回答
- ignored:Bool - 忽略标识
- deleted:Bool - 删除标识
- createDateTime:String - 创建时间，格式为yyyy-MM-dd'T'HH:mm:ss'.'SSS'Z'
- timestamp:Number - 时间戳
- orderId:Number - 对话顺序

8.4 忽略问答

接口地址

/v10/tenants/{tenantId}/unknown-question/answer-mining/qa/{msgId}/ignore

接口请求示例

curl -X POST \
  http://robot.easemob.com/v10/tenants/9/unknown-question/answer-mining/qa/52f57fa0-ae96-451d-a4b7-cb715bf97326/ignore?ignored= \
  -H 'Content-type: application/json' \
  -H 'token:eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjaGl4aWFveXUyMTFAMTYzLmNvbSIsImlzcyI6ImVhc2Vtb2Itcm9ib3QiLCJ0ZW5hbnRJZCI6OSwiZXhwIjoxNTIxMTY5MzM4LCJpYXQiOjE1MjA1NjQ1MzgsInVzZXJJZCI6IjFmYmNhNjE5LTZlMWItNDg2Yi1hOTdhLWE4MDc0ZjRlNzIxMSIsImp0aSI6IjQ0ZmFiYzk5LWI5MzctNDZmZi05ZTcyLTAzNDYyOWE5MDllMSIsInVzZXJuYW1lIjoiY2hpeGlhb3l1MjExQDE2My5jb20ifQ.2c7noYiWadTT84gnN4rmuyFcVRquJjt7RgaxMJgt5KE'

请求参数说明
- tenantId - 租户ID
- msgId - 消息ID
- ignored - (可选)忽略问答，默认值true
接口返回的ResponseBody

{
    "status": "OK",
    "errorCode": null,
    "errorDescription": null,
    "entity": true,
    "first": null,
    "last": null,
    "size": null,
    "number": null,
    "numberOfElements": null,
    "totalPages": null,
    "totalElements": null
}

接口返回参数说明
- true - 忽略成功
- false - 忽略失败

8.5 删除问答

接口地址

/v10/tenants/{tenantId}/unknown-question/answer-mining/qa/{msgId}

接口请求示例

curl -X DELETE \
  http://robot.easemob.com/v10/tenants/9/unknown-question/answer-mining/qa/52f57fa0-ae96-451d-a4b7-cb715bf97326 \
  -H 'Content-type: application/json' \
  -H 'token:eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjaGl4aWFveXUyMTFAMTYzLmNvbSIsImlzcyI6ImVhc2Vtb2Itcm9ib3QiLCJ0ZW5hbnRJZCI6OSwiZXhwIjoxNTIxMTY5MzM4LCJpYXQiOjE1MjA1NjQ1MzgsInVzZXJJZCI6IjFmYmNhNjE5LTZlMWItNDg2Yi1hOTdhLWE4MDc0ZjRlNzIxMSIsImp0aSI6IjQ0ZmFiYzk5LWI5MzctNDZmZi05ZTcyLTAzNDYyOWE5MDllMSIsInVzZXJuYW1lIjoiY2hpeGlhb3l1MjExQDE2My5jb20ifQ.2c7noYiWadTT84gnN4rmuyFcVRquJjt7RgaxMJgt5KE'

请求参数说明
- tenantId - 租户ID
- msgId - 消息ID
接口返回的ResponseBody

{
    "status": "OK",
    "errorCode": null,
    "errorDescription": null,
    "entity": true,
    "first": null,
    "last": null,
    "size": null,
    "number": null,
    "numberOfElements": null,
    "totalPages": null,
    "totalElements": null
}

接口返回参数说明
- true - 删除成功
- false - 删除失败