AdaptationClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.speech_v1p1beta1.services.adaptation.transports.base.AdaptationTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = 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.
Inheritance
builtins.object > AdaptationClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
AdaptationTransport | The transport used by the client instance. |
Methods
AdaptationClient
AdaptationClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.speech_v1p1beta1.services.adaptation.transports.base.AdaptationTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the adaptation client.
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 |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
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 |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_custom_class
create_custom_class(request: Optional[Union[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.CreateCustomClassRequest, dict]] = None, *, parent: Optional[str] = None, custom_class: Optional[google.cloud.speech_v1p1beta1.types.resource.CustomClass] = None, custom_class_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Create a custom class.
# 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_v1p1beta1
def sample_create_custom_class():
# Create a client
client = speech_v1p1beta1.AdaptationClient()
# Initialize request argument(s)
request = speech_v1p1beta1.CreateCustomClassRequest(
parent="parent_value",
custom_class_id="custom_class_id_value",
)
# Make the request
response = client.create_custom_class(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.speech_v1p1beta1.types.CreateCustomClassRequest, dict]
The request object. Message sent by the client for the |
parent |
str
Required. The parent resource where this custom class will be created. Format: |
custom_class |
google.cloud.speech_v1p1beta1.types.CustomClass
Required. The custom class to create. This corresponds to the |
custom_class_id |
str
Required. The ID to use for the custom class, which will become the final component of the custom class' resource name. This value should restrict to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and be 4-63 characters. This corresponds to the |
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. |
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[Union[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.CreatePhraseSetRequest, dict]] = None, *, parent: Optional[str] = None, phrase_set: Optional[google.cloud.speech_v1p1beta1.types.resource.PhraseSet] = None, phrase_set_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.
# 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_v1p1beta1
def sample_create_phrase_set():
# Create a client
client = speech_v1p1beta1.AdaptationClient()
# Initialize request argument(s)
request = speech_v1p1beta1.CreatePhraseSetRequest(
parent="parent_value",
phrase_set_id="phrase_set_id_value",
)
# Make the request
response = client.create_phrase_set(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.speech_v1p1beta1.types.CreatePhraseSetRequest, dict]
The request object. Message sent by the client for the |
parent |
str
Required. The parent resource where this phrase set will be created. Format: |
phrase_set |
google.cloud.speech_v1p1beta1.types.PhraseSet
Required. The phrase set to create. This corresponds to the |
phrase_set_id |
str
Required. The ID to use for the phrase set, which will become the final component of the phrase set's resource name. This value should restrict to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and be 4-63 characters. This corresponds to the |
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. |
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)
Returns a fully-qualified custom_class string.
delete_custom_class
delete_custom_class(request: Optional[Union[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.DeleteCustomClassRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Delete a custom class.
# 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_v1p1beta1
def sample_delete_custom_class():
# Create a client
client = speech_v1p1beta1.AdaptationClient()
# Initialize request argument(s)
request = speech_v1p1beta1.DeleteCustomClassRequest(
name="name_value",
)
# Make the request
client.delete_custom_class(request=request)
Name | Description |
request |
Union[google.cloud.speech_v1p1beta1.types.DeleteCustomClassRequest, dict]
The request object. Message sent by the client for the |
name |
str
Required. The name of the custom class to delete. Format: |
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[Union[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.DeletePhraseSetRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Delete a phrase set.
# 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_v1p1beta1
def sample_delete_phrase_set():
# Create a client
client = speech_v1p1beta1.AdaptationClient()
# Initialize request argument(s)
request = speech_v1p1beta1.DeletePhraseSetRequest(
name="name_value",
)
# Make the request
client.delete_phrase_set(request=request)
Name | Description |
request |
Union[google.cloud.speech_v1p1beta1.types.DeletePhraseSetRequest, dict]
The request object. Message sent by the client for the |
name |
str
Required. The name of the phrase set to delete. Format: |
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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
AdaptationClient | 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.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
AdaptationClient | 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
AdaptationClient | The constructed client. |
get_custom_class
get_custom_class(request: Optional[Union[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.GetCustomClassRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get a custom class.
# 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_v1p1beta1
def sample_get_custom_class():
# Create a client
client = speech_v1p1beta1.AdaptationClient()
# Initialize request argument(s)
request = speech_v1p1beta1.GetCustomClassRequest(
name="name_value",
)
# Make the request
response = client.get_custom_class(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.speech_v1p1beta1.types.GetCustomClassRequest, dict]
The request object. Message sent by the client for the |
name |
str
Required. The name of the custom class to retrieve. Format: |
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. |
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_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
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 variabel 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.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_phrase_set
get_phrase_set(request: Optional[Union[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.GetPhraseSetRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get a phrase set.
# 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_v1p1beta1
def sample_get_phrase_set():
# Create a client
client = speech_v1p1beta1.AdaptationClient()
# Initialize request argument(s)
request = speech_v1p1beta1.GetPhraseSetRequest(
name="name_value",
)
# Make the request
response = client.get_phrase_set(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.speech_v1p1beta1.types.GetPhraseSetRequest, dict]
The request object. Message sent by the client for the |
name |
str
Required. The name of the phrase set to retrieve. Format: |
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. |
Type | Description |
google.cloud.speech_v1p1beta1.types.PhraseSet | Provides "hints" to the speech recognizer to favor specific words and phrases in the results. |
list_custom_classes
list_custom_classes(request: Optional[Union[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.ListCustomClassesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
List custom classes.
# 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_v1p1beta1
def sample_list_custom_classes():
# Create a client
client = speech_v1p1beta1.AdaptationClient()
# Initialize request argument(s)
request = speech_v1p1beta1.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)
Name | Description |
request |
Union[google.cloud.speech_v1p1beta1.types.ListCustomClassesRequest, dict]
The request object. Message sent by the client for the |
parent |
str
Required. The parent, which owns this collection of custom classes. Format: |
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. |
Type | Description |
google.cloud.speech_v1p1beta1.services.adaptation.pagers.ListCustomClassesPager | 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[Union[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.ListPhraseSetRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
List phrase sets.
# 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_v1p1beta1
def sample_list_phrase_set():
# Create a client
client = speech_v1p1beta1.AdaptationClient()
# Initialize request argument(s)
request = speech_v1p1beta1.ListPhraseSetRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_phrase_set(request=request)
# Handle the response
for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.speech_v1p1beta1.types.ListPhraseSetRequest, dict]
The request object. Message sent by the client for the |
parent |
str
Required. The parent, which owns this collection of phrase set. Format: |
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. |
Type | Description |
google.cloud.speech_v1p1beta1.services.adaptation.pagers.ListPhraseSetPager | 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)
Parses a custom_class path into its component segments.
parse_phrase_set_path
parse_phrase_set_path(path: str)
Parses a phrase_set path into its component segments.
phrase_set_path
phrase_set_path(project: str, location: str, phrase_set: str)
Returns a fully-qualified phrase_set string.
update_custom_class
update_custom_class(request: Optional[Union[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.UpdateCustomClassRequest, dict]] = None, *, custom_class: Optional[google.cloud.speech_v1p1beta1.types.resource.CustomClass] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Update a custom class.
# 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_v1p1beta1
def sample_update_custom_class():
# Create a client
client = speech_v1p1beta1.AdaptationClient()
# Initialize request argument(s)
request = speech_v1p1beta1.UpdateCustomClassRequest(
)
# Make the request
response = client.update_custom_class(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.speech_v1p1beta1.types.UpdateCustomClassRequest, dict]
The request object. Message sent by the client for the |
custom_class |
google.cloud.speech_v1p1beta1.types.CustomClass
Required. The custom class to update. The custom class's |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
The list of fields to be updated. This corresponds to the |
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. |
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[Union[google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation.UpdatePhraseSetRequest, dict]] = None, *, phrase_set: Optional[google.cloud.speech_v1p1beta1.types.resource.PhraseSet] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Update a phrase set.
# 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_v1p1beta1
def sample_update_phrase_set():
# Create a client
client = speech_v1p1beta1.AdaptationClient()
# Initialize request argument(s)
request = speech_v1p1beta1.UpdatePhraseSetRequest(
)
# Make the request
response = client.update_phrase_set(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.speech_v1p1beta1.types.UpdatePhraseSetRequest, dict]
The request object. Message sent by the client for the |
phrase_set |
google.cloud.speech_v1p1beta1.types.PhraseSet
Required. The phrase set to update. The phrase set's |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
The list of fields to be updated. This corresponds to the |
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. |
Type | Description |
google.cloud.speech_v1p1beta1.types.PhraseSet | Provides "hints" to the speech recognizer to favor specific words and phrases in the results. |