Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions api-reference/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -836,6 +836,12 @@
"example": "Use a friendly, diplomatic tone"
}
},
"style_profile_id": {
"description": "Translate with a [style profile](/api-reference/style-profiles/get-style-profile): its glossaries,\nstyle rule lists, translation memories and example documents through one ID. The profile is applied\nper text once the source language is known: the glossaries with a dictionary for the text's language\npair, the style rule list for the target language, the translation memories whose source language\nmatches the text, and the example documents written in the target language. A component that does\nnot fit a text's language pair is left out for that text; this is not an error.\n\nA style profile is a complete set of customizations, so it cannot be combined with `customizations`,\n`glossary_id`, `glossary_ids`, `style_id`, `translation_memory_id`, `translation_memory_threshold` or\n`custom_instructions`. A request that combines them is rejected with `400 Bad Request`. A style\nprofile that does not exist or that your account cannot access is rejected with `404 Not Found`.\n\nAvailable for accounts with style profiles enabled; otherwise the request is rejected with\n`403 Forbidden`.",
"type": "string",
"format": "uuid",
"example": "3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47"
},
"tag_handling": {
"$ref": "#/components/schemas/TagHandlingOption"
},
Expand Down Expand Up @@ -938,6 +944,12 @@
"translation_memory_threshold": {
"$ref": "#/components/schemas/TranslationMemoryThreshold"
},
"style_profile_id": {
"description": "Translate with a [style profile](/api-reference/style-profiles/get-style-profile): its glossaries,\nstyle rule lists, translation memories and example documents through one ID. The profile is applied\nper text once the source language is known: the glossaries with a dictionary for the text's language\npair, the style rule list for the target language, the translation memories whose source language\nmatches the text, and the example documents written in the target language. A component that does\nnot fit a text's language pair is left out for that text; this is not an error.\n\nA style profile is a complete set of customizations, so it cannot be combined with `customizations`,\n`glossary_id`, `glossary_ids`, `style_id`, `translation_memory_id`, `translation_memory_threshold` or\n`custom_instructions`. A request that combines them is rejected with `400 Bad Request`. A style\nprofile that does not exist or that your account cannot access is rejected with `404 Not Found`.\n\nAvailable for accounts with style profiles enabled; otherwise the request is rejected with\n`403 Forbidden`.",
"type": "string",
"format": "uuid",
"example": "3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47"
},
"tag_handling": {
"$ref": "#/components/schemas/TagHandlingOption"
},
Expand Down
38 changes: 38 additions & 0 deletions api-reference/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -668,6 +668,25 @@ paths:
items:
type: string
example: "Use a friendly, diplomatic tone"
style_profile_id:
description: |-
Translate with a [style profile](/api-reference/style-profiles/get-style-profile): its glossaries,
style rule lists, translation memories and example documents through one ID. The profile is applied
per text once the source language is known: the glossaries with a dictionary for the text's language
pair, the style rule list for the target language, the translation memories whose source language
matches the text, and the example documents written in the target language. A component that does
not fit a text's language pair is left out for that text; this is not an error.

A style profile is a complete set of customizations, so it cannot be combined with `customizations`,
`glossary_id`, `glossary_ids`, `style_id`, `translation_memory_id`, `translation_memory_threshold` or
`custom_instructions`. A request that combines them is rejected with `400 Bad Request`. A style
profile that does not exist or that your account cannot access is rejected with `404 Not Found`.

Available for accounts with style profiles enabled; otherwise the request is rejected with
`403 Forbidden`.
type: string
format: uuid
example: 3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47
tag_handling:
$ref: '#/components/schemas/TagHandlingOption'
tag_handling_version:
Expand Down Expand Up @@ -755,6 +774,25 @@ paths:
$ref: '#/components/schemas/TranslationMemoryId'
translation_memory_threshold:
$ref: '#/components/schemas/TranslationMemoryThreshold'
style_profile_id:
description: |-
Translate with a [style profile](/api-reference/style-profiles/get-style-profile): its glossaries,
style rule lists, translation memories and example documents through one ID. The profile is applied
per text once the source language is known: the glossaries with a dictionary for the text's language
pair, the style rule list for the target language, the translation memories whose source language
matches the text, and the example documents written in the target language. A component that does
not fit a text's language pair is left out for that text; this is not an error.

A style profile is a complete set of customizations, so it cannot be combined with `customizations`,
`glossary_id`, `glossary_ids`, `style_id`, `translation_memory_id`, `translation_memory_threshold` or
`custom_instructions`. A request that combines them is rejected with `400 Bad Request`. A style
profile that does not exist or that your account cannot access is rejected with `404 Not Found`.

Available for accounts with style profiles enabled; otherwise the request is rejected with
`403 Forbidden`.
type: string
format: uuid
example: 3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47
tag_handling:
$ref: '#/components/schemas/TagHandlingOption'
outline_detection:
Expand Down
1 change: 1 addition & 0 deletions docs/customize/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ DeepL's customization features let you control terminology, style, and consisten
| [Custom instructions](/docs/customize/custom-instructions) | Tone, phrasing, and domain-specific behavior via natural-language directives | Inline per request via `custom_instructions`, or stored in a style rule list |
| [Translation memories](/docs/customize/using-translation-memories) | Reuse of your previously approved translations for matching segments | Stored on your account; passed per request via `translation_memory_id` |
| [Spoken terms](/docs/customize/improving-transcription-with-spoken-terms) | Recognition of specific terms during Voice API speech transcription | Stored on your account; passed per voice session via `spoken_terms_id` |
| [Style profiles](/api-reference/style-profiles/list-all-style-profiles) | A named bundle of glossaries, style rules, translation memories and example documents for one purpose | Stored on your account; passed per request via `style_profile_id`, which stands in for the individual parameters |

Glossaries, style rules, custom instructions, and translation memories work with both [text translation](/docs/translate/translate-text-quickstart) and [document translation](/docs/translate/translate-documents-quickstart), support all `model_type` values, and can be combined in a single request. Spoken terms apply to [Voice API](/docs/voice/overview) sessions, where they can be combined with glossaries.

Expand Down
Loading