diff --git a/api-reference/openapi.json b/api-reference/openapi.json index 6acdac00..502f7369 100644 --- a/api-reference/openapi.json +++ b/api-reference/openapi.json @@ -1050,6 +1050,25 @@ "file": "@document.docx", "glossary_id": "[yourGlossaryId]" } + }, + "StyleRule": { + "summary": "Using a Style Rule List", + "value": { + "source_lang": "EN", + "target_lang": "DE", + "file": "@document.docx", + "style_id": "[yourStyleId]" + } + }, + "TranslationMemory": { + "summary": "Using a Translation Memory", + "value": { + "source_lang": "EN", + "target_lang": "DE", + "file": "@document.docx", + "translation_memory_id": "[yourTranslationMemoryId]", + "translation_memory_threshold": 75 + } } }, "schema": { @@ -1084,6 +1103,17 @@ "glossary_id": { "$ref": "#/components/schemas/GlossaryId" }, + "style_id": { + "description": "Specify the [style rule list](/api-reference/style-rules) to use for the translation.\n\n**Important:** The target language has to match the language of the style rule list.", + "type": "string", + "example": "7ff9bfd6-cd85-4190-8503-d6215a321519" + }, + "translation_memory_id": { + "$ref": "#/components/schemas/TranslationMemoryId" + }, + "translation_memory_threshold": { + "$ref": "#/components/schemas/TranslationMemoryThreshold" + }, "enable_beta_languages": { "description": "This parameter is maintained for backward compatibility and has no effect.", "type": "boolean", diff --git a/api-reference/openapi.yaml b/api-reference/openapi.yaml index 0f312767..febbb8f9 100644 --- a/api-reference/openapi.yaml +++ b/api-reference/openapi.yaml @@ -787,6 +787,21 @@ paths: target_lang: DE file: '@document.docx' glossary_id: '[yourGlossaryId]' + StyleRule: + summary: Using a Style Rule List + value: + source_lang: EN + target_lang: DE + file: '@document.docx' + style_id: '[yourStyleId]' + TranslationMemory: + summary: Using a Translation Memory + value: + source_lang: EN + target_lang: DE + file: '@document.docx' + translation_memory_id: '[yourTranslationMemoryId]' + translation_memory_threshold: 75 schema: type: object required: @@ -823,6 +838,17 @@ paths: $ref: '#/components/schemas/Formality' glossary_id: $ref: '#/components/schemas/GlossaryId' + style_id: + description: |- + Specify the [style rule list](/api-reference/style-rules) to use for the translation. + + **Important:** The target language has to match the language of the style rule list. + type: string + example: 7ff9bfd6-cd85-4190-8503-d6215a321519 + translation_memory_id: + $ref: '#/components/schemas/TranslationMemoryId' + translation_memory_threshold: + $ref: '#/components/schemas/TranslationMemoryThreshold' enable_beta_languages: description: |- This parameter is maintained for backward compatibility and has no effect. diff --git a/docs/resources/roadmap-and-release-notes.mdx b/docs/resources/roadmap-and-release-notes.mdx index 9e5ff26d..07a9e7e1 100644 --- a/docs/resources/roadmap-and-release-notes.mdx +++ b/docs/resources/roadmap-and-release-notes.mdx @@ -10,6 +10,13 @@ rss: true - Usage reporting by language pair + +## June 3 - Style Rules and Translation Memories for Document Translation +- [`POST /v2/document`](/api-reference/document/upload-and-translate-a-document) now accepts `style_id`, `translation_memory_id`, and `translation_memory_threshold`, bringing document translation in line with the parameters already available on text translation. +- `style_id` applies a configured [style rule list](/api-reference/style-rules) to the document translation. +- `translation_memory_id` and `translation_memory_threshold` work as on text translation: pass a translation memory ID to apply stored translations, and set a threshold (0-100) to control how closely source text must match a stored segment. See the [translation memories guide](/docs/learning-how-tos/examples-and-guides/how-to-use-translation-memories). + + ## May 27 - Custom Reporting Tags in deepl-rb - The Ruby client library [`deepl-rb`](https://github.com/DeepLcom/deepl-rb) v3.8.0 now accepts an `additional_headers` argument on `translate` calls, so you can send `X-DeepL-Reporting-Tag` for usage reporting.