Speech<a class="headerlink" href="#module-google.cloud.speech_v2.services.speech" title="Permalink to this headline">¶

async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (CancelOperationRequest) – The request object. Request message for CancelOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

None

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

static config_path(project: str, location: str) → str¶: Returns a fully-qualified config string.

async create_custom_class(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.CreateCustomClassRequest, dict]] = None, *, parent: Optional[str] = None, custom_class: Optional[google.cloud.speech_v2.types.cloud_speech.CustomClass] = None, custom_class_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a [CustomClass][google.cloud.speech.v2.CustomClass].

# 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 speech_v2

async def sample_create_custom_class():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.CreateCustomClassRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_custom_class(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.CreateCustomClassRequest, dict]]) – The request object. Request message for the [CreateCustomClass][google.cloud.speech.v2.Speech.CreateCustomClass] method.
parent (str) –
Required. The project and location where this CustomClass will be created. The expected format is projects/{project}/locations/{location}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
custom_class (google.cloud.speech_v2.types.CustomClass) – Required. The CustomClass to create. This corresponds to the custom_class field on the request instance; if request is provided, this should not be set.
custom_class_id (str) –
The ID to use for the CustomClass, which will become the final component of the CustomClass’s resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

This corresponds to the custom_class_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.CustomClass CustomClass for biasing in speech recognition. Used to define a set of words: or phrases that represents a common concept or theme likely to appear in your audio, for example a list of passenger ship names.

Return type

async create_phrase_set(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.CreatePhraseSetRequest, dict]] = None, *, parent: Optional[str] = None, phrase_set: Optional[google.cloud.speech_v2.types.cloud_speech.PhraseSet] = None, phrase_set_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a [PhraseSet][google.cloud.speech.v2.PhraseSet].

# 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 speech_v2

async def sample_create_phrase_set():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.CreatePhraseSetRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_phrase_set(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.CreatePhraseSetRequest, dict]]) – The request object. Request message for the [CreatePhraseSet][google.cloud.speech.v2.Speech.CreatePhraseSet] method.
parent (str) –
Required. The project and location where this PhraseSet will be created. The expected format is projects/{project}/locations/{location}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
phrase_set (google.cloud.speech_v2.types.PhraseSet) – Required. The PhraseSet to create. This corresponds to the phrase_set field on the request instance; if request is provided, this should not be set.
phrase_set_id (str) –
The ID to use for the PhraseSet, which will become the final component of the PhraseSet’s resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

This corresponds to the phrase_set_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.PhraseSet PhraseSet for biasing in speech recognition. A PhraseSet is used to provide: ”hints” to the speech recognizer to favor specific words and phrases in the results.

Return type

async create_recognizer(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.CreateRecognizerRequest, dict]] = None, *, parent: Optional[str] = None, recognizer: Optional[google.cloud.speech_v2.types.cloud_speech.Recognizer] = None, recognizer_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a [Recognizer][google.cloud.speech.v2.Recognizer].

# 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 speech_v2

async def sample_create_recognizer():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.CreateRecognizerRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_recognizer(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.CreateRecognizerRequest, dict]]) – The request object. Request message for the [CreateRecognizer][google.cloud.speech.v2.Speech.CreateRecognizer] method.
parent (str) –
Required. The project and location where this Recognizer will be created. The expected format is projects/{project}/locations/{location}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
recognizer (google.cloud.speech_v2.types.Recognizer) – Required. The Recognizer to create. This corresponds to the recognizer field on the request instance; if request is provided, this should not be set.
recognizer_id (str) –
The ID to use for the Recognizer, which will become the final component of the Recognizer’s resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

This corresponds to the recognizer_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.Recognizer A Recognizer message. Stores recognition configuration and metadata.

Return type

static crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) → str¶: Returns a fully-qualified crypto_key string.

static crypto_key_version_path(project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str) → str¶: Returns a fully-qualified crypto_key_version string.

static custom_class_path(project: str, location: str, custom_class: str) → str¶: Returns a fully-qualified custom_class string.

async delete_custom_class(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.DeleteCustomClassRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes the [CustomClass][google.cloud.speech.v2.CustomClass].

# 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 speech_v2

async def sample_delete_custom_class():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.DeleteCustomClassRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_custom_class(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.DeleteCustomClassRequest, dict]]) – The request object. Request message for the [DeleteCustomClass][google.cloud.speech.v2.Speech.DeleteCustomClass] method.
name (str) –
Required. The name of the CustomClass to delete. Format: projects/{project}/locations/{location}/customClasses/{custom_class}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.CustomClass CustomClass for biasing in speech recognition. Used to define a set of words: or phrases that represents a common concept or theme likely to appear in your audio, for example a list of passenger ship names.

Return type

async delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

None

async delete_phrase_set(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.DeletePhraseSetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes the [PhraseSet][google.cloud.speech.v2.PhraseSet].

# 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 speech_v2

async def sample_delete_phrase_set():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.DeletePhraseSetRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_phrase_set(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.DeletePhraseSetRequest, dict]]) – The request object. Request message for the [DeletePhraseSet][google.cloud.speech.v2.Speech.DeletePhraseSet] method.
name (str) –
Required. The name of the PhraseSet to delete. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.PhraseSet PhraseSet for biasing in speech recognition. A PhraseSet is used to provide: ”hints” to the speech recognizer to favor specific words and phrases in the results.

Return type

async delete_recognizer(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.DeleteRecognizerRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes the [Recognizer][google.cloud.speech.v2.Recognizer].

# 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 speech_v2

async def sample_delete_recognizer():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.DeleteRecognizerRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_recognizer(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.DeleteRecognizerRequest, dict]]) – The request object. Request message for the [DeleteRecognizer][google.cloud.speech.v2.Speech.DeleteRecognizer] method.
name (str) –
Required. The name of the Recognizer to delete. Format: projects/{project}/locations/{location}/recognizers/{recognizer}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.Recognizer A Recognizer message. Stores recognition configuration and metadata.

Return type

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SpeechAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SpeechAsyncClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SpeechAsyncClient

async get_config(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.GetConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.types.cloud_speech.Config[source]¶

Returns the requested [Config][google.cloud.speech.v2.Config].

# 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 speech_v2

async def sample_get_config():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.GetConfigRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.GetConfigRequest, dict]]) – The request object. Request message for the [GetConfig][google.cloud.speech.v2.Speech.GetConfig] method.
name (str) –
Required. The name of the config to retrieve. There is exactly one config resource per project per location. The expected format is projects/{project}/locations/{location}/config.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Message representing the config for the Speech-to-Text API. This includes an: optional [KMS key](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which incoming data will be encrypted.

Return type

google.cloud.speech_v2.types.CustomClass

async get_custom_class(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.GetCustomClassRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.types.cloud_speech.CustomClass[source]¶

Returns the requested [CustomClass][google.cloud.speech.v2.CustomClass].

# 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 speech_v2

async def sample_get_custom_class():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.GetCustomClassRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_custom_class(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.GetCustomClassRequest, dict]]) – The request object. Request message for the [GetCustomClass][google.cloud.speech.v2.Speech.GetCustomClass] method.
name (str) –
Required. The name of the CustomClass to retrieve. The expected format is projects/{project}/locations/{location}/customClasses/{custom_class}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

CustomClass for biasing in speech recognition. Used to define a set of words or phrases that represents a common concept or theme likely to appear in your audio, for example a list of passenger ship names.

Return type

async get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

An Operation object.

Return type

Operation

async get_phrase_set(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.GetPhraseSetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.types.cloud_speech.PhraseSet[source]¶

Returns the requested [PhraseSet][google.cloud.speech.v2.PhraseSet].

# 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 speech_v2

async def sample_get_phrase_set():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.GetPhraseSetRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_phrase_set(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.GetPhraseSetRequest, dict]]) – The request object. Request message for the [GetPhraseSet][google.cloud.speech.v2.Speech.GetPhraseSet] method.
name (str) –
Required. The name of the PhraseSet to retrieve. The expected format is projects/{project}/locations/{location}/phraseSets/{phrase_set}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

PhraseSet for biasing in speech recognition. A PhraseSet is used to provide “hints” to the speech recognizer to favor specific words and phrases in the results.

Return type

google.cloud.speech_v2.types.PhraseSet

async get_recognizer(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.GetRecognizerRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.types.cloud_speech.Recognizer[source]¶

Returns the requested [Recognizer][google.cloud.speech.v2.Recognizer]. Fails with [NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested Recognizer doesn’t exist.

# 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 speech_v2

async def sample_get_recognizer():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.GetRecognizerRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_recognizer(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.GetRecognizerRequest, dict]]) – The request object. Request message for the [GetRecognizer][google.cloud.speech.v2.Speech.GetRecognizer] method.
name (str) –
Required. The name of the Recognizer to retrieve. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

A Recognizer message. Stores recognition configuration and metadata.

Return type

google.cloud.speech_v2.types.Recognizer

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.speech_v2.services.speech.transports.base.SpeechTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_custom_classes(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.ListCustomClassesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.services.speech.pagers.ListCustomClassesAsyncPager[source]¶

Lists CustomClasses.

# 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 speech_v2

async def sample_list_custom_classes():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.ListCustomClassesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_custom_classes(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.ListCustomClassesRequest, dict]]) – The request object. Request message for the [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] method.
parent (str) –
Required. The project and location of CustomClass resources to list. The expected format is projects/{project}/locations/{location}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for the: [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.speech_v2.services.speech.pagers.ListCustomClassesAsyncPager

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ListLocations method.

Return type

ListLocationsResponse

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for ListOperations method.

Return type

ListOperationsResponse

async list_phrase_sets(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.ListPhraseSetsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.services.speech.pagers.ListPhraseSetsAsyncPager[source]¶

Lists PhraseSets.

# 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 speech_v2

async def sample_list_phrase_sets():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.ListPhraseSetsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_phrase_sets(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.ListPhraseSetsRequest, dict]]) – The request object. Request message for the [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] method.
parent (str) –
Required. The project and location of PhraseSet resources to list. The expected format is projects/{project}/locations/{location}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for the: [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.speech_v2.services.speech.pagers.ListPhraseSetsAsyncPager

async list_recognizers(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.ListRecognizersRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.services.speech.pagers.ListRecognizersAsyncPager[source]¶

Lists Recognizers.

# 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 speech_v2

async def sample_list_recognizers():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.ListRecognizersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_recognizers(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.ListRecognizersRequest, dict]]) – The request object. Request message for the [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] method.
parent (str) –
Required. The project and location of Recognizers to list. The expected format is projects/{project}/locations/{location}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for the: [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.speech_v2.services.speech.pagers.ListRecognizersAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_config_path(path: str) → Dict[str, str]¶: Parses a config path into its component segments.

static parse_crypto_key_path(path: str) → Dict[str, str]¶: Parses a crypto_key path into its component segments.

static parse_crypto_key_version_path(path: str) → Dict[str, str]¶: Parses a crypto_key_version path into its component segments.

static parse_custom_class_path(path: str) → Dict[str, str]¶: Parses a custom_class path into its component segments.

static parse_phrase_set_path(path: str) → Dict[str, str]¶: Parses a phrase_set path into its component segments.

static parse_recognizer_path(path: str) → Dict[str, str]¶: Parses a recognizer path into its component segments.

static phrase_set_path(project: str, location: str, phrase_set: str) → str¶: Returns a fully-qualified phrase_set string.

async recognize(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.RecognizeRequest, dict]] = None, *, recognizer: Optional[str] = None, config: Optional[google.cloud.speech_v2.types.cloud_speech.RecognitionConfig] = None, config_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, content: Optional[bytes] = None, uri: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.types.cloud_speech.RecognizeResponse[source]¶

Performs synchronous Speech recognition: receive results after all audio has been sent and 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 speech_v2

async def sample_recognize():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.RecognizeRequest(
        content=b'content_blob',
        recognizer="recognizer_value",
    )

    # Make the request
    response = await client.recognize(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.RecognizeRequest, dict]]) – The request object. Request message for the [Recognize][google.cloud.speech.v2.Speech.Recognize] method. Either content or uri must be supplied. Supplying both or neither returns [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. See content limits.
recognizer (str) –
Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. The {recognizer} segment may be set to _ to use an empty implicit Recognizer.

This corresponds to the recognizer field on the request instance; if request is provided, this should not be set.
config (google.cloud.speech_v2.types.RecognitionConfig) –
Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the [config_mask][google.cloud.speech.v2.RecognizeRequest.config_mask] field can be used to override parts of the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the Recognizer resource.

This corresponds to the config field on the request instance; if request is provided, this should not be set.
config_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields in [config][google.cloud.speech.v2.RecognizeRequest.config] that override the values in the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in [config][google.cloud.speech.v2.RecognizeRequest.config] override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, [config][google.cloud.speech.v2.RecognizeRequest.config] completely overrides and replaces the config in the recognizer for this recognition request.

This corresponds to the config_mask field on the request instance; if request is provided, this should not be set.
content (bytes) –
The audio data bytes encoded as specified in [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. As with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64.

This corresponds to the content field on the request instance; if request is provided, this should not be set.
uri (str) –
URI that points to a file that contains audio data bytes as specified in [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket_name/object_name (other URI formats return [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs.

This corresponds to the uri field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Response message for the: [Recognize][google.cloud.speech.v2.Speech.Recognize] method.

Return type

google.cloud.speech_v2.types.RecognizeResponse

static recognizer_path(project: str, location: str, recognizer: str) → str¶: Returns a fully-qualified recognizer string.

streaming_recognize(requests: Optional[AsyncIterator[google.cloud.speech_v2.types.cloud_speech.StreamingRecognizeRequest]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Awaitable[AsyncIterable[google.cloud.speech_v2.types.cloud_speech.StreamingRecognizeResponse]][source]¶

Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).

# 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 speech_v2

async def sample_streaming_recognize():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.StreamingRecognizeRequest(
        recognizer="recognizer_value",
    )

    # This method expects an iterator which contains
    # 'speech_v2.StreamingRecognizeRequest' 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 = await client.streaming_recognize(requests=request_generator())

    # Handle the response
    async for response in stream:
        print(response)

Parameters

requests (AsyncIterator[google.cloud.speech_v2.types.StreamingRecognizeRequest]) –
The request object AsyncIterator. Request message for the [StreamingRecognize][google.cloud.speech.v2.Speech.StreamingRecognize] method. Multiple [StreamingRecognizeRequest][google.cloud.speech.v2.StreamingRecognizeRequest] messages are sent in one call.

If the [Recognizer][google.cloud.speech.v2.Recognizer] referenced by [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] contains a fully specified request configuration then the stream may only contain messages with only [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] set.

Otherwise the first message must contain a [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] and a [streaming_config][google.cloud.speech.v2.StreamingRecognizeRequest.streaming_config] message that together fully specify the request configuration and must not contain [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio]. All subsequent messages must only have [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] set.
retry (google.api_core.retry_async.AsyncRetry) – 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

StreamingRecognizeResponse is the only message returned to the client by

StreamingRecognize. A series of zero or more StreamingRecognizeResponse messages are streamed back to the client. If there is no recognizable audio then no messages are streamed back to the client.

Here are some examples of StreamingRecognizeResponses that might be returned while processing audio:

results { alternatives { transcript: “tube” } stability: 0.01 }
results { alternatives { transcript: “to be a” } stability: 0.01 }
results { alternatives { transcript: “to be” } stability: 0.9 } results { alternatives { transcript: ” or not to be” } stability: 0.01 }
results { alternatives { transcript: “to be or not to be”
confidence: 0.92 }

alternatives { transcript: “to bee or not to bee” }
is_final: true }
results { alternatives { transcript: ” that’s” } stability: 0.01 }
results { alternatives { transcript: ” that is” } stability: 0.9 } results { alternatives { transcript: ” the question” } stability: 0.01 }
results { alternatives { transcript: ” that is the question”
confidence: 0.98 }

alternatives { transcript: ” that was the question” }
is_final: true }

Notes:

Only two of the above responses #4 and #7 contain final results; they are indicated by is_final: true. Concatenating these together generates the full transcript: “to be or not to be that is the question”.
The others contain interim results. #3 and #6 contain two interim `results`: the first portion has a high stability and is less likely to change; the second portion has a low stability and is very likely to change. A UI designer might choose to show only high stability results.
The specific stability and confidence values shown above are only for illustrative purposes. Actual values may vary.
In each response, only one of these fields will be set:
error, speech_event_type, or one or more (repeated) results.

Return type

AsyncIterable[google.cloud.speech_v2.types.StreamingRecognizeResponse]

property transport: google.cloud.speech_v2.services.speech.transports.base.SpeechTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: SpeechTransport

async undelete_custom_class(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UndeleteCustomClassRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Undeletes the [CustomClass][google.cloud.speech.v2.CustomClass].

# 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 speech_v2

async def sample_undelete_custom_class():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.UndeleteCustomClassRequest(
        name="name_value",
    )

    # Make the request
    operation = client.undelete_custom_class(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.UndeleteCustomClassRequest, dict]]) – The request object. Request message for the [UndeleteCustomClass][google.cloud.speech.v2.Speech.UndeleteCustomClass] method.
name (str) –
Required. The name of the CustomClass to undelete. Format: projects/{project}/locations/{location}/customClasses/{custom_class}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.CustomClass CustomClass for biasing in speech recognition. Used to define a set of words: or phrases that represents a common concept or theme likely to appear in your audio, for example a list of passenger ship names.

Return type

async undelete_phrase_set(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UndeletePhraseSetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Undeletes the [PhraseSet][google.cloud.speech.v2.PhraseSet].

# 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 speech_v2

async def sample_undelete_phrase_set():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.UndeletePhraseSetRequest(
        name="name_value",
    )

    # Make the request
    operation = client.undelete_phrase_set(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.UndeletePhraseSetRequest, dict]]) – The request object. Request message for the [UndeletePhraseSet][google.cloud.speech.v2.Speech.UndeletePhraseSet] method.
name (str) –
Required. The name of the PhraseSet to undelete. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.PhraseSet PhraseSet for biasing in speech recognition. A PhraseSet is used to provide: ”hints” to the speech recognizer to favor specific words and phrases in the results.

Return type

async undelete_recognizer(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UndeleteRecognizerRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Undeletes the [Recognizer][google.cloud.speech.v2.Recognizer].

# 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 speech_v2

async def sample_undelete_recognizer():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.UndeleteRecognizerRequest(
        name="name_value",
    )

    # Make the request
    operation = client.undelete_recognizer(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.UndeleteRecognizerRequest, dict]]) – The request object. Request message for the [UndeleteRecognizer][google.cloud.speech.v2.Speech.UndeleteRecognizer] method.
name (str) –
Required. The name of the Recognizer to undelete. Format: projects/{project}/locations/{location}/recognizers/{recognizer}

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.Recognizer A Recognizer message. Stores recognition configuration and metadata.

Return type

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_config(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UpdateConfigRequest, dict]] = None, *, config: Optional[google.cloud.speech_v2.types.cloud_speech.Config] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.types.cloud_speech.Config[source]¶

Updates the [Config][google.cloud.speech.v2.Config].

# 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 speech_v2

async def sample_update_config():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.UpdateConfigRequest(
    )

    # Make the request
    response = await client.update_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.UpdateConfigRequest, dict]]) – The request object. Request message for the [UpdateConfig][google.cloud.speech.v2.Speech.UpdateConfig] method.
config (google.cloud.speech_v2.types.Config) –
Required. The config to update.

The config’s name field is used to identify the config to be updated. The expected format is projects/{project}/locations/{location}/config.

This corresponds to the config field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) – The list of fields to be updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Message representing the config for the Speech-to-Text API. This includes an: optional [KMS key](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which incoming data will be encrypted.

Return type

async update_custom_class(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UpdateCustomClassRequest, dict]] = None, *, custom_class: Optional[google.cloud.speech_v2.types.cloud_speech.CustomClass] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the [CustomClass][google.cloud.speech.v2.CustomClass].

# 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 speech_v2

async def sample_update_custom_class():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.UpdateCustomClassRequest(
    )

    # Make the request
    operation = client.update_custom_class(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.UpdateCustomClassRequest, dict]]) – The request object. Request message for the [UpdateCustomClass][google.cloud.speech.v2.Speech.UpdateCustomClass] method.
custom_class (google.cloud.speech_v2.types.CustomClass) –
Required. The CustomClass to update.

The CustomClass’s name field is used to identify the CustomClass to update. Format: projects/{project}/locations/{location}/customClasses/{custom_class}.

This corresponds to the custom_class field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields to be updated. If empty, all fields are considered for update.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.CustomClass CustomClass for biasing in speech recognition. Used to define a set of words: or phrases that represents a common concept or theme likely to appear in your audio, for example a list of passenger ship names.

Return type

async update_phrase_set(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UpdatePhraseSetRequest, dict]] = None, *, phrase_set: Optional[google.cloud.speech_v2.types.cloud_speech.PhraseSet] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the [PhraseSet][google.cloud.speech.v2.PhraseSet].

# 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 speech_v2

async def sample_update_phrase_set():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.UpdatePhraseSetRequest(
    )

    # Make the request
    operation = client.update_phrase_set(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.UpdatePhraseSetRequest, dict]]) – The request object. Request message for the [UpdatePhraseSet][google.cloud.speech.v2.Speech.UpdatePhraseSet] method.
phrase_set (google.cloud.speech_v2.types.PhraseSet) –
Required. The PhraseSet to update.

The PhraseSet’s name field is used to identify the PhraseSet to update. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.

This corresponds to the phrase_set field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire PhraseSet resource.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.PhraseSet PhraseSet for biasing in speech recognition. A PhraseSet is used to provide: ”hints” to the speech recognizer to favor specific words and phrases in the results.

Return type

async update_recognizer(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UpdateRecognizerRequest, dict]] = None, *, recognizer: Optional[google.cloud.speech_v2.types.cloud_speech.Recognizer] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the [Recognizer][google.cloud.speech.v2.Recognizer].

# 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 speech_v2

async def sample_update_recognizer():
    # Create a client
    client = speech_v2.SpeechAsyncClient()

    # Initialize request argument(s)
    request = speech_v2.UpdateRecognizerRequest(
    )

    # Make the request
    operation = client.update_recognizer(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.speech_v2.types.UpdateRecognizerRequest, dict]]) – The request object. Request message for the [UpdateRecognizer][google.cloud.speech.v2.Speech.UpdateRecognizer] method.
recognizer (google.cloud.speech_v2.types.Recognizer) –
Required. The Recognizer to update.

The Recognizer’s name field is used to identify the Recognizer to update. Format: projects/{project}/locations/{location}/recognizers/{recognizer}.

This corresponds to the recognizer field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire Recognizer resource.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.Recognizer A Recognizer message. Stores recognition configuration and metadata.

Return type

class google.cloud.speech_v2.services.speech.SpeechClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.speech_v2.services.speech.transports.base.SpeechTransport, typing.Callable[[...], google.cloud.speech_v2.services.speech.transports.base.SpeechTransport]]] = 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>)[source]¶

Enables speech transcription and resource management.

Instantiates the speech client.

Parameters

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,SpeechTransport,Callable[..., SpeechTransport]]]) – 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 SpeechTransport constructor. If set to None, a transport is chosen automatically.
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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

batch_recognize(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.BatchRecognizeRequest, dict]] = None, *, recognizer: Optional[str] = None, config: Optional[google.cloud.speech_v2.types.cloud_speech.RecognitionConfig] = None, config_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, files: Optional[MutableSequence[google.cloud.speech_v2.types.cloud_speech.BatchRecognizeFileMetadata]] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Performs batch asynchronous speech recognition: send a request with N audio files and receive a long running operation that can be polled to see when the transcriptions are finished.

# 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 speech_v2

def sample_batch_recognize():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.BatchRecognizeRequest(
        recognizer="recognizer_value",
    )

    # Make the request
    operation = client.batch_recognize(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.BatchRecognizeRequest, dict]) – The request object. Request message for the [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] method.
recognizer (str) –
Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. The {recognizer} segment may be set to _ to use an empty implicit Recognizer.

This corresponds to the recognizer field on the request instance; if request is provided, this should not be set.
config (google.cloud.speech_v2.types.RecognitionConfig) –
Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the [config_mask][google.cloud.speech.v2.BatchRecognizeRequest.config_mask] field can be used to override parts of the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the Recognizer resource.

This corresponds to the config field on the request instance; if request is provided, this should not be set.
config_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields in [config][google.cloud.speech.v2.BatchRecognizeRequest.config] that override the values in the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the recognizer during this recognition request. If no mask is provided, all given fields in [config][google.cloud.speech.v2.BatchRecognizeRequest.config] override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, [config][google.cloud.speech.v2.BatchRecognizeRequest.config] completely overrides and replaces the config in the recognizer for this recognition request.

This corresponds to the config_mask field on the request instance; if request is provided, this should not be set.
files (MutableSequence[google.cloud.speech_v2.types.BatchRecognizeFileMetadata]) –
Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 15.

This corresponds to the files 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.BatchRecognizeResponse Response message for: [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] that is packaged into a longrunning [Operation][google.longrunning.Operation].

Return type

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (CancelOperationRequest) – The request object. Request message for CancelOperation 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

None

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

static config_path(project: str, location: str) → str[source]¶: Returns a fully-qualified config string.

create_custom_class(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.CreateCustomClassRequest, dict]] = None, *, parent: Optional[str] = None, custom_class: Optional[google.cloud.speech_v2.types.cloud_speech.CustomClass] = None, custom_class_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a [CustomClass][google.cloud.speech.v2.CustomClass].

# 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 speech_v2

def sample_create_custom_class():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.CreateCustomClassRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_custom_class(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.CreateCustomClassRequest, dict]) – The request object. Request message for the [CreateCustomClass][google.cloud.speech.v2.Speech.CreateCustomClass] method.
parent (str) –
Required. The project and location where this CustomClass will be created. The expected format is projects/{project}/locations/{location}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
custom_class (google.cloud.speech_v2.types.CustomClass) – Required. The CustomClass to create. This corresponds to the custom_class field on the request instance; if request is provided, this should not be set.
custom_class_id (str) –
The ID to use for the CustomClass, which will become the final component of the CustomClass’s resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

This corresponds to the custom_class_id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.CustomClass CustomClass for biasing in speech recognition. Used to define a set of words: or phrases that represents a common concept or theme likely to appear in your audio, for example a list of passenger ship names.

Return type

create_phrase_set(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.CreatePhraseSetRequest, dict]] = None, *, parent: Optional[str] = None, phrase_set: Optional[google.cloud.speech_v2.types.cloud_speech.PhraseSet] = None, phrase_set_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a [PhraseSet][google.cloud.speech.v2.PhraseSet].

# 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 speech_v2

def sample_create_phrase_set():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.CreatePhraseSetRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_phrase_set(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.CreatePhraseSetRequest, dict]) – The request object. Request message for the [CreatePhraseSet][google.cloud.speech.v2.Speech.CreatePhraseSet] method.
parent (str) –
Required. The project and location where this PhraseSet will be created. The expected format is projects/{project}/locations/{location}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
phrase_set (google.cloud.speech_v2.types.PhraseSet) – Required. The PhraseSet to create. This corresponds to the phrase_set field on the request instance; if request is provided, this should not be set.
phrase_set_id (str) –
The ID to use for the PhraseSet, which will become the final component of the PhraseSet’s resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

This corresponds to the phrase_set_id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.PhraseSet PhraseSet for biasing in speech recognition. A PhraseSet is used to provide: ”hints” to the speech recognizer to favor specific words and phrases in the results.

Return type

create_recognizer(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.CreateRecognizerRequest, dict]] = None, *, parent: Optional[str] = None, recognizer: Optional[google.cloud.speech_v2.types.cloud_speech.Recognizer] = None, recognizer_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a [Recognizer][google.cloud.speech.v2.Recognizer].

# 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 speech_v2

def sample_create_recognizer():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.CreateRecognizerRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_recognizer(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.CreateRecognizerRequest, dict]) – The request object. Request message for the [CreateRecognizer][google.cloud.speech.v2.Speech.CreateRecognizer] method.
parent (str) –
Required. The project and location where this Recognizer will be created. The expected format is projects/{project}/locations/{location}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
recognizer (google.cloud.speech_v2.types.Recognizer) – Required. The Recognizer to create. This corresponds to the recognizer field on the request instance; if request is provided, this should not be set.
recognizer_id (str) –
The ID to use for the Recognizer, which will become the final component of the Recognizer’s resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

This corresponds to the recognizer_id 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.Recognizer A Recognizer message. Stores recognition configuration and metadata.

Return type

static crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) → str[source]¶: Returns a fully-qualified crypto_key string.

static crypto_key_version_path(project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str) → str[source]¶: Returns a fully-qualified crypto_key_version string.

static custom_class_path(project: str, location: str, custom_class: str) → str[source]¶: Returns a fully-qualified custom_class string.

delete_custom_class(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.DeleteCustomClassRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes the [CustomClass][google.cloud.speech.v2.CustomClass].

# 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 speech_v2

def sample_delete_custom_class():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.DeleteCustomClassRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_custom_class(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.DeleteCustomClassRequest, dict]) – The request object. Request message for the [DeleteCustomClass][google.cloud.speech.v2.Speech.DeleteCustomClass] method.
name (str) –
Required. The name of the CustomClass to delete. Format: projects/{project}/locations/{location}/customClasses/{custom_class}

This corresponds to the name 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.CustomClass CustomClass for biasing in speech recognition. Used to define a set of words: or phrases that represents a common concept or theme likely to appear in your audio, for example a list of passenger ship names.

Return type

delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (DeleteOperationRequest) – The request object. Request message for DeleteOperation 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

None

delete_phrase_set(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.DeletePhraseSetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes the [PhraseSet][google.cloud.speech.v2.PhraseSet].

# 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 speech_v2

def sample_delete_phrase_set():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.DeletePhraseSetRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_phrase_set(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.DeletePhraseSetRequest, dict]) – The request object. Request message for the [DeletePhraseSet][google.cloud.speech.v2.Speech.DeletePhraseSet] method.
name (str) –
Required. The name of the PhraseSet to delete. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}

This corresponds to the name 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.PhraseSet PhraseSet for biasing in speech recognition. A PhraseSet is used to provide: ”hints” to the speech recognizer to favor specific words and phrases in the results.

Return type

delete_recognizer(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.DeleteRecognizerRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes the [Recognizer][google.cloud.speech.v2.Recognizer].

# 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 speech_v2

def sample_delete_recognizer():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.DeleteRecognizerRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_recognizer(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.DeleteRecognizerRequest, dict]) – The request object. Request message for the [DeleteRecognizer][google.cloud.speech.v2.Speech.DeleteRecognizer] method.
name (str) –
Required. The name of the Recognizer to delete. Format: projects/{project}/locations/{location}/recognizers/{recognizer}

This corresponds to the name 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.Recognizer A Recognizer message. Stores recognition configuration and metadata.

Return type

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SpeechClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SpeechClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SpeechClient

get_config(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.GetConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.types.cloud_speech.Config[source]¶

Returns the requested [Config][google.cloud.speech.v2.Config].

# 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 speech_v2

def sample_get_config():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.GetConfigRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.GetConfigRequest, dict]) – The request object. Request message for the [GetConfig][google.cloud.speech.v2.Speech.GetConfig] method.
name (str) –
Required. The name of the config to retrieve. There is exactly one config resource per project per location. The expected format is projects/{project}/locations/{location}/config.

This corresponds to the name 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

Message representing the config for the Speech-to-Text API. This includes an: optional [KMS key](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which incoming data will be encrypted.

Return type

google.cloud.speech_v2.types.CustomClass

get_custom_class(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.GetCustomClassRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.types.cloud_speech.CustomClass[source]¶

Returns the requested [CustomClass][google.cloud.speech.v2.CustomClass].

# 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 speech_v2

def sample_get_custom_class():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.GetCustomClassRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.GetCustomClassRequest, dict]) – The request object. Request message for the [GetCustomClass][google.cloud.speech.v2.Speech.GetCustomClass] method.
name (str) –
Required. The name of the CustomClass to retrieve. The expected format is projects/{project}/locations/{location}/customClasses/{custom_class}.

This corresponds to the name 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

CustomClass for biasing in speech recognition. Used to define a set of words or phrases that represents a common concept or theme likely to appear in your audio, for example a list of passenger ship names.

Return type

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation 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

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

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

Gets the latest state of a long-running operation.

Parameters

request (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

An Operation object.

Return type

Operation

get_phrase_set(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.GetPhraseSetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.types.cloud_speech.PhraseSet[source]¶

Returns the requested [PhraseSet][google.cloud.speech.v2.PhraseSet].

# 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 speech_v2

def sample_get_phrase_set():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.GetPhraseSetRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.GetPhraseSetRequest, dict]) – The request object. Request message for the [GetPhraseSet][google.cloud.speech.v2.Speech.GetPhraseSet] method.
name (str) –
Required. The name of the PhraseSet to retrieve. The expected format is projects/{project}/locations/{location}/phraseSets/{phrase_set}.

This corresponds to the name 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

PhraseSet for biasing in speech recognition. A PhraseSet is used to provide “hints” to the speech recognizer to favor specific words and phrases in the results.

Return type

google.cloud.speech_v2.types.PhraseSet

get_recognizer(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.GetRecognizerRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.types.cloud_speech.Recognizer[source]¶

Returns the requested [Recognizer][google.cloud.speech.v2.Recognizer]. Fails with [NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested Recognizer doesn’t exist.

# 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 speech_v2

def sample_get_recognizer():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.GetRecognizerRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.GetRecognizerRequest, dict]) – The request object. Request message for the [GetRecognizer][google.cloud.speech.v2.Speech.GetRecognizer] method.
name (str) –
Required. The name of the Recognizer to retrieve. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}.

This corresponds to the name 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

A Recognizer message. Stores recognition configuration and metadata.

Return type

google.cloud.speech_v2.types.Recognizer

list_custom_classes(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.ListCustomClassesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.services.speech.pagers.ListCustomClassesPager[source]¶

Lists CustomClasses.

# 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 speech_v2

def sample_list_custom_classes():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.ListCustomClassesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_custom_classes(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.speech_v2.types.ListCustomClassesRequest, dict]) – The request object. Request message for the [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] method.
parent (str) –
Required. The project and location of CustomClass resources to list. The expected format is projects/{project}/locations/{location}.

This corresponds to the parent 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

Response message for the: [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.speech_v2.services.speech.pagers.ListCustomClassesPager

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations 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

Response message for ListLocations method.

Return type

ListLocationsResponse

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

Lists operations that match the specified filter in the request.

Parameters

request (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

Response message for ListOperations method.

Return type

ListOperationsResponse

list_phrase_sets(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.ListPhraseSetsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.services.speech.pagers.ListPhraseSetsPager[source]¶

Lists PhraseSets.

# 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 speech_v2

def sample_list_phrase_sets():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.ListPhraseSetsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_phrase_sets(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.speech_v2.types.ListPhraseSetsRequest, dict]) – The request object. Request message for the [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] method.
parent (str) –
Required. The project and location of PhraseSet resources to list. The expected format is projects/{project}/locations/{location}.

This corresponds to the parent 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

Response message for the: [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.speech_v2.services.speech.pagers.ListPhraseSetsPager

list_recognizers(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.ListRecognizersRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.services.speech.pagers.ListRecognizersPager[source]¶

Lists Recognizers.

# 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 speech_v2

def sample_list_recognizers():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.ListRecognizersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_recognizers(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.speech_v2.types.ListRecognizersRequest, dict]) – The request object. Request message for the [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] method.
parent (str) –
Required. The project and location of Recognizers to list. The expected format is projects/{project}/locations/{location}.

This corresponds to the parent 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

Response message for the: [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] method.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.speech_v2.services.speech.pagers.ListRecognizersPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_config_path(path: str) → Dict[str, str][source]¶: Parses a config path into its component segments.

static parse_crypto_key_path(path: str) → Dict[str, str][source]¶: Parses a crypto_key path into its component segments.

static parse_crypto_key_version_path(path: str) → Dict[str, str][source]¶: Parses a crypto_key_version path into its component segments.

static parse_custom_class_path(path: str) → Dict[str, str][source]¶: Parses a custom_class path into its component segments.

static parse_phrase_set_path(path: str) → Dict[str, str][source]¶: Parses a phrase_set path into its component segments.

static parse_recognizer_path(path: str) → Dict[str, str][source]¶: Parses a recognizer path into its component segments.

static phrase_set_path(project: str, location: str, phrase_set: str) → str[source]¶: Returns a fully-qualified phrase_set string.

recognize(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.RecognizeRequest, dict]] = None, *, recognizer: Optional[str] = None, config: Optional[google.cloud.speech_v2.types.cloud_speech.RecognitionConfig] = None, config_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, content: Optional[bytes] = None, uri: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.types.cloud_speech.RecognizeResponse[source]¶

Performs synchronous Speech recognition: receive results after all audio has been sent and 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 speech_v2

def sample_recognize():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.RecognizeRequest(
        content=b'content_blob',
        recognizer="recognizer_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.RecognizeRequest, dict]) – The request object. Request message for the [Recognize][google.cloud.speech.v2.Speech.Recognize] method. Either content or uri must be supplied. Supplying both or neither returns [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. See content limits.
recognizer (str) –
Required. The name of the Recognizer to use during recognition. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}. The {recognizer} segment may be set to _ to use an empty implicit Recognizer.

This corresponds to the recognizer field on the request instance; if request is provided, this should not be set.
config (google.cloud.speech_v2.types.RecognitionConfig) –
Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the [config_mask][google.cloud.speech.v2.RecognizeRequest.config_mask] field can be used to override parts of the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the Recognizer resource.

This corresponds to the config field on the request instance; if request is provided, this should not be set.
config_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields in [config][google.cloud.speech.v2.RecognizeRequest.config] that override the values in the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in [config][google.cloud.speech.v2.RecognizeRequest.config] override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (*) is provided, [config][google.cloud.speech.v2.RecognizeRequest.config] completely overrides and replaces the config in the recognizer for this recognition request.

This corresponds to the config_mask field on the request instance; if request is provided, this should not be set.
content (bytes) –
The audio data bytes encoded as specified in [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. As with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64.

This corresponds to the content field on the request instance; if request is provided, this should not be set.
uri (str) –
URI that points to a file that contains audio data bytes as specified in [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. The file must not be compressed (for example, gzip). Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket_name/object_name (other URI formats return [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs.

This corresponds to the uri 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

Response message for the: [Recognize][google.cloud.speech.v2.Speech.Recognize] method.

Return type

google.cloud.speech_v2.types.RecognizeResponse

static recognizer_path(project: str, location: str, recognizer: str) → str[source]¶: Returns a fully-qualified recognizer string.

streaming_recognize(requests: Optional[Iterator[google.cloud.speech_v2.types.cloud_speech.StreamingRecognizeRequest]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Iterable[google.cloud.speech_v2.types.cloud_speech.StreamingRecognizeResponse][source]¶

Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).

# 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 speech_v2

def sample_streaming_recognize():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.StreamingRecognizeRequest(
        recognizer="recognizer_value",
    )

    # This method expects an iterator which contains
    # 'speech_v2.StreamingRecognizeRequest' 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_recognize(requests=request_generator())

    # Handle the response
    for response in stream:
        print(response)

Parameters

requests (Iterator[google.cloud.speech_v2.types.StreamingRecognizeRequest]) –
The request object iterator. Request message for the [StreamingRecognize][google.cloud.speech.v2.Speech.StreamingRecognize] method. Multiple [StreamingRecognizeRequest][google.cloud.speech.v2.StreamingRecognizeRequest] messages are sent in one call.

If the [Recognizer][google.cloud.speech.v2.Recognizer] referenced by [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] contains a fully specified request configuration then the stream may only contain messages with only [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] set.

Otherwise the first message must contain a [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] and a [streaming_config][google.cloud.speech.v2.StreamingRecognizeRequest.streaming_config] message that together fully specify the request configuration and must not contain [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio]. All subsequent messages must only have [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] 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

StreamingRecognizeResponse is the only message returned to the client by

StreamingRecognize. A series of zero or more StreamingRecognizeResponse messages are streamed back to the client. If there is no recognizable audio then no messages are streamed back to the client.

Here are some examples of StreamingRecognizeResponses that might be returned while processing audio:

results { alternatives { transcript: “tube” } stability: 0.01 }
results { alternatives { transcript: “to be a” } stability: 0.01 }
results { alternatives { transcript: “to be” } stability: 0.9 } results { alternatives { transcript: ” or not to be” } stability: 0.01 }
results { alternatives { transcript: “to be or not to be”
confidence: 0.92 }

alternatives { transcript: “to bee or not to bee” }
is_final: true }
results { alternatives { transcript: ” that’s” } stability: 0.01 }
results { alternatives { transcript: ” that is” } stability: 0.9 } results { alternatives { transcript: ” the question” } stability: 0.01 }
results { alternatives { transcript: ” that is the question”
confidence: 0.98 }

alternatives { transcript: ” that was the question” }
is_final: true }

Notes:

Only two of the above responses #4 and #7 contain final results; they are indicated by is_final: true. Concatenating these together generates the full transcript: “to be or not to be that is the question”.
The others contain interim results. #3 and #6 contain two interim `results`: the first portion has a high stability and is less likely to change; the second portion has a low stability and is very likely to change. A UI designer might choose to show only high stability results.
The specific stability and confidence values shown above are only for illustrative purposes. Actual values may vary.
In each response, only one of these fields will be set:
error, speech_event_type, or one or more (repeated) results.

Return type

Iterable[google.cloud.speech_v2.types.StreamingRecognizeResponse]

property transport: google.cloud.speech_v2.services.speech.transports.base.SpeechTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

SpeechTransport

undelete_custom_class(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UndeleteCustomClassRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Undeletes the [CustomClass][google.cloud.speech.v2.CustomClass].

# 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 speech_v2

def sample_undelete_custom_class():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.UndeleteCustomClassRequest(
        name="name_value",
    )

    # Make the request
    operation = client.undelete_custom_class(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.UndeleteCustomClassRequest, dict]) – The request object. Request message for the [UndeleteCustomClass][google.cloud.speech.v2.Speech.UndeleteCustomClass] method.
name (str) –
Required. The name of the CustomClass to undelete. Format: projects/{project}/locations/{location}/customClasses/{custom_class}

This corresponds to the name 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.CustomClass CustomClass for biasing in speech recognition. Used to define a set of words: or phrases that represents a common concept or theme likely to appear in your audio, for example a list of passenger ship names.

Return type

undelete_phrase_set(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UndeletePhraseSetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Undeletes the [PhraseSet][google.cloud.speech.v2.PhraseSet].

# 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 speech_v2

def sample_undelete_phrase_set():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.UndeletePhraseSetRequest(
        name="name_value",
    )

    # Make the request
    operation = client.undelete_phrase_set(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.UndeletePhraseSetRequest, dict]) – The request object. Request message for the [UndeletePhraseSet][google.cloud.speech.v2.Speech.UndeletePhraseSet] method.
name (str) –
Required. The name of the PhraseSet to undelete. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}

This corresponds to the name 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.PhraseSet PhraseSet for biasing in speech recognition. A PhraseSet is used to provide: ”hints” to the speech recognizer to favor specific words and phrases in the results.

Return type

undelete_recognizer(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UndeleteRecognizerRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Undeletes the [Recognizer][google.cloud.speech.v2.Recognizer].

# 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 speech_v2

def sample_undelete_recognizer():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.UndeleteRecognizerRequest(
        name="name_value",
    )

    # Make the request
    operation = client.undelete_recognizer(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.UndeleteRecognizerRequest, dict]) – The request object. Request message for the [UndeleteRecognizer][google.cloud.speech.v2.Speech.UndeleteRecognizer] method.
name (str) –
Required. The name of the Recognizer to undelete. Format: projects/{project}/locations/{location}/recognizers/{recognizer}

This corresponds to the name 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.Recognizer A Recognizer message. Stores recognition configuration and metadata.

Return type

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_config(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UpdateConfigRequest, dict]] = None, *, config: Optional[google.cloud.speech_v2.types.cloud_speech.Config] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.speech_v2.types.cloud_speech.Config[source]¶

Updates the [Config][google.cloud.speech.v2.Config].

# 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 speech_v2

def sample_update_config():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.UpdateConfigRequest(
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.UpdateConfigRequest, dict]) – The request object. Request message for the [UpdateConfig][google.cloud.speech.v2.Speech.UpdateConfig] method.
config (google.cloud.speech_v2.types.Config) –
Required. The config to update.

The config’s name field is used to identify the config to be updated. The expected format is projects/{project}/locations/{location}/config.

This corresponds to the config field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) – The list of fields to be updated. This corresponds to the update_mask 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

Message representing the config for the Speech-to-Text API. This includes an: optional [KMS key](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which incoming data will be encrypted.

Return type

update_custom_class(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UpdateCustomClassRequest, dict]] = None, *, custom_class: Optional[google.cloud.speech_v2.types.cloud_speech.CustomClass] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the [CustomClass][google.cloud.speech.v2.CustomClass].

# 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 speech_v2

def sample_update_custom_class():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.UpdateCustomClassRequest(
    )

    # Make the request
    operation = client.update_custom_class(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.UpdateCustomClassRequest, dict]) – The request object. Request message for the [UpdateCustomClass][google.cloud.speech.v2.Speech.UpdateCustomClass] method.
custom_class (google.cloud.speech_v2.types.CustomClass) –
Required. The CustomClass to update.

The CustomClass’s name field is used to identify the CustomClass to update. Format: projects/{project}/locations/{location}/customClasses/{custom_class}.

This corresponds to the custom_class field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields to be updated. If empty, all fields are considered for update.

This corresponds to the update_mask 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.CustomClass CustomClass for biasing in speech recognition. Used to define a set of words: or phrases that represents a common concept or theme likely to appear in your audio, for example a list of passenger ship names.

Return type

update_phrase_set(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UpdatePhraseSetRequest, dict]] = None, *, phrase_set: Optional[google.cloud.speech_v2.types.cloud_speech.PhraseSet] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the [PhraseSet][google.cloud.speech.v2.PhraseSet].

# 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 speech_v2

def sample_update_phrase_set():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.UpdatePhraseSetRequest(
    )

    # Make the request
    operation = client.update_phrase_set(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.UpdatePhraseSetRequest, dict]) – The request object. Request message for the [UpdatePhraseSet][google.cloud.speech.v2.Speech.UpdatePhraseSet] method.
phrase_set (google.cloud.speech_v2.types.PhraseSet) –
Required. The PhraseSet to update.

The PhraseSet’s name field is used to identify the PhraseSet to update. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.

This corresponds to the phrase_set field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire PhraseSet resource.

This corresponds to the update_mask 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.PhraseSet PhraseSet for biasing in speech recognition. A PhraseSet is used to provide: ”hints” to the speech recognizer to favor specific words and phrases in the results.

Return type

update_recognizer(request: Optional[Union[google.cloud.speech_v2.types.cloud_speech.UpdateRecognizerRequest, dict]] = None, *, recognizer: Optional[google.cloud.speech_v2.types.cloud_speech.Recognizer] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the [Recognizer][google.cloud.speech.v2.Recognizer].

# 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 speech_v2

def sample_update_recognizer():
    # Create a client
    client = speech_v2.SpeechClient()

    # Initialize request argument(s)
    request = speech_v2.UpdateRecognizerRequest(
    )

    # Make the request
    operation = client.update_recognizer(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.speech_v2.types.UpdateRecognizerRequest, dict]) – The request object. Request message for the [UpdateRecognizer][google.cloud.speech.v2.Speech.UpdateRecognizer] method.
recognizer (google.cloud.speech_v2.types.Recognizer) –
Required. The Recognizer to update.

The Recognizer’s name field is used to identify the Recognizer to update. Format: projects/{project}/locations/{location}/recognizers/{recognizer}.

This corresponds to the recognizer field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire Recognizer resource.

This corresponds to the update_mask 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.speech_v2.types.Recognizer A Recognizer message. Stores recognition configuration and metadata.

Return type