{"id":48940,"date":"2022-11-20T06:06:56","date_gmt":"2022-11-20T06:06:56","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=48940"},"modified":"2024-01-03T12:06:24","modified_gmt":"2024-01-03T12:06:24","slug":"add-and-enable-a-new-language-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/add-and-enable-a-new-language-api\/","title":{"rendered":"Add and Enable a New Language API"},"content":{"rendered":"
<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

To initiate the addition and enablement of a new language for a virtual assistant.<\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nPOST<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\nhttps:\/\/{{host}}\/api\/1.1\/public\/bot\/{{botId}}\/language<\/code><\/span><\/td>\n<\/tr>\n
Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\nauth: {{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: Language Configuration<\/li>\n
  • Admin Console: Language Settings > Language Management<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Path Parameters<\/span><\/h2>\n\n\n\n\n\n
    Parameter<\/b><\/th>\nRequired<\/b><\/th>\nDescription<\/b><\/th>\n<\/tr>\n
    host<\/span><\/td>\nYes<\/span><\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code>.<\/td>\n<\/tr>\n
    botId<\/span><\/td>\nYes<\/span><\/td>\nBot ID or Stream ID. You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Sample Request<\/span><\/h2>\n
    curl --location 'https:\/\/bots.kore.ai\/api\/1.1\/public\/bot\/st-70xx8595-ebcf-58xf-9xx7-5da61fexxxxx\/language' \\\r\n--header 'Content-Type: application\/json' \\\r\n--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\ \r\n--data '{\r\n\"enableLanguage\": \"es\",\r\n\"langDefinitionMode\":\r\n{\r\n\"baseLanguage\": \"en\",\r\n\"type\": \"advancedConfig\",\r\n\"preferredData\":\r\n{\r\n\"training\": true,\r\n\"faqs\": true,\r\n\"ontology\": true,\r\n\"smalltalk\": true,\r\n\"traits\": true\r\n}\r\n},\r\n\"multiLingualConfigurations\":\r\n{\r\n\"nluLanguage\": \"en\",\r\n\"inputTranslation\": true,\r\n\"responseTranslation\": true\r\n}\r\n}'<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Body Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/b><\/th>\n<\/tr>\n
    enableLanguage<\/span><\/td>\nThe language to be enabled based on the language code.<\/td>\nRequired<\/td>\n<\/tr>\n
    langDefinitionMode<\/span><\/td>\nThe Language Definition Mode object.<\/td>\nRequired<\/td>\n<\/tr>\n
    langDefinitionMode.baseLanguage<\/span><\/td>\nBase language of the Virtual Assistant.<\/td>\nRequired<\/td>\n<\/tr>\n
    langDefinitionMode.type<\/span><\/td>\nType of language enablement Basic<\/b>, advancedConfig<\/b>, or fileUpload<\/b>.<\/td>\nRequired<\/td>\n<\/tr>\n
    langDefinitionMode.fileId<\/span><\/td>\nThe file ID<\/b> for handling the file upload if the fileUpload<\/b> language enablement is selected.<\/td>\nOptional<\/td>\n<\/tr>\n
    langDefinitionMode.preferredData<\/span><\/td>\nIf the advancedConfig<\/b> language enablement is selected, the True\/False configuration setting for “training”, “faqs”, “ontology”, “Smalltalk” and “traits” keys should be included.<\/td>\nOptional<\/td>\n<\/tr>\n
    multiLingualConfigurations<\/td>\nThe multi Lingual Configurations object.<\/td>\nRequired<\/td>\n<\/tr>\n
    multiLingualConfigurations.nluLanguage<\/td>\nRefers to the language code of the bot language.<\/td>\nRequired<\/td>\n<\/tr>\n
    multiLingualConfigurations.inputTranslation<\/td>\nRefers to True\/False setting for the input language translation to English.<\/td>\nRequired<\/td>\n<\/tr>\n
    multiLingualConfigurations.responseTranslation<\/td>\nRefers to the True\/False setting for the response language translation to English.<\/td>\nRequired<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Sample Response<\/span><\/h2>\n
    For success case:<\/p>\n
    {\r\n    \"message\": \"Enabled Spanish language successfully\",\r\n    \"configurationDetails\": {\r\n        \"dialogs\": 2,\r\n        \"alerts\": 0,\r\n        \"actions\": 0,\r\n        \"knowledgetTasks\": 0,\r\n        \"smallTalk\": 1,\r\n        \"panels\": 0,\r\n        \"widgets\": 0\r\n    }\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"To initiate the addition and enablement of a new language for a virtual assistant. Method POST Endpoint https:\/\/{{host}}\/api\/1.1\/public\/bot\/{{botId}}\/language Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Language Configuration Admin Console: Language Settings > Language Management Path Parameters Parameter Required Description host Yes The environment URL. For...","protected":false},"author":21,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-48940","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\/48940","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\/21"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=48940"}],"version-history":[{"count":28,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/48940\/revisions"}],"predecessor-version":[{"id":60947,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/48940\/revisions\/60947"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=48940"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=48940"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=48940"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}