# TextImprovementsByTextList: DeepL Text List Improvements ## Documentation The text rewritten for fluency, optionally in a writing style or tone. Billed per character on every execution. - Catalog: `DeepL` - Schema: `Write` - Label: Text List Improvements 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 `TextImprovementsByTextList`. 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 | |---|:---:|:---:|:---:|---| | `target_lang` | `varchar2` | ☐ | | The language of the result, such as en-GB or de; when absent the language of the text. | | `text_list` | `clob` | ☑ | | JSON array of texts, or of objects with text and optionally key. | | `tone` | `varchar2` | ☐ | | confident, default, diplomatic, enthusiastic or friendly, optionally prefixed by prefer_. | | `writing_style` | `varchar2` | ☐ | | academic, business, casual, default or simple, optionally prefixed by prefer_. | ## Columns of Table Function The columns of the table function `TextImprovementsByTextList` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `detected_source_language` | `varchar2` | | ☐ | The language detected in the text. | | `improved_text` | `varchar2` | | ☐ | The improved text. | | `key` | `varchar2` | | ☐ | The key of the element in the text list, returned unchanged. | | `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. | | `target_language` | `varchar2` | | ☐ | The language of the result. | | `text` | `varchar2` | | ☐ | The text as sent. |