FAQ Group Test and Activation Interface

Interface Method

POST

URL

https://IP:PORT/oifde/rest/api/faq/testEnabledGroups

Request

**Table 1** Parameters in the request body
Parameter	Type	Position	Mandatory	Description
tenantId	String	Body	Yes	Tenant ID.
user	String	Body	Yes	Test subscriber ID.
sentence	String	Body	Yes	Request statement.
language	String	Body	Yes	Language. en_US: English zh_CN: Chinese es_ES: Spanish ar: Arabic th_TH: Thai pt_BR: Portuguese
authToken	String	Body	Yes	Authentication token. For details, see C3 OIAP Interface Authentication.

Response

Parameter	Type	Position	Mandatory	Description
answer	FaqAnswer	Body	Yes	Answer.
similarFaqs	FaqAnswer[]	Body	Yes	Answer group.

**Table 2** FaqAnswer
Parameter	Type	Position	Mandatory	Description
faqGroupId	Integer	Body	Yes	FAQ group ID.
faqGroupName	String	Body	Yes	FAQ group name.
faqId	Integer	Body	Yes	Q&A ID.
question	String	Body	Yes	Question.
answers	String[]	Body	Yes	Answer.
prob	Float	Body	Yes	Matching degree. A larger value indicates a higher matching degree. The value must be 0 or greater.

Example

Request

{
    "tenantId": "00030010",
    "user":"138****8888",
    "sentence":"What is life insurance?",
    "language":"zh_CN",
    "authToken": "5*********************"
}

Response

{
   "answer":    {
      "faqGroupId": 10000,
      "faqGroupName": "Insurance consultation",
      "faqId": 10039,
      "question": "What is life insurance?",
      "answers": ["Life insurance is a type of personal insurance that takes the life span of the insured as the object of insurance and takes the survival and death of the insured as the prestation conditions. In the life insurance, the insured transfers risks to the insurer by accepting the terms raised by the insurer and paying the insurance premium. The difference between the life insurance and other insurance businesses lies in the risk that is transferred. In the life insurance, the risk of survival or death of the insured is transferred."],
      "prob": 121.11094785672965
   }
}

Parent topic: FAQ Configuration Interface

Previous topic: Specific FAQ Group Test Interface

Next topic: Intention List Query Interface