To get the status of the FAQ training.
| Method | GET |
| Endpoint | https://{{host}}/api/public/bot/{{BotID}}/faqs/train/status?language={{Lang}}&state={{state}} |
| Content Type | application/json |
| Authorization |
|
| API Scope |
|
Path Parameters
| Parameter | Description | Mandate |
|---|---|---|
| host | The environment URL. For example, https://bots.kore.ai |
Required |
| BotId | Bot ID or Stream ID can be accessed under General Settings on the Bot Builder. | Required |
| language | The Bot language which is identified by the language acronym. For example, en for English and de for German. The user can set the default language of the bot. | Required |
| state | The state of the bot – configured is set for the In-Development version and published for the Published version. The default setting is configured. | Optional |
Sample Request
curl -X GET \
'https://{{host}}/api/public/bot/{{bot_id}}/faqs/train/status?language=en' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
-H 'content-type: application/json' \
Body Parameters
No body parameters are passed.
Sample Response
For successful training
{
"_id": "5dxxxxxxxxxxxxxxxxxxxxxx",
"message": "Success",
"status": "success",
"__v": 0,
"modifiedOn": "2019-06-27T12:07:30.898Z",
"lastModifiedBy": "u-5xxxxxxd-bxx1-5xx0-axx8-2exxxxxxxxxx"
}
For training in-progress
{
"_id": "5dxxxxxxxxxxxxxxxxxxxxxx",
"message": "in-progress",
"status": "in-progress",
"__v": 0,
"modifiedOn": "2019-06-27T12:07:30.898Z",
"lastModifiedBy": "u-5xxxxxxd-bxx1-5xx0-axx8-2exxxxxxxxxx"
}
For failed training
{
"_id": "5dxxxxxxxxxxxxxxxxxxxxxx",
"message": "failure",
"status": "failure",
"__v": 0,
"modifiedOn": "2019-06-27T12:07:30.898Z",
"lastModifiedBy": "u-5xxxxxxd-bxx1-5xx0-axx8-2exxxxxxxxxx"
}