大模型实时文本质检。
接口说明
将特定格式的待检文本数据推送到 SCA，根据用户指定的规则对文本数据进行实时质检分析，并同步返回分析结果。相比于上传文本质检，上传文本质检通常是一个对话结束后，将完整的对话文本上传，而文本实时质检，可以在一个角色讲完一句话或多句话后，就推送到 SCA 进行分析，实时性更高。特殊说明：
如果推送的文本是一个角色的一句话，因为缺少对话上下文，规则中的部分算子会失效，例如上下文重复检查、抢话检查、通话静音检查等。 实时质检会同步返回分析结果，SCA 不会保存调用记录，所以无法通过 API 查询质检结果。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| JsonStr |
string |
是 |
完整 JSON 字符串信息，具体内容参见以下详细信息。 |
{\"tickets\":[{\"dialogue\":[{\"role\":\"客服\",\"words\":\"有的\",\"end\":0,\"beginTime\":1783909236618,\"begin\":0}],\"tid\":\"20260713-20240612032225161783909236618\"}],\"commonRuleIds\":[\"20773\"]} |
| BaseMeAgentId |
integer |
否 |
业务空间 Id |
123456 |
jsonStr 属性说明：
| 属性 | 值类型 | 是否必须 | 说明 |
| tickets | List | 是 | 待检文本数据信息，一次调用可以上传多段文本数据，详见下方的tickets 属性说明。 |
| commonRuleIds | List | 否 | 指定规则 ID，若不指定，则使用所有规则进行分析，如果规则总数大于 100，则最多使用规则列表前 100 条规则进行分析。强烈建议您指定质检规则，否则每次都使用大量规则进行分析，会增加接口返回的延时。 |
| isSimpleLlmResponseFormat | Boolean | 否 | 是否简化大模型输出。为 true 时，结果仅包含维度名称和是否命中。 |
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。 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
结果代码，200 表示成功，若为别的值则表示失败，调用方可根据此字段判断失败原因。 |
200 |
| Message |
string |
出错时表示出错详情，成功时为 successful。 |
successful |
| RequestId |
string |
请求 ID |
3CEA0495-341B-4482-9AD9-8191EF4*** |
| Success |
boolean |
请求是否成功，调用方可根据此字段来判断请求是否成功：true 表示成功；false/null 表示失败 |
true |
| Data |
object |
||
| ResultInfo |
array<object> |
实时质检结果。 |
|
|
array<object> |
质检结果。 |
||
| Score |
integer |
质检得分，默认为 100 分，会根据规则所关联的评分项进行加减分。 |
16 |
| Rules |
object |
||
| RuleHitInfo |
array<object> |
命中详情。 |
|
|
array<object> |
规则列表。 |
||
| Tid |
string |
文本 ID，对应的是请求参数 tickets 中的 tid。 |
79127 |
| Rid |
string |
命中的规则 ID。 |
25372 |
| Name |
string |
规则名称 |
脏话检测 |
| Hit |
object |
||
| ConditionHitInfo |
array<object> |
具体命中位置信息，以句子维度，返回命中句子中具体命中了什么规则中哪个条件，是哪几个字命中的。 |
|
|
array<object> |
|||
| HitKeyWords |
object |
||
| HitKeyWord |
array<object> |
返回当前句中是哪几个字命中了规则，也就是需要高亮展示的关键字。 |
|
|
object |
条件命中的关键词。 |
||
| To |
integer |
需要高亮展示的关键字到第几个字符结束，最大值为当句话字符总数减 1。高亮的字不包含 to，例如一句话为“不可能给你退货的”，from=0，to=3，那么需要高亮的关键字就是“不可能”三个字。 |
1 |
| From |
integer |
需要高亮展示的关键字从第几个字符开始，取值范围从 0 开始，最大值为当句话字符总数减 1。高亮的字包含 from。 |
1 |
| Val |
string |
具体的关键字内容。 |
good |
| Tid |
string |
文本 ID，对应的是请求参数 tickets 中的 tid。 |
1 |
| Pid |
integer |
当前句子在所有句子中的下标值，即当前句子是请求参数中 dialogue 数组中的第几个，从 0 开始。 |
1 |
| CustomizeCode |
string |
质检项名称 |
不文明用语检测 |
| IsMatch |
boolean |
是否匹配 |
true |
| HitCids |
object |
||
| CidItem |
array |
当前句子命中的条件 ID 的列表。 |
|
|
string |
当前句子命中的条件 ID 的列表。 |
["3265"] |
|
| Phrase |
object |
当前命中规则的句子详情。 |
|
| Words |
string |
这个角色说的一句话。 |
hello |
| Identity |
string |
对话角色的具体身份标识。 |
1 |
| Begin |
integer |
本句话的开始时间，是相对起始点的开始时间偏移，单位 ms。 |
0 |
| BeginTime |
string |
这句话的开始时间，示例值：2019-11-25 15:37:16。 |
1742350336950 |
| End |
integer |
本句话的结束时间，是相对起始点的结束时间偏移，单位 ms。 |
2090 |
| Role |
string |
对话内容角色，可能值：客服、客户、系统。 |
客服 |
| ConditionInfo |
object |
||
| ConditionBasicInfo |
array<object> |
废弃字段，请忽略。 |
|
|
object |
废弃字段，请忽略。 |
||
| ConditionInfoCid |
string |
废弃字段，请忽略。 |
1 |
| TyxmTurboCount |
string |
turbo 模型使用次数 |
1 |
| TyxmPlusCount |
string |
plus 模型使用次数 |
1 |
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "successful",
"RequestId": "3CEA0495-341B-4482-9AD9-8191EF4***\t",
"Success": true,
"Data": {
"ResultInfo": [
{
"Score": 16,
"Rules": {
"RuleHitInfo": [
{
"Tid": "79127",
"Rid": "25372",
"Name": "脏话检测",
"Hit": {
"ConditionHitInfo": [
{
"HitKeyWords": {
"HitKeyWord": [
{
"To": 1,
"From": 1,
"Val": "good",
"Tid": "1",
"Pid": 1,
"CustomizeCode": "不文明用语检测",
"IsMatch": true
}
]
},
"HitCids": {
"CidItem": [
"[\"3265\"]"
]
},
"Phrase": {
"Words": "hello",
"Identity": "1",
"Begin": 0,
"BeginTime": "1742350336950",
"End": 2090,
"Role": "客服"
}
}
]
},
"ConditionInfo": {
"ConditionBasicInfo": [
{
"ConditionInfoCid": "1"
}
]
}
}
]
},
"TyxmTurboCount": "1",
"TyxmPlusCount": "1"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。