# TranslationsByTextList: DeepL Text List Translations ## Documentation The translation of a list of texts, in as few requests as the request size of DeepL allows. Billed per character on every execution. - Catalog: `DeepL` - Schema: `Translate` - Label: Text List Translations This is a read-only table function. The DeepL API may not support changing the data or the Invantive UniversalSQL driver for DeepL does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the DeepL API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `TranslationsByTextList`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `context` | `varchar2` | ☐ | | Text that influences the translation without being translated itself. Not billed. | | `custom_instructions` | `varchar2` | ☐ | | JSON array of up to 10 instructions of at most 300 characters. | | `formality` | `varchar2` | ☐ | | default, more, less, prefer_more or prefer_less. | | `glossary_id` | `varchar2` | ☐ | | The glossary to apply; requires source_lang. | | `glossary_ids` | `varchar2` | ☐ | | Comma-separated list of up to 5 glossaries; excludes glossary_id. | | `ignore_tags` | `varchar2` | ☐ | | Comma-separated XML tags whose content is not translated. | | `model_type` | `varchar2` | ☐ | | quality_optimized, prefer_quality_optimized or latency_optimized. | | `non_splitting_tags` | `varchar2` | ☐ | | Comma-separated XML tags which never split sentences. | | `outline_detection` | `boolean` | ☐ | | False disables the automatic detection of the XML structure. | | `preserve_formatting` | `boolean` | ☐ | | Whether DeepL keeps the formatting even where it would correct it. | | `reporting_tag` | `varchar2` | ☐ | | Custom reporting tag of the request; overrides the connection attribute reporting-tag. | | `source_lang` | `varchar2` | ☐ | | Language of the text. When absent, DeepL detects it; a glossary requires it. | | `split_sentences` | `varchar2` | ☐ | | 0 (no splitting), 1 (default) or nonewlines. | | `splitting_tags` | `varchar2` | ☐ | | Comma-separated XML tags which always split sentences. | | `style_id` | `varchar2` | ☐ | | The style rule list to apply. | | `tag_handling_version` | `varchar2` | ☐ | | v1 or v2. | | `tag_handling` | `varchar2` | ☐ | | xml or html. | | `target_lang` | `varchar2` | ☐ | | The language to translate into, for every element that names none of its own. | | `text_list` | `clob` | ☑ | | JSON array of texts, or of objects with text and optionally key, target_lang, source_lang, glossary_id and context. | | `translation_memory_id` | `varchar2` | ☐ | | The translation memory to apply. | | `translation_memory_threshold` | `int32` | ☐ | | Minimum matching percentage of a translation memory segment; below 50 is 50. | ## Columns of Table Function The columns of the table function `TranslationsByTextList` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `billed_characters` | `int32` | | ☐ | The characters DeepL billed for the text in this execution; 0 when the translation came from the cache. | | `detected_source_language` | `varchar2` | | ☐ | The source language, as given or as detected. | | `key` | `varchar2` | | ☐ | The key of the element in the text list, returned unchanged. | | `model_type_used` | `varchar2` | | ☐ | The model used; only when a model type was requested. | | `ordinal` | `int32` | | ☑ | The position of the element in the text list, starting at 1. | | `request_ordinal` | `int32` | | ☑ | The number of the request the element was sent in, starting at 1. | | `source_lang` | `varchar2` | | ☐ | The source language of the element as requested. | | `tag_handling_version` | `varchar2` | | ☐ | The tag handling algorithm used; only with tag handling. | | `target_lang` | `varchar2` | | ☑ | The target language of the element. | | `text` | `varchar2` | | ☐ | The text as sent. | | `translated_text` | `varchar2` | | ☐ | The translated text. |