Repository navigation
Releases
Releases · DeepL/deepl-dotnet
v1.23.0
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
DocumentTranslationExceptionnow copiesHttpStatusCodeandShouldRetryfrom theDeepLExceptionthat
caused it; they were alwaysnullbefore.- Added
DeepLClientoverloads ofListTranslationMemorySegmentsAsync()(translation memory ID or
TranslationMemoryInfo) taking aTranslationMemorySegmentsOptions(PageSize,PageCursor,FilterText,
FilterCaseSensitive); options leftnullare not sent. - Added a
DeepLClientoverload ofCreateTranslationMemoryImportAsync()taking a
CreateTranslationMemoryImportOptions(ContentType,DisplayName); itsExtraBodyParametersare added last to
the JSON request body. - Added a
DeepLClientoverload ofImportTranslationMemoryFromFilepathAsync()taking an
ImportTranslationMemoryOptions(DisplayName,ContentType,Timeout).ContentTypeis declared on the import
job and sent with the upload (defaultapplication/xml);ExtraBodyParametersare added last to the import job
request body. - Added
DeepLClientoverloads ofWaitUntilTranslationMemoryJobDoneAsync()and
ExportTranslationMemoryToFilepathAsync()taking aTimeSpan? timeout; aDeepLExceptionis thrown when it
expires before the job finishes. - Added
DeepLClientoverloads ofGetTranslationMemoryJobAsync()andWaitUntilTranslationMemoryJobDoneAsync()
taking aTranslationMemoryJobinstead of the job ID. TranslationMemoryJobconverts implicitly to its job ID, so a job object can also be passed to the
ITranslationMemoryManagermethods taking a job ID.- Added
TranslationMemoryJobStatus.UnknownandStatusValueonTranslationMemoryJobResultand
TranslationMemoryJob, holding the job status as returned by the API. - The new translation memory overloads are members of
DeepLClient; theITranslationMemoryManagerinterface is
unchanged. - Added
DeepLClientoverloads of all eight style rule methods that take a style rule ID (GetStyleRuleAsync(),
UpdateStyleRuleNameAsync(),UpdateStyleRuleConfiguredRulesAsync(),DeleteStyleRuleAsync(),
CreateStyleRuleCustomInstructionAsync(),GetStyleRuleCustomInstructionAsync(),
UpdateStyleRuleCustomInstructionAsync(),DeleteStyleRuleCustomInstructionAsync()) taking aStyleRuleInfo
instead, and overloads of the get, update and delete custom instruction methods taking aCustomInstruction
instead of the instruction ID.CustomInstructionconverts implicitly to its ID. These and the following style rule
overloads are members ofDeepLClient; theIStyleRuleManagerinterface is unchanged. - Added
DeepLClientoverloads ofCreateStyleRuleAsync()andUpdateStyleRuleConfiguredRulesAsync()taking the
configured rules as aDictionary<string, Dictionary<string, string>>(category to rule to value, keyed by the API
names), sent as given, so categories theConfiguredRulesclass lacks can be sent.ConfiguredRulesconverts
implicitly to this map. - Added
DeepLClientoverloads ofCreateStyleRuleAsync(),UpdateStyleRuleNameAsync(),
UpdateStyleRuleConfiguredRulesAsync(),CreateStyleRuleCustomInstructionAsync()and
UpdateStyleRuleCustomInstructionAsync()taking aCreateStyleRuleOptions,UpdateStyleRuleNameOptions,
UpdateStyleRuleConfiguredRulesOptions,CreateStyleRuleCustomInstructionOptionsor
UpdateStyleRuleCustomInstructionOptions. The options classes derive fromBaseRequestOptions: their
ExtraBodyParametersare 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 orMultilingualGlossaryInfoand an
UpdateMultilingualGlossaryOptionsobject (Name,Dictionaries), to rename a glossary and merge entries into
its dictionaries in one request. Only the set properties are sent;ExtraBodyParametersare added last to the
JSON request body. - Added
DeepLClientoverloads ofCreateMultilingualGlossaryAsync()andCreateMultilingualGlossaryFromCsvAsync()
taking aCreateMultilingualGlossaryOptions, and ofReplaceMultilingualGlossaryDictionaryAsync()and
ReplaceMultilingualGlossaryDictionaryFromCsvAsync()taking aReplaceMultilingualGlossaryDictionaryOptions. Both
options classes derive fromBaseRequestOptions: theirExtraBodyParametersare added last to the request body. - Added
DeepLClientoverloads ofGetMultilingualGlossaryAsync()andUpdateMultilingualGlossaryNameAsync()taking
aMultilingualGlossaryInfoinstead of the glossary ID. - The new multilingual glossary methods and overloads are members of
DeepLClient; theIGlossaryManagerinterface
is unchanged. - Added
StyleProfiletoTextTranslateOptionsandDocumentTranslateOptions(the ID or aStyleProfileobject),
and constructors taking aStyleProfile, to translate text and documents with a style profile (sent as
style_profile_id). - Added
Glossary,StyleRuleandTranslationMemorytoDocumentTranslateOptions, replacingGlossaryId,
StyleIdandTranslationMemoryId, as inTextTranslateOptions: each takes the ID or the resource object.
Glossary objects can also be added toDocumentTranslateOptions.GlossaryIds. - Added
DocumentTranslateOptions.FormalityValue: theformalityvalue as a string, sent unchanged instead of
Formalityif set. - Added
DocumentTranslateOptions.FilenameandStreamoverloads ofTranslateDocumentAsync()and
TranslateDocumentUploadAsync()without theinputFileNameparameter, which sendFilenameas the file name.
TheFileInfooverloads sendFilenameinstead of the file's name if it is set. - Added
TranslateDocumentGetStatusAsync(), replacingTranslateDocumentStatusAsync(). - Added a
TranslateDocumentWaitUntilDoneAsync()overload with aTimeSpan? timeout, and
DocumentTranslateOptions.Timeoutfor the wait insideTranslateDocumentAsync(). When the timeout expires, a
DeepLExceptionis thrown (wrapped in aDocumentTranslationExceptionbyTranslateDocumentAsync()). - Added
DocumentStatus.StatusValue, the status string as returned by the API, and
DocumentStatus.StatusCode.Unknownfor statuses this library does not know. - The new document methods and overloads are members of
TranslatorandDeepLClient; the obsoleteITranslator
interface is unchanged. - Added
Glossary,StyleRuleandTranslationMemorytoTextTranslateOptions, replacingGlossaryId,StyleId
andTranslationMemoryId. Each takes the ID or the resource object (GlossaryInfoorMultilingualGlossaryInfo,
StyleRuleInfo,TranslationMemoryInfo), so several resource objects can be combined in one options object. GlossaryInfo,MultilingualGlossaryInfo,StyleRuleInfo,StyleProfileandTranslationMemoryInfoconvert
implicitly to their ID, so they can also be added toTextTranslateOptions.GlossaryIds, mixed with IDs. Anull
object converts tonull, so assigning one leaves the option unset.- Added
FormalityValue,SplitSentencesandModelTypeValuetoTextTranslateOptions: theformality,
split_sentencesandmodel_typevalues as strings, sent unchanged instead of theFormality,
SentenceSplittingModeandModelTypeenum properties if set, for values the enums do not have. - Added the
TagHandlingMode(Html,Xml) andTagHandlingVersion(V1,V2) constants for
TextTranslateOptions.TagHandlingandTagHandlingVersion, which still accept any string. - Added
TextResult.TagHandlingVersion, thetag_handling_versionof the response (nullif absent or not a
string). - Added
IStyleProfileManager, implemented byDeepLClient, to manage style profiles (/v3/style_profiles):
ListStyleProfilesAsync(),CreateStyleProfileAsync(),GetStyleProfileAsync(),UpdateStyleProfileAsync()and
DeleteStyleProfileAsync(), with the modelStyleProfileand the options classesCreateStyleProfileOptionsand
UpdateStyleProfileOptions(which addsName). Options leftnullare 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:ExtraBodyParametersare added to the body last. The glossary, style rule list and
translation memory lists take IDs or resource objects (SetGlossaries(),SetStyleRules(),
SetTranslationMemories()).StyleProfile.CreationTimeandUpdatedTimeare non-nullable. - Added
ISpokenTermsManager, implemented byDeepLClient, to manage Spoken Terms collections (/v3/spoken-terms):
CreateSpokenTermsAsync(),ListSpokenTermsAsync(),GetSpokenTermsAsync(),UpdateSpokenTermsAsync(),
GetSpokenTermsEntriesAsync(),ReplaceSpokenTermsListAsync(),DeleteSpokenTermsAsync()and
DeleteSpokenTermsListAsync(), with the modelsSpokenTerms,SpokenTermsListandSpokenTermsEntries.
Terms are checked like glossary terms before sending; an invalid term throwsArgumentException.
UpdateSpokenTermsAsync()takes the new name and the terms to merge as anUpdateSpokenTermsOptionsobject
(Name,TermLists).CreateSpokenTermsAsync(),UpdateSpokenTermsAsync()andReplaceSpokenTermsListAsync()
take an optionalCreateSpokenTermsOptions,UpdateSpokenTermsOptionsorReplaceSpokenTermsListOptions, whose
ExtraBodyParametersare added last to the JSON request body. - Added the API Pro fields of
GET /v2/usagetoUsage:ApiKeyCharacter(the character usage of the API key,
as opposed to the account-wideCharacter),SpeechToTextMinutes,SpeechToSpeechMinutes,StartTime,
EndTimeandProducts...
v1.22.1
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
Added
- Added support for using multiple glossaries in text and document translation
via theGlossaryIdsproperty (up to 5 glossary IDs) inTextTranslateOptions
andDocumentTranslateOptions. - Added support for style rules in document translation via the
StyleId
property inDocumentTranslateOptions. - Added support for translation memories in document translation via the
TranslationMemoryIdandTranslationMemoryThresholdproperties in
DocumentTranslateOptions. - Added support for the translation memory management endpoints in the
DeepLClientclass:GetTranslationMemoryAsync(),
ListTranslationMemorySegmentsAsync(),DeleteTranslationMemoryAsync(),
CreateTranslationMemoryImportAsync(),UploadTranslationMemoryFileAsync(),
CreateTranslationMemoryExportAsync(),GetTranslationMemoryJobAsync(),
WaitUntilTranslationMemoryJobDoneAsync(),
DownloadTranslationMemoryExportAsync(),
ImportTranslationMemoryFromFilepathAsync()and
ExportTranslationMemoryToFilepathAsync(), along with the
TranslationMemorySegments,TranslationMemorySegment,
TranslationMemoryTargetSegment,TranslationMemoryImport,
TranslationMemoryExport,TranslationMemoryJoband
TranslationMemoryJobResultmodel classes.
Please refer to the README for usage instructions. - Added the
CreationTimeandUpdatedTimeproperties to
TranslationMemoryInfo.
Fixed
- Fixed incorrect example texts in test suite for several languages (Danish, Indonesian,
Japanese, Portuguese, and Russian).
v1.21.0
Added
- Added support for translation memories in text translation via
TranslationMemoryIdandTranslationMemoryThresholdproperties in
TextTranslateOptions. - Added
ListTranslationMemoriesAsync()method to theDeepLClientclass
for listing available translation memories.
Fixed
- Fixed
gitlab releaseCI job by explicitly setting therelease-cliimage to avoid
issues with a missing$HOMEenvironment variable from the global image.
v1.20.0
Added
- Added new language constants from January 2026 API release of 81 new languages.
- Added
ApiPostJsonAsync(),ApiPutJsonAsync(), andApiPatchJsonAsync()methods to
DeepLHttpClient, enabling JSON-encoded API calls. - Added support for style rules CRUD endpoints in the
DeepLClientclass:CreateStyleRuleAsync(),GetStyleRuleAsync(),UpdateStyleRuleNameAsync(),UpdateStyleRuleConfiguredRulesAsync(), andDeleteStyleRuleAsync(). - Added support for style rule custom instruction CRUD endpoints in the
DeepLClientclass:CreateStyleRuleCustomInstructionAsync(),GetStyleRuleCustomInstructionAsync(),UpdateStyleRuleCustomInstructionAsync(), andDeleteStyleRuleCustomInstructionAsync().
Please refer to the README for usage instructions.
v1.19.0
Added
- Added
TagHandlingVersionparameter toTextTranslateOptionsto specify which version of the tag handling algorithm to use. Options arev1andv2.
v1.18.0
Added
- Added
CustomInstructionsproperty toTextTranslateOptionsto customize translation behavior with up to 10 instructions (max 300 characters each). Only supported for target languages:de,en,es,fr,it,ja,ko,zhand their variants. Note: using theCustomInstructionsparameter will usequality_optimizedmodel type as the default. Requests combiningCustomInstructionsand theLatencyOptimizedmodel type will be rejected.
v1.17.0
Added
- Added support for style rules in text translation via the
StyleIdproperty inTextTranslateOptions. - Added
GetAllStyleRulesAsync()method toDeepLClientto retrieve all available style rules with optional pagination and detailed configuration. - Added new model classes:
StyleRuleInfo,ConfiguredRules, andCustomInstructionto support style rules functionality.
v1.16.0
Added
- Added
ExtraBodyParametersoption 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 astarget_lang,source_lang, etc.).
v1.15.0
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.