Weblate/weblate
0
0
Fork 0
mirror of https://gh.wpcy.net/https://github.com/WeblateOrg/weblate.git synced 2026-04-26 20:24:26 +08:00
Code Issues Projects Releases Packages Activity Actions 6
weblate/docs/snippets/machines-autogenerated.rst
Gersona bf2d62dbe5
feat: Automatic documentation generation (#18152) 
* Automate docs generation for addons
* Automate docs generation for machinery
* refactor DocVersionsMixin
* Automate docs generation for checks
* setup DB/cache services in docs GA workflow
* update command name in comments
* improve test coverage
2026-03-17 17:48:07 +01:00

1184 lines
87 KiB
ReStructuredText
Raw Permalink Blame History

.. AUTOGENERATED START: alibaba
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-alibaba:
Alibaba
-------
.. versionadded:: 5.3
:Service ID: ``alibaba``
:Maximal score: 80
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``key`` | Access key ID | |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``secret`` | Access key secret | |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``region`` | Region ID | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: alibaba
Alibaba Translate is a neural machine translation service for translating text
and it supports up to 214 language pairs.
.. seealso::
`Alibaba Translate Documentation <https://www.alibabacloud.com/help/en/machine-translation>`_
.. AUTOGENERATED START: anthropic
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-anthropic:
Anthropic
---------
.. versionadded:: 5.16
:Service ID: ``anthropic``
:Maximal score: 90
:Advanced features: * :ref:`glossary-mt`
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``base_url`` | Anthropic API URL | Base URL of the Anthropic API. Leave empty to use the default URL. |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``model`` | Anthropic model | Available choices: |
| | | |
| | | ``claude-sonnet-4-5`` -- Claude Sonnet 4.5 (Recommended) |
| | | |
| | | ``claude-haiku-4-5`` -- Claude Haiku 4.5 |
| | | |
| | | ``claude-opus-4-5`` -- Claude Opus 4.5 |
| | | |
| | | ``custom`` -- Custom model |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``persona`` | Translator persona | Describe the persona of translator to improve the accuracy of the translation. For example: “You are a squirrel breeder.” |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``style`` | Translator style | Describe the style of translation. For example: “Use informal language.” |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``custom_model`` | Custom model name | Only needed when model is set to 'Custom model' |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``max_tokens`` | Max tokens | Maximum number of tokens to generate in the response. |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
.. AUTOGENERATED END: anthropic
Performs translation using `Anthropic's Claude`_ models.
The Anthropic API provides access to the Claude family of models, which are
known for their strong reasoning and language capabilities. You need an API key
from Anthropic to use this service.
Use persona and style fields to further fine-tune translations. These will be
used in a prompt for Claude and allow you to change the style of the
translations.
The service automatically uses :ref:`glossary`, see :ref:`glossary-mt`.
.. seealso::
* `Anthropic API documentation <https://docs.anthropic.com/en/api/getting-started>`_
* `Anthropic Console <https://console.anthropic.com/>`_
.. _Anthropic's Claude: https://www.anthropic.com/
.. AUTOGENERATED START: apertium-apy
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-apertium-apy:
Apertium APy
------------
:Service ID: ``apertium-apy``
:Maximal score: 88
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``url`` | API URL | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: apertium-apy
A libre software machine translation platform providing translations to
a limited set of languages.
The recommended way to use Apertium is to run your own Apertium-APy server.
.. seealso::
* `Apertium website <https://www.apertium.org/>`_
* `Apertium APy documentation <https://wiki.apertium.org/wiki/Apertium-apy>`_
.. AUTOGENERATED START: aws
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-aws:
Amazon Translate
----------------
:Service ID: ``aws``
:Maximal score: 88
:Advanced features: * :ref:`glossary-mt`
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``key`` | Access key ID | |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``secret`` | API secret key | |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``region`` | Region name | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: aws
Amazon Translate is a neural machine translation service for translating text
to and from English across a breadth of supported languages.
The service requires the `TranslateFullAccess` Managed Policy.
The service automatically uses :ref:`glossary`, see :ref:`glossary-mt`.
.. seealso::
* `Amazon Translate Documentation <https://docs.aws.amazon.com/translate/>`_
* `AWS TranslateFullAccess Policy <https://docs.aws.amazon.com/aws-managed-policy/latest/reference/TranslateFullAccess.html>`_
.. AUTOGENERATED START: azure-openai
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-azure-openai:
Azure OpenAI
------------
.. versionadded:: 5.8
:Service ID: ``azure-openai``
:Maximal score: 90
:Advanced features: * :ref:`glossary-mt`
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``base_url`` | API URL | |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``model`` | LLM model | |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``persona`` | Translator persona | Describe the persona of translator to improve the accuracy of the translation. For example: “You are a squirrel breeder.” |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``style`` | Translator style | Describe the style of translation. For example: “Use informal language.” |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``azure_endpoint`` | Azure OpenAI endpoint URL | Endpoint URL of the instance, e.g: https://my-instance.openai.azure.com. |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``deployment`` | Azure OpenAI deployment | The model's unique deployment name. |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
.. AUTOGENERATED END: azure-openai
Performs translation using `OpenAI`_ hosted on Azure.
.. seealso::
:ref:`mt-openai`
.. AUTOGENERATED START: baidu
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-baidu:
Baidu
-----
:Service ID: ``baidu``
:Maximal score: 90
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``key`` | Client ID | |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``secret`` | Client secret | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: baidu
Machine translation service provided by Baidu.
This service uses an API and you need to obtain an ID and API key from Baidu to use it.
.. seealso::
`Baidu Translate API <https://fanyi-api.baidu.com/product/11>`_
.. AUTOGENERATED START: cyrtranslit
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-cyrtranslit:
CyrTranslit
-----------
.. versionadded:: 5.7
:Service ID: ``cyrtranslit``
:Maximal score: 100
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: cyrtranslit
Machine translation service using the Cyrtranslit library.
This service converts text between Cyrillic and Latin scripts for languages that have both scripts.
.. seealso::
`Cyrtranslit repository <https://github.com/opendatakosovo/cyrillic-transliteration>`_
.. AUTOGENERATED START: deepl
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-deepl:
DeepL
-----
:Service ID: ``deepl``
:Maximal score: 91
:Advanced features: * :ref:`placeables-mt`
* :ref:`glossary-mt`
:Configuration: +---------------------+---------------------------+-------------------------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+-------------------------------------------------------------------------------------+
| ``url`` | API URL | |
+---------------------+---------------------------+-------------------------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+---------------------------+-------------------------------------------------------------------------------------+
| ``formality`` | Formality | Uses the specified formality if language is not specified as (in)formal |
+---------------------+---------------------------+-------------------------------------------------------------------------------------+
| ``context`` | Translation context | Describe the context of the translation to improve the accuracy of the translation. |
+---------------------+---------------------------+-------------------------------------------------------------------------------------+
| ``next_gen`` | Use next-gen model | Prefer next-gen LLM over classic machine translation model. |
+---------------------+---------------------------+-------------------------------------------------------------------------------------+
.. AUTOGENERATED END: deepl
DeepL is paid service providing good machine translation for a few languages.
You need to purchase :guilabel:`DeepL API` subscription or you can use legacy
:guilabel:`DeepL Pro (classic)` plan.
API URL to use with the DeepL service. At the time of writing, there is the v1 API
as well as a free and a paid version of the v2 API.
``https://api.deepl.com/v2/`` (default in Weblate)
Is meant for API usage on the paid plan, and the subscription is usage-based.
``https://api-free.deepl.com/v2/``
Is meant for API usage on the free plan, and the subscription is usage-based.
``https://api.deepl.com/v1/``
Is meant for CAT tools and is usable with a per-user subscription.
.. note::
Previously Weblate was classified as a CAT tool by DeepL, so it was supposed
to use the v1 API, but now is supposed to use the v2 API. Therefore it
defaults to v2, and you can change it to v1 in case you have an existing CAT
subscription and want Weblate to use that.
Weblate supports DeepL formality, it will choose matching one based on the
language (for example, there is ``de@formal`` and ``de@informal``).
The translation context can optionally be specified to improve translations quality. Read more on that in
`DeepL translation context documentation <https://developers.deepl.com/docs/best-practices/working-with-context>`_.
The service automatically uses :ref:`glossary`, see :ref:`glossary-mt`.
.. seealso::
* `DeepL translator <https://www.deepl.com/translator>`_
* `DeepL pricing <https://www.deepl.com/pro>`_
* `DeepL API documentation <https://developers.deepl.com/docs/getting-started/intro>`_
.. AUTOGENERATED START: glosbe
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-glosbe:
Glosbe
------
:Service ID: ``glosbe``
:Maximal score: 90
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: glosbe
Free dictionary and translation memory for almost every living language.
The API is gratis to use, but usage of the translations is subject to the
license of the used data source. There is a limit of calls that may be done
from one IP in a set period of time, to prevent abuse.
.. seealso::
`Glosbe website <https://glosbe.com/>`_
.. AUTOGENERATED START: google-translate
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-google-translate:
Google Cloud Translation Basic
------------------------------
:Service ID: ``google-translate``
:Maximal score: 90
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: google-translate
Machine translation service provided by the Google Cloud services.
This service uses the Google Translation API v2, and you need to obtain an API key and turn on
billing in the Google API console.
.. seealso::
`Google translate documentation <https://docs.cloud.google.com/translate/docs>`_
.. AUTOGENERATED START: google-translate-api-v3
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-google-translate-api-v3:
Google Cloud Translation Advanced
---------------------------------
:Service ID: ``google-translate-api-v3``
:Maximal score: 90
:Advanced features: * :ref:`placeables-mt`
* :ref:`glossary-mt`
:Configuration: +---------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| ``credentials`` | Google Translate service account info | Enter a JSON key for the service account. |
+---------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| ``project`` | Google Translate project | Enter the numeric or alphanumeric ID of your Google Cloud project. |
+---------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| ``location`` | Google Translate location | Choose a Google Cloud Translation region that is used for the Google Cloud project or is closest to you. |
+---------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------+
| ``bucket_name`` | Google Storage Bucket name | Enter the name of the Google Cloud Storage bucket that is used to store the Glossary files. |
+---------------------+---------------------------------------+----------------------------------------------------------------------------------------------------------+
.. AUTOGENERATED END: google-translate-api-v3
Machine translation service provided by the Google Cloud services.
This service uses the Google Translation API v3 and you need credentials in JSON format to access it.
In order to use this service, you first need to go through the following steps:
1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. `Enable the Cloud Translation.`_
4. `Setup Authentication.`_
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://docs.cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Cloud Translation.: https://docs.cloud.google.com/translate/docs
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
Optionally, you can configure the service to use :ref:`glossary` by setting up a Bucket:
1. `Create a Google Cloud bucket.`_
2. `Set bucket location to "us-central1".`_
3. `Grant 'Storage Admin' permission to the Service Account.`_
.. _Create a Google Cloud bucket.: https://docs.cloud.google.com/storage/docs/creating-buckets
.. _Set bucket location to "us-central1".: https://docs.cloud.google.com/translate/docs/migrate-to-v3#resources_projects_and_locations
.. _Grant 'Storage Admin' permission to the Service Account.: https://docs.cloud.google.com/translate/docs/access-control
.. seealso::
* `Google translate documentation <https://docs.cloud.google.com/translate/docs>`_
* `Authenticate to Cloud services using client libraries <https://docs.cloud.google.com/docs/authentication/client-libraries>`_
* `Creating Google Translate project <https://docs.cloud.google.com/appengine/docs/standard/nodejs/building-app/creating-project>`_
* `Google Cloud App Engine locations <https://docs.cloud.google.com/appengine/docs/standard/locations>`_
.. _mt-ibm:
IBM Watson Language Translator
------------------------------
.. versionremoved:: 5.13.1
This service was withdrawn by vendor as of 10 December 2024.
.. AUTOGENERATED START: libretranslate
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-libretranslate:
LibreTranslate
--------------
.. versionadded:: 4.7.1
:Service ID: ``libretranslate``
:Maximal score: 89
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``url`` | API URL | |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: libretranslate
LibreTranslate is a free and open-source service for machine translations. The
public instance requires an API key, but LibreTranslate can be self-hosted
and there are several mirrors available to use the API for free.
``https://libretranslate.com/`` (official public instance)
Requires an API key to use outside of the website.
.. seealso::
* `LibreTranslate website <https://libretranslate.com/>`_
* `LibreTranslate repository <https://github.com/LibreTranslate/LibreTranslate>`_
* :ref:`docker-libretranslate`
..
# spellchecker:off
.. AUTOGENERATED START: microsoft-translator
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-microsoft-translator:
Azure AI Translator
-------------------
:Service ID: ``microsoft-translator``
:Maximal score: 90
:Advanced features: * :ref:`placeables-mt`
* :ref:`glossary-mt`
:Configuration: +---------------------+-------------------------------+---------------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+-------------------------------+---------------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+-------------------------------+---------------------------------------------------------------------------+
| ``base_url`` | Application base URL | Available choices: |
| | | |
| | | ``api.cognitive.microsofttranslator.com`` -- Global (non-regional) |
| | | |
| | | ``api-apc.cognitive.microsofttranslator.com`` -- Asia Pacific |
| | | |
| | | ``api-eur.cognitive.microsofttranslator.com`` -- Europe |
| | | |
| | | ``api-nam.cognitive.microsofttranslator.com`` -- North America |
| | | |
| | | ``api.translator.azure.cn`` -- China |
| | | |
| | | ``api.cognitive.microsofttranslator.us`` -- Azure US Government cloud |
+---------------------+-------------------------------+---------------------------------------------------------------------------+
| ``endpoint_url`` | Authentication service URL | Regional or multi-service can be specified using region field below. |
| | | |
| | | Available choices: |
| | | |
| | | ``api.cognitive.microsoft.com`` -- Global |
| | | |
| | | ``api.cognitive.azure.cn`` -- China |
| | | |
| | | ``api.cognitive.microsoft.us`` -- Azure US Government cloud |
+---------------------+-------------------------------+---------------------------------------------------------------------------+
| ``region`` | Authentication service region | |
+---------------------+-------------------------------+---------------------------------------------------------------------------+
| ``category`` | Category | Specify a customized system category ID to use it instead of general one. |
+---------------------+-------------------------------+---------------------------------------------------------------------------+
.. AUTOGENERATED END: microsoft-translator
..
# spellchecker:on
Machine translation service provided by Microsoft in Azure portal as a one of
Cognitive Services.
Weblate implements Translator API V3.
The service automatically uses :ref:`glossary` via `dynamic dictionary <https://learn.microsoft.com/en-us/azure/ai-services/translator/dynamic-dictionary>`_, see :ref:`glossary-mt`.
Translator Text API V2
``````````````````````
The key you use with Translator API V2 can be used with API 3.
Translator Text API V3
``````````````````````
You need to register at Azure portal and use the key you obtain there.
With new Azure keys, you also need to set ``region`` to locale of your service.
You can also specify a custom category to use `custom translator <https://learn.microsoft.com/en-gb/azure/ai-services/Translator/custom-translator/concepts/customization>`_.
.. hint::
For Azure China, please use your endpoint from the Azure Portal.
.. seealso::
* `Cognitive Services - Text Translation API <https://azure.microsoft.com/en-us/products/ai-services/ai-translator>`_
* `Microsoft Azure Portal <https://portal.azure.com/>`_
* `Base URLs <https://learn.microsoft.com/en-us/azure/ai-services/translator/text-translation/reference/v3/reference#base-urls>`_
* `"Authenticating with a Multi-service resource" <https://learn.microsoft.com/en-us/azure/ai-services/translator/text-translation/reference/authentication#authenticating-with-a-multi-service-resource>`_
* `"Authenticating with an access token" section <https://learn.microsoft.com/en-us/azure/ai-services/translator/text-translation/reference/authentication#authenticating-with-an-access-token>`_
.. AUTOGENERATED START: modernmt
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-modernmt:
ModernMT
--------
.. versionadded:: 4.2
:Service ID: ``modernmt``
:Maximal score: 90
:Advanced features: * :ref:`glossary-mt`
:Configuration: +---------------------+---------------------------+-----------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+-----------------------------------------------------------------------+
| ``url`` | API URL | |
+---------------------+---------------------------+-----------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+---------------------------+-----------------------------------------------------------------------+
| ``context_vector`` | Context vector | Comma-separated list of memory IDs:weight. e.g: 1234:0.123,4567:0.456 |
+---------------------+---------------------------+-----------------------------------------------------------------------+
.. AUTOGENERATED END: modernmt
The service automatically uses :ref:`glossary`, see :ref:`glossary-mt`.
.. seealso::
`ModernMT API <https://www.modernmt.com/api/#translation>`_
.. AUTOGENERATED START: mymemory
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-mymemory:
MyMemory
--------
:Service ID: ``mymemory``
:Maximal score: 100
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``email`` | Contact e-mail | |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``username`` | Username | |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: mymemory
Huge translation memory with machine translation.
Free, anonymous usage is currently limited to 100 requests/day, or to 1000
requests/day when you provide a contact e-mail address in ``email``.
You can also ask them for more.
.. seealso::
`MyMemory website <https://mymemory.translated.net/>`_
.. AUTOGENERATED START: netease-sight
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-netease-sight:
Netease Sight
-------------
:Service ID: ``netease-sight``
:Maximal score: 90
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``key`` | Client ID | |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``secret`` | Client secret | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: netease-sight
Machine translation service provided by NetEase.
This service uses an API, and you need to obtain key and secret from NetEase.
.. seealso::
`NetEase Sight Translation Platform <https://sight.youdao.com/>`_
.. AUTOGENERATED START: ollama
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-ollama:
Ollama
------
.. versionadded:: 5.15
:Service ID: ``ollama``
:Maximal score: 90
:Advanced features: * :ref:`glossary-mt`
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``base_url`` | API URL | Base URL of the Ollama API, localhost and port 11434 by default. |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``model`` | Ollama model | Name of the model described in Ollama catalogue. |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``persona`` | Translator persona | Describe the persona of translator to improve the accuracy of the translation. For example: “You are a squirrel breeder.” |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``style`` | Translator style | Describe the style of translation. For example: “Use informal language.” |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
.. AUTOGENERATED END: ollama
Performs translation using `Ollama`_ models.
The Ollama API allows for the use of open source models for translations
either locally installed or remotely accessed via the `Ollama`_ service.
Note that before configuring your models, you should have `Ollama installed`_
and downloaded the models you wish to use.
Use persona and style fields to further fine-tune translations. These will be
used in a prompt for Ollama and allow you to change the style of the
translations.
The service automatically uses :ref:`glossary`, see :ref:`glossary-mt`.
.. seealso::
* `Ollama models <https://ollama.com/search>`_
.. _Ollama: https://ollama.com/
.. _Ollama installed: https://ollama.com/download
.. AUTOGENERATED START: openai
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-openai:
OpenAI
------
.. versionadded:: 5.3
:Service ID: ``openai``
:Maximal score: 90
:Advanced features: * :ref:`glossary-mt`
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``base_url`` | OpenAI API base URL | Base URL of the OpenAI API, if it differs from the OpenAI default URL |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``model`` | OpenAI model | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``gpt-5-nano`` -- GPT-5-nano |
| | | |
| | | ``gpt-5-mini`` -- GPT-5-mini |
| | | |
| | | ``gpt-5.2`` -- GPT-5.2 |
| | | |
| | | ``gpt-5.1`` -- GPT-5.1 |
| | | |
| | | ``gpt-5`` -- GPT-5 |
| | | |
| | | ``gpt-4.1-nano`` -- GPT-4.1-nano |
| | | |
| | | ``gpt-4.1-mini`` -- GPT-4.1-mini |
| | | |
| | | ``gpt-4.1`` -- GPT-4.1 |
| | | |
| | | ``gpt-4o-mini`` -- GPT-4o mini |
| | | |
| | | ``gpt-4o`` -- GPT-4o |
| | | |
| | | ``o3-mini`` -- o3-mini |
| | | |
| | | ``o3`` -- o3 |
| | | |
| | | ``o1-mini`` -- o1-mini |
| | | |
| | | ``o1`` -- o1 |
| | | |
| | | ``o1-pro`` -- o1-pro |
| | | |
| | | ``custom`` -- Custom model |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``persona`` | Translator persona | Describe the persona of translator to improve the accuracy of the translation. For example: “You are a squirrel breeder.” |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``style`` | Translator style | Describe the style of translation. For example: “Use informal language.” |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``custom_model`` | Custom model name | Only needed when model is set to 'Custom model' |
+---------------------+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
.. AUTOGENERATED END: openai
Performs translation using `OpenAI`_.
The OpenAI API is powered by a diverse set of models with different
capabilities and price points. Automatic selection chooses the best model
available, but you might want to choose a specific model that matches your needs.
Use persona and style fields to further fine-tune translations. These will be
used in a prompt for OpenAI and allow you to change the style of the
translations.
The service automatically uses :ref:`glossary`, see :ref:`glossary-mt`.
.. versionchanged:: 5.7
Support for custom model and base URL was added.
.. seealso::
* `OpenAI models <https://platform.openai.com/docs/models>`_
* `OpenAI API keys <https://platform.openai.com/api-keys>`_
.. _OpenAI: https://openai.com/
.. AUTOGENERATED START: sap-translation-hub
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-sap-translation-hub:
SAP Translation Hub
-------------------
:Service ID: ``sap-translation-hub``
:Maximal score: 100
:Configuration: +---------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``url`` | API URL | |
+---------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``username`` | SAP username | |
+---------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``password`` | SAP password | |
+---------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``enable_mt`` | Enable machine translation | |
+---------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``domain`` | Translation domain | The ID of a translation domain, for example, BC. If you do not specify a domain, the method searches for translations in all available domains. |
+---------------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
.. AUTOGENERATED END: sap-translation-hub
Machine translation service provided by SAP.
You need to have a SAP account (and the SAP Translation Hub enabled in the SAP Cloud
Platform) to use this service.
You can also configure whether to also use machine translation services, in
addition to the term database.
.. note::
To access the Sandbox API, you need to set ``url``
and ``key``.
To access the productive API, you need to set ``url``, ``username`` and ``password``.
.. seealso::
* `What is SAP Translation Hub <https://help.sap.com/docs/translation-hub/sap-translation-hub/what-is-sap-translation-hub>`_
* `SAP Translation Hub API <https://api.sap.com/api/translationhub/overview>`_
.. AUTOGENERATED START: systran
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-systran:
Systran
-------
:Service ID: ``systran``
:Maximal score: 90
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: systran
Machine translation service provided by Systran.
This service uses an API, and you need to obtain API key at <https://translate.systran.net/en/account>.
.. AUTOGENERATED START: tmserver
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-tmserver:
tmserver
--------
:Service ID: ``tmserver``
:Maximal score: 100
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``url`` | API URL | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: tmserver
You can run your own translation memory server by using a tmserver protocol.
* The original :program:`tmserver` was bundled with the translate-toolkit.
* amaGama server is an enhanced version of tmserver.
.. note::
There currently does not seem to be a maintained server for this.
.. AUTOGENERATED START: weblate
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-weblate:
Weblate
-------
:Service ID: ``weblate``
:Maximal score: 100
:Configuration: `This service has no configuration.`
.. AUTOGENERATED END: weblate
Weblate machine translation service can provide translations based
on the exact matches of a string in the currently existing strings
in a :guilabel:`Translated`, :guilabel:`Approved`,
or :guilabel:`Read-only` :ref:`states <states>` inside Weblate.
.. AUTOGENERATED START: weblate-translation-memory
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-weblate-translation-memory:
Weblate Translation Memory
--------------------------
:Service ID: ``weblate-translation-memory``
:Maximal score: 100
:Configuration: `This service has no configuration.`
.. AUTOGENERATED END: weblate-translation-memory
Use :ref:`translation-memory` as a machine translation service.
Any string that has been translated before (or uploaded to the
translation memory) can be translated in this way.
This suggestion source works with fuzzy matching.
.. note::
Recreating :ref:`translation-memory` reduces capabilities of this TM source.
.. AUTOGENERATED START: yandex
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-yandex:
Yandex
------
:Service ID: ``yandex``
:Maximal score: 90
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: yandex
Machine translation service provided by Yandex.
This service uses a Translation API, and you need to obtain an API key from Yandex.
.. seealso::
* `Yandex Translate API <https://yandex.com/dev/translate/>`_
* `Powered by Yandex.Translate <https://translate.yandex.com/>`_
.. AUTOGENERATED START: yandex-v2
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-yandex-v2:
Yandex v2
---------
.. versionadded:: 5.1
:Service ID: ``yandex-v2``
:Maximal score: 90
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``key`` | API key | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: yandex-v2
Machine translation service provided by Yandex.
This service uses a Translation API, and you need to obtain an API key from Yandex Cloud.
.. seealso::
* `Yandex Translate API v2 <https://cloud.yandex.com/en/docs/translate/api-ref/authentication>`_
* `Powered by Yandex.Cloud <https://cloud.yandex.com/en/services/translate>`_
.. AUTOGENERATED START: youdao-zhiyun
.. This section is automatically generated by `./manage.py list_machinery`. Do not edit manually.
.. _mt-youdao-zhiyun:
Youdao Zhiyun
-------------
:Service ID: ``youdao-zhiyun``
:Maximal score: 90
:Configuration: +---------------------+---------------------------+---------------------------------------------------------------------+
| ``source_language`` | Source language selection | Available choices: |
| | | |
| | | ``auto`` -- Automatic selection |
| | | |
| | | ``source`` -- Component source language |
| | | |
| | | ``secondary`` -- Secondary language defined in project or component |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``key`` | Client ID | |
+---------------------+---------------------------+---------------------------------------------------------------------+
| ``secret`` | Client secret | |
+---------------------+---------------------------+---------------------------------------------------------------------+
.. AUTOGENERATED END: youdao-zhiyun
Machine translation service provided by Youdao.
This service uses an API, and you need to obtain an ID and an API key from Youdao.
.. seealso::
`Youdao Zhiyun Natural Language Translation Service <https://ai.youdao.com/product-fanyi-text.s>`_
Reference in a new issue View git blame Copy permalink