Querying Recommended Keywords

Function

Query recommended keywords based on specified conditions.

URI

GET /v2/irobot/recommend-words

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
recommend_word_id	No	String	Specifies the recommended keyword ID. Minimum length: 1 Maximum length: 64
level_value	No	Integer	Specifies the recommended keyword level. Minimum value: 1 Maximum value: 3
theme_name	No	String	Specifies the theme name. Minimum length: 1 Maximum length: 200

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 Maximum length: 5000
x-service-key	No	String	Specifies the flag for invoking the intelligent customer service. Minimum length: 1 Maximum length: 32
x-site	No	String	Specifies the site flag. The options are 0 (Chinese mainland) and 1 (international). Minimum length: 0 Maximum length: 1
x-language	No	String	Specifies the region language with a language abbreviation. The options are en-us and zh-cn. Minimum length: 0 Maximum length: 32

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code. Minimum length: 0 Maximum length: 32
error_msg	String	Describes the error. Minimum length: 0 Maximum length: 32
recommend_words	Array of RecommendWord objects	Specifies the recommended keyword list. Array length: 0 - 65535
total_count	Integer	Specifies the total number of recommended keywords. Minimum value: 0 Maximum value: 2147483647

**Table 4** RecommendWord
Parameter	Type	Description
recommend_word_id	String	Specifies the recommended keyword ID. Minimum length: 0 Maximum length: 64
recommend_word_name	String	Specifies the recommended keyword. Minimum length: 0 Maximum length: 512
level_value	Integer	Specifies the recommended keyword level. Minimum value: 1 Maximum value: 3
sort_value	Integer	Sorts recommended keywords. The smaller the sequence number of a keyword is, the more recommended the keyword is. Minimum value: 0 Maximum value: 2147483647
theme_id	String	Specifies the theme ID. Minimum length: 0 Maximum length: 64
theme_name	String	Specifies the theme name. Minimum length: 0 Maximum length: 200
answer_info	AnswerInfo object	Specifies the answer.

**Table 5** AnswerInfo
Parameter	Type	Description
answer	String	Specifies the answer. Minimum length: 0 Maximum length: 65535
link	String	Specifies the link. Minimum length: 0 Maximum length: 65535
question	String	Specifies the question. Minimum length: 0 Maximum length: 65535
qa_pair_id	String	Specifies the Q&A pair ID. Minimum length: 0 Maximum length: 64
relevance_details	Array of RelevanceQapair objects	Specifies the list of related question details. Array length: 0 - 65535

**Table 6** RelevanceQapair
Parameter	Type	Description
link	String	Specifies the link. Minimum length: 0 Maximum length: 65535
question	String	Specifies the standard question. Minimum length: 0 Maximum length: 9223372036854775807
qa_pair_id	String	Specifies the standard question ID. Minimum length: 0 Maximum length: 64

Request Example

GET https://{endpoint}/v2/irobot/recommend-words?recommend_word_id=word-id&level_value=2&theme_name=ECS

null

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "recommend_words" : [ {
    "recommend_word_id" : "Recommended keyword ID",
    "recommend_word_name" : "Recommended keyword",
    "level_value" : 3,
    "sort_value" : 1,
    "theme_id" : "Theme ID",
    "theme_name" : "Theme name",
    "answer_info" : {
      "answer" : "Answer",
      "link" : "link"
    }
  } ]
}