意图列表查询接口

基本信息

给第三方提供（例如静默座席系统）调用,实现意图列表的查询。

接口方法

设置成“POST”。

URL

https://IP:PORT/oifde/rest/api/intentions/query

请求说明

表1 请求体参数
参数名称	数据类型	参数位置	必选/可选	描述
tenantId	String	body	True	租户ID
language	String	body	True	语言 en_US：英文 zh_CN：中文 pt_BR：葡萄牙语 th_TH：泰语 fr_FR：法语 ar：阿拉伯语
pageNum	int	body	True	页码分页查询,查询第几页,首页为1
pageSize	int	body	True	每页多少条支持每页 5、10、20、50、100条
domainInfo	DomainInfo	body	配置项oifde.slient.use =ipcc 时True,反之False	领域信息
authToken	String	body	True	认证token。请参见C3 智能助手平台接口鉴权方式。

表2 DomainInfo
参数名称	数据类型	参数位置	必选/可选	描述
domainName	String	body	False	领域名称
domainId	int	body	True	领域ID
language	String	body	False	语言
tenantId	String	body	False	租户ID

响应说明

参数名称	数据类型	参数位置	必选/可选	描述
errorCode	int	body	False	错误码 0：成功非0表示失败
errorMsg	String	body	False	错误描述
intentions	intention[]	body	True	返回意图列表（数组结构）不包含默认意图,如：未知意图、敏感词等。
total	int	body	True	返回意图的条数

表3 intention参数说明
参数名称	数据类型	参数位置	必选/可选	描述
intentCmd	String	body	False	命令字
intentName	String	body	O	意图名称（格式：领域名称/意图名称-命令字）
intentDesc	String	body	False	意图描述

报文样例

请求消息样例

{ 
    "tenantId":"202104237142",
    "language":"zh_CN",
    "pageNum":1,
    "pageSize":20,
    "authToken": "t*********************",
    "domainInfo":{
       "domainName":"机器人",
        "domainId": "10149"
    }
}

响应消息样例

{
    "errorMsg": "",
    "errorCode": 0,
    "intentions": [
        {
            "intentName": "移车地址",
            "intentDesc": " ",
            "intentCmd": "移车地址"
        },
        {
            "intentName": "社保业务",
            "intentDesc": " ",
            "intentCmd": "社保业务"
        },
        {
            "intentName": "移车业务",
            "intentDesc": "移车业务",
            "intentCmd": "移车"
        },
        {
            "intentName": "公积金问题",
            "intentDesc": " ",
            "intentCmd": "公积金问题"
        },
        {
            "intentName": "是否",
            "intentDesc": " ",
            "intentCmd": "是否"
        },
        {
            "intentName": "公积金业务",
            "intentDesc": " ",
            "intentCmd": "公积金"
        }
    ],
    "total": 6
}

父主题：智能化模块接口参考

上一篇：测试激活问答组接口

下一篇：静默座席专有接口