From 6bd2237d6b491700ff93556f5b8775211642f2ed Mon Sep 17 00:00:00 2001 From: Animenosekai <40539549+Animenosekai@users.noreply.github.com> Date: Tue, 31 Oct 2023 04:36:54 +0100 Subject: [PATCH] [update] trying out new reference --- docs/eng/reference/__info__.md | 2 +- docs/eng/reference/exceptions.md | 138 ++---- docs/eng/reference/language.md | 466 +++++------------- docs/eng/reference/models.md | 418 ++++------------ docs/eng/reference/server/server.md | 14 +- docs/eng/reference/translate.md | 10 +- docs/eng/reference/translators/README.md | 58 +-- docs/eng/reference/translators/base.md | 158 ++---- .../reference/translators/base_aggregator.md | 6 +- docs/eng/reference/translators/bing.md | 50 +- docs/eng/reference/translators/deepl.md | 62 +-- docs/eng/reference/translators/google.md | 22 +- docs/eng/reference/translators/libre.md | 6 +- docs/eng/reference/translators/microsoft.md | 18 +- docs/eng/reference/translators/mymemory.md | 18 +- docs/eng/reference/translators/papago.md | 38 +- docs/eng/reference/translators/pons.md | 14 +- docs/eng/reference/translators/qcri.md | 14 +- docs/eng/reference/translators/reverso.md | 6 +- .../eng/reference/translators/translatecom.md | 14 +- docs/eng/reference/translators/yandex.md | 14 +- docs/eng/reference/utils/audio.md | 150 ++---- docs/eng/reference/utils/gtoken.md | 26 +- docs/eng/reference/utils/hasher.md | 14 +- docs/eng/reference/utils/importer.md | 30 +- docs/eng/reference/utils/lru.md | 30 +- docs/eng/reference/utils/queue.md | 10 +- docs/eng/reference/utils/request.md | 70 +-- docs/eng/reference/utils/sanitize.md | 10 +- docs/eng/reference/utils/utils.md | 10 +- docs/eng/reference/utils/vectorize.md | 58 +-- .../Language.postman_collection.utils.json | 2 +- .../Work.postman_collection.utils.json | 2 +- docs/eng/server/Sections/Language.md | 4 +- docs/eng/server/Sections/Work.md | 118 ++--- docs/fra/reference/__info__.md | 2 +- docs/fra/reference/exceptions.md | 138 ++---- docs/fra/reference/language.md | 466 +++++------------- docs/fra/reference/models.md | 418 ++++------------ docs/fra/reference/server/server.md | 14 +- docs/fra/reference/translate.md | 10 +- docs/fra/reference/translators/README.md | 58 +-- docs/fra/reference/translators/base.md | 158 ++---- .../reference/translators/base_aggregator.md | 6 +- docs/fra/reference/translators/bing.md | 50 +- docs/fra/reference/translators/deepl.md | 62 +-- docs/fra/reference/translators/google.md | 22 +- docs/fra/reference/translators/libre.md | 6 +- docs/fra/reference/translators/microsoft.md | 18 +- docs/fra/reference/translators/mymemory.md | 18 +- docs/fra/reference/translators/papago.md | 38 +- docs/fra/reference/translators/pons.md | 14 +- docs/fra/reference/translators/qcri.md | 14 +- docs/fra/reference/translators/reverso.md | 6 +- .../fra/reference/translators/translatecom.md | 14 +- docs/fra/reference/translators/yandex.md | 14 +- docs/fra/reference/utils/audio.md | 150 ++---- docs/fra/reference/utils/gtoken.md | 26 +- docs/fra/reference/utils/hasher.md | 14 +- docs/fra/reference/utils/importer.md | 30 +- docs/fra/reference/utils/lru.md | 30 +- docs/fra/reference/utils/queue.md | 10 +- docs/fra/reference/utils/request.md | 70 +-- docs/fra/reference/utils/sanitize.md | 10 +- docs/fra/reference/utils/utils.md | 10 +- docs/fra/reference/utils/vectorize.md | 58 +-- .../Language.postman_collection.utils.json | 2 +- .../Work.postman_collection.utils.json | 2 +- docs/fra/server/Sections/Language.md | 4 +- docs/fra/server/Sections/Work.md | 118 ++--- docs/jpn/reference/__info__.md | 2 +- docs/jpn/reference/exceptions.md | 138 ++---- docs/jpn/reference/language.md | 466 +++++------------- docs/jpn/reference/models.md | 418 ++++------------ docs/jpn/reference/server/server.md | 14 +- docs/jpn/reference/translate.md | 10 +- docs/jpn/reference/translators/README.md | 58 +-- docs/jpn/reference/translators/base.md | 158 ++---- .../reference/translators/base_aggregator.md | 6 +- docs/jpn/reference/translators/bing.md | 50 +- docs/jpn/reference/translators/deepl.md | 62 +-- docs/jpn/reference/translators/google.md | 22 +- docs/jpn/reference/translators/libre.md | 6 +- docs/jpn/reference/translators/microsoft.md | 18 +- docs/jpn/reference/translators/mymemory.md | 18 +- docs/jpn/reference/translators/papago.md | 38 +- docs/jpn/reference/translators/pons.md | 14 +- docs/jpn/reference/translators/qcri.md | 14 +- docs/jpn/reference/translators/reverso.md | 6 +- .../jpn/reference/translators/translatecom.md | 14 +- docs/jpn/reference/translators/yandex.md | 14 +- docs/jpn/reference/utils/audio.md | 150 ++---- docs/jpn/reference/utils/gtoken.md | 26 +- docs/jpn/reference/utils/hasher.md | 14 +- docs/jpn/reference/utils/importer.md | 30 +- docs/jpn/reference/utils/lru.md | 30 +- docs/jpn/reference/utils/queue.md | 10 +- docs/jpn/reference/utils/request.md | 70 +-- docs/jpn/reference/utils/sanitize.md | 10 +- docs/jpn/reference/utils/utils.md | 10 +- docs/jpn/reference/utils/vectorize.md | 58 +-- .../Language.postman_collection.utils.json | 2 +- .../Work.postman_collection.utils.json | 2 +- .../Language.md" | 4 +- .../Work.md" | 118 ++--- .../server/docs/eng/reference/__info__.md | 2 +- .../server/docs/eng/reference/exceptions.md | 138 ++---- .../server/docs/eng/reference/language.md | 466 +++++------------- .../server/docs/eng/reference/models.md | 418 ++++------------ .../docs/eng/reference/server/server.md | 14 +- .../server/docs/eng/reference/translate.md | 10 +- .../docs/eng/reference/translators/README.md | 58 +-- .../docs/eng/reference/translators/base.md | 158 ++---- .../reference/translators/base_aggregator.md | 6 +- .../docs/eng/reference/translators/bing.md | 50 +- .../docs/eng/reference/translators/deepl.md | 62 +-- .../docs/eng/reference/translators/google.md | 22 +- .../docs/eng/reference/translators/libre.md | 6 +- .../eng/reference/translators/microsoft.md | 18 +- .../eng/reference/translators/mymemory.md | 18 +- .../docs/eng/reference/translators/papago.md | 38 +- .../docs/eng/reference/translators/pons.md | 14 +- .../docs/eng/reference/translators/qcri.md | 14 +- .../docs/eng/reference/translators/reverso.md | 6 +- .../eng/reference/translators/translatecom.md | 14 +- .../docs/eng/reference/translators/yandex.md | 14 +- .../server/docs/eng/reference/utils/audio.md | 150 ++---- .../server/docs/eng/reference/utils/gtoken.md | 26 +- .../server/docs/eng/reference/utils/hasher.md | 14 +- .../docs/eng/reference/utils/importer.md | 30 +- .../server/docs/eng/reference/utils/lru.md | 30 +- .../server/docs/eng/reference/utils/queue.md | 10 +- .../docs/eng/reference/utils/request.md | 70 +-- .../docs/eng/reference/utils/sanitize.md | 10 +- .../server/docs/eng/reference/utils/utils.md | 10 +- .../docs/eng/reference/utils/vectorize.md | 58 +-- .../Language.postman_collection.utils.json | 2 +- .../Work.postman_collection.utils.json | 2 +- .../docs/eng/server/Sections/Language.md | 4 +- .../server/docs/eng/server/Sections/Work.md | 118 ++--- .../server/docs/fra/reference/__info__.md | 2 +- .../server/docs/fra/reference/exceptions.md | 138 ++---- .../server/docs/fra/reference/language.md | 466 +++++------------- .../server/docs/fra/reference/models.md | 418 ++++------------ .../docs/fra/reference/server/server.md | 14 +- .../server/docs/fra/reference/translate.md | 10 +- .../docs/fra/reference/translators/README.md | 58 +-- .../docs/fra/reference/translators/base.md | 158 ++---- .../reference/translators/base_aggregator.md | 6 +- .../docs/fra/reference/translators/bing.md | 50 +- .../docs/fra/reference/translators/deepl.md | 62 +-- .../docs/fra/reference/translators/google.md | 22 +- .../docs/fra/reference/translators/libre.md | 6 +- .../fra/reference/translators/microsoft.md | 18 +- .../fra/reference/translators/mymemory.md | 18 +- .../docs/fra/reference/translators/papago.md | 38 +- .../docs/fra/reference/translators/pons.md | 14 +- .../docs/fra/reference/translators/qcri.md | 14 +- .../docs/fra/reference/translators/reverso.md | 6 +- .../fra/reference/translators/translatecom.md | 14 +- .../docs/fra/reference/translators/yandex.md | 14 +- .../server/docs/fra/reference/utils/audio.md | 150 ++---- .../server/docs/fra/reference/utils/gtoken.md | 26 +- .../server/docs/fra/reference/utils/hasher.md | 14 +- .../docs/fra/reference/utils/importer.md | 30 +- .../server/docs/fra/reference/utils/lru.md | 30 +- .../server/docs/fra/reference/utils/queue.md | 10 +- .../docs/fra/reference/utils/request.md | 70 +-- .../docs/fra/reference/utils/sanitize.md | 10 +- .../server/docs/fra/reference/utils/utils.md | 10 +- .../docs/fra/reference/utils/vectorize.md | 58 +-- .../Language.postman_collection.utils.json | 2 +- .../Work.postman_collection.utils.json | 2 +- .../docs/fra/server/Sections/Language.md | 4 +- .../server/docs/fra/server/Sections/Work.md | 118 ++--- .../server/docs/jpn/reference/__info__.md | 2 +- .../server/docs/jpn/reference/exceptions.md | 138 ++---- .../server/docs/jpn/reference/language.md | 466 +++++------------- .../server/docs/jpn/reference/models.md | 418 ++++------------ .../docs/jpn/reference/server/server.md | 14 +- .../server/docs/jpn/reference/translate.md | 10 +- .../docs/jpn/reference/translators/README.md | 58 +-- .../docs/jpn/reference/translators/base.md | 158 ++---- .../reference/translators/base_aggregator.md | 6 +- .../docs/jpn/reference/translators/bing.md | 50 +- .../docs/jpn/reference/translators/deepl.md | 62 +-- .../docs/jpn/reference/translators/google.md | 22 +- .../docs/jpn/reference/translators/libre.md | 6 +- .../jpn/reference/translators/microsoft.md | 18 +- .../jpn/reference/translators/mymemory.md | 18 +- .../docs/jpn/reference/translators/papago.md | 38 +- .../docs/jpn/reference/translators/pons.md | 14 +- .../docs/jpn/reference/translators/qcri.md | 14 +- .../docs/jpn/reference/translators/reverso.md | 6 +- .../jpn/reference/translators/translatecom.md | 14 +- .../docs/jpn/reference/translators/yandex.md | 14 +- .../server/docs/jpn/reference/utils/audio.md | 150 ++---- .../server/docs/jpn/reference/utils/gtoken.md | 26 +- .../server/docs/jpn/reference/utils/hasher.md | 14 +- .../docs/jpn/reference/utils/importer.md | 30 +- .../server/docs/jpn/reference/utils/lru.md | 30 +- .../server/docs/jpn/reference/utils/queue.md | 10 +- .../docs/jpn/reference/utils/request.md | 70 +-- .../docs/jpn/reference/utils/sanitize.md | 10 +- .../server/docs/jpn/reference/utils/utils.md | 10 +- .../docs/jpn/reference/utils/vectorize.md | 58 +-- .../Language.postman_collection.utils.json | 2 +- .../Work.postman_collection.utils.json | 2 +- .../Language.md" | 4 +- .../Work.md" | 118 ++--- 210 files changed, 3402 insertions(+), 9078 deletions(-) diff --git a/docs/eng/reference/__info__.md b/docs/eng/reference/__info__.md index c756dbc..265d0ca 100644 --- a/docs/eng/reference/__info__.md +++ b/docs/eng/reference/__info__.md @@ -1,5 +1,5 @@ # *module* **__info__** -> [Source: ../../../translatepy/__info__.py @ line 0](../../../translatepy/__info__.py#L0) +> [Source: ../../../translatepy/__info__.py](../../../translatepy/__info__.py#L0) Stores information on the current module version diff --git a/docs/eng/reference/exceptions.md b/docs/eng/reference/exceptions.md index ad84d31..059cd10 100644 --- a/docs/eng/reference/exceptions.md +++ b/docs/eng/reference/exceptions.md @@ -1,141 +1,73 @@ # *module* **exceptions** -> [Source: ../../../translatepy/exceptions.py @ line 0](../../../translatepy/exceptions.py#L0) +> [Source: ../../../translatepy/exceptions.py](../../../translatepy/exceptions.py#L0) A list of exceptions used throughout translatepy -## *class* **TranslatepyException** +## *class* [**TranslatepyException**](../../../translatepy/exceptions.py#L5-L9) -> [Source: ../../../translatepy/exceptions.py @ line 5-9](../../../translatepy/exceptions.py#L5-L9) +### *attr* [TranslatepyException.**LOG**](../../../translatepy/exceptions.py#L6) -### *attr* TranslatepyException.**LOG** +## *class* [**NoResult**](../../../translatepy/exceptions.py#L12-L18) -> [Source: ../../../translatepy/exceptions.py @ line 6](../../../translatepy/exceptions.py#L6) +### *attr* [NoResult.**STATUS_CODE**](../../../translatepy/exceptions.py#L13) -## *class* **NoResult** +### *attr* [NoResult.**MESSAGE**](../../../translatepy/exceptions.py#L14) -> [Source: ../../../translatepy/exceptions.py @ line 12-18](../../../translatepy/exceptions.py#L12-L18) +### *attr* [NoResult.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L15) -### *attr* NoResult.**STATUS_CODE** +## *class* [**ParameterTypeError**](../../../translatepy/exceptions.py#L21-L27) -> [Source: ../../../translatepy/exceptions.py @ line 13](../../../translatepy/exceptions.py#L13) +### *attr* [ParameterTypeError.**STATUS_CODE**](../../../translatepy/exceptions.py#L22) -### *attr* NoResult.**MESSAGE** +### *attr* [ParameterTypeError.**MESSAGE**](../../../translatepy/exceptions.py#L23) -> [Source: ../../../translatepy/exceptions.py @ line 14](../../../translatepy/exceptions.py#L14) +### *attr* [ParameterTypeError.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L24) -### *attr* NoResult.**EXCEPTION_NAME** +## *class* [**UnknownLanguage**](../../../translatepy/exceptions.py#L30-L38) -> [Source: ../../../translatepy/exceptions.py @ line 15](../../../translatepy/exceptions.py#L15) +### *attr* [UnknownLanguage.**STATUS_CODE**](../../../translatepy/exceptions.py#L31) -## *class* **ParameterTypeError** +### *attr* [UnknownLanguage.**MESSAGE**](../../../translatepy/exceptions.py#L32) -> [Source: ../../../translatepy/exceptions.py @ line 21-27](../../../translatepy/exceptions.py#L21-L27) +### *attr* [UnknownLanguage.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L33) -### *attr* ParameterTypeError.**STATUS_CODE** +## *class* [**UnknownTranslator**](../../../translatepy/exceptions.py#L41-L49) -> [Source: ../../../translatepy/exceptions.py @ line 22](../../../translatepy/exceptions.py#L22) +### *attr* [UnknownTranslator.**STATUS_CODE**](../../../translatepy/exceptions.py#L42) -### *attr* ParameterTypeError.**MESSAGE** +### *attr* [UnknownTranslator.**MESSAGE**](../../../translatepy/exceptions.py#L43) -> [Source: ../../../translatepy/exceptions.py @ line 23](../../../translatepy/exceptions.py#L23) +### *attr* [UnknownTranslator.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L44) -### *attr* ParameterTypeError.**EXCEPTION_NAME** +## *class* [**UnsupportedMethod**](../../../translatepy/exceptions.py#L52-L58) -> [Source: ../../../translatepy/exceptions.py @ line 24](../../../translatepy/exceptions.py#L24) +### *attr* [UnsupportedMethod.**STATUS_CODE**](../../../translatepy/exceptions.py#L53) -## *class* **UnknownLanguage** +### *attr* [UnsupportedMethod.**MESSAGE**](../../../translatepy/exceptions.py#L54) -> [Source: ../../../translatepy/exceptions.py @ line 30-38](../../../translatepy/exceptions.py#L30-L38) +### *attr* [UnsupportedMethod.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L55) -### *attr* UnknownLanguage.**STATUS_CODE** +## *class* [**UnsupportedLanguage**](../../../translatepy/exceptions.py#L61-L67) -> [Source: ../../../translatepy/exceptions.py @ line 31](../../../translatepy/exceptions.py#L31) +### *attr* [UnsupportedLanguage.**STATUS_CODE**](../../../translatepy/exceptions.py#L62) -### *attr* UnknownLanguage.**MESSAGE** +### *attr* [UnsupportedLanguage.**MESSAGE**](../../../translatepy/exceptions.py#L63) -> [Source: ../../../translatepy/exceptions.py @ line 32](../../../translatepy/exceptions.py#L32) +### *attr* [UnsupportedLanguage.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L64) -### *attr* UnknownLanguage.**EXCEPTION_NAME** +## *class* [**ServiceURLError**](../../../translatepy/exceptions.py#L70-L76) -> [Source: ../../../translatepy/exceptions.py @ line 33](../../../translatepy/exceptions.py#L33) +### *attr* [ServiceURLError.**STATUS_CODE**](../../../translatepy/exceptions.py#L71) -## *class* **UnknownTranslator** +### *attr* [ServiceURLError.**MESSAGE**](../../../translatepy/exceptions.py#L72) -> [Source: ../../../translatepy/exceptions.py @ line 41-49](../../../translatepy/exceptions.py#L41-L49) +### *attr* [ServiceURLError.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L73) -### *attr* UnknownTranslator.**STATUS_CODE** +## *class* [**RateLimitPrevention**](../../../translatepy/exceptions.py#L79-L82) -> [Source: ../../../translatepy/exceptions.py @ line 42](../../../translatepy/exceptions.py#L42) +### *attr* [RateLimitPrevention.**STATUS_CODE**](../../../translatepy/exceptions.py#L80) -### *attr* UnknownTranslator.**MESSAGE** +### *attr* [RateLimitPrevention.**MESSAGE**](../../../translatepy/exceptions.py#L81) -> [Source: ../../../translatepy/exceptions.py @ line 43](../../../translatepy/exceptions.py#L43) - -### *attr* UnknownTranslator.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 44](../../../translatepy/exceptions.py#L44) - -## *class* **UnsupportedMethod** - -> [Source: ../../../translatepy/exceptions.py @ line 52-58](../../../translatepy/exceptions.py#L52-L58) - -### *attr* UnsupportedMethod.**STATUS_CODE** - -> [Source: ../../../translatepy/exceptions.py @ line 53](../../../translatepy/exceptions.py#L53) - -### *attr* UnsupportedMethod.**MESSAGE** - -> [Source: ../../../translatepy/exceptions.py @ line 54](../../../translatepy/exceptions.py#L54) - -### *attr* UnsupportedMethod.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 55](../../../translatepy/exceptions.py#L55) - -## *class* **UnsupportedLanguage** - -> [Source: ../../../translatepy/exceptions.py @ line 61-67](../../../translatepy/exceptions.py#L61-L67) - -### *attr* UnsupportedLanguage.**STATUS_CODE** - -> [Source: ../../../translatepy/exceptions.py @ line 62](../../../translatepy/exceptions.py#L62) - -### *attr* UnsupportedLanguage.**MESSAGE** - -> [Source: ../../../translatepy/exceptions.py @ line 63](../../../translatepy/exceptions.py#L63) - -### *attr* UnsupportedLanguage.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 64](../../../translatepy/exceptions.py#L64) - -## *class* **ServiceURLError** - -> [Source: ../../../translatepy/exceptions.py @ line 70-76](../../../translatepy/exceptions.py#L70-L76) - -### *attr* ServiceURLError.**STATUS_CODE** - -> [Source: ../../../translatepy/exceptions.py @ line 71](../../../translatepy/exceptions.py#L71) - -### *attr* ServiceURLError.**MESSAGE** - -> [Source: ../../../translatepy/exceptions.py @ line 72](../../../translatepy/exceptions.py#L72) - -### *attr* ServiceURLError.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 73](../../../translatepy/exceptions.py#L73) - -## *class* **RateLimitPrevention** - -> [Source: ../../../translatepy/exceptions.py @ line 79-82](../../../translatepy/exceptions.py#L79-L82) - -### *attr* RateLimitPrevention.**STATUS_CODE** - -> [Source: ../../../translatepy/exceptions.py @ line 80](../../../translatepy/exceptions.py#L80) - -### *attr* RateLimitPrevention.**MESSAGE** - -> [Source: ../../../translatepy/exceptions.py @ line 81](../../../translatepy/exceptions.py#L81) - -### *attr* RateLimitPrevention.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 82](../../../translatepy/exceptions.py#L82) +### *attr* [RateLimitPrevention.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L82) diff --git a/docs/eng/reference/language.md b/docs/eng/reference/language.md index ac1bcf2..1d5f29b 100644 --- a/docs/eng/reference/language.md +++ b/docs/eng/reference/language.md @@ -1,6 +1,6 @@ # *module* **language** -> [Source: ../../../translatepy/language.py @ line 0](../../../translatepy/language.py#L0) +> [Source: ../../../translatepy/language.py](../../../translatepy/language.py#L0) Handles the languages management on `translatepy` @@ -12,21 +12,15 @@ Handles the languages management on `translatepy` - [../../../translatepy/utils/vectorize.py](../../../translatepy/utils/vectorize.py): As `vectorize` -## *const* **Number** - -> [Source: ../../../translatepy/language.py @ line 17](../../../translatepy/language.py#L17) +## *const* [**Number**](../../../translatepy/language.py#L17) Represents a number -## *class* **LanguageExtra** - -> [Source: ../../../translatepy/language.py @ line 21-34](../../../translatepy/language.py#L21-L34) +## *class* [**LanguageExtra**](../../../translatepy/language.py#L21-L34) Extra data given on supported languages -### *attr* LanguageExtra.**scope** - -> [Source: ../../../translatepy/language.py @ line 23](../../../translatepy/language.py#L23) +### *attr* [LanguageExtra.**scope**](../../../translatepy/language.py#L23) > Type: `cain.types.Enum` @@ -35,9 +29,7 @@ Language scope > **Note** > Can be one of "individual", "macrolanguage", "special" -### *attr* LanguageExtra.**type** - -> [Source: ../../../translatepy/language.py @ line 28](../../../translatepy/language.py#L28) +### *attr* [LanguageExtra.**type**](../../../translatepy/language.py#L28) > Type: `cain.types.Enum` @@ -46,773 +38,577 @@ Language type > **Note** > Can be one of "ancient", "constructed", "extinct", "historical", "living", "special" -## *class* **Foreign** - -> [Source: ../../../translatepy/language.py @ line 37-208](../../../translatepy/language.py#L37-L208) +## *class* [**Foreign**](../../../translatepy/language.py#L37-L208) The language name in foreign languages -### *attr* Foreign.**afrikaans** - -> [Source: ../../../translatepy/language.py @ line 39](../../../translatepy/language.py#L39) +### *attr* [Foreign.**afrikaans**](../../../translatepy/language.py#L39) > Type: `str` The language name in afrikaans -### *attr* Foreign.**albanian** - -> [Source: ../../../translatepy/language.py @ line 41](../../../translatepy/language.py#L41) +### *attr* [Foreign.**albanian**](../../../translatepy/language.py#L41) > Type: `str` The language name in albanian -### *attr* Foreign.**amharic** - -> [Source: ../../../translatepy/language.py @ line 43](../../../translatepy/language.py#L43) +### *attr* [Foreign.**amharic**](../../../translatepy/language.py#L43) > Type: `str` The language name in amharic -### *attr* Foreign.**arabic** - -> [Source: ../../../translatepy/language.py @ line 45](../../../translatepy/language.py#L45) +### *attr* [Foreign.**arabic**](../../../translatepy/language.py#L45) > Type: `str` The language name in arabic -### *attr* Foreign.**armenian** - -> [Source: ../../../translatepy/language.py @ line 47](../../../translatepy/language.py#L47) +### *attr* [Foreign.**armenian**](../../../translatepy/language.py#L47) > Type: `str` The language name in armenian -### *attr* Foreign.**azerbaijani** - -> [Source: ../../../translatepy/language.py @ line 49](../../../translatepy/language.py#L49) +### *attr* [Foreign.**azerbaijani**](../../../translatepy/language.py#L49) > Type: `str` The language name in azerbaijani -### *attr* Foreign.**basque** - -> [Source: ../../../translatepy/language.py @ line 51](../../../translatepy/language.py#L51) +### *attr* [Foreign.**basque**](../../../translatepy/language.py#L51) > Type: `str` The language name in basque -### *attr* Foreign.**belarusian** - -> [Source: ../../../translatepy/language.py @ line 53](../../../translatepy/language.py#L53) +### *attr* [Foreign.**belarusian**](../../../translatepy/language.py#L53) > Type: `str` The language name in belarusian -### *attr* Foreign.**bengali** - -> [Source: ../../../translatepy/language.py @ line 55](../../../translatepy/language.py#L55) +### *attr* [Foreign.**bengali**](../../../translatepy/language.py#L55) > Type: `str` The language name in bengali -### *attr* Foreign.**bosnian** - -> [Source: ../../../translatepy/language.py @ line 57](../../../translatepy/language.py#L57) +### *attr* [Foreign.**bosnian**](../../../translatepy/language.py#L57) > Type: `str` The language name in bosnian -### *attr* Foreign.**bulgarian** - -> [Source: ../../../translatepy/language.py @ line 59](../../../translatepy/language.py#L59) +### *attr* [Foreign.**bulgarian**](../../../translatepy/language.py#L59) > Type: `str` The language name in bulgarian -### *attr* Foreign.**burmese** - -> [Source: ../../../translatepy/language.py @ line 61](../../../translatepy/language.py#L61) +### *attr* [Foreign.**burmese**](../../../translatepy/language.py#L61) > Type: `str` The language name in burmese -### *attr* Foreign.**catalan** - -> [Source: ../../../translatepy/language.py @ line 63](../../../translatepy/language.py#L63) +### *attr* [Foreign.**catalan**](../../../translatepy/language.py#L63) > Type: `str` The language name in catalan -### *attr* Foreign.**chinese** - -> [Source: ../../../translatepy/language.py @ line 65](../../../translatepy/language.py#L65) +### *attr* [Foreign.**chinese**](../../../translatepy/language.py#L65) > Type: `str` The language name in chinese -### *attr* Foreign.**croatian** - -> [Source: ../../../translatepy/language.py @ line 67](../../../translatepy/language.py#L67) +### *attr* [Foreign.**croatian**](../../../translatepy/language.py#L67) > Type: `str` The language name in croatian -### *attr* Foreign.**czech** - -> [Source: ../../../translatepy/language.py @ line 69](../../../translatepy/language.py#L69) +### *attr* [Foreign.**czech**](../../../translatepy/language.py#L69) > Type: `str` The language name in czech -### *attr* Foreign.**danish** - -> [Source: ../../../translatepy/language.py @ line 71](../../../translatepy/language.py#L71) +### *attr* [Foreign.**danish**](../../../translatepy/language.py#L71) > Type: `str` The language name in danish -### *attr* Foreign.**dutch** - -> [Source: ../../../translatepy/language.py @ line 73](../../../translatepy/language.py#L73) +### *attr* [Foreign.**dutch**](../../../translatepy/language.py#L73) > Type: `str` The language name in dutch -### *attr* Foreign.**esperanto** - -> [Source: ../../../translatepy/language.py @ line 75](../../../translatepy/language.py#L75) +### *attr* [Foreign.**esperanto**](../../../translatepy/language.py#L75) > Type: `str` The language name in esperanto -### *attr* Foreign.**estonian** - -> [Source: ../../../translatepy/language.py @ line 77](../../../translatepy/language.py#L77) +### *attr* [Foreign.**estonian**](../../../translatepy/language.py#L77) > Type: `str` The language name in estonian -### *attr* Foreign.**finnish** - -> [Source: ../../../translatepy/language.py @ line 79](../../../translatepy/language.py#L79) +### *attr* [Foreign.**finnish**](../../../translatepy/language.py#L79) > Type: `str` The language name in finnish -### *attr* Foreign.**french** - -> [Source: ../../../translatepy/language.py @ line 81](../../../translatepy/language.py#L81) +### *attr* [Foreign.**french**](../../../translatepy/language.py#L81) > Type: `str` The language name in french -### *attr* Foreign.**galician** - -> [Source: ../../../translatepy/language.py @ line 83](../../../translatepy/language.py#L83) +### *attr* [Foreign.**galician**](../../../translatepy/language.py#L83) > Type: `str` The language name in galician -### *attr* Foreign.**georgian** - -> [Source: ../../../translatepy/language.py @ line 85](../../../translatepy/language.py#L85) +### *attr* [Foreign.**georgian**](../../../translatepy/language.py#L85) > Type: `str` The language name in georgian -### *attr* Foreign.**german** - -> [Source: ../../../translatepy/language.py @ line 87](../../../translatepy/language.py#L87) +### *attr* [Foreign.**german**](../../../translatepy/language.py#L87) > Type: `str` The language name in german -### *attr* Foreign.**gujarati** - -> [Source: ../../../translatepy/language.py @ line 89](../../../translatepy/language.py#L89) +### *attr* [Foreign.**gujarati**](../../../translatepy/language.py#L89) > Type: `str` The language name in gujarati -### *attr* Foreign.**haitian** - -> [Source: ../../../translatepy/language.py @ line 91](../../../translatepy/language.py#L91) +### *attr* [Foreign.**haitian**](../../../translatepy/language.py#L91) > Type: `str` The language name in haitian -### *attr* Foreign.**hebrew** - -> [Source: ../../../translatepy/language.py @ line 93](../../../translatepy/language.py#L93) +### *attr* [Foreign.**hebrew**](../../../translatepy/language.py#L93) > Type: `str` The language name in hebrew -### *attr* Foreign.**hindi** - -> [Source: ../../../translatepy/language.py @ line 95](../../../translatepy/language.py#L95) +### *attr* [Foreign.**hindi**](../../../translatepy/language.py#L95) > Type: `str` The language name in hindi -### *attr* Foreign.**hungarian** - -> [Source: ../../../translatepy/language.py @ line 97](../../../translatepy/language.py#L97) +### *attr* [Foreign.**hungarian**](../../../translatepy/language.py#L97) > Type: `str` The language name in hungarian -### *attr* Foreign.**icelandic** - -> [Source: ../../../translatepy/language.py @ line 99](../../../translatepy/language.py#L99) +### *attr* [Foreign.**icelandic**](../../../translatepy/language.py#L99) > Type: `str` The language name in icelandic -### *attr* Foreign.**indonesian** - -> [Source: ../../../translatepy/language.py @ line 101](../../../translatepy/language.py#L101) +### *attr* [Foreign.**indonesian**](../../../translatepy/language.py#L101) > Type: `str` The language name in indonesian -### *attr* Foreign.**irish** - -> [Source: ../../../translatepy/language.py @ line 103](../../../translatepy/language.py#L103) +### *attr* [Foreign.**irish**](../../../translatepy/language.py#L103) > Type: `str` The language name in irish -### *attr* Foreign.**italian** - -> [Source: ../../../translatepy/language.py @ line 105](../../../translatepy/language.py#L105) +### *attr* [Foreign.**italian**](../../../translatepy/language.py#L105) > Type: `str` The language name in italian -### *attr* Foreign.**japanese** - -> [Source: ../../../translatepy/language.py @ line 107](../../../translatepy/language.py#L107) +### *attr* [Foreign.**japanese**](../../../translatepy/language.py#L107) > Type: `str` The language name in japanese -### *attr* Foreign.**javanese** - -> [Source: ../../../translatepy/language.py @ line 109](../../../translatepy/language.py#L109) +### *attr* [Foreign.**javanese**](../../../translatepy/language.py#L109) > Type: `str` The language name in javanese -### *attr* Foreign.**kannada** - -> [Source: ../../../translatepy/language.py @ line 111](../../../translatepy/language.py#L111) +### *attr* [Foreign.**kannada**](../../../translatepy/language.py#L111) > Type: `str` The language name in kannada -### *attr* Foreign.**kazakh** - -> [Source: ../../../translatepy/language.py @ line 113](../../../translatepy/language.py#L113) +### *attr* [Foreign.**kazakh**](../../../translatepy/language.py#L113) > Type: `str` The language name in kazakh -### *attr* Foreign.**khmer** - -> [Source: ../../../translatepy/language.py @ line 115](../../../translatepy/language.py#L115) +### *attr* [Foreign.**khmer**](../../../translatepy/language.py#L115) > Type: `str` The language name in khmer -### *attr* Foreign.**kirghiz** - -> [Source: ../../../translatepy/language.py @ line 117](../../../translatepy/language.py#L117) +### *attr* [Foreign.**kirghiz**](../../../translatepy/language.py#L117) > Type: `str` The language name in kirghiz -### *attr* Foreign.**korean** - -> [Source: ../../../translatepy/language.py @ line 119](../../../translatepy/language.py#L119) +### *attr* [Foreign.**korean**](../../../translatepy/language.py#L119) > Type: `str` The language name in korean -### *attr* Foreign.**lao** - -> [Source: ../../../translatepy/language.py @ line 121](../../../translatepy/language.py#L121) +### *attr* [Foreign.**lao**](../../../translatepy/language.py#L121) > Type: `str` The language name in lao -### *attr* Foreign.**latin** - -> [Source: ../../../translatepy/language.py @ line 123](../../../translatepy/language.py#L123) +### *attr* [Foreign.**latin**](../../../translatepy/language.py#L123) > Type: `str` The language name in latin -### *attr* Foreign.**latvian** - -> [Source: ../../../translatepy/language.py @ line 125](../../../translatepy/language.py#L125) +### *attr* [Foreign.**latvian**](../../../translatepy/language.py#L125) > Type: `str` The language name in latvian -### *attr* Foreign.**lithuanian** - -> [Source: ../../../translatepy/language.py @ line 127](../../../translatepy/language.py#L127) +### *attr* [Foreign.**lithuanian**](../../../translatepy/language.py#L127) > Type: `str` The language name in lithuanian -### *attr* Foreign.**luxembourgish** - -> [Source: ../../../translatepy/language.py @ line 129](../../../translatepy/language.py#L129) +### *attr* [Foreign.**luxembourgish**](../../../translatepy/language.py#L129) > Type: `str` The language name in luxembourgish -### *attr* Foreign.**macedonian** - -> [Source: ../../../translatepy/language.py @ line 131](../../../translatepy/language.py#L131) +### *attr* [Foreign.**macedonian**](../../../translatepy/language.py#L131) > Type: `str` The language name in macedonian -### *attr* Foreign.**malagasy** - -> [Source: ../../../translatepy/language.py @ line 133](../../../translatepy/language.py#L133) +### *attr* [Foreign.**malagasy**](../../../translatepy/language.py#L133) > Type: `str` The language name in malagasy -### *attr* Foreign.**malay** - -> [Source: ../../../translatepy/language.py @ line 135](../../../translatepy/language.py#L135) +### *attr* [Foreign.**malay**](../../../translatepy/language.py#L135) > Type: `str` The language name in malay -### *attr* Foreign.**maltese** - -> [Source: ../../../translatepy/language.py @ line 137](../../../translatepy/language.py#L137) +### *attr* [Foreign.**maltese**](../../../translatepy/language.py#L137) > Type: `str` The language name in maltese -### *attr* Foreign.**maori** - -> [Source: ../../../translatepy/language.py @ line 139](../../../translatepy/language.py#L139) +### *attr* [Foreign.**maori**](../../../translatepy/language.py#L139) > Type: `str` The language name in maori -### *attr* Foreign.**marathi** - -> [Source: ../../../translatepy/language.py @ line 141](../../../translatepy/language.py#L141) +### *attr* [Foreign.**marathi**](../../../translatepy/language.py#L141) > Type: `str` The language name in marathi -### *attr* Foreign.**moderngreek** - -> [Source: ../../../translatepy/language.py @ line 143](../../../translatepy/language.py#L143) +### *attr* [Foreign.**moderngreek**](../../../translatepy/language.py#L143) > Type: `str` The language name in moderngreek -### *attr* Foreign.**mongolian** - -> [Source: ../../../translatepy/language.py @ line 145](../../../translatepy/language.py#L145) +### *attr* [Foreign.**mongolian**](../../../translatepy/language.py#L145) > Type: `str` The language name in mongolian -### *attr* Foreign.**nepali** - -> [Source: ../../../translatepy/language.py @ line 147](../../../translatepy/language.py#L147) +### *attr* [Foreign.**nepali**](../../../translatepy/language.py#L147) > Type: `str` The language name in nepali -### *attr* Foreign.**norwegian** - -> [Source: ../../../translatepy/language.py @ line 149](../../../translatepy/language.py#L149) +### *attr* [Foreign.**norwegian**](../../../translatepy/language.py#L149) > Type: `str` The language name in norwegian -### *attr* Foreign.**panjabi** - -> [Source: ../../../translatepy/language.py @ line 151](../../../translatepy/language.py#L151) +### *attr* [Foreign.**panjabi**](../../../translatepy/language.py#L151) > Type: `str` The language name in panjabi -### *attr* Foreign.**persian** - -> [Source: ../../../translatepy/language.py @ line 153](../../../translatepy/language.py#L153) +### *attr* [Foreign.**persian**](../../../translatepy/language.py#L153) > Type: `str` The language name in persian -### *attr* Foreign.**polish** - -> [Source: ../../../translatepy/language.py @ line 155](../../../translatepy/language.py#L155) +### *attr* [Foreign.**polish**](../../../translatepy/language.py#L155) > Type: `str` The language name in polish -### *attr* Foreign.**portuguese** - -> [Source: ../../../translatepy/language.py @ line 157](../../../translatepy/language.py#L157) +### *attr* [Foreign.**portuguese**](../../../translatepy/language.py#L157) > Type: `str` The language name in portuguese -### *attr* Foreign.**romanian** - -> [Source: ../../../translatepy/language.py @ line 159](../../../translatepy/language.py#L159) +### *attr* [Foreign.**romanian**](../../../translatepy/language.py#L159) > Type: `str` The language name in romanian -### *attr* Foreign.**russian** - -> [Source: ../../../translatepy/language.py @ line 161](../../../translatepy/language.py#L161) +### *attr* [Foreign.**russian**](../../../translatepy/language.py#L161) > Type: `str` The language name in russian -### *attr* Foreign.**scottishgaelic** - -> [Source: ../../../translatepy/language.py @ line 163](../../../translatepy/language.py#L163) +### *attr* [Foreign.**scottishgaelic**](../../../translatepy/language.py#L163) > Type: `str` The language name in scottishgaelic -### *attr* Foreign.**serbian** - -> [Source: ../../../translatepy/language.py @ line 165](../../../translatepy/language.py#L165) +### *attr* [Foreign.**serbian**](../../../translatepy/language.py#L165) > Type: `str` The language name in serbian -### *attr* Foreign.**sinhala** - -> [Source: ../../../translatepy/language.py @ line 167](../../../translatepy/language.py#L167) +### *attr* [Foreign.**sinhala**](../../../translatepy/language.py#L167) > Type: `str` The language name in sinhala -### *attr* Foreign.**slovak** - -> [Source: ../../../translatepy/language.py @ line 169](../../../translatepy/language.py#L169) +### *attr* [Foreign.**slovak**](../../../translatepy/language.py#L169) > Type: `str` The language name in slovak -### *attr* Foreign.**slovenian** - -> [Source: ../../../translatepy/language.py @ line 171](../../../translatepy/language.py#L171) +### *attr* [Foreign.**slovenian**](../../../translatepy/language.py#L171) > Type: `str` The language name in slovenian -### *attr* Foreign.**spanish** - -> [Source: ../../../translatepy/language.py @ line 173](../../../translatepy/language.py#L173) +### *attr* [Foreign.**spanish**](../../../translatepy/language.py#L173) > Type: `str` The language name in spanish -### *attr* Foreign.**sundanese** - -> [Source: ../../../translatepy/language.py @ line 175](../../../translatepy/language.py#L175) +### *attr* [Foreign.**sundanese**](../../../translatepy/language.py#L175) > Type: `str` The language name in sundanese -### *attr* Foreign.**swahili** - -> [Source: ../../../translatepy/language.py @ line 177](../../../translatepy/language.py#L177) +### *attr* [Foreign.**swahili**](../../../translatepy/language.py#L177) > Type: `str` The language name in swahili -### *attr* Foreign.**swedish** - -> [Source: ../../../translatepy/language.py @ line 179](../../../translatepy/language.py#L179) +### *attr* [Foreign.**swedish**](../../../translatepy/language.py#L179) > Type: `str` The language name in swedish -### *attr* Foreign.**tagalog** - -> [Source: ../../../translatepy/language.py @ line 181](../../../translatepy/language.py#L181) +### *attr* [Foreign.**tagalog**](../../../translatepy/language.py#L181) > Type: `str` The language name in tagalog -### *attr* Foreign.**tajik** - -> [Source: ../../../translatepy/language.py @ line 183](../../../translatepy/language.py#L183) +### *attr* [Foreign.**tajik**](../../../translatepy/language.py#L183) > Type: `str` The language name in tajik -### *attr* Foreign.**tamil** - -> [Source: ../../../translatepy/language.py @ line 185](../../../translatepy/language.py#L185) +### *attr* [Foreign.**tamil**](../../../translatepy/language.py#L185) > Type: `str` The language name in tamil -### *attr* Foreign.**telugu** - -> [Source: ../../../translatepy/language.py @ line 187](../../../translatepy/language.py#L187) +### *attr* [Foreign.**telugu**](../../../translatepy/language.py#L187) > Type: `str` The language name in telugu -### *attr* Foreign.**thai** - -> [Source: ../../../translatepy/language.py @ line 189](../../../translatepy/language.py#L189) +### *attr* [Foreign.**thai**](../../../translatepy/language.py#L189) > Type: `str` The language name in thai -### *attr* Foreign.**turkish** - -> [Source: ../../../translatepy/language.py @ line 191](../../../translatepy/language.py#L191) +### *attr* [Foreign.**turkish**](../../../translatepy/language.py#L191) > Type: `str` The language name in turkish -### *attr* Foreign.**ukrainian** - -> [Source: ../../../translatepy/language.py @ line 193](../../../translatepy/language.py#L193) +### *attr* [Foreign.**ukrainian**](../../../translatepy/language.py#L193) > Type: `str` The language name in ukrainian -### *attr* Foreign.**urdu** - -> [Source: ../../../translatepy/language.py @ line 195](../../../translatepy/language.py#L195) +### *attr* [Foreign.**urdu**](../../../translatepy/language.py#L195) > Type: `str` The language name in urdu -### *attr* Foreign.**uzbek** - -> [Source: ../../../translatepy/language.py @ line 197](../../../translatepy/language.py#L197) +### *attr* [Foreign.**uzbek**](../../../translatepy/language.py#L197) > Type: `str` The language name in uzbek -### *attr* Foreign.**vietnamese** - -> [Source: ../../../translatepy/language.py @ line 199](../../../translatepy/language.py#L199) +### *attr* [Foreign.**vietnamese**](../../../translatepy/language.py#L199) > Type: `str` The language name in vietnamese -### *attr* Foreign.**welsh** - -> [Source: ../../../translatepy/language.py @ line 201](../../../translatepy/language.py#L201) +### *attr* [Foreign.**welsh**](../../../translatepy/language.py#L201) > Type: `str` The language name in welsh -### *attr* Foreign.**xhosa** - -> [Source: ../../../translatepy/language.py @ line 203](../../../translatepy/language.py#L203) +### *attr* [Foreign.**xhosa**](../../../translatepy/language.py#L203) > Type: `str` The language name in xhosa -### *attr* Foreign.**yiddish** - -> [Source: ../../../translatepy/language.py @ line 205](../../../translatepy/language.py#L205) +### *attr* [Foreign.**yiddish**](../../../translatepy/language.py#L205) > Type: `str` The language name in yiddish -### *attr* Foreign.**zulu** - -> [Source: ../../../translatepy/language.py @ line 207](../../../translatepy/language.py#L207) +### *attr* [Foreign.**zulu**](../../../translatepy/language.py#L207) > Type: `str` The language name in zulu -## *const* **LANGUAGE_CACHE** - -> [Source: ../../../translatepy/language.py @ line 211](../../../translatepy/language.py#L211) +## *const* [**LANGUAGE_CACHE**](../../../translatepy/language.py#L211) -## *const* **NULLABLE_ATTRIBUTES** +## *const* [**NULLABLE_ATTRIBUTES**](../../../translatepy/language.py#L212) -> [Source: ../../../translatepy/language.py @ line 212](../../../translatepy/language.py#L212) - -## *class* **Language** - -> [Source: ../../../translatepy/language.py @ line 215-347](../../../translatepy/language.py#L215-L347) +## *class* [**Language**](../../../translatepy/language.py#L215-L347) A language -### *attr* Language.**id** - -> [Source: ../../../translatepy/language.py @ line 218](../../../translatepy/language.py#L218) +### *attr* [Language.**id**](../../../translatepy/language.py#L218) > Type: `str` The language identifier -### *attr* Language.**alpha3** - -> [Source: ../../../translatepy/language.py @ line 220](../../../translatepy/language.py#L220) +### *attr* [Language.**alpha3**](../../../translatepy/language.py#L220) > Type: `str` The ISO 639-3 (Alpha-3) code -### *attr* Language.**name** - -> [Source: ../../../translatepy/language.py @ line 222](../../../translatepy/language.py#L222) +### *attr* [Language.**name**](../../../translatepy/language.py#L222) > Type: `str` The english name -### *attr* Language.**alpha2** - -> [Source: ../../../translatepy/language.py @ line 224](../../../translatepy/language.py#L224) +### *attr* [Language.**alpha2**](../../../translatepy/language.py#L224) > Type: `Optional` The ISO 639-1 (Alpha-2) code, if available -### *attr* Language.**alpha3b** - -> [Source: ../../../translatepy/language.py @ line 226](../../../translatepy/language.py#L226) +### *attr* [Language.**alpha3b**](../../../translatepy/language.py#L226) > Type: `Optional` The ISO 639-2B (Alpha-3) code, if available -### *attr* Language.**alpha3t** - -> [Source: ../../../translatepy/language.py @ line 228](../../../translatepy/language.py#L228) +### *attr* [Language.**alpha3t**](../../../translatepy/language.py#L228) > Type: `Optional` The ISO 639-2T (Alpha-3) code, if available -### *attr* Language.**extra** - -> [Source: ../../../translatepy/language.py @ line 230](../../../translatepy/language.py#L230) +### *attr* [Language.**extra**](../../../translatepy/language.py#L230) > Type: `Optional` Extra data for the language, if available -### *attr* Language.**foreign** - -> [Source: ../../../translatepy/language.py @ line 232](../../../translatepy/language.py#L232) +### *attr* [Language.**foreign**](../../../translatepy/language.py#L232) > Type: `Optional` Name in foreign languages, if available -### *func* Language.**search** - -> [Source: ../../../translatepy/language.py @ line 269-292](../../../translatepy/language.py#L269-L292) +### *func* [Language.**search**](../../../translatepy/language.py#L269-L292) Searches the given language @@ -828,9 +624,7 @@ Searches the given language - `list` -### *func* Language.**get_extra** - -> [Source: ../../../translatepy/language.py @ line 310-317](../../../translatepy/language.py#L310-L317) +### *func* [Language.**get_extra**](../../../translatepy/language.py#L310-L317) Retrieves the given attribute from `extra` if available @@ -845,9 +639,7 @@ Retrieves the given attribute from `extra` if available - `str` -### *func* Language.**get_foreign** - -> [Source: ../../../translatepy/language.py @ line 319-328](../../../translatepy/language.py#L319-L328) +### *func* [Language.**get_foreign**](../../../translatepy/language.py#L319-L328) Retrieves the given attribute from `foreign` if available @@ -862,9 +654,7 @@ Retrieves the given attribute from `foreign` if available - `str` -### *property* Language.**similarity** - -> [Source: ../../../translatepy/language.py @ line 331-333](../../../translatepy/language.py#L331-L333) +### *property* [Language.**similarity**](../../../translatepy/language.py#L331-L333) The similarity with the vector while searching the language @@ -872,9 +662,7 @@ The similarity with the vector while searching the language - `float` -### *property* Language.**native** - -> [Source: ../../../translatepy/language.py @ line 336-338](../../../translatepy/language.py#L336-L338) +### *property* [Language.**native**](../../../translatepy/language.py#L336-L338) The native name for the language or its english name @@ -882,9 +670,7 @@ The native name for the language or its english name - `str` -### *property* Language.**rich** - -> [Source: ../../../translatepy/language.py @ line 341-347](../../../translatepy/language.py#L341-L347) +### *property* [Language.**rich**](../../../translatepy/language.py#L341-L347) If the language discovery used the full translatepy dataset Note: This returns `False` if the `Language` was not fully initialized @@ -893,56 +679,38 @@ Note: This returns `False` if the `Language` was not fully initialized - `bool` -## *class* **LanguageData** - -> [Source: ../../../translatepy/language.py @ line 352-356](../../../translatepy/language.py#L352-L356) +## *class* [**LanguageData**](../../../translatepy/language.py#L352-L356) Groups all of the data -### *attr* LanguageData.**codes** - -> [Source: ../../../translatepy/language.py @ line 354](../../../translatepy/language.py#L354) +### *attr* [LanguageData.**codes**](../../../translatepy/language.py#L354) > Type: `Dict` -### *attr* LanguageData.**data** - -> [Source: ../../../translatepy/language.py @ line 355](../../../translatepy/language.py#L355) +### *attr* [LanguageData.**data**](../../../translatepy/language.py#L355) > Type: `Dict` -### *attr* LanguageData.**vectors** - -> [Source: ../../../translatepy/language.py @ line 356](../../../translatepy/language.py#L356) +### *attr* [LanguageData.**vectors**](../../../translatepy/language.py#L356) > Type: `List` -## *const* **LANGUAGE_DATA_DIR** - -> [Source: ../../../translatepy/language.py @ line 360](../../../translatepy/language.py#L360) +## *const* [**LANGUAGE_DATA_DIR**](../../../translatepy/language.py#L360) The directory where all of the data is stored -## *const* **DATA** - -> [Source: ../../../translatepy/language.py @ line 363](../../../translatepy/language.py#L363) +## *const* [**DATA**](../../../translatepy/language.py#L363) The languages in-memory data -## *const* **TRANSLATEPY_LANGUAGE_FULL** - -> [Source: ../../../translatepy/language.py @ line 369](../../../translatepy/language.py#L369) +## *const* [**TRANSLATEPY_LANGUAGE_FULL**](../../../translatepy/language.py#L369) If the full language data database got loaded at runtime -## *func* **load_full** - -> [Source: ../../../translatepy/language.py @ line 378-385](../../../translatepy/language.py#L378-L385) +## *func* [**load_full**](../../../translatepy/language.py#L378-L385) Loads the full data languages DB -## *const* **COMMON_LANGUAGES** - -> [Source: ../../../translatepy/language.py @ line 392](../../../translatepy/language.py#L392) +## *const* [**COMMON_LANGUAGES**](../../../translatepy/language.py#L392) All of the available foreign languages for the `foreign` field on the `Language` class and English diff --git a/docs/eng/reference/models.md b/docs/eng/reference/models.md index d515c15..c8ec56d 100644 --- a/docs/eng/reference/models.md +++ b/docs/eng/reference/models.md @@ -1,6 +1,6 @@ # *module* **models** -> [Source: ../../../translatepy/models.py @ line 0](../../../translatepy/models.py#L0) +> [Source: ../../../translatepy/models.py](../../../translatepy/models.py#L0) translatepy/models.py Describes the different result models returned by the translators @@ -11,62 +11,38 @@ Describes the different result models returned by the translators - [../../../translatepy/utils/audio.py](../../../translatepy/utils/audio.py): As `get_type` -## *class* **Speed** - -> [Source: ../../../translatepy/models.py @ line 23-28](../../../translatepy/models.py#L23-L28) +## *class* [**Speed**](../../../translatepy/models.py#L23-L28) Represents a speed percentage -### *attr* Speed.**FULL** - -> [Source: ../../../translatepy/models.py @ line 25](../../../translatepy/models.py#L25) - -### *attr* Speed.**HALF** - -> [Source: ../../../translatepy/models.py @ line 26](../../../translatepy/models.py#L26) +### *attr* [Speed.**FULL**](../../../translatepy/models.py#L25) -### *attr* Speed.**QUARTER** +### *attr* [Speed.**HALF**](../../../translatepy/models.py#L26) -> [Source: ../../../translatepy/models.py @ line 27](../../../translatepy/models.py#L27) +### *attr* [Speed.**QUARTER**](../../../translatepy/models.py#L27) -### *attr* Speed.**SLOW** +### *attr* [Speed.**SLOW**](../../../translatepy/models.py#L28) -> [Source: ../../../translatepy/models.py @ line 28](../../../translatepy/models.py#L28) - -## *class* **Gender** - -> [Source: ../../../translatepy/models.py @ line 31-36](../../../translatepy/models.py#L31-L36) +## *class* [**Gender**](../../../translatepy/models.py#L31-L36) Represents a gender -### *attr* Gender.**MALE** - -> [Source: ../../../translatepy/models.py @ line 33](../../../translatepy/models.py#L33) +### *attr* [Gender.**MALE**](../../../translatepy/models.py#L33) -### *attr* Gender.**FEMALE** +### *attr* [Gender.**FEMALE**](../../../translatepy/models.py#L34) -> [Source: ../../../translatepy/models.py @ line 34](../../../translatepy/models.py#L34) +### *attr* [Gender.**OTHER**](../../../translatepy/models.py#L35) -### *attr* Gender.**OTHER** +### *attr* [Gender.**GENDERLESS**](../../../translatepy/models.py#L36) -> [Source: ../../../translatepy/models.py @ line 35](../../../translatepy/models.py#L35) - -### *attr* Gender.**GENDERLESS** - -> [Source: ../../../translatepy/models.py @ line 36](../../../translatepy/models.py#L36) - -## *class* **WordClass** - -> [Source: ../../../translatepy/models.py @ line 39-110](../../../translatepy/models.py#L39-L110) +## *class* [**WordClass**](../../../translatepy/models.py#L39-L110) Part of speech > **Note** > Refer to https://en.wikipedia.org/wiki/Part_of_speech -### *attr* WordClass.**NOUN** - -> [Source: ../../../translatepy/models.py @ line 45](../../../translatepy/models.py#L45) +### *attr* [WordClass.**NOUN**](../../../translatepy/models.py#L45) A word or lexical item denoting any abstract (abstract noun: e.g. home) or concrete entity (concrete noun: e.g. house); a person (police officer, Michael), place (coastline, London), thing (necktie, television), idea (happiness), or quality (bravery). @@ -75,37 +51,27 @@ Nouns can also be classified as count nouns or non-count nouns; some can belong > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**PRONOUN** - -> [Source: ../../../translatepy/models.py @ line 54](../../../translatepy/models.py#L54) +### *attr* [WordClass.**PRONOUN**](../../../translatepy/models.py#L54) A substitute for a noun or noun phrase (them, he). Pronouns make sentences shorter and clearer since they replace nouns. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ADJECTIVE** - -> [Source: ../../../translatepy/models.py @ line 60](../../../translatepy/models.py#L60) +### *attr* [WordClass.**ADJECTIVE**](../../../translatepy/models.py#L60) A modifier of a noun or pronoun (big, brave). Adjectives make the meaning of another word (noun) more precise. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**VERB** - -> [Source: ../../../translatepy/models.py @ line 66](../../../translatepy/models.py#L66) +### *attr* [WordClass.**VERB**](../../../translatepy/models.py#L66) A word denoting an action (walk), occurrence (happen), or state of being (be). Without a verb, a group of words cannot be a clause or sentence. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ADVERB** - -> [Source: ../../../translatepy/models.py @ line 72](../../../translatepy/models.py#L72) +### *attr* [WordClass.**ADVERB**](../../../translatepy/models.py#L72) A modifier of an adjective, verb, or another adverb (very, quite). Adverbs make language more precise. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**PREPOSITION** - -> [Source: ../../../translatepy/models.py @ line 78](../../../translatepy/models.py#L78) +### *attr* [WordClass.**PREPOSITION**](../../../translatepy/models.py#L78) A word that relates words to each other in a phrase or sentence and aids in syntactic context (in, of). Prepositions show the relationship between a noun or a pronoun with another word in the sentence. @@ -113,23 +79,17 @@ Prepositions show the relationship between a noun or a pronoun with another word > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**CONJUNCTION** - -> [Source: ../../../translatepy/models.py @ line 86](../../../translatepy/models.py#L86) +### *attr* [WordClass.**CONJUNCTION**](../../../translatepy/models.py#L86) A syntactic connector; links words, phrases, or clauses (and, but). Conjunctions connect words or group of words Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**INTERJECTION** - -> [Source: ../../../translatepy/models.py @ line 92](../../../translatepy/models.py#L92) +### *attr* [WordClass.**INTERJECTION**](../../../translatepy/models.py#L92) An emotional greeting or exclamation (Huzzah, Alas). Interjections express strong feelings and emotions. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ARTICLE** - -> [Source: ../../../translatepy/models.py @ line 98](../../../translatepy/models.py#L98) +### *attr* [WordClass.**ARTICLE**](../../../translatepy/models.py#L98) A grammatical marker of definiteness (the) or indefiniteness (a, an). The article is not always listed among the parts of speech. @@ -138,23 +98,15 @@ It is considered by some grammarians to be a type of adjective or sometimes the > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**OTHER** - -> [Source: ../../../translatepy/models.py @ line 107](../../../translatepy/models.py#L107) +### *attr* [WordClass.**OTHER**](../../../translatepy/models.py#L107) For other part of speech -## *const* **Translator** - -> [Source: ../../../translatepy/models.py @ line 113](../../../translatepy/models.py#L113) - -## *const* **PRIVATE_ATTRIBUTES** +## *const* [**Translator**](../../../translatepy/models.py#L113) -> [Source: ../../../translatepy/models.py @ line 115](../../../translatepy/models.py#L115) +## *const* [**PRIVATE_ATTRIBUTES**](../../../translatepy/models.py#L115) -## *func* **should_be_exported** - -> [Source: ../../../translatepy/models.py @ line 118-121](../../../translatepy/models.py#L118-L121) +## *func* [**should_be_exported**](../../../translatepy/models.py#L118-L121) if the given attribute should be exposed or not @@ -163,33 +115,23 @@ if the given attribute should be exposed or not - **attr**: `str` -## *class* **ResultAttribute** - -> [Source: ../../../translatepy/models.py @ line 125-129](../../../translatepy/models.py#L125-L129) +## *class* [**ResultAttribute**](../../../translatepy/models.py#L125-L129) Details about a result attribute -### *attr* ResultAttribute.**name** - -> [Source: ../../../translatepy/models.py @ line 127](../../../translatepy/models.py#L127) +### *attr* [ResultAttribute.**name**](../../../translatepy/models.py#L127) > Type: `str` -### *attr* ResultAttribute.**annotation** - -> [Source: ../../../translatepy/models.py @ line 128](../../../translatepy/models.py#L128) +### *attr* [ResultAttribute.**annotation**](../../../translatepy/models.py#L128) > Type: `Optional` -### *attr* ResultAttribute.**description** - -> [Source: ../../../translatepy/models.py @ line 129](../../../translatepy/models.py#L129) +### *attr* [ResultAttribute.**description**](../../../translatepy/models.py#L129) > Type: `Optional` -## *class* **Result** - -> [Source: ../../../translatepy/models.py @ line 136-287](../../../translatepy/models.py#L136-L287) +## *class* [**Result**](../../../translatepy/models.py#L136-L287) The base result model @@ -197,33 +139,25 @@ The base result model - `IndexError` -### *attr* Result.**service** - -> [Source: ../../../translatepy/models.py @ line 143](../../../translatepy/models.py#L143) +### *attr* [Result.**service**](../../../translatepy/models.py#L143) > Type: `Translator` The service which returned the result -### *attr* Result.**source** - -> [Source: ../../../translatepy/models.py @ line 146](../../../translatepy/models.py#L146) +### *attr* [Result.**source**](../../../translatepy/models.py#L146) > Type: `str` The source text -### *attr* Result.**source_lang** - -> [Source: ../../../translatepy/models.py @ line 148](../../../translatepy/models.py#L148) +### *attr* [Result.**source_lang**](../../../translatepy/models.py#L148) > Type: `Language` The source text's language -### *attr* Result.**raw** - -> [Source: ../../../translatepy/models.py @ line 158](../../../translatepy/models.py#L158) +### *attr* [Result.**raw**](../../../translatepy/models.py#L158) > Type: `Optional` @@ -231,9 +165,7 @@ The raw response returned by the service. Note: This is very dependent on the service used. Refer to the service documentation to learn how to use this object. -### *property* Result.**attributes** - -> [Source: ../../../translatepy/models.py @ line 217-267](../../../translatepy/models.py#L217-L267) +### *property* [Result.**attributes**](../../../translatepy/models.py#L217-L267) The different attributes on the dataclass @@ -246,9 +178,7 @@ The different attributes on the dataclass - `list` -### *property* Result.**exported** - -> [Source: ../../../translatepy/models.py @ line 270-281](../../../translatepy/models.py#L270-L281) +### *property* [Result.**exported**](../../../translatepy/models.py#L270-L281) A dictionary version of the dataclass which can be exposed to the public @@ -256,169 +186,119 @@ A dictionary version of the dataclass which can be exposed to the public - `dict` -## *class* **TranslationResult** - -> [Source: ../../../translatepy/models.py @ line 291-329](../../../translatepy/models.py#L291-L329) +## *class* [**TranslationResult**](../../../translatepy/models.py#L291-L329) Holds the result of a regular translation -### *attr* TranslationResult.**dest_lang** - -> [Source: ../../../translatepy/models.py @ line 296](../../../translatepy/models.py#L296) +### *attr* [TranslationResult.**dest_lang**](../../../translatepy/models.py#L296) > Type: `Language` The result's language -### *attr* TranslationResult.**translation** - -> [Source: ../../../translatepy/models.py @ line 299](../../../translatepy/models.py#L299) +### *attr* [TranslationResult.**translation**](../../../translatepy/models.py#L299) > Type: `str` The translation result -### *property* TranslationResult.**alternatives** - -> [Source: ../../../translatepy/models.py @ line 306-310](../../../translatepy/models.py#L306-L310) +### *property* [TranslationResult.**alternatives**](../../../translatepy/models.py#L306-L310) Returns the alternative translations associated -## *const* **TRANSLATION_TEST** +## *const* [**TRANSLATION_TEST**](../../../translatepy/models.py#L332) -> [Source: ../../../translatepy/models.py @ line 332](../../../translatepy/models.py#L332) - -## *class* **TransliterationResult** - -> [Source: ../../../translatepy/models.py @ line 344-371](../../../translatepy/models.py#L344-L371) +## *class* [**TransliterationResult**](../../../translatepy/models.py#L344-L371) Holds the result of a transliteration -### *attr* TransliterationResult.**transliteration** - -> [Source: ../../../translatepy/models.py @ line 348](../../../translatepy/models.py#L348) +### *attr* [TransliterationResult.**transliteration**](../../../translatepy/models.py#L348) > Type: `str` The transliteration result -### *attr* TransliterationResult.**dest_lang** - -> [Source: ../../../translatepy/models.py @ line 351](../../../translatepy/models.py#L351) +### *attr* [TransliterationResult.**dest_lang**](../../../translatepy/models.py#L351) > Type: `Language` The result's language -## *const* **TRANSLITERATION_TEST** +## *const* [**TRANSLITERATION_TEST**](../../../translatepy/models.py#L374) -> [Source: ../../../translatepy/models.py @ line 374](../../../translatepy/models.py#L374) - -## *class* **SpellcheckResult** - -> [Source: ../../../translatepy/models.py @ line 384-410](../../../translatepy/models.py#L384-L410) +## *class* [**SpellcheckResult**](../../../translatepy/models.py#L384-L410) Holds a spellchecking result -### *attr* SpellcheckResult.**rich** - -> [Source: ../../../translatepy/models.py @ line 389](../../../translatepy/models.py#L389) +### *attr* [SpellcheckResult.**rich**](../../../translatepy/models.py#L389) -### *attr* SpellcheckResult.**source_lang** - -> [Source: ../../../translatepy/models.py @ line 391](../../../translatepy/models.py#L391) +### *attr* [SpellcheckResult.**source_lang**](../../../translatepy/models.py#L391) > Type: `Language` The source text's language -### *attr* SpellcheckResult.**corrected** - -> [Source: ../../../translatepy/models.py @ line 393](../../../translatepy/models.py#L393) +### *attr* [SpellcheckResult.**corrected**](../../../translatepy/models.py#L393) > Type: `str` The corrected text -## *const* **SPELLCHECK_TEST** - -> [Source: ../../../translatepy/models.py @ line 413](../../../translatepy/models.py#L413) +## *const* [**SPELLCHECK_TEST**](../../../translatepy/models.py#L413) -## *class* **SpellcheckMistake** - -> [Source: ../../../translatepy/models.py @ line 422-435](../../../translatepy/models.py#L422-L435) +## *class* [**SpellcheckMistake**](../../../translatepy/models.py#L422-L435) This holds a mistake made detected by the spellchecker -### *attr* SpellcheckMistake.**start** - -> [Source: ../../../translatepy/models.py @ line 424](../../../translatepy/models.py#L424) +### *attr* [SpellcheckMistake.**start**](../../../translatepy/models.py#L424) > Type: `int` The beginning index of the part to correct in the original text -### *attr* SpellcheckMistake.**end** - -> [Source: ../../../translatepy/models.py @ line 426](../../../translatepy/models.py#L426) +### *attr* [SpellcheckMistake.**end**](../../../translatepy/models.py#L426) > Type: `int` The ending index of the part to correct in the original text -### *attr* SpellcheckMistake.**corrected** - -> [Source: ../../../translatepy/models.py @ line 428](../../../translatepy/models.py#L428) +### *attr* [SpellcheckMistake.**corrected**](../../../translatepy/models.py#L428) > Type: `str` The corrected part -### *attr* SpellcheckMistake.**message** - -> [Source: ../../../translatepy/models.py @ line 431](../../../translatepy/models.py#L431) +### *attr* [SpellcheckMistake.**message**](../../../translatepy/models.py#L431) > Type: `Optional` A message explaining what happened -### *attr* SpellcheckMistake.**rule** - -> [Source: ../../../translatepy/models.py @ line 434](../../../translatepy/models.py#L434) +### *attr* [SpellcheckMistake.**rule**](../../../translatepy/models.py#L434) > Type: `Optional` A string which identifies the rule associated with the mistake made -## *class* **RichSpellcheckResult** - -> [Source: ../../../translatepy/models.py @ line 441-601](../../../translatepy/models.py#L441-L601) +## *class* [**RichSpellcheckResult**](../../../translatepy/models.py#L441-L601) Holds a rich spellchecking result -### *attr* RichSpellcheckResult.**rich** +### *attr* [RichSpellcheckResult.**rich**](../../../translatepy/models.py#L447) -> [Source: ../../../translatepy/models.py @ line 447](../../../translatepy/models.py#L447) - -### *attr* RichSpellcheckResult.**source_lang** - -> [Source: ../../../translatepy/models.py @ line 449](../../../translatepy/models.py#L449) +### *attr* [RichSpellcheckResult.**source_lang**](../../../translatepy/models.py#L449) > Type: `Language` The source text's language -### *attr* RichSpellcheckResult.**mistakes** - -> [Source: ../../../translatepy/models.py @ line 451](../../../translatepy/models.py#L451) +### *attr* [RichSpellcheckResult.**mistakes**](../../../translatepy/models.py#L451) > Type: `List` The different mistakes made -### *property* RichSpellcheckResult.**corrected** - -> [Source: ../../../translatepy/models.py @ line 455-463](../../../translatepy/models.py#L455-L463) +### *property* [RichSpellcheckResult.**corrected**](../../../translatepy/models.py#L455-L463) The corrected text @@ -426,45 +306,31 @@ The corrected text - `str` -## *const* **RICH_SPELLCHECK_TEST** - -> [Source: ../../../translatepy/models.py @ line 604](../../../translatepy/models.py#L604) - -## *class* **LanguageResult** +## *const* [**RICH_SPELLCHECK_TEST**](../../../translatepy/models.py#L604) -> [Source: ../../../translatepy/models.py @ line 618-628](../../../translatepy/models.py#L618-L628) +## *class* [**LanguageResult**](../../../translatepy/models.py#L618-L628) Holds the language of the given text -## *const* **LANGUAGE_TEST** +## *const* [**LANGUAGE_TEST**](../../../translatepy/models.py#L631) -> [Source: ../../../translatepy/models.py @ line 631](../../../translatepy/models.py#L631) - -## *class* **ExampleResult** - -> [Source: ../../../translatepy/models.py @ line 635-725](../../../translatepy/models.py#L635-L725) +## *class* [**ExampleResult**](../../../translatepy/models.py#L635-L725) Holds an example sentence where the given word is used. -### *attr* ExampleResult.**example** - -> [Source: ../../../translatepy/models.py @ line 641](../../../translatepy/models.py#L641) +### *attr* [ExampleResult.**example**](../../../translatepy/models.py#L641) > Type: `str` The example -### *attr* ExampleResult.**reference** - -> [Source: ../../../translatepy/models.py @ line 644](../../../translatepy/models.py#L644) +### *attr* [ExampleResult.**reference**](../../../translatepy/models.py#L644) > Type: `Optional` Where the example comes from (i.e a book or a the person who said it if it's a quote) -### *property* ExampleResult.**position** - -> [Source: ../../../translatepy/models.py @ line 648-655](../../../translatepy/models.py#L648-L655) +### *property* [ExampleResult.**position**](../../../translatepy/models.py#L648-L655) The first position of the word in the example @@ -474,9 +340,7 @@ The first position of the word in the example - `int` -### *property* ExampleResult.**positions** - -> [Source: ../../../translatepy/models.py @ line 658-690](../../../translatepy/models.py#L658-L690) +### *property* [ExampleResult.**positions**](../../../translatepy/models.py#L658-L690) The positions of the word in the example @@ -485,75 +349,51 @@ The positions of the word in the example - `list[int]` - A list of positions of the word in the example -## *const* **EXAMPLE_TEST** - -> [Source: ../../../translatepy/models.py @ line 728](../../../translatepy/models.py#L728) +## *const* [**EXAMPLE_TEST**](../../../translatepy/models.py#L728) -## *class* **DictionaryResult** - -> [Source: ../../../translatepy/models.py @ line 737-752](../../../translatepy/models.py#L737-L752) +## *class* [**DictionaryResult**](../../../translatepy/models.py#L737-L752) Holds the meaning of the given text -### *attr* DictionaryResult.**rich** - -> [Source: ../../../translatepy/models.py @ line 743](../../../translatepy/models.py#L743) - -### *attr* DictionaryResult.**meaning** +### *attr* [DictionaryResult.**rich**](../../../translatepy/models.py#L743) -> [Source: ../../../translatepy/models.py @ line 745](../../../translatepy/models.py#L745) +### *attr* [DictionaryResult.**meaning**](../../../translatepy/models.py#L745) > Type: `str` The meaning of the text -## *const* **DICTIONARY_TEST** +## *const* [**DICTIONARY_TEST**](../../../translatepy/models.py#L755) -> [Source: ../../../translatepy/models.py @ line 755](../../../translatepy/models.py#L755) - -## *class* **EtymologicalNode** - -> [Source: ../../../translatepy/models.py @ line 764-791](../../../translatepy/models.py#L764-L791) +## *class* [**EtymologicalNode**](../../../translatepy/models.py#L764-L791) The node of an etymological tree -### *attr* EtymologicalNode.**origin** - -> [Source: ../../../translatepy/models.py @ line 766](../../../translatepy/models.py#L766) +### *attr* [EtymologicalNode.**origin**](../../../translatepy/models.py#L766) > Type: `str` The origin name (i.e 'Latin') -### *attr* EtymologicalNode.**source** - -> [Source: ../../../translatepy/models.py @ line 769](../../../translatepy/models.py#L769) +### *attr* [EtymologicalNode.**source**](../../../translatepy/models.py#L769) > Type: `Optional` The original way of writing it -### *attr* EtymologicalNode.**year** - -> [Source: ../../../translatepy/models.py @ line 771](../../../translatepy/models.py#L771) +### *attr* [EtymologicalNode.**year**](../../../translatepy/models.py#L771) > Type: `Optional` The year of origin -## *class* **RichDictionaryResult** - -> [Source: ../../../translatepy/models.py @ line 795-904](../../../translatepy/models.py#L795-L904) +## *class* [**RichDictionaryResult**](../../../translatepy/models.py#L795-L904) Holds more (optional) information than the regular `DictionaryResult` -### *attr* RichDictionaryResult.**rich** +### *attr* [RichDictionaryResult.**rich**](../../../translatepy/models.py#L801) -> [Source: ../../../translatepy/models.py @ line 801](../../../translatepy/models.py#L801) - -### *attr* RichDictionaryResult.**etymology** - -> [Source: ../../../translatepy/models.py @ line 803](../../../translatepy/models.py#L803) +### *attr* [RichDictionaryResult.**etymology**](../../../translatepy/models.py#L803) > Type: `List` @@ -566,9 +406,7 @@ Each element corresponds to a node in the tree of origins for the given text `Node1 (Greek) -> Node2 (Latin) -> Node3 (French) -> Node4 (Ancient English) -> Current Word` -### *attr* RichDictionaryResult.**gender** - -> [Source: ../../../translatepy/models.py @ line 814](../../../translatepy/models.py#L814) +### *attr* [RichDictionaryResult.**gender**](../../../translatepy/models.py#L814) > Type: `Gender` @@ -580,77 +418,55 @@ For languages which assign genders on words `chaîse (french; a chair) -> Gender.FEMALE` -### *attr* RichDictionaryResult.**pronunciation** - -> [Source: ../../../translatepy/models.py @ line 823](../../../translatepy/models.py#L823) +### *attr* [RichDictionaryResult.**pronunciation**](../../../translatepy/models.py#L823) > Type: `Optional` A way of pronouncing the text -### *attr* RichDictionaryResult.**type** - -> [Source: ../../../translatepy/models.py @ line 826](../../../translatepy/models.py#L826) +### *attr* [RichDictionaryResult.**type**](../../../translatepy/models.py#L826) > Type: `WordClass` The part of speech of the text -### *attr* RichDictionaryResult.**synonyms** - -> [Source: ../../../translatepy/models.py @ line 829](../../../translatepy/models.py#L829) +### *attr* [RichDictionaryResult.**synonyms**](../../../translatepy/models.py#L829) > Type: `List` -### *attr* RichDictionaryResult.**antonyms** - -> [Source: ../../../translatepy/models.py @ line 830](../../../translatepy/models.py#L830) +### *attr* [RichDictionaryResult.**antonyms**](../../../translatepy/models.py#L830) > Type: `List` -## *const* **RICH_DICTIONARY_TEST** +## *const* [**RICH_DICTIONARY_TEST**](../../../translatepy/models.py#L907) -> [Source: ../../../translatepy/models.py @ line 907](../../../translatepy/models.py#L907) - -## *class* **TextToSpeechResult** - -> [Source: ../../../translatepy/models.py @ line 922-988](../../../translatepy/models.py#L922-L988) +## *class* [**TextToSpeechResult**](../../../translatepy/models.py#L922-L988) Holds the text to speech results -### *attr* TextToSpeechResult.**result** - -> [Source: ../../../translatepy/models.py @ line 928](../../../translatepy/models.py#L928) +### *attr* [TextToSpeechResult.**result**](../../../translatepy/models.py#L928) > Type: `bytes` Text to speech result -### *attr* TextToSpeechResult.**speed** - -> [Source: ../../../translatepy/models.py @ line 930](../../../translatepy/models.py#L930) +### *attr* [TextToSpeechResult.**speed**](../../../translatepy/models.py#L930) > Type: `int` Speed of the text to speech result -### *attr* TextToSpeechResult.**gender** - -> [Source: ../../../translatepy/models.py @ line 932](../../../translatepy/models.py#L932) +### *attr* [TextToSpeechResult.**gender**](../../../translatepy/models.py#L932) > Type: `Gender` Gender of the 'person' saying the text -### *property* TextToSpeechResult.**type** - -> [Source: ../../../translatepy/models.py @ line 936-938](../../../translatepy/models.py#L936-L938) +### *property* [TextToSpeechResult.**type**](../../../translatepy/models.py#L936-L938) Returns the type of audio file -### *property* TextToSpeechResult.**mime_type** - -> [Source: ../../../translatepy/models.py @ line 941-953](../../../translatepy/models.py#L941-L953) +### *property* [TextToSpeechResult.**mime_type**](../../../translatepy/models.py#L941-L953) Returns the MIME type of the audio file @@ -659,9 +475,7 @@ Returns the MIME type of the audio file - `Optional[str]` - The MIME type of the audio file -### *property* TextToSpeechResult.**extension** - -> [Source: ../../../translatepy/models.py @ line 956-968](../../../translatepy/models.py#L956-L968) +### *property* [TextToSpeechResult.**extension**](../../../translatepy/models.py#L956-L968) Returns the audio file extension @@ -670,9 +484,7 @@ Returns the audio file extension - `Optional[str]` - The MIME type of the audio file -### *func* TextToSpeechResult.**write_to_file** - -> [Source: ../../../translatepy/models.py @ line 970-988](../../../translatepy/models.py#L970-L988) +### *func* [TextToSpeechResult.**write_to_file**](../../../translatepy/models.py#L970-L988) Writes the spoken text to a file. @@ -687,27 +499,19 @@ Writes the spoken text to a file. - If we need to change the extension of the file to match the right file type -## *class* **HTMLTranslationNode** - -> [Source: ../../../translatepy/models.py @ line 992-1029](../../../translatepy/models.py#L992-L1029) +## *class* [**HTMLTranslationNode**](../../../translatepy/models.py#L992-L1029) A translation node, containing the DOM element and its translation result -### *attr* HTMLTranslationNode.**node** - -> [Source: ../../../translatepy/models.py @ line 996](../../../translatepy/models.py#L996) +### *attr* [HTMLTranslationNode.**node**](../../../translatepy/models.py#L996) > Type: `bs4.NavigableString` -### *attr* HTMLTranslationNode.**result** - -> [Source: ../../../translatepy/models.py @ line 997](../../../translatepy/models.py#L997) +### *attr* [HTMLTranslationNode.**result**](../../../translatepy/models.py#L997) > Type: `Optional` -### *property* HTMLTranslationNode.**position** - -> [Source: ../../../translatepy/models.py @ line 1000-1020](../../../translatepy/models.py#L1000-L1020) +### *property* [HTMLTranslationNode.**position**](../../../translatepy/models.py#L1000-L1020) The position of the node in the HTML @@ -715,9 +519,7 @@ The position of the node in the HTML - `int` -### *property* HTMLTranslationNode.**exported** - -> [Source: ../../../translatepy/models.py @ line 1023-1029](../../../translatepy/models.py#L1023-L1029) +### *property* [HTMLTranslationNode.**exported**](../../../translatepy/models.py#L1023-L1029) The exported dictionary @@ -725,33 +527,23 @@ The exported dictionary - `dict` -## *class* **HTMLTranslationResult** - -> [Source: ../../../translatepy/models.py @ line 1033-1052](../../../translatepy/models.py#L1033-L1052) +## *class* [**HTMLTranslationResult**](../../../translatepy/models.py#L1033-L1052) Holds an HTML translation result -### *attr* HTMLTranslationResult.**result** - -> [Source: ../../../translatepy/models.py @ line 1037](../../../translatepy/models.py#L1037) +### *attr* [HTMLTranslationResult.**result**](../../../translatepy/models.py#L1037) > Type: `str` -### *attr* HTMLTranslationResult.**soup** - -> [Source: ../../../translatepy/models.py @ line 1038](../../../translatepy/models.py#L1038) +### *attr* [HTMLTranslationResult.**soup**](../../../translatepy/models.py#L1038) > Type: `bs4.BeautifulSoup` -### *attr* HTMLTranslationResult.**nodes** - -> [Source: ../../../translatepy/models.py @ line 1039](../../../translatepy/models.py#L1039) +### *attr* [HTMLTranslationResult.**nodes**](../../../translatepy/models.py#L1039) > Type: `List` -### *property* HTMLTranslationResult.**exported** - -> [Source: ../../../translatepy/models.py @ line 1048-1052](../../../translatepy/models.py#L1048-L1052) +### *property* [HTMLTranslationResult.**exported**](../../../translatepy/models.py#L1048-L1052) #### Returns diff --git a/docs/eng/reference/server/server.md b/docs/eng/reference/server/server.md index 114afdd..0b55870 100644 --- a/docs/eng/reference/server/server.md +++ b/docs/eng/reference/server/server.md @@ -1,23 +1,17 @@ # *module* **server** -> [Source: ../../../../translatepy/server/server.py @ line 0](../../../../translatepy/server/server.py#L0) +> [Source: ../../../../translatepy/server/server.py](../../../../translatepy/server/server.py#L0) the translatepy server -## *const* **app** - -> [Source: ../../../../translatepy/server/server.py @ line 6](../../../../translatepy/server/server.py#L6) +## *const* [**app**](../../../../translatepy/server/server.py#L6) The `nasse` server instance for `translatepy` -## *const* **TRANSLATEPY_ENDPOINT** - -> [Source: ../../../../translatepy/server/server.py @ line 9](../../../../translatepy/server/server.py#L9) +## *const* [**TRANSLATEPY_ENDPOINT**](../../../../translatepy/server/server.py#L9) Base `translatepy` endpoint -## *const* **SERVER_DOCS_PATH** - -> [Source: ../../../../translatepy/server/server.py @ line 13](../../../../translatepy/server/server.py#L13) +## *const* [**SERVER_DOCS_PATH**](../../../../translatepy/server/server.py#L13) The root path for the server offline docs diff --git a/docs/eng/reference/translate.md b/docs/eng/reference/translate.md index b1f3252..7425526 100644 --- a/docs/eng/reference/translate.md +++ b/docs/eng/reference/translate.md @@ -1,6 +1,6 @@ # *module* **translate** -> [Source: ../../../translatepy/translate.py @ line 0](../../../translatepy/translate.py#L0) +> [Source: ../../../translatepy/translate.py](../../../translatepy/translate.py#L0) translatepy v3.0 © Anime no Sekai — 2023 @@ -37,14 +37,10 @@ translatepy v3.0 - [../../../translatepy/utils/request.py](../../../translatepy/utils/request.py): As `request` -## *const* **DEFAULT_TRANSLATORS** - -> [Source: ../../../translatepy/translate.py @ line 15](../../../translatepy/translate.py#L15) +## *const* [**DEFAULT_TRANSLATORS**](../../../translatepy/translate.py#L15) A list of default translators to use with the translators aggregation -## *class* **Translate** - -> [Source: ../../../translatepy/translate.py @ line 20-27](../../../translatepy/translate.py#L20-L27) +## *class* [**Translate**](../../../translatepy/translate.py#L20-L27) A class which groups all of the translators diff --git a/docs/eng/reference/translators/README.md b/docs/eng/reference/translators/README.md index 316ceb5..f5dbc05 100644 --- a/docs/eng/reference/translators/README.md +++ b/docs/eng/reference/translators/README.md @@ -1,6 +1,6 @@ # *module* **__init__** -> [Source: ../../../../translatepy/translators/__init__.py @ line 0](../../../../translatepy/translators/__init__.py#L0) +> [Source: ../../../../translatepy/translators/__init__.py](../../../../translatepy/translators/__init__.py#L0) ## Imports @@ -30,58 +30,30 @@ - [../../../../translatepy/translators/papago.py](../../../../translatepy/translators/papago.py): As `Papago` -## *const* **Reverso** +## *const* [**Reverso**](../../../../translatepy/translators/__init__.py#L21) -> [Source: ../../../../translatepy/translators/__init__.py @ line 21](../../../../translatepy/translators/__init__.py#L21) +## *const* [**Bing**](../../../../translatepy/translators/__init__.py#L22) -## *const* **Bing** +## *const* [**DeepL**](../../../../translatepy/translators/__init__.py#L23) -> [Source: ../../../../translatepy/translators/__init__.py @ line 22](../../../../translatepy/translators/__init__.py#L22) +## *const* [**Deepl**](../../../../translatepy/translators/__init__.py#L24) -## *const* **DeepL** +## *const* [**Google**](../../../../translatepy/translators/__init__.py#L25) -> [Source: ../../../../translatepy/translators/__init__.py @ line 23](../../../../translatepy/translators/__init__.py#L23) +## *const* [**Libre**](../../../../translatepy/translators/__init__.py#L26) -## *const* **Deepl** +## *const* [**MyMemory**](../../../../translatepy/translators/__init__.py#L27) -> [Source: ../../../../translatepy/translators/__init__.py @ line 24](../../../../translatepy/translators/__init__.py#L24) +## *const* [**TranslateCom**](../../../../translatepy/translators/__init__.py#L28) -## *const* **Google** +## *const* [**Yandex**](../../../../translatepy/translators/__init__.py#L29) -> [Source: ../../../../translatepy/translators/__init__.py @ line 25](../../../../translatepy/translators/__init__.py#L25) +## *const* [**Microsoft**](../../../../translatepy/translators/__init__.py#L30) -## *const* **Libre** +## *const* [**QCRITranslate**](../../../../translatepy/translators/__init__.py#L32) -> [Source: ../../../../translatepy/translators/__init__.py @ line 26](../../../../translatepy/translators/__init__.py#L26) +## *const* [**PONSTranslate**](../../../../translatepy/translators/__init__.py#L33) -## *const* **MyMemory** +## *const* [**PapagoTranslate**](../../../../translatepy/translators/__init__.py#L34) -> [Source: ../../../../translatepy/translators/__init__.py @ line 27](../../../../translatepy/translators/__init__.py#L27) - -## *const* **TranslateCom** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 28](../../../../translatepy/translators/__init__.py#L28) - -## *const* **Yandex** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 29](../../../../translatepy/translators/__init__.py#L29) - -## *const* **Microsoft** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 30](../../../../translatepy/translators/__init__.py#L30) - -## *const* **QCRITranslate** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 32](../../../../translatepy/translators/__init__.py#L32) - -## *const* **PONSTranslate** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 33](../../../../translatepy/translators/__init__.py#L33) - -## *const* **PapagoTranslate** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 34](../../../../translatepy/translators/__init__.py#L34) - -## *const* **NaverTranslate** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 35](../../../../translatepy/translators/__init__.py#L35) +## *const* [**NaverTranslate**](../../../../translatepy/translators/__init__.py#L35) diff --git a/docs/eng/reference/translators/base.md b/docs/eng/reference/translators/base.md index 8a09073..9165f5e 100644 --- a/docs/eng/reference/translators/base.md +++ b/docs/eng/reference/translators/base.md @@ -1,25 +1,17 @@ # *module* **base** -> [Source: ../../../../translatepy/translators/base.py @ line 0](../../../../translatepy/translators/base.py#L0) +> [Source: ../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py#L0) translators/base.py Implements the Base Translator class -## *const* **C** +## *const* [**C**](../../../../translatepy/translators/base.py#L25) -> [Source: ../../../../translatepy/translators/base.py @ line 25](../../../../translatepy/translators/base.py#L25) +## *const* [**R**](../../../../translatepy/translators/base.py#L26) -## *const* **R** +## *const* [**HTMLType**](../../../../translatepy/translators/base.py#L27) -> [Source: ../../../../translatepy/translators/base.py @ line 26](../../../../translatepy/translators/base.py#L26) - -## *const* **HTMLType** - -> [Source: ../../../../translatepy/translators/base.py @ line 27](../../../../translatepy/translators/base.py#L27) - -## *class* **LazyIterable** - -> [Source: ../../../../translatepy/translators/base.py @ line 30-69](../../../../translatepy/translators/base.py#L30-L69) +## *class* [**LazyIterable**](../../../../translatepy/translators/base.py#L30-L69) An object which can be iterated through, even multiple times, but lazy loads the results. @@ -27,33 +19,21 @@ An object which can be iterated through, even multiple times, but lazy loads the - `IndexError` -## *const* **T** - -> [Source: ../../../../translatepy/translators/base.py @ line 73](../../../../translatepy/translators/base.py#L73) +## *const* [**T**](../../../../translatepy/translators/base.py#L73) -## *class* **BaseTranslateException** - -> [Source: ../../../../translatepy/translators/base.py @ line 79-105](../../../../translatepy/translators/base.py#L79-L105) +## *class* [**BaseTranslateException**](../../../../translatepy/translators/base.py#L79-L105) A translator exception, indicating a problem which occured during translation -### *attr* BaseTranslateException.**error_codes** - -> [Source: ../../../../translatepy/translators/base.py @ line 83](../../../../translatepy/translators/base.py#L83) - -## *class* **Flag** +### *attr* [BaseTranslateException.**error_codes**](../../../../translatepy/translators/base.py#L83) -> [Source: ../../../../translatepy/translators/base.py @ line 108-112](../../../../translatepy/translators/base.py#L108-L112) +## *class* [**Flag**](../../../../translatepy/translators/base.py#L108-L112) Defines a set of internal flags the handlers can send to the validator -### *attr* Flag.**MULTIPLE_RESULTS** - -> [Source: ../../../../translatepy/translators/base.py @ line 112](../../../../translatepy/translators/base.py#L112) - -## *class* **BaseTranslator** +### *attr* [Flag.**MULTIPLE_RESULTS**](../../../../translatepy/translators/base.py#L112) -> [Source: ../../../../translatepy/translators/base.py @ line 115-1293](../../../../translatepy/translators/base.py#L115-L1293) +## *class* [**BaseTranslator**](../../../../translatepy/translators/base.py#L115-L1293) The core of translatepy This defines a "Translator" instance, which is the gateway between the translator logic and translatepy @@ -68,9 +48,7 @@ This defines a "Translator" instance, which is the gateway between the translato - `exceptions.UnsupportedMethod` -### *func* BaseTranslator.**translate** - -> [Source: ../../../../translatepy/translators/base.py @ line 307-324](../../../../translatepy/translators/base.py#L307-L324) +### *func* [BaseTranslator.**translate**](../../../../translatepy/translators/base.py#L307-L324) Translates the given `text` into the given `dest_lang` @@ -102,9 +80,7 @@ Translates the given `text` into the given `dest_lang` - `models.TranslationResult` -### *func* BaseTranslator.**translate** - -> [Source: ../../../../translatepy/translators/base.py @ line 327-346](../../../../translatepy/translators/base.py#L327-L346) +### *func* [BaseTranslator.**translate**](../../../../translatepy/translators/base.py#L327-L346) Translates all of the elements in `text` into the given `dest_lang` @@ -139,9 +115,7 @@ Translates all of the elements in `text` into the given `dest_lang` > **Note** > aka "Bulk Translation" -### *func* BaseTranslator.**translate** - -> [Source: ../../../../translatepy/translators/base.py @ line 351-393](../../../../translatepy/translators/base.py#L351-L393) +### *func* [BaseTranslator.**translate**](../../../../translatepy/translators/base.py#L351-L393) Translates `text` into the given `dest_lang` @@ -172,9 +146,7 @@ Translates `text` into the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../translatepy/translators/base.py @ line 420-451](../../../../translatepy/translators/base.py#L420-L451) +### *func* [BaseTranslator.**translate_html**](../../../../translatepy/translators/base.py#L420-L451) Translates the given `html` into the given `dest_lang` @@ -222,9 +194,7 @@ If `False`, the node will be left as is and the `result` part will be `None` - `models.HTMLTranslationResult` -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../translatepy/translators/base.py @ line 454-486](../../../../translatepy/translators/base.py#L454-L486) +### *func* [BaseTranslator.**translate_html**](../../../../translatepy/translators/base.py#L454-L486) Translates all of the elements in `html` into the given `dest_lang` @@ -275,9 +245,7 @@ If `False`, the node will be left as is and the `result` part will be `None` > **Note** > aka "Bulk Translation" -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../translatepy/translators/base.py @ line 489-565](../../../../translatepy/translators/base.py#L489-L565) +### *func* [BaseTranslator.**translate_html**](../../../../translatepy/translators/base.py#L489-L565) Translates `html` into the given `dest_lang` @@ -324,9 +292,7 @@ Translates `html` into the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../translatepy/translators/base.py @ line 573-586](../../../../translatepy/translators/base.py#L573-L586) +### *func* [BaseTranslator.**alternatives**](../../../../translatepy/translators/base.py#L573-L586) Returns the different alternative translations available for a given previous translation. @@ -349,9 +315,7 @@ Returns the different alternative translations available for a given previous tr - `list[TranslationResult]` - The list of other translations a word might have -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../translatepy/translators/base.py @ line 589-602](../../../../translatepy/translators/base.py#L589-L602) +### *func* [BaseTranslator.**alternatives**](../../../../translatepy/translators/base.py#L589-L602) Returns the different alternative translations available for all of the given translations. @@ -374,9 +338,7 @@ Returns the different alternative translations available for all of the given tr - `LazyIterable[list[TranslationResult]]` - All of the other translations -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../translatepy/translators/base.py @ line 606-632](../../../../translatepy/translators/base.py#L606-L632) +### *func* [BaseTranslator.**alternatives**](../../../../translatepy/translators/base.py#L606-L632) Returns the different alternative translations available for the given `translation`. @@ -400,9 +362,7 @@ Returns the different alternative translations available for the given `translat > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../translatepy/translators/base.py @ line 664-681](../../../../translatepy/translators/base.py#L664-L681) +### *func* [BaseTranslator.**transliterate**](../../../../translatepy/translators/base.py#L664-L681) Transliterates the given `text` into the given `dest_lang` @@ -434,9 +394,7 @@ Transliterates the given `text` into the given `dest_lang` - `models.TransliterationResult` -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../translatepy/translators/base.py @ line 684-701](../../../../translatepy/translators/base.py#L684-L701) +### *func* [BaseTranslator.**transliterate**](../../../../translatepy/translators/base.py#L684-L701) Transliterates all of the given `text` to the given `dest_lang` @@ -468,9 +426,7 @@ Transliterates all of the given `text` to the given `dest_lang` - `LazyIterable[TransliterationResult]` - An iterable which contains the transliterations -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../translatepy/translators/base.py @ line 704-750](../../../../translatepy/translators/base.py#L704-L750) +### *func* [BaseTranslator.**transliterate**](../../../../translatepy/translators/base.py#L704-L750) Transliterates the given `text` to the given `dest_lang` @@ -501,13 +457,9 @@ Transliterates the given `text` to the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *attr* BaseTranslator.**transliteration** - -> [Source: ../../../../translatepy/translators/base.py @ line 753](../../../../translatepy/translators/base.py#L753) +### *attr* [BaseTranslator.**transliteration**](../../../../translatepy/translators/base.py#L753) -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../translatepy/translators/base.py @ line 781-798](../../../../translatepy/translators/base.py#L781-L798) +### *func* [BaseTranslator.**spellcheck**](../../../../translatepy/translators/base.py#L781-L798) Checks for spelling mistakes in the given `text` @@ -540,9 +492,7 @@ Checks for spelling mistakes in the given `text` - `SpellcheckResult` - The result of the spell check -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../translatepy/translators/base.py @ line 801-818](../../../../translatepy/translators/base.py#L801-L818) +### *func* [BaseTranslator.**spellcheck**](../../../../translatepy/translators/base.py#L801-L818) Checks for spelling mistakes in all of the given `text` @@ -573,9 +523,7 @@ Checks for spelling mistakes in all of the given `text` - `LazyIterable[SpellcheckResult]` - The results of the spell checks -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../translatepy/translators/base.py @ line 822-853](../../../../translatepy/translators/base.py#L822-L853) +### *func* [BaseTranslator.**spellcheck**](../../../../translatepy/translators/base.py#L822-L853) Checks for spelling mistakes in the given `text` @@ -605,9 +553,7 @@ Checks for spelling mistakes in the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**language** - -> [Source: ../../../../translatepy/translators/base.py @ line 881-894](../../../../translatepy/translators/base.py#L881-L894) +### *func* [BaseTranslator.**language**](../../../../translatepy/translators/base.py#L881-L894) Returns the detected language for the given `text` @@ -630,9 +576,7 @@ Returns the detected language for the given `text` - `models.LanguageResult` -### *func* BaseTranslator.**language** - -> [Source: ../../../../translatepy/translators/base.py @ line 897-910](../../../../translatepy/translators/base.py#L897-L910) +### *func* [BaseTranslator.**language**](../../../../translatepy/translators/base.py#L897-L910) Returns the detected language for all of the given `text` @@ -655,9 +599,7 @@ Returns the detected language for all of the given `text` - `LazyIterable[LanguageResult]` - The results of the language detections -### *func* BaseTranslator.**language** - -> [Source: ../../../../translatepy/translators/base.py @ line 914-936](../../../../translatepy/translators/base.py#L914-L936) +### *func* [BaseTranslator.**language**](../../../../translatepy/translators/base.py#L914-L936) Returns the detected language for the given `text` @@ -685,9 +627,7 @@ Returns the detected language for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**example** - -> [Source: ../../../../translatepy/translators/base.py @ line 960-975](../../../../translatepy/translators/base.py#L960-L975) +### *func* [BaseTranslator.**example**](../../../../translatepy/translators/base.py#L960-L975) Returns use cases for the given `text` @@ -715,9 +655,7 @@ Returns use cases for the given `text` - `list[ExampleResult]` - The examples -### *func* BaseTranslator.**example** - -> [Source: ../../../../translatepy/translators/base.py @ line 978-993](../../../../translatepy/translators/base.py#L978-L993) +### *func* [BaseTranslator.**example**](../../../../translatepy/translators/base.py#L978-L993) Returns use cases for all of the given `text` @@ -745,9 +683,7 @@ Returns use cases for all of the given `text` - `LazyIterable[list[ExampleResult]]` - All of the examples -### *func* BaseTranslator.**example** - -> [Source: ../../../../translatepy/translators/base.py @ line 997-1031](../../../../translatepy/translators/base.py#L997-L1031) +### *func* [BaseTranslator.**example**](../../../../translatepy/translators/base.py#L997-L1031) Returns use cases for the given `text` @@ -775,9 +711,7 @@ Returns use cases for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../translatepy/translators/base.py @ line 1060-1077](../../../../translatepy/translators/base.py#L1060-L1077) +### *func* [BaseTranslator.**dictionary**](../../../../translatepy/translators/base.py#L1060-L1077) Returns the meaning for the given `text` @@ -808,9 +742,7 @@ Returns the meaning for the given `text` - `list` -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../translatepy/translators/base.py @ line 1080-1097](../../../../translatepy/translators/base.py#L1080-L1097) +### *func* [BaseTranslator.**dictionary**](../../../../translatepy/translators/base.py#L1080-L1097) Returns the meaning for all of the given `text` @@ -841,9 +773,7 @@ Returns the meaning for all of the given `text` - `LazyIterable[RichDictionaryResult]` - If supported, a value which contains much more information on all of the `text` -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../translatepy/translators/base.py @ line 1101-1135](../../../../translatepy/translators/base.py#L1101-L1135) +### *func* [BaseTranslator.**dictionary**](../../../../translatepy/translators/base.py#L1101-L1135) Returns the meaning for the given `text` @@ -871,9 +801,7 @@ Returns the meaning for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../translatepy/translators/base.py @ line 1161-1180](../../../../translatepy/translators/base.py#L1161-L1180) +### *func* [BaseTranslator.**text_to_speech**](../../../../translatepy/translators/base.py#L1161-L1180) Returns the speech version of the given `text` @@ -900,9 +828,7 @@ Returns the speech version of the given `text` - `TextToSpeechResult` - The text to speech result -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../translatepy/translators/base.py @ line 1183-1202](../../../../translatepy/translators/base.py#L1183-L1202) +### *func* [BaseTranslator.**text_to_speech**](../../../../translatepy/translators/base.py#L1183-L1202) Returns the speech version for all of the given `text` @@ -929,18 +855,14 @@ Returns the speech version for all of the given `text` - `LazyIterable[TextToSpeechResult]` - The text to speech results -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../translatepy/translators/base.py @ line 1205-1241](../../../../translatepy/translators/base.py#L1205-L1241) +### *func* [BaseTranslator.**text_to_speech**](../../../../translatepy/translators/base.py#L1205-L1241) Returns the speech version of the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**clean_cache** - -> [Source: ../../../../translatepy/translators/base.py @ line 1265-1274](../../../../translatepy/translators/base.py#L1265-L1274) +### *func* [BaseTranslator.**clean_cache**](../../../../translatepy/translators/base.py#L1265-L1274) Cleans caches diff --git a/docs/eng/reference/translators/base_aggregator.md b/docs/eng/reference/translators/base_aggregator.md index ae39c56..556e05d 100644 --- a/docs/eng/reference/translators/base_aggregator.md +++ b/docs/eng/reference/translators/base_aggregator.md @@ -1,14 +1,12 @@ # *module* **base_aggregator** -> [Source: ../../../../translatepy/translators/base_aggregator.py @ line 0](../../../../translatepy/translators/base_aggregator.py#L0) +> [Source: ../../../../translatepy/translators/base_aggregator.py](../../../../translatepy/translators/base_aggregator.py#L0) ## Imports - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslator`, `C` -## *class* **BaseTranslatorAggregator** - -> [Source: ../../../../translatepy/translators/base_aggregator.py @ line 9-145](../../../../translatepy/translators/base_aggregator.py#L9-L145) +## *class* [**BaseTranslatorAggregator**](../../../../translatepy/translators/base_aggregator.py#L9-L145) ### Raises diff --git a/docs/eng/reference/translators/bing.md b/docs/eng/reference/translators/bing.md index 3edc83c..bb47dee 100644 --- a/docs/eng/reference/translators/bing.md +++ b/docs/eng/reference/translators/bing.md @@ -1,6 +1,6 @@ # *module* **Bing** -> [Source: ../../../../translatepy/translators/Bing.py @ line 0](../../../../translatepy/translators/Bing.py#L0) +> [Source: ../../../../translatepy/translators/Bing.py](../../../../translatepy/translators/Bing.py#L0) This implementation was made specifically for translatepy from 'Zhymabek Roman', based on 'Anime no Sekai' version. @@ -8,59 +8,39 @@ This implementation was made specifically for translatepy from 'Zhymabek Roman', - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator` -## *class* **BingTranslateException** +## *class* [**BingTranslateException**](../../../../translatepy/translators/Bing.py#L20-L23) -> [Source: ../../../../translatepy/translators/Bing.py @ line 20-23](../../../../translatepy/translators/Bing.py#L20-L23) +### *attr* [BingTranslateException.**error_codes**](../../../../translatepy/translators/Bing.py#L21) -### *attr* BingTranslateException.**error_codes** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 21](../../../../translatepy/translators/Bing.py#L21) - -## *class* **BingSessionData** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 26-33](../../../../translatepy/translators/Bing.py#L26-L33) +## *class* [**BingSessionData**](../../../../translatepy/translators/Bing.py#L26-L33) Bing session data holder -### *attr* BingSessionData.**ig** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 28](../../../../translatepy/translators/Bing.py#L28) +### *attr* [BingSessionData.**ig**](../../../../translatepy/translators/Bing.py#L28) > Type: `str` -### *attr* BingSessionData.**iid** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 29](../../../../translatepy/translators/Bing.py#L29) +### *attr* [BingSessionData.**iid**](../../../../translatepy/translators/Bing.py#L29) > Type: `str` -### *attr* BingSessionData.**key** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 30](../../../../translatepy/translators/Bing.py#L30) +### *attr* [BingSessionData.**key**](../../../../translatepy/translators/Bing.py#L30) > Type: `cain.types.UInt64` -### *attr* BingSessionData.**token** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 31](../../../../translatepy/translators/Bing.py#L31) +### *attr* [BingSessionData.**token**](../../../../translatepy/translators/Bing.py#L31) > Type: `str` -### *attr* BingSessionData.**cookies_keys** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 32](../../../../translatepy/translators/Bing.py#L32) +### *attr* [BingSessionData.**cookies_keys**](../../../../translatepy/translators/Bing.py#L32) > Type: `List` -### *attr* BingSessionData.**cookies_values** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 33](../../../../translatepy/translators/Bing.py#L33) +### *attr* [BingSessionData.**cookies_values**](../../../../translatepy/translators/Bing.py#L33) > Type: `List` -## *class* **BingSessionManager** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 36-136](../../../../translatepy/translators/Bing.py#L36-L136) +## *class* [**BingSessionManager**](../../../../translatepy/translators/Bing.py#L36-L136) Creates and manages a Bing session @@ -68,9 +48,7 @@ Creates and manages a Bing session - `BingTranslateException` -### *func* BingSessionManager.**send** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 92-136](../../../../translatepy/translators/Bing.py#L92-L136) +### *func* [BingSessionManager.**send**](../../../../translatepy/translators/Bing.py#L92-L136) Sends requestts to the API @@ -86,9 +64,7 @@ Sends requestts to the API - `BingTranslateException` -## *class* **BingTranslate** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 145-251](../../../../translatepy/translators/Bing.py#L145-L251) +## *class* [**BingTranslate**](../../../../translatepy/translators/Bing.py#L145-L251) A Python implementation of Microsoft Bing Translation's APIs diff --git a/docs/eng/reference/translators/deepl.md b/docs/eng/reference/translators/deepl.md index 2ef0e8e..f663f89 100644 --- a/docs/eng/reference/translators/deepl.md +++ b/docs/eng/reference/translators/deepl.md @@ -1,6 +1,6 @@ # *module* **DeepL** -> [Source: ../../../../translatepy/translators/DeepL.py @ line 0](../../../../translatepy/translators/DeepL.py#L0) +> [Source: ../../../../translatepy/translators/DeepL.py](../../../../translatepy/translators/DeepL.py#L0) DeepL Implementation for translatepy @@ -19,53 +19,33 @@ Refer to Animenosekai/translate#7 Arrangements, optimizations - **ZhymabekRoman** Co-Author -## *const* **SENTENCES_SPLITTING_REGEX** +## *const* [**SENTENCES_SPLITTING_REGEX**](../../../../translatepy/translators/DeepL.py#L31) -> [Source: ../../../../translatepy/translators/DeepL.py @ line 31](../../../../translatepy/translators/DeepL.py#L31) +## *class* [**DeeplFormality**](../../../../translatepy/translators/DeepL.py#L34-L36) -## *class* **DeeplFormality** +### *attr* [DeeplFormality.**formal**](../../../../translatepy/translators/DeepL.py#L35) -> [Source: ../../../../translatepy/translators/DeepL.py @ line 34-36](../../../../translatepy/translators/DeepL.py#L34-L36) +### *attr* [DeeplFormality.**informal**](../../../../translatepy/translators/DeepL.py#L36) -### *attr* DeeplFormality.**formal** +## *class* [**DeeplTranslate**](../../../../translatepy/translators/DeepL.py#L39-L41) -> [Source: ../../../../translatepy/translators/DeepL.py @ line 35](../../../../translatepy/translators/DeepL.py#L35) - -### *attr* DeeplFormality.**informal** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 36](../../../../translatepy/translators/DeepL.py#L36) - -## *class* **DeeplTranslate** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 39-41](../../../../translatepy/translators/DeepL.py#L39-L41) - -## *class* **DeeplTranslateException** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 44-51](../../../../translatepy/translators/DeepL.py#L44-L51) +## *class* [**DeeplTranslateException**](../../../../translatepy/translators/DeepL.py#L44-L51) Default DeepL Translate exception -### *attr* DeeplTranslateException.**error_codes** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 49](../../../../translatepy/translators/DeepL.py#L49) - -## *class* **GetClientState** +### *attr* [DeeplTranslateException.**error_codes**](../../../../translatepy/translators/DeepL.py#L49) -> [Source: ../../../../translatepy/translators/DeepL.py @ line 54-82](../../../../translatepy/translators/DeepL.py#L54-L82) +## *class* [**GetClientState**](../../../../translatepy/translators/DeepL.py#L54-L82) DeepL Translate state manager -### *func* GetClientState.**dump** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 63-74](../../../../translatepy/translators/DeepL.py#L63-L74) +### *func* [GetClientState.**dump**](../../../../translatepy/translators/DeepL.py#L63-L74) #### Returns - `dict` -### *func* GetClientState.**get** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 76-82](../../../../translatepy/translators/DeepL.py#L76-L82) +### *func* [GetClientState.**get**](../../../../translatepy/translators/DeepL.py#L76-L82) Returns a new Client State ID @@ -73,15 +53,11 @@ Returns a new Client State ID - `int` -## *class* **JSONRPCRequest** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 85-121](../../../../translatepy/translators/DeepL.py#L85-L121) +## *class* [**JSONRPCRequest**](../../../../translatepy/translators/DeepL.py#L85-L121) JSON RPC Request Sender for DeepL -### *func* JSONRPCRequest.**dump** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 99-107](../../../../translatepy/translators/DeepL.py#L99-L107) +### *func* [JSONRPCRequest.**dump**](../../../../translatepy/translators/DeepL.py#L99-L107) #### Parameters @@ -91,9 +67,7 @@ JSON RPC Request Sender for DeepL - **params**: `dict` -### *func* JSONRPCRequest.**send_jsonrpc** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 109-121](../../../../translatepy/translators/DeepL.py#L109-L121) +### *func* [JSONRPCRequest.**send_jsonrpc**](../../../../translatepy/translators/DeepL.py#L109-L121) #### Parameters @@ -107,17 +81,13 @@ JSON RPC Request Sender for DeepL - `dict` -## *class* **DeeplTranslateV1** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 124-308](../../../../translatepy/translators/DeepL.py#L124-L308) +## *class* [**DeeplTranslateV1**](../../../../translatepy/translators/DeepL.py#L124-L308) ### Raises - `exceptions.UnsupportedMethod` -## *class* **DeeplTranslateV2** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 311-386](../../../../translatepy/translators/DeepL.py#L311-L386) +## *class* [**DeeplTranslateV2**](../../../../translatepy/translators/DeepL.py#L311-L386) ### Raises diff --git a/docs/eng/reference/translators/google.md b/docs/eng/reference/translators/google.md index 051b325..f8bdecf 100644 --- a/docs/eng/reference/translators/google.md +++ b/docs/eng/reference/translators/google.md @@ -1,6 +1,6 @@ # *module* **Google** -> [Source: ../../../../translatepy/translators/Google.py @ line 0](../../../../translatepy/translators/Google.py#L0) +> [Source: ../../../../translatepy/translators/Google.py](../../../../translatepy/translators/Google.py#L0) Google Translate This both uses the mobile version of Google Translate, extension endpoints and the `batchexecute` (JSONRPC) API @@ -12,17 +12,11 @@ The `batchexecute` implementation is heavily inspired by ssut/py-googletrans#255 - [../../../../translatepy/translators/base_aggregator.py](../../../../translatepy/translators/base_aggregator.py): As `BaseTranslatorAggregator` -## *const* **DOMAINS** +## *const* [**DOMAINS**](../../../../translatepy/translators/Google.py#L21) -> [Source: ../../../../translatepy/translators/Google.py @ line 21](../../../../translatepy/translators/Google.py#L21) +## *const* [**SUPPORTED_LANGUAGES**](../../../../translatepy/translators/Google.py#L58) -## *const* **SUPPORTED_LANGUAGES** - -> [Source: ../../../../translatepy/translators/Google.py @ line 58](../../../../translatepy/translators/Google.py#L58) - -## *class* **GoogleTranslate** - -> [Source: ../../../../translatepy/translators/Google.py @ line 66-81](../../../../translatepy/translators/Google.py#L66-L81) +## *class* [**GoogleTranslate**](../../../../translatepy/translators/Google.py#L66-L81) An aggregation of Google Translate translators @@ -30,9 +24,7 @@ An aggregation of Google Translate translators - `ServiceURLError` -## *class* **GoogleTranslateV1** - -> [Source: ../../../../translatepy/translators/Google.py @ line 84-261](../../../../translatepy/translators/Google.py#L84-L261) +## *class* [**GoogleTranslateV1**](../../../../translatepy/translators/Google.py#L84-L261) A Python implementation of Google Translate's JSONRPC API @@ -40,8 +32,6 @@ A Python implementation of Google Translate's JSONRPC API - `ValueError` -## *class* **GoogleTranslateV2** - -> [Source: ../../../../translatepy/translators/Google.py @ line 264-423](../../../../translatepy/translators/Google.py#L264-L423) +## *class* [**GoogleTranslateV2**](../../../../translatepy/translators/Google.py#L264-L423) A Python implementation of Google Translate's APIs diff --git a/docs/eng/reference/translators/libre.md b/docs/eng/reference/translators/libre.md index d71e907..2b7ca3d 100644 --- a/docs/eng/reference/translators/libre.md +++ b/docs/eng/reference/translators/libre.md @@ -1,6 +1,6 @@ # *module* **Libre** -> [Source: ../../../../translatepy/translators/Libre.py @ line 0](../../../../translatepy/translators/Libre.py#L0) +> [Source: ../../../../translatepy/translators/Libre.py](../../../../translatepy/translators/Libre.py#L0) LibreTranslate translatepy's implementation of LibreTranslate @@ -13,8 +13,6 @@ translatepy's implementation of LibreTranslate - **Animenosekai** Original author -## *class* **LibreTranslate** - -> [Source: ../../../../translatepy/translators/Libre.py @ line 19-43](../../../../translatepy/translators/Libre.py#L19-L43) +## *class* [**LibreTranslate**](../../../../translatepy/translators/Libre.py#L19-L43) translatepy's implementation of LibreTranslate diff --git a/docs/eng/reference/translators/microsoft.md b/docs/eng/reference/translators/microsoft.md index 8eaeb3c..9f2e8a6 100644 --- a/docs/eng/reference/translators/microsoft.md +++ b/docs/eng/reference/translators/microsoft.md @@ -1,6 +1,6 @@ # *module* **Microsoft** -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 0](../../../../translatepy/translators/Microsoft.py#L0) +> [Source: ../../../../translatepy/translators/Microsoft.py](../../../../translatepy/translators/Microsoft.py#L0) This implementation was made specifically for translatepy by 'Zhymabek Roman'. @@ -10,27 +10,19 @@ This implementation was made specifically for translatepy by 'Zhymabek Roman'. - [../../../../translatepy/translators/base_aggregator.py](../../../../translatepy/translators/base_aggregator.py): As `BaseTranslatorAggregator` -## *class* **MicrosoftTranslate** - -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 23-32](../../../../translatepy/translators/Microsoft.py#L23-L32) +## *class* [**MicrosoftTranslate**](../../../../translatepy/translators/Microsoft.py#L23-L32) An aggregation of Microsoft Translate translators -## *class* **MicrosoftTranslateV1** - -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 37-141](../../../../translatepy/translators/Microsoft.py#L37-L141) +## *class* [**MicrosoftTranslateV1**](../../../../translatepy/translators/Microsoft.py#L37-L141) A Python implementation of Microsoft Translation, reverse engenered from Microsoft Translator Android application. Ported from https://github.com/d4n3436/GTranslate/blob/master/src/GTranslate/Translators/MicrosoftTranslator.cs Huge thanks to d4n3436. -## *class* **MicrosoftTranslateV2** - -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 144-187](../../../../translatepy/translators/Microsoft.py#L144-L187) +## *class* [**MicrosoftTranslateV2**](../../../../translatepy/translators/Microsoft.py#L144-L187) A Python implementation of Microsoft Translation, reverse engenered from Microsoft SwiftKey by ZhymabekRoman Also I found '/v1/languages?scope=translation' endpoint, idk maybe it can be useful -## *class* **MicrosoftTranslateV3** - -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 189-254](../../../../translatepy/translators/Microsoft.py#L189-L254) +## *class* [**MicrosoftTranslateV3**](../../../../translatepy/translators/Microsoft.py#L189-L254) diff --git a/docs/eng/reference/translators/mymemory.md b/docs/eng/reference/translators/mymemory.md index 79b3754..809328e 100644 --- a/docs/eng/reference/translators/mymemory.md +++ b/docs/eng/reference/translators/mymemory.md @@ -1,6 +1,6 @@ # *module* **MyMemory** -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 0](../../../../translatepy/translators/MyMemory.py#L0) +> [Source: ../../../../translatepy/translators/MyMemory.py](../../../../translatepy/translators/MyMemory.py#L0) MyMemory translatepy's implementation of MyMemory @@ -9,17 +9,11 @@ translatepy's implementation of MyMemory - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **MyMemoryException** +## *class* [**MyMemoryException**](../../../../translatepy/translators/MyMemory.py#L16-L19) -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 16-19](../../../../translatepy/translators/MyMemory.py#L16-L19) +### *attr* [MyMemoryException.**error_codes**](../../../../translatepy/translators/MyMemory.py#L17) -### *attr* MyMemoryException.**error_codes** - -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 17](../../../../translatepy/translators/MyMemory.py#L17) - -## *class* **MyMemoryTranslate** - -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 22-81](../../../../translatepy/translators/MyMemory.py#L22-L81) +## *class* [**MyMemoryTranslate**](../../../../translatepy/translators/MyMemory.py#L22-L81) translatepy's implementation of MyMemory @@ -27,6 +21,4 @@ translatepy's implementation of MyMemory - `MyMemoryException` -### *attr* MyMemoryTranslate.**base_url** - -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 26](../../../../translatepy/translators/MyMemory.py#L26) +### *attr* [MyMemoryTranslate.**base_url**](../../../../translatepy/translators/MyMemory.py#L26) diff --git a/docs/eng/reference/translators/papago.md b/docs/eng/reference/translators/papago.md index 8da7560..37cb3a6 100644 --- a/docs/eng/reference/translators/papago.md +++ b/docs/eng/reference/translators/papago.md @@ -1,6 +1,6 @@ # *module* **Papago** -> [Source: ../../../../translatepy/translators/Papago.py @ line 0](../../../../translatepy/translators/Papago.py#L0) +> [Source: ../../../../translatepy/translators/Papago.py](../../../../translatepy/translators/Papago.py#L0) translatepy's implementation of @@ -8,45 +8,29 @@ translatepy's implementation of - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **PapagoException** +## *class* [**PapagoException**](../../../../translatepy/translators/Papago.py#L18-L21) -> [Source: ../../../../translatepy/translators/Papago.py @ line 18-21](../../../../translatepy/translators/Papago.py#L18-L21) +### *attr* [PapagoException.**error_codes**](../../../../translatepy/translators/Papago.py#L19) -### *attr* PapagoException.**error_codes** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 19](../../../../translatepy/translators/Papago.py#L19) - -## *class* **PapagoSessionData** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 27-31](../../../../translatepy/translators/Papago.py#L27-L31) +## *class* [**PapagoSessionData**](../../../../translatepy/translators/Papago.py#L27-L31) Bing session data holder -### *attr* PapagoSessionData.**timestamp** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 29](../../../../translatepy/translators/Papago.py#L29) +### *attr* [PapagoSessionData.**timestamp**](../../../../translatepy/translators/Papago.py#L29) > Type: `cain.types.UInt64` -### *attr* PapagoSessionData.**cookies_keys** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 30](../../../../translatepy/translators/Papago.py#L30) +### *attr* [PapagoSessionData.**cookies_keys**](../../../../translatepy/translators/Papago.py#L30) > Type: `List` -### *attr* PapagoSessionData.**cookies_values** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 31](../../../../translatepy/translators/Papago.py#L31) +### *attr* [PapagoSessionData.**cookies_values**](../../../../translatepy/translators/Papago.py#L31) > Type: `List` -## *const* **SESSION_CACHE_EXPIRATION** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 34](../../../../translatepy/translators/Papago.py#L34) +## *const* [**SESSION_CACHE_EXPIRATION**](../../../../translatepy/translators/Papago.py#L34) -## *class* **Papago** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 37-262](../../../../translatepy/translators/Papago.py#L37-L262) +## *class* [**Papago**](../../../../translatepy/translators/Papago.py#L37-L262) translatepy's implementation of @@ -56,9 +40,7 @@ translatepy's implementation of - `exceptions.UnsupportedLanguage` -### *func* Papago.**generate_headers** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 83-119](../../../../translatepy/translators/Papago.py#L83-L119) +### *func* [Papago.**generate_headers**](../../../../translatepy/translators/Papago.py#L83-L119) Generates the headers for the API diff --git a/docs/eng/reference/translators/pons.md b/docs/eng/reference/translators/pons.md index 1e73dab..f3fa69e 100644 --- a/docs/eng/reference/translators/pons.md +++ b/docs/eng/reference/translators/pons.md @@ -1,6 +1,6 @@ # *module* **PONS** -> [Source: ../../../../translatepy/translators/PONS.py @ line 0](../../../../translatepy/translators/PONS.py#L0) +> [Source: ../../../../translatepy/translators/PONS.py](../../../../translatepy/translators/PONS.py#L0) translatepy's implementation of @@ -8,16 +8,10 @@ translatepy's implementation of - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **PONSException** +## *class* [**PONSException**](../../../../translatepy/translators/PONS.py#L15-L18) -> [Source: ../../../../translatepy/translators/PONS.py @ line 15-18](../../../../translatepy/translators/PONS.py#L15-L18) +### *attr* [PONSException.**error_codes**](../../../../translatepy/translators/PONS.py#L16) -### *attr* PONSException.**error_codes** - -> [Source: ../../../../translatepy/translators/PONS.py @ line 16](../../../../translatepy/translators/PONS.py#L16) - -## *class* **PONS** - -> [Source: ../../../../translatepy/translators/PONS.py @ line 24-111](../../../../translatepy/translators/PONS.py#L24-L111) +## *class* [**PONS**](../../../../translatepy/translators/PONS.py#L24-L111) translatepy's implementation of diff --git a/docs/eng/reference/translators/qcri.md b/docs/eng/reference/translators/qcri.md index 80bc1f8..93bb768 100644 --- a/docs/eng/reference/translators/qcri.md +++ b/docs/eng/reference/translators/qcri.md @@ -1,6 +1,6 @@ # *module* **QCRI** -> [Source: ../../../../translatepy/translators/QCRI.py @ line 0](../../../../translatepy/translators/QCRI.py#L0) +> [Source: ../../../../translatepy/translators/QCRI.py](../../../../translatepy/translators/QCRI.py#L0) translatepy's implementation of @@ -8,17 +8,11 @@ translatepy's implementation of - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **QCRIException** +## *class* [**QCRIException**](../../../../translatepy/translators/QCRI.py#L16-L19) -> [Source: ../../../../translatepy/translators/QCRI.py @ line 16-19](../../../../translatepy/translators/QCRI.py#L16-L19) +### *attr* [QCRIException.**error_codes**](../../../../translatepy/translators/QCRI.py#L17) -### *attr* QCRIException.**error_codes** - -> [Source: ../../../../translatepy/translators/QCRI.py @ line 17](../../../../translatepy/translators/QCRI.py#L17) - -## *class* **QCRI** - -> [Source: ../../../../translatepy/translators/QCRI.py @ line 25-87](../../../../translatepy/translators/QCRI.py#L25-L87) +## *class* [**QCRI**](../../../../translatepy/translators/QCRI.py#L25-L87) translatepy's implementation of diff --git a/docs/eng/reference/translators/reverso.md b/docs/eng/reference/translators/reverso.md index d375571..a8e6504 100644 --- a/docs/eng/reference/translators/reverso.md +++ b/docs/eng/reference/translators/reverso.md @@ -1,6 +1,6 @@ # *module* **Reverso** -> [Source: ../../../../translatepy/translators/Reverso.py @ line 0](../../../../translatepy/translators/Reverso.py#L0) +> [Source: ../../../../translatepy/translators/Reverso.py](../../../../translatepy/translators/Reverso.py#L0) Reverso translatepy's implementation of Reverso @@ -9,9 +9,7 @@ translatepy's implementation of Reverso - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslator`, `C` -## *class* **ReversoTranslate** - -> [Source: ../../../../translatepy/translators/Reverso.py @ line 16-182](../../../../translatepy/translators/Reverso.py#L16-L182) +## *class* [**ReversoTranslate**](../../../../translatepy/translators/Reverso.py#L16-L182) A Python implementation of Reverso's API diff --git a/docs/eng/reference/translators/translatecom.md b/docs/eng/reference/translators/translatecom.md index 6d11650..8c51a87 100644 --- a/docs/eng/reference/translators/translatecom.md +++ b/docs/eng/reference/translators/translatecom.md @@ -1,21 +1,15 @@ # *module* **TranslateCom** -> [Source: ../../../../translatepy/translators/TranslateCom.py @ line 0](../../../../translatepy/translators/TranslateCom.py#L0) +> [Source: ../../../../translatepy/translators/TranslateCom.py](../../../../translatepy/translators/TranslateCom.py#L0) ## Imports - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslator`, `C` -## *class* **TranslateComTranslate** - -> [Source: ../../../../translatepy/translators/TranslateCom.py @ line 9-44](../../../../translatepy/translators/TranslateCom.py#L9-L44) +## *class* [**TranslateComTranslate**](../../../../translatepy/translators/TranslateCom.py#L9-L44) translatepy's implementation of translate.com -### *attr* TranslateComTranslate.**translate_url** - -> [Source: ../../../../translatepy/translators/TranslateCom.py @ line 14](../../../../translatepy/translators/TranslateCom.py#L14) - -### *attr* TranslateComTranslate.**langdetect_url** +### *attr* [TranslateComTranslate.**translate_url**](../../../../translatepy/translators/TranslateCom.py#L14) -> [Source: ../../../../translatepy/translators/TranslateCom.py @ line 15](../../../../translatepy/translators/TranslateCom.py#L15) +### *attr* [TranslateComTranslate.**langdetect_url**](../../../../translatepy/translators/TranslateCom.py#L15) diff --git a/docs/eng/reference/translators/yandex.md b/docs/eng/reference/translators/yandex.md index acf39d7..2a447f1 100644 --- a/docs/eng/reference/translators/yandex.md +++ b/docs/eng/reference/translators/yandex.md @@ -1,6 +1,6 @@ # *module* **Yandex** -> [Source: ../../../../translatepy/translators/Yandex.py @ line 0](../../../../translatepy/translators/Yandex.py#L0) +> [Source: ../../../../translatepy/translators/Yandex.py](../../../../translatepy/translators/Yandex.py#L0) Yandex Translate This implementation was made specifically for translatepy from 'Zhymabek Roman', based on 'Anime no Sekai' version. @@ -9,19 +9,13 @@ This implementation was made specifically for translatepy from 'Zhymabek Roman', - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **YandexTranslateException** - -> [Source: ../../../../translatepy/translators/Yandex.py @ line 16-31](../../../../translatepy/translators/Yandex.py#L16-L31) +## *class* [**YandexTranslateException**](../../../../translatepy/translators/Yandex.py#L16-L31) Default Yandex Translate exception -### *attr* YandexTranslateException.**error_codes** - -> [Source: ../../../../translatepy/translators/Yandex.py @ line 21](../../../../translatepy/translators/Yandex.py#L21) - -## *class* **YandexTranslate** +### *attr* [YandexTranslateException.**error_codes**](../../../../translatepy/translators/Yandex.py#L21) -> [Source: ../../../../translatepy/translators/Yandex.py @ line 34-205](../../../../translatepy/translators/Yandex.py#L34-L205) +## *class* [**YandexTranslate**](../../../../translatepy/translators/Yandex.py#L34-L205) Yandex Translation Implementation diff --git a/docs/eng/reference/utils/audio.md b/docs/eng/reference/utils/audio.md index 49fd953..2bcf114 100644 --- a/docs/eng/reference/utils/audio.md +++ b/docs/eng/reference/utils/audio.md @@ -1,6 +1,6 @@ # *module* **audio** -> [Source: ../../../../translatepy/utils/audio.py @ line 0](../../../../translatepy/utils/audio.py#L0) +> [Source: ../../../../translatepy/utils/audio.py](../../../../translatepy/utils/audio.py#L0) Handles audio file formats for translatepy @@ -9,27 +9,19 @@ Handles audio file formats for translatepy - **h2non, MIT License** Author of `filetype.py` a Python package to infer binary file types checking the magic numbers signature Most of the source code comes from this package -## *class* **Type** - -> [Source: ../../../../translatepy/utils/audio.py @ line 12-22](../../../../translatepy/utils/audio.py#L12-L22) +## *class* [**Type**](../../../../translatepy/utils/audio.py#L12-L22) Represents an audio format -### *attr* Type.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 16](../../../../translatepy/utils/audio.py#L16) +### *attr* [Type.**MIME**](../../../../translatepy/utils/audio.py#L16) > Type: `str` -### *attr* Type.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 17](../../../../translatepy/utils/audio.py#L17) +### *attr* [Type.**EXTENSION**](../../../../translatepy/utils/audio.py#L17) > Type: `str` -### *func* Type.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 20-22](../../../../translatepy/utils/audio.py#L20-L22) +### *func* [Type.**test**](../../../../translatepy/utils/audio.py#L20-L22) Tests if the given file matches the audio format @@ -38,193 +30,127 @@ Tests if the given file matches the audio format - **data**: `bytes` -## *class* **MP3** - -> [Source: ../../../../translatepy/utils/audio.py @ line 25-42](../../../../translatepy/utils/audio.py#L25-L42) +## *class* [**MP3**](../../../../translatepy/utils/audio.py#L25-L42) Implements the MP3 audio type matcher. -### *attr* MP3.**MIME** +### *attr* [MP3.**MIME**](../../../../translatepy/utils/audio.py#L29) -> [Source: ../../../../translatepy/utils/audio.py @ line 29](../../../../translatepy/utils/audio.py#L29) +### *attr* [MP3.**EXTENSION**](../../../../translatepy/utils/audio.py#L30) -### *attr* MP3.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 30](../../../../translatepy/utils/audio.py#L30) - -### *func* MP3.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 33-42](../../../../translatepy/utils/audio.py#L33-L42) +### *func* [MP3.**test**](../../../../translatepy/utils/audio.py#L33-L42) #### Parameters - **data**: `bytes` -## *class* **M4A** - -> [Source: ../../../../translatepy/utils/audio.py @ line 45-64](../../../../translatepy/utils/audio.py#L45-L64) +## *class* [**M4A**](../../../../translatepy/utils/audio.py#L45-L64) Implements the M4A audio type matcher. -### *attr* M4A.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 49](../../../../translatepy/utils/audio.py#L49) +### *attr* [M4A.**MIME**](../../../../translatepy/utils/audio.py#L49) -### *attr* M4A.**EXTENSION** +### *attr* [M4A.**EXTENSION**](../../../../translatepy/utils/audio.py#L50) -> [Source: ../../../../translatepy/utils/audio.py @ line 50](../../../../translatepy/utils/audio.py#L50) - -### *func* M4A.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 53-64](../../../../translatepy/utils/audio.py#L53-L64) +### *func* [M4A.**test**](../../../../translatepy/utils/audio.py#L53-L64) #### Parameters - **data**: `bytes` -## *class* **Ogg** - -> [Source: ../../../../translatepy/utils/audio.py @ line 67-79](../../../../translatepy/utils/audio.py#L67-L79) +## *class* [**Ogg**](../../../../translatepy/utils/audio.py#L67-L79) Implements the OGG audio type matcher. -### *attr* Ogg.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 71](../../../../translatepy/utils/audio.py#L71) - -### *attr* Ogg.**EXTENSION** +### *attr* [Ogg.**MIME**](../../../../translatepy/utils/audio.py#L71) -> [Source: ../../../../translatepy/utils/audio.py @ line 72](../../../../translatepy/utils/audio.py#L72) +### *attr* [Ogg.**EXTENSION**](../../../../translatepy/utils/audio.py#L72) -### *func* Ogg.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 75-79](../../../../translatepy/utils/audio.py#L75-L79) +### *func* [Ogg.**test**](../../../../translatepy/utils/audio.py#L75-L79) #### Parameters - **data**: `bytes` -## *class* **Flac** - -> [Source: ../../../../translatepy/utils/audio.py @ line 82-94](../../../../translatepy/utils/audio.py#L82-L94) +## *class* [**Flac**](../../../../translatepy/utils/audio.py#L82-L94) Implements the FLAC audio type matcher. -### *attr* Flac.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 86](../../../../translatepy/utils/audio.py#L86) - -### *attr* Flac.**EXTENSION** +### *attr* [Flac.**MIME**](../../../../translatepy/utils/audio.py#L86) -> [Source: ../../../../translatepy/utils/audio.py @ line 87](../../../../translatepy/utils/audio.py#L87) +### *attr* [Flac.**EXTENSION**](../../../../translatepy/utils/audio.py#L87) -### *func* Flac.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 90-94](../../../../translatepy/utils/audio.py#L90-L94) +### *func* [Flac.**test**](../../../../translatepy/utils/audio.py#L90-L94) #### Parameters - **data**: `bytes` -## *class* **Wav** - -> [Source: ../../../../translatepy/utils/audio.py @ line 97-113](../../../../translatepy/utils/audio.py#L97-L113) +## *class* [**Wav**](../../../../translatepy/utils/audio.py#L97-L113) Implements the WAV audio type matcher. -### *attr* Wav.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 101](../../../../translatepy/utils/audio.py#L101) - -### *attr* Wav.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 102](../../../../translatepy/utils/audio.py#L102) +### *attr* [Wav.**MIME**](../../../../translatepy/utils/audio.py#L101) -### *func* Wav.**test** +### *attr* [Wav.**EXTENSION**](../../../../translatepy/utils/audio.py#L102) -> [Source: ../../../../translatepy/utils/audio.py @ line 105-113](../../../../translatepy/utils/audio.py#L105-L113) +### *func* [Wav.**test**](../../../../translatepy/utils/audio.py#L105-L113) #### Parameters - **data**: `bytes` -## *class* **Amr** - -> [Source: ../../../../translatepy/utils/audio.py @ line 116-130](../../../../translatepy/utils/audio.py#L116-L130) +## *class* [**Amr**](../../../../translatepy/utils/audio.py#L116-L130) Implements the AMR audio type matcher. -### *attr* Amr.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 120](../../../../translatepy/utils/audio.py#L120) - -### *attr* Amr.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 121](../../../../translatepy/utils/audio.py#L121) +### *attr* [Amr.**MIME**](../../../../translatepy/utils/audio.py#L120) -### *func* Amr.**test** +### *attr* [Amr.**EXTENSION**](../../../../translatepy/utils/audio.py#L121) -> [Source: ../../../../translatepy/utils/audio.py @ line 124-130](../../../../translatepy/utils/audio.py#L124-L130) +### *func* [Amr.**test**](../../../../translatepy/utils/audio.py#L124-L130) #### Parameters - **data**: `bytes` -## *class* **Aac** - -> [Source: ../../../../translatepy/utils/audio.py @ line 133-142](../../../../translatepy/utils/audio.py#L133-L142) +## *class* [**Aac**](../../../../translatepy/utils/audio.py#L133-L142) Implements the Aac audio type matcher. -### *attr* Aac.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 136](../../../../translatepy/utils/audio.py#L136) - -### *attr* Aac.**EXTENSION** +### *attr* [Aac.**MIME**](../../../../translatepy/utils/audio.py#L136) -> [Source: ../../../../translatepy/utils/audio.py @ line 137](../../../../translatepy/utils/audio.py#L137) +### *attr* [Aac.**EXTENSION**](../../../../translatepy/utils/audio.py#L137) -### *func* Aac.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 140-142](../../../../translatepy/utils/audio.py#L140-L142) +### *func* [Aac.**test**](../../../../translatepy/utils/audio.py#L140-L142) #### Parameters - **data**: `bytes` -## *class* **Aiff** - -> [Source: ../../../../translatepy/utils/audio.py @ line 145-161](../../../../translatepy/utils/audio.py#L145-L161) +## *class* [**Aiff**](../../../../translatepy/utils/audio.py#L145-L161) Implements the AIFF audio type matcher. -### *attr* Aiff.**MIME** +### *attr* [Aiff.**MIME**](../../../../translatepy/utils/audio.py#L149) -> [Source: ../../../../translatepy/utils/audio.py @ line 149](../../../../translatepy/utils/audio.py#L149) +### *attr* [Aiff.**EXTENSION**](../../../../translatepy/utils/audio.py#L150) -### *attr* Aiff.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 150](../../../../translatepy/utils/audio.py#L150) - -### *func* Aiff.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 153-161](../../../../translatepy/utils/audio.py#L153-L161) +### *func* [Aiff.**test**](../../../../translatepy/utils/audio.py#L153-L161) #### Parameters - **data**: `bytes` -## *func* **get_type** - -> [Source: ../../../../translatepy/utils/audio.py @ line 164-181](../../../../translatepy/utils/audio.py#L164-L181) +## *func* [**get_type**](../../../../translatepy/utils/audio.py#L164-L181) Returns the audio format of the given buffer diff --git a/docs/eng/reference/utils/gtoken.md b/docs/eng/reference/utils/gtoken.md index 0880fe6..828e745 100644 --- a/docs/eng/reference/utils/gtoken.md +++ b/docs/eng/reference/utils/gtoken.md @@ -1,6 +1,6 @@ # *module* **gtoken** -> [Source: ../../../../translatepy/utils/gtoken.py @ line 0](../../../../translatepy/utils/gtoken.py#L0) +> [Source: ../../../../translatepy/utils/gtoken.py](../../../../translatepy/utils/gtoken.py#L0) ORIGINAL FILENAME: gtoken.py @@ -33,13 +33,9 @@ LICENSE: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -## *const* **HEADERS** +## *const* [**HEADERS**](../../../../translatepy/utils/gtoken.py#L45) -> [Source: ../../../../translatepy/utils/gtoken.py @ line 45](../../../../translatepy/utils/gtoken.py#L45) - -## *class* **TokenAcquirer** - -> [Source: ../../../../translatepy/utils/gtoken.py @ line 56-244](../../../../translatepy/utils/gtoken.py#L56-L244) +## *class* [**TokenAcquirer**](../../../../translatepy/utils/gtoken.py#L56-L244) Google Translate API token generator translate.google.com uses a token to authorize the requests. If you are @@ -65,26 +61,18 @@ Example usage: - `Exception` -### *attr* TokenAcquirer.**RE_TKK** - -> [Source: ../../../../translatepy/utils/gtoken.py @ line 82](../../../../translatepy/utils/gtoken.py#L82) +### *attr* [TokenAcquirer.**RE_TKK**](../../../../translatepy/utils/gtoken.py#L82) -### *attr* TokenAcquirer.**RE_RAWTKK** +### *attr* [TokenAcquirer.**RE_RAWTKK**](../../../../translatepy/utils/gtoken.py#L83) -> [Source: ../../../../translatepy/utils/gtoken.py @ line 83](../../../../translatepy/utils/gtoken.py#L83) - -### *func* TokenAcquirer.**acquire** - -> [Source: ../../../../translatepy/utils/gtoken.py @ line 185-239](../../../../translatepy/utils/gtoken.py#L185-L239) +### *func* [TokenAcquirer.**acquire**](../../../../translatepy/utils/gtoken.py#L185-L239) #### Parameters - **text** -### *func* TokenAcquirer.**do** - -> [Source: ../../../../translatepy/utils/gtoken.py @ line 241-244](../../../../translatepy/utils/gtoken.py#L241-L244) +### *func* [TokenAcquirer.**do**](../../../../translatepy/utils/gtoken.py#L241-L244) #### Parameters diff --git a/docs/eng/reference/utils/hasher.md b/docs/eng/reference/utils/hasher.md index 948a25b..4f1a190 100644 --- a/docs/eng/reference/utils/hasher.md +++ b/docs/eng/reference/utils/hasher.md @@ -1,13 +1,11 @@ # *module* **hasher** -> [Source: ../../../../translatepy/utils/hasher.py @ line 0](../../../../translatepy/utils/hasher.py#L0) +> [Source: ../../../../translatepy/utils/hasher.py](../../../../translatepy/utils/hasher.py#L0) utils/hasher.py Utility to hash different kind of objects -## *func* **sha256** - -> [Source: ../../../../translatepy/utils/hasher.py @ line 11-28](../../../../translatepy/utils/hasher.py#L11-L28) +## *func* [**sha256**](../../../../translatepy/utils/hasher.py#L11-L28) Hashes the given content using SHA-256 and returns its hexadecimal version @@ -22,9 +20,7 @@ Hashes the given content using SHA-256 and returns its hexadecimal version - `str` - The SHA-256 hash -## *func* **hash_object** - -> [Source: ../../../../translatepy/utils/hasher.py @ line 31-48](../../../../translatepy/utils/hasher.py#L31-L48) +## *func* [**hash_object**](../../../../translatepy/utils/hasher.py#L31-L48) Hashes a given object @@ -38,9 +34,7 @@ Hashes a given object - `str` - The hash of the object -## *func* **hash_request** - -> [Source: ../../../../translatepy/utils/hasher.py @ line 51-82](../../../../translatepy/utils/hasher.py#L51-L82) +## *func* [**hash_request**](../../../../translatepy/utils/hasher.py#L51-L82) Hashes the given request. diff --git a/docs/eng/reference/utils/importer.md b/docs/eng/reference/utils/importer.md index f82aabb..ce063e0 100644 --- a/docs/eng/reference/utils/importer.md +++ b/docs/eng/reference/utils/importer.md @@ -1,6 +1,6 @@ # *module* **importer** -> [Source: ../../../../translatepy/utils/importer.py @ line 0](../../../../translatepy/utils/importer.py#L0) +> [Source: ../../../../translatepy/utils/importer.py](../../../../translatepy/utils/importer.py#L0) importer.py A module to allow for dynamic importing of translators. @@ -11,25 +11,15 @@ A module to allow for dynamic importing of translators. - [../../../../translatepy/utils/vectorize.py](../../../../translatepy/utils/vectorize.py): As `vectorize` -## *const* **IMPORTER_CACHE** +## *const* [**IMPORTER_CACHE**](../../../../translatepy/utils/importer.py#L18) -> [Source: ../../../../translatepy/utils/importer.py @ line 18](../../../../translatepy/utils/importer.py#L18) +## *const* [**IMPORTER_DATA_DIR**](../../../../translatepy/utils/importer.py#L20) -## *const* **IMPORTER_DATA_DIR** +## *const* [**IMPORTER_DATA_FILE**](../../../../translatepy/utils/importer.py#L21) -> [Source: ../../../../translatepy/utils/importer.py @ line 20](../../../../translatepy/utils/importer.py#L20) +## *const* [**NAMED_TRANSLATORS**](../../../../translatepy/utils/importer.py#L27) -## *const* **IMPORTER_DATA_FILE** - -> [Source: ../../../../translatepy/utils/importer.py @ line 21](../../../../translatepy/utils/importer.py#L21) - -## *const* **NAMED_TRANSLATORS** - -> [Source: ../../../../translatepy/utils/importer.py @ line 27](../../../../translatepy/utils/importer.py#L27) - -## *func* **translator_from_name** - -> [Source: ../../../../translatepy/utils/importer.py @ line 37-42](../../../../translatepy/utils/importer.py#L37-L42) +## *func* [**translator_from_name**](../../../../translatepy/utils/importer.py#L37-L42) Retrieves the given translate from its name @@ -46,9 +36,7 @@ Retrieves the given translate from its name - `ValueError` -## *func* **translator_from_path** - -> [Source: ../../../../translatepy/utils/importer.py @ line 45-55](../../../../translatepy/utils/importer.py#L45-L55) +## *func* [**translator_from_path**](../../../../translatepy/utils/importer.py#L45-L55) Returns a translator from its dot path @@ -69,9 +57,7 @@ Returns a translator from its dot path - `ImportError` -## *func* **get_translator** - -> [Source: ../../../../translatepy/utils/importer.py @ line 58-94](../../../../translatepy/utils/importer.py#L58-L94) +## *func* [**get_translator**](../../../../translatepy/utils/importer.py#L58-L94) Searches the given translator diff --git a/docs/eng/reference/utils/lru.md b/docs/eng/reference/utils/lru.md index 8e9d53a..b9670f8 100644 --- a/docs/eng/reference/utils/lru.md +++ b/docs/eng/reference/utils/lru.md @@ -1,31 +1,21 @@ # *module* **lru** -> [Source: ../../../../translatepy/utils/lru.py @ line 0](../../../../translatepy/utils/lru.py#L0) +> [Source: ../../../../translatepy/utils/lru.py](../../../../translatepy/utils/lru.py#L0) lru.py LRU cache implementation for the translatepy project. -## *const* **logger** +## *const* [**logger**](../../../../translatepy/utils/lru.py#L16) -> [Source: ../../../../translatepy/utils/lru.py @ line 16](../../../../translatepy/utils/lru.py#L16) +## *class* [**LRUDictCache**](../../../../translatepy/utils/lru.py#L19-L38) -## *class* **LRUDictCache** +### *func* [LRUDictCache.**clear**](../../../../translatepy/utils/lru.py#L37-L38) -> [Source: ../../../../translatepy/utils/lru.py @ line 19-38](../../../../translatepy/utils/lru.py#L19-L38) - -### *func* LRUDictCache.**clear** - -> [Source: ../../../../translatepy/utils/lru.py @ line 37-38](../../../../translatepy/utils/lru.py#L37-L38) - -## *class* **SizeLimitedLRUCache** - -> [Source: ../../../../translatepy/utils/lru.py @ line 41-173](../../../../translatepy/utils/lru.py#L41-L173) +## *class* [**SizeLimitedLRUCache**](../../../../translatepy/utils/lru.py#L41-L173) Special implementation of a size limited LRU cache. -### *func* SizeLimitedLRUCache.**get_size** - -> [Source: ../../../../translatepy/utils/lru.py @ line 135-170](../../../../translatepy/utils/lru.py#L135-L170) +### *func* [SizeLimitedLRUCache.**get_size**](../../../../translatepy/utils/lru.py#L135-L170) Get the size of an object. @@ -50,13 +40,9 @@ This function is faster than the custom implementation but might yield inaccurat > The second implementation of this function is based on the following article: https://towardsdatascience.com/the-strange-size-of-python-objects-in-memory-ce87bdfbb97f -### *func* SizeLimitedLRUCache.**clear** - -> [Source: ../../../../translatepy/utils/lru.py @ line 172-173](../../../../translatepy/utils/lru.py#L172-L173) - -## *func* **timed_lru_cache** +### *func* [SizeLimitedLRUCache.**clear**](../../../../translatepy/utils/lru.py#L172-L173) -> [Source: ../../../../translatepy/utils/lru.py @ line 176-198](../../../../translatepy/utils/lru.py#L176-L198) +## *func* [**timed_lru_cache**](../../../../translatepy/utils/lru.py#L176-L198) ### Parameters diff --git a/docs/eng/reference/utils/queue.md b/docs/eng/reference/utils/queue.md index 848870b..6555cee 100644 --- a/docs/eng/reference/utils/queue.md +++ b/docs/eng/reference/utils/queue.md @@ -1,18 +1,14 @@ # *module* **queue** -> [Source: ../../../../translatepy/utils/queue.py @ line 0](../../../../translatepy/utils/queue.py#L0) +> [Source: ../../../../translatepy/utils/queue.py](../../../../translatepy/utils/queue.py#L0) -## *class* **Queue** - -> [Source: ../../../../translatepy/utils/queue.py @ line 6-32](../../../../translatepy/utils/queue.py#L6-L32) +## *class* [**Queue**](../../../../translatepy/utils/queue.py#L6-L32) ### Raises - `ValueError` -### *func* Queue.**get** - -> [Source: ../../../../translatepy/utils/queue.py @ line 16-32](../../../../translatepy/utils/queue.py#L16-L32) +### *func* [Queue.**get**](../../../../translatepy/utils/queue.py#L16-L32) Remove and return an item from the queue. It waits for a value or the termination of all threads diff --git a/docs/eng/reference/utils/request.md b/docs/eng/reference/utils/request.md index c4faed9..fad2227 100644 --- a/docs/eng/reference/utils/request.md +++ b/docs/eng/reference/utils/request.md @@ -1,6 +1,6 @@ # *module* **request** -> [Source: ../../../../translatepy/utils/request.py @ line 0](../../../../translatepy/utils/request.py#L0) +> [Source: ../../../../translatepy/utils/request.py](../../../../translatepy/utils/request.py#L0) utils/request Extending python requests functionalities with translatepy's own implementation of proxies, caching, exceptions, etc. @@ -13,29 +13,19 @@ Extending python requests functionalities with translatepy's own implementation - **Animenosekai** Original author -## *const* **RequestHash** +## *const* [**RequestHash**](../../../../translatepy/utils/request.py#L24) -> [Source: ../../../../translatepy/utils/request.py @ line 24](../../../../translatepy/utils/request.py#L24) +## *const* [**RateLimitLock**](../../../../translatepy/utils/request.py#L27) -## *const* **RateLimitLock** +## *const* [**CacheLock**](../../../../translatepy/utils/request.py#L28) -> [Source: ../../../../translatepy/utils/request.py @ line 27](../../../../translatepy/utils/request.py#L27) - -## *const* **CacheLock** - -> [Source: ../../../../translatepy/utils/request.py @ line 28](../../../../translatepy/utils/request.py#L28) - -## *class* **Session** - -> [Source: ../../../../translatepy/utils/request.py @ line 32-225](../../../../translatepy/utils/request.py#L32-L225) +## *class* [**Session**](../../../../translatepy/utils/request.py#L32-L225) ### Raises - `exceptions.RateLimitPrevention` -### *func* Session.**set_http_proxy** - -> [Source: ../../../../translatepy/utils/request.py @ line 52-64](../../../../translatepy/utils/request.py#L52-L64) +### *func* [Session.**set_http_proxy**](../../../../translatepy/utils/request.py#L52-L64) Sets the HTTP proxy to use. @@ -45,9 +35,7 @@ Sets the HTTP proxy to use. - The HTTP proxy to use. -### *func* Session.**add_http_proxy** - -> [Source: ../../../../translatepy/utils/request.py @ line 66-75](../../../../translatepy/utils/request.py#L66-L75) +### *func* [Session.**add_http_proxy**](../../../../translatepy/utils/request.py#L66-L75) Adds a HTTP proxy to the list of proxies to use. @@ -57,9 +45,7 @@ Adds a HTTP proxy to the list of proxies to use. - The HTTP proxy to add. -### *func* Session.**request** - -> [Source: ../../../../translatepy/utils/request.py @ line 77-215](../../../../translatepy/utils/request.py#L77-L215) +### *func* [Session.**request**](../../../../translatepy/utils/request.py#L77-L215) Make an HTTP request with the provided method. @@ -203,9 +189,7 @@ If None, the default_cache_duration attribute will be used. ``` -### *func* Session.**invalidate** - -> [Source: ../../../../translatepy/utils/request.py @ line 217-225](../../../../translatepy/utils/request.py#L217-L225) +### *func* [Session.**invalidate**](../../../../translatepy/utils/request.py#L217-L225) Invalidates the given request cache. @@ -214,13 +198,9 @@ Invalidates the given request cache. - **hash**: `RequestHash`, `requesthash` -## *const* **SharedSession** - -> [Source: ../../../../translatepy/utils/request.py @ line 228](../../../../translatepy/utils/request.py#L228) +## *const* [**SharedSession**](../../../../translatepy/utils/request.py#L228) -## *func* **request** - -> [Source: ../../../../translatepy/utils/request.py @ line 231-268](../../../../translatepy/utils/request.py#L231-L268) +## *func* [**request**](../../../../translatepy/utils/request.py#L231-L268) Make an HTTP request. @@ -315,9 +295,7 @@ Make an HTTP request. > **Note** > Look at Session.request for more information. -## *func* **get** - -> [Source: ../../../../translatepy/utils/request.py @ line 271-300](../../../../translatepy/utils/request.py#L271-L300) +## *func* [**get**](../../../../translatepy/utils/request.py#L271-L300) Make a GET request. @@ -405,9 +383,7 @@ Make a GET request. > **Note** > Look at Session.request for more information. -## *func* **post** - -> [Source: ../../../../translatepy/utils/request.py @ line 303-332](../../../../translatepy/utils/request.py#L303-L332) +## *func* [**post**](../../../../translatepy/utils/request.py#L303-L332) Make a POST request. @@ -495,9 +471,7 @@ Make a POST request. > **Note** > Look at Session.request for more information. -## *func* **put** - -> [Source: ../../../../translatepy/utils/request.py @ line 335-364](../../../../translatepy/utils/request.py#L335-L364) +## *func* [**put**](../../../../translatepy/utils/request.py#L335-L364) Make a PUT request. @@ -585,9 +559,7 @@ Make a PUT request. > **Note** > Look at Session.request for more information. -## *func* **patch** - -> [Source: ../../../../translatepy/utils/request.py @ line 367-396](../../../../translatepy/utils/request.py#L367-L396) +## *func* [**patch**](../../../../translatepy/utils/request.py#L367-L396) Make a PATCH request. @@ -675,9 +647,7 @@ Make a PATCH request. > **Note** > Look at Session.request for more information. -## *func* **delete** - -> [Source: ../../../../translatepy/utils/request.py @ line 399-428](../../../../translatepy/utils/request.py#L399-L428) +## *func* [**delete**](../../../../translatepy/utils/request.py#L399-L428) Make a DELETE request. @@ -765,9 +735,7 @@ Make a DELETE request. > **Note** > Look at Session.request for more information. -## *func* **head** - -> [Source: ../../../../translatepy/utils/request.py @ line 431-460](../../../../translatepy/utils/request.py#L431-L460) +## *func* [**head**](../../../../translatepy/utils/request.py#L431-L460) Make a HEAD request. @@ -855,9 +823,7 @@ Make a HEAD request. > **Note** > Look at Session.request for more information. -## *func* **options** - -> [Source: ../../../../translatepy/utils/request.py @ line 463-492](../../../../translatepy/utils/request.py#L463-L492) +## *func* [**options**](../../../../translatepy/utils/request.py#L463-L492) Make an OPTIONS request. diff --git a/docs/eng/reference/utils/sanitize.md b/docs/eng/reference/utils/sanitize.md index fc0bf1d..8951b42 100644 --- a/docs/eng/reference/utils/sanitize.md +++ b/docs/eng/reference/utils/sanitize.md @@ -1,14 +1,10 @@ # *module* **sanitize** -> [Source: ../../../../translatepy/utils/sanitize.py @ line 0](../../../../translatepy/utils/sanitize.py#L0) +> [Source: ../../../../translatepy/utils/sanitize.py](../../../../translatepy/utils/sanitize.py#L0) -## *const* **WHITESPACES** +## *const* [**WHITESPACES**](../../../../translatepy/utils/sanitize.py#L3) -> [Source: ../../../../translatepy/utils/sanitize.py @ line 3](../../../../translatepy/utils/sanitize.py#L3) - -## *func* **remove_spaces** - -> [Source: ../../../../translatepy/utils/sanitize.py @ line 8-15](../../../../translatepy/utils/sanitize.py#L8-L15) +## *func* [**remove_spaces**](../../../../translatepy/utils/sanitize.py#L8-L15) Removes all whitespaces from the given string diff --git a/docs/eng/reference/utils/utils.md b/docs/eng/reference/utils/utils.md index 8595dcb..3c3c0b5 100644 --- a/docs/eng/reference/utils/utils.md +++ b/docs/eng/reference/utils/utils.md @@ -1,14 +1,10 @@ # *module* **utils** -> [Source: ../../../../translatepy/utils/utils.py @ line 0](../../../../translatepy/utils/utils.py#L0) +> [Source: ../../../../translatepy/utils/utils.py](../../../../translatepy/utils/utils.py#L0) -## *const* **POSITIVE_FLOAT_REGEX** +## *const* [**POSITIVE_FLOAT_REGEX**](../../../../translatepy/utils/utils.py#L3) -> [Source: ../../../../translatepy/utils/utils.py @ line 3](../../../../translatepy/utils/utils.py#L3) - -## *func* **convert_to_float** - -> [Source: ../../../../translatepy/utils/utils.py @ line 6-13](../../../../translatepy/utils/utils.py#L6-L13) +## *func* [**convert_to_float**](../../../../translatepy/utils/utils.py#L6-L13) Safely converts anything to a positive float diff --git a/docs/eng/reference/utils/vectorize.md b/docs/eng/reference/utils/vectorize.md index 6686e79..a3037ca 100644 --- a/docs/eng/reference/utils/vectorize.md +++ b/docs/eng/reference/utils/vectorize.md @@ -1,6 +1,6 @@ # *module* **vectorize** -> [Source: ../../../../translatepy/utils/vectorize.py @ line 0](../../../../translatepy/utils/vectorize.py#L0) +> [Source: ../../../../translatepy/utils/vectorize.py](../../../../translatepy/utils/vectorize.py#L0) Handles vectors @@ -8,13 +8,9 @@ Handles vectors - [../../../../translatepy/utils/sanitize.py](../../../../translatepy/utils/sanitize.py): As `sanitize` -## *const* **CLEANUP_REGEX** +## *const* [**CLEANUP_REGEX**](../../../../translatepy/utils/vectorize.py#L12) -> [Source: ../../../../translatepy/utils/vectorize.py @ line 12](../../../../translatepy/utils/vectorize.py#L12) - -## *func* **string_preprocessing** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 15-17](../../../../translatepy/utils/vectorize.py#L15-L17) +## *func* [**string_preprocessing**](../../../../translatepy/utils/vectorize.py#L15-L17) internal function to preprocess the given string for fuzzy search @@ -27,49 +23,33 @@ internal function to preprocess the given string for fuzzy search - `str` -## *class* **Vector** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 20-34](../../../../translatepy/utils/vectorize.py#L20-L34) +## *class* [**Vector**](../../../../translatepy/utils/vectorize.py#L20-L34) A string vector -### *attr* Vector.**id** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 22](../../../../translatepy/utils/vectorize.py#L22) +### *attr* [Vector.**id**](../../../../translatepy/utils/vectorize.py#L22) > Type: `str` -### *attr* Vector.**string** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 23](../../../../translatepy/utils/vectorize.py#L23) +### *attr* [Vector.**string**](../../../../translatepy/utils/vectorize.py#L23) > Type: `str` -### *attr* Vector.**value** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 24](../../../../translatepy/utils/vectorize.py#L24) +### *attr* [Vector.**value**](../../../../translatepy/utils/vectorize.py#L24) > Type: `float` -### *property* Vector.**counter** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 27-29](../../../../translatepy/utils/vectorize.py#L27-L29) +### *property* [Vector.**counter**](../../../../translatepy/utils/vectorize.py#L27-L29) Returns a counter for the vector -### *property* Vector.**set** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 32-34](../../../../translatepy/utils/vectorize.py#L32-L34) +### *property* [Vector.**set**](../../../../translatepy/utils/vectorize.py#L32-L34) Returns a set for the vector -## *const* **A** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 36](../../../../translatepy/utils/vectorize.py#L36) +## *const* [**A**](../../../../translatepy/utils/vectorize.py#L36) -## *func* **vectorize** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 38-45](../../../../translatepy/utils/vectorize.py#L38-L45) +## *func* [**vectorize**](../../../../translatepy/utils/vectorize.py#L38-L45) Vectorizes the given string @@ -81,31 +61,23 @@ Vectorizes the given string - **string**: `str` -## *class* **SearchResult** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 49-54](../../../../translatepy/utils/vectorize.py#L49-L54) +## *class* [**SearchResult**](../../../../translatepy/utils/vectorize.py#L49-L54) A result from the `search` function -### *attr* SearchResult.**vector** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 51](../../../../translatepy/utils/vectorize.py#L51) +### *attr* [SearchResult.**vector**](../../../../translatepy/utils/vectorize.py#L51) > Type: `Vector` The actual vector -### *attr* SearchResult.**similarity** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 53](../../../../translatepy/utils/vectorize.py#L53) +### *attr* [SearchResult.**similarity**](../../../../translatepy/utils/vectorize.py#L53) > Type: `float` The similarity with the search query -## *func* **search** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 57-70](../../../../translatepy/utils/vectorize.py#L57-L70) +## *func* [**search**](../../../../translatepy/utils/vectorize.py#L57-L70) Searches `query` through `data` diff --git a/docs/eng/server/Postman/Language.postman_collection.utils.json b/docs/eng/server/Postman/Language.postman_collection.utils.json index 9e1964e..283e229 100644 --- a/docs/eng/server/Postman/Language.postman_collection.utils.json +++ b/docs/eng/server/Postman/Language.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Language","description":"All of the endpoints under the 'Language' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file +{"info":{"name":"Language","description":"All of the endpoints under the 'Language' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file diff --git a/docs/eng/server/Postman/Work.postman_collection.utils.json b/docs/eng/server/Postman/Work.postman_collection.utils.json index e5feaae..28195a7 100644 --- a/docs/eng/server/Postman/Work.postman_collection.utils.json +++ b/docs/eng/server/Postman/Work.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Work","description":"All of the endpoints under the 'Work' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `service` | The service which returned the result | Translator | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `translation` | The translation result | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `service` | The service which returned the result | Translator | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `translation` | The translation result | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n"}]},{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n| `transliteration` | The transliteration result | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n| `transliteration` | The transliteration result | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n"}]},{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n| `corrected` | The corrected text | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n| `corrected` | The corrected text | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n"}]},{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | No |\n| `example` | The example | string | No |\n| `source_lang` | The source text's language | Language | No |\n| `positions` | The positions of the word in the example | list[int] | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | No |\n| `example` | The example | string | No |\n| `source_lang` | The source text's language | Language | No |\n| `positions` | The positions of the word in the example | list[int] | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `meaning` | The meaning of the text | string | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `meaning` | The meaning of the text | string | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `extension` | Returns the audio file extension | Optional[str] | No |\n| `result` | Text to speech result | bytes | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n| `gender` | Gender of the 'person' saying the text | Gender | No |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | No |\n| `speed` | Speed of the text to speech result | int | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `extension` | Returns the audio file extension | Optional[str] | No |\n| `result` | Text to speech result | bytes | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n| `gender` | Gender of the 'person' saying the text | Gender | No |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | No |\n| `speed` | Speed of the text to speech result | int | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file +{"info":{"name":"Work","description":"All of the endpoints under the 'Work' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `translation` | The translation result | string | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `translation` | The translation result | string | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]},{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n"}]},{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `transliteration` | The transliteration result | string | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `transliteration` | The transliteration result | string | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]},{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n| `corrected` | The corrected text | string | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n| `corrected` | The corrected text | string | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n"}]},{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n"}]},{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n| `example` | The example | string | No |\n| `positions` | The positions of the word in the example | list[int] | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n| `example` | The example | string | No |\n| `positions` | The positions of the word in the example | list[int] | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n"}]},{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n| `meaning` | The meaning of the text | string | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n| `meaning` | The meaning of the text | string | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n"}]},{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `extension` | Returns the audio file extension | Optional[str] | No |\n| `result` | Text to speech result | bytes | No |\n| `source` | The source text | string | No |\n| `speed` | Speed of the text to speech result | int | No |\n| `gender` | Gender of the 'person' saying the text | Gender | No |\n| `service` | The service which returned the result | Translator | No |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | No |\n| `source_lang` | The source text's language | Language | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `extension` | Returns the audio file extension | Optional[str] | No |\n| `result` | Text to speech result | bytes | No |\n| `source` | The source text | string | No |\n| `speed` | Speed of the text to speech result | int | No |\n| `gender` | Gender of the 'person' saying the text | Gender | No |\n| `service` | The service which returned the result | Translator | No |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | No |\n| `source_lang` | The source text's language | Language | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file diff --git a/docs/eng/server/Sections/Language.md b/docs/eng/server/Sections/Language.md index f39fc98..a7ea8ae 100644 --- a/docs/eng/server/Sections/Language.md +++ b/docs/eng/server/Sections/Language.md @@ -84,8 +84,8 @@ print(r.json()["data"]) | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | | `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | [Return to the Index](../Getting%20Started.md#index) # search @@ -185,6 +185,6 @@ print(r.json()["data"]) | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | | `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | [Return to the Index](../Getting%20Started.md#index) \ No newline at end of file diff --git a/docs/eng/server/Sections/Work.md b/docs/eng/server/Sections/Work.md index 6df6f93..d854e35 100644 --- a/docs/eng/server/Sections/Work.md +++ b/docs/eng/server/Sections/Work.md @@ -92,11 +92,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", "service": "no example", + "translation": "no example", "dest_lang": "no example", "source": "no example", - "translation": "no example" + "source_lang": "no example" } } @@ -106,20 +106,20 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | No | | `service` | The service which returned the result | Translator | No | +| `translation` | The translation result | string | No | | `dest_lang` | The result's language | Language | No | | `source` | The source text | string | No | -| `translation` | The translation result | string | No | +| `source_lang` | The source text's language | Language | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # translate_html @@ -211,9 +211,9 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "source": "no example", - "service": "no example" + "source": "no example" } } @@ -223,18 +223,18 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | No | | `source_lang` | The source text's language | Language | No | | `source` | The source text | string | No | -| `service` | The service which returned the result | Translator | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # stream @@ -312,10 +312,10 @@ print(r.json()["data"]) | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # transliterate @@ -407,11 +407,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", + "service": "no example", + "transliteration": "no example", "dest_lang": "no example", "source": "no example", - "service": "no example", - "transliteration": "no example" + "source_lang": "no example" } } @@ -421,20 +421,20 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | No | -| `dest_lang` | The result's language | Language | No | -| `source` | The source text | string | No | | `service` | The service which returned the result | Translator | No | | `transliteration` | The transliteration result | string | No | +| `dest_lang` | The result's language | Language | No | +| `source` | The source text | string | No | +| `source_lang` | The source text's language | Language | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # spellcheck @@ -526,11 +526,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", - "rich": true, - "source": "no example", "service": "no example", - "corrected": "no example" + "source": "no example", + "source_lang": "no example", + "corrected": "no example", + "rich": true } } @@ -540,20 +540,20 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | No | -| `rich` | Whether the given result features the full range of information | bool | No | -| `source` | The source text | string | No | | `service` | The service which returned the result | Translator | No | +| `source` | The source text | string | No | +| `source_lang` | The source text's language | Language | No | | `corrected` | The corrected text | string | No | +| `rich` | Whether the given result features the full range of information | bool | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # language @@ -645,9 +645,9 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "source": "no example", - "service": "no example" + "source": "no example" } } @@ -657,18 +657,18 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | No | | `source_lang` | The source text's language | Language | No | | `source` | The source text | string | No | -| `service` | The service which returned the result | Translator | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # example @@ -760,12 +760,12 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "reference": "no example", - "example": "no example", - "source_lang": "no example", - "positions": "no example", "source": "no example", - "service": "no example" + "source_lang": "no example", + "example": "no example", + "positions": "no example" } } @@ -775,21 +775,21 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | No | | `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | No | -| `example` | The example | string | No | +| `source` | The source text | string | No | | `source_lang` | The source text's language | Language | No | +| `example` | The example | string | No | | `positions` | The positions of the word in the example | list[int] | No | -| `source` | The source text | string | No | -| `service` | The service which returned the result | Translator | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # dictionary @@ -881,11 +881,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "meaning": "no example", - "rich": true, "source": "no example", - "service": "no example" + "meaning": "no example", + "rich": true } } @@ -895,20 +895,20 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | No | | `source_lang` | The source text's language | Language | No | +| `source` | The source text | string | No | | `meaning` | The meaning of the text | string | No | | `rich` | Whether the given result features the full range of information | bool | No | -| `source` | The source text | string | No | -| `service` | The service which returned the result | Translator | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # tts @@ -1000,14 +1000,14 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", "extension": "no example", "result": "no example", "source": "no example", - "service": "no example", + "speed": 4, "gender": "no example", + "service": "no example", "mime_type": "no example", - "speed": 4 + "source_lang": "no example" } } @@ -1017,21 +1017,21 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | No | | `extension` | Returns the audio file extension | Optional[str] | No | | `result` | Text to speech result | bytes | No | | `source` | The source text | string | No | -| `service` | The service which returned the result | Translator | No | +| `speed` | Speed of the text to speech result | int | No | | `gender` | Gender of the 'person' saying the text | Gender | No | +| `service` | The service which returned the result | Translator | No | | `mime_type` | Returns the MIME type of the audio file | Optional[str] | No | -| `speed` | Speed of the text to speech result | int | No | +| `source_lang` | The source text's language | Language | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) \ No newline at end of file diff --git a/docs/fra/reference/__info__.md b/docs/fra/reference/__info__.md index c756dbc..265d0ca 100644 --- a/docs/fra/reference/__info__.md +++ b/docs/fra/reference/__info__.md @@ -1,5 +1,5 @@ # *module* **__info__** -> [Source: ../../../translatepy/__info__.py @ line 0](../../../translatepy/__info__.py#L0) +> [Source: ../../../translatepy/__info__.py](../../../translatepy/__info__.py#L0) Stores information on the current module version diff --git a/docs/fra/reference/exceptions.md b/docs/fra/reference/exceptions.md index ad84d31..059cd10 100644 --- a/docs/fra/reference/exceptions.md +++ b/docs/fra/reference/exceptions.md @@ -1,141 +1,73 @@ # *module* **exceptions** -> [Source: ../../../translatepy/exceptions.py @ line 0](../../../translatepy/exceptions.py#L0) +> [Source: ../../../translatepy/exceptions.py](../../../translatepy/exceptions.py#L0) A list of exceptions used throughout translatepy -## *class* **TranslatepyException** +## *class* [**TranslatepyException**](../../../translatepy/exceptions.py#L5-L9) -> [Source: ../../../translatepy/exceptions.py @ line 5-9](../../../translatepy/exceptions.py#L5-L9) +### *attr* [TranslatepyException.**LOG**](../../../translatepy/exceptions.py#L6) -### *attr* TranslatepyException.**LOG** +## *class* [**NoResult**](../../../translatepy/exceptions.py#L12-L18) -> [Source: ../../../translatepy/exceptions.py @ line 6](../../../translatepy/exceptions.py#L6) +### *attr* [NoResult.**STATUS_CODE**](../../../translatepy/exceptions.py#L13) -## *class* **NoResult** +### *attr* [NoResult.**MESSAGE**](../../../translatepy/exceptions.py#L14) -> [Source: ../../../translatepy/exceptions.py @ line 12-18](../../../translatepy/exceptions.py#L12-L18) +### *attr* [NoResult.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L15) -### *attr* NoResult.**STATUS_CODE** +## *class* [**ParameterTypeError**](../../../translatepy/exceptions.py#L21-L27) -> [Source: ../../../translatepy/exceptions.py @ line 13](../../../translatepy/exceptions.py#L13) +### *attr* [ParameterTypeError.**STATUS_CODE**](../../../translatepy/exceptions.py#L22) -### *attr* NoResult.**MESSAGE** +### *attr* [ParameterTypeError.**MESSAGE**](../../../translatepy/exceptions.py#L23) -> [Source: ../../../translatepy/exceptions.py @ line 14](../../../translatepy/exceptions.py#L14) +### *attr* [ParameterTypeError.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L24) -### *attr* NoResult.**EXCEPTION_NAME** +## *class* [**UnknownLanguage**](../../../translatepy/exceptions.py#L30-L38) -> [Source: ../../../translatepy/exceptions.py @ line 15](../../../translatepy/exceptions.py#L15) +### *attr* [UnknownLanguage.**STATUS_CODE**](../../../translatepy/exceptions.py#L31) -## *class* **ParameterTypeError** +### *attr* [UnknownLanguage.**MESSAGE**](../../../translatepy/exceptions.py#L32) -> [Source: ../../../translatepy/exceptions.py @ line 21-27](../../../translatepy/exceptions.py#L21-L27) +### *attr* [UnknownLanguage.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L33) -### *attr* ParameterTypeError.**STATUS_CODE** +## *class* [**UnknownTranslator**](../../../translatepy/exceptions.py#L41-L49) -> [Source: ../../../translatepy/exceptions.py @ line 22](../../../translatepy/exceptions.py#L22) +### *attr* [UnknownTranslator.**STATUS_CODE**](../../../translatepy/exceptions.py#L42) -### *attr* ParameterTypeError.**MESSAGE** +### *attr* [UnknownTranslator.**MESSAGE**](../../../translatepy/exceptions.py#L43) -> [Source: ../../../translatepy/exceptions.py @ line 23](../../../translatepy/exceptions.py#L23) +### *attr* [UnknownTranslator.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L44) -### *attr* ParameterTypeError.**EXCEPTION_NAME** +## *class* [**UnsupportedMethod**](../../../translatepy/exceptions.py#L52-L58) -> [Source: ../../../translatepy/exceptions.py @ line 24](../../../translatepy/exceptions.py#L24) +### *attr* [UnsupportedMethod.**STATUS_CODE**](../../../translatepy/exceptions.py#L53) -## *class* **UnknownLanguage** +### *attr* [UnsupportedMethod.**MESSAGE**](../../../translatepy/exceptions.py#L54) -> [Source: ../../../translatepy/exceptions.py @ line 30-38](../../../translatepy/exceptions.py#L30-L38) +### *attr* [UnsupportedMethod.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L55) -### *attr* UnknownLanguage.**STATUS_CODE** +## *class* [**UnsupportedLanguage**](../../../translatepy/exceptions.py#L61-L67) -> [Source: ../../../translatepy/exceptions.py @ line 31](../../../translatepy/exceptions.py#L31) +### *attr* [UnsupportedLanguage.**STATUS_CODE**](../../../translatepy/exceptions.py#L62) -### *attr* UnknownLanguage.**MESSAGE** +### *attr* [UnsupportedLanguage.**MESSAGE**](../../../translatepy/exceptions.py#L63) -> [Source: ../../../translatepy/exceptions.py @ line 32](../../../translatepy/exceptions.py#L32) +### *attr* [UnsupportedLanguage.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L64) -### *attr* UnknownLanguage.**EXCEPTION_NAME** +## *class* [**ServiceURLError**](../../../translatepy/exceptions.py#L70-L76) -> [Source: ../../../translatepy/exceptions.py @ line 33](../../../translatepy/exceptions.py#L33) +### *attr* [ServiceURLError.**STATUS_CODE**](../../../translatepy/exceptions.py#L71) -## *class* **UnknownTranslator** +### *attr* [ServiceURLError.**MESSAGE**](../../../translatepy/exceptions.py#L72) -> [Source: ../../../translatepy/exceptions.py @ line 41-49](../../../translatepy/exceptions.py#L41-L49) +### *attr* [ServiceURLError.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L73) -### *attr* UnknownTranslator.**STATUS_CODE** +## *class* [**RateLimitPrevention**](../../../translatepy/exceptions.py#L79-L82) -> [Source: ../../../translatepy/exceptions.py @ line 42](../../../translatepy/exceptions.py#L42) +### *attr* [RateLimitPrevention.**STATUS_CODE**](../../../translatepy/exceptions.py#L80) -### *attr* UnknownTranslator.**MESSAGE** +### *attr* [RateLimitPrevention.**MESSAGE**](../../../translatepy/exceptions.py#L81) -> [Source: ../../../translatepy/exceptions.py @ line 43](../../../translatepy/exceptions.py#L43) - -### *attr* UnknownTranslator.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 44](../../../translatepy/exceptions.py#L44) - -## *class* **UnsupportedMethod** - -> [Source: ../../../translatepy/exceptions.py @ line 52-58](../../../translatepy/exceptions.py#L52-L58) - -### *attr* UnsupportedMethod.**STATUS_CODE** - -> [Source: ../../../translatepy/exceptions.py @ line 53](../../../translatepy/exceptions.py#L53) - -### *attr* UnsupportedMethod.**MESSAGE** - -> [Source: ../../../translatepy/exceptions.py @ line 54](../../../translatepy/exceptions.py#L54) - -### *attr* UnsupportedMethod.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 55](../../../translatepy/exceptions.py#L55) - -## *class* **UnsupportedLanguage** - -> [Source: ../../../translatepy/exceptions.py @ line 61-67](../../../translatepy/exceptions.py#L61-L67) - -### *attr* UnsupportedLanguage.**STATUS_CODE** - -> [Source: ../../../translatepy/exceptions.py @ line 62](../../../translatepy/exceptions.py#L62) - -### *attr* UnsupportedLanguage.**MESSAGE** - -> [Source: ../../../translatepy/exceptions.py @ line 63](../../../translatepy/exceptions.py#L63) - -### *attr* UnsupportedLanguage.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 64](../../../translatepy/exceptions.py#L64) - -## *class* **ServiceURLError** - -> [Source: ../../../translatepy/exceptions.py @ line 70-76](../../../translatepy/exceptions.py#L70-L76) - -### *attr* ServiceURLError.**STATUS_CODE** - -> [Source: ../../../translatepy/exceptions.py @ line 71](../../../translatepy/exceptions.py#L71) - -### *attr* ServiceURLError.**MESSAGE** - -> [Source: ../../../translatepy/exceptions.py @ line 72](../../../translatepy/exceptions.py#L72) - -### *attr* ServiceURLError.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 73](../../../translatepy/exceptions.py#L73) - -## *class* **RateLimitPrevention** - -> [Source: ../../../translatepy/exceptions.py @ line 79-82](../../../translatepy/exceptions.py#L79-L82) - -### *attr* RateLimitPrevention.**STATUS_CODE** - -> [Source: ../../../translatepy/exceptions.py @ line 80](../../../translatepy/exceptions.py#L80) - -### *attr* RateLimitPrevention.**MESSAGE** - -> [Source: ../../../translatepy/exceptions.py @ line 81](../../../translatepy/exceptions.py#L81) - -### *attr* RateLimitPrevention.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 82](../../../translatepy/exceptions.py#L82) +### *attr* [RateLimitPrevention.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L82) diff --git a/docs/fra/reference/language.md b/docs/fra/reference/language.md index ac1bcf2..1d5f29b 100644 --- a/docs/fra/reference/language.md +++ b/docs/fra/reference/language.md @@ -1,6 +1,6 @@ # *module* **language** -> [Source: ../../../translatepy/language.py @ line 0](../../../translatepy/language.py#L0) +> [Source: ../../../translatepy/language.py](../../../translatepy/language.py#L0) Handles the languages management on `translatepy` @@ -12,21 +12,15 @@ Handles the languages management on `translatepy` - [../../../translatepy/utils/vectorize.py](../../../translatepy/utils/vectorize.py): As `vectorize` -## *const* **Number** - -> [Source: ../../../translatepy/language.py @ line 17](../../../translatepy/language.py#L17) +## *const* [**Number**](../../../translatepy/language.py#L17) Represents a number -## *class* **LanguageExtra** - -> [Source: ../../../translatepy/language.py @ line 21-34](../../../translatepy/language.py#L21-L34) +## *class* [**LanguageExtra**](../../../translatepy/language.py#L21-L34) Extra data given on supported languages -### *attr* LanguageExtra.**scope** - -> [Source: ../../../translatepy/language.py @ line 23](../../../translatepy/language.py#L23) +### *attr* [LanguageExtra.**scope**](../../../translatepy/language.py#L23) > Type: `cain.types.Enum` @@ -35,9 +29,7 @@ Language scope > **Note** > Can be one of "individual", "macrolanguage", "special" -### *attr* LanguageExtra.**type** - -> [Source: ../../../translatepy/language.py @ line 28](../../../translatepy/language.py#L28) +### *attr* [LanguageExtra.**type**](../../../translatepy/language.py#L28) > Type: `cain.types.Enum` @@ -46,773 +38,577 @@ Language type > **Note** > Can be one of "ancient", "constructed", "extinct", "historical", "living", "special" -## *class* **Foreign** - -> [Source: ../../../translatepy/language.py @ line 37-208](../../../translatepy/language.py#L37-L208) +## *class* [**Foreign**](../../../translatepy/language.py#L37-L208) The language name in foreign languages -### *attr* Foreign.**afrikaans** - -> [Source: ../../../translatepy/language.py @ line 39](../../../translatepy/language.py#L39) +### *attr* [Foreign.**afrikaans**](../../../translatepy/language.py#L39) > Type: `str` The language name in afrikaans -### *attr* Foreign.**albanian** - -> [Source: ../../../translatepy/language.py @ line 41](../../../translatepy/language.py#L41) +### *attr* [Foreign.**albanian**](../../../translatepy/language.py#L41) > Type: `str` The language name in albanian -### *attr* Foreign.**amharic** - -> [Source: ../../../translatepy/language.py @ line 43](../../../translatepy/language.py#L43) +### *attr* [Foreign.**amharic**](../../../translatepy/language.py#L43) > Type: `str` The language name in amharic -### *attr* Foreign.**arabic** - -> [Source: ../../../translatepy/language.py @ line 45](../../../translatepy/language.py#L45) +### *attr* [Foreign.**arabic**](../../../translatepy/language.py#L45) > Type: `str` The language name in arabic -### *attr* Foreign.**armenian** - -> [Source: ../../../translatepy/language.py @ line 47](../../../translatepy/language.py#L47) +### *attr* [Foreign.**armenian**](../../../translatepy/language.py#L47) > Type: `str` The language name in armenian -### *attr* Foreign.**azerbaijani** - -> [Source: ../../../translatepy/language.py @ line 49](../../../translatepy/language.py#L49) +### *attr* [Foreign.**azerbaijani**](../../../translatepy/language.py#L49) > Type: `str` The language name in azerbaijani -### *attr* Foreign.**basque** - -> [Source: ../../../translatepy/language.py @ line 51](../../../translatepy/language.py#L51) +### *attr* [Foreign.**basque**](../../../translatepy/language.py#L51) > Type: `str` The language name in basque -### *attr* Foreign.**belarusian** - -> [Source: ../../../translatepy/language.py @ line 53](../../../translatepy/language.py#L53) +### *attr* [Foreign.**belarusian**](../../../translatepy/language.py#L53) > Type: `str` The language name in belarusian -### *attr* Foreign.**bengali** - -> [Source: ../../../translatepy/language.py @ line 55](../../../translatepy/language.py#L55) +### *attr* [Foreign.**bengali**](../../../translatepy/language.py#L55) > Type: `str` The language name in bengali -### *attr* Foreign.**bosnian** - -> [Source: ../../../translatepy/language.py @ line 57](../../../translatepy/language.py#L57) +### *attr* [Foreign.**bosnian**](../../../translatepy/language.py#L57) > Type: `str` The language name in bosnian -### *attr* Foreign.**bulgarian** - -> [Source: ../../../translatepy/language.py @ line 59](../../../translatepy/language.py#L59) +### *attr* [Foreign.**bulgarian**](../../../translatepy/language.py#L59) > Type: `str` The language name in bulgarian -### *attr* Foreign.**burmese** - -> [Source: ../../../translatepy/language.py @ line 61](../../../translatepy/language.py#L61) +### *attr* [Foreign.**burmese**](../../../translatepy/language.py#L61) > Type: `str` The language name in burmese -### *attr* Foreign.**catalan** - -> [Source: ../../../translatepy/language.py @ line 63](../../../translatepy/language.py#L63) +### *attr* [Foreign.**catalan**](../../../translatepy/language.py#L63) > Type: `str` The language name in catalan -### *attr* Foreign.**chinese** - -> [Source: ../../../translatepy/language.py @ line 65](../../../translatepy/language.py#L65) +### *attr* [Foreign.**chinese**](../../../translatepy/language.py#L65) > Type: `str` The language name in chinese -### *attr* Foreign.**croatian** - -> [Source: ../../../translatepy/language.py @ line 67](../../../translatepy/language.py#L67) +### *attr* [Foreign.**croatian**](../../../translatepy/language.py#L67) > Type: `str` The language name in croatian -### *attr* Foreign.**czech** - -> [Source: ../../../translatepy/language.py @ line 69](../../../translatepy/language.py#L69) +### *attr* [Foreign.**czech**](../../../translatepy/language.py#L69) > Type: `str` The language name in czech -### *attr* Foreign.**danish** - -> [Source: ../../../translatepy/language.py @ line 71](../../../translatepy/language.py#L71) +### *attr* [Foreign.**danish**](../../../translatepy/language.py#L71) > Type: `str` The language name in danish -### *attr* Foreign.**dutch** - -> [Source: ../../../translatepy/language.py @ line 73](../../../translatepy/language.py#L73) +### *attr* [Foreign.**dutch**](../../../translatepy/language.py#L73) > Type: `str` The language name in dutch -### *attr* Foreign.**esperanto** - -> [Source: ../../../translatepy/language.py @ line 75](../../../translatepy/language.py#L75) +### *attr* [Foreign.**esperanto**](../../../translatepy/language.py#L75) > Type: `str` The language name in esperanto -### *attr* Foreign.**estonian** - -> [Source: ../../../translatepy/language.py @ line 77](../../../translatepy/language.py#L77) +### *attr* [Foreign.**estonian**](../../../translatepy/language.py#L77) > Type: `str` The language name in estonian -### *attr* Foreign.**finnish** - -> [Source: ../../../translatepy/language.py @ line 79](../../../translatepy/language.py#L79) +### *attr* [Foreign.**finnish**](../../../translatepy/language.py#L79) > Type: `str` The language name in finnish -### *attr* Foreign.**french** - -> [Source: ../../../translatepy/language.py @ line 81](../../../translatepy/language.py#L81) +### *attr* [Foreign.**french**](../../../translatepy/language.py#L81) > Type: `str` The language name in french -### *attr* Foreign.**galician** - -> [Source: ../../../translatepy/language.py @ line 83](../../../translatepy/language.py#L83) +### *attr* [Foreign.**galician**](../../../translatepy/language.py#L83) > Type: `str` The language name in galician -### *attr* Foreign.**georgian** - -> [Source: ../../../translatepy/language.py @ line 85](../../../translatepy/language.py#L85) +### *attr* [Foreign.**georgian**](../../../translatepy/language.py#L85) > Type: `str` The language name in georgian -### *attr* Foreign.**german** - -> [Source: ../../../translatepy/language.py @ line 87](../../../translatepy/language.py#L87) +### *attr* [Foreign.**german**](../../../translatepy/language.py#L87) > Type: `str` The language name in german -### *attr* Foreign.**gujarati** - -> [Source: ../../../translatepy/language.py @ line 89](../../../translatepy/language.py#L89) +### *attr* [Foreign.**gujarati**](../../../translatepy/language.py#L89) > Type: `str` The language name in gujarati -### *attr* Foreign.**haitian** - -> [Source: ../../../translatepy/language.py @ line 91](../../../translatepy/language.py#L91) +### *attr* [Foreign.**haitian**](../../../translatepy/language.py#L91) > Type: `str` The language name in haitian -### *attr* Foreign.**hebrew** - -> [Source: ../../../translatepy/language.py @ line 93](../../../translatepy/language.py#L93) +### *attr* [Foreign.**hebrew**](../../../translatepy/language.py#L93) > Type: `str` The language name in hebrew -### *attr* Foreign.**hindi** - -> [Source: ../../../translatepy/language.py @ line 95](../../../translatepy/language.py#L95) +### *attr* [Foreign.**hindi**](../../../translatepy/language.py#L95) > Type: `str` The language name in hindi -### *attr* Foreign.**hungarian** - -> [Source: ../../../translatepy/language.py @ line 97](../../../translatepy/language.py#L97) +### *attr* [Foreign.**hungarian**](../../../translatepy/language.py#L97) > Type: `str` The language name in hungarian -### *attr* Foreign.**icelandic** - -> [Source: ../../../translatepy/language.py @ line 99](../../../translatepy/language.py#L99) +### *attr* [Foreign.**icelandic**](../../../translatepy/language.py#L99) > Type: `str` The language name in icelandic -### *attr* Foreign.**indonesian** - -> [Source: ../../../translatepy/language.py @ line 101](../../../translatepy/language.py#L101) +### *attr* [Foreign.**indonesian**](../../../translatepy/language.py#L101) > Type: `str` The language name in indonesian -### *attr* Foreign.**irish** - -> [Source: ../../../translatepy/language.py @ line 103](../../../translatepy/language.py#L103) +### *attr* [Foreign.**irish**](../../../translatepy/language.py#L103) > Type: `str` The language name in irish -### *attr* Foreign.**italian** - -> [Source: ../../../translatepy/language.py @ line 105](../../../translatepy/language.py#L105) +### *attr* [Foreign.**italian**](../../../translatepy/language.py#L105) > Type: `str` The language name in italian -### *attr* Foreign.**japanese** - -> [Source: ../../../translatepy/language.py @ line 107](../../../translatepy/language.py#L107) +### *attr* [Foreign.**japanese**](../../../translatepy/language.py#L107) > Type: `str` The language name in japanese -### *attr* Foreign.**javanese** - -> [Source: ../../../translatepy/language.py @ line 109](../../../translatepy/language.py#L109) +### *attr* [Foreign.**javanese**](../../../translatepy/language.py#L109) > Type: `str` The language name in javanese -### *attr* Foreign.**kannada** - -> [Source: ../../../translatepy/language.py @ line 111](../../../translatepy/language.py#L111) +### *attr* [Foreign.**kannada**](../../../translatepy/language.py#L111) > Type: `str` The language name in kannada -### *attr* Foreign.**kazakh** - -> [Source: ../../../translatepy/language.py @ line 113](../../../translatepy/language.py#L113) +### *attr* [Foreign.**kazakh**](../../../translatepy/language.py#L113) > Type: `str` The language name in kazakh -### *attr* Foreign.**khmer** - -> [Source: ../../../translatepy/language.py @ line 115](../../../translatepy/language.py#L115) +### *attr* [Foreign.**khmer**](../../../translatepy/language.py#L115) > Type: `str` The language name in khmer -### *attr* Foreign.**kirghiz** - -> [Source: ../../../translatepy/language.py @ line 117](../../../translatepy/language.py#L117) +### *attr* [Foreign.**kirghiz**](../../../translatepy/language.py#L117) > Type: `str` The language name in kirghiz -### *attr* Foreign.**korean** - -> [Source: ../../../translatepy/language.py @ line 119](../../../translatepy/language.py#L119) +### *attr* [Foreign.**korean**](../../../translatepy/language.py#L119) > Type: `str` The language name in korean -### *attr* Foreign.**lao** - -> [Source: ../../../translatepy/language.py @ line 121](../../../translatepy/language.py#L121) +### *attr* [Foreign.**lao**](../../../translatepy/language.py#L121) > Type: `str` The language name in lao -### *attr* Foreign.**latin** - -> [Source: ../../../translatepy/language.py @ line 123](../../../translatepy/language.py#L123) +### *attr* [Foreign.**latin**](../../../translatepy/language.py#L123) > Type: `str` The language name in latin -### *attr* Foreign.**latvian** - -> [Source: ../../../translatepy/language.py @ line 125](../../../translatepy/language.py#L125) +### *attr* [Foreign.**latvian**](../../../translatepy/language.py#L125) > Type: `str` The language name in latvian -### *attr* Foreign.**lithuanian** - -> [Source: ../../../translatepy/language.py @ line 127](../../../translatepy/language.py#L127) +### *attr* [Foreign.**lithuanian**](../../../translatepy/language.py#L127) > Type: `str` The language name in lithuanian -### *attr* Foreign.**luxembourgish** - -> [Source: ../../../translatepy/language.py @ line 129](../../../translatepy/language.py#L129) +### *attr* [Foreign.**luxembourgish**](../../../translatepy/language.py#L129) > Type: `str` The language name in luxembourgish -### *attr* Foreign.**macedonian** - -> [Source: ../../../translatepy/language.py @ line 131](../../../translatepy/language.py#L131) +### *attr* [Foreign.**macedonian**](../../../translatepy/language.py#L131) > Type: `str` The language name in macedonian -### *attr* Foreign.**malagasy** - -> [Source: ../../../translatepy/language.py @ line 133](../../../translatepy/language.py#L133) +### *attr* [Foreign.**malagasy**](../../../translatepy/language.py#L133) > Type: `str` The language name in malagasy -### *attr* Foreign.**malay** - -> [Source: ../../../translatepy/language.py @ line 135](../../../translatepy/language.py#L135) +### *attr* [Foreign.**malay**](../../../translatepy/language.py#L135) > Type: `str` The language name in malay -### *attr* Foreign.**maltese** - -> [Source: ../../../translatepy/language.py @ line 137](../../../translatepy/language.py#L137) +### *attr* [Foreign.**maltese**](../../../translatepy/language.py#L137) > Type: `str` The language name in maltese -### *attr* Foreign.**maori** - -> [Source: ../../../translatepy/language.py @ line 139](../../../translatepy/language.py#L139) +### *attr* [Foreign.**maori**](../../../translatepy/language.py#L139) > Type: `str` The language name in maori -### *attr* Foreign.**marathi** - -> [Source: ../../../translatepy/language.py @ line 141](../../../translatepy/language.py#L141) +### *attr* [Foreign.**marathi**](../../../translatepy/language.py#L141) > Type: `str` The language name in marathi -### *attr* Foreign.**moderngreek** - -> [Source: ../../../translatepy/language.py @ line 143](../../../translatepy/language.py#L143) +### *attr* [Foreign.**moderngreek**](../../../translatepy/language.py#L143) > Type: `str` The language name in moderngreek -### *attr* Foreign.**mongolian** - -> [Source: ../../../translatepy/language.py @ line 145](../../../translatepy/language.py#L145) +### *attr* [Foreign.**mongolian**](../../../translatepy/language.py#L145) > Type: `str` The language name in mongolian -### *attr* Foreign.**nepali** - -> [Source: ../../../translatepy/language.py @ line 147](../../../translatepy/language.py#L147) +### *attr* [Foreign.**nepali**](../../../translatepy/language.py#L147) > Type: `str` The language name in nepali -### *attr* Foreign.**norwegian** - -> [Source: ../../../translatepy/language.py @ line 149](../../../translatepy/language.py#L149) +### *attr* [Foreign.**norwegian**](../../../translatepy/language.py#L149) > Type: `str` The language name in norwegian -### *attr* Foreign.**panjabi** - -> [Source: ../../../translatepy/language.py @ line 151](../../../translatepy/language.py#L151) +### *attr* [Foreign.**panjabi**](../../../translatepy/language.py#L151) > Type: `str` The language name in panjabi -### *attr* Foreign.**persian** - -> [Source: ../../../translatepy/language.py @ line 153](../../../translatepy/language.py#L153) +### *attr* [Foreign.**persian**](../../../translatepy/language.py#L153) > Type: `str` The language name in persian -### *attr* Foreign.**polish** - -> [Source: ../../../translatepy/language.py @ line 155](../../../translatepy/language.py#L155) +### *attr* [Foreign.**polish**](../../../translatepy/language.py#L155) > Type: `str` The language name in polish -### *attr* Foreign.**portuguese** - -> [Source: ../../../translatepy/language.py @ line 157](../../../translatepy/language.py#L157) +### *attr* [Foreign.**portuguese**](../../../translatepy/language.py#L157) > Type: `str` The language name in portuguese -### *attr* Foreign.**romanian** - -> [Source: ../../../translatepy/language.py @ line 159](../../../translatepy/language.py#L159) +### *attr* [Foreign.**romanian**](../../../translatepy/language.py#L159) > Type: `str` The language name in romanian -### *attr* Foreign.**russian** - -> [Source: ../../../translatepy/language.py @ line 161](../../../translatepy/language.py#L161) +### *attr* [Foreign.**russian**](../../../translatepy/language.py#L161) > Type: `str` The language name in russian -### *attr* Foreign.**scottishgaelic** - -> [Source: ../../../translatepy/language.py @ line 163](../../../translatepy/language.py#L163) +### *attr* [Foreign.**scottishgaelic**](../../../translatepy/language.py#L163) > Type: `str` The language name in scottishgaelic -### *attr* Foreign.**serbian** - -> [Source: ../../../translatepy/language.py @ line 165](../../../translatepy/language.py#L165) +### *attr* [Foreign.**serbian**](../../../translatepy/language.py#L165) > Type: `str` The language name in serbian -### *attr* Foreign.**sinhala** - -> [Source: ../../../translatepy/language.py @ line 167](../../../translatepy/language.py#L167) +### *attr* [Foreign.**sinhala**](../../../translatepy/language.py#L167) > Type: `str` The language name in sinhala -### *attr* Foreign.**slovak** - -> [Source: ../../../translatepy/language.py @ line 169](../../../translatepy/language.py#L169) +### *attr* [Foreign.**slovak**](../../../translatepy/language.py#L169) > Type: `str` The language name in slovak -### *attr* Foreign.**slovenian** - -> [Source: ../../../translatepy/language.py @ line 171](../../../translatepy/language.py#L171) +### *attr* [Foreign.**slovenian**](../../../translatepy/language.py#L171) > Type: `str` The language name in slovenian -### *attr* Foreign.**spanish** - -> [Source: ../../../translatepy/language.py @ line 173](../../../translatepy/language.py#L173) +### *attr* [Foreign.**spanish**](../../../translatepy/language.py#L173) > Type: `str` The language name in spanish -### *attr* Foreign.**sundanese** - -> [Source: ../../../translatepy/language.py @ line 175](../../../translatepy/language.py#L175) +### *attr* [Foreign.**sundanese**](../../../translatepy/language.py#L175) > Type: `str` The language name in sundanese -### *attr* Foreign.**swahili** - -> [Source: ../../../translatepy/language.py @ line 177](../../../translatepy/language.py#L177) +### *attr* [Foreign.**swahili**](../../../translatepy/language.py#L177) > Type: `str` The language name in swahili -### *attr* Foreign.**swedish** - -> [Source: ../../../translatepy/language.py @ line 179](../../../translatepy/language.py#L179) +### *attr* [Foreign.**swedish**](../../../translatepy/language.py#L179) > Type: `str` The language name in swedish -### *attr* Foreign.**tagalog** - -> [Source: ../../../translatepy/language.py @ line 181](../../../translatepy/language.py#L181) +### *attr* [Foreign.**tagalog**](../../../translatepy/language.py#L181) > Type: `str` The language name in tagalog -### *attr* Foreign.**tajik** - -> [Source: ../../../translatepy/language.py @ line 183](../../../translatepy/language.py#L183) +### *attr* [Foreign.**tajik**](../../../translatepy/language.py#L183) > Type: `str` The language name in tajik -### *attr* Foreign.**tamil** - -> [Source: ../../../translatepy/language.py @ line 185](../../../translatepy/language.py#L185) +### *attr* [Foreign.**tamil**](../../../translatepy/language.py#L185) > Type: `str` The language name in tamil -### *attr* Foreign.**telugu** - -> [Source: ../../../translatepy/language.py @ line 187](../../../translatepy/language.py#L187) +### *attr* [Foreign.**telugu**](../../../translatepy/language.py#L187) > Type: `str` The language name in telugu -### *attr* Foreign.**thai** - -> [Source: ../../../translatepy/language.py @ line 189](../../../translatepy/language.py#L189) +### *attr* [Foreign.**thai**](../../../translatepy/language.py#L189) > Type: `str` The language name in thai -### *attr* Foreign.**turkish** - -> [Source: ../../../translatepy/language.py @ line 191](../../../translatepy/language.py#L191) +### *attr* [Foreign.**turkish**](../../../translatepy/language.py#L191) > Type: `str` The language name in turkish -### *attr* Foreign.**ukrainian** - -> [Source: ../../../translatepy/language.py @ line 193](../../../translatepy/language.py#L193) +### *attr* [Foreign.**ukrainian**](../../../translatepy/language.py#L193) > Type: `str` The language name in ukrainian -### *attr* Foreign.**urdu** - -> [Source: ../../../translatepy/language.py @ line 195](../../../translatepy/language.py#L195) +### *attr* [Foreign.**urdu**](../../../translatepy/language.py#L195) > Type: `str` The language name in urdu -### *attr* Foreign.**uzbek** - -> [Source: ../../../translatepy/language.py @ line 197](../../../translatepy/language.py#L197) +### *attr* [Foreign.**uzbek**](../../../translatepy/language.py#L197) > Type: `str` The language name in uzbek -### *attr* Foreign.**vietnamese** - -> [Source: ../../../translatepy/language.py @ line 199](../../../translatepy/language.py#L199) +### *attr* [Foreign.**vietnamese**](../../../translatepy/language.py#L199) > Type: `str` The language name in vietnamese -### *attr* Foreign.**welsh** - -> [Source: ../../../translatepy/language.py @ line 201](../../../translatepy/language.py#L201) +### *attr* [Foreign.**welsh**](../../../translatepy/language.py#L201) > Type: `str` The language name in welsh -### *attr* Foreign.**xhosa** - -> [Source: ../../../translatepy/language.py @ line 203](../../../translatepy/language.py#L203) +### *attr* [Foreign.**xhosa**](../../../translatepy/language.py#L203) > Type: `str` The language name in xhosa -### *attr* Foreign.**yiddish** - -> [Source: ../../../translatepy/language.py @ line 205](../../../translatepy/language.py#L205) +### *attr* [Foreign.**yiddish**](../../../translatepy/language.py#L205) > Type: `str` The language name in yiddish -### *attr* Foreign.**zulu** - -> [Source: ../../../translatepy/language.py @ line 207](../../../translatepy/language.py#L207) +### *attr* [Foreign.**zulu**](../../../translatepy/language.py#L207) > Type: `str` The language name in zulu -## *const* **LANGUAGE_CACHE** - -> [Source: ../../../translatepy/language.py @ line 211](../../../translatepy/language.py#L211) +## *const* [**LANGUAGE_CACHE**](../../../translatepy/language.py#L211) -## *const* **NULLABLE_ATTRIBUTES** +## *const* [**NULLABLE_ATTRIBUTES**](../../../translatepy/language.py#L212) -> [Source: ../../../translatepy/language.py @ line 212](../../../translatepy/language.py#L212) - -## *class* **Language** - -> [Source: ../../../translatepy/language.py @ line 215-347](../../../translatepy/language.py#L215-L347) +## *class* [**Language**](../../../translatepy/language.py#L215-L347) A language -### *attr* Language.**id** - -> [Source: ../../../translatepy/language.py @ line 218](../../../translatepy/language.py#L218) +### *attr* [Language.**id**](../../../translatepy/language.py#L218) > Type: `str` The language identifier -### *attr* Language.**alpha3** - -> [Source: ../../../translatepy/language.py @ line 220](../../../translatepy/language.py#L220) +### *attr* [Language.**alpha3**](../../../translatepy/language.py#L220) > Type: `str` The ISO 639-3 (Alpha-3) code -### *attr* Language.**name** - -> [Source: ../../../translatepy/language.py @ line 222](../../../translatepy/language.py#L222) +### *attr* [Language.**name**](../../../translatepy/language.py#L222) > Type: `str` The english name -### *attr* Language.**alpha2** - -> [Source: ../../../translatepy/language.py @ line 224](../../../translatepy/language.py#L224) +### *attr* [Language.**alpha2**](../../../translatepy/language.py#L224) > Type: `Optional` The ISO 639-1 (Alpha-2) code, if available -### *attr* Language.**alpha3b** - -> [Source: ../../../translatepy/language.py @ line 226](../../../translatepy/language.py#L226) +### *attr* [Language.**alpha3b**](../../../translatepy/language.py#L226) > Type: `Optional` The ISO 639-2B (Alpha-3) code, if available -### *attr* Language.**alpha3t** - -> [Source: ../../../translatepy/language.py @ line 228](../../../translatepy/language.py#L228) +### *attr* [Language.**alpha3t**](../../../translatepy/language.py#L228) > Type: `Optional` The ISO 639-2T (Alpha-3) code, if available -### *attr* Language.**extra** - -> [Source: ../../../translatepy/language.py @ line 230](../../../translatepy/language.py#L230) +### *attr* [Language.**extra**](../../../translatepy/language.py#L230) > Type: `Optional` Extra data for the language, if available -### *attr* Language.**foreign** - -> [Source: ../../../translatepy/language.py @ line 232](../../../translatepy/language.py#L232) +### *attr* [Language.**foreign**](../../../translatepy/language.py#L232) > Type: `Optional` Name in foreign languages, if available -### *func* Language.**search** - -> [Source: ../../../translatepy/language.py @ line 269-292](../../../translatepy/language.py#L269-L292) +### *func* [Language.**search**](../../../translatepy/language.py#L269-L292) Searches the given language @@ -828,9 +624,7 @@ Searches the given language - `list` -### *func* Language.**get_extra** - -> [Source: ../../../translatepy/language.py @ line 310-317](../../../translatepy/language.py#L310-L317) +### *func* [Language.**get_extra**](../../../translatepy/language.py#L310-L317) Retrieves the given attribute from `extra` if available @@ -845,9 +639,7 @@ Retrieves the given attribute from `extra` if available - `str` -### *func* Language.**get_foreign** - -> [Source: ../../../translatepy/language.py @ line 319-328](../../../translatepy/language.py#L319-L328) +### *func* [Language.**get_foreign**](../../../translatepy/language.py#L319-L328) Retrieves the given attribute from `foreign` if available @@ -862,9 +654,7 @@ Retrieves the given attribute from `foreign` if available - `str` -### *property* Language.**similarity** - -> [Source: ../../../translatepy/language.py @ line 331-333](../../../translatepy/language.py#L331-L333) +### *property* [Language.**similarity**](../../../translatepy/language.py#L331-L333) The similarity with the vector while searching the language @@ -872,9 +662,7 @@ The similarity with the vector while searching the language - `float` -### *property* Language.**native** - -> [Source: ../../../translatepy/language.py @ line 336-338](../../../translatepy/language.py#L336-L338) +### *property* [Language.**native**](../../../translatepy/language.py#L336-L338) The native name for the language or its english name @@ -882,9 +670,7 @@ The native name for the language or its english name - `str` -### *property* Language.**rich** - -> [Source: ../../../translatepy/language.py @ line 341-347](../../../translatepy/language.py#L341-L347) +### *property* [Language.**rich**](../../../translatepy/language.py#L341-L347) If the language discovery used the full translatepy dataset Note: This returns `False` if the `Language` was not fully initialized @@ -893,56 +679,38 @@ Note: This returns `False` if the `Language` was not fully initialized - `bool` -## *class* **LanguageData** - -> [Source: ../../../translatepy/language.py @ line 352-356](../../../translatepy/language.py#L352-L356) +## *class* [**LanguageData**](../../../translatepy/language.py#L352-L356) Groups all of the data -### *attr* LanguageData.**codes** - -> [Source: ../../../translatepy/language.py @ line 354](../../../translatepy/language.py#L354) +### *attr* [LanguageData.**codes**](../../../translatepy/language.py#L354) > Type: `Dict` -### *attr* LanguageData.**data** - -> [Source: ../../../translatepy/language.py @ line 355](../../../translatepy/language.py#L355) +### *attr* [LanguageData.**data**](../../../translatepy/language.py#L355) > Type: `Dict` -### *attr* LanguageData.**vectors** - -> [Source: ../../../translatepy/language.py @ line 356](../../../translatepy/language.py#L356) +### *attr* [LanguageData.**vectors**](../../../translatepy/language.py#L356) > Type: `List` -## *const* **LANGUAGE_DATA_DIR** - -> [Source: ../../../translatepy/language.py @ line 360](../../../translatepy/language.py#L360) +## *const* [**LANGUAGE_DATA_DIR**](../../../translatepy/language.py#L360) The directory where all of the data is stored -## *const* **DATA** - -> [Source: ../../../translatepy/language.py @ line 363](../../../translatepy/language.py#L363) +## *const* [**DATA**](../../../translatepy/language.py#L363) The languages in-memory data -## *const* **TRANSLATEPY_LANGUAGE_FULL** - -> [Source: ../../../translatepy/language.py @ line 369](../../../translatepy/language.py#L369) +## *const* [**TRANSLATEPY_LANGUAGE_FULL**](../../../translatepy/language.py#L369) If the full language data database got loaded at runtime -## *func* **load_full** - -> [Source: ../../../translatepy/language.py @ line 378-385](../../../translatepy/language.py#L378-L385) +## *func* [**load_full**](../../../translatepy/language.py#L378-L385) Loads the full data languages DB -## *const* **COMMON_LANGUAGES** - -> [Source: ../../../translatepy/language.py @ line 392](../../../translatepy/language.py#L392) +## *const* [**COMMON_LANGUAGES**](../../../translatepy/language.py#L392) All of the available foreign languages for the `foreign` field on the `Language` class and English diff --git a/docs/fra/reference/models.md b/docs/fra/reference/models.md index d515c15..c8ec56d 100644 --- a/docs/fra/reference/models.md +++ b/docs/fra/reference/models.md @@ -1,6 +1,6 @@ # *module* **models** -> [Source: ../../../translatepy/models.py @ line 0](../../../translatepy/models.py#L0) +> [Source: ../../../translatepy/models.py](../../../translatepy/models.py#L0) translatepy/models.py Describes the different result models returned by the translators @@ -11,62 +11,38 @@ Describes the different result models returned by the translators - [../../../translatepy/utils/audio.py](../../../translatepy/utils/audio.py): As `get_type` -## *class* **Speed** - -> [Source: ../../../translatepy/models.py @ line 23-28](../../../translatepy/models.py#L23-L28) +## *class* [**Speed**](../../../translatepy/models.py#L23-L28) Represents a speed percentage -### *attr* Speed.**FULL** - -> [Source: ../../../translatepy/models.py @ line 25](../../../translatepy/models.py#L25) - -### *attr* Speed.**HALF** - -> [Source: ../../../translatepy/models.py @ line 26](../../../translatepy/models.py#L26) +### *attr* [Speed.**FULL**](../../../translatepy/models.py#L25) -### *attr* Speed.**QUARTER** +### *attr* [Speed.**HALF**](../../../translatepy/models.py#L26) -> [Source: ../../../translatepy/models.py @ line 27](../../../translatepy/models.py#L27) +### *attr* [Speed.**QUARTER**](../../../translatepy/models.py#L27) -### *attr* Speed.**SLOW** +### *attr* [Speed.**SLOW**](../../../translatepy/models.py#L28) -> [Source: ../../../translatepy/models.py @ line 28](../../../translatepy/models.py#L28) - -## *class* **Gender** - -> [Source: ../../../translatepy/models.py @ line 31-36](../../../translatepy/models.py#L31-L36) +## *class* [**Gender**](../../../translatepy/models.py#L31-L36) Represents a gender -### *attr* Gender.**MALE** - -> [Source: ../../../translatepy/models.py @ line 33](../../../translatepy/models.py#L33) +### *attr* [Gender.**MALE**](../../../translatepy/models.py#L33) -### *attr* Gender.**FEMALE** +### *attr* [Gender.**FEMALE**](../../../translatepy/models.py#L34) -> [Source: ../../../translatepy/models.py @ line 34](../../../translatepy/models.py#L34) +### *attr* [Gender.**OTHER**](../../../translatepy/models.py#L35) -### *attr* Gender.**OTHER** +### *attr* [Gender.**GENDERLESS**](../../../translatepy/models.py#L36) -> [Source: ../../../translatepy/models.py @ line 35](../../../translatepy/models.py#L35) - -### *attr* Gender.**GENDERLESS** - -> [Source: ../../../translatepy/models.py @ line 36](../../../translatepy/models.py#L36) - -## *class* **WordClass** - -> [Source: ../../../translatepy/models.py @ line 39-110](../../../translatepy/models.py#L39-L110) +## *class* [**WordClass**](../../../translatepy/models.py#L39-L110) Part of speech > **Note** > Refer to https://en.wikipedia.org/wiki/Part_of_speech -### *attr* WordClass.**NOUN** - -> [Source: ../../../translatepy/models.py @ line 45](../../../translatepy/models.py#L45) +### *attr* [WordClass.**NOUN**](../../../translatepy/models.py#L45) A word or lexical item denoting any abstract (abstract noun: e.g. home) or concrete entity (concrete noun: e.g. house); a person (police officer, Michael), place (coastline, London), thing (necktie, television), idea (happiness), or quality (bravery). @@ -75,37 +51,27 @@ Nouns can also be classified as count nouns or non-count nouns; some can belong > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**PRONOUN** - -> [Source: ../../../translatepy/models.py @ line 54](../../../translatepy/models.py#L54) +### *attr* [WordClass.**PRONOUN**](../../../translatepy/models.py#L54) A substitute for a noun or noun phrase (them, he). Pronouns make sentences shorter and clearer since they replace nouns. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ADJECTIVE** - -> [Source: ../../../translatepy/models.py @ line 60](../../../translatepy/models.py#L60) +### *attr* [WordClass.**ADJECTIVE**](../../../translatepy/models.py#L60) A modifier of a noun or pronoun (big, brave). Adjectives make the meaning of another word (noun) more precise. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**VERB** - -> [Source: ../../../translatepy/models.py @ line 66](../../../translatepy/models.py#L66) +### *attr* [WordClass.**VERB**](../../../translatepy/models.py#L66) A word denoting an action (walk), occurrence (happen), or state of being (be). Without a verb, a group of words cannot be a clause or sentence. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ADVERB** - -> [Source: ../../../translatepy/models.py @ line 72](../../../translatepy/models.py#L72) +### *attr* [WordClass.**ADVERB**](../../../translatepy/models.py#L72) A modifier of an adjective, verb, or another adverb (very, quite). Adverbs make language more precise. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**PREPOSITION** - -> [Source: ../../../translatepy/models.py @ line 78](../../../translatepy/models.py#L78) +### *attr* [WordClass.**PREPOSITION**](../../../translatepy/models.py#L78) A word that relates words to each other in a phrase or sentence and aids in syntactic context (in, of). Prepositions show the relationship between a noun or a pronoun with another word in the sentence. @@ -113,23 +79,17 @@ Prepositions show the relationship between a noun or a pronoun with another word > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**CONJUNCTION** - -> [Source: ../../../translatepy/models.py @ line 86](../../../translatepy/models.py#L86) +### *attr* [WordClass.**CONJUNCTION**](../../../translatepy/models.py#L86) A syntactic connector; links words, phrases, or clauses (and, but). Conjunctions connect words or group of words Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**INTERJECTION** - -> [Source: ../../../translatepy/models.py @ line 92](../../../translatepy/models.py#L92) +### *attr* [WordClass.**INTERJECTION**](../../../translatepy/models.py#L92) An emotional greeting or exclamation (Huzzah, Alas). Interjections express strong feelings and emotions. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ARTICLE** - -> [Source: ../../../translatepy/models.py @ line 98](../../../translatepy/models.py#L98) +### *attr* [WordClass.**ARTICLE**](../../../translatepy/models.py#L98) A grammatical marker of definiteness (the) or indefiniteness (a, an). The article is not always listed among the parts of speech. @@ -138,23 +98,15 @@ It is considered by some grammarians to be a type of adjective or sometimes the > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**OTHER** - -> [Source: ../../../translatepy/models.py @ line 107](../../../translatepy/models.py#L107) +### *attr* [WordClass.**OTHER**](../../../translatepy/models.py#L107) For other part of speech -## *const* **Translator** - -> [Source: ../../../translatepy/models.py @ line 113](../../../translatepy/models.py#L113) - -## *const* **PRIVATE_ATTRIBUTES** +## *const* [**Translator**](../../../translatepy/models.py#L113) -> [Source: ../../../translatepy/models.py @ line 115](../../../translatepy/models.py#L115) +## *const* [**PRIVATE_ATTRIBUTES**](../../../translatepy/models.py#L115) -## *func* **should_be_exported** - -> [Source: ../../../translatepy/models.py @ line 118-121](../../../translatepy/models.py#L118-L121) +## *func* [**should_be_exported**](../../../translatepy/models.py#L118-L121) if the given attribute should be exposed or not @@ -163,33 +115,23 @@ if the given attribute should be exposed or not - **attr**: `str` -## *class* **ResultAttribute** - -> [Source: ../../../translatepy/models.py @ line 125-129](../../../translatepy/models.py#L125-L129) +## *class* [**ResultAttribute**](../../../translatepy/models.py#L125-L129) Details about a result attribute -### *attr* ResultAttribute.**name** - -> [Source: ../../../translatepy/models.py @ line 127](../../../translatepy/models.py#L127) +### *attr* [ResultAttribute.**name**](../../../translatepy/models.py#L127) > Type: `str` -### *attr* ResultAttribute.**annotation** - -> [Source: ../../../translatepy/models.py @ line 128](../../../translatepy/models.py#L128) +### *attr* [ResultAttribute.**annotation**](../../../translatepy/models.py#L128) > Type: `Optional` -### *attr* ResultAttribute.**description** - -> [Source: ../../../translatepy/models.py @ line 129](../../../translatepy/models.py#L129) +### *attr* [ResultAttribute.**description**](../../../translatepy/models.py#L129) > Type: `Optional` -## *class* **Result** - -> [Source: ../../../translatepy/models.py @ line 136-287](../../../translatepy/models.py#L136-L287) +## *class* [**Result**](../../../translatepy/models.py#L136-L287) The base result model @@ -197,33 +139,25 @@ The base result model - `IndexError` -### *attr* Result.**service** - -> [Source: ../../../translatepy/models.py @ line 143](../../../translatepy/models.py#L143) +### *attr* [Result.**service**](../../../translatepy/models.py#L143) > Type: `Translator` The service which returned the result -### *attr* Result.**source** - -> [Source: ../../../translatepy/models.py @ line 146](../../../translatepy/models.py#L146) +### *attr* [Result.**source**](../../../translatepy/models.py#L146) > Type: `str` The source text -### *attr* Result.**source_lang** - -> [Source: ../../../translatepy/models.py @ line 148](../../../translatepy/models.py#L148) +### *attr* [Result.**source_lang**](../../../translatepy/models.py#L148) > Type: `Language` The source text's language -### *attr* Result.**raw** - -> [Source: ../../../translatepy/models.py @ line 158](../../../translatepy/models.py#L158) +### *attr* [Result.**raw**](../../../translatepy/models.py#L158) > Type: `Optional` @@ -231,9 +165,7 @@ The raw response returned by the service. Note: This is very dependent on the service used. Refer to the service documentation to learn how to use this object. -### *property* Result.**attributes** - -> [Source: ../../../translatepy/models.py @ line 217-267](../../../translatepy/models.py#L217-L267) +### *property* [Result.**attributes**](../../../translatepy/models.py#L217-L267) The different attributes on the dataclass @@ -246,9 +178,7 @@ The different attributes on the dataclass - `list` -### *property* Result.**exported** - -> [Source: ../../../translatepy/models.py @ line 270-281](../../../translatepy/models.py#L270-L281) +### *property* [Result.**exported**](../../../translatepy/models.py#L270-L281) A dictionary version of the dataclass which can be exposed to the public @@ -256,169 +186,119 @@ A dictionary version of the dataclass which can be exposed to the public - `dict` -## *class* **TranslationResult** - -> [Source: ../../../translatepy/models.py @ line 291-329](../../../translatepy/models.py#L291-L329) +## *class* [**TranslationResult**](../../../translatepy/models.py#L291-L329) Holds the result of a regular translation -### *attr* TranslationResult.**dest_lang** - -> [Source: ../../../translatepy/models.py @ line 296](../../../translatepy/models.py#L296) +### *attr* [TranslationResult.**dest_lang**](../../../translatepy/models.py#L296) > Type: `Language` The result's language -### *attr* TranslationResult.**translation** - -> [Source: ../../../translatepy/models.py @ line 299](../../../translatepy/models.py#L299) +### *attr* [TranslationResult.**translation**](../../../translatepy/models.py#L299) > Type: `str` The translation result -### *property* TranslationResult.**alternatives** - -> [Source: ../../../translatepy/models.py @ line 306-310](../../../translatepy/models.py#L306-L310) +### *property* [TranslationResult.**alternatives**](../../../translatepy/models.py#L306-L310) Returns the alternative translations associated -## *const* **TRANSLATION_TEST** +## *const* [**TRANSLATION_TEST**](../../../translatepy/models.py#L332) -> [Source: ../../../translatepy/models.py @ line 332](../../../translatepy/models.py#L332) - -## *class* **TransliterationResult** - -> [Source: ../../../translatepy/models.py @ line 344-371](../../../translatepy/models.py#L344-L371) +## *class* [**TransliterationResult**](../../../translatepy/models.py#L344-L371) Holds the result of a transliteration -### *attr* TransliterationResult.**transliteration** - -> [Source: ../../../translatepy/models.py @ line 348](../../../translatepy/models.py#L348) +### *attr* [TransliterationResult.**transliteration**](../../../translatepy/models.py#L348) > Type: `str` The transliteration result -### *attr* TransliterationResult.**dest_lang** - -> [Source: ../../../translatepy/models.py @ line 351](../../../translatepy/models.py#L351) +### *attr* [TransliterationResult.**dest_lang**](../../../translatepy/models.py#L351) > Type: `Language` The result's language -## *const* **TRANSLITERATION_TEST** +## *const* [**TRANSLITERATION_TEST**](../../../translatepy/models.py#L374) -> [Source: ../../../translatepy/models.py @ line 374](../../../translatepy/models.py#L374) - -## *class* **SpellcheckResult** - -> [Source: ../../../translatepy/models.py @ line 384-410](../../../translatepy/models.py#L384-L410) +## *class* [**SpellcheckResult**](../../../translatepy/models.py#L384-L410) Holds a spellchecking result -### *attr* SpellcheckResult.**rich** - -> [Source: ../../../translatepy/models.py @ line 389](../../../translatepy/models.py#L389) +### *attr* [SpellcheckResult.**rich**](../../../translatepy/models.py#L389) -### *attr* SpellcheckResult.**source_lang** - -> [Source: ../../../translatepy/models.py @ line 391](../../../translatepy/models.py#L391) +### *attr* [SpellcheckResult.**source_lang**](../../../translatepy/models.py#L391) > Type: `Language` The source text's language -### *attr* SpellcheckResult.**corrected** - -> [Source: ../../../translatepy/models.py @ line 393](../../../translatepy/models.py#L393) +### *attr* [SpellcheckResult.**corrected**](../../../translatepy/models.py#L393) > Type: `str` The corrected text -## *const* **SPELLCHECK_TEST** - -> [Source: ../../../translatepy/models.py @ line 413](../../../translatepy/models.py#L413) +## *const* [**SPELLCHECK_TEST**](../../../translatepy/models.py#L413) -## *class* **SpellcheckMistake** - -> [Source: ../../../translatepy/models.py @ line 422-435](../../../translatepy/models.py#L422-L435) +## *class* [**SpellcheckMistake**](../../../translatepy/models.py#L422-L435) This holds a mistake made detected by the spellchecker -### *attr* SpellcheckMistake.**start** - -> [Source: ../../../translatepy/models.py @ line 424](../../../translatepy/models.py#L424) +### *attr* [SpellcheckMistake.**start**](../../../translatepy/models.py#L424) > Type: `int` The beginning index of the part to correct in the original text -### *attr* SpellcheckMistake.**end** - -> [Source: ../../../translatepy/models.py @ line 426](../../../translatepy/models.py#L426) +### *attr* [SpellcheckMistake.**end**](../../../translatepy/models.py#L426) > Type: `int` The ending index of the part to correct in the original text -### *attr* SpellcheckMistake.**corrected** - -> [Source: ../../../translatepy/models.py @ line 428](../../../translatepy/models.py#L428) +### *attr* [SpellcheckMistake.**corrected**](../../../translatepy/models.py#L428) > Type: `str` The corrected part -### *attr* SpellcheckMistake.**message** - -> [Source: ../../../translatepy/models.py @ line 431](../../../translatepy/models.py#L431) +### *attr* [SpellcheckMistake.**message**](../../../translatepy/models.py#L431) > Type: `Optional` A message explaining what happened -### *attr* SpellcheckMistake.**rule** - -> [Source: ../../../translatepy/models.py @ line 434](../../../translatepy/models.py#L434) +### *attr* [SpellcheckMistake.**rule**](../../../translatepy/models.py#L434) > Type: `Optional` A string which identifies the rule associated with the mistake made -## *class* **RichSpellcheckResult** - -> [Source: ../../../translatepy/models.py @ line 441-601](../../../translatepy/models.py#L441-L601) +## *class* [**RichSpellcheckResult**](../../../translatepy/models.py#L441-L601) Holds a rich spellchecking result -### *attr* RichSpellcheckResult.**rich** +### *attr* [RichSpellcheckResult.**rich**](../../../translatepy/models.py#L447) -> [Source: ../../../translatepy/models.py @ line 447](../../../translatepy/models.py#L447) - -### *attr* RichSpellcheckResult.**source_lang** - -> [Source: ../../../translatepy/models.py @ line 449](../../../translatepy/models.py#L449) +### *attr* [RichSpellcheckResult.**source_lang**](../../../translatepy/models.py#L449) > Type: `Language` The source text's language -### *attr* RichSpellcheckResult.**mistakes** - -> [Source: ../../../translatepy/models.py @ line 451](../../../translatepy/models.py#L451) +### *attr* [RichSpellcheckResult.**mistakes**](../../../translatepy/models.py#L451) > Type: `List` The different mistakes made -### *property* RichSpellcheckResult.**corrected** - -> [Source: ../../../translatepy/models.py @ line 455-463](../../../translatepy/models.py#L455-L463) +### *property* [RichSpellcheckResult.**corrected**](../../../translatepy/models.py#L455-L463) The corrected text @@ -426,45 +306,31 @@ The corrected text - `str` -## *const* **RICH_SPELLCHECK_TEST** - -> [Source: ../../../translatepy/models.py @ line 604](../../../translatepy/models.py#L604) - -## *class* **LanguageResult** +## *const* [**RICH_SPELLCHECK_TEST**](../../../translatepy/models.py#L604) -> [Source: ../../../translatepy/models.py @ line 618-628](../../../translatepy/models.py#L618-L628) +## *class* [**LanguageResult**](../../../translatepy/models.py#L618-L628) Holds the language of the given text -## *const* **LANGUAGE_TEST** +## *const* [**LANGUAGE_TEST**](../../../translatepy/models.py#L631) -> [Source: ../../../translatepy/models.py @ line 631](../../../translatepy/models.py#L631) - -## *class* **ExampleResult** - -> [Source: ../../../translatepy/models.py @ line 635-725](../../../translatepy/models.py#L635-L725) +## *class* [**ExampleResult**](../../../translatepy/models.py#L635-L725) Holds an example sentence where the given word is used. -### *attr* ExampleResult.**example** - -> [Source: ../../../translatepy/models.py @ line 641](../../../translatepy/models.py#L641) +### *attr* [ExampleResult.**example**](../../../translatepy/models.py#L641) > Type: `str` The example -### *attr* ExampleResult.**reference** - -> [Source: ../../../translatepy/models.py @ line 644](../../../translatepy/models.py#L644) +### *attr* [ExampleResult.**reference**](../../../translatepy/models.py#L644) > Type: `Optional` Where the example comes from (i.e a book or a the person who said it if it's a quote) -### *property* ExampleResult.**position** - -> [Source: ../../../translatepy/models.py @ line 648-655](../../../translatepy/models.py#L648-L655) +### *property* [ExampleResult.**position**](../../../translatepy/models.py#L648-L655) The first position of the word in the example @@ -474,9 +340,7 @@ The first position of the word in the example - `int` -### *property* ExampleResult.**positions** - -> [Source: ../../../translatepy/models.py @ line 658-690](../../../translatepy/models.py#L658-L690) +### *property* [ExampleResult.**positions**](../../../translatepy/models.py#L658-L690) The positions of the word in the example @@ -485,75 +349,51 @@ The positions of the word in the example - `list[int]` - A list of positions of the word in the example -## *const* **EXAMPLE_TEST** - -> [Source: ../../../translatepy/models.py @ line 728](../../../translatepy/models.py#L728) +## *const* [**EXAMPLE_TEST**](../../../translatepy/models.py#L728) -## *class* **DictionaryResult** - -> [Source: ../../../translatepy/models.py @ line 737-752](../../../translatepy/models.py#L737-L752) +## *class* [**DictionaryResult**](../../../translatepy/models.py#L737-L752) Holds the meaning of the given text -### *attr* DictionaryResult.**rich** - -> [Source: ../../../translatepy/models.py @ line 743](../../../translatepy/models.py#L743) - -### *attr* DictionaryResult.**meaning** +### *attr* [DictionaryResult.**rich**](../../../translatepy/models.py#L743) -> [Source: ../../../translatepy/models.py @ line 745](../../../translatepy/models.py#L745) +### *attr* [DictionaryResult.**meaning**](../../../translatepy/models.py#L745) > Type: `str` The meaning of the text -## *const* **DICTIONARY_TEST** +## *const* [**DICTIONARY_TEST**](../../../translatepy/models.py#L755) -> [Source: ../../../translatepy/models.py @ line 755](../../../translatepy/models.py#L755) - -## *class* **EtymologicalNode** - -> [Source: ../../../translatepy/models.py @ line 764-791](../../../translatepy/models.py#L764-L791) +## *class* [**EtymologicalNode**](../../../translatepy/models.py#L764-L791) The node of an etymological tree -### *attr* EtymologicalNode.**origin** - -> [Source: ../../../translatepy/models.py @ line 766](../../../translatepy/models.py#L766) +### *attr* [EtymologicalNode.**origin**](../../../translatepy/models.py#L766) > Type: `str` The origin name (i.e 'Latin') -### *attr* EtymologicalNode.**source** - -> [Source: ../../../translatepy/models.py @ line 769](../../../translatepy/models.py#L769) +### *attr* [EtymologicalNode.**source**](../../../translatepy/models.py#L769) > Type: `Optional` The original way of writing it -### *attr* EtymologicalNode.**year** - -> [Source: ../../../translatepy/models.py @ line 771](../../../translatepy/models.py#L771) +### *attr* [EtymologicalNode.**year**](../../../translatepy/models.py#L771) > Type: `Optional` The year of origin -## *class* **RichDictionaryResult** - -> [Source: ../../../translatepy/models.py @ line 795-904](../../../translatepy/models.py#L795-L904) +## *class* [**RichDictionaryResult**](../../../translatepy/models.py#L795-L904) Holds more (optional) information than the regular `DictionaryResult` -### *attr* RichDictionaryResult.**rich** +### *attr* [RichDictionaryResult.**rich**](../../../translatepy/models.py#L801) -> [Source: ../../../translatepy/models.py @ line 801](../../../translatepy/models.py#L801) - -### *attr* RichDictionaryResult.**etymology** - -> [Source: ../../../translatepy/models.py @ line 803](../../../translatepy/models.py#L803) +### *attr* [RichDictionaryResult.**etymology**](../../../translatepy/models.py#L803) > Type: `List` @@ -566,9 +406,7 @@ Each element corresponds to a node in the tree of origins for the given text `Node1 (Greek) -> Node2 (Latin) -> Node3 (French) -> Node4 (Ancient English) -> Current Word` -### *attr* RichDictionaryResult.**gender** - -> [Source: ../../../translatepy/models.py @ line 814](../../../translatepy/models.py#L814) +### *attr* [RichDictionaryResult.**gender**](../../../translatepy/models.py#L814) > Type: `Gender` @@ -580,77 +418,55 @@ For languages which assign genders on words `chaîse (french; a chair) -> Gender.FEMALE` -### *attr* RichDictionaryResult.**pronunciation** - -> [Source: ../../../translatepy/models.py @ line 823](../../../translatepy/models.py#L823) +### *attr* [RichDictionaryResult.**pronunciation**](../../../translatepy/models.py#L823) > Type: `Optional` A way of pronouncing the text -### *attr* RichDictionaryResult.**type** - -> [Source: ../../../translatepy/models.py @ line 826](../../../translatepy/models.py#L826) +### *attr* [RichDictionaryResult.**type**](../../../translatepy/models.py#L826) > Type: `WordClass` The part of speech of the text -### *attr* RichDictionaryResult.**synonyms** - -> [Source: ../../../translatepy/models.py @ line 829](../../../translatepy/models.py#L829) +### *attr* [RichDictionaryResult.**synonyms**](../../../translatepy/models.py#L829) > Type: `List` -### *attr* RichDictionaryResult.**antonyms** - -> [Source: ../../../translatepy/models.py @ line 830](../../../translatepy/models.py#L830) +### *attr* [RichDictionaryResult.**antonyms**](../../../translatepy/models.py#L830) > Type: `List` -## *const* **RICH_DICTIONARY_TEST** +## *const* [**RICH_DICTIONARY_TEST**](../../../translatepy/models.py#L907) -> [Source: ../../../translatepy/models.py @ line 907](../../../translatepy/models.py#L907) - -## *class* **TextToSpeechResult** - -> [Source: ../../../translatepy/models.py @ line 922-988](../../../translatepy/models.py#L922-L988) +## *class* [**TextToSpeechResult**](../../../translatepy/models.py#L922-L988) Holds the text to speech results -### *attr* TextToSpeechResult.**result** - -> [Source: ../../../translatepy/models.py @ line 928](../../../translatepy/models.py#L928) +### *attr* [TextToSpeechResult.**result**](../../../translatepy/models.py#L928) > Type: `bytes` Text to speech result -### *attr* TextToSpeechResult.**speed** - -> [Source: ../../../translatepy/models.py @ line 930](../../../translatepy/models.py#L930) +### *attr* [TextToSpeechResult.**speed**](../../../translatepy/models.py#L930) > Type: `int` Speed of the text to speech result -### *attr* TextToSpeechResult.**gender** - -> [Source: ../../../translatepy/models.py @ line 932](../../../translatepy/models.py#L932) +### *attr* [TextToSpeechResult.**gender**](../../../translatepy/models.py#L932) > Type: `Gender` Gender of the 'person' saying the text -### *property* TextToSpeechResult.**type** - -> [Source: ../../../translatepy/models.py @ line 936-938](../../../translatepy/models.py#L936-L938) +### *property* [TextToSpeechResult.**type**](../../../translatepy/models.py#L936-L938) Returns the type of audio file -### *property* TextToSpeechResult.**mime_type** - -> [Source: ../../../translatepy/models.py @ line 941-953](../../../translatepy/models.py#L941-L953) +### *property* [TextToSpeechResult.**mime_type**](../../../translatepy/models.py#L941-L953) Returns the MIME type of the audio file @@ -659,9 +475,7 @@ Returns the MIME type of the audio file - `Optional[str]` - The MIME type of the audio file -### *property* TextToSpeechResult.**extension** - -> [Source: ../../../translatepy/models.py @ line 956-968](../../../translatepy/models.py#L956-L968) +### *property* [TextToSpeechResult.**extension**](../../../translatepy/models.py#L956-L968) Returns the audio file extension @@ -670,9 +484,7 @@ Returns the audio file extension - `Optional[str]` - The MIME type of the audio file -### *func* TextToSpeechResult.**write_to_file** - -> [Source: ../../../translatepy/models.py @ line 970-988](../../../translatepy/models.py#L970-L988) +### *func* [TextToSpeechResult.**write_to_file**](../../../translatepy/models.py#L970-L988) Writes the spoken text to a file. @@ -687,27 +499,19 @@ Writes the spoken text to a file. - If we need to change the extension of the file to match the right file type -## *class* **HTMLTranslationNode** - -> [Source: ../../../translatepy/models.py @ line 992-1029](../../../translatepy/models.py#L992-L1029) +## *class* [**HTMLTranslationNode**](../../../translatepy/models.py#L992-L1029) A translation node, containing the DOM element and its translation result -### *attr* HTMLTranslationNode.**node** - -> [Source: ../../../translatepy/models.py @ line 996](../../../translatepy/models.py#L996) +### *attr* [HTMLTranslationNode.**node**](../../../translatepy/models.py#L996) > Type: `bs4.NavigableString` -### *attr* HTMLTranslationNode.**result** - -> [Source: ../../../translatepy/models.py @ line 997](../../../translatepy/models.py#L997) +### *attr* [HTMLTranslationNode.**result**](../../../translatepy/models.py#L997) > Type: `Optional` -### *property* HTMLTranslationNode.**position** - -> [Source: ../../../translatepy/models.py @ line 1000-1020](../../../translatepy/models.py#L1000-L1020) +### *property* [HTMLTranslationNode.**position**](../../../translatepy/models.py#L1000-L1020) The position of the node in the HTML @@ -715,9 +519,7 @@ The position of the node in the HTML - `int` -### *property* HTMLTranslationNode.**exported** - -> [Source: ../../../translatepy/models.py @ line 1023-1029](../../../translatepy/models.py#L1023-L1029) +### *property* [HTMLTranslationNode.**exported**](../../../translatepy/models.py#L1023-L1029) The exported dictionary @@ -725,33 +527,23 @@ The exported dictionary - `dict` -## *class* **HTMLTranslationResult** - -> [Source: ../../../translatepy/models.py @ line 1033-1052](../../../translatepy/models.py#L1033-L1052) +## *class* [**HTMLTranslationResult**](../../../translatepy/models.py#L1033-L1052) Holds an HTML translation result -### *attr* HTMLTranslationResult.**result** - -> [Source: ../../../translatepy/models.py @ line 1037](../../../translatepy/models.py#L1037) +### *attr* [HTMLTranslationResult.**result**](../../../translatepy/models.py#L1037) > Type: `str` -### *attr* HTMLTranslationResult.**soup** - -> [Source: ../../../translatepy/models.py @ line 1038](../../../translatepy/models.py#L1038) +### *attr* [HTMLTranslationResult.**soup**](../../../translatepy/models.py#L1038) > Type: `bs4.BeautifulSoup` -### *attr* HTMLTranslationResult.**nodes** - -> [Source: ../../../translatepy/models.py @ line 1039](../../../translatepy/models.py#L1039) +### *attr* [HTMLTranslationResult.**nodes**](../../../translatepy/models.py#L1039) > Type: `List` -### *property* HTMLTranslationResult.**exported** - -> [Source: ../../../translatepy/models.py @ line 1048-1052](../../../translatepy/models.py#L1048-L1052) +### *property* [HTMLTranslationResult.**exported**](../../../translatepy/models.py#L1048-L1052) #### Returns diff --git a/docs/fra/reference/server/server.md b/docs/fra/reference/server/server.md index 114afdd..0b55870 100644 --- a/docs/fra/reference/server/server.md +++ b/docs/fra/reference/server/server.md @@ -1,23 +1,17 @@ # *module* **server** -> [Source: ../../../../translatepy/server/server.py @ line 0](../../../../translatepy/server/server.py#L0) +> [Source: ../../../../translatepy/server/server.py](../../../../translatepy/server/server.py#L0) the translatepy server -## *const* **app** - -> [Source: ../../../../translatepy/server/server.py @ line 6](../../../../translatepy/server/server.py#L6) +## *const* [**app**](../../../../translatepy/server/server.py#L6) The `nasse` server instance for `translatepy` -## *const* **TRANSLATEPY_ENDPOINT** - -> [Source: ../../../../translatepy/server/server.py @ line 9](../../../../translatepy/server/server.py#L9) +## *const* [**TRANSLATEPY_ENDPOINT**](../../../../translatepy/server/server.py#L9) Base `translatepy` endpoint -## *const* **SERVER_DOCS_PATH** - -> [Source: ../../../../translatepy/server/server.py @ line 13](../../../../translatepy/server/server.py#L13) +## *const* [**SERVER_DOCS_PATH**](../../../../translatepy/server/server.py#L13) The root path for the server offline docs diff --git a/docs/fra/reference/translate.md b/docs/fra/reference/translate.md index b1f3252..7425526 100644 --- a/docs/fra/reference/translate.md +++ b/docs/fra/reference/translate.md @@ -1,6 +1,6 @@ # *module* **translate** -> [Source: ../../../translatepy/translate.py @ line 0](../../../translatepy/translate.py#L0) +> [Source: ../../../translatepy/translate.py](../../../translatepy/translate.py#L0) translatepy v3.0 © Anime no Sekai — 2023 @@ -37,14 +37,10 @@ translatepy v3.0 - [../../../translatepy/utils/request.py](../../../translatepy/utils/request.py): As `request` -## *const* **DEFAULT_TRANSLATORS** - -> [Source: ../../../translatepy/translate.py @ line 15](../../../translatepy/translate.py#L15) +## *const* [**DEFAULT_TRANSLATORS**](../../../translatepy/translate.py#L15) A list of default translators to use with the translators aggregation -## *class* **Translate** - -> [Source: ../../../translatepy/translate.py @ line 20-27](../../../translatepy/translate.py#L20-L27) +## *class* [**Translate**](../../../translatepy/translate.py#L20-L27) A class which groups all of the translators diff --git a/docs/fra/reference/translators/README.md b/docs/fra/reference/translators/README.md index 316ceb5..f5dbc05 100644 --- a/docs/fra/reference/translators/README.md +++ b/docs/fra/reference/translators/README.md @@ -1,6 +1,6 @@ # *module* **__init__** -> [Source: ../../../../translatepy/translators/__init__.py @ line 0](../../../../translatepy/translators/__init__.py#L0) +> [Source: ../../../../translatepy/translators/__init__.py](../../../../translatepy/translators/__init__.py#L0) ## Imports @@ -30,58 +30,30 @@ - [../../../../translatepy/translators/papago.py](../../../../translatepy/translators/papago.py): As `Papago` -## *const* **Reverso** +## *const* [**Reverso**](../../../../translatepy/translators/__init__.py#L21) -> [Source: ../../../../translatepy/translators/__init__.py @ line 21](../../../../translatepy/translators/__init__.py#L21) +## *const* [**Bing**](../../../../translatepy/translators/__init__.py#L22) -## *const* **Bing** +## *const* [**DeepL**](../../../../translatepy/translators/__init__.py#L23) -> [Source: ../../../../translatepy/translators/__init__.py @ line 22](../../../../translatepy/translators/__init__.py#L22) +## *const* [**Deepl**](../../../../translatepy/translators/__init__.py#L24) -## *const* **DeepL** +## *const* [**Google**](../../../../translatepy/translators/__init__.py#L25) -> [Source: ../../../../translatepy/translators/__init__.py @ line 23](../../../../translatepy/translators/__init__.py#L23) +## *const* [**Libre**](../../../../translatepy/translators/__init__.py#L26) -## *const* **Deepl** +## *const* [**MyMemory**](../../../../translatepy/translators/__init__.py#L27) -> [Source: ../../../../translatepy/translators/__init__.py @ line 24](../../../../translatepy/translators/__init__.py#L24) +## *const* [**TranslateCom**](../../../../translatepy/translators/__init__.py#L28) -## *const* **Google** +## *const* [**Yandex**](../../../../translatepy/translators/__init__.py#L29) -> [Source: ../../../../translatepy/translators/__init__.py @ line 25](../../../../translatepy/translators/__init__.py#L25) +## *const* [**Microsoft**](../../../../translatepy/translators/__init__.py#L30) -## *const* **Libre** +## *const* [**QCRITranslate**](../../../../translatepy/translators/__init__.py#L32) -> [Source: ../../../../translatepy/translators/__init__.py @ line 26](../../../../translatepy/translators/__init__.py#L26) +## *const* [**PONSTranslate**](../../../../translatepy/translators/__init__.py#L33) -## *const* **MyMemory** +## *const* [**PapagoTranslate**](../../../../translatepy/translators/__init__.py#L34) -> [Source: ../../../../translatepy/translators/__init__.py @ line 27](../../../../translatepy/translators/__init__.py#L27) - -## *const* **TranslateCom** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 28](../../../../translatepy/translators/__init__.py#L28) - -## *const* **Yandex** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 29](../../../../translatepy/translators/__init__.py#L29) - -## *const* **Microsoft** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 30](../../../../translatepy/translators/__init__.py#L30) - -## *const* **QCRITranslate** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 32](../../../../translatepy/translators/__init__.py#L32) - -## *const* **PONSTranslate** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 33](../../../../translatepy/translators/__init__.py#L33) - -## *const* **PapagoTranslate** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 34](../../../../translatepy/translators/__init__.py#L34) - -## *const* **NaverTranslate** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 35](../../../../translatepy/translators/__init__.py#L35) +## *const* [**NaverTranslate**](../../../../translatepy/translators/__init__.py#L35) diff --git a/docs/fra/reference/translators/base.md b/docs/fra/reference/translators/base.md index 8a09073..9165f5e 100644 --- a/docs/fra/reference/translators/base.md +++ b/docs/fra/reference/translators/base.md @@ -1,25 +1,17 @@ # *module* **base** -> [Source: ../../../../translatepy/translators/base.py @ line 0](../../../../translatepy/translators/base.py#L0) +> [Source: ../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py#L0) translators/base.py Implements the Base Translator class -## *const* **C** +## *const* [**C**](../../../../translatepy/translators/base.py#L25) -> [Source: ../../../../translatepy/translators/base.py @ line 25](../../../../translatepy/translators/base.py#L25) +## *const* [**R**](../../../../translatepy/translators/base.py#L26) -## *const* **R** +## *const* [**HTMLType**](../../../../translatepy/translators/base.py#L27) -> [Source: ../../../../translatepy/translators/base.py @ line 26](../../../../translatepy/translators/base.py#L26) - -## *const* **HTMLType** - -> [Source: ../../../../translatepy/translators/base.py @ line 27](../../../../translatepy/translators/base.py#L27) - -## *class* **LazyIterable** - -> [Source: ../../../../translatepy/translators/base.py @ line 30-69](../../../../translatepy/translators/base.py#L30-L69) +## *class* [**LazyIterable**](../../../../translatepy/translators/base.py#L30-L69) An object which can be iterated through, even multiple times, but lazy loads the results. @@ -27,33 +19,21 @@ An object which can be iterated through, even multiple times, but lazy loads the - `IndexError` -## *const* **T** - -> [Source: ../../../../translatepy/translators/base.py @ line 73](../../../../translatepy/translators/base.py#L73) +## *const* [**T**](../../../../translatepy/translators/base.py#L73) -## *class* **BaseTranslateException** - -> [Source: ../../../../translatepy/translators/base.py @ line 79-105](../../../../translatepy/translators/base.py#L79-L105) +## *class* [**BaseTranslateException**](../../../../translatepy/translators/base.py#L79-L105) A translator exception, indicating a problem which occured during translation -### *attr* BaseTranslateException.**error_codes** - -> [Source: ../../../../translatepy/translators/base.py @ line 83](../../../../translatepy/translators/base.py#L83) - -## *class* **Flag** +### *attr* [BaseTranslateException.**error_codes**](../../../../translatepy/translators/base.py#L83) -> [Source: ../../../../translatepy/translators/base.py @ line 108-112](../../../../translatepy/translators/base.py#L108-L112) +## *class* [**Flag**](../../../../translatepy/translators/base.py#L108-L112) Defines a set of internal flags the handlers can send to the validator -### *attr* Flag.**MULTIPLE_RESULTS** - -> [Source: ../../../../translatepy/translators/base.py @ line 112](../../../../translatepy/translators/base.py#L112) - -## *class* **BaseTranslator** +### *attr* [Flag.**MULTIPLE_RESULTS**](../../../../translatepy/translators/base.py#L112) -> [Source: ../../../../translatepy/translators/base.py @ line 115-1293](../../../../translatepy/translators/base.py#L115-L1293) +## *class* [**BaseTranslator**](../../../../translatepy/translators/base.py#L115-L1293) The core of translatepy This defines a "Translator" instance, which is the gateway between the translator logic and translatepy @@ -68,9 +48,7 @@ This defines a "Translator" instance, which is the gateway between the translato - `exceptions.UnsupportedMethod` -### *func* BaseTranslator.**translate** - -> [Source: ../../../../translatepy/translators/base.py @ line 307-324](../../../../translatepy/translators/base.py#L307-L324) +### *func* [BaseTranslator.**translate**](../../../../translatepy/translators/base.py#L307-L324) Translates the given `text` into the given `dest_lang` @@ -102,9 +80,7 @@ Translates the given `text` into the given `dest_lang` - `models.TranslationResult` -### *func* BaseTranslator.**translate** - -> [Source: ../../../../translatepy/translators/base.py @ line 327-346](../../../../translatepy/translators/base.py#L327-L346) +### *func* [BaseTranslator.**translate**](../../../../translatepy/translators/base.py#L327-L346) Translates all of the elements in `text` into the given `dest_lang` @@ -139,9 +115,7 @@ Translates all of the elements in `text` into the given `dest_lang` > **Note** > aka "Bulk Translation" -### *func* BaseTranslator.**translate** - -> [Source: ../../../../translatepy/translators/base.py @ line 351-393](../../../../translatepy/translators/base.py#L351-L393) +### *func* [BaseTranslator.**translate**](../../../../translatepy/translators/base.py#L351-L393) Translates `text` into the given `dest_lang` @@ -172,9 +146,7 @@ Translates `text` into the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../translatepy/translators/base.py @ line 420-451](../../../../translatepy/translators/base.py#L420-L451) +### *func* [BaseTranslator.**translate_html**](../../../../translatepy/translators/base.py#L420-L451) Translates the given `html` into the given `dest_lang` @@ -222,9 +194,7 @@ If `False`, the node will be left as is and the `result` part will be `None` - `models.HTMLTranslationResult` -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../translatepy/translators/base.py @ line 454-486](../../../../translatepy/translators/base.py#L454-L486) +### *func* [BaseTranslator.**translate_html**](../../../../translatepy/translators/base.py#L454-L486) Translates all of the elements in `html` into the given `dest_lang` @@ -275,9 +245,7 @@ If `False`, the node will be left as is and the `result` part will be `None` > **Note** > aka "Bulk Translation" -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../translatepy/translators/base.py @ line 489-565](../../../../translatepy/translators/base.py#L489-L565) +### *func* [BaseTranslator.**translate_html**](../../../../translatepy/translators/base.py#L489-L565) Translates `html` into the given `dest_lang` @@ -324,9 +292,7 @@ Translates `html` into the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../translatepy/translators/base.py @ line 573-586](../../../../translatepy/translators/base.py#L573-L586) +### *func* [BaseTranslator.**alternatives**](../../../../translatepy/translators/base.py#L573-L586) Returns the different alternative translations available for a given previous translation. @@ -349,9 +315,7 @@ Returns the different alternative translations available for a given previous tr - `list[TranslationResult]` - The list of other translations a word might have -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../translatepy/translators/base.py @ line 589-602](../../../../translatepy/translators/base.py#L589-L602) +### *func* [BaseTranslator.**alternatives**](../../../../translatepy/translators/base.py#L589-L602) Returns the different alternative translations available for all of the given translations. @@ -374,9 +338,7 @@ Returns the different alternative translations available for all of the given tr - `LazyIterable[list[TranslationResult]]` - All of the other translations -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../translatepy/translators/base.py @ line 606-632](../../../../translatepy/translators/base.py#L606-L632) +### *func* [BaseTranslator.**alternatives**](../../../../translatepy/translators/base.py#L606-L632) Returns the different alternative translations available for the given `translation`. @@ -400,9 +362,7 @@ Returns the different alternative translations available for the given `translat > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../translatepy/translators/base.py @ line 664-681](../../../../translatepy/translators/base.py#L664-L681) +### *func* [BaseTranslator.**transliterate**](../../../../translatepy/translators/base.py#L664-L681) Transliterates the given `text` into the given `dest_lang` @@ -434,9 +394,7 @@ Transliterates the given `text` into the given `dest_lang` - `models.TransliterationResult` -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../translatepy/translators/base.py @ line 684-701](../../../../translatepy/translators/base.py#L684-L701) +### *func* [BaseTranslator.**transliterate**](../../../../translatepy/translators/base.py#L684-L701) Transliterates all of the given `text` to the given `dest_lang` @@ -468,9 +426,7 @@ Transliterates all of the given `text` to the given `dest_lang` - `LazyIterable[TransliterationResult]` - An iterable which contains the transliterations -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../translatepy/translators/base.py @ line 704-750](../../../../translatepy/translators/base.py#L704-L750) +### *func* [BaseTranslator.**transliterate**](../../../../translatepy/translators/base.py#L704-L750) Transliterates the given `text` to the given `dest_lang` @@ -501,13 +457,9 @@ Transliterates the given `text` to the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *attr* BaseTranslator.**transliteration** - -> [Source: ../../../../translatepy/translators/base.py @ line 753](../../../../translatepy/translators/base.py#L753) +### *attr* [BaseTranslator.**transliteration**](../../../../translatepy/translators/base.py#L753) -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../translatepy/translators/base.py @ line 781-798](../../../../translatepy/translators/base.py#L781-L798) +### *func* [BaseTranslator.**spellcheck**](../../../../translatepy/translators/base.py#L781-L798) Checks for spelling mistakes in the given `text` @@ -540,9 +492,7 @@ Checks for spelling mistakes in the given `text` - `SpellcheckResult` - The result of the spell check -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../translatepy/translators/base.py @ line 801-818](../../../../translatepy/translators/base.py#L801-L818) +### *func* [BaseTranslator.**spellcheck**](../../../../translatepy/translators/base.py#L801-L818) Checks for spelling mistakes in all of the given `text` @@ -573,9 +523,7 @@ Checks for spelling mistakes in all of the given `text` - `LazyIterable[SpellcheckResult]` - The results of the spell checks -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../translatepy/translators/base.py @ line 822-853](../../../../translatepy/translators/base.py#L822-L853) +### *func* [BaseTranslator.**spellcheck**](../../../../translatepy/translators/base.py#L822-L853) Checks for spelling mistakes in the given `text` @@ -605,9 +553,7 @@ Checks for spelling mistakes in the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**language** - -> [Source: ../../../../translatepy/translators/base.py @ line 881-894](../../../../translatepy/translators/base.py#L881-L894) +### *func* [BaseTranslator.**language**](../../../../translatepy/translators/base.py#L881-L894) Returns the detected language for the given `text` @@ -630,9 +576,7 @@ Returns the detected language for the given `text` - `models.LanguageResult` -### *func* BaseTranslator.**language** - -> [Source: ../../../../translatepy/translators/base.py @ line 897-910](../../../../translatepy/translators/base.py#L897-L910) +### *func* [BaseTranslator.**language**](../../../../translatepy/translators/base.py#L897-L910) Returns the detected language for all of the given `text` @@ -655,9 +599,7 @@ Returns the detected language for all of the given `text` - `LazyIterable[LanguageResult]` - The results of the language detections -### *func* BaseTranslator.**language** - -> [Source: ../../../../translatepy/translators/base.py @ line 914-936](../../../../translatepy/translators/base.py#L914-L936) +### *func* [BaseTranslator.**language**](../../../../translatepy/translators/base.py#L914-L936) Returns the detected language for the given `text` @@ -685,9 +627,7 @@ Returns the detected language for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**example** - -> [Source: ../../../../translatepy/translators/base.py @ line 960-975](../../../../translatepy/translators/base.py#L960-L975) +### *func* [BaseTranslator.**example**](../../../../translatepy/translators/base.py#L960-L975) Returns use cases for the given `text` @@ -715,9 +655,7 @@ Returns use cases for the given `text` - `list[ExampleResult]` - The examples -### *func* BaseTranslator.**example** - -> [Source: ../../../../translatepy/translators/base.py @ line 978-993](../../../../translatepy/translators/base.py#L978-L993) +### *func* [BaseTranslator.**example**](../../../../translatepy/translators/base.py#L978-L993) Returns use cases for all of the given `text` @@ -745,9 +683,7 @@ Returns use cases for all of the given `text` - `LazyIterable[list[ExampleResult]]` - All of the examples -### *func* BaseTranslator.**example** - -> [Source: ../../../../translatepy/translators/base.py @ line 997-1031](../../../../translatepy/translators/base.py#L997-L1031) +### *func* [BaseTranslator.**example**](../../../../translatepy/translators/base.py#L997-L1031) Returns use cases for the given `text` @@ -775,9 +711,7 @@ Returns use cases for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../translatepy/translators/base.py @ line 1060-1077](../../../../translatepy/translators/base.py#L1060-L1077) +### *func* [BaseTranslator.**dictionary**](../../../../translatepy/translators/base.py#L1060-L1077) Returns the meaning for the given `text` @@ -808,9 +742,7 @@ Returns the meaning for the given `text` - `list` -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../translatepy/translators/base.py @ line 1080-1097](../../../../translatepy/translators/base.py#L1080-L1097) +### *func* [BaseTranslator.**dictionary**](../../../../translatepy/translators/base.py#L1080-L1097) Returns the meaning for all of the given `text` @@ -841,9 +773,7 @@ Returns the meaning for all of the given `text` - `LazyIterable[RichDictionaryResult]` - If supported, a value which contains much more information on all of the `text` -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../translatepy/translators/base.py @ line 1101-1135](../../../../translatepy/translators/base.py#L1101-L1135) +### *func* [BaseTranslator.**dictionary**](../../../../translatepy/translators/base.py#L1101-L1135) Returns the meaning for the given `text` @@ -871,9 +801,7 @@ Returns the meaning for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../translatepy/translators/base.py @ line 1161-1180](../../../../translatepy/translators/base.py#L1161-L1180) +### *func* [BaseTranslator.**text_to_speech**](../../../../translatepy/translators/base.py#L1161-L1180) Returns the speech version of the given `text` @@ -900,9 +828,7 @@ Returns the speech version of the given `text` - `TextToSpeechResult` - The text to speech result -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../translatepy/translators/base.py @ line 1183-1202](../../../../translatepy/translators/base.py#L1183-L1202) +### *func* [BaseTranslator.**text_to_speech**](../../../../translatepy/translators/base.py#L1183-L1202) Returns the speech version for all of the given `text` @@ -929,18 +855,14 @@ Returns the speech version for all of the given `text` - `LazyIterable[TextToSpeechResult]` - The text to speech results -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../translatepy/translators/base.py @ line 1205-1241](../../../../translatepy/translators/base.py#L1205-L1241) +### *func* [BaseTranslator.**text_to_speech**](../../../../translatepy/translators/base.py#L1205-L1241) Returns the speech version of the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**clean_cache** - -> [Source: ../../../../translatepy/translators/base.py @ line 1265-1274](../../../../translatepy/translators/base.py#L1265-L1274) +### *func* [BaseTranslator.**clean_cache**](../../../../translatepy/translators/base.py#L1265-L1274) Cleans caches diff --git a/docs/fra/reference/translators/base_aggregator.md b/docs/fra/reference/translators/base_aggregator.md index ae39c56..556e05d 100644 --- a/docs/fra/reference/translators/base_aggregator.md +++ b/docs/fra/reference/translators/base_aggregator.md @@ -1,14 +1,12 @@ # *module* **base_aggregator** -> [Source: ../../../../translatepy/translators/base_aggregator.py @ line 0](../../../../translatepy/translators/base_aggregator.py#L0) +> [Source: ../../../../translatepy/translators/base_aggregator.py](../../../../translatepy/translators/base_aggregator.py#L0) ## Imports - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslator`, `C` -## *class* **BaseTranslatorAggregator** - -> [Source: ../../../../translatepy/translators/base_aggregator.py @ line 9-145](../../../../translatepy/translators/base_aggregator.py#L9-L145) +## *class* [**BaseTranslatorAggregator**](../../../../translatepy/translators/base_aggregator.py#L9-L145) ### Raises diff --git a/docs/fra/reference/translators/bing.md b/docs/fra/reference/translators/bing.md index 3edc83c..bb47dee 100644 --- a/docs/fra/reference/translators/bing.md +++ b/docs/fra/reference/translators/bing.md @@ -1,6 +1,6 @@ # *module* **Bing** -> [Source: ../../../../translatepy/translators/Bing.py @ line 0](../../../../translatepy/translators/Bing.py#L0) +> [Source: ../../../../translatepy/translators/Bing.py](../../../../translatepy/translators/Bing.py#L0) This implementation was made specifically for translatepy from 'Zhymabek Roman', based on 'Anime no Sekai' version. @@ -8,59 +8,39 @@ This implementation was made specifically for translatepy from 'Zhymabek Roman', - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator` -## *class* **BingTranslateException** +## *class* [**BingTranslateException**](../../../../translatepy/translators/Bing.py#L20-L23) -> [Source: ../../../../translatepy/translators/Bing.py @ line 20-23](../../../../translatepy/translators/Bing.py#L20-L23) +### *attr* [BingTranslateException.**error_codes**](../../../../translatepy/translators/Bing.py#L21) -### *attr* BingTranslateException.**error_codes** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 21](../../../../translatepy/translators/Bing.py#L21) - -## *class* **BingSessionData** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 26-33](../../../../translatepy/translators/Bing.py#L26-L33) +## *class* [**BingSessionData**](../../../../translatepy/translators/Bing.py#L26-L33) Bing session data holder -### *attr* BingSessionData.**ig** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 28](../../../../translatepy/translators/Bing.py#L28) +### *attr* [BingSessionData.**ig**](../../../../translatepy/translators/Bing.py#L28) > Type: `str` -### *attr* BingSessionData.**iid** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 29](../../../../translatepy/translators/Bing.py#L29) +### *attr* [BingSessionData.**iid**](../../../../translatepy/translators/Bing.py#L29) > Type: `str` -### *attr* BingSessionData.**key** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 30](../../../../translatepy/translators/Bing.py#L30) +### *attr* [BingSessionData.**key**](../../../../translatepy/translators/Bing.py#L30) > Type: `cain.types.UInt64` -### *attr* BingSessionData.**token** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 31](../../../../translatepy/translators/Bing.py#L31) +### *attr* [BingSessionData.**token**](../../../../translatepy/translators/Bing.py#L31) > Type: `str` -### *attr* BingSessionData.**cookies_keys** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 32](../../../../translatepy/translators/Bing.py#L32) +### *attr* [BingSessionData.**cookies_keys**](../../../../translatepy/translators/Bing.py#L32) > Type: `List` -### *attr* BingSessionData.**cookies_values** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 33](../../../../translatepy/translators/Bing.py#L33) +### *attr* [BingSessionData.**cookies_values**](../../../../translatepy/translators/Bing.py#L33) > Type: `List` -## *class* **BingSessionManager** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 36-136](../../../../translatepy/translators/Bing.py#L36-L136) +## *class* [**BingSessionManager**](../../../../translatepy/translators/Bing.py#L36-L136) Creates and manages a Bing session @@ -68,9 +48,7 @@ Creates and manages a Bing session - `BingTranslateException` -### *func* BingSessionManager.**send** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 92-136](../../../../translatepy/translators/Bing.py#L92-L136) +### *func* [BingSessionManager.**send**](../../../../translatepy/translators/Bing.py#L92-L136) Sends requestts to the API @@ -86,9 +64,7 @@ Sends requestts to the API - `BingTranslateException` -## *class* **BingTranslate** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 145-251](../../../../translatepy/translators/Bing.py#L145-L251) +## *class* [**BingTranslate**](../../../../translatepy/translators/Bing.py#L145-L251) A Python implementation of Microsoft Bing Translation's APIs diff --git a/docs/fra/reference/translators/deepl.md b/docs/fra/reference/translators/deepl.md index 2ef0e8e..f663f89 100644 --- a/docs/fra/reference/translators/deepl.md +++ b/docs/fra/reference/translators/deepl.md @@ -1,6 +1,6 @@ # *module* **DeepL** -> [Source: ../../../../translatepy/translators/DeepL.py @ line 0](../../../../translatepy/translators/DeepL.py#L0) +> [Source: ../../../../translatepy/translators/DeepL.py](../../../../translatepy/translators/DeepL.py#L0) DeepL Implementation for translatepy @@ -19,53 +19,33 @@ Refer to Animenosekai/translate#7 Arrangements, optimizations - **ZhymabekRoman** Co-Author -## *const* **SENTENCES_SPLITTING_REGEX** +## *const* [**SENTENCES_SPLITTING_REGEX**](../../../../translatepy/translators/DeepL.py#L31) -> [Source: ../../../../translatepy/translators/DeepL.py @ line 31](../../../../translatepy/translators/DeepL.py#L31) +## *class* [**DeeplFormality**](../../../../translatepy/translators/DeepL.py#L34-L36) -## *class* **DeeplFormality** +### *attr* [DeeplFormality.**formal**](../../../../translatepy/translators/DeepL.py#L35) -> [Source: ../../../../translatepy/translators/DeepL.py @ line 34-36](../../../../translatepy/translators/DeepL.py#L34-L36) +### *attr* [DeeplFormality.**informal**](../../../../translatepy/translators/DeepL.py#L36) -### *attr* DeeplFormality.**formal** +## *class* [**DeeplTranslate**](../../../../translatepy/translators/DeepL.py#L39-L41) -> [Source: ../../../../translatepy/translators/DeepL.py @ line 35](../../../../translatepy/translators/DeepL.py#L35) - -### *attr* DeeplFormality.**informal** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 36](../../../../translatepy/translators/DeepL.py#L36) - -## *class* **DeeplTranslate** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 39-41](../../../../translatepy/translators/DeepL.py#L39-L41) - -## *class* **DeeplTranslateException** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 44-51](../../../../translatepy/translators/DeepL.py#L44-L51) +## *class* [**DeeplTranslateException**](../../../../translatepy/translators/DeepL.py#L44-L51) Default DeepL Translate exception -### *attr* DeeplTranslateException.**error_codes** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 49](../../../../translatepy/translators/DeepL.py#L49) - -## *class* **GetClientState** +### *attr* [DeeplTranslateException.**error_codes**](../../../../translatepy/translators/DeepL.py#L49) -> [Source: ../../../../translatepy/translators/DeepL.py @ line 54-82](../../../../translatepy/translators/DeepL.py#L54-L82) +## *class* [**GetClientState**](../../../../translatepy/translators/DeepL.py#L54-L82) DeepL Translate state manager -### *func* GetClientState.**dump** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 63-74](../../../../translatepy/translators/DeepL.py#L63-L74) +### *func* [GetClientState.**dump**](../../../../translatepy/translators/DeepL.py#L63-L74) #### Returns - `dict` -### *func* GetClientState.**get** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 76-82](../../../../translatepy/translators/DeepL.py#L76-L82) +### *func* [GetClientState.**get**](../../../../translatepy/translators/DeepL.py#L76-L82) Returns a new Client State ID @@ -73,15 +53,11 @@ Returns a new Client State ID - `int` -## *class* **JSONRPCRequest** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 85-121](../../../../translatepy/translators/DeepL.py#L85-L121) +## *class* [**JSONRPCRequest**](../../../../translatepy/translators/DeepL.py#L85-L121) JSON RPC Request Sender for DeepL -### *func* JSONRPCRequest.**dump** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 99-107](../../../../translatepy/translators/DeepL.py#L99-L107) +### *func* [JSONRPCRequest.**dump**](../../../../translatepy/translators/DeepL.py#L99-L107) #### Parameters @@ -91,9 +67,7 @@ JSON RPC Request Sender for DeepL - **params**: `dict` -### *func* JSONRPCRequest.**send_jsonrpc** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 109-121](../../../../translatepy/translators/DeepL.py#L109-L121) +### *func* [JSONRPCRequest.**send_jsonrpc**](../../../../translatepy/translators/DeepL.py#L109-L121) #### Parameters @@ -107,17 +81,13 @@ JSON RPC Request Sender for DeepL - `dict` -## *class* **DeeplTranslateV1** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 124-308](../../../../translatepy/translators/DeepL.py#L124-L308) +## *class* [**DeeplTranslateV1**](../../../../translatepy/translators/DeepL.py#L124-L308) ### Raises - `exceptions.UnsupportedMethod` -## *class* **DeeplTranslateV2** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 311-386](../../../../translatepy/translators/DeepL.py#L311-L386) +## *class* [**DeeplTranslateV2**](../../../../translatepy/translators/DeepL.py#L311-L386) ### Raises diff --git a/docs/fra/reference/translators/google.md b/docs/fra/reference/translators/google.md index 051b325..f8bdecf 100644 --- a/docs/fra/reference/translators/google.md +++ b/docs/fra/reference/translators/google.md @@ -1,6 +1,6 @@ # *module* **Google** -> [Source: ../../../../translatepy/translators/Google.py @ line 0](../../../../translatepy/translators/Google.py#L0) +> [Source: ../../../../translatepy/translators/Google.py](../../../../translatepy/translators/Google.py#L0) Google Translate This both uses the mobile version of Google Translate, extension endpoints and the `batchexecute` (JSONRPC) API @@ -12,17 +12,11 @@ The `batchexecute` implementation is heavily inspired by ssut/py-googletrans#255 - [../../../../translatepy/translators/base_aggregator.py](../../../../translatepy/translators/base_aggregator.py): As `BaseTranslatorAggregator` -## *const* **DOMAINS** +## *const* [**DOMAINS**](../../../../translatepy/translators/Google.py#L21) -> [Source: ../../../../translatepy/translators/Google.py @ line 21](../../../../translatepy/translators/Google.py#L21) +## *const* [**SUPPORTED_LANGUAGES**](../../../../translatepy/translators/Google.py#L58) -## *const* **SUPPORTED_LANGUAGES** - -> [Source: ../../../../translatepy/translators/Google.py @ line 58](../../../../translatepy/translators/Google.py#L58) - -## *class* **GoogleTranslate** - -> [Source: ../../../../translatepy/translators/Google.py @ line 66-81](../../../../translatepy/translators/Google.py#L66-L81) +## *class* [**GoogleTranslate**](../../../../translatepy/translators/Google.py#L66-L81) An aggregation of Google Translate translators @@ -30,9 +24,7 @@ An aggregation of Google Translate translators - `ServiceURLError` -## *class* **GoogleTranslateV1** - -> [Source: ../../../../translatepy/translators/Google.py @ line 84-261](../../../../translatepy/translators/Google.py#L84-L261) +## *class* [**GoogleTranslateV1**](../../../../translatepy/translators/Google.py#L84-L261) A Python implementation of Google Translate's JSONRPC API @@ -40,8 +32,6 @@ A Python implementation of Google Translate's JSONRPC API - `ValueError` -## *class* **GoogleTranslateV2** - -> [Source: ../../../../translatepy/translators/Google.py @ line 264-423](../../../../translatepy/translators/Google.py#L264-L423) +## *class* [**GoogleTranslateV2**](../../../../translatepy/translators/Google.py#L264-L423) A Python implementation of Google Translate's APIs diff --git a/docs/fra/reference/translators/libre.md b/docs/fra/reference/translators/libre.md index d71e907..2b7ca3d 100644 --- a/docs/fra/reference/translators/libre.md +++ b/docs/fra/reference/translators/libre.md @@ -1,6 +1,6 @@ # *module* **Libre** -> [Source: ../../../../translatepy/translators/Libre.py @ line 0](../../../../translatepy/translators/Libre.py#L0) +> [Source: ../../../../translatepy/translators/Libre.py](../../../../translatepy/translators/Libre.py#L0) LibreTranslate translatepy's implementation of LibreTranslate @@ -13,8 +13,6 @@ translatepy's implementation of LibreTranslate - **Animenosekai** Original author -## *class* **LibreTranslate** - -> [Source: ../../../../translatepy/translators/Libre.py @ line 19-43](../../../../translatepy/translators/Libre.py#L19-L43) +## *class* [**LibreTranslate**](../../../../translatepy/translators/Libre.py#L19-L43) translatepy's implementation of LibreTranslate diff --git a/docs/fra/reference/translators/microsoft.md b/docs/fra/reference/translators/microsoft.md index 8eaeb3c..9f2e8a6 100644 --- a/docs/fra/reference/translators/microsoft.md +++ b/docs/fra/reference/translators/microsoft.md @@ -1,6 +1,6 @@ # *module* **Microsoft** -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 0](../../../../translatepy/translators/Microsoft.py#L0) +> [Source: ../../../../translatepy/translators/Microsoft.py](../../../../translatepy/translators/Microsoft.py#L0) This implementation was made specifically for translatepy by 'Zhymabek Roman'. @@ -10,27 +10,19 @@ This implementation was made specifically for translatepy by 'Zhymabek Roman'. - [../../../../translatepy/translators/base_aggregator.py](../../../../translatepy/translators/base_aggregator.py): As `BaseTranslatorAggregator` -## *class* **MicrosoftTranslate** - -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 23-32](../../../../translatepy/translators/Microsoft.py#L23-L32) +## *class* [**MicrosoftTranslate**](../../../../translatepy/translators/Microsoft.py#L23-L32) An aggregation of Microsoft Translate translators -## *class* **MicrosoftTranslateV1** - -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 37-141](../../../../translatepy/translators/Microsoft.py#L37-L141) +## *class* [**MicrosoftTranslateV1**](../../../../translatepy/translators/Microsoft.py#L37-L141) A Python implementation of Microsoft Translation, reverse engenered from Microsoft Translator Android application. Ported from https://github.com/d4n3436/GTranslate/blob/master/src/GTranslate/Translators/MicrosoftTranslator.cs Huge thanks to d4n3436. -## *class* **MicrosoftTranslateV2** - -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 144-187](../../../../translatepy/translators/Microsoft.py#L144-L187) +## *class* [**MicrosoftTranslateV2**](../../../../translatepy/translators/Microsoft.py#L144-L187) A Python implementation of Microsoft Translation, reverse engenered from Microsoft SwiftKey by ZhymabekRoman Also I found '/v1/languages?scope=translation' endpoint, idk maybe it can be useful -## *class* **MicrosoftTranslateV3** - -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 189-254](../../../../translatepy/translators/Microsoft.py#L189-L254) +## *class* [**MicrosoftTranslateV3**](../../../../translatepy/translators/Microsoft.py#L189-L254) diff --git a/docs/fra/reference/translators/mymemory.md b/docs/fra/reference/translators/mymemory.md index 79b3754..809328e 100644 --- a/docs/fra/reference/translators/mymemory.md +++ b/docs/fra/reference/translators/mymemory.md @@ -1,6 +1,6 @@ # *module* **MyMemory** -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 0](../../../../translatepy/translators/MyMemory.py#L0) +> [Source: ../../../../translatepy/translators/MyMemory.py](../../../../translatepy/translators/MyMemory.py#L0) MyMemory translatepy's implementation of MyMemory @@ -9,17 +9,11 @@ translatepy's implementation of MyMemory - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **MyMemoryException** +## *class* [**MyMemoryException**](../../../../translatepy/translators/MyMemory.py#L16-L19) -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 16-19](../../../../translatepy/translators/MyMemory.py#L16-L19) +### *attr* [MyMemoryException.**error_codes**](../../../../translatepy/translators/MyMemory.py#L17) -### *attr* MyMemoryException.**error_codes** - -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 17](../../../../translatepy/translators/MyMemory.py#L17) - -## *class* **MyMemoryTranslate** - -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 22-81](../../../../translatepy/translators/MyMemory.py#L22-L81) +## *class* [**MyMemoryTranslate**](../../../../translatepy/translators/MyMemory.py#L22-L81) translatepy's implementation of MyMemory @@ -27,6 +21,4 @@ translatepy's implementation of MyMemory - `MyMemoryException` -### *attr* MyMemoryTranslate.**base_url** - -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 26](../../../../translatepy/translators/MyMemory.py#L26) +### *attr* [MyMemoryTranslate.**base_url**](../../../../translatepy/translators/MyMemory.py#L26) diff --git a/docs/fra/reference/translators/papago.md b/docs/fra/reference/translators/papago.md index 8da7560..37cb3a6 100644 --- a/docs/fra/reference/translators/papago.md +++ b/docs/fra/reference/translators/papago.md @@ -1,6 +1,6 @@ # *module* **Papago** -> [Source: ../../../../translatepy/translators/Papago.py @ line 0](../../../../translatepy/translators/Papago.py#L0) +> [Source: ../../../../translatepy/translators/Papago.py](../../../../translatepy/translators/Papago.py#L0) translatepy's implementation of @@ -8,45 +8,29 @@ translatepy's implementation of - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **PapagoException** +## *class* [**PapagoException**](../../../../translatepy/translators/Papago.py#L18-L21) -> [Source: ../../../../translatepy/translators/Papago.py @ line 18-21](../../../../translatepy/translators/Papago.py#L18-L21) +### *attr* [PapagoException.**error_codes**](../../../../translatepy/translators/Papago.py#L19) -### *attr* PapagoException.**error_codes** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 19](../../../../translatepy/translators/Papago.py#L19) - -## *class* **PapagoSessionData** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 27-31](../../../../translatepy/translators/Papago.py#L27-L31) +## *class* [**PapagoSessionData**](../../../../translatepy/translators/Papago.py#L27-L31) Bing session data holder -### *attr* PapagoSessionData.**timestamp** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 29](../../../../translatepy/translators/Papago.py#L29) +### *attr* [PapagoSessionData.**timestamp**](../../../../translatepy/translators/Papago.py#L29) > Type: `cain.types.UInt64` -### *attr* PapagoSessionData.**cookies_keys** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 30](../../../../translatepy/translators/Papago.py#L30) +### *attr* [PapagoSessionData.**cookies_keys**](../../../../translatepy/translators/Papago.py#L30) > Type: `List` -### *attr* PapagoSessionData.**cookies_values** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 31](../../../../translatepy/translators/Papago.py#L31) +### *attr* [PapagoSessionData.**cookies_values**](../../../../translatepy/translators/Papago.py#L31) > Type: `List` -## *const* **SESSION_CACHE_EXPIRATION** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 34](../../../../translatepy/translators/Papago.py#L34) +## *const* [**SESSION_CACHE_EXPIRATION**](../../../../translatepy/translators/Papago.py#L34) -## *class* **Papago** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 37-262](../../../../translatepy/translators/Papago.py#L37-L262) +## *class* [**Papago**](../../../../translatepy/translators/Papago.py#L37-L262) translatepy's implementation of @@ -56,9 +40,7 @@ translatepy's implementation of - `exceptions.UnsupportedLanguage` -### *func* Papago.**generate_headers** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 83-119](../../../../translatepy/translators/Papago.py#L83-L119) +### *func* [Papago.**generate_headers**](../../../../translatepy/translators/Papago.py#L83-L119) Generates the headers for the API diff --git a/docs/fra/reference/translators/pons.md b/docs/fra/reference/translators/pons.md index 1e73dab..f3fa69e 100644 --- a/docs/fra/reference/translators/pons.md +++ b/docs/fra/reference/translators/pons.md @@ -1,6 +1,6 @@ # *module* **PONS** -> [Source: ../../../../translatepy/translators/PONS.py @ line 0](../../../../translatepy/translators/PONS.py#L0) +> [Source: ../../../../translatepy/translators/PONS.py](../../../../translatepy/translators/PONS.py#L0) translatepy's implementation of @@ -8,16 +8,10 @@ translatepy's implementation of - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **PONSException** +## *class* [**PONSException**](../../../../translatepy/translators/PONS.py#L15-L18) -> [Source: ../../../../translatepy/translators/PONS.py @ line 15-18](../../../../translatepy/translators/PONS.py#L15-L18) +### *attr* [PONSException.**error_codes**](../../../../translatepy/translators/PONS.py#L16) -### *attr* PONSException.**error_codes** - -> [Source: ../../../../translatepy/translators/PONS.py @ line 16](../../../../translatepy/translators/PONS.py#L16) - -## *class* **PONS** - -> [Source: ../../../../translatepy/translators/PONS.py @ line 24-111](../../../../translatepy/translators/PONS.py#L24-L111) +## *class* [**PONS**](../../../../translatepy/translators/PONS.py#L24-L111) translatepy's implementation of diff --git a/docs/fra/reference/translators/qcri.md b/docs/fra/reference/translators/qcri.md index 80bc1f8..93bb768 100644 --- a/docs/fra/reference/translators/qcri.md +++ b/docs/fra/reference/translators/qcri.md @@ -1,6 +1,6 @@ # *module* **QCRI** -> [Source: ../../../../translatepy/translators/QCRI.py @ line 0](../../../../translatepy/translators/QCRI.py#L0) +> [Source: ../../../../translatepy/translators/QCRI.py](../../../../translatepy/translators/QCRI.py#L0) translatepy's implementation of @@ -8,17 +8,11 @@ translatepy's implementation of - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **QCRIException** +## *class* [**QCRIException**](../../../../translatepy/translators/QCRI.py#L16-L19) -> [Source: ../../../../translatepy/translators/QCRI.py @ line 16-19](../../../../translatepy/translators/QCRI.py#L16-L19) +### *attr* [QCRIException.**error_codes**](../../../../translatepy/translators/QCRI.py#L17) -### *attr* QCRIException.**error_codes** - -> [Source: ../../../../translatepy/translators/QCRI.py @ line 17](../../../../translatepy/translators/QCRI.py#L17) - -## *class* **QCRI** - -> [Source: ../../../../translatepy/translators/QCRI.py @ line 25-87](../../../../translatepy/translators/QCRI.py#L25-L87) +## *class* [**QCRI**](../../../../translatepy/translators/QCRI.py#L25-L87) translatepy's implementation of diff --git a/docs/fra/reference/translators/reverso.md b/docs/fra/reference/translators/reverso.md index d375571..a8e6504 100644 --- a/docs/fra/reference/translators/reverso.md +++ b/docs/fra/reference/translators/reverso.md @@ -1,6 +1,6 @@ # *module* **Reverso** -> [Source: ../../../../translatepy/translators/Reverso.py @ line 0](../../../../translatepy/translators/Reverso.py#L0) +> [Source: ../../../../translatepy/translators/Reverso.py](../../../../translatepy/translators/Reverso.py#L0) Reverso translatepy's implementation of Reverso @@ -9,9 +9,7 @@ translatepy's implementation of Reverso - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslator`, `C` -## *class* **ReversoTranslate** - -> [Source: ../../../../translatepy/translators/Reverso.py @ line 16-182](../../../../translatepy/translators/Reverso.py#L16-L182) +## *class* [**ReversoTranslate**](../../../../translatepy/translators/Reverso.py#L16-L182) A Python implementation of Reverso's API diff --git a/docs/fra/reference/translators/translatecom.md b/docs/fra/reference/translators/translatecom.md index 6d11650..8c51a87 100644 --- a/docs/fra/reference/translators/translatecom.md +++ b/docs/fra/reference/translators/translatecom.md @@ -1,21 +1,15 @@ # *module* **TranslateCom** -> [Source: ../../../../translatepy/translators/TranslateCom.py @ line 0](../../../../translatepy/translators/TranslateCom.py#L0) +> [Source: ../../../../translatepy/translators/TranslateCom.py](../../../../translatepy/translators/TranslateCom.py#L0) ## Imports - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslator`, `C` -## *class* **TranslateComTranslate** - -> [Source: ../../../../translatepy/translators/TranslateCom.py @ line 9-44](../../../../translatepy/translators/TranslateCom.py#L9-L44) +## *class* [**TranslateComTranslate**](../../../../translatepy/translators/TranslateCom.py#L9-L44) translatepy's implementation of translate.com -### *attr* TranslateComTranslate.**translate_url** - -> [Source: ../../../../translatepy/translators/TranslateCom.py @ line 14](../../../../translatepy/translators/TranslateCom.py#L14) - -### *attr* TranslateComTranslate.**langdetect_url** +### *attr* [TranslateComTranslate.**translate_url**](../../../../translatepy/translators/TranslateCom.py#L14) -> [Source: ../../../../translatepy/translators/TranslateCom.py @ line 15](../../../../translatepy/translators/TranslateCom.py#L15) +### *attr* [TranslateComTranslate.**langdetect_url**](../../../../translatepy/translators/TranslateCom.py#L15) diff --git a/docs/fra/reference/translators/yandex.md b/docs/fra/reference/translators/yandex.md index acf39d7..2a447f1 100644 --- a/docs/fra/reference/translators/yandex.md +++ b/docs/fra/reference/translators/yandex.md @@ -1,6 +1,6 @@ # *module* **Yandex** -> [Source: ../../../../translatepy/translators/Yandex.py @ line 0](../../../../translatepy/translators/Yandex.py#L0) +> [Source: ../../../../translatepy/translators/Yandex.py](../../../../translatepy/translators/Yandex.py#L0) Yandex Translate This implementation was made specifically for translatepy from 'Zhymabek Roman', based on 'Anime no Sekai' version. @@ -9,19 +9,13 @@ This implementation was made specifically for translatepy from 'Zhymabek Roman', - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **YandexTranslateException** - -> [Source: ../../../../translatepy/translators/Yandex.py @ line 16-31](../../../../translatepy/translators/Yandex.py#L16-L31) +## *class* [**YandexTranslateException**](../../../../translatepy/translators/Yandex.py#L16-L31) Default Yandex Translate exception -### *attr* YandexTranslateException.**error_codes** - -> [Source: ../../../../translatepy/translators/Yandex.py @ line 21](../../../../translatepy/translators/Yandex.py#L21) - -## *class* **YandexTranslate** +### *attr* [YandexTranslateException.**error_codes**](../../../../translatepy/translators/Yandex.py#L21) -> [Source: ../../../../translatepy/translators/Yandex.py @ line 34-205](../../../../translatepy/translators/Yandex.py#L34-L205) +## *class* [**YandexTranslate**](../../../../translatepy/translators/Yandex.py#L34-L205) Yandex Translation Implementation diff --git a/docs/fra/reference/utils/audio.md b/docs/fra/reference/utils/audio.md index 49fd953..2bcf114 100644 --- a/docs/fra/reference/utils/audio.md +++ b/docs/fra/reference/utils/audio.md @@ -1,6 +1,6 @@ # *module* **audio** -> [Source: ../../../../translatepy/utils/audio.py @ line 0](../../../../translatepy/utils/audio.py#L0) +> [Source: ../../../../translatepy/utils/audio.py](../../../../translatepy/utils/audio.py#L0) Handles audio file formats for translatepy @@ -9,27 +9,19 @@ Handles audio file formats for translatepy - **h2non, MIT License** Author of `filetype.py` a Python package to infer binary file types checking the magic numbers signature Most of the source code comes from this package -## *class* **Type** - -> [Source: ../../../../translatepy/utils/audio.py @ line 12-22](../../../../translatepy/utils/audio.py#L12-L22) +## *class* [**Type**](../../../../translatepy/utils/audio.py#L12-L22) Represents an audio format -### *attr* Type.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 16](../../../../translatepy/utils/audio.py#L16) +### *attr* [Type.**MIME**](../../../../translatepy/utils/audio.py#L16) > Type: `str` -### *attr* Type.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 17](../../../../translatepy/utils/audio.py#L17) +### *attr* [Type.**EXTENSION**](../../../../translatepy/utils/audio.py#L17) > Type: `str` -### *func* Type.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 20-22](../../../../translatepy/utils/audio.py#L20-L22) +### *func* [Type.**test**](../../../../translatepy/utils/audio.py#L20-L22) Tests if the given file matches the audio format @@ -38,193 +30,127 @@ Tests if the given file matches the audio format - **data**: `bytes` -## *class* **MP3** - -> [Source: ../../../../translatepy/utils/audio.py @ line 25-42](../../../../translatepy/utils/audio.py#L25-L42) +## *class* [**MP3**](../../../../translatepy/utils/audio.py#L25-L42) Implements the MP3 audio type matcher. -### *attr* MP3.**MIME** +### *attr* [MP3.**MIME**](../../../../translatepy/utils/audio.py#L29) -> [Source: ../../../../translatepy/utils/audio.py @ line 29](../../../../translatepy/utils/audio.py#L29) +### *attr* [MP3.**EXTENSION**](../../../../translatepy/utils/audio.py#L30) -### *attr* MP3.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 30](../../../../translatepy/utils/audio.py#L30) - -### *func* MP3.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 33-42](../../../../translatepy/utils/audio.py#L33-L42) +### *func* [MP3.**test**](../../../../translatepy/utils/audio.py#L33-L42) #### Parameters - **data**: `bytes` -## *class* **M4A** - -> [Source: ../../../../translatepy/utils/audio.py @ line 45-64](../../../../translatepy/utils/audio.py#L45-L64) +## *class* [**M4A**](../../../../translatepy/utils/audio.py#L45-L64) Implements the M4A audio type matcher. -### *attr* M4A.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 49](../../../../translatepy/utils/audio.py#L49) +### *attr* [M4A.**MIME**](../../../../translatepy/utils/audio.py#L49) -### *attr* M4A.**EXTENSION** +### *attr* [M4A.**EXTENSION**](../../../../translatepy/utils/audio.py#L50) -> [Source: ../../../../translatepy/utils/audio.py @ line 50](../../../../translatepy/utils/audio.py#L50) - -### *func* M4A.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 53-64](../../../../translatepy/utils/audio.py#L53-L64) +### *func* [M4A.**test**](../../../../translatepy/utils/audio.py#L53-L64) #### Parameters - **data**: `bytes` -## *class* **Ogg** - -> [Source: ../../../../translatepy/utils/audio.py @ line 67-79](../../../../translatepy/utils/audio.py#L67-L79) +## *class* [**Ogg**](../../../../translatepy/utils/audio.py#L67-L79) Implements the OGG audio type matcher. -### *attr* Ogg.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 71](../../../../translatepy/utils/audio.py#L71) - -### *attr* Ogg.**EXTENSION** +### *attr* [Ogg.**MIME**](../../../../translatepy/utils/audio.py#L71) -> [Source: ../../../../translatepy/utils/audio.py @ line 72](../../../../translatepy/utils/audio.py#L72) +### *attr* [Ogg.**EXTENSION**](../../../../translatepy/utils/audio.py#L72) -### *func* Ogg.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 75-79](../../../../translatepy/utils/audio.py#L75-L79) +### *func* [Ogg.**test**](../../../../translatepy/utils/audio.py#L75-L79) #### Parameters - **data**: `bytes` -## *class* **Flac** - -> [Source: ../../../../translatepy/utils/audio.py @ line 82-94](../../../../translatepy/utils/audio.py#L82-L94) +## *class* [**Flac**](../../../../translatepy/utils/audio.py#L82-L94) Implements the FLAC audio type matcher. -### *attr* Flac.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 86](../../../../translatepy/utils/audio.py#L86) - -### *attr* Flac.**EXTENSION** +### *attr* [Flac.**MIME**](../../../../translatepy/utils/audio.py#L86) -> [Source: ../../../../translatepy/utils/audio.py @ line 87](../../../../translatepy/utils/audio.py#L87) +### *attr* [Flac.**EXTENSION**](../../../../translatepy/utils/audio.py#L87) -### *func* Flac.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 90-94](../../../../translatepy/utils/audio.py#L90-L94) +### *func* [Flac.**test**](../../../../translatepy/utils/audio.py#L90-L94) #### Parameters - **data**: `bytes` -## *class* **Wav** - -> [Source: ../../../../translatepy/utils/audio.py @ line 97-113](../../../../translatepy/utils/audio.py#L97-L113) +## *class* [**Wav**](../../../../translatepy/utils/audio.py#L97-L113) Implements the WAV audio type matcher. -### *attr* Wav.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 101](../../../../translatepy/utils/audio.py#L101) - -### *attr* Wav.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 102](../../../../translatepy/utils/audio.py#L102) +### *attr* [Wav.**MIME**](../../../../translatepy/utils/audio.py#L101) -### *func* Wav.**test** +### *attr* [Wav.**EXTENSION**](../../../../translatepy/utils/audio.py#L102) -> [Source: ../../../../translatepy/utils/audio.py @ line 105-113](../../../../translatepy/utils/audio.py#L105-L113) +### *func* [Wav.**test**](../../../../translatepy/utils/audio.py#L105-L113) #### Parameters - **data**: `bytes` -## *class* **Amr** - -> [Source: ../../../../translatepy/utils/audio.py @ line 116-130](../../../../translatepy/utils/audio.py#L116-L130) +## *class* [**Amr**](../../../../translatepy/utils/audio.py#L116-L130) Implements the AMR audio type matcher. -### *attr* Amr.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 120](../../../../translatepy/utils/audio.py#L120) - -### *attr* Amr.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 121](../../../../translatepy/utils/audio.py#L121) +### *attr* [Amr.**MIME**](../../../../translatepy/utils/audio.py#L120) -### *func* Amr.**test** +### *attr* [Amr.**EXTENSION**](../../../../translatepy/utils/audio.py#L121) -> [Source: ../../../../translatepy/utils/audio.py @ line 124-130](../../../../translatepy/utils/audio.py#L124-L130) +### *func* [Amr.**test**](../../../../translatepy/utils/audio.py#L124-L130) #### Parameters - **data**: `bytes` -## *class* **Aac** - -> [Source: ../../../../translatepy/utils/audio.py @ line 133-142](../../../../translatepy/utils/audio.py#L133-L142) +## *class* [**Aac**](../../../../translatepy/utils/audio.py#L133-L142) Implements the Aac audio type matcher. -### *attr* Aac.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 136](../../../../translatepy/utils/audio.py#L136) - -### *attr* Aac.**EXTENSION** +### *attr* [Aac.**MIME**](../../../../translatepy/utils/audio.py#L136) -> [Source: ../../../../translatepy/utils/audio.py @ line 137](../../../../translatepy/utils/audio.py#L137) +### *attr* [Aac.**EXTENSION**](../../../../translatepy/utils/audio.py#L137) -### *func* Aac.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 140-142](../../../../translatepy/utils/audio.py#L140-L142) +### *func* [Aac.**test**](../../../../translatepy/utils/audio.py#L140-L142) #### Parameters - **data**: `bytes` -## *class* **Aiff** - -> [Source: ../../../../translatepy/utils/audio.py @ line 145-161](../../../../translatepy/utils/audio.py#L145-L161) +## *class* [**Aiff**](../../../../translatepy/utils/audio.py#L145-L161) Implements the AIFF audio type matcher. -### *attr* Aiff.**MIME** +### *attr* [Aiff.**MIME**](../../../../translatepy/utils/audio.py#L149) -> [Source: ../../../../translatepy/utils/audio.py @ line 149](../../../../translatepy/utils/audio.py#L149) +### *attr* [Aiff.**EXTENSION**](../../../../translatepy/utils/audio.py#L150) -### *attr* Aiff.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 150](../../../../translatepy/utils/audio.py#L150) - -### *func* Aiff.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 153-161](../../../../translatepy/utils/audio.py#L153-L161) +### *func* [Aiff.**test**](../../../../translatepy/utils/audio.py#L153-L161) #### Parameters - **data**: `bytes` -## *func* **get_type** - -> [Source: ../../../../translatepy/utils/audio.py @ line 164-181](../../../../translatepy/utils/audio.py#L164-L181) +## *func* [**get_type**](../../../../translatepy/utils/audio.py#L164-L181) Returns the audio format of the given buffer diff --git a/docs/fra/reference/utils/gtoken.md b/docs/fra/reference/utils/gtoken.md index 0880fe6..828e745 100644 --- a/docs/fra/reference/utils/gtoken.md +++ b/docs/fra/reference/utils/gtoken.md @@ -1,6 +1,6 @@ # *module* **gtoken** -> [Source: ../../../../translatepy/utils/gtoken.py @ line 0](../../../../translatepy/utils/gtoken.py#L0) +> [Source: ../../../../translatepy/utils/gtoken.py](../../../../translatepy/utils/gtoken.py#L0) ORIGINAL FILENAME: gtoken.py @@ -33,13 +33,9 @@ LICENSE: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -## *const* **HEADERS** +## *const* [**HEADERS**](../../../../translatepy/utils/gtoken.py#L45) -> [Source: ../../../../translatepy/utils/gtoken.py @ line 45](../../../../translatepy/utils/gtoken.py#L45) - -## *class* **TokenAcquirer** - -> [Source: ../../../../translatepy/utils/gtoken.py @ line 56-244](../../../../translatepy/utils/gtoken.py#L56-L244) +## *class* [**TokenAcquirer**](../../../../translatepy/utils/gtoken.py#L56-L244) Google Translate API token generator translate.google.com uses a token to authorize the requests. If you are @@ -65,26 +61,18 @@ Example usage: - `Exception` -### *attr* TokenAcquirer.**RE_TKK** - -> [Source: ../../../../translatepy/utils/gtoken.py @ line 82](../../../../translatepy/utils/gtoken.py#L82) +### *attr* [TokenAcquirer.**RE_TKK**](../../../../translatepy/utils/gtoken.py#L82) -### *attr* TokenAcquirer.**RE_RAWTKK** +### *attr* [TokenAcquirer.**RE_RAWTKK**](../../../../translatepy/utils/gtoken.py#L83) -> [Source: ../../../../translatepy/utils/gtoken.py @ line 83](../../../../translatepy/utils/gtoken.py#L83) - -### *func* TokenAcquirer.**acquire** - -> [Source: ../../../../translatepy/utils/gtoken.py @ line 185-239](../../../../translatepy/utils/gtoken.py#L185-L239) +### *func* [TokenAcquirer.**acquire**](../../../../translatepy/utils/gtoken.py#L185-L239) #### Parameters - **text** -### *func* TokenAcquirer.**do** - -> [Source: ../../../../translatepy/utils/gtoken.py @ line 241-244](../../../../translatepy/utils/gtoken.py#L241-L244) +### *func* [TokenAcquirer.**do**](../../../../translatepy/utils/gtoken.py#L241-L244) #### Parameters diff --git a/docs/fra/reference/utils/hasher.md b/docs/fra/reference/utils/hasher.md index 948a25b..4f1a190 100644 --- a/docs/fra/reference/utils/hasher.md +++ b/docs/fra/reference/utils/hasher.md @@ -1,13 +1,11 @@ # *module* **hasher** -> [Source: ../../../../translatepy/utils/hasher.py @ line 0](../../../../translatepy/utils/hasher.py#L0) +> [Source: ../../../../translatepy/utils/hasher.py](../../../../translatepy/utils/hasher.py#L0) utils/hasher.py Utility to hash different kind of objects -## *func* **sha256** - -> [Source: ../../../../translatepy/utils/hasher.py @ line 11-28](../../../../translatepy/utils/hasher.py#L11-L28) +## *func* [**sha256**](../../../../translatepy/utils/hasher.py#L11-L28) Hashes the given content using SHA-256 and returns its hexadecimal version @@ -22,9 +20,7 @@ Hashes the given content using SHA-256 and returns its hexadecimal version - `str` - The SHA-256 hash -## *func* **hash_object** - -> [Source: ../../../../translatepy/utils/hasher.py @ line 31-48](../../../../translatepy/utils/hasher.py#L31-L48) +## *func* [**hash_object**](../../../../translatepy/utils/hasher.py#L31-L48) Hashes a given object @@ -38,9 +34,7 @@ Hashes a given object - `str` - The hash of the object -## *func* **hash_request** - -> [Source: ../../../../translatepy/utils/hasher.py @ line 51-82](../../../../translatepy/utils/hasher.py#L51-L82) +## *func* [**hash_request**](../../../../translatepy/utils/hasher.py#L51-L82) Hashes the given request. diff --git a/docs/fra/reference/utils/importer.md b/docs/fra/reference/utils/importer.md index f82aabb..ce063e0 100644 --- a/docs/fra/reference/utils/importer.md +++ b/docs/fra/reference/utils/importer.md @@ -1,6 +1,6 @@ # *module* **importer** -> [Source: ../../../../translatepy/utils/importer.py @ line 0](../../../../translatepy/utils/importer.py#L0) +> [Source: ../../../../translatepy/utils/importer.py](../../../../translatepy/utils/importer.py#L0) importer.py A module to allow for dynamic importing of translators. @@ -11,25 +11,15 @@ A module to allow for dynamic importing of translators. - [../../../../translatepy/utils/vectorize.py](../../../../translatepy/utils/vectorize.py): As `vectorize` -## *const* **IMPORTER_CACHE** +## *const* [**IMPORTER_CACHE**](../../../../translatepy/utils/importer.py#L18) -> [Source: ../../../../translatepy/utils/importer.py @ line 18](../../../../translatepy/utils/importer.py#L18) +## *const* [**IMPORTER_DATA_DIR**](../../../../translatepy/utils/importer.py#L20) -## *const* **IMPORTER_DATA_DIR** +## *const* [**IMPORTER_DATA_FILE**](../../../../translatepy/utils/importer.py#L21) -> [Source: ../../../../translatepy/utils/importer.py @ line 20](../../../../translatepy/utils/importer.py#L20) +## *const* [**NAMED_TRANSLATORS**](../../../../translatepy/utils/importer.py#L27) -## *const* **IMPORTER_DATA_FILE** - -> [Source: ../../../../translatepy/utils/importer.py @ line 21](../../../../translatepy/utils/importer.py#L21) - -## *const* **NAMED_TRANSLATORS** - -> [Source: ../../../../translatepy/utils/importer.py @ line 27](../../../../translatepy/utils/importer.py#L27) - -## *func* **translator_from_name** - -> [Source: ../../../../translatepy/utils/importer.py @ line 37-42](../../../../translatepy/utils/importer.py#L37-L42) +## *func* [**translator_from_name**](../../../../translatepy/utils/importer.py#L37-L42) Retrieves the given translate from its name @@ -46,9 +36,7 @@ Retrieves the given translate from its name - `ValueError` -## *func* **translator_from_path** - -> [Source: ../../../../translatepy/utils/importer.py @ line 45-55](../../../../translatepy/utils/importer.py#L45-L55) +## *func* [**translator_from_path**](../../../../translatepy/utils/importer.py#L45-L55) Returns a translator from its dot path @@ -69,9 +57,7 @@ Returns a translator from its dot path - `ImportError` -## *func* **get_translator** - -> [Source: ../../../../translatepy/utils/importer.py @ line 58-94](../../../../translatepy/utils/importer.py#L58-L94) +## *func* [**get_translator**](../../../../translatepy/utils/importer.py#L58-L94) Searches the given translator diff --git a/docs/fra/reference/utils/lru.md b/docs/fra/reference/utils/lru.md index 8e9d53a..b9670f8 100644 --- a/docs/fra/reference/utils/lru.md +++ b/docs/fra/reference/utils/lru.md @@ -1,31 +1,21 @@ # *module* **lru** -> [Source: ../../../../translatepy/utils/lru.py @ line 0](../../../../translatepy/utils/lru.py#L0) +> [Source: ../../../../translatepy/utils/lru.py](../../../../translatepy/utils/lru.py#L0) lru.py LRU cache implementation for the translatepy project. -## *const* **logger** +## *const* [**logger**](../../../../translatepy/utils/lru.py#L16) -> [Source: ../../../../translatepy/utils/lru.py @ line 16](../../../../translatepy/utils/lru.py#L16) +## *class* [**LRUDictCache**](../../../../translatepy/utils/lru.py#L19-L38) -## *class* **LRUDictCache** +### *func* [LRUDictCache.**clear**](../../../../translatepy/utils/lru.py#L37-L38) -> [Source: ../../../../translatepy/utils/lru.py @ line 19-38](../../../../translatepy/utils/lru.py#L19-L38) - -### *func* LRUDictCache.**clear** - -> [Source: ../../../../translatepy/utils/lru.py @ line 37-38](../../../../translatepy/utils/lru.py#L37-L38) - -## *class* **SizeLimitedLRUCache** - -> [Source: ../../../../translatepy/utils/lru.py @ line 41-173](../../../../translatepy/utils/lru.py#L41-L173) +## *class* [**SizeLimitedLRUCache**](../../../../translatepy/utils/lru.py#L41-L173) Special implementation of a size limited LRU cache. -### *func* SizeLimitedLRUCache.**get_size** - -> [Source: ../../../../translatepy/utils/lru.py @ line 135-170](../../../../translatepy/utils/lru.py#L135-L170) +### *func* [SizeLimitedLRUCache.**get_size**](../../../../translatepy/utils/lru.py#L135-L170) Get the size of an object. @@ -50,13 +40,9 @@ This function is faster than the custom implementation but might yield inaccurat > The second implementation of this function is based on the following article: https://towardsdatascience.com/the-strange-size-of-python-objects-in-memory-ce87bdfbb97f -### *func* SizeLimitedLRUCache.**clear** - -> [Source: ../../../../translatepy/utils/lru.py @ line 172-173](../../../../translatepy/utils/lru.py#L172-L173) - -## *func* **timed_lru_cache** +### *func* [SizeLimitedLRUCache.**clear**](../../../../translatepy/utils/lru.py#L172-L173) -> [Source: ../../../../translatepy/utils/lru.py @ line 176-198](../../../../translatepy/utils/lru.py#L176-L198) +## *func* [**timed_lru_cache**](../../../../translatepy/utils/lru.py#L176-L198) ### Parameters diff --git a/docs/fra/reference/utils/queue.md b/docs/fra/reference/utils/queue.md index 848870b..6555cee 100644 --- a/docs/fra/reference/utils/queue.md +++ b/docs/fra/reference/utils/queue.md @@ -1,18 +1,14 @@ # *module* **queue** -> [Source: ../../../../translatepy/utils/queue.py @ line 0](../../../../translatepy/utils/queue.py#L0) +> [Source: ../../../../translatepy/utils/queue.py](../../../../translatepy/utils/queue.py#L0) -## *class* **Queue** - -> [Source: ../../../../translatepy/utils/queue.py @ line 6-32](../../../../translatepy/utils/queue.py#L6-L32) +## *class* [**Queue**](../../../../translatepy/utils/queue.py#L6-L32) ### Raises - `ValueError` -### *func* Queue.**get** - -> [Source: ../../../../translatepy/utils/queue.py @ line 16-32](../../../../translatepy/utils/queue.py#L16-L32) +### *func* [Queue.**get**](../../../../translatepy/utils/queue.py#L16-L32) Remove and return an item from the queue. It waits for a value or the termination of all threads diff --git a/docs/fra/reference/utils/request.md b/docs/fra/reference/utils/request.md index c4faed9..fad2227 100644 --- a/docs/fra/reference/utils/request.md +++ b/docs/fra/reference/utils/request.md @@ -1,6 +1,6 @@ # *module* **request** -> [Source: ../../../../translatepy/utils/request.py @ line 0](../../../../translatepy/utils/request.py#L0) +> [Source: ../../../../translatepy/utils/request.py](../../../../translatepy/utils/request.py#L0) utils/request Extending python requests functionalities with translatepy's own implementation of proxies, caching, exceptions, etc. @@ -13,29 +13,19 @@ Extending python requests functionalities with translatepy's own implementation - **Animenosekai** Original author -## *const* **RequestHash** +## *const* [**RequestHash**](../../../../translatepy/utils/request.py#L24) -> [Source: ../../../../translatepy/utils/request.py @ line 24](../../../../translatepy/utils/request.py#L24) +## *const* [**RateLimitLock**](../../../../translatepy/utils/request.py#L27) -## *const* **RateLimitLock** +## *const* [**CacheLock**](../../../../translatepy/utils/request.py#L28) -> [Source: ../../../../translatepy/utils/request.py @ line 27](../../../../translatepy/utils/request.py#L27) - -## *const* **CacheLock** - -> [Source: ../../../../translatepy/utils/request.py @ line 28](../../../../translatepy/utils/request.py#L28) - -## *class* **Session** - -> [Source: ../../../../translatepy/utils/request.py @ line 32-225](../../../../translatepy/utils/request.py#L32-L225) +## *class* [**Session**](../../../../translatepy/utils/request.py#L32-L225) ### Raises - `exceptions.RateLimitPrevention` -### *func* Session.**set_http_proxy** - -> [Source: ../../../../translatepy/utils/request.py @ line 52-64](../../../../translatepy/utils/request.py#L52-L64) +### *func* [Session.**set_http_proxy**](../../../../translatepy/utils/request.py#L52-L64) Sets the HTTP proxy to use. @@ -45,9 +35,7 @@ Sets the HTTP proxy to use. - The HTTP proxy to use. -### *func* Session.**add_http_proxy** - -> [Source: ../../../../translatepy/utils/request.py @ line 66-75](../../../../translatepy/utils/request.py#L66-L75) +### *func* [Session.**add_http_proxy**](../../../../translatepy/utils/request.py#L66-L75) Adds a HTTP proxy to the list of proxies to use. @@ -57,9 +45,7 @@ Adds a HTTP proxy to the list of proxies to use. - The HTTP proxy to add. -### *func* Session.**request** - -> [Source: ../../../../translatepy/utils/request.py @ line 77-215](../../../../translatepy/utils/request.py#L77-L215) +### *func* [Session.**request**](../../../../translatepy/utils/request.py#L77-L215) Make an HTTP request with the provided method. @@ -203,9 +189,7 @@ If None, the default_cache_duration attribute will be used. ``` -### *func* Session.**invalidate** - -> [Source: ../../../../translatepy/utils/request.py @ line 217-225](../../../../translatepy/utils/request.py#L217-L225) +### *func* [Session.**invalidate**](../../../../translatepy/utils/request.py#L217-L225) Invalidates the given request cache. @@ -214,13 +198,9 @@ Invalidates the given request cache. - **hash**: `RequestHash`, `requesthash` -## *const* **SharedSession** - -> [Source: ../../../../translatepy/utils/request.py @ line 228](../../../../translatepy/utils/request.py#L228) +## *const* [**SharedSession**](../../../../translatepy/utils/request.py#L228) -## *func* **request** - -> [Source: ../../../../translatepy/utils/request.py @ line 231-268](../../../../translatepy/utils/request.py#L231-L268) +## *func* [**request**](../../../../translatepy/utils/request.py#L231-L268) Make an HTTP request. @@ -315,9 +295,7 @@ Make an HTTP request. > **Note** > Look at Session.request for more information. -## *func* **get** - -> [Source: ../../../../translatepy/utils/request.py @ line 271-300](../../../../translatepy/utils/request.py#L271-L300) +## *func* [**get**](../../../../translatepy/utils/request.py#L271-L300) Make a GET request. @@ -405,9 +383,7 @@ Make a GET request. > **Note** > Look at Session.request for more information. -## *func* **post** - -> [Source: ../../../../translatepy/utils/request.py @ line 303-332](../../../../translatepy/utils/request.py#L303-L332) +## *func* [**post**](../../../../translatepy/utils/request.py#L303-L332) Make a POST request. @@ -495,9 +471,7 @@ Make a POST request. > **Note** > Look at Session.request for more information. -## *func* **put** - -> [Source: ../../../../translatepy/utils/request.py @ line 335-364](../../../../translatepy/utils/request.py#L335-L364) +## *func* [**put**](../../../../translatepy/utils/request.py#L335-L364) Make a PUT request. @@ -585,9 +559,7 @@ Make a PUT request. > **Note** > Look at Session.request for more information. -## *func* **patch** - -> [Source: ../../../../translatepy/utils/request.py @ line 367-396](../../../../translatepy/utils/request.py#L367-L396) +## *func* [**patch**](../../../../translatepy/utils/request.py#L367-L396) Make a PATCH request. @@ -675,9 +647,7 @@ Make a PATCH request. > **Note** > Look at Session.request for more information. -## *func* **delete** - -> [Source: ../../../../translatepy/utils/request.py @ line 399-428](../../../../translatepy/utils/request.py#L399-L428) +## *func* [**delete**](../../../../translatepy/utils/request.py#L399-L428) Make a DELETE request. @@ -765,9 +735,7 @@ Make a DELETE request. > **Note** > Look at Session.request for more information. -## *func* **head** - -> [Source: ../../../../translatepy/utils/request.py @ line 431-460](../../../../translatepy/utils/request.py#L431-L460) +## *func* [**head**](../../../../translatepy/utils/request.py#L431-L460) Make a HEAD request. @@ -855,9 +823,7 @@ Make a HEAD request. > **Note** > Look at Session.request for more information. -## *func* **options** - -> [Source: ../../../../translatepy/utils/request.py @ line 463-492](../../../../translatepy/utils/request.py#L463-L492) +## *func* [**options**](../../../../translatepy/utils/request.py#L463-L492) Make an OPTIONS request. diff --git a/docs/fra/reference/utils/sanitize.md b/docs/fra/reference/utils/sanitize.md index fc0bf1d..8951b42 100644 --- a/docs/fra/reference/utils/sanitize.md +++ b/docs/fra/reference/utils/sanitize.md @@ -1,14 +1,10 @@ # *module* **sanitize** -> [Source: ../../../../translatepy/utils/sanitize.py @ line 0](../../../../translatepy/utils/sanitize.py#L0) +> [Source: ../../../../translatepy/utils/sanitize.py](../../../../translatepy/utils/sanitize.py#L0) -## *const* **WHITESPACES** +## *const* [**WHITESPACES**](../../../../translatepy/utils/sanitize.py#L3) -> [Source: ../../../../translatepy/utils/sanitize.py @ line 3](../../../../translatepy/utils/sanitize.py#L3) - -## *func* **remove_spaces** - -> [Source: ../../../../translatepy/utils/sanitize.py @ line 8-15](../../../../translatepy/utils/sanitize.py#L8-L15) +## *func* [**remove_spaces**](../../../../translatepy/utils/sanitize.py#L8-L15) Removes all whitespaces from the given string diff --git a/docs/fra/reference/utils/utils.md b/docs/fra/reference/utils/utils.md index 8595dcb..3c3c0b5 100644 --- a/docs/fra/reference/utils/utils.md +++ b/docs/fra/reference/utils/utils.md @@ -1,14 +1,10 @@ # *module* **utils** -> [Source: ../../../../translatepy/utils/utils.py @ line 0](../../../../translatepy/utils/utils.py#L0) +> [Source: ../../../../translatepy/utils/utils.py](../../../../translatepy/utils/utils.py#L0) -## *const* **POSITIVE_FLOAT_REGEX** +## *const* [**POSITIVE_FLOAT_REGEX**](../../../../translatepy/utils/utils.py#L3) -> [Source: ../../../../translatepy/utils/utils.py @ line 3](../../../../translatepy/utils/utils.py#L3) - -## *func* **convert_to_float** - -> [Source: ../../../../translatepy/utils/utils.py @ line 6-13](../../../../translatepy/utils/utils.py#L6-L13) +## *func* [**convert_to_float**](../../../../translatepy/utils/utils.py#L6-L13) Safely converts anything to a positive float diff --git a/docs/fra/reference/utils/vectorize.md b/docs/fra/reference/utils/vectorize.md index 6686e79..a3037ca 100644 --- a/docs/fra/reference/utils/vectorize.md +++ b/docs/fra/reference/utils/vectorize.md @@ -1,6 +1,6 @@ # *module* **vectorize** -> [Source: ../../../../translatepy/utils/vectorize.py @ line 0](../../../../translatepy/utils/vectorize.py#L0) +> [Source: ../../../../translatepy/utils/vectorize.py](../../../../translatepy/utils/vectorize.py#L0) Handles vectors @@ -8,13 +8,9 @@ Handles vectors - [../../../../translatepy/utils/sanitize.py](../../../../translatepy/utils/sanitize.py): As `sanitize` -## *const* **CLEANUP_REGEX** +## *const* [**CLEANUP_REGEX**](../../../../translatepy/utils/vectorize.py#L12) -> [Source: ../../../../translatepy/utils/vectorize.py @ line 12](../../../../translatepy/utils/vectorize.py#L12) - -## *func* **string_preprocessing** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 15-17](../../../../translatepy/utils/vectorize.py#L15-L17) +## *func* [**string_preprocessing**](../../../../translatepy/utils/vectorize.py#L15-L17) internal function to preprocess the given string for fuzzy search @@ -27,49 +23,33 @@ internal function to preprocess the given string for fuzzy search - `str` -## *class* **Vector** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 20-34](../../../../translatepy/utils/vectorize.py#L20-L34) +## *class* [**Vector**](../../../../translatepy/utils/vectorize.py#L20-L34) A string vector -### *attr* Vector.**id** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 22](../../../../translatepy/utils/vectorize.py#L22) +### *attr* [Vector.**id**](../../../../translatepy/utils/vectorize.py#L22) > Type: `str` -### *attr* Vector.**string** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 23](../../../../translatepy/utils/vectorize.py#L23) +### *attr* [Vector.**string**](../../../../translatepy/utils/vectorize.py#L23) > Type: `str` -### *attr* Vector.**value** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 24](../../../../translatepy/utils/vectorize.py#L24) +### *attr* [Vector.**value**](../../../../translatepy/utils/vectorize.py#L24) > Type: `float` -### *property* Vector.**counter** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 27-29](../../../../translatepy/utils/vectorize.py#L27-L29) +### *property* [Vector.**counter**](../../../../translatepy/utils/vectorize.py#L27-L29) Returns a counter for the vector -### *property* Vector.**set** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 32-34](../../../../translatepy/utils/vectorize.py#L32-L34) +### *property* [Vector.**set**](../../../../translatepy/utils/vectorize.py#L32-L34) Returns a set for the vector -## *const* **A** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 36](../../../../translatepy/utils/vectorize.py#L36) +## *const* [**A**](../../../../translatepy/utils/vectorize.py#L36) -## *func* **vectorize** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 38-45](../../../../translatepy/utils/vectorize.py#L38-L45) +## *func* [**vectorize**](../../../../translatepy/utils/vectorize.py#L38-L45) Vectorizes the given string @@ -81,31 +61,23 @@ Vectorizes the given string - **string**: `str` -## *class* **SearchResult** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 49-54](../../../../translatepy/utils/vectorize.py#L49-L54) +## *class* [**SearchResult**](../../../../translatepy/utils/vectorize.py#L49-L54) A result from the `search` function -### *attr* SearchResult.**vector** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 51](../../../../translatepy/utils/vectorize.py#L51) +### *attr* [SearchResult.**vector**](../../../../translatepy/utils/vectorize.py#L51) > Type: `Vector` The actual vector -### *attr* SearchResult.**similarity** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 53](../../../../translatepy/utils/vectorize.py#L53) +### *attr* [SearchResult.**similarity**](../../../../translatepy/utils/vectorize.py#L53) > Type: `float` The similarity with the search query -## *func* **search** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 57-70](../../../../translatepy/utils/vectorize.py#L57-L70) +## *func* [**search**](../../../../translatepy/utils/vectorize.py#L57-L70) Searches `query` through `data` diff --git a/docs/fra/server/Postman/Language.postman_collection.utils.json b/docs/fra/server/Postman/Language.postman_collection.utils.json index 29eda2e..9702a9a 100644 --- a/docs/fra/server/Postman/Language.postman_collection.utils.json +++ b/docs/fra/server/Postman/Language.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Language","description":"Tous les endpoints sous la section 'Language' de l'interface API de translatepy","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file +{"info":{"name":"Language","description":"Tous les endpoints sous la section 'Language' de l'interface API de translatepy","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file diff --git a/docs/fra/server/Postman/Work.postman_collection.utils.json b/docs/fra/server/Postman/Work.postman_collection.utils.json index 25503a5..d05e262 100644 --- a/docs/fra/server/Postman/Work.postman_collection.utils.json +++ b/docs/fra/server/Postman/Work.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Work","description":"Tous les endpoints sous la section 'Work' de l'interface API de translatepy","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `translation` | The translation result | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `translation` | The translation result | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n"}]},{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `transliteration` | The transliteration result | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `transliteration` | The transliteration result | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n"}]},{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `corrected` | The corrected text | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `corrected` | The corrected text | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n"}]},{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | Non |\n| `example` | The example | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `positions` | The positions of the word in the example | list[int] | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | Non |\n| `example` | The example | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `positions` | The positions of the word in the example | list[int] | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `meaning` | The meaning of the text | string | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `meaning` | The meaning of the text | string | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `extension` | Returns the audio file extension | Optional[str] | Non |\n| `result` | Text to speech result | bytes | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `gender` | Gender of the 'person' saying the text | Gender | Non |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | Non |\n| `speed` | Speed of the text to speech result | int | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `extension` | Returns the audio file extension | Optional[str] | Non |\n| `result` | Text to speech result | bytes | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `gender` | Gender of the 'person' saying the text | Gender | Non |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | Non |\n| `speed` | Speed of the text to speech result | int | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file +{"info":{"name":"Work","description":"Tous les endpoints sous la section 'Work' de l'interface API de translatepy","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `translation` | The translation result | string | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `translation` | The translation result | string | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]},{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n"}]},{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `transliteration` | The transliteration result | string | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `transliteration` | The transliteration result | string | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]},{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `corrected` | The corrected text | string | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `corrected` | The corrected text | string | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n"}]},{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n"}]},{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `example` | The example | string | Non |\n| `positions` | The positions of the word in the example | list[int] | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `example` | The example | string | Non |\n| `positions` | The positions of the word in the example | list[int] | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n"}]},{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n| `meaning` | The meaning of the text | string | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n| `meaning` | The meaning of the text | string | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n"}]},{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `extension` | Returns the audio file extension | Optional[str] | Non |\n| `result` | Text to speech result | bytes | Non |\n| `source` | The source text | string | Non |\n| `speed` | Speed of the text to speech result | int | Non |\n| `gender` | Gender of the 'person' saying the text | Gender | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | Non |\n| `source_lang` | The source text's language | Language | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `extension` | Returns the audio file extension | Optional[str] | Non |\n| `result` | Text to speech result | bytes | Non |\n| `source` | The source text | string | Non |\n| `speed` | Speed of the text to speech result | int | Non |\n| `gender` | Gender of the 'person' saying the text | Gender | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | Non |\n| `source_lang` | The source text's language | Language | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file diff --git a/docs/fra/server/Sections/Language.md b/docs/fra/server/Sections/Language.md index 85c470f..bca1e20 100644 --- a/docs/fra/server/Sections/Language.md +++ b/docs/fra/server/Sections/Language.md @@ -84,8 +84,8 @@ print(r.json()["data"]) | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | | `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | [Retourner à l'Index](../Pour%20commencer.md#index) # search @@ -185,6 +185,6 @@ print(r.json()["data"]) | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | | `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | [Retourner à l'Index](../Pour%20commencer.md#index) \ No newline at end of file diff --git a/docs/fra/server/Sections/Work.md b/docs/fra/server/Sections/Work.md index f1f5589..b6ecaca 100644 --- a/docs/fra/server/Sections/Work.md +++ b/docs/fra/server/Sections/Work.md @@ -92,11 +92,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", "service": "no example", + "translation": "no example", "dest_lang": "no example", "source": "no example", - "translation": "no example" + "source_lang": "no example" } } @@ -106,20 +106,20 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | Non | | `service` | The service which returned the result | Translator | Non | +| `translation` | The translation result | string | Non | | `dest_lang` | The result's language | Language | Non | | `source` | The source text | string | Non | -| `translation` | The translation result | string | Non | +| `source_lang` | The source text's language | Language | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # translate_html @@ -211,9 +211,9 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "source": "no example", - "service": "no example" + "source": "no example" } } @@ -223,18 +223,18 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | Non | | `source_lang` | The source text's language | Language | Non | | `source` | The source text | string | Non | -| `service` | The service which returned the result | Translator | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # stream @@ -312,10 +312,10 @@ print(r.json()["data"]) | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # transliterate @@ -407,11 +407,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", + "service": "no example", + "transliteration": "no example", "dest_lang": "no example", "source": "no example", - "service": "no example", - "transliteration": "no example" + "source_lang": "no example" } } @@ -421,20 +421,20 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | Non | -| `dest_lang` | The result's language | Language | Non | -| `source` | The source text | string | Non | | `service` | The service which returned the result | Translator | Non | | `transliteration` | The transliteration result | string | Non | +| `dest_lang` | The result's language | Language | Non | +| `source` | The source text | string | Non | +| `source_lang` | The source text's language | Language | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # spellcheck @@ -526,11 +526,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", - "rich": true, - "source": "no example", "service": "no example", - "corrected": "no example" + "source": "no example", + "source_lang": "no example", + "corrected": "no example", + "rich": true } } @@ -540,20 +540,20 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | Non | -| `rich` | Whether the given result features the full range of information | bool | Non | -| `source` | The source text | string | Non | | `service` | The service which returned the result | Translator | Non | +| `source` | The source text | string | Non | +| `source_lang` | The source text's language | Language | Non | | `corrected` | The corrected text | string | Non | +| `rich` | Whether the given result features the full range of information | bool | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # language @@ -645,9 +645,9 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "source": "no example", - "service": "no example" + "source": "no example" } } @@ -657,18 +657,18 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | Non | | `source_lang` | The source text's language | Language | Non | | `source` | The source text | string | Non | -| `service` | The service which returned the result | Translator | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # example @@ -760,12 +760,12 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "reference": "no example", - "example": "no example", - "source_lang": "no example", - "positions": "no example", "source": "no example", - "service": "no example" + "source_lang": "no example", + "example": "no example", + "positions": "no example" } } @@ -775,21 +775,21 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | Non | | `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | Non | -| `example` | The example | string | Non | +| `source` | The source text | string | Non | | `source_lang` | The source text's language | Language | Non | +| `example` | The example | string | Non | | `positions` | The positions of the word in the example | list[int] | Non | -| `source` | The source text | string | Non | -| `service` | The service which returned the result | Translator | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # dictionary @@ -881,11 +881,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "meaning": "no example", - "rich": true, "source": "no example", - "service": "no example" + "meaning": "no example", + "rich": true } } @@ -895,20 +895,20 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | Non | | `source_lang` | The source text's language | Language | Non | +| `source` | The source text | string | Non | | `meaning` | The meaning of the text | string | Non | | `rich` | Whether the given result features the full range of information | bool | Non | -| `source` | The source text | string | Non | -| `service` | The service which returned the result | Translator | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # tts @@ -1000,14 +1000,14 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", "extension": "no example", "result": "no example", "source": "no example", - "service": "no example", + "speed": 4, "gender": "no example", + "service": "no example", "mime_type": "no example", - "speed": 4 + "source_lang": "no example" } } @@ -1017,21 +1017,21 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | Non | | `extension` | Returns the audio file extension | Optional[str] | Non | | `result` | Text to speech result | bytes | Non | | `source` | The source text | string | Non | -| `service` | The service which returned the result | Translator | Non | +| `speed` | Speed of the text to speech result | int | Non | | `gender` | Gender of the 'person' saying the text | Gender | Non | +| `service` | The service which returned the result | Translator | Non | | `mime_type` | Returns the MIME type of the audio file | Optional[str] | Non | -| `speed` | Speed of the text to speech result | int | Non | +| `source_lang` | The source text's language | Language | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) \ No newline at end of file diff --git a/docs/jpn/reference/__info__.md b/docs/jpn/reference/__info__.md index c756dbc..265d0ca 100644 --- a/docs/jpn/reference/__info__.md +++ b/docs/jpn/reference/__info__.md @@ -1,5 +1,5 @@ # *module* **__info__** -> [Source: ../../../translatepy/__info__.py @ line 0](../../../translatepy/__info__.py#L0) +> [Source: ../../../translatepy/__info__.py](../../../translatepy/__info__.py#L0) Stores information on the current module version diff --git a/docs/jpn/reference/exceptions.md b/docs/jpn/reference/exceptions.md index ad84d31..059cd10 100644 --- a/docs/jpn/reference/exceptions.md +++ b/docs/jpn/reference/exceptions.md @@ -1,141 +1,73 @@ # *module* **exceptions** -> [Source: ../../../translatepy/exceptions.py @ line 0](../../../translatepy/exceptions.py#L0) +> [Source: ../../../translatepy/exceptions.py](../../../translatepy/exceptions.py#L0) A list of exceptions used throughout translatepy -## *class* **TranslatepyException** +## *class* [**TranslatepyException**](../../../translatepy/exceptions.py#L5-L9) -> [Source: ../../../translatepy/exceptions.py @ line 5-9](../../../translatepy/exceptions.py#L5-L9) +### *attr* [TranslatepyException.**LOG**](../../../translatepy/exceptions.py#L6) -### *attr* TranslatepyException.**LOG** +## *class* [**NoResult**](../../../translatepy/exceptions.py#L12-L18) -> [Source: ../../../translatepy/exceptions.py @ line 6](../../../translatepy/exceptions.py#L6) +### *attr* [NoResult.**STATUS_CODE**](../../../translatepy/exceptions.py#L13) -## *class* **NoResult** +### *attr* [NoResult.**MESSAGE**](../../../translatepy/exceptions.py#L14) -> [Source: ../../../translatepy/exceptions.py @ line 12-18](../../../translatepy/exceptions.py#L12-L18) +### *attr* [NoResult.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L15) -### *attr* NoResult.**STATUS_CODE** +## *class* [**ParameterTypeError**](../../../translatepy/exceptions.py#L21-L27) -> [Source: ../../../translatepy/exceptions.py @ line 13](../../../translatepy/exceptions.py#L13) +### *attr* [ParameterTypeError.**STATUS_CODE**](../../../translatepy/exceptions.py#L22) -### *attr* NoResult.**MESSAGE** +### *attr* [ParameterTypeError.**MESSAGE**](../../../translatepy/exceptions.py#L23) -> [Source: ../../../translatepy/exceptions.py @ line 14](../../../translatepy/exceptions.py#L14) +### *attr* [ParameterTypeError.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L24) -### *attr* NoResult.**EXCEPTION_NAME** +## *class* [**UnknownLanguage**](../../../translatepy/exceptions.py#L30-L38) -> [Source: ../../../translatepy/exceptions.py @ line 15](../../../translatepy/exceptions.py#L15) +### *attr* [UnknownLanguage.**STATUS_CODE**](../../../translatepy/exceptions.py#L31) -## *class* **ParameterTypeError** +### *attr* [UnknownLanguage.**MESSAGE**](../../../translatepy/exceptions.py#L32) -> [Source: ../../../translatepy/exceptions.py @ line 21-27](../../../translatepy/exceptions.py#L21-L27) +### *attr* [UnknownLanguage.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L33) -### *attr* ParameterTypeError.**STATUS_CODE** +## *class* [**UnknownTranslator**](../../../translatepy/exceptions.py#L41-L49) -> [Source: ../../../translatepy/exceptions.py @ line 22](../../../translatepy/exceptions.py#L22) +### *attr* [UnknownTranslator.**STATUS_CODE**](../../../translatepy/exceptions.py#L42) -### *attr* ParameterTypeError.**MESSAGE** +### *attr* [UnknownTranslator.**MESSAGE**](../../../translatepy/exceptions.py#L43) -> [Source: ../../../translatepy/exceptions.py @ line 23](../../../translatepy/exceptions.py#L23) +### *attr* [UnknownTranslator.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L44) -### *attr* ParameterTypeError.**EXCEPTION_NAME** +## *class* [**UnsupportedMethod**](../../../translatepy/exceptions.py#L52-L58) -> [Source: ../../../translatepy/exceptions.py @ line 24](../../../translatepy/exceptions.py#L24) +### *attr* [UnsupportedMethod.**STATUS_CODE**](../../../translatepy/exceptions.py#L53) -## *class* **UnknownLanguage** +### *attr* [UnsupportedMethod.**MESSAGE**](../../../translatepy/exceptions.py#L54) -> [Source: ../../../translatepy/exceptions.py @ line 30-38](../../../translatepy/exceptions.py#L30-L38) +### *attr* [UnsupportedMethod.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L55) -### *attr* UnknownLanguage.**STATUS_CODE** +## *class* [**UnsupportedLanguage**](../../../translatepy/exceptions.py#L61-L67) -> [Source: ../../../translatepy/exceptions.py @ line 31](../../../translatepy/exceptions.py#L31) +### *attr* [UnsupportedLanguage.**STATUS_CODE**](../../../translatepy/exceptions.py#L62) -### *attr* UnknownLanguage.**MESSAGE** +### *attr* [UnsupportedLanguage.**MESSAGE**](../../../translatepy/exceptions.py#L63) -> [Source: ../../../translatepy/exceptions.py @ line 32](../../../translatepy/exceptions.py#L32) +### *attr* [UnsupportedLanguage.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L64) -### *attr* UnknownLanguage.**EXCEPTION_NAME** +## *class* [**ServiceURLError**](../../../translatepy/exceptions.py#L70-L76) -> [Source: ../../../translatepy/exceptions.py @ line 33](../../../translatepy/exceptions.py#L33) +### *attr* [ServiceURLError.**STATUS_CODE**](../../../translatepy/exceptions.py#L71) -## *class* **UnknownTranslator** +### *attr* [ServiceURLError.**MESSAGE**](../../../translatepy/exceptions.py#L72) -> [Source: ../../../translatepy/exceptions.py @ line 41-49](../../../translatepy/exceptions.py#L41-L49) +### *attr* [ServiceURLError.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L73) -### *attr* UnknownTranslator.**STATUS_CODE** +## *class* [**RateLimitPrevention**](../../../translatepy/exceptions.py#L79-L82) -> [Source: ../../../translatepy/exceptions.py @ line 42](../../../translatepy/exceptions.py#L42) +### *attr* [RateLimitPrevention.**STATUS_CODE**](../../../translatepy/exceptions.py#L80) -### *attr* UnknownTranslator.**MESSAGE** +### *attr* [RateLimitPrevention.**MESSAGE**](../../../translatepy/exceptions.py#L81) -> [Source: ../../../translatepy/exceptions.py @ line 43](../../../translatepy/exceptions.py#L43) - -### *attr* UnknownTranslator.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 44](../../../translatepy/exceptions.py#L44) - -## *class* **UnsupportedMethod** - -> [Source: ../../../translatepy/exceptions.py @ line 52-58](../../../translatepy/exceptions.py#L52-L58) - -### *attr* UnsupportedMethod.**STATUS_CODE** - -> [Source: ../../../translatepy/exceptions.py @ line 53](../../../translatepy/exceptions.py#L53) - -### *attr* UnsupportedMethod.**MESSAGE** - -> [Source: ../../../translatepy/exceptions.py @ line 54](../../../translatepy/exceptions.py#L54) - -### *attr* UnsupportedMethod.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 55](../../../translatepy/exceptions.py#L55) - -## *class* **UnsupportedLanguage** - -> [Source: ../../../translatepy/exceptions.py @ line 61-67](../../../translatepy/exceptions.py#L61-L67) - -### *attr* UnsupportedLanguage.**STATUS_CODE** - -> [Source: ../../../translatepy/exceptions.py @ line 62](../../../translatepy/exceptions.py#L62) - -### *attr* UnsupportedLanguage.**MESSAGE** - -> [Source: ../../../translatepy/exceptions.py @ line 63](../../../translatepy/exceptions.py#L63) - -### *attr* UnsupportedLanguage.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 64](../../../translatepy/exceptions.py#L64) - -## *class* **ServiceURLError** - -> [Source: ../../../translatepy/exceptions.py @ line 70-76](../../../translatepy/exceptions.py#L70-L76) - -### *attr* ServiceURLError.**STATUS_CODE** - -> [Source: ../../../translatepy/exceptions.py @ line 71](../../../translatepy/exceptions.py#L71) - -### *attr* ServiceURLError.**MESSAGE** - -> [Source: ../../../translatepy/exceptions.py @ line 72](../../../translatepy/exceptions.py#L72) - -### *attr* ServiceURLError.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 73](../../../translatepy/exceptions.py#L73) - -## *class* **RateLimitPrevention** - -> [Source: ../../../translatepy/exceptions.py @ line 79-82](../../../translatepy/exceptions.py#L79-L82) - -### *attr* RateLimitPrevention.**STATUS_CODE** - -> [Source: ../../../translatepy/exceptions.py @ line 80](../../../translatepy/exceptions.py#L80) - -### *attr* RateLimitPrevention.**MESSAGE** - -> [Source: ../../../translatepy/exceptions.py @ line 81](../../../translatepy/exceptions.py#L81) - -### *attr* RateLimitPrevention.**EXCEPTION_NAME** - -> [Source: ../../../translatepy/exceptions.py @ line 82](../../../translatepy/exceptions.py#L82) +### *attr* [RateLimitPrevention.**EXCEPTION_NAME**](../../../translatepy/exceptions.py#L82) diff --git a/docs/jpn/reference/language.md b/docs/jpn/reference/language.md index ac1bcf2..1d5f29b 100644 --- a/docs/jpn/reference/language.md +++ b/docs/jpn/reference/language.md @@ -1,6 +1,6 @@ # *module* **language** -> [Source: ../../../translatepy/language.py @ line 0](../../../translatepy/language.py#L0) +> [Source: ../../../translatepy/language.py](../../../translatepy/language.py#L0) Handles the languages management on `translatepy` @@ -12,21 +12,15 @@ Handles the languages management on `translatepy` - [../../../translatepy/utils/vectorize.py](../../../translatepy/utils/vectorize.py): As `vectorize` -## *const* **Number** - -> [Source: ../../../translatepy/language.py @ line 17](../../../translatepy/language.py#L17) +## *const* [**Number**](../../../translatepy/language.py#L17) Represents a number -## *class* **LanguageExtra** - -> [Source: ../../../translatepy/language.py @ line 21-34](../../../translatepy/language.py#L21-L34) +## *class* [**LanguageExtra**](../../../translatepy/language.py#L21-L34) Extra data given on supported languages -### *attr* LanguageExtra.**scope** - -> [Source: ../../../translatepy/language.py @ line 23](../../../translatepy/language.py#L23) +### *attr* [LanguageExtra.**scope**](../../../translatepy/language.py#L23) > Type: `cain.types.Enum` @@ -35,9 +29,7 @@ Language scope > **Note** > Can be one of "individual", "macrolanguage", "special" -### *attr* LanguageExtra.**type** - -> [Source: ../../../translatepy/language.py @ line 28](../../../translatepy/language.py#L28) +### *attr* [LanguageExtra.**type**](../../../translatepy/language.py#L28) > Type: `cain.types.Enum` @@ -46,773 +38,577 @@ Language type > **Note** > Can be one of "ancient", "constructed", "extinct", "historical", "living", "special" -## *class* **Foreign** - -> [Source: ../../../translatepy/language.py @ line 37-208](../../../translatepy/language.py#L37-L208) +## *class* [**Foreign**](../../../translatepy/language.py#L37-L208) The language name in foreign languages -### *attr* Foreign.**afrikaans** - -> [Source: ../../../translatepy/language.py @ line 39](../../../translatepy/language.py#L39) +### *attr* [Foreign.**afrikaans**](../../../translatepy/language.py#L39) > Type: `str` The language name in afrikaans -### *attr* Foreign.**albanian** - -> [Source: ../../../translatepy/language.py @ line 41](../../../translatepy/language.py#L41) +### *attr* [Foreign.**albanian**](../../../translatepy/language.py#L41) > Type: `str` The language name in albanian -### *attr* Foreign.**amharic** - -> [Source: ../../../translatepy/language.py @ line 43](../../../translatepy/language.py#L43) +### *attr* [Foreign.**amharic**](../../../translatepy/language.py#L43) > Type: `str` The language name in amharic -### *attr* Foreign.**arabic** - -> [Source: ../../../translatepy/language.py @ line 45](../../../translatepy/language.py#L45) +### *attr* [Foreign.**arabic**](../../../translatepy/language.py#L45) > Type: `str` The language name in arabic -### *attr* Foreign.**armenian** - -> [Source: ../../../translatepy/language.py @ line 47](../../../translatepy/language.py#L47) +### *attr* [Foreign.**armenian**](../../../translatepy/language.py#L47) > Type: `str` The language name in armenian -### *attr* Foreign.**azerbaijani** - -> [Source: ../../../translatepy/language.py @ line 49](../../../translatepy/language.py#L49) +### *attr* [Foreign.**azerbaijani**](../../../translatepy/language.py#L49) > Type: `str` The language name in azerbaijani -### *attr* Foreign.**basque** - -> [Source: ../../../translatepy/language.py @ line 51](../../../translatepy/language.py#L51) +### *attr* [Foreign.**basque**](../../../translatepy/language.py#L51) > Type: `str` The language name in basque -### *attr* Foreign.**belarusian** - -> [Source: ../../../translatepy/language.py @ line 53](../../../translatepy/language.py#L53) +### *attr* [Foreign.**belarusian**](../../../translatepy/language.py#L53) > Type: `str` The language name in belarusian -### *attr* Foreign.**bengali** - -> [Source: ../../../translatepy/language.py @ line 55](../../../translatepy/language.py#L55) +### *attr* [Foreign.**bengali**](../../../translatepy/language.py#L55) > Type: `str` The language name in bengali -### *attr* Foreign.**bosnian** - -> [Source: ../../../translatepy/language.py @ line 57](../../../translatepy/language.py#L57) +### *attr* [Foreign.**bosnian**](../../../translatepy/language.py#L57) > Type: `str` The language name in bosnian -### *attr* Foreign.**bulgarian** - -> [Source: ../../../translatepy/language.py @ line 59](../../../translatepy/language.py#L59) +### *attr* [Foreign.**bulgarian**](../../../translatepy/language.py#L59) > Type: `str` The language name in bulgarian -### *attr* Foreign.**burmese** - -> [Source: ../../../translatepy/language.py @ line 61](../../../translatepy/language.py#L61) +### *attr* [Foreign.**burmese**](../../../translatepy/language.py#L61) > Type: `str` The language name in burmese -### *attr* Foreign.**catalan** - -> [Source: ../../../translatepy/language.py @ line 63](../../../translatepy/language.py#L63) +### *attr* [Foreign.**catalan**](../../../translatepy/language.py#L63) > Type: `str` The language name in catalan -### *attr* Foreign.**chinese** - -> [Source: ../../../translatepy/language.py @ line 65](../../../translatepy/language.py#L65) +### *attr* [Foreign.**chinese**](../../../translatepy/language.py#L65) > Type: `str` The language name in chinese -### *attr* Foreign.**croatian** - -> [Source: ../../../translatepy/language.py @ line 67](../../../translatepy/language.py#L67) +### *attr* [Foreign.**croatian**](../../../translatepy/language.py#L67) > Type: `str` The language name in croatian -### *attr* Foreign.**czech** - -> [Source: ../../../translatepy/language.py @ line 69](../../../translatepy/language.py#L69) +### *attr* [Foreign.**czech**](../../../translatepy/language.py#L69) > Type: `str` The language name in czech -### *attr* Foreign.**danish** - -> [Source: ../../../translatepy/language.py @ line 71](../../../translatepy/language.py#L71) +### *attr* [Foreign.**danish**](../../../translatepy/language.py#L71) > Type: `str` The language name in danish -### *attr* Foreign.**dutch** - -> [Source: ../../../translatepy/language.py @ line 73](../../../translatepy/language.py#L73) +### *attr* [Foreign.**dutch**](../../../translatepy/language.py#L73) > Type: `str` The language name in dutch -### *attr* Foreign.**esperanto** - -> [Source: ../../../translatepy/language.py @ line 75](../../../translatepy/language.py#L75) +### *attr* [Foreign.**esperanto**](../../../translatepy/language.py#L75) > Type: `str` The language name in esperanto -### *attr* Foreign.**estonian** - -> [Source: ../../../translatepy/language.py @ line 77](../../../translatepy/language.py#L77) +### *attr* [Foreign.**estonian**](../../../translatepy/language.py#L77) > Type: `str` The language name in estonian -### *attr* Foreign.**finnish** - -> [Source: ../../../translatepy/language.py @ line 79](../../../translatepy/language.py#L79) +### *attr* [Foreign.**finnish**](../../../translatepy/language.py#L79) > Type: `str` The language name in finnish -### *attr* Foreign.**french** - -> [Source: ../../../translatepy/language.py @ line 81](../../../translatepy/language.py#L81) +### *attr* [Foreign.**french**](../../../translatepy/language.py#L81) > Type: `str` The language name in french -### *attr* Foreign.**galician** - -> [Source: ../../../translatepy/language.py @ line 83](../../../translatepy/language.py#L83) +### *attr* [Foreign.**galician**](../../../translatepy/language.py#L83) > Type: `str` The language name in galician -### *attr* Foreign.**georgian** - -> [Source: ../../../translatepy/language.py @ line 85](../../../translatepy/language.py#L85) +### *attr* [Foreign.**georgian**](../../../translatepy/language.py#L85) > Type: `str` The language name in georgian -### *attr* Foreign.**german** - -> [Source: ../../../translatepy/language.py @ line 87](../../../translatepy/language.py#L87) +### *attr* [Foreign.**german**](../../../translatepy/language.py#L87) > Type: `str` The language name in german -### *attr* Foreign.**gujarati** - -> [Source: ../../../translatepy/language.py @ line 89](../../../translatepy/language.py#L89) +### *attr* [Foreign.**gujarati**](../../../translatepy/language.py#L89) > Type: `str` The language name in gujarati -### *attr* Foreign.**haitian** - -> [Source: ../../../translatepy/language.py @ line 91](../../../translatepy/language.py#L91) +### *attr* [Foreign.**haitian**](../../../translatepy/language.py#L91) > Type: `str` The language name in haitian -### *attr* Foreign.**hebrew** - -> [Source: ../../../translatepy/language.py @ line 93](../../../translatepy/language.py#L93) +### *attr* [Foreign.**hebrew**](../../../translatepy/language.py#L93) > Type: `str` The language name in hebrew -### *attr* Foreign.**hindi** - -> [Source: ../../../translatepy/language.py @ line 95](../../../translatepy/language.py#L95) +### *attr* [Foreign.**hindi**](../../../translatepy/language.py#L95) > Type: `str` The language name in hindi -### *attr* Foreign.**hungarian** - -> [Source: ../../../translatepy/language.py @ line 97](../../../translatepy/language.py#L97) +### *attr* [Foreign.**hungarian**](../../../translatepy/language.py#L97) > Type: `str` The language name in hungarian -### *attr* Foreign.**icelandic** - -> [Source: ../../../translatepy/language.py @ line 99](../../../translatepy/language.py#L99) +### *attr* [Foreign.**icelandic**](../../../translatepy/language.py#L99) > Type: `str` The language name in icelandic -### *attr* Foreign.**indonesian** - -> [Source: ../../../translatepy/language.py @ line 101](../../../translatepy/language.py#L101) +### *attr* [Foreign.**indonesian**](../../../translatepy/language.py#L101) > Type: `str` The language name in indonesian -### *attr* Foreign.**irish** - -> [Source: ../../../translatepy/language.py @ line 103](../../../translatepy/language.py#L103) +### *attr* [Foreign.**irish**](../../../translatepy/language.py#L103) > Type: `str` The language name in irish -### *attr* Foreign.**italian** - -> [Source: ../../../translatepy/language.py @ line 105](../../../translatepy/language.py#L105) +### *attr* [Foreign.**italian**](../../../translatepy/language.py#L105) > Type: `str` The language name in italian -### *attr* Foreign.**japanese** - -> [Source: ../../../translatepy/language.py @ line 107](../../../translatepy/language.py#L107) +### *attr* [Foreign.**japanese**](../../../translatepy/language.py#L107) > Type: `str` The language name in japanese -### *attr* Foreign.**javanese** - -> [Source: ../../../translatepy/language.py @ line 109](../../../translatepy/language.py#L109) +### *attr* [Foreign.**javanese**](../../../translatepy/language.py#L109) > Type: `str` The language name in javanese -### *attr* Foreign.**kannada** - -> [Source: ../../../translatepy/language.py @ line 111](../../../translatepy/language.py#L111) +### *attr* [Foreign.**kannada**](../../../translatepy/language.py#L111) > Type: `str` The language name in kannada -### *attr* Foreign.**kazakh** - -> [Source: ../../../translatepy/language.py @ line 113](../../../translatepy/language.py#L113) +### *attr* [Foreign.**kazakh**](../../../translatepy/language.py#L113) > Type: `str` The language name in kazakh -### *attr* Foreign.**khmer** - -> [Source: ../../../translatepy/language.py @ line 115](../../../translatepy/language.py#L115) +### *attr* [Foreign.**khmer**](../../../translatepy/language.py#L115) > Type: `str` The language name in khmer -### *attr* Foreign.**kirghiz** - -> [Source: ../../../translatepy/language.py @ line 117](../../../translatepy/language.py#L117) +### *attr* [Foreign.**kirghiz**](../../../translatepy/language.py#L117) > Type: `str` The language name in kirghiz -### *attr* Foreign.**korean** - -> [Source: ../../../translatepy/language.py @ line 119](../../../translatepy/language.py#L119) +### *attr* [Foreign.**korean**](../../../translatepy/language.py#L119) > Type: `str` The language name in korean -### *attr* Foreign.**lao** - -> [Source: ../../../translatepy/language.py @ line 121](../../../translatepy/language.py#L121) +### *attr* [Foreign.**lao**](../../../translatepy/language.py#L121) > Type: `str` The language name in lao -### *attr* Foreign.**latin** - -> [Source: ../../../translatepy/language.py @ line 123](../../../translatepy/language.py#L123) +### *attr* [Foreign.**latin**](../../../translatepy/language.py#L123) > Type: `str` The language name in latin -### *attr* Foreign.**latvian** - -> [Source: ../../../translatepy/language.py @ line 125](../../../translatepy/language.py#L125) +### *attr* [Foreign.**latvian**](../../../translatepy/language.py#L125) > Type: `str` The language name in latvian -### *attr* Foreign.**lithuanian** - -> [Source: ../../../translatepy/language.py @ line 127](../../../translatepy/language.py#L127) +### *attr* [Foreign.**lithuanian**](../../../translatepy/language.py#L127) > Type: `str` The language name in lithuanian -### *attr* Foreign.**luxembourgish** - -> [Source: ../../../translatepy/language.py @ line 129](../../../translatepy/language.py#L129) +### *attr* [Foreign.**luxembourgish**](../../../translatepy/language.py#L129) > Type: `str` The language name in luxembourgish -### *attr* Foreign.**macedonian** - -> [Source: ../../../translatepy/language.py @ line 131](../../../translatepy/language.py#L131) +### *attr* [Foreign.**macedonian**](../../../translatepy/language.py#L131) > Type: `str` The language name in macedonian -### *attr* Foreign.**malagasy** - -> [Source: ../../../translatepy/language.py @ line 133](../../../translatepy/language.py#L133) +### *attr* [Foreign.**malagasy**](../../../translatepy/language.py#L133) > Type: `str` The language name in malagasy -### *attr* Foreign.**malay** - -> [Source: ../../../translatepy/language.py @ line 135](../../../translatepy/language.py#L135) +### *attr* [Foreign.**malay**](../../../translatepy/language.py#L135) > Type: `str` The language name in malay -### *attr* Foreign.**maltese** - -> [Source: ../../../translatepy/language.py @ line 137](../../../translatepy/language.py#L137) +### *attr* [Foreign.**maltese**](../../../translatepy/language.py#L137) > Type: `str` The language name in maltese -### *attr* Foreign.**maori** - -> [Source: ../../../translatepy/language.py @ line 139](../../../translatepy/language.py#L139) +### *attr* [Foreign.**maori**](../../../translatepy/language.py#L139) > Type: `str` The language name in maori -### *attr* Foreign.**marathi** - -> [Source: ../../../translatepy/language.py @ line 141](../../../translatepy/language.py#L141) +### *attr* [Foreign.**marathi**](../../../translatepy/language.py#L141) > Type: `str` The language name in marathi -### *attr* Foreign.**moderngreek** - -> [Source: ../../../translatepy/language.py @ line 143](../../../translatepy/language.py#L143) +### *attr* [Foreign.**moderngreek**](../../../translatepy/language.py#L143) > Type: `str` The language name in moderngreek -### *attr* Foreign.**mongolian** - -> [Source: ../../../translatepy/language.py @ line 145](../../../translatepy/language.py#L145) +### *attr* [Foreign.**mongolian**](../../../translatepy/language.py#L145) > Type: `str` The language name in mongolian -### *attr* Foreign.**nepali** - -> [Source: ../../../translatepy/language.py @ line 147](../../../translatepy/language.py#L147) +### *attr* [Foreign.**nepali**](../../../translatepy/language.py#L147) > Type: `str` The language name in nepali -### *attr* Foreign.**norwegian** - -> [Source: ../../../translatepy/language.py @ line 149](../../../translatepy/language.py#L149) +### *attr* [Foreign.**norwegian**](../../../translatepy/language.py#L149) > Type: `str` The language name in norwegian -### *attr* Foreign.**panjabi** - -> [Source: ../../../translatepy/language.py @ line 151](../../../translatepy/language.py#L151) +### *attr* [Foreign.**panjabi**](../../../translatepy/language.py#L151) > Type: `str` The language name in panjabi -### *attr* Foreign.**persian** - -> [Source: ../../../translatepy/language.py @ line 153](../../../translatepy/language.py#L153) +### *attr* [Foreign.**persian**](../../../translatepy/language.py#L153) > Type: `str` The language name in persian -### *attr* Foreign.**polish** - -> [Source: ../../../translatepy/language.py @ line 155](../../../translatepy/language.py#L155) +### *attr* [Foreign.**polish**](../../../translatepy/language.py#L155) > Type: `str` The language name in polish -### *attr* Foreign.**portuguese** - -> [Source: ../../../translatepy/language.py @ line 157](../../../translatepy/language.py#L157) +### *attr* [Foreign.**portuguese**](../../../translatepy/language.py#L157) > Type: `str` The language name in portuguese -### *attr* Foreign.**romanian** - -> [Source: ../../../translatepy/language.py @ line 159](../../../translatepy/language.py#L159) +### *attr* [Foreign.**romanian**](../../../translatepy/language.py#L159) > Type: `str` The language name in romanian -### *attr* Foreign.**russian** - -> [Source: ../../../translatepy/language.py @ line 161](../../../translatepy/language.py#L161) +### *attr* [Foreign.**russian**](../../../translatepy/language.py#L161) > Type: `str` The language name in russian -### *attr* Foreign.**scottishgaelic** - -> [Source: ../../../translatepy/language.py @ line 163](../../../translatepy/language.py#L163) +### *attr* [Foreign.**scottishgaelic**](../../../translatepy/language.py#L163) > Type: `str` The language name in scottishgaelic -### *attr* Foreign.**serbian** - -> [Source: ../../../translatepy/language.py @ line 165](../../../translatepy/language.py#L165) +### *attr* [Foreign.**serbian**](../../../translatepy/language.py#L165) > Type: `str` The language name in serbian -### *attr* Foreign.**sinhala** - -> [Source: ../../../translatepy/language.py @ line 167](../../../translatepy/language.py#L167) +### *attr* [Foreign.**sinhala**](../../../translatepy/language.py#L167) > Type: `str` The language name in sinhala -### *attr* Foreign.**slovak** - -> [Source: ../../../translatepy/language.py @ line 169](../../../translatepy/language.py#L169) +### *attr* [Foreign.**slovak**](../../../translatepy/language.py#L169) > Type: `str` The language name in slovak -### *attr* Foreign.**slovenian** - -> [Source: ../../../translatepy/language.py @ line 171](../../../translatepy/language.py#L171) +### *attr* [Foreign.**slovenian**](../../../translatepy/language.py#L171) > Type: `str` The language name in slovenian -### *attr* Foreign.**spanish** - -> [Source: ../../../translatepy/language.py @ line 173](../../../translatepy/language.py#L173) +### *attr* [Foreign.**spanish**](../../../translatepy/language.py#L173) > Type: `str` The language name in spanish -### *attr* Foreign.**sundanese** - -> [Source: ../../../translatepy/language.py @ line 175](../../../translatepy/language.py#L175) +### *attr* [Foreign.**sundanese**](../../../translatepy/language.py#L175) > Type: `str` The language name in sundanese -### *attr* Foreign.**swahili** - -> [Source: ../../../translatepy/language.py @ line 177](../../../translatepy/language.py#L177) +### *attr* [Foreign.**swahili**](../../../translatepy/language.py#L177) > Type: `str` The language name in swahili -### *attr* Foreign.**swedish** - -> [Source: ../../../translatepy/language.py @ line 179](../../../translatepy/language.py#L179) +### *attr* [Foreign.**swedish**](../../../translatepy/language.py#L179) > Type: `str` The language name in swedish -### *attr* Foreign.**tagalog** - -> [Source: ../../../translatepy/language.py @ line 181](../../../translatepy/language.py#L181) +### *attr* [Foreign.**tagalog**](../../../translatepy/language.py#L181) > Type: `str` The language name in tagalog -### *attr* Foreign.**tajik** - -> [Source: ../../../translatepy/language.py @ line 183](../../../translatepy/language.py#L183) +### *attr* [Foreign.**tajik**](../../../translatepy/language.py#L183) > Type: `str` The language name in tajik -### *attr* Foreign.**tamil** - -> [Source: ../../../translatepy/language.py @ line 185](../../../translatepy/language.py#L185) +### *attr* [Foreign.**tamil**](../../../translatepy/language.py#L185) > Type: `str` The language name in tamil -### *attr* Foreign.**telugu** - -> [Source: ../../../translatepy/language.py @ line 187](../../../translatepy/language.py#L187) +### *attr* [Foreign.**telugu**](../../../translatepy/language.py#L187) > Type: `str` The language name in telugu -### *attr* Foreign.**thai** - -> [Source: ../../../translatepy/language.py @ line 189](../../../translatepy/language.py#L189) +### *attr* [Foreign.**thai**](../../../translatepy/language.py#L189) > Type: `str` The language name in thai -### *attr* Foreign.**turkish** - -> [Source: ../../../translatepy/language.py @ line 191](../../../translatepy/language.py#L191) +### *attr* [Foreign.**turkish**](../../../translatepy/language.py#L191) > Type: `str` The language name in turkish -### *attr* Foreign.**ukrainian** - -> [Source: ../../../translatepy/language.py @ line 193](../../../translatepy/language.py#L193) +### *attr* [Foreign.**ukrainian**](../../../translatepy/language.py#L193) > Type: `str` The language name in ukrainian -### *attr* Foreign.**urdu** - -> [Source: ../../../translatepy/language.py @ line 195](../../../translatepy/language.py#L195) +### *attr* [Foreign.**urdu**](../../../translatepy/language.py#L195) > Type: `str` The language name in urdu -### *attr* Foreign.**uzbek** - -> [Source: ../../../translatepy/language.py @ line 197](../../../translatepy/language.py#L197) +### *attr* [Foreign.**uzbek**](../../../translatepy/language.py#L197) > Type: `str` The language name in uzbek -### *attr* Foreign.**vietnamese** - -> [Source: ../../../translatepy/language.py @ line 199](../../../translatepy/language.py#L199) +### *attr* [Foreign.**vietnamese**](../../../translatepy/language.py#L199) > Type: `str` The language name in vietnamese -### *attr* Foreign.**welsh** - -> [Source: ../../../translatepy/language.py @ line 201](../../../translatepy/language.py#L201) +### *attr* [Foreign.**welsh**](../../../translatepy/language.py#L201) > Type: `str` The language name in welsh -### *attr* Foreign.**xhosa** - -> [Source: ../../../translatepy/language.py @ line 203](../../../translatepy/language.py#L203) +### *attr* [Foreign.**xhosa**](../../../translatepy/language.py#L203) > Type: `str` The language name in xhosa -### *attr* Foreign.**yiddish** - -> [Source: ../../../translatepy/language.py @ line 205](../../../translatepy/language.py#L205) +### *attr* [Foreign.**yiddish**](../../../translatepy/language.py#L205) > Type: `str` The language name in yiddish -### *attr* Foreign.**zulu** - -> [Source: ../../../translatepy/language.py @ line 207](../../../translatepy/language.py#L207) +### *attr* [Foreign.**zulu**](../../../translatepy/language.py#L207) > Type: `str` The language name in zulu -## *const* **LANGUAGE_CACHE** - -> [Source: ../../../translatepy/language.py @ line 211](../../../translatepy/language.py#L211) +## *const* [**LANGUAGE_CACHE**](../../../translatepy/language.py#L211) -## *const* **NULLABLE_ATTRIBUTES** +## *const* [**NULLABLE_ATTRIBUTES**](../../../translatepy/language.py#L212) -> [Source: ../../../translatepy/language.py @ line 212](../../../translatepy/language.py#L212) - -## *class* **Language** - -> [Source: ../../../translatepy/language.py @ line 215-347](../../../translatepy/language.py#L215-L347) +## *class* [**Language**](../../../translatepy/language.py#L215-L347) A language -### *attr* Language.**id** - -> [Source: ../../../translatepy/language.py @ line 218](../../../translatepy/language.py#L218) +### *attr* [Language.**id**](../../../translatepy/language.py#L218) > Type: `str` The language identifier -### *attr* Language.**alpha3** - -> [Source: ../../../translatepy/language.py @ line 220](../../../translatepy/language.py#L220) +### *attr* [Language.**alpha3**](../../../translatepy/language.py#L220) > Type: `str` The ISO 639-3 (Alpha-3) code -### *attr* Language.**name** - -> [Source: ../../../translatepy/language.py @ line 222](../../../translatepy/language.py#L222) +### *attr* [Language.**name**](../../../translatepy/language.py#L222) > Type: `str` The english name -### *attr* Language.**alpha2** - -> [Source: ../../../translatepy/language.py @ line 224](../../../translatepy/language.py#L224) +### *attr* [Language.**alpha2**](../../../translatepy/language.py#L224) > Type: `Optional` The ISO 639-1 (Alpha-2) code, if available -### *attr* Language.**alpha3b** - -> [Source: ../../../translatepy/language.py @ line 226](../../../translatepy/language.py#L226) +### *attr* [Language.**alpha3b**](../../../translatepy/language.py#L226) > Type: `Optional` The ISO 639-2B (Alpha-3) code, if available -### *attr* Language.**alpha3t** - -> [Source: ../../../translatepy/language.py @ line 228](../../../translatepy/language.py#L228) +### *attr* [Language.**alpha3t**](../../../translatepy/language.py#L228) > Type: `Optional` The ISO 639-2T (Alpha-3) code, if available -### *attr* Language.**extra** - -> [Source: ../../../translatepy/language.py @ line 230](../../../translatepy/language.py#L230) +### *attr* [Language.**extra**](../../../translatepy/language.py#L230) > Type: `Optional` Extra data for the language, if available -### *attr* Language.**foreign** - -> [Source: ../../../translatepy/language.py @ line 232](../../../translatepy/language.py#L232) +### *attr* [Language.**foreign**](../../../translatepy/language.py#L232) > Type: `Optional` Name in foreign languages, if available -### *func* Language.**search** - -> [Source: ../../../translatepy/language.py @ line 269-292](../../../translatepy/language.py#L269-L292) +### *func* [Language.**search**](../../../translatepy/language.py#L269-L292) Searches the given language @@ -828,9 +624,7 @@ Searches the given language - `list` -### *func* Language.**get_extra** - -> [Source: ../../../translatepy/language.py @ line 310-317](../../../translatepy/language.py#L310-L317) +### *func* [Language.**get_extra**](../../../translatepy/language.py#L310-L317) Retrieves the given attribute from `extra` if available @@ -845,9 +639,7 @@ Retrieves the given attribute from `extra` if available - `str` -### *func* Language.**get_foreign** - -> [Source: ../../../translatepy/language.py @ line 319-328](../../../translatepy/language.py#L319-L328) +### *func* [Language.**get_foreign**](../../../translatepy/language.py#L319-L328) Retrieves the given attribute from `foreign` if available @@ -862,9 +654,7 @@ Retrieves the given attribute from `foreign` if available - `str` -### *property* Language.**similarity** - -> [Source: ../../../translatepy/language.py @ line 331-333](../../../translatepy/language.py#L331-L333) +### *property* [Language.**similarity**](../../../translatepy/language.py#L331-L333) The similarity with the vector while searching the language @@ -872,9 +662,7 @@ The similarity with the vector while searching the language - `float` -### *property* Language.**native** - -> [Source: ../../../translatepy/language.py @ line 336-338](../../../translatepy/language.py#L336-L338) +### *property* [Language.**native**](../../../translatepy/language.py#L336-L338) The native name for the language or its english name @@ -882,9 +670,7 @@ The native name for the language or its english name - `str` -### *property* Language.**rich** - -> [Source: ../../../translatepy/language.py @ line 341-347](../../../translatepy/language.py#L341-L347) +### *property* [Language.**rich**](../../../translatepy/language.py#L341-L347) If the language discovery used the full translatepy dataset Note: This returns `False` if the `Language` was not fully initialized @@ -893,56 +679,38 @@ Note: This returns `False` if the `Language` was not fully initialized - `bool` -## *class* **LanguageData** - -> [Source: ../../../translatepy/language.py @ line 352-356](../../../translatepy/language.py#L352-L356) +## *class* [**LanguageData**](../../../translatepy/language.py#L352-L356) Groups all of the data -### *attr* LanguageData.**codes** - -> [Source: ../../../translatepy/language.py @ line 354](../../../translatepy/language.py#L354) +### *attr* [LanguageData.**codes**](../../../translatepy/language.py#L354) > Type: `Dict` -### *attr* LanguageData.**data** - -> [Source: ../../../translatepy/language.py @ line 355](../../../translatepy/language.py#L355) +### *attr* [LanguageData.**data**](../../../translatepy/language.py#L355) > Type: `Dict` -### *attr* LanguageData.**vectors** - -> [Source: ../../../translatepy/language.py @ line 356](../../../translatepy/language.py#L356) +### *attr* [LanguageData.**vectors**](../../../translatepy/language.py#L356) > Type: `List` -## *const* **LANGUAGE_DATA_DIR** - -> [Source: ../../../translatepy/language.py @ line 360](../../../translatepy/language.py#L360) +## *const* [**LANGUAGE_DATA_DIR**](../../../translatepy/language.py#L360) The directory where all of the data is stored -## *const* **DATA** - -> [Source: ../../../translatepy/language.py @ line 363](../../../translatepy/language.py#L363) +## *const* [**DATA**](../../../translatepy/language.py#L363) The languages in-memory data -## *const* **TRANSLATEPY_LANGUAGE_FULL** - -> [Source: ../../../translatepy/language.py @ line 369](../../../translatepy/language.py#L369) +## *const* [**TRANSLATEPY_LANGUAGE_FULL**](../../../translatepy/language.py#L369) If the full language data database got loaded at runtime -## *func* **load_full** - -> [Source: ../../../translatepy/language.py @ line 378-385](../../../translatepy/language.py#L378-L385) +## *func* [**load_full**](../../../translatepy/language.py#L378-L385) Loads the full data languages DB -## *const* **COMMON_LANGUAGES** - -> [Source: ../../../translatepy/language.py @ line 392](../../../translatepy/language.py#L392) +## *const* [**COMMON_LANGUAGES**](../../../translatepy/language.py#L392) All of the available foreign languages for the `foreign` field on the `Language` class and English diff --git a/docs/jpn/reference/models.md b/docs/jpn/reference/models.md index d515c15..c8ec56d 100644 --- a/docs/jpn/reference/models.md +++ b/docs/jpn/reference/models.md @@ -1,6 +1,6 @@ # *module* **models** -> [Source: ../../../translatepy/models.py @ line 0](../../../translatepy/models.py#L0) +> [Source: ../../../translatepy/models.py](../../../translatepy/models.py#L0) translatepy/models.py Describes the different result models returned by the translators @@ -11,62 +11,38 @@ Describes the different result models returned by the translators - [../../../translatepy/utils/audio.py](../../../translatepy/utils/audio.py): As `get_type` -## *class* **Speed** - -> [Source: ../../../translatepy/models.py @ line 23-28](../../../translatepy/models.py#L23-L28) +## *class* [**Speed**](../../../translatepy/models.py#L23-L28) Represents a speed percentage -### *attr* Speed.**FULL** - -> [Source: ../../../translatepy/models.py @ line 25](../../../translatepy/models.py#L25) - -### *attr* Speed.**HALF** - -> [Source: ../../../translatepy/models.py @ line 26](../../../translatepy/models.py#L26) +### *attr* [Speed.**FULL**](../../../translatepy/models.py#L25) -### *attr* Speed.**QUARTER** +### *attr* [Speed.**HALF**](../../../translatepy/models.py#L26) -> [Source: ../../../translatepy/models.py @ line 27](../../../translatepy/models.py#L27) +### *attr* [Speed.**QUARTER**](../../../translatepy/models.py#L27) -### *attr* Speed.**SLOW** +### *attr* [Speed.**SLOW**](../../../translatepy/models.py#L28) -> [Source: ../../../translatepy/models.py @ line 28](../../../translatepy/models.py#L28) - -## *class* **Gender** - -> [Source: ../../../translatepy/models.py @ line 31-36](../../../translatepy/models.py#L31-L36) +## *class* [**Gender**](../../../translatepy/models.py#L31-L36) Represents a gender -### *attr* Gender.**MALE** - -> [Source: ../../../translatepy/models.py @ line 33](../../../translatepy/models.py#L33) +### *attr* [Gender.**MALE**](../../../translatepy/models.py#L33) -### *attr* Gender.**FEMALE** +### *attr* [Gender.**FEMALE**](../../../translatepy/models.py#L34) -> [Source: ../../../translatepy/models.py @ line 34](../../../translatepy/models.py#L34) +### *attr* [Gender.**OTHER**](../../../translatepy/models.py#L35) -### *attr* Gender.**OTHER** +### *attr* [Gender.**GENDERLESS**](../../../translatepy/models.py#L36) -> [Source: ../../../translatepy/models.py @ line 35](../../../translatepy/models.py#L35) - -### *attr* Gender.**GENDERLESS** - -> [Source: ../../../translatepy/models.py @ line 36](../../../translatepy/models.py#L36) - -## *class* **WordClass** - -> [Source: ../../../translatepy/models.py @ line 39-110](../../../translatepy/models.py#L39-L110) +## *class* [**WordClass**](../../../translatepy/models.py#L39-L110) Part of speech > **Note** > Refer to https://en.wikipedia.org/wiki/Part_of_speech -### *attr* WordClass.**NOUN** - -> [Source: ../../../translatepy/models.py @ line 45](../../../translatepy/models.py#L45) +### *attr* [WordClass.**NOUN**](../../../translatepy/models.py#L45) A word or lexical item denoting any abstract (abstract noun: e.g. home) or concrete entity (concrete noun: e.g. house); a person (police officer, Michael), place (coastline, London), thing (necktie, television), idea (happiness), or quality (bravery). @@ -75,37 +51,27 @@ Nouns can also be classified as count nouns or non-count nouns; some can belong > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**PRONOUN** - -> [Source: ../../../translatepy/models.py @ line 54](../../../translatepy/models.py#L54) +### *attr* [WordClass.**PRONOUN**](../../../translatepy/models.py#L54) A substitute for a noun or noun phrase (them, he). Pronouns make sentences shorter and clearer since they replace nouns. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ADJECTIVE** - -> [Source: ../../../translatepy/models.py @ line 60](../../../translatepy/models.py#L60) +### *attr* [WordClass.**ADJECTIVE**](../../../translatepy/models.py#L60) A modifier of a noun or pronoun (big, brave). Adjectives make the meaning of another word (noun) more precise. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**VERB** - -> [Source: ../../../translatepy/models.py @ line 66](../../../translatepy/models.py#L66) +### *attr* [WordClass.**VERB**](../../../translatepy/models.py#L66) A word denoting an action (walk), occurrence (happen), or state of being (be). Without a verb, a group of words cannot be a clause or sentence. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ADVERB** - -> [Source: ../../../translatepy/models.py @ line 72](../../../translatepy/models.py#L72) +### *attr* [WordClass.**ADVERB**](../../../translatepy/models.py#L72) A modifier of an adjective, verb, or another adverb (very, quite). Adverbs make language more precise. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**PREPOSITION** - -> [Source: ../../../translatepy/models.py @ line 78](../../../translatepy/models.py#L78) +### *attr* [WordClass.**PREPOSITION**](../../../translatepy/models.py#L78) A word that relates words to each other in a phrase or sentence and aids in syntactic context (in, of). Prepositions show the relationship between a noun or a pronoun with another word in the sentence. @@ -113,23 +79,17 @@ Prepositions show the relationship between a noun or a pronoun with another word > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**CONJUNCTION** - -> [Source: ../../../translatepy/models.py @ line 86](../../../translatepy/models.py#L86) +### *attr* [WordClass.**CONJUNCTION**](../../../translatepy/models.py#L86) A syntactic connector; links words, phrases, or clauses (and, but). Conjunctions connect words or group of words Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**INTERJECTION** - -> [Source: ../../../translatepy/models.py @ line 92](../../../translatepy/models.py#L92) +### *attr* [WordClass.**INTERJECTION**](../../../translatepy/models.py#L92) An emotional greeting or exclamation (Huzzah, Alas). Interjections express strong feelings and emotions. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ARTICLE** - -> [Source: ../../../translatepy/models.py @ line 98](../../../translatepy/models.py#L98) +### *attr* [WordClass.**ARTICLE**](../../../translatepy/models.py#L98) A grammatical marker of definiteness (the) or indefiniteness (a, an). The article is not always listed among the parts of speech. @@ -138,23 +98,15 @@ It is considered by some grammarians to be a type of adjective or sometimes the > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**OTHER** - -> [Source: ../../../translatepy/models.py @ line 107](../../../translatepy/models.py#L107) +### *attr* [WordClass.**OTHER**](../../../translatepy/models.py#L107) For other part of speech -## *const* **Translator** - -> [Source: ../../../translatepy/models.py @ line 113](../../../translatepy/models.py#L113) - -## *const* **PRIVATE_ATTRIBUTES** +## *const* [**Translator**](../../../translatepy/models.py#L113) -> [Source: ../../../translatepy/models.py @ line 115](../../../translatepy/models.py#L115) +## *const* [**PRIVATE_ATTRIBUTES**](../../../translatepy/models.py#L115) -## *func* **should_be_exported** - -> [Source: ../../../translatepy/models.py @ line 118-121](../../../translatepy/models.py#L118-L121) +## *func* [**should_be_exported**](../../../translatepy/models.py#L118-L121) if the given attribute should be exposed or not @@ -163,33 +115,23 @@ if the given attribute should be exposed or not - **attr**: `str` -## *class* **ResultAttribute** - -> [Source: ../../../translatepy/models.py @ line 125-129](../../../translatepy/models.py#L125-L129) +## *class* [**ResultAttribute**](../../../translatepy/models.py#L125-L129) Details about a result attribute -### *attr* ResultAttribute.**name** - -> [Source: ../../../translatepy/models.py @ line 127](../../../translatepy/models.py#L127) +### *attr* [ResultAttribute.**name**](../../../translatepy/models.py#L127) > Type: `str` -### *attr* ResultAttribute.**annotation** - -> [Source: ../../../translatepy/models.py @ line 128](../../../translatepy/models.py#L128) +### *attr* [ResultAttribute.**annotation**](../../../translatepy/models.py#L128) > Type: `Optional` -### *attr* ResultAttribute.**description** - -> [Source: ../../../translatepy/models.py @ line 129](../../../translatepy/models.py#L129) +### *attr* [ResultAttribute.**description**](../../../translatepy/models.py#L129) > Type: `Optional` -## *class* **Result** - -> [Source: ../../../translatepy/models.py @ line 136-287](../../../translatepy/models.py#L136-L287) +## *class* [**Result**](../../../translatepy/models.py#L136-L287) The base result model @@ -197,33 +139,25 @@ The base result model - `IndexError` -### *attr* Result.**service** - -> [Source: ../../../translatepy/models.py @ line 143](../../../translatepy/models.py#L143) +### *attr* [Result.**service**](../../../translatepy/models.py#L143) > Type: `Translator` The service which returned the result -### *attr* Result.**source** - -> [Source: ../../../translatepy/models.py @ line 146](../../../translatepy/models.py#L146) +### *attr* [Result.**source**](../../../translatepy/models.py#L146) > Type: `str` The source text -### *attr* Result.**source_lang** - -> [Source: ../../../translatepy/models.py @ line 148](../../../translatepy/models.py#L148) +### *attr* [Result.**source_lang**](../../../translatepy/models.py#L148) > Type: `Language` The source text's language -### *attr* Result.**raw** - -> [Source: ../../../translatepy/models.py @ line 158](../../../translatepy/models.py#L158) +### *attr* [Result.**raw**](../../../translatepy/models.py#L158) > Type: `Optional` @@ -231,9 +165,7 @@ The raw response returned by the service. Note: This is very dependent on the service used. Refer to the service documentation to learn how to use this object. -### *property* Result.**attributes** - -> [Source: ../../../translatepy/models.py @ line 217-267](../../../translatepy/models.py#L217-L267) +### *property* [Result.**attributes**](../../../translatepy/models.py#L217-L267) The different attributes on the dataclass @@ -246,9 +178,7 @@ The different attributes on the dataclass - `list` -### *property* Result.**exported** - -> [Source: ../../../translatepy/models.py @ line 270-281](../../../translatepy/models.py#L270-L281) +### *property* [Result.**exported**](../../../translatepy/models.py#L270-L281) A dictionary version of the dataclass which can be exposed to the public @@ -256,169 +186,119 @@ A dictionary version of the dataclass which can be exposed to the public - `dict` -## *class* **TranslationResult** - -> [Source: ../../../translatepy/models.py @ line 291-329](../../../translatepy/models.py#L291-L329) +## *class* [**TranslationResult**](../../../translatepy/models.py#L291-L329) Holds the result of a regular translation -### *attr* TranslationResult.**dest_lang** - -> [Source: ../../../translatepy/models.py @ line 296](../../../translatepy/models.py#L296) +### *attr* [TranslationResult.**dest_lang**](../../../translatepy/models.py#L296) > Type: `Language` The result's language -### *attr* TranslationResult.**translation** - -> [Source: ../../../translatepy/models.py @ line 299](../../../translatepy/models.py#L299) +### *attr* [TranslationResult.**translation**](../../../translatepy/models.py#L299) > Type: `str` The translation result -### *property* TranslationResult.**alternatives** - -> [Source: ../../../translatepy/models.py @ line 306-310](../../../translatepy/models.py#L306-L310) +### *property* [TranslationResult.**alternatives**](../../../translatepy/models.py#L306-L310) Returns the alternative translations associated -## *const* **TRANSLATION_TEST** +## *const* [**TRANSLATION_TEST**](../../../translatepy/models.py#L332) -> [Source: ../../../translatepy/models.py @ line 332](../../../translatepy/models.py#L332) - -## *class* **TransliterationResult** - -> [Source: ../../../translatepy/models.py @ line 344-371](../../../translatepy/models.py#L344-L371) +## *class* [**TransliterationResult**](../../../translatepy/models.py#L344-L371) Holds the result of a transliteration -### *attr* TransliterationResult.**transliteration** - -> [Source: ../../../translatepy/models.py @ line 348](../../../translatepy/models.py#L348) +### *attr* [TransliterationResult.**transliteration**](../../../translatepy/models.py#L348) > Type: `str` The transliteration result -### *attr* TransliterationResult.**dest_lang** - -> [Source: ../../../translatepy/models.py @ line 351](../../../translatepy/models.py#L351) +### *attr* [TransliterationResult.**dest_lang**](../../../translatepy/models.py#L351) > Type: `Language` The result's language -## *const* **TRANSLITERATION_TEST** +## *const* [**TRANSLITERATION_TEST**](../../../translatepy/models.py#L374) -> [Source: ../../../translatepy/models.py @ line 374](../../../translatepy/models.py#L374) - -## *class* **SpellcheckResult** - -> [Source: ../../../translatepy/models.py @ line 384-410](../../../translatepy/models.py#L384-L410) +## *class* [**SpellcheckResult**](../../../translatepy/models.py#L384-L410) Holds a spellchecking result -### *attr* SpellcheckResult.**rich** - -> [Source: ../../../translatepy/models.py @ line 389](../../../translatepy/models.py#L389) +### *attr* [SpellcheckResult.**rich**](../../../translatepy/models.py#L389) -### *attr* SpellcheckResult.**source_lang** - -> [Source: ../../../translatepy/models.py @ line 391](../../../translatepy/models.py#L391) +### *attr* [SpellcheckResult.**source_lang**](../../../translatepy/models.py#L391) > Type: `Language` The source text's language -### *attr* SpellcheckResult.**corrected** - -> [Source: ../../../translatepy/models.py @ line 393](../../../translatepy/models.py#L393) +### *attr* [SpellcheckResult.**corrected**](../../../translatepy/models.py#L393) > Type: `str` The corrected text -## *const* **SPELLCHECK_TEST** - -> [Source: ../../../translatepy/models.py @ line 413](../../../translatepy/models.py#L413) +## *const* [**SPELLCHECK_TEST**](../../../translatepy/models.py#L413) -## *class* **SpellcheckMistake** - -> [Source: ../../../translatepy/models.py @ line 422-435](../../../translatepy/models.py#L422-L435) +## *class* [**SpellcheckMistake**](../../../translatepy/models.py#L422-L435) This holds a mistake made detected by the spellchecker -### *attr* SpellcheckMistake.**start** - -> [Source: ../../../translatepy/models.py @ line 424](../../../translatepy/models.py#L424) +### *attr* [SpellcheckMistake.**start**](../../../translatepy/models.py#L424) > Type: `int` The beginning index of the part to correct in the original text -### *attr* SpellcheckMistake.**end** - -> [Source: ../../../translatepy/models.py @ line 426](../../../translatepy/models.py#L426) +### *attr* [SpellcheckMistake.**end**](../../../translatepy/models.py#L426) > Type: `int` The ending index of the part to correct in the original text -### *attr* SpellcheckMistake.**corrected** - -> [Source: ../../../translatepy/models.py @ line 428](../../../translatepy/models.py#L428) +### *attr* [SpellcheckMistake.**corrected**](../../../translatepy/models.py#L428) > Type: `str` The corrected part -### *attr* SpellcheckMistake.**message** - -> [Source: ../../../translatepy/models.py @ line 431](../../../translatepy/models.py#L431) +### *attr* [SpellcheckMistake.**message**](../../../translatepy/models.py#L431) > Type: `Optional` A message explaining what happened -### *attr* SpellcheckMistake.**rule** - -> [Source: ../../../translatepy/models.py @ line 434](../../../translatepy/models.py#L434) +### *attr* [SpellcheckMistake.**rule**](../../../translatepy/models.py#L434) > Type: `Optional` A string which identifies the rule associated with the mistake made -## *class* **RichSpellcheckResult** - -> [Source: ../../../translatepy/models.py @ line 441-601](../../../translatepy/models.py#L441-L601) +## *class* [**RichSpellcheckResult**](../../../translatepy/models.py#L441-L601) Holds a rich spellchecking result -### *attr* RichSpellcheckResult.**rich** +### *attr* [RichSpellcheckResult.**rich**](../../../translatepy/models.py#L447) -> [Source: ../../../translatepy/models.py @ line 447](../../../translatepy/models.py#L447) - -### *attr* RichSpellcheckResult.**source_lang** - -> [Source: ../../../translatepy/models.py @ line 449](../../../translatepy/models.py#L449) +### *attr* [RichSpellcheckResult.**source_lang**](../../../translatepy/models.py#L449) > Type: `Language` The source text's language -### *attr* RichSpellcheckResult.**mistakes** - -> [Source: ../../../translatepy/models.py @ line 451](../../../translatepy/models.py#L451) +### *attr* [RichSpellcheckResult.**mistakes**](../../../translatepy/models.py#L451) > Type: `List` The different mistakes made -### *property* RichSpellcheckResult.**corrected** - -> [Source: ../../../translatepy/models.py @ line 455-463](../../../translatepy/models.py#L455-L463) +### *property* [RichSpellcheckResult.**corrected**](../../../translatepy/models.py#L455-L463) The corrected text @@ -426,45 +306,31 @@ The corrected text - `str` -## *const* **RICH_SPELLCHECK_TEST** - -> [Source: ../../../translatepy/models.py @ line 604](../../../translatepy/models.py#L604) - -## *class* **LanguageResult** +## *const* [**RICH_SPELLCHECK_TEST**](../../../translatepy/models.py#L604) -> [Source: ../../../translatepy/models.py @ line 618-628](../../../translatepy/models.py#L618-L628) +## *class* [**LanguageResult**](../../../translatepy/models.py#L618-L628) Holds the language of the given text -## *const* **LANGUAGE_TEST** +## *const* [**LANGUAGE_TEST**](../../../translatepy/models.py#L631) -> [Source: ../../../translatepy/models.py @ line 631](../../../translatepy/models.py#L631) - -## *class* **ExampleResult** - -> [Source: ../../../translatepy/models.py @ line 635-725](../../../translatepy/models.py#L635-L725) +## *class* [**ExampleResult**](../../../translatepy/models.py#L635-L725) Holds an example sentence where the given word is used. -### *attr* ExampleResult.**example** - -> [Source: ../../../translatepy/models.py @ line 641](../../../translatepy/models.py#L641) +### *attr* [ExampleResult.**example**](../../../translatepy/models.py#L641) > Type: `str` The example -### *attr* ExampleResult.**reference** - -> [Source: ../../../translatepy/models.py @ line 644](../../../translatepy/models.py#L644) +### *attr* [ExampleResult.**reference**](../../../translatepy/models.py#L644) > Type: `Optional` Where the example comes from (i.e a book or a the person who said it if it's a quote) -### *property* ExampleResult.**position** - -> [Source: ../../../translatepy/models.py @ line 648-655](../../../translatepy/models.py#L648-L655) +### *property* [ExampleResult.**position**](../../../translatepy/models.py#L648-L655) The first position of the word in the example @@ -474,9 +340,7 @@ The first position of the word in the example - `int` -### *property* ExampleResult.**positions** - -> [Source: ../../../translatepy/models.py @ line 658-690](../../../translatepy/models.py#L658-L690) +### *property* [ExampleResult.**positions**](../../../translatepy/models.py#L658-L690) The positions of the word in the example @@ -485,75 +349,51 @@ The positions of the word in the example - `list[int]` - A list of positions of the word in the example -## *const* **EXAMPLE_TEST** - -> [Source: ../../../translatepy/models.py @ line 728](../../../translatepy/models.py#L728) +## *const* [**EXAMPLE_TEST**](../../../translatepy/models.py#L728) -## *class* **DictionaryResult** - -> [Source: ../../../translatepy/models.py @ line 737-752](../../../translatepy/models.py#L737-L752) +## *class* [**DictionaryResult**](../../../translatepy/models.py#L737-L752) Holds the meaning of the given text -### *attr* DictionaryResult.**rich** - -> [Source: ../../../translatepy/models.py @ line 743](../../../translatepy/models.py#L743) - -### *attr* DictionaryResult.**meaning** +### *attr* [DictionaryResult.**rich**](../../../translatepy/models.py#L743) -> [Source: ../../../translatepy/models.py @ line 745](../../../translatepy/models.py#L745) +### *attr* [DictionaryResult.**meaning**](../../../translatepy/models.py#L745) > Type: `str` The meaning of the text -## *const* **DICTIONARY_TEST** +## *const* [**DICTIONARY_TEST**](../../../translatepy/models.py#L755) -> [Source: ../../../translatepy/models.py @ line 755](../../../translatepy/models.py#L755) - -## *class* **EtymologicalNode** - -> [Source: ../../../translatepy/models.py @ line 764-791](../../../translatepy/models.py#L764-L791) +## *class* [**EtymologicalNode**](../../../translatepy/models.py#L764-L791) The node of an etymological tree -### *attr* EtymologicalNode.**origin** - -> [Source: ../../../translatepy/models.py @ line 766](../../../translatepy/models.py#L766) +### *attr* [EtymologicalNode.**origin**](../../../translatepy/models.py#L766) > Type: `str` The origin name (i.e 'Latin') -### *attr* EtymologicalNode.**source** - -> [Source: ../../../translatepy/models.py @ line 769](../../../translatepy/models.py#L769) +### *attr* [EtymologicalNode.**source**](../../../translatepy/models.py#L769) > Type: `Optional` The original way of writing it -### *attr* EtymologicalNode.**year** - -> [Source: ../../../translatepy/models.py @ line 771](../../../translatepy/models.py#L771) +### *attr* [EtymologicalNode.**year**](../../../translatepy/models.py#L771) > Type: `Optional` The year of origin -## *class* **RichDictionaryResult** - -> [Source: ../../../translatepy/models.py @ line 795-904](../../../translatepy/models.py#L795-L904) +## *class* [**RichDictionaryResult**](../../../translatepy/models.py#L795-L904) Holds more (optional) information than the regular `DictionaryResult` -### *attr* RichDictionaryResult.**rich** +### *attr* [RichDictionaryResult.**rich**](../../../translatepy/models.py#L801) -> [Source: ../../../translatepy/models.py @ line 801](../../../translatepy/models.py#L801) - -### *attr* RichDictionaryResult.**etymology** - -> [Source: ../../../translatepy/models.py @ line 803](../../../translatepy/models.py#L803) +### *attr* [RichDictionaryResult.**etymology**](../../../translatepy/models.py#L803) > Type: `List` @@ -566,9 +406,7 @@ Each element corresponds to a node in the tree of origins for the given text `Node1 (Greek) -> Node2 (Latin) -> Node3 (French) -> Node4 (Ancient English) -> Current Word` -### *attr* RichDictionaryResult.**gender** - -> [Source: ../../../translatepy/models.py @ line 814](../../../translatepy/models.py#L814) +### *attr* [RichDictionaryResult.**gender**](../../../translatepy/models.py#L814) > Type: `Gender` @@ -580,77 +418,55 @@ For languages which assign genders on words `chaîse (french; a chair) -> Gender.FEMALE` -### *attr* RichDictionaryResult.**pronunciation** - -> [Source: ../../../translatepy/models.py @ line 823](../../../translatepy/models.py#L823) +### *attr* [RichDictionaryResult.**pronunciation**](../../../translatepy/models.py#L823) > Type: `Optional` A way of pronouncing the text -### *attr* RichDictionaryResult.**type** - -> [Source: ../../../translatepy/models.py @ line 826](../../../translatepy/models.py#L826) +### *attr* [RichDictionaryResult.**type**](../../../translatepy/models.py#L826) > Type: `WordClass` The part of speech of the text -### *attr* RichDictionaryResult.**synonyms** - -> [Source: ../../../translatepy/models.py @ line 829](../../../translatepy/models.py#L829) +### *attr* [RichDictionaryResult.**synonyms**](../../../translatepy/models.py#L829) > Type: `List` -### *attr* RichDictionaryResult.**antonyms** - -> [Source: ../../../translatepy/models.py @ line 830](../../../translatepy/models.py#L830) +### *attr* [RichDictionaryResult.**antonyms**](../../../translatepy/models.py#L830) > Type: `List` -## *const* **RICH_DICTIONARY_TEST** +## *const* [**RICH_DICTIONARY_TEST**](../../../translatepy/models.py#L907) -> [Source: ../../../translatepy/models.py @ line 907](../../../translatepy/models.py#L907) - -## *class* **TextToSpeechResult** - -> [Source: ../../../translatepy/models.py @ line 922-988](../../../translatepy/models.py#L922-L988) +## *class* [**TextToSpeechResult**](../../../translatepy/models.py#L922-L988) Holds the text to speech results -### *attr* TextToSpeechResult.**result** - -> [Source: ../../../translatepy/models.py @ line 928](../../../translatepy/models.py#L928) +### *attr* [TextToSpeechResult.**result**](../../../translatepy/models.py#L928) > Type: `bytes` Text to speech result -### *attr* TextToSpeechResult.**speed** - -> [Source: ../../../translatepy/models.py @ line 930](../../../translatepy/models.py#L930) +### *attr* [TextToSpeechResult.**speed**](../../../translatepy/models.py#L930) > Type: `int` Speed of the text to speech result -### *attr* TextToSpeechResult.**gender** - -> [Source: ../../../translatepy/models.py @ line 932](../../../translatepy/models.py#L932) +### *attr* [TextToSpeechResult.**gender**](../../../translatepy/models.py#L932) > Type: `Gender` Gender of the 'person' saying the text -### *property* TextToSpeechResult.**type** - -> [Source: ../../../translatepy/models.py @ line 936-938](../../../translatepy/models.py#L936-L938) +### *property* [TextToSpeechResult.**type**](../../../translatepy/models.py#L936-L938) Returns the type of audio file -### *property* TextToSpeechResult.**mime_type** - -> [Source: ../../../translatepy/models.py @ line 941-953](../../../translatepy/models.py#L941-L953) +### *property* [TextToSpeechResult.**mime_type**](../../../translatepy/models.py#L941-L953) Returns the MIME type of the audio file @@ -659,9 +475,7 @@ Returns the MIME type of the audio file - `Optional[str]` - The MIME type of the audio file -### *property* TextToSpeechResult.**extension** - -> [Source: ../../../translatepy/models.py @ line 956-968](../../../translatepy/models.py#L956-L968) +### *property* [TextToSpeechResult.**extension**](../../../translatepy/models.py#L956-L968) Returns the audio file extension @@ -670,9 +484,7 @@ Returns the audio file extension - `Optional[str]` - The MIME type of the audio file -### *func* TextToSpeechResult.**write_to_file** - -> [Source: ../../../translatepy/models.py @ line 970-988](../../../translatepy/models.py#L970-L988) +### *func* [TextToSpeechResult.**write_to_file**](../../../translatepy/models.py#L970-L988) Writes the spoken text to a file. @@ -687,27 +499,19 @@ Writes the spoken text to a file. - If we need to change the extension of the file to match the right file type -## *class* **HTMLTranslationNode** - -> [Source: ../../../translatepy/models.py @ line 992-1029](../../../translatepy/models.py#L992-L1029) +## *class* [**HTMLTranslationNode**](../../../translatepy/models.py#L992-L1029) A translation node, containing the DOM element and its translation result -### *attr* HTMLTranslationNode.**node** - -> [Source: ../../../translatepy/models.py @ line 996](../../../translatepy/models.py#L996) +### *attr* [HTMLTranslationNode.**node**](../../../translatepy/models.py#L996) > Type: `bs4.NavigableString` -### *attr* HTMLTranslationNode.**result** - -> [Source: ../../../translatepy/models.py @ line 997](../../../translatepy/models.py#L997) +### *attr* [HTMLTranslationNode.**result**](../../../translatepy/models.py#L997) > Type: `Optional` -### *property* HTMLTranslationNode.**position** - -> [Source: ../../../translatepy/models.py @ line 1000-1020](../../../translatepy/models.py#L1000-L1020) +### *property* [HTMLTranslationNode.**position**](../../../translatepy/models.py#L1000-L1020) The position of the node in the HTML @@ -715,9 +519,7 @@ The position of the node in the HTML - `int` -### *property* HTMLTranslationNode.**exported** - -> [Source: ../../../translatepy/models.py @ line 1023-1029](../../../translatepy/models.py#L1023-L1029) +### *property* [HTMLTranslationNode.**exported**](../../../translatepy/models.py#L1023-L1029) The exported dictionary @@ -725,33 +527,23 @@ The exported dictionary - `dict` -## *class* **HTMLTranslationResult** - -> [Source: ../../../translatepy/models.py @ line 1033-1052](../../../translatepy/models.py#L1033-L1052) +## *class* [**HTMLTranslationResult**](../../../translatepy/models.py#L1033-L1052) Holds an HTML translation result -### *attr* HTMLTranslationResult.**result** - -> [Source: ../../../translatepy/models.py @ line 1037](../../../translatepy/models.py#L1037) +### *attr* [HTMLTranslationResult.**result**](../../../translatepy/models.py#L1037) > Type: `str` -### *attr* HTMLTranslationResult.**soup** - -> [Source: ../../../translatepy/models.py @ line 1038](../../../translatepy/models.py#L1038) +### *attr* [HTMLTranslationResult.**soup**](../../../translatepy/models.py#L1038) > Type: `bs4.BeautifulSoup` -### *attr* HTMLTranslationResult.**nodes** - -> [Source: ../../../translatepy/models.py @ line 1039](../../../translatepy/models.py#L1039) +### *attr* [HTMLTranslationResult.**nodes**](../../../translatepy/models.py#L1039) > Type: `List` -### *property* HTMLTranslationResult.**exported** - -> [Source: ../../../translatepy/models.py @ line 1048-1052](../../../translatepy/models.py#L1048-L1052) +### *property* [HTMLTranslationResult.**exported**](../../../translatepy/models.py#L1048-L1052) #### Returns diff --git a/docs/jpn/reference/server/server.md b/docs/jpn/reference/server/server.md index 114afdd..0b55870 100644 --- a/docs/jpn/reference/server/server.md +++ b/docs/jpn/reference/server/server.md @@ -1,23 +1,17 @@ # *module* **server** -> [Source: ../../../../translatepy/server/server.py @ line 0](../../../../translatepy/server/server.py#L0) +> [Source: ../../../../translatepy/server/server.py](../../../../translatepy/server/server.py#L0) the translatepy server -## *const* **app** - -> [Source: ../../../../translatepy/server/server.py @ line 6](../../../../translatepy/server/server.py#L6) +## *const* [**app**](../../../../translatepy/server/server.py#L6) The `nasse` server instance for `translatepy` -## *const* **TRANSLATEPY_ENDPOINT** - -> [Source: ../../../../translatepy/server/server.py @ line 9](../../../../translatepy/server/server.py#L9) +## *const* [**TRANSLATEPY_ENDPOINT**](../../../../translatepy/server/server.py#L9) Base `translatepy` endpoint -## *const* **SERVER_DOCS_PATH** - -> [Source: ../../../../translatepy/server/server.py @ line 13](../../../../translatepy/server/server.py#L13) +## *const* [**SERVER_DOCS_PATH**](../../../../translatepy/server/server.py#L13) The root path for the server offline docs diff --git a/docs/jpn/reference/translate.md b/docs/jpn/reference/translate.md index b1f3252..7425526 100644 --- a/docs/jpn/reference/translate.md +++ b/docs/jpn/reference/translate.md @@ -1,6 +1,6 @@ # *module* **translate** -> [Source: ../../../translatepy/translate.py @ line 0](../../../translatepy/translate.py#L0) +> [Source: ../../../translatepy/translate.py](../../../translatepy/translate.py#L0) translatepy v3.0 © Anime no Sekai — 2023 @@ -37,14 +37,10 @@ translatepy v3.0 - [../../../translatepy/utils/request.py](../../../translatepy/utils/request.py): As `request` -## *const* **DEFAULT_TRANSLATORS** - -> [Source: ../../../translatepy/translate.py @ line 15](../../../translatepy/translate.py#L15) +## *const* [**DEFAULT_TRANSLATORS**](../../../translatepy/translate.py#L15) A list of default translators to use with the translators aggregation -## *class* **Translate** - -> [Source: ../../../translatepy/translate.py @ line 20-27](../../../translatepy/translate.py#L20-L27) +## *class* [**Translate**](../../../translatepy/translate.py#L20-L27) A class which groups all of the translators diff --git a/docs/jpn/reference/translators/README.md b/docs/jpn/reference/translators/README.md index 316ceb5..f5dbc05 100644 --- a/docs/jpn/reference/translators/README.md +++ b/docs/jpn/reference/translators/README.md @@ -1,6 +1,6 @@ # *module* **__init__** -> [Source: ../../../../translatepy/translators/__init__.py @ line 0](../../../../translatepy/translators/__init__.py#L0) +> [Source: ../../../../translatepy/translators/__init__.py](../../../../translatepy/translators/__init__.py#L0) ## Imports @@ -30,58 +30,30 @@ - [../../../../translatepy/translators/papago.py](../../../../translatepy/translators/papago.py): As `Papago` -## *const* **Reverso** +## *const* [**Reverso**](../../../../translatepy/translators/__init__.py#L21) -> [Source: ../../../../translatepy/translators/__init__.py @ line 21](../../../../translatepy/translators/__init__.py#L21) +## *const* [**Bing**](../../../../translatepy/translators/__init__.py#L22) -## *const* **Bing** +## *const* [**DeepL**](../../../../translatepy/translators/__init__.py#L23) -> [Source: ../../../../translatepy/translators/__init__.py @ line 22](../../../../translatepy/translators/__init__.py#L22) +## *const* [**Deepl**](../../../../translatepy/translators/__init__.py#L24) -## *const* **DeepL** +## *const* [**Google**](../../../../translatepy/translators/__init__.py#L25) -> [Source: ../../../../translatepy/translators/__init__.py @ line 23](../../../../translatepy/translators/__init__.py#L23) +## *const* [**Libre**](../../../../translatepy/translators/__init__.py#L26) -## *const* **Deepl** +## *const* [**MyMemory**](../../../../translatepy/translators/__init__.py#L27) -> [Source: ../../../../translatepy/translators/__init__.py @ line 24](../../../../translatepy/translators/__init__.py#L24) +## *const* [**TranslateCom**](../../../../translatepy/translators/__init__.py#L28) -## *const* **Google** +## *const* [**Yandex**](../../../../translatepy/translators/__init__.py#L29) -> [Source: ../../../../translatepy/translators/__init__.py @ line 25](../../../../translatepy/translators/__init__.py#L25) +## *const* [**Microsoft**](../../../../translatepy/translators/__init__.py#L30) -## *const* **Libre** +## *const* [**QCRITranslate**](../../../../translatepy/translators/__init__.py#L32) -> [Source: ../../../../translatepy/translators/__init__.py @ line 26](../../../../translatepy/translators/__init__.py#L26) +## *const* [**PONSTranslate**](../../../../translatepy/translators/__init__.py#L33) -## *const* **MyMemory** +## *const* [**PapagoTranslate**](../../../../translatepy/translators/__init__.py#L34) -> [Source: ../../../../translatepy/translators/__init__.py @ line 27](../../../../translatepy/translators/__init__.py#L27) - -## *const* **TranslateCom** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 28](../../../../translatepy/translators/__init__.py#L28) - -## *const* **Yandex** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 29](../../../../translatepy/translators/__init__.py#L29) - -## *const* **Microsoft** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 30](../../../../translatepy/translators/__init__.py#L30) - -## *const* **QCRITranslate** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 32](../../../../translatepy/translators/__init__.py#L32) - -## *const* **PONSTranslate** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 33](../../../../translatepy/translators/__init__.py#L33) - -## *const* **PapagoTranslate** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 34](../../../../translatepy/translators/__init__.py#L34) - -## *const* **NaverTranslate** - -> [Source: ../../../../translatepy/translators/__init__.py @ line 35](../../../../translatepy/translators/__init__.py#L35) +## *const* [**NaverTranslate**](../../../../translatepy/translators/__init__.py#L35) diff --git a/docs/jpn/reference/translators/base.md b/docs/jpn/reference/translators/base.md index 8a09073..9165f5e 100644 --- a/docs/jpn/reference/translators/base.md +++ b/docs/jpn/reference/translators/base.md @@ -1,25 +1,17 @@ # *module* **base** -> [Source: ../../../../translatepy/translators/base.py @ line 0](../../../../translatepy/translators/base.py#L0) +> [Source: ../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py#L0) translators/base.py Implements the Base Translator class -## *const* **C** +## *const* [**C**](../../../../translatepy/translators/base.py#L25) -> [Source: ../../../../translatepy/translators/base.py @ line 25](../../../../translatepy/translators/base.py#L25) +## *const* [**R**](../../../../translatepy/translators/base.py#L26) -## *const* **R** +## *const* [**HTMLType**](../../../../translatepy/translators/base.py#L27) -> [Source: ../../../../translatepy/translators/base.py @ line 26](../../../../translatepy/translators/base.py#L26) - -## *const* **HTMLType** - -> [Source: ../../../../translatepy/translators/base.py @ line 27](../../../../translatepy/translators/base.py#L27) - -## *class* **LazyIterable** - -> [Source: ../../../../translatepy/translators/base.py @ line 30-69](../../../../translatepy/translators/base.py#L30-L69) +## *class* [**LazyIterable**](../../../../translatepy/translators/base.py#L30-L69) An object which can be iterated through, even multiple times, but lazy loads the results. @@ -27,33 +19,21 @@ An object which can be iterated through, even multiple times, but lazy loads the - `IndexError` -## *const* **T** - -> [Source: ../../../../translatepy/translators/base.py @ line 73](../../../../translatepy/translators/base.py#L73) +## *const* [**T**](../../../../translatepy/translators/base.py#L73) -## *class* **BaseTranslateException** - -> [Source: ../../../../translatepy/translators/base.py @ line 79-105](../../../../translatepy/translators/base.py#L79-L105) +## *class* [**BaseTranslateException**](../../../../translatepy/translators/base.py#L79-L105) A translator exception, indicating a problem which occured during translation -### *attr* BaseTranslateException.**error_codes** - -> [Source: ../../../../translatepy/translators/base.py @ line 83](../../../../translatepy/translators/base.py#L83) - -## *class* **Flag** +### *attr* [BaseTranslateException.**error_codes**](../../../../translatepy/translators/base.py#L83) -> [Source: ../../../../translatepy/translators/base.py @ line 108-112](../../../../translatepy/translators/base.py#L108-L112) +## *class* [**Flag**](../../../../translatepy/translators/base.py#L108-L112) Defines a set of internal flags the handlers can send to the validator -### *attr* Flag.**MULTIPLE_RESULTS** - -> [Source: ../../../../translatepy/translators/base.py @ line 112](../../../../translatepy/translators/base.py#L112) - -## *class* **BaseTranslator** +### *attr* [Flag.**MULTIPLE_RESULTS**](../../../../translatepy/translators/base.py#L112) -> [Source: ../../../../translatepy/translators/base.py @ line 115-1293](../../../../translatepy/translators/base.py#L115-L1293) +## *class* [**BaseTranslator**](../../../../translatepy/translators/base.py#L115-L1293) The core of translatepy This defines a "Translator" instance, which is the gateway between the translator logic and translatepy @@ -68,9 +48,7 @@ This defines a "Translator" instance, which is the gateway between the translato - `exceptions.UnsupportedMethod` -### *func* BaseTranslator.**translate** - -> [Source: ../../../../translatepy/translators/base.py @ line 307-324](../../../../translatepy/translators/base.py#L307-L324) +### *func* [BaseTranslator.**translate**](../../../../translatepy/translators/base.py#L307-L324) Translates the given `text` into the given `dest_lang` @@ -102,9 +80,7 @@ Translates the given `text` into the given `dest_lang` - `models.TranslationResult` -### *func* BaseTranslator.**translate** - -> [Source: ../../../../translatepy/translators/base.py @ line 327-346](../../../../translatepy/translators/base.py#L327-L346) +### *func* [BaseTranslator.**translate**](../../../../translatepy/translators/base.py#L327-L346) Translates all of the elements in `text` into the given `dest_lang` @@ -139,9 +115,7 @@ Translates all of the elements in `text` into the given `dest_lang` > **Note** > aka "Bulk Translation" -### *func* BaseTranslator.**translate** - -> [Source: ../../../../translatepy/translators/base.py @ line 351-393](../../../../translatepy/translators/base.py#L351-L393) +### *func* [BaseTranslator.**translate**](../../../../translatepy/translators/base.py#L351-L393) Translates `text` into the given `dest_lang` @@ -172,9 +146,7 @@ Translates `text` into the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../translatepy/translators/base.py @ line 420-451](../../../../translatepy/translators/base.py#L420-L451) +### *func* [BaseTranslator.**translate_html**](../../../../translatepy/translators/base.py#L420-L451) Translates the given `html` into the given `dest_lang` @@ -222,9 +194,7 @@ If `False`, the node will be left as is and the `result` part will be `None` - `models.HTMLTranslationResult` -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../translatepy/translators/base.py @ line 454-486](../../../../translatepy/translators/base.py#L454-L486) +### *func* [BaseTranslator.**translate_html**](../../../../translatepy/translators/base.py#L454-L486) Translates all of the elements in `html` into the given `dest_lang` @@ -275,9 +245,7 @@ If `False`, the node will be left as is and the `result` part will be `None` > **Note** > aka "Bulk Translation" -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../translatepy/translators/base.py @ line 489-565](../../../../translatepy/translators/base.py#L489-L565) +### *func* [BaseTranslator.**translate_html**](../../../../translatepy/translators/base.py#L489-L565) Translates `html` into the given `dest_lang` @@ -324,9 +292,7 @@ Translates `html` into the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../translatepy/translators/base.py @ line 573-586](../../../../translatepy/translators/base.py#L573-L586) +### *func* [BaseTranslator.**alternatives**](../../../../translatepy/translators/base.py#L573-L586) Returns the different alternative translations available for a given previous translation. @@ -349,9 +315,7 @@ Returns the different alternative translations available for a given previous tr - `list[TranslationResult]` - The list of other translations a word might have -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../translatepy/translators/base.py @ line 589-602](../../../../translatepy/translators/base.py#L589-L602) +### *func* [BaseTranslator.**alternatives**](../../../../translatepy/translators/base.py#L589-L602) Returns the different alternative translations available for all of the given translations. @@ -374,9 +338,7 @@ Returns the different alternative translations available for all of the given tr - `LazyIterable[list[TranslationResult]]` - All of the other translations -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../translatepy/translators/base.py @ line 606-632](../../../../translatepy/translators/base.py#L606-L632) +### *func* [BaseTranslator.**alternatives**](../../../../translatepy/translators/base.py#L606-L632) Returns the different alternative translations available for the given `translation`. @@ -400,9 +362,7 @@ Returns the different alternative translations available for the given `translat > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../translatepy/translators/base.py @ line 664-681](../../../../translatepy/translators/base.py#L664-L681) +### *func* [BaseTranslator.**transliterate**](../../../../translatepy/translators/base.py#L664-L681) Transliterates the given `text` into the given `dest_lang` @@ -434,9 +394,7 @@ Transliterates the given `text` into the given `dest_lang` - `models.TransliterationResult` -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../translatepy/translators/base.py @ line 684-701](../../../../translatepy/translators/base.py#L684-L701) +### *func* [BaseTranslator.**transliterate**](../../../../translatepy/translators/base.py#L684-L701) Transliterates all of the given `text` to the given `dest_lang` @@ -468,9 +426,7 @@ Transliterates all of the given `text` to the given `dest_lang` - `LazyIterable[TransliterationResult]` - An iterable which contains the transliterations -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../translatepy/translators/base.py @ line 704-750](../../../../translatepy/translators/base.py#L704-L750) +### *func* [BaseTranslator.**transliterate**](../../../../translatepy/translators/base.py#L704-L750) Transliterates the given `text` to the given `dest_lang` @@ -501,13 +457,9 @@ Transliterates the given `text` to the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *attr* BaseTranslator.**transliteration** - -> [Source: ../../../../translatepy/translators/base.py @ line 753](../../../../translatepy/translators/base.py#L753) +### *attr* [BaseTranslator.**transliteration**](../../../../translatepy/translators/base.py#L753) -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../translatepy/translators/base.py @ line 781-798](../../../../translatepy/translators/base.py#L781-L798) +### *func* [BaseTranslator.**spellcheck**](../../../../translatepy/translators/base.py#L781-L798) Checks for spelling mistakes in the given `text` @@ -540,9 +492,7 @@ Checks for spelling mistakes in the given `text` - `SpellcheckResult` - The result of the spell check -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../translatepy/translators/base.py @ line 801-818](../../../../translatepy/translators/base.py#L801-L818) +### *func* [BaseTranslator.**spellcheck**](../../../../translatepy/translators/base.py#L801-L818) Checks for spelling mistakes in all of the given `text` @@ -573,9 +523,7 @@ Checks for spelling mistakes in all of the given `text` - `LazyIterable[SpellcheckResult]` - The results of the spell checks -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../translatepy/translators/base.py @ line 822-853](../../../../translatepy/translators/base.py#L822-L853) +### *func* [BaseTranslator.**spellcheck**](../../../../translatepy/translators/base.py#L822-L853) Checks for spelling mistakes in the given `text` @@ -605,9 +553,7 @@ Checks for spelling mistakes in the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**language** - -> [Source: ../../../../translatepy/translators/base.py @ line 881-894](../../../../translatepy/translators/base.py#L881-L894) +### *func* [BaseTranslator.**language**](../../../../translatepy/translators/base.py#L881-L894) Returns the detected language for the given `text` @@ -630,9 +576,7 @@ Returns the detected language for the given `text` - `models.LanguageResult` -### *func* BaseTranslator.**language** - -> [Source: ../../../../translatepy/translators/base.py @ line 897-910](../../../../translatepy/translators/base.py#L897-L910) +### *func* [BaseTranslator.**language**](../../../../translatepy/translators/base.py#L897-L910) Returns the detected language for all of the given `text` @@ -655,9 +599,7 @@ Returns the detected language for all of the given `text` - `LazyIterable[LanguageResult]` - The results of the language detections -### *func* BaseTranslator.**language** - -> [Source: ../../../../translatepy/translators/base.py @ line 914-936](../../../../translatepy/translators/base.py#L914-L936) +### *func* [BaseTranslator.**language**](../../../../translatepy/translators/base.py#L914-L936) Returns the detected language for the given `text` @@ -685,9 +627,7 @@ Returns the detected language for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**example** - -> [Source: ../../../../translatepy/translators/base.py @ line 960-975](../../../../translatepy/translators/base.py#L960-L975) +### *func* [BaseTranslator.**example**](../../../../translatepy/translators/base.py#L960-L975) Returns use cases for the given `text` @@ -715,9 +655,7 @@ Returns use cases for the given `text` - `list[ExampleResult]` - The examples -### *func* BaseTranslator.**example** - -> [Source: ../../../../translatepy/translators/base.py @ line 978-993](../../../../translatepy/translators/base.py#L978-L993) +### *func* [BaseTranslator.**example**](../../../../translatepy/translators/base.py#L978-L993) Returns use cases for all of the given `text` @@ -745,9 +683,7 @@ Returns use cases for all of the given `text` - `LazyIterable[list[ExampleResult]]` - All of the examples -### *func* BaseTranslator.**example** - -> [Source: ../../../../translatepy/translators/base.py @ line 997-1031](../../../../translatepy/translators/base.py#L997-L1031) +### *func* [BaseTranslator.**example**](../../../../translatepy/translators/base.py#L997-L1031) Returns use cases for the given `text` @@ -775,9 +711,7 @@ Returns use cases for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../translatepy/translators/base.py @ line 1060-1077](../../../../translatepy/translators/base.py#L1060-L1077) +### *func* [BaseTranslator.**dictionary**](../../../../translatepy/translators/base.py#L1060-L1077) Returns the meaning for the given `text` @@ -808,9 +742,7 @@ Returns the meaning for the given `text` - `list` -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../translatepy/translators/base.py @ line 1080-1097](../../../../translatepy/translators/base.py#L1080-L1097) +### *func* [BaseTranslator.**dictionary**](../../../../translatepy/translators/base.py#L1080-L1097) Returns the meaning for all of the given `text` @@ -841,9 +773,7 @@ Returns the meaning for all of the given `text` - `LazyIterable[RichDictionaryResult]` - If supported, a value which contains much more information on all of the `text` -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../translatepy/translators/base.py @ line 1101-1135](../../../../translatepy/translators/base.py#L1101-L1135) +### *func* [BaseTranslator.**dictionary**](../../../../translatepy/translators/base.py#L1101-L1135) Returns the meaning for the given `text` @@ -871,9 +801,7 @@ Returns the meaning for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../translatepy/translators/base.py @ line 1161-1180](../../../../translatepy/translators/base.py#L1161-L1180) +### *func* [BaseTranslator.**text_to_speech**](../../../../translatepy/translators/base.py#L1161-L1180) Returns the speech version of the given `text` @@ -900,9 +828,7 @@ Returns the speech version of the given `text` - `TextToSpeechResult` - The text to speech result -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../translatepy/translators/base.py @ line 1183-1202](../../../../translatepy/translators/base.py#L1183-L1202) +### *func* [BaseTranslator.**text_to_speech**](../../../../translatepy/translators/base.py#L1183-L1202) Returns the speech version for all of the given `text` @@ -929,18 +855,14 @@ Returns the speech version for all of the given `text` - `LazyIterable[TextToSpeechResult]` - The text to speech results -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../translatepy/translators/base.py @ line 1205-1241](../../../../translatepy/translators/base.py#L1205-L1241) +### *func* [BaseTranslator.**text_to_speech**](../../../../translatepy/translators/base.py#L1205-L1241) Returns the speech version of the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**clean_cache** - -> [Source: ../../../../translatepy/translators/base.py @ line 1265-1274](../../../../translatepy/translators/base.py#L1265-L1274) +### *func* [BaseTranslator.**clean_cache**](../../../../translatepy/translators/base.py#L1265-L1274) Cleans caches diff --git a/docs/jpn/reference/translators/base_aggregator.md b/docs/jpn/reference/translators/base_aggregator.md index ae39c56..556e05d 100644 --- a/docs/jpn/reference/translators/base_aggregator.md +++ b/docs/jpn/reference/translators/base_aggregator.md @@ -1,14 +1,12 @@ # *module* **base_aggregator** -> [Source: ../../../../translatepy/translators/base_aggregator.py @ line 0](../../../../translatepy/translators/base_aggregator.py#L0) +> [Source: ../../../../translatepy/translators/base_aggregator.py](../../../../translatepy/translators/base_aggregator.py#L0) ## Imports - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslator`, `C` -## *class* **BaseTranslatorAggregator** - -> [Source: ../../../../translatepy/translators/base_aggregator.py @ line 9-145](../../../../translatepy/translators/base_aggregator.py#L9-L145) +## *class* [**BaseTranslatorAggregator**](../../../../translatepy/translators/base_aggregator.py#L9-L145) ### Raises diff --git a/docs/jpn/reference/translators/bing.md b/docs/jpn/reference/translators/bing.md index 3edc83c..bb47dee 100644 --- a/docs/jpn/reference/translators/bing.md +++ b/docs/jpn/reference/translators/bing.md @@ -1,6 +1,6 @@ # *module* **Bing** -> [Source: ../../../../translatepy/translators/Bing.py @ line 0](../../../../translatepy/translators/Bing.py#L0) +> [Source: ../../../../translatepy/translators/Bing.py](../../../../translatepy/translators/Bing.py#L0) This implementation was made specifically for translatepy from 'Zhymabek Roman', based on 'Anime no Sekai' version. @@ -8,59 +8,39 @@ This implementation was made specifically for translatepy from 'Zhymabek Roman', - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator` -## *class* **BingTranslateException** +## *class* [**BingTranslateException**](../../../../translatepy/translators/Bing.py#L20-L23) -> [Source: ../../../../translatepy/translators/Bing.py @ line 20-23](../../../../translatepy/translators/Bing.py#L20-L23) +### *attr* [BingTranslateException.**error_codes**](../../../../translatepy/translators/Bing.py#L21) -### *attr* BingTranslateException.**error_codes** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 21](../../../../translatepy/translators/Bing.py#L21) - -## *class* **BingSessionData** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 26-33](../../../../translatepy/translators/Bing.py#L26-L33) +## *class* [**BingSessionData**](../../../../translatepy/translators/Bing.py#L26-L33) Bing session data holder -### *attr* BingSessionData.**ig** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 28](../../../../translatepy/translators/Bing.py#L28) +### *attr* [BingSessionData.**ig**](../../../../translatepy/translators/Bing.py#L28) > Type: `str` -### *attr* BingSessionData.**iid** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 29](../../../../translatepy/translators/Bing.py#L29) +### *attr* [BingSessionData.**iid**](../../../../translatepy/translators/Bing.py#L29) > Type: `str` -### *attr* BingSessionData.**key** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 30](../../../../translatepy/translators/Bing.py#L30) +### *attr* [BingSessionData.**key**](../../../../translatepy/translators/Bing.py#L30) > Type: `cain.types.UInt64` -### *attr* BingSessionData.**token** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 31](../../../../translatepy/translators/Bing.py#L31) +### *attr* [BingSessionData.**token**](../../../../translatepy/translators/Bing.py#L31) > Type: `str` -### *attr* BingSessionData.**cookies_keys** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 32](../../../../translatepy/translators/Bing.py#L32) +### *attr* [BingSessionData.**cookies_keys**](../../../../translatepy/translators/Bing.py#L32) > Type: `List` -### *attr* BingSessionData.**cookies_values** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 33](../../../../translatepy/translators/Bing.py#L33) +### *attr* [BingSessionData.**cookies_values**](../../../../translatepy/translators/Bing.py#L33) > Type: `List` -## *class* **BingSessionManager** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 36-136](../../../../translatepy/translators/Bing.py#L36-L136) +## *class* [**BingSessionManager**](../../../../translatepy/translators/Bing.py#L36-L136) Creates and manages a Bing session @@ -68,9 +48,7 @@ Creates and manages a Bing session - `BingTranslateException` -### *func* BingSessionManager.**send** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 92-136](../../../../translatepy/translators/Bing.py#L92-L136) +### *func* [BingSessionManager.**send**](../../../../translatepy/translators/Bing.py#L92-L136) Sends requestts to the API @@ -86,9 +64,7 @@ Sends requestts to the API - `BingTranslateException` -## *class* **BingTranslate** - -> [Source: ../../../../translatepy/translators/Bing.py @ line 145-251](../../../../translatepy/translators/Bing.py#L145-L251) +## *class* [**BingTranslate**](../../../../translatepy/translators/Bing.py#L145-L251) A Python implementation of Microsoft Bing Translation's APIs diff --git a/docs/jpn/reference/translators/deepl.md b/docs/jpn/reference/translators/deepl.md index 2ef0e8e..f663f89 100644 --- a/docs/jpn/reference/translators/deepl.md +++ b/docs/jpn/reference/translators/deepl.md @@ -1,6 +1,6 @@ # *module* **DeepL** -> [Source: ../../../../translatepy/translators/DeepL.py @ line 0](../../../../translatepy/translators/DeepL.py#L0) +> [Source: ../../../../translatepy/translators/DeepL.py](../../../../translatepy/translators/DeepL.py#L0) DeepL Implementation for translatepy @@ -19,53 +19,33 @@ Refer to Animenosekai/translate#7 Arrangements, optimizations - **ZhymabekRoman** Co-Author -## *const* **SENTENCES_SPLITTING_REGEX** +## *const* [**SENTENCES_SPLITTING_REGEX**](../../../../translatepy/translators/DeepL.py#L31) -> [Source: ../../../../translatepy/translators/DeepL.py @ line 31](../../../../translatepy/translators/DeepL.py#L31) +## *class* [**DeeplFormality**](../../../../translatepy/translators/DeepL.py#L34-L36) -## *class* **DeeplFormality** +### *attr* [DeeplFormality.**formal**](../../../../translatepy/translators/DeepL.py#L35) -> [Source: ../../../../translatepy/translators/DeepL.py @ line 34-36](../../../../translatepy/translators/DeepL.py#L34-L36) +### *attr* [DeeplFormality.**informal**](../../../../translatepy/translators/DeepL.py#L36) -### *attr* DeeplFormality.**formal** +## *class* [**DeeplTranslate**](../../../../translatepy/translators/DeepL.py#L39-L41) -> [Source: ../../../../translatepy/translators/DeepL.py @ line 35](../../../../translatepy/translators/DeepL.py#L35) - -### *attr* DeeplFormality.**informal** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 36](../../../../translatepy/translators/DeepL.py#L36) - -## *class* **DeeplTranslate** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 39-41](../../../../translatepy/translators/DeepL.py#L39-L41) - -## *class* **DeeplTranslateException** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 44-51](../../../../translatepy/translators/DeepL.py#L44-L51) +## *class* [**DeeplTranslateException**](../../../../translatepy/translators/DeepL.py#L44-L51) Default DeepL Translate exception -### *attr* DeeplTranslateException.**error_codes** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 49](../../../../translatepy/translators/DeepL.py#L49) - -## *class* **GetClientState** +### *attr* [DeeplTranslateException.**error_codes**](../../../../translatepy/translators/DeepL.py#L49) -> [Source: ../../../../translatepy/translators/DeepL.py @ line 54-82](../../../../translatepy/translators/DeepL.py#L54-L82) +## *class* [**GetClientState**](../../../../translatepy/translators/DeepL.py#L54-L82) DeepL Translate state manager -### *func* GetClientState.**dump** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 63-74](../../../../translatepy/translators/DeepL.py#L63-L74) +### *func* [GetClientState.**dump**](../../../../translatepy/translators/DeepL.py#L63-L74) #### Returns - `dict` -### *func* GetClientState.**get** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 76-82](../../../../translatepy/translators/DeepL.py#L76-L82) +### *func* [GetClientState.**get**](../../../../translatepy/translators/DeepL.py#L76-L82) Returns a new Client State ID @@ -73,15 +53,11 @@ Returns a new Client State ID - `int` -## *class* **JSONRPCRequest** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 85-121](../../../../translatepy/translators/DeepL.py#L85-L121) +## *class* [**JSONRPCRequest**](../../../../translatepy/translators/DeepL.py#L85-L121) JSON RPC Request Sender for DeepL -### *func* JSONRPCRequest.**dump** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 99-107](../../../../translatepy/translators/DeepL.py#L99-L107) +### *func* [JSONRPCRequest.**dump**](../../../../translatepy/translators/DeepL.py#L99-L107) #### Parameters @@ -91,9 +67,7 @@ JSON RPC Request Sender for DeepL - **params**: `dict` -### *func* JSONRPCRequest.**send_jsonrpc** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 109-121](../../../../translatepy/translators/DeepL.py#L109-L121) +### *func* [JSONRPCRequest.**send_jsonrpc**](../../../../translatepy/translators/DeepL.py#L109-L121) #### Parameters @@ -107,17 +81,13 @@ JSON RPC Request Sender for DeepL - `dict` -## *class* **DeeplTranslateV1** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 124-308](../../../../translatepy/translators/DeepL.py#L124-L308) +## *class* [**DeeplTranslateV1**](../../../../translatepy/translators/DeepL.py#L124-L308) ### Raises - `exceptions.UnsupportedMethod` -## *class* **DeeplTranslateV2** - -> [Source: ../../../../translatepy/translators/DeepL.py @ line 311-386](../../../../translatepy/translators/DeepL.py#L311-L386) +## *class* [**DeeplTranslateV2**](../../../../translatepy/translators/DeepL.py#L311-L386) ### Raises diff --git a/docs/jpn/reference/translators/google.md b/docs/jpn/reference/translators/google.md index 051b325..f8bdecf 100644 --- a/docs/jpn/reference/translators/google.md +++ b/docs/jpn/reference/translators/google.md @@ -1,6 +1,6 @@ # *module* **Google** -> [Source: ../../../../translatepy/translators/Google.py @ line 0](../../../../translatepy/translators/Google.py#L0) +> [Source: ../../../../translatepy/translators/Google.py](../../../../translatepy/translators/Google.py#L0) Google Translate This both uses the mobile version of Google Translate, extension endpoints and the `batchexecute` (JSONRPC) API @@ -12,17 +12,11 @@ The `batchexecute` implementation is heavily inspired by ssut/py-googletrans#255 - [../../../../translatepy/translators/base_aggregator.py](../../../../translatepy/translators/base_aggregator.py): As `BaseTranslatorAggregator` -## *const* **DOMAINS** +## *const* [**DOMAINS**](../../../../translatepy/translators/Google.py#L21) -> [Source: ../../../../translatepy/translators/Google.py @ line 21](../../../../translatepy/translators/Google.py#L21) +## *const* [**SUPPORTED_LANGUAGES**](../../../../translatepy/translators/Google.py#L58) -## *const* **SUPPORTED_LANGUAGES** - -> [Source: ../../../../translatepy/translators/Google.py @ line 58](../../../../translatepy/translators/Google.py#L58) - -## *class* **GoogleTranslate** - -> [Source: ../../../../translatepy/translators/Google.py @ line 66-81](../../../../translatepy/translators/Google.py#L66-L81) +## *class* [**GoogleTranslate**](../../../../translatepy/translators/Google.py#L66-L81) An aggregation of Google Translate translators @@ -30,9 +24,7 @@ An aggregation of Google Translate translators - `ServiceURLError` -## *class* **GoogleTranslateV1** - -> [Source: ../../../../translatepy/translators/Google.py @ line 84-261](../../../../translatepy/translators/Google.py#L84-L261) +## *class* [**GoogleTranslateV1**](../../../../translatepy/translators/Google.py#L84-L261) A Python implementation of Google Translate's JSONRPC API @@ -40,8 +32,6 @@ A Python implementation of Google Translate's JSONRPC API - `ValueError` -## *class* **GoogleTranslateV2** - -> [Source: ../../../../translatepy/translators/Google.py @ line 264-423](../../../../translatepy/translators/Google.py#L264-L423) +## *class* [**GoogleTranslateV2**](../../../../translatepy/translators/Google.py#L264-L423) A Python implementation of Google Translate's APIs diff --git a/docs/jpn/reference/translators/libre.md b/docs/jpn/reference/translators/libre.md index d71e907..2b7ca3d 100644 --- a/docs/jpn/reference/translators/libre.md +++ b/docs/jpn/reference/translators/libre.md @@ -1,6 +1,6 @@ # *module* **Libre** -> [Source: ../../../../translatepy/translators/Libre.py @ line 0](../../../../translatepy/translators/Libre.py#L0) +> [Source: ../../../../translatepy/translators/Libre.py](../../../../translatepy/translators/Libre.py#L0) LibreTranslate translatepy's implementation of LibreTranslate @@ -13,8 +13,6 @@ translatepy's implementation of LibreTranslate - **Animenosekai** Original author -## *class* **LibreTranslate** - -> [Source: ../../../../translatepy/translators/Libre.py @ line 19-43](../../../../translatepy/translators/Libre.py#L19-L43) +## *class* [**LibreTranslate**](../../../../translatepy/translators/Libre.py#L19-L43) translatepy's implementation of LibreTranslate diff --git a/docs/jpn/reference/translators/microsoft.md b/docs/jpn/reference/translators/microsoft.md index 8eaeb3c..9f2e8a6 100644 --- a/docs/jpn/reference/translators/microsoft.md +++ b/docs/jpn/reference/translators/microsoft.md @@ -1,6 +1,6 @@ # *module* **Microsoft** -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 0](../../../../translatepy/translators/Microsoft.py#L0) +> [Source: ../../../../translatepy/translators/Microsoft.py](../../../../translatepy/translators/Microsoft.py#L0) This implementation was made specifically for translatepy by 'Zhymabek Roman'. @@ -10,27 +10,19 @@ This implementation was made specifically for translatepy by 'Zhymabek Roman'. - [../../../../translatepy/translators/base_aggregator.py](../../../../translatepy/translators/base_aggregator.py): As `BaseTranslatorAggregator` -## *class* **MicrosoftTranslate** - -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 23-32](../../../../translatepy/translators/Microsoft.py#L23-L32) +## *class* [**MicrosoftTranslate**](../../../../translatepy/translators/Microsoft.py#L23-L32) An aggregation of Microsoft Translate translators -## *class* **MicrosoftTranslateV1** - -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 37-141](../../../../translatepy/translators/Microsoft.py#L37-L141) +## *class* [**MicrosoftTranslateV1**](../../../../translatepy/translators/Microsoft.py#L37-L141) A Python implementation of Microsoft Translation, reverse engenered from Microsoft Translator Android application. Ported from https://github.com/d4n3436/GTranslate/blob/master/src/GTranslate/Translators/MicrosoftTranslator.cs Huge thanks to d4n3436. -## *class* **MicrosoftTranslateV2** - -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 144-187](../../../../translatepy/translators/Microsoft.py#L144-L187) +## *class* [**MicrosoftTranslateV2**](../../../../translatepy/translators/Microsoft.py#L144-L187) A Python implementation of Microsoft Translation, reverse engenered from Microsoft SwiftKey by ZhymabekRoman Also I found '/v1/languages?scope=translation' endpoint, idk maybe it can be useful -## *class* **MicrosoftTranslateV3** - -> [Source: ../../../../translatepy/translators/Microsoft.py @ line 189-254](../../../../translatepy/translators/Microsoft.py#L189-L254) +## *class* [**MicrosoftTranslateV3**](../../../../translatepy/translators/Microsoft.py#L189-L254) diff --git a/docs/jpn/reference/translators/mymemory.md b/docs/jpn/reference/translators/mymemory.md index 79b3754..809328e 100644 --- a/docs/jpn/reference/translators/mymemory.md +++ b/docs/jpn/reference/translators/mymemory.md @@ -1,6 +1,6 @@ # *module* **MyMemory** -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 0](../../../../translatepy/translators/MyMemory.py#L0) +> [Source: ../../../../translatepy/translators/MyMemory.py](../../../../translatepy/translators/MyMemory.py#L0) MyMemory translatepy's implementation of MyMemory @@ -9,17 +9,11 @@ translatepy's implementation of MyMemory - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **MyMemoryException** +## *class* [**MyMemoryException**](../../../../translatepy/translators/MyMemory.py#L16-L19) -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 16-19](../../../../translatepy/translators/MyMemory.py#L16-L19) +### *attr* [MyMemoryException.**error_codes**](../../../../translatepy/translators/MyMemory.py#L17) -### *attr* MyMemoryException.**error_codes** - -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 17](../../../../translatepy/translators/MyMemory.py#L17) - -## *class* **MyMemoryTranslate** - -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 22-81](../../../../translatepy/translators/MyMemory.py#L22-L81) +## *class* [**MyMemoryTranslate**](../../../../translatepy/translators/MyMemory.py#L22-L81) translatepy's implementation of MyMemory @@ -27,6 +21,4 @@ translatepy's implementation of MyMemory - `MyMemoryException` -### *attr* MyMemoryTranslate.**base_url** - -> [Source: ../../../../translatepy/translators/MyMemory.py @ line 26](../../../../translatepy/translators/MyMemory.py#L26) +### *attr* [MyMemoryTranslate.**base_url**](../../../../translatepy/translators/MyMemory.py#L26) diff --git a/docs/jpn/reference/translators/papago.md b/docs/jpn/reference/translators/papago.md index 8da7560..37cb3a6 100644 --- a/docs/jpn/reference/translators/papago.md +++ b/docs/jpn/reference/translators/papago.md @@ -1,6 +1,6 @@ # *module* **Papago** -> [Source: ../../../../translatepy/translators/Papago.py @ line 0](../../../../translatepy/translators/Papago.py#L0) +> [Source: ../../../../translatepy/translators/Papago.py](../../../../translatepy/translators/Papago.py#L0) translatepy's implementation of @@ -8,45 +8,29 @@ translatepy's implementation of - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **PapagoException** +## *class* [**PapagoException**](../../../../translatepy/translators/Papago.py#L18-L21) -> [Source: ../../../../translatepy/translators/Papago.py @ line 18-21](../../../../translatepy/translators/Papago.py#L18-L21) +### *attr* [PapagoException.**error_codes**](../../../../translatepy/translators/Papago.py#L19) -### *attr* PapagoException.**error_codes** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 19](../../../../translatepy/translators/Papago.py#L19) - -## *class* **PapagoSessionData** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 27-31](../../../../translatepy/translators/Papago.py#L27-L31) +## *class* [**PapagoSessionData**](../../../../translatepy/translators/Papago.py#L27-L31) Bing session data holder -### *attr* PapagoSessionData.**timestamp** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 29](../../../../translatepy/translators/Papago.py#L29) +### *attr* [PapagoSessionData.**timestamp**](../../../../translatepy/translators/Papago.py#L29) > Type: `cain.types.UInt64` -### *attr* PapagoSessionData.**cookies_keys** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 30](../../../../translatepy/translators/Papago.py#L30) +### *attr* [PapagoSessionData.**cookies_keys**](../../../../translatepy/translators/Papago.py#L30) > Type: `List` -### *attr* PapagoSessionData.**cookies_values** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 31](../../../../translatepy/translators/Papago.py#L31) +### *attr* [PapagoSessionData.**cookies_values**](../../../../translatepy/translators/Papago.py#L31) > Type: `List` -## *const* **SESSION_CACHE_EXPIRATION** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 34](../../../../translatepy/translators/Papago.py#L34) +## *const* [**SESSION_CACHE_EXPIRATION**](../../../../translatepy/translators/Papago.py#L34) -## *class* **Papago** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 37-262](../../../../translatepy/translators/Papago.py#L37-L262) +## *class* [**Papago**](../../../../translatepy/translators/Papago.py#L37-L262) translatepy's implementation of @@ -56,9 +40,7 @@ translatepy's implementation of - `exceptions.UnsupportedLanguage` -### *func* Papago.**generate_headers** - -> [Source: ../../../../translatepy/translators/Papago.py @ line 83-119](../../../../translatepy/translators/Papago.py#L83-L119) +### *func* [Papago.**generate_headers**](../../../../translatepy/translators/Papago.py#L83-L119) Generates the headers for the API diff --git a/docs/jpn/reference/translators/pons.md b/docs/jpn/reference/translators/pons.md index 1e73dab..f3fa69e 100644 --- a/docs/jpn/reference/translators/pons.md +++ b/docs/jpn/reference/translators/pons.md @@ -1,6 +1,6 @@ # *module* **PONS** -> [Source: ../../../../translatepy/translators/PONS.py @ line 0](../../../../translatepy/translators/PONS.py#L0) +> [Source: ../../../../translatepy/translators/PONS.py](../../../../translatepy/translators/PONS.py#L0) translatepy's implementation of @@ -8,16 +8,10 @@ translatepy's implementation of - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **PONSException** +## *class* [**PONSException**](../../../../translatepy/translators/PONS.py#L15-L18) -> [Source: ../../../../translatepy/translators/PONS.py @ line 15-18](../../../../translatepy/translators/PONS.py#L15-L18) +### *attr* [PONSException.**error_codes**](../../../../translatepy/translators/PONS.py#L16) -### *attr* PONSException.**error_codes** - -> [Source: ../../../../translatepy/translators/PONS.py @ line 16](../../../../translatepy/translators/PONS.py#L16) - -## *class* **PONS** - -> [Source: ../../../../translatepy/translators/PONS.py @ line 24-111](../../../../translatepy/translators/PONS.py#L24-L111) +## *class* [**PONS**](../../../../translatepy/translators/PONS.py#L24-L111) translatepy's implementation of diff --git a/docs/jpn/reference/translators/qcri.md b/docs/jpn/reference/translators/qcri.md index 80bc1f8..93bb768 100644 --- a/docs/jpn/reference/translators/qcri.md +++ b/docs/jpn/reference/translators/qcri.md @@ -1,6 +1,6 @@ # *module* **QCRI** -> [Source: ../../../../translatepy/translators/QCRI.py @ line 0](../../../../translatepy/translators/QCRI.py#L0) +> [Source: ../../../../translatepy/translators/QCRI.py](../../../../translatepy/translators/QCRI.py#L0) translatepy's implementation of @@ -8,17 +8,11 @@ translatepy's implementation of - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **QCRIException** +## *class* [**QCRIException**](../../../../translatepy/translators/QCRI.py#L16-L19) -> [Source: ../../../../translatepy/translators/QCRI.py @ line 16-19](../../../../translatepy/translators/QCRI.py#L16-L19) +### *attr* [QCRIException.**error_codes**](../../../../translatepy/translators/QCRI.py#L17) -### *attr* QCRIException.**error_codes** - -> [Source: ../../../../translatepy/translators/QCRI.py @ line 17](../../../../translatepy/translators/QCRI.py#L17) - -## *class* **QCRI** - -> [Source: ../../../../translatepy/translators/QCRI.py @ line 25-87](../../../../translatepy/translators/QCRI.py#L25-L87) +## *class* [**QCRI**](../../../../translatepy/translators/QCRI.py#L25-L87) translatepy's implementation of diff --git a/docs/jpn/reference/translators/reverso.md b/docs/jpn/reference/translators/reverso.md index d375571..a8e6504 100644 --- a/docs/jpn/reference/translators/reverso.md +++ b/docs/jpn/reference/translators/reverso.md @@ -1,6 +1,6 @@ # *module* **Reverso** -> [Source: ../../../../translatepy/translators/Reverso.py @ line 0](../../../../translatepy/translators/Reverso.py#L0) +> [Source: ../../../../translatepy/translators/Reverso.py](../../../../translatepy/translators/Reverso.py#L0) Reverso translatepy's implementation of Reverso @@ -9,9 +9,7 @@ translatepy's implementation of Reverso - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslator`, `C` -## *class* **ReversoTranslate** - -> [Source: ../../../../translatepy/translators/Reverso.py @ line 16-182](../../../../translatepy/translators/Reverso.py#L16-L182) +## *class* [**ReversoTranslate**](../../../../translatepy/translators/Reverso.py#L16-L182) A Python implementation of Reverso's API diff --git a/docs/jpn/reference/translators/translatecom.md b/docs/jpn/reference/translators/translatecom.md index 6d11650..8c51a87 100644 --- a/docs/jpn/reference/translators/translatecom.md +++ b/docs/jpn/reference/translators/translatecom.md @@ -1,21 +1,15 @@ # *module* **TranslateCom** -> [Source: ../../../../translatepy/translators/TranslateCom.py @ line 0](../../../../translatepy/translators/TranslateCom.py#L0) +> [Source: ../../../../translatepy/translators/TranslateCom.py](../../../../translatepy/translators/TranslateCom.py#L0) ## Imports - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslator`, `C` -## *class* **TranslateComTranslate** - -> [Source: ../../../../translatepy/translators/TranslateCom.py @ line 9-44](../../../../translatepy/translators/TranslateCom.py#L9-L44) +## *class* [**TranslateComTranslate**](../../../../translatepy/translators/TranslateCom.py#L9-L44) translatepy's implementation of translate.com -### *attr* TranslateComTranslate.**translate_url** - -> [Source: ../../../../translatepy/translators/TranslateCom.py @ line 14](../../../../translatepy/translators/TranslateCom.py#L14) - -### *attr* TranslateComTranslate.**langdetect_url** +### *attr* [TranslateComTranslate.**translate_url**](../../../../translatepy/translators/TranslateCom.py#L14) -> [Source: ../../../../translatepy/translators/TranslateCom.py @ line 15](../../../../translatepy/translators/TranslateCom.py#L15) +### *attr* [TranslateComTranslate.**langdetect_url**](../../../../translatepy/translators/TranslateCom.py#L15) diff --git a/docs/jpn/reference/translators/yandex.md b/docs/jpn/reference/translators/yandex.md index acf39d7..2a447f1 100644 --- a/docs/jpn/reference/translators/yandex.md +++ b/docs/jpn/reference/translators/yandex.md @@ -1,6 +1,6 @@ # *module* **Yandex** -> [Source: ../../../../translatepy/translators/Yandex.py @ line 0](../../../../translatepy/translators/Yandex.py#L0) +> [Source: ../../../../translatepy/translators/Yandex.py](../../../../translatepy/translators/Yandex.py#L0) Yandex Translate This implementation was made specifically for translatepy from 'Zhymabek Roman', based on 'Anime no Sekai' version. @@ -9,19 +9,13 @@ This implementation was made specifically for translatepy from 'Zhymabek Roman', - [../../../../translatepy/translators/base.py](../../../../translatepy/translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **YandexTranslateException** - -> [Source: ../../../../translatepy/translators/Yandex.py @ line 16-31](../../../../translatepy/translators/Yandex.py#L16-L31) +## *class* [**YandexTranslateException**](../../../../translatepy/translators/Yandex.py#L16-L31) Default Yandex Translate exception -### *attr* YandexTranslateException.**error_codes** - -> [Source: ../../../../translatepy/translators/Yandex.py @ line 21](../../../../translatepy/translators/Yandex.py#L21) - -## *class* **YandexTranslate** +### *attr* [YandexTranslateException.**error_codes**](../../../../translatepy/translators/Yandex.py#L21) -> [Source: ../../../../translatepy/translators/Yandex.py @ line 34-205](../../../../translatepy/translators/Yandex.py#L34-L205) +## *class* [**YandexTranslate**](../../../../translatepy/translators/Yandex.py#L34-L205) Yandex Translation Implementation diff --git a/docs/jpn/reference/utils/audio.md b/docs/jpn/reference/utils/audio.md index 49fd953..2bcf114 100644 --- a/docs/jpn/reference/utils/audio.md +++ b/docs/jpn/reference/utils/audio.md @@ -1,6 +1,6 @@ # *module* **audio** -> [Source: ../../../../translatepy/utils/audio.py @ line 0](../../../../translatepy/utils/audio.py#L0) +> [Source: ../../../../translatepy/utils/audio.py](../../../../translatepy/utils/audio.py#L0) Handles audio file formats for translatepy @@ -9,27 +9,19 @@ Handles audio file formats for translatepy - **h2non, MIT License** Author of `filetype.py` a Python package to infer binary file types checking the magic numbers signature Most of the source code comes from this package -## *class* **Type** - -> [Source: ../../../../translatepy/utils/audio.py @ line 12-22](../../../../translatepy/utils/audio.py#L12-L22) +## *class* [**Type**](../../../../translatepy/utils/audio.py#L12-L22) Represents an audio format -### *attr* Type.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 16](../../../../translatepy/utils/audio.py#L16) +### *attr* [Type.**MIME**](../../../../translatepy/utils/audio.py#L16) > Type: `str` -### *attr* Type.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 17](../../../../translatepy/utils/audio.py#L17) +### *attr* [Type.**EXTENSION**](../../../../translatepy/utils/audio.py#L17) > Type: `str` -### *func* Type.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 20-22](../../../../translatepy/utils/audio.py#L20-L22) +### *func* [Type.**test**](../../../../translatepy/utils/audio.py#L20-L22) Tests if the given file matches the audio format @@ -38,193 +30,127 @@ Tests if the given file matches the audio format - **data**: `bytes` -## *class* **MP3** - -> [Source: ../../../../translatepy/utils/audio.py @ line 25-42](../../../../translatepy/utils/audio.py#L25-L42) +## *class* [**MP3**](../../../../translatepy/utils/audio.py#L25-L42) Implements the MP3 audio type matcher. -### *attr* MP3.**MIME** +### *attr* [MP3.**MIME**](../../../../translatepy/utils/audio.py#L29) -> [Source: ../../../../translatepy/utils/audio.py @ line 29](../../../../translatepy/utils/audio.py#L29) +### *attr* [MP3.**EXTENSION**](../../../../translatepy/utils/audio.py#L30) -### *attr* MP3.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 30](../../../../translatepy/utils/audio.py#L30) - -### *func* MP3.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 33-42](../../../../translatepy/utils/audio.py#L33-L42) +### *func* [MP3.**test**](../../../../translatepy/utils/audio.py#L33-L42) #### Parameters - **data**: `bytes` -## *class* **M4A** - -> [Source: ../../../../translatepy/utils/audio.py @ line 45-64](../../../../translatepy/utils/audio.py#L45-L64) +## *class* [**M4A**](../../../../translatepy/utils/audio.py#L45-L64) Implements the M4A audio type matcher. -### *attr* M4A.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 49](../../../../translatepy/utils/audio.py#L49) +### *attr* [M4A.**MIME**](../../../../translatepy/utils/audio.py#L49) -### *attr* M4A.**EXTENSION** +### *attr* [M4A.**EXTENSION**](../../../../translatepy/utils/audio.py#L50) -> [Source: ../../../../translatepy/utils/audio.py @ line 50](../../../../translatepy/utils/audio.py#L50) - -### *func* M4A.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 53-64](../../../../translatepy/utils/audio.py#L53-L64) +### *func* [M4A.**test**](../../../../translatepy/utils/audio.py#L53-L64) #### Parameters - **data**: `bytes` -## *class* **Ogg** - -> [Source: ../../../../translatepy/utils/audio.py @ line 67-79](../../../../translatepy/utils/audio.py#L67-L79) +## *class* [**Ogg**](../../../../translatepy/utils/audio.py#L67-L79) Implements the OGG audio type matcher. -### *attr* Ogg.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 71](../../../../translatepy/utils/audio.py#L71) - -### *attr* Ogg.**EXTENSION** +### *attr* [Ogg.**MIME**](../../../../translatepy/utils/audio.py#L71) -> [Source: ../../../../translatepy/utils/audio.py @ line 72](../../../../translatepy/utils/audio.py#L72) +### *attr* [Ogg.**EXTENSION**](../../../../translatepy/utils/audio.py#L72) -### *func* Ogg.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 75-79](../../../../translatepy/utils/audio.py#L75-L79) +### *func* [Ogg.**test**](../../../../translatepy/utils/audio.py#L75-L79) #### Parameters - **data**: `bytes` -## *class* **Flac** - -> [Source: ../../../../translatepy/utils/audio.py @ line 82-94](../../../../translatepy/utils/audio.py#L82-L94) +## *class* [**Flac**](../../../../translatepy/utils/audio.py#L82-L94) Implements the FLAC audio type matcher. -### *attr* Flac.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 86](../../../../translatepy/utils/audio.py#L86) - -### *attr* Flac.**EXTENSION** +### *attr* [Flac.**MIME**](../../../../translatepy/utils/audio.py#L86) -> [Source: ../../../../translatepy/utils/audio.py @ line 87](../../../../translatepy/utils/audio.py#L87) +### *attr* [Flac.**EXTENSION**](../../../../translatepy/utils/audio.py#L87) -### *func* Flac.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 90-94](../../../../translatepy/utils/audio.py#L90-L94) +### *func* [Flac.**test**](../../../../translatepy/utils/audio.py#L90-L94) #### Parameters - **data**: `bytes` -## *class* **Wav** - -> [Source: ../../../../translatepy/utils/audio.py @ line 97-113](../../../../translatepy/utils/audio.py#L97-L113) +## *class* [**Wav**](../../../../translatepy/utils/audio.py#L97-L113) Implements the WAV audio type matcher. -### *attr* Wav.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 101](../../../../translatepy/utils/audio.py#L101) - -### *attr* Wav.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 102](../../../../translatepy/utils/audio.py#L102) +### *attr* [Wav.**MIME**](../../../../translatepy/utils/audio.py#L101) -### *func* Wav.**test** +### *attr* [Wav.**EXTENSION**](../../../../translatepy/utils/audio.py#L102) -> [Source: ../../../../translatepy/utils/audio.py @ line 105-113](../../../../translatepy/utils/audio.py#L105-L113) +### *func* [Wav.**test**](../../../../translatepy/utils/audio.py#L105-L113) #### Parameters - **data**: `bytes` -## *class* **Amr** - -> [Source: ../../../../translatepy/utils/audio.py @ line 116-130](../../../../translatepy/utils/audio.py#L116-L130) +## *class* [**Amr**](../../../../translatepy/utils/audio.py#L116-L130) Implements the AMR audio type matcher. -### *attr* Amr.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 120](../../../../translatepy/utils/audio.py#L120) - -### *attr* Amr.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 121](../../../../translatepy/utils/audio.py#L121) +### *attr* [Amr.**MIME**](../../../../translatepy/utils/audio.py#L120) -### *func* Amr.**test** +### *attr* [Amr.**EXTENSION**](../../../../translatepy/utils/audio.py#L121) -> [Source: ../../../../translatepy/utils/audio.py @ line 124-130](../../../../translatepy/utils/audio.py#L124-L130) +### *func* [Amr.**test**](../../../../translatepy/utils/audio.py#L124-L130) #### Parameters - **data**: `bytes` -## *class* **Aac** - -> [Source: ../../../../translatepy/utils/audio.py @ line 133-142](../../../../translatepy/utils/audio.py#L133-L142) +## *class* [**Aac**](../../../../translatepy/utils/audio.py#L133-L142) Implements the Aac audio type matcher. -### *attr* Aac.**MIME** - -> [Source: ../../../../translatepy/utils/audio.py @ line 136](../../../../translatepy/utils/audio.py#L136) - -### *attr* Aac.**EXTENSION** +### *attr* [Aac.**MIME**](../../../../translatepy/utils/audio.py#L136) -> [Source: ../../../../translatepy/utils/audio.py @ line 137](../../../../translatepy/utils/audio.py#L137) +### *attr* [Aac.**EXTENSION**](../../../../translatepy/utils/audio.py#L137) -### *func* Aac.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 140-142](../../../../translatepy/utils/audio.py#L140-L142) +### *func* [Aac.**test**](../../../../translatepy/utils/audio.py#L140-L142) #### Parameters - **data**: `bytes` -## *class* **Aiff** - -> [Source: ../../../../translatepy/utils/audio.py @ line 145-161](../../../../translatepy/utils/audio.py#L145-L161) +## *class* [**Aiff**](../../../../translatepy/utils/audio.py#L145-L161) Implements the AIFF audio type matcher. -### *attr* Aiff.**MIME** +### *attr* [Aiff.**MIME**](../../../../translatepy/utils/audio.py#L149) -> [Source: ../../../../translatepy/utils/audio.py @ line 149](../../../../translatepy/utils/audio.py#L149) +### *attr* [Aiff.**EXTENSION**](../../../../translatepy/utils/audio.py#L150) -### *attr* Aiff.**EXTENSION** - -> [Source: ../../../../translatepy/utils/audio.py @ line 150](../../../../translatepy/utils/audio.py#L150) - -### *func* Aiff.**test** - -> [Source: ../../../../translatepy/utils/audio.py @ line 153-161](../../../../translatepy/utils/audio.py#L153-L161) +### *func* [Aiff.**test**](../../../../translatepy/utils/audio.py#L153-L161) #### Parameters - **data**: `bytes` -## *func* **get_type** - -> [Source: ../../../../translatepy/utils/audio.py @ line 164-181](../../../../translatepy/utils/audio.py#L164-L181) +## *func* [**get_type**](../../../../translatepy/utils/audio.py#L164-L181) Returns the audio format of the given buffer diff --git a/docs/jpn/reference/utils/gtoken.md b/docs/jpn/reference/utils/gtoken.md index 0880fe6..828e745 100644 --- a/docs/jpn/reference/utils/gtoken.md +++ b/docs/jpn/reference/utils/gtoken.md @@ -1,6 +1,6 @@ # *module* **gtoken** -> [Source: ../../../../translatepy/utils/gtoken.py @ line 0](../../../../translatepy/utils/gtoken.py#L0) +> [Source: ../../../../translatepy/utils/gtoken.py](../../../../translatepy/utils/gtoken.py#L0) ORIGINAL FILENAME: gtoken.py @@ -33,13 +33,9 @@ LICENSE: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -## *const* **HEADERS** +## *const* [**HEADERS**](../../../../translatepy/utils/gtoken.py#L45) -> [Source: ../../../../translatepy/utils/gtoken.py @ line 45](../../../../translatepy/utils/gtoken.py#L45) - -## *class* **TokenAcquirer** - -> [Source: ../../../../translatepy/utils/gtoken.py @ line 56-244](../../../../translatepy/utils/gtoken.py#L56-L244) +## *class* [**TokenAcquirer**](../../../../translatepy/utils/gtoken.py#L56-L244) Google Translate API token generator translate.google.com uses a token to authorize the requests. If you are @@ -65,26 +61,18 @@ Example usage: - `Exception` -### *attr* TokenAcquirer.**RE_TKK** - -> [Source: ../../../../translatepy/utils/gtoken.py @ line 82](../../../../translatepy/utils/gtoken.py#L82) +### *attr* [TokenAcquirer.**RE_TKK**](../../../../translatepy/utils/gtoken.py#L82) -### *attr* TokenAcquirer.**RE_RAWTKK** +### *attr* [TokenAcquirer.**RE_RAWTKK**](../../../../translatepy/utils/gtoken.py#L83) -> [Source: ../../../../translatepy/utils/gtoken.py @ line 83](../../../../translatepy/utils/gtoken.py#L83) - -### *func* TokenAcquirer.**acquire** - -> [Source: ../../../../translatepy/utils/gtoken.py @ line 185-239](../../../../translatepy/utils/gtoken.py#L185-L239) +### *func* [TokenAcquirer.**acquire**](../../../../translatepy/utils/gtoken.py#L185-L239) #### Parameters - **text** -### *func* TokenAcquirer.**do** - -> [Source: ../../../../translatepy/utils/gtoken.py @ line 241-244](../../../../translatepy/utils/gtoken.py#L241-L244) +### *func* [TokenAcquirer.**do**](../../../../translatepy/utils/gtoken.py#L241-L244) #### Parameters diff --git a/docs/jpn/reference/utils/hasher.md b/docs/jpn/reference/utils/hasher.md index 948a25b..4f1a190 100644 --- a/docs/jpn/reference/utils/hasher.md +++ b/docs/jpn/reference/utils/hasher.md @@ -1,13 +1,11 @@ # *module* **hasher** -> [Source: ../../../../translatepy/utils/hasher.py @ line 0](../../../../translatepy/utils/hasher.py#L0) +> [Source: ../../../../translatepy/utils/hasher.py](../../../../translatepy/utils/hasher.py#L0) utils/hasher.py Utility to hash different kind of objects -## *func* **sha256** - -> [Source: ../../../../translatepy/utils/hasher.py @ line 11-28](../../../../translatepy/utils/hasher.py#L11-L28) +## *func* [**sha256**](../../../../translatepy/utils/hasher.py#L11-L28) Hashes the given content using SHA-256 and returns its hexadecimal version @@ -22,9 +20,7 @@ Hashes the given content using SHA-256 and returns its hexadecimal version - `str` - The SHA-256 hash -## *func* **hash_object** - -> [Source: ../../../../translatepy/utils/hasher.py @ line 31-48](../../../../translatepy/utils/hasher.py#L31-L48) +## *func* [**hash_object**](../../../../translatepy/utils/hasher.py#L31-L48) Hashes a given object @@ -38,9 +34,7 @@ Hashes a given object - `str` - The hash of the object -## *func* **hash_request** - -> [Source: ../../../../translatepy/utils/hasher.py @ line 51-82](../../../../translatepy/utils/hasher.py#L51-L82) +## *func* [**hash_request**](../../../../translatepy/utils/hasher.py#L51-L82) Hashes the given request. diff --git a/docs/jpn/reference/utils/importer.md b/docs/jpn/reference/utils/importer.md index f82aabb..ce063e0 100644 --- a/docs/jpn/reference/utils/importer.md +++ b/docs/jpn/reference/utils/importer.md @@ -1,6 +1,6 @@ # *module* **importer** -> [Source: ../../../../translatepy/utils/importer.py @ line 0](../../../../translatepy/utils/importer.py#L0) +> [Source: ../../../../translatepy/utils/importer.py](../../../../translatepy/utils/importer.py#L0) importer.py A module to allow for dynamic importing of translators. @@ -11,25 +11,15 @@ A module to allow for dynamic importing of translators. - [../../../../translatepy/utils/vectorize.py](../../../../translatepy/utils/vectorize.py): As `vectorize` -## *const* **IMPORTER_CACHE** +## *const* [**IMPORTER_CACHE**](../../../../translatepy/utils/importer.py#L18) -> [Source: ../../../../translatepy/utils/importer.py @ line 18](../../../../translatepy/utils/importer.py#L18) +## *const* [**IMPORTER_DATA_DIR**](../../../../translatepy/utils/importer.py#L20) -## *const* **IMPORTER_DATA_DIR** +## *const* [**IMPORTER_DATA_FILE**](../../../../translatepy/utils/importer.py#L21) -> [Source: ../../../../translatepy/utils/importer.py @ line 20](../../../../translatepy/utils/importer.py#L20) +## *const* [**NAMED_TRANSLATORS**](../../../../translatepy/utils/importer.py#L27) -## *const* **IMPORTER_DATA_FILE** - -> [Source: ../../../../translatepy/utils/importer.py @ line 21](../../../../translatepy/utils/importer.py#L21) - -## *const* **NAMED_TRANSLATORS** - -> [Source: ../../../../translatepy/utils/importer.py @ line 27](../../../../translatepy/utils/importer.py#L27) - -## *func* **translator_from_name** - -> [Source: ../../../../translatepy/utils/importer.py @ line 37-42](../../../../translatepy/utils/importer.py#L37-L42) +## *func* [**translator_from_name**](../../../../translatepy/utils/importer.py#L37-L42) Retrieves the given translate from its name @@ -46,9 +36,7 @@ Retrieves the given translate from its name - `ValueError` -## *func* **translator_from_path** - -> [Source: ../../../../translatepy/utils/importer.py @ line 45-55](../../../../translatepy/utils/importer.py#L45-L55) +## *func* [**translator_from_path**](../../../../translatepy/utils/importer.py#L45-L55) Returns a translator from its dot path @@ -69,9 +57,7 @@ Returns a translator from its dot path - `ImportError` -## *func* **get_translator** - -> [Source: ../../../../translatepy/utils/importer.py @ line 58-94](../../../../translatepy/utils/importer.py#L58-L94) +## *func* [**get_translator**](../../../../translatepy/utils/importer.py#L58-L94) Searches the given translator diff --git a/docs/jpn/reference/utils/lru.md b/docs/jpn/reference/utils/lru.md index 8e9d53a..b9670f8 100644 --- a/docs/jpn/reference/utils/lru.md +++ b/docs/jpn/reference/utils/lru.md @@ -1,31 +1,21 @@ # *module* **lru** -> [Source: ../../../../translatepy/utils/lru.py @ line 0](../../../../translatepy/utils/lru.py#L0) +> [Source: ../../../../translatepy/utils/lru.py](../../../../translatepy/utils/lru.py#L0) lru.py LRU cache implementation for the translatepy project. -## *const* **logger** +## *const* [**logger**](../../../../translatepy/utils/lru.py#L16) -> [Source: ../../../../translatepy/utils/lru.py @ line 16](../../../../translatepy/utils/lru.py#L16) +## *class* [**LRUDictCache**](../../../../translatepy/utils/lru.py#L19-L38) -## *class* **LRUDictCache** +### *func* [LRUDictCache.**clear**](../../../../translatepy/utils/lru.py#L37-L38) -> [Source: ../../../../translatepy/utils/lru.py @ line 19-38](../../../../translatepy/utils/lru.py#L19-L38) - -### *func* LRUDictCache.**clear** - -> [Source: ../../../../translatepy/utils/lru.py @ line 37-38](../../../../translatepy/utils/lru.py#L37-L38) - -## *class* **SizeLimitedLRUCache** - -> [Source: ../../../../translatepy/utils/lru.py @ line 41-173](../../../../translatepy/utils/lru.py#L41-L173) +## *class* [**SizeLimitedLRUCache**](../../../../translatepy/utils/lru.py#L41-L173) Special implementation of a size limited LRU cache. -### *func* SizeLimitedLRUCache.**get_size** - -> [Source: ../../../../translatepy/utils/lru.py @ line 135-170](../../../../translatepy/utils/lru.py#L135-L170) +### *func* [SizeLimitedLRUCache.**get_size**](../../../../translatepy/utils/lru.py#L135-L170) Get the size of an object. @@ -50,13 +40,9 @@ This function is faster than the custom implementation but might yield inaccurat > The second implementation of this function is based on the following article: https://towardsdatascience.com/the-strange-size-of-python-objects-in-memory-ce87bdfbb97f -### *func* SizeLimitedLRUCache.**clear** - -> [Source: ../../../../translatepy/utils/lru.py @ line 172-173](../../../../translatepy/utils/lru.py#L172-L173) - -## *func* **timed_lru_cache** +### *func* [SizeLimitedLRUCache.**clear**](../../../../translatepy/utils/lru.py#L172-L173) -> [Source: ../../../../translatepy/utils/lru.py @ line 176-198](../../../../translatepy/utils/lru.py#L176-L198) +## *func* [**timed_lru_cache**](../../../../translatepy/utils/lru.py#L176-L198) ### Parameters diff --git a/docs/jpn/reference/utils/queue.md b/docs/jpn/reference/utils/queue.md index 848870b..6555cee 100644 --- a/docs/jpn/reference/utils/queue.md +++ b/docs/jpn/reference/utils/queue.md @@ -1,18 +1,14 @@ # *module* **queue** -> [Source: ../../../../translatepy/utils/queue.py @ line 0](../../../../translatepy/utils/queue.py#L0) +> [Source: ../../../../translatepy/utils/queue.py](../../../../translatepy/utils/queue.py#L0) -## *class* **Queue** - -> [Source: ../../../../translatepy/utils/queue.py @ line 6-32](../../../../translatepy/utils/queue.py#L6-L32) +## *class* [**Queue**](../../../../translatepy/utils/queue.py#L6-L32) ### Raises - `ValueError` -### *func* Queue.**get** - -> [Source: ../../../../translatepy/utils/queue.py @ line 16-32](../../../../translatepy/utils/queue.py#L16-L32) +### *func* [Queue.**get**](../../../../translatepy/utils/queue.py#L16-L32) Remove and return an item from the queue. It waits for a value or the termination of all threads diff --git a/docs/jpn/reference/utils/request.md b/docs/jpn/reference/utils/request.md index c4faed9..fad2227 100644 --- a/docs/jpn/reference/utils/request.md +++ b/docs/jpn/reference/utils/request.md @@ -1,6 +1,6 @@ # *module* **request** -> [Source: ../../../../translatepy/utils/request.py @ line 0](../../../../translatepy/utils/request.py#L0) +> [Source: ../../../../translatepy/utils/request.py](../../../../translatepy/utils/request.py#L0) utils/request Extending python requests functionalities with translatepy's own implementation of proxies, caching, exceptions, etc. @@ -13,29 +13,19 @@ Extending python requests functionalities with translatepy's own implementation - **Animenosekai** Original author -## *const* **RequestHash** +## *const* [**RequestHash**](../../../../translatepy/utils/request.py#L24) -> [Source: ../../../../translatepy/utils/request.py @ line 24](../../../../translatepy/utils/request.py#L24) +## *const* [**RateLimitLock**](../../../../translatepy/utils/request.py#L27) -## *const* **RateLimitLock** +## *const* [**CacheLock**](../../../../translatepy/utils/request.py#L28) -> [Source: ../../../../translatepy/utils/request.py @ line 27](../../../../translatepy/utils/request.py#L27) - -## *const* **CacheLock** - -> [Source: ../../../../translatepy/utils/request.py @ line 28](../../../../translatepy/utils/request.py#L28) - -## *class* **Session** - -> [Source: ../../../../translatepy/utils/request.py @ line 32-225](../../../../translatepy/utils/request.py#L32-L225) +## *class* [**Session**](../../../../translatepy/utils/request.py#L32-L225) ### Raises - `exceptions.RateLimitPrevention` -### *func* Session.**set_http_proxy** - -> [Source: ../../../../translatepy/utils/request.py @ line 52-64](../../../../translatepy/utils/request.py#L52-L64) +### *func* [Session.**set_http_proxy**](../../../../translatepy/utils/request.py#L52-L64) Sets the HTTP proxy to use. @@ -45,9 +35,7 @@ Sets the HTTP proxy to use. - The HTTP proxy to use. -### *func* Session.**add_http_proxy** - -> [Source: ../../../../translatepy/utils/request.py @ line 66-75](../../../../translatepy/utils/request.py#L66-L75) +### *func* [Session.**add_http_proxy**](../../../../translatepy/utils/request.py#L66-L75) Adds a HTTP proxy to the list of proxies to use. @@ -57,9 +45,7 @@ Adds a HTTP proxy to the list of proxies to use. - The HTTP proxy to add. -### *func* Session.**request** - -> [Source: ../../../../translatepy/utils/request.py @ line 77-215](../../../../translatepy/utils/request.py#L77-L215) +### *func* [Session.**request**](../../../../translatepy/utils/request.py#L77-L215) Make an HTTP request with the provided method. @@ -203,9 +189,7 @@ If None, the default_cache_duration attribute will be used. ``` -### *func* Session.**invalidate** - -> [Source: ../../../../translatepy/utils/request.py @ line 217-225](../../../../translatepy/utils/request.py#L217-L225) +### *func* [Session.**invalidate**](../../../../translatepy/utils/request.py#L217-L225) Invalidates the given request cache. @@ -214,13 +198,9 @@ Invalidates the given request cache. - **hash**: `RequestHash`, `requesthash` -## *const* **SharedSession** - -> [Source: ../../../../translatepy/utils/request.py @ line 228](../../../../translatepy/utils/request.py#L228) +## *const* [**SharedSession**](../../../../translatepy/utils/request.py#L228) -## *func* **request** - -> [Source: ../../../../translatepy/utils/request.py @ line 231-268](../../../../translatepy/utils/request.py#L231-L268) +## *func* [**request**](../../../../translatepy/utils/request.py#L231-L268) Make an HTTP request. @@ -315,9 +295,7 @@ Make an HTTP request. > **Note** > Look at Session.request for more information. -## *func* **get** - -> [Source: ../../../../translatepy/utils/request.py @ line 271-300](../../../../translatepy/utils/request.py#L271-L300) +## *func* [**get**](../../../../translatepy/utils/request.py#L271-L300) Make a GET request. @@ -405,9 +383,7 @@ Make a GET request. > **Note** > Look at Session.request for more information. -## *func* **post** - -> [Source: ../../../../translatepy/utils/request.py @ line 303-332](../../../../translatepy/utils/request.py#L303-L332) +## *func* [**post**](../../../../translatepy/utils/request.py#L303-L332) Make a POST request. @@ -495,9 +471,7 @@ Make a POST request. > **Note** > Look at Session.request for more information. -## *func* **put** - -> [Source: ../../../../translatepy/utils/request.py @ line 335-364](../../../../translatepy/utils/request.py#L335-L364) +## *func* [**put**](../../../../translatepy/utils/request.py#L335-L364) Make a PUT request. @@ -585,9 +559,7 @@ Make a PUT request. > **Note** > Look at Session.request for more information. -## *func* **patch** - -> [Source: ../../../../translatepy/utils/request.py @ line 367-396](../../../../translatepy/utils/request.py#L367-L396) +## *func* [**patch**](../../../../translatepy/utils/request.py#L367-L396) Make a PATCH request. @@ -675,9 +647,7 @@ Make a PATCH request. > **Note** > Look at Session.request for more information. -## *func* **delete** - -> [Source: ../../../../translatepy/utils/request.py @ line 399-428](../../../../translatepy/utils/request.py#L399-L428) +## *func* [**delete**](../../../../translatepy/utils/request.py#L399-L428) Make a DELETE request. @@ -765,9 +735,7 @@ Make a DELETE request. > **Note** > Look at Session.request for more information. -## *func* **head** - -> [Source: ../../../../translatepy/utils/request.py @ line 431-460](../../../../translatepy/utils/request.py#L431-L460) +## *func* [**head**](../../../../translatepy/utils/request.py#L431-L460) Make a HEAD request. @@ -855,9 +823,7 @@ Make a HEAD request. > **Note** > Look at Session.request for more information. -## *func* **options** - -> [Source: ../../../../translatepy/utils/request.py @ line 463-492](../../../../translatepy/utils/request.py#L463-L492) +## *func* [**options**](../../../../translatepy/utils/request.py#L463-L492) Make an OPTIONS request. diff --git a/docs/jpn/reference/utils/sanitize.md b/docs/jpn/reference/utils/sanitize.md index fc0bf1d..8951b42 100644 --- a/docs/jpn/reference/utils/sanitize.md +++ b/docs/jpn/reference/utils/sanitize.md @@ -1,14 +1,10 @@ # *module* **sanitize** -> [Source: ../../../../translatepy/utils/sanitize.py @ line 0](../../../../translatepy/utils/sanitize.py#L0) +> [Source: ../../../../translatepy/utils/sanitize.py](../../../../translatepy/utils/sanitize.py#L0) -## *const* **WHITESPACES** +## *const* [**WHITESPACES**](../../../../translatepy/utils/sanitize.py#L3) -> [Source: ../../../../translatepy/utils/sanitize.py @ line 3](../../../../translatepy/utils/sanitize.py#L3) - -## *func* **remove_spaces** - -> [Source: ../../../../translatepy/utils/sanitize.py @ line 8-15](../../../../translatepy/utils/sanitize.py#L8-L15) +## *func* [**remove_spaces**](../../../../translatepy/utils/sanitize.py#L8-L15) Removes all whitespaces from the given string diff --git a/docs/jpn/reference/utils/utils.md b/docs/jpn/reference/utils/utils.md index 8595dcb..3c3c0b5 100644 --- a/docs/jpn/reference/utils/utils.md +++ b/docs/jpn/reference/utils/utils.md @@ -1,14 +1,10 @@ # *module* **utils** -> [Source: ../../../../translatepy/utils/utils.py @ line 0](../../../../translatepy/utils/utils.py#L0) +> [Source: ../../../../translatepy/utils/utils.py](../../../../translatepy/utils/utils.py#L0) -## *const* **POSITIVE_FLOAT_REGEX** +## *const* [**POSITIVE_FLOAT_REGEX**](../../../../translatepy/utils/utils.py#L3) -> [Source: ../../../../translatepy/utils/utils.py @ line 3](../../../../translatepy/utils/utils.py#L3) - -## *func* **convert_to_float** - -> [Source: ../../../../translatepy/utils/utils.py @ line 6-13](../../../../translatepy/utils/utils.py#L6-L13) +## *func* [**convert_to_float**](../../../../translatepy/utils/utils.py#L6-L13) Safely converts anything to a positive float diff --git a/docs/jpn/reference/utils/vectorize.md b/docs/jpn/reference/utils/vectorize.md index 6686e79..a3037ca 100644 --- a/docs/jpn/reference/utils/vectorize.md +++ b/docs/jpn/reference/utils/vectorize.md @@ -1,6 +1,6 @@ # *module* **vectorize** -> [Source: ../../../../translatepy/utils/vectorize.py @ line 0](../../../../translatepy/utils/vectorize.py#L0) +> [Source: ../../../../translatepy/utils/vectorize.py](../../../../translatepy/utils/vectorize.py#L0) Handles vectors @@ -8,13 +8,9 @@ Handles vectors - [../../../../translatepy/utils/sanitize.py](../../../../translatepy/utils/sanitize.py): As `sanitize` -## *const* **CLEANUP_REGEX** +## *const* [**CLEANUP_REGEX**](../../../../translatepy/utils/vectorize.py#L12) -> [Source: ../../../../translatepy/utils/vectorize.py @ line 12](../../../../translatepy/utils/vectorize.py#L12) - -## *func* **string_preprocessing** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 15-17](../../../../translatepy/utils/vectorize.py#L15-L17) +## *func* [**string_preprocessing**](../../../../translatepy/utils/vectorize.py#L15-L17) internal function to preprocess the given string for fuzzy search @@ -27,49 +23,33 @@ internal function to preprocess the given string for fuzzy search - `str` -## *class* **Vector** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 20-34](../../../../translatepy/utils/vectorize.py#L20-L34) +## *class* [**Vector**](../../../../translatepy/utils/vectorize.py#L20-L34) A string vector -### *attr* Vector.**id** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 22](../../../../translatepy/utils/vectorize.py#L22) +### *attr* [Vector.**id**](../../../../translatepy/utils/vectorize.py#L22) > Type: `str` -### *attr* Vector.**string** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 23](../../../../translatepy/utils/vectorize.py#L23) +### *attr* [Vector.**string**](../../../../translatepy/utils/vectorize.py#L23) > Type: `str` -### *attr* Vector.**value** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 24](../../../../translatepy/utils/vectorize.py#L24) +### *attr* [Vector.**value**](../../../../translatepy/utils/vectorize.py#L24) > Type: `float` -### *property* Vector.**counter** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 27-29](../../../../translatepy/utils/vectorize.py#L27-L29) +### *property* [Vector.**counter**](../../../../translatepy/utils/vectorize.py#L27-L29) Returns a counter for the vector -### *property* Vector.**set** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 32-34](../../../../translatepy/utils/vectorize.py#L32-L34) +### *property* [Vector.**set**](../../../../translatepy/utils/vectorize.py#L32-L34) Returns a set for the vector -## *const* **A** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 36](../../../../translatepy/utils/vectorize.py#L36) +## *const* [**A**](../../../../translatepy/utils/vectorize.py#L36) -## *func* **vectorize** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 38-45](../../../../translatepy/utils/vectorize.py#L38-L45) +## *func* [**vectorize**](../../../../translatepy/utils/vectorize.py#L38-L45) Vectorizes the given string @@ -81,31 +61,23 @@ Vectorizes the given string - **string**: `str` -## *class* **SearchResult** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 49-54](../../../../translatepy/utils/vectorize.py#L49-L54) +## *class* [**SearchResult**](../../../../translatepy/utils/vectorize.py#L49-L54) A result from the `search` function -### *attr* SearchResult.**vector** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 51](../../../../translatepy/utils/vectorize.py#L51) +### *attr* [SearchResult.**vector**](../../../../translatepy/utils/vectorize.py#L51) > Type: `Vector` The actual vector -### *attr* SearchResult.**similarity** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 53](../../../../translatepy/utils/vectorize.py#L53) +### *attr* [SearchResult.**similarity**](../../../../translatepy/utils/vectorize.py#L53) > Type: `float` The similarity with the search query -## *func* **search** - -> [Source: ../../../../translatepy/utils/vectorize.py @ line 57-70](../../../../translatepy/utils/vectorize.py#L57-L70) +## *func* [**search**](../../../../translatepy/utils/vectorize.py#L57-L70) Searches `query` through `data` diff --git a/docs/jpn/server/Postman/Language.postman_collection.utils.json b/docs/jpn/server/Postman/Language.postman_collection.utils.json index 2caa280..6bc64be 100644 --- a/docs/jpn/server/Postman/Language.postman_collection.utils.json +++ b/docs/jpn/server/Postman/Language.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Language","description":"translatepy APIインターフェイスでの「Language」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file +{"info":{"name":"Language","description":"translatepy APIインターフェイスでの「Language」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file diff --git a/docs/jpn/server/Postman/Work.postman_collection.utils.json b/docs/jpn/server/Postman/Work.postman_collection.utils.json index f127135..f87ac3c 100644 --- a/docs/jpn/server/Postman/Work.postman_collection.utils.json +++ b/docs/jpn/server/Postman/Work.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Work","description":"translatepy APIインターフェイスでの「Work」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `translation` | The translation result | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `translation` | The translation result | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n"}]},{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `transliteration` | The transliteration result | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `transliteration` | The transliteration result | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n"}]},{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `corrected` | The corrected text | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `corrected` | The corrected text | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n"}]},{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | いいえ |\n| `example` | The example | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `positions` | The positions of the word in the example | list[int] | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | いいえ |\n| `example` | The example | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `positions` | The positions of the word in the example | list[int] | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `meaning` | The meaning of the text | string | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `meaning` | The meaning of the text | string | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `extension` | Returns the audio file extension | Optional[str] | いいえ |\n| `result` | Text to speech result | bytes | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `gender` | Gender of the 'person' saying the text | Gender | いいえ |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | いいえ |\n| `speed` | Speed of the text to speech result | int | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `extension` | Returns the audio file extension | Optional[str] | いいえ |\n| `result` | Text to speech result | bytes | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `gender` | Gender of the 'person' saying the text | Gender | いいえ |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | いいえ |\n| `speed` | Speed of the text to speech result | int | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file +{"info":{"name":"Work","description":"translatepy APIインターフェイスでの「Work」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `translation` | The translation result | string | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `translation` | The translation result | string | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]},{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n"}]},{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `transliteration` | The transliteration result | string | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `transliteration` | The transliteration result | string | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]},{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `corrected` | The corrected text | string | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `corrected` | The corrected text | string | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n"}]},{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n"}]},{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `example` | The example | string | いいえ |\n| `positions` | The positions of the word in the example | list[int] | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `example` | The example | string | いいえ |\n| `positions` | The positions of the word in the example | list[int] | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n"}]},{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `meaning` | The meaning of the text | string | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `meaning` | The meaning of the text | string | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n"}]},{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `extension` | Returns the audio file extension | Optional[str] | いいえ |\n| `result` | Text to speech result | bytes | いいえ |\n| `source` | The source text | string | いいえ |\n| `speed` | Speed of the text to speech result | int | いいえ |\n| `gender` | Gender of the 'person' saying the text | Gender | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `extension` | Returns the audio file extension | Optional[str] | いいえ |\n| `result` | Text to speech result | bytes | いいえ |\n| `source` | The source text | string | いいえ |\n| `speed` | Speed of the text to speech result | int | いいえ |\n| `gender` | Gender of the 'person' saying the text | Gender | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file diff --git "a/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Language.md" "b/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Language.md" index aee7c18..ec02c13 100644 --- "a/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Language.md" +++ "b/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Language.md" @@ -84,8 +84,8 @@ print(r.json()["data"]) | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | | `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # search @@ -185,6 +185,6 @@ print(r.json()["data"]) | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | | `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) \ No newline at end of file diff --git "a/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Work.md" "b/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Work.md" index 56e17a5..d4aaf1e 100644 --- "a/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Work.md" +++ "b/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Work.md" @@ -92,11 +92,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", "service": "no example", + "translation": "no example", "dest_lang": "no example", "source": "no example", - "translation": "no example" + "source_lang": "no example" } } @@ -106,20 +106,20 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | いいえ | | `service` | The service which returned the result | Translator | いいえ | +| `translation` | The translation result | string | いいえ | | `dest_lang` | The result's language | Language | いいえ | | `source` | The source text | string | いいえ | -| `translation` | The translation result | string | いいえ | +| `source_lang` | The source text's language | Language | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # translate_html @@ -211,9 +211,9 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "source": "no example", - "service": "no example" + "source": "no example" } } @@ -223,18 +223,18 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | いいえ | | `source_lang` | The source text's language | Language | いいえ | | `source` | The source text | string | いいえ | -| `service` | The service which returned the result | Translator | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # stream @@ -312,10 +312,10 @@ print(r.json()["data"]) | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # transliterate @@ -407,11 +407,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", + "service": "no example", + "transliteration": "no example", "dest_lang": "no example", "source": "no example", - "service": "no example", - "transliteration": "no example" + "source_lang": "no example" } } @@ -421,20 +421,20 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | いいえ | -| `dest_lang` | The result's language | Language | いいえ | -| `source` | The source text | string | いいえ | | `service` | The service which returned the result | Translator | いいえ | | `transliteration` | The transliteration result | string | いいえ | +| `dest_lang` | The result's language | Language | いいえ | +| `source` | The source text | string | いいえ | +| `source_lang` | The source text's language | Language | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # spellcheck @@ -526,11 +526,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", - "rich": true, - "source": "no example", "service": "no example", - "corrected": "no example" + "source": "no example", + "source_lang": "no example", + "corrected": "no example", + "rich": true } } @@ -540,20 +540,20 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | いいえ | -| `rich` | Whether the given result features the full range of information | bool | いいえ | -| `source` | The source text | string | いいえ | | `service` | The service which returned the result | Translator | いいえ | +| `source` | The source text | string | いいえ | +| `source_lang` | The source text's language | Language | いいえ | | `corrected` | The corrected text | string | いいえ | +| `rich` | Whether the given result features the full range of information | bool | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # language @@ -645,9 +645,9 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "source": "no example", - "service": "no example" + "source": "no example" } } @@ -657,18 +657,18 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | いいえ | | `source_lang` | The source text's language | Language | いいえ | | `source` | The source text | string | いいえ | -| `service` | The service which returned the result | Translator | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # example @@ -760,12 +760,12 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "reference": "no example", - "example": "no example", - "source_lang": "no example", - "positions": "no example", "source": "no example", - "service": "no example" + "source_lang": "no example", + "example": "no example", + "positions": "no example" } } @@ -775,21 +775,21 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | いいえ | | `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | いいえ | -| `example` | The example | string | いいえ | +| `source` | The source text | string | いいえ | | `source_lang` | The source text's language | Language | いいえ | +| `example` | The example | string | いいえ | | `positions` | The positions of the word in the example | list[int] | いいえ | -| `source` | The source text | string | いいえ | -| `service` | The service which returned the result | Translator | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # dictionary @@ -881,11 +881,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "meaning": "no example", - "rich": true, "source": "no example", - "service": "no example" + "meaning": "no example", + "rich": true } } @@ -895,20 +895,20 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | いいえ | | `source_lang` | The source text's language | Language | いいえ | +| `source` | The source text | string | いいえ | | `meaning` | The meaning of the text | string | いいえ | | `rich` | Whether the given result features the full range of information | bool | いいえ | -| `source` | The source text | string | いいえ | -| `service` | The service which returned the result | Translator | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # tts @@ -1000,14 +1000,14 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", "extension": "no example", "result": "no example", "source": "no example", - "service": "no example", + "speed": 4, "gender": "no example", + "service": "no example", "mime_type": "no example", - "speed": 4 + "source_lang": "no example" } } @@ -1017,21 +1017,21 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | いいえ | | `extension` | Returns the audio file extension | Optional[str] | いいえ | | `result` | Text to speech result | bytes | いいえ | | `source` | The source text | string | いいえ | -| `service` | The service which returned the result | Translator | いいえ | +| `speed` | Speed of the text to speech result | int | いいえ | | `gender` | Gender of the 'person' saying the text | Gender | いいえ | +| `service` | The service which returned the result | Translator | いいえ | | `mime_type` | Returns the MIME type of the audio file | Optional[str] | いいえ | -| `speed` | Speed of the text to speech result | int | いいえ | +| `source_lang` | The source text's language | Language | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) \ No newline at end of file diff --git a/translatepy/server/docs/eng/reference/__info__.md b/translatepy/server/docs/eng/reference/__info__.md index e2b5ac9..1f91092 100644 --- a/translatepy/server/docs/eng/reference/__info__.md +++ b/translatepy/server/docs/eng/reference/__info__.md @@ -1,5 +1,5 @@ # *module* **__info__** -> [Source: ../../../../__info__.py @ line 0](../../../../__info__.py#L0) +> [Source: ../../../../__info__.py](../../../../__info__.py#L0) Stores information on the current module version diff --git a/translatepy/server/docs/eng/reference/exceptions.md b/translatepy/server/docs/eng/reference/exceptions.md index 0779dca..2f0769a 100644 --- a/translatepy/server/docs/eng/reference/exceptions.md +++ b/translatepy/server/docs/eng/reference/exceptions.md @@ -1,141 +1,73 @@ # *module* **exceptions** -> [Source: ../../../../exceptions.py @ line 0](../../../../exceptions.py#L0) +> [Source: ../../../../exceptions.py](../../../../exceptions.py#L0) A list of exceptions used throughout translatepy -## *class* **TranslatepyException** +## *class* [**TranslatepyException**](../../../../exceptions.py#L5-L9) -> [Source: ../../../../exceptions.py @ line 5-9](../../../../exceptions.py#L5-L9) +### *attr* [TranslatepyException.**LOG**](../../../../exceptions.py#L6) -### *attr* TranslatepyException.**LOG** +## *class* [**NoResult**](../../../../exceptions.py#L12-L18) -> [Source: ../../../../exceptions.py @ line 6](../../../../exceptions.py#L6) +### *attr* [NoResult.**STATUS_CODE**](../../../../exceptions.py#L13) -## *class* **NoResult** +### *attr* [NoResult.**MESSAGE**](../../../../exceptions.py#L14) -> [Source: ../../../../exceptions.py @ line 12-18](../../../../exceptions.py#L12-L18) +### *attr* [NoResult.**EXCEPTION_NAME**](../../../../exceptions.py#L15) -### *attr* NoResult.**STATUS_CODE** +## *class* [**ParameterTypeError**](../../../../exceptions.py#L21-L27) -> [Source: ../../../../exceptions.py @ line 13](../../../../exceptions.py#L13) +### *attr* [ParameterTypeError.**STATUS_CODE**](../../../../exceptions.py#L22) -### *attr* NoResult.**MESSAGE** +### *attr* [ParameterTypeError.**MESSAGE**](../../../../exceptions.py#L23) -> [Source: ../../../../exceptions.py @ line 14](../../../../exceptions.py#L14) +### *attr* [ParameterTypeError.**EXCEPTION_NAME**](../../../../exceptions.py#L24) -### *attr* NoResult.**EXCEPTION_NAME** +## *class* [**UnknownLanguage**](../../../../exceptions.py#L30-L38) -> [Source: ../../../../exceptions.py @ line 15](../../../../exceptions.py#L15) +### *attr* [UnknownLanguage.**STATUS_CODE**](../../../../exceptions.py#L31) -## *class* **ParameterTypeError** +### *attr* [UnknownLanguage.**MESSAGE**](../../../../exceptions.py#L32) -> [Source: ../../../../exceptions.py @ line 21-27](../../../../exceptions.py#L21-L27) +### *attr* [UnknownLanguage.**EXCEPTION_NAME**](../../../../exceptions.py#L33) -### *attr* ParameterTypeError.**STATUS_CODE** +## *class* [**UnknownTranslator**](../../../../exceptions.py#L41-L49) -> [Source: ../../../../exceptions.py @ line 22](../../../../exceptions.py#L22) +### *attr* [UnknownTranslator.**STATUS_CODE**](../../../../exceptions.py#L42) -### *attr* ParameterTypeError.**MESSAGE** +### *attr* [UnknownTranslator.**MESSAGE**](../../../../exceptions.py#L43) -> [Source: ../../../../exceptions.py @ line 23](../../../../exceptions.py#L23) +### *attr* [UnknownTranslator.**EXCEPTION_NAME**](../../../../exceptions.py#L44) -### *attr* ParameterTypeError.**EXCEPTION_NAME** +## *class* [**UnsupportedMethod**](../../../../exceptions.py#L52-L58) -> [Source: ../../../../exceptions.py @ line 24](../../../../exceptions.py#L24) +### *attr* [UnsupportedMethod.**STATUS_CODE**](../../../../exceptions.py#L53) -## *class* **UnknownLanguage** +### *attr* [UnsupportedMethod.**MESSAGE**](../../../../exceptions.py#L54) -> [Source: ../../../../exceptions.py @ line 30-38](../../../../exceptions.py#L30-L38) +### *attr* [UnsupportedMethod.**EXCEPTION_NAME**](../../../../exceptions.py#L55) -### *attr* UnknownLanguage.**STATUS_CODE** +## *class* [**UnsupportedLanguage**](../../../../exceptions.py#L61-L67) -> [Source: ../../../../exceptions.py @ line 31](../../../../exceptions.py#L31) +### *attr* [UnsupportedLanguage.**STATUS_CODE**](../../../../exceptions.py#L62) -### *attr* UnknownLanguage.**MESSAGE** +### *attr* [UnsupportedLanguage.**MESSAGE**](../../../../exceptions.py#L63) -> [Source: ../../../../exceptions.py @ line 32](../../../../exceptions.py#L32) +### *attr* [UnsupportedLanguage.**EXCEPTION_NAME**](../../../../exceptions.py#L64) -### *attr* UnknownLanguage.**EXCEPTION_NAME** +## *class* [**ServiceURLError**](../../../../exceptions.py#L70-L76) -> [Source: ../../../../exceptions.py @ line 33](../../../../exceptions.py#L33) +### *attr* [ServiceURLError.**STATUS_CODE**](../../../../exceptions.py#L71) -## *class* **UnknownTranslator** +### *attr* [ServiceURLError.**MESSAGE**](../../../../exceptions.py#L72) -> [Source: ../../../../exceptions.py @ line 41-49](../../../../exceptions.py#L41-L49) +### *attr* [ServiceURLError.**EXCEPTION_NAME**](../../../../exceptions.py#L73) -### *attr* UnknownTranslator.**STATUS_CODE** +## *class* [**RateLimitPrevention**](../../../../exceptions.py#L79-L82) -> [Source: ../../../../exceptions.py @ line 42](../../../../exceptions.py#L42) +### *attr* [RateLimitPrevention.**STATUS_CODE**](../../../../exceptions.py#L80) -### *attr* UnknownTranslator.**MESSAGE** +### *attr* [RateLimitPrevention.**MESSAGE**](../../../../exceptions.py#L81) -> [Source: ../../../../exceptions.py @ line 43](../../../../exceptions.py#L43) - -### *attr* UnknownTranslator.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 44](../../../../exceptions.py#L44) - -## *class* **UnsupportedMethod** - -> [Source: ../../../../exceptions.py @ line 52-58](../../../../exceptions.py#L52-L58) - -### *attr* UnsupportedMethod.**STATUS_CODE** - -> [Source: ../../../../exceptions.py @ line 53](../../../../exceptions.py#L53) - -### *attr* UnsupportedMethod.**MESSAGE** - -> [Source: ../../../../exceptions.py @ line 54](../../../../exceptions.py#L54) - -### *attr* UnsupportedMethod.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 55](../../../../exceptions.py#L55) - -## *class* **UnsupportedLanguage** - -> [Source: ../../../../exceptions.py @ line 61-67](../../../../exceptions.py#L61-L67) - -### *attr* UnsupportedLanguage.**STATUS_CODE** - -> [Source: ../../../../exceptions.py @ line 62](../../../../exceptions.py#L62) - -### *attr* UnsupportedLanguage.**MESSAGE** - -> [Source: ../../../../exceptions.py @ line 63](../../../../exceptions.py#L63) - -### *attr* UnsupportedLanguage.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 64](../../../../exceptions.py#L64) - -## *class* **ServiceURLError** - -> [Source: ../../../../exceptions.py @ line 70-76](../../../../exceptions.py#L70-L76) - -### *attr* ServiceURLError.**STATUS_CODE** - -> [Source: ../../../../exceptions.py @ line 71](../../../../exceptions.py#L71) - -### *attr* ServiceURLError.**MESSAGE** - -> [Source: ../../../../exceptions.py @ line 72](../../../../exceptions.py#L72) - -### *attr* ServiceURLError.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 73](../../../../exceptions.py#L73) - -## *class* **RateLimitPrevention** - -> [Source: ../../../../exceptions.py @ line 79-82](../../../../exceptions.py#L79-L82) - -### *attr* RateLimitPrevention.**STATUS_CODE** - -> [Source: ../../../../exceptions.py @ line 80](../../../../exceptions.py#L80) - -### *attr* RateLimitPrevention.**MESSAGE** - -> [Source: ../../../../exceptions.py @ line 81](../../../../exceptions.py#L81) - -### *attr* RateLimitPrevention.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 82](../../../../exceptions.py#L82) +### *attr* [RateLimitPrevention.**EXCEPTION_NAME**](../../../../exceptions.py#L82) diff --git a/translatepy/server/docs/eng/reference/language.md b/translatepy/server/docs/eng/reference/language.md index 797bbef..52de28c 100644 --- a/translatepy/server/docs/eng/reference/language.md +++ b/translatepy/server/docs/eng/reference/language.md @@ -1,6 +1,6 @@ # *module* **language** -> [Source: ../../../../language.py @ line 0](../../../../language.py#L0) +> [Source: ../../../../language.py](../../../../language.py#L0) Handles the languages management on `translatepy` @@ -12,21 +12,15 @@ Handles the languages management on `translatepy` - [../../../../utils/vectorize.py](../../../../utils/vectorize.py): As `vectorize` -## *const* **Number** - -> [Source: ../../../../language.py @ line 17](../../../../language.py#L17) +## *const* [**Number**](../../../../language.py#L17) Represents a number -## *class* **LanguageExtra** - -> [Source: ../../../../language.py @ line 21-34](../../../../language.py#L21-L34) +## *class* [**LanguageExtra**](../../../../language.py#L21-L34) Extra data given on supported languages -### *attr* LanguageExtra.**scope** - -> [Source: ../../../../language.py @ line 23](../../../../language.py#L23) +### *attr* [LanguageExtra.**scope**](../../../../language.py#L23) > Type: `cain.types.Enum` @@ -35,9 +29,7 @@ Language scope > **Note** > Can be one of "individual", "macrolanguage", "special" -### *attr* LanguageExtra.**type** - -> [Source: ../../../../language.py @ line 28](../../../../language.py#L28) +### *attr* [LanguageExtra.**type**](../../../../language.py#L28) > Type: `cain.types.Enum` @@ -46,773 +38,577 @@ Language type > **Note** > Can be one of "ancient", "constructed", "extinct", "historical", "living", "special" -## *class* **Foreign** - -> [Source: ../../../../language.py @ line 37-208](../../../../language.py#L37-L208) +## *class* [**Foreign**](../../../../language.py#L37-L208) The language name in foreign languages -### *attr* Foreign.**afrikaans** - -> [Source: ../../../../language.py @ line 39](../../../../language.py#L39) +### *attr* [Foreign.**afrikaans**](../../../../language.py#L39) > Type: `str` The language name in afrikaans -### *attr* Foreign.**albanian** - -> [Source: ../../../../language.py @ line 41](../../../../language.py#L41) +### *attr* [Foreign.**albanian**](../../../../language.py#L41) > Type: `str` The language name in albanian -### *attr* Foreign.**amharic** - -> [Source: ../../../../language.py @ line 43](../../../../language.py#L43) +### *attr* [Foreign.**amharic**](../../../../language.py#L43) > Type: `str` The language name in amharic -### *attr* Foreign.**arabic** - -> [Source: ../../../../language.py @ line 45](../../../../language.py#L45) +### *attr* [Foreign.**arabic**](../../../../language.py#L45) > Type: `str` The language name in arabic -### *attr* Foreign.**armenian** - -> [Source: ../../../../language.py @ line 47](../../../../language.py#L47) +### *attr* [Foreign.**armenian**](../../../../language.py#L47) > Type: `str` The language name in armenian -### *attr* Foreign.**azerbaijani** - -> [Source: ../../../../language.py @ line 49](../../../../language.py#L49) +### *attr* [Foreign.**azerbaijani**](../../../../language.py#L49) > Type: `str` The language name in azerbaijani -### *attr* Foreign.**basque** - -> [Source: ../../../../language.py @ line 51](../../../../language.py#L51) +### *attr* [Foreign.**basque**](../../../../language.py#L51) > Type: `str` The language name in basque -### *attr* Foreign.**belarusian** - -> [Source: ../../../../language.py @ line 53](../../../../language.py#L53) +### *attr* [Foreign.**belarusian**](../../../../language.py#L53) > Type: `str` The language name in belarusian -### *attr* Foreign.**bengali** - -> [Source: ../../../../language.py @ line 55](../../../../language.py#L55) +### *attr* [Foreign.**bengali**](../../../../language.py#L55) > Type: `str` The language name in bengali -### *attr* Foreign.**bosnian** - -> [Source: ../../../../language.py @ line 57](../../../../language.py#L57) +### *attr* [Foreign.**bosnian**](../../../../language.py#L57) > Type: `str` The language name in bosnian -### *attr* Foreign.**bulgarian** - -> [Source: ../../../../language.py @ line 59](../../../../language.py#L59) +### *attr* [Foreign.**bulgarian**](../../../../language.py#L59) > Type: `str` The language name in bulgarian -### *attr* Foreign.**burmese** - -> [Source: ../../../../language.py @ line 61](../../../../language.py#L61) +### *attr* [Foreign.**burmese**](../../../../language.py#L61) > Type: `str` The language name in burmese -### *attr* Foreign.**catalan** - -> [Source: ../../../../language.py @ line 63](../../../../language.py#L63) +### *attr* [Foreign.**catalan**](../../../../language.py#L63) > Type: `str` The language name in catalan -### *attr* Foreign.**chinese** - -> [Source: ../../../../language.py @ line 65](../../../../language.py#L65) +### *attr* [Foreign.**chinese**](../../../../language.py#L65) > Type: `str` The language name in chinese -### *attr* Foreign.**croatian** - -> [Source: ../../../../language.py @ line 67](../../../../language.py#L67) +### *attr* [Foreign.**croatian**](../../../../language.py#L67) > Type: `str` The language name in croatian -### *attr* Foreign.**czech** - -> [Source: ../../../../language.py @ line 69](../../../../language.py#L69) +### *attr* [Foreign.**czech**](../../../../language.py#L69) > Type: `str` The language name in czech -### *attr* Foreign.**danish** - -> [Source: ../../../../language.py @ line 71](../../../../language.py#L71) +### *attr* [Foreign.**danish**](../../../../language.py#L71) > Type: `str` The language name in danish -### *attr* Foreign.**dutch** - -> [Source: ../../../../language.py @ line 73](../../../../language.py#L73) +### *attr* [Foreign.**dutch**](../../../../language.py#L73) > Type: `str` The language name in dutch -### *attr* Foreign.**esperanto** - -> [Source: ../../../../language.py @ line 75](../../../../language.py#L75) +### *attr* [Foreign.**esperanto**](../../../../language.py#L75) > Type: `str` The language name in esperanto -### *attr* Foreign.**estonian** - -> [Source: ../../../../language.py @ line 77](../../../../language.py#L77) +### *attr* [Foreign.**estonian**](../../../../language.py#L77) > Type: `str` The language name in estonian -### *attr* Foreign.**finnish** - -> [Source: ../../../../language.py @ line 79](../../../../language.py#L79) +### *attr* [Foreign.**finnish**](../../../../language.py#L79) > Type: `str` The language name in finnish -### *attr* Foreign.**french** - -> [Source: ../../../../language.py @ line 81](../../../../language.py#L81) +### *attr* [Foreign.**french**](../../../../language.py#L81) > Type: `str` The language name in french -### *attr* Foreign.**galician** - -> [Source: ../../../../language.py @ line 83](../../../../language.py#L83) +### *attr* [Foreign.**galician**](../../../../language.py#L83) > Type: `str` The language name in galician -### *attr* Foreign.**georgian** - -> [Source: ../../../../language.py @ line 85](../../../../language.py#L85) +### *attr* [Foreign.**georgian**](../../../../language.py#L85) > Type: `str` The language name in georgian -### *attr* Foreign.**german** - -> [Source: ../../../../language.py @ line 87](../../../../language.py#L87) +### *attr* [Foreign.**german**](../../../../language.py#L87) > Type: `str` The language name in german -### *attr* Foreign.**gujarati** - -> [Source: ../../../../language.py @ line 89](../../../../language.py#L89) +### *attr* [Foreign.**gujarati**](../../../../language.py#L89) > Type: `str` The language name in gujarati -### *attr* Foreign.**haitian** - -> [Source: ../../../../language.py @ line 91](../../../../language.py#L91) +### *attr* [Foreign.**haitian**](../../../../language.py#L91) > Type: `str` The language name in haitian -### *attr* Foreign.**hebrew** - -> [Source: ../../../../language.py @ line 93](../../../../language.py#L93) +### *attr* [Foreign.**hebrew**](../../../../language.py#L93) > Type: `str` The language name in hebrew -### *attr* Foreign.**hindi** - -> [Source: ../../../../language.py @ line 95](../../../../language.py#L95) +### *attr* [Foreign.**hindi**](../../../../language.py#L95) > Type: `str` The language name in hindi -### *attr* Foreign.**hungarian** - -> [Source: ../../../../language.py @ line 97](../../../../language.py#L97) +### *attr* [Foreign.**hungarian**](../../../../language.py#L97) > Type: `str` The language name in hungarian -### *attr* Foreign.**icelandic** - -> [Source: ../../../../language.py @ line 99](../../../../language.py#L99) +### *attr* [Foreign.**icelandic**](../../../../language.py#L99) > Type: `str` The language name in icelandic -### *attr* Foreign.**indonesian** - -> [Source: ../../../../language.py @ line 101](../../../../language.py#L101) +### *attr* [Foreign.**indonesian**](../../../../language.py#L101) > Type: `str` The language name in indonesian -### *attr* Foreign.**irish** - -> [Source: ../../../../language.py @ line 103](../../../../language.py#L103) +### *attr* [Foreign.**irish**](../../../../language.py#L103) > Type: `str` The language name in irish -### *attr* Foreign.**italian** - -> [Source: ../../../../language.py @ line 105](../../../../language.py#L105) +### *attr* [Foreign.**italian**](../../../../language.py#L105) > Type: `str` The language name in italian -### *attr* Foreign.**japanese** - -> [Source: ../../../../language.py @ line 107](../../../../language.py#L107) +### *attr* [Foreign.**japanese**](../../../../language.py#L107) > Type: `str` The language name in japanese -### *attr* Foreign.**javanese** - -> [Source: ../../../../language.py @ line 109](../../../../language.py#L109) +### *attr* [Foreign.**javanese**](../../../../language.py#L109) > Type: `str` The language name in javanese -### *attr* Foreign.**kannada** - -> [Source: ../../../../language.py @ line 111](../../../../language.py#L111) +### *attr* [Foreign.**kannada**](../../../../language.py#L111) > Type: `str` The language name in kannada -### *attr* Foreign.**kazakh** - -> [Source: ../../../../language.py @ line 113](../../../../language.py#L113) +### *attr* [Foreign.**kazakh**](../../../../language.py#L113) > Type: `str` The language name in kazakh -### *attr* Foreign.**khmer** - -> [Source: ../../../../language.py @ line 115](../../../../language.py#L115) +### *attr* [Foreign.**khmer**](../../../../language.py#L115) > Type: `str` The language name in khmer -### *attr* Foreign.**kirghiz** - -> [Source: ../../../../language.py @ line 117](../../../../language.py#L117) +### *attr* [Foreign.**kirghiz**](../../../../language.py#L117) > Type: `str` The language name in kirghiz -### *attr* Foreign.**korean** - -> [Source: ../../../../language.py @ line 119](../../../../language.py#L119) +### *attr* [Foreign.**korean**](../../../../language.py#L119) > Type: `str` The language name in korean -### *attr* Foreign.**lao** - -> [Source: ../../../../language.py @ line 121](../../../../language.py#L121) +### *attr* [Foreign.**lao**](../../../../language.py#L121) > Type: `str` The language name in lao -### *attr* Foreign.**latin** - -> [Source: ../../../../language.py @ line 123](../../../../language.py#L123) +### *attr* [Foreign.**latin**](../../../../language.py#L123) > Type: `str` The language name in latin -### *attr* Foreign.**latvian** - -> [Source: ../../../../language.py @ line 125](../../../../language.py#L125) +### *attr* [Foreign.**latvian**](../../../../language.py#L125) > Type: `str` The language name in latvian -### *attr* Foreign.**lithuanian** - -> [Source: ../../../../language.py @ line 127](../../../../language.py#L127) +### *attr* [Foreign.**lithuanian**](../../../../language.py#L127) > Type: `str` The language name in lithuanian -### *attr* Foreign.**luxembourgish** - -> [Source: ../../../../language.py @ line 129](../../../../language.py#L129) +### *attr* [Foreign.**luxembourgish**](../../../../language.py#L129) > Type: `str` The language name in luxembourgish -### *attr* Foreign.**macedonian** - -> [Source: ../../../../language.py @ line 131](../../../../language.py#L131) +### *attr* [Foreign.**macedonian**](../../../../language.py#L131) > Type: `str` The language name in macedonian -### *attr* Foreign.**malagasy** - -> [Source: ../../../../language.py @ line 133](../../../../language.py#L133) +### *attr* [Foreign.**malagasy**](../../../../language.py#L133) > Type: `str` The language name in malagasy -### *attr* Foreign.**malay** - -> [Source: ../../../../language.py @ line 135](../../../../language.py#L135) +### *attr* [Foreign.**malay**](../../../../language.py#L135) > Type: `str` The language name in malay -### *attr* Foreign.**maltese** - -> [Source: ../../../../language.py @ line 137](../../../../language.py#L137) +### *attr* [Foreign.**maltese**](../../../../language.py#L137) > Type: `str` The language name in maltese -### *attr* Foreign.**maori** - -> [Source: ../../../../language.py @ line 139](../../../../language.py#L139) +### *attr* [Foreign.**maori**](../../../../language.py#L139) > Type: `str` The language name in maori -### *attr* Foreign.**marathi** - -> [Source: ../../../../language.py @ line 141](../../../../language.py#L141) +### *attr* [Foreign.**marathi**](../../../../language.py#L141) > Type: `str` The language name in marathi -### *attr* Foreign.**moderngreek** - -> [Source: ../../../../language.py @ line 143](../../../../language.py#L143) +### *attr* [Foreign.**moderngreek**](../../../../language.py#L143) > Type: `str` The language name in moderngreek -### *attr* Foreign.**mongolian** - -> [Source: ../../../../language.py @ line 145](../../../../language.py#L145) +### *attr* [Foreign.**mongolian**](../../../../language.py#L145) > Type: `str` The language name in mongolian -### *attr* Foreign.**nepali** - -> [Source: ../../../../language.py @ line 147](../../../../language.py#L147) +### *attr* [Foreign.**nepali**](../../../../language.py#L147) > Type: `str` The language name in nepali -### *attr* Foreign.**norwegian** - -> [Source: ../../../../language.py @ line 149](../../../../language.py#L149) +### *attr* [Foreign.**norwegian**](../../../../language.py#L149) > Type: `str` The language name in norwegian -### *attr* Foreign.**panjabi** - -> [Source: ../../../../language.py @ line 151](../../../../language.py#L151) +### *attr* [Foreign.**panjabi**](../../../../language.py#L151) > Type: `str` The language name in panjabi -### *attr* Foreign.**persian** - -> [Source: ../../../../language.py @ line 153](../../../../language.py#L153) +### *attr* [Foreign.**persian**](../../../../language.py#L153) > Type: `str` The language name in persian -### *attr* Foreign.**polish** - -> [Source: ../../../../language.py @ line 155](../../../../language.py#L155) +### *attr* [Foreign.**polish**](../../../../language.py#L155) > Type: `str` The language name in polish -### *attr* Foreign.**portuguese** - -> [Source: ../../../../language.py @ line 157](../../../../language.py#L157) +### *attr* [Foreign.**portuguese**](../../../../language.py#L157) > Type: `str` The language name in portuguese -### *attr* Foreign.**romanian** - -> [Source: ../../../../language.py @ line 159](../../../../language.py#L159) +### *attr* [Foreign.**romanian**](../../../../language.py#L159) > Type: `str` The language name in romanian -### *attr* Foreign.**russian** - -> [Source: ../../../../language.py @ line 161](../../../../language.py#L161) +### *attr* [Foreign.**russian**](../../../../language.py#L161) > Type: `str` The language name in russian -### *attr* Foreign.**scottishgaelic** - -> [Source: ../../../../language.py @ line 163](../../../../language.py#L163) +### *attr* [Foreign.**scottishgaelic**](../../../../language.py#L163) > Type: `str` The language name in scottishgaelic -### *attr* Foreign.**serbian** - -> [Source: ../../../../language.py @ line 165](../../../../language.py#L165) +### *attr* [Foreign.**serbian**](../../../../language.py#L165) > Type: `str` The language name in serbian -### *attr* Foreign.**sinhala** - -> [Source: ../../../../language.py @ line 167](../../../../language.py#L167) +### *attr* [Foreign.**sinhala**](../../../../language.py#L167) > Type: `str` The language name in sinhala -### *attr* Foreign.**slovak** - -> [Source: ../../../../language.py @ line 169](../../../../language.py#L169) +### *attr* [Foreign.**slovak**](../../../../language.py#L169) > Type: `str` The language name in slovak -### *attr* Foreign.**slovenian** - -> [Source: ../../../../language.py @ line 171](../../../../language.py#L171) +### *attr* [Foreign.**slovenian**](../../../../language.py#L171) > Type: `str` The language name in slovenian -### *attr* Foreign.**spanish** - -> [Source: ../../../../language.py @ line 173](../../../../language.py#L173) +### *attr* [Foreign.**spanish**](../../../../language.py#L173) > Type: `str` The language name in spanish -### *attr* Foreign.**sundanese** - -> [Source: ../../../../language.py @ line 175](../../../../language.py#L175) +### *attr* [Foreign.**sundanese**](../../../../language.py#L175) > Type: `str` The language name in sundanese -### *attr* Foreign.**swahili** - -> [Source: ../../../../language.py @ line 177](../../../../language.py#L177) +### *attr* [Foreign.**swahili**](../../../../language.py#L177) > Type: `str` The language name in swahili -### *attr* Foreign.**swedish** - -> [Source: ../../../../language.py @ line 179](../../../../language.py#L179) +### *attr* [Foreign.**swedish**](../../../../language.py#L179) > Type: `str` The language name in swedish -### *attr* Foreign.**tagalog** - -> [Source: ../../../../language.py @ line 181](../../../../language.py#L181) +### *attr* [Foreign.**tagalog**](../../../../language.py#L181) > Type: `str` The language name in tagalog -### *attr* Foreign.**tajik** - -> [Source: ../../../../language.py @ line 183](../../../../language.py#L183) +### *attr* [Foreign.**tajik**](../../../../language.py#L183) > Type: `str` The language name in tajik -### *attr* Foreign.**tamil** - -> [Source: ../../../../language.py @ line 185](../../../../language.py#L185) +### *attr* [Foreign.**tamil**](../../../../language.py#L185) > Type: `str` The language name in tamil -### *attr* Foreign.**telugu** - -> [Source: ../../../../language.py @ line 187](../../../../language.py#L187) +### *attr* [Foreign.**telugu**](../../../../language.py#L187) > Type: `str` The language name in telugu -### *attr* Foreign.**thai** - -> [Source: ../../../../language.py @ line 189](../../../../language.py#L189) +### *attr* [Foreign.**thai**](../../../../language.py#L189) > Type: `str` The language name in thai -### *attr* Foreign.**turkish** - -> [Source: ../../../../language.py @ line 191](../../../../language.py#L191) +### *attr* [Foreign.**turkish**](../../../../language.py#L191) > Type: `str` The language name in turkish -### *attr* Foreign.**ukrainian** - -> [Source: ../../../../language.py @ line 193](../../../../language.py#L193) +### *attr* [Foreign.**ukrainian**](../../../../language.py#L193) > Type: `str` The language name in ukrainian -### *attr* Foreign.**urdu** - -> [Source: ../../../../language.py @ line 195](../../../../language.py#L195) +### *attr* [Foreign.**urdu**](../../../../language.py#L195) > Type: `str` The language name in urdu -### *attr* Foreign.**uzbek** - -> [Source: ../../../../language.py @ line 197](../../../../language.py#L197) +### *attr* [Foreign.**uzbek**](../../../../language.py#L197) > Type: `str` The language name in uzbek -### *attr* Foreign.**vietnamese** - -> [Source: ../../../../language.py @ line 199](../../../../language.py#L199) +### *attr* [Foreign.**vietnamese**](../../../../language.py#L199) > Type: `str` The language name in vietnamese -### *attr* Foreign.**welsh** - -> [Source: ../../../../language.py @ line 201](../../../../language.py#L201) +### *attr* [Foreign.**welsh**](../../../../language.py#L201) > Type: `str` The language name in welsh -### *attr* Foreign.**xhosa** - -> [Source: ../../../../language.py @ line 203](../../../../language.py#L203) +### *attr* [Foreign.**xhosa**](../../../../language.py#L203) > Type: `str` The language name in xhosa -### *attr* Foreign.**yiddish** - -> [Source: ../../../../language.py @ line 205](../../../../language.py#L205) +### *attr* [Foreign.**yiddish**](../../../../language.py#L205) > Type: `str` The language name in yiddish -### *attr* Foreign.**zulu** - -> [Source: ../../../../language.py @ line 207](../../../../language.py#L207) +### *attr* [Foreign.**zulu**](../../../../language.py#L207) > Type: `str` The language name in zulu -## *const* **LANGUAGE_CACHE** - -> [Source: ../../../../language.py @ line 211](../../../../language.py#L211) +## *const* [**LANGUAGE_CACHE**](../../../../language.py#L211) -## *const* **NULLABLE_ATTRIBUTES** +## *const* [**NULLABLE_ATTRIBUTES**](../../../../language.py#L212) -> [Source: ../../../../language.py @ line 212](../../../../language.py#L212) - -## *class* **Language** - -> [Source: ../../../../language.py @ line 215-347](../../../../language.py#L215-L347) +## *class* [**Language**](../../../../language.py#L215-L347) A language -### *attr* Language.**id** - -> [Source: ../../../../language.py @ line 218](../../../../language.py#L218) +### *attr* [Language.**id**](../../../../language.py#L218) > Type: `str` The language identifier -### *attr* Language.**alpha3** - -> [Source: ../../../../language.py @ line 220](../../../../language.py#L220) +### *attr* [Language.**alpha3**](../../../../language.py#L220) > Type: `str` The ISO 639-3 (Alpha-3) code -### *attr* Language.**name** - -> [Source: ../../../../language.py @ line 222](../../../../language.py#L222) +### *attr* [Language.**name**](../../../../language.py#L222) > Type: `str` The english name -### *attr* Language.**alpha2** - -> [Source: ../../../../language.py @ line 224](../../../../language.py#L224) +### *attr* [Language.**alpha2**](../../../../language.py#L224) > Type: `Optional` The ISO 639-1 (Alpha-2) code, if available -### *attr* Language.**alpha3b** - -> [Source: ../../../../language.py @ line 226](../../../../language.py#L226) +### *attr* [Language.**alpha3b**](../../../../language.py#L226) > Type: `Optional` The ISO 639-2B (Alpha-3) code, if available -### *attr* Language.**alpha3t** - -> [Source: ../../../../language.py @ line 228](../../../../language.py#L228) +### *attr* [Language.**alpha3t**](../../../../language.py#L228) > Type: `Optional` The ISO 639-2T (Alpha-3) code, if available -### *attr* Language.**extra** - -> [Source: ../../../../language.py @ line 230](../../../../language.py#L230) +### *attr* [Language.**extra**](../../../../language.py#L230) > Type: `Optional` Extra data for the language, if available -### *attr* Language.**foreign** - -> [Source: ../../../../language.py @ line 232](../../../../language.py#L232) +### *attr* [Language.**foreign**](../../../../language.py#L232) > Type: `Optional` Name in foreign languages, if available -### *func* Language.**search** - -> [Source: ../../../../language.py @ line 269-292](../../../../language.py#L269-L292) +### *func* [Language.**search**](../../../../language.py#L269-L292) Searches the given language @@ -828,9 +624,7 @@ Searches the given language - `list` -### *func* Language.**get_extra** - -> [Source: ../../../../language.py @ line 310-317](../../../../language.py#L310-L317) +### *func* [Language.**get_extra**](../../../../language.py#L310-L317) Retrieves the given attribute from `extra` if available @@ -845,9 +639,7 @@ Retrieves the given attribute from `extra` if available - `str` -### *func* Language.**get_foreign** - -> [Source: ../../../../language.py @ line 319-328](../../../../language.py#L319-L328) +### *func* [Language.**get_foreign**](../../../../language.py#L319-L328) Retrieves the given attribute from `foreign` if available @@ -862,9 +654,7 @@ Retrieves the given attribute from `foreign` if available - `str` -### *property* Language.**similarity** - -> [Source: ../../../../language.py @ line 331-333](../../../../language.py#L331-L333) +### *property* [Language.**similarity**](../../../../language.py#L331-L333) The similarity with the vector while searching the language @@ -872,9 +662,7 @@ The similarity with the vector while searching the language - `float` -### *property* Language.**native** - -> [Source: ../../../../language.py @ line 336-338](../../../../language.py#L336-L338) +### *property* [Language.**native**](../../../../language.py#L336-L338) The native name for the language or its english name @@ -882,9 +670,7 @@ The native name for the language or its english name - `str` -### *property* Language.**rich** - -> [Source: ../../../../language.py @ line 341-347](../../../../language.py#L341-L347) +### *property* [Language.**rich**](../../../../language.py#L341-L347) If the language discovery used the full translatepy dataset Note: This returns `False` if the `Language` was not fully initialized @@ -893,56 +679,38 @@ Note: This returns `False` if the `Language` was not fully initialized - `bool` -## *class* **LanguageData** - -> [Source: ../../../../language.py @ line 352-356](../../../../language.py#L352-L356) +## *class* [**LanguageData**](../../../../language.py#L352-L356) Groups all of the data -### *attr* LanguageData.**codes** - -> [Source: ../../../../language.py @ line 354](../../../../language.py#L354) +### *attr* [LanguageData.**codes**](../../../../language.py#L354) > Type: `Dict` -### *attr* LanguageData.**data** - -> [Source: ../../../../language.py @ line 355](../../../../language.py#L355) +### *attr* [LanguageData.**data**](../../../../language.py#L355) > Type: `Dict` -### *attr* LanguageData.**vectors** - -> [Source: ../../../../language.py @ line 356](../../../../language.py#L356) +### *attr* [LanguageData.**vectors**](../../../../language.py#L356) > Type: `List` -## *const* **LANGUAGE_DATA_DIR** - -> [Source: ../../../../language.py @ line 360](../../../../language.py#L360) +## *const* [**LANGUAGE_DATA_DIR**](../../../../language.py#L360) The directory where all of the data is stored -## *const* **DATA** - -> [Source: ../../../../language.py @ line 363](../../../../language.py#L363) +## *const* [**DATA**](../../../../language.py#L363) The languages in-memory data -## *const* **TRANSLATEPY_LANGUAGE_FULL** - -> [Source: ../../../../language.py @ line 369](../../../../language.py#L369) +## *const* [**TRANSLATEPY_LANGUAGE_FULL**](../../../../language.py#L369) If the full language data database got loaded at runtime -## *func* **load_full** - -> [Source: ../../../../language.py @ line 378-385](../../../../language.py#L378-L385) +## *func* [**load_full**](../../../../language.py#L378-L385) Loads the full data languages DB -## *const* **COMMON_LANGUAGES** - -> [Source: ../../../../language.py @ line 392](../../../../language.py#L392) +## *const* [**COMMON_LANGUAGES**](../../../../language.py#L392) All of the available foreign languages for the `foreign` field on the `Language` class and English diff --git a/translatepy/server/docs/eng/reference/models.md b/translatepy/server/docs/eng/reference/models.md index c2ea421..0bee762 100644 --- a/translatepy/server/docs/eng/reference/models.md +++ b/translatepy/server/docs/eng/reference/models.md @@ -1,6 +1,6 @@ # *module* **models** -> [Source: ../../../../models.py @ line 0](../../../../models.py#L0) +> [Source: ../../../../models.py](../../../../models.py#L0) translatepy/models.py Describes the different result models returned by the translators @@ -11,62 +11,38 @@ Describes the different result models returned by the translators - [../../../../utils/audio.py](../../../../utils/audio.py): As `get_type` -## *class* **Speed** - -> [Source: ../../../../models.py @ line 23-28](../../../../models.py#L23-L28) +## *class* [**Speed**](../../../../models.py#L23-L28) Represents a speed percentage -### *attr* Speed.**FULL** - -> [Source: ../../../../models.py @ line 25](../../../../models.py#L25) - -### *attr* Speed.**HALF** - -> [Source: ../../../../models.py @ line 26](../../../../models.py#L26) +### *attr* [Speed.**FULL**](../../../../models.py#L25) -### *attr* Speed.**QUARTER** +### *attr* [Speed.**HALF**](../../../../models.py#L26) -> [Source: ../../../../models.py @ line 27](../../../../models.py#L27) +### *attr* [Speed.**QUARTER**](../../../../models.py#L27) -### *attr* Speed.**SLOW** +### *attr* [Speed.**SLOW**](../../../../models.py#L28) -> [Source: ../../../../models.py @ line 28](../../../../models.py#L28) - -## *class* **Gender** - -> [Source: ../../../../models.py @ line 31-36](../../../../models.py#L31-L36) +## *class* [**Gender**](../../../../models.py#L31-L36) Represents a gender -### *attr* Gender.**MALE** - -> [Source: ../../../../models.py @ line 33](../../../../models.py#L33) +### *attr* [Gender.**MALE**](../../../../models.py#L33) -### *attr* Gender.**FEMALE** +### *attr* [Gender.**FEMALE**](../../../../models.py#L34) -> [Source: ../../../../models.py @ line 34](../../../../models.py#L34) +### *attr* [Gender.**OTHER**](../../../../models.py#L35) -### *attr* Gender.**OTHER** +### *attr* [Gender.**GENDERLESS**](../../../../models.py#L36) -> [Source: ../../../../models.py @ line 35](../../../../models.py#L35) - -### *attr* Gender.**GENDERLESS** - -> [Source: ../../../../models.py @ line 36](../../../../models.py#L36) - -## *class* **WordClass** - -> [Source: ../../../../models.py @ line 39-110](../../../../models.py#L39-L110) +## *class* [**WordClass**](../../../../models.py#L39-L110) Part of speech > **Note** > Refer to https://en.wikipedia.org/wiki/Part_of_speech -### *attr* WordClass.**NOUN** - -> [Source: ../../../../models.py @ line 45](../../../../models.py#L45) +### *attr* [WordClass.**NOUN**](../../../../models.py#L45) A word or lexical item denoting any abstract (abstract noun: e.g. home) or concrete entity (concrete noun: e.g. house); a person (police officer, Michael), place (coastline, London), thing (necktie, television), idea (happiness), or quality (bravery). @@ -75,37 +51,27 @@ Nouns can also be classified as count nouns or non-count nouns; some can belong > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**PRONOUN** - -> [Source: ../../../../models.py @ line 54](../../../../models.py#L54) +### *attr* [WordClass.**PRONOUN**](../../../../models.py#L54) A substitute for a noun or noun phrase (them, he). Pronouns make sentences shorter and clearer since they replace nouns. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ADJECTIVE** - -> [Source: ../../../../models.py @ line 60](../../../../models.py#L60) +### *attr* [WordClass.**ADJECTIVE**](../../../../models.py#L60) A modifier of a noun or pronoun (big, brave). Adjectives make the meaning of another word (noun) more precise. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**VERB** - -> [Source: ../../../../models.py @ line 66](../../../../models.py#L66) +### *attr* [WordClass.**VERB**](../../../../models.py#L66) A word denoting an action (walk), occurrence (happen), or state of being (be). Without a verb, a group of words cannot be a clause or sentence. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ADVERB** - -> [Source: ../../../../models.py @ line 72](../../../../models.py#L72) +### *attr* [WordClass.**ADVERB**](../../../../models.py#L72) A modifier of an adjective, verb, or another adverb (very, quite). Adverbs make language more precise. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**PREPOSITION** - -> [Source: ../../../../models.py @ line 78](../../../../models.py#L78) +### *attr* [WordClass.**PREPOSITION**](../../../../models.py#L78) A word that relates words to each other in a phrase or sentence and aids in syntactic context (in, of). Prepositions show the relationship between a noun or a pronoun with another word in the sentence. @@ -113,23 +79,17 @@ Prepositions show the relationship between a noun or a pronoun with another word > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**CONJUNCTION** - -> [Source: ../../../../models.py @ line 86](../../../../models.py#L86) +### *attr* [WordClass.**CONJUNCTION**](../../../../models.py#L86) A syntactic connector; links words, phrases, or clauses (and, but). Conjunctions connect words or group of words Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**INTERJECTION** - -> [Source: ../../../../models.py @ line 92](../../../../models.py#L92) +### *attr* [WordClass.**INTERJECTION**](../../../../models.py#L92) An emotional greeting or exclamation (Huzzah, Alas). Interjections express strong feelings and emotions. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ARTICLE** - -> [Source: ../../../../models.py @ line 98](../../../../models.py#L98) +### *attr* [WordClass.**ARTICLE**](../../../../models.py#L98) A grammatical marker of definiteness (the) or indefiniteness (a, an). The article is not always listed among the parts of speech. @@ -138,23 +98,15 @@ It is considered by some grammarians to be a type of adjective or sometimes the > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**OTHER** - -> [Source: ../../../../models.py @ line 107](../../../../models.py#L107) +### *attr* [WordClass.**OTHER**](../../../../models.py#L107) For other part of speech -## *const* **Translator** - -> [Source: ../../../../models.py @ line 113](../../../../models.py#L113) - -## *const* **PRIVATE_ATTRIBUTES** +## *const* [**Translator**](../../../../models.py#L113) -> [Source: ../../../../models.py @ line 115](../../../../models.py#L115) +## *const* [**PRIVATE_ATTRIBUTES**](../../../../models.py#L115) -## *func* **should_be_exported** - -> [Source: ../../../../models.py @ line 118-121](../../../../models.py#L118-L121) +## *func* [**should_be_exported**](../../../../models.py#L118-L121) if the given attribute should be exposed or not @@ -163,33 +115,23 @@ if the given attribute should be exposed or not - **attr**: `str` -## *class* **ResultAttribute** - -> [Source: ../../../../models.py @ line 125-129](../../../../models.py#L125-L129) +## *class* [**ResultAttribute**](../../../../models.py#L125-L129) Details about a result attribute -### *attr* ResultAttribute.**name** - -> [Source: ../../../../models.py @ line 127](../../../../models.py#L127) +### *attr* [ResultAttribute.**name**](../../../../models.py#L127) > Type: `str` -### *attr* ResultAttribute.**annotation** - -> [Source: ../../../../models.py @ line 128](../../../../models.py#L128) +### *attr* [ResultAttribute.**annotation**](../../../../models.py#L128) > Type: `Optional` -### *attr* ResultAttribute.**description** - -> [Source: ../../../../models.py @ line 129](../../../../models.py#L129) +### *attr* [ResultAttribute.**description**](../../../../models.py#L129) > Type: `Optional` -## *class* **Result** - -> [Source: ../../../../models.py @ line 136-287](../../../../models.py#L136-L287) +## *class* [**Result**](../../../../models.py#L136-L287) The base result model @@ -197,33 +139,25 @@ The base result model - `IndexError` -### *attr* Result.**service** - -> [Source: ../../../../models.py @ line 143](../../../../models.py#L143) +### *attr* [Result.**service**](../../../../models.py#L143) > Type: `Translator` The service which returned the result -### *attr* Result.**source** - -> [Source: ../../../../models.py @ line 146](../../../../models.py#L146) +### *attr* [Result.**source**](../../../../models.py#L146) > Type: `str` The source text -### *attr* Result.**source_lang** - -> [Source: ../../../../models.py @ line 148](../../../../models.py#L148) +### *attr* [Result.**source_lang**](../../../../models.py#L148) > Type: `Language` The source text's language -### *attr* Result.**raw** - -> [Source: ../../../../models.py @ line 158](../../../../models.py#L158) +### *attr* [Result.**raw**](../../../../models.py#L158) > Type: `Optional` @@ -231,9 +165,7 @@ The raw response returned by the service. Note: This is very dependent on the service used. Refer to the service documentation to learn how to use this object. -### *property* Result.**attributes** - -> [Source: ../../../../models.py @ line 217-267](../../../../models.py#L217-L267) +### *property* [Result.**attributes**](../../../../models.py#L217-L267) The different attributes on the dataclass @@ -246,9 +178,7 @@ The different attributes on the dataclass - `list` -### *property* Result.**exported** - -> [Source: ../../../../models.py @ line 270-281](../../../../models.py#L270-L281) +### *property* [Result.**exported**](../../../../models.py#L270-L281) A dictionary version of the dataclass which can be exposed to the public @@ -256,169 +186,119 @@ A dictionary version of the dataclass which can be exposed to the public - `dict` -## *class* **TranslationResult** - -> [Source: ../../../../models.py @ line 291-329](../../../../models.py#L291-L329) +## *class* [**TranslationResult**](../../../../models.py#L291-L329) Holds the result of a regular translation -### *attr* TranslationResult.**dest_lang** - -> [Source: ../../../../models.py @ line 296](../../../../models.py#L296) +### *attr* [TranslationResult.**dest_lang**](../../../../models.py#L296) > Type: `Language` The result's language -### *attr* TranslationResult.**translation** - -> [Source: ../../../../models.py @ line 299](../../../../models.py#L299) +### *attr* [TranslationResult.**translation**](../../../../models.py#L299) > Type: `str` The translation result -### *property* TranslationResult.**alternatives** - -> [Source: ../../../../models.py @ line 306-310](../../../../models.py#L306-L310) +### *property* [TranslationResult.**alternatives**](../../../../models.py#L306-L310) Returns the alternative translations associated -## *const* **TRANSLATION_TEST** +## *const* [**TRANSLATION_TEST**](../../../../models.py#L332) -> [Source: ../../../../models.py @ line 332](../../../../models.py#L332) - -## *class* **TransliterationResult** - -> [Source: ../../../../models.py @ line 344-371](../../../../models.py#L344-L371) +## *class* [**TransliterationResult**](../../../../models.py#L344-L371) Holds the result of a transliteration -### *attr* TransliterationResult.**transliteration** - -> [Source: ../../../../models.py @ line 348](../../../../models.py#L348) +### *attr* [TransliterationResult.**transliteration**](../../../../models.py#L348) > Type: `str` The transliteration result -### *attr* TransliterationResult.**dest_lang** - -> [Source: ../../../../models.py @ line 351](../../../../models.py#L351) +### *attr* [TransliterationResult.**dest_lang**](../../../../models.py#L351) > Type: `Language` The result's language -## *const* **TRANSLITERATION_TEST** +## *const* [**TRANSLITERATION_TEST**](../../../../models.py#L374) -> [Source: ../../../../models.py @ line 374](../../../../models.py#L374) - -## *class* **SpellcheckResult** - -> [Source: ../../../../models.py @ line 384-410](../../../../models.py#L384-L410) +## *class* [**SpellcheckResult**](../../../../models.py#L384-L410) Holds a spellchecking result -### *attr* SpellcheckResult.**rich** - -> [Source: ../../../../models.py @ line 389](../../../../models.py#L389) +### *attr* [SpellcheckResult.**rich**](../../../../models.py#L389) -### *attr* SpellcheckResult.**source_lang** - -> [Source: ../../../../models.py @ line 391](../../../../models.py#L391) +### *attr* [SpellcheckResult.**source_lang**](../../../../models.py#L391) > Type: `Language` The source text's language -### *attr* SpellcheckResult.**corrected** - -> [Source: ../../../../models.py @ line 393](../../../../models.py#L393) +### *attr* [SpellcheckResult.**corrected**](../../../../models.py#L393) > Type: `str` The corrected text -## *const* **SPELLCHECK_TEST** - -> [Source: ../../../../models.py @ line 413](../../../../models.py#L413) +## *const* [**SPELLCHECK_TEST**](../../../../models.py#L413) -## *class* **SpellcheckMistake** - -> [Source: ../../../../models.py @ line 422-435](../../../../models.py#L422-L435) +## *class* [**SpellcheckMistake**](../../../../models.py#L422-L435) This holds a mistake made detected by the spellchecker -### *attr* SpellcheckMistake.**start** - -> [Source: ../../../../models.py @ line 424](../../../../models.py#L424) +### *attr* [SpellcheckMistake.**start**](../../../../models.py#L424) > Type: `int` The beginning index of the part to correct in the original text -### *attr* SpellcheckMistake.**end** - -> [Source: ../../../../models.py @ line 426](../../../../models.py#L426) +### *attr* [SpellcheckMistake.**end**](../../../../models.py#L426) > Type: `int` The ending index of the part to correct in the original text -### *attr* SpellcheckMistake.**corrected** - -> [Source: ../../../../models.py @ line 428](../../../../models.py#L428) +### *attr* [SpellcheckMistake.**corrected**](../../../../models.py#L428) > Type: `str` The corrected part -### *attr* SpellcheckMistake.**message** - -> [Source: ../../../../models.py @ line 431](../../../../models.py#L431) +### *attr* [SpellcheckMistake.**message**](../../../../models.py#L431) > Type: `Optional` A message explaining what happened -### *attr* SpellcheckMistake.**rule** - -> [Source: ../../../../models.py @ line 434](../../../../models.py#L434) +### *attr* [SpellcheckMistake.**rule**](../../../../models.py#L434) > Type: `Optional` A string which identifies the rule associated with the mistake made -## *class* **RichSpellcheckResult** - -> [Source: ../../../../models.py @ line 441-601](../../../../models.py#L441-L601) +## *class* [**RichSpellcheckResult**](../../../../models.py#L441-L601) Holds a rich spellchecking result -### *attr* RichSpellcheckResult.**rich** +### *attr* [RichSpellcheckResult.**rich**](../../../../models.py#L447) -> [Source: ../../../../models.py @ line 447](../../../../models.py#L447) - -### *attr* RichSpellcheckResult.**source_lang** - -> [Source: ../../../../models.py @ line 449](../../../../models.py#L449) +### *attr* [RichSpellcheckResult.**source_lang**](../../../../models.py#L449) > Type: `Language` The source text's language -### *attr* RichSpellcheckResult.**mistakes** - -> [Source: ../../../../models.py @ line 451](../../../../models.py#L451) +### *attr* [RichSpellcheckResult.**mistakes**](../../../../models.py#L451) > Type: `List` The different mistakes made -### *property* RichSpellcheckResult.**corrected** - -> [Source: ../../../../models.py @ line 455-463](../../../../models.py#L455-L463) +### *property* [RichSpellcheckResult.**corrected**](../../../../models.py#L455-L463) The corrected text @@ -426,45 +306,31 @@ The corrected text - `str` -## *const* **RICH_SPELLCHECK_TEST** - -> [Source: ../../../../models.py @ line 604](../../../../models.py#L604) - -## *class* **LanguageResult** +## *const* [**RICH_SPELLCHECK_TEST**](../../../../models.py#L604) -> [Source: ../../../../models.py @ line 618-628](../../../../models.py#L618-L628) +## *class* [**LanguageResult**](../../../../models.py#L618-L628) Holds the language of the given text -## *const* **LANGUAGE_TEST** +## *const* [**LANGUAGE_TEST**](../../../../models.py#L631) -> [Source: ../../../../models.py @ line 631](../../../../models.py#L631) - -## *class* **ExampleResult** - -> [Source: ../../../../models.py @ line 635-725](../../../../models.py#L635-L725) +## *class* [**ExampleResult**](../../../../models.py#L635-L725) Holds an example sentence where the given word is used. -### *attr* ExampleResult.**example** - -> [Source: ../../../../models.py @ line 641](../../../../models.py#L641) +### *attr* [ExampleResult.**example**](../../../../models.py#L641) > Type: `str` The example -### *attr* ExampleResult.**reference** - -> [Source: ../../../../models.py @ line 644](../../../../models.py#L644) +### *attr* [ExampleResult.**reference**](../../../../models.py#L644) > Type: `Optional` Where the example comes from (i.e a book or a the person who said it if it's a quote) -### *property* ExampleResult.**position** - -> [Source: ../../../../models.py @ line 648-655](../../../../models.py#L648-L655) +### *property* [ExampleResult.**position**](../../../../models.py#L648-L655) The first position of the word in the example @@ -474,9 +340,7 @@ The first position of the word in the example - `int` -### *property* ExampleResult.**positions** - -> [Source: ../../../../models.py @ line 658-690](../../../../models.py#L658-L690) +### *property* [ExampleResult.**positions**](../../../../models.py#L658-L690) The positions of the word in the example @@ -485,75 +349,51 @@ The positions of the word in the example - `list[int]` - A list of positions of the word in the example -## *const* **EXAMPLE_TEST** - -> [Source: ../../../../models.py @ line 728](../../../../models.py#L728) +## *const* [**EXAMPLE_TEST**](../../../../models.py#L728) -## *class* **DictionaryResult** - -> [Source: ../../../../models.py @ line 737-752](../../../../models.py#L737-L752) +## *class* [**DictionaryResult**](../../../../models.py#L737-L752) Holds the meaning of the given text -### *attr* DictionaryResult.**rich** - -> [Source: ../../../../models.py @ line 743](../../../../models.py#L743) - -### *attr* DictionaryResult.**meaning** +### *attr* [DictionaryResult.**rich**](../../../../models.py#L743) -> [Source: ../../../../models.py @ line 745](../../../../models.py#L745) +### *attr* [DictionaryResult.**meaning**](../../../../models.py#L745) > Type: `str` The meaning of the text -## *const* **DICTIONARY_TEST** +## *const* [**DICTIONARY_TEST**](../../../../models.py#L755) -> [Source: ../../../../models.py @ line 755](../../../../models.py#L755) - -## *class* **EtymologicalNode** - -> [Source: ../../../../models.py @ line 764-791](../../../../models.py#L764-L791) +## *class* [**EtymologicalNode**](../../../../models.py#L764-L791) The node of an etymological tree -### *attr* EtymologicalNode.**origin** - -> [Source: ../../../../models.py @ line 766](../../../../models.py#L766) +### *attr* [EtymologicalNode.**origin**](../../../../models.py#L766) > Type: `str` The origin name (i.e 'Latin') -### *attr* EtymologicalNode.**source** - -> [Source: ../../../../models.py @ line 769](../../../../models.py#L769) +### *attr* [EtymologicalNode.**source**](../../../../models.py#L769) > Type: `Optional` The original way of writing it -### *attr* EtymologicalNode.**year** - -> [Source: ../../../../models.py @ line 771](../../../../models.py#L771) +### *attr* [EtymologicalNode.**year**](../../../../models.py#L771) > Type: `Optional` The year of origin -## *class* **RichDictionaryResult** - -> [Source: ../../../../models.py @ line 795-904](../../../../models.py#L795-L904) +## *class* [**RichDictionaryResult**](../../../../models.py#L795-L904) Holds more (optional) information than the regular `DictionaryResult` -### *attr* RichDictionaryResult.**rich** +### *attr* [RichDictionaryResult.**rich**](../../../../models.py#L801) -> [Source: ../../../../models.py @ line 801](../../../../models.py#L801) - -### *attr* RichDictionaryResult.**etymology** - -> [Source: ../../../../models.py @ line 803](../../../../models.py#L803) +### *attr* [RichDictionaryResult.**etymology**](../../../../models.py#L803) > Type: `List` @@ -566,9 +406,7 @@ Each element corresponds to a node in the tree of origins for the given text `Node1 (Greek) -> Node2 (Latin) -> Node3 (French) -> Node4 (Ancient English) -> Current Word` -### *attr* RichDictionaryResult.**gender** - -> [Source: ../../../../models.py @ line 814](../../../../models.py#L814) +### *attr* [RichDictionaryResult.**gender**](../../../../models.py#L814) > Type: `Gender` @@ -580,77 +418,55 @@ For languages which assign genders on words `chaîse (french; a chair) -> Gender.FEMALE` -### *attr* RichDictionaryResult.**pronunciation** - -> [Source: ../../../../models.py @ line 823](../../../../models.py#L823) +### *attr* [RichDictionaryResult.**pronunciation**](../../../../models.py#L823) > Type: `Optional` A way of pronouncing the text -### *attr* RichDictionaryResult.**type** - -> [Source: ../../../../models.py @ line 826](../../../../models.py#L826) +### *attr* [RichDictionaryResult.**type**](../../../../models.py#L826) > Type: `WordClass` The part of speech of the text -### *attr* RichDictionaryResult.**synonyms** - -> [Source: ../../../../models.py @ line 829](../../../../models.py#L829) +### *attr* [RichDictionaryResult.**synonyms**](../../../../models.py#L829) > Type: `List` -### *attr* RichDictionaryResult.**antonyms** - -> [Source: ../../../../models.py @ line 830](../../../../models.py#L830) +### *attr* [RichDictionaryResult.**antonyms**](../../../../models.py#L830) > Type: `List` -## *const* **RICH_DICTIONARY_TEST** +## *const* [**RICH_DICTIONARY_TEST**](../../../../models.py#L907) -> [Source: ../../../../models.py @ line 907](../../../../models.py#L907) - -## *class* **TextToSpeechResult** - -> [Source: ../../../../models.py @ line 922-988](../../../../models.py#L922-L988) +## *class* [**TextToSpeechResult**](../../../../models.py#L922-L988) Holds the text to speech results -### *attr* TextToSpeechResult.**result** - -> [Source: ../../../../models.py @ line 928](../../../../models.py#L928) +### *attr* [TextToSpeechResult.**result**](../../../../models.py#L928) > Type: `bytes` Text to speech result -### *attr* TextToSpeechResult.**speed** - -> [Source: ../../../../models.py @ line 930](../../../../models.py#L930) +### *attr* [TextToSpeechResult.**speed**](../../../../models.py#L930) > Type: `int` Speed of the text to speech result -### *attr* TextToSpeechResult.**gender** - -> [Source: ../../../../models.py @ line 932](../../../../models.py#L932) +### *attr* [TextToSpeechResult.**gender**](../../../../models.py#L932) > Type: `Gender` Gender of the 'person' saying the text -### *property* TextToSpeechResult.**type** - -> [Source: ../../../../models.py @ line 936-938](../../../../models.py#L936-L938) +### *property* [TextToSpeechResult.**type**](../../../../models.py#L936-L938) Returns the type of audio file -### *property* TextToSpeechResult.**mime_type** - -> [Source: ../../../../models.py @ line 941-953](../../../../models.py#L941-L953) +### *property* [TextToSpeechResult.**mime_type**](../../../../models.py#L941-L953) Returns the MIME type of the audio file @@ -659,9 +475,7 @@ Returns the MIME type of the audio file - `Optional[str]` - The MIME type of the audio file -### *property* TextToSpeechResult.**extension** - -> [Source: ../../../../models.py @ line 956-968](../../../../models.py#L956-L968) +### *property* [TextToSpeechResult.**extension**](../../../../models.py#L956-L968) Returns the audio file extension @@ -670,9 +484,7 @@ Returns the audio file extension - `Optional[str]` - The MIME type of the audio file -### *func* TextToSpeechResult.**write_to_file** - -> [Source: ../../../../models.py @ line 970-988](../../../../models.py#L970-L988) +### *func* [TextToSpeechResult.**write_to_file**](../../../../models.py#L970-L988) Writes the spoken text to a file. @@ -687,27 +499,19 @@ Writes the spoken text to a file. - If we need to change the extension of the file to match the right file type -## *class* **HTMLTranslationNode** - -> [Source: ../../../../models.py @ line 992-1029](../../../../models.py#L992-L1029) +## *class* [**HTMLTranslationNode**](../../../../models.py#L992-L1029) A translation node, containing the DOM element and its translation result -### *attr* HTMLTranslationNode.**node** - -> [Source: ../../../../models.py @ line 996](../../../../models.py#L996) +### *attr* [HTMLTranslationNode.**node**](../../../../models.py#L996) > Type: `bs4.NavigableString` -### *attr* HTMLTranslationNode.**result** - -> [Source: ../../../../models.py @ line 997](../../../../models.py#L997) +### *attr* [HTMLTranslationNode.**result**](../../../../models.py#L997) > Type: `Optional` -### *property* HTMLTranslationNode.**position** - -> [Source: ../../../../models.py @ line 1000-1020](../../../../models.py#L1000-L1020) +### *property* [HTMLTranslationNode.**position**](../../../../models.py#L1000-L1020) The position of the node in the HTML @@ -715,9 +519,7 @@ The position of the node in the HTML - `int` -### *property* HTMLTranslationNode.**exported** - -> [Source: ../../../../models.py @ line 1023-1029](../../../../models.py#L1023-L1029) +### *property* [HTMLTranslationNode.**exported**](../../../../models.py#L1023-L1029) The exported dictionary @@ -725,33 +527,23 @@ The exported dictionary - `dict` -## *class* **HTMLTranslationResult** - -> [Source: ../../../../models.py @ line 1033-1052](../../../../models.py#L1033-L1052) +## *class* [**HTMLTranslationResult**](../../../../models.py#L1033-L1052) Holds an HTML translation result -### *attr* HTMLTranslationResult.**result** - -> [Source: ../../../../models.py @ line 1037](../../../../models.py#L1037) +### *attr* [HTMLTranslationResult.**result**](../../../../models.py#L1037) > Type: `str` -### *attr* HTMLTranslationResult.**soup** - -> [Source: ../../../../models.py @ line 1038](../../../../models.py#L1038) +### *attr* [HTMLTranslationResult.**soup**](../../../../models.py#L1038) > Type: `bs4.BeautifulSoup` -### *attr* HTMLTranslationResult.**nodes** - -> [Source: ../../../../models.py @ line 1039](../../../../models.py#L1039) +### *attr* [HTMLTranslationResult.**nodes**](../../../../models.py#L1039) > Type: `List` -### *property* HTMLTranslationResult.**exported** - -> [Source: ../../../../models.py @ line 1048-1052](../../../../models.py#L1048-L1052) +### *property* [HTMLTranslationResult.**exported**](../../../../models.py#L1048-L1052) #### Returns diff --git a/translatepy/server/docs/eng/reference/server/server.md b/translatepy/server/docs/eng/reference/server/server.md index 3fac41e..a95efb2 100644 --- a/translatepy/server/docs/eng/reference/server/server.md +++ b/translatepy/server/docs/eng/reference/server/server.md @@ -1,23 +1,17 @@ # *module* **server** -> [Source: ../../../../server.py @ line 0](../../../../server.py#L0) +> [Source: ../../../../server.py](../../../../server.py#L0) the translatepy server -## *const* **app** - -> [Source: ../../../../server.py @ line 6](../../../../server.py#L6) +## *const* [**app**](../../../../server.py#L6) The `nasse` server instance for `translatepy` -## *const* **TRANSLATEPY_ENDPOINT** - -> [Source: ../../../../server.py @ line 9](../../../../server.py#L9) +## *const* [**TRANSLATEPY_ENDPOINT**](../../../../server.py#L9) Base `translatepy` endpoint -## *const* **SERVER_DOCS_PATH** - -> [Source: ../../../../server.py @ line 13](../../../../server.py#L13) +## *const* [**SERVER_DOCS_PATH**](../../../../server.py#L13) The root path for the server offline docs diff --git a/translatepy/server/docs/eng/reference/translate.md b/translatepy/server/docs/eng/reference/translate.md index 32695c3..89256a1 100644 --- a/translatepy/server/docs/eng/reference/translate.md +++ b/translatepy/server/docs/eng/reference/translate.md @@ -1,6 +1,6 @@ # *module* **translate** -> [Source: ../../../../translate.py @ line 0](../../../../translate.py#L0) +> [Source: ../../../../translate.py](../../../../translate.py#L0) translatepy v3.0 © Anime no Sekai — 2023 @@ -37,14 +37,10 @@ translatepy v3.0 - [../../../../utils/request.py](../../../../utils/request.py): As `request` -## *const* **DEFAULT_TRANSLATORS** - -> [Source: ../../../../translate.py @ line 15](../../../../translate.py#L15) +## *const* [**DEFAULT_TRANSLATORS**](../../../../translate.py#L15) A list of default translators to use with the translators aggregation -## *class* **Translate** - -> [Source: ../../../../translate.py @ line 20-27](../../../../translate.py#L20-L27) +## *class* [**Translate**](../../../../translate.py#L20-L27) A class which groups all of the translators diff --git a/translatepy/server/docs/eng/reference/translators/README.md b/translatepy/server/docs/eng/reference/translators/README.md index f1565ab..1bb8003 100644 --- a/translatepy/server/docs/eng/reference/translators/README.md +++ b/translatepy/server/docs/eng/reference/translators/README.md @@ -1,6 +1,6 @@ # *module* **__init__** -> [Source: ../../../../../translators/__init__.py @ line 0](../../../../../translators/__init__.py#L0) +> [Source: ../../../../../translators/__init__.py](../../../../../translators/__init__.py#L0) ## Imports @@ -30,58 +30,30 @@ - [../../../../../translators/papago.py](../../../../../translators/papago.py): As `Papago` -## *const* **Reverso** +## *const* [**Reverso**](../../../../../translators/__init__.py#L21) -> [Source: ../../../../../translators/__init__.py @ line 21](../../../../../translators/__init__.py#L21) +## *const* [**Bing**](../../../../../translators/__init__.py#L22) -## *const* **Bing** +## *const* [**DeepL**](../../../../../translators/__init__.py#L23) -> [Source: ../../../../../translators/__init__.py @ line 22](../../../../../translators/__init__.py#L22) +## *const* [**Deepl**](../../../../../translators/__init__.py#L24) -## *const* **DeepL** +## *const* [**Google**](../../../../../translators/__init__.py#L25) -> [Source: ../../../../../translators/__init__.py @ line 23](../../../../../translators/__init__.py#L23) +## *const* [**Libre**](../../../../../translators/__init__.py#L26) -## *const* **Deepl** +## *const* [**MyMemory**](../../../../../translators/__init__.py#L27) -> [Source: ../../../../../translators/__init__.py @ line 24](../../../../../translators/__init__.py#L24) +## *const* [**TranslateCom**](../../../../../translators/__init__.py#L28) -## *const* **Google** +## *const* [**Yandex**](../../../../../translators/__init__.py#L29) -> [Source: ../../../../../translators/__init__.py @ line 25](../../../../../translators/__init__.py#L25) +## *const* [**Microsoft**](../../../../../translators/__init__.py#L30) -## *const* **Libre** +## *const* [**QCRITranslate**](../../../../../translators/__init__.py#L32) -> [Source: ../../../../../translators/__init__.py @ line 26](../../../../../translators/__init__.py#L26) +## *const* [**PONSTranslate**](../../../../../translators/__init__.py#L33) -## *const* **MyMemory** +## *const* [**PapagoTranslate**](../../../../../translators/__init__.py#L34) -> [Source: ../../../../../translators/__init__.py @ line 27](../../../../../translators/__init__.py#L27) - -## *const* **TranslateCom** - -> [Source: ../../../../../translators/__init__.py @ line 28](../../../../../translators/__init__.py#L28) - -## *const* **Yandex** - -> [Source: ../../../../../translators/__init__.py @ line 29](../../../../../translators/__init__.py#L29) - -## *const* **Microsoft** - -> [Source: ../../../../../translators/__init__.py @ line 30](../../../../../translators/__init__.py#L30) - -## *const* **QCRITranslate** - -> [Source: ../../../../../translators/__init__.py @ line 32](../../../../../translators/__init__.py#L32) - -## *const* **PONSTranslate** - -> [Source: ../../../../../translators/__init__.py @ line 33](../../../../../translators/__init__.py#L33) - -## *const* **PapagoTranslate** - -> [Source: ../../../../../translators/__init__.py @ line 34](../../../../../translators/__init__.py#L34) - -## *const* **NaverTranslate** - -> [Source: ../../../../../translators/__init__.py @ line 35](../../../../../translators/__init__.py#L35) +## *const* [**NaverTranslate**](../../../../../translators/__init__.py#L35) diff --git a/translatepy/server/docs/eng/reference/translators/base.md b/translatepy/server/docs/eng/reference/translators/base.md index 34421d7..dd36a6b 100644 --- a/translatepy/server/docs/eng/reference/translators/base.md +++ b/translatepy/server/docs/eng/reference/translators/base.md @@ -1,25 +1,17 @@ # *module* **base** -> [Source: ../../../../../translators/base.py @ line 0](../../../../../translators/base.py#L0) +> [Source: ../../../../../translators/base.py](../../../../../translators/base.py#L0) translators/base.py Implements the Base Translator class -## *const* **C** +## *const* [**C**](../../../../../translators/base.py#L25) -> [Source: ../../../../../translators/base.py @ line 25](../../../../../translators/base.py#L25) +## *const* [**R**](../../../../../translators/base.py#L26) -## *const* **R** +## *const* [**HTMLType**](../../../../../translators/base.py#L27) -> [Source: ../../../../../translators/base.py @ line 26](../../../../../translators/base.py#L26) - -## *const* **HTMLType** - -> [Source: ../../../../../translators/base.py @ line 27](../../../../../translators/base.py#L27) - -## *class* **LazyIterable** - -> [Source: ../../../../../translators/base.py @ line 30-69](../../../../../translators/base.py#L30-L69) +## *class* [**LazyIterable**](../../../../../translators/base.py#L30-L69) An object which can be iterated through, even multiple times, but lazy loads the results. @@ -27,33 +19,21 @@ An object which can be iterated through, even multiple times, but lazy loads the - `IndexError` -## *const* **T** - -> [Source: ../../../../../translators/base.py @ line 73](../../../../../translators/base.py#L73) +## *const* [**T**](../../../../../translators/base.py#L73) -## *class* **BaseTranslateException** - -> [Source: ../../../../../translators/base.py @ line 79-105](../../../../../translators/base.py#L79-L105) +## *class* [**BaseTranslateException**](../../../../../translators/base.py#L79-L105) A translator exception, indicating a problem which occured during translation -### *attr* BaseTranslateException.**error_codes** - -> [Source: ../../../../../translators/base.py @ line 83](../../../../../translators/base.py#L83) - -## *class* **Flag** +### *attr* [BaseTranslateException.**error_codes**](../../../../../translators/base.py#L83) -> [Source: ../../../../../translators/base.py @ line 108-112](../../../../../translators/base.py#L108-L112) +## *class* [**Flag**](../../../../../translators/base.py#L108-L112) Defines a set of internal flags the handlers can send to the validator -### *attr* Flag.**MULTIPLE_RESULTS** - -> [Source: ../../../../../translators/base.py @ line 112](../../../../../translators/base.py#L112) - -## *class* **BaseTranslator** +### *attr* [Flag.**MULTIPLE_RESULTS**](../../../../../translators/base.py#L112) -> [Source: ../../../../../translators/base.py @ line 115-1293](../../../../../translators/base.py#L115-L1293) +## *class* [**BaseTranslator**](../../../../../translators/base.py#L115-L1293) The core of translatepy This defines a "Translator" instance, which is the gateway between the translator logic and translatepy @@ -68,9 +48,7 @@ This defines a "Translator" instance, which is the gateway between the translato - `exceptions.UnsupportedMethod` -### *func* BaseTranslator.**translate** - -> [Source: ../../../../../translators/base.py @ line 307-324](../../../../../translators/base.py#L307-L324) +### *func* [BaseTranslator.**translate**](../../../../../translators/base.py#L307-L324) Translates the given `text` into the given `dest_lang` @@ -102,9 +80,7 @@ Translates the given `text` into the given `dest_lang` - `models.TranslationResult` -### *func* BaseTranslator.**translate** - -> [Source: ../../../../../translators/base.py @ line 327-346](../../../../../translators/base.py#L327-L346) +### *func* [BaseTranslator.**translate**](../../../../../translators/base.py#L327-L346) Translates all of the elements in `text` into the given `dest_lang` @@ -139,9 +115,7 @@ Translates all of the elements in `text` into the given `dest_lang` > **Note** > aka "Bulk Translation" -### *func* BaseTranslator.**translate** - -> [Source: ../../../../../translators/base.py @ line 351-393](../../../../../translators/base.py#L351-L393) +### *func* [BaseTranslator.**translate**](../../../../../translators/base.py#L351-L393) Translates `text` into the given `dest_lang` @@ -172,9 +146,7 @@ Translates `text` into the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../../translators/base.py @ line 420-451](../../../../../translators/base.py#L420-L451) +### *func* [BaseTranslator.**translate_html**](../../../../../translators/base.py#L420-L451) Translates the given `html` into the given `dest_lang` @@ -222,9 +194,7 @@ If `False`, the node will be left as is and the `result` part will be `None` - `models.HTMLTranslationResult` -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../../translators/base.py @ line 454-486](../../../../../translators/base.py#L454-L486) +### *func* [BaseTranslator.**translate_html**](../../../../../translators/base.py#L454-L486) Translates all of the elements in `html` into the given `dest_lang` @@ -275,9 +245,7 @@ If `False`, the node will be left as is and the `result` part will be `None` > **Note** > aka "Bulk Translation" -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../../translators/base.py @ line 489-565](../../../../../translators/base.py#L489-L565) +### *func* [BaseTranslator.**translate_html**](../../../../../translators/base.py#L489-L565) Translates `html` into the given `dest_lang` @@ -324,9 +292,7 @@ Translates `html` into the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../../translators/base.py @ line 573-586](../../../../../translators/base.py#L573-L586) +### *func* [BaseTranslator.**alternatives**](../../../../../translators/base.py#L573-L586) Returns the different alternative translations available for a given previous translation. @@ -349,9 +315,7 @@ Returns the different alternative translations available for a given previous tr - `list[TranslationResult]` - The list of other translations a word might have -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../../translators/base.py @ line 589-602](../../../../../translators/base.py#L589-L602) +### *func* [BaseTranslator.**alternatives**](../../../../../translators/base.py#L589-L602) Returns the different alternative translations available for all of the given translations. @@ -374,9 +338,7 @@ Returns the different alternative translations available for all of the given tr - `LazyIterable[list[TranslationResult]]` - All of the other translations -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../../translators/base.py @ line 606-632](../../../../../translators/base.py#L606-L632) +### *func* [BaseTranslator.**alternatives**](../../../../../translators/base.py#L606-L632) Returns the different alternative translations available for the given `translation`. @@ -400,9 +362,7 @@ Returns the different alternative translations available for the given `translat > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../../translators/base.py @ line 664-681](../../../../../translators/base.py#L664-L681) +### *func* [BaseTranslator.**transliterate**](../../../../../translators/base.py#L664-L681) Transliterates the given `text` into the given `dest_lang` @@ -434,9 +394,7 @@ Transliterates the given `text` into the given `dest_lang` - `models.TransliterationResult` -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../../translators/base.py @ line 684-701](../../../../../translators/base.py#L684-L701) +### *func* [BaseTranslator.**transliterate**](../../../../../translators/base.py#L684-L701) Transliterates all of the given `text` to the given `dest_lang` @@ -468,9 +426,7 @@ Transliterates all of the given `text` to the given `dest_lang` - `LazyIterable[TransliterationResult]` - An iterable which contains the transliterations -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../../translators/base.py @ line 704-750](../../../../../translators/base.py#L704-L750) +### *func* [BaseTranslator.**transliterate**](../../../../../translators/base.py#L704-L750) Transliterates the given `text` to the given `dest_lang` @@ -501,13 +457,9 @@ Transliterates the given `text` to the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *attr* BaseTranslator.**transliteration** - -> [Source: ../../../../../translators/base.py @ line 753](../../../../../translators/base.py#L753) +### *attr* [BaseTranslator.**transliteration**](../../../../../translators/base.py#L753) -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../../translators/base.py @ line 781-798](../../../../../translators/base.py#L781-L798) +### *func* [BaseTranslator.**spellcheck**](../../../../../translators/base.py#L781-L798) Checks for spelling mistakes in the given `text` @@ -540,9 +492,7 @@ Checks for spelling mistakes in the given `text` - `SpellcheckResult` - The result of the spell check -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../../translators/base.py @ line 801-818](../../../../../translators/base.py#L801-L818) +### *func* [BaseTranslator.**spellcheck**](../../../../../translators/base.py#L801-L818) Checks for spelling mistakes in all of the given `text` @@ -573,9 +523,7 @@ Checks for spelling mistakes in all of the given `text` - `LazyIterable[SpellcheckResult]` - The results of the spell checks -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../../translators/base.py @ line 822-853](../../../../../translators/base.py#L822-L853) +### *func* [BaseTranslator.**spellcheck**](../../../../../translators/base.py#L822-L853) Checks for spelling mistakes in the given `text` @@ -605,9 +553,7 @@ Checks for spelling mistakes in the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**language** - -> [Source: ../../../../../translators/base.py @ line 881-894](../../../../../translators/base.py#L881-L894) +### *func* [BaseTranslator.**language**](../../../../../translators/base.py#L881-L894) Returns the detected language for the given `text` @@ -630,9 +576,7 @@ Returns the detected language for the given `text` - `models.LanguageResult` -### *func* BaseTranslator.**language** - -> [Source: ../../../../../translators/base.py @ line 897-910](../../../../../translators/base.py#L897-L910) +### *func* [BaseTranslator.**language**](../../../../../translators/base.py#L897-L910) Returns the detected language for all of the given `text` @@ -655,9 +599,7 @@ Returns the detected language for all of the given `text` - `LazyIterable[LanguageResult]` - The results of the language detections -### *func* BaseTranslator.**language** - -> [Source: ../../../../../translators/base.py @ line 914-936](../../../../../translators/base.py#L914-L936) +### *func* [BaseTranslator.**language**](../../../../../translators/base.py#L914-L936) Returns the detected language for the given `text` @@ -685,9 +627,7 @@ Returns the detected language for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**example** - -> [Source: ../../../../../translators/base.py @ line 960-975](../../../../../translators/base.py#L960-L975) +### *func* [BaseTranslator.**example**](../../../../../translators/base.py#L960-L975) Returns use cases for the given `text` @@ -715,9 +655,7 @@ Returns use cases for the given `text` - `list[ExampleResult]` - The examples -### *func* BaseTranslator.**example** - -> [Source: ../../../../../translators/base.py @ line 978-993](../../../../../translators/base.py#L978-L993) +### *func* [BaseTranslator.**example**](../../../../../translators/base.py#L978-L993) Returns use cases for all of the given `text` @@ -745,9 +683,7 @@ Returns use cases for all of the given `text` - `LazyIterable[list[ExampleResult]]` - All of the examples -### *func* BaseTranslator.**example** - -> [Source: ../../../../../translators/base.py @ line 997-1031](../../../../../translators/base.py#L997-L1031) +### *func* [BaseTranslator.**example**](../../../../../translators/base.py#L997-L1031) Returns use cases for the given `text` @@ -775,9 +711,7 @@ Returns use cases for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../../translators/base.py @ line 1060-1077](../../../../../translators/base.py#L1060-L1077) +### *func* [BaseTranslator.**dictionary**](../../../../../translators/base.py#L1060-L1077) Returns the meaning for the given `text` @@ -808,9 +742,7 @@ Returns the meaning for the given `text` - `list` -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../../translators/base.py @ line 1080-1097](../../../../../translators/base.py#L1080-L1097) +### *func* [BaseTranslator.**dictionary**](../../../../../translators/base.py#L1080-L1097) Returns the meaning for all of the given `text` @@ -841,9 +773,7 @@ Returns the meaning for all of the given `text` - `LazyIterable[RichDictionaryResult]` - If supported, a value which contains much more information on all of the `text` -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../../translators/base.py @ line 1101-1135](../../../../../translators/base.py#L1101-L1135) +### *func* [BaseTranslator.**dictionary**](../../../../../translators/base.py#L1101-L1135) Returns the meaning for the given `text` @@ -871,9 +801,7 @@ Returns the meaning for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../../translators/base.py @ line 1161-1180](../../../../../translators/base.py#L1161-L1180) +### *func* [BaseTranslator.**text_to_speech**](../../../../../translators/base.py#L1161-L1180) Returns the speech version of the given `text` @@ -900,9 +828,7 @@ Returns the speech version of the given `text` - `TextToSpeechResult` - The text to speech result -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../../translators/base.py @ line 1183-1202](../../../../../translators/base.py#L1183-L1202) +### *func* [BaseTranslator.**text_to_speech**](../../../../../translators/base.py#L1183-L1202) Returns the speech version for all of the given `text` @@ -929,18 +855,14 @@ Returns the speech version for all of the given `text` - `LazyIterable[TextToSpeechResult]` - The text to speech results -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../../translators/base.py @ line 1205-1241](../../../../../translators/base.py#L1205-L1241) +### *func* [BaseTranslator.**text_to_speech**](../../../../../translators/base.py#L1205-L1241) Returns the speech version of the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**clean_cache** - -> [Source: ../../../../../translators/base.py @ line 1265-1274](../../../../../translators/base.py#L1265-L1274) +### *func* [BaseTranslator.**clean_cache**](../../../../../translators/base.py#L1265-L1274) Cleans caches diff --git a/translatepy/server/docs/eng/reference/translators/base_aggregator.md b/translatepy/server/docs/eng/reference/translators/base_aggregator.md index 2149f83..487bc04 100644 --- a/translatepy/server/docs/eng/reference/translators/base_aggregator.md +++ b/translatepy/server/docs/eng/reference/translators/base_aggregator.md @@ -1,14 +1,12 @@ # *module* **base_aggregator** -> [Source: ../../../../../translators/base_aggregator.py @ line 0](../../../../../translators/base_aggregator.py#L0) +> [Source: ../../../../../translators/base_aggregator.py](../../../../../translators/base_aggregator.py#L0) ## Imports - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslator`, `C` -## *class* **BaseTranslatorAggregator** - -> [Source: ../../../../../translators/base_aggregator.py @ line 9-145](../../../../../translators/base_aggregator.py#L9-L145) +## *class* [**BaseTranslatorAggregator**](../../../../../translators/base_aggregator.py#L9-L145) ### Raises diff --git a/translatepy/server/docs/eng/reference/translators/bing.md b/translatepy/server/docs/eng/reference/translators/bing.md index b60f86d..1b12748 100644 --- a/translatepy/server/docs/eng/reference/translators/bing.md +++ b/translatepy/server/docs/eng/reference/translators/bing.md @@ -1,6 +1,6 @@ # *module* **Bing** -> [Source: ../../../../../translators/Bing.py @ line 0](../../../../../translators/Bing.py#L0) +> [Source: ../../../../../translators/Bing.py](../../../../../translators/Bing.py#L0) This implementation was made specifically for translatepy from 'Zhymabek Roman', based on 'Anime no Sekai' version. @@ -8,59 +8,39 @@ This implementation was made specifically for translatepy from 'Zhymabek Roman', - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator` -## *class* **BingTranslateException** +## *class* [**BingTranslateException**](../../../../../translators/Bing.py#L20-L23) -> [Source: ../../../../../translators/Bing.py @ line 20-23](../../../../../translators/Bing.py#L20-L23) +### *attr* [BingTranslateException.**error_codes**](../../../../../translators/Bing.py#L21) -### *attr* BingTranslateException.**error_codes** - -> [Source: ../../../../../translators/Bing.py @ line 21](../../../../../translators/Bing.py#L21) - -## *class* **BingSessionData** - -> [Source: ../../../../../translators/Bing.py @ line 26-33](../../../../../translators/Bing.py#L26-L33) +## *class* [**BingSessionData**](../../../../../translators/Bing.py#L26-L33) Bing session data holder -### *attr* BingSessionData.**ig** - -> [Source: ../../../../../translators/Bing.py @ line 28](../../../../../translators/Bing.py#L28) +### *attr* [BingSessionData.**ig**](../../../../../translators/Bing.py#L28) > Type: `str` -### *attr* BingSessionData.**iid** - -> [Source: ../../../../../translators/Bing.py @ line 29](../../../../../translators/Bing.py#L29) +### *attr* [BingSessionData.**iid**](../../../../../translators/Bing.py#L29) > Type: `str` -### *attr* BingSessionData.**key** - -> [Source: ../../../../../translators/Bing.py @ line 30](../../../../../translators/Bing.py#L30) +### *attr* [BingSessionData.**key**](../../../../../translators/Bing.py#L30) > Type: `cain.types.UInt64` -### *attr* BingSessionData.**token** - -> [Source: ../../../../../translators/Bing.py @ line 31](../../../../../translators/Bing.py#L31) +### *attr* [BingSessionData.**token**](../../../../../translators/Bing.py#L31) > Type: `str` -### *attr* BingSessionData.**cookies_keys** - -> [Source: ../../../../../translators/Bing.py @ line 32](../../../../../translators/Bing.py#L32) +### *attr* [BingSessionData.**cookies_keys**](../../../../../translators/Bing.py#L32) > Type: `List` -### *attr* BingSessionData.**cookies_values** - -> [Source: ../../../../../translators/Bing.py @ line 33](../../../../../translators/Bing.py#L33) +### *attr* [BingSessionData.**cookies_values**](../../../../../translators/Bing.py#L33) > Type: `List` -## *class* **BingSessionManager** - -> [Source: ../../../../../translators/Bing.py @ line 36-136](../../../../../translators/Bing.py#L36-L136) +## *class* [**BingSessionManager**](../../../../../translators/Bing.py#L36-L136) Creates and manages a Bing session @@ -68,9 +48,7 @@ Creates and manages a Bing session - `BingTranslateException` -### *func* BingSessionManager.**send** - -> [Source: ../../../../../translators/Bing.py @ line 92-136](../../../../../translators/Bing.py#L92-L136) +### *func* [BingSessionManager.**send**](../../../../../translators/Bing.py#L92-L136) Sends requestts to the API @@ -86,9 +64,7 @@ Sends requestts to the API - `BingTranslateException` -## *class* **BingTranslate** - -> [Source: ../../../../../translators/Bing.py @ line 145-251](../../../../../translators/Bing.py#L145-L251) +## *class* [**BingTranslate**](../../../../../translators/Bing.py#L145-L251) A Python implementation of Microsoft Bing Translation's APIs diff --git a/translatepy/server/docs/eng/reference/translators/deepl.md b/translatepy/server/docs/eng/reference/translators/deepl.md index 3deb1ca..34d9fa8 100644 --- a/translatepy/server/docs/eng/reference/translators/deepl.md +++ b/translatepy/server/docs/eng/reference/translators/deepl.md @@ -1,6 +1,6 @@ # *module* **DeepL** -> [Source: ../../../../../translators/DeepL.py @ line 0](../../../../../translators/DeepL.py#L0) +> [Source: ../../../../../translators/DeepL.py](../../../../../translators/DeepL.py#L0) DeepL Implementation for translatepy @@ -19,53 +19,33 @@ Refer to Animenosekai/translate#7 Arrangements, optimizations - **ZhymabekRoman** Co-Author -## *const* **SENTENCES_SPLITTING_REGEX** +## *const* [**SENTENCES_SPLITTING_REGEX**](../../../../../translators/DeepL.py#L31) -> [Source: ../../../../../translators/DeepL.py @ line 31](../../../../../translators/DeepL.py#L31) +## *class* [**DeeplFormality**](../../../../../translators/DeepL.py#L34-L36) -## *class* **DeeplFormality** +### *attr* [DeeplFormality.**formal**](../../../../../translators/DeepL.py#L35) -> [Source: ../../../../../translators/DeepL.py @ line 34-36](../../../../../translators/DeepL.py#L34-L36) +### *attr* [DeeplFormality.**informal**](../../../../../translators/DeepL.py#L36) -### *attr* DeeplFormality.**formal** +## *class* [**DeeplTranslate**](../../../../../translators/DeepL.py#L39-L41) -> [Source: ../../../../../translators/DeepL.py @ line 35](../../../../../translators/DeepL.py#L35) - -### *attr* DeeplFormality.**informal** - -> [Source: ../../../../../translators/DeepL.py @ line 36](../../../../../translators/DeepL.py#L36) - -## *class* **DeeplTranslate** - -> [Source: ../../../../../translators/DeepL.py @ line 39-41](../../../../../translators/DeepL.py#L39-L41) - -## *class* **DeeplTranslateException** - -> [Source: ../../../../../translators/DeepL.py @ line 44-51](../../../../../translators/DeepL.py#L44-L51) +## *class* [**DeeplTranslateException**](../../../../../translators/DeepL.py#L44-L51) Default DeepL Translate exception -### *attr* DeeplTranslateException.**error_codes** - -> [Source: ../../../../../translators/DeepL.py @ line 49](../../../../../translators/DeepL.py#L49) - -## *class* **GetClientState** +### *attr* [DeeplTranslateException.**error_codes**](../../../../../translators/DeepL.py#L49) -> [Source: ../../../../../translators/DeepL.py @ line 54-82](../../../../../translators/DeepL.py#L54-L82) +## *class* [**GetClientState**](../../../../../translators/DeepL.py#L54-L82) DeepL Translate state manager -### *func* GetClientState.**dump** - -> [Source: ../../../../../translators/DeepL.py @ line 63-74](../../../../../translators/DeepL.py#L63-L74) +### *func* [GetClientState.**dump**](../../../../../translators/DeepL.py#L63-L74) #### Returns - `dict` -### *func* GetClientState.**get** - -> [Source: ../../../../../translators/DeepL.py @ line 76-82](../../../../../translators/DeepL.py#L76-L82) +### *func* [GetClientState.**get**](../../../../../translators/DeepL.py#L76-L82) Returns a new Client State ID @@ -73,15 +53,11 @@ Returns a new Client State ID - `int` -## *class* **JSONRPCRequest** - -> [Source: ../../../../../translators/DeepL.py @ line 85-121](../../../../../translators/DeepL.py#L85-L121) +## *class* [**JSONRPCRequest**](../../../../../translators/DeepL.py#L85-L121) JSON RPC Request Sender for DeepL -### *func* JSONRPCRequest.**dump** - -> [Source: ../../../../../translators/DeepL.py @ line 99-107](../../../../../translators/DeepL.py#L99-L107) +### *func* [JSONRPCRequest.**dump**](../../../../../translators/DeepL.py#L99-L107) #### Parameters @@ -91,9 +67,7 @@ JSON RPC Request Sender for DeepL - **params**: `dict` -### *func* JSONRPCRequest.**send_jsonrpc** - -> [Source: ../../../../../translators/DeepL.py @ line 109-121](../../../../../translators/DeepL.py#L109-L121) +### *func* [JSONRPCRequest.**send_jsonrpc**](../../../../../translators/DeepL.py#L109-L121) #### Parameters @@ -107,17 +81,13 @@ JSON RPC Request Sender for DeepL - `dict` -## *class* **DeeplTranslateV1** - -> [Source: ../../../../../translators/DeepL.py @ line 124-308](../../../../../translators/DeepL.py#L124-L308) +## *class* [**DeeplTranslateV1**](../../../../../translators/DeepL.py#L124-L308) ### Raises - `exceptions.UnsupportedMethod` -## *class* **DeeplTranslateV2** - -> [Source: ../../../../../translators/DeepL.py @ line 311-386](../../../../../translators/DeepL.py#L311-L386) +## *class* [**DeeplTranslateV2**](../../../../../translators/DeepL.py#L311-L386) ### Raises diff --git a/translatepy/server/docs/eng/reference/translators/google.md b/translatepy/server/docs/eng/reference/translators/google.md index 7fa3f0e..957a5ce 100644 --- a/translatepy/server/docs/eng/reference/translators/google.md +++ b/translatepy/server/docs/eng/reference/translators/google.md @@ -1,6 +1,6 @@ # *module* **Google** -> [Source: ../../../../../translators/Google.py @ line 0](../../../../../translators/Google.py#L0) +> [Source: ../../../../../translators/Google.py](../../../../../translators/Google.py#L0) Google Translate This both uses the mobile version of Google Translate, extension endpoints and the `batchexecute` (JSONRPC) API @@ -12,17 +12,11 @@ The `batchexecute` implementation is heavily inspired by ssut/py-googletrans#255 - [../../../../../translators/base_aggregator.py](../../../../../translators/base_aggregator.py): As `BaseTranslatorAggregator` -## *const* **DOMAINS** +## *const* [**DOMAINS**](../../../../../translators/Google.py#L21) -> [Source: ../../../../../translators/Google.py @ line 21](../../../../../translators/Google.py#L21) +## *const* [**SUPPORTED_LANGUAGES**](../../../../../translators/Google.py#L58) -## *const* **SUPPORTED_LANGUAGES** - -> [Source: ../../../../../translators/Google.py @ line 58](../../../../../translators/Google.py#L58) - -## *class* **GoogleTranslate** - -> [Source: ../../../../../translators/Google.py @ line 66-81](../../../../../translators/Google.py#L66-L81) +## *class* [**GoogleTranslate**](../../../../../translators/Google.py#L66-L81) An aggregation of Google Translate translators @@ -30,9 +24,7 @@ An aggregation of Google Translate translators - `ServiceURLError` -## *class* **GoogleTranslateV1** - -> [Source: ../../../../../translators/Google.py @ line 84-261](../../../../../translators/Google.py#L84-L261) +## *class* [**GoogleTranslateV1**](../../../../../translators/Google.py#L84-L261) A Python implementation of Google Translate's JSONRPC API @@ -40,8 +32,6 @@ A Python implementation of Google Translate's JSONRPC API - `ValueError` -## *class* **GoogleTranslateV2** - -> [Source: ../../../../../translators/Google.py @ line 264-423](../../../../../translators/Google.py#L264-L423) +## *class* [**GoogleTranslateV2**](../../../../../translators/Google.py#L264-L423) A Python implementation of Google Translate's APIs diff --git a/translatepy/server/docs/eng/reference/translators/libre.md b/translatepy/server/docs/eng/reference/translators/libre.md index a70c7a3..531aa89 100644 --- a/translatepy/server/docs/eng/reference/translators/libre.md +++ b/translatepy/server/docs/eng/reference/translators/libre.md @@ -1,6 +1,6 @@ # *module* **Libre** -> [Source: ../../../../../translators/Libre.py @ line 0](../../../../../translators/Libre.py#L0) +> [Source: ../../../../../translators/Libre.py](../../../../../translators/Libre.py#L0) LibreTranslate translatepy's implementation of LibreTranslate @@ -13,8 +13,6 @@ translatepy's implementation of LibreTranslate - **Animenosekai** Original author -## *class* **LibreTranslate** - -> [Source: ../../../../../translators/Libre.py @ line 19-43](../../../../../translators/Libre.py#L19-L43) +## *class* [**LibreTranslate**](../../../../../translators/Libre.py#L19-L43) translatepy's implementation of LibreTranslate diff --git a/translatepy/server/docs/eng/reference/translators/microsoft.md b/translatepy/server/docs/eng/reference/translators/microsoft.md index 3035dbb..27b8369 100644 --- a/translatepy/server/docs/eng/reference/translators/microsoft.md +++ b/translatepy/server/docs/eng/reference/translators/microsoft.md @@ -1,6 +1,6 @@ # *module* **Microsoft** -> [Source: ../../../../../translators/Microsoft.py @ line 0](../../../../../translators/Microsoft.py#L0) +> [Source: ../../../../../translators/Microsoft.py](../../../../../translators/Microsoft.py#L0) This implementation was made specifically for translatepy by 'Zhymabek Roman'. @@ -10,27 +10,19 @@ This implementation was made specifically for translatepy by 'Zhymabek Roman'. - [../../../../../translators/base_aggregator.py](../../../../../translators/base_aggregator.py): As `BaseTranslatorAggregator` -## *class* **MicrosoftTranslate** - -> [Source: ../../../../../translators/Microsoft.py @ line 23-32](../../../../../translators/Microsoft.py#L23-L32) +## *class* [**MicrosoftTranslate**](../../../../../translators/Microsoft.py#L23-L32) An aggregation of Microsoft Translate translators -## *class* **MicrosoftTranslateV1** - -> [Source: ../../../../../translators/Microsoft.py @ line 37-141](../../../../../translators/Microsoft.py#L37-L141) +## *class* [**MicrosoftTranslateV1**](../../../../../translators/Microsoft.py#L37-L141) A Python implementation of Microsoft Translation, reverse engenered from Microsoft Translator Android application. Ported from https://github.com/d4n3436/GTranslate/blob/master/src/GTranslate/Translators/MicrosoftTranslator.cs Huge thanks to d4n3436. -## *class* **MicrosoftTranslateV2** - -> [Source: ../../../../../translators/Microsoft.py @ line 144-187](../../../../../translators/Microsoft.py#L144-L187) +## *class* [**MicrosoftTranslateV2**](../../../../../translators/Microsoft.py#L144-L187) A Python implementation of Microsoft Translation, reverse engenered from Microsoft SwiftKey by ZhymabekRoman Also I found '/v1/languages?scope=translation' endpoint, idk maybe it can be useful -## *class* **MicrosoftTranslateV3** - -> [Source: ../../../../../translators/Microsoft.py @ line 189-254](../../../../../translators/Microsoft.py#L189-L254) +## *class* [**MicrosoftTranslateV3**](../../../../../translators/Microsoft.py#L189-L254) diff --git a/translatepy/server/docs/eng/reference/translators/mymemory.md b/translatepy/server/docs/eng/reference/translators/mymemory.md index 30c6836..2f47615 100644 --- a/translatepy/server/docs/eng/reference/translators/mymemory.md +++ b/translatepy/server/docs/eng/reference/translators/mymemory.md @@ -1,6 +1,6 @@ # *module* **MyMemory** -> [Source: ../../../../../translators/MyMemory.py @ line 0](../../../../../translators/MyMemory.py#L0) +> [Source: ../../../../../translators/MyMemory.py](../../../../../translators/MyMemory.py#L0) MyMemory translatepy's implementation of MyMemory @@ -9,17 +9,11 @@ translatepy's implementation of MyMemory - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **MyMemoryException** +## *class* [**MyMemoryException**](../../../../../translators/MyMemory.py#L16-L19) -> [Source: ../../../../../translators/MyMemory.py @ line 16-19](../../../../../translators/MyMemory.py#L16-L19) +### *attr* [MyMemoryException.**error_codes**](../../../../../translators/MyMemory.py#L17) -### *attr* MyMemoryException.**error_codes** - -> [Source: ../../../../../translators/MyMemory.py @ line 17](../../../../../translators/MyMemory.py#L17) - -## *class* **MyMemoryTranslate** - -> [Source: ../../../../../translators/MyMemory.py @ line 22-81](../../../../../translators/MyMemory.py#L22-L81) +## *class* [**MyMemoryTranslate**](../../../../../translators/MyMemory.py#L22-L81) translatepy's implementation of MyMemory @@ -27,6 +21,4 @@ translatepy's implementation of MyMemory - `MyMemoryException` -### *attr* MyMemoryTranslate.**base_url** - -> [Source: ../../../../../translators/MyMemory.py @ line 26](../../../../../translators/MyMemory.py#L26) +### *attr* [MyMemoryTranslate.**base_url**](../../../../../translators/MyMemory.py#L26) diff --git a/translatepy/server/docs/eng/reference/translators/papago.md b/translatepy/server/docs/eng/reference/translators/papago.md index 1d37221..2101cb5 100644 --- a/translatepy/server/docs/eng/reference/translators/papago.md +++ b/translatepy/server/docs/eng/reference/translators/papago.md @@ -1,6 +1,6 @@ # *module* **Papago** -> [Source: ../../../../../translators/Papago.py @ line 0](../../../../../translators/Papago.py#L0) +> [Source: ../../../../../translators/Papago.py](../../../../../translators/Papago.py#L0) translatepy's implementation of @@ -8,45 +8,29 @@ translatepy's implementation of - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **PapagoException** +## *class* [**PapagoException**](../../../../../translators/Papago.py#L18-L21) -> [Source: ../../../../../translators/Papago.py @ line 18-21](../../../../../translators/Papago.py#L18-L21) +### *attr* [PapagoException.**error_codes**](../../../../../translators/Papago.py#L19) -### *attr* PapagoException.**error_codes** - -> [Source: ../../../../../translators/Papago.py @ line 19](../../../../../translators/Papago.py#L19) - -## *class* **PapagoSessionData** - -> [Source: ../../../../../translators/Papago.py @ line 27-31](../../../../../translators/Papago.py#L27-L31) +## *class* [**PapagoSessionData**](../../../../../translators/Papago.py#L27-L31) Bing session data holder -### *attr* PapagoSessionData.**timestamp** - -> [Source: ../../../../../translators/Papago.py @ line 29](../../../../../translators/Papago.py#L29) +### *attr* [PapagoSessionData.**timestamp**](../../../../../translators/Papago.py#L29) > Type: `cain.types.UInt64` -### *attr* PapagoSessionData.**cookies_keys** - -> [Source: ../../../../../translators/Papago.py @ line 30](../../../../../translators/Papago.py#L30) +### *attr* [PapagoSessionData.**cookies_keys**](../../../../../translators/Papago.py#L30) > Type: `List` -### *attr* PapagoSessionData.**cookies_values** - -> [Source: ../../../../../translators/Papago.py @ line 31](../../../../../translators/Papago.py#L31) +### *attr* [PapagoSessionData.**cookies_values**](../../../../../translators/Papago.py#L31) > Type: `List` -## *const* **SESSION_CACHE_EXPIRATION** - -> [Source: ../../../../../translators/Papago.py @ line 34](../../../../../translators/Papago.py#L34) +## *const* [**SESSION_CACHE_EXPIRATION**](../../../../../translators/Papago.py#L34) -## *class* **Papago** - -> [Source: ../../../../../translators/Papago.py @ line 37-262](../../../../../translators/Papago.py#L37-L262) +## *class* [**Papago**](../../../../../translators/Papago.py#L37-L262) translatepy's implementation of @@ -56,9 +40,7 @@ translatepy's implementation of - `exceptions.UnsupportedLanguage` -### *func* Papago.**generate_headers** - -> [Source: ../../../../../translators/Papago.py @ line 83-119](../../../../../translators/Papago.py#L83-L119) +### *func* [Papago.**generate_headers**](../../../../../translators/Papago.py#L83-L119) Generates the headers for the API diff --git a/translatepy/server/docs/eng/reference/translators/pons.md b/translatepy/server/docs/eng/reference/translators/pons.md index ac12a21..da0a9e9 100644 --- a/translatepy/server/docs/eng/reference/translators/pons.md +++ b/translatepy/server/docs/eng/reference/translators/pons.md @@ -1,6 +1,6 @@ # *module* **PONS** -> [Source: ../../../../../translators/PONS.py @ line 0](../../../../../translators/PONS.py#L0) +> [Source: ../../../../../translators/PONS.py](../../../../../translators/PONS.py#L0) translatepy's implementation of @@ -8,16 +8,10 @@ translatepy's implementation of - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **PONSException** +## *class* [**PONSException**](../../../../../translators/PONS.py#L15-L18) -> [Source: ../../../../../translators/PONS.py @ line 15-18](../../../../../translators/PONS.py#L15-L18) +### *attr* [PONSException.**error_codes**](../../../../../translators/PONS.py#L16) -### *attr* PONSException.**error_codes** - -> [Source: ../../../../../translators/PONS.py @ line 16](../../../../../translators/PONS.py#L16) - -## *class* **PONS** - -> [Source: ../../../../../translators/PONS.py @ line 24-111](../../../../../translators/PONS.py#L24-L111) +## *class* [**PONS**](../../../../../translators/PONS.py#L24-L111) translatepy's implementation of diff --git a/translatepy/server/docs/eng/reference/translators/qcri.md b/translatepy/server/docs/eng/reference/translators/qcri.md index 725633a..5abe0b2 100644 --- a/translatepy/server/docs/eng/reference/translators/qcri.md +++ b/translatepy/server/docs/eng/reference/translators/qcri.md @@ -1,6 +1,6 @@ # *module* **QCRI** -> [Source: ../../../../../translators/QCRI.py @ line 0](../../../../../translators/QCRI.py#L0) +> [Source: ../../../../../translators/QCRI.py](../../../../../translators/QCRI.py#L0) translatepy's implementation of @@ -8,17 +8,11 @@ translatepy's implementation of - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **QCRIException** +## *class* [**QCRIException**](../../../../../translators/QCRI.py#L16-L19) -> [Source: ../../../../../translators/QCRI.py @ line 16-19](../../../../../translators/QCRI.py#L16-L19) +### *attr* [QCRIException.**error_codes**](../../../../../translators/QCRI.py#L17) -### *attr* QCRIException.**error_codes** - -> [Source: ../../../../../translators/QCRI.py @ line 17](../../../../../translators/QCRI.py#L17) - -## *class* **QCRI** - -> [Source: ../../../../../translators/QCRI.py @ line 25-87](../../../../../translators/QCRI.py#L25-L87) +## *class* [**QCRI**](../../../../../translators/QCRI.py#L25-L87) translatepy's implementation of diff --git a/translatepy/server/docs/eng/reference/translators/reverso.md b/translatepy/server/docs/eng/reference/translators/reverso.md index 4b8fc87..a3b7cad 100644 --- a/translatepy/server/docs/eng/reference/translators/reverso.md +++ b/translatepy/server/docs/eng/reference/translators/reverso.md @@ -1,6 +1,6 @@ # *module* **Reverso** -> [Source: ../../../../../translators/Reverso.py @ line 0](../../../../../translators/Reverso.py#L0) +> [Source: ../../../../../translators/Reverso.py](../../../../../translators/Reverso.py#L0) Reverso translatepy's implementation of Reverso @@ -9,9 +9,7 @@ translatepy's implementation of Reverso - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslator`, `C` -## *class* **ReversoTranslate** - -> [Source: ../../../../../translators/Reverso.py @ line 16-182](../../../../../translators/Reverso.py#L16-L182) +## *class* [**ReversoTranslate**](../../../../../translators/Reverso.py#L16-L182) A Python implementation of Reverso's API diff --git a/translatepy/server/docs/eng/reference/translators/translatecom.md b/translatepy/server/docs/eng/reference/translators/translatecom.md index dc4c3fd..5cba45b 100644 --- a/translatepy/server/docs/eng/reference/translators/translatecom.md +++ b/translatepy/server/docs/eng/reference/translators/translatecom.md @@ -1,21 +1,15 @@ # *module* **TranslateCom** -> [Source: ../../../../../translators/TranslateCom.py @ line 0](../../../../../translators/TranslateCom.py#L0) +> [Source: ../../../../../translators/TranslateCom.py](../../../../../translators/TranslateCom.py#L0) ## Imports - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslator`, `C` -## *class* **TranslateComTranslate** - -> [Source: ../../../../../translators/TranslateCom.py @ line 9-44](../../../../../translators/TranslateCom.py#L9-L44) +## *class* [**TranslateComTranslate**](../../../../../translators/TranslateCom.py#L9-L44) translatepy's implementation of translate.com -### *attr* TranslateComTranslate.**translate_url** - -> [Source: ../../../../../translators/TranslateCom.py @ line 14](../../../../../translators/TranslateCom.py#L14) - -### *attr* TranslateComTranslate.**langdetect_url** +### *attr* [TranslateComTranslate.**translate_url**](../../../../../translators/TranslateCom.py#L14) -> [Source: ../../../../../translators/TranslateCom.py @ line 15](../../../../../translators/TranslateCom.py#L15) +### *attr* [TranslateComTranslate.**langdetect_url**](../../../../../translators/TranslateCom.py#L15) diff --git a/translatepy/server/docs/eng/reference/translators/yandex.md b/translatepy/server/docs/eng/reference/translators/yandex.md index e3a6c08..8aa08ef 100644 --- a/translatepy/server/docs/eng/reference/translators/yandex.md +++ b/translatepy/server/docs/eng/reference/translators/yandex.md @@ -1,6 +1,6 @@ # *module* **Yandex** -> [Source: ../../../../../translators/Yandex.py @ line 0](../../../../../translators/Yandex.py#L0) +> [Source: ../../../../../translators/Yandex.py](../../../../../translators/Yandex.py#L0) Yandex Translate This implementation was made specifically for translatepy from 'Zhymabek Roman', based on 'Anime no Sekai' version. @@ -9,19 +9,13 @@ This implementation was made specifically for translatepy from 'Zhymabek Roman', - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **YandexTranslateException** - -> [Source: ../../../../../translators/Yandex.py @ line 16-31](../../../../../translators/Yandex.py#L16-L31) +## *class* [**YandexTranslateException**](../../../../../translators/Yandex.py#L16-L31) Default Yandex Translate exception -### *attr* YandexTranslateException.**error_codes** - -> [Source: ../../../../../translators/Yandex.py @ line 21](../../../../../translators/Yandex.py#L21) - -## *class* **YandexTranslate** +### *attr* [YandexTranslateException.**error_codes**](../../../../../translators/Yandex.py#L21) -> [Source: ../../../../../translators/Yandex.py @ line 34-205](../../../../../translators/Yandex.py#L34-L205) +## *class* [**YandexTranslate**](../../../../../translators/Yandex.py#L34-L205) Yandex Translation Implementation diff --git a/translatepy/server/docs/eng/reference/utils/audio.md b/translatepy/server/docs/eng/reference/utils/audio.md index 8fe473d..803b7b8 100644 --- a/translatepy/server/docs/eng/reference/utils/audio.md +++ b/translatepy/server/docs/eng/reference/utils/audio.md @@ -1,6 +1,6 @@ # *module* **audio** -> [Source: ../../../../../utils/audio.py @ line 0](../../../../../utils/audio.py#L0) +> [Source: ../../../../../utils/audio.py](../../../../../utils/audio.py#L0) Handles audio file formats for translatepy @@ -9,27 +9,19 @@ Handles audio file formats for translatepy - **h2non, MIT License** Author of `filetype.py` a Python package to infer binary file types checking the magic numbers signature Most of the source code comes from this package -## *class* **Type** - -> [Source: ../../../../../utils/audio.py @ line 12-22](../../../../../utils/audio.py#L12-L22) +## *class* [**Type**](../../../../../utils/audio.py#L12-L22) Represents an audio format -### *attr* Type.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 16](../../../../../utils/audio.py#L16) +### *attr* [Type.**MIME**](../../../../../utils/audio.py#L16) > Type: `str` -### *attr* Type.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 17](../../../../../utils/audio.py#L17) +### *attr* [Type.**EXTENSION**](../../../../../utils/audio.py#L17) > Type: `str` -### *func* Type.**test** - -> [Source: ../../../../../utils/audio.py @ line 20-22](../../../../../utils/audio.py#L20-L22) +### *func* [Type.**test**](../../../../../utils/audio.py#L20-L22) Tests if the given file matches the audio format @@ -38,193 +30,127 @@ Tests if the given file matches the audio format - **data**: `bytes` -## *class* **MP3** - -> [Source: ../../../../../utils/audio.py @ line 25-42](../../../../../utils/audio.py#L25-L42) +## *class* [**MP3**](../../../../../utils/audio.py#L25-L42) Implements the MP3 audio type matcher. -### *attr* MP3.**MIME** +### *attr* [MP3.**MIME**](../../../../../utils/audio.py#L29) -> [Source: ../../../../../utils/audio.py @ line 29](../../../../../utils/audio.py#L29) +### *attr* [MP3.**EXTENSION**](../../../../../utils/audio.py#L30) -### *attr* MP3.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 30](../../../../../utils/audio.py#L30) - -### *func* MP3.**test** - -> [Source: ../../../../../utils/audio.py @ line 33-42](../../../../../utils/audio.py#L33-L42) +### *func* [MP3.**test**](../../../../../utils/audio.py#L33-L42) #### Parameters - **data**: `bytes` -## *class* **M4A** - -> [Source: ../../../../../utils/audio.py @ line 45-64](../../../../../utils/audio.py#L45-L64) +## *class* [**M4A**](../../../../../utils/audio.py#L45-L64) Implements the M4A audio type matcher. -### *attr* M4A.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 49](../../../../../utils/audio.py#L49) +### *attr* [M4A.**MIME**](../../../../../utils/audio.py#L49) -### *attr* M4A.**EXTENSION** +### *attr* [M4A.**EXTENSION**](../../../../../utils/audio.py#L50) -> [Source: ../../../../../utils/audio.py @ line 50](../../../../../utils/audio.py#L50) - -### *func* M4A.**test** - -> [Source: ../../../../../utils/audio.py @ line 53-64](../../../../../utils/audio.py#L53-L64) +### *func* [M4A.**test**](../../../../../utils/audio.py#L53-L64) #### Parameters - **data**: `bytes` -## *class* **Ogg** - -> [Source: ../../../../../utils/audio.py @ line 67-79](../../../../../utils/audio.py#L67-L79) +## *class* [**Ogg**](../../../../../utils/audio.py#L67-L79) Implements the OGG audio type matcher. -### *attr* Ogg.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 71](../../../../../utils/audio.py#L71) - -### *attr* Ogg.**EXTENSION** +### *attr* [Ogg.**MIME**](../../../../../utils/audio.py#L71) -> [Source: ../../../../../utils/audio.py @ line 72](../../../../../utils/audio.py#L72) +### *attr* [Ogg.**EXTENSION**](../../../../../utils/audio.py#L72) -### *func* Ogg.**test** - -> [Source: ../../../../../utils/audio.py @ line 75-79](../../../../../utils/audio.py#L75-L79) +### *func* [Ogg.**test**](../../../../../utils/audio.py#L75-L79) #### Parameters - **data**: `bytes` -## *class* **Flac** - -> [Source: ../../../../../utils/audio.py @ line 82-94](../../../../../utils/audio.py#L82-L94) +## *class* [**Flac**](../../../../../utils/audio.py#L82-L94) Implements the FLAC audio type matcher. -### *attr* Flac.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 86](../../../../../utils/audio.py#L86) - -### *attr* Flac.**EXTENSION** +### *attr* [Flac.**MIME**](../../../../../utils/audio.py#L86) -> [Source: ../../../../../utils/audio.py @ line 87](../../../../../utils/audio.py#L87) +### *attr* [Flac.**EXTENSION**](../../../../../utils/audio.py#L87) -### *func* Flac.**test** - -> [Source: ../../../../../utils/audio.py @ line 90-94](../../../../../utils/audio.py#L90-L94) +### *func* [Flac.**test**](../../../../../utils/audio.py#L90-L94) #### Parameters - **data**: `bytes` -## *class* **Wav** - -> [Source: ../../../../../utils/audio.py @ line 97-113](../../../../../utils/audio.py#L97-L113) +## *class* [**Wav**](../../../../../utils/audio.py#L97-L113) Implements the WAV audio type matcher. -### *attr* Wav.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 101](../../../../../utils/audio.py#L101) - -### *attr* Wav.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 102](../../../../../utils/audio.py#L102) +### *attr* [Wav.**MIME**](../../../../../utils/audio.py#L101) -### *func* Wav.**test** +### *attr* [Wav.**EXTENSION**](../../../../../utils/audio.py#L102) -> [Source: ../../../../../utils/audio.py @ line 105-113](../../../../../utils/audio.py#L105-L113) +### *func* [Wav.**test**](../../../../../utils/audio.py#L105-L113) #### Parameters - **data**: `bytes` -## *class* **Amr** - -> [Source: ../../../../../utils/audio.py @ line 116-130](../../../../../utils/audio.py#L116-L130) +## *class* [**Amr**](../../../../../utils/audio.py#L116-L130) Implements the AMR audio type matcher. -### *attr* Amr.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 120](../../../../../utils/audio.py#L120) - -### *attr* Amr.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 121](../../../../../utils/audio.py#L121) +### *attr* [Amr.**MIME**](../../../../../utils/audio.py#L120) -### *func* Amr.**test** +### *attr* [Amr.**EXTENSION**](../../../../../utils/audio.py#L121) -> [Source: ../../../../../utils/audio.py @ line 124-130](../../../../../utils/audio.py#L124-L130) +### *func* [Amr.**test**](../../../../../utils/audio.py#L124-L130) #### Parameters - **data**: `bytes` -## *class* **Aac** - -> [Source: ../../../../../utils/audio.py @ line 133-142](../../../../../utils/audio.py#L133-L142) +## *class* [**Aac**](../../../../../utils/audio.py#L133-L142) Implements the Aac audio type matcher. -### *attr* Aac.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 136](../../../../../utils/audio.py#L136) - -### *attr* Aac.**EXTENSION** +### *attr* [Aac.**MIME**](../../../../../utils/audio.py#L136) -> [Source: ../../../../../utils/audio.py @ line 137](../../../../../utils/audio.py#L137) +### *attr* [Aac.**EXTENSION**](../../../../../utils/audio.py#L137) -### *func* Aac.**test** - -> [Source: ../../../../../utils/audio.py @ line 140-142](../../../../../utils/audio.py#L140-L142) +### *func* [Aac.**test**](../../../../../utils/audio.py#L140-L142) #### Parameters - **data**: `bytes` -## *class* **Aiff** - -> [Source: ../../../../../utils/audio.py @ line 145-161](../../../../../utils/audio.py#L145-L161) +## *class* [**Aiff**](../../../../../utils/audio.py#L145-L161) Implements the AIFF audio type matcher. -### *attr* Aiff.**MIME** +### *attr* [Aiff.**MIME**](../../../../../utils/audio.py#L149) -> [Source: ../../../../../utils/audio.py @ line 149](../../../../../utils/audio.py#L149) +### *attr* [Aiff.**EXTENSION**](../../../../../utils/audio.py#L150) -### *attr* Aiff.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 150](../../../../../utils/audio.py#L150) - -### *func* Aiff.**test** - -> [Source: ../../../../../utils/audio.py @ line 153-161](../../../../../utils/audio.py#L153-L161) +### *func* [Aiff.**test**](../../../../../utils/audio.py#L153-L161) #### Parameters - **data**: `bytes` -## *func* **get_type** - -> [Source: ../../../../../utils/audio.py @ line 164-181](../../../../../utils/audio.py#L164-L181) +## *func* [**get_type**](../../../../../utils/audio.py#L164-L181) Returns the audio format of the given buffer diff --git a/translatepy/server/docs/eng/reference/utils/gtoken.md b/translatepy/server/docs/eng/reference/utils/gtoken.md index e0e318d..556e43f 100644 --- a/translatepy/server/docs/eng/reference/utils/gtoken.md +++ b/translatepy/server/docs/eng/reference/utils/gtoken.md @@ -1,6 +1,6 @@ # *module* **gtoken** -> [Source: ../../../../../utils/gtoken.py @ line 0](../../../../../utils/gtoken.py#L0) +> [Source: ../../../../../utils/gtoken.py](../../../../../utils/gtoken.py#L0) ORIGINAL FILENAME: gtoken.py @@ -33,13 +33,9 @@ LICENSE: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -## *const* **HEADERS** +## *const* [**HEADERS**](../../../../../utils/gtoken.py#L45) -> [Source: ../../../../../utils/gtoken.py @ line 45](../../../../../utils/gtoken.py#L45) - -## *class* **TokenAcquirer** - -> [Source: ../../../../../utils/gtoken.py @ line 56-244](../../../../../utils/gtoken.py#L56-L244) +## *class* [**TokenAcquirer**](../../../../../utils/gtoken.py#L56-L244) Google Translate API token generator translate.google.com uses a token to authorize the requests. If you are @@ -65,26 +61,18 @@ Example usage: - `Exception` -### *attr* TokenAcquirer.**RE_TKK** - -> [Source: ../../../../../utils/gtoken.py @ line 82](../../../../../utils/gtoken.py#L82) +### *attr* [TokenAcquirer.**RE_TKK**](../../../../../utils/gtoken.py#L82) -### *attr* TokenAcquirer.**RE_RAWTKK** +### *attr* [TokenAcquirer.**RE_RAWTKK**](../../../../../utils/gtoken.py#L83) -> [Source: ../../../../../utils/gtoken.py @ line 83](../../../../../utils/gtoken.py#L83) - -### *func* TokenAcquirer.**acquire** - -> [Source: ../../../../../utils/gtoken.py @ line 185-239](../../../../../utils/gtoken.py#L185-L239) +### *func* [TokenAcquirer.**acquire**](../../../../../utils/gtoken.py#L185-L239) #### Parameters - **text** -### *func* TokenAcquirer.**do** - -> [Source: ../../../../../utils/gtoken.py @ line 241-244](../../../../../utils/gtoken.py#L241-L244) +### *func* [TokenAcquirer.**do**](../../../../../utils/gtoken.py#L241-L244) #### Parameters diff --git a/translatepy/server/docs/eng/reference/utils/hasher.md b/translatepy/server/docs/eng/reference/utils/hasher.md index e171be6..1cee5fe 100644 --- a/translatepy/server/docs/eng/reference/utils/hasher.md +++ b/translatepy/server/docs/eng/reference/utils/hasher.md @@ -1,13 +1,11 @@ # *module* **hasher** -> [Source: ../../../../../utils/hasher.py @ line 0](../../../../../utils/hasher.py#L0) +> [Source: ../../../../../utils/hasher.py](../../../../../utils/hasher.py#L0) utils/hasher.py Utility to hash different kind of objects -## *func* **sha256** - -> [Source: ../../../../../utils/hasher.py @ line 11-28](../../../../../utils/hasher.py#L11-L28) +## *func* [**sha256**](../../../../../utils/hasher.py#L11-L28) Hashes the given content using SHA-256 and returns its hexadecimal version @@ -22,9 +20,7 @@ Hashes the given content using SHA-256 and returns its hexadecimal version - `str` - The SHA-256 hash -## *func* **hash_object** - -> [Source: ../../../../../utils/hasher.py @ line 31-48](../../../../../utils/hasher.py#L31-L48) +## *func* [**hash_object**](../../../../../utils/hasher.py#L31-L48) Hashes a given object @@ -38,9 +34,7 @@ Hashes a given object - `str` - The hash of the object -## *func* **hash_request** - -> [Source: ../../../../../utils/hasher.py @ line 51-82](../../../../../utils/hasher.py#L51-L82) +## *func* [**hash_request**](../../../../../utils/hasher.py#L51-L82) Hashes the given request. diff --git a/translatepy/server/docs/eng/reference/utils/importer.md b/translatepy/server/docs/eng/reference/utils/importer.md index 7db2bec..009cc5d 100644 --- a/translatepy/server/docs/eng/reference/utils/importer.md +++ b/translatepy/server/docs/eng/reference/utils/importer.md @@ -1,6 +1,6 @@ # *module* **importer** -> [Source: ../../../../../utils/importer.py @ line 0](../../../../../utils/importer.py#L0) +> [Source: ../../../../../utils/importer.py](../../../../../utils/importer.py#L0) importer.py A module to allow for dynamic importing of translators. @@ -11,25 +11,15 @@ A module to allow for dynamic importing of translators. - [../../../../../utils/vectorize.py](../../../../../utils/vectorize.py): As `vectorize` -## *const* **IMPORTER_CACHE** +## *const* [**IMPORTER_CACHE**](../../../../../utils/importer.py#L18) -> [Source: ../../../../../utils/importer.py @ line 18](../../../../../utils/importer.py#L18) +## *const* [**IMPORTER_DATA_DIR**](../../../../../utils/importer.py#L20) -## *const* **IMPORTER_DATA_DIR** +## *const* [**IMPORTER_DATA_FILE**](../../../../../utils/importer.py#L21) -> [Source: ../../../../../utils/importer.py @ line 20](../../../../../utils/importer.py#L20) +## *const* [**NAMED_TRANSLATORS**](../../../../../utils/importer.py#L27) -## *const* **IMPORTER_DATA_FILE** - -> [Source: ../../../../../utils/importer.py @ line 21](../../../../../utils/importer.py#L21) - -## *const* **NAMED_TRANSLATORS** - -> [Source: ../../../../../utils/importer.py @ line 27](../../../../../utils/importer.py#L27) - -## *func* **translator_from_name** - -> [Source: ../../../../../utils/importer.py @ line 37-42](../../../../../utils/importer.py#L37-L42) +## *func* [**translator_from_name**](../../../../../utils/importer.py#L37-L42) Retrieves the given translate from its name @@ -46,9 +36,7 @@ Retrieves the given translate from its name - `ValueError` -## *func* **translator_from_path** - -> [Source: ../../../../../utils/importer.py @ line 45-55](../../../../../utils/importer.py#L45-L55) +## *func* [**translator_from_path**](../../../../../utils/importer.py#L45-L55) Returns a translator from its dot path @@ -69,9 +57,7 @@ Returns a translator from its dot path - `ImportError` -## *func* **get_translator** - -> [Source: ../../../../../utils/importer.py @ line 58-94](../../../../../utils/importer.py#L58-L94) +## *func* [**get_translator**](../../../../../utils/importer.py#L58-L94) Searches the given translator diff --git a/translatepy/server/docs/eng/reference/utils/lru.md b/translatepy/server/docs/eng/reference/utils/lru.md index 237da12..f061169 100644 --- a/translatepy/server/docs/eng/reference/utils/lru.md +++ b/translatepy/server/docs/eng/reference/utils/lru.md @@ -1,31 +1,21 @@ # *module* **lru** -> [Source: ../../../../../utils/lru.py @ line 0](../../../../../utils/lru.py#L0) +> [Source: ../../../../../utils/lru.py](../../../../../utils/lru.py#L0) lru.py LRU cache implementation for the translatepy project. -## *const* **logger** +## *const* [**logger**](../../../../../utils/lru.py#L16) -> [Source: ../../../../../utils/lru.py @ line 16](../../../../../utils/lru.py#L16) +## *class* [**LRUDictCache**](../../../../../utils/lru.py#L19-L38) -## *class* **LRUDictCache** +### *func* [LRUDictCache.**clear**](../../../../../utils/lru.py#L37-L38) -> [Source: ../../../../../utils/lru.py @ line 19-38](../../../../../utils/lru.py#L19-L38) - -### *func* LRUDictCache.**clear** - -> [Source: ../../../../../utils/lru.py @ line 37-38](../../../../../utils/lru.py#L37-L38) - -## *class* **SizeLimitedLRUCache** - -> [Source: ../../../../../utils/lru.py @ line 41-173](../../../../../utils/lru.py#L41-L173) +## *class* [**SizeLimitedLRUCache**](../../../../../utils/lru.py#L41-L173) Special implementation of a size limited LRU cache. -### *func* SizeLimitedLRUCache.**get_size** - -> [Source: ../../../../../utils/lru.py @ line 135-170](../../../../../utils/lru.py#L135-L170) +### *func* [SizeLimitedLRUCache.**get_size**](../../../../../utils/lru.py#L135-L170) Get the size of an object. @@ -50,13 +40,9 @@ This function is faster than the custom implementation but might yield inaccurat > The second implementation of this function is based on the following article: https://towardsdatascience.com/the-strange-size-of-python-objects-in-memory-ce87bdfbb97f -### *func* SizeLimitedLRUCache.**clear** - -> [Source: ../../../../../utils/lru.py @ line 172-173](../../../../../utils/lru.py#L172-L173) - -## *func* **timed_lru_cache** +### *func* [SizeLimitedLRUCache.**clear**](../../../../../utils/lru.py#L172-L173) -> [Source: ../../../../../utils/lru.py @ line 176-198](../../../../../utils/lru.py#L176-L198) +## *func* [**timed_lru_cache**](../../../../../utils/lru.py#L176-L198) ### Parameters diff --git a/translatepy/server/docs/eng/reference/utils/queue.md b/translatepy/server/docs/eng/reference/utils/queue.md index 1ef378e..b42be00 100644 --- a/translatepy/server/docs/eng/reference/utils/queue.md +++ b/translatepy/server/docs/eng/reference/utils/queue.md @@ -1,18 +1,14 @@ # *module* **queue** -> [Source: ../../../../../utils/queue.py @ line 0](../../../../../utils/queue.py#L0) +> [Source: ../../../../../utils/queue.py](../../../../../utils/queue.py#L0) -## *class* **Queue** - -> [Source: ../../../../../utils/queue.py @ line 6-32](../../../../../utils/queue.py#L6-L32) +## *class* [**Queue**](../../../../../utils/queue.py#L6-L32) ### Raises - `ValueError` -### *func* Queue.**get** - -> [Source: ../../../../../utils/queue.py @ line 16-32](../../../../../utils/queue.py#L16-L32) +### *func* [Queue.**get**](../../../../../utils/queue.py#L16-L32) Remove and return an item from the queue. It waits for a value or the termination of all threads diff --git a/translatepy/server/docs/eng/reference/utils/request.md b/translatepy/server/docs/eng/reference/utils/request.md index cb5f713..21988c1 100644 --- a/translatepy/server/docs/eng/reference/utils/request.md +++ b/translatepy/server/docs/eng/reference/utils/request.md @@ -1,6 +1,6 @@ # *module* **request** -> [Source: ../../../../../utils/request.py @ line 0](../../../../../utils/request.py#L0) +> [Source: ../../../../../utils/request.py](../../../../../utils/request.py#L0) utils/request Extending python requests functionalities with translatepy's own implementation of proxies, caching, exceptions, etc. @@ -13,29 +13,19 @@ Extending python requests functionalities with translatepy's own implementation - **Animenosekai** Original author -## *const* **RequestHash** +## *const* [**RequestHash**](../../../../../utils/request.py#L24) -> [Source: ../../../../../utils/request.py @ line 24](../../../../../utils/request.py#L24) +## *const* [**RateLimitLock**](../../../../../utils/request.py#L27) -## *const* **RateLimitLock** +## *const* [**CacheLock**](../../../../../utils/request.py#L28) -> [Source: ../../../../../utils/request.py @ line 27](../../../../../utils/request.py#L27) - -## *const* **CacheLock** - -> [Source: ../../../../../utils/request.py @ line 28](../../../../../utils/request.py#L28) - -## *class* **Session** - -> [Source: ../../../../../utils/request.py @ line 32-225](../../../../../utils/request.py#L32-L225) +## *class* [**Session**](../../../../../utils/request.py#L32-L225) ### Raises - `exceptions.RateLimitPrevention` -### *func* Session.**set_http_proxy** - -> [Source: ../../../../../utils/request.py @ line 52-64](../../../../../utils/request.py#L52-L64) +### *func* [Session.**set_http_proxy**](../../../../../utils/request.py#L52-L64) Sets the HTTP proxy to use. @@ -45,9 +35,7 @@ Sets the HTTP proxy to use. - The HTTP proxy to use. -### *func* Session.**add_http_proxy** - -> [Source: ../../../../../utils/request.py @ line 66-75](../../../../../utils/request.py#L66-L75) +### *func* [Session.**add_http_proxy**](../../../../../utils/request.py#L66-L75) Adds a HTTP proxy to the list of proxies to use. @@ -57,9 +45,7 @@ Adds a HTTP proxy to the list of proxies to use. - The HTTP proxy to add. -### *func* Session.**request** - -> [Source: ../../../../../utils/request.py @ line 77-215](../../../../../utils/request.py#L77-L215) +### *func* [Session.**request**](../../../../../utils/request.py#L77-L215) Make an HTTP request with the provided method. @@ -203,9 +189,7 @@ If None, the default_cache_duration attribute will be used. ``` -### *func* Session.**invalidate** - -> [Source: ../../../../../utils/request.py @ line 217-225](../../../../../utils/request.py#L217-L225) +### *func* [Session.**invalidate**](../../../../../utils/request.py#L217-L225) Invalidates the given request cache. @@ -214,13 +198,9 @@ Invalidates the given request cache. - **hash**: `RequestHash`, `requesthash` -## *const* **SharedSession** - -> [Source: ../../../../../utils/request.py @ line 228](../../../../../utils/request.py#L228) +## *const* [**SharedSession**](../../../../../utils/request.py#L228) -## *func* **request** - -> [Source: ../../../../../utils/request.py @ line 231-268](../../../../../utils/request.py#L231-L268) +## *func* [**request**](../../../../../utils/request.py#L231-L268) Make an HTTP request. @@ -315,9 +295,7 @@ Make an HTTP request. > **Note** > Look at Session.request for more information. -## *func* **get** - -> [Source: ../../../../../utils/request.py @ line 271-300](../../../../../utils/request.py#L271-L300) +## *func* [**get**](../../../../../utils/request.py#L271-L300) Make a GET request. @@ -405,9 +383,7 @@ Make a GET request. > **Note** > Look at Session.request for more information. -## *func* **post** - -> [Source: ../../../../../utils/request.py @ line 303-332](../../../../../utils/request.py#L303-L332) +## *func* [**post**](../../../../../utils/request.py#L303-L332) Make a POST request. @@ -495,9 +471,7 @@ Make a POST request. > **Note** > Look at Session.request for more information. -## *func* **put** - -> [Source: ../../../../../utils/request.py @ line 335-364](../../../../../utils/request.py#L335-L364) +## *func* [**put**](../../../../../utils/request.py#L335-L364) Make a PUT request. @@ -585,9 +559,7 @@ Make a PUT request. > **Note** > Look at Session.request for more information. -## *func* **patch** - -> [Source: ../../../../../utils/request.py @ line 367-396](../../../../../utils/request.py#L367-L396) +## *func* [**patch**](../../../../../utils/request.py#L367-L396) Make a PATCH request. @@ -675,9 +647,7 @@ Make a PATCH request. > **Note** > Look at Session.request for more information. -## *func* **delete** - -> [Source: ../../../../../utils/request.py @ line 399-428](../../../../../utils/request.py#L399-L428) +## *func* [**delete**](../../../../../utils/request.py#L399-L428) Make a DELETE request. @@ -765,9 +735,7 @@ Make a DELETE request. > **Note** > Look at Session.request for more information. -## *func* **head** - -> [Source: ../../../../../utils/request.py @ line 431-460](../../../../../utils/request.py#L431-L460) +## *func* [**head**](../../../../../utils/request.py#L431-L460) Make a HEAD request. @@ -855,9 +823,7 @@ Make a HEAD request. > **Note** > Look at Session.request for more information. -## *func* **options** - -> [Source: ../../../../../utils/request.py @ line 463-492](../../../../../utils/request.py#L463-L492) +## *func* [**options**](../../../../../utils/request.py#L463-L492) Make an OPTIONS request. diff --git a/translatepy/server/docs/eng/reference/utils/sanitize.md b/translatepy/server/docs/eng/reference/utils/sanitize.md index c058776..19cb339 100644 --- a/translatepy/server/docs/eng/reference/utils/sanitize.md +++ b/translatepy/server/docs/eng/reference/utils/sanitize.md @@ -1,14 +1,10 @@ # *module* **sanitize** -> [Source: ../../../../../utils/sanitize.py @ line 0](../../../../../utils/sanitize.py#L0) +> [Source: ../../../../../utils/sanitize.py](../../../../../utils/sanitize.py#L0) -## *const* **WHITESPACES** +## *const* [**WHITESPACES**](../../../../../utils/sanitize.py#L3) -> [Source: ../../../../../utils/sanitize.py @ line 3](../../../../../utils/sanitize.py#L3) - -## *func* **remove_spaces** - -> [Source: ../../../../../utils/sanitize.py @ line 8-15](../../../../../utils/sanitize.py#L8-L15) +## *func* [**remove_spaces**](../../../../../utils/sanitize.py#L8-L15) Removes all whitespaces from the given string diff --git a/translatepy/server/docs/eng/reference/utils/utils.md b/translatepy/server/docs/eng/reference/utils/utils.md index 626ac8b..a3f841d 100644 --- a/translatepy/server/docs/eng/reference/utils/utils.md +++ b/translatepy/server/docs/eng/reference/utils/utils.md @@ -1,14 +1,10 @@ # *module* **utils** -> [Source: ../../../../../utils/utils.py @ line 0](../../../../../utils/utils.py#L0) +> [Source: ../../../../../utils/utils.py](../../../../../utils/utils.py#L0) -## *const* **POSITIVE_FLOAT_REGEX** +## *const* [**POSITIVE_FLOAT_REGEX**](../../../../../utils/utils.py#L3) -> [Source: ../../../../../utils/utils.py @ line 3](../../../../../utils/utils.py#L3) - -## *func* **convert_to_float** - -> [Source: ../../../../../utils/utils.py @ line 6-13](../../../../../utils/utils.py#L6-L13) +## *func* [**convert_to_float**](../../../../../utils/utils.py#L6-L13) Safely converts anything to a positive float diff --git a/translatepy/server/docs/eng/reference/utils/vectorize.md b/translatepy/server/docs/eng/reference/utils/vectorize.md index 9245e3a..eb82996 100644 --- a/translatepy/server/docs/eng/reference/utils/vectorize.md +++ b/translatepy/server/docs/eng/reference/utils/vectorize.md @@ -1,6 +1,6 @@ # *module* **vectorize** -> [Source: ../../../../../utils/vectorize.py @ line 0](../../../../../utils/vectorize.py#L0) +> [Source: ../../../../../utils/vectorize.py](../../../../../utils/vectorize.py#L0) Handles vectors @@ -8,13 +8,9 @@ Handles vectors - [../../../../../utils/sanitize.py](../../../../../utils/sanitize.py): As `sanitize` -## *const* **CLEANUP_REGEX** +## *const* [**CLEANUP_REGEX**](../../../../../utils/vectorize.py#L12) -> [Source: ../../../../../utils/vectorize.py @ line 12](../../../../../utils/vectorize.py#L12) - -## *func* **string_preprocessing** - -> [Source: ../../../../../utils/vectorize.py @ line 15-17](../../../../../utils/vectorize.py#L15-L17) +## *func* [**string_preprocessing**](../../../../../utils/vectorize.py#L15-L17) internal function to preprocess the given string for fuzzy search @@ -27,49 +23,33 @@ internal function to preprocess the given string for fuzzy search - `str` -## *class* **Vector** - -> [Source: ../../../../../utils/vectorize.py @ line 20-34](../../../../../utils/vectorize.py#L20-L34) +## *class* [**Vector**](../../../../../utils/vectorize.py#L20-L34) A string vector -### *attr* Vector.**id** - -> [Source: ../../../../../utils/vectorize.py @ line 22](../../../../../utils/vectorize.py#L22) +### *attr* [Vector.**id**](../../../../../utils/vectorize.py#L22) > Type: `str` -### *attr* Vector.**string** - -> [Source: ../../../../../utils/vectorize.py @ line 23](../../../../../utils/vectorize.py#L23) +### *attr* [Vector.**string**](../../../../../utils/vectorize.py#L23) > Type: `str` -### *attr* Vector.**value** - -> [Source: ../../../../../utils/vectorize.py @ line 24](../../../../../utils/vectorize.py#L24) +### *attr* [Vector.**value**](../../../../../utils/vectorize.py#L24) > Type: `float` -### *property* Vector.**counter** - -> [Source: ../../../../../utils/vectorize.py @ line 27-29](../../../../../utils/vectorize.py#L27-L29) +### *property* [Vector.**counter**](../../../../../utils/vectorize.py#L27-L29) Returns a counter for the vector -### *property* Vector.**set** - -> [Source: ../../../../../utils/vectorize.py @ line 32-34](../../../../../utils/vectorize.py#L32-L34) +### *property* [Vector.**set**](../../../../../utils/vectorize.py#L32-L34) Returns a set for the vector -## *const* **A** - -> [Source: ../../../../../utils/vectorize.py @ line 36](../../../../../utils/vectorize.py#L36) +## *const* [**A**](../../../../../utils/vectorize.py#L36) -## *func* **vectorize** - -> [Source: ../../../../../utils/vectorize.py @ line 38-45](../../../../../utils/vectorize.py#L38-L45) +## *func* [**vectorize**](../../../../../utils/vectorize.py#L38-L45) Vectorizes the given string @@ -81,31 +61,23 @@ Vectorizes the given string - **string**: `str` -## *class* **SearchResult** - -> [Source: ../../../../../utils/vectorize.py @ line 49-54](../../../../../utils/vectorize.py#L49-L54) +## *class* [**SearchResult**](../../../../../utils/vectorize.py#L49-L54) A result from the `search` function -### *attr* SearchResult.**vector** - -> [Source: ../../../../../utils/vectorize.py @ line 51](../../../../../utils/vectorize.py#L51) +### *attr* [SearchResult.**vector**](../../../../../utils/vectorize.py#L51) > Type: `Vector` The actual vector -### *attr* SearchResult.**similarity** - -> [Source: ../../../../../utils/vectorize.py @ line 53](../../../../../utils/vectorize.py#L53) +### *attr* [SearchResult.**similarity**](../../../../../utils/vectorize.py#L53) > Type: `float` The similarity with the search query -## *func* **search** - -> [Source: ../../../../../utils/vectorize.py @ line 57-70](../../../../../utils/vectorize.py#L57-L70) +## *func* [**search**](../../../../../utils/vectorize.py#L57-L70) Searches `query` through `data` diff --git a/translatepy/server/docs/eng/server/Postman/Language.postman_collection.utils.json b/translatepy/server/docs/eng/server/Postman/Language.postman_collection.utils.json index 9e1964e..283e229 100644 --- a/translatepy/server/docs/eng/server/Postman/Language.postman_collection.utils.json +++ b/translatepy/server/docs/eng/server/Postman/Language.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Language","description":"All of the endpoints under the 'Language' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file +{"info":{"name":"Language","description":"All of the endpoints under the 'Language' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file diff --git a/translatepy/server/docs/eng/server/Postman/Work.postman_collection.utils.json b/translatepy/server/docs/eng/server/Postman/Work.postman_collection.utils.json index e5feaae..28195a7 100644 --- a/translatepy/server/docs/eng/server/Postman/Work.postman_collection.utils.json +++ b/translatepy/server/docs/eng/server/Postman/Work.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Work","description":"All of the endpoints under the 'Work' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `service` | The service which returned the result | Translator | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `translation` | The translation result | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `service` | The service which returned the result | Translator | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `translation` | The translation result | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n"}]},{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n| `transliteration` | The transliteration result | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n| `transliteration` | The transliteration result | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n"}]},{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n| `corrected` | The corrected text | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n| `corrected` | The corrected text | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n"}]},{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | No |\n| `example` | The example | string | No |\n| `source_lang` | The source text's language | Language | No |\n| `positions` | The positions of the word in the example | list[int] | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | No |\n| `example` | The example | string | No |\n| `source_lang` | The source text's language | Language | No |\n| `positions` | The positions of the word in the example | list[int] | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `meaning` | The meaning of the text | string | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `meaning` | The meaning of the text | string | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `extension` | Returns the audio file extension | Optional[str] | No |\n| `result` | Text to speech result | bytes | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n| `gender` | Gender of the 'person' saying the text | Gender | No |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | No |\n| `speed` | Speed of the text to speech result | int | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | No |\n| `extension` | Returns the audio file extension | Optional[str] | No |\n| `result` | Text to speech result | bytes | No |\n| `source` | The source text | string | No |\n| `service` | The service which returned the result | Translator | No |\n| `gender` | Gender of the 'person' saying the text | Gender | No |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | No |\n| `speed` | Speed of the text to speech result | int | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file +{"info":{"name":"Work","description":"All of the endpoints under the 'Work' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `translation` | The translation result | string | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `translation` | The translation result | string | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]},{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n"}]},{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `transliteration` | The transliteration result | string | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `transliteration` | The transliteration result | string | No |\n| `dest_lang` | The result's language | Language | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]},{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n| `corrected` | The corrected text | string | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n| `corrected` | The corrected text | string | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n"}]},{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n"}]},{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n| `example` | The example | string | No |\n| `positions` | The positions of the word in the example | list[int] | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | No |\n| `source` | The source text | string | No |\n| `source_lang` | The source text's language | Language | No |\n| `example` | The example | string | No |\n| `positions` | The positions of the word in the example | list[int] | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n"}]},{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n| `meaning` | The meaning of the text | string | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | No |\n| `source_lang` | The source text's language | Language | No |\n| `source` | The source text | string | No |\n| `meaning` | The meaning of the text | string | No |\n| `rich` | Whether the given result features the full range of information | bool | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n"}]},{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `extension` | Returns the audio file extension | Optional[str] | No |\n| `result` | Text to speech result | bytes | No |\n| `source` | The source text | string | No |\n| `speed` | Speed of the text to speech result | int | No |\n| `gender` | Gender of the 'person' saying the text | Gender | No |\n| `service` | The service which returned the result | Translator | No |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | No |\n| `source_lang` | The source text's language | Language | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentication\n\nLogin is **not** required\n\n### Response\n\n#### Example response\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `extension` | Returns the audio file extension | Optional[str] | No |\n| `result` | Text to speech result | bytes | No |\n| `source` | The source text | string | No |\n| `speed` | Speed of the text to speech result | int | No |\n| `gender` | Gender of the 'person' saying the text | Gender | No |\n| `service` | The service which returned the result | Translator | No |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | No |\n| `source_lang` | The source text's language | Language | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Return to the Index](../Getting%20Started.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file diff --git a/translatepy/server/docs/eng/server/Sections/Language.md b/translatepy/server/docs/eng/server/Sections/Language.md index 6fc8954..b469cd0 100644 --- a/translatepy/server/docs/eng/server/Sections/Language.md +++ b/translatepy/server/docs/eng/server/Sections/Language.md @@ -84,8 +84,8 @@ print(r.json()["data"]) | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | | `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | [Return to the Index](../Getting%20Started.md#index) # search @@ -185,6 +185,6 @@ print(r.json()["data"]) | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | | `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | [Return to the Index](../Getting%20Started.md#index) \ No newline at end of file diff --git a/translatepy/server/docs/eng/server/Sections/Work.md b/translatepy/server/docs/eng/server/Sections/Work.md index 21836a3..1b77e45 100644 --- a/translatepy/server/docs/eng/server/Sections/Work.md +++ b/translatepy/server/docs/eng/server/Sections/Work.md @@ -92,11 +92,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", "service": "no example", + "translation": "no example", "dest_lang": "no example", "source": "no example", - "translation": "no example" + "source_lang": "no example" } } @@ -106,20 +106,20 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | No | | `service` | The service which returned the result | Translator | No | +| `translation` | The translation result | string | No | | `dest_lang` | The result's language | Language | No | | `source` | The source text | string | No | -| `translation` | The translation result | string | No | +| `source_lang` | The source text's language | Language | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # translate_html @@ -211,9 +211,9 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "source": "no example", - "service": "no example" + "source": "no example" } } @@ -223,18 +223,18 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | No | | `source_lang` | The source text's language | Language | No | | `source` | The source text | string | No | -| `service` | The service which returned the result | Translator | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # stream @@ -312,10 +312,10 @@ print(r.json()["data"]) | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # transliterate @@ -407,11 +407,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", + "service": "no example", + "transliteration": "no example", "dest_lang": "no example", "source": "no example", - "service": "no example", - "transliteration": "no example" + "source_lang": "no example" } } @@ -421,20 +421,20 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | No | -| `dest_lang` | The result's language | Language | No | -| `source` | The source text | string | No | | `service` | The service which returned the result | Translator | No | | `transliteration` | The transliteration result | string | No | +| `dest_lang` | The result's language | Language | No | +| `source` | The source text | string | No | +| `source_lang` | The source text's language | Language | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # spellcheck @@ -526,11 +526,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", - "rich": true, - "source": "no example", "service": "no example", - "corrected": "no example" + "source": "no example", + "source_lang": "no example", + "corrected": "no example", + "rich": true } } @@ -540,20 +540,20 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | No | -| `rich` | Whether the given result features the full range of information | bool | No | -| `source` | The source text | string | No | | `service` | The service which returned the result | Translator | No | +| `source` | The source text | string | No | +| `source_lang` | The source text's language | Language | No | | `corrected` | The corrected text | string | No | +| `rich` | Whether the given result features the full range of information | bool | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # language @@ -645,9 +645,9 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "source": "no example", - "service": "no example" + "source": "no example" } } @@ -657,18 +657,18 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | No | | `source_lang` | The source text's language | Language | No | | `source` | The source text | string | No | -| `service` | The service which returned the result | Translator | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # example @@ -760,12 +760,12 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "reference": "no example", - "example": "no example", - "source_lang": "no example", - "positions": "no example", "source": "no example", - "service": "no example" + "source_lang": "no example", + "example": "no example", + "positions": "no example" } } @@ -775,21 +775,21 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | No | | `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | No | -| `example` | The example | string | No | +| `source` | The source text | string | No | | `source_lang` | The source text's language | Language | No | +| `example` | The example | string | No | | `positions` | The positions of the word in the example | list[int] | No | -| `source` | The source text | string | No | -| `service` | The service which returned the result | Translator | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # dictionary @@ -881,11 +881,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "meaning": "no example", - "rich": true, "source": "no example", - "service": "no example" + "meaning": "no example", + "rich": true } } @@ -895,20 +895,20 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | No | | `source_lang` | The source text's language | Language | No | +| `source` | The source text | string | No | | `meaning` | The meaning of the text | string | No | | `rich` | Whether the given result features the full range of information | bool | No | -| `source` | The source text | string | No | -| `service` | The service which returned the result | Translator | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) # tts @@ -1000,14 +1000,14 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", "extension": "no example", "result": "no example", "source": "no example", - "service": "no example", + "speed": 4, "gender": "no example", + "service": "no example", "mime_type": "no example", - "speed": 4 + "source_lang": "no example" } } @@ -1017,21 +1017,21 @@ print(r.json()["data"]) | Field | Description | Type | Nullable | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | No | | `extension` | Returns the audio file extension | Optional[str] | No | | `result` | Text to speech result | bytes | No | | `source` | The source text | string | No | -| `service` | The service which returned the result | Translator | No | +| `speed` | Speed of the text to speech result | int | No | | `gender` | Gender of the 'person' saying the text | Gender | No | +| `service` | The service which returned the result | Translator | No | | `mime_type` | Returns the MIME type of the audio file | Optional[str] | No | -| `speed` | Speed of the text to speech result | int | No | +| `source_lang` | The source text's language | Language | No | #### Possible Errors | Exception | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Return to the Index](../Getting%20Started.md#index) \ No newline at end of file diff --git a/translatepy/server/docs/fra/reference/__info__.md b/translatepy/server/docs/fra/reference/__info__.md index e2b5ac9..1f91092 100644 --- a/translatepy/server/docs/fra/reference/__info__.md +++ b/translatepy/server/docs/fra/reference/__info__.md @@ -1,5 +1,5 @@ # *module* **__info__** -> [Source: ../../../../__info__.py @ line 0](../../../../__info__.py#L0) +> [Source: ../../../../__info__.py](../../../../__info__.py#L0) Stores information on the current module version diff --git a/translatepy/server/docs/fra/reference/exceptions.md b/translatepy/server/docs/fra/reference/exceptions.md index 0779dca..2f0769a 100644 --- a/translatepy/server/docs/fra/reference/exceptions.md +++ b/translatepy/server/docs/fra/reference/exceptions.md @@ -1,141 +1,73 @@ # *module* **exceptions** -> [Source: ../../../../exceptions.py @ line 0](../../../../exceptions.py#L0) +> [Source: ../../../../exceptions.py](../../../../exceptions.py#L0) A list of exceptions used throughout translatepy -## *class* **TranslatepyException** +## *class* [**TranslatepyException**](../../../../exceptions.py#L5-L9) -> [Source: ../../../../exceptions.py @ line 5-9](../../../../exceptions.py#L5-L9) +### *attr* [TranslatepyException.**LOG**](../../../../exceptions.py#L6) -### *attr* TranslatepyException.**LOG** +## *class* [**NoResult**](../../../../exceptions.py#L12-L18) -> [Source: ../../../../exceptions.py @ line 6](../../../../exceptions.py#L6) +### *attr* [NoResult.**STATUS_CODE**](../../../../exceptions.py#L13) -## *class* **NoResult** +### *attr* [NoResult.**MESSAGE**](../../../../exceptions.py#L14) -> [Source: ../../../../exceptions.py @ line 12-18](../../../../exceptions.py#L12-L18) +### *attr* [NoResult.**EXCEPTION_NAME**](../../../../exceptions.py#L15) -### *attr* NoResult.**STATUS_CODE** +## *class* [**ParameterTypeError**](../../../../exceptions.py#L21-L27) -> [Source: ../../../../exceptions.py @ line 13](../../../../exceptions.py#L13) +### *attr* [ParameterTypeError.**STATUS_CODE**](../../../../exceptions.py#L22) -### *attr* NoResult.**MESSAGE** +### *attr* [ParameterTypeError.**MESSAGE**](../../../../exceptions.py#L23) -> [Source: ../../../../exceptions.py @ line 14](../../../../exceptions.py#L14) +### *attr* [ParameterTypeError.**EXCEPTION_NAME**](../../../../exceptions.py#L24) -### *attr* NoResult.**EXCEPTION_NAME** +## *class* [**UnknownLanguage**](../../../../exceptions.py#L30-L38) -> [Source: ../../../../exceptions.py @ line 15](../../../../exceptions.py#L15) +### *attr* [UnknownLanguage.**STATUS_CODE**](../../../../exceptions.py#L31) -## *class* **ParameterTypeError** +### *attr* [UnknownLanguage.**MESSAGE**](../../../../exceptions.py#L32) -> [Source: ../../../../exceptions.py @ line 21-27](../../../../exceptions.py#L21-L27) +### *attr* [UnknownLanguage.**EXCEPTION_NAME**](../../../../exceptions.py#L33) -### *attr* ParameterTypeError.**STATUS_CODE** +## *class* [**UnknownTranslator**](../../../../exceptions.py#L41-L49) -> [Source: ../../../../exceptions.py @ line 22](../../../../exceptions.py#L22) +### *attr* [UnknownTranslator.**STATUS_CODE**](../../../../exceptions.py#L42) -### *attr* ParameterTypeError.**MESSAGE** +### *attr* [UnknownTranslator.**MESSAGE**](../../../../exceptions.py#L43) -> [Source: ../../../../exceptions.py @ line 23](../../../../exceptions.py#L23) +### *attr* [UnknownTranslator.**EXCEPTION_NAME**](../../../../exceptions.py#L44) -### *attr* ParameterTypeError.**EXCEPTION_NAME** +## *class* [**UnsupportedMethod**](../../../../exceptions.py#L52-L58) -> [Source: ../../../../exceptions.py @ line 24](../../../../exceptions.py#L24) +### *attr* [UnsupportedMethod.**STATUS_CODE**](../../../../exceptions.py#L53) -## *class* **UnknownLanguage** +### *attr* [UnsupportedMethod.**MESSAGE**](../../../../exceptions.py#L54) -> [Source: ../../../../exceptions.py @ line 30-38](../../../../exceptions.py#L30-L38) +### *attr* [UnsupportedMethod.**EXCEPTION_NAME**](../../../../exceptions.py#L55) -### *attr* UnknownLanguage.**STATUS_CODE** +## *class* [**UnsupportedLanguage**](../../../../exceptions.py#L61-L67) -> [Source: ../../../../exceptions.py @ line 31](../../../../exceptions.py#L31) +### *attr* [UnsupportedLanguage.**STATUS_CODE**](../../../../exceptions.py#L62) -### *attr* UnknownLanguage.**MESSAGE** +### *attr* [UnsupportedLanguage.**MESSAGE**](../../../../exceptions.py#L63) -> [Source: ../../../../exceptions.py @ line 32](../../../../exceptions.py#L32) +### *attr* [UnsupportedLanguage.**EXCEPTION_NAME**](../../../../exceptions.py#L64) -### *attr* UnknownLanguage.**EXCEPTION_NAME** +## *class* [**ServiceURLError**](../../../../exceptions.py#L70-L76) -> [Source: ../../../../exceptions.py @ line 33](../../../../exceptions.py#L33) +### *attr* [ServiceURLError.**STATUS_CODE**](../../../../exceptions.py#L71) -## *class* **UnknownTranslator** +### *attr* [ServiceURLError.**MESSAGE**](../../../../exceptions.py#L72) -> [Source: ../../../../exceptions.py @ line 41-49](../../../../exceptions.py#L41-L49) +### *attr* [ServiceURLError.**EXCEPTION_NAME**](../../../../exceptions.py#L73) -### *attr* UnknownTranslator.**STATUS_CODE** +## *class* [**RateLimitPrevention**](../../../../exceptions.py#L79-L82) -> [Source: ../../../../exceptions.py @ line 42](../../../../exceptions.py#L42) +### *attr* [RateLimitPrevention.**STATUS_CODE**](../../../../exceptions.py#L80) -### *attr* UnknownTranslator.**MESSAGE** +### *attr* [RateLimitPrevention.**MESSAGE**](../../../../exceptions.py#L81) -> [Source: ../../../../exceptions.py @ line 43](../../../../exceptions.py#L43) - -### *attr* UnknownTranslator.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 44](../../../../exceptions.py#L44) - -## *class* **UnsupportedMethod** - -> [Source: ../../../../exceptions.py @ line 52-58](../../../../exceptions.py#L52-L58) - -### *attr* UnsupportedMethod.**STATUS_CODE** - -> [Source: ../../../../exceptions.py @ line 53](../../../../exceptions.py#L53) - -### *attr* UnsupportedMethod.**MESSAGE** - -> [Source: ../../../../exceptions.py @ line 54](../../../../exceptions.py#L54) - -### *attr* UnsupportedMethod.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 55](../../../../exceptions.py#L55) - -## *class* **UnsupportedLanguage** - -> [Source: ../../../../exceptions.py @ line 61-67](../../../../exceptions.py#L61-L67) - -### *attr* UnsupportedLanguage.**STATUS_CODE** - -> [Source: ../../../../exceptions.py @ line 62](../../../../exceptions.py#L62) - -### *attr* UnsupportedLanguage.**MESSAGE** - -> [Source: ../../../../exceptions.py @ line 63](../../../../exceptions.py#L63) - -### *attr* UnsupportedLanguage.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 64](../../../../exceptions.py#L64) - -## *class* **ServiceURLError** - -> [Source: ../../../../exceptions.py @ line 70-76](../../../../exceptions.py#L70-L76) - -### *attr* ServiceURLError.**STATUS_CODE** - -> [Source: ../../../../exceptions.py @ line 71](../../../../exceptions.py#L71) - -### *attr* ServiceURLError.**MESSAGE** - -> [Source: ../../../../exceptions.py @ line 72](../../../../exceptions.py#L72) - -### *attr* ServiceURLError.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 73](../../../../exceptions.py#L73) - -## *class* **RateLimitPrevention** - -> [Source: ../../../../exceptions.py @ line 79-82](../../../../exceptions.py#L79-L82) - -### *attr* RateLimitPrevention.**STATUS_CODE** - -> [Source: ../../../../exceptions.py @ line 80](../../../../exceptions.py#L80) - -### *attr* RateLimitPrevention.**MESSAGE** - -> [Source: ../../../../exceptions.py @ line 81](../../../../exceptions.py#L81) - -### *attr* RateLimitPrevention.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 82](../../../../exceptions.py#L82) +### *attr* [RateLimitPrevention.**EXCEPTION_NAME**](../../../../exceptions.py#L82) diff --git a/translatepy/server/docs/fra/reference/language.md b/translatepy/server/docs/fra/reference/language.md index 797bbef..52de28c 100644 --- a/translatepy/server/docs/fra/reference/language.md +++ b/translatepy/server/docs/fra/reference/language.md @@ -1,6 +1,6 @@ # *module* **language** -> [Source: ../../../../language.py @ line 0](../../../../language.py#L0) +> [Source: ../../../../language.py](../../../../language.py#L0) Handles the languages management on `translatepy` @@ -12,21 +12,15 @@ Handles the languages management on `translatepy` - [../../../../utils/vectorize.py](../../../../utils/vectorize.py): As `vectorize` -## *const* **Number** - -> [Source: ../../../../language.py @ line 17](../../../../language.py#L17) +## *const* [**Number**](../../../../language.py#L17) Represents a number -## *class* **LanguageExtra** - -> [Source: ../../../../language.py @ line 21-34](../../../../language.py#L21-L34) +## *class* [**LanguageExtra**](../../../../language.py#L21-L34) Extra data given on supported languages -### *attr* LanguageExtra.**scope** - -> [Source: ../../../../language.py @ line 23](../../../../language.py#L23) +### *attr* [LanguageExtra.**scope**](../../../../language.py#L23) > Type: `cain.types.Enum` @@ -35,9 +29,7 @@ Language scope > **Note** > Can be one of "individual", "macrolanguage", "special" -### *attr* LanguageExtra.**type** - -> [Source: ../../../../language.py @ line 28](../../../../language.py#L28) +### *attr* [LanguageExtra.**type**](../../../../language.py#L28) > Type: `cain.types.Enum` @@ -46,773 +38,577 @@ Language type > **Note** > Can be one of "ancient", "constructed", "extinct", "historical", "living", "special" -## *class* **Foreign** - -> [Source: ../../../../language.py @ line 37-208](../../../../language.py#L37-L208) +## *class* [**Foreign**](../../../../language.py#L37-L208) The language name in foreign languages -### *attr* Foreign.**afrikaans** - -> [Source: ../../../../language.py @ line 39](../../../../language.py#L39) +### *attr* [Foreign.**afrikaans**](../../../../language.py#L39) > Type: `str` The language name in afrikaans -### *attr* Foreign.**albanian** - -> [Source: ../../../../language.py @ line 41](../../../../language.py#L41) +### *attr* [Foreign.**albanian**](../../../../language.py#L41) > Type: `str` The language name in albanian -### *attr* Foreign.**amharic** - -> [Source: ../../../../language.py @ line 43](../../../../language.py#L43) +### *attr* [Foreign.**amharic**](../../../../language.py#L43) > Type: `str` The language name in amharic -### *attr* Foreign.**arabic** - -> [Source: ../../../../language.py @ line 45](../../../../language.py#L45) +### *attr* [Foreign.**arabic**](../../../../language.py#L45) > Type: `str` The language name in arabic -### *attr* Foreign.**armenian** - -> [Source: ../../../../language.py @ line 47](../../../../language.py#L47) +### *attr* [Foreign.**armenian**](../../../../language.py#L47) > Type: `str` The language name in armenian -### *attr* Foreign.**azerbaijani** - -> [Source: ../../../../language.py @ line 49](../../../../language.py#L49) +### *attr* [Foreign.**azerbaijani**](../../../../language.py#L49) > Type: `str` The language name in azerbaijani -### *attr* Foreign.**basque** - -> [Source: ../../../../language.py @ line 51](../../../../language.py#L51) +### *attr* [Foreign.**basque**](../../../../language.py#L51) > Type: `str` The language name in basque -### *attr* Foreign.**belarusian** - -> [Source: ../../../../language.py @ line 53](../../../../language.py#L53) +### *attr* [Foreign.**belarusian**](../../../../language.py#L53) > Type: `str` The language name in belarusian -### *attr* Foreign.**bengali** - -> [Source: ../../../../language.py @ line 55](../../../../language.py#L55) +### *attr* [Foreign.**bengali**](../../../../language.py#L55) > Type: `str` The language name in bengali -### *attr* Foreign.**bosnian** - -> [Source: ../../../../language.py @ line 57](../../../../language.py#L57) +### *attr* [Foreign.**bosnian**](../../../../language.py#L57) > Type: `str` The language name in bosnian -### *attr* Foreign.**bulgarian** - -> [Source: ../../../../language.py @ line 59](../../../../language.py#L59) +### *attr* [Foreign.**bulgarian**](../../../../language.py#L59) > Type: `str` The language name in bulgarian -### *attr* Foreign.**burmese** - -> [Source: ../../../../language.py @ line 61](../../../../language.py#L61) +### *attr* [Foreign.**burmese**](../../../../language.py#L61) > Type: `str` The language name in burmese -### *attr* Foreign.**catalan** - -> [Source: ../../../../language.py @ line 63](../../../../language.py#L63) +### *attr* [Foreign.**catalan**](../../../../language.py#L63) > Type: `str` The language name in catalan -### *attr* Foreign.**chinese** - -> [Source: ../../../../language.py @ line 65](../../../../language.py#L65) +### *attr* [Foreign.**chinese**](../../../../language.py#L65) > Type: `str` The language name in chinese -### *attr* Foreign.**croatian** - -> [Source: ../../../../language.py @ line 67](../../../../language.py#L67) +### *attr* [Foreign.**croatian**](../../../../language.py#L67) > Type: `str` The language name in croatian -### *attr* Foreign.**czech** - -> [Source: ../../../../language.py @ line 69](../../../../language.py#L69) +### *attr* [Foreign.**czech**](../../../../language.py#L69) > Type: `str` The language name in czech -### *attr* Foreign.**danish** - -> [Source: ../../../../language.py @ line 71](../../../../language.py#L71) +### *attr* [Foreign.**danish**](../../../../language.py#L71) > Type: `str` The language name in danish -### *attr* Foreign.**dutch** - -> [Source: ../../../../language.py @ line 73](../../../../language.py#L73) +### *attr* [Foreign.**dutch**](../../../../language.py#L73) > Type: `str` The language name in dutch -### *attr* Foreign.**esperanto** - -> [Source: ../../../../language.py @ line 75](../../../../language.py#L75) +### *attr* [Foreign.**esperanto**](../../../../language.py#L75) > Type: `str` The language name in esperanto -### *attr* Foreign.**estonian** - -> [Source: ../../../../language.py @ line 77](../../../../language.py#L77) +### *attr* [Foreign.**estonian**](../../../../language.py#L77) > Type: `str` The language name in estonian -### *attr* Foreign.**finnish** - -> [Source: ../../../../language.py @ line 79](../../../../language.py#L79) +### *attr* [Foreign.**finnish**](../../../../language.py#L79) > Type: `str` The language name in finnish -### *attr* Foreign.**french** - -> [Source: ../../../../language.py @ line 81](../../../../language.py#L81) +### *attr* [Foreign.**french**](../../../../language.py#L81) > Type: `str` The language name in french -### *attr* Foreign.**galician** - -> [Source: ../../../../language.py @ line 83](../../../../language.py#L83) +### *attr* [Foreign.**galician**](../../../../language.py#L83) > Type: `str` The language name in galician -### *attr* Foreign.**georgian** - -> [Source: ../../../../language.py @ line 85](../../../../language.py#L85) +### *attr* [Foreign.**georgian**](../../../../language.py#L85) > Type: `str` The language name in georgian -### *attr* Foreign.**german** - -> [Source: ../../../../language.py @ line 87](../../../../language.py#L87) +### *attr* [Foreign.**german**](../../../../language.py#L87) > Type: `str` The language name in german -### *attr* Foreign.**gujarati** - -> [Source: ../../../../language.py @ line 89](../../../../language.py#L89) +### *attr* [Foreign.**gujarati**](../../../../language.py#L89) > Type: `str` The language name in gujarati -### *attr* Foreign.**haitian** - -> [Source: ../../../../language.py @ line 91](../../../../language.py#L91) +### *attr* [Foreign.**haitian**](../../../../language.py#L91) > Type: `str` The language name in haitian -### *attr* Foreign.**hebrew** - -> [Source: ../../../../language.py @ line 93](../../../../language.py#L93) +### *attr* [Foreign.**hebrew**](../../../../language.py#L93) > Type: `str` The language name in hebrew -### *attr* Foreign.**hindi** - -> [Source: ../../../../language.py @ line 95](../../../../language.py#L95) +### *attr* [Foreign.**hindi**](../../../../language.py#L95) > Type: `str` The language name in hindi -### *attr* Foreign.**hungarian** - -> [Source: ../../../../language.py @ line 97](../../../../language.py#L97) +### *attr* [Foreign.**hungarian**](../../../../language.py#L97) > Type: `str` The language name in hungarian -### *attr* Foreign.**icelandic** - -> [Source: ../../../../language.py @ line 99](../../../../language.py#L99) +### *attr* [Foreign.**icelandic**](../../../../language.py#L99) > Type: `str` The language name in icelandic -### *attr* Foreign.**indonesian** - -> [Source: ../../../../language.py @ line 101](../../../../language.py#L101) +### *attr* [Foreign.**indonesian**](../../../../language.py#L101) > Type: `str` The language name in indonesian -### *attr* Foreign.**irish** - -> [Source: ../../../../language.py @ line 103](../../../../language.py#L103) +### *attr* [Foreign.**irish**](../../../../language.py#L103) > Type: `str` The language name in irish -### *attr* Foreign.**italian** - -> [Source: ../../../../language.py @ line 105](../../../../language.py#L105) +### *attr* [Foreign.**italian**](../../../../language.py#L105) > Type: `str` The language name in italian -### *attr* Foreign.**japanese** - -> [Source: ../../../../language.py @ line 107](../../../../language.py#L107) +### *attr* [Foreign.**japanese**](../../../../language.py#L107) > Type: `str` The language name in japanese -### *attr* Foreign.**javanese** - -> [Source: ../../../../language.py @ line 109](../../../../language.py#L109) +### *attr* [Foreign.**javanese**](../../../../language.py#L109) > Type: `str` The language name in javanese -### *attr* Foreign.**kannada** - -> [Source: ../../../../language.py @ line 111](../../../../language.py#L111) +### *attr* [Foreign.**kannada**](../../../../language.py#L111) > Type: `str` The language name in kannada -### *attr* Foreign.**kazakh** - -> [Source: ../../../../language.py @ line 113](../../../../language.py#L113) +### *attr* [Foreign.**kazakh**](../../../../language.py#L113) > Type: `str` The language name in kazakh -### *attr* Foreign.**khmer** - -> [Source: ../../../../language.py @ line 115](../../../../language.py#L115) +### *attr* [Foreign.**khmer**](../../../../language.py#L115) > Type: `str` The language name in khmer -### *attr* Foreign.**kirghiz** - -> [Source: ../../../../language.py @ line 117](../../../../language.py#L117) +### *attr* [Foreign.**kirghiz**](../../../../language.py#L117) > Type: `str` The language name in kirghiz -### *attr* Foreign.**korean** - -> [Source: ../../../../language.py @ line 119](../../../../language.py#L119) +### *attr* [Foreign.**korean**](../../../../language.py#L119) > Type: `str` The language name in korean -### *attr* Foreign.**lao** - -> [Source: ../../../../language.py @ line 121](../../../../language.py#L121) +### *attr* [Foreign.**lao**](../../../../language.py#L121) > Type: `str` The language name in lao -### *attr* Foreign.**latin** - -> [Source: ../../../../language.py @ line 123](../../../../language.py#L123) +### *attr* [Foreign.**latin**](../../../../language.py#L123) > Type: `str` The language name in latin -### *attr* Foreign.**latvian** - -> [Source: ../../../../language.py @ line 125](../../../../language.py#L125) +### *attr* [Foreign.**latvian**](../../../../language.py#L125) > Type: `str` The language name in latvian -### *attr* Foreign.**lithuanian** - -> [Source: ../../../../language.py @ line 127](../../../../language.py#L127) +### *attr* [Foreign.**lithuanian**](../../../../language.py#L127) > Type: `str` The language name in lithuanian -### *attr* Foreign.**luxembourgish** - -> [Source: ../../../../language.py @ line 129](../../../../language.py#L129) +### *attr* [Foreign.**luxembourgish**](../../../../language.py#L129) > Type: `str` The language name in luxembourgish -### *attr* Foreign.**macedonian** - -> [Source: ../../../../language.py @ line 131](../../../../language.py#L131) +### *attr* [Foreign.**macedonian**](../../../../language.py#L131) > Type: `str` The language name in macedonian -### *attr* Foreign.**malagasy** - -> [Source: ../../../../language.py @ line 133](../../../../language.py#L133) +### *attr* [Foreign.**malagasy**](../../../../language.py#L133) > Type: `str` The language name in malagasy -### *attr* Foreign.**malay** - -> [Source: ../../../../language.py @ line 135](../../../../language.py#L135) +### *attr* [Foreign.**malay**](../../../../language.py#L135) > Type: `str` The language name in malay -### *attr* Foreign.**maltese** - -> [Source: ../../../../language.py @ line 137](../../../../language.py#L137) +### *attr* [Foreign.**maltese**](../../../../language.py#L137) > Type: `str` The language name in maltese -### *attr* Foreign.**maori** - -> [Source: ../../../../language.py @ line 139](../../../../language.py#L139) +### *attr* [Foreign.**maori**](../../../../language.py#L139) > Type: `str` The language name in maori -### *attr* Foreign.**marathi** - -> [Source: ../../../../language.py @ line 141](../../../../language.py#L141) +### *attr* [Foreign.**marathi**](../../../../language.py#L141) > Type: `str` The language name in marathi -### *attr* Foreign.**moderngreek** - -> [Source: ../../../../language.py @ line 143](../../../../language.py#L143) +### *attr* [Foreign.**moderngreek**](../../../../language.py#L143) > Type: `str` The language name in moderngreek -### *attr* Foreign.**mongolian** - -> [Source: ../../../../language.py @ line 145](../../../../language.py#L145) +### *attr* [Foreign.**mongolian**](../../../../language.py#L145) > Type: `str` The language name in mongolian -### *attr* Foreign.**nepali** - -> [Source: ../../../../language.py @ line 147](../../../../language.py#L147) +### *attr* [Foreign.**nepali**](../../../../language.py#L147) > Type: `str` The language name in nepali -### *attr* Foreign.**norwegian** - -> [Source: ../../../../language.py @ line 149](../../../../language.py#L149) +### *attr* [Foreign.**norwegian**](../../../../language.py#L149) > Type: `str` The language name in norwegian -### *attr* Foreign.**panjabi** - -> [Source: ../../../../language.py @ line 151](../../../../language.py#L151) +### *attr* [Foreign.**panjabi**](../../../../language.py#L151) > Type: `str` The language name in panjabi -### *attr* Foreign.**persian** - -> [Source: ../../../../language.py @ line 153](../../../../language.py#L153) +### *attr* [Foreign.**persian**](../../../../language.py#L153) > Type: `str` The language name in persian -### *attr* Foreign.**polish** - -> [Source: ../../../../language.py @ line 155](../../../../language.py#L155) +### *attr* [Foreign.**polish**](../../../../language.py#L155) > Type: `str` The language name in polish -### *attr* Foreign.**portuguese** - -> [Source: ../../../../language.py @ line 157](../../../../language.py#L157) +### *attr* [Foreign.**portuguese**](../../../../language.py#L157) > Type: `str` The language name in portuguese -### *attr* Foreign.**romanian** - -> [Source: ../../../../language.py @ line 159](../../../../language.py#L159) +### *attr* [Foreign.**romanian**](../../../../language.py#L159) > Type: `str` The language name in romanian -### *attr* Foreign.**russian** - -> [Source: ../../../../language.py @ line 161](../../../../language.py#L161) +### *attr* [Foreign.**russian**](../../../../language.py#L161) > Type: `str` The language name in russian -### *attr* Foreign.**scottishgaelic** - -> [Source: ../../../../language.py @ line 163](../../../../language.py#L163) +### *attr* [Foreign.**scottishgaelic**](../../../../language.py#L163) > Type: `str` The language name in scottishgaelic -### *attr* Foreign.**serbian** - -> [Source: ../../../../language.py @ line 165](../../../../language.py#L165) +### *attr* [Foreign.**serbian**](../../../../language.py#L165) > Type: `str` The language name in serbian -### *attr* Foreign.**sinhala** - -> [Source: ../../../../language.py @ line 167](../../../../language.py#L167) +### *attr* [Foreign.**sinhala**](../../../../language.py#L167) > Type: `str` The language name in sinhala -### *attr* Foreign.**slovak** - -> [Source: ../../../../language.py @ line 169](../../../../language.py#L169) +### *attr* [Foreign.**slovak**](../../../../language.py#L169) > Type: `str` The language name in slovak -### *attr* Foreign.**slovenian** - -> [Source: ../../../../language.py @ line 171](../../../../language.py#L171) +### *attr* [Foreign.**slovenian**](../../../../language.py#L171) > Type: `str` The language name in slovenian -### *attr* Foreign.**spanish** - -> [Source: ../../../../language.py @ line 173](../../../../language.py#L173) +### *attr* [Foreign.**spanish**](../../../../language.py#L173) > Type: `str` The language name in spanish -### *attr* Foreign.**sundanese** - -> [Source: ../../../../language.py @ line 175](../../../../language.py#L175) +### *attr* [Foreign.**sundanese**](../../../../language.py#L175) > Type: `str` The language name in sundanese -### *attr* Foreign.**swahili** - -> [Source: ../../../../language.py @ line 177](../../../../language.py#L177) +### *attr* [Foreign.**swahili**](../../../../language.py#L177) > Type: `str` The language name in swahili -### *attr* Foreign.**swedish** - -> [Source: ../../../../language.py @ line 179](../../../../language.py#L179) +### *attr* [Foreign.**swedish**](../../../../language.py#L179) > Type: `str` The language name in swedish -### *attr* Foreign.**tagalog** - -> [Source: ../../../../language.py @ line 181](../../../../language.py#L181) +### *attr* [Foreign.**tagalog**](../../../../language.py#L181) > Type: `str` The language name in tagalog -### *attr* Foreign.**tajik** - -> [Source: ../../../../language.py @ line 183](../../../../language.py#L183) +### *attr* [Foreign.**tajik**](../../../../language.py#L183) > Type: `str` The language name in tajik -### *attr* Foreign.**tamil** - -> [Source: ../../../../language.py @ line 185](../../../../language.py#L185) +### *attr* [Foreign.**tamil**](../../../../language.py#L185) > Type: `str` The language name in tamil -### *attr* Foreign.**telugu** - -> [Source: ../../../../language.py @ line 187](../../../../language.py#L187) +### *attr* [Foreign.**telugu**](../../../../language.py#L187) > Type: `str` The language name in telugu -### *attr* Foreign.**thai** - -> [Source: ../../../../language.py @ line 189](../../../../language.py#L189) +### *attr* [Foreign.**thai**](../../../../language.py#L189) > Type: `str` The language name in thai -### *attr* Foreign.**turkish** - -> [Source: ../../../../language.py @ line 191](../../../../language.py#L191) +### *attr* [Foreign.**turkish**](../../../../language.py#L191) > Type: `str` The language name in turkish -### *attr* Foreign.**ukrainian** - -> [Source: ../../../../language.py @ line 193](../../../../language.py#L193) +### *attr* [Foreign.**ukrainian**](../../../../language.py#L193) > Type: `str` The language name in ukrainian -### *attr* Foreign.**urdu** - -> [Source: ../../../../language.py @ line 195](../../../../language.py#L195) +### *attr* [Foreign.**urdu**](../../../../language.py#L195) > Type: `str` The language name in urdu -### *attr* Foreign.**uzbek** - -> [Source: ../../../../language.py @ line 197](../../../../language.py#L197) +### *attr* [Foreign.**uzbek**](../../../../language.py#L197) > Type: `str` The language name in uzbek -### *attr* Foreign.**vietnamese** - -> [Source: ../../../../language.py @ line 199](../../../../language.py#L199) +### *attr* [Foreign.**vietnamese**](../../../../language.py#L199) > Type: `str` The language name in vietnamese -### *attr* Foreign.**welsh** - -> [Source: ../../../../language.py @ line 201](../../../../language.py#L201) +### *attr* [Foreign.**welsh**](../../../../language.py#L201) > Type: `str` The language name in welsh -### *attr* Foreign.**xhosa** - -> [Source: ../../../../language.py @ line 203](../../../../language.py#L203) +### *attr* [Foreign.**xhosa**](../../../../language.py#L203) > Type: `str` The language name in xhosa -### *attr* Foreign.**yiddish** - -> [Source: ../../../../language.py @ line 205](../../../../language.py#L205) +### *attr* [Foreign.**yiddish**](../../../../language.py#L205) > Type: `str` The language name in yiddish -### *attr* Foreign.**zulu** - -> [Source: ../../../../language.py @ line 207](../../../../language.py#L207) +### *attr* [Foreign.**zulu**](../../../../language.py#L207) > Type: `str` The language name in zulu -## *const* **LANGUAGE_CACHE** - -> [Source: ../../../../language.py @ line 211](../../../../language.py#L211) +## *const* [**LANGUAGE_CACHE**](../../../../language.py#L211) -## *const* **NULLABLE_ATTRIBUTES** +## *const* [**NULLABLE_ATTRIBUTES**](../../../../language.py#L212) -> [Source: ../../../../language.py @ line 212](../../../../language.py#L212) - -## *class* **Language** - -> [Source: ../../../../language.py @ line 215-347](../../../../language.py#L215-L347) +## *class* [**Language**](../../../../language.py#L215-L347) A language -### *attr* Language.**id** - -> [Source: ../../../../language.py @ line 218](../../../../language.py#L218) +### *attr* [Language.**id**](../../../../language.py#L218) > Type: `str` The language identifier -### *attr* Language.**alpha3** - -> [Source: ../../../../language.py @ line 220](../../../../language.py#L220) +### *attr* [Language.**alpha3**](../../../../language.py#L220) > Type: `str` The ISO 639-3 (Alpha-3) code -### *attr* Language.**name** - -> [Source: ../../../../language.py @ line 222](../../../../language.py#L222) +### *attr* [Language.**name**](../../../../language.py#L222) > Type: `str` The english name -### *attr* Language.**alpha2** - -> [Source: ../../../../language.py @ line 224](../../../../language.py#L224) +### *attr* [Language.**alpha2**](../../../../language.py#L224) > Type: `Optional` The ISO 639-1 (Alpha-2) code, if available -### *attr* Language.**alpha3b** - -> [Source: ../../../../language.py @ line 226](../../../../language.py#L226) +### *attr* [Language.**alpha3b**](../../../../language.py#L226) > Type: `Optional` The ISO 639-2B (Alpha-3) code, if available -### *attr* Language.**alpha3t** - -> [Source: ../../../../language.py @ line 228](../../../../language.py#L228) +### *attr* [Language.**alpha3t**](../../../../language.py#L228) > Type: `Optional` The ISO 639-2T (Alpha-3) code, if available -### *attr* Language.**extra** - -> [Source: ../../../../language.py @ line 230](../../../../language.py#L230) +### *attr* [Language.**extra**](../../../../language.py#L230) > Type: `Optional` Extra data for the language, if available -### *attr* Language.**foreign** - -> [Source: ../../../../language.py @ line 232](../../../../language.py#L232) +### *attr* [Language.**foreign**](../../../../language.py#L232) > Type: `Optional` Name in foreign languages, if available -### *func* Language.**search** - -> [Source: ../../../../language.py @ line 269-292](../../../../language.py#L269-L292) +### *func* [Language.**search**](../../../../language.py#L269-L292) Searches the given language @@ -828,9 +624,7 @@ Searches the given language - `list` -### *func* Language.**get_extra** - -> [Source: ../../../../language.py @ line 310-317](../../../../language.py#L310-L317) +### *func* [Language.**get_extra**](../../../../language.py#L310-L317) Retrieves the given attribute from `extra` if available @@ -845,9 +639,7 @@ Retrieves the given attribute from `extra` if available - `str` -### *func* Language.**get_foreign** - -> [Source: ../../../../language.py @ line 319-328](../../../../language.py#L319-L328) +### *func* [Language.**get_foreign**](../../../../language.py#L319-L328) Retrieves the given attribute from `foreign` if available @@ -862,9 +654,7 @@ Retrieves the given attribute from `foreign` if available - `str` -### *property* Language.**similarity** - -> [Source: ../../../../language.py @ line 331-333](../../../../language.py#L331-L333) +### *property* [Language.**similarity**](../../../../language.py#L331-L333) The similarity with the vector while searching the language @@ -872,9 +662,7 @@ The similarity with the vector while searching the language - `float` -### *property* Language.**native** - -> [Source: ../../../../language.py @ line 336-338](../../../../language.py#L336-L338) +### *property* [Language.**native**](../../../../language.py#L336-L338) The native name for the language or its english name @@ -882,9 +670,7 @@ The native name for the language or its english name - `str` -### *property* Language.**rich** - -> [Source: ../../../../language.py @ line 341-347](../../../../language.py#L341-L347) +### *property* [Language.**rich**](../../../../language.py#L341-L347) If the language discovery used the full translatepy dataset Note: This returns `False` if the `Language` was not fully initialized @@ -893,56 +679,38 @@ Note: This returns `False` if the `Language` was not fully initialized - `bool` -## *class* **LanguageData** - -> [Source: ../../../../language.py @ line 352-356](../../../../language.py#L352-L356) +## *class* [**LanguageData**](../../../../language.py#L352-L356) Groups all of the data -### *attr* LanguageData.**codes** - -> [Source: ../../../../language.py @ line 354](../../../../language.py#L354) +### *attr* [LanguageData.**codes**](../../../../language.py#L354) > Type: `Dict` -### *attr* LanguageData.**data** - -> [Source: ../../../../language.py @ line 355](../../../../language.py#L355) +### *attr* [LanguageData.**data**](../../../../language.py#L355) > Type: `Dict` -### *attr* LanguageData.**vectors** - -> [Source: ../../../../language.py @ line 356](../../../../language.py#L356) +### *attr* [LanguageData.**vectors**](../../../../language.py#L356) > Type: `List` -## *const* **LANGUAGE_DATA_DIR** - -> [Source: ../../../../language.py @ line 360](../../../../language.py#L360) +## *const* [**LANGUAGE_DATA_DIR**](../../../../language.py#L360) The directory where all of the data is stored -## *const* **DATA** - -> [Source: ../../../../language.py @ line 363](../../../../language.py#L363) +## *const* [**DATA**](../../../../language.py#L363) The languages in-memory data -## *const* **TRANSLATEPY_LANGUAGE_FULL** - -> [Source: ../../../../language.py @ line 369](../../../../language.py#L369) +## *const* [**TRANSLATEPY_LANGUAGE_FULL**](../../../../language.py#L369) If the full language data database got loaded at runtime -## *func* **load_full** - -> [Source: ../../../../language.py @ line 378-385](../../../../language.py#L378-L385) +## *func* [**load_full**](../../../../language.py#L378-L385) Loads the full data languages DB -## *const* **COMMON_LANGUAGES** - -> [Source: ../../../../language.py @ line 392](../../../../language.py#L392) +## *const* [**COMMON_LANGUAGES**](../../../../language.py#L392) All of the available foreign languages for the `foreign` field on the `Language` class and English diff --git a/translatepy/server/docs/fra/reference/models.md b/translatepy/server/docs/fra/reference/models.md index c2ea421..0bee762 100644 --- a/translatepy/server/docs/fra/reference/models.md +++ b/translatepy/server/docs/fra/reference/models.md @@ -1,6 +1,6 @@ # *module* **models** -> [Source: ../../../../models.py @ line 0](../../../../models.py#L0) +> [Source: ../../../../models.py](../../../../models.py#L0) translatepy/models.py Describes the different result models returned by the translators @@ -11,62 +11,38 @@ Describes the different result models returned by the translators - [../../../../utils/audio.py](../../../../utils/audio.py): As `get_type` -## *class* **Speed** - -> [Source: ../../../../models.py @ line 23-28](../../../../models.py#L23-L28) +## *class* [**Speed**](../../../../models.py#L23-L28) Represents a speed percentage -### *attr* Speed.**FULL** - -> [Source: ../../../../models.py @ line 25](../../../../models.py#L25) - -### *attr* Speed.**HALF** - -> [Source: ../../../../models.py @ line 26](../../../../models.py#L26) +### *attr* [Speed.**FULL**](../../../../models.py#L25) -### *attr* Speed.**QUARTER** +### *attr* [Speed.**HALF**](../../../../models.py#L26) -> [Source: ../../../../models.py @ line 27](../../../../models.py#L27) +### *attr* [Speed.**QUARTER**](../../../../models.py#L27) -### *attr* Speed.**SLOW** +### *attr* [Speed.**SLOW**](../../../../models.py#L28) -> [Source: ../../../../models.py @ line 28](../../../../models.py#L28) - -## *class* **Gender** - -> [Source: ../../../../models.py @ line 31-36](../../../../models.py#L31-L36) +## *class* [**Gender**](../../../../models.py#L31-L36) Represents a gender -### *attr* Gender.**MALE** - -> [Source: ../../../../models.py @ line 33](../../../../models.py#L33) +### *attr* [Gender.**MALE**](../../../../models.py#L33) -### *attr* Gender.**FEMALE** +### *attr* [Gender.**FEMALE**](../../../../models.py#L34) -> [Source: ../../../../models.py @ line 34](../../../../models.py#L34) +### *attr* [Gender.**OTHER**](../../../../models.py#L35) -### *attr* Gender.**OTHER** +### *attr* [Gender.**GENDERLESS**](../../../../models.py#L36) -> [Source: ../../../../models.py @ line 35](../../../../models.py#L35) - -### *attr* Gender.**GENDERLESS** - -> [Source: ../../../../models.py @ line 36](../../../../models.py#L36) - -## *class* **WordClass** - -> [Source: ../../../../models.py @ line 39-110](../../../../models.py#L39-L110) +## *class* [**WordClass**](../../../../models.py#L39-L110) Part of speech > **Note** > Refer to https://en.wikipedia.org/wiki/Part_of_speech -### *attr* WordClass.**NOUN** - -> [Source: ../../../../models.py @ line 45](../../../../models.py#L45) +### *attr* [WordClass.**NOUN**](../../../../models.py#L45) A word or lexical item denoting any abstract (abstract noun: e.g. home) or concrete entity (concrete noun: e.g. house); a person (police officer, Michael), place (coastline, London), thing (necktie, television), idea (happiness), or quality (bravery). @@ -75,37 +51,27 @@ Nouns can also be classified as count nouns or non-count nouns; some can belong > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**PRONOUN** - -> [Source: ../../../../models.py @ line 54](../../../../models.py#L54) +### *attr* [WordClass.**PRONOUN**](../../../../models.py#L54) A substitute for a noun or noun phrase (them, he). Pronouns make sentences shorter and clearer since they replace nouns. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ADJECTIVE** - -> [Source: ../../../../models.py @ line 60](../../../../models.py#L60) +### *attr* [WordClass.**ADJECTIVE**](../../../../models.py#L60) A modifier of a noun or pronoun (big, brave). Adjectives make the meaning of another word (noun) more precise. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**VERB** - -> [Source: ../../../../models.py @ line 66](../../../../models.py#L66) +### *attr* [WordClass.**VERB**](../../../../models.py#L66) A word denoting an action (walk), occurrence (happen), or state of being (be). Without a verb, a group of words cannot be a clause or sentence. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ADVERB** - -> [Source: ../../../../models.py @ line 72](../../../../models.py#L72) +### *attr* [WordClass.**ADVERB**](../../../../models.py#L72) A modifier of an adjective, verb, or another adverb (very, quite). Adverbs make language more precise. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**PREPOSITION** - -> [Source: ../../../../models.py @ line 78](../../../../models.py#L78) +### *attr* [WordClass.**PREPOSITION**](../../../../models.py#L78) A word that relates words to each other in a phrase or sentence and aids in syntactic context (in, of). Prepositions show the relationship between a noun or a pronoun with another word in the sentence. @@ -113,23 +79,17 @@ Prepositions show the relationship between a noun or a pronoun with another word > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**CONJUNCTION** - -> [Source: ../../../../models.py @ line 86](../../../../models.py#L86) +### *attr* [WordClass.**CONJUNCTION**](../../../../models.py#L86) A syntactic connector; links words, phrases, or clauses (and, but). Conjunctions connect words or group of words Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**INTERJECTION** - -> [Source: ../../../../models.py @ line 92](../../../../models.py#L92) +### *attr* [WordClass.**INTERJECTION**](../../../../models.py#L92) An emotional greeting or exclamation (Huzzah, Alas). Interjections express strong feelings and emotions. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ARTICLE** - -> [Source: ../../../../models.py @ line 98](../../../../models.py#L98) +### *attr* [WordClass.**ARTICLE**](../../../../models.py#L98) A grammatical marker of definiteness (the) or indefiniteness (a, an). The article is not always listed among the parts of speech. @@ -138,23 +98,15 @@ It is considered by some grammarians to be a type of adjective or sometimes the > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**OTHER** - -> [Source: ../../../../models.py @ line 107](../../../../models.py#L107) +### *attr* [WordClass.**OTHER**](../../../../models.py#L107) For other part of speech -## *const* **Translator** - -> [Source: ../../../../models.py @ line 113](../../../../models.py#L113) - -## *const* **PRIVATE_ATTRIBUTES** +## *const* [**Translator**](../../../../models.py#L113) -> [Source: ../../../../models.py @ line 115](../../../../models.py#L115) +## *const* [**PRIVATE_ATTRIBUTES**](../../../../models.py#L115) -## *func* **should_be_exported** - -> [Source: ../../../../models.py @ line 118-121](../../../../models.py#L118-L121) +## *func* [**should_be_exported**](../../../../models.py#L118-L121) if the given attribute should be exposed or not @@ -163,33 +115,23 @@ if the given attribute should be exposed or not - **attr**: `str` -## *class* **ResultAttribute** - -> [Source: ../../../../models.py @ line 125-129](../../../../models.py#L125-L129) +## *class* [**ResultAttribute**](../../../../models.py#L125-L129) Details about a result attribute -### *attr* ResultAttribute.**name** - -> [Source: ../../../../models.py @ line 127](../../../../models.py#L127) +### *attr* [ResultAttribute.**name**](../../../../models.py#L127) > Type: `str` -### *attr* ResultAttribute.**annotation** - -> [Source: ../../../../models.py @ line 128](../../../../models.py#L128) +### *attr* [ResultAttribute.**annotation**](../../../../models.py#L128) > Type: `Optional` -### *attr* ResultAttribute.**description** - -> [Source: ../../../../models.py @ line 129](../../../../models.py#L129) +### *attr* [ResultAttribute.**description**](../../../../models.py#L129) > Type: `Optional` -## *class* **Result** - -> [Source: ../../../../models.py @ line 136-287](../../../../models.py#L136-L287) +## *class* [**Result**](../../../../models.py#L136-L287) The base result model @@ -197,33 +139,25 @@ The base result model - `IndexError` -### *attr* Result.**service** - -> [Source: ../../../../models.py @ line 143](../../../../models.py#L143) +### *attr* [Result.**service**](../../../../models.py#L143) > Type: `Translator` The service which returned the result -### *attr* Result.**source** - -> [Source: ../../../../models.py @ line 146](../../../../models.py#L146) +### *attr* [Result.**source**](../../../../models.py#L146) > Type: `str` The source text -### *attr* Result.**source_lang** - -> [Source: ../../../../models.py @ line 148](../../../../models.py#L148) +### *attr* [Result.**source_lang**](../../../../models.py#L148) > Type: `Language` The source text's language -### *attr* Result.**raw** - -> [Source: ../../../../models.py @ line 158](../../../../models.py#L158) +### *attr* [Result.**raw**](../../../../models.py#L158) > Type: `Optional` @@ -231,9 +165,7 @@ The raw response returned by the service. Note: This is very dependent on the service used. Refer to the service documentation to learn how to use this object. -### *property* Result.**attributes** - -> [Source: ../../../../models.py @ line 217-267](../../../../models.py#L217-L267) +### *property* [Result.**attributes**](../../../../models.py#L217-L267) The different attributes on the dataclass @@ -246,9 +178,7 @@ The different attributes on the dataclass - `list` -### *property* Result.**exported** - -> [Source: ../../../../models.py @ line 270-281](../../../../models.py#L270-L281) +### *property* [Result.**exported**](../../../../models.py#L270-L281) A dictionary version of the dataclass which can be exposed to the public @@ -256,169 +186,119 @@ A dictionary version of the dataclass which can be exposed to the public - `dict` -## *class* **TranslationResult** - -> [Source: ../../../../models.py @ line 291-329](../../../../models.py#L291-L329) +## *class* [**TranslationResult**](../../../../models.py#L291-L329) Holds the result of a regular translation -### *attr* TranslationResult.**dest_lang** - -> [Source: ../../../../models.py @ line 296](../../../../models.py#L296) +### *attr* [TranslationResult.**dest_lang**](../../../../models.py#L296) > Type: `Language` The result's language -### *attr* TranslationResult.**translation** - -> [Source: ../../../../models.py @ line 299](../../../../models.py#L299) +### *attr* [TranslationResult.**translation**](../../../../models.py#L299) > Type: `str` The translation result -### *property* TranslationResult.**alternatives** - -> [Source: ../../../../models.py @ line 306-310](../../../../models.py#L306-L310) +### *property* [TranslationResult.**alternatives**](../../../../models.py#L306-L310) Returns the alternative translations associated -## *const* **TRANSLATION_TEST** +## *const* [**TRANSLATION_TEST**](../../../../models.py#L332) -> [Source: ../../../../models.py @ line 332](../../../../models.py#L332) - -## *class* **TransliterationResult** - -> [Source: ../../../../models.py @ line 344-371](../../../../models.py#L344-L371) +## *class* [**TransliterationResult**](../../../../models.py#L344-L371) Holds the result of a transliteration -### *attr* TransliterationResult.**transliteration** - -> [Source: ../../../../models.py @ line 348](../../../../models.py#L348) +### *attr* [TransliterationResult.**transliteration**](../../../../models.py#L348) > Type: `str` The transliteration result -### *attr* TransliterationResult.**dest_lang** - -> [Source: ../../../../models.py @ line 351](../../../../models.py#L351) +### *attr* [TransliterationResult.**dest_lang**](../../../../models.py#L351) > Type: `Language` The result's language -## *const* **TRANSLITERATION_TEST** +## *const* [**TRANSLITERATION_TEST**](../../../../models.py#L374) -> [Source: ../../../../models.py @ line 374](../../../../models.py#L374) - -## *class* **SpellcheckResult** - -> [Source: ../../../../models.py @ line 384-410](../../../../models.py#L384-L410) +## *class* [**SpellcheckResult**](../../../../models.py#L384-L410) Holds a spellchecking result -### *attr* SpellcheckResult.**rich** - -> [Source: ../../../../models.py @ line 389](../../../../models.py#L389) +### *attr* [SpellcheckResult.**rich**](../../../../models.py#L389) -### *attr* SpellcheckResult.**source_lang** - -> [Source: ../../../../models.py @ line 391](../../../../models.py#L391) +### *attr* [SpellcheckResult.**source_lang**](../../../../models.py#L391) > Type: `Language` The source text's language -### *attr* SpellcheckResult.**corrected** - -> [Source: ../../../../models.py @ line 393](../../../../models.py#L393) +### *attr* [SpellcheckResult.**corrected**](../../../../models.py#L393) > Type: `str` The corrected text -## *const* **SPELLCHECK_TEST** - -> [Source: ../../../../models.py @ line 413](../../../../models.py#L413) +## *const* [**SPELLCHECK_TEST**](../../../../models.py#L413) -## *class* **SpellcheckMistake** - -> [Source: ../../../../models.py @ line 422-435](../../../../models.py#L422-L435) +## *class* [**SpellcheckMistake**](../../../../models.py#L422-L435) This holds a mistake made detected by the spellchecker -### *attr* SpellcheckMistake.**start** - -> [Source: ../../../../models.py @ line 424](../../../../models.py#L424) +### *attr* [SpellcheckMistake.**start**](../../../../models.py#L424) > Type: `int` The beginning index of the part to correct in the original text -### *attr* SpellcheckMistake.**end** - -> [Source: ../../../../models.py @ line 426](../../../../models.py#L426) +### *attr* [SpellcheckMistake.**end**](../../../../models.py#L426) > Type: `int` The ending index of the part to correct in the original text -### *attr* SpellcheckMistake.**corrected** - -> [Source: ../../../../models.py @ line 428](../../../../models.py#L428) +### *attr* [SpellcheckMistake.**corrected**](../../../../models.py#L428) > Type: `str` The corrected part -### *attr* SpellcheckMistake.**message** - -> [Source: ../../../../models.py @ line 431](../../../../models.py#L431) +### *attr* [SpellcheckMistake.**message**](../../../../models.py#L431) > Type: `Optional` A message explaining what happened -### *attr* SpellcheckMistake.**rule** - -> [Source: ../../../../models.py @ line 434](../../../../models.py#L434) +### *attr* [SpellcheckMistake.**rule**](../../../../models.py#L434) > Type: `Optional` A string which identifies the rule associated with the mistake made -## *class* **RichSpellcheckResult** - -> [Source: ../../../../models.py @ line 441-601](../../../../models.py#L441-L601) +## *class* [**RichSpellcheckResult**](../../../../models.py#L441-L601) Holds a rich spellchecking result -### *attr* RichSpellcheckResult.**rich** +### *attr* [RichSpellcheckResult.**rich**](../../../../models.py#L447) -> [Source: ../../../../models.py @ line 447](../../../../models.py#L447) - -### *attr* RichSpellcheckResult.**source_lang** - -> [Source: ../../../../models.py @ line 449](../../../../models.py#L449) +### *attr* [RichSpellcheckResult.**source_lang**](../../../../models.py#L449) > Type: `Language` The source text's language -### *attr* RichSpellcheckResult.**mistakes** - -> [Source: ../../../../models.py @ line 451](../../../../models.py#L451) +### *attr* [RichSpellcheckResult.**mistakes**](../../../../models.py#L451) > Type: `List` The different mistakes made -### *property* RichSpellcheckResult.**corrected** - -> [Source: ../../../../models.py @ line 455-463](../../../../models.py#L455-L463) +### *property* [RichSpellcheckResult.**corrected**](../../../../models.py#L455-L463) The corrected text @@ -426,45 +306,31 @@ The corrected text - `str` -## *const* **RICH_SPELLCHECK_TEST** - -> [Source: ../../../../models.py @ line 604](../../../../models.py#L604) - -## *class* **LanguageResult** +## *const* [**RICH_SPELLCHECK_TEST**](../../../../models.py#L604) -> [Source: ../../../../models.py @ line 618-628](../../../../models.py#L618-L628) +## *class* [**LanguageResult**](../../../../models.py#L618-L628) Holds the language of the given text -## *const* **LANGUAGE_TEST** +## *const* [**LANGUAGE_TEST**](../../../../models.py#L631) -> [Source: ../../../../models.py @ line 631](../../../../models.py#L631) - -## *class* **ExampleResult** - -> [Source: ../../../../models.py @ line 635-725](../../../../models.py#L635-L725) +## *class* [**ExampleResult**](../../../../models.py#L635-L725) Holds an example sentence where the given word is used. -### *attr* ExampleResult.**example** - -> [Source: ../../../../models.py @ line 641](../../../../models.py#L641) +### *attr* [ExampleResult.**example**](../../../../models.py#L641) > Type: `str` The example -### *attr* ExampleResult.**reference** - -> [Source: ../../../../models.py @ line 644](../../../../models.py#L644) +### *attr* [ExampleResult.**reference**](../../../../models.py#L644) > Type: `Optional` Where the example comes from (i.e a book or a the person who said it if it's a quote) -### *property* ExampleResult.**position** - -> [Source: ../../../../models.py @ line 648-655](../../../../models.py#L648-L655) +### *property* [ExampleResult.**position**](../../../../models.py#L648-L655) The first position of the word in the example @@ -474,9 +340,7 @@ The first position of the word in the example - `int` -### *property* ExampleResult.**positions** - -> [Source: ../../../../models.py @ line 658-690](../../../../models.py#L658-L690) +### *property* [ExampleResult.**positions**](../../../../models.py#L658-L690) The positions of the word in the example @@ -485,75 +349,51 @@ The positions of the word in the example - `list[int]` - A list of positions of the word in the example -## *const* **EXAMPLE_TEST** - -> [Source: ../../../../models.py @ line 728](../../../../models.py#L728) +## *const* [**EXAMPLE_TEST**](../../../../models.py#L728) -## *class* **DictionaryResult** - -> [Source: ../../../../models.py @ line 737-752](../../../../models.py#L737-L752) +## *class* [**DictionaryResult**](../../../../models.py#L737-L752) Holds the meaning of the given text -### *attr* DictionaryResult.**rich** - -> [Source: ../../../../models.py @ line 743](../../../../models.py#L743) - -### *attr* DictionaryResult.**meaning** +### *attr* [DictionaryResult.**rich**](../../../../models.py#L743) -> [Source: ../../../../models.py @ line 745](../../../../models.py#L745) +### *attr* [DictionaryResult.**meaning**](../../../../models.py#L745) > Type: `str` The meaning of the text -## *const* **DICTIONARY_TEST** +## *const* [**DICTIONARY_TEST**](../../../../models.py#L755) -> [Source: ../../../../models.py @ line 755](../../../../models.py#L755) - -## *class* **EtymologicalNode** - -> [Source: ../../../../models.py @ line 764-791](../../../../models.py#L764-L791) +## *class* [**EtymologicalNode**](../../../../models.py#L764-L791) The node of an etymological tree -### *attr* EtymologicalNode.**origin** - -> [Source: ../../../../models.py @ line 766](../../../../models.py#L766) +### *attr* [EtymologicalNode.**origin**](../../../../models.py#L766) > Type: `str` The origin name (i.e 'Latin') -### *attr* EtymologicalNode.**source** - -> [Source: ../../../../models.py @ line 769](../../../../models.py#L769) +### *attr* [EtymologicalNode.**source**](../../../../models.py#L769) > Type: `Optional` The original way of writing it -### *attr* EtymologicalNode.**year** - -> [Source: ../../../../models.py @ line 771](../../../../models.py#L771) +### *attr* [EtymologicalNode.**year**](../../../../models.py#L771) > Type: `Optional` The year of origin -## *class* **RichDictionaryResult** - -> [Source: ../../../../models.py @ line 795-904](../../../../models.py#L795-L904) +## *class* [**RichDictionaryResult**](../../../../models.py#L795-L904) Holds more (optional) information than the regular `DictionaryResult` -### *attr* RichDictionaryResult.**rich** +### *attr* [RichDictionaryResult.**rich**](../../../../models.py#L801) -> [Source: ../../../../models.py @ line 801](../../../../models.py#L801) - -### *attr* RichDictionaryResult.**etymology** - -> [Source: ../../../../models.py @ line 803](../../../../models.py#L803) +### *attr* [RichDictionaryResult.**etymology**](../../../../models.py#L803) > Type: `List` @@ -566,9 +406,7 @@ Each element corresponds to a node in the tree of origins for the given text `Node1 (Greek) -> Node2 (Latin) -> Node3 (French) -> Node4 (Ancient English) -> Current Word` -### *attr* RichDictionaryResult.**gender** - -> [Source: ../../../../models.py @ line 814](../../../../models.py#L814) +### *attr* [RichDictionaryResult.**gender**](../../../../models.py#L814) > Type: `Gender` @@ -580,77 +418,55 @@ For languages which assign genders on words `chaîse (french; a chair) -> Gender.FEMALE` -### *attr* RichDictionaryResult.**pronunciation** - -> [Source: ../../../../models.py @ line 823](../../../../models.py#L823) +### *attr* [RichDictionaryResult.**pronunciation**](../../../../models.py#L823) > Type: `Optional` A way of pronouncing the text -### *attr* RichDictionaryResult.**type** - -> [Source: ../../../../models.py @ line 826](../../../../models.py#L826) +### *attr* [RichDictionaryResult.**type**](../../../../models.py#L826) > Type: `WordClass` The part of speech of the text -### *attr* RichDictionaryResult.**synonyms** - -> [Source: ../../../../models.py @ line 829](../../../../models.py#L829) +### *attr* [RichDictionaryResult.**synonyms**](../../../../models.py#L829) > Type: `List` -### *attr* RichDictionaryResult.**antonyms** - -> [Source: ../../../../models.py @ line 830](../../../../models.py#L830) +### *attr* [RichDictionaryResult.**antonyms**](../../../../models.py#L830) > Type: `List` -## *const* **RICH_DICTIONARY_TEST** +## *const* [**RICH_DICTIONARY_TEST**](../../../../models.py#L907) -> [Source: ../../../../models.py @ line 907](../../../../models.py#L907) - -## *class* **TextToSpeechResult** - -> [Source: ../../../../models.py @ line 922-988](../../../../models.py#L922-L988) +## *class* [**TextToSpeechResult**](../../../../models.py#L922-L988) Holds the text to speech results -### *attr* TextToSpeechResult.**result** - -> [Source: ../../../../models.py @ line 928](../../../../models.py#L928) +### *attr* [TextToSpeechResult.**result**](../../../../models.py#L928) > Type: `bytes` Text to speech result -### *attr* TextToSpeechResult.**speed** - -> [Source: ../../../../models.py @ line 930](../../../../models.py#L930) +### *attr* [TextToSpeechResult.**speed**](../../../../models.py#L930) > Type: `int` Speed of the text to speech result -### *attr* TextToSpeechResult.**gender** - -> [Source: ../../../../models.py @ line 932](../../../../models.py#L932) +### *attr* [TextToSpeechResult.**gender**](../../../../models.py#L932) > Type: `Gender` Gender of the 'person' saying the text -### *property* TextToSpeechResult.**type** - -> [Source: ../../../../models.py @ line 936-938](../../../../models.py#L936-L938) +### *property* [TextToSpeechResult.**type**](../../../../models.py#L936-L938) Returns the type of audio file -### *property* TextToSpeechResult.**mime_type** - -> [Source: ../../../../models.py @ line 941-953](../../../../models.py#L941-L953) +### *property* [TextToSpeechResult.**mime_type**](../../../../models.py#L941-L953) Returns the MIME type of the audio file @@ -659,9 +475,7 @@ Returns the MIME type of the audio file - `Optional[str]` - The MIME type of the audio file -### *property* TextToSpeechResult.**extension** - -> [Source: ../../../../models.py @ line 956-968](../../../../models.py#L956-L968) +### *property* [TextToSpeechResult.**extension**](../../../../models.py#L956-L968) Returns the audio file extension @@ -670,9 +484,7 @@ Returns the audio file extension - `Optional[str]` - The MIME type of the audio file -### *func* TextToSpeechResult.**write_to_file** - -> [Source: ../../../../models.py @ line 970-988](../../../../models.py#L970-L988) +### *func* [TextToSpeechResult.**write_to_file**](../../../../models.py#L970-L988) Writes the spoken text to a file. @@ -687,27 +499,19 @@ Writes the spoken text to a file. - If we need to change the extension of the file to match the right file type -## *class* **HTMLTranslationNode** - -> [Source: ../../../../models.py @ line 992-1029](../../../../models.py#L992-L1029) +## *class* [**HTMLTranslationNode**](../../../../models.py#L992-L1029) A translation node, containing the DOM element and its translation result -### *attr* HTMLTranslationNode.**node** - -> [Source: ../../../../models.py @ line 996](../../../../models.py#L996) +### *attr* [HTMLTranslationNode.**node**](../../../../models.py#L996) > Type: `bs4.NavigableString` -### *attr* HTMLTranslationNode.**result** - -> [Source: ../../../../models.py @ line 997](../../../../models.py#L997) +### *attr* [HTMLTranslationNode.**result**](../../../../models.py#L997) > Type: `Optional` -### *property* HTMLTranslationNode.**position** - -> [Source: ../../../../models.py @ line 1000-1020](../../../../models.py#L1000-L1020) +### *property* [HTMLTranslationNode.**position**](../../../../models.py#L1000-L1020) The position of the node in the HTML @@ -715,9 +519,7 @@ The position of the node in the HTML - `int` -### *property* HTMLTranslationNode.**exported** - -> [Source: ../../../../models.py @ line 1023-1029](../../../../models.py#L1023-L1029) +### *property* [HTMLTranslationNode.**exported**](../../../../models.py#L1023-L1029) The exported dictionary @@ -725,33 +527,23 @@ The exported dictionary - `dict` -## *class* **HTMLTranslationResult** - -> [Source: ../../../../models.py @ line 1033-1052](../../../../models.py#L1033-L1052) +## *class* [**HTMLTranslationResult**](../../../../models.py#L1033-L1052) Holds an HTML translation result -### *attr* HTMLTranslationResult.**result** - -> [Source: ../../../../models.py @ line 1037](../../../../models.py#L1037) +### *attr* [HTMLTranslationResult.**result**](../../../../models.py#L1037) > Type: `str` -### *attr* HTMLTranslationResult.**soup** - -> [Source: ../../../../models.py @ line 1038](../../../../models.py#L1038) +### *attr* [HTMLTranslationResult.**soup**](../../../../models.py#L1038) > Type: `bs4.BeautifulSoup` -### *attr* HTMLTranslationResult.**nodes** - -> [Source: ../../../../models.py @ line 1039](../../../../models.py#L1039) +### *attr* [HTMLTranslationResult.**nodes**](../../../../models.py#L1039) > Type: `List` -### *property* HTMLTranslationResult.**exported** - -> [Source: ../../../../models.py @ line 1048-1052](../../../../models.py#L1048-L1052) +### *property* [HTMLTranslationResult.**exported**](../../../../models.py#L1048-L1052) #### Returns diff --git a/translatepy/server/docs/fra/reference/server/server.md b/translatepy/server/docs/fra/reference/server/server.md index 3fac41e..a95efb2 100644 --- a/translatepy/server/docs/fra/reference/server/server.md +++ b/translatepy/server/docs/fra/reference/server/server.md @@ -1,23 +1,17 @@ # *module* **server** -> [Source: ../../../../server.py @ line 0](../../../../server.py#L0) +> [Source: ../../../../server.py](../../../../server.py#L0) the translatepy server -## *const* **app** - -> [Source: ../../../../server.py @ line 6](../../../../server.py#L6) +## *const* [**app**](../../../../server.py#L6) The `nasse` server instance for `translatepy` -## *const* **TRANSLATEPY_ENDPOINT** - -> [Source: ../../../../server.py @ line 9](../../../../server.py#L9) +## *const* [**TRANSLATEPY_ENDPOINT**](../../../../server.py#L9) Base `translatepy` endpoint -## *const* **SERVER_DOCS_PATH** - -> [Source: ../../../../server.py @ line 13](../../../../server.py#L13) +## *const* [**SERVER_DOCS_PATH**](../../../../server.py#L13) The root path for the server offline docs diff --git a/translatepy/server/docs/fra/reference/translate.md b/translatepy/server/docs/fra/reference/translate.md index 32695c3..89256a1 100644 --- a/translatepy/server/docs/fra/reference/translate.md +++ b/translatepy/server/docs/fra/reference/translate.md @@ -1,6 +1,6 @@ # *module* **translate** -> [Source: ../../../../translate.py @ line 0](../../../../translate.py#L0) +> [Source: ../../../../translate.py](../../../../translate.py#L0) translatepy v3.0 © Anime no Sekai — 2023 @@ -37,14 +37,10 @@ translatepy v3.0 - [../../../../utils/request.py](../../../../utils/request.py): As `request` -## *const* **DEFAULT_TRANSLATORS** - -> [Source: ../../../../translate.py @ line 15](../../../../translate.py#L15) +## *const* [**DEFAULT_TRANSLATORS**](../../../../translate.py#L15) A list of default translators to use with the translators aggregation -## *class* **Translate** - -> [Source: ../../../../translate.py @ line 20-27](../../../../translate.py#L20-L27) +## *class* [**Translate**](../../../../translate.py#L20-L27) A class which groups all of the translators diff --git a/translatepy/server/docs/fra/reference/translators/README.md b/translatepy/server/docs/fra/reference/translators/README.md index f1565ab..1bb8003 100644 --- a/translatepy/server/docs/fra/reference/translators/README.md +++ b/translatepy/server/docs/fra/reference/translators/README.md @@ -1,6 +1,6 @@ # *module* **__init__** -> [Source: ../../../../../translators/__init__.py @ line 0](../../../../../translators/__init__.py#L0) +> [Source: ../../../../../translators/__init__.py](../../../../../translators/__init__.py#L0) ## Imports @@ -30,58 +30,30 @@ - [../../../../../translators/papago.py](../../../../../translators/papago.py): As `Papago` -## *const* **Reverso** +## *const* [**Reverso**](../../../../../translators/__init__.py#L21) -> [Source: ../../../../../translators/__init__.py @ line 21](../../../../../translators/__init__.py#L21) +## *const* [**Bing**](../../../../../translators/__init__.py#L22) -## *const* **Bing** +## *const* [**DeepL**](../../../../../translators/__init__.py#L23) -> [Source: ../../../../../translators/__init__.py @ line 22](../../../../../translators/__init__.py#L22) +## *const* [**Deepl**](../../../../../translators/__init__.py#L24) -## *const* **DeepL** +## *const* [**Google**](../../../../../translators/__init__.py#L25) -> [Source: ../../../../../translators/__init__.py @ line 23](../../../../../translators/__init__.py#L23) +## *const* [**Libre**](../../../../../translators/__init__.py#L26) -## *const* **Deepl** +## *const* [**MyMemory**](../../../../../translators/__init__.py#L27) -> [Source: ../../../../../translators/__init__.py @ line 24](../../../../../translators/__init__.py#L24) +## *const* [**TranslateCom**](../../../../../translators/__init__.py#L28) -## *const* **Google** +## *const* [**Yandex**](../../../../../translators/__init__.py#L29) -> [Source: ../../../../../translators/__init__.py @ line 25](../../../../../translators/__init__.py#L25) +## *const* [**Microsoft**](../../../../../translators/__init__.py#L30) -## *const* **Libre** +## *const* [**QCRITranslate**](../../../../../translators/__init__.py#L32) -> [Source: ../../../../../translators/__init__.py @ line 26](../../../../../translators/__init__.py#L26) +## *const* [**PONSTranslate**](../../../../../translators/__init__.py#L33) -## *const* **MyMemory** +## *const* [**PapagoTranslate**](../../../../../translators/__init__.py#L34) -> [Source: ../../../../../translators/__init__.py @ line 27](../../../../../translators/__init__.py#L27) - -## *const* **TranslateCom** - -> [Source: ../../../../../translators/__init__.py @ line 28](../../../../../translators/__init__.py#L28) - -## *const* **Yandex** - -> [Source: ../../../../../translators/__init__.py @ line 29](../../../../../translators/__init__.py#L29) - -## *const* **Microsoft** - -> [Source: ../../../../../translators/__init__.py @ line 30](../../../../../translators/__init__.py#L30) - -## *const* **QCRITranslate** - -> [Source: ../../../../../translators/__init__.py @ line 32](../../../../../translators/__init__.py#L32) - -## *const* **PONSTranslate** - -> [Source: ../../../../../translators/__init__.py @ line 33](../../../../../translators/__init__.py#L33) - -## *const* **PapagoTranslate** - -> [Source: ../../../../../translators/__init__.py @ line 34](../../../../../translators/__init__.py#L34) - -## *const* **NaverTranslate** - -> [Source: ../../../../../translators/__init__.py @ line 35](../../../../../translators/__init__.py#L35) +## *const* [**NaverTranslate**](../../../../../translators/__init__.py#L35) diff --git a/translatepy/server/docs/fra/reference/translators/base.md b/translatepy/server/docs/fra/reference/translators/base.md index 34421d7..dd36a6b 100644 --- a/translatepy/server/docs/fra/reference/translators/base.md +++ b/translatepy/server/docs/fra/reference/translators/base.md @@ -1,25 +1,17 @@ # *module* **base** -> [Source: ../../../../../translators/base.py @ line 0](../../../../../translators/base.py#L0) +> [Source: ../../../../../translators/base.py](../../../../../translators/base.py#L0) translators/base.py Implements the Base Translator class -## *const* **C** +## *const* [**C**](../../../../../translators/base.py#L25) -> [Source: ../../../../../translators/base.py @ line 25](../../../../../translators/base.py#L25) +## *const* [**R**](../../../../../translators/base.py#L26) -## *const* **R** +## *const* [**HTMLType**](../../../../../translators/base.py#L27) -> [Source: ../../../../../translators/base.py @ line 26](../../../../../translators/base.py#L26) - -## *const* **HTMLType** - -> [Source: ../../../../../translators/base.py @ line 27](../../../../../translators/base.py#L27) - -## *class* **LazyIterable** - -> [Source: ../../../../../translators/base.py @ line 30-69](../../../../../translators/base.py#L30-L69) +## *class* [**LazyIterable**](../../../../../translators/base.py#L30-L69) An object which can be iterated through, even multiple times, but lazy loads the results. @@ -27,33 +19,21 @@ An object which can be iterated through, even multiple times, but lazy loads the - `IndexError` -## *const* **T** - -> [Source: ../../../../../translators/base.py @ line 73](../../../../../translators/base.py#L73) +## *const* [**T**](../../../../../translators/base.py#L73) -## *class* **BaseTranslateException** - -> [Source: ../../../../../translators/base.py @ line 79-105](../../../../../translators/base.py#L79-L105) +## *class* [**BaseTranslateException**](../../../../../translators/base.py#L79-L105) A translator exception, indicating a problem which occured during translation -### *attr* BaseTranslateException.**error_codes** - -> [Source: ../../../../../translators/base.py @ line 83](../../../../../translators/base.py#L83) - -## *class* **Flag** +### *attr* [BaseTranslateException.**error_codes**](../../../../../translators/base.py#L83) -> [Source: ../../../../../translators/base.py @ line 108-112](../../../../../translators/base.py#L108-L112) +## *class* [**Flag**](../../../../../translators/base.py#L108-L112) Defines a set of internal flags the handlers can send to the validator -### *attr* Flag.**MULTIPLE_RESULTS** - -> [Source: ../../../../../translators/base.py @ line 112](../../../../../translators/base.py#L112) - -## *class* **BaseTranslator** +### *attr* [Flag.**MULTIPLE_RESULTS**](../../../../../translators/base.py#L112) -> [Source: ../../../../../translators/base.py @ line 115-1293](../../../../../translators/base.py#L115-L1293) +## *class* [**BaseTranslator**](../../../../../translators/base.py#L115-L1293) The core of translatepy This defines a "Translator" instance, which is the gateway between the translator logic and translatepy @@ -68,9 +48,7 @@ This defines a "Translator" instance, which is the gateway between the translato - `exceptions.UnsupportedMethod` -### *func* BaseTranslator.**translate** - -> [Source: ../../../../../translators/base.py @ line 307-324](../../../../../translators/base.py#L307-L324) +### *func* [BaseTranslator.**translate**](../../../../../translators/base.py#L307-L324) Translates the given `text` into the given `dest_lang` @@ -102,9 +80,7 @@ Translates the given `text` into the given `dest_lang` - `models.TranslationResult` -### *func* BaseTranslator.**translate** - -> [Source: ../../../../../translators/base.py @ line 327-346](../../../../../translators/base.py#L327-L346) +### *func* [BaseTranslator.**translate**](../../../../../translators/base.py#L327-L346) Translates all of the elements in `text` into the given `dest_lang` @@ -139,9 +115,7 @@ Translates all of the elements in `text` into the given `dest_lang` > **Note** > aka "Bulk Translation" -### *func* BaseTranslator.**translate** - -> [Source: ../../../../../translators/base.py @ line 351-393](../../../../../translators/base.py#L351-L393) +### *func* [BaseTranslator.**translate**](../../../../../translators/base.py#L351-L393) Translates `text` into the given `dest_lang` @@ -172,9 +146,7 @@ Translates `text` into the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../../translators/base.py @ line 420-451](../../../../../translators/base.py#L420-L451) +### *func* [BaseTranslator.**translate_html**](../../../../../translators/base.py#L420-L451) Translates the given `html` into the given `dest_lang` @@ -222,9 +194,7 @@ If `False`, the node will be left as is and the `result` part will be `None` - `models.HTMLTranslationResult` -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../../translators/base.py @ line 454-486](../../../../../translators/base.py#L454-L486) +### *func* [BaseTranslator.**translate_html**](../../../../../translators/base.py#L454-L486) Translates all of the elements in `html` into the given `dest_lang` @@ -275,9 +245,7 @@ If `False`, the node will be left as is and the `result` part will be `None` > **Note** > aka "Bulk Translation" -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../../translators/base.py @ line 489-565](../../../../../translators/base.py#L489-L565) +### *func* [BaseTranslator.**translate_html**](../../../../../translators/base.py#L489-L565) Translates `html` into the given `dest_lang` @@ -324,9 +292,7 @@ Translates `html` into the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../../translators/base.py @ line 573-586](../../../../../translators/base.py#L573-L586) +### *func* [BaseTranslator.**alternatives**](../../../../../translators/base.py#L573-L586) Returns the different alternative translations available for a given previous translation. @@ -349,9 +315,7 @@ Returns the different alternative translations available for a given previous tr - `list[TranslationResult]` - The list of other translations a word might have -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../../translators/base.py @ line 589-602](../../../../../translators/base.py#L589-L602) +### *func* [BaseTranslator.**alternatives**](../../../../../translators/base.py#L589-L602) Returns the different alternative translations available for all of the given translations. @@ -374,9 +338,7 @@ Returns the different alternative translations available for all of the given tr - `LazyIterable[list[TranslationResult]]` - All of the other translations -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../../translators/base.py @ line 606-632](../../../../../translators/base.py#L606-L632) +### *func* [BaseTranslator.**alternatives**](../../../../../translators/base.py#L606-L632) Returns the different alternative translations available for the given `translation`. @@ -400,9 +362,7 @@ Returns the different alternative translations available for the given `translat > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../../translators/base.py @ line 664-681](../../../../../translators/base.py#L664-L681) +### *func* [BaseTranslator.**transliterate**](../../../../../translators/base.py#L664-L681) Transliterates the given `text` into the given `dest_lang` @@ -434,9 +394,7 @@ Transliterates the given `text` into the given `dest_lang` - `models.TransliterationResult` -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../../translators/base.py @ line 684-701](../../../../../translators/base.py#L684-L701) +### *func* [BaseTranslator.**transliterate**](../../../../../translators/base.py#L684-L701) Transliterates all of the given `text` to the given `dest_lang` @@ -468,9 +426,7 @@ Transliterates all of the given `text` to the given `dest_lang` - `LazyIterable[TransliterationResult]` - An iterable which contains the transliterations -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../../translators/base.py @ line 704-750](../../../../../translators/base.py#L704-L750) +### *func* [BaseTranslator.**transliterate**](../../../../../translators/base.py#L704-L750) Transliterates the given `text` to the given `dest_lang` @@ -501,13 +457,9 @@ Transliterates the given `text` to the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *attr* BaseTranslator.**transliteration** - -> [Source: ../../../../../translators/base.py @ line 753](../../../../../translators/base.py#L753) +### *attr* [BaseTranslator.**transliteration**](../../../../../translators/base.py#L753) -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../../translators/base.py @ line 781-798](../../../../../translators/base.py#L781-L798) +### *func* [BaseTranslator.**spellcheck**](../../../../../translators/base.py#L781-L798) Checks for spelling mistakes in the given `text` @@ -540,9 +492,7 @@ Checks for spelling mistakes in the given `text` - `SpellcheckResult` - The result of the spell check -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../../translators/base.py @ line 801-818](../../../../../translators/base.py#L801-L818) +### *func* [BaseTranslator.**spellcheck**](../../../../../translators/base.py#L801-L818) Checks for spelling mistakes in all of the given `text` @@ -573,9 +523,7 @@ Checks for spelling mistakes in all of the given `text` - `LazyIterable[SpellcheckResult]` - The results of the spell checks -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../../translators/base.py @ line 822-853](../../../../../translators/base.py#L822-L853) +### *func* [BaseTranslator.**spellcheck**](../../../../../translators/base.py#L822-L853) Checks for spelling mistakes in the given `text` @@ -605,9 +553,7 @@ Checks for spelling mistakes in the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**language** - -> [Source: ../../../../../translators/base.py @ line 881-894](../../../../../translators/base.py#L881-L894) +### *func* [BaseTranslator.**language**](../../../../../translators/base.py#L881-L894) Returns the detected language for the given `text` @@ -630,9 +576,7 @@ Returns the detected language for the given `text` - `models.LanguageResult` -### *func* BaseTranslator.**language** - -> [Source: ../../../../../translators/base.py @ line 897-910](../../../../../translators/base.py#L897-L910) +### *func* [BaseTranslator.**language**](../../../../../translators/base.py#L897-L910) Returns the detected language for all of the given `text` @@ -655,9 +599,7 @@ Returns the detected language for all of the given `text` - `LazyIterable[LanguageResult]` - The results of the language detections -### *func* BaseTranslator.**language** - -> [Source: ../../../../../translators/base.py @ line 914-936](../../../../../translators/base.py#L914-L936) +### *func* [BaseTranslator.**language**](../../../../../translators/base.py#L914-L936) Returns the detected language for the given `text` @@ -685,9 +627,7 @@ Returns the detected language for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**example** - -> [Source: ../../../../../translators/base.py @ line 960-975](../../../../../translators/base.py#L960-L975) +### *func* [BaseTranslator.**example**](../../../../../translators/base.py#L960-L975) Returns use cases for the given `text` @@ -715,9 +655,7 @@ Returns use cases for the given `text` - `list[ExampleResult]` - The examples -### *func* BaseTranslator.**example** - -> [Source: ../../../../../translators/base.py @ line 978-993](../../../../../translators/base.py#L978-L993) +### *func* [BaseTranslator.**example**](../../../../../translators/base.py#L978-L993) Returns use cases for all of the given `text` @@ -745,9 +683,7 @@ Returns use cases for all of the given `text` - `LazyIterable[list[ExampleResult]]` - All of the examples -### *func* BaseTranslator.**example** - -> [Source: ../../../../../translators/base.py @ line 997-1031](../../../../../translators/base.py#L997-L1031) +### *func* [BaseTranslator.**example**](../../../../../translators/base.py#L997-L1031) Returns use cases for the given `text` @@ -775,9 +711,7 @@ Returns use cases for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../../translators/base.py @ line 1060-1077](../../../../../translators/base.py#L1060-L1077) +### *func* [BaseTranslator.**dictionary**](../../../../../translators/base.py#L1060-L1077) Returns the meaning for the given `text` @@ -808,9 +742,7 @@ Returns the meaning for the given `text` - `list` -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../../translators/base.py @ line 1080-1097](../../../../../translators/base.py#L1080-L1097) +### *func* [BaseTranslator.**dictionary**](../../../../../translators/base.py#L1080-L1097) Returns the meaning for all of the given `text` @@ -841,9 +773,7 @@ Returns the meaning for all of the given `text` - `LazyIterable[RichDictionaryResult]` - If supported, a value which contains much more information on all of the `text` -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../../translators/base.py @ line 1101-1135](../../../../../translators/base.py#L1101-L1135) +### *func* [BaseTranslator.**dictionary**](../../../../../translators/base.py#L1101-L1135) Returns the meaning for the given `text` @@ -871,9 +801,7 @@ Returns the meaning for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../../translators/base.py @ line 1161-1180](../../../../../translators/base.py#L1161-L1180) +### *func* [BaseTranslator.**text_to_speech**](../../../../../translators/base.py#L1161-L1180) Returns the speech version of the given `text` @@ -900,9 +828,7 @@ Returns the speech version of the given `text` - `TextToSpeechResult` - The text to speech result -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../../translators/base.py @ line 1183-1202](../../../../../translators/base.py#L1183-L1202) +### *func* [BaseTranslator.**text_to_speech**](../../../../../translators/base.py#L1183-L1202) Returns the speech version for all of the given `text` @@ -929,18 +855,14 @@ Returns the speech version for all of the given `text` - `LazyIterable[TextToSpeechResult]` - The text to speech results -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../../translators/base.py @ line 1205-1241](../../../../../translators/base.py#L1205-L1241) +### *func* [BaseTranslator.**text_to_speech**](../../../../../translators/base.py#L1205-L1241) Returns the speech version of the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**clean_cache** - -> [Source: ../../../../../translators/base.py @ line 1265-1274](../../../../../translators/base.py#L1265-L1274) +### *func* [BaseTranslator.**clean_cache**](../../../../../translators/base.py#L1265-L1274) Cleans caches diff --git a/translatepy/server/docs/fra/reference/translators/base_aggregator.md b/translatepy/server/docs/fra/reference/translators/base_aggregator.md index 2149f83..487bc04 100644 --- a/translatepy/server/docs/fra/reference/translators/base_aggregator.md +++ b/translatepy/server/docs/fra/reference/translators/base_aggregator.md @@ -1,14 +1,12 @@ # *module* **base_aggregator** -> [Source: ../../../../../translators/base_aggregator.py @ line 0](../../../../../translators/base_aggregator.py#L0) +> [Source: ../../../../../translators/base_aggregator.py](../../../../../translators/base_aggregator.py#L0) ## Imports - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslator`, `C` -## *class* **BaseTranslatorAggregator** - -> [Source: ../../../../../translators/base_aggregator.py @ line 9-145](../../../../../translators/base_aggregator.py#L9-L145) +## *class* [**BaseTranslatorAggregator**](../../../../../translators/base_aggregator.py#L9-L145) ### Raises diff --git a/translatepy/server/docs/fra/reference/translators/bing.md b/translatepy/server/docs/fra/reference/translators/bing.md index b60f86d..1b12748 100644 --- a/translatepy/server/docs/fra/reference/translators/bing.md +++ b/translatepy/server/docs/fra/reference/translators/bing.md @@ -1,6 +1,6 @@ # *module* **Bing** -> [Source: ../../../../../translators/Bing.py @ line 0](../../../../../translators/Bing.py#L0) +> [Source: ../../../../../translators/Bing.py](../../../../../translators/Bing.py#L0) This implementation was made specifically for translatepy from 'Zhymabek Roman', based on 'Anime no Sekai' version. @@ -8,59 +8,39 @@ This implementation was made specifically for translatepy from 'Zhymabek Roman', - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator` -## *class* **BingTranslateException** +## *class* [**BingTranslateException**](../../../../../translators/Bing.py#L20-L23) -> [Source: ../../../../../translators/Bing.py @ line 20-23](../../../../../translators/Bing.py#L20-L23) +### *attr* [BingTranslateException.**error_codes**](../../../../../translators/Bing.py#L21) -### *attr* BingTranslateException.**error_codes** - -> [Source: ../../../../../translators/Bing.py @ line 21](../../../../../translators/Bing.py#L21) - -## *class* **BingSessionData** - -> [Source: ../../../../../translators/Bing.py @ line 26-33](../../../../../translators/Bing.py#L26-L33) +## *class* [**BingSessionData**](../../../../../translators/Bing.py#L26-L33) Bing session data holder -### *attr* BingSessionData.**ig** - -> [Source: ../../../../../translators/Bing.py @ line 28](../../../../../translators/Bing.py#L28) +### *attr* [BingSessionData.**ig**](../../../../../translators/Bing.py#L28) > Type: `str` -### *attr* BingSessionData.**iid** - -> [Source: ../../../../../translators/Bing.py @ line 29](../../../../../translators/Bing.py#L29) +### *attr* [BingSessionData.**iid**](../../../../../translators/Bing.py#L29) > Type: `str` -### *attr* BingSessionData.**key** - -> [Source: ../../../../../translators/Bing.py @ line 30](../../../../../translators/Bing.py#L30) +### *attr* [BingSessionData.**key**](../../../../../translators/Bing.py#L30) > Type: `cain.types.UInt64` -### *attr* BingSessionData.**token** - -> [Source: ../../../../../translators/Bing.py @ line 31](../../../../../translators/Bing.py#L31) +### *attr* [BingSessionData.**token**](../../../../../translators/Bing.py#L31) > Type: `str` -### *attr* BingSessionData.**cookies_keys** - -> [Source: ../../../../../translators/Bing.py @ line 32](../../../../../translators/Bing.py#L32) +### *attr* [BingSessionData.**cookies_keys**](../../../../../translators/Bing.py#L32) > Type: `List` -### *attr* BingSessionData.**cookies_values** - -> [Source: ../../../../../translators/Bing.py @ line 33](../../../../../translators/Bing.py#L33) +### *attr* [BingSessionData.**cookies_values**](../../../../../translators/Bing.py#L33) > Type: `List` -## *class* **BingSessionManager** - -> [Source: ../../../../../translators/Bing.py @ line 36-136](../../../../../translators/Bing.py#L36-L136) +## *class* [**BingSessionManager**](../../../../../translators/Bing.py#L36-L136) Creates and manages a Bing session @@ -68,9 +48,7 @@ Creates and manages a Bing session - `BingTranslateException` -### *func* BingSessionManager.**send** - -> [Source: ../../../../../translators/Bing.py @ line 92-136](../../../../../translators/Bing.py#L92-L136) +### *func* [BingSessionManager.**send**](../../../../../translators/Bing.py#L92-L136) Sends requestts to the API @@ -86,9 +64,7 @@ Sends requestts to the API - `BingTranslateException` -## *class* **BingTranslate** - -> [Source: ../../../../../translators/Bing.py @ line 145-251](../../../../../translators/Bing.py#L145-L251) +## *class* [**BingTranslate**](../../../../../translators/Bing.py#L145-L251) A Python implementation of Microsoft Bing Translation's APIs diff --git a/translatepy/server/docs/fra/reference/translators/deepl.md b/translatepy/server/docs/fra/reference/translators/deepl.md index 3deb1ca..34d9fa8 100644 --- a/translatepy/server/docs/fra/reference/translators/deepl.md +++ b/translatepy/server/docs/fra/reference/translators/deepl.md @@ -1,6 +1,6 @@ # *module* **DeepL** -> [Source: ../../../../../translators/DeepL.py @ line 0](../../../../../translators/DeepL.py#L0) +> [Source: ../../../../../translators/DeepL.py](../../../../../translators/DeepL.py#L0) DeepL Implementation for translatepy @@ -19,53 +19,33 @@ Refer to Animenosekai/translate#7 Arrangements, optimizations - **ZhymabekRoman** Co-Author -## *const* **SENTENCES_SPLITTING_REGEX** +## *const* [**SENTENCES_SPLITTING_REGEX**](../../../../../translators/DeepL.py#L31) -> [Source: ../../../../../translators/DeepL.py @ line 31](../../../../../translators/DeepL.py#L31) +## *class* [**DeeplFormality**](../../../../../translators/DeepL.py#L34-L36) -## *class* **DeeplFormality** +### *attr* [DeeplFormality.**formal**](../../../../../translators/DeepL.py#L35) -> [Source: ../../../../../translators/DeepL.py @ line 34-36](../../../../../translators/DeepL.py#L34-L36) +### *attr* [DeeplFormality.**informal**](../../../../../translators/DeepL.py#L36) -### *attr* DeeplFormality.**formal** +## *class* [**DeeplTranslate**](../../../../../translators/DeepL.py#L39-L41) -> [Source: ../../../../../translators/DeepL.py @ line 35](../../../../../translators/DeepL.py#L35) - -### *attr* DeeplFormality.**informal** - -> [Source: ../../../../../translators/DeepL.py @ line 36](../../../../../translators/DeepL.py#L36) - -## *class* **DeeplTranslate** - -> [Source: ../../../../../translators/DeepL.py @ line 39-41](../../../../../translators/DeepL.py#L39-L41) - -## *class* **DeeplTranslateException** - -> [Source: ../../../../../translators/DeepL.py @ line 44-51](../../../../../translators/DeepL.py#L44-L51) +## *class* [**DeeplTranslateException**](../../../../../translators/DeepL.py#L44-L51) Default DeepL Translate exception -### *attr* DeeplTranslateException.**error_codes** - -> [Source: ../../../../../translators/DeepL.py @ line 49](../../../../../translators/DeepL.py#L49) - -## *class* **GetClientState** +### *attr* [DeeplTranslateException.**error_codes**](../../../../../translators/DeepL.py#L49) -> [Source: ../../../../../translators/DeepL.py @ line 54-82](../../../../../translators/DeepL.py#L54-L82) +## *class* [**GetClientState**](../../../../../translators/DeepL.py#L54-L82) DeepL Translate state manager -### *func* GetClientState.**dump** - -> [Source: ../../../../../translators/DeepL.py @ line 63-74](../../../../../translators/DeepL.py#L63-L74) +### *func* [GetClientState.**dump**](../../../../../translators/DeepL.py#L63-L74) #### Returns - `dict` -### *func* GetClientState.**get** - -> [Source: ../../../../../translators/DeepL.py @ line 76-82](../../../../../translators/DeepL.py#L76-L82) +### *func* [GetClientState.**get**](../../../../../translators/DeepL.py#L76-L82) Returns a new Client State ID @@ -73,15 +53,11 @@ Returns a new Client State ID - `int` -## *class* **JSONRPCRequest** - -> [Source: ../../../../../translators/DeepL.py @ line 85-121](../../../../../translators/DeepL.py#L85-L121) +## *class* [**JSONRPCRequest**](../../../../../translators/DeepL.py#L85-L121) JSON RPC Request Sender for DeepL -### *func* JSONRPCRequest.**dump** - -> [Source: ../../../../../translators/DeepL.py @ line 99-107](../../../../../translators/DeepL.py#L99-L107) +### *func* [JSONRPCRequest.**dump**](../../../../../translators/DeepL.py#L99-L107) #### Parameters @@ -91,9 +67,7 @@ JSON RPC Request Sender for DeepL - **params**: `dict` -### *func* JSONRPCRequest.**send_jsonrpc** - -> [Source: ../../../../../translators/DeepL.py @ line 109-121](../../../../../translators/DeepL.py#L109-L121) +### *func* [JSONRPCRequest.**send_jsonrpc**](../../../../../translators/DeepL.py#L109-L121) #### Parameters @@ -107,17 +81,13 @@ JSON RPC Request Sender for DeepL - `dict` -## *class* **DeeplTranslateV1** - -> [Source: ../../../../../translators/DeepL.py @ line 124-308](../../../../../translators/DeepL.py#L124-L308) +## *class* [**DeeplTranslateV1**](../../../../../translators/DeepL.py#L124-L308) ### Raises - `exceptions.UnsupportedMethod` -## *class* **DeeplTranslateV2** - -> [Source: ../../../../../translators/DeepL.py @ line 311-386](../../../../../translators/DeepL.py#L311-L386) +## *class* [**DeeplTranslateV2**](../../../../../translators/DeepL.py#L311-L386) ### Raises diff --git a/translatepy/server/docs/fra/reference/translators/google.md b/translatepy/server/docs/fra/reference/translators/google.md index 7fa3f0e..957a5ce 100644 --- a/translatepy/server/docs/fra/reference/translators/google.md +++ b/translatepy/server/docs/fra/reference/translators/google.md @@ -1,6 +1,6 @@ # *module* **Google** -> [Source: ../../../../../translators/Google.py @ line 0](../../../../../translators/Google.py#L0) +> [Source: ../../../../../translators/Google.py](../../../../../translators/Google.py#L0) Google Translate This both uses the mobile version of Google Translate, extension endpoints and the `batchexecute` (JSONRPC) API @@ -12,17 +12,11 @@ The `batchexecute` implementation is heavily inspired by ssut/py-googletrans#255 - [../../../../../translators/base_aggregator.py](../../../../../translators/base_aggregator.py): As `BaseTranslatorAggregator` -## *const* **DOMAINS** +## *const* [**DOMAINS**](../../../../../translators/Google.py#L21) -> [Source: ../../../../../translators/Google.py @ line 21](../../../../../translators/Google.py#L21) +## *const* [**SUPPORTED_LANGUAGES**](../../../../../translators/Google.py#L58) -## *const* **SUPPORTED_LANGUAGES** - -> [Source: ../../../../../translators/Google.py @ line 58](../../../../../translators/Google.py#L58) - -## *class* **GoogleTranslate** - -> [Source: ../../../../../translators/Google.py @ line 66-81](../../../../../translators/Google.py#L66-L81) +## *class* [**GoogleTranslate**](../../../../../translators/Google.py#L66-L81) An aggregation of Google Translate translators @@ -30,9 +24,7 @@ An aggregation of Google Translate translators - `ServiceURLError` -## *class* **GoogleTranslateV1** - -> [Source: ../../../../../translators/Google.py @ line 84-261](../../../../../translators/Google.py#L84-L261) +## *class* [**GoogleTranslateV1**](../../../../../translators/Google.py#L84-L261) A Python implementation of Google Translate's JSONRPC API @@ -40,8 +32,6 @@ A Python implementation of Google Translate's JSONRPC API - `ValueError` -## *class* **GoogleTranslateV2** - -> [Source: ../../../../../translators/Google.py @ line 264-423](../../../../../translators/Google.py#L264-L423) +## *class* [**GoogleTranslateV2**](../../../../../translators/Google.py#L264-L423) A Python implementation of Google Translate's APIs diff --git a/translatepy/server/docs/fra/reference/translators/libre.md b/translatepy/server/docs/fra/reference/translators/libre.md index a70c7a3..531aa89 100644 --- a/translatepy/server/docs/fra/reference/translators/libre.md +++ b/translatepy/server/docs/fra/reference/translators/libre.md @@ -1,6 +1,6 @@ # *module* **Libre** -> [Source: ../../../../../translators/Libre.py @ line 0](../../../../../translators/Libre.py#L0) +> [Source: ../../../../../translators/Libre.py](../../../../../translators/Libre.py#L0) LibreTranslate translatepy's implementation of LibreTranslate @@ -13,8 +13,6 @@ translatepy's implementation of LibreTranslate - **Animenosekai** Original author -## *class* **LibreTranslate** - -> [Source: ../../../../../translators/Libre.py @ line 19-43](../../../../../translators/Libre.py#L19-L43) +## *class* [**LibreTranslate**](../../../../../translators/Libre.py#L19-L43) translatepy's implementation of LibreTranslate diff --git a/translatepy/server/docs/fra/reference/translators/microsoft.md b/translatepy/server/docs/fra/reference/translators/microsoft.md index 3035dbb..27b8369 100644 --- a/translatepy/server/docs/fra/reference/translators/microsoft.md +++ b/translatepy/server/docs/fra/reference/translators/microsoft.md @@ -1,6 +1,6 @@ # *module* **Microsoft** -> [Source: ../../../../../translators/Microsoft.py @ line 0](../../../../../translators/Microsoft.py#L0) +> [Source: ../../../../../translators/Microsoft.py](../../../../../translators/Microsoft.py#L0) This implementation was made specifically for translatepy by 'Zhymabek Roman'. @@ -10,27 +10,19 @@ This implementation was made specifically for translatepy by 'Zhymabek Roman'. - [../../../../../translators/base_aggregator.py](../../../../../translators/base_aggregator.py): As `BaseTranslatorAggregator` -## *class* **MicrosoftTranslate** - -> [Source: ../../../../../translators/Microsoft.py @ line 23-32](../../../../../translators/Microsoft.py#L23-L32) +## *class* [**MicrosoftTranslate**](../../../../../translators/Microsoft.py#L23-L32) An aggregation of Microsoft Translate translators -## *class* **MicrosoftTranslateV1** - -> [Source: ../../../../../translators/Microsoft.py @ line 37-141](../../../../../translators/Microsoft.py#L37-L141) +## *class* [**MicrosoftTranslateV1**](../../../../../translators/Microsoft.py#L37-L141) A Python implementation of Microsoft Translation, reverse engenered from Microsoft Translator Android application. Ported from https://github.com/d4n3436/GTranslate/blob/master/src/GTranslate/Translators/MicrosoftTranslator.cs Huge thanks to d4n3436. -## *class* **MicrosoftTranslateV2** - -> [Source: ../../../../../translators/Microsoft.py @ line 144-187](../../../../../translators/Microsoft.py#L144-L187) +## *class* [**MicrosoftTranslateV2**](../../../../../translators/Microsoft.py#L144-L187) A Python implementation of Microsoft Translation, reverse engenered from Microsoft SwiftKey by ZhymabekRoman Also I found '/v1/languages?scope=translation' endpoint, idk maybe it can be useful -## *class* **MicrosoftTranslateV3** - -> [Source: ../../../../../translators/Microsoft.py @ line 189-254](../../../../../translators/Microsoft.py#L189-L254) +## *class* [**MicrosoftTranslateV3**](../../../../../translators/Microsoft.py#L189-L254) diff --git a/translatepy/server/docs/fra/reference/translators/mymemory.md b/translatepy/server/docs/fra/reference/translators/mymemory.md index 30c6836..2f47615 100644 --- a/translatepy/server/docs/fra/reference/translators/mymemory.md +++ b/translatepy/server/docs/fra/reference/translators/mymemory.md @@ -1,6 +1,6 @@ # *module* **MyMemory** -> [Source: ../../../../../translators/MyMemory.py @ line 0](../../../../../translators/MyMemory.py#L0) +> [Source: ../../../../../translators/MyMemory.py](../../../../../translators/MyMemory.py#L0) MyMemory translatepy's implementation of MyMemory @@ -9,17 +9,11 @@ translatepy's implementation of MyMemory - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **MyMemoryException** +## *class* [**MyMemoryException**](../../../../../translators/MyMemory.py#L16-L19) -> [Source: ../../../../../translators/MyMemory.py @ line 16-19](../../../../../translators/MyMemory.py#L16-L19) +### *attr* [MyMemoryException.**error_codes**](../../../../../translators/MyMemory.py#L17) -### *attr* MyMemoryException.**error_codes** - -> [Source: ../../../../../translators/MyMemory.py @ line 17](../../../../../translators/MyMemory.py#L17) - -## *class* **MyMemoryTranslate** - -> [Source: ../../../../../translators/MyMemory.py @ line 22-81](../../../../../translators/MyMemory.py#L22-L81) +## *class* [**MyMemoryTranslate**](../../../../../translators/MyMemory.py#L22-L81) translatepy's implementation of MyMemory @@ -27,6 +21,4 @@ translatepy's implementation of MyMemory - `MyMemoryException` -### *attr* MyMemoryTranslate.**base_url** - -> [Source: ../../../../../translators/MyMemory.py @ line 26](../../../../../translators/MyMemory.py#L26) +### *attr* [MyMemoryTranslate.**base_url**](../../../../../translators/MyMemory.py#L26) diff --git a/translatepy/server/docs/fra/reference/translators/papago.md b/translatepy/server/docs/fra/reference/translators/papago.md index 1d37221..2101cb5 100644 --- a/translatepy/server/docs/fra/reference/translators/papago.md +++ b/translatepy/server/docs/fra/reference/translators/papago.md @@ -1,6 +1,6 @@ # *module* **Papago** -> [Source: ../../../../../translators/Papago.py @ line 0](../../../../../translators/Papago.py#L0) +> [Source: ../../../../../translators/Papago.py](../../../../../translators/Papago.py#L0) translatepy's implementation of @@ -8,45 +8,29 @@ translatepy's implementation of - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **PapagoException** +## *class* [**PapagoException**](../../../../../translators/Papago.py#L18-L21) -> [Source: ../../../../../translators/Papago.py @ line 18-21](../../../../../translators/Papago.py#L18-L21) +### *attr* [PapagoException.**error_codes**](../../../../../translators/Papago.py#L19) -### *attr* PapagoException.**error_codes** - -> [Source: ../../../../../translators/Papago.py @ line 19](../../../../../translators/Papago.py#L19) - -## *class* **PapagoSessionData** - -> [Source: ../../../../../translators/Papago.py @ line 27-31](../../../../../translators/Papago.py#L27-L31) +## *class* [**PapagoSessionData**](../../../../../translators/Papago.py#L27-L31) Bing session data holder -### *attr* PapagoSessionData.**timestamp** - -> [Source: ../../../../../translators/Papago.py @ line 29](../../../../../translators/Papago.py#L29) +### *attr* [PapagoSessionData.**timestamp**](../../../../../translators/Papago.py#L29) > Type: `cain.types.UInt64` -### *attr* PapagoSessionData.**cookies_keys** - -> [Source: ../../../../../translators/Papago.py @ line 30](../../../../../translators/Papago.py#L30) +### *attr* [PapagoSessionData.**cookies_keys**](../../../../../translators/Papago.py#L30) > Type: `List` -### *attr* PapagoSessionData.**cookies_values** - -> [Source: ../../../../../translators/Papago.py @ line 31](../../../../../translators/Papago.py#L31) +### *attr* [PapagoSessionData.**cookies_values**](../../../../../translators/Papago.py#L31) > Type: `List` -## *const* **SESSION_CACHE_EXPIRATION** - -> [Source: ../../../../../translators/Papago.py @ line 34](../../../../../translators/Papago.py#L34) +## *const* [**SESSION_CACHE_EXPIRATION**](../../../../../translators/Papago.py#L34) -## *class* **Papago** - -> [Source: ../../../../../translators/Papago.py @ line 37-262](../../../../../translators/Papago.py#L37-L262) +## *class* [**Papago**](../../../../../translators/Papago.py#L37-L262) translatepy's implementation of @@ -56,9 +40,7 @@ translatepy's implementation of - `exceptions.UnsupportedLanguage` -### *func* Papago.**generate_headers** - -> [Source: ../../../../../translators/Papago.py @ line 83-119](../../../../../translators/Papago.py#L83-L119) +### *func* [Papago.**generate_headers**](../../../../../translators/Papago.py#L83-L119) Generates the headers for the API diff --git a/translatepy/server/docs/fra/reference/translators/pons.md b/translatepy/server/docs/fra/reference/translators/pons.md index ac12a21..da0a9e9 100644 --- a/translatepy/server/docs/fra/reference/translators/pons.md +++ b/translatepy/server/docs/fra/reference/translators/pons.md @@ -1,6 +1,6 @@ # *module* **PONS** -> [Source: ../../../../../translators/PONS.py @ line 0](../../../../../translators/PONS.py#L0) +> [Source: ../../../../../translators/PONS.py](../../../../../translators/PONS.py#L0) translatepy's implementation of @@ -8,16 +8,10 @@ translatepy's implementation of - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **PONSException** +## *class* [**PONSException**](../../../../../translators/PONS.py#L15-L18) -> [Source: ../../../../../translators/PONS.py @ line 15-18](../../../../../translators/PONS.py#L15-L18) +### *attr* [PONSException.**error_codes**](../../../../../translators/PONS.py#L16) -### *attr* PONSException.**error_codes** - -> [Source: ../../../../../translators/PONS.py @ line 16](../../../../../translators/PONS.py#L16) - -## *class* **PONS** - -> [Source: ../../../../../translators/PONS.py @ line 24-111](../../../../../translators/PONS.py#L24-L111) +## *class* [**PONS**](../../../../../translators/PONS.py#L24-L111) translatepy's implementation of diff --git a/translatepy/server/docs/fra/reference/translators/qcri.md b/translatepy/server/docs/fra/reference/translators/qcri.md index 725633a..5abe0b2 100644 --- a/translatepy/server/docs/fra/reference/translators/qcri.md +++ b/translatepy/server/docs/fra/reference/translators/qcri.md @@ -1,6 +1,6 @@ # *module* **QCRI** -> [Source: ../../../../../translators/QCRI.py @ line 0](../../../../../translators/QCRI.py#L0) +> [Source: ../../../../../translators/QCRI.py](../../../../../translators/QCRI.py#L0) translatepy's implementation of @@ -8,17 +8,11 @@ translatepy's implementation of - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **QCRIException** +## *class* [**QCRIException**](../../../../../translators/QCRI.py#L16-L19) -> [Source: ../../../../../translators/QCRI.py @ line 16-19](../../../../../translators/QCRI.py#L16-L19) +### *attr* [QCRIException.**error_codes**](../../../../../translators/QCRI.py#L17) -### *attr* QCRIException.**error_codes** - -> [Source: ../../../../../translators/QCRI.py @ line 17](../../../../../translators/QCRI.py#L17) - -## *class* **QCRI** - -> [Source: ../../../../../translators/QCRI.py @ line 25-87](../../../../../translators/QCRI.py#L25-L87) +## *class* [**QCRI**](../../../../../translators/QCRI.py#L25-L87) translatepy's implementation of diff --git a/translatepy/server/docs/fra/reference/translators/reverso.md b/translatepy/server/docs/fra/reference/translators/reverso.md index 4b8fc87..a3b7cad 100644 --- a/translatepy/server/docs/fra/reference/translators/reverso.md +++ b/translatepy/server/docs/fra/reference/translators/reverso.md @@ -1,6 +1,6 @@ # *module* **Reverso** -> [Source: ../../../../../translators/Reverso.py @ line 0](../../../../../translators/Reverso.py#L0) +> [Source: ../../../../../translators/Reverso.py](../../../../../translators/Reverso.py#L0) Reverso translatepy's implementation of Reverso @@ -9,9 +9,7 @@ translatepy's implementation of Reverso - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslator`, `C` -## *class* **ReversoTranslate** - -> [Source: ../../../../../translators/Reverso.py @ line 16-182](../../../../../translators/Reverso.py#L16-L182) +## *class* [**ReversoTranslate**](../../../../../translators/Reverso.py#L16-L182) A Python implementation of Reverso's API diff --git a/translatepy/server/docs/fra/reference/translators/translatecom.md b/translatepy/server/docs/fra/reference/translators/translatecom.md index dc4c3fd..5cba45b 100644 --- a/translatepy/server/docs/fra/reference/translators/translatecom.md +++ b/translatepy/server/docs/fra/reference/translators/translatecom.md @@ -1,21 +1,15 @@ # *module* **TranslateCom** -> [Source: ../../../../../translators/TranslateCom.py @ line 0](../../../../../translators/TranslateCom.py#L0) +> [Source: ../../../../../translators/TranslateCom.py](../../../../../translators/TranslateCom.py#L0) ## Imports - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslator`, `C` -## *class* **TranslateComTranslate** - -> [Source: ../../../../../translators/TranslateCom.py @ line 9-44](../../../../../translators/TranslateCom.py#L9-L44) +## *class* [**TranslateComTranslate**](../../../../../translators/TranslateCom.py#L9-L44) translatepy's implementation of translate.com -### *attr* TranslateComTranslate.**translate_url** - -> [Source: ../../../../../translators/TranslateCom.py @ line 14](../../../../../translators/TranslateCom.py#L14) - -### *attr* TranslateComTranslate.**langdetect_url** +### *attr* [TranslateComTranslate.**translate_url**](../../../../../translators/TranslateCom.py#L14) -> [Source: ../../../../../translators/TranslateCom.py @ line 15](../../../../../translators/TranslateCom.py#L15) +### *attr* [TranslateComTranslate.**langdetect_url**](../../../../../translators/TranslateCom.py#L15) diff --git a/translatepy/server/docs/fra/reference/translators/yandex.md b/translatepy/server/docs/fra/reference/translators/yandex.md index e3a6c08..8aa08ef 100644 --- a/translatepy/server/docs/fra/reference/translators/yandex.md +++ b/translatepy/server/docs/fra/reference/translators/yandex.md @@ -1,6 +1,6 @@ # *module* **Yandex** -> [Source: ../../../../../translators/Yandex.py @ line 0](../../../../../translators/Yandex.py#L0) +> [Source: ../../../../../translators/Yandex.py](../../../../../translators/Yandex.py#L0) Yandex Translate This implementation was made specifically for translatepy from 'Zhymabek Roman', based on 'Anime no Sekai' version. @@ -9,19 +9,13 @@ This implementation was made specifically for translatepy from 'Zhymabek Roman', - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **YandexTranslateException** - -> [Source: ../../../../../translators/Yandex.py @ line 16-31](../../../../../translators/Yandex.py#L16-L31) +## *class* [**YandexTranslateException**](../../../../../translators/Yandex.py#L16-L31) Default Yandex Translate exception -### *attr* YandexTranslateException.**error_codes** - -> [Source: ../../../../../translators/Yandex.py @ line 21](../../../../../translators/Yandex.py#L21) - -## *class* **YandexTranslate** +### *attr* [YandexTranslateException.**error_codes**](../../../../../translators/Yandex.py#L21) -> [Source: ../../../../../translators/Yandex.py @ line 34-205](../../../../../translators/Yandex.py#L34-L205) +## *class* [**YandexTranslate**](../../../../../translators/Yandex.py#L34-L205) Yandex Translation Implementation diff --git a/translatepy/server/docs/fra/reference/utils/audio.md b/translatepy/server/docs/fra/reference/utils/audio.md index 8fe473d..803b7b8 100644 --- a/translatepy/server/docs/fra/reference/utils/audio.md +++ b/translatepy/server/docs/fra/reference/utils/audio.md @@ -1,6 +1,6 @@ # *module* **audio** -> [Source: ../../../../../utils/audio.py @ line 0](../../../../../utils/audio.py#L0) +> [Source: ../../../../../utils/audio.py](../../../../../utils/audio.py#L0) Handles audio file formats for translatepy @@ -9,27 +9,19 @@ Handles audio file formats for translatepy - **h2non, MIT License** Author of `filetype.py` a Python package to infer binary file types checking the magic numbers signature Most of the source code comes from this package -## *class* **Type** - -> [Source: ../../../../../utils/audio.py @ line 12-22](../../../../../utils/audio.py#L12-L22) +## *class* [**Type**](../../../../../utils/audio.py#L12-L22) Represents an audio format -### *attr* Type.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 16](../../../../../utils/audio.py#L16) +### *attr* [Type.**MIME**](../../../../../utils/audio.py#L16) > Type: `str` -### *attr* Type.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 17](../../../../../utils/audio.py#L17) +### *attr* [Type.**EXTENSION**](../../../../../utils/audio.py#L17) > Type: `str` -### *func* Type.**test** - -> [Source: ../../../../../utils/audio.py @ line 20-22](../../../../../utils/audio.py#L20-L22) +### *func* [Type.**test**](../../../../../utils/audio.py#L20-L22) Tests if the given file matches the audio format @@ -38,193 +30,127 @@ Tests if the given file matches the audio format - **data**: `bytes` -## *class* **MP3** - -> [Source: ../../../../../utils/audio.py @ line 25-42](../../../../../utils/audio.py#L25-L42) +## *class* [**MP3**](../../../../../utils/audio.py#L25-L42) Implements the MP3 audio type matcher. -### *attr* MP3.**MIME** +### *attr* [MP3.**MIME**](../../../../../utils/audio.py#L29) -> [Source: ../../../../../utils/audio.py @ line 29](../../../../../utils/audio.py#L29) +### *attr* [MP3.**EXTENSION**](../../../../../utils/audio.py#L30) -### *attr* MP3.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 30](../../../../../utils/audio.py#L30) - -### *func* MP3.**test** - -> [Source: ../../../../../utils/audio.py @ line 33-42](../../../../../utils/audio.py#L33-L42) +### *func* [MP3.**test**](../../../../../utils/audio.py#L33-L42) #### Parameters - **data**: `bytes` -## *class* **M4A** - -> [Source: ../../../../../utils/audio.py @ line 45-64](../../../../../utils/audio.py#L45-L64) +## *class* [**M4A**](../../../../../utils/audio.py#L45-L64) Implements the M4A audio type matcher. -### *attr* M4A.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 49](../../../../../utils/audio.py#L49) +### *attr* [M4A.**MIME**](../../../../../utils/audio.py#L49) -### *attr* M4A.**EXTENSION** +### *attr* [M4A.**EXTENSION**](../../../../../utils/audio.py#L50) -> [Source: ../../../../../utils/audio.py @ line 50](../../../../../utils/audio.py#L50) - -### *func* M4A.**test** - -> [Source: ../../../../../utils/audio.py @ line 53-64](../../../../../utils/audio.py#L53-L64) +### *func* [M4A.**test**](../../../../../utils/audio.py#L53-L64) #### Parameters - **data**: `bytes` -## *class* **Ogg** - -> [Source: ../../../../../utils/audio.py @ line 67-79](../../../../../utils/audio.py#L67-L79) +## *class* [**Ogg**](../../../../../utils/audio.py#L67-L79) Implements the OGG audio type matcher. -### *attr* Ogg.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 71](../../../../../utils/audio.py#L71) - -### *attr* Ogg.**EXTENSION** +### *attr* [Ogg.**MIME**](../../../../../utils/audio.py#L71) -> [Source: ../../../../../utils/audio.py @ line 72](../../../../../utils/audio.py#L72) +### *attr* [Ogg.**EXTENSION**](../../../../../utils/audio.py#L72) -### *func* Ogg.**test** - -> [Source: ../../../../../utils/audio.py @ line 75-79](../../../../../utils/audio.py#L75-L79) +### *func* [Ogg.**test**](../../../../../utils/audio.py#L75-L79) #### Parameters - **data**: `bytes` -## *class* **Flac** - -> [Source: ../../../../../utils/audio.py @ line 82-94](../../../../../utils/audio.py#L82-L94) +## *class* [**Flac**](../../../../../utils/audio.py#L82-L94) Implements the FLAC audio type matcher. -### *attr* Flac.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 86](../../../../../utils/audio.py#L86) - -### *attr* Flac.**EXTENSION** +### *attr* [Flac.**MIME**](../../../../../utils/audio.py#L86) -> [Source: ../../../../../utils/audio.py @ line 87](../../../../../utils/audio.py#L87) +### *attr* [Flac.**EXTENSION**](../../../../../utils/audio.py#L87) -### *func* Flac.**test** - -> [Source: ../../../../../utils/audio.py @ line 90-94](../../../../../utils/audio.py#L90-L94) +### *func* [Flac.**test**](../../../../../utils/audio.py#L90-L94) #### Parameters - **data**: `bytes` -## *class* **Wav** - -> [Source: ../../../../../utils/audio.py @ line 97-113](../../../../../utils/audio.py#L97-L113) +## *class* [**Wav**](../../../../../utils/audio.py#L97-L113) Implements the WAV audio type matcher. -### *attr* Wav.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 101](../../../../../utils/audio.py#L101) - -### *attr* Wav.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 102](../../../../../utils/audio.py#L102) +### *attr* [Wav.**MIME**](../../../../../utils/audio.py#L101) -### *func* Wav.**test** +### *attr* [Wav.**EXTENSION**](../../../../../utils/audio.py#L102) -> [Source: ../../../../../utils/audio.py @ line 105-113](../../../../../utils/audio.py#L105-L113) +### *func* [Wav.**test**](../../../../../utils/audio.py#L105-L113) #### Parameters - **data**: `bytes` -## *class* **Amr** - -> [Source: ../../../../../utils/audio.py @ line 116-130](../../../../../utils/audio.py#L116-L130) +## *class* [**Amr**](../../../../../utils/audio.py#L116-L130) Implements the AMR audio type matcher. -### *attr* Amr.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 120](../../../../../utils/audio.py#L120) - -### *attr* Amr.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 121](../../../../../utils/audio.py#L121) +### *attr* [Amr.**MIME**](../../../../../utils/audio.py#L120) -### *func* Amr.**test** +### *attr* [Amr.**EXTENSION**](../../../../../utils/audio.py#L121) -> [Source: ../../../../../utils/audio.py @ line 124-130](../../../../../utils/audio.py#L124-L130) +### *func* [Amr.**test**](../../../../../utils/audio.py#L124-L130) #### Parameters - **data**: `bytes` -## *class* **Aac** - -> [Source: ../../../../../utils/audio.py @ line 133-142](../../../../../utils/audio.py#L133-L142) +## *class* [**Aac**](../../../../../utils/audio.py#L133-L142) Implements the Aac audio type matcher. -### *attr* Aac.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 136](../../../../../utils/audio.py#L136) - -### *attr* Aac.**EXTENSION** +### *attr* [Aac.**MIME**](../../../../../utils/audio.py#L136) -> [Source: ../../../../../utils/audio.py @ line 137](../../../../../utils/audio.py#L137) +### *attr* [Aac.**EXTENSION**](../../../../../utils/audio.py#L137) -### *func* Aac.**test** - -> [Source: ../../../../../utils/audio.py @ line 140-142](../../../../../utils/audio.py#L140-L142) +### *func* [Aac.**test**](../../../../../utils/audio.py#L140-L142) #### Parameters - **data**: `bytes` -## *class* **Aiff** - -> [Source: ../../../../../utils/audio.py @ line 145-161](../../../../../utils/audio.py#L145-L161) +## *class* [**Aiff**](../../../../../utils/audio.py#L145-L161) Implements the AIFF audio type matcher. -### *attr* Aiff.**MIME** +### *attr* [Aiff.**MIME**](../../../../../utils/audio.py#L149) -> [Source: ../../../../../utils/audio.py @ line 149](../../../../../utils/audio.py#L149) +### *attr* [Aiff.**EXTENSION**](../../../../../utils/audio.py#L150) -### *attr* Aiff.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 150](../../../../../utils/audio.py#L150) - -### *func* Aiff.**test** - -> [Source: ../../../../../utils/audio.py @ line 153-161](../../../../../utils/audio.py#L153-L161) +### *func* [Aiff.**test**](../../../../../utils/audio.py#L153-L161) #### Parameters - **data**: `bytes` -## *func* **get_type** - -> [Source: ../../../../../utils/audio.py @ line 164-181](../../../../../utils/audio.py#L164-L181) +## *func* [**get_type**](../../../../../utils/audio.py#L164-L181) Returns the audio format of the given buffer diff --git a/translatepy/server/docs/fra/reference/utils/gtoken.md b/translatepy/server/docs/fra/reference/utils/gtoken.md index e0e318d..556e43f 100644 --- a/translatepy/server/docs/fra/reference/utils/gtoken.md +++ b/translatepy/server/docs/fra/reference/utils/gtoken.md @@ -1,6 +1,6 @@ # *module* **gtoken** -> [Source: ../../../../../utils/gtoken.py @ line 0](../../../../../utils/gtoken.py#L0) +> [Source: ../../../../../utils/gtoken.py](../../../../../utils/gtoken.py#L0) ORIGINAL FILENAME: gtoken.py @@ -33,13 +33,9 @@ LICENSE: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -## *const* **HEADERS** +## *const* [**HEADERS**](../../../../../utils/gtoken.py#L45) -> [Source: ../../../../../utils/gtoken.py @ line 45](../../../../../utils/gtoken.py#L45) - -## *class* **TokenAcquirer** - -> [Source: ../../../../../utils/gtoken.py @ line 56-244](../../../../../utils/gtoken.py#L56-L244) +## *class* [**TokenAcquirer**](../../../../../utils/gtoken.py#L56-L244) Google Translate API token generator translate.google.com uses a token to authorize the requests. If you are @@ -65,26 +61,18 @@ Example usage: - `Exception` -### *attr* TokenAcquirer.**RE_TKK** - -> [Source: ../../../../../utils/gtoken.py @ line 82](../../../../../utils/gtoken.py#L82) +### *attr* [TokenAcquirer.**RE_TKK**](../../../../../utils/gtoken.py#L82) -### *attr* TokenAcquirer.**RE_RAWTKK** +### *attr* [TokenAcquirer.**RE_RAWTKK**](../../../../../utils/gtoken.py#L83) -> [Source: ../../../../../utils/gtoken.py @ line 83](../../../../../utils/gtoken.py#L83) - -### *func* TokenAcquirer.**acquire** - -> [Source: ../../../../../utils/gtoken.py @ line 185-239](../../../../../utils/gtoken.py#L185-L239) +### *func* [TokenAcquirer.**acquire**](../../../../../utils/gtoken.py#L185-L239) #### Parameters - **text** -### *func* TokenAcquirer.**do** - -> [Source: ../../../../../utils/gtoken.py @ line 241-244](../../../../../utils/gtoken.py#L241-L244) +### *func* [TokenAcquirer.**do**](../../../../../utils/gtoken.py#L241-L244) #### Parameters diff --git a/translatepy/server/docs/fra/reference/utils/hasher.md b/translatepy/server/docs/fra/reference/utils/hasher.md index e171be6..1cee5fe 100644 --- a/translatepy/server/docs/fra/reference/utils/hasher.md +++ b/translatepy/server/docs/fra/reference/utils/hasher.md @@ -1,13 +1,11 @@ # *module* **hasher** -> [Source: ../../../../../utils/hasher.py @ line 0](../../../../../utils/hasher.py#L0) +> [Source: ../../../../../utils/hasher.py](../../../../../utils/hasher.py#L0) utils/hasher.py Utility to hash different kind of objects -## *func* **sha256** - -> [Source: ../../../../../utils/hasher.py @ line 11-28](../../../../../utils/hasher.py#L11-L28) +## *func* [**sha256**](../../../../../utils/hasher.py#L11-L28) Hashes the given content using SHA-256 and returns its hexadecimal version @@ -22,9 +20,7 @@ Hashes the given content using SHA-256 and returns its hexadecimal version - `str` - The SHA-256 hash -## *func* **hash_object** - -> [Source: ../../../../../utils/hasher.py @ line 31-48](../../../../../utils/hasher.py#L31-L48) +## *func* [**hash_object**](../../../../../utils/hasher.py#L31-L48) Hashes a given object @@ -38,9 +34,7 @@ Hashes a given object - `str` - The hash of the object -## *func* **hash_request** - -> [Source: ../../../../../utils/hasher.py @ line 51-82](../../../../../utils/hasher.py#L51-L82) +## *func* [**hash_request**](../../../../../utils/hasher.py#L51-L82) Hashes the given request. diff --git a/translatepy/server/docs/fra/reference/utils/importer.md b/translatepy/server/docs/fra/reference/utils/importer.md index 7db2bec..009cc5d 100644 --- a/translatepy/server/docs/fra/reference/utils/importer.md +++ b/translatepy/server/docs/fra/reference/utils/importer.md @@ -1,6 +1,6 @@ # *module* **importer** -> [Source: ../../../../../utils/importer.py @ line 0](../../../../../utils/importer.py#L0) +> [Source: ../../../../../utils/importer.py](../../../../../utils/importer.py#L0) importer.py A module to allow for dynamic importing of translators. @@ -11,25 +11,15 @@ A module to allow for dynamic importing of translators. - [../../../../../utils/vectorize.py](../../../../../utils/vectorize.py): As `vectorize` -## *const* **IMPORTER_CACHE** +## *const* [**IMPORTER_CACHE**](../../../../../utils/importer.py#L18) -> [Source: ../../../../../utils/importer.py @ line 18](../../../../../utils/importer.py#L18) +## *const* [**IMPORTER_DATA_DIR**](../../../../../utils/importer.py#L20) -## *const* **IMPORTER_DATA_DIR** +## *const* [**IMPORTER_DATA_FILE**](../../../../../utils/importer.py#L21) -> [Source: ../../../../../utils/importer.py @ line 20](../../../../../utils/importer.py#L20) +## *const* [**NAMED_TRANSLATORS**](../../../../../utils/importer.py#L27) -## *const* **IMPORTER_DATA_FILE** - -> [Source: ../../../../../utils/importer.py @ line 21](../../../../../utils/importer.py#L21) - -## *const* **NAMED_TRANSLATORS** - -> [Source: ../../../../../utils/importer.py @ line 27](../../../../../utils/importer.py#L27) - -## *func* **translator_from_name** - -> [Source: ../../../../../utils/importer.py @ line 37-42](../../../../../utils/importer.py#L37-L42) +## *func* [**translator_from_name**](../../../../../utils/importer.py#L37-L42) Retrieves the given translate from its name @@ -46,9 +36,7 @@ Retrieves the given translate from its name - `ValueError` -## *func* **translator_from_path** - -> [Source: ../../../../../utils/importer.py @ line 45-55](../../../../../utils/importer.py#L45-L55) +## *func* [**translator_from_path**](../../../../../utils/importer.py#L45-L55) Returns a translator from its dot path @@ -69,9 +57,7 @@ Returns a translator from its dot path - `ImportError` -## *func* **get_translator** - -> [Source: ../../../../../utils/importer.py @ line 58-94](../../../../../utils/importer.py#L58-L94) +## *func* [**get_translator**](../../../../../utils/importer.py#L58-L94) Searches the given translator diff --git a/translatepy/server/docs/fra/reference/utils/lru.md b/translatepy/server/docs/fra/reference/utils/lru.md index 237da12..f061169 100644 --- a/translatepy/server/docs/fra/reference/utils/lru.md +++ b/translatepy/server/docs/fra/reference/utils/lru.md @@ -1,31 +1,21 @@ # *module* **lru** -> [Source: ../../../../../utils/lru.py @ line 0](../../../../../utils/lru.py#L0) +> [Source: ../../../../../utils/lru.py](../../../../../utils/lru.py#L0) lru.py LRU cache implementation for the translatepy project. -## *const* **logger** +## *const* [**logger**](../../../../../utils/lru.py#L16) -> [Source: ../../../../../utils/lru.py @ line 16](../../../../../utils/lru.py#L16) +## *class* [**LRUDictCache**](../../../../../utils/lru.py#L19-L38) -## *class* **LRUDictCache** +### *func* [LRUDictCache.**clear**](../../../../../utils/lru.py#L37-L38) -> [Source: ../../../../../utils/lru.py @ line 19-38](../../../../../utils/lru.py#L19-L38) - -### *func* LRUDictCache.**clear** - -> [Source: ../../../../../utils/lru.py @ line 37-38](../../../../../utils/lru.py#L37-L38) - -## *class* **SizeLimitedLRUCache** - -> [Source: ../../../../../utils/lru.py @ line 41-173](../../../../../utils/lru.py#L41-L173) +## *class* [**SizeLimitedLRUCache**](../../../../../utils/lru.py#L41-L173) Special implementation of a size limited LRU cache. -### *func* SizeLimitedLRUCache.**get_size** - -> [Source: ../../../../../utils/lru.py @ line 135-170](../../../../../utils/lru.py#L135-L170) +### *func* [SizeLimitedLRUCache.**get_size**](../../../../../utils/lru.py#L135-L170) Get the size of an object. @@ -50,13 +40,9 @@ This function is faster than the custom implementation but might yield inaccurat > The second implementation of this function is based on the following article: https://towardsdatascience.com/the-strange-size-of-python-objects-in-memory-ce87bdfbb97f -### *func* SizeLimitedLRUCache.**clear** - -> [Source: ../../../../../utils/lru.py @ line 172-173](../../../../../utils/lru.py#L172-L173) - -## *func* **timed_lru_cache** +### *func* [SizeLimitedLRUCache.**clear**](../../../../../utils/lru.py#L172-L173) -> [Source: ../../../../../utils/lru.py @ line 176-198](../../../../../utils/lru.py#L176-L198) +## *func* [**timed_lru_cache**](../../../../../utils/lru.py#L176-L198) ### Parameters diff --git a/translatepy/server/docs/fra/reference/utils/queue.md b/translatepy/server/docs/fra/reference/utils/queue.md index 1ef378e..b42be00 100644 --- a/translatepy/server/docs/fra/reference/utils/queue.md +++ b/translatepy/server/docs/fra/reference/utils/queue.md @@ -1,18 +1,14 @@ # *module* **queue** -> [Source: ../../../../../utils/queue.py @ line 0](../../../../../utils/queue.py#L0) +> [Source: ../../../../../utils/queue.py](../../../../../utils/queue.py#L0) -## *class* **Queue** - -> [Source: ../../../../../utils/queue.py @ line 6-32](../../../../../utils/queue.py#L6-L32) +## *class* [**Queue**](../../../../../utils/queue.py#L6-L32) ### Raises - `ValueError` -### *func* Queue.**get** - -> [Source: ../../../../../utils/queue.py @ line 16-32](../../../../../utils/queue.py#L16-L32) +### *func* [Queue.**get**](../../../../../utils/queue.py#L16-L32) Remove and return an item from the queue. It waits for a value or the termination of all threads diff --git a/translatepy/server/docs/fra/reference/utils/request.md b/translatepy/server/docs/fra/reference/utils/request.md index cb5f713..21988c1 100644 --- a/translatepy/server/docs/fra/reference/utils/request.md +++ b/translatepy/server/docs/fra/reference/utils/request.md @@ -1,6 +1,6 @@ # *module* **request** -> [Source: ../../../../../utils/request.py @ line 0](../../../../../utils/request.py#L0) +> [Source: ../../../../../utils/request.py](../../../../../utils/request.py#L0) utils/request Extending python requests functionalities with translatepy's own implementation of proxies, caching, exceptions, etc. @@ -13,29 +13,19 @@ Extending python requests functionalities with translatepy's own implementation - **Animenosekai** Original author -## *const* **RequestHash** +## *const* [**RequestHash**](../../../../../utils/request.py#L24) -> [Source: ../../../../../utils/request.py @ line 24](../../../../../utils/request.py#L24) +## *const* [**RateLimitLock**](../../../../../utils/request.py#L27) -## *const* **RateLimitLock** +## *const* [**CacheLock**](../../../../../utils/request.py#L28) -> [Source: ../../../../../utils/request.py @ line 27](../../../../../utils/request.py#L27) - -## *const* **CacheLock** - -> [Source: ../../../../../utils/request.py @ line 28](../../../../../utils/request.py#L28) - -## *class* **Session** - -> [Source: ../../../../../utils/request.py @ line 32-225](../../../../../utils/request.py#L32-L225) +## *class* [**Session**](../../../../../utils/request.py#L32-L225) ### Raises - `exceptions.RateLimitPrevention` -### *func* Session.**set_http_proxy** - -> [Source: ../../../../../utils/request.py @ line 52-64](../../../../../utils/request.py#L52-L64) +### *func* [Session.**set_http_proxy**](../../../../../utils/request.py#L52-L64) Sets the HTTP proxy to use. @@ -45,9 +35,7 @@ Sets the HTTP proxy to use. - The HTTP proxy to use. -### *func* Session.**add_http_proxy** - -> [Source: ../../../../../utils/request.py @ line 66-75](../../../../../utils/request.py#L66-L75) +### *func* [Session.**add_http_proxy**](../../../../../utils/request.py#L66-L75) Adds a HTTP proxy to the list of proxies to use. @@ -57,9 +45,7 @@ Adds a HTTP proxy to the list of proxies to use. - The HTTP proxy to add. -### *func* Session.**request** - -> [Source: ../../../../../utils/request.py @ line 77-215](../../../../../utils/request.py#L77-L215) +### *func* [Session.**request**](../../../../../utils/request.py#L77-L215) Make an HTTP request with the provided method. @@ -203,9 +189,7 @@ If None, the default_cache_duration attribute will be used. ``` -### *func* Session.**invalidate** - -> [Source: ../../../../../utils/request.py @ line 217-225](../../../../../utils/request.py#L217-L225) +### *func* [Session.**invalidate**](../../../../../utils/request.py#L217-L225) Invalidates the given request cache. @@ -214,13 +198,9 @@ Invalidates the given request cache. - **hash**: `RequestHash`, `requesthash` -## *const* **SharedSession** - -> [Source: ../../../../../utils/request.py @ line 228](../../../../../utils/request.py#L228) +## *const* [**SharedSession**](../../../../../utils/request.py#L228) -## *func* **request** - -> [Source: ../../../../../utils/request.py @ line 231-268](../../../../../utils/request.py#L231-L268) +## *func* [**request**](../../../../../utils/request.py#L231-L268) Make an HTTP request. @@ -315,9 +295,7 @@ Make an HTTP request. > **Note** > Look at Session.request for more information. -## *func* **get** - -> [Source: ../../../../../utils/request.py @ line 271-300](../../../../../utils/request.py#L271-L300) +## *func* [**get**](../../../../../utils/request.py#L271-L300) Make a GET request. @@ -405,9 +383,7 @@ Make a GET request. > **Note** > Look at Session.request for more information. -## *func* **post** - -> [Source: ../../../../../utils/request.py @ line 303-332](../../../../../utils/request.py#L303-L332) +## *func* [**post**](../../../../../utils/request.py#L303-L332) Make a POST request. @@ -495,9 +471,7 @@ Make a POST request. > **Note** > Look at Session.request for more information. -## *func* **put** - -> [Source: ../../../../../utils/request.py @ line 335-364](../../../../../utils/request.py#L335-L364) +## *func* [**put**](../../../../../utils/request.py#L335-L364) Make a PUT request. @@ -585,9 +559,7 @@ Make a PUT request. > **Note** > Look at Session.request for more information. -## *func* **patch** - -> [Source: ../../../../../utils/request.py @ line 367-396](../../../../../utils/request.py#L367-L396) +## *func* [**patch**](../../../../../utils/request.py#L367-L396) Make a PATCH request. @@ -675,9 +647,7 @@ Make a PATCH request. > **Note** > Look at Session.request for more information. -## *func* **delete** - -> [Source: ../../../../../utils/request.py @ line 399-428](../../../../../utils/request.py#L399-L428) +## *func* [**delete**](../../../../../utils/request.py#L399-L428) Make a DELETE request. @@ -765,9 +735,7 @@ Make a DELETE request. > **Note** > Look at Session.request for more information. -## *func* **head** - -> [Source: ../../../../../utils/request.py @ line 431-460](../../../../../utils/request.py#L431-L460) +## *func* [**head**](../../../../../utils/request.py#L431-L460) Make a HEAD request. @@ -855,9 +823,7 @@ Make a HEAD request. > **Note** > Look at Session.request for more information. -## *func* **options** - -> [Source: ../../../../../utils/request.py @ line 463-492](../../../../../utils/request.py#L463-L492) +## *func* [**options**](../../../../../utils/request.py#L463-L492) Make an OPTIONS request. diff --git a/translatepy/server/docs/fra/reference/utils/sanitize.md b/translatepy/server/docs/fra/reference/utils/sanitize.md index c058776..19cb339 100644 --- a/translatepy/server/docs/fra/reference/utils/sanitize.md +++ b/translatepy/server/docs/fra/reference/utils/sanitize.md @@ -1,14 +1,10 @@ # *module* **sanitize** -> [Source: ../../../../../utils/sanitize.py @ line 0](../../../../../utils/sanitize.py#L0) +> [Source: ../../../../../utils/sanitize.py](../../../../../utils/sanitize.py#L0) -## *const* **WHITESPACES** +## *const* [**WHITESPACES**](../../../../../utils/sanitize.py#L3) -> [Source: ../../../../../utils/sanitize.py @ line 3](../../../../../utils/sanitize.py#L3) - -## *func* **remove_spaces** - -> [Source: ../../../../../utils/sanitize.py @ line 8-15](../../../../../utils/sanitize.py#L8-L15) +## *func* [**remove_spaces**](../../../../../utils/sanitize.py#L8-L15) Removes all whitespaces from the given string diff --git a/translatepy/server/docs/fra/reference/utils/utils.md b/translatepy/server/docs/fra/reference/utils/utils.md index 626ac8b..a3f841d 100644 --- a/translatepy/server/docs/fra/reference/utils/utils.md +++ b/translatepy/server/docs/fra/reference/utils/utils.md @@ -1,14 +1,10 @@ # *module* **utils** -> [Source: ../../../../../utils/utils.py @ line 0](../../../../../utils/utils.py#L0) +> [Source: ../../../../../utils/utils.py](../../../../../utils/utils.py#L0) -## *const* **POSITIVE_FLOAT_REGEX** +## *const* [**POSITIVE_FLOAT_REGEX**](../../../../../utils/utils.py#L3) -> [Source: ../../../../../utils/utils.py @ line 3](../../../../../utils/utils.py#L3) - -## *func* **convert_to_float** - -> [Source: ../../../../../utils/utils.py @ line 6-13](../../../../../utils/utils.py#L6-L13) +## *func* [**convert_to_float**](../../../../../utils/utils.py#L6-L13) Safely converts anything to a positive float diff --git a/translatepy/server/docs/fra/reference/utils/vectorize.md b/translatepy/server/docs/fra/reference/utils/vectorize.md index 9245e3a..eb82996 100644 --- a/translatepy/server/docs/fra/reference/utils/vectorize.md +++ b/translatepy/server/docs/fra/reference/utils/vectorize.md @@ -1,6 +1,6 @@ # *module* **vectorize** -> [Source: ../../../../../utils/vectorize.py @ line 0](../../../../../utils/vectorize.py#L0) +> [Source: ../../../../../utils/vectorize.py](../../../../../utils/vectorize.py#L0) Handles vectors @@ -8,13 +8,9 @@ Handles vectors - [../../../../../utils/sanitize.py](../../../../../utils/sanitize.py): As `sanitize` -## *const* **CLEANUP_REGEX** +## *const* [**CLEANUP_REGEX**](../../../../../utils/vectorize.py#L12) -> [Source: ../../../../../utils/vectorize.py @ line 12](../../../../../utils/vectorize.py#L12) - -## *func* **string_preprocessing** - -> [Source: ../../../../../utils/vectorize.py @ line 15-17](../../../../../utils/vectorize.py#L15-L17) +## *func* [**string_preprocessing**](../../../../../utils/vectorize.py#L15-L17) internal function to preprocess the given string for fuzzy search @@ -27,49 +23,33 @@ internal function to preprocess the given string for fuzzy search - `str` -## *class* **Vector** - -> [Source: ../../../../../utils/vectorize.py @ line 20-34](../../../../../utils/vectorize.py#L20-L34) +## *class* [**Vector**](../../../../../utils/vectorize.py#L20-L34) A string vector -### *attr* Vector.**id** - -> [Source: ../../../../../utils/vectorize.py @ line 22](../../../../../utils/vectorize.py#L22) +### *attr* [Vector.**id**](../../../../../utils/vectorize.py#L22) > Type: `str` -### *attr* Vector.**string** - -> [Source: ../../../../../utils/vectorize.py @ line 23](../../../../../utils/vectorize.py#L23) +### *attr* [Vector.**string**](../../../../../utils/vectorize.py#L23) > Type: `str` -### *attr* Vector.**value** - -> [Source: ../../../../../utils/vectorize.py @ line 24](../../../../../utils/vectorize.py#L24) +### *attr* [Vector.**value**](../../../../../utils/vectorize.py#L24) > Type: `float` -### *property* Vector.**counter** - -> [Source: ../../../../../utils/vectorize.py @ line 27-29](../../../../../utils/vectorize.py#L27-L29) +### *property* [Vector.**counter**](../../../../../utils/vectorize.py#L27-L29) Returns a counter for the vector -### *property* Vector.**set** - -> [Source: ../../../../../utils/vectorize.py @ line 32-34](../../../../../utils/vectorize.py#L32-L34) +### *property* [Vector.**set**](../../../../../utils/vectorize.py#L32-L34) Returns a set for the vector -## *const* **A** - -> [Source: ../../../../../utils/vectorize.py @ line 36](../../../../../utils/vectorize.py#L36) +## *const* [**A**](../../../../../utils/vectorize.py#L36) -## *func* **vectorize** - -> [Source: ../../../../../utils/vectorize.py @ line 38-45](../../../../../utils/vectorize.py#L38-L45) +## *func* [**vectorize**](../../../../../utils/vectorize.py#L38-L45) Vectorizes the given string @@ -81,31 +61,23 @@ Vectorizes the given string - **string**: `str` -## *class* **SearchResult** - -> [Source: ../../../../../utils/vectorize.py @ line 49-54](../../../../../utils/vectorize.py#L49-L54) +## *class* [**SearchResult**](../../../../../utils/vectorize.py#L49-L54) A result from the `search` function -### *attr* SearchResult.**vector** - -> [Source: ../../../../../utils/vectorize.py @ line 51](../../../../../utils/vectorize.py#L51) +### *attr* [SearchResult.**vector**](../../../../../utils/vectorize.py#L51) > Type: `Vector` The actual vector -### *attr* SearchResult.**similarity** - -> [Source: ../../../../../utils/vectorize.py @ line 53](../../../../../utils/vectorize.py#L53) +### *attr* [SearchResult.**similarity**](../../../../../utils/vectorize.py#L53) > Type: `float` The similarity with the search query -## *func* **search** - -> [Source: ../../../../../utils/vectorize.py @ line 57-70](../../../../../utils/vectorize.py#L57-L70) +## *func* [**search**](../../../../../utils/vectorize.py#L57-L70) Searches `query` through `data` diff --git a/translatepy/server/docs/fra/server/Postman/Language.postman_collection.utils.json b/translatepy/server/docs/fra/server/Postman/Language.postman_collection.utils.json index 29eda2e..9702a9a 100644 --- a/translatepy/server/docs/fra/server/Postman/Language.postman_collection.utils.json +++ b/translatepy/server/docs/fra/server/Postman/Language.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Language","description":"Tous les endpoints sous la section 'Language' de l'interface API de translatepy","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file +{"info":{"name":"Language","description":"Tous les endpoints sous la section 'Language' de l'interface API de translatepy","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file diff --git a/translatepy/server/docs/fra/server/Postman/Work.postman_collection.utils.json b/translatepy/server/docs/fra/server/Postman/Work.postman_collection.utils.json index 25503a5..d05e262 100644 --- a/translatepy/server/docs/fra/server/Postman/Work.postman_collection.utils.json +++ b/translatepy/server/docs/fra/server/Postman/Work.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Work","description":"Tous les endpoints sous la section 'Work' de l'interface API de translatepy","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `translation` | The translation result | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `translation` | The translation result | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n"}]},{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `transliteration` | The transliteration result | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `transliteration` | The transliteration result | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n"}]},{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `corrected` | The corrected text | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `corrected` | The corrected text | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n"}]},{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | Non |\n| `example` | The example | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `positions` | The positions of the word in the example | list[int] | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | Non |\n| `example` | The example | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `positions` | The positions of the word in the example | list[int] | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `meaning` | The meaning of the text | string | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `meaning` | The meaning of the text | string | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `extension` | Returns the audio file extension | Optional[str] | Non |\n| `result` | Text to speech result | bytes | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `gender` | Gender of the 'person' saying the text | Gender | Non |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | Non |\n| `speed` | Speed of the text to speech result | int | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | Non |\n| `extension` | Returns the audio file extension | Optional[str] | Non |\n| `result` | Text to speech result | bytes | Non |\n| `source` | The source text | string | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `gender` | Gender of the 'person' saying the text | Gender | Non |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | Non |\n| `speed` | Speed of the text to speech result | int | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file +{"info":{"name":"Work","description":"Tous les endpoints sous la section 'Work' de l'interface API de translatepy","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `translation` | The translation result | string | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `translation` | The translation result | string | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]},{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n"}]},{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `transliteration` | The transliteration result | string | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `transliteration` | The transliteration result | string | Non |\n| `dest_lang` | The result's language | Language | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]},{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `corrected` | The corrected text | string | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `corrected` | The corrected text | string | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n"}]},{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n"}]},{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `example` | The example | string | Non |\n| `positions` | The positions of the word in the example | list[int] | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | Non |\n| `source` | The source text | string | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `example` | The example | string | Non |\n| `positions` | The positions of the word in the example | list[int] | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n"}]},{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n| `meaning` | The meaning of the text | string | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | Non |\n| `source_lang` | The source text's language | Language | Non |\n| `source` | The source text | string | Non |\n| `meaning` | The meaning of the text | string | Non |\n| `rich` | Whether the given result features the full range of information | bool | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n"}]},{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `extension` | Returns the audio file extension | Optional[str] | Non |\n| `result` | Text to speech result | bytes | Non |\n| `source` | The source text | string | Non |\n| `speed` | Speed of the text to speech result | int | Non |\n| `gender` | Gender of the 'person' saying the text | Gender | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | Non |\n| `source_lang` | The source text's language | Language | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### Authentification\n\nIl n'est **pas** nécessaire d'être authentifié\n\n### Réponse\n\n#### Exemple de réponse\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `extension` | Returns the audio file extension | Optional[str] | Non |\n| `result` | Text to speech result | bytes | Non |\n| `source` | The source text | string | Non |\n| `speed` | Speed of the text to speech result | int | Non |\n| `gender` | Gender of the 'person' saying the text | Gender | Non |\n| `service` | The service which returned the result | Translator | Non |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | Non |\n| `source_lang` | The source text's language | Language | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[Retourner à l'Index](../Pour%20commencer.md#index)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file diff --git a/translatepy/server/docs/fra/server/Sections/Language.md b/translatepy/server/docs/fra/server/Sections/Language.md index 338a4b1..22a54f7 100644 --- a/translatepy/server/docs/fra/server/Sections/Language.md +++ b/translatepy/server/docs/fra/server/Sections/Language.md @@ -84,8 +84,8 @@ print(r.json()["data"]) | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | | `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | [Retourner à l'Index](../Pour%20commencer.md#index) # search @@ -185,6 +185,6 @@ print(r.json()["data"]) | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | | `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | [Retourner à l'Index](../Pour%20commencer.md#index) \ No newline at end of file diff --git a/translatepy/server/docs/fra/server/Sections/Work.md b/translatepy/server/docs/fra/server/Sections/Work.md index f515001..821080f 100644 --- a/translatepy/server/docs/fra/server/Sections/Work.md +++ b/translatepy/server/docs/fra/server/Sections/Work.md @@ -92,11 +92,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", "service": "no example", + "translation": "no example", "dest_lang": "no example", "source": "no example", - "translation": "no example" + "source_lang": "no example" } } @@ -106,20 +106,20 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | Non | | `service` | The service which returned the result | Translator | Non | +| `translation` | The translation result | string | Non | | `dest_lang` | The result's language | Language | Non | | `source` | The source text | string | Non | -| `translation` | The translation result | string | Non | +| `source_lang` | The source text's language | Language | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # translate_html @@ -211,9 +211,9 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "source": "no example", - "service": "no example" + "source": "no example" } } @@ -223,18 +223,18 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | Non | | `source_lang` | The source text's language | Language | Non | | `source` | The source text | string | Non | -| `service` | The service which returned the result | Translator | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # stream @@ -312,10 +312,10 @@ print(r.json()["data"]) | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # transliterate @@ -407,11 +407,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", + "service": "no example", + "transliteration": "no example", "dest_lang": "no example", "source": "no example", - "service": "no example", - "transliteration": "no example" + "source_lang": "no example" } } @@ -421,20 +421,20 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | Non | -| `dest_lang` | The result's language | Language | Non | -| `source` | The source text | string | Non | | `service` | The service which returned the result | Translator | Non | | `transliteration` | The transliteration result | string | Non | +| `dest_lang` | The result's language | Language | Non | +| `source` | The source text | string | Non | +| `source_lang` | The source text's language | Language | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # spellcheck @@ -526,11 +526,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", - "rich": true, - "source": "no example", "service": "no example", - "corrected": "no example" + "source": "no example", + "source_lang": "no example", + "corrected": "no example", + "rich": true } } @@ -540,20 +540,20 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | Non | -| `rich` | Whether the given result features the full range of information | bool | Non | -| `source` | The source text | string | Non | | `service` | The service which returned the result | Translator | Non | +| `source` | The source text | string | Non | +| `source_lang` | The source text's language | Language | Non | | `corrected` | The corrected text | string | Non | +| `rich` | Whether the given result features the full range of information | bool | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # language @@ -645,9 +645,9 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "source": "no example", - "service": "no example" + "source": "no example" } } @@ -657,18 +657,18 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | Non | | `source_lang` | The source text's language | Language | Non | | `source` | The source text | string | Non | -| `service` | The service which returned the result | Translator | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # example @@ -760,12 +760,12 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "reference": "no example", - "example": "no example", - "source_lang": "no example", - "positions": "no example", "source": "no example", - "service": "no example" + "source_lang": "no example", + "example": "no example", + "positions": "no example" } } @@ -775,21 +775,21 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | Non | | `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | Non | -| `example` | The example | string | Non | +| `source` | The source text | string | Non | | `source_lang` | The source text's language | Language | Non | +| `example` | The example | string | Non | | `positions` | The positions of the word in the example | list[int] | Non | -| `source` | The source text | string | Non | -| `service` | The service which returned the result | Translator | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # dictionary @@ -881,11 +881,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "meaning": "no example", - "rich": true, "source": "no example", - "service": "no example" + "meaning": "no example", + "rich": true } } @@ -895,20 +895,20 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | Non | | `source_lang` | The source text's language | Language | Non | +| `source` | The source text | string | Non | | `meaning` | The meaning of the text | string | Non | | `rich` | Whether the given result features the full range of information | bool | Non | -| `source` | The source text | string | Non | -| `service` | The service which returned the result | Translator | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) # tts @@ -1000,14 +1000,14 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", "extension": "no example", "result": "no example", "source": "no example", - "service": "no example", + "speed": 4, "gender": "no example", + "service": "no example", "mime_type": "no example", - "speed": 4 + "source_lang": "no example" } } @@ -1017,21 +1017,21 @@ print(r.json()["data"]) | Champ | Description | Type | Peut être `null` | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | Non | | `extension` | Returns the audio file extension | Optional[str] | Non | | `result` | Text to speech result | bytes | Non | | `source` | The source text | string | Non | -| `service` | The service which returned the result | Translator | Non | +| `speed` | Speed of the text to speech result | int | Non | | `gender` | Gender of the 'person' saying the text | Gender | Non | +| `service` | The service which returned the result | Translator | Non | | `mime_type` | Returns the MIME type of the audio file | Optional[str] | Non | -| `speed` | Speed of the text to speech result | int | Non | +| `source_lang` | The source text's language | Language | Non | #### Erreurs possibles | Erreur | Description | Code | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [Retourner à l'Index](../Pour%20commencer.md#index) \ No newline at end of file diff --git a/translatepy/server/docs/jpn/reference/__info__.md b/translatepy/server/docs/jpn/reference/__info__.md index e2b5ac9..1f91092 100644 --- a/translatepy/server/docs/jpn/reference/__info__.md +++ b/translatepy/server/docs/jpn/reference/__info__.md @@ -1,5 +1,5 @@ # *module* **__info__** -> [Source: ../../../../__info__.py @ line 0](../../../../__info__.py#L0) +> [Source: ../../../../__info__.py](../../../../__info__.py#L0) Stores information on the current module version diff --git a/translatepy/server/docs/jpn/reference/exceptions.md b/translatepy/server/docs/jpn/reference/exceptions.md index 0779dca..2f0769a 100644 --- a/translatepy/server/docs/jpn/reference/exceptions.md +++ b/translatepy/server/docs/jpn/reference/exceptions.md @@ -1,141 +1,73 @@ # *module* **exceptions** -> [Source: ../../../../exceptions.py @ line 0](../../../../exceptions.py#L0) +> [Source: ../../../../exceptions.py](../../../../exceptions.py#L0) A list of exceptions used throughout translatepy -## *class* **TranslatepyException** +## *class* [**TranslatepyException**](../../../../exceptions.py#L5-L9) -> [Source: ../../../../exceptions.py @ line 5-9](../../../../exceptions.py#L5-L9) +### *attr* [TranslatepyException.**LOG**](../../../../exceptions.py#L6) -### *attr* TranslatepyException.**LOG** +## *class* [**NoResult**](../../../../exceptions.py#L12-L18) -> [Source: ../../../../exceptions.py @ line 6](../../../../exceptions.py#L6) +### *attr* [NoResult.**STATUS_CODE**](../../../../exceptions.py#L13) -## *class* **NoResult** +### *attr* [NoResult.**MESSAGE**](../../../../exceptions.py#L14) -> [Source: ../../../../exceptions.py @ line 12-18](../../../../exceptions.py#L12-L18) +### *attr* [NoResult.**EXCEPTION_NAME**](../../../../exceptions.py#L15) -### *attr* NoResult.**STATUS_CODE** +## *class* [**ParameterTypeError**](../../../../exceptions.py#L21-L27) -> [Source: ../../../../exceptions.py @ line 13](../../../../exceptions.py#L13) +### *attr* [ParameterTypeError.**STATUS_CODE**](../../../../exceptions.py#L22) -### *attr* NoResult.**MESSAGE** +### *attr* [ParameterTypeError.**MESSAGE**](../../../../exceptions.py#L23) -> [Source: ../../../../exceptions.py @ line 14](../../../../exceptions.py#L14) +### *attr* [ParameterTypeError.**EXCEPTION_NAME**](../../../../exceptions.py#L24) -### *attr* NoResult.**EXCEPTION_NAME** +## *class* [**UnknownLanguage**](../../../../exceptions.py#L30-L38) -> [Source: ../../../../exceptions.py @ line 15](../../../../exceptions.py#L15) +### *attr* [UnknownLanguage.**STATUS_CODE**](../../../../exceptions.py#L31) -## *class* **ParameterTypeError** +### *attr* [UnknownLanguage.**MESSAGE**](../../../../exceptions.py#L32) -> [Source: ../../../../exceptions.py @ line 21-27](../../../../exceptions.py#L21-L27) +### *attr* [UnknownLanguage.**EXCEPTION_NAME**](../../../../exceptions.py#L33) -### *attr* ParameterTypeError.**STATUS_CODE** +## *class* [**UnknownTranslator**](../../../../exceptions.py#L41-L49) -> [Source: ../../../../exceptions.py @ line 22](../../../../exceptions.py#L22) +### *attr* [UnknownTranslator.**STATUS_CODE**](../../../../exceptions.py#L42) -### *attr* ParameterTypeError.**MESSAGE** +### *attr* [UnknownTranslator.**MESSAGE**](../../../../exceptions.py#L43) -> [Source: ../../../../exceptions.py @ line 23](../../../../exceptions.py#L23) +### *attr* [UnknownTranslator.**EXCEPTION_NAME**](../../../../exceptions.py#L44) -### *attr* ParameterTypeError.**EXCEPTION_NAME** +## *class* [**UnsupportedMethod**](../../../../exceptions.py#L52-L58) -> [Source: ../../../../exceptions.py @ line 24](../../../../exceptions.py#L24) +### *attr* [UnsupportedMethod.**STATUS_CODE**](../../../../exceptions.py#L53) -## *class* **UnknownLanguage** +### *attr* [UnsupportedMethod.**MESSAGE**](../../../../exceptions.py#L54) -> [Source: ../../../../exceptions.py @ line 30-38](../../../../exceptions.py#L30-L38) +### *attr* [UnsupportedMethod.**EXCEPTION_NAME**](../../../../exceptions.py#L55) -### *attr* UnknownLanguage.**STATUS_CODE** +## *class* [**UnsupportedLanguage**](../../../../exceptions.py#L61-L67) -> [Source: ../../../../exceptions.py @ line 31](../../../../exceptions.py#L31) +### *attr* [UnsupportedLanguage.**STATUS_CODE**](../../../../exceptions.py#L62) -### *attr* UnknownLanguage.**MESSAGE** +### *attr* [UnsupportedLanguage.**MESSAGE**](../../../../exceptions.py#L63) -> [Source: ../../../../exceptions.py @ line 32](../../../../exceptions.py#L32) +### *attr* [UnsupportedLanguage.**EXCEPTION_NAME**](../../../../exceptions.py#L64) -### *attr* UnknownLanguage.**EXCEPTION_NAME** +## *class* [**ServiceURLError**](../../../../exceptions.py#L70-L76) -> [Source: ../../../../exceptions.py @ line 33](../../../../exceptions.py#L33) +### *attr* [ServiceURLError.**STATUS_CODE**](../../../../exceptions.py#L71) -## *class* **UnknownTranslator** +### *attr* [ServiceURLError.**MESSAGE**](../../../../exceptions.py#L72) -> [Source: ../../../../exceptions.py @ line 41-49](../../../../exceptions.py#L41-L49) +### *attr* [ServiceURLError.**EXCEPTION_NAME**](../../../../exceptions.py#L73) -### *attr* UnknownTranslator.**STATUS_CODE** +## *class* [**RateLimitPrevention**](../../../../exceptions.py#L79-L82) -> [Source: ../../../../exceptions.py @ line 42](../../../../exceptions.py#L42) +### *attr* [RateLimitPrevention.**STATUS_CODE**](../../../../exceptions.py#L80) -### *attr* UnknownTranslator.**MESSAGE** +### *attr* [RateLimitPrevention.**MESSAGE**](../../../../exceptions.py#L81) -> [Source: ../../../../exceptions.py @ line 43](../../../../exceptions.py#L43) - -### *attr* UnknownTranslator.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 44](../../../../exceptions.py#L44) - -## *class* **UnsupportedMethod** - -> [Source: ../../../../exceptions.py @ line 52-58](../../../../exceptions.py#L52-L58) - -### *attr* UnsupportedMethod.**STATUS_CODE** - -> [Source: ../../../../exceptions.py @ line 53](../../../../exceptions.py#L53) - -### *attr* UnsupportedMethod.**MESSAGE** - -> [Source: ../../../../exceptions.py @ line 54](../../../../exceptions.py#L54) - -### *attr* UnsupportedMethod.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 55](../../../../exceptions.py#L55) - -## *class* **UnsupportedLanguage** - -> [Source: ../../../../exceptions.py @ line 61-67](../../../../exceptions.py#L61-L67) - -### *attr* UnsupportedLanguage.**STATUS_CODE** - -> [Source: ../../../../exceptions.py @ line 62](../../../../exceptions.py#L62) - -### *attr* UnsupportedLanguage.**MESSAGE** - -> [Source: ../../../../exceptions.py @ line 63](../../../../exceptions.py#L63) - -### *attr* UnsupportedLanguage.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 64](../../../../exceptions.py#L64) - -## *class* **ServiceURLError** - -> [Source: ../../../../exceptions.py @ line 70-76](../../../../exceptions.py#L70-L76) - -### *attr* ServiceURLError.**STATUS_CODE** - -> [Source: ../../../../exceptions.py @ line 71](../../../../exceptions.py#L71) - -### *attr* ServiceURLError.**MESSAGE** - -> [Source: ../../../../exceptions.py @ line 72](../../../../exceptions.py#L72) - -### *attr* ServiceURLError.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 73](../../../../exceptions.py#L73) - -## *class* **RateLimitPrevention** - -> [Source: ../../../../exceptions.py @ line 79-82](../../../../exceptions.py#L79-L82) - -### *attr* RateLimitPrevention.**STATUS_CODE** - -> [Source: ../../../../exceptions.py @ line 80](../../../../exceptions.py#L80) - -### *attr* RateLimitPrevention.**MESSAGE** - -> [Source: ../../../../exceptions.py @ line 81](../../../../exceptions.py#L81) - -### *attr* RateLimitPrevention.**EXCEPTION_NAME** - -> [Source: ../../../../exceptions.py @ line 82](../../../../exceptions.py#L82) +### *attr* [RateLimitPrevention.**EXCEPTION_NAME**](../../../../exceptions.py#L82) diff --git a/translatepy/server/docs/jpn/reference/language.md b/translatepy/server/docs/jpn/reference/language.md index 797bbef..52de28c 100644 --- a/translatepy/server/docs/jpn/reference/language.md +++ b/translatepy/server/docs/jpn/reference/language.md @@ -1,6 +1,6 @@ # *module* **language** -> [Source: ../../../../language.py @ line 0](../../../../language.py#L0) +> [Source: ../../../../language.py](../../../../language.py#L0) Handles the languages management on `translatepy` @@ -12,21 +12,15 @@ Handles the languages management on `translatepy` - [../../../../utils/vectorize.py](../../../../utils/vectorize.py): As `vectorize` -## *const* **Number** - -> [Source: ../../../../language.py @ line 17](../../../../language.py#L17) +## *const* [**Number**](../../../../language.py#L17) Represents a number -## *class* **LanguageExtra** - -> [Source: ../../../../language.py @ line 21-34](../../../../language.py#L21-L34) +## *class* [**LanguageExtra**](../../../../language.py#L21-L34) Extra data given on supported languages -### *attr* LanguageExtra.**scope** - -> [Source: ../../../../language.py @ line 23](../../../../language.py#L23) +### *attr* [LanguageExtra.**scope**](../../../../language.py#L23) > Type: `cain.types.Enum` @@ -35,9 +29,7 @@ Language scope > **Note** > Can be one of "individual", "macrolanguage", "special" -### *attr* LanguageExtra.**type** - -> [Source: ../../../../language.py @ line 28](../../../../language.py#L28) +### *attr* [LanguageExtra.**type**](../../../../language.py#L28) > Type: `cain.types.Enum` @@ -46,773 +38,577 @@ Language type > **Note** > Can be one of "ancient", "constructed", "extinct", "historical", "living", "special" -## *class* **Foreign** - -> [Source: ../../../../language.py @ line 37-208](../../../../language.py#L37-L208) +## *class* [**Foreign**](../../../../language.py#L37-L208) The language name in foreign languages -### *attr* Foreign.**afrikaans** - -> [Source: ../../../../language.py @ line 39](../../../../language.py#L39) +### *attr* [Foreign.**afrikaans**](../../../../language.py#L39) > Type: `str` The language name in afrikaans -### *attr* Foreign.**albanian** - -> [Source: ../../../../language.py @ line 41](../../../../language.py#L41) +### *attr* [Foreign.**albanian**](../../../../language.py#L41) > Type: `str` The language name in albanian -### *attr* Foreign.**amharic** - -> [Source: ../../../../language.py @ line 43](../../../../language.py#L43) +### *attr* [Foreign.**amharic**](../../../../language.py#L43) > Type: `str` The language name in amharic -### *attr* Foreign.**arabic** - -> [Source: ../../../../language.py @ line 45](../../../../language.py#L45) +### *attr* [Foreign.**arabic**](../../../../language.py#L45) > Type: `str` The language name in arabic -### *attr* Foreign.**armenian** - -> [Source: ../../../../language.py @ line 47](../../../../language.py#L47) +### *attr* [Foreign.**armenian**](../../../../language.py#L47) > Type: `str` The language name in armenian -### *attr* Foreign.**azerbaijani** - -> [Source: ../../../../language.py @ line 49](../../../../language.py#L49) +### *attr* [Foreign.**azerbaijani**](../../../../language.py#L49) > Type: `str` The language name in azerbaijani -### *attr* Foreign.**basque** - -> [Source: ../../../../language.py @ line 51](../../../../language.py#L51) +### *attr* [Foreign.**basque**](../../../../language.py#L51) > Type: `str` The language name in basque -### *attr* Foreign.**belarusian** - -> [Source: ../../../../language.py @ line 53](../../../../language.py#L53) +### *attr* [Foreign.**belarusian**](../../../../language.py#L53) > Type: `str` The language name in belarusian -### *attr* Foreign.**bengali** - -> [Source: ../../../../language.py @ line 55](../../../../language.py#L55) +### *attr* [Foreign.**bengali**](../../../../language.py#L55) > Type: `str` The language name in bengali -### *attr* Foreign.**bosnian** - -> [Source: ../../../../language.py @ line 57](../../../../language.py#L57) +### *attr* [Foreign.**bosnian**](../../../../language.py#L57) > Type: `str` The language name in bosnian -### *attr* Foreign.**bulgarian** - -> [Source: ../../../../language.py @ line 59](../../../../language.py#L59) +### *attr* [Foreign.**bulgarian**](../../../../language.py#L59) > Type: `str` The language name in bulgarian -### *attr* Foreign.**burmese** - -> [Source: ../../../../language.py @ line 61](../../../../language.py#L61) +### *attr* [Foreign.**burmese**](../../../../language.py#L61) > Type: `str` The language name in burmese -### *attr* Foreign.**catalan** - -> [Source: ../../../../language.py @ line 63](../../../../language.py#L63) +### *attr* [Foreign.**catalan**](../../../../language.py#L63) > Type: `str` The language name in catalan -### *attr* Foreign.**chinese** - -> [Source: ../../../../language.py @ line 65](../../../../language.py#L65) +### *attr* [Foreign.**chinese**](../../../../language.py#L65) > Type: `str` The language name in chinese -### *attr* Foreign.**croatian** - -> [Source: ../../../../language.py @ line 67](../../../../language.py#L67) +### *attr* [Foreign.**croatian**](../../../../language.py#L67) > Type: `str` The language name in croatian -### *attr* Foreign.**czech** - -> [Source: ../../../../language.py @ line 69](../../../../language.py#L69) +### *attr* [Foreign.**czech**](../../../../language.py#L69) > Type: `str` The language name in czech -### *attr* Foreign.**danish** - -> [Source: ../../../../language.py @ line 71](../../../../language.py#L71) +### *attr* [Foreign.**danish**](../../../../language.py#L71) > Type: `str` The language name in danish -### *attr* Foreign.**dutch** - -> [Source: ../../../../language.py @ line 73](../../../../language.py#L73) +### *attr* [Foreign.**dutch**](../../../../language.py#L73) > Type: `str` The language name in dutch -### *attr* Foreign.**esperanto** - -> [Source: ../../../../language.py @ line 75](../../../../language.py#L75) +### *attr* [Foreign.**esperanto**](../../../../language.py#L75) > Type: `str` The language name in esperanto -### *attr* Foreign.**estonian** - -> [Source: ../../../../language.py @ line 77](../../../../language.py#L77) +### *attr* [Foreign.**estonian**](../../../../language.py#L77) > Type: `str` The language name in estonian -### *attr* Foreign.**finnish** - -> [Source: ../../../../language.py @ line 79](../../../../language.py#L79) +### *attr* [Foreign.**finnish**](../../../../language.py#L79) > Type: `str` The language name in finnish -### *attr* Foreign.**french** - -> [Source: ../../../../language.py @ line 81](../../../../language.py#L81) +### *attr* [Foreign.**french**](../../../../language.py#L81) > Type: `str` The language name in french -### *attr* Foreign.**galician** - -> [Source: ../../../../language.py @ line 83](../../../../language.py#L83) +### *attr* [Foreign.**galician**](../../../../language.py#L83) > Type: `str` The language name in galician -### *attr* Foreign.**georgian** - -> [Source: ../../../../language.py @ line 85](../../../../language.py#L85) +### *attr* [Foreign.**georgian**](../../../../language.py#L85) > Type: `str` The language name in georgian -### *attr* Foreign.**german** - -> [Source: ../../../../language.py @ line 87](../../../../language.py#L87) +### *attr* [Foreign.**german**](../../../../language.py#L87) > Type: `str` The language name in german -### *attr* Foreign.**gujarati** - -> [Source: ../../../../language.py @ line 89](../../../../language.py#L89) +### *attr* [Foreign.**gujarati**](../../../../language.py#L89) > Type: `str` The language name in gujarati -### *attr* Foreign.**haitian** - -> [Source: ../../../../language.py @ line 91](../../../../language.py#L91) +### *attr* [Foreign.**haitian**](../../../../language.py#L91) > Type: `str` The language name in haitian -### *attr* Foreign.**hebrew** - -> [Source: ../../../../language.py @ line 93](../../../../language.py#L93) +### *attr* [Foreign.**hebrew**](../../../../language.py#L93) > Type: `str` The language name in hebrew -### *attr* Foreign.**hindi** - -> [Source: ../../../../language.py @ line 95](../../../../language.py#L95) +### *attr* [Foreign.**hindi**](../../../../language.py#L95) > Type: `str` The language name in hindi -### *attr* Foreign.**hungarian** - -> [Source: ../../../../language.py @ line 97](../../../../language.py#L97) +### *attr* [Foreign.**hungarian**](../../../../language.py#L97) > Type: `str` The language name in hungarian -### *attr* Foreign.**icelandic** - -> [Source: ../../../../language.py @ line 99](../../../../language.py#L99) +### *attr* [Foreign.**icelandic**](../../../../language.py#L99) > Type: `str` The language name in icelandic -### *attr* Foreign.**indonesian** - -> [Source: ../../../../language.py @ line 101](../../../../language.py#L101) +### *attr* [Foreign.**indonesian**](../../../../language.py#L101) > Type: `str` The language name in indonesian -### *attr* Foreign.**irish** - -> [Source: ../../../../language.py @ line 103](../../../../language.py#L103) +### *attr* [Foreign.**irish**](../../../../language.py#L103) > Type: `str` The language name in irish -### *attr* Foreign.**italian** - -> [Source: ../../../../language.py @ line 105](../../../../language.py#L105) +### *attr* [Foreign.**italian**](../../../../language.py#L105) > Type: `str` The language name in italian -### *attr* Foreign.**japanese** - -> [Source: ../../../../language.py @ line 107](../../../../language.py#L107) +### *attr* [Foreign.**japanese**](../../../../language.py#L107) > Type: `str` The language name in japanese -### *attr* Foreign.**javanese** - -> [Source: ../../../../language.py @ line 109](../../../../language.py#L109) +### *attr* [Foreign.**javanese**](../../../../language.py#L109) > Type: `str` The language name in javanese -### *attr* Foreign.**kannada** - -> [Source: ../../../../language.py @ line 111](../../../../language.py#L111) +### *attr* [Foreign.**kannada**](../../../../language.py#L111) > Type: `str` The language name in kannada -### *attr* Foreign.**kazakh** - -> [Source: ../../../../language.py @ line 113](../../../../language.py#L113) +### *attr* [Foreign.**kazakh**](../../../../language.py#L113) > Type: `str` The language name in kazakh -### *attr* Foreign.**khmer** - -> [Source: ../../../../language.py @ line 115](../../../../language.py#L115) +### *attr* [Foreign.**khmer**](../../../../language.py#L115) > Type: `str` The language name in khmer -### *attr* Foreign.**kirghiz** - -> [Source: ../../../../language.py @ line 117](../../../../language.py#L117) +### *attr* [Foreign.**kirghiz**](../../../../language.py#L117) > Type: `str` The language name in kirghiz -### *attr* Foreign.**korean** - -> [Source: ../../../../language.py @ line 119](../../../../language.py#L119) +### *attr* [Foreign.**korean**](../../../../language.py#L119) > Type: `str` The language name in korean -### *attr* Foreign.**lao** - -> [Source: ../../../../language.py @ line 121](../../../../language.py#L121) +### *attr* [Foreign.**lao**](../../../../language.py#L121) > Type: `str` The language name in lao -### *attr* Foreign.**latin** - -> [Source: ../../../../language.py @ line 123](../../../../language.py#L123) +### *attr* [Foreign.**latin**](../../../../language.py#L123) > Type: `str` The language name in latin -### *attr* Foreign.**latvian** - -> [Source: ../../../../language.py @ line 125](../../../../language.py#L125) +### *attr* [Foreign.**latvian**](../../../../language.py#L125) > Type: `str` The language name in latvian -### *attr* Foreign.**lithuanian** - -> [Source: ../../../../language.py @ line 127](../../../../language.py#L127) +### *attr* [Foreign.**lithuanian**](../../../../language.py#L127) > Type: `str` The language name in lithuanian -### *attr* Foreign.**luxembourgish** - -> [Source: ../../../../language.py @ line 129](../../../../language.py#L129) +### *attr* [Foreign.**luxembourgish**](../../../../language.py#L129) > Type: `str` The language name in luxembourgish -### *attr* Foreign.**macedonian** - -> [Source: ../../../../language.py @ line 131](../../../../language.py#L131) +### *attr* [Foreign.**macedonian**](../../../../language.py#L131) > Type: `str` The language name in macedonian -### *attr* Foreign.**malagasy** - -> [Source: ../../../../language.py @ line 133](../../../../language.py#L133) +### *attr* [Foreign.**malagasy**](../../../../language.py#L133) > Type: `str` The language name in malagasy -### *attr* Foreign.**malay** - -> [Source: ../../../../language.py @ line 135](../../../../language.py#L135) +### *attr* [Foreign.**malay**](../../../../language.py#L135) > Type: `str` The language name in malay -### *attr* Foreign.**maltese** - -> [Source: ../../../../language.py @ line 137](../../../../language.py#L137) +### *attr* [Foreign.**maltese**](../../../../language.py#L137) > Type: `str` The language name in maltese -### *attr* Foreign.**maori** - -> [Source: ../../../../language.py @ line 139](../../../../language.py#L139) +### *attr* [Foreign.**maori**](../../../../language.py#L139) > Type: `str` The language name in maori -### *attr* Foreign.**marathi** - -> [Source: ../../../../language.py @ line 141](../../../../language.py#L141) +### *attr* [Foreign.**marathi**](../../../../language.py#L141) > Type: `str` The language name in marathi -### *attr* Foreign.**moderngreek** - -> [Source: ../../../../language.py @ line 143](../../../../language.py#L143) +### *attr* [Foreign.**moderngreek**](../../../../language.py#L143) > Type: `str` The language name in moderngreek -### *attr* Foreign.**mongolian** - -> [Source: ../../../../language.py @ line 145](../../../../language.py#L145) +### *attr* [Foreign.**mongolian**](../../../../language.py#L145) > Type: `str` The language name in mongolian -### *attr* Foreign.**nepali** - -> [Source: ../../../../language.py @ line 147](../../../../language.py#L147) +### *attr* [Foreign.**nepali**](../../../../language.py#L147) > Type: `str` The language name in nepali -### *attr* Foreign.**norwegian** - -> [Source: ../../../../language.py @ line 149](../../../../language.py#L149) +### *attr* [Foreign.**norwegian**](../../../../language.py#L149) > Type: `str` The language name in norwegian -### *attr* Foreign.**panjabi** - -> [Source: ../../../../language.py @ line 151](../../../../language.py#L151) +### *attr* [Foreign.**panjabi**](../../../../language.py#L151) > Type: `str` The language name in panjabi -### *attr* Foreign.**persian** - -> [Source: ../../../../language.py @ line 153](../../../../language.py#L153) +### *attr* [Foreign.**persian**](../../../../language.py#L153) > Type: `str` The language name in persian -### *attr* Foreign.**polish** - -> [Source: ../../../../language.py @ line 155](../../../../language.py#L155) +### *attr* [Foreign.**polish**](../../../../language.py#L155) > Type: `str` The language name in polish -### *attr* Foreign.**portuguese** - -> [Source: ../../../../language.py @ line 157](../../../../language.py#L157) +### *attr* [Foreign.**portuguese**](../../../../language.py#L157) > Type: `str` The language name in portuguese -### *attr* Foreign.**romanian** - -> [Source: ../../../../language.py @ line 159](../../../../language.py#L159) +### *attr* [Foreign.**romanian**](../../../../language.py#L159) > Type: `str` The language name in romanian -### *attr* Foreign.**russian** - -> [Source: ../../../../language.py @ line 161](../../../../language.py#L161) +### *attr* [Foreign.**russian**](../../../../language.py#L161) > Type: `str` The language name in russian -### *attr* Foreign.**scottishgaelic** - -> [Source: ../../../../language.py @ line 163](../../../../language.py#L163) +### *attr* [Foreign.**scottishgaelic**](../../../../language.py#L163) > Type: `str` The language name in scottishgaelic -### *attr* Foreign.**serbian** - -> [Source: ../../../../language.py @ line 165](../../../../language.py#L165) +### *attr* [Foreign.**serbian**](../../../../language.py#L165) > Type: `str` The language name in serbian -### *attr* Foreign.**sinhala** - -> [Source: ../../../../language.py @ line 167](../../../../language.py#L167) +### *attr* [Foreign.**sinhala**](../../../../language.py#L167) > Type: `str` The language name in sinhala -### *attr* Foreign.**slovak** - -> [Source: ../../../../language.py @ line 169](../../../../language.py#L169) +### *attr* [Foreign.**slovak**](../../../../language.py#L169) > Type: `str` The language name in slovak -### *attr* Foreign.**slovenian** - -> [Source: ../../../../language.py @ line 171](../../../../language.py#L171) +### *attr* [Foreign.**slovenian**](../../../../language.py#L171) > Type: `str` The language name in slovenian -### *attr* Foreign.**spanish** - -> [Source: ../../../../language.py @ line 173](../../../../language.py#L173) +### *attr* [Foreign.**spanish**](../../../../language.py#L173) > Type: `str` The language name in spanish -### *attr* Foreign.**sundanese** - -> [Source: ../../../../language.py @ line 175](../../../../language.py#L175) +### *attr* [Foreign.**sundanese**](../../../../language.py#L175) > Type: `str` The language name in sundanese -### *attr* Foreign.**swahili** - -> [Source: ../../../../language.py @ line 177](../../../../language.py#L177) +### *attr* [Foreign.**swahili**](../../../../language.py#L177) > Type: `str` The language name in swahili -### *attr* Foreign.**swedish** - -> [Source: ../../../../language.py @ line 179](../../../../language.py#L179) +### *attr* [Foreign.**swedish**](../../../../language.py#L179) > Type: `str` The language name in swedish -### *attr* Foreign.**tagalog** - -> [Source: ../../../../language.py @ line 181](../../../../language.py#L181) +### *attr* [Foreign.**tagalog**](../../../../language.py#L181) > Type: `str` The language name in tagalog -### *attr* Foreign.**tajik** - -> [Source: ../../../../language.py @ line 183](../../../../language.py#L183) +### *attr* [Foreign.**tajik**](../../../../language.py#L183) > Type: `str` The language name in tajik -### *attr* Foreign.**tamil** - -> [Source: ../../../../language.py @ line 185](../../../../language.py#L185) +### *attr* [Foreign.**tamil**](../../../../language.py#L185) > Type: `str` The language name in tamil -### *attr* Foreign.**telugu** - -> [Source: ../../../../language.py @ line 187](../../../../language.py#L187) +### *attr* [Foreign.**telugu**](../../../../language.py#L187) > Type: `str` The language name in telugu -### *attr* Foreign.**thai** - -> [Source: ../../../../language.py @ line 189](../../../../language.py#L189) +### *attr* [Foreign.**thai**](../../../../language.py#L189) > Type: `str` The language name in thai -### *attr* Foreign.**turkish** - -> [Source: ../../../../language.py @ line 191](../../../../language.py#L191) +### *attr* [Foreign.**turkish**](../../../../language.py#L191) > Type: `str` The language name in turkish -### *attr* Foreign.**ukrainian** - -> [Source: ../../../../language.py @ line 193](../../../../language.py#L193) +### *attr* [Foreign.**ukrainian**](../../../../language.py#L193) > Type: `str` The language name in ukrainian -### *attr* Foreign.**urdu** - -> [Source: ../../../../language.py @ line 195](../../../../language.py#L195) +### *attr* [Foreign.**urdu**](../../../../language.py#L195) > Type: `str` The language name in urdu -### *attr* Foreign.**uzbek** - -> [Source: ../../../../language.py @ line 197](../../../../language.py#L197) +### *attr* [Foreign.**uzbek**](../../../../language.py#L197) > Type: `str` The language name in uzbek -### *attr* Foreign.**vietnamese** - -> [Source: ../../../../language.py @ line 199](../../../../language.py#L199) +### *attr* [Foreign.**vietnamese**](../../../../language.py#L199) > Type: `str` The language name in vietnamese -### *attr* Foreign.**welsh** - -> [Source: ../../../../language.py @ line 201](../../../../language.py#L201) +### *attr* [Foreign.**welsh**](../../../../language.py#L201) > Type: `str` The language name in welsh -### *attr* Foreign.**xhosa** - -> [Source: ../../../../language.py @ line 203](../../../../language.py#L203) +### *attr* [Foreign.**xhosa**](../../../../language.py#L203) > Type: `str` The language name in xhosa -### *attr* Foreign.**yiddish** - -> [Source: ../../../../language.py @ line 205](../../../../language.py#L205) +### *attr* [Foreign.**yiddish**](../../../../language.py#L205) > Type: `str` The language name in yiddish -### *attr* Foreign.**zulu** - -> [Source: ../../../../language.py @ line 207](../../../../language.py#L207) +### *attr* [Foreign.**zulu**](../../../../language.py#L207) > Type: `str` The language name in zulu -## *const* **LANGUAGE_CACHE** - -> [Source: ../../../../language.py @ line 211](../../../../language.py#L211) +## *const* [**LANGUAGE_CACHE**](../../../../language.py#L211) -## *const* **NULLABLE_ATTRIBUTES** +## *const* [**NULLABLE_ATTRIBUTES**](../../../../language.py#L212) -> [Source: ../../../../language.py @ line 212](../../../../language.py#L212) - -## *class* **Language** - -> [Source: ../../../../language.py @ line 215-347](../../../../language.py#L215-L347) +## *class* [**Language**](../../../../language.py#L215-L347) A language -### *attr* Language.**id** - -> [Source: ../../../../language.py @ line 218](../../../../language.py#L218) +### *attr* [Language.**id**](../../../../language.py#L218) > Type: `str` The language identifier -### *attr* Language.**alpha3** - -> [Source: ../../../../language.py @ line 220](../../../../language.py#L220) +### *attr* [Language.**alpha3**](../../../../language.py#L220) > Type: `str` The ISO 639-3 (Alpha-3) code -### *attr* Language.**name** - -> [Source: ../../../../language.py @ line 222](../../../../language.py#L222) +### *attr* [Language.**name**](../../../../language.py#L222) > Type: `str` The english name -### *attr* Language.**alpha2** - -> [Source: ../../../../language.py @ line 224](../../../../language.py#L224) +### *attr* [Language.**alpha2**](../../../../language.py#L224) > Type: `Optional` The ISO 639-1 (Alpha-2) code, if available -### *attr* Language.**alpha3b** - -> [Source: ../../../../language.py @ line 226](../../../../language.py#L226) +### *attr* [Language.**alpha3b**](../../../../language.py#L226) > Type: `Optional` The ISO 639-2B (Alpha-3) code, if available -### *attr* Language.**alpha3t** - -> [Source: ../../../../language.py @ line 228](../../../../language.py#L228) +### *attr* [Language.**alpha3t**](../../../../language.py#L228) > Type: `Optional` The ISO 639-2T (Alpha-3) code, if available -### *attr* Language.**extra** - -> [Source: ../../../../language.py @ line 230](../../../../language.py#L230) +### *attr* [Language.**extra**](../../../../language.py#L230) > Type: `Optional` Extra data for the language, if available -### *attr* Language.**foreign** - -> [Source: ../../../../language.py @ line 232](../../../../language.py#L232) +### *attr* [Language.**foreign**](../../../../language.py#L232) > Type: `Optional` Name in foreign languages, if available -### *func* Language.**search** - -> [Source: ../../../../language.py @ line 269-292](../../../../language.py#L269-L292) +### *func* [Language.**search**](../../../../language.py#L269-L292) Searches the given language @@ -828,9 +624,7 @@ Searches the given language - `list` -### *func* Language.**get_extra** - -> [Source: ../../../../language.py @ line 310-317](../../../../language.py#L310-L317) +### *func* [Language.**get_extra**](../../../../language.py#L310-L317) Retrieves the given attribute from `extra` if available @@ -845,9 +639,7 @@ Retrieves the given attribute from `extra` if available - `str` -### *func* Language.**get_foreign** - -> [Source: ../../../../language.py @ line 319-328](../../../../language.py#L319-L328) +### *func* [Language.**get_foreign**](../../../../language.py#L319-L328) Retrieves the given attribute from `foreign` if available @@ -862,9 +654,7 @@ Retrieves the given attribute from `foreign` if available - `str` -### *property* Language.**similarity** - -> [Source: ../../../../language.py @ line 331-333](../../../../language.py#L331-L333) +### *property* [Language.**similarity**](../../../../language.py#L331-L333) The similarity with the vector while searching the language @@ -872,9 +662,7 @@ The similarity with the vector while searching the language - `float` -### *property* Language.**native** - -> [Source: ../../../../language.py @ line 336-338](../../../../language.py#L336-L338) +### *property* [Language.**native**](../../../../language.py#L336-L338) The native name for the language or its english name @@ -882,9 +670,7 @@ The native name for the language or its english name - `str` -### *property* Language.**rich** - -> [Source: ../../../../language.py @ line 341-347](../../../../language.py#L341-L347) +### *property* [Language.**rich**](../../../../language.py#L341-L347) If the language discovery used the full translatepy dataset Note: This returns `False` if the `Language` was not fully initialized @@ -893,56 +679,38 @@ Note: This returns `False` if the `Language` was not fully initialized - `bool` -## *class* **LanguageData** - -> [Source: ../../../../language.py @ line 352-356](../../../../language.py#L352-L356) +## *class* [**LanguageData**](../../../../language.py#L352-L356) Groups all of the data -### *attr* LanguageData.**codes** - -> [Source: ../../../../language.py @ line 354](../../../../language.py#L354) +### *attr* [LanguageData.**codes**](../../../../language.py#L354) > Type: `Dict` -### *attr* LanguageData.**data** - -> [Source: ../../../../language.py @ line 355](../../../../language.py#L355) +### *attr* [LanguageData.**data**](../../../../language.py#L355) > Type: `Dict` -### *attr* LanguageData.**vectors** - -> [Source: ../../../../language.py @ line 356](../../../../language.py#L356) +### *attr* [LanguageData.**vectors**](../../../../language.py#L356) > Type: `List` -## *const* **LANGUAGE_DATA_DIR** - -> [Source: ../../../../language.py @ line 360](../../../../language.py#L360) +## *const* [**LANGUAGE_DATA_DIR**](../../../../language.py#L360) The directory where all of the data is stored -## *const* **DATA** - -> [Source: ../../../../language.py @ line 363](../../../../language.py#L363) +## *const* [**DATA**](../../../../language.py#L363) The languages in-memory data -## *const* **TRANSLATEPY_LANGUAGE_FULL** - -> [Source: ../../../../language.py @ line 369](../../../../language.py#L369) +## *const* [**TRANSLATEPY_LANGUAGE_FULL**](../../../../language.py#L369) If the full language data database got loaded at runtime -## *func* **load_full** - -> [Source: ../../../../language.py @ line 378-385](../../../../language.py#L378-L385) +## *func* [**load_full**](../../../../language.py#L378-L385) Loads the full data languages DB -## *const* **COMMON_LANGUAGES** - -> [Source: ../../../../language.py @ line 392](../../../../language.py#L392) +## *const* [**COMMON_LANGUAGES**](../../../../language.py#L392) All of the available foreign languages for the `foreign` field on the `Language` class and English diff --git a/translatepy/server/docs/jpn/reference/models.md b/translatepy/server/docs/jpn/reference/models.md index c2ea421..0bee762 100644 --- a/translatepy/server/docs/jpn/reference/models.md +++ b/translatepy/server/docs/jpn/reference/models.md @@ -1,6 +1,6 @@ # *module* **models** -> [Source: ../../../../models.py @ line 0](../../../../models.py#L0) +> [Source: ../../../../models.py](../../../../models.py#L0) translatepy/models.py Describes the different result models returned by the translators @@ -11,62 +11,38 @@ Describes the different result models returned by the translators - [../../../../utils/audio.py](../../../../utils/audio.py): As `get_type` -## *class* **Speed** - -> [Source: ../../../../models.py @ line 23-28](../../../../models.py#L23-L28) +## *class* [**Speed**](../../../../models.py#L23-L28) Represents a speed percentage -### *attr* Speed.**FULL** - -> [Source: ../../../../models.py @ line 25](../../../../models.py#L25) - -### *attr* Speed.**HALF** - -> [Source: ../../../../models.py @ line 26](../../../../models.py#L26) +### *attr* [Speed.**FULL**](../../../../models.py#L25) -### *attr* Speed.**QUARTER** +### *attr* [Speed.**HALF**](../../../../models.py#L26) -> [Source: ../../../../models.py @ line 27](../../../../models.py#L27) +### *attr* [Speed.**QUARTER**](../../../../models.py#L27) -### *attr* Speed.**SLOW** +### *attr* [Speed.**SLOW**](../../../../models.py#L28) -> [Source: ../../../../models.py @ line 28](../../../../models.py#L28) - -## *class* **Gender** - -> [Source: ../../../../models.py @ line 31-36](../../../../models.py#L31-L36) +## *class* [**Gender**](../../../../models.py#L31-L36) Represents a gender -### *attr* Gender.**MALE** - -> [Source: ../../../../models.py @ line 33](../../../../models.py#L33) +### *attr* [Gender.**MALE**](../../../../models.py#L33) -### *attr* Gender.**FEMALE** +### *attr* [Gender.**FEMALE**](../../../../models.py#L34) -> [Source: ../../../../models.py @ line 34](../../../../models.py#L34) +### *attr* [Gender.**OTHER**](../../../../models.py#L35) -### *attr* Gender.**OTHER** +### *attr* [Gender.**GENDERLESS**](../../../../models.py#L36) -> [Source: ../../../../models.py @ line 35](../../../../models.py#L35) - -### *attr* Gender.**GENDERLESS** - -> [Source: ../../../../models.py @ line 36](../../../../models.py#L36) - -## *class* **WordClass** - -> [Source: ../../../../models.py @ line 39-110](../../../../models.py#L39-L110) +## *class* [**WordClass**](../../../../models.py#L39-L110) Part of speech > **Note** > Refer to https://en.wikipedia.org/wiki/Part_of_speech -### *attr* WordClass.**NOUN** - -> [Source: ../../../../models.py @ line 45](../../../../models.py#L45) +### *attr* [WordClass.**NOUN**](../../../../models.py#L45) A word or lexical item denoting any abstract (abstract noun: e.g. home) or concrete entity (concrete noun: e.g. house); a person (police officer, Michael), place (coastline, London), thing (necktie, television), idea (happiness), or quality (bravery). @@ -75,37 +51,27 @@ Nouns can also be classified as count nouns or non-count nouns; some can belong > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**PRONOUN** - -> [Source: ../../../../models.py @ line 54](../../../../models.py#L54) +### *attr* [WordClass.**PRONOUN**](../../../../models.py#L54) A substitute for a noun or noun phrase (them, he). Pronouns make sentences shorter and clearer since they replace nouns. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ADJECTIVE** - -> [Source: ../../../../models.py @ line 60](../../../../models.py#L60) +### *attr* [WordClass.**ADJECTIVE**](../../../../models.py#L60) A modifier of a noun or pronoun (big, brave). Adjectives make the meaning of another word (noun) more precise. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**VERB** - -> [Source: ../../../../models.py @ line 66](../../../../models.py#L66) +### *attr* [WordClass.**VERB**](../../../../models.py#L66) A word denoting an action (walk), occurrence (happen), or state of being (be). Without a verb, a group of words cannot be a clause or sentence. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ADVERB** - -> [Source: ../../../../models.py @ line 72](../../../../models.py#L72) +### *attr* [WordClass.**ADVERB**](../../../../models.py#L72) A modifier of an adjective, verb, or another adverb (very, quite). Adverbs make language more precise. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**PREPOSITION** - -> [Source: ../../../../models.py @ line 78](../../../../models.py#L78) +### *attr* [WordClass.**PREPOSITION**](../../../../models.py#L78) A word that relates words to each other in a phrase or sentence and aids in syntactic context (in, of). Prepositions show the relationship between a noun or a pronoun with another word in the sentence. @@ -113,23 +79,17 @@ Prepositions show the relationship between a noun or a pronoun with another word > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**CONJUNCTION** - -> [Source: ../../../../models.py @ line 86](../../../../models.py#L86) +### *attr* [WordClass.**CONJUNCTION**](../../../../models.py#L86) A syntactic connector; links words, phrases, or clauses (and, but). Conjunctions connect words or group of words Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**INTERJECTION** - -> [Source: ../../../../models.py @ line 92](../../../../models.py#L92) +### *attr* [WordClass.**INTERJECTION**](../../../../models.py#L92) An emotional greeting or exclamation (Huzzah, Alas). Interjections express strong feelings and emotions. Note: https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**ARTICLE** - -> [Source: ../../../../models.py @ line 98](../../../../models.py#L98) +### *attr* [WordClass.**ARTICLE**](../../../../models.py#L98) A grammatical marker of definiteness (the) or indefiniteness (a, an). The article is not always listed among the parts of speech. @@ -138,23 +98,15 @@ It is considered by some grammarians to be a type of adjective or sometimes the > **Note** > https://en.wikipedia.org/wiki/Part_of_speech#Classification -### *attr* WordClass.**OTHER** - -> [Source: ../../../../models.py @ line 107](../../../../models.py#L107) +### *attr* [WordClass.**OTHER**](../../../../models.py#L107) For other part of speech -## *const* **Translator** - -> [Source: ../../../../models.py @ line 113](../../../../models.py#L113) - -## *const* **PRIVATE_ATTRIBUTES** +## *const* [**Translator**](../../../../models.py#L113) -> [Source: ../../../../models.py @ line 115](../../../../models.py#L115) +## *const* [**PRIVATE_ATTRIBUTES**](../../../../models.py#L115) -## *func* **should_be_exported** - -> [Source: ../../../../models.py @ line 118-121](../../../../models.py#L118-L121) +## *func* [**should_be_exported**](../../../../models.py#L118-L121) if the given attribute should be exposed or not @@ -163,33 +115,23 @@ if the given attribute should be exposed or not - **attr**: `str` -## *class* **ResultAttribute** - -> [Source: ../../../../models.py @ line 125-129](../../../../models.py#L125-L129) +## *class* [**ResultAttribute**](../../../../models.py#L125-L129) Details about a result attribute -### *attr* ResultAttribute.**name** - -> [Source: ../../../../models.py @ line 127](../../../../models.py#L127) +### *attr* [ResultAttribute.**name**](../../../../models.py#L127) > Type: `str` -### *attr* ResultAttribute.**annotation** - -> [Source: ../../../../models.py @ line 128](../../../../models.py#L128) +### *attr* [ResultAttribute.**annotation**](../../../../models.py#L128) > Type: `Optional` -### *attr* ResultAttribute.**description** - -> [Source: ../../../../models.py @ line 129](../../../../models.py#L129) +### *attr* [ResultAttribute.**description**](../../../../models.py#L129) > Type: `Optional` -## *class* **Result** - -> [Source: ../../../../models.py @ line 136-287](../../../../models.py#L136-L287) +## *class* [**Result**](../../../../models.py#L136-L287) The base result model @@ -197,33 +139,25 @@ The base result model - `IndexError` -### *attr* Result.**service** - -> [Source: ../../../../models.py @ line 143](../../../../models.py#L143) +### *attr* [Result.**service**](../../../../models.py#L143) > Type: `Translator` The service which returned the result -### *attr* Result.**source** - -> [Source: ../../../../models.py @ line 146](../../../../models.py#L146) +### *attr* [Result.**source**](../../../../models.py#L146) > Type: `str` The source text -### *attr* Result.**source_lang** - -> [Source: ../../../../models.py @ line 148](../../../../models.py#L148) +### *attr* [Result.**source_lang**](../../../../models.py#L148) > Type: `Language` The source text's language -### *attr* Result.**raw** - -> [Source: ../../../../models.py @ line 158](../../../../models.py#L158) +### *attr* [Result.**raw**](../../../../models.py#L158) > Type: `Optional` @@ -231,9 +165,7 @@ The raw response returned by the service. Note: This is very dependent on the service used. Refer to the service documentation to learn how to use this object. -### *property* Result.**attributes** - -> [Source: ../../../../models.py @ line 217-267](../../../../models.py#L217-L267) +### *property* [Result.**attributes**](../../../../models.py#L217-L267) The different attributes on the dataclass @@ -246,9 +178,7 @@ The different attributes on the dataclass - `list` -### *property* Result.**exported** - -> [Source: ../../../../models.py @ line 270-281](../../../../models.py#L270-L281) +### *property* [Result.**exported**](../../../../models.py#L270-L281) A dictionary version of the dataclass which can be exposed to the public @@ -256,169 +186,119 @@ A dictionary version of the dataclass which can be exposed to the public - `dict` -## *class* **TranslationResult** - -> [Source: ../../../../models.py @ line 291-329](../../../../models.py#L291-L329) +## *class* [**TranslationResult**](../../../../models.py#L291-L329) Holds the result of a regular translation -### *attr* TranslationResult.**dest_lang** - -> [Source: ../../../../models.py @ line 296](../../../../models.py#L296) +### *attr* [TranslationResult.**dest_lang**](../../../../models.py#L296) > Type: `Language` The result's language -### *attr* TranslationResult.**translation** - -> [Source: ../../../../models.py @ line 299](../../../../models.py#L299) +### *attr* [TranslationResult.**translation**](../../../../models.py#L299) > Type: `str` The translation result -### *property* TranslationResult.**alternatives** - -> [Source: ../../../../models.py @ line 306-310](../../../../models.py#L306-L310) +### *property* [TranslationResult.**alternatives**](../../../../models.py#L306-L310) Returns the alternative translations associated -## *const* **TRANSLATION_TEST** +## *const* [**TRANSLATION_TEST**](../../../../models.py#L332) -> [Source: ../../../../models.py @ line 332](../../../../models.py#L332) - -## *class* **TransliterationResult** - -> [Source: ../../../../models.py @ line 344-371](../../../../models.py#L344-L371) +## *class* [**TransliterationResult**](../../../../models.py#L344-L371) Holds the result of a transliteration -### *attr* TransliterationResult.**transliteration** - -> [Source: ../../../../models.py @ line 348](../../../../models.py#L348) +### *attr* [TransliterationResult.**transliteration**](../../../../models.py#L348) > Type: `str` The transliteration result -### *attr* TransliterationResult.**dest_lang** - -> [Source: ../../../../models.py @ line 351](../../../../models.py#L351) +### *attr* [TransliterationResult.**dest_lang**](../../../../models.py#L351) > Type: `Language` The result's language -## *const* **TRANSLITERATION_TEST** +## *const* [**TRANSLITERATION_TEST**](../../../../models.py#L374) -> [Source: ../../../../models.py @ line 374](../../../../models.py#L374) - -## *class* **SpellcheckResult** - -> [Source: ../../../../models.py @ line 384-410](../../../../models.py#L384-L410) +## *class* [**SpellcheckResult**](../../../../models.py#L384-L410) Holds a spellchecking result -### *attr* SpellcheckResult.**rich** - -> [Source: ../../../../models.py @ line 389](../../../../models.py#L389) +### *attr* [SpellcheckResult.**rich**](../../../../models.py#L389) -### *attr* SpellcheckResult.**source_lang** - -> [Source: ../../../../models.py @ line 391](../../../../models.py#L391) +### *attr* [SpellcheckResult.**source_lang**](../../../../models.py#L391) > Type: `Language` The source text's language -### *attr* SpellcheckResult.**corrected** - -> [Source: ../../../../models.py @ line 393](../../../../models.py#L393) +### *attr* [SpellcheckResult.**corrected**](../../../../models.py#L393) > Type: `str` The corrected text -## *const* **SPELLCHECK_TEST** - -> [Source: ../../../../models.py @ line 413](../../../../models.py#L413) +## *const* [**SPELLCHECK_TEST**](../../../../models.py#L413) -## *class* **SpellcheckMistake** - -> [Source: ../../../../models.py @ line 422-435](../../../../models.py#L422-L435) +## *class* [**SpellcheckMistake**](../../../../models.py#L422-L435) This holds a mistake made detected by the spellchecker -### *attr* SpellcheckMistake.**start** - -> [Source: ../../../../models.py @ line 424](../../../../models.py#L424) +### *attr* [SpellcheckMistake.**start**](../../../../models.py#L424) > Type: `int` The beginning index of the part to correct in the original text -### *attr* SpellcheckMistake.**end** - -> [Source: ../../../../models.py @ line 426](../../../../models.py#L426) +### *attr* [SpellcheckMistake.**end**](../../../../models.py#L426) > Type: `int` The ending index of the part to correct in the original text -### *attr* SpellcheckMistake.**corrected** - -> [Source: ../../../../models.py @ line 428](../../../../models.py#L428) +### *attr* [SpellcheckMistake.**corrected**](../../../../models.py#L428) > Type: `str` The corrected part -### *attr* SpellcheckMistake.**message** - -> [Source: ../../../../models.py @ line 431](../../../../models.py#L431) +### *attr* [SpellcheckMistake.**message**](../../../../models.py#L431) > Type: `Optional` A message explaining what happened -### *attr* SpellcheckMistake.**rule** - -> [Source: ../../../../models.py @ line 434](../../../../models.py#L434) +### *attr* [SpellcheckMistake.**rule**](../../../../models.py#L434) > Type: `Optional` A string which identifies the rule associated with the mistake made -## *class* **RichSpellcheckResult** - -> [Source: ../../../../models.py @ line 441-601](../../../../models.py#L441-L601) +## *class* [**RichSpellcheckResult**](../../../../models.py#L441-L601) Holds a rich spellchecking result -### *attr* RichSpellcheckResult.**rich** +### *attr* [RichSpellcheckResult.**rich**](../../../../models.py#L447) -> [Source: ../../../../models.py @ line 447](../../../../models.py#L447) - -### *attr* RichSpellcheckResult.**source_lang** - -> [Source: ../../../../models.py @ line 449](../../../../models.py#L449) +### *attr* [RichSpellcheckResult.**source_lang**](../../../../models.py#L449) > Type: `Language` The source text's language -### *attr* RichSpellcheckResult.**mistakes** - -> [Source: ../../../../models.py @ line 451](../../../../models.py#L451) +### *attr* [RichSpellcheckResult.**mistakes**](../../../../models.py#L451) > Type: `List` The different mistakes made -### *property* RichSpellcheckResult.**corrected** - -> [Source: ../../../../models.py @ line 455-463](../../../../models.py#L455-L463) +### *property* [RichSpellcheckResult.**corrected**](../../../../models.py#L455-L463) The corrected text @@ -426,45 +306,31 @@ The corrected text - `str` -## *const* **RICH_SPELLCHECK_TEST** - -> [Source: ../../../../models.py @ line 604](../../../../models.py#L604) - -## *class* **LanguageResult** +## *const* [**RICH_SPELLCHECK_TEST**](../../../../models.py#L604) -> [Source: ../../../../models.py @ line 618-628](../../../../models.py#L618-L628) +## *class* [**LanguageResult**](../../../../models.py#L618-L628) Holds the language of the given text -## *const* **LANGUAGE_TEST** +## *const* [**LANGUAGE_TEST**](../../../../models.py#L631) -> [Source: ../../../../models.py @ line 631](../../../../models.py#L631) - -## *class* **ExampleResult** - -> [Source: ../../../../models.py @ line 635-725](../../../../models.py#L635-L725) +## *class* [**ExampleResult**](../../../../models.py#L635-L725) Holds an example sentence where the given word is used. -### *attr* ExampleResult.**example** - -> [Source: ../../../../models.py @ line 641](../../../../models.py#L641) +### *attr* [ExampleResult.**example**](../../../../models.py#L641) > Type: `str` The example -### *attr* ExampleResult.**reference** - -> [Source: ../../../../models.py @ line 644](../../../../models.py#L644) +### *attr* [ExampleResult.**reference**](../../../../models.py#L644) > Type: `Optional` Where the example comes from (i.e a book or a the person who said it if it's a quote) -### *property* ExampleResult.**position** - -> [Source: ../../../../models.py @ line 648-655](../../../../models.py#L648-L655) +### *property* [ExampleResult.**position**](../../../../models.py#L648-L655) The first position of the word in the example @@ -474,9 +340,7 @@ The first position of the word in the example - `int` -### *property* ExampleResult.**positions** - -> [Source: ../../../../models.py @ line 658-690](../../../../models.py#L658-L690) +### *property* [ExampleResult.**positions**](../../../../models.py#L658-L690) The positions of the word in the example @@ -485,75 +349,51 @@ The positions of the word in the example - `list[int]` - A list of positions of the word in the example -## *const* **EXAMPLE_TEST** - -> [Source: ../../../../models.py @ line 728](../../../../models.py#L728) +## *const* [**EXAMPLE_TEST**](../../../../models.py#L728) -## *class* **DictionaryResult** - -> [Source: ../../../../models.py @ line 737-752](../../../../models.py#L737-L752) +## *class* [**DictionaryResult**](../../../../models.py#L737-L752) Holds the meaning of the given text -### *attr* DictionaryResult.**rich** - -> [Source: ../../../../models.py @ line 743](../../../../models.py#L743) - -### *attr* DictionaryResult.**meaning** +### *attr* [DictionaryResult.**rich**](../../../../models.py#L743) -> [Source: ../../../../models.py @ line 745](../../../../models.py#L745) +### *attr* [DictionaryResult.**meaning**](../../../../models.py#L745) > Type: `str` The meaning of the text -## *const* **DICTIONARY_TEST** +## *const* [**DICTIONARY_TEST**](../../../../models.py#L755) -> [Source: ../../../../models.py @ line 755](../../../../models.py#L755) - -## *class* **EtymologicalNode** - -> [Source: ../../../../models.py @ line 764-791](../../../../models.py#L764-L791) +## *class* [**EtymologicalNode**](../../../../models.py#L764-L791) The node of an etymological tree -### *attr* EtymologicalNode.**origin** - -> [Source: ../../../../models.py @ line 766](../../../../models.py#L766) +### *attr* [EtymologicalNode.**origin**](../../../../models.py#L766) > Type: `str` The origin name (i.e 'Latin') -### *attr* EtymologicalNode.**source** - -> [Source: ../../../../models.py @ line 769](../../../../models.py#L769) +### *attr* [EtymologicalNode.**source**](../../../../models.py#L769) > Type: `Optional` The original way of writing it -### *attr* EtymologicalNode.**year** - -> [Source: ../../../../models.py @ line 771](../../../../models.py#L771) +### *attr* [EtymologicalNode.**year**](../../../../models.py#L771) > Type: `Optional` The year of origin -## *class* **RichDictionaryResult** - -> [Source: ../../../../models.py @ line 795-904](../../../../models.py#L795-L904) +## *class* [**RichDictionaryResult**](../../../../models.py#L795-L904) Holds more (optional) information than the regular `DictionaryResult` -### *attr* RichDictionaryResult.**rich** +### *attr* [RichDictionaryResult.**rich**](../../../../models.py#L801) -> [Source: ../../../../models.py @ line 801](../../../../models.py#L801) - -### *attr* RichDictionaryResult.**etymology** - -> [Source: ../../../../models.py @ line 803](../../../../models.py#L803) +### *attr* [RichDictionaryResult.**etymology**](../../../../models.py#L803) > Type: `List` @@ -566,9 +406,7 @@ Each element corresponds to a node in the tree of origins for the given text `Node1 (Greek) -> Node2 (Latin) -> Node3 (French) -> Node4 (Ancient English) -> Current Word` -### *attr* RichDictionaryResult.**gender** - -> [Source: ../../../../models.py @ line 814](../../../../models.py#L814) +### *attr* [RichDictionaryResult.**gender**](../../../../models.py#L814) > Type: `Gender` @@ -580,77 +418,55 @@ For languages which assign genders on words `chaîse (french; a chair) -> Gender.FEMALE` -### *attr* RichDictionaryResult.**pronunciation** - -> [Source: ../../../../models.py @ line 823](../../../../models.py#L823) +### *attr* [RichDictionaryResult.**pronunciation**](../../../../models.py#L823) > Type: `Optional` A way of pronouncing the text -### *attr* RichDictionaryResult.**type** - -> [Source: ../../../../models.py @ line 826](../../../../models.py#L826) +### *attr* [RichDictionaryResult.**type**](../../../../models.py#L826) > Type: `WordClass` The part of speech of the text -### *attr* RichDictionaryResult.**synonyms** - -> [Source: ../../../../models.py @ line 829](../../../../models.py#L829) +### *attr* [RichDictionaryResult.**synonyms**](../../../../models.py#L829) > Type: `List` -### *attr* RichDictionaryResult.**antonyms** - -> [Source: ../../../../models.py @ line 830](../../../../models.py#L830) +### *attr* [RichDictionaryResult.**antonyms**](../../../../models.py#L830) > Type: `List` -## *const* **RICH_DICTIONARY_TEST** +## *const* [**RICH_DICTIONARY_TEST**](../../../../models.py#L907) -> [Source: ../../../../models.py @ line 907](../../../../models.py#L907) - -## *class* **TextToSpeechResult** - -> [Source: ../../../../models.py @ line 922-988](../../../../models.py#L922-L988) +## *class* [**TextToSpeechResult**](../../../../models.py#L922-L988) Holds the text to speech results -### *attr* TextToSpeechResult.**result** - -> [Source: ../../../../models.py @ line 928](../../../../models.py#L928) +### *attr* [TextToSpeechResult.**result**](../../../../models.py#L928) > Type: `bytes` Text to speech result -### *attr* TextToSpeechResult.**speed** - -> [Source: ../../../../models.py @ line 930](../../../../models.py#L930) +### *attr* [TextToSpeechResult.**speed**](../../../../models.py#L930) > Type: `int` Speed of the text to speech result -### *attr* TextToSpeechResult.**gender** - -> [Source: ../../../../models.py @ line 932](../../../../models.py#L932) +### *attr* [TextToSpeechResult.**gender**](../../../../models.py#L932) > Type: `Gender` Gender of the 'person' saying the text -### *property* TextToSpeechResult.**type** - -> [Source: ../../../../models.py @ line 936-938](../../../../models.py#L936-L938) +### *property* [TextToSpeechResult.**type**](../../../../models.py#L936-L938) Returns the type of audio file -### *property* TextToSpeechResult.**mime_type** - -> [Source: ../../../../models.py @ line 941-953](../../../../models.py#L941-L953) +### *property* [TextToSpeechResult.**mime_type**](../../../../models.py#L941-L953) Returns the MIME type of the audio file @@ -659,9 +475,7 @@ Returns the MIME type of the audio file - `Optional[str]` - The MIME type of the audio file -### *property* TextToSpeechResult.**extension** - -> [Source: ../../../../models.py @ line 956-968](../../../../models.py#L956-L968) +### *property* [TextToSpeechResult.**extension**](../../../../models.py#L956-L968) Returns the audio file extension @@ -670,9 +484,7 @@ Returns the audio file extension - `Optional[str]` - The MIME type of the audio file -### *func* TextToSpeechResult.**write_to_file** - -> [Source: ../../../../models.py @ line 970-988](../../../../models.py#L970-L988) +### *func* [TextToSpeechResult.**write_to_file**](../../../../models.py#L970-L988) Writes the spoken text to a file. @@ -687,27 +499,19 @@ Writes the spoken text to a file. - If we need to change the extension of the file to match the right file type -## *class* **HTMLTranslationNode** - -> [Source: ../../../../models.py @ line 992-1029](../../../../models.py#L992-L1029) +## *class* [**HTMLTranslationNode**](../../../../models.py#L992-L1029) A translation node, containing the DOM element and its translation result -### *attr* HTMLTranslationNode.**node** - -> [Source: ../../../../models.py @ line 996](../../../../models.py#L996) +### *attr* [HTMLTranslationNode.**node**](../../../../models.py#L996) > Type: `bs4.NavigableString` -### *attr* HTMLTranslationNode.**result** - -> [Source: ../../../../models.py @ line 997](../../../../models.py#L997) +### *attr* [HTMLTranslationNode.**result**](../../../../models.py#L997) > Type: `Optional` -### *property* HTMLTranslationNode.**position** - -> [Source: ../../../../models.py @ line 1000-1020](../../../../models.py#L1000-L1020) +### *property* [HTMLTranslationNode.**position**](../../../../models.py#L1000-L1020) The position of the node in the HTML @@ -715,9 +519,7 @@ The position of the node in the HTML - `int` -### *property* HTMLTranslationNode.**exported** - -> [Source: ../../../../models.py @ line 1023-1029](../../../../models.py#L1023-L1029) +### *property* [HTMLTranslationNode.**exported**](../../../../models.py#L1023-L1029) The exported dictionary @@ -725,33 +527,23 @@ The exported dictionary - `dict` -## *class* **HTMLTranslationResult** - -> [Source: ../../../../models.py @ line 1033-1052](../../../../models.py#L1033-L1052) +## *class* [**HTMLTranslationResult**](../../../../models.py#L1033-L1052) Holds an HTML translation result -### *attr* HTMLTranslationResult.**result** - -> [Source: ../../../../models.py @ line 1037](../../../../models.py#L1037) +### *attr* [HTMLTranslationResult.**result**](../../../../models.py#L1037) > Type: `str` -### *attr* HTMLTranslationResult.**soup** - -> [Source: ../../../../models.py @ line 1038](../../../../models.py#L1038) +### *attr* [HTMLTranslationResult.**soup**](../../../../models.py#L1038) > Type: `bs4.BeautifulSoup` -### *attr* HTMLTranslationResult.**nodes** - -> [Source: ../../../../models.py @ line 1039](../../../../models.py#L1039) +### *attr* [HTMLTranslationResult.**nodes**](../../../../models.py#L1039) > Type: `List` -### *property* HTMLTranslationResult.**exported** - -> [Source: ../../../../models.py @ line 1048-1052](../../../../models.py#L1048-L1052) +### *property* [HTMLTranslationResult.**exported**](../../../../models.py#L1048-L1052) #### Returns diff --git a/translatepy/server/docs/jpn/reference/server/server.md b/translatepy/server/docs/jpn/reference/server/server.md index 3fac41e..a95efb2 100644 --- a/translatepy/server/docs/jpn/reference/server/server.md +++ b/translatepy/server/docs/jpn/reference/server/server.md @@ -1,23 +1,17 @@ # *module* **server** -> [Source: ../../../../server.py @ line 0](../../../../server.py#L0) +> [Source: ../../../../server.py](../../../../server.py#L0) the translatepy server -## *const* **app** - -> [Source: ../../../../server.py @ line 6](../../../../server.py#L6) +## *const* [**app**](../../../../server.py#L6) The `nasse` server instance for `translatepy` -## *const* **TRANSLATEPY_ENDPOINT** - -> [Source: ../../../../server.py @ line 9](../../../../server.py#L9) +## *const* [**TRANSLATEPY_ENDPOINT**](../../../../server.py#L9) Base `translatepy` endpoint -## *const* **SERVER_DOCS_PATH** - -> [Source: ../../../../server.py @ line 13](../../../../server.py#L13) +## *const* [**SERVER_DOCS_PATH**](../../../../server.py#L13) The root path for the server offline docs diff --git a/translatepy/server/docs/jpn/reference/translate.md b/translatepy/server/docs/jpn/reference/translate.md index 32695c3..89256a1 100644 --- a/translatepy/server/docs/jpn/reference/translate.md +++ b/translatepy/server/docs/jpn/reference/translate.md @@ -1,6 +1,6 @@ # *module* **translate** -> [Source: ../../../../translate.py @ line 0](../../../../translate.py#L0) +> [Source: ../../../../translate.py](../../../../translate.py#L0) translatepy v3.0 © Anime no Sekai — 2023 @@ -37,14 +37,10 @@ translatepy v3.0 - [../../../../utils/request.py](../../../../utils/request.py): As `request` -## *const* **DEFAULT_TRANSLATORS** - -> [Source: ../../../../translate.py @ line 15](../../../../translate.py#L15) +## *const* [**DEFAULT_TRANSLATORS**](../../../../translate.py#L15) A list of default translators to use with the translators aggregation -## *class* **Translate** - -> [Source: ../../../../translate.py @ line 20-27](../../../../translate.py#L20-L27) +## *class* [**Translate**](../../../../translate.py#L20-L27) A class which groups all of the translators diff --git a/translatepy/server/docs/jpn/reference/translators/README.md b/translatepy/server/docs/jpn/reference/translators/README.md index f1565ab..1bb8003 100644 --- a/translatepy/server/docs/jpn/reference/translators/README.md +++ b/translatepy/server/docs/jpn/reference/translators/README.md @@ -1,6 +1,6 @@ # *module* **__init__** -> [Source: ../../../../../translators/__init__.py @ line 0](../../../../../translators/__init__.py#L0) +> [Source: ../../../../../translators/__init__.py](../../../../../translators/__init__.py#L0) ## Imports @@ -30,58 +30,30 @@ - [../../../../../translators/papago.py](../../../../../translators/papago.py): As `Papago` -## *const* **Reverso** +## *const* [**Reverso**](../../../../../translators/__init__.py#L21) -> [Source: ../../../../../translators/__init__.py @ line 21](../../../../../translators/__init__.py#L21) +## *const* [**Bing**](../../../../../translators/__init__.py#L22) -## *const* **Bing** +## *const* [**DeepL**](../../../../../translators/__init__.py#L23) -> [Source: ../../../../../translators/__init__.py @ line 22](../../../../../translators/__init__.py#L22) +## *const* [**Deepl**](../../../../../translators/__init__.py#L24) -## *const* **DeepL** +## *const* [**Google**](../../../../../translators/__init__.py#L25) -> [Source: ../../../../../translators/__init__.py @ line 23](../../../../../translators/__init__.py#L23) +## *const* [**Libre**](../../../../../translators/__init__.py#L26) -## *const* **Deepl** +## *const* [**MyMemory**](../../../../../translators/__init__.py#L27) -> [Source: ../../../../../translators/__init__.py @ line 24](../../../../../translators/__init__.py#L24) +## *const* [**TranslateCom**](../../../../../translators/__init__.py#L28) -## *const* **Google** +## *const* [**Yandex**](../../../../../translators/__init__.py#L29) -> [Source: ../../../../../translators/__init__.py @ line 25](../../../../../translators/__init__.py#L25) +## *const* [**Microsoft**](../../../../../translators/__init__.py#L30) -## *const* **Libre** +## *const* [**QCRITranslate**](../../../../../translators/__init__.py#L32) -> [Source: ../../../../../translators/__init__.py @ line 26](../../../../../translators/__init__.py#L26) +## *const* [**PONSTranslate**](../../../../../translators/__init__.py#L33) -## *const* **MyMemory** +## *const* [**PapagoTranslate**](../../../../../translators/__init__.py#L34) -> [Source: ../../../../../translators/__init__.py @ line 27](../../../../../translators/__init__.py#L27) - -## *const* **TranslateCom** - -> [Source: ../../../../../translators/__init__.py @ line 28](../../../../../translators/__init__.py#L28) - -## *const* **Yandex** - -> [Source: ../../../../../translators/__init__.py @ line 29](../../../../../translators/__init__.py#L29) - -## *const* **Microsoft** - -> [Source: ../../../../../translators/__init__.py @ line 30](../../../../../translators/__init__.py#L30) - -## *const* **QCRITranslate** - -> [Source: ../../../../../translators/__init__.py @ line 32](../../../../../translators/__init__.py#L32) - -## *const* **PONSTranslate** - -> [Source: ../../../../../translators/__init__.py @ line 33](../../../../../translators/__init__.py#L33) - -## *const* **PapagoTranslate** - -> [Source: ../../../../../translators/__init__.py @ line 34](../../../../../translators/__init__.py#L34) - -## *const* **NaverTranslate** - -> [Source: ../../../../../translators/__init__.py @ line 35](../../../../../translators/__init__.py#L35) +## *const* [**NaverTranslate**](../../../../../translators/__init__.py#L35) diff --git a/translatepy/server/docs/jpn/reference/translators/base.md b/translatepy/server/docs/jpn/reference/translators/base.md index 34421d7..dd36a6b 100644 --- a/translatepy/server/docs/jpn/reference/translators/base.md +++ b/translatepy/server/docs/jpn/reference/translators/base.md @@ -1,25 +1,17 @@ # *module* **base** -> [Source: ../../../../../translators/base.py @ line 0](../../../../../translators/base.py#L0) +> [Source: ../../../../../translators/base.py](../../../../../translators/base.py#L0) translators/base.py Implements the Base Translator class -## *const* **C** +## *const* [**C**](../../../../../translators/base.py#L25) -> [Source: ../../../../../translators/base.py @ line 25](../../../../../translators/base.py#L25) +## *const* [**R**](../../../../../translators/base.py#L26) -## *const* **R** +## *const* [**HTMLType**](../../../../../translators/base.py#L27) -> [Source: ../../../../../translators/base.py @ line 26](../../../../../translators/base.py#L26) - -## *const* **HTMLType** - -> [Source: ../../../../../translators/base.py @ line 27](../../../../../translators/base.py#L27) - -## *class* **LazyIterable** - -> [Source: ../../../../../translators/base.py @ line 30-69](../../../../../translators/base.py#L30-L69) +## *class* [**LazyIterable**](../../../../../translators/base.py#L30-L69) An object which can be iterated through, even multiple times, but lazy loads the results. @@ -27,33 +19,21 @@ An object which can be iterated through, even multiple times, but lazy loads the - `IndexError` -## *const* **T** - -> [Source: ../../../../../translators/base.py @ line 73](../../../../../translators/base.py#L73) +## *const* [**T**](../../../../../translators/base.py#L73) -## *class* **BaseTranslateException** - -> [Source: ../../../../../translators/base.py @ line 79-105](../../../../../translators/base.py#L79-L105) +## *class* [**BaseTranslateException**](../../../../../translators/base.py#L79-L105) A translator exception, indicating a problem which occured during translation -### *attr* BaseTranslateException.**error_codes** - -> [Source: ../../../../../translators/base.py @ line 83](../../../../../translators/base.py#L83) - -## *class* **Flag** +### *attr* [BaseTranslateException.**error_codes**](../../../../../translators/base.py#L83) -> [Source: ../../../../../translators/base.py @ line 108-112](../../../../../translators/base.py#L108-L112) +## *class* [**Flag**](../../../../../translators/base.py#L108-L112) Defines a set of internal flags the handlers can send to the validator -### *attr* Flag.**MULTIPLE_RESULTS** - -> [Source: ../../../../../translators/base.py @ line 112](../../../../../translators/base.py#L112) - -## *class* **BaseTranslator** +### *attr* [Flag.**MULTIPLE_RESULTS**](../../../../../translators/base.py#L112) -> [Source: ../../../../../translators/base.py @ line 115-1293](../../../../../translators/base.py#L115-L1293) +## *class* [**BaseTranslator**](../../../../../translators/base.py#L115-L1293) The core of translatepy This defines a "Translator" instance, which is the gateway between the translator logic and translatepy @@ -68,9 +48,7 @@ This defines a "Translator" instance, which is the gateway between the translato - `exceptions.UnsupportedMethod` -### *func* BaseTranslator.**translate** - -> [Source: ../../../../../translators/base.py @ line 307-324](../../../../../translators/base.py#L307-L324) +### *func* [BaseTranslator.**translate**](../../../../../translators/base.py#L307-L324) Translates the given `text` into the given `dest_lang` @@ -102,9 +80,7 @@ Translates the given `text` into the given `dest_lang` - `models.TranslationResult` -### *func* BaseTranslator.**translate** - -> [Source: ../../../../../translators/base.py @ line 327-346](../../../../../translators/base.py#L327-L346) +### *func* [BaseTranslator.**translate**](../../../../../translators/base.py#L327-L346) Translates all of the elements in `text` into the given `dest_lang` @@ -139,9 +115,7 @@ Translates all of the elements in `text` into the given `dest_lang` > **Note** > aka "Bulk Translation" -### *func* BaseTranslator.**translate** - -> [Source: ../../../../../translators/base.py @ line 351-393](../../../../../translators/base.py#L351-L393) +### *func* [BaseTranslator.**translate**](../../../../../translators/base.py#L351-L393) Translates `text` into the given `dest_lang` @@ -172,9 +146,7 @@ Translates `text` into the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../../translators/base.py @ line 420-451](../../../../../translators/base.py#L420-L451) +### *func* [BaseTranslator.**translate_html**](../../../../../translators/base.py#L420-L451) Translates the given `html` into the given `dest_lang` @@ -222,9 +194,7 @@ If `False`, the node will be left as is and the `result` part will be `None` - `models.HTMLTranslationResult` -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../../translators/base.py @ line 454-486](../../../../../translators/base.py#L454-L486) +### *func* [BaseTranslator.**translate_html**](../../../../../translators/base.py#L454-L486) Translates all of the elements in `html` into the given `dest_lang` @@ -275,9 +245,7 @@ If `False`, the node will be left as is and the `result` part will be `None` > **Note** > aka "Bulk Translation" -### *func* BaseTranslator.**translate_html** - -> [Source: ../../../../../translators/base.py @ line 489-565](../../../../../translators/base.py#L489-L565) +### *func* [BaseTranslator.**translate_html**](../../../../../translators/base.py#L489-L565) Translates `html` into the given `dest_lang` @@ -324,9 +292,7 @@ Translates `html` into the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../../translators/base.py @ line 573-586](../../../../../translators/base.py#L573-L586) +### *func* [BaseTranslator.**alternatives**](../../../../../translators/base.py#L573-L586) Returns the different alternative translations available for a given previous translation. @@ -349,9 +315,7 @@ Returns the different alternative translations available for a given previous tr - `list[TranslationResult]` - The list of other translations a word might have -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../../translators/base.py @ line 589-602](../../../../../translators/base.py#L589-L602) +### *func* [BaseTranslator.**alternatives**](../../../../../translators/base.py#L589-L602) Returns the different alternative translations available for all of the given translations. @@ -374,9 +338,7 @@ Returns the different alternative translations available for all of the given tr - `LazyIterable[list[TranslationResult]]` - All of the other translations -### *func* BaseTranslator.**alternatives** - -> [Source: ../../../../../translators/base.py @ line 606-632](../../../../../translators/base.py#L606-L632) +### *func* [BaseTranslator.**alternatives**](../../../../../translators/base.py#L606-L632) Returns the different alternative translations available for the given `translation`. @@ -400,9 +362,7 @@ Returns the different alternative translations available for the given `translat > **Note** > Refer to the overloaded methods docstrings for more information. -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../../translators/base.py @ line 664-681](../../../../../translators/base.py#L664-L681) +### *func* [BaseTranslator.**transliterate**](../../../../../translators/base.py#L664-L681) Transliterates the given `text` into the given `dest_lang` @@ -434,9 +394,7 @@ Transliterates the given `text` into the given `dest_lang` - `models.TransliterationResult` -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../../translators/base.py @ line 684-701](../../../../../translators/base.py#L684-L701) +### *func* [BaseTranslator.**transliterate**](../../../../../translators/base.py#L684-L701) Transliterates all of the given `text` to the given `dest_lang` @@ -468,9 +426,7 @@ Transliterates all of the given `text` to the given `dest_lang` - `LazyIterable[TransliterationResult]` - An iterable which contains the transliterations -### *func* BaseTranslator.**transliterate** - -> [Source: ../../../../../translators/base.py @ line 704-750](../../../../../translators/base.py#L704-L750) +### *func* [BaseTranslator.**transliterate**](../../../../../translators/base.py#L704-L750) Transliterates the given `text` to the given `dest_lang` @@ -501,13 +457,9 @@ Transliterates the given `text` to the given `dest_lang` > **Note** > Refer to the overloaded methods docstrings for more information. -### *attr* BaseTranslator.**transliteration** - -> [Source: ../../../../../translators/base.py @ line 753](../../../../../translators/base.py#L753) +### *attr* [BaseTranslator.**transliteration**](../../../../../translators/base.py#L753) -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../../translators/base.py @ line 781-798](../../../../../translators/base.py#L781-L798) +### *func* [BaseTranslator.**spellcheck**](../../../../../translators/base.py#L781-L798) Checks for spelling mistakes in the given `text` @@ -540,9 +492,7 @@ Checks for spelling mistakes in the given `text` - `SpellcheckResult` - The result of the spell check -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../../translators/base.py @ line 801-818](../../../../../translators/base.py#L801-L818) +### *func* [BaseTranslator.**spellcheck**](../../../../../translators/base.py#L801-L818) Checks for spelling mistakes in all of the given `text` @@ -573,9 +523,7 @@ Checks for spelling mistakes in all of the given `text` - `LazyIterable[SpellcheckResult]` - The results of the spell checks -### *func* BaseTranslator.**spellcheck** - -> [Source: ../../../../../translators/base.py @ line 822-853](../../../../../translators/base.py#L822-L853) +### *func* [BaseTranslator.**spellcheck**](../../../../../translators/base.py#L822-L853) Checks for spelling mistakes in the given `text` @@ -605,9 +553,7 @@ Checks for spelling mistakes in the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**language** - -> [Source: ../../../../../translators/base.py @ line 881-894](../../../../../translators/base.py#L881-L894) +### *func* [BaseTranslator.**language**](../../../../../translators/base.py#L881-L894) Returns the detected language for the given `text` @@ -630,9 +576,7 @@ Returns the detected language for the given `text` - `models.LanguageResult` -### *func* BaseTranslator.**language** - -> [Source: ../../../../../translators/base.py @ line 897-910](../../../../../translators/base.py#L897-L910) +### *func* [BaseTranslator.**language**](../../../../../translators/base.py#L897-L910) Returns the detected language for all of the given `text` @@ -655,9 +599,7 @@ Returns the detected language for all of the given `text` - `LazyIterable[LanguageResult]` - The results of the language detections -### *func* BaseTranslator.**language** - -> [Source: ../../../../../translators/base.py @ line 914-936](../../../../../translators/base.py#L914-L936) +### *func* [BaseTranslator.**language**](../../../../../translators/base.py#L914-L936) Returns the detected language for the given `text` @@ -685,9 +627,7 @@ Returns the detected language for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**example** - -> [Source: ../../../../../translators/base.py @ line 960-975](../../../../../translators/base.py#L960-L975) +### *func* [BaseTranslator.**example**](../../../../../translators/base.py#L960-L975) Returns use cases for the given `text` @@ -715,9 +655,7 @@ Returns use cases for the given `text` - `list[ExampleResult]` - The examples -### *func* BaseTranslator.**example** - -> [Source: ../../../../../translators/base.py @ line 978-993](../../../../../translators/base.py#L978-L993) +### *func* [BaseTranslator.**example**](../../../../../translators/base.py#L978-L993) Returns use cases for all of the given `text` @@ -745,9 +683,7 @@ Returns use cases for all of the given `text` - `LazyIterable[list[ExampleResult]]` - All of the examples -### *func* BaseTranslator.**example** - -> [Source: ../../../../../translators/base.py @ line 997-1031](../../../../../translators/base.py#L997-L1031) +### *func* [BaseTranslator.**example**](../../../../../translators/base.py#L997-L1031) Returns use cases for the given `text` @@ -775,9 +711,7 @@ Returns use cases for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../../translators/base.py @ line 1060-1077](../../../../../translators/base.py#L1060-L1077) +### *func* [BaseTranslator.**dictionary**](../../../../../translators/base.py#L1060-L1077) Returns the meaning for the given `text` @@ -808,9 +742,7 @@ Returns the meaning for the given `text` - `list` -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../../translators/base.py @ line 1080-1097](../../../../../translators/base.py#L1080-L1097) +### *func* [BaseTranslator.**dictionary**](../../../../../translators/base.py#L1080-L1097) Returns the meaning for all of the given `text` @@ -841,9 +773,7 @@ Returns the meaning for all of the given `text` - `LazyIterable[RichDictionaryResult]` - If supported, a value which contains much more information on all of the `text` -### *func* BaseTranslator.**dictionary** - -> [Source: ../../../../../translators/base.py @ line 1101-1135](../../../../../translators/base.py#L1101-L1135) +### *func* [BaseTranslator.**dictionary**](../../../../../translators/base.py#L1101-L1135) Returns the meaning for the given `text` @@ -871,9 +801,7 @@ Returns the meaning for the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../../translators/base.py @ line 1161-1180](../../../../../translators/base.py#L1161-L1180) +### *func* [BaseTranslator.**text_to_speech**](../../../../../translators/base.py#L1161-L1180) Returns the speech version of the given `text` @@ -900,9 +828,7 @@ Returns the speech version of the given `text` - `TextToSpeechResult` - The text to speech result -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../../translators/base.py @ line 1183-1202](../../../../../translators/base.py#L1183-L1202) +### *func* [BaseTranslator.**text_to_speech**](../../../../../translators/base.py#L1183-L1202) Returns the speech version for all of the given `text` @@ -929,18 +855,14 @@ Returns the speech version for all of the given `text` - `LazyIterable[TextToSpeechResult]` - The text to speech results -### *func* BaseTranslator.**text_to_speech** - -> [Source: ../../../../../translators/base.py @ line 1205-1241](../../../../../translators/base.py#L1205-L1241) +### *func* [BaseTranslator.**text_to_speech**](../../../../../translators/base.py#L1205-L1241) Returns the speech version of the given `text` > **Note** > Refer to the other overloaded methods for more information. -### *func* BaseTranslator.**clean_cache** - -> [Source: ../../../../../translators/base.py @ line 1265-1274](../../../../../translators/base.py#L1265-L1274) +### *func* [BaseTranslator.**clean_cache**](../../../../../translators/base.py#L1265-L1274) Cleans caches diff --git a/translatepy/server/docs/jpn/reference/translators/base_aggregator.md b/translatepy/server/docs/jpn/reference/translators/base_aggregator.md index 2149f83..487bc04 100644 --- a/translatepy/server/docs/jpn/reference/translators/base_aggregator.md +++ b/translatepy/server/docs/jpn/reference/translators/base_aggregator.md @@ -1,14 +1,12 @@ # *module* **base_aggregator** -> [Source: ../../../../../translators/base_aggregator.py @ line 0](../../../../../translators/base_aggregator.py#L0) +> [Source: ../../../../../translators/base_aggregator.py](../../../../../translators/base_aggregator.py#L0) ## Imports - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslator`, `C` -## *class* **BaseTranslatorAggregator** - -> [Source: ../../../../../translators/base_aggregator.py @ line 9-145](../../../../../translators/base_aggregator.py#L9-L145) +## *class* [**BaseTranslatorAggregator**](../../../../../translators/base_aggregator.py#L9-L145) ### Raises diff --git a/translatepy/server/docs/jpn/reference/translators/bing.md b/translatepy/server/docs/jpn/reference/translators/bing.md index b60f86d..1b12748 100644 --- a/translatepy/server/docs/jpn/reference/translators/bing.md +++ b/translatepy/server/docs/jpn/reference/translators/bing.md @@ -1,6 +1,6 @@ # *module* **Bing** -> [Source: ../../../../../translators/Bing.py @ line 0](../../../../../translators/Bing.py#L0) +> [Source: ../../../../../translators/Bing.py](../../../../../translators/Bing.py#L0) This implementation was made specifically for translatepy from 'Zhymabek Roman', based on 'Anime no Sekai' version. @@ -8,59 +8,39 @@ This implementation was made specifically for translatepy from 'Zhymabek Roman', - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator` -## *class* **BingTranslateException** +## *class* [**BingTranslateException**](../../../../../translators/Bing.py#L20-L23) -> [Source: ../../../../../translators/Bing.py @ line 20-23](../../../../../translators/Bing.py#L20-L23) +### *attr* [BingTranslateException.**error_codes**](../../../../../translators/Bing.py#L21) -### *attr* BingTranslateException.**error_codes** - -> [Source: ../../../../../translators/Bing.py @ line 21](../../../../../translators/Bing.py#L21) - -## *class* **BingSessionData** - -> [Source: ../../../../../translators/Bing.py @ line 26-33](../../../../../translators/Bing.py#L26-L33) +## *class* [**BingSessionData**](../../../../../translators/Bing.py#L26-L33) Bing session data holder -### *attr* BingSessionData.**ig** - -> [Source: ../../../../../translators/Bing.py @ line 28](../../../../../translators/Bing.py#L28) +### *attr* [BingSessionData.**ig**](../../../../../translators/Bing.py#L28) > Type: `str` -### *attr* BingSessionData.**iid** - -> [Source: ../../../../../translators/Bing.py @ line 29](../../../../../translators/Bing.py#L29) +### *attr* [BingSessionData.**iid**](../../../../../translators/Bing.py#L29) > Type: `str` -### *attr* BingSessionData.**key** - -> [Source: ../../../../../translators/Bing.py @ line 30](../../../../../translators/Bing.py#L30) +### *attr* [BingSessionData.**key**](../../../../../translators/Bing.py#L30) > Type: `cain.types.UInt64` -### *attr* BingSessionData.**token** - -> [Source: ../../../../../translators/Bing.py @ line 31](../../../../../translators/Bing.py#L31) +### *attr* [BingSessionData.**token**](../../../../../translators/Bing.py#L31) > Type: `str` -### *attr* BingSessionData.**cookies_keys** - -> [Source: ../../../../../translators/Bing.py @ line 32](../../../../../translators/Bing.py#L32) +### *attr* [BingSessionData.**cookies_keys**](../../../../../translators/Bing.py#L32) > Type: `List` -### *attr* BingSessionData.**cookies_values** - -> [Source: ../../../../../translators/Bing.py @ line 33](../../../../../translators/Bing.py#L33) +### *attr* [BingSessionData.**cookies_values**](../../../../../translators/Bing.py#L33) > Type: `List` -## *class* **BingSessionManager** - -> [Source: ../../../../../translators/Bing.py @ line 36-136](../../../../../translators/Bing.py#L36-L136) +## *class* [**BingSessionManager**](../../../../../translators/Bing.py#L36-L136) Creates and manages a Bing session @@ -68,9 +48,7 @@ Creates and manages a Bing session - `BingTranslateException` -### *func* BingSessionManager.**send** - -> [Source: ../../../../../translators/Bing.py @ line 92-136](../../../../../translators/Bing.py#L92-L136) +### *func* [BingSessionManager.**send**](../../../../../translators/Bing.py#L92-L136) Sends requestts to the API @@ -86,9 +64,7 @@ Sends requestts to the API - `BingTranslateException` -## *class* **BingTranslate** - -> [Source: ../../../../../translators/Bing.py @ line 145-251](../../../../../translators/Bing.py#L145-L251) +## *class* [**BingTranslate**](../../../../../translators/Bing.py#L145-L251) A Python implementation of Microsoft Bing Translation's APIs diff --git a/translatepy/server/docs/jpn/reference/translators/deepl.md b/translatepy/server/docs/jpn/reference/translators/deepl.md index 3deb1ca..34d9fa8 100644 --- a/translatepy/server/docs/jpn/reference/translators/deepl.md +++ b/translatepy/server/docs/jpn/reference/translators/deepl.md @@ -1,6 +1,6 @@ # *module* **DeepL** -> [Source: ../../../../../translators/DeepL.py @ line 0](../../../../../translators/DeepL.py#L0) +> [Source: ../../../../../translators/DeepL.py](../../../../../translators/DeepL.py#L0) DeepL Implementation for translatepy @@ -19,53 +19,33 @@ Refer to Animenosekai/translate#7 Arrangements, optimizations - **ZhymabekRoman** Co-Author -## *const* **SENTENCES_SPLITTING_REGEX** +## *const* [**SENTENCES_SPLITTING_REGEX**](../../../../../translators/DeepL.py#L31) -> [Source: ../../../../../translators/DeepL.py @ line 31](../../../../../translators/DeepL.py#L31) +## *class* [**DeeplFormality**](../../../../../translators/DeepL.py#L34-L36) -## *class* **DeeplFormality** +### *attr* [DeeplFormality.**formal**](../../../../../translators/DeepL.py#L35) -> [Source: ../../../../../translators/DeepL.py @ line 34-36](../../../../../translators/DeepL.py#L34-L36) +### *attr* [DeeplFormality.**informal**](../../../../../translators/DeepL.py#L36) -### *attr* DeeplFormality.**formal** +## *class* [**DeeplTranslate**](../../../../../translators/DeepL.py#L39-L41) -> [Source: ../../../../../translators/DeepL.py @ line 35](../../../../../translators/DeepL.py#L35) - -### *attr* DeeplFormality.**informal** - -> [Source: ../../../../../translators/DeepL.py @ line 36](../../../../../translators/DeepL.py#L36) - -## *class* **DeeplTranslate** - -> [Source: ../../../../../translators/DeepL.py @ line 39-41](../../../../../translators/DeepL.py#L39-L41) - -## *class* **DeeplTranslateException** - -> [Source: ../../../../../translators/DeepL.py @ line 44-51](../../../../../translators/DeepL.py#L44-L51) +## *class* [**DeeplTranslateException**](../../../../../translators/DeepL.py#L44-L51) Default DeepL Translate exception -### *attr* DeeplTranslateException.**error_codes** - -> [Source: ../../../../../translators/DeepL.py @ line 49](../../../../../translators/DeepL.py#L49) - -## *class* **GetClientState** +### *attr* [DeeplTranslateException.**error_codes**](../../../../../translators/DeepL.py#L49) -> [Source: ../../../../../translators/DeepL.py @ line 54-82](../../../../../translators/DeepL.py#L54-L82) +## *class* [**GetClientState**](../../../../../translators/DeepL.py#L54-L82) DeepL Translate state manager -### *func* GetClientState.**dump** - -> [Source: ../../../../../translators/DeepL.py @ line 63-74](../../../../../translators/DeepL.py#L63-L74) +### *func* [GetClientState.**dump**](../../../../../translators/DeepL.py#L63-L74) #### Returns - `dict` -### *func* GetClientState.**get** - -> [Source: ../../../../../translators/DeepL.py @ line 76-82](../../../../../translators/DeepL.py#L76-L82) +### *func* [GetClientState.**get**](../../../../../translators/DeepL.py#L76-L82) Returns a new Client State ID @@ -73,15 +53,11 @@ Returns a new Client State ID - `int` -## *class* **JSONRPCRequest** - -> [Source: ../../../../../translators/DeepL.py @ line 85-121](../../../../../translators/DeepL.py#L85-L121) +## *class* [**JSONRPCRequest**](../../../../../translators/DeepL.py#L85-L121) JSON RPC Request Sender for DeepL -### *func* JSONRPCRequest.**dump** - -> [Source: ../../../../../translators/DeepL.py @ line 99-107](../../../../../translators/DeepL.py#L99-L107) +### *func* [JSONRPCRequest.**dump**](../../../../../translators/DeepL.py#L99-L107) #### Parameters @@ -91,9 +67,7 @@ JSON RPC Request Sender for DeepL - **params**: `dict` -### *func* JSONRPCRequest.**send_jsonrpc** - -> [Source: ../../../../../translators/DeepL.py @ line 109-121](../../../../../translators/DeepL.py#L109-L121) +### *func* [JSONRPCRequest.**send_jsonrpc**](../../../../../translators/DeepL.py#L109-L121) #### Parameters @@ -107,17 +81,13 @@ JSON RPC Request Sender for DeepL - `dict` -## *class* **DeeplTranslateV1** - -> [Source: ../../../../../translators/DeepL.py @ line 124-308](../../../../../translators/DeepL.py#L124-L308) +## *class* [**DeeplTranslateV1**](../../../../../translators/DeepL.py#L124-L308) ### Raises - `exceptions.UnsupportedMethod` -## *class* **DeeplTranslateV2** - -> [Source: ../../../../../translators/DeepL.py @ line 311-386](../../../../../translators/DeepL.py#L311-L386) +## *class* [**DeeplTranslateV2**](../../../../../translators/DeepL.py#L311-L386) ### Raises diff --git a/translatepy/server/docs/jpn/reference/translators/google.md b/translatepy/server/docs/jpn/reference/translators/google.md index 7fa3f0e..957a5ce 100644 --- a/translatepy/server/docs/jpn/reference/translators/google.md +++ b/translatepy/server/docs/jpn/reference/translators/google.md @@ -1,6 +1,6 @@ # *module* **Google** -> [Source: ../../../../../translators/Google.py @ line 0](../../../../../translators/Google.py#L0) +> [Source: ../../../../../translators/Google.py](../../../../../translators/Google.py#L0) Google Translate This both uses the mobile version of Google Translate, extension endpoints and the `batchexecute` (JSONRPC) API @@ -12,17 +12,11 @@ The `batchexecute` implementation is heavily inspired by ssut/py-googletrans#255 - [../../../../../translators/base_aggregator.py](../../../../../translators/base_aggregator.py): As `BaseTranslatorAggregator` -## *const* **DOMAINS** +## *const* [**DOMAINS**](../../../../../translators/Google.py#L21) -> [Source: ../../../../../translators/Google.py @ line 21](../../../../../translators/Google.py#L21) +## *const* [**SUPPORTED_LANGUAGES**](../../../../../translators/Google.py#L58) -## *const* **SUPPORTED_LANGUAGES** - -> [Source: ../../../../../translators/Google.py @ line 58](../../../../../translators/Google.py#L58) - -## *class* **GoogleTranslate** - -> [Source: ../../../../../translators/Google.py @ line 66-81](../../../../../translators/Google.py#L66-L81) +## *class* [**GoogleTranslate**](../../../../../translators/Google.py#L66-L81) An aggregation of Google Translate translators @@ -30,9 +24,7 @@ An aggregation of Google Translate translators - `ServiceURLError` -## *class* **GoogleTranslateV1** - -> [Source: ../../../../../translators/Google.py @ line 84-261](../../../../../translators/Google.py#L84-L261) +## *class* [**GoogleTranslateV1**](../../../../../translators/Google.py#L84-L261) A Python implementation of Google Translate's JSONRPC API @@ -40,8 +32,6 @@ A Python implementation of Google Translate's JSONRPC API - `ValueError` -## *class* **GoogleTranslateV2** - -> [Source: ../../../../../translators/Google.py @ line 264-423](../../../../../translators/Google.py#L264-L423) +## *class* [**GoogleTranslateV2**](../../../../../translators/Google.py#L264-L423) A Python implementation of Google Translate's APIs diff --git a/translatepy/server/docs/jpn/reference/translators/libre.md b/translatepy/server/docs/jpn/reference/translators/libre.md index a70c7a3..531aa89 100644 --- a/translatepy/server/docs/jpn/reference/translators/libre.md +++ b/translatepy/server/docs/jpn/reference/translators/libre.md @@ -1,6 +1,6 @@ # *module* **Libre** -> [Source: ../../../../../translators/Libre.py @ line 0](../../../../../translators/Libre.py#L0) +> [Source: ../../../../../translators/Libre.py](../../../../../translators/Libre.py#L0) LibreTranslate translatepy's implementation of LibreTranslate @@ -13,8 +13,6 @@ translatepy's implementation of LibreTranslate - **Animenosekai** Original author -## *class* **LibreTranslate** - -> [Source: ../../../../../translators/Libre.py @ line 19-43](../../../../../translators/Libre.py#L19-L43) +## *class* [**LibreTranslate**](../../../../../translators/Libre.py#L19-L43) translatepy's implementation of LibreTranslate diff --git a/translatepy/server/docs/jpn/reference/translators/microsoft.md b/translatepy/server/docs/jpn/reference/translators/microsoft.md index 3035dbb..27b8369 100644 --- a/translatepy/server/docs/jpn/reference/translators/microsoft.md +++ b/translatepy/server/docs/jpn/reference/translators/microsoft.md @@ -1,6 +1,6 @@ # *module* **Microsoft** -> [Source: ../../../../../translators/Microsoft.py @ line 0](../../../../../translators/Microsoft.py#L0) +> [Source: ../../../../../translators/Microsoft.py](../../../../../translators/Microsoft.py#L0) This implementation was made specifically for translatepy by 'Zhymabek Roman'. @@ -10,27 +10,19 @@ This implementation was made specifically for translatepy by 'Zhymabek Roman'. - [../../../../../translators/base_aggregator.py](../../../../../translators/base_aggregator.py): As `BaseTranslatorAggregator` -## *class* **MicrosoftTranslate** - -> [Source: ../../../../../translators/Microsoft.py @ line 23-32](../../../../../translators/Microsoft.py#L23-L32) +## *class* [**MicrosoftTranslate**](../../../../../translators/Microsoft.py#L23-L32) An aggregation of Microsoft Translate translators -## *class* **MicrosoftTranslateV1** - -> [Source: ../../../../../translators/Microsoft.py @ line 37-141](../../../../../translators/Microsoft.py#L37-L141) +## *class* [**MicrosoftTranslateV1**](../../../../../translators/Microsoft.py#L37-L141) A Python implementation of Microsoft Translation, reverse engenered from Microsoft Translator Android application. Ported from https://github.com/d4n3436/GTranslate/blob/master/src/GTranslate/Translators/MicrosoftTranslator.cs Huge thanks to d4n3436. -## *class* **MicrosoftTranslateV2** - -> [Source: ../../../../../translators/Microsoft.py @ line 144-187](../../../../../translators/Microsoft.py#L144-L187) +## *class* [**MicrosoftTranslateV2**](../../../../../translators/Microsoft.py#L144-L187) A Python implementation of Microsoft Translation, reverse engenered from Microsoft SwiftKey by ZhymabekRoman Also I found '/v1/languages?scope=translation' endpoint, idk maybe it can be useful -## *class* **MicrosoftTranslateV3** - -> [Source: ../../../../../translators/Microsoft.py @ line 189-254](../../../../../translators/Microsoft.py#L189-L254) +## *class* [**MicrosoftTranslateV3**](../../../../../translators/Microsoft.py#L189-L254) diff --git a/translatepy/server/docs/jpn/reference/translators/mymemory.md b/translatepy/server/docs/jpn/reference/translators/mymemory.md index 30c6836..2f47615 100644 --- a/translatepy/server/docs/jpn/reference/translators/mymemory.md +++ b/translatepy/server/docs/jpn/reference/translators/mymemory.md @@ -1,6 +1,6 @@ # *module* **MyMemory** -> [Source: ../../../../../translators/MyMemory.py @ line 0](../../../../../translators/MyMemory.py#L0) +> [Source: ../../../../../translators/MyMemory.py](../../../../../translators/MyMemory.py#L0) MyMemory translatepy's implementation of MyMemory @@ -9,17 +9,11 @@ translatepy's implementation of MyMemory - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **MyMemoryException** +## *class* [**MyMemoryException**](../../../../../translators/MyMemory.py#L16-L19) -> [Source: ../../../../../translators/MyMemory.py @ line 16-19](../../../../../translators/MyMemory.py#L16-L19) +### *attr* [MyMemoryException.**error_codes**](../../../../../translators/MyMemory.py#L17) -### *attr* MyMemoryException.**error_codes** - -> [Source: ../../../../../translators/MyMemory.py @ line 17](../../../../../translators/MyMemory.py#L17) - -## *class* **MyMemoryTranslate** - -> [Source: ../../../../../translators/MyMemory.py @ line 22-81](../../../../../translators/MyMemory.py#L22-L81) +## *class* [**MyMemoryTranslate**](../../../../../translators/MyMemory.py#L22-L81) translatepy's implementation of MyMemory @@ -27,6 +21,4 @@ translatepy's implementation of MyMemory - `MyMemoryException` -### *attr* MyMemoryTranslate.**base_url** - -> [Source: ../../../../../translators/MyMemory.py @ line 26](../../../../../translators/MyMemory.py#L26) +### *attr* [MyMemoryTranslate.**base_url**](../../../../../translators/MyMemory.py#L26) diff --git a/translatepy/server/docs/jpn/reference/translators/papago.md b/translatepy/server/docs/jpn/reference/translators/papago.md index 1d37221..2101cb5 100644 --- a/translatepy/server/docs/jpn/reference/translators/papago.md +++ b/translatepy/server/docs/jpn/reference/translators/papago.md @@ -1,6 +1,6 @@ # *module* **Papago** -> [Source: ../../../../../translators/Papago.py @ line 0](../../../../../translators/Papago.py#L0) +> [Source: ../../../../../translators/Papago.py](../../../../../translators/Papago.py#L0) translatepy's implementation of @@ -8,45 +8,29 @@ translatepy's implementation of - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **PapagoException** +## *class* [**PapagoException**](../../../../../translators/Papago.py#L18-L21) -> [Source: ../../../../../translators/Papago.py @ line 18-21](../../../../../translators/Papago.py#L18-L21) +### *attr* [PapagoException.**error_codes**](../../../../../translators/Papago.py#L19) -### *attr* PapagoException.**error_codes** - -> [Source: ../../../../../translators/Papago.py @ line 19](../../../../../translators/Papago.py#L19) - -## *class* **PapagoSessionData** - -> [Source: ../../../../../translators/Papago.py @ line 27-31](../../../../../translators/Papago.py#L27-L31) +## *class* [**PapagoSessionData**](../../../../../translators/Papago.py#L27-L31) Bing session data holder -### *attr* PapagoSessionData.**timestamp** - -> [Source: ../../../../../translators/Papago.py @ line 29](../../../../../translators/Papago.py#L29) +### *attr* [PapagoSessionData.**timestamp**](../../../../../translators/Papago.py#L29) > Type: `cain.types.UInt64` -### *attr* PapagoSessionData.**cookies_keys** - -> [Source: ../../../../../translators/Papago.py @ line 30](../../../../../translators/Papago.py#L30) +### *attr* [PapagoSessionData.**cookies_keys**](../../../../../translators/Papago.py#L30) > Type: `List` -### *attr* PapagoSessionData.**cookies_values** - -> [Source: ../../../../../translators/Papago.py @ line 31](../../../../../translators/Papago.py#L31) +### *attr* [PapagoSessionData.**cookies_values**](../../../../../translators/Papago.py#L31) > Type: `List` -## *const* **SESSION_CACHE_EXPIRATION** - -> [Source: ../../../../../translators/Papago.py @ line 34](../../../../../translators/Papago.py#L34) +## *const* [**SESSION_CACHE_EXPIRATION**](../../../../../translators/Papago.py#L34) -## *class* **Papago** - -> [Source: ../../../../../translators/Papago.py @ line 37-262](../../../../../translators/Papago.py#L37-L262) +## *class* [**Papago**](../../../../../translators/Papago.py#L37-L262) translatepy's implementation of @@ -56,9 +40,7 @@ translatepy's implementation of - `exceptions.UnsupportedLanguage` -### *func* Papago.**generate_headers** - -> [Source: ../../../../../translators/Papago.py @ line 83-119](../../../../../translators/Papago.py#L83-L119) +### *func* [Papago.**generate_headers**](../../../../../translators/Papago.py#L83-L119) Generates the headers for the API diff --git a/translatepy/server/docs/jpn/reference/translators/pons.md b/translatepy/server/docs/jpn/reference/translators/pons.md index ac12a21..da0a9e9 100644 --- a/translatepy/server/docs/jpn/reference/translators/pons.md +++ b/translatepy/server/docs/jpn/reference/translators/pons.md @@ -1,6 +1,6 @@ # *module* **PONS** -> [Source: ../../../../../translators/PONS.py @ line 0](../../../../../translators/PONS.py#L0) +> [Source: ../../../../../translators/PONS.py](../../../../../translators/PONS.py#L0) translatepy's implementation of @@ -8,16 +8,10 @@ translatepy's implementation of - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **PONSException** +## *class* [**PONSException**](../../../../../translators/PONS.py#L15-L18) -> [Source: ../../../../../translators/PONS.py @ line 15-18](../../../../../translators/PONS.py#L15-L18) +### *attr* [PONSException.**error_codes**](../../../../../translators/PONS.py#L16) -### *attr* PONSException.**error_codes** - -> [Source: ../../../../../translators/PONS.py @ line 16](../../../../../translators/PONS.py#L16) - -## *class* **PONS** - -> [Source: ../../../../../translators/PONS.py @ line 24-111](../../../../../translators/PONS.py#L24-L111) +## *class* [**PONS**](../../../../../translators/PONS.py#L24-L111) translatepy's implementation of diff --git a/translatepy/server/docs/jpn/reference/translators/qcri.md b/translatepy/server/docs/jpn/reference/translators/qcri.md index 725633a..5abe0b2 100644 --- a/translatepy/server/docs/jpn/reference/translators/qcri.md +++ b/translatepy/server/docs/jpn/reference/translators/qcri.md @@ -1,6 +1,6 @@ # *module* **QCRI** -> [Source: ../../../../../translators/QCRI.py @ line 0](../../../../../translators/QCRI.py#L0) +> [Source: ../../../../../translators/QCRI.py](../../../../../translators/QCRI.py#L0) translatepy's implementation of @@ -8,17 +8,11 @@ translatepy's implementation of - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **QCRIException** +## *class* [**QCRIException**](../../../../../translators/QCRI.py#L16-L19) -> [Source: ../../../../../translators/QCRI.py @ line 16-19](../../../../../translators/QCRI.py#L16-L19) +### *attr* [QCRIException.**error_codes**](../../../../../translators/QCRI.py#L17) -### *attr* QCRIException.**error_codes** - -> [Source: ../../../../../translators/QCRI.py @ line 17](../../../../../translators/QCRI.py#L17) - -## *class* **QCRI** - -> [Source: ../../../../../translators/QCRI.py @ line 25-87](../../../../../translators/QCRI.py#L25-L87) +## *class* [**QCRI**](../../../../../translators/QCRI.py#L25-L87) translatepy's implementation of diff --git a/translatepy/server/docs/jpn/reference/translators/reverso.md b/translatepy/server/docs/jpn/reference/translators/reverso.md index 4b8fc87..a3b7cad 100644 --- a/translatepy/server/docs/jpn/reference/translators/reverso.md +++ b/translatepy/server/docs/jpn/reference/translators/reverso.md @@ -1,6 +1,6 @@ # *module* **Reverso** -> [Source: ../../../../../translators/Reverso.py @ line 0](../../../../../translators/Reverso.py#L0) +> [Source: ../../../../../translators/Reverso.py](../../../../../translators/Reverso.py#L0) Reverso translatepy's implementation of Reverso @@ -9,9 +9,7 @@ translatepy's implementation of Reverso - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslator`, `C` -## *class* **ReversoTranslate** - -> [Source: ../../../../../translators/Reverso.py @ line 16-182](../../../../../translators/Reverso.py#L16-L182) +## *class* [**ReversoTranslate**](../../../../../translators/Reverso.py#L16-L182) A Python implementation of Reverso's API diff --git a/translatepy/server/docs/jpn/reference/translators/translatecom.md b/translatepy/server/docs/jpn/reference/translators/translatecom.md index dc4c3fd..5cba45b 100644 --- a/translatepy/server/docs/jpn/reference/translators/translatecom.md +++ b/translatepy/server/docs/jpn/reference/translators/translatecom.md @@ -1,21 +1,15 @@ # *module* **TranslateCom** -> [Source: ../../../../../translators/TranslateCom.py @ line 0](../../../../../translators/TranslateCom.py#L0) +> [Source: ../../../../../translators/TranslateCom.py](../../../../../translators/TranslateCom.py#L0) ## Imports - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslator`, `C` -## *class* **TranslateComTranslate** - -> [Source: ../../../../../translators/TranslateCom.py @ line 9-44](../../../../../translators/TranslateCom.py#L9-L44) +## *class* [**TranslateComTranslate**](../../../../../translators/TranslateCom.py#L9-L44) translatepy's implementation of translate.com -### *attr* TranslateComTranslate.**translate_url** - -> [Source: ../../../../../translators/TranslateCom.py @ line 14](../../../../../translators/TranslateCom.py#L14) - -### *attr* TranslateComTranslate.**langdetect_url** +### *attr* [TranslateComTranslate.**translate_url**](../../../../../translators/TranslateCom.py#L14) -> [Source: ../../../../../translators/TranslateCom.py @ line 15](../../../../../translators/TranslateCom.py#L15) +### *attr* [TranslateComTranslate.**langdetect_url**](../../../../../translators/TranslateCom.py#L15) diff --git a/translatepy/server/docs/jpn/reference/translators/yandex.md b/translatepy/server/docs/jpn/reference/translators/yandex.md index e3a6c08..8aa08ef 100644 --- a/translatepy/server/docs/jpn/reference/translators/yandex.md +++ b/translatepy/server/docs/jpn/reference/translators/yandex.md @@ -1,6 +1,6 @@ # *module* **Yandex** -> [Source: ../../../../../translators/Yandex.py @ line 0](../../../../../translators/Yandex.py#L0) +> [Source: ../../../../../translators/Yandex.py](../../../../../translators/Yandex.py#L0) Yandex Translate This implementation was made specifically for translatepy from 'Zhymabek Roman', based on 'Anime no Sekai' version. @@ -9,19 +9,13 @@ This implementation was made specifically for translatepy from 'Zhymabek Roman', - [../../../../../translators/base.py](../../../../../translators/base.py): As `BaseTranslateException`, `BaseTranslator`, `C` -## *class* **YandexTranslateException** - -> [Source: ../../../../../translators/Yandex.py @ line 16-31](../../../../../translators/Yandex.py#L16-L31) +## *class* [**YandexTranslateException**](../../../../../translators/Yandex.py#L16-L31) Default Yandex Translate exception -### *attr* YandexTranslateException.**error_codes** - -> [Source: ../../../../../translators/Yandex.py @ line 21](../../../../../translators/Yandex.py#L21) - -## *class* **YandexTranslate** +### *attr* [YandexTranslateException.**error_codes**](../../../../../translators/Yandex.py#L21) -> [Source: ../../../../../translators/Yandex.py @ line 34-205](../../../../../translators/Yandex.py#L34-L205) +## *class* [**YandexTranslate**](../../../../../translators/Yandex.py#L34-L205) Yandex Translation Implementation diff --git a/translatepy/server/docs/jpn/reference/utils/audio.md b/translatepy/server/docs/jpn/reference/utils/audio.md index 8fe473d..803b7b8 100644 --- a/translatepy/server/docs/jpn/reference/utils/audio.md +++ b/translatepy/server/docs/jpn/reference/utils/audio.md @@ -1,6 +1,6 @@ # *module* **audio** -> [Source: ../../../../../utils/audio.py @ line 0](../../../../../utils/audio.py#L0) +> [Source: ../../../../../utils/audio.py](../../../../../utils/audio.py#L0) Handles audio file formats for translatepy @@ -9,27 +9,19 @@ Handles audio file formats for translatepy - **h2non, MIT License** Author of `filetype.py` a Python package to infer binary file types checking the magic numbers signature Most of the source code comes from this package -## *class* **Type** - -> [Source: ../../../../../utils/audio.py @ line 12-22](../../../../../utils/audio.py#L12-L22) +## *class* [**Type**](../../../../../utils/audio.py#L12-L22) Represents an audio format -### *attr* Type.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 16](../../../../../utils/audio.py#L16) +### *attr* [Type.**MIME**](../../../../../utils/audio.py#L16) > Type: `str` -### *attr* Type.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 17](../../../../../utils/audio.py#L17) +### *attr* [Type.**EXTENSION**](../../../../../utils/audio.py#L17) > Type: `str` -### *func* Type.**test** - -> [Source: ../../../../../utils/audio.py @ line 20-22](../../../../../utils/audio.py#L20-L22) +### *func* [Type.**test**](../../../../../utils/audio.py#L20-L22) Tests if the given file matches the audio format @@ -38,193 +30,127 @@ Tests if the given file matches the audio format - **data**: `bytes` -## *class* **MP3** - -> [Source: ../../../../../utils/audio.py @ line 25-42](../../../../../utils/audio.py#L25-L42) +## *class* [**MP3**](../../../../../utils/audio.py#L25-L42) Implements the MP3 audio type matcher. -### *attr* MP3.**MIME** +### *attr* [MP3.**MIME**](../../../../../utils/audio.py#L29) -> [Source: ../../../../../utils/audio.py @ line 29](../../../../../utils/audio.py#L29) +### *attr* [MP3.**EXTENSION**](../../../../../utils/audio.py#L30) -### *attr* MP3.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 30](../../../../../utils/audio.py#L30) - -### *func* MP3.**test** - -> [Source: ../../../../../utils/audio.py @ line 33-42](../../../../../utils/audio.py#L33-L42) +### *func* [MP3.**test**](../../../../../utils/audio.py#L33-L42) #### Parameters - **data**: `bytes` -## *class* **M4A** - -> [Source: ../../../../../utils/audio.py @ line 45-64](../../../../../utils/audio.py#L45-L64) +## *class* [**M4A**](../../../../../utils/audio.py#L45-L64) Implements the M4A audio type matcher. -### *attr* M4A.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 49](../../../../../utils/audio.py#L49) +### *attr* [M4A.**MIME**](../../../../../utils/audio.py#L49) -### *attr* M4A.**EXTENSION** +### *attr* [M4A.**EXTENSION**](../../../../../utils/audio.py#L50) -> [Source: ../../../../../utils/audio.py @ line 50](../../../../../utils/audio.py#L50) - -### *func* M4A.**test** - -> [Source: ../../../../../utils/audio.py @ line 53-64](../../../../../utils/audio.py#L53-L64) +### *func* [M4A.**test**](../../../../../utils/audio.py#L53-L64) #### Parameters - **data**: `bytes` -## *class* **Ogg** - -> [Source: ../../../../../utils/audio.py @ line 67-79](../../../../../utils/audio.py#L67-L79) +## *class* [**Ogg**](../../../../../utils/audio.py#L67-L79) Implements the OGG audio type matcher. -### *attr* Ogg.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 71](../../../../../utils/audio.py#L71) - -### *attr* Ogg.**EXTENSION** +### *attr* [Ogg.**MIME**](../../../../../utils/audio.py#L71) -> [Source: ../../../../../utils/audio.py @ line 72](../../../../../utils/audio.py#L72) +### *attr* [Ogg.**EXTENSION**](../../../../../utils/audio.py#L72) -### *func* Ogg.**test** - -> [Source: ../../../../../utils/audio.py @ line 75-79](../../../../../utils/audio.py#L75-L79) +### *func* [Ogg.**test**](../../../../../utils/audio.py#L75-L79) #### Parameters - **data**: `bytes` -## *class* **Flac** - -> [Source: ../../../../../utils/audio.py @ line 82-94](../../../../../utils/audio.py#L82-L94) +## *class* [**Flac**](../../../../../utils/audio.py#L82-L94) Implements the FLAC audio type matcher. -### *attr* Flac.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 86](../../../../../utils/audio.py#L86) - -### *attr* Flac.**EXTENSION** +### *attr* [Flac.**MIME**](../../../../../utils/audio.py#L86) -> [Source: ../../../../../utils/audio.py @ line 87](../../../../../utils/audio.py#L87) +### *attr* [Flac.**EXTENSION**](../../../../../utils/audio.py#L87) -### *func* Flac.**test** - -> [Source: ../../../../../utils/audio.py @ line 90-94](../../../../../utils/audio.py#L90-L94) +### *func* [Flac.**test**](../../../../../utils/audio.py#L90-L94) #### Parameters - **data**: `bytes` -## *class* **Wav** - -> [Source: ../../../../../utils/audio.py @ line 97-113](../../../../../utils/audio.py#L97-L113) +## *class* [**Wav**](../../../../../utils/audio.py#L97-L113) Implements the WAV audio type matcher. -### *attr* Wav.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 101](../../../../../utils/audio.py#L101) - -### *attr* Wav.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 102](../../../../../utils/audio.py#L102) +### *attr* [Wav.**MIME**](../../../../../utils/audio.py#L101) -### *func* Wav.**test** +### *attr* [Wav.**EXTENSION**](../../../../../utils/audio.py#L102) -> [Source: ../../../../../utils/audio.py @ line 105-113](../../../../../utils/audio.py#L105-L113) +### *func* [Wav.**test**](../../../../../utils/audio.py#L105-L113) #### Parameters - **data**: `bytes` -## *class* **Amr** - -> [Source: ../../../../../utils/audio.py @ line 116-130](../../../../../utils/audio.py#L116-L130) +## *class* [**Amr**](../../../../../utils/audio.py#L116-L130) Implements the AMR audio type matcher. -### *attr* Amr.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 120](../../../../../utils/audio.py#L120) - -### *attr* Amr.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 121](../../../../../utils/audio.py#L121) +### *attr* [Amr.**MIME**](../../../../../utils/audio.py#L120) -### *func* Amr.**test** +### *attr* [Amr.**EXTENSION**](../../../../../utils/audio.py#L121) -> [Source: ../../../../../utils/audio.py @ line 124-130](../../../../../utils/audio.py#L124-L130) +### *func* [Amr.**test**](../../../../../utils/audio.py#L124-L130) #### Parameters - **data**: `bytes` -## *class* **Aac** - -> [Source: ../../../../../utils/audio.py @ line 133-142](../../../../../utils/audio.py#L133-L142) +## *class* [**Aac**](../../../../../utils/audio.py#L133-L142) Implements the Aac audio type matcher. -### *attr* Aac.**MIME** - -> [Source: ../../../../../utils/audio.py @ line 136](../../../../../utils/audio.py#L136) - -### *attr* Aac.**EXTENSION** +### *attr* [Aac.**MIME**](../../../../../utils/audio.py#L136) -> [Source: ../../../../../utils/audio.py @ line 137](../../../../../utils/audio.py#L137) +### *attr* [Aac.**EXTENSION**](../../../../../utils/audio.py#L137) -### *func* Aac.**test** - -> [Source: ../../../../../utils/audio.py @ line 140-142](../../../../../utils/audio.py#L140-L142) +### *func* [Aac.**test**](../../../../../utils/audio.py#L140-L142) #### Parameters - **data**: `bytes` -## *class* **Aiff** - -> [Source: ../../../../../utils/audio.py @ line 145-161](../../../../../utils/audio.py#L145-L161) +## *class* [**Aiff**](../../../../../utils/audio.py#L145-L161) Implements the AIFF audio type matcher. -### *attr* Aiff.**MIME** +### *attr* [Aiff.**MIME**](../../../../../utils/audio.py#L149) -> [Source: ../../../../../utils/audio.py @ line 149](../../../../../utils/audio.py#L149) +### *attr* [Aiff.**EXTENSION**](../../../../../utils/audio.py#L150) -### *attr* Aiff.**EXTENSION** - -> [Source: ../../../../../utils/audio.py @ line 150](../../../../../utils/audio.py#L150) - -### *func* Aiff.**test** - -> [Source: ../../../../../utils/audio.py @ line 153-161](../../../../../utils/audio.py#L153-L161) +### *func* [Aiff.**test**](../../../../../utils/audio.py#L153-L161) #### Parameters - **data**: `bytes` -## *func* **get_type** - -> [Source: ../../../../../utils/audio.py @ line 164-181](../../../../../utils/audio.py#L164-L181) +## *func* [**get_type**](../../../../../utils/audio.py#L164-L181) Returns the audio format of the given buffer diff --git a/translatepy/server/docs/jpn/reference/utils/gtoken.md b/translatepy/server/docs/jpn/reference/utils/gtoken.md index e0e318d..556e43f 100644 --- a/translatepy/server/docs/jpn/reference/utils/gtoken.md +++ b/translatepy/server/docs/jpn/reference/utils/gtoken.md @@ -1,6 +1,6 @@ # *module* **gtoken** -> [Source: ../../../../../utils/gtoken.py @ line 0](../../../../../utils/gtoken.py#L0) +> [Source: ../../../../../utils/gtoken.py](../../../../../utils/gtoken.py#L0) ORIGINAL FILENAME: gtoken.py @@ -33,13 +33,9 @@ LICENSE: OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -## *const* **HEADERS** +## *const* [**HEADERS**](../../../../../utils/gtoken.py#L45) -> [Source: ../../../../../utils/gtoken.py @ line 45](../../../../../utils/gtoken.py#L45) - -## *class* **TokenAcquirer** - -> [Source: ../../../../../utils/gtoken.py @ line 56-244](../../../../../utils/gtoken.py#L56-L244) +## *class* [**TokenAcquirer**](../../../../../utils/gtoken.py#L56-L244) Google Translate API token generator translate.google.com uses a token to authorize the requests. If you are @@ -65,26 +61,18 @@ Example usage: - `Exception` -### *attr* TokenAcquirer.**RE_TKK** - -> [Source: ../../../../../utils/gtoken.py @ line 82](../../../../../utils/gtoken.py#L82) +### *attr* [TokenAcquirer.**RE_TKK**](../../../../../utils/gtoken.py#L82) -### *attr* TokenAcquirer.**RE_RAWTKK** +### *attr* [TokenAcquirer.**RE_RAWTKK**](../../../../../utils/gtoken.py#L83) -> [Source: ../../../../../utils/gtoken.py @ line 83](../../../../../utils/gtoken.py#L83) - -### *func* TokenAcquirer.**acquire** - -> [Source: ../../../../../utils/gtoken.py @ line 185-239](../../../../../utils/gtoken.py#L185-L239) +### *func* [TokenAcquirer.**acquire**](../../../../../utils/gtoken.py#L185-L239) #### Parameters - **text** -### *func* TokenAcquirer.**do** - -> [Source: ../../../../../utils/gtoken.py @ line 241-244](../../../../../utils/gtoken.py#L241-L244) +### *func* [TokenAcquirer.**do**](../../../../../utils/gtoken.py#L241-L244) #### Parameters diff --git a/translatepy/server/docs/jpn/reference/utils/hasher.md b/translatepy/server/docs/jpn/reference/utils/hasher.md index e171be6..1cee5fe 100644 --- a/translatepy/server/docs/jpn/reference/utils/hasher.md +++ b/translatepy/server/docs/jpn/reference/utils/hasher.md @@ -1,13 +1,11 @@ # *module* **hasher** -> [Source: ../../../../../utils/hasher.py @ line 0](../../../../../utils/hasher.py#L0) +> [Source: ../../../../../utils/hasher.py](../../../../../utils/hasher.py#L0) utils/hasher.py Utility to hash different kind of objects -## *func* **sha256** - -> [Source: ../../../../../utils/hasher.py @ line 11-28](../../../../../utils/hasher.py#L11-L28) +## *func* [**sha256**](../../../../../utils/hasher.py#L11-L28) Hashes the given content using SHA-256 and returns its hexadecimal version @@ -22,9 +20,7 @@ Hashes the given content using SHA-256 and returns its hexadecimal version - `str` - The SHA-256 hash -## *func* **hash_object** - -> [Source: ../../../../../utils/hasher.py @ line 31-48](../../../../../utils/hasher.py#L31-L48) +## *func* [**hash_object**](../../../../../utils/hasher.py#L31-L48) Hashes a given object @@ -38,9 +34,7 @@ Hashes a given object - `str` - The hash of the object -## *func* **hash_request** - -> [Source: ../../../../../utils/hasher.py @ line 51-82](../../../../../utils/hasher.py#L51-L82) +## *func* [**hash_request**](../../../../../utils/hasher.py#L51-L82) Hashes the given request. diff --git a/translatepy/server/docs/jpn/reference/utils/importer.md b/translatepy/server/docs/jpn/reference/utils/importer.md index 7db2bec..009cc5d 100644 --- a/translatepy/server/docs/jpn/reference/utils/importer.md +++ b/translatepy/server/docs/jpn/reference/utils/importer.md @@ -1,6 +1,6 @@ # *module* **importer** -> [Source: ../../../../../utils/importer.py @ line 0](../../../../../utils/importer.py#L0) +> [Source: ../../../../../utils/importer.py](../../../../../utils/importer.py#L0) importer.py A module to allow for dynamic importing of translators. @@ -11,25 +11,15 @@ A module to allow for dynamic importing of translators. - [../../../../../utils/vectorize.py](../../../../../utils/vectorize.py): As `vectorize` -## *const* **IMPORTER_CACHE** +## *const* [**IMPORTER_CACHE**](../../../../../utils/importer.py#L18) -> [Source: ../../../../../utils/importer.py @ line 18](../../../../../utils/importer.py#L18) +## *const* [**IMPORTER_DATA_DIR**](../../../../../utils/importer.py#L20) -## *const* **IMPORTER_DATA_DIR** +## *const* [**IMPORTER_DATA_FILE**](../../../../../utils/importer.py#L21) -> [Source: ../../../../../utils/importer.py @ line 20](../../../../../utils/importer.py#L20) +## *const* [**NAMED_TRANSLATORS**](../../../../../utils/importer.py#L27) -## *const* **IMPORTER_DATA_FILE** - -> [Source: ../../../../../utils/importer.py @ line 21](../../../../../utils/importer.py#L21) - -## *const* **NAMED_TRANSLATORS** - -> [Source: ../../../../../utils/importer.py @ line 27](../../../../../utils/importer.py#L27) - -## *func* **translator_from_name** - -> [Source: ../../../../../utils/importer.py @ line 37-42](../../../../../utils/importer.py#L37-L42) +## *func* [**translator_from_name**](../../../../../utils/importer.py#L37-L42) Retrieves the given translate from its name @@ -46,9 +36,7 @@ Retrieves the given translate from its name - `ValueError` -## *func* **translator_from_path** - -> [Source: ../../../../../utils/importer.py @ line 45-55](../../../../../utils/importer.py#L45-L55) +## *func* [**translator_from_path**](../../../../../utils/importer.py#L45-L55) Returns a translator from its dot path @@ -69,9 +57,7 @@ Returns a translator from its dot path - `ImportError` -## *func* **get_translator** - -> [Source: ../../../../../utils/importer.py @ line 58-94](../../../../../utils/importer.py#L58-L94) +## *func* [**get_translator**](../../../../../utils/importer.py#L58-L94) Searches the given translator diff --git a/translatepy/server/docs/jpn/reference/utils/lru.md b/translatepy/server/docs/jpn/reference/utils/lru.md index 237da12..f061169 100644 --- a/translatepy/server/docs/jpn/reference/utils/lru.md +++ b/translatepy/server/docs/jpn/reference/utils/lru.md @@ -1,31 +1,21 @@ # *module* **lru** -> [Source: ../../../../../utils/lru.py @ line 0](../../../../../utils/lru.py#L0) +> [Source: ../../../../../utils/lru.py](../../../../../utils/lru.py#L0) lru.py LRU cache implementation for the translatepy project. -## *const* **logger** +## *const* [**logger**](../../../../../utils/lru.py#L16) -> [Source: ../../../../../utils/lru.py @ line 16](../../../../../utils/lru.py#L16) +## *class* [**LRUDictCache**](../../../../../utils/lru.py#L19-L38) -## *class* **LRUDictCache** +### *func* [LRUDictCache.**clear**](../../../../../utils/lru.py#L37-L38) -> [Source: ../../../../../utils/lru.py @ line 19-38](../../../../../utils/lru.py#L19-L38) - -### *func* LRUDictCache.**clear** - -> [Source: ../../../../../utils/lru.py @ line 37-38](../../../../../utils/lru.py#L37-L38) - -## *class* **SizeLimitedLRUCache** - -> [Source: ../../../../../utils/lru.py @ line 41-173](../../../../../utils/lru.py#L41-L173) +## *class* [**SizeLimitedLRUCache**](../../../../../utils/lru.py#L41-L173) Special implementation of a size limited LRU cache. -### *func* SizeLimitedLRUCache.**get_size** - -> [Source: ../../../../../utils/lru.py @ line 135-170](../../../../../utils/lru.py#L135-L170) +### *func* [SizeLimitedLRUCache.**get_size**](../../../../../utils/lru.py#L135-L170) Get the size of an object. @@ -50,13 +40,9 @@ This function is faster than the custom implementation but might yield inaccurat > The second implementation of this function is based on the following article: https://towardsdatascience.com/the-strange-size-of-python-objects-in-memory-ce87bdfbb97f -### *func* SizeLimitedLRUCache.**clear** - -> [Source: ../../../../../utils/lru.py @ line 172-173](../../../../../utils/lru.py#L172-L173) - -## *func* **timed_lru_cache** +### *func* [SizeLimitedLRUCache.**clear**](../../../../../utils/lru.py#L172-L173) -> [Source: ../../../../../utils/lru.py @ line 176-198](../../../../../utils/lru.py#L176-L198) +## *func* [**timed_lru_cache**](../../../../../utils/lru.py#L176-L198) ### Parameters diff --git a/translatepy/server/docs/jpn/reference/utils/queue.md b/translatepy/server/docs/jpn/reference/utils/queue.md index 1ef378e..b42be00 100644 --- a/translatepy/server/docs/jpn/reference/utils/queue.md +++ b/translatepy/server/docs/jpn/reference/utils/queue.md @@ -1,18 +1,14 @@ # *module* **queue** -> [Source: ../../../../../utils/queue.py @ line 0](../../../../../utils/queue.py#L0) +> [Source: ../../../../../utils/queue.py](../../../../../utils/queue.py#L0) -## *class* **Queue** - -> [Source: ../../../../../utils/queue.py @ line 6-32](../../../../../utils/queue.py#L6-L32) +## *class* [**Queue**](../../../../../utils/queue.py#L6-L32) ### Raises - `ValueError` -### *func* Queue.**get** - -> [Source: ../../../../../utils/queue.py @ line 16-32](../../../../../utils/queue.py#L16-L32) +### *func* [Queue.**get**](../../../../../utils/queue.py#L16-L32) Remove and return an item from the queue. It waits for a value or the termination of all threads diff --git a/translatepy/server/docs/jpn/reference/utils/request.md b/translatepy/server/docs/jpn/reference/utils/request.md index cb5f713..21988c1 100644 --- a/translatepy/server/docs/jpn/reference/utils/request.md +++ b/translatepy/server/docs/jpn/reference/utils/request.md @@ -1,6 +1,6 @@ # *module* **request** -> [Source: ../../../../../utils/request.py @ line 0](../../../../../utils/request.py#L0) +> [Source: ../../../../../utils/request.py](../../../../../utils/request.py#L0) utils/request Extending python requests functionalities with translatepy's own implementation of proxies, caching, exceptions, etc. @@ -13,29 +13,19 @@ Extending python requests functionalities with translatepy's own implementation - **Animenosekai** Original author -## *const* **RequestHash** +## *const* [**RequestHash**](../../../../../utils/request.py#L24) -> [Source: ../../../../../utils/request.py @ line 24](../../../../../utils/request.py#L24) +## *const* [**RateLimitLock**](../../../../../utils/request.py#L27) -## *const* **RateLimitLock** +## *const* [**CacheLock**](../../../../../utils/request.py#L28) -> [Source: ../../../../../utils/request.py @ line 27](../../../../../utils/request.py#L27) - -## *const* **CacheLock** - -> [Source: ../../../../../utils/request.py @ line 28](../../../../../utils/request.py#L28) - -## *class* **Session** - -> [Source: ../../../../../utils/request.py @ line 32-225](../../../../../utils/request.py#L32-L225) +## *class* [**Session**](../../../../../utils/request.py#L32-L225) ### Raises - `exceptions.RateLimitPrevention` -### *func* Session.**set_http_proxy** - -> [Source: ../../../../../utils/request.py @ line 52-64](../../../../../utils/request.py#L52-L64) +### *func* [Session.**set_http_proxy**](../../../../../utils/request.py#L52-L64) Sets the HTTP proxy to use. @@ -45,9 +35,7 @@ Sets the HTTP proxy to use. - The HTTP proxy to use. -### *func* Session.**add_http_proxy** - -> [Source: ../../../../../utils/request.py @ line 66-75](../../../../../utils/request.py#L66-L75) +### *func* [Session.**add_http_proxy**](../../../../../utils/request.py#L66-L75) Adds a HTTP proxy to the list of proxies to use. @@ -57,9 +45,7 @@ Adds a HTTP proxy to the list of proxies to use. - The HTTP proxy to add. -### *func* Session.**request** - -> [Source: ../../../../../utils/request.py @ line 77-215](../../../../../utils/request.py#L77-L215) +### *func* [Session.**request**](../../../../../utils/request.py#L77-L215) Make an HTTP request with the provided method. @@ -203,9 +189,7 @@ If None, the default_cache_duration attribute will be used. ``` -### *func* Session.**invalidate** - -> [Source: ../../../../../utils/request.py @ line 217-225](../../../../../utils/request.py#L217-L225) +### *func* [Session.**invalidate**](../../../../../utils/request.py#L217-L225) Invalidates the given request cache. @@ -214,13 +198,9 @@ Invalidates the given request cache. - **hash**: `RequestHash`, `requesthash` -## *const* **SharedSession** - -> [Source: ../../../../../utils/request.py @ line 228](../../../../../utils/request.py#L228) +## *const* [**SharedSession**](../../../../../utils/request.py#L228) -## *func* **request** - -> [Source: ../../../../../utils/request.py @ line 231-268](../../../../../utils/request.py#L231-L268) +## *func* [**request**](../../../../../utils/request.py#L231-L268) Make an HTTP request. @@ -315,9 +295,7 @@ Make an HTTP request. > **Note** > Look at Session.request for more information. -## *func* **get** - -> [Source: ../../../../../utils/request.py @ line 271-300](../../../../../utils/request.py#L271-L300) +## *func* [**get**](../../../../../utils/request.py#L271-L300) Make a GET request. @@ -405,9 +383,7 @@ Make a GET request. > **Note** > Look at Session.request for more information. -## *func* **post** - -> [Source: ../../../../../utils/request.py @ line 303-332](../../../../../utils/request.py#L303-L332) +## *func* [**post**](../../../../../utils/request.py#L303-L332) Make a POST request. @@ -495,9 +471,7 @@ Make a POST request. > **Note** > Look at Session.request for more information. -## *func* **put** - -> [Source: ../../../../../utils/request.py @ line 335-364](../../../../../utils/request.py#L335-L364) +## *func* [**put**](../../../../../utils/request.py#L335-L364) Make a PUT request. @@ -585,9 +559,7 @@ Make a PUT request. > **Note** > Look at Session.request for more information. -## *func* **patch** - -> [Source: ../../../../../utils/request.py @ line 367-396](../../../../../utils/request.py#L367-L396) +## *func* [**patch**](../../../../../utils/request.py#L367-L396) Make a PATCH request. @@ -675,9 +647,7 @@ Make a PATCH request. > **Note** > Look at Session.request for more information. -## *func* **delete** - -> [Source: ../../../../../utils/request.py @ line 399-428](../../../../../utils/request.py#L399-L428) +## *func* [**delete**](../../../../../utils/request.py#L399-L428) Make a DELETE request. @@ -765,9 +735,7 @@ Make a DELETE request. > **Note** > Look at Session.request for more information. -## *func* **head** - -> [Source: ../../../../../utils/request.py @ line 431-460](../../../../../utils/request.py#L431-L460) +## *func* [**head**](../../../../../utils/request.py#L431-L460) Make a HEAD request. @@ -855,9 +823,7 @@ Make a HEAD request. > **Note** > Look at Session.request for more information. -## *func* **options** - -> [Source: ../../../../../utils/request.py @ line 463-492](../../../../../utils/request.py#L463-L492) +## *func* [**options**](../../../../../utils/request.py#L463-L492) Make an OPTIONS request. diff --git a/translatepy/server/docs/jpn/reference/utils/sanitize.md b/translatepy/server/docs/jpn/reference/utils/sanitize.md index c058776..19cb339 100644 --- a/translatepy/server/docs/jpn/reference/utils/sanitize.md +++ b/translatepy/server/docs/jpn/reference/utils/sanitize.md @@ -1,14 +1,10 @@ # *module* **sanitize** -> [Source: ../../../../../utils/sanitize.py @ line 0](../../../../../utils/sanitize.py#L0) +> [Source: ../../../../../utils/sanitize.py](../../../../../utils/sanitize.py#L0) -## *const* **WHITESPACES** +## *const* [**WHITESPACES**](../../../../../utils/sanitize.py#L3) -> [Source: ../../../../../utils/sanitize.py @ line 3](../../../../../utils/sanitize.py#L3) - -## *func* **remove_spaces** - -> [Source: ../../../../../utils/sanitize.py @ line 8-15](../../../../../utils/sanitize.py#L8-L15) +## *func* [**remove_spaces**](../../../../../utils/sanitize.py#L8-L15) Removes all whitespaces from the given string diff --git a/translatepy/server/docs/jpn/reference/utils/utils.md b/translatepy/server/docs/jpn/reference/utils/utils.md index 626ac8b..a3f841d 100644 --- a/translatepy/server/docs/jpn/reference/utils/utils.md +++ b/translatepy/server/docs/jpn/reference/utils/utils.md @@ -1,14 +1,10 @@ # *module* **utils** -> [Source: ../../../../../utils/utils.py @ line 0](../../../../../utils/utils.py#L0) +> [Source: ../../../../../utils/utils.py](../../../../../utils/utils.py#L0) -## *const* **POSITIVE_FLOAT_REGEX** +## *const* [**POSITIVE_FLOAT_REGEX**](../../../../../utils/utils.py#L3) -> [Source: ../../../../../utils/utils.py @ line 3](../../../../../utils/utils.py#L3) - -## *func* **convert_to_float** - -> [Source: ../../../../../utils/utils.py @ line 6-13](../../../../../utils/utils.py#L6-L13) +## *func* [**convert_to_float**](../../../../../utils/utils.py#L6-L13) Safely converts anything to a positive float diff --git a/translatepy/server/docs/jpn/reference/utils/vectorize.md b/translatepy/server/docs/jpn/reference/utils/vectorize.md index 9245e3a..eb82996 100644 --- a/translatepy/server/docs/jpn/reference/utils/vectorize.md +++ b/translatepy/server/docs/jpn/reference/utils/vectorize.md @@ -1,6 +1,6 @@ # *module* **vectorize** -> [Source: ../../../../../utils/vectorize.py @ line 0](../../../../../utils/vectorize.py#L0) +> [Source: ../../../../../utils/vectorize.py](../../../../../utils/vectorize.py#L0) Handles vectors @@ -8,13 +8,9 @@ Handles vectors - [../../../../../utils/sanitize.py](../../../../../utils/sanitize.py): As `sanitize` -## *const* **CLEANUP_REGEX** +## *const* [**CLEANUP_REGEX**](../../../../../utils/vectorize.py#L12) -> [Source: ../../../../../utils/vectorize.py @ line 12](../../../../../utils/vectorize.py#L12) - -## *func* **string_preprocessing** - -> [Source: ../../../../../utils/vectorize.py @ line 15-17](../../../../../utils/vectorize.py#L15-L17) +## *func* [**string_preprocessing**](../../../../../utils/vectorize.py#L15-L17) internal function to preprocess the given string for fuzzy search @@ -27,49 +23,33 @@ internal function to preprocess the given string for fuzzy search - `str` -## *class* **Vector** - -> [Source: ../../../../../utils/vectorize.py @ line 20-34](../../../../../utils/vectorize.py#L20-L34) +## *class* [**Vector**](../../../../../utils/vectorize.py#L20-L34) A string vector -### *attr* Vector.**id** - -> [Source: ../../../../../utils/vectorize.py @ line 22](../../../../../utils/vectorize.py#L22) +### *attr* [Vector.**id**](../../../../../utils/vectorize.py#L22) > Type: `str` -### *attr* Vector.**string** - -> [Source: ../../../../../utils/vectorize.py @ line 23](../../../../../utils/vectorize.py#L23) +### *attr* [Vector.**string**](../../../../../utils/vectorize.py#L23) > Type: `str` -### *attr* Vector.**value** - -> [Source: ../../../../../utils/vectorize.py @ line 24](../../../../../utils/vectorize.py#L24) +### *attr* [Vector.**value**](../../../../../utils/vectorize.py#L24) > Type: `float` -### *property* Vector.**counter** - -> [Source: ../../../../../utils/vectorize.py @ line 27-29](../../../../../utils/vectorize.py#L27-L29) +### *property* [Vector.**counter**](../../../../../utils/vectorize.py#L27-L29) Returns a counter for the vector -### *property* Vector.**set** - -> [Source: ../../../../../utils/vectorize.py @ line 32-34](../../../../../utils/vectorize.py#L32-L34) +### *property* [Vector.**set**](../../../../../utils/vectorize.py#L32-L34) Returns a set for the vector -## *const* **A** - -> [Source: ../../../../../utils/vectorize.py @ line 36](../../../../../utils/vectorize.py#L36) +## *const* [**A**](../../../../../utils/vectorize.py#L36) -## *func* **vectorize** - -> [Source: ../../../../../utils/vectorize.py @ line 38-45](../../../../../utils/vectorize.py#L38-L45) +## *func* [**vectorize**](../../../../../utils/vectorize.py#L38-L45) Vectorizes the given string @@ -81,31 +61,23 @@ Vectorizes the given string - **string**: `str` -## *class* **SearchResult** - -> [Source: ../../../../../utils/vectorize.py @ line 49-54](../../../../../utils/vectorize.py#L49-L54) +## *class* [**SearchResult**](../../../../../utils/vectorize.py#L49-L54) A result from the `search` function -### *attr* SearchResult.**vector** - -> [Source: ../../../../../utils/vectorize.py @ line 51](../../../../../utils/vectorize.py#L51) +### *attr* [SearchResult.**vector**](../../../../../utils/vectorize.py#L51) > Type: `Vector` The actual vector -### *attr* SearchResult.**similarity** - -> [Source: ../../../../../utils/vectorize.py @ line 53](../../../../../utils/vectorize.py#L53) +### *attr* [SearchResult.**similarity**](../../../../../utils/vectorize.py#L53) > Type: `float` The similarity with the search query -## *func* **search** - -> [Source: ../../../../../utils/vectorize.py @ line 57-70](../../../../../utils/vectorize.py#L57-L70) +## *func* [**search**](../../../../../utils/vectorize.py#L57-L70) Searches `query` through `data` diff --git a/translatepy/server/docs/jpn/server/Postman/Language.postman_collection.utils.json b/translatepy/server/docs/jpn/server/Postman/Language.postman_collection.utils.json index 2caa280..6bc64be 100644 --- a/translatepy/server/docs/jpn/server/Postman/Language.postman_collection.utils.json +++ b/translatepy/server/docs/jpn/server/Postman/Language.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Language","description":"translatepy APIインターフェイスでの「Language」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file +{"info":{"name":"Language","description":"translatepy APIインターフェイスでの「Language」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"__language__","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/{{string:language}}?=","host":["{{DOMAIN}}"],"path":["api","language","{{string:language}}"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L17)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"search","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/language/search?=","host":["{{DOMAIN}}"],"path":["api","language","search"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/language.py](../../../../translatepy/server/endpoints/api/language.py#L22)\n\nThis represents a non implemented endpoint\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `languages` | The language search results | | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"languages\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file diff --git a/translatepy/server/docs/jpn/server/Postman/Work.postman_collection.utils.json b/translatepy/server/docs/jpn/server/Postman/Work.postman_collection.utils.json index f127135..f87ac3c 100644 --- a/translatepy/server/docs/jpn/server/Postman/Work.postman_collection.utils.json +++ b/translatepy/server/docs/jpn/server/Postman/Work.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Work","description":"translatepy APIインターフェイスでの「Work」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `translation` | The translation result | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `translation` | The translation result | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"service\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"translation\": \"no example\"\n }\n}\n"}]},{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `transliteration` | The transliteration result | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `transliteration` | The transliteration result | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"transliteration\": \"no example\"\n }\n}\n"}]},{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `corrected` | The corrected text | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `corrected` | The corrected text | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"corrected\": \"no example\"\n }\n}\n"}]},{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | いいえ |\n| `example` | The example | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `positions` | The positions of the word in the example | list[int] | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | いいえ |\n| `example` | The example | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `positions` | The positions of the word in the example | list[int] | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"reference\": \"no example\",\n \"example\": \"no example\",\n \"source_lang\": \"no example\",\n \"positions\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `meaning` | The meaning of the text | string | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `meaning` | The meaning of the text | string | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true,\n \"source\": \"no example\",\n \"service\": \"no example\"\n }\n}\n"}]},{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `extension` | Returns the audio file extension | Optional[str] | いいえ |\n| `result` | Text to speech result | bytes | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `gender` | Gender of the 'person' saying the text | Gender | いいえ |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | いいえ |\n| `speed` | Speed of the text to speech result | int | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `source_lang` | The source text's language | Language | いいえ |\n| `extension` | Returns the audio file extension | Optional[str] | いいえ |\n| `result` | Text to speech result | bytes | いいえ |\n| `source` | The source text | string | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `gender` | Gender of the 'person' saying the text | Gender | いいえ |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | いいえ |\n| `speed` | Speed of the text to speech result | int | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"source_lang\": \"no example\",\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"service\": \"no example\",\n \"gender\": \"no example\",\n \"mime_type\": \"no example\",\n \"speed\": 4\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file +{"info":{"name":"Work","description":"translatepy APIインターフェイスでの「Work」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `translation` | The translation result | string | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate?=translators","host":["{{DOMAIN}}"],"path":["api","translate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L113)\n\nTranslates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `translation` | The translation result | string | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"translation\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]},{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"translate_html","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/translate/html?=translators","host":["{{DOMAIN}}"],"path":["api","translate","html"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L121)\n\nTranslates the HTML in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n"}]},{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"stream","event":[],"request":{"method":"*","header":[],"url":{"raw":"{{DOMAIN}}/api/stream?=","host":["{{DOMAIN}}"],"path":["api","stream"],"query":[]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L133)\n\nStreams all translations available using the different translators\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {}\n}\n"}]},{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `transliteration` | The transliteration result | string | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/transliterate?=translators","host":["{{DOMAIN}}"],"path":["api","transliterate"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L186)\n\nTransliterates the text in the given language\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `transliteration` | The transliteration result | string | いいえ |\n| `dest_lang` | The result's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"transliteration\": \"no example\",\n \"dest_lang\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]},{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `corrected` | The corrected text | string | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/spellcheck?=translators","host":["{{DOMAIN}}"],"path":["api","spellcheck"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L194)\n\nSpellchecks the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `corrected` | The corrected text | string | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"corrected\": \"no example\",\n \"rich\": true\n }\n}\n"}]},{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/language?=translators","host":["{{DOMAIN}}"],"path":["api","language"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L202)\n\nRetrieves the language of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\"\n }\n}\n"}]},{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `example` | The example | string | いいえ |\n| `positions` | The positions of the word in the example | list[int] | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"example","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/example?=translators","host":["{{DOMAIN}}"],"path":["api","example"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L210)\n\nFinds examples for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | いいえ |\n| `source` | The source text | string | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `example` | The example | string | いいえ |\n| `positions` | The positions of the word in the example | list[int] | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"reference\": \"no example\",\n \"source\": \"no example\",\n \"source_lang\": \"no example\",\n \"example\": \"no example\",\n \"positions\": \"no example\"\n }\n}\n"}]},{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `meaning` | The meaning of the text | string | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"dictionary","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/dictionary?=translators","host":["{{DOMAIN}}"],"path":["api","dictionary"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L218)\n\nRetrieves meanings for the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The service which returned the result | Translator | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n| `source` | The source text | string | いいえ |\n| `meaning` | The meaning of the text | string | いいえ |\n| `rich` | Whether the given result features the full range of information | bool | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"service\": \"no example\",\n \"source_lang\": \"no example\",\n \"source\": \"no example\",\n \"meaning\": \"no example\",\n \"rich\": true\n }\n}\n"}]},{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `extension` | Returns the audio file extension | Optional[str] | いいえ |\n| `result` | Text to speech result | bytes | いいえ |\n| `source` | The source text | string | いいえ |\n| `speed` | Speed of the text to speech result | int | いいえ |\n| `gender` | Gender of the 'person' saying the text | Gender | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"tts","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/api/tts?=translators","host":["{{DOMAIN}}"],"path":["api","tts"],"query":[{"key":"translators","value":"","description":"A comma-separated list of translators to use"}]},"description":"\n> [../../translatepy/server/endpoints/api/_.py](../../../../translatepy/server/endpoints/api/_.py#L226)\n\nReturns the speech version of the given text\n\n\n### 認証\n\nログインは**不要**です\n\n### レスポンス\n\n#### レスポンスの例\n\n```json\n{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `extension` | Returns the audio file extension | Optional[str] | いいえ |\n| `result` | Text to speech result | bytes | いいえ |\n| `source` | The source text | string | いいえ |\n| `speed` | Speed of the text to speech result | int | いいえ |\n| `gender` | Gender of the 'person' saying the text | Gender | いいえ |\n| `service` | The service which returned the result | Translator | いいえ |\n| `mime_type` | Returns the MIME type of the audio file | Optional[str] | いいえ |\n| `source_lang` | The source text's language | Language | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)"},"response":[],"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"body":"{\n \"success\": true,\n \"message\": \"Successfully processed your request\",\n \"error\": null,\n \"data\": {\n \"extension\": \"no example\",\n \"result\": \"no example\",\n \"source\": \"no example\",\n \"speed\": 4,\n \"gender\": \"no example\",\n \"service\": \"no example\",\n \"mime_type\": \"no example\",\n \"source_lang\": \"no example\"\n }\n}\n"}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{TRANSLATEPY_TOKEN}}","type":"string"},{"key":"key","value":"Authorization","type":"string"}]}} \ No newline at end of file diff --git "a/translatepy/server/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Language.md" "b/translatepy/server/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Language.md" index bbb874a..a52a88e 100644 --- "a/translatepy/server/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Language.md" +++ "b/translatepy/server/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Language.md" @@ -84,8 +84,8 @@ print(r.json()["data"]) | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | | `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # search @@ -185,6 +185,6 @@ print(r.json()["data"]) | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | | `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) \ No newline at end of file diff --git "a/translatepy/server/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Work.md" "b/translatepy/server/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Work.md" index b435aeb..6e975d2 100644 --- "a/translatepy/server/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Work.md" +++ "b/translatepy/server/docs/jpn/server/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Work.md" @@ -92,11 +92,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", "service": "no example", + "translation": "no example", "dest_lang": "no example", "source": "no example", - "translation": "no example" + "source_lang": "no example" } } @@ -106,20 +106,20 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | いいえ | | `service` | The service which returned the result | Translator | いいえ | +| `translation` | The translation result | string | いいえ | | `dest_lang` | The result's language | Language | いいえ | | `source` | The source text | string | いいえ | -| `translation` | The translation result | string | いいえ | +| `source_lang` | The source text's language | Language | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # translate_html @@ -211,9 +211,9 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "source": "no example", - "service": "no example" + "source": "no example" } } @@ -223,18 +223,18 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | いいえ | | `source_lang` | The source text's language | Language | いいえ | | `source` | The source text | string | いいえ | -| `service` | The service which returned the result | Translator | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # stream @@ -312,10 +312,10 @@ print(r.json()["data"]) | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # transliterate @@ -407,11 +407,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", + "service": "no example", + "transliteration": "no example", "dest_lang": "no example", "source": "no example", - "service": "no example", - "transliteration": "no example" + "source_lang": "no example" } } @@ -421,20 +421,20 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | いいえ | -| `dest_lang` | The result's language | Language | いいえ | -| `source` | The source text | string | いいえ | | `service` | The service which returned the result | Translator | いいえ | | `transliteration` | The transliteration result | string | いいえ | +| `dest_lang` | The result's language | Language | いいえ | +| `source` | The source text | string | いいえ | +| `source_lang` | The source text's language | Language | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # spellcheck @@ -526,11 +526,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", - "rich": true, - "source": "no example", "service": "no example", - "corrected": "no example" + "source": "no example", + "source_lang": "no example", + "corrected": "no example", + "rich": true } } @@ -540,20 +540,20 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | いいえ | -| `rich` | Whether the given result features the full range of information | bool | いいえ | -| `source` | The source text | string | いいえ | | `service` | The service which returned the result | Translator | いいえ | +| `source` | The source text | string | いいえ | +| `source_lang` | The source text's language | Language | いいえ | | `corrected` | The corrected text | string | いいえ | +| `rich` | Whether the given result features the full range of information | bool | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # language @@ -645,9 +645,9 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "source": "no example", - "service": "no example" + "source": "no example" } } @@ -657,18 +657,18 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | いいえ | | `source_lang` | The source text's language | Language | いいえ | | `source` | The source text | string | いいえ | -| `service` | The service which returned the result | Translator | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # example @@ -760,12 +760,12 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "reference": "no example", - "example": "no example", - "source_lang": "no example", - "positions": "no example", "source": "no example", - "service": "no example" + "source_lang": "no example", + "example": "no example", + "positions": "no example" } } @@ -775,21 +775,21 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | いいえ | | `reference` | Where the example comes from (i.e a book or a the person who said it if it's a quote) | string | いいえ | -| `example` | The example | string | いいえ | +| `source` | The source text | string | いいえ | | `source_lang` | The source text's language | Language | いいえ | +| `example` | The example | string | いいえ | | `positions` | The positions of the word in the example | list[int] | いいえ | -| `source` | The source text | string | いいえ | -| `service` | The service which returned the result | Translator | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # dictionary @@ -881,11 +881,11 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { + "service": "no example", "source_lang": "no example", - "meaning": "no example", - "rich": true, "source": "no example", - "service": "no example" + "meaning": "no example", + "rich": true } } @@ -895,20 +895,20 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | +| `service` | The service which returned the result | Translator | いいえ | | `source_lang` | The source text's language | Language | いいえ | +| `source` | The source text | string | いいえ | | `meaning` | The meaning of the text | string | いいえ | | `rich` | Whether the given result features the full range of information | bool | いいえ | -| `source` | The source text | string | いいえ | -| `service` | The service which returned the result | Translator | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) # tts @@ -1000,14 +1000,14 @@ print(r.json()["data"]) "message": "Successfully processed your request", "error": null, "data": { - "source_lang": "no example", "extension": "no example", "result": "no example", "source": "no example", - "service": "no example", + "speed": 4, "gender": "no example", + "service": "no example", "mime_type": "no example", - "speed": 4 + "source_lang": "no example" } } @@ -1017,21 +1017,21 @@ print(r.json()["data"]) | フィールド | 詳細 | タイプ | null可能 | | ---------- | -------------------------------- | ------ | --------- | -| `source_lang` | The source text's language | Language | いいえ | | `extension` | Returns the audio file extension | Optional[str] | いいえ | | `result` | Text to speech result | bytes | いいえ | | `source` | The source text | string | いいえ | -| `service` | The service which returned the result | Translator | いいえ | +| `speed` | Speed of the text to speech result | int | いいえ | | `gender` | Gender of the 'person' saying the text | Gender | いいえ | +| `service` | The service which returned the result | Translator | いいえ | | `mime_type` | Returns the MIME type of the audio file | Optional[str] | いいえ | -| `speed` | Speed of the text to speech result | int | いいえ | +| `source_lang` | The source text's language | Language | いいえ | #### 起こりうるエラー | エラー名 | 詳細 | コード | | --------------- | -------------------------------- | ------ | -| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_TRANSLATOR` | When one of the provided translator/service could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | -| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | +| `NO_RESULT` | When no result is returned from the translator(s) | 500 | | `UNKNOWN_LANGUAGE` | When one of the provided language could not be understood by translatepy. Extra information like the string similarity and the most similar string are provided in `data`. | 400 | +| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy | 500 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) \ No newline at end of file