文档首页/ 工单管理/ API参考/ API v2（推荐）/ 智能客服/ 查询语料
更新时间：2023-12-18 GMT+08:00
查看PDF
分享

查询语料

功能介绍

查询满足指定条件的语料列表

调试

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

URI

POST /v2/irobot/qapairs/search

表1 Query参数

参数

是否必选

参数类型

描述

search_type

是

String

  • HOT:

  • RECOMMEND:

枚举值：

  • HOT

  • RECOMMEND

请求参数

表2 请求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
表3 请求Body参数

参数

是否必选

参数类型

描述

domain

否

String

主题名称

最小长度：0

最大长度：200

top

否

Integer

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

最小值：1

最大值：1000

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：32

error_msg

String

错误描述

最小长度：0

最大长度：32

qa_pairs

Array of SimpleQaPair objects

语料列表

数组长度：0 - 65535
表5 SimpleQaPair

参数

参数类型

描述

question

String

问题

最小长度：0

最大长度：65535

domain

String

主题

最小长度：0

最大长度：200

qa_pair_id

String

语料Id

最小长度：0

最大长度：64

请求示例

POST https://{endpoint}/v2/irobot/qapairs/search?search_type=HOT

{
  "domain" : "ECS",
  "top" : 10
}

响应示例

状态码： 200

成功返回200

{
  "qa_pairs" : [ {
    "question" : "问题",
    "domain" : "主题",
    "qa_pair_id" : "语料Id"
  } ]
}

状态码

状态码

描述

200

成功返回200

错误码

请参见错误码。

父主题： 智能客服

相关文档