TranslationsByTextList: DeepL Text List Translations
read only REST
- Catalog:
DeepL - Schema:
Translate - Label: Text List Translations
Can only retrieve data.
Summary
The translation of a list of texts, in as few requests as the request size of DeepL allows. Billed per character on every execution.
API Source
- Endpoint:
/v2/translate
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 45 |
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
context |
varchar2 |
Text that influences the translation without being translated itself. Not billed. | ||
custom_ |
varchar2 |
JSON array of up to 10 instructions of at most 300 characters. | ||
formality |
varchar2 |
default, more, less, prefer_more or prefer_less. | ||
glossary_ |
varchar2 |
The glossary to apply; requires source_lang. | ||
glossary_ |
varchar2 |
Comma-separated list of up to 5 glossaries; excludes glossary_id. | ||
ignore_ |
varchar2 |
Comma-separated XML tags whose content is not translated. | ||
model_ |
varchar2 |
quality_optimized, prefer_quality_optimized or latency_optimized. | ||
non_ |
varchar2 |
Comma-separated XML tags which never split sentences. | ||
outline_ |
boolean |
False disables the automatic detection of the XML structure. | ||
preserve_ |
boolean |
Whether DeepL keeps the formatting even where it would correct it. | ||
reporting_ |
varchar2 |
Custom reporting tag of the request; overrides the connection attribute reporting-tag. | ||
source_ |
varchar2 |
Language of the text. When absent, DeepL detects it; a glossary requires it. | ||
split_ |
varchar2 |
0 (no splitting), 1 (default) or nonewlines. | ||
splitting_ |
varchar2 |
Comma-separated XML tags which always split sentences. | ||
style_ |
varchar2 |
The style rule list to apply. | ||
tag_ |
varchar2 |
xml or html. | ||
tag_ |
varchar2 |
v1 or v2. | ||
target_ |
varchar2 |
The language to translate into, for every element that names none of its own. | ||
text_ |
clob |
JSON array of texts, or of objects with text and optionally key, target_lang, source_lang, glossary_id and context. | ||
translation_ |
varchar2 |
The translation memory to apply. | ||
translation_ |
int32 |
Minimum matching percentage of a translation memory segment; below 50 is 50. |
Table Columns
The columns of the table TranslationsByTextList are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
billed_ |
int32 |
itgen_dpl_billed_characters | filters on the platform, writable | The characters DeepL billed for the text in this execution; 0 when the translation came from the cache. | |
detected_ |
varchar2 |
itgen_dpl_detected_source_language | filters on the platform, writable | The source language, as given or as detected. | |
key |
varchar2 |
itgen_dpl_key | filters on the platform, writable | The key of the element in the text list, returned unchanged. | |
model_ |
varchar2 |
itgen_dpl_model_type_used | filters on the platform, writable | The model used; only when a model type was requested. | |
ordinal |
int32 |
itgen_dpl_ordinal | filters on the platform, writable | The position of the element in the text list, starting at 1. | |
request_ |
int32 |
itgen_dpl_request_ordinal | filters on the platform, writable | The number of the request the element was sent in, starting at 1. | |
source_ |
varchar2 |
itgen_dpl_source_lang | filters on the platform, writable | The source language of the element as requested. | |
tag_ |
varchar2 |
itgen_dpl_tag_handling_version | filters on the platform, writable | The tag handling algorithm used; only with tag handling. | |
target_ |
varchar2 |
itgen_dpl_target_lang | filters on the platform, writable | The target language of the element. | |
text |
varchar2 |
itgen_dpl_text | filters on the platform, writable | The text as sent. | |
translated_ |
varchar2 |
itgen_dpl_translated_text | filters on the platform, writable | The translated text. |