调用 UploadDataSync.json 进行文本实时质检。

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

• 如果推送的文本是一个角色的一句话,因为缺少对话上下文,规则中的部分算子会失效,例如 上下文重复检查、抢话检查、通话静音检查 等。

• 实时质检会同步返回分析结果,SCA不会保存调用记录,所以无法通过API查询质检结果。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String UploadDataSync

系统规定参数。取值:UploadDataSync

JsonStr String {"tickets":xxx}

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

jsonStr属性说明:

属性

值类型

是否必须

说明

tickets

List

待检文本数据信息,一次调用可以上传多段文本数据,详见下方的 tickets 属性说明

commonRuleIds

List

指定规则ID,若不指定,则使用所有规则进行分析,如果规则总数大于100,则最多使用规则列表前100条规则进行分析。强烈建议您指定质检规则,否则每次都使用大量规则进行分析,会增加接口返回的延时。

tickets 属性说明:

属性

值类型

是否必须

说明

tid

String

本段文本的ID,可以使用对应的的电话或工单数据ID,注意不要重复。

dialogue

List

本段文本对话的详细内容,详见下方的 dialogue 属性说明

dialogue 属性说明:

属性

值类型

是否必须

说明

role

String

对话内容角色,取值:客服、客户。

identity

String

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

words

String

这个角色说的一句话。

begin

Integer

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

end

Integer

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

beginTime

Date

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

返回数据

名称 类型 示例值 描述
Code String 200

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

Data Array of ResultInfo

实时质检结果。

ResultInfo
HandScoreIdList List []

废弃字段,请忽略。

Rules Array of RuleHitInfo

命中详情。

RuleHitInfo
ConditionInfo Array of ConditionBasicInfo

废弃字段,请忽略。

ConditionBasicInfo
ConditionInfoCid String xxx

废弃字段,请忽略。

Hit Array of ConditionHitInfo

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

ConditionHitInfo
HitCids List ["3265"]

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

HitKeyWords Array of HitKeyWord

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

HitKeyWord
From Integer 1

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

Pid Integer 1

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

Tid String 1

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

To Integer 1

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

Val String

具体的关键字内容。

Phrase Struct

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

Begin Long 0

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

BeginTime String 1564574

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

End Long 2090

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

Identity String 1

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

Role String 客服

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

Words String 你好

这个角色说的一句话。

Rid String 801

命中的规则ID。

Tid String 88888888

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

Score Integer 100

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

Message String successful

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

RequestId String 4987D326-83D9-4A42-B9A5-0B27F9B***

请求ID。

Success Boolean true

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

示例

请求示例

http(s)://qualitycheck.cn-hangzhou.aliyuncs.com/?Action=UploadDataSync
&JsonStr={"tickets":xxx}
&<公共请求参数>

正常返回示例

XML 格式

<UploadDataSyncResponse>
      <Message>successful</Message>
      <RequestId>4EFC3224-4E25-4019-AD06-63AC0***</RequestId>
      <Data>
            <ResultInfo>
                  <Rules>
                        <RuleHitInfo>
                              <Hit>
                                    <ConditionHitInfo>
                                          <HitKeyWords>
                                                <HitKeyWord>
                                                      <Val>你好</Val>
                                                      <Pid>1</Pid>
                                                      <From>2</From>
                                                      <To>4</To>
                                                      <Tid>4ef4f8a9-4910-4d46-a348-eabfb***</Tid>
                                                </HitKeyWord>
                                          </HitKeyWords>
                                          <HitCids>
                                                <CidItem>24196</CidItem>
                                          </HitCids>
                                          <Phrase>
                                                <Role>客服</Role>
                                                <Words>哎,你好。</Words>
                                                <Begin>3820</Begin>
                                                <End>4830</End>
                                                <Identity>某客服</Identity>
                                          </Phrase>
                                    </ConditionHitInfo>
                              </Hit>
                              <Rid>15589</Rid>
                        </RuleHitInfo>
                        <RuleHitInfo>
                              <Hit>
                                    <ConditionHitInfo>
                                          <HitKeyWords>
                                                <HitKeyWord>
                                                      <Val>帮您</Val>
                                                      <Pid>2</Pid>
                                                      <From>5</From>
                                                      <To>7</To>
                                                      <Tid>4ef4f8a9-4910-4d46-a348-eabfb8e***</Tid>
                                                </HitKeyWord>
                                          </HitKeyWords>
                                          <HitCids>
                                                <CidItem>28208</CidItem>
                                          </HitCids>
                                          <Phrase>
                                                <Role>客服</Role>
                                                <Words>有什么可以帮您。</Words>
                                                <Begin>6770</Begin>
                                                <End>8540</End>
                                                <Identity>某客服</Identity>
                                          </Phrase>
                                    </ConditionHitInfo>
                              </Hit>
                              <Rid>18128</Rid>
                        </RuleHitInfo>
                  </Rules>
                  <Tid>4ef4f8a9-4910-4d46-a348-eabfb8***</Tid>
            </ResultInfo>
      </Data>
      <Code>200</Code>
      <Success>true</Success>
</UploadDataSyncResponse>

JSON 格式

{
    "Message":"successful",
    "RequestId":"4EFC3224-4E25-4019-AD06-63AC0***",
    "Data":{
        "ResultInfo":[
            {
                "Rules":{
                    "RuleHitInfo":[
                        {
                            "Hit":{
                                "ConditionHitInfo":[
                                    {
                                        "HitKeyWords":{
                                            "HitKeyWord":[
                                                {
                                                    "Val":"你好",
                                                    "Pid":1,
                                                    "From":2,
                                                    "To":4,
                                                    "Tid":"4ef4f8a9-4910-4d46-a348-eabfb***"
                                                }
                                            ]
                                        },
                                        "HitCids":{
                                            "CidItem":[
                                                "24196"
                                            ]
                                        },
                                        "Phrase":{
                                            "Role":"客服",
                                            "Words":"哎,你好。",
                                            "Begin":3820,
                                            "End":4830,
                                            "Identity":"某客服"
                                        }
                                    }
                                ]
                            },
                            "Rid":"15589"
                        },
                        {
                            "Hit":{
                                "ConditionHitInfo":[
                                    {
                                        "HitKeyWords":{
                                            "HitKeyWord":[
                                                {
                                                    "Val":"帮您",
                                                    "Pid":2,
                                                    "From":5,
                                                    "To":7,
                                                    "Tid":"4ef4f8a9-4910-4d46-a348-eabfb8e***"
                                                }
                                            ]
                                        },
                                        "HitCids":{
                                            "CidItem":[
                                                "28208"
                                            ]
                                        },
                                        "Phrase":{
                                            "Role":"客服",
                                            "Words":"有什么可以帮您。",
                                            "Begin":6770,
                                            "End":8540,
                                            "Identity":"某客服"
                                        }
                                    }
                                ]
                            },
                            "Rid":"18128"
                        }
                    ]
                },
                "Tid":"4ef4f8a9-4910-4d46-a348-eabfb8***"
            }
        ]
    },
    "Code":"200",
    "Success":true
}

错误码

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