• 沒有找到結果。

单轮问答(即将下线)

4.4 其他问答 API

4.4.4 单轮问答(即将下线)

状态码:400 失败响应示例

{ "error_code":"CBS.3254", "error_msg":"resource not exist"

}

URI

POST /v1/{project_id}/qabots/{qabot_id}/requests

4-91 路径参数

参数 是否必选 参数类型 描述

project_id 是 String 项目ID,用于资源隔离。请参见 获取项目ID。

qabot_id 是 String qabot编号,UUID格式,如:

303a0a00-c88a-43e3-aa2f-d5b8b9832b02。

进入问答机器人的Console界 面,在“机器人名称/ID”列显 示对应的qabot_id。

请求参数

4-92 请求 Header 参数

参数 是否必选 参数类型 描述

X-Auth-Token 是 String 用户Token。

Token认证就是在调用API的时 候将Token加到请求消息头,从 而通过身份认证,获得操作API 的权限,响应消息头中X-Subject-Token的值即为Token。

4-93 请求 Body 参数

参数 参数类型 是否必选 说明

session_id 是 String 会话ID,由任意字符串组成,由用户自 定义产生,用来区分不同的会话。

具体获取方式请参见开启会话章节。

user_id 否 String 用户ID,用来区分唯一用户信息。

question 是 String 用户问题。

extends 否 Extends

object 扩展参数项。

threshold_ena

ble 否 Boolean true:启动内部阈值 返回经过阈值处理 之后的答案。

false:不启用内部阈值 返回原答案。

参数 参数类型 是否必选 说明 chat_enable 否 Boolean 默认true

true:使用内部闲聊语料进行兜底。

false:不使用闲聊兜底。

operate_type 否 Integer 调用接口时候传入,用以标记的问答的 行为,默认为0,最终会展示在问答日志 里。

● 0 用户输入

● 1 单击热点问题

● 3 单击推荐问题

● 4 单击问题提示

4-94 Extends

参数 是否必

参数类型 描述

domains 否 Array of

strings 领域列表,多个领域用分号隔开。如果设 置了领域且领域不为空,就从这些领域中 匹配答案,否则就从该用户的全部知识库 匹配答案。

当前最多支持10个领域。

top 否 Integer 返回答案数量,默认为5,取值范围 1~10。

响应消息

状态码: 200

4-95 响应 Body 参数

参数 参数类型 描述

request_id String 请求ID。

调用失败时无此字段。

question String 问题。

调用失败时无此字段。

answers Array of Answers objects

最相似的问题集。调用失败时无此字段。

参数 参数类型 描述 extends Extends

object 扩展参数项。调用失败时无此字段。

4-96 Answers

参数 参数类型 描述

qa_pair_id String 问答对ID。

st_question String 标准问题。

ex_questions Array of ExQuestions objects

扩展问。

answer String 答案。

score Float 相似度得分,精确到小数点后3位。

domain String 所属领域。

4-97 ExQuestions

参数 参数类型 描述

content String 扩展问题。

4-98 Extends

参数 是否必

参数类型 描述

domains 否 Array of

strings 领域列表,多个领域用分号隔开。如果设 置了领域且领域不为空,就从这些领域中 匹配答案,否则就从该用户的全部知识库 匹配答案。

当前最多支持10个领域。

top 否 Integer 返回答案数量,默认为5,取值范围 1~10。

状态码: 400

4-99 响应 Body 参数

参数 参数类型 描述

error_code String 调用失败时的错误码。 调用成功时无此字段。

error_msg String 调用失败时的错误信息。 调用成功时无此字段。

请求示例

请求示例POST https://{endpoint}/v1/1604d8170cd84440a81281e5a3a04f8b/qabots/303a0a00-c88a-43e3-aa2f-d5b8b9832b02/requests

Request Header:

Content-Type: application/json

X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

Request Body:

{ "user_id": "z00123456",

"session_id": "xxxxxxxxxxxxxxxxxx", "operate_type":3,

"question": "桌面云无法登录", "extends":{

"domains":["桌面云"], "top":5

},

"threshold_enable":false, "chat_enable":true }

响应示例

状态码:200 成功响应示例

● 关闭内置阈值处理(设置threshold_enable = false),按top个数返回结果数量。

{ "request_id": "303a0a00-c88a", "question": "桌面云打不开",

{

{ "request_id": "303a0a00-c88a", "question": "桌面云打不开",

{ "request_id": "303a0a00-c88a",

"question": "桌面云打不开",

{ "request_id": "303a0a00-c88a", "question": "桌面云打不开",

{ "request_id": "303a0a00-c88a", "question": "你好",

{ "error_code": "CBS.0022",

"error_msg": "session_id can not be null"

}

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。

5 话务机器人

相關文件