From 3b24a9fb170aecd0fd6e127b7481ef16dc5f349a Mon Sep 17 00:00:00 2001 From: Animenosekai <40539549+Animenosekai@users.noreply.github.com> Date: Tue, 28 Jun 2022 14:59:23 +0200 Subject: [PATCH] [update] fixing typos in docs --- .../API Documentation/Getting Started.md | 14 ++-- .../Stats.postman_collection.utils.json | 2 +- .../Translation.postman_collection.utils.json | 2 +- .../API Documentation/sections/Stats.md | 2 +- .../API Documentation/sections/Translation.md | 84 +++++++++---------- .../Server Documentation/Getting Started.md | 12 +-- .../Sections/Translation.md | 84 +++++++++---------- .../Translation.postman_collection.utils.json | 2 +- .../Documentation d'API/Pour commencer.md" | 2 +- .../Stats.postman_collection.utils.json" | 2 +- ...Translation.postman_collection.utils.json" | 2 +- .../Documentation d'API/sections/Stats.md" | 2 +- .../sections/Translation.md" | 84 +++++++++---------- .../Sections/Translation.md" | 84 +++++++++---------- ...Translation.postman_collection.utils.json" | 2 +- .../Stats.postman_collection.utils.json" | 2 +- ...Translation.postman_collection.utils.json" | 2 +- ...57\343\201\230\343\202\201\343\201\253.md" | 2 +- .../Stats.md" | 2 +- .../Translation.md" | 84 +++++++++---------- ...Translation.postman_collection.utils.json" | 2 +- .../Translation.md" | 84 +++++++++---------- server/docs/Getting Started.md | 14 ++-- .../Stats.postman_collection.utils.json | 2 +- .../Translation.postman_collection.utils.json | 2 +- server/docs/sections/Stats.md | 2 +- server/docs/sections/Translation.md | 84 +++++++++---------- server/endpoints/stats.py | 2 +- translatepy/server/docs/Getting Started.md | 12 +-- .../Translation.postman_collection.utils.json | 2 +- .../server/docs/sections/Translation.md | 84 +++++++++---------- 31 files changed, 381 insertions(+), 381 deletions(-) diff --git a/docs/English/API Documentation/Getting Started.md b/docs/English/API Documentation/Getting Started.md index 382a4b4..053774c 100644 --- a/docs/English/API Documentation/Getting Started.md +++ b/docs/English/API Documentation/Getting Started.md @@ -20,16 +20,16 @@ Globally, JSON responses should be formatted as follows (even when critical erro | Field | Description | Nullable | | ------------ | ------------------------------------------------ | ---------------- | -| `success` | Wether the request was a success or not | False | +| `success` | Whether the request was a success or not | False | | `message` | A message describing what happened | True | -| `error` | The exception name if an error occured | True | +| `error` | The exception name if an error occurred | True | | `data` | The extra data, information asked in the request | False | ### Errors Multiple Errors can occur, server side or request side. -Specific errors are documented in each endpoint but these are the general errors that can occur on any endpoint: +Specific errors are documented in each endpoint, but these are the general errors that can occur on any endpoint: | Exception | Description | Code | | --------------------------- | --------------------------------------------------------------------------------------------------------------- | ----- | @@ -43,15 +43,15 @@ Specific errors are documented in each endpoint but these are the general errors | `MISSING_DYNAMIC` | When a dynamic routing value is missing from the requested URL | 400 | | `MISSING_HEADER` | When a header is missing from the request | 400 | | `MISSING_COOKIE` | When a cookie is missing from the request | 400 | -| `AUTH_ERROR` | When an error occured while authenticating the request | 403 | +| `AUTH_ERROR` | When an error occurred while authenticating the request | 403 | ### Authenticated Requests When a user needs to be logged in, the "Authorization" header needs to be set to the login token provided when logging in. -Alternatively, the "translatepy_token" parameter and "__translatepy_token" cookie can be used but these won't be prioritized. +Alternatively, the "translatepy_token" parameter and "__translatepy_token" cookie can be used, but these won't be prioritized. -If the endpoint is flagged for a "verified only" login, the account won't be fetched from any database but the token will be checked. +If the endpoint is flagged for a "verified only" login, the account won't be fetched from any database, but the token will be checked. ### Debug Mode @@ -110,7 +110,7 @@ The "call_stack" attribute is enabled only when an error occurs or the `call_sta - [Translation Star](./Sections/Stars.md#translation-star) - [Stats](./Sections/Stats.md#stats) - [Timings Stats](./Sections/Stats.md#timings-stats) - - [Erros Stats](./Sections/Stats.md#erros-stats) + - [Errors Stats](./Sections/Stats.md#errors-stats) - [Translation](./Sections/Translation.md#translation) - [Translate](./Sections/Translation.md#translate) - [Translation Stream](./Sections/Translation.md#translation-stream) diff --git a/docs/English/API Documentation/postman/Stats.postman_collection.utils.json b/docs/English/API Documentation/postman/Stats.postman_collection.utils.json index 6be5394..0a0331a 100644 --- a/docs/English/API Documentation/postman/Stats.postman_collection.utils.json +++ b/docs/English/API Documentation/postman/Stats.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Stats","description":"All of the endpoints under the 'Stats' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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":"Erros Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Erros Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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"}]}],"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":"Stats","description":"All of the endpoints under the 'Stats' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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":"Errors Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Errors Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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"}]}],"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/English/API Documentation/postman/Translation.postman_collection.utils.json b/docs/English/API Documentation/postman/Translation.postman_collection.utils.json index 3bbc734..b5f0f4e 100644 --- a/docs/English/API Documentation/postman/Translation.postman_collection.utils.json +++ b/docs/English/API Documentation/postman/Translation.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Translation","description":"All of the endpoints under the 'Translation' 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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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"}]}],"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":"Translation","description":"All of the endpoints under the 'Translation' 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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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"}]}],"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/English/API Documentation/sections/Stats.md b/docs/English/API Documentation/sections/Stats.md index 2694731..e7e5f89 100644 --- a/docs/English/API Documentation/sections/Stats.md +++ b/docs/English/API Documentation/sections/Stats.md @@ -87,7 +87,7 @@ print(r.json()["data"]) | `DATABASE_DISABLED` | When the server disabled any database interaction | 501 | [Return to the Index](../Getting%20Started.md#index) -# Erros Stats +# Errors Stats Get all errors count for each service diff --git a/docs/English/API Documentation/sections/Translation.md b/docs/English/API Documentation/sections/Translation.md index bf25817..d73bee6 100644 --- a/docs/English/API Documentation/sections/Translation.md +++ b/docs/English/API Documentation/sections/Translation.md @@ -108,30 +108,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -268,30 +268,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -469,17 +469,17 @@ print(r.json()["data"]) "eng" ], "destinationLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "

こんにちは、今日はお元気ですか

大丈夫

" } @@ -614,30 +614,30 @@ print(r.json()["data"]) "service": "Google", "source": "おはよう", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Ohayou" } @@ -771,17 +771,17 @@ print(r.json()["data"]) "service": "Google", "source": "God morning", "sourceLang": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Good morning" } @@ -913,17 +913,17 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "result": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" } } } diff --git a/docs/English/CLI Usage/Server Documentation/Getting Started.md b/docs/English/CLI Usage/Server Documentation/Getting Started.md index 167a496..bd8189b 100644 --- a/docs/English/CLI Usage/Server Documentation/Getting Started.md +++ b/docs/English/CLI Usage/Server Documentation/Getting Started.md @@ -20,16 +20,16 @@ Globally, JSON responses should be formatted as follows (even when critical erro | Field | Description | Nullable | | ------------ | ------------------------------------------------ | ---------------- | -| `success` | Wether the request was a success or not | False | +| `success` | Whether the request was a success or not | False | | `message` | A message describing what happened | True | -| `error` | The exception name if an error occured | True | +| `error` | The exception name if an error occurred | True | | `data` | The extra data, information asked in the request | False | ### Errors Multiple Errors can occur, server side or request side. -Specific errors are documented in each endpoint but these are the general errors that can occur on any endpoint: +Specific errors are documented in each endpoint, but these are the general errors that can occur on any endpoint: | Exception | Description | Code | | --------------------------- | --------------------------------------------------------------------------------------------------------------- | ----- | @@ -43,15 +43,15 @@ Specific errors are documented in each endpoint but these are the general errors | `MISSING_DYNAMIC` | When a dynamic routing value is missing from the requested URL | 400 | | `MISSING_HEADER` | When a header is missing from the request | 400 | | `MISSING_COOKIE` | When a cookie is missing from the request | 400 | -| `AUTH_ERROR` | When an error occured while authenticating the request | 403 | +| `AUTH_ERROR` | When an error occurred while authenticating the request | 403 | ### Authenticated Requests When a user needs to be logged in, the "Authorization" header needs to be set to the login token provided when logging in. -Alternatively, the "translatepy_token" parameter and "__translatepy_token" cookie can be used but these won't be prioritized. +Alternatively, the "translatepy_token" parameter and "__translatepy_token" cookie can be used, but these won't be prioritized. -If the endpoint is flagged for a "verified only" login, the account won't be fetched from any database but the token will be checked. +If the endpoint is flagged for a "verified only" login, the account won't be fetched from any database, but the token will be checked. ### Debug Mode diff --git a/docs/English/CLI Usage/Server Documentation/Sections/Translation.md b/docs/English/CLI Usage/Server Documentation/Sections/Translation.md index a54ff6a..27261f2 100644 --- a/docs/English/CLI Usage/Server Documentation/Sections/Translation.md +++ b/docs/English/CLI Usage/Server Documentation/Sections/Translation.md @@ -108,30 +108,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -268,30 +268,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -469,17 +469,17 @@ print(r.json()["data"]) "eng" ], "destinationLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "

こんにちは、今日はお元気ですか

大丈夫

" } @@ -614,30 +614,30 @@ print(r.json()["data"]) "service": "Google", "source": "おはよう", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Ohayou" } @@ -771,17 +771,17 @@ print(r.json()["data"]) "service": "Google", "source": "God morning", "sourceLang": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Good morning" } @@ -913,17 +913,17 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "result": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" } } } diff --git a/docs/English/CLI Usage/Server Documentation/postman/Translation.postman_collection.utils.json b/docs/English/CLI Usage/Server Documentation/postman/Translation.postman_collection.utils.json index a208c93..e15aea3 100644 --- a/docs/English/CLI Usage/Server Documentation/postman/Translation.postman_collection.utils.json +++ b/docs/English/CLI Usage/Server Documentation/postman/Translation.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Translation","description":"All of the endpoints under the 'Translation' 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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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"}]}],"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":"Translation","description":"All of the endpoints under the 'Translation' 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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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"}]}],"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/Fran\303\247ais/Documentation d'API/Pour commencer.md" "b/docs/Fran\303\247ais/Documentation d'API/Pour commencer.md" index 7d261d7..5a1c654 100644 --- "a/docs/Fran\303\247ais/Documentation d'API/Pour commencer.md" +++ "b/docs/Fran\303\247ais/Documentation d'API/Pour commencer.md" @@ -110,7 +110,7 @@ Le champ "call_stack" est activé seulement quand il y a le paramètre `call_sta - [Translation Star](./Sections/Stars.md#translation-star) - [Stats](./Sections/Stats.md#stats) - [Timings Stats](./Sections/Stats.md#timings-stats) - - [Erros Stats](./Sections/Stats.md#erros-stats) + - [Errors Stats](./Sections/Stats.md#errors-stats) - [Translation](./Sections/Translation.md#translation) - [Translate](./Sections/Translation.md#translate) - [Translation Stream](./Sections/Translation.md#translation-stream) diff --git "a/docs/Fran\303\247ais/Documentation d'API/postman/Stats.postman_collection.utils.json" "b/docs/Fran\303\247ais/Documentation d'API/postman/Stats.postman_collection.utils.json" index 58a17c4..4fea950 100644 --- "a/docs/Fran\303\247ais/Documentation d'API/postman/Stats.postman_collection.utils.json" +++ "b/docs/Fran\303\247ais/Documentation d'API/postman/Stats.postman_collection.utils.json" @@ -1 +1 @@ -{"info":{"name":"Stats","description":"Tous les endpoints sous la section 'Stats' de l'interface API de translatepy","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\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| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\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| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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":"Erros Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\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| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Erros Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\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| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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"}]}],"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":"Stats","description":"Tous les endpoints sous la section 'Stats' de l'interface API de translatepy","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\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| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\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| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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":"Errors Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\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| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Errors Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\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| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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"}]}],"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/Fran\303\247ais/Documentation d'API/postman/Translation.postman_collection.utils.json" "b/docs/Fran\303\247ais/Documentation d'API/postman/Translation.postman_collection.utils.json" index 2a6156a..9d131a1 100644 --- "a/docs/Fran\303\247ais/Documentation d'API/postman/Translation.postman_collection.utils.json" +++ "b/docs/Fran\303\247ais/Documentation d'API/postman/Translation.postman_collection.utils.json" @@ -1 +1 @@ -{"info":{"name":"Translation","description":"Tous les endpoints sous la section 'Translation' 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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source languages | array | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source languages | array | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The transliteration | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The transliteration | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLang` | The source language | object | Non |\n| `result` | The spellchecked text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLang` | The source language | object | Non |\n| `result` | The spellchecked text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `result` | The resulting language alpha-3 code | object | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `result` | The resulting language alpha-3 code | object | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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"}]}],"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":"Translation","description":"Tous les endpoints sous la section 'Translation' 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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source languages | array | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source languages | array | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The transliteration | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The transliteration | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLang` | The source language | object | Non |\n| `result` | The spellchecked text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLang` | The source language | object | Non |\n| `result` | The spellchecked text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `result` | The resulting language alpha-3 code | object | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `result` | The resulting language alpha-3 code | object | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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"}]}],"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/Fran\303\247ais/Documentation d'API/sections/Stats.md" "b/docs/Fran\303\247ais/Documentation d'API/sections/Stats.md" index 29c88e5..46752aa 100644 --- "a/docs/Fran\303\247ais/Documentation d'API/sections/Stats.md" +++ "b/docs/Fran\303\247ais/Documentation d'API/sections/Stats.md" @@ -87,7 +87,7 @@ print(r.json()["data"]) | `DATABASE_DISABLED` | When the server disabled any database interaction | 501 | [Retourner à l'Index](../Pour%20commencer.md#index) -# Erros Stats +# Errors Stats Get all errors count for each service diff --git "a/docs/Fran\303\247ais/Documentation d'API/sections/Translation.md" "b/docs/Fran\303\247ais/Documentation d'API/sections/Translation.md" index 5e1a157..cbee7ca 100644 --- "a/docs/Fran\303\247ais/Documentation d'API/sections/Translation.md" +++ "b/docs/Fran\303\247ais/Documentation d'API/sections/Translation.md" @@ -108,30 +108,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -268,30 +268,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -469,17 +469,17 @@ print(r.json()["data"]) "eng" ], "destinationLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "

こんにちは、今日はお元気ですか

大丈夫

" } @@ -614,30 +614,30 @@ print(r.json()["data"]) "service": "Google", "source": "おはよう", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Ohayou" } @@ -771,17 +771,17 @@ print(r.json()["data"]) "service": "Google", "source": "God morning", "sourceLang": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Good morning" } @@ -913,17 +913,17 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "result": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" } } } diff --git "a/docs/Fran\303\247ais/Utilisation par CLI/Documentation du Serveur/Sections/Translation.md" "b/docs/Fran\303\247ais/Utilisation par CLI/Documentation du Serveur/Sections/Translation.md" index 15e8fa2..59c66c7 100644 --- "a/docs/Fran\303\247ais/Utilisation par CLI/Documentation du Serveur/Sections/Translation.md" +++ "b/docs/Fran\303\247ais/Utilisation par CLI/Documentation du Serveur/Sections/Translation.md" @@ -108,30 +108,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -268,30 +268,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -469,17 +469,17 @@ print(r.json()["data"]) "eng" ], "destinationLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "

こんにちは、今日はお元気ですか

大丈夫

" } @@ -614,30 +614,30 @@ print(r.json()["data"]) "service": "Google", "source": "おはよう", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Ohayou" } @@ -771,17 +771,17 @@ print(r.json()["data"]) "service": "Google", "source": "God morning", "sourceLang": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Good morning" } @@ -913,17 +913,17 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "result": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" } } } diff --git "a/docs/Fran\303\247ais/Utilisation par CLI/Documentation du Serveur/postman/Translation.postman_collection.utils.json" "b/docs/Fran\303\247ais/Utilisation par CLI/Documentation du Serveur/postman/Translation.postman_collection.utils.json" index 8a72c70..e1c89b4 100644 --- "a/docs/Fran\303\247ais/Utilisation par CLI/Documentation du Serveur/postman/Translation.postman_collection.utils.json" +++ "b/docs/Fran\303\247ais/Utilisation par CLI/Documentation du Serveur/postman/Translation.postman_collection.utils.json" @@ -1 +1 @@ -{"info":{"name":"Translation","description":"Tous les endpoints sous la section 'Translation' 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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source languages | array | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source languages | array | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The transliteration | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The transliteration | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLang` | The source language | object | Non |\n| `result` | The spellchecked text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLang` | The source language | object | Non |\n| `result` | The spellchecked text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `result` | The resulting language alpha-3 code | object | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `result` | The resulting language alpha-3 code | object | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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"}]}],"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":"Translation","description":"Tous les endpoints sous la section 'Translation' 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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source languages | array | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source languages | array | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The translated text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The transliteration | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLanguage` | The source language | object | Non |\n| `destinationLanguage` | The destination language | object | Non |\n| `result` | The transliteration | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLang` | The source language | object | Non |\n| `result` | The spellchecked text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `sourceLang` | The source language | object | Non |\n| `result` | The spellchecked text | str | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `result` | The resulting language alpha-3 code | object | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### Retourne\n\n| Champ | Description | Type | Peut être `null` |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | Non |\n| `source` | The source text | str | Non |\n| `result` | The resulting language alpha-3 code | object | Non |\n\n#### Erreurs possibles\n\n| Erreur | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Retourner à l'Index](../Pour%20commencer.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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"}]}],"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/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/postman/Stats.postman_collection.utils.json" "b/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/postman/Stats.postman_collection.utils.json" index 1299b07..9f94b20 100644 --- "a/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/postman/Stats.postman_collection.utils.json" +++ "b/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/postman/Stats.postman_collection.utils.json" @@ -1 +1 @@ -{"info":{"name":"Stats","description":"translatepy APIインターフェイスでの「Stats」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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":"Erros Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"Erros Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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"}]}],"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":"Stats","description":"translatepy APIインターフェイスでの「Stats」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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":"Errors Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"Errors Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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"}]}],"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/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/postman/Translation.postman_collection.utils.json" "b/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/postman/Translation.postman_collection.utils.json" index f53bbdc..f7cf6a3 100644 --- "a/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/postman/Translation.postman_collection.utils.json" +++ "b/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/postman/Translation.postman_collection.utils.json" @@ -1 +1 @@ -{"info":{"name":"Translation","description":"translatepy APIインターフェイスでの「Translation」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source languages | array | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source languages | array | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The transliteration | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The transliteration | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLang` | The source language | object | いいえ |\n| `result` | The spellchecked text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLang` | The source language | object | いいえ |\n| `result` | The spellchecked text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `result` | The resulting language alpha-3 code | object | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `result` | The resulting language alpha-3 code | object | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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"}]}],"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":"Translation","description":"translatepy APIインターフェイスでの「Translation」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source languages | array | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source languages | array | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The transliteration | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The transliteration | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLang` | The source language | object | いいえ |\n| `result` | The spellchecked text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLang` | The source language | object | いいえ |\n| `result` | The spellchecked text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `result` | The resulting language alpha-3 code | object | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `result` | The resulting language alpha-3 code | object | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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"}]}],"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/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\201\257\343\201\230\343\202\201\343\201\253.md" "b/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\201\257\343\201\230\343\202\201\343\201\253.md" index 79117ba..7b398fd 100644 --- "a/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\201\257\343\201\230\343\202\201\343\201\253.md" +++ "b/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\201\257\343\201\230\343\202\201\343\201\253.md" @@ -112,7 +112,7 @@ translatepy APIリファレンスへようこそ！ - [Translation Star](./%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3/Stars.md#translation-star) - [Stats](./%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3/Stats.md#stats) - [Timings Stats](./%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3/Stats.md#timings-stats) - - [Erros Stats](./%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3/Stats.md#erros-stats) + - [Errors Stats](./%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3/Stats.md#errors-stats) - [Translation](./%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3/Translation.md#translation) - [Translate](./%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3/Translation.md#translate) - [Translation Stream](./%E3%82%BB%E3%82%AF%E3%82%B7%E3%83%A7%E3%83%B3/Translation.md#translation-stream) diff --git "a/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Stats.md" "b/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Stats.md" index bfc4320..2e53e82 100644 --- "a/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Stats.md" +++ "b/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Stats.md" @@ -87,7 +87,7 @@ print(r.json()["data"]) | `DATABASE_DISABLED` | When the server disabled any database interaction | 501 | [インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス) -# Erros Stats +# Errors Stats Get all errors count for each service diff --git "a/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Translation.md" "b/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Translation.md" index b1002e3..8dd25b2 100644 --- "a/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Translation.md" +++ "b/docs/\346\227\245\346\234\254\350\252\236/API\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Translation.md" @@ -108,30 +108,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -268,30 +268,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -469,17 +469,17 @@ print(r.json()["data"]) "eng" ], "destinationLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "

こんにちは、今日はお元気ですか

大丈夫

" } @@ -614,30 +614,30 @@ print(r.json()["data"]) "service": "Google", "source": "おはよう", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Ohayou" } @@ -771,17 +771,17 @@ print(r.json()["data"]) "service": "Google", "source": "God morning", "sourceLang": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Good morning" } @@ -913,17 +913,17 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "result": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" } } } diff --git "a/docs/\346\227\245\346\234\254\350\252\236/CLI\343\201\247\343\201\256\345\210\251\347\224\250/\343\202\265\343\203\274\343\203\220\343\203\274\343\201\256\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/postman/Translation.postman_collection.utils.json" "b/docs/\346\227\245\346\234\254\350\252\236/CLI\343\201\247\343\201\256\345\210\251\347\224\250/\343\202\265\343\203\274\343\203\220\343\203\274\343\201\256\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/postman/Translation.postman_collection.utils.json" index d0fef37..0a59029 100644 --- "a/docs/\346\227\245\346\234\254\350\252\236/CLI\343\201\247\343\201\256\345\210\251\347\224\250/\343\202\265\343\203\274\343\203\220\343\203\274\343\201\256\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/postman/Translation.postman_collection.utils.json" +++ "b/docs/\346\227\245\346\234\254\350\252\236/CLI\343\201\247\343\201\256\345\210\251\347\224\250/\343\202\265\343\203\274\343\203\220\343\203\274\343\201\256\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/postman/Translation.postman_collection.utils.json" @@ -1 +1 @@ -{"info":{"name":"Translation","description":"translatepy APIインターフェイスでの「Translation」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source languages | array | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source languages | array | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The transliteration | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The transliteration | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLang` | The source language | object | いいえ |\n| `result` | The spellchecked text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLang` | The source language | object | いいえ |\n| `result` | The spellchecked text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `result` | The resulting language alpha-3 code | object | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `result` | The resulting language alpha-3 code | object | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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"}]}],"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":"Translation","description":"translatepy APIインターフェイスでの「Translation」セクションの全てのエンドポイント","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source languages | array | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source languages | array | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The translated text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The transliteration | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLanguage` | The source language | object | いいえ |\n| `destinationLanguage` | The destination language | object | いいえ |\n| `result` | The transliteration | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLang` | The source language | object | いいえ |\n| `result` | The spellchecked text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `sourceLang` | The source language | object | いいえ |\n| `result` | The spellchecked text | str | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `result` | The resulting language alpha-3 code | object | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### 返したフィールド\n\n| フィールド | 詳細 | タイプ | null可能 |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | いいえ |\n| `source` | The source text | str | いいえ |\n| `result` | The resulting language alpha-3 code | object | いいえ |\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB.md#インデックス)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \n\n\n### 認証\n\nログインは**不要**です\n\n#### 起こりうるエラー\n\n| エラー名 | 詳細 | コード |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[インデックスに戻る](../%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"}]}],"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/\346\227\245\346\234\254\350\252\236/CLI\343\201\247\343\201\256\345\210\251\347\224\250/\343\202\265\343\203\274\343\203\220\343\203\274\343\201\256\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Translation.md" "b/docs/\346\227\245\346\234\254\350\252\236/CLI\343\201\247\343\201\256\345\210\251\347\224\250/\343\202\265\343\203\274\343\203\220\343\203\274\343\201\256\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Translation.md" index c4a97d9..fafbfb8 100644 --- "a/docs/\346\227\245\346\234\254\350\252\236/CLI\343\201\247\343\201\256\345\210\251\347\224\250/\343\202\265\343\203\274\343\203\220\343\203\274\343\201\256\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Translation.md" +++ "b/docs/\346\227\245\346\234\254\350\252\236/CLI\343\201\247\343\201\256\345\210\251\347\224\250/\343\202\265\343\203\274\343\203\220\343\203\274\343\201\256\343\203\211\343\202\255\343\203\245\343\203\241\343\203\263\343\203\210/\343\202\273\343\202\257\343\202\267\343\203\247\343\203\263/Translation.md" @@ -108,30 +108,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -268,30 +268,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -469,17 +469,17 @@ print(r.json()["data"]) "eng" ], "destinationLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "

こんにちは、今日はお元気ですか

大丈夫

" } @@ -614,30 +614,30 @@ print(r.json()["data"]) "service": "Google", "source": "おはよう", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Ohayou" } @@ -771,17 +771,17 @@ print(r.json()["data"]) "service": "Google", "source": "God morning", "sourceLang": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Good morning" } @@ -913,17 +913,17 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "result": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" } } } diff --git a/server/docs/Getting Started.md b/server/docs/Getting Started.md index 382a4b4..053774c 100644 --- a/server/docs/Getting Started.md +++ b/server/docs/Getting Started.md @@ -20,16 +20,16 @@ Globally, JSON responses should be formatted as follows (even when critical erro | Field | Description | Nullable | | ------------ | ------------------------------------------------ | ---------------- | -| `success` | Wether the request was a success or not | False | +| `success` | Whether the request was a success or not | False | | `message` | A message describing what happened | True | -| `error` | The exception name if an error occured | True | +| `error` | The exception name if an error occurred | True | | `data` | The extra data, information asked in the request | False | ### Errors Multiple Errors can occur, server side or request side. -Specific errors are documented in each endpoint but these are the general errors that can occur on any endpoint: +Specific errors are documented in each endpoint, but these are the general errors that can occur on any endpoint: | Exception | Description | Code | | --------------------------- | --------------------------------------------------------------------------------------------------------------- | ----- | @@ -43,15 +43,15 @@ Specific errors are documented in each endpoint but these are the general errors | `MISSING_DYNAMIC` | When a dynamic routing value is missing from the requested URL | 400 | | `MISSING_HEADER` | When a header is missing from the request | 400 | | `MISSING_COOKIE` | When a cookie is missing from the request | 400 | -| `AUTH_ERROR` | When an error occured while authenticating the request | 403 | +| `AUTH_ERROR` | When an error occurred while authenticating the request | 403 | ### Authenticated Requests When a user needs to be logged in, the "Authorization" header needs to be set to the login token provided when logging in. -Alternatively, the "translatepy_token" parameter and "__translatepy_token" cookie can be used but these won't be prioritized. +Alternatively, the "translatepy_token" parameter and "__translatepy_token" cookie can be used, but these won't be prioritized. -If the endpoint is flagged for a "verified only" login, the account won't be fetched from any database but the token will be checked. +If the endpoint is flagged for a "verified only" login, the account won't be fetched from any database, but the token will be checked. ### Debug Mode @@ -110,7 +110,7 @@ The "call_stack" attribute is enabled only when an error occurs or the `call_sta - [Translation Star](./Sections/Stars.md#translation-star) - [Stats](./Sections/Stats.md#stats) - [Timings Stats](./Sections/Stats.md#timings-stats) - - [Erros Stats](./Sections/Stats.md#erros-stats) + - [Errors Stats](./Sections/Stats.md#errors-stats) - [Translation](./Sections/Translation.md#translation) - [Translate](./Sections/Translation.md#translate) - [Translation Stream](./Sections/Translation.md#translation-stream) diff --git a/server/docs/postman/Stats.postman_collection.utils.json b/server/docs/postman/Stats.postman_collection.utils.json index 6be5394..0a0331a 100644 --- a/server/docs/postman/Stats.postman_collection.utils.json +++ b/server/docs/postman/Stats.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Stats","description":"All of the endpoints under the 'Stats' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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":"Erros Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Erros Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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"}]}],"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":"Stats","description":"All of the endpoints under the 'Stats' section of the translatepy API Interface","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Timings Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/timings?=granularity","host":["{{DOMAIN}}"],"path":["stats","timings"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L17)\n\nGet all timings\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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":"Errors Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\n[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Errors Stats","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stats/errors?=granularity","host":["{{DOMAIN}}"],"path":["stats","errors"],"query":[{"key":"granularity","value":"","description":"The granularity of the stats"}]},"description":"\n> [server/endpoints/stats.py](../../server/endpoints/stats.py#L28)\n\nGet all errors count for each service\n\n\n### Authentication\n\nLogin is **not** required\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `DATABASE_DISABLED` | When the server disabled any database interaction | 501 |\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"}]}],"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/server/docs/postman/Translation.postman_collection.utils.json b/server/docs/postman/Translation.postman_collection.utils.json index 3bbc734..b5f0f4e 100644 --- a/server/docs/postman/Translation.postman_collection.utils.json +++ b/server/docs/postman/Translation.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Translation","description":"All of the endpoints under the 'Translation' 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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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"}]}],"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":"Translation","description":"All of the endpoints under the 'Translation' 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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [server/endpoints/translation.py](../../server/endpoints/translation.py#L49)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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"}]}],"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/server/docs/sections/Stats.md b/server/docs/sections/Stats.md index 309bf86..b2c9f85 100644 --- a/server/docs/sections/Stats.md +++ b/server/docs/sections/Stats.md @@ -30,7 +30,7 @@ Login is **not** required | `DATABASE_DISABLED` | When the server disabled any database interaction | 501 | [Return to the Index](../Getting%20Started.md#index) -# Erros Stats +# Errors Stats Get all errors count for each service diff --git a/server/docs/sections/Translation.md b/server/docs/sections/Translation.md index ec59840..b279e9b 100644 --- a/server/docs/sections/Translation.md +++ b/server/docs/sections/Translation.md @@ -44,30 +44,30 @@ Login is **not** required "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -140,30 +140,30 @@ Login is **not** required "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -277,17 +277,17 @@ Login is **not** required "eng" ], "destinationLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "

こんにちは、今日はお元気ですか

大丈夫

" } @@ -360,30 +360,30 @@ Login is **not** required "service": "Google", "source": "おはよう", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Ohayou" } @@ -455,17 +455,17 @@ Login is **not** required "service": "Google", "source": "God morning", "sourceLang": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Good morning" } @@ -535,17 +535,17 @@ Login is **not** required "service": "Google", "source": "Hello world", "result": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" } } } diff --git a/server/endpoints/stats.py b/server/endpoints/stats.py index 9e13092..b532f26 100644 --- a/server/endpoints/stats.py +++ b/server/endpoints/stats.py @@ -28,7 +28,7 @@ def timings_handler(granularity: Granularity = "hour"): @app.route("/stats/errors", endpoint=Endpoint( endpoint=base, description="Get all errors count for each service", - name="Erros Stats" + name="Errors Stats" )) def timings_handler(granularity: Granularity = "hour"): return Response( diff --git a/translatepy/server/docs/Getting Started.md b/translatepy/server/docs/Getting Started.md index 167a496..bd8189b 100644 --- a/translatepy/server/docs/Getting Started.md +++ b/translatepy/server/docs/Getting Started.md @@ -20,16 +20,16 @@ Globally, JSON responses should be formatted as follows (even when critical erro | Field | Description | Nullable | | ------------ | ------------------------------------------------ | ---------------- | -| `success` | Wether the request was a success or not | False | +| `success` | Whether the request was a success or not | False | | `message` | A message describing what happened | True | -| `error` | The exception name if an error occured | True | +| `error` | The exception name if an error occurred | True | | `data` | The extra data, information asked in the request | False | ### Errors Multiple Errors can occur, server side or request side. -Specific errors are documented in each endpoint but these are the general errors that can occur on any endpoint: +Specific errors are documented in each endpoint, but these are the general errors that can occur on any endpoint: | Exception | Description | Code | | --------------------------- | --------------------------------------------------------------------------------------------------------------- | ----- | @@ -43,15 +43,15 @@ Specific errors are documented in each endpoint but these are the general errors | `MISSING_DYNAMIC` | When a dynamic routing value is missing from the requested URL | 400 | | `MISSING_HEADER` | When a header is missing from the request | 400 | | `MISSING_COOKIE` | When a cookie is missing from the request | 400 | -| `AUTH_ERROR` | When an error occured while authenticating the request | 403 | +| `AUTH_ERROR` | When an error occurred while authenticating the request | 403 | ### Authenticated Requests When a user needs to be logged in, the "Authorization" header needs to be set to the login token provided when logging in. -Alternatively, the "translatepy_token" parameter and "__translatepy_token" cookie can be used but these won't be prioritized. +Alternatively, the "translatepy_token" parameter and "__translatepy_token" cookie can be used, but these won't be prioritized. -If the endpoint is flagged for a "verified only" login, the account won't be fetched from any database but the token will be checked. +If the endpoint is flagged for a "verified only" login, the account won't be fetched from any database, but the token will be checked. ### Debug Mode diff --git a/translatepy/server/docs/postman/Translation.postman_collection.utils.json b/translatepy/server/docs/postman/Translation.postman_collection.utils.json index a208c93..e15aea3 100644 --- a/translatepy/server/docs/postman/Translation.postman_collection.utils.json +++ b/translatepy/server/docs/postman/Translation.postman_collection.utils.json @@ -1 +1 @@ -{"info":{"name":"Translation","description":"All of the endpoints under the 'Translation' 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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"destinationLanguage\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\",\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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"}]}],"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":"Translation","description":"All of the endpoints under the 'Translation' 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}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/translate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["translate"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L45)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translation Stream","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/stream?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["stream"],"query":[{"key":"text","value":"","description":"The text to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L101)\n\n\n Translates the given text to the given language\n\n i.e Good morning (en) --> おはようございます (ja)\n This endpoint returns a stream of results.\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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"こんにちは世界\"\n }\n}\n"}]},{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Translate HTML","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/html?=code&dest&source&parser&translators&foreign","host":["{{DOMAIN}}"],"path":["html"],"query":[{"key":"code","value":"","description":"The HTML snippet to translate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"parser","value":"","description":"The HTML parser to use"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L206)\n\n\n Translates the given HTML string or BeautifulSoup object to the given language\n\n i.e\n English: `

Hello

everyone and welcome to my website
`\n French: `

Bonjour

tout le monde etBienvenueàMon site internet
`\n\n Note: This method is not perfect since it is not tag/context aware. Example: `Hello everyone` will not be understood as\n \"Hello everyone\" with \"everyone\" in bold but rather \"Hello\" and \"everyone\" separately.\n\n Warning: If you give a `bs4.BeautifulSoup`, `bs4.element.PageElement` or `bs4.element.Tag` input (which are mutable), they will be modified.\n If you don't want this behavior, please make sure to pass the string version of the element:\n >>> result = Translate().translate_html(str(page_element), \"French\")\n\n Parameters:\n ----------\n html : str | bs4.element.PageElement | bs4.element.Tag | bs4.BeautifulSoup\n The HTML string to be translated. This can also be an instance of BeautifulSoup's `BeautifulSoup` element, `PageElement` or `Tag` element.\n destination_language : str\n The language the HTML string needs to be translated in.\n source_language : str, default = \"auto\"\n The language of the HTML string.\n parser : str, default = \"html.parser\"\n The parser that BeautifulSoup will use to parse the HTML string.\n threads_limit : int, default = 100\n The maximum number of threads that will be spawned by translate_html\n __internal_replacement_function__ : function, default = None\n This is used internally, especially by the translatepy HTTP server to modify the translation step.\n\n Returns:\n --------\n BeautifulSoup:\n The result will be the same element as the input `html` parameter with the values modified if the given\n input is of bs4.BeautifulSoup, bs4.element.PageElement or bs4.element.Tag instance.\n str:\n The result will be a string in any other case.\n\n \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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `services` | The translators used | array | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source languages | array | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The translated text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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 \"services\": [\n \"Google\",\n \"Bing\"\n ],\n \"source\": \"

Hello, how are you today

Comment allez-vous

\",\n \"sourceLanguage\": [\n \"fra\",\n \"eng\"\n ],\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"

こんにちは、今日はお元気ですか

大丈夫

\"\n }\n}\n"}]},{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Transliterate","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/transliterate?=text&dest&source&translators&foreign","host":["{{DOMAIN}}"],"path":["transliterate"],"query":[{"key":"text","value":"","description":"The text to transliterate"},{"key":"dest","value":"","description":"The destination language"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L284)\n\n\n Transliterates the given text, get its pronunciation\n\n i.e おはよう --> Ohayou\n \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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLanguage` | The source language | object | No |\n| `destinationLanguage` | The destination language | object | No |\n| `result` | The transliteration | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"おはよう\",\n \"sourceLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"destinationLanguage\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Ohayou\"\n }\n}\n"}]},{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Spellcheck","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/spellcheck?=text&source&translators&foreign","host":["{{DOMAIN}}"],"path":["spellcheck"],"query":[{"key":"text","value":"","description":"The text to spellcheck"},{"key":"source","value":"","description":"The source language"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L340)\n\n\n Checks the spelling of a given text\n\n i.e God morning --> Good morning\n \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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `sourceLang` | The source language | object | No |\n| `result` | The spellchecked text | str | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"God morning\",\n \"sourceLang\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n },\n \"result\": \"Good morning\"\n }\n}\n"}]},{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Language","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/language?=text&translators&foreign","host":["{{DOMAIN}}"],"path":["language"],"query":[{"key":"text","value":"","description":"The text to get the language of"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."},{"key":"foreign","value":"","description":"Whether to include the language in foreign languages"}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L394)\n\n\n Returns the language of the given text\n\n i.e 皆さんおはようございます！ --> Japanese\n \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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n\n```\n\n#### Returns\n\n| Field | Description | Type | Nullable |\n| ---------- | -------------------------------- | ------ | --------- |\n| `service` | The translator used | str | No |\n| `source` | The source text | str | No |\n| `result` | The resulting language alpha-3 code | object | No |\n\n#### Possible Errors\n\n| Exception | Description | Code |\n| --------------- | -------------------------------- | ------ |\n| `TRANSLATEPY_EXCEPTION` | Generic exception raised when an error occured on translatepy. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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\": \"Google\",\n \"source\": \"Hello world\",\n \"result\": {\n \"inForeignLanguages\": {},\n \"extra\": {\n \"scope\": \"Individual\",\n \"type\": \"Living\"\n },\n \"id\": \"eng\",\n \"alpha2\": \"en\",\n \"alpha3b\": \"eng\",\n \"alpha3t\": \"eng\",\n \"alpha3\": \"eng\",\n \"name\": \"English\"\n }\n }\n}\n"}]},{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[Return to the Index](../Getting%20Started.md#index)","auth":{"type":"noauth"}},"response":[{"name":"Text to Speech","event":[],"request":{"method":"GET","header":[],"url":{"raw":"{{DOMAIN}}/tts?=text&source&speed&gender&translators","host":["{{DOMAIN}}"],"path":["tts"],"query":[{"key":"text","value":"","description":"The text to convert to speech"},{"key":"source","value":"","description":"The source language"},{"key":"speed","value":"","description":"The speed of the speech"},{"key":"gender","value":"","description":"The gender of the speech"},{"key":"translators","value":"","description":"The translator(s) to use. When providing multiple translators, the names should be comma-separated."}]},"description":"\n> [translatepy/server/translation.py](../../translatepy/server/translation.py#L434)\n\n\n Gives back the text to speech result for the given text\n\n Args:\n text: the given text\n source_language: the source language\n\n Returns:\n the mp3 file as bytes\n\n Example:\n >>> from translatepy import Translator\n >>> t = Translator()\n >>> result = t.text_to_speech(\"Hello, how are you?\")\n >>> with open(\"output.mp3\", \"wb\") as output: # open a binary (b) file to write (w)\n ... output.write(result.result)\n # or:\n result.write_to_file(output)\n # Or you can just use write_to_file method:\n >>> result.write_to_file(\"output.mp3\")\n >>> print(\"Output of Text to Speech is available in output.mp3!\")\n\n # the result is an MP3 file with the text to speech output\n \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. This is the base class for the other exceptions raised by translatepy. | 500 |\n| `NO_RESULT` | When no result is returned from the translator(s) | 500 |\n| `PARAMETER_ERROR` | When a parameter is missing or invalid | 500 |\n| `PARAMETER_TYPE_ERROR` | When a parameter is of the wrong type | 500 |\n| `PARAMETER_VALUE_ERROR` | When a parameter is of the wrong value | 500 |\n| `TRANSLATION_ERROR` | When a translation error occurs | 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| `UNKNOWN_TRANSLATOR` | When one of the provided 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[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"}]}],"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/sections/Translation.md b/translatepy/server/docs/sections/Translation.md index a54ff6a..27261f2 100644 --- a/translatepy/server/docs/sections/Translation.md +++ b/translatepy/server/docs/sections/Translation.md @@ -108,30 +108,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -268,30 +268,30 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "こんにちは世界" } @@ -469,17 +469,17 @@ print(r.json()["data"]) "eng" ], "destinationLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "

こんにちは、今日はお元気ですか

大丈夫

" } @@ -614,30 +614,30 @@ print(r.json()["data"]) "service": "Google", "source": "おはよう", "sourceLanguage": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" - }, - "destinationLanguage": { + "alpha2": "en", "alpha3b": "eng", "alpha3t": "eng", "alpha3": "eng", - "name": "English", + "name": "English" + }, + "destinationLanguage": { "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Ohayou" } @@ -771,17 +771,17 @@ print(r.json()["data"]) "service": "Google", "source": "God morning", "sourceLang": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" }, "result": "Good morning" } @@ -913,17 +913,17 @@ print(r.json()["data"]) "service": "Google", "source": "Hello world", "result": { - "alpha3b": "eng", - "alpha3t": "eng", - "alpha3": "eng", - "name": "English", "inForeignLanguages": {}, "extra": { "scope": "Individual", "type": "Living" }, "id": "eng", - "alpha2": "en" + "alpha2": "en", + "alpha3b": "eng", + "alpha3t": "eng", + "alpha3": "eng", + "name": "English" } } }