To get the status of the FAQ training.
To use this API, app needs the Admin API Scope of Train FAQ under Test and Train.
GET https://{{host}}/api/public/bot/{{BotID}}/faqs/train/status?language={{Lang}}&state={{state}}
Path Parameters
Parameter | Required/Optional | Description |
---|---|---|
host | Required | Environment URL, for example, https://bots.kore.ai |
BotID | Required | Bot ID or Stream ID. You can access it from the General Settings page of the bot. |
Lang | Required | The bot language, for example, “en” for English and “de” for German. |
state | Optional | The state of the bot – configured for In-Development version and published for Published version Set by default to configured |
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
Response Content Type
application/json
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' \
Sample Response
For successful training
{ "_id": "5d13600c1e22bc5eaec93e76", "message": "Success", "status": "success", "__v": 0, "modifiedOn": "2019-06-27T12:07:30.898Z", "lastModifiedBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91" }
For training in-progress
{ "_id": "5d13600c1e22bc5eaec93e76", "message": "in-progress", "status": "in-progress", "__v": 0, "modifiedOn": "2019-06-27T12:07:30.898Z", "lastModifiedBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91" }
For failed training
{ "_id": "5d13600c1e22bc5eaec93e76", "message": "failure", "status": "failure", "__v": 0, "modifiedOn": "2019-06-27T12:07:30.898Z", "lastModifiedBy": "u-5dad2ccd-b271-5c00-a338-2e6e25e1ec91" }