class DeepL::Translator

• DeepL::Translator
• Reference
• Object

Overview

DEPRECATED Use V3 MultilingualGlossaryInfo instead

Defined in:

deepl/translator.cr
deepl/v2.cr
deepl/v2/admin.cr
deepl/v2/document.cr
deepl/v2/glossary.cr
deepl/v2/language.cr
deepl/v2/rephrase.cr
deepl/v2/text.cr
deepl/v2/usage.cr
deepl/v3.cr
deepl/v3/glossary.cr
deepl/v3/language.cr
deepl/v3/style_rules.cr
deepl/v3/translation_memory.cr
deepl/v3/voice.cr

Constant Summary

DEEPL_API_VERSION = {{ (env("DEEPL_API_VERSION")) || "v2" }}

DEEPL_DEFAULT_SERVER_URL = "https://api.deepl.com"

Note: The default server URL is set during the compilation process. To change the default server URL, you need to recompile the code.

DEEPL_DEFAULT_SERVER_URL_FREE = "https://api-free.deepl.com"

DEEPL_SERVER_URL = {{ (env("DEEPL_SERVER_URL")) || DEEPL_DEFAULT_SERVER_URL }}

DEEPL_SERVER_URL_FREE = {{ (env("DEEPL_SERVER_URL_FREE")) || DEEPL_DEFAULT_SERVER_URL_FREE }}

HTTP_STATUS_QUOTA_EXCEEDED = 456

HTTP_STATUS_TOO_MANY_REQUESTS = 529

REQUEST_ERROR_MESSAGES = {HTTP::Status::NOT_FOUND.to_i => "Not found", HTTP::Status::BAD_REQUEST.to_i => "Bad request", HTTP::Status::PAYLOAD_TOO_LARGE.to_i => "Payload too large", HTTP::Status::UNSUPPORTED_MEDIA_TYPE.to_i => "Unsupported media type", HTTP::Status::SERVICE_UNAVAILABLE.to_i => "Service unavailable or Document not ready", HTTP::Status::GATEWAY_TIMEOUT.to_i => "Gateway timeout"}

Constructors

• .new(auth_key : Nil | String = nil, user_agent : Nil | String = nil, server_url : Nil | String = nil)

Instance Method Summary

• #admin_create_developer_key(label : String | Nil = nil) : ApiKey

  Create a developer key as an admin

• #admin_deactivate_developer_key(key_id : String) : ApiKey

  Deactivate a developer key as an admin

• #admin_get_analytics(start_date : String, end_date : String, group_by : String | Nil = nil) : AdminUsageReport

  Get usage statistics as an admin

• #admin_get_custom_tag_analytics(start_date : String, end_date : String, aggregate_by : String | Nil = nil, page : Int32 | Nil = nil) : CustomTagUsageReport
• #admin_get_developer_keys : Array(ApiKey)

  Get all developer keys as an admin

• #admin_rename_developer_key(key_id : String, label : String) : ApiKey

  Rename a developer key as an admin

• #admin_set_developer_key_usage_limits(key_id : String, characters : Float64 | Nil = nil, speech_to_text_milliseconds : Float64 | Nil = nil) : ApiKey

  Set developer key usage limits as an admin

• #auth_key : String
• #auth_key=(auth_key : String | Nil)
• #base_server_url : String

  Return the base API server URL without any version suffix.

• #correct_text(text : String | Array(String), target_lang = nil) : Array(RephraseResult)
• #create_custom_instruction(style_id : String, label : String, prompt : String, source_language : String | Nil = nil) : CustomInstruction
• #create_glossary(name, source_lang, target_lang, entries, entry_format = "tsv") : GlossaryInfo
• #create_multilingual_glossary(name : String, dictionaries : Array(GlossaryDictionary)) : MultilingualGlossaryInfo

  Create a multilingual glossary with specified name and dictionaries

• #create_style_rule_list(name : String, language : String, configured_rules : JSON::Any | Nil = nil, custom_instructions : Array(CustomInstruction) | Nil = nil) : StyleRuleList
• #delete_custom_instruction(style_id : String, instruction_id : String) : Nil
• #delete_glossary(glossary : GlossaryInfo) : Bool
• #delete_glossary(glossary_id : String) : Bool
• #delete_glossary_by_name(name : String) : Bool
• #delete_multilingual_glossary(glossary_id : String) : Bool

  Delete a multilingual glossary by ID

• #delete_multilingual_glossary(glossary : MultilingualGlossaryInfo) : Bool

  Delete a multilingual glossary (convenience method)

• #delete_multilingual_glossary_dictionary(glossary_id : String, source_lang : String, target_lang : String) : Bool

  Delete a dictionary from the glossary

• #delete_style_rule_list(style_id : String) : Nil
• #find_glossary_info_by_name(name : String) : GlossaryInfo
• #find_multilingual_glossary_by_name(name : String) : MultilingualGlossaryInfo

  Find multilingual glossary by name

• #get_custom_instruction(style_id : String, instruction_id : String) : CustomInstruction
• #get_glossary_entries(glossary : GlossaryInfo) : String
• #get_glossary_entries(glossary_id : String) : String
• #get_glossary_entries_by_name(name : String) : String
• #get_glossary_info(glossary_id : String) : GlossaryInfo
• #get_glossary_info_by_name(name : String) : Array(GlossaryInfo)
• #get_glossary_language_pairs : Array(GlossaryLanguagePair)

  ameba:disable Naming/AccessorMethodName

• #get_language_resources : Array(LanguageResource)

  ameba:disable Naming/AccessorMethodName

• #get_languages(resource : String, include_values : Array(String) | Nil = nil) : Array(ResourceLanguage)
• #get_multilingual_glossaries_by_name(name : String) : Array(MultilingualGlossaryInfo)

  Get multilingual glossaries by name (multiple matches possible)

• #get_multilingual_glossary(glossary_id : String) : MultilingualGlossaryInfo

  Get multilingual glossary details by ID

• #get_multilingual_glossary_entries(glossary_id : String, source_lang : String, target_lang : String) : GlossaryDictionary

  Get glossary entries for specific language pair

• #get_multilingual_glossary_entries(glossary : MultilingualGlossaryInfo, source_lang : String, target_lang : String) : GlossaryDictionary

  Get glossary entries (convenience method)

• #get_multilingual_glossary_language_pairs : Array(MultilingualGlossaryLanguagePair)

  Get supported language pairs for multilingual glossaries ameba:disable Naming/AccessorMethodName

• #get_source_languages : Array(LanguageInfo)

  ameba:disable Naming/AccessorMethodName

• #get_style_rule_list(style_id : String) : StyleRuleList
• #get_target_languages : Array(LanguageInfo)

  ameba:disable Naming/AccessorMethodName

• #get_usage : Usage

  ameba:disable Naming/AccessorMethodName

• #get_usage_free : UsageFree

  ameba:disable Naming/AccessorMethodName

• #get_usage_pro : UsagePro

  ameba:disable Naming/AccessorMethodName

• #get_voice_streaming_url(source_media_content_type : String, source_language : String | Nil = nil, source_language_mode : String | Nil = nil, target_languages : Array(String) | Nil = nil, message_format : String | Nil = nil, target_media_languages : Array(String) | Nil = nil, target_media_content_type : String | Nil = nil, target_media_voice : String | Nil = nil, spoken_terms_id : String | Nil = nil, glossary_id : String | Nil = nil, formality : String | Nil = nil) : VoiceStreamingResponse
• #guess_target_language : String
• #last_trace_id : String | Nil
• #list_glossaries : Array(GlossaryInfo)
• #list_multilingual_glossaries : Array(MultilingualGlossaryInfo)

  List all multilingual glossaries and their meta-information

• #list_style_rule_lists(page : Int32 | Nil = nil, page_size : Int32 | Nil = nil, detailed : Bool | Nil = nil) : Array(StyleRuleList)

  List style rule lists

• #list_translation_memories(page : Int32 | Nil = nil, page_size : Int32 | Nil = nil) : TranslationMemoryList
• #patch_multilingual_glossary(glossary_id : String, name : String | Nil = nil, dictionaries : Array(GlossaryDictionary) | Nil = nil) : MultilingualGlossaryInfo

  Edit glossary details (name or dictionaries)

• #put_multilingual_glossary_dictionary(glossary_id : String, source_lang : String, target_lang : String, entries : String, entries_format : String = "tsv") : GlossaryEntriesInformation

  Replace or create a dictionary in the glossary

• #rephrase_text(text : String | Array(String), target_lang = nil, writing_style = nil, tone = nil) : Array(RephraseResult)
• #request_reconnection(token : String) : VoiceStreamingResponse
• #resolve_glossary_id_from_name(name : String) : String
• #server_url : String
• #server_url=(server_url : String | Nil)
• #translate_document(path, target_lang, source_lang = nil, formality = nil, glossary_id = nil, glossary_name = nil, output_format = nil, output_file = nil, filename = nil, interval = 5.0, message_prefix = "[deepl.cr] ", &block : String -> )
• #translate_document(path, target_lang, source_lang = nil, formality = nil, glossary_id = nil, glossary_name = nil, output_format = nil, output_file = nil, filename = nil, interval = 5.0, message_prefix = "[deepl.cr] ", block : String -> | Nil = nil)
• #translate_document_download(handle : DocumentHandle, output_file)
• #translate_document_get_status(handle : DocumentHandle) : DocumentStatus
• #translate_document_upload(path : Path | String, target_lang, source_lang = nil, formality = nil, glossary_id = nil, glossary_name = nil, output_format = nil, filename = nil) : DocumentHandle
• #translate_document_wait_until_done(handle : DocumentHandle, interval = 5.0, &block : DocumentStatus -> )
• #translate_document_wait_until_done(handle : DocumentHandle, interval = 5.0, block : DocumentStatus -> | Nil = nil)
• #translate_text(text : String | Array(String), target_lang, source_lang = nil, context = nil, enable_beta_languages : Bool | Nil = nil, custom_instructions : Array(String) | Nil = nil, show_billed_characters : Bool | Nil = nil, split_sentences = nil, preserve_formatting : Bool | Nil = nil, formality = nil, glossary_id = nil, glossary_name = nil, tag_handling = nil, outline_detection : Bool | Nil = nil, non_splitting_tags : Array(String) | Nil = nil, splitting_tags : Array(String) | Nil = nil, ignore_tags : Array(String) | Nil = nil, model_type = nil, style_id = nil, tag_handling_version = nil, translation_memory_id = nil, translation_memory_threshold : Int32 | Nil = nil) : Array(TextResult)
• #update_custom_instruction(style_id : String, instruction_id : String, label : String, prompt : String, source_language : String | Nil = nil) : CustomInstruction
• #update_style_rule_configured_rules(style_id : String, configured_rules : JSON::Any) : StyleRuleList
• #update_style_rule_list(style_id : String, name : String) : StyleRuleList
• #user_agent : String
• #user_agent=(user_agent : String | Nil)

Constructor Detail

Instance Method Detail