This module contains a Google Cloud Translate Hook.

Module Contents



Hook for Google Cloud translate APIs.

class'google_cloud_default', impersonation_chain=None, **kwargs)[source]


Hook for Google Cloud translate APIs.

All the methods in the hook where project_id is used must be called with keyword arguments rather than positional.


Retrieve connection to Cloud Translate.


Google Cloud Translate client object.

Return type

translate(values, target_language, format_=None, source_language=None, model=None)[source]

Translate a string or list of strings.


  • values (str | list[str]) – String or list of strings to translate.

  • target_language (str) – The language to translate results into. This is required by the API and defaults to the target language of the current instance.

  • format – (Optional) One of text or html, to specify if the input text is plain text or HTML.

  • source_language (str | None) – (Optional) The language of the text to be translated.

  • model (str | list[str] | None) – (Optional) The model used to translate the text, such as 'base' or 'nmt'.


A list of dictionaries for each queried value. Each dictionary typically contains three keys (though not all will be present in all cases)

  • detectedSourceLanguage: The detected language (as an ISO 639-1 language code) of the text.

  • translatedText: The translation of the text into the target language.

  • input: The corresponding input value.

  • model: The model used to translate the text.

If only a single value is passed, then only a single dictionary will be returned.


ValueError if the number of values and translations differ.

Return type


Was this entry helpful?