Querying Q&A Pairs

Query the list of Q&A pairs that meet the specified conditions.

POST /v2/irobot/qapairs/search

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
search_type	Yes	String	Specifies the type of the content to be queried. Options: HOT RECOMMEND

**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	Yes	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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
domain	No	String	Specifies the domain name. Minimum length: 0 Maximum length: 200
top	No	Integer	Requests for the number of data records with the highest matching degree. Minimum value: 1 Maximum value: 1000

Status code: 200

**Table 4** 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
qa_pairs	Array of SimpleQaPair objects	Specifies the list of Q&A pairs. Array length: 0 - 65535

**Table 5** SimpleQaPair
Parameter	Type	Description
question	String	Specifies the question. Minimum length: 0 Maximum length: 65535
domain	String	Specifies the domain. Minimum length: 0 Maximum length: 200
qa_pair_id	String	Specifies the Q&A pair ID. Minimum length: 0 Maximum length: 64

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

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

Status code: 200

Code 200 is returned if the operation is successful.

{
  "qa_pairs" : [ {
    "question" : "Question",
    "domain" : "Domain",
    "qa_pair_id" : "Q&A pair ID"
  } ]
}

Status Code	Description
200	Code 200 is returned if the operation is successful.

Parent topic: Intelligent Customer Service

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.