Class AdaptationAsyncClient (2.1.0)

AdaptationAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.speech_v1p1beta1.services.adaptation.transports.base.AdaptationTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-speech/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service that implements Google Cloud Speech Adaptation API.

Properties

transport

Return the transport used by the client instance.

Returns
Type	Description
`AdaptationTransport`	The transport used by the client instance.

Methods

AdaptationAsyncClient

AdaptationAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.speech_v1p1beta1.services.adaptation.transports.base.AdaptationTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-speech/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the adaptation client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, .AdaptationTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS 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.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

create_custom_class

create_custom_class(request: Optional[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.CreateCustomClassRequest] = None, *, parent: Optional[str] = None, custom_class: Optional[google.cloud.speech_v1p1beta1.types.resource.CustomClass] = None, custom_class_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Create a custom class.

Parameters
Name	Description
`request`	`CreateCustomClassRequest` The request object. Message sent by the client for the `CreateCustomClass` method.
`parent`	`str` Required. The parent resource where this custom class will be created. Format: {api_version}/projects/{project}/locations/{location}/customClasses This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`custom_class`	`CustomClass` Required. The custom class 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 custom class, which will become the final component of the custom class' 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
Type	Description
`google.cloud.speech_v1p1beta1.types.CustomClass`	A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.

create_phrase_set

create_phrase_set(request: Optional[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.CreatePhraseSetRequest] = None, *, parent: Optional[str] = None, phrase_set: Optional[google.cloud.speech_v1p1beta1.types.resource.PhraseSet] = None, phrase_set_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.

Parameters
Name	Description
`request`	`CreatePhraseSetRequest` The request object. Message sent by the client for the `CreatePhraseSet` method.
`parent`	`str` Required. The parent resource where this phrase set will be created. Format: {api_version}/projects/{project}/locations/{location}/phraseSets This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`phrase_set`	`PhraseSet` Required. The phrase set 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 phrase set, which will become the final component of the phrase set'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
Type	Description
`google.cloud.speech_v1p1beta1.types.PhraseSet`	Provides "hints" to the speech recognizer to favor specific words and phrases in the results.

custom_class_path

custom_class_path(project: str, location: str, custom_class: str)

Return a fully-qualified custom_class string.

delete_custom_class

delete_custom_class(request: Optional[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.DeleteCustomClassRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Delete a custom class.

Parameters
Name	Description
`request`	`DeleteCustomClassRequest` The request object. Message sent by the client for the `DeleteCustomClass` method.
`name`	`str` Required. The name of the custom class to delete. Format: {api_version}/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.

delete_phrase_set

delete_phrase_set(request: Optional[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.DeletePhraseSetRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Delete a phrase set.

Parameters
Name	Description
`request`	`DeletePhraseSetRequest` The request object. Message sent by the client for the `DeletePhraseSet` method.
`name`	`str` Required. The name of the phrase set to delete. Format: {api_version}/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.

from_service_account_file

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

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

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`AdaptationAsyncClient`	The constructed client.

from_service_account_info

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

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

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`AdaptationAsyncClient`	The constructed client.

from_service_account_json

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

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

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`AdaptationAsyncClient`	The constructed client.

get_custom_class

get_custom_class(request: Optional[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.GetCustomClassRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Get a custom class.

Parameters
Name	Description
`request`	`GetCustomClassRequest` The request object. Message sent by the client for the `GetCustomClass` method.
`name`	`str` Required. The name of the custom class to retrieve. Format: {api_version}/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
Type	Description
`google.cloud.speech_v1p1beta1.types.CustomClass`	A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.

get_phrase_set

get_phrase_set(request: Optional[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.GetPhraseSetRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Get a phrase set.

Parameters
Name	Description
`request`	`GetPhraseSetRequest` The request object. Message sent by the client for the `GetPhraseSet` method.
`name`	`str` Required. The name of the phrase set to retrieve. Format: {api_version}/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
Type	Description
`google.cloud.speech_v1p1beta1.types.PhraseSet`	Provides "hints" to the speech recognizer to favor specific words and phrases in the results.

get_transport_class

get_transport_class()

Return an appropriate transport class.

list_custom_classes

list_custom_classes(request: Optional[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.ListCustomClassesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

List custom classes.

Parameters
Name	Description
`request`	`ListCustomClassesRequest` The request object. Message sent by the client for the `ListCustomClasses` method.
`parent`	`str` Required. The parent, which owns this collection of custom classes. Format: {api_version}/projects/{project}/locations/{location}/customClasses 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
Type	Description
`google.cloud.speech_v1p1beta1.services.adaptation.pagers.ListCustomClassesAsyncPager`	Message returned to the client by the ListCustomClasses method. Iterating over this object will yield results and resolve additional pages automatically.

list_phrase_set

list_phrase_set(request: Optional[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.ListPhraseSetRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

List phrase sets.

Parameters
Name	Description
`request`	`ListPhraseSetRequest` The request object. Message sent by the client for the `ListPhraseSet` method.
`parent`	`str` Required. The parent, which owns this collection of phrase set. Format: 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
Type	Description
`google.cloud.speech_v1p1beta1.services.adaptation.pagers.ListPhraseSetAsyncPager`	Message returned to the client by the ListPhraseSet method. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_custom_class_path

parse_custom_class_path(path: str)

Parse a custom_class path into its component segments.

parse_phrase_set_path

parse_phrase_set_path(path: str)

Parse a phrase_set path into its component segments.

phrase_set_path

phrase_set_path(project: str, location: str, phrase_set: str)

Return a fully-qualified phrase_set string.

update_custom_class

update_custom_class(request: Optional[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.UpdateCustomClassRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Update a custom class.

Parameters
Name	Description
`request`	`UpdateCustomClassRequest` The request object. Message sent by the client for the `UpdateCustomClass` method.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.speech_v1p1beta1.types.CustomClass`	A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.

update_phrase_set

update_phrase_set(request: Optional[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.UpdatePhraseSetRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Update a phrase set.

Parameters
Name	Description
`request`	`UpdatePhraseSetRequest` The request object. Message sent by the client for the `UpdatePhraseSet` method.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.speech_v1p1beta1.types.PhraseSet`	Provides "hints" to the speech recognizer to favor specific words and phrases in the results.