文档

UploadDataSync - 文本实时质检

更新时间:

文本实时质检。

接口说明

将特定格式的待检文本数据推送到 SCA,根据用户指定的规则对文本数据进行实时质检分析,并同步返回分析结果。相比于上传文本质检,上传文本质检通常是一个对话结束后,将完整的对话文本上传,而文本实时质检,可以在一个角色讲完一句话或多句话后,就推送到 SCA 进行分析,实时性更高。特殊说明:

  • 如果推送的文本是一个角色的一句话,因为缺少对话上下文,规则中的部分算子会失效,例如上下文重复检查、抢话检查、通话静音检查等。
  • 实时质检会同步返回分析结果,SCA 不会保存调用记录,所以无法通过 API 查询质检结果。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
JsonStrstring

jsonStr 是一个 JSON 字符串,里面是该接口所有的自定义参数,具体内容参见下方的jsonStr 属性说明

{"tickets":xxx}
BaseMeAgentIdlong

业务空间 Id

jsonStr 属性说明:

属性值类型是否必须说明
ticketsList待检文本数据信息,一次调用可以上传多段文本数据,详见下方的tickets 属性说明
commonRuleIdsList指定规则 ID,若不指定,则使用所有规则进行分析,如果规则总数大于 100,则最多使用规则列表前 100 条规则进行分析。强烈建议您指定质检规则,否则每次都使用大量规则进行分析,会增加接口返回的延时。(只能使用离线质检规则,不可使用实时质检规则)

tickets 属性说明:

属性值类型是否必须说明
tidString本段文本的 ID,可以使用对应的电话或工单数据 ID,注意不要重复。
dialogueList本段文本对话的详细内容,详见下方的dialogue 属性说明

dialogue 属性说明:

属性值类型是否必须说明
roleString对话内容角色,取值:客服、客户。
identityString对话角色的具体身份标识。
wordsString这个角色说的一句话。
beginInteger本句话的开始时间,是相对起始点的开始时间偏移,单位 ms。
endInteger本句话的结束时间,是相对起始点的结束时间偏移,单位 ms。
beginTimeDate这句话的开始时间,示例值:2019-11-25 15:37:16。

返回参数

名称类型描述示例值
object
Codestring

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

200
Messagestring

出错时表示出错详情,成功时为 successful

successful
RequestIdstring

请求 ID。

4987D326-83D9-4A42-B9A5-0B27F9B***
Successboolean

请求是否成功,调用方可根据此字段来判断请求是否成功:true 表示成功;false/null 表示失败。

true
Dataobject []

实时质检结果。

Scoreinteger

质检得分,默认为 100 分,会根据规则所关联的评分项进行加减分。

100
Rulesobject []

命中详情。

Tidstring

文本 ID,对应的是请求参数 tickets 中的 tid。

88888888
Ridstring

命中的规则 ID。

801
Hitobject []

具体命中位置信息,以句子维度,返回命中句子中具体命中了什么规则中哪个条件,是哪几个字命中的。

HitKeyWordsobject []

返回当前句中是哪几个字命中了规则,也就是需要高亮展示的关键字。

Tointeger

需要高亮展示的关键字到第几个字符结束,最大值为当句话字符总数减 1。高亮的字不包含 to,例如一句话为“不可能给你退货的”,from=0,to=3,那么需要高亮的关键字就是“不可能”三个字。

1
Frominteger

需要高亮展示的关键字从第几个字符开始,取值范围从 0 开始,最大值为当句话字符总数减 1。高亮的字包含 from。

1
Valstring

具体的关键字内容。

Tidstring

文本 ID,对应的是请求参数 tickets 中的 tid。

1
Pidinteger

当前句子在所有句子中的下标值,即当前句子是请求参数中 dialogue 数组中的第几个,从 0 开始。

1
HitCidsarray

当前句子命中的条件 ID 的列表。

string

当前句子命中的条件 ID 的列表。

["3265"]
Phraseobject

当前命中规则的句子详情。

Wordsstring

这个角色说的一句话。

你好
Identitystring

对话角色的具体身份标识。

1
Beginlong

本句话的开始时间,是相对起始点的开始时间偏移,单位 ms。

0
BeginTimestring

这句话的开始时间,示例值:2019-11-25 15:37:16。

1564574
Endlong

本句话的结束时间,是相对起始点的结束时间偏移,单位 ms。

2090
Rolestring

对话内容角色,可能值:客服、客户、系统。

客服
ConditionInfoobject []

废弃字段,请忽略。

ConditionInfoCidstring

废弃字段,请忽略。

xxx
HandScoreIdListarray

废弃字段,请忽略。

string

废弃字段,请忽略。

[]

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "4987D326-83D9-4A42-B9A5-0B27F9B***",
  "Success": true,
  "Data": {
    "ResultInfo": [
      {
        "Score": 100,
        "Rules": {
          "RuleHitInfo": [
            {
              "Tid": "88888888",
              "Rid": "801",
              "Hit": {
                "ConditionHitInfo": [
                  {
                    "HitKeyWords": {
                      "HitKeyWord": [
                        {
                          "To": 1,
                          "From": 1,
                          "Val": "嗯",
                          "Tid": "1",
                          "Pid": 1
                        }
                      ]
                    },
                    "HitCids": {
                      "CidItem": [
                        "[\"3265\"]"
                      ]
                    },
                    "Phrase": {
                      "Words": "你好",
                      "Identity": "1",
                      "Begin": 0,
                      "BeginTime": "1564574",
                      "End": 2090,
                      "Role": "客服"
                    }
                  }
                ]
              },
              "ConditionInfo": {
                "ConditionBasicInfo": [
                  {
                    "ConditionInfoCid": "xxx"
                  }
                ]
              }
            }
          ]
        },
        "HandScoreIdList": {
          "HandScoreIdList": [
            "[]"
          ]
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)
文档反馈