translate: Translate texts with DeepL API Pro

In deeplr: Interface to the 'DeepL' Translation API

Translate texts with DeepL API Pro

Description

translate translates texts between different languages using DeepL API Pro. Use available_languages to list all supported languages. An authentication key is required to use this service. The service costs depending on the number of translated characters.

Usage

translate(
  text,
  target_lang = "EN",
  source_lang = NULL,
  split_sentences = TRUE,
  preserve_formatting = FALSE,
  get_detect = FALSE,
  auth_key = "your_key"
)

Arguments

text	character vector to be translated. Only UTF8-encoded plain text is supported. An element can contain several sentences, but should not exceed 30kbytes.
target_lang	target language of the translation. If input is of length 1, all elements are translated into the same language.
source_lang	language of the text to be translated. If parameter is.null, the API guesses the language of the source. If input is of length 1, the same source language is applied to all elements.
split_sentences	if TRUE, the translation engine splits the input into sentences. If only one sentence is translated, it is recommended to set to FALSE to prevent the engine from unintentionally splitting the sentence.
preserve_formatting	if TRUE, the translation engine tries to preserve some aspects (e.g. punctuation at the beginning and end of the sentence, upper/lower case at the beginning of the sentence) of the formatting.
get_detect	if TRUE, the language detected for the source text is included in the response.
auth_key	Authentication key.

Details

To get an authentication key, you need to register for a DeepL API Pro account (https://www.deepl.com/pro#developer).

Value

If get_detect is set to FALSE a character vector containing the translation is returned. Otherwise, a (tibble) is returned with the following columns:

• translation the translated text.

• source_lang detected or specified language of the input text.

References

DeepL API documentations

Examples

## Not run: 
# Translate a single text
translate("I like to translate texts.", target_lang = "DE", auth_key = "x")

# Translate multiple texts into one target language
texts <- c("I like to translate texts.", "Ich übersetze gerne Texte.")
translate(texts, target_lang = "FR", auth_key = "x")

# Translate a single text into multiple target languages
translate("I like to translate texts.", target_lang = c("FR", "DE", "IT"), auth_key = "x")

# Translate multiple texts into different languages
texts <- c("I like to translate texts.", "Ich übersetze gerne Texte.")
translate(texts, target_lang = c("FR", "IT"), auth_key = "x")


## End(Not run)

deeplr documentation built on Nov. 8, 2023, 1:09 a.m.