文档首页/ 云客服/ API参考/ 机器人管理/ 语义识别业务请求接口
更新时间：2023-09-27 GMT+08:00
查看PDF
分享

语义识别业务请求接口

场景描述

获取意图模板的匹配情况。

接口方法

设置成“POST”。

URL

https://IP:PORT/oifde/rest/api/speechrecognition

请求说明

表1 请求体参数

参数名称

数据类型

参数位置

必选/可选

描述

userId

String

body

True

用户ID

限制长度：64

sentence

String

body

True

客户输入的文本信息

限制长度：1024

tenantId

String

body

True

租户ID

限制长度：64

language

String

body

True

语言，选项如下：

  • 汉语：zh_CN
  • 英语：en_US
  • 西班牙语：es_ES
  • 阿拉伯语：ar
  • 泰语：th_TH
  • 葡萄牙语：pt_BR
  • 法语：fr_FR

targetIntentCount

String

body

False

需要chatbot返回多个意图时的意图数量，一般用于客户输入一句话可以匹配多个意图的情况。

取值范围：1~5

confidence2Top

String

body

False

置信度间距如果返回多个意图，要求后面的意图与第一个置信度最高的意图的置信度间距，这个值越小表示返回的意图越接近。

取值范围：0~1

context

String

body

False

传递意图识别需要的上下文，当前接口只支持传递单个上下文。

上下文的使用，需要结合意图配置单个上下文。

限制长度：128

domainList

List<String>

body

False

传递已经存在且激活的领域id列表。

限制数量：100

faqGroupList

List<String>

body

False

传递已经存在且激活的问答组id列表。

限制数量：100

authToken

String

body

True

访问接口的有效Token值。

有效Token信息通过获取Token接口获取。

请参见C3 智能助手平台接口鉴权方式。

限制长度：32

响应说明

表2 响应体参数

参数名称

数据类型

参数位置

必选/可选

描述

errorCode

int

body

True

错误码

返回0：成功 其他值：失败

errorMessage

String

body

False

错误信息

intentsResponses

intentsResponses[]

body

False

意图数组，成功时必须返回。
表3 intentsResponses 参数说明

参数名称

数据类型

参数位置

必选/可选

描述

responses

String[]

body

False

Chatbot返回的应答信息，字符串数组，可以有多个。

confidence

float

body

True

置信度

commands

String[]

body

True

意图命令字

commandParams

Map

body

False

命令字参数信息，一般意图的槽位信息都通过这个返回。

例如{"Number":"3"}。

一般意图操作具体详情参考添加意图模板章节。

scenarioName

String

body

False

意图名

scenarioStatus

String

body

False

场景状态

simQuestions

List<String>

body

False

对于FAQ应答存在相似问时，返回相似问。（相似问指的是：除匹配的主问题外的其他问题。）

报文样例

  • 请求消息样例 
    {
	"userId": "1649209493813571405"，
	"sentence": "查询话费"，
	"tenantId": "202205125916"，
	"language": "zh_CN"，
	"targetIntentCount": "2"，
	"confidence2Top": "0.5"，
	"authToken": "Xun4*******************yAmResnf"，
        "context":"查询话费"，
        "domainList":[10039]，
        "faqGroupList":[10952，10950]
}
  • 响应消息样例 
    {
    "intentsResponses": [
        {
            "scenarioStatus": "finish"，
            "confidence": 1.0，
            "responses": "尊敬的用户，您当前话费账户余额为56元。"，
            "scenarioName": "话费查询"，
            "commands": "查询话费"
        }
    ]，
    "errorCode": 0
}
  • 请求消息样例(包含FAQ问答) 
    {
	"userId": "1649209493813571405"，
	"sentence": "优惠套餐推荐"，
	"tenantId": "202205125916"，
	"language": "zh_CN"，
	"targetIntentCount": "2"，
	"confidence2Top": "0.5"，
	"authToken": "Xun4vb*******************mResnf"，
        "context":""，
        "domainList":[10039]，
        "faqGroupList":[10952，10950]
}
  • 响应消息样例 
    {
    "intentsResponses": [
        {
            "simQuestions": [
                "有实惠一点的流量套餐可以办理"
            ]，
            "scenarioStatus": "SUCCESS"，
            "confidence": 23.0，
            "responses": "本月特惠，10元3G流量。"，
            "scenarioName": "1721756338"，
            "commands": "systemQA"
        }
    ]，
    "errorCode": 0
}
父主题： 机器人管理