FAQ Training API¶

To initiate the training of the knowledge graph.

Method	POST
Endpoint	`https://{{host}}/api/public/bot/{{BotID}}/faqs/train`
Content Type	`application/json`
Authorization	`auth: {{JWT}}` See How to generate the JWT Token.
API Scope	Bot Builder: Train FAQ Admin Console: Test and Train > Train FAQ

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

Sample Request¶

curl -X POST \
  https://{{host}}/api/public/bot/{{bot_id}}/faqs/train \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json' \
-d '{
"language":"en"
}'

Body Parameters¶

PARAMETER	DESCRIPTION	MANDATE
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

Sample Response¶

{
    "_id": "ds-1xxxxxxd-31xx-5xx1-83xx-0dxxxxxxxxxx",
    "message": "in-progress",
    "status": "in-progress",
    "__v": 0,
    "lastModifiedBy": "u-adxxxxxx-exx1-5xxd-axxc-21xxxxxxxxxx",
    "modifiedOn": "2022-07-29T08:20:31.569Z"
}