To initiate the addition and enablement of a new language for a virtual assistant.
Method | POST |
Endpoint |
|
Content Type | application/json |
Authorization |
|
API Scope |
|
Path Parameters
Parameter | Description |
---|---|
host | The environment URL. For example, https://bots.kore.ai . |
Sample Request
curl -X POST \ https://{{host}}/api/public/users \ -H 'Content-Type: application/json' \ -H 'auth: YOUR_JWT_ACCESS_TOKEN' \ -d '[ { "enableLanguage" : "", "langDefinitionMode": { "baseLanguage": "language_code”, "Type": "advancedConfig/fileUpload", "fileId":" ", "preferredData":{ "Training": true/false, "Faqs": true/false, "ontology": true/false, "smalltalk": true/false, "traits": true/false } }, "multiLingualConfigurations":{ "nluLanguage": "language_code", "inputTranslation": true/false, "responseTranslation": true/false } }]
Body Parameters
Parameter | Sub-parameter | Description | Mandate |
---|---|---|---|
enableLanguage | The language to be enabled based on the language code. | Required | |
langDefinitionMode | Required | ||
langDefinitionMode.baseLanguage | Base language of the Virtual Assistant. | Optional | |
langDefinitionMode.type | Type of language enablement Basic, advancedConfig, or fileUpload. | Optional | |
langDefinitionMode.fileId | The file ID for handling the file upload if the fileUpload language enablement is selected. | Optional | |
langDefinitionMode.preferredData | If the advancedConfig language enablement is selected, the True/False configuration setting for “training”, “faqs”, “ontology”, “Smalltalk” and “traits” keys should be included. | Optional | |
multiLingualConfigurations | Required | ||
multiLingualConfigurations.nluLanguage | Refers to the language code of the bot language. | Required | |
multiLingualConfigurations.inputTranslation | Refers to True/False setting for the input language translation to English. | Required | |
multiLingualConfigurations.responseTranslation | Refers to the True/False setting for the response language translation to English. | Required |
Sample Response
For success case:
[{
“message”: “Enabled
“configurationDetails”: {
"dialogs":3,
"alerts":0,
"actions":0,
"knowledgetTasks":0,
"smallTalk":1,
"panels":0,
"widgets":0
}
}]