Chat - 会话

Ext 字段说明

AnswerSource=BotFramework 时：

字段名	类型	描述
MATCHED_ENTRY_NAME	String	命中的触发节点名称
MATCHED_INTENT_SOURCE	String	命中的触发节点意图来源
INTENT_ID	Long	命中的意图 ID
IntentName	String	与 INTENT_NAME 相同
INTENT_DETAIL	String	意图命中的方式细节，主要在 INTENT_SOURCE=Similarity 或者 Lgf 的时候有用，当为 Similarity 时，这个字段的值就是匹配的意图话术，当为 Lgf 时，这个字段的值就是匹配的 Lgf 语法
IS_SESSION_FINISHED	Boolean	会话是否完结标志
DsScore	String	命中对话流的分数
DIALOG_ID	String	对话流 ID
FINISH_LABEL	Boolean	回复节点是否被标记为完结节点，由业务定义，常用于业务统计
MODULE_START	Boolean	是否为对话流开启意图节点
INTENT_NAME	String	命中的意图名称
INTENT_SOURCE	String	意图识别命中的来源方法，包括：Simialrity - 相似度匹配方法，Lgf - LGF 语法匹配方法，Classify - 有监督模型方法
DIALOG_NAME	String	对话流名称
DS_REPORT	Map	对话流变量配置中，勾选为“输出至报表”的变量 key value 数据
TASK_ID	String	异步服务返回的任务 ID

响应报文：

FAQ 问答-直出

{
  "QuerySegList": [
    "测试",
    "富文",
    "本"
  ],
  "Messages": [
    {
      "Knowledge": {
        "Score": 100.0,
        "Category": "第一个类目",
        "ContentType": "RICH_TEXT",
        "AnswerSource": "KnowledgeBase",
        "Content": "<p>富文本答案啊</p>",
        "Summary": "富文本答案啊",
        "Title": "测试富文本",
        "Id": "4549"
      },
      "AnswerType": "Knowledge"
    }
  ],
  "RequestId": "1b8b19de-7e6d-4e45-b7f1-9daca21af8b0",
  "SessionId": "1234",
  "MessageId": "1b8b19de-7e6d-4e45-b7f1-9daca21af8b0"
}

FAQ 问答-澄清

{
  "QuerySegList": [
    "文本"
  ],
  "Messages": [
    {
      "AnswerSource": "KNOWLEDGE",
      "Recommends": [
        {
          "Score": 46.0,
          "Title": "测试纯文本",
          "KnowledgeId": "4548"
        }
      ],
      "AnswerType": "Recommend"
    }
  ],
  "RequestId": "5af5d5f9-76b1-45e9-8003-fcd07ab9a5e4",
  "SessionId": "1234",
  "MessageId": "5af5d5f9-76b1-45e9-8003-fcd07ab9a5e4"
}

对话工厂直出

{
  "QuerySegList": [
    "查",
    "天气"
  ],
  "Messages": [
    {
      "Text": {
        "Ext": {
          "MATCHED_ENTRY_NAME": "intentWithout_city",
          "MATCHED_INTENT_SOURCE": "",
          "INTENT_ID": 724414,
          "BOT_ANSWER_SOURCE": "Lgf",
          "IntentName": "查天气意图",
          "INTENT_DETAIL": "[我想|我要]查天气",
          "LGF_EXPRESSION": "[我想|我要]查天气",
          "IS_SESSION_FINISHED": false,
          "DsScore": 100.0,
          "DIALOG_ID": "299034",
          "FINISH_LABEL": false,
          "MODULE_START": false,
          "INTENT_NAME": "查天气意图",
          "INTENT_SOURCE": "Lgf",
          "DIALOG_NAME": "示例_查天气"
        },
        "ContentType": "PLAIN_TEXT",
        "NodeName": "示例_查天气.查天气填槽.__city",
        "AnswerSource": "BotFramework",
        "Slots": [
          {
            "Origin": "",
            "Hit": false,
            "Value": "",
            "Name": "查天气意图.city"
          }
        ],
        "Score": 100.0,
        "DialogName": "示例_查天气",
        "IntentName": "查天气意图",
        "Content": "请问您要查哪里的天气？",
        "NodeId": "1410-c7a72a78.__city",
        "ExternalFlags": {
          
        }
      },
      "AnswerType": "Text"
    }
  ],
  "RequestId": "dc6757ef-9d03-4255-92ec-d262752a88ed",
  "SessionId": "1234",
  "MessageId": "dc6757ef-9d03-4255-92ec-d262752a88ed"
}

对话工厂澄清

{
  "QuerySegList": [
    "公积金"
  ],
  "Messages": [
    {
      "VoiceTitle": "请问你说的是公积金查询，还是公积金提取",
      "AnswerSource": "BotFramework",
      "Recommends": [
        {
          "Score": 0.656,
          "AnswerSource": "BotFramework",
          "Title": "公积金查询",
          "KnowledgeId": "735899"
        },
        {
          "Score": 0.634,
          "AnswerSource": "BotFramework",
          "Title": "公积金提取",
          "KnowledgeId": "735900"
        }
      ],
      "AnswerType": "Recommend"
    }
  ],
  "RequestId": "ab6be8af-cee4-40c3-9919-2ac7461d7d98",
  "SessionId": "123",
  "MessageId": "ab6be8af-cee4-40c3-9919-2ac7461d7d98"
}

意图、FAQ 混合澄清

{
  "QuerySegList": [
    "公积金"
  ],
  "Messages": [
    {
      "VoiceTitle": "请问你说的是公积金查询，还是住房公积金在个人所得税税前扣除的具体规定是什么？",
      "AnswerSource": "INTENT_FAQ_CLARIFY",
      "Recommends": [
        {
          "Score": 0.656,
          "AnswerSource": "BotFramework",
          "Title": "公积金查询",
          "KnowledgeId": "735899"
        },
        {
          "Score": 0.47410887479782104,
          "Category": "税务-12366&680 条-税款计算-居民个人取得综合所得-个人所得税专项扣除",
          "AnswerSource": "KNOWLEDGE",
          "Title": "住房公积金在个人所得税税前扣除的具体规定是什么？",
          "KnowledgeId": "7049"
        }
      ],
      "AnswerType": "Recommend"
    }
  ],
  "RequestId": "08d6bb1c-5394-4836-8e4a-86c07e7729b1",
  "SessionId": "123",
  "MessageId": "08d6bb1c-5394-4836-8e4a-86c07e7729b1"
}

闲聊

{
  "QuerySegList": [
    "你好"
  ],
  "Messages": [
    {
      "Text": {
        "ContentType": "PLAIN_TEXT",
        "AnswerSource": "ChitChat",
        "HitStatement": "你好",
        "Content": "哔~哔~哔~，我来了"
      },
      "AnswerType": "Text"
    }
  ],
  "RequestId": "8f267d8c-c118-4d6a-9ba1-2a5bdc720fed",
  "SessionId": "1234",
  "MessageId": "8f267d8c-c118-4d6a-9ba1-2a5bdc720fed"
}

全局敏感词

{
  "QuerySegList": [
    "查",
    "天气"
  ],
  "Messages": [
    {
      "Text": {
        "ContentType": "PLAIN_TEXT",
        "AnswerSource": "SENSITIVE_WORD",
        "Content": "您说的这个问题我不能回答您，您可以尝试询问其他问题"
      },
      "AnswerType": "Text"
    }
  ],
  "RequestId": "961d4187-e2e7-4463-8063-a4c79c912227",
  "SessionId": "1234",
  "MessageId": "961d4187-e2e7-4463-8063-a4c79c912227"
}

转人工

全局转人工

{
  "QuerySegList": [
    "人工"
  ],
  "Messages": [
    {
      "Text": {
        "ContentType": "PLAIN_TEXT",
        "AnswerSource": "COMMANDS",
        "Content": "正在为您转接人工客服",
        "Commands": {
          "sysToAgent": "{\"skillGroup\":\"12\"}"
        }
      },
      "Knowledge": {
        
      },
      "Type": "Text",
      "AnswerType": "Text"
    }
  ],
  "RequestId": "1ad8733a-7180-4e3b-a969-96f47d774256",
  "SessionId": "123",
  "MessageId": "fbbe0230-af14-4850-8f59-2ff60dfbf773"
}

触发对话工厂意图转人工

{
  "QuerySegList": [
    "转",
    "人工"
  ],
  "Messages": [
    {
      "Text": {
        "Ext": {
          "MATCHED_ENTRY_NAME": "转人工",
          "MATCHED_INTENT_SOURCE": "",
          "INTENT_ID": 8454,
          "BOT_ANSWER_SOURCE": "Similarity",
          "intentName": "转人工",
          "DsScore": 100.0,
          "INTENT_DETAIL": "转人工",
          "LGF_EXPRESSION": "转人工",
          "IS_SESSION_FINISHED": true,
          "dsScore": 100.0,
          "DIALOG_ID": "2529",
          "FINISH_LABEL": false,
          "IntentName": "转人工",
          "MODULE_START": true,
          "INTENT_NAME": "转人工",
          "INTENT_SOURCE": "Similarity",
          "DIALOG_NAME": "公积金转人工"
        },
        "ContentType": "PLAIN_TEXT",
        "NodeName": "公积金转人工.回复信息",
        "AnswerSource": "BotFramework",
        "Score": 100.0,
        "DialogName": "公积金转人工",
        "IntentName": "转人工",
        "Content": "这是转人工的回复",
        "Commands": {
          "sysToAgent": "{\"skillGroup\":\"8\",\"ext\":\"123\"}"
        },
        "NodeId": "i073y198",
        "ExternalFlags": {
          
        }
      },
      "Type": "Text",
      "AnswerType": "Text"
    }
  ],
  "RequestId": "1ad8733a-7180-4e3b-a969-96f47d774256",
  "SessionId": "123",
  "MessageId": "590f0434-030a-4de2-8212-bf1a96e0c687"
}

无答案

{
  "QuerySegList": [
    "公积金",
    "贷款"
  ],
  "Messages": [
    {
      "Text": {
        "ContentType": "PLAIN_TEXT",
        "AnswerSource": "NO_ANSWER",
        "Content": "我还没有学会这个问题，已经记录会尽快学习为您解答，请尝试询问我其他问题"
      },
      "AnswerType": "Text"
    }
  ],
  "RequestId": "1ad8733a-7180-4e3b-a969-96f47d774256",
  "SessionId": "1234",
  "MessageId": "1ad8733a-7180-4e3b-a969-96f47d774256"
}

机器阅读 [非标，依赖开启文档问答能力]

{
    "QuerySegList":[
        "项目",
        "备案"
    ],
    "Messages":[
        {
            "Type":"Text",
            "AnswerType": "Text",
            "Text":{
                "AnswerSource":"MACHINE_READ",
                "ArticleTitle":"备案十一",
                "Content":"四、申请接收:
申请方式:网上申请
联系电话:0571-87052724、87052837
办公地址:无
五、办理基本流程:
1、项目单位登录浙江政务服务网(http://www.zjzwfw.gov.cn)进行法人用户
注册。
2、项目单位使用法人用户账号登录浙江政务服务网投资项目在线审批监
管平台(http://tzxm.zjzwfw.gov.cn)(以下简称在线平台)。
3、项目单位选择在线平台“项目登记”中的“备案类登记”栏目,进入
备案系统。
4、填报项目备案信息
5、提交项目备案信息表,完成项目赋码
6、提交声明,完成项目备案
流程图:http://zjqlk.oss-cn-hangzhou.aliyuncs.com/c/5/53"
            }
        }
    ],
    "RequestId":"089abc58-e9ab-4aa8-86a8-70fc9d8cf0fb",
    "SessionId":"123",
    "MessageId":"089abc58-e9ab-4aa8-86a8-70fc9d8cf0fb"
}

表格问答直出[非标，依赖开启 Tableqa 能力]

{
  "QuerySegList": [
    "王珊珊",
    "的",
    "成绩"
  ],
  "Messages": [
    {
      "Text": {
        "ContentType": "PLAIN_TEXT",
        "AnswerSource": "TABLEQA",
        "Content": "姓名是王珊珊的成绩是不及格"
      },
      "AnswerType": "Text"
    }
  ],
  "RequestId": "c09d1913-dd8d-4a45-b8bd-e45e4fcf872b",
  "SessionId": "123",
  "MessageId": "c09d1913-dd8d-4a45-b8bd-e45e4fcf872b"
}

表格问答反问[非标，依赖开启 Tableqa 能力]

{
  "QuerySegList": [
    "收益率",
    "大于",
    "4",
    "的",
    "产品"
  ],
  "Messages": [
    {
      "AnswerSource": "TABLEQA",
      "Title": "请选择投资时间：",
      "Recommends": [
        {
          "Title": "1907"
        },
        {
          "Title": "31"
        },
        {
          "Title": "365"
        }
      ],
      "AnswerType": "Recommend"
    }
  ],
  "RequestId": "abef84e0-8d08-4d80-9dfb-2e958e0833ad",
  "SessionId": "1234",
  "MessageId": "abef84e0-8d08-4d80-9dfb-2e958e0833ad"
}

常见问答错误

第三方服务错误

第三方服务错误是由于在 FAQ 或对话工厂中配置了第三方服务的接口，在问答命中配置的条件或话术时，会调用对应的第三方服务。如果该服务调用错误，则会提示“Third party interface error”，具体协议如下。

响应参数说明

字段名称	字段含义
RequestId	请求 ID
HostId	云小蜜主机 ID
Code	错误码，第三方服务错误的错误码为“Third party interface error”
Message	错误说明

响应参数示例

{
    "RequestId": "A805905D-B20C-57C9-8793-EAF98FBD8F84",
    "HostId": "chatbot.cn-shanghai.aliyuncs.com",
    "Code": "Third party interface error",
    "Message": "第三方接口错误. HTTP 请求出现 IOException 异常，可能由网络链接超时，服务端未响应或其他配置问题导致, Url 信息: https://example.com/order/create",
    "Recommend": "https://next.api.aliyun.com/troubleshoot?q=Third party interface error&product=Chatbot"
}