业务请求接口
场景描述
1、首次调用该接口可获取鉴权所需的nonce信息。
2、接口鉴权通过后,调用该接口可从第三方系统获取意图模板的匹配情况。
接口方法
设置成“POST”。
URL
/chatbot/u-route/api/router_service/recognize
请求头参数
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
Content-Type |
True |
String |
application/json;charset=utf-8 |
Chatbot-Token |
True |
String |
认证接口返回的token |
请求说明
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
request |
True |
requestBody |
请求体 |
名称 |
是否必选 |
参数类型 |
长度 |
说明 |
---|---|---|---|---|
userId |
True |
String |
64 |
用户ID |
accesscode |
False |
String |
32 |
接入码(用户通过拨打什么号码接入的) |
channel |
False |
String |
32 |
渠道(目前固定填OIFDE) |
sentence |
True |
String |
1024 |
客户输入的文本信息 |
tenantId |
True |
String |
64 |
租户ID |
language |
True |
String |
20 |
语言 中文:zh_CN 英文:en_US |
context |
False |
String |
64 |
意图识别需要的上下文 |
targetIntentCount |
False |
int |
4 |
需要chatbot返回多个意图时的意图数量,一般用于客户输入一句话可以匹配多个意图的情况 范围:1——5 |
confidence2Top |
False |
float |
4 |
置信度间距 如果返回多个意图,要求后面的意图与第一个置信度最高的意图的置信度间距,这个值越小表示返回的意图越接近。 范围:0——1 |
timeZone |
False |
String |
10 |
时区,8表示东8区。 |
响应参数
名称 |
是否必选 |
参数类型 |
长度 |
说明 |
---|---|---|---|---|
errorMsg |
False |
String |
512 |
错误信息 |
errorCode |
False |
String |
20 |
错误码 |
intentsResponses |
False |
Intents[] |
- |
意图数组,成功时必须返回。 |
nonce |
False |
String |
128 |
token认证失败时返回,服务端随机生成的字符串,同时需要返回状态码401。 |
名称 |
是否必选 |
参数类型 |
长度 |
说明 |
---|---|---|---|---|
responses |
False |
String[] |
4096 |
Chatbot返回的应答信息,字符串数组,可以有多个。 |
confidence |
True |
float |
4 |
置信度
|
commands |
True |
String[] |
64 |
意图命令字 |
params |
False |
Map |
- |
命令字参数信息,一般意图的槽位信息都通过这个返回。例如{"Number":"3"}。 一般意图操作具体详情参考添加意图模板章节。 |
scenarioName |
False |
String |
64 |
意图名 |
scenarioType |
False |
int |
4 |
场景类型,辅助场景=1, 业务场景=0, 无场景= -1 |
scenarioStatus |
False |
String |
64 |
场景状态(暂不使用) |
报文样例
- 请求样例
{ "request": { "sentence":"查询3月账单", "targetIntentCount":1, "confidence2Top":0.2, "accessCode":"10086", "channel":"OIFDE", "tenantId":"NJ_001", "language":"zh_CN", "userId":"123456789" } }
- 响应成功样例:
{ "errorCode":"0", "errorMsg":"", "intentsResponses": [ { "responses":[""], "confidence":1.0, "commands":["bill"], "params":{"Number":"3"}, "scenarioName":"query bills", "scenarioType":"normal", "scenarioStatus":"finish" } ] }
- 响应失败样例:
401 Unauthorized { "errorMsg":"NEED_LOGIN","nonce":"0cf*******************accesaf" }