Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Simply talk to the agent, ask it its capability and it will tell you how to use it.

Capabilities

The Document Translator has the following capabilities:

  • Document Selection: If multiple documents are uploaded, the translator can ask the user to select a specific document by showing them as buttons. Clicking on these buttons injects a prompt into the chat window.

...

  • Language Selection: The translator can present the user with proposed languages as buttons if the user asks for languages to translate to. Clicking on these buttons injects a prompt into the chat window.

...

  • Time estimation: The translator can estimate the time it will take to translate documents.

...

Known Issues

Small Document Upload

Cannot upload small documents in chat for translation.

...

Sheet names in xlsx files are not translated.

Bullet points within tables*
Bullet points within tables are removed. Text is still there.

Configuration settings

...

Reference in Code

...

DocumentTranslator

Tool Definition

Code Block
{
  "type": "function",
  "function": {
    "name": "DocumentTranslator",
    "parameters": {
      "type": "object",
      "required": [
        "outputLanguage"
      ],
      "properties": {
        "inputDocument": {
          "type": "string",
          "description": "The name of the document to translate"
        },
        "output_language": {
          "type": "string",
          "description": "The language used to generate the translation of the document."
        }
      }
    },
    "description": "The document translator helps you translate documents from one language to another. After translation you can download the document directly."
  }
}

Default Configuration

The following is the default configuration for the module, it consists of four sections that will be discussed in detail below.

Code Block
{
    "glossaryConfig": {
        "scope_id": null,
        "filename": null,
        "active": false
    },
    "textPostProcessingConfig": [],
    "agentConfig": {
        "historyTokenLimit": 400,
        "languageModelName": "AZURE_GPT_4_0613",
        "proposedLanguagesForTranslation": ["English", "Spanish", "French", "German", "Italian", "Portuguese", "Dutch", "Russian", "Swedish" ],
        "supportedDocEndings": [".docx", ".xlsx", ".pptx", ".pdf"]
    },
    "agentPromptConfig": {
        "systemPrompt": "You are a friendly person that helps our customers to translated uploaded documents.\nTherefore, you must find out which uploaded documents they want to translate and to what language before starting the translation.\nIf you cannot find the information from the conversation, nicely ask them to provide it or to upload a document.\nYou have access to tools that can help you with these tasks, but use only one at the time elsewise it is complicated for the user.\nNote that at the moment, only pdf, word, powerpoint and excel documents can be translated, thus the files must end with an .pdf, .docx, .xlsx or .pptx file extension.\nMention this if the user uploads other files."
    },
    "translatorPromptConfig": {
        "systemPromptInstruction": "You are a helpful AI designed to to translate text to a specified language.\nDo it even if the target language is the same as the source language.\nMake sure the translated text contains the same amount of carriage returns '\\n' as the original text block.\nTry to keep the translated text as close to the original as possible and having approximately the same lenght.",
        "inputPromptInstructionTemplate": "List of text blocks to be translated to ${language}:\n\n<INPUT>\n${input_block}\n</INPUT>",
        "outputPromptInstructionTemplate": "<OUTPUT>\n${output_block}\n</OUTPUT>"
    },
    "translatorUserConfig": {
        "languageModelName": "AZURE_GPT_4_0613",
        "maxTokensPerTranlationRequest": 1000,
        "maxTokenPerMinute": 40000,
        "allowedInputLanguages": [
                     "Afrikaans", "Albanian", "Arabic", "Aragonese", "Armenian", "Azeri", "Bashkir", "Basque", "Belarusian", "Bengali", "Bislama",
                     "Bosnian", "Breton", "Bulgarian", "Burmese", "Catalan", "Chamorro", "Chechen", "Chinese", "Cornish", "Corsican", "Croatian",
                     "Czech", "Danish", "Dutch", "English", "Esperanto", "Estonian", "Ewe", "Faroese", "Fijian", "Finnish", "French", "Galician",
                     "Georgian", "German", "Greek", "Greenlandic", "Guaran\u00ed", "Haitian Creole", "Hausa", "Hebrew", "Hindi", "Hungarian", "Icelandic",
                     "Ido", "Indonesian", "Interlingua", "Interlingue", "Inuktitut", "Irish", "Italian", "Japanese", "Javanese", "Kannada", "Kazakh", "Khmer",
                     "Korean", "Kurdish", "Kyrgyz", "Lao", "Latin", "Latvian", "Limburgish", "Lingala", "Lithuanian", "Luxembourgish", "Macedonian", "Malagasy",
                     "Malay", "Malayalam", "Maltese", "Manx", "Maori", "Marathi", "Marshallese", "Mongolian", "Navajo", "Nepali", "Northern Sami", "Norwegian", "Norwegian Bokm\u00e5l",
                     "Norwegian Nynorsk", "Occitan", "Ojibwe", "Old Church Slavonic", "Ossetian", "Pashto", "Persian", "Polish", "Portuguese", "Punjabi", "Quechua", "Romanian",
                     "Romansch", "Russian", "Samoan", "Sanskrit", "Sardinian", "Scottish Gaelic", "Serbian", "Serbo-Croatian", "Sichuan Yi", "Sindhi", "Slovak", "Slovene",
                     "Somali", "Spanish", "Sundanese", "Swahili", "Swedish", "Tagalog", "Tahitian", "Tajik", "Tamil", "Tatar", "Telugu", "Thai", "Tibetan", "Tongan",
                     "Tswana", "Turkish", "Turkmen", "Ukrainian", "Urdu", "Uyghur", "Uzbek", "Vietnamese", "Volap\u00fck", "Walloon", "Welsh", "West Frisian", "Yiddish",
                     "Yoruba", "Zhuang", "Zulu" ]
    }
}

...

Configuration Parts

GlossaryConfig

The glossary is expected to be in an .xlsx file within the knowledge base.

Parameter

Description

Default Value

scope_id

The scope id within the knowledge base

""

filename

The filename of the .xlsx file

""

active

If the glossary is used or not

False

Code Block
{
  "scope_id": "",
  "filename": "",
  "active": false
      }

PostProcessorConfig
The post processors are a list of text processors that are applied to translations

...

Parameter

...

Description

...

Default Value

...

name

...

Name of the processor

...

active

...

If the processor is used or not

...

False

...

applied_to_languages

...

The languages that will be processed by this processor.

...

[]

At the moment there are two valid processors "Replace sharp s with ss" and "American to British"

Code Block
[{
    "name": "Replace sharp s with ss",
    "active": true,
    "applied_to_languages": ["German"]
},
{
    "name": "American to British",
    "active": true,
    "applied_to_languages": ["English"]
}]

AgentConfig

Parameter

Description

Default

historyTokenLimit

The number of tokens used from the history when calling the LLM.

400

languageModelName

The name of the language model to use for the agent.

"AZURE_GPT_4_TURBO_2024_0409"

proposedLanguagesForTranslation

The languages that the agent proposes to translate to.

["English", "Spanish", "French", "German", "Italian", "Portuguese","Dutch","Russian", "Swedish"]

supportedDocEndings

The supported document endings for translation.

[".pdf", ".docx", ".xlsx", ".pptx"]

Example

Code Block
languagejson
{
    "historyTokenLimit": 400,
    "languageModelName": "AZURE_GPT_4_TURBO_2024_0409",
    "proposedLanguagesForTranslation": ["English", "Spanish", "French", "German", "Italian", "Portuguese", "Dutch", "Russian", "Swedish" ],
    "supportedDocEndings": [".pdf", ".docx", ".xlsx", ".pptx"]
}

AgentPromptConfi
❗Only adjust prompts if you are fully familiar with the code logic. Small changes can break the module or reduce the output quality.

Parameter

Description

systemPrompt

System prompt for document translation agent.

Default Value

Code Block
You are a friendly person that helps our customers to translate uploaded documents.
Therefore, you must find out which uploaded documents they want to translate and to what
language before starting the translation. If you cannot find the information from
the conversation, nicely ask them to provide it or to upload a document.
You have access to tools that can help you with these tasks, but use only one at a time
else it is complicated for the user.
Note that at the moment, only Word and Excel documents can be translated, thus the files must
end with a .docx or .xlsx file extension. Mention this if the user uploads other files.

Example

Code Block
languagejson
{
    "systemPrompt": "You are a friendly person that helps our customers to translate uploaded documents. Therefore, you must find out which uploaded documents they want to translate and to what language before starting the translation. If you cannot find the information from the conversation, nicely ask them to provide it or to upload a document. You have access to tools that can help you with these tasks, but use only one at a time else it is complicated for the user. Note that at the moment, only Word and Excel documents can be translated, thus the files must end with a .docx or .xlsx file extension. Mention this if the user uploads other files."
}

TranslatorPromptConfig
❗Only adjust prompts if you are fully familiar with the code logic. Small changes can break the module or reduce the output quality.

Parameter

Description

Default Value

systemPromptInstruction

System prompt instruction for the document translation module.

See below

inputPromptInstructionTemplate

Input prompt for translating an array of text blocks with word formatting tags to a specified language.

See below

outputPromptInstructionTemplate

Output prompt instruction template.

See below

Default Values

  • systemPromptInstruction:

    Code Block
    You are a helpful AI designed to translate text to a specified language.
    Do it even if the target language is the same as the source language.
    Make sure the translated text contains the same amount of carriage returns
    '\\\\n' as the original text block and keep the number of characters per line
    approximately the same.
  • inputPromptInstructionTemplate:

    Code Block
    List of text blocks to be translated to ${language}:
    
    <INPUT>
    ${input_block}
    </INPUT>
  • outputPromptInstructionTemplate:

    Code Block
    <OUTPUT>
    ${output_block}
    </OUTPUT>

Example

Code Block
languagejson
{
    "systemPromptInstruction": "You are a helpful AI designed to translate text to a specified language. Do it even if the target language is the same as the source language. Make sure the translated text contains the same amount of carriage returns '\\n' as the original text block and keep the number of characters per line approximately the same.",
    "inputPromptInstructionTemplate": "List of text blocks to be translated to ${language}:\n\n<INPUT>\n${input_block}\n</INPUT>",
    "outputPromptInstructionTemplate": "<OUTPUT>\n${output_block}\n</OUTPUT>",
}

TranslatorUserConfig

Parameter

Description

Default Value

languageModelName

The model that will be used to translate between languages.

"AZURE_GPT_4_0613"

maxTokensPerTranlationRequest

The maximum number of tokens that will be translated at once. If the model cannot handle more than this many tokens in a single request then it will be split into multiple requests.

1000

maxTokenPerMinute

The maximum number of tokens available for translation tasks per minute.

40000

allowedInputLanguages

Languages that can be recognized to use correspondingly configured few-shot examples, glossary for translation and postprocessing of text.

["Afrikaans", ..,"Zulu"]

Full Example

...

languagejson

...

The document translator uses multiple configuration corresponding to different services. More information for each part can be found following the links below