Skip to content

Commit 3f82936

Browse files
fix: Improve clarity around customizations' supported languages
1 parent 5515744 commit 3f82936

5 files changed

Lines changed: 153 additions & 140 deletions

File tree

api-reference/document.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Because the request includes a file upload, it must be an HTTP POST request with
3434

3535
Please be aware that the uploaded document is automatically removed from the server once the translated document has been downloaded. You have to upload the document again in order to restart the translation.
3636

37-
You may specify the glossary to use for the document translation using the `glossary_id` parameter. **Important:** This requires the `source_lang` parameter to be set and the language pair of the glossary has to match the language pair of the request.
37+
You may specify the glossary to use for the document translation using the `glossary_id` parameter. **Important:** This requires the `source_lang` parameter to be set and the language pair of the glossary has to match the language pair of the request. If the target language is a variant (e.g., `EN-GB`), a glossary with the base language (e.g., `EN`) as its target language will still be applied.
3838

3939
For more detail about request body parameters, see the [Request Body Descriptions](/api-reference/document#request-body-descriptions) section further down on the page.
4040

@@ -156,7 +156,10 @@ These examples are for demonstration purposes only. In production code, the auth
156156
</ul>
157157
</ParamField>
158158
<ParamField body="glossary_id" type="string">
159-
A unique ID assigned to a glossary.
159+
Specify the glossary to use for the document translation.
160+
<Note>
161+
<strong>Important:</strong> This requires the <code>source_lang</code> parameter to be set and the language pair of the glossary has to match the language pair of the request. If the target language is a variant (e.g., <code>EN-GB</code>), a glossary with the base language (e.g., <code>EN</code>) as its target language will still be applied.
162+
</Note>
160163
</ParamField>
161164
<ParamField body="output_format" type="string">
162165
File extension of desired format of translated file, for example: `pdf`. If unspecified, by default the translated file will be in the same format as the input file.

api-reference/openapi.yaml

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -433,15 +433,15 @@ paths:
433433
description: |-
434434
Specify the glossary to use for the translation. **Important:** This requires the `source_lang`
435435
parameter to be set. The language pair of the glossary has to match the language pair of the
436-
request.
436+
request. If the target language is a variant (e.g., `EN-GB`), a glossary with the base language (e.g., `EN`) as its target language will still be applied.
437437
type: string
438438
example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
439439
style_id:
440440
description: |-
441-
Specify the [style rule list](/api-reference/style-rules) to use for the translation.
441+
Specify the [style rule list](/api-reference/style-rules) to use for the translation.
442+
443+
**Important:** The target language has to match the language of the style rule list. If the target language is a variant (e.g., `EN-GB`), a style rule list created for the base language (e.g., `EN`) will still be applied.
442444
443-
**Important:** The target language has to match the language of the style rule list.
444-
445445
**Note:** Any request with the `style_id` parameter enabled will use `quality_optimized` models. Requests combining `style_id` and `model_type: latency_optimized` will be rejected.
446446
type: string
447447
example: 7ff9bfd6-cd85-4190-8503-d6215a321519
@@ -525,7 +525,7 @@ paths:
525525
description: |-
526526
Specify the glossary to use for the translation. **Important:** This requires the `source_lang`
527527
parameter to be set. The language pair of the glossary has to match the language pair of the
528-
request.
528+
request. If the target language is a variant (e.g., `EN-GB`), a glossary with the base language (e.g., `EN`) as its target language will still be applied.
529529
type: string
530530
example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
531531
translation_memory_id:
@@ -682,7 +682,12 @@ paths:
682682
formality:
683683
$ref: '#/components/schemas/Formality'
684684
glossary_id:
685-
$ref: '#/components/schemas/GlossaryId'
685+
description: |-
686+
Specify the glossary to use for the document translation. **Important:** This requires the `source_lang`
687+
parameter to be set. The language pair of the glossary has to match the language pair of the
688+
request. If the target language is a variant (e.g., `EN-GB`), a glossary with the base language (e.g., `EN`) as its target language will still be applied.
689+
type: string
690+
example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
686691
enable_beta_languages:
687692
description: |-
688693
No languages are currently in Beta. This parameter is maintained for backward compatibility and has no effect. Previously enabled 81 languages that are now part of the standard language list. See the [full list](/docs/getting-started/supported-languages).

api-reference/translate.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,13 +284,13 @@ error.
284284
<ParamField body="glossary_id" type="string">
285285
Specify the glossary to use for the translation.
286286
<Note>
287-
<strong>Important:</strong> This requires the <code>source_lang</code> parameter to be set and the language pair of the glossary has to match the language pair of the request.
287+
<strong>Important:</strong> This requires the <code>source_lang</code> parameter to be set and the language pair of the glossary has to match the language pair of the request. If the target language is a variant (e.g., <code>EN-GB</code>), a glossary with the base language (e.g., <code>EN</code>) as its target language will still be applied.
288288
</Note>
289289
</ParamField>
290290
<ParamField body="style_id" type="string">
291291
Specify the style rule list to use for the translation which can be used to customize translations according to the selected formatting and style conventions.
292292
<Info>
293-
The target language has to match the language of the style rule list.
293+
The target language has to match the language of the style rule list. If the target language is a variant (e.g., `EN-GB`), a style rule list created for the base language (e.g., `EN`) will still be applied.
294294

295295
Additionally, any request with the `style_id` parameter enabled will default to use the `quality_optimized` model type. Requests combining `style_id` and `model_type: latency_optimized` will be rejected.
296296
</Info>

docs/getting-started/supported-languages.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,3 @@ import { LanguageTable } from "/snippets/language-table.jsx"
1717
<Info>
1818
Text improvement languages have not yet been added to the [`/languages` endpoint](/api-reference/languages/retrieve-supported-languages). For `/write/rephrase`, `writing_style` and `tone` currently work in `DE`, `EN-GB`, and `EN-US`.
1919
</Info>
20-
21-
<Info>
22-
Style rules are supported for the following target languages: `de`, `en`, `es`, `fr`, `it`, `ja`, `ko`, and `zh`. For more details, see the [Style Rules API documentation](/api-reference/style-rules).
23-
</Info>

0 commit comments

Comments
 (0)