{"id":18074,"date":"2018-11-24T06:30:46","date_gmt":"2018-11-24T06:30:46","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?post_type=docs&p=15508"},"modified":"2023-07-19T12:54:37","modified_gmt":"2023-07-19T11:54:37","slug":"faq-training-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/faq-training-api\/","title":{"rendered":"FAQ Training API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

To initiate the training of the knowledge graph.<\/p>\n

 <\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nPOST<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\nhttps:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/faqs\/train<\/code><\/span><\/td>\n<\/tr>\n
Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\n\n

auth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token<\/a>.<\/td>\n<\/tr>\n

API Scope<\/b><\/td>\n\n
    \n
  • Bot Builder: Train FAQ<\/li>\n
  • Admin Console: Test and Train > Train FAQ<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    Path Parameters<\/span><\/h2>\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/b><\/th>\n<\/tr>\n
    host<\/b><\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code><\/td>\nRequired<\/td>\n<\/tr>\n
    BotId<\/b><\/td>\nBot ID<\/i> or Stream ID<\/i> can be accessed under General Settings<\/b> on the Bot Builder.<\/td>\nRequired<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t

     <\/p>\n

    Sample Request<\/span><\/h2>\n
    curl -X POST \\\r\n  https:\/\/{{host}}\/api\/public\/bot\/{{bot_id}}\/faqs\/train \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n  -H 'content-type: application\/json' \\\r\n-d '{\r\n\"language\":\"en\"\r\n}'<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
     <\/p>\n
    Body Parameters<\/span><\/h2>\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/th>\n<\/tr>\n
    language<\/b><\/td>\nThe Bot language which is identified by the language acronym. For example, en<\/em> for English and de<\/em> for German. The user can set the default language of the bot.<\/td>\nRequired<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
    \r\n\t\t
    \r\n\t\t\t
     <\/p>\n
    Sample Response<\/span><\/h2>\n
    \r\n{\r\n    \"_id\": \"ds-1xxxxxxd-31xx-5xx1-83xx-0dxxxxxxxxxx\",\r\n    \"message\": \"in-progress\",\r\n    \"status\": \"in-progress\",\r\n    \"__v\": 0,\r\n    \"lastModifiedBy\": \"u-adxxxxxx-exx1-5xxd-axxc-21xxxxxxxxxx\",\r\n    \"modifiedOn\": \"2022-07-29T08:20:31.569Z\"\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"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...","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-18074","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18074","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=18074"}],"version-history":[{"count":15,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18074\/revisions"}],"predecessor-version":[{"id":57976,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/18074\/revisions\/57976"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=18074"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=18074"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=18074"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}