API使用说明

语义解析接口介绍

本接口用来根据机器人配置的语法规则,返回查询语句的语义解析结果。

URL
http://dev.zhimabot.com:8080/zhimabot/analysis

HTTP Method
POST

HTTP Header
Content-Type
   application/json; charset=utf-8
Accept
   application/json
HTTP 请求 Body

JSON 格式的数据,采用utf-8编码方式。appId传入你的机器人编号,编号在机器人配置界面右上角可见。query传入你要解析的语句,比如:

{"appId":"2110" ,"query":"查找新街口附近的三星级宾馆"}

HTTP 返回 Body
返回 JSON 格式的解析结果信息

CURL 调用示例

$ curl -X POST \
    -H "Content-Type: application/json; charset=utf-8 " \
    -H "Accept: application/json" \
    --data "{\"appId\":\"2110\" ,\"query\":\"查找新街口附近的三星级宾馆\"}" \
    http://dev.zhimabot.com:8080/zhimabot/analysis

返回结果说明

{
"query":"查找新街口附近的三星级宾馆",                  //要解析的语句
"intents": [                                      //意图
     {                              
        "intent": "hotel",                       //意图名称 
        "score": "0.9999",     
     }
  ],
"entities": [                                    //实体集合
     {                              
        "entity": "新街口",                       //实体值
        "type": "location"                       //实体代码
     },
     {                              
        "entity": "3",                           //实体值
        "type": "grade"                          //实体代码
     }     
  ]
}   
字段 说明
query 要解析的语句
intent 语句对应的意图代码,意图在机器人配置界面里面配置
score 分析出的意图得分情况
entities 语句解析出的实体集合,实体在机器人配置界面里面配置
entity 实体值
type 实体代码

API 调用失败说明

用户调用失败会遇到如下HTTP返回信息:

{"resultCode":"9999","resultMsg":"count limit exceeded"}

resultCode 为返回代码。

resultMsg 为返回消息。