数美智能文本流式代答查询产品API接口文档#

请求参数#

请求URL:#

集群URL
北京http://api-text-bj.fengkongcloud.com/answer/v1

字符编码格式:#

UTF-8字符集编码

请求方法:#

POST

建议超时时长:#

1s

请求参数:#

放在HTTP Body中,采用Json格式,具体参数如下:

请求参数名类型参数说明是否必传规范
accessKeystring接口认证密钥Y由数美提供
requestIdstring请求标识Y本次流式代答查询数据的流水号

返回结果#

返回结果#

放在HTTP Body中,采用Json格式,具体参数如下:

参数名称类型参数说明是否必返规范
codeint返回码Y1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1905:字数超限
9101:无权限操作
messagestring返回码描述Y和code对应:
成功
QPS超限
参数不合法
服务失败
字数超限
无权限操作
requestIdstring请求标识Y本次请求数据的唯一标识,用于问题排查和效果优化,强烈建议保存
kbDetailjson_object知识库详情N知识库详情,详见kbDetail参数
其中,kbDetail字段内容如下:
参数名称类型参数说明是否必返规范
qlabelstring问题标签Y可选值:
UNKNOWN:没有匹配
CANNOT_ASK:问题本身不可提问/不可输入
EXACTNESS:问题答案必须正确。包括立场正确
POSITIVE:问题答案需要包含正向引导
answerstring建议答案Y当qlabel为"EXACTNESS"或者"POSITIVE"时,会给出数美建议的符合要求的答案。
isEndbool答案是否完整返回Y答案是否完整返回
hasAnswerint是否有答案Y1 有代答;0 没有代答,默认为0

示例#

请求示例#

{
"accessKey": "*************",
"requestId": "xxxxxxxxxxxxxxxx"
}

返回示例#

{
"code": 1100,
"requestId": "xxxxxxx",
"message": "成功",
"kbDetail": {
"answer": "东风汽车集团有限公司(以下简称东风公司)",
"isEnd": false,
"qlabel": "EXACTNESS",
"hasAnswer": 1
}
}
{
"code": 1100,
"requestId": "xxxxxxx",
"message": "成功",
"kbDetail": {
"answer": "成立于1969年,是中央直管的企业,累计用户近6000万。",
"isEnd": true,
"qlabel": "EXACTNESS",
"hasAnswer": 1
}
}

在线咨询