针对用户query,返回机器人有关这个query的语言理解(nlu)结果。当前只支持对话工厂、中控的NLU信息透出,其他引擎后续按需支持。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
否 |
机器人唯一标识 |
chatbot-cn-mp90s2lrk00050 |
| Utterance |
string |
否 |
用户表述 |
北京的天气怎么样 |
| AgentKey |
string |
否 |
业务空间 key,不设置则访问默认业务空间,key 值在主账号业务管理页面获取 |
ac627989eb4f8a98ed05fd098bbae5_p_beebot_public |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Messages |
array<object> |
消息的列表 |
|
|
array<object> |
|||
| DialogHubNluInfo |
object |
对话中控的 nlu 信息 |
|
| GlobalDictList |
array<object> |
全局名词列表 |
|
|
object |
|||
| StandardWord |
string |
名词 |
天气 |
| Word |
string |
同义词 |
天气 |
| GlobalSensitiveWordList |
array<object> |
全局敏感词列表 |
|
|
object |
|||
| StandardWord |
string |
名词 |
天气 |
| Word |
string |
同义词 |
天气 |
| DsNluInfo |
object |
对话工厂的 nlu 信息 |
|
| EntityList |
array<object> |
实体列表 |
|
|
object |
|||
| Name |
string |
实体名称 |
@城市 |
| Origin |
string |
实体原词(实体成员) |
北京 |
| Type |
string |
实体类型,当前只有 text 类型 |
text |
| Value |
string |
实体同义词 |
首都 |
| IntentList |
array<object> |
意图列表 |
|
|
array<object> |
|||
| IntentId |
integer |
意图 ID |
724387 |
| MatchDetail |
string |
匹配详情(匹配过程) |
classifierType=Fewshot,from=Fewshot,content=[我要查北京的天气, 帮我查北京的天气, 北京天气怎么样, 北京今天下雨吗, 北京今天多少度] |
| MatchType |
string |
匹配类型,其枚举值含义如下: Similarity:query 与意图通过意图话术相似度匹配 Lgf:query 与意图通过 LGF 匹配 Classify:query 与意图通过模型训练匹配 FewShotLearning:query 与意图通过系统内置 fewshot 模型匹配 BuildIn: query 与系统内置意图匹配 |
FewShotLearning |
| Name |
string |
意图名称 |
查天气意图 |
| Score |
number |
分数 |
0.995 |
| SlotList |
array<object> |
命中意图的槽位列表 |
|
|
object |
|||
| Name |
string |
实体名称 |
@城市 |
| Origin |
string |
实体原词(实体成员) |
北京 |
| Type |
string |
实体类型,当前只有 text 类型 |
text |
| Value |
string |
实体同义词 |
首都 |
| RequestId |
string |
请求 ID |
A6357C1B-1D79-1382-B259-BD9E80751B42 |
| MessageId |
string |
本条语言理解应答消息的 ID |
2828708A-2C7A-1BAE-B810-87DB9DA9C661 |
示例
响应报文
{
"Messages": [
{
"DsNluInfo": {
"EntityList": [
{
"Origin": "北京",
"Name": "@城市",
"Type": "text",
"Value": "首都"
}
],
"IntentList": [
{
"Score": 0.995,
"SlotList": [
{
"Origin": "北京",
"Name": "@城市",
"Type": "text",
"Value": "首都"
}
],
"MatchType": "FewShotLearning",
"MatchDetail": "classifierType=Fewshot,from=Fewshot,content=[我要查北京的天气, 帮我查北京的天气, 北京天气怎么样, 北京今天下雨吗, 北京今天多少度]",
"Name": "查天气意图",
"IntentId": 724387
}
]
},
"DialogHubNluInfo": {
"GlobalDictList": [
{
"StandardWord": "天气",
"Word": "天气"
}
],
"GlobalSensitiveWordList": [
{
"StandardWord": "天气",
"Word": "天气"
}
]
}
}
],
"RequestId": "5C20F0D4-9721-178A-8236-3BF990634962",
"MessageId": "e7ac691f-b166-4561-bddf-9dd00c8bdce6"
}
示例
正常返回示例
JSON格式
{
"Messages": [
{
"DialogHubNluInfo": {
"GlobalDictList": [
{
"StandardWord": "天气",
"Word": "天气"
}
],
"GlobalSensitiveWordList": [
{
"StandardWord": "天气",
"Word": "天气"
}
]
},
"DsNluInfo": {
"EntityList": [
{
"Name": "@城市",
"Origin": "北京",
"Type": "text",
"Value": "首都"
}
],
"IntentList": [
{
"IntentId": 724387,
"MatchDetail": "classifierType=Fewshot,from=Fewshot,content=[我要查北京的天气, 帮我查北京的天气, 北京天气怎么样, 北京今天下雨吗, 北京今天多少度]",
"MatchType": "FewShotLearning",
"Name": "查天气意图",
"Score": 0.995,
"SlotList": [
{
"Name": "@城市",
"Origin": "北京",
"Type": "text",
"Value": "首都"
}
]
}
]
}
}
],
"RequestId": "A6357C1B-1D79-1382-B259-BD9E80751B42",
"MessageId": "2828708A-2C7A-1BAE-B810-87DB9DA9C661"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。