更新时间:2023-12-18 GMT+08:00
分享

语料提问

功能介绍

基于语料的一次问答

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/irobot/qapairs/ask

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:5000

x-service-key

String

调用智能客服服务标志。

最小长度:1

最大长度:32

x-site

String

站点标记,0-中国站 1-国际站

最小长度:0

最大长度:1

x-language

String

区域语言简写,en-us zh-cn

最小长度:0

最大长度:32

表2 请求Body参数

参数

是否必选

参数类型

描述

question

String

用户输入问题

最小长度:1

最大长度:1000

domains

Array of strings

主题列表

最小长度:1

最大长度:200

数组长度:0 - 200

top

Integer

返回匹配度最高的数据条数

最小值:1

最大值:10

session_id

String

会话ID

最小长度:1

最大长度:64

source_qa_pair_id

String

语料ID

最小长度:0

最大长度:64

operate_type

Integer

操作类型:0-手动输入,1-单击热点问题,2-单击猜你想问,3-单击推荐问题,4-单击问题提示

枚举值:

  • 0

  • 1

  • 2

  • 3

  • 4

threshold_enable

String

是否启用内部阈值开关

product_type_id

String

产品类型id

最小长度:0

最大长度:64

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

question

String

问题

最小长度:0

最大长度:65535

answers

Array of AnswerQaPair objects

答案列表

数组长度:0 - 65535

error_code

String

错误码

最小长度:0

最大长度:32

error_msg

String

错误描述

最小长度:0

最大长度:32

request_id

String

请求Id

最小长度:0

最大长度:64

表4 AnswerQaPair

参数

参数类型

描述

score

Double

相似度得分

最小值:0

最大值:1

answer

String

答案

最小长度:0

最大长度:9223372036854775807

domain

String

主题

最小长度:0

最大长度:65535

link

String

链接

最小长度:0

最大长度:65535

question

String

问题

最小长度:0

最大长度:65535

qa_pair_id

String

语料Id

最小长度:0

最大长度:65535

relevance_details

Array of RelevanceQapair objects

相关问题详情列表

数组长度:0 - 65535

task_complete

Boolean

技能意图识别是否结束

表5 RelevanceQapair

参数

参数类型

描述

link

String

链接

最小长度:0

最大长度:65535

question

String

标准问题

最小长度:0

最大长度:9223372036854775807

qa_pair_id

String

标准问题Id

最小长度:0

最大长度:64

请求示例

POST https://{endpoint}/v2/irobot/qapairs/ask

{
  "question" : "ECS如何购买",
  "session_id" : "session-id",
  "source_qa_pair_id" : "pair-id",
  "operate_type" : 1,
  "top" : 5
}

响应示例

状态码: 200

成功返回200

{
  "request_id" : "request-id",
  "question" : "ECS如何购买",
  "answers" : [ {
    "score" : 0.85,
    "answer" : "ECS如何购买",
    "domain" : "ECS",
    "link" : "link",
    "qa_pair_id" : "pair-001",
    "task_complete" : true,
    "relevance_details" : null
  } ]
}

状态码

状态码

描述

200

成功返回200

错误码

请参见错误码

相关文档