Class TextToSpeechClient (2.17.1) 

TextToSpeechClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.texttospeech_v1beta1.services.text_to_speech.transports.base.TextToSpeechTransport, typing.Callable[[...], google.cloud.texttospeech_v1beta1.services.text_to_speech.transports.base.TextToSpeechTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service that implements Google Cloud Text-to-Speech API.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
TextToSpeechTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

TextToSpeechClient

TextToSpeechClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.texttospeech_v1beta1.services.text_to_speech.transports.base.TextToSpeechTransport, typing.Callable[[...], google.cloud.texttospeech_v1beta1.services.text_to_speech.transports.base.TextToSpeechTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the text to speech client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Optional[Union[str,TextToSpeechTransport,Callable[..., TextToSpeechTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the TextToSpeechTransport constructor. If set to None, a transport is chosen automatically. NOTE: "rest" transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library's source repository.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info google.api_core.gapic_v1.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 client library.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
TextToSpeechClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
TextToSpeechClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
TextToSpeechClient The constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.operations_pb2.Operation An Operation object.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

list_voices

list_voices(
    request: typing.Optional[
        typing.Union[
            google.cloud.texttospeech_v1beta1.types.cloud_tts.ListVoicesRequest, dict
        ]
    ] = None,
    *,
    language_code: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.texttospeech_v1beta1.types.cloud_tts.ListVoicesResponse

Returns a list of Voice supported for synthesis.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import texttospeech_v1beta1

def sample_list_voices():
    # Create a client
    client = texttospeech_v1beta1.TextToSpeechClient()

    # Initialize request argument(s)
    request = texttospeech_v1beta1.ListVoicesRequest(
    )

    # Make the request
    response = client.list_voices(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.texttospeech_v1beta1.types.ListVoicesRequest, dict]

The request object. The top-level message sent by the client for the ListVoices method.
language_code str

Optional. Recommended. BCP-47 https://www.rfc-editor.org/rfc/bcp/bcp47.txt__ language tag. If not specified, the API will return all supported voices. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. For example, if you specify "en-NZ", all "en-NZ" voices will be returned. If you specify "no", both "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices will be returned. This corresponds to the language_code field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.texttospeech_v1beta1.types.ListVoicesResponse The message returned to the client by the ListVoices method.

model_path

model_path(project: str, location: str, model: str) -> str

Returns a fully-qualified model string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_model_path

parse_model_path(path: str) -> typing.Dict[str, str]

Parses a model path into its component segments.

streaming_synthesize

streaming_synthesize(
    requests: typing.Optional[
        typing.Iterator[
            google.cloud.texttospeech_v1beta1.types.cloud_tts.StreamingSynthesizeRequest
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[
    google.cloud.texttospeech_v1beta1.types.cloud_tts.StreamingSynthesizeResponse
]

Performs bidirectional streaming speech synthesis: receive audio while sending text.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import texttospeech_v1beta1

def sample_streaming_synthesize():
    # Create a client
    client = texttospeech_v1beta1.TextToSpeechClient()

    # Initialize request argument(s)
    streaming_config = texttospeech_v1beta1.StreamingSynthesizeConfig()
    streaming_config.voice.language_code = "language_code_value"

    request = texttospeech_v1beta1.StreamingSynthesizeRequest(
        streaming_config=streaming_config,
    )

    # This method expects an iterator which contains
    # 'texttospeech_v1beta1.StreamingSynthesizeRequest' objects
    # Here we create a generator that yields a single `request` for
    # demonstrative purposes.
    requests = [request]

    def request_generator():
        for request in requests:
            yield request

    # Make the request
    stream = client.streaming_synthesize(requests=request_generator())

    # Handle the response
    for response in stream:
        print(response)
Parameters
Name Description
requests Iterator[google.cloud.texttospeech_v1beta1.types.StreamingSynthesizeRequest]

The request object iterator. Request message for the StreamingSynthesize method. Multiple StreamingSynthesizeRequest messages are sent in one call. The first message must contain a streaming_config that fully specifies the request configuration and must not contain input. All subsequent messages must only have input set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
Iterable[google.cloud.texttospeech_v1beta1.types.StreamingSynthesizeResponse] StreamingSynthesizeResponse is the only message returned to the client by StreamingSynthesize method. A series of zero or more StreamingSynthesizeResponse messages are streamed back to the client.

synthesize_speech

synthesize_speech(
    request: typing.Optional[
        typing.Union[
            google.cloud.texttospeech_v1beta1.types.cloud_tts.SynthesizeSpeechRequest,
            dict,
        ]
    ] = None,
    *,
    input: typing.Optional[
        google.cloud.texttospeech_v1beta1.types.cloud_tts.SynthesisInput
    ] = None,
    voice: typing.Optional[
        google.cloud.texttospeech_v1beta1.types.cloud_tts.VoiceSelectionParams
    ] = None,
    audio_config: typing.Optional[
        google.cloud.texttospeech_v1beta1.types.cloud_tts.AudioConfig
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.texttospeech_v1beta1.types.cloud_tts.SynthesizeSpeechResponse

Synthesizes speech synchronously: receive results after all text input has been processed.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import texttospeech_v1beta1

def sample_synthesize_speech():
    # Create a client
    client = texttospeech_v1beta1.TextToSpeechClient()

    # Initialize request argument(s)
    input = texttospeech_v1beta1.SynthesisInput()
    input.text = "text_value"

    voice = texttospeech_v1beta1.VoiceSelectionParams()
    voice.language_code = "language_code_value"

    audio_config = texttospeech_v1beta1.AudioConfig()
    audio_config.audio_encoding = "ALAW"

    request = texttospeech_v1beta1.SynthesizeSpeechRequest(
        input=input,
        voice=voice,
        audio_config=audio_config,
    )

    # Make the request
    response = client.synthesize_speech(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.texttospeech_v1beta1.types.SynthesizeSpeechRequest, dict]

The request object. The top-level message sent by the client for the SynthesizeSpeech method.
input google.cloud.texttospeech_v1beta1.types.SynthesisInput

Required. The Synthesizer requires either plain text or SSML as input. This corresponds to the input field on the request instance; if request is provided, this should not be set.
voice google.cloud.texttospeech_v1beta1.types.VoiceSelectionParams

Required. The desired voice of the synthesized audio. This corresponds to the voice field on the request instance; if request is provided, this should not be set.
audio_config google.cloud.texttospeech_v1beta1.types.AudioConfig

Required. The configuration of the synthesized audio. This corresponds to the audio_config field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.texttospeech_v1beta1.types.SynthesizeSpeechResponse The message returned to the client by the SynthesizeSpeech method.