Configuration Parameters

common parameters are attributes of the digital human that are available across all create a digital human docid\ hoboropyem9tuenmqcf s these are used to further personalise your digital human to achieve your desired end user experience one or more parameters can be changed within a single digital human update as specified in the update a digital human docid\ gjy qc6alw5tk6sscxrpp documentation below you can find the parameters listed the parameters listed here are commonly updated atleast once after the initial digital human creation process conversation greetings this is the welcome message that the digital human will deliver to the end user upon first interaction type string example "hi there, i am john" operating modes applies to all suggestions these are a list of menu like options that suggest to the user what to engage the digital human about these options are clickable via the unith front end type list of strings example \["who is unith", "where are unith offices?"] operating modes doc qa, oc in doc qa mode, the list of suggestions is dynamically generated when you upload a document it is highly recommended to review and edit the list to align with your use case furthermore, every time you upload a new document, the suggestions list is over written with a new dynamically generated list therefore, it is advised to keep a local copy of your suggestions list, before you upload the document suggestions can only be actioned once in a given conversational session israndomsuggestions informs unith if the suggestions should be delivered at random the end user or if they will be sequenced in order of the list type true/false operating modes doc qa, oc personalisation alias the name of the digital human as it appears to the end user engaging with the digital human type string example "david beckham" operating modes applies to all name the name of the digital human used only for classification purposes inside the unith platform not recommended to change type string example "beckham" operating modes applies to all tts & stt languagespeechrecognition language code to improve speech recognition choose a value supported by speech service type string example "en us" operating modes applies to all ttsprovider name of the text to speech audio synthesis engine unith platform will leverage only "audiostack" is currently supported type string example "audiostack" operating modes applies to all ttsvoice the voice that will be associated with the digital human this list is sourced from audiostack you can access the list directly via unith api as detailed list voices docid\ ujeqesnyxa j9j2 z6jtl type string example "kelso" operating modes applies to all customwords a dictionary containing pairs of words and their custom pronunciation you can use this to override how a word is usually pronounced can be empty type dict example "customwords" {"unith" "unith", "idan" "eedan", "xavi" "chavi"} operating modes applies to all customwords are specific to the ttsvoice a custom word that is required for one voice, may not be required for another voice hence it is important to consider your customvoice for each digital human you create, independently phrases a list of phrases used to provide better speech recognition this is often brand names and uncommon proper nouns that can be difficult to recognise without prior knowledge can be empty type list of strings example "phrases" \["unith", "casio", "idan"] operating modes applies to all ui language unith front end application language current supported languages are curl x 'get' \\ 'https //platform api unith ai/languages/all' \\ h 'accept application/json' \\ h 'authorization bearer yourbearer' "ui languages" { "ar ae" "arabic (united arab emirates)", "bg bg" "bulgarian (bulgaria)", "bs ba" "bosnian (bosnia and herzegovina)", "cs cz" "czech (czechia)", "de de" "german (germany)", "en us" "english (united states)", "es es" "spanish (spain)", "fr fr" "french (france)", "it it" "italian (italy)", "ka ge" "georgian (georgia)", "kk kz" "kazakh (kazakhstan)", "lt lt" "lithuanian (lithuania)", "lv lv" "latvian (latvia)", "nl nl" "dutch (netherlands)", "pl pl" "polish (poland)", "pt pt" "portuguese (portugal)", "ro ro" "romanian (romania)", "ru ru" "russian (russia)", "sk sk" "slovak (slovakia)", "sr rs" "serbian (cyrillic, serbia)", "uk ua" "ukrainian (ukraine)", "th th" "thai (thailand)", "hu hu" "hungarian (hungary)", "id id" "indonesian (indonesia)" } type string example "language" "en us" operating modes applies to all when creating the digital human, "langcode" is used, instead of "language" update digital human example per description in update a digital human docid\ gjy qc6alw5tk6sscxrpp , the below is an example payload that is executed against the put head/update endpoint curl x 'put' \\ 'https //platform api unith ai/head/update' \\ h 'accept application/json' \\ h 'authorization bearer #yourbearer' \\ h 'content type application/json' \\ d '{ "id" "yourheadid", "name" "john", "alias" "john", "ttsvoice" "coco", "greetings" "hi there, i am johnny", "israndomsuggestions" false, "phrases" \[ "unith", "casio" ], "customwords" {"unith" "unithh", "xavi" "chavi"} }' { "id" "yourheadid", "name" "john", "alias" "john", "ttsvoice" "coco", "greetings" "hi there, i am johnny", "israndomsuggestions" false, "phrases" \[ "unith", "casio" ], "customwords" {"unith" "unithh", "xavi" "chavi"} } operational mode parameters operationmode the converational mode that the digital human will employ type fixed value string doc qa ideal for document informed questions & answers leverages unith rag pipeline used to power configuration parameters docid\ qi6kwaiqafhoaqaan5nkg oc open conversation, purely based on chatgpt ttt used for text to video plugin used to leverage another conversational engine instead of unith voiceflow used for guided conversations built with voiceflow see create a digital human docid\ hoboropyem9tuenmqcf s ttt { "operationmode" "ttt", } oc { "operationmode" "oc", "promptconfig" { "system prompt" "act as a sports coach called sally who wants to " }, } doc qa { "operationmode" "doc qa", "promptconfig" { "system prompt" "string" }, } voiceflow { "operationmode" "voiceflow", "voiceflowapikey" "string", } plugin { "operationmode" "plugin", "pluginoperationalmodeconfig" { "name" "\<plugin name>", "url" "\<plugin url>", "options" { "\<optional param>" "option value" } } } unith does not support the updating of operationmodes if the operationmode needs to be changed, you will need to create a new digital human for voiceflow, the "greetings" welcome message must be defined in voiceflow