| Overview |  |
Behaviours: gen_server.
error() = {error, Reason::atom(), Info::term()}
glossary() = #{glossary_id => glossary_id(), name => glossary_name(), source_lang => language(), target_lang => language(), creation_time => nonempty_string(), entry_count => integer()}
glossary_entries() = [glossary_entry()]
glossary_entry() = {nonempty_str_or_binary(), nonempty_str_or_binary()}
glossary_id() = nonempty_string()
glossary_name() = nonempty_str_or_binary()
language() = nonempty_string()
nonempty_str_or_binary() = nonempty_string() | nonempty_binary()
tag() = nonempty_str_or_binary()
tag_list() = [tag()]
translation_options() = #{source_lang => language(), split_sentences => boolean() | nonewlines, preserve_formatting => boolean(), tag_handling => xml, non_splitting_tags => tag_list(), splitting_tags => tag_list(), ignore_tags => tag_list(), outline_detection => boolean(), formality => default | more | less, glossary_id => glossary_id()}
| auth_key/1 | Set the DeepL authentication key. |
| glossary_create/4 | Create a glossary. |
| glossary_delete/1 | Delete a glossary. |
| glossary_entries/1 | Get the entries for a specific glossary. |
| glossary_information/1 | Get detailed information for a specific glossary. |
| glossary_language_pairs/0 | |
| glossary_list/0 | List all glossaries. |
| httpc_profile/1 | Set the inets httpc profile to be used. |
| source_languages/0 | Get the list of languages DeepL can translate from. |
| target_languages/0 | Get the list of languages DeepL can translate to. |
| translate/2 | Translate a list of texts. |
| translate/3 | Translate a list of texts with special translation options. |
| usage/0 | See the usage statistics for you account. |
auth_key(AuthKey::nonempty_string()) -> ok
Set the DeepL authentication key
glossary_create(Name::glossary_name(), SourceLang::language(), TargetLang::language(), Entries::glossary_entries()) -> {ok, glossary()} | error()
Create a glossary
glossary_delete(GlossaryId::glossary_id()) -> ok | error()
Delete a glossary
glossary_entries(GlossaryId::glossary_id()) -> {ok, glossary_entries()} | error()
Get the entries for a specific glossary
glossary_information(GlossaryId::glossary_id()) -> {ok, glossary()} | error()
Get detailed information for a specific glossary
glossary_language_pairs() -> {ok, [{SourceLanguage::language(), TargetLanguage::language()}]} | error()
glossary_list() -> {ok, [glossary()]} | error()
List all glossaries
httpc_profile(Profile::pid() | atom()) -> ok
Set the inets httpc profile to be used
source_languages() -> {ok, [{Language::language(), Name::nonempty_str_or_binary()}]} | error()
Get the list of languages DeepL can translate from
target_languages() -> {ok, [{Language::language(), Name::nonempty_str_or_binary(), SupportsFormality::boolean()}]} | error()
Get the list of languages DeepL can translate to
translate(TargetLang::language(), Texts::[nonempty_str_or_binary()]) -> {ok, [{DetectedLanguage::language(), Text::nonempty_str_or_binary()}]} | error()
Translate a list of texts
translate(TargetLang::language(), Texts::[nonempty_str_or_binary()], Options::translation_options()) -> {ok, [{DetectedLanguage::language(), Text::nonempty_str_or_binary()}]} | error()
Translate a list of texts with special translation options
usage() -> {ok, {CharacterCount::integer(), CharacterLimit::integer()}} | error()
See the usage statistics for you account
Generated by EDoc