Class Client

Client(
    target_language="en",
    credentials=None,
    _http=None,
    client_info=None,
    client_options=None,
)

Client to bundle configuration needed for API requests.

Parameters

NameDescription
target_language str

(Optional) The target language used for translations and language names. (Defaults to :data:ENGLISH_ISO_639.)

credentials `google.auth.credentials.Credentials`

(Optional) The OAuth2 Credentials to use for this client. If not passed (and if no _http object is passed), falls back to the default inferred from the environment.

_http `requests.Session`

(Optional) HTTP object to make requests. Can be any object that defines request() with the same interface as requests.Session.request. If not passed, an _http object is created that is bound to the credentials for the current object. This parameter should be considered private, and could change in the future.

client_info `google.api_core.client_info.ClientInfo`

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own library or partner tool.

client_options `google.api_core.client_options.ClientOptions` or `dict`

(Optional) Client options used to set user options on the client. API Endpoint should be set through client_options.

Inheritance

builtins.object > google.cloud.client._ClientFactoryMixin > google.cloud.client.Client > Client

Methods

detect_language

detect_language(values)

Detect the language of a string or list of strings.

See https://cloud.google.com/translate/docs/detecting-language

Parameter
NameDescription
values str or list

String or list of strings that will have language detected.

Exceptions
TypeDescription
`ValueErro
Returns
TypeDescription
dict or listA list of dictionaries for each queried value. Each dictionary typically contains three keys * ``confidence``: The confidence in language detection, a float between 0 and 1. * ``input``: The corresponding input value. * ``language``: The detected language (as an ISO 639-1 language code). though the key ``confidence`` may not always be present. If only a single value is passed, then only a single dictionary will be returned.

get_languages

get_languages(target_language=None)

Get list of supported languages for translation.

Response

See https://cloud.google.com/translate/docs/discovering-supported-languages

Parameter
NameDescription
target_language str

(Optional) The language used to localize returned language names. Defaults to the target language on the current client.

Returns
TypeDescription
listList of dictionaries. Each dictionary contains a supported ISO 639-1 language code (using the dictionary key ``language``). If ``target_language`` is passed, each dictionary will also contain the name of each supported language (localized to the target language).

translate

translate(
    values,
    target_language=None,
    format_=None,
    source_language=None,
    customization_ids=(),
    model=None,
)

Translate a string or list of strings.

See https://cloud.google.com/translate/docs/translating-text

Parameters
NameDescription
values str or list

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_ str

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

source_language str

(Optional) The language of the text to be translated.

customization_ids str or list

(Optional) ID or list of customization IDs for translation. Sets the cid parameter in the query.

model str

(Optional) The model used to translate the text, such as 'base' or 'nmt'.

Exceptions
TypeDescription
`exceptions.ValueErrorif the number of values and translations differ.
Returns
TypeDescription
dict or listA 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.