Skip to content

Releases

v1.23.0

Choose a tag to compare

@github-actions github-actions released this 02 Nov 12:11

TL;DR: new APIs in this release: the Admin API, spoken terms, style profiles and text correction.
Translation memories, style rules and multilingual glossaries gained many options and fixes.
Read Changed and Deprecated before upgrading; no public API is removed in this release.

Added

  • DocumentTranslationException now copies HttpStatusCode and ShouldRetry from the DeepLException that
    caused it; they were always null before.
  • Added DeepLClient overloads of ListTranslationMemorySegmentsAsync() (translation memory ID or
    TranslationMemoryInfo) taking a TranslationMemorySegmentsOptions (PageSize, PageCursor, FilterText,
    FilterCaseSensitive); options left null are not sent.
  • Added a DeepLClient overload of CreateTranslationMemoryImportAsync() taking a
    CreateTranslationMemoryImportOptions (ContentType, DisplayName); its ExtraBodyParameters are added last to
    the JSON request body.
  • Added a DeepLClient overload of ImportTranslationMemoryFromFilepathAsync() taking an
    ImportTranslationMemoryOptions (DisplayName, ContentType, Timeout). ContentType is declared on the import
    job and sent with the upload (default application/xml); ExtraBodyParameters are added last to the import job
    request body.
  • Added DeepLClient overloads of WaitUntilTranslationMemoryJobDoneAsync() and
    ExportTranslationMemoryToFilepathAsync() taking a TimeSpan? timeout; a DeepLException is thrown when it
    expires before the job finishes.
  • Added DeepLClient overloads of GetTranslationMemoryJobAsync() and WaitUntilTranslationMemoryJobDoneAsync()
    taking a TranslationMemoryJob instead of the job ID.
  • TranslationMemoryJob converts implicitly to its job ID, so a job object can also be passed to the
    ITranslationMemoryManager methods taking a job ID.
  • Added TranslationMemoryJobStatus.Unknown and StatusValue on TranslationMemoryJobResult and
    TranslationMemoryJob, holding the job status as returned by the API.
  • The new translation memory overloads are members of DeepLClient; the ITranslationMemoryManager interface is
    unchanged.
  • Added DeepLClient overloads of all eight style rule methods that take a style rule ID (GetStyleRuleAsync(),
    UpdateStyleRuleNameAsync(), UpdateStyleRuleConfiguredRulesAsync(), DeleteStyleRuleAsync(),
    CreateStyleRuleCustomInstructionAsync(), GetStyleRuleCustomInstructionAsync(),
    UpdateStyleRuleCustomInstructionAsync(), DeleteStyleRuleCustomInstructionAsync()) taking a StyleRuleInfo
    instead, and overloads of the get, update and delete custom instruction methods taking a CustomInstruction
    instead of the instruction ID. CustomInstruction converts implicitly to its ID. These and the following style rule
    overloads are members of DeepLClient; the IStyleRuleManager interface is unchanged.
  • Added DeepLClient overloads of CreateStyleRuleAsync() and UpdateStyleRuleConfiguredRulesAsync() taking the
    configured rules as a Dictionary<string, Dictionary<string, string>> (category to rule to value, keyed by the API
    names), sent as given, so categories the ConfiguredRules class lacks can be sent. ConfiguredRules converts
    implicitly to this map.
  • Added DeepLClient overloads of CreateStyleRuleAsync(), UpdateStyleRuleNameAsync(),
    UpdateStyleRuleConfiguredRulesAsync(), CreateStyleRuleCustomInstructionAsync() and
    UpdateStyleRuleCustomInstructionAsync() taking a CreateStyleRuleOptions, UpdateStyleRuleNameOptions,
    UpdateStyleRuleConfiguredRulesOptions, CreateStyleRuleCustomInstructionOptions or
    UpdateStyleRuleCustomInstructionOptions. The options classes derive from BaseRequestOptions: their
    ExtraBodyParameters are added last to the JSON request body (for the configured rules, to the rules map as further
    keys).
  • Added DeepLClient.UpdateMultilingualGlossaryAsync(), taking a glossary ID or MultilingualGlossaryInfo and an
    UpdateMultilingualGlossaryOptions object (Name, Dictionaries), to rename a glossary and merge entries into
    its dictionaries in one request. Only the set properties are sent; ExtraBodyParameters are added last to the
    JSON request body.
  • Added DeepLClient overloads of CreateMultilingualGlossaryAsync() and CreateMultilingualGlossaryFromCsvAsync()
    taking a CreateMultilingualGlossaryOptions, and of ReplaceMultilingualGlossaryDictionaryAsync() and
    ReplaceMultilingualGlossaryDictionaryFromCsvAsync() taking a ReplaceMultilingualGlossaryDictionaryOptions. Both
    options classes derive from BaseRequestOptions: their ExtraBodyParameters are added last to the request body.
  • Added DeepLClient overloads of GetMultilingualGlossaryAsync() and UpdateMultilingualGlossaryNameAsync() taking
    a MultilingualGlossaryInfo instead of the glossary ID.
  • The new multilingual glossary methods and overloads are members of DeepLClient; the IGlossaryManager interface
    is unchanged.
  • Added StyleProfile to TextTranslateOptions and DocumentTranslateOptions (the ID or a StyleProfile object),
    and constructors taking a StyleProfile, to translate text and documents with a style profile (sent as
    style_profile_id).
  • Added Glossary, StyleRule and TranslationMemory to DocumentTranslateOptions, replacing GlossaryId,
    StyleId and TranslationMemoryId, as in TextTranslateOptions: each takes the ID or the resource object.
    Glossary objects can also be added to DocumentTranslateOptions.GlossaryIds.
  • Added DocumentTranslateOptions.FormalityValue: the formality value as a string, sent unchanged instead of
    Formality if set.
  • Added DocumentTranslateOptions.Filename and Stream overloads of TranslateDocumentAsync() and
    TranslateDocumentUploadAsync() without the inputFileName parameter, which send Filename as the file name.
    The FileInfo overloads send Filename instead of the file's name if it is set.
  • Added TranslateDocumentGetStatusAsync(), replacing TranslateDocumentStatusAsync().
  • Added a TranslateDocumentWaitUntilDoneAsync() overload with a TimeSpan? timeout, and
    DocumentTranslateOptions.Timeout for the wait inside TranslateDocumentAsync(). When the timeout expires, a
    DeepLException is thrown (wrapped in a DocumentTranslationException by TranslateDocumentAsync()).
  • Added DocumentStatus.StatusValue, the status string as returned by the API, and
    DocumentStatus.StatusCode.Unknown for statuses this library does not know.
  • The new document methods and overloads are members of Translator and DeepLClient; the obsolete ITranslator
    interface is unchanged.
  • Added Glossary, StyleRule and TranslationMemory to TextTranslateOptions, replacing GlossaryId, StyleId
    and TranslationMemoryId. Each takes the ID or the resource object (GlossaryInfo or MultilingualGlossaryInfo,
    StyleRuleInfo, TranslationMemoryInfo), so several resource objects can be combined in one options object.
  • GlossaryInfo, MultilingualGlossaryInfo, StyleRuleInfo, StyleProfile and TranslationMemoryInfo convert
    implicitly to their ID, so they can also be added to TextTranslateOptions.GlossaryIds, mixed with IDs. A null
    object converts to null, so assigning one leaves the option unset.
  • Added FormalityValue, SplitSentences and ModelTypeValue to TextTranslateOptions: the formality,
    split_sentences and model_type values as strings, sent unchanged instead of the Formality,
    SentenceSplittingMode and ModelType enum properties if set, for values the enums do not have.
  • Added the TagHandlingMode (Html, Xml) and TagHandlingVersion (V1, V2) constants for
    TextTranslateOptions.TagHandling and TagHandlingVersion, which still accept any string.
  • Added TextResult.TagHandlingVersion, the tag_handling_version of the response (null if absent or not a
    string).
  • Added IStyleProfileManager, implemented by DeepLClient, to manage style profiles (/v3/style_profiles):
    ListStyleProfilesAsync(), CreateStyleProfileAsync(), GetStyleProfileAsync(), UpdateStyleProfileAsync() and
    DeleteStyleProfileAsync(), with the model StyleProfile and the options classes CreateStyleProfileOptions and
    UpdateStyleProfileOptions (which adds Name). Options left null are not sent; an empty string clears the
    description or industry and an empty list unlinks all components of that kind. Both options classes derive from
    BaseRequestOptions: ExtraBodyParameters are added to the body last. The glossary, style rule list and
    translation memory lists take IDs or resource objects (SetGlossaries(), SetStyleRules(),
    SetTranslationMemories()). StyleProfile.CreationTime and UpdatedTime are non-nullable.
  • Added ISpokenTermsManager, implemented by DeepLClient, to manage Spoken Terms collections (/v3/spoken-terms):
    CreateSpokenTermsAsync(), ListSpokenTermsAsync(), GetSpokenTermsAsync(), UpdateSpokenTermsAsync(),
    GetSpokenTermsEntriesAsync(), ReplaceSpokenTermsListAsync(), DeleteSpokenTermsAsync() and
    DeleteSpokenTermsListAsync(), with the models SpokenTerms, SpokenTermsList and SpokenTermsEntries.
    Terms are checked like glossary terms before sending; an invalid term throws ArgumentException.
    UpdateSpokenTermsAsync() takes the new name and the terms to merge as an UpdateSpokenTermsOptions object
    (Name, TermLists). CreateSpokenTermsAsync(), UpdateSpokenTermsAsync() and ReplaceSpokenTermsListAsync()
    take an optional CreateSpokenTermsOptions, UpdateSpokenTermsOptions or ReplaceSpokenTermsListOptions, whose
    ExtraBodyParameters are added last to the JSON request body.
  • Added the API Pro fields of GET /v2/usage to Usage: ApiKeyCharacter (the character usage of the API key,
    as opposed to the account-wide Character), SpeechToTextMinutes, SpeechToSpeechMinutes, StartTime,
    EndTime and Products ...
Read more

v1.22.1

Choose a tag to compare

@kabraham13 kabraham13 released this 19 Aug 15:39

Changed

  • Relaxed client-side validation for translation requests using glossaries without a set source language. API-side enforcement remains active until upcoming release.

v1.22.0

Choose a tag to compare

@BriannaDelgado BriannaDelgado released this 12 Aug 01:08
88b0fe5

Added

  • Added support for using multiple glossaries in text and document translation
    via the GlossaryIds property (up to 5 glossary IDs) in TextTranslateOptions
    and DocumentTranslateOptions.
  • Added support for style rules in document translation via the StyleId
    property in DocumentTranslateOptions.
  • Added support for translation memories in document translation via the
    TranslationMemoryId and TranslationMemoryThreshold properties in
    DocumentTranslateOptions.
  • Added support for the translation memory management endpoints in the
    DeepLClient class: GetTranslationMemoryAsync(),
    ListTranslationMemorySegmentsAsync(), DeleteTranslationMemoryAsync(),
    CreateTranslationMemoryImportAsync(), UploadTranslationMemoryFileAsync(),
    CreateTranslationMemoryExportAsync(), GetTranslationMemoryJobAsync(),
    WaitUntilTranslationMemoryJobDoneAsync(),
    DownloadTranslationMemoryExportAsync(),
    ImportTranslationMemoryFromFilepathAsync() and
    ExportTranslationMemoryToFilepathAsync(), along with the
    TranslationMemorySegments, TranslationMemorySegment,
    TranslationMemoryTargetSegment, TranslationMemoryImport,
    TranslationMemoryExport, TranslationMemoryJob and
    TranslationMemoryJobResult model classes.
    Please refer to the README for usage instructions.
  • Added the CreationTime and UpdatedTime properties to
    TranslationMemoryInfo.

Fixed

  • Fixed incorrect example texts in test suite for several languages (Danish, Indonesian,
    Japanese, Portuguese, and Russian).

v1.21.0

Choose a tag to compare

@BriannaDelgado BriannaDelgado released this 09 Apr 18:37
v1.21.0
ff6ffbf

Added

  • Added support for translation memories in text translation via
    TranslationMemoryId and TranslationMemoryThreshold properties in
    TextTranslateOptions.
  • Added ListTranslationMemoriesAsync() method to the DeepLClient class
    for listing available translation memories.

Fixed

  • Fixed gitlab release CI job by explicitly setting the release-cli image to avoid
    issues with a missing $HOME environment variable from the global image.

v1.20.0

Choose a tag to compare

@BriannaDelgado BriannaDelgado released this 26 Mar 20:33
v1.20.0
cdfac38

Added

  • Added new language constants from January 2026 API release of 81 new languages.
  • Added ApiPostJsonAsync(), ApiPutJsonAsync(), and ApiPatchJsonAsync() methods to
    DeepLHttpClient, enabling JSON-encoded API calls.
  • Added support for style rules CRUD endpoints in the DeepLClient class: CreateStyleRuleAsync(), GetStyleRuleAsync(), UpdateStyleRuleNameAsync(), UpdateStyleRuleConfiguredRulesAsync(), and DeleteStyleRuleAsync().
  • Added support for style rule custom instruction CRUD endpoints in the DeepLClient class: CreateStyleRuleCustomInstructionAsync(), GetStyleRuleCustomInstructionAsync(), UpdateStyleRuleCustomInstructionAsync(), and DeleteStyleRuleCustomInstructionAsync().
    Please refer to the README for usage instructions.

v1.19.0

Choose a tag to compare

@BriannaDelgado BriannaDelgado released this 21 Jan 17:00
9976f4c

Added

  • Added TagHandlingVersion parameter to TextTranslateOptions to specify which version of the tag handling algorithm to use. Options are v1 and v2.

v1.18.0

Choose a tag to compare

@BriannaDelgado BriannaDelgado released this 08 Dec 20:19
v1.18.0
9766590

Added

  • Added CustomInstructions property to TextTranslateOptions to customize translation behavior with up to 10 instructions (max 300 characters each). Only supported for target languages: de, en, es, fr, it, ja, ko, zh and their variants. Note: using the CustomInstructions parameter will use quality_optimized model type as the default. Requests combining CustomInstructions and the LatencyOptimized model type will be rejected.

v1.17.0

Choose a tag to compare

@BriannaDelgado BriannaDelgado released this 12 Nov 20:03
v1.17.0
57aa2ce

Added

  • Added support for style rules in text translation via the StyleId property in TextTranslateOptions.
  • Added GetAllStyleRulesAsync() method to DeepLClient to retrieve all available style rules with optional pagination and detailed configuration.
  • Added new model classes: StyleRuleInfo, ConfiguredRules, and CustomInstruction to support style rules functionality.

v1.16.0

Choose a tag to compare

@daniel-jones-dev daniel-jones-dev released this 04 Nov 14:57
fd3323c

Added

  • Added ExtraBodyParameters option to text and document translation methods to pass arbitrary parameters in the request body. This can be used to access beta features or override built-in parameters (such as target_lang, source_lang, etc.).

v1.15.0

Choose a tag to compare

@BriannaDelgado BriannaDelgado released this 25 Apr 20:52
v1.15.0
2189313

Added

  • Added support for the /v3 Multilingual Glossary APIs in the client library while providing backwards compatability for the previous /v2 Glossary endpoints. Please refer to the README or upgrading_to_multilingual_glossaries.md for usage instructions.