查询推荐热词
功能介绍
查询指定条件的推荐热词
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/irobot/recommend-words
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
recommend_word_id |
否 |
String |
推荐词Id 最小长度：1 最大长度：64 |
|
level_value |
否 |
Integer |
推荐词层级 最小值：1 最大值：3 |
|
theme_name |
否 |
String |
主题名称 最小长度：1 最大长度：200 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：0 最大长度：32 |
|
error_msg |
String |
错误描述 最小长度：0 最大长度：32 |
|
recommend_words |
Array of RecommendWord objects |
推荐词列表 数组长度：0 - 65535 |
|
total_count |
Integer |
推荐词总数 最小值：0 最大值：2147483647 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
recommend_word_id |
String |
推荐词Id 最小长度：0 最大长度：64 |
|
recommend_word_name |
String |
推荐词 最小长度：0 最大长度：512 |
|
level_value |
Integer |
推荐词层级 最小值：1 最大值：3 |
|
sort_value |
Integer |
推荐词排序，序号越小越靠前 最小值：0 最大值：2147483647 |
|
theme_id |
String |
主题Id 最小长度：0 最大长度：64 |
|
theme_name |
String |
主题名称 最小长度：0 最大长度：200 |
|
answer_info |
AnswerInfo object |
答案 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
answer |
String |
答案 最小长度：0 最大长度：65535 |
|
link |
String |
链接 最小长度：0 最大长度：65535 |
|
question |
String |
问题 最小长度：0 最大长度：65535 |
|
qa_pair_id |
String |
语料Id 最小长度：0 最大长度：64 |
|
relevance_details |
Array of RelevanceQapair objects |
相关问题详情列表 数组长度：0 - 65535 |
请求示例
GET https://{endpoint}/v2/irobot/recommend-words?recommend_word_id=word-id&level_value=2&theme_name=ECS
null
响应示例
状态码： 200
成功返回200
{
"recommend_words" : [ {
"recommend_word_id" : "推荐词Id",
"recommend_word_name" : "推荐词",
"level_value" : 3,
"sort_value" : 1,
"theme_id" : "主题Id",
"theme_name" : "主题名称",
"answer_info" : {
"answer" : "答案",
"link" : "link"
}
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功返回200 |
错误码
请参见错误码。
