airflow.providers.google.cloud.hooks.text_to_speech¶

This module contains a Google Cloud Text to Speech Hook.

Classes¶

CloudTextToSpeechHook

Hook for Google Cloud Text to Speech API.

Module Contents¶

class airflow.providers.google.cloud.hooks.text_to_speech.CloudTextToSpeechHook(gcp_conn_id='google_cloud_default', impersonation_chain=None, **kwargs)[source]¶

Bases: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

Hook for Google Cloud Text to Speech API.

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

Parameters:

gcp_conn_id (str) – The connection ID to use when fetching connection info.
impersonation_chain (str | collections.abc.Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account.

get_conn()[source]¶

Retrieve connection to Cloud Text to Speech.

Returns:: Google Cloud Text to Speech client object.
Return type:: google.cloud.texttospeech_v1.TextToSpeechClient

synthesize_speech(input_data, voice, audio_config, retry=DEFAULT, timeout=None)[source]¶

Synthesizes text input.

Parameters:

input_data (dict | google.cloud.texttospeech_v1.types.SynthesisInput) – text input to be synthesized. See more: https://googleapis.github.io/google-cloud-python/latest/texttospeech/gapic/v1/types.html#google.cloud.texttospeech_v1.types.SynthesisInput
voice (dict | google.cloud.texttospeech_v1.types.VoiceSelectionParams) – configuration of voice to be used in synthesis. See more: https://googleapis.github.io/google-cloud-python/latest/texttospeech/gapic/v1/types.html#google.cloud.texttospeech_v1.types.VoiceSelectionParams
audio_config (dict | google.cloud.texttospeech_v1.types.AudioConfig) – configuration of the synthesized audio. See more: https://googleapis.github.io/google-cloud-python/latest/texttospeech/gapic/v1/types.html#google.cloud.texttospeech_v1.types.AudioConfig
retry (google.api_core.retry.Retry | google.api_core.gapic_v1.method._MethodDefault) – (Optional) A retry object used to retry requests. If None is specified, requests will not be retried.
timeout (float | None) – (Optional) The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

Returns:

SynthesizeSpeechResponse See more: https://googleapis.github.io/google-cloud-python/latest/texttospeech/gapic/v1/types.html#google.cloud.texttospeech_v1.types.SynthesizeSpeechResponse

Return type:

google.cloud.texttospeech_v1.types.SynthesizeSpeechResponse