DeepLIP (Independent Publisher) (Preview)

DeepL Translator is a neural machine translation service.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Michal Romiszewski
URL	https://github.com/mromiszewski
Email	michal@nbtech.pl

Connector Metadata
Publisher	Michal Romiszewski
DeepL - Plans and pricing	https://docs.microsoft.com/connectors/deeplipip
Website	https://www.deepl.com/
Privacy policy	https://www.deepl.com/privacy/
Categories	Data

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
API Key	securestring	The API Key for this api	True
Plan	string	The API pricing plan to use; either Free or Pro	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Check Document Status	Retrieve the current status of a document translation process.
Check Usage and Limits	Retrieve usage information within the current billing period together with the corresponding account limits.
Create a Glossary	Create a Glossary
Delete a Glossary	Deletes the specified glossary.
Download Translated Document	Once the status of the document translation process is done, the result can be downloaded.
List all Glossaries	List all glossaries and their meta-information, but not the glossary entries.
List Language Pairs Supported by Glossaries	Retrieve the list of language pairs supported by the glossary feature.
Request Translation	The translate function.
Retrieve Glossary Details	Retrieve meta information for a single glossary, omitting the glossary entries.
Retrieve Glossary Entries	List the entries of a single glossary in the format specified by the Accept header.
Retrieve Supported Languages	Retrieve the list of languages that are currently supported for translation, either as source or target language, respectively.
Upload and Translate a Document	This call uploads a document and queues it for translation.

Check Document Status

Operation ID:

getDocumentStatus

Retrieve the current status of a document translation process.

Parameters

Name	Key	Required	Type	Description
Document ID	document_id	True	string	The document ID was sent to the client when the document was uploaded
Document Key	document_key	True	string	The encryption key was sent to the client when the document was uploaded

Returns

Name	Path	Type	Description
document_id	document_id	string	A unique ID assigned to the uploaded document and the requested translation process. The same ID that was used when requesting the translation status.
status	status	string	A short description of the state the document translation process is currently in.
seconds_remaining	seconds_remaining	integer	Estimated number of seconds until the translation is done. This parameter is only included while status is "translating".
billed_characters	billed_characters	integer	The number of characters billed to your account.
error_message	error_message	string	A short description of the error, if available. Note that the content is subject to change. This parameter may be included if an error occurred during translation.

Check Usage and Limits

Operation ID:

getUsage

Retrieve usage information within the current billing period together with the corresponding account limits.

Returns

Name	Path	Type	Description
character_count	character_count	integer	Characters translated so far in the current billing period.
character_limit	character_limit	integer	Current maximum number of characters that can be translated per billing period.
document_limit	document_limit	integer	Documents translated so far in the current billing period.
document_count	document_count	integer	Current maximum number of documents that can be translated per billing period.
team_document_limit	team_document_limit	integer	Documents translated by all users in the team so far in the current billing period.
team_document_count	team_document_count	integer	Current maximum number of documents that can be translated by the team per billing period.

Create a Glossary

Operation ID:

createGlossary

Create a Glossary

Parameters

Name	Key	Required	Type	Description
Name	name	True	string	Name to be associated with the glossary
Source Language	source_lang	True	string	The language in which the source texts in the glossary are specified
Target Language	target_lang	True	string	The language in which the target texts in the glossary are specified
Entries	entries	True	string	The glossary entries in the format specified in the Entries Format parameter
Entries Format	entries_format	True	string	tsv (default) - tab-separated values - csv - comma-separated values

Returns

Body

Glossary

Delete a Glossary

Operation ID:

deleteGlossary

Deletes the specified glossary.

Parameters

Name	Key	Required	Type	Description
Glossary ID	glossary_id	True	string	A unique ID assigned to the glossary

Download Translated Document

Operation ID:

downloadDocument

Once the status of the document translation process is done, the result can be downloaded.

Parameters

Name	Key	Required	Type	Description
Document ID	document_id	True	string	The document ID was sent to the client when the document was uploaded
Document Key	document_key	True	string	The encryption key was sent to the client when the document was uploaded

Returns

response

binary

List all Glossaries

Operation ID:

listGlossaries

List all glossaries and their meta-information, but not the glossary entries.

Returns

Name	Path	Type	Description
glossaries	glossaries	array of Glossary

List Language Pairs Supported by Glossaries

Operation ID:

listGlossaryLanguages

Retrieve the list of language pairs supported by the glossary feature.

Returns

Name	Path	Type	Description
supported_languages	supported_languages	array of object	The list of supported languages
source_lang	supported_languages.source_lang	string	The language in which the source texts in the glossary are specified.
target_lang	supported_languages.target_lang	string	The language in which the target texts in the glossary are specified.

Request Translation

Operation ID:

translateText

The translate function.

Parameters

Name	Key	Required	Type	Description
Text to be translated	text	True	array	Text to be translated. Only UTF-8-encoded plain text is supported
Source Language	source_lang		string	Language of the text to be translated
Target Language	target_lang	True	string	The language into which the text should be translated
Split Sentences	split_sentences		string	Whether to split the input into sentences
Preserve Formatting	preserve_formatting		string	Whether to respect the original formatting
Formality	formality		string	Whether to lean towards formal or informal language.
Glossary ID	glossary_id		string	Specify the glossary to use for the translation
Tag Handling	tag_handling		string	Sets which kind of tags should be handled
Non Splitting Tags	non_splitting_tags		string	Comma-separated list of XML tags which never split sentences
Outline Detection	outline_detection		string	0 disables automatic detection of XML structure
Splitting Tags	splitting_tags		string	Comma-separated list of XML tags which always cause splits
Ignore Tags	ignore_tags		string	Comma-separated list of XML tags that indicate text not to be translated

Returns

Name	Path	Type	Description
translations	translations	array of object
detected_source_language	translations.detected_source_language	string	The detected source language.
text	translations.text	string	The translated text.

Retrieve Glossary Details

Operation ID:

getGlossary

Retrieve meta information for a single glossary, omitting the glossary entries.

Parameters

Name	Key	Required	Type	Description
Glossary ID	glossary_id	True	string	A unique ID assigned to the glossary

Returns

Body

Glossary

Retrieve Glossary Entries

Operation ID:

getGlossaryEntries

List the entries of a single glossary in the format specified by the Accept header.

Parameters

Name	Key	Required	Type	Description
Glossary ID	glossary_id	True	string	A unique ID assigned to the glossary
Format	Accept		string	Currently, supports only text/tab-separated-values

Retrieve Supported Languages

Operation ID:

getLanguages

Retrieve the list of languages that are currently supported for translation, either as source or target language, respectively.

Parameters

Name	Key	Required	Type	Description
Type	type		string	Sets whether source or target languages should be listed

Returns

Name	Path	Type	Description
		array of object
language	language	string	The language code of the given language.
name	name	string	Name of the language in English.
supports_formality	supports_formality	boolean	Denotes formality support in case of a target language listing.

Upload and Translate a Document

Operation ID:

translateDocument

This call uploads a document and queues it for translation.

Parameters

Name	Key	Required	Type	Description
Source Language	source_lang		string	Language of the text to be translated
Target Language	target_lang	True	string	The language into which the text should be translated
File	file	True	file	The file to be translated (.docx,.pptx,.pdf,.htm,.html,.txt)
File Name	filename		string	The name of the uploaded file
Formality	formality		string	Whether to lean towards formal or informal language.
Glossary ID	glossary_id		string	A unique ID assigned to a glossary

Returns

Name	Path	Type	Description
document_id	document_id	string	A unique ID assigned to the uploaded document and the translation process.
document_key	document_key	string	A unique key that is used to encrypt the uploaded document as well as the resulting translation on the server side.

Definitions

GlossaryId

A unique ID assigned to a glossary.

A unique ID assigned to a glossary.

string

Glossary

Name	Path	Type	Description
glossary_id	glossary_id	GlossaryId	A unique ID assigned to a glossary.
name	name	string	Name associated with the glossary.
ready	ready	boolean	Indicates if the newly created glossary can already be used in translate requests. If the created glossary is not yet ready, you have to wait and check the ready status of the glossary before using it in a translate request.
source_lang	source_lang	GlossarySourceLanguage	The language in which the source texts in the glossary are specified.
target_lang	target_lang	GlossaryTargetLanguage	The language in which the target texts in the glossary are specified.
creation_time	creation_time	date-time	The creation time of the glossary in the ISO 8601-1:2019 format (e.g.: 2021-08-03T14:16:18.329Z).
entry_count	entry_count	integer	The number of entries in the glossary.

GlossarySourceLanguage

The language in which the source texts in the glossary are specified.

The language in which the source texts in the glossary are specified.

string

GlossaryTargetLanguage

The language in which the target texts in the glossary are specified.

The language in which the target texts in the glossary are specified.

string

binary

This is the basic data type 'binary'.