File: //snap/google-cloud-cli/396/lib/googlecloudsdk/generated_clients/apis/speech/v1/speech_v1_client.py
"""Generated client library for speech version v1."""
# NOTE: This file is autogenerated and should not be edited by hand.
from __future__ import absolute_import
from apitools.base.py import base_api
from googlecloudsdk.generated_clients.apis.speech.v1 import speech_v1_messages as messages
class SpeechV1(base_api.BaseApiClient):
"""Generated client library for service speech version v1."""
MESSAGES_MODULE = messages
BASE_URL = 'https://speech.googleapis.com/'
MTLS_BASE_URL = 'https://speech.mtls.googleapis.com/'
_PACKAGE = 'speech'
_SCOPES = ['https://www.googleapis.com/auth/cloud-platform']
_VERSION = 'v1'
_CLIENT_ID = 'CLIENT_ID'
_CLIENT_SECRET = 'CLIENT_SECRET'
_USER_AGENT = 'google-cloud-sdk'
_CLIENT_CLASS_NAME = 'SpeechV1'
_URL_VERSION = 'v1'
_API_KEY = None
def __init__(self, url='', credentials=None,
get_credentials=True, http=None, model=None,
log_request=False, log_response=False,
credentials_args=None, default_global_params=None,
additional_http_headers=None, response_encoding=None):
"""Create a new speech handle."""
url = url or self.BASE_URL
super(SpeechV1, self).__init__(
url, credentials=credentials,
get_credentials=get_credentials, http=http, model=model,
log_request=log_request, log_response=log_response,
credentials_args=credentials_args,
default_global_params=default_global_params,
additional_http_headers=additional_http_headers,
response_encoding=response_encoding)
self.operations = self.OperationsService(self)
self.projects_locations_customClasses = self.ProjectsLocationsCustomClassesService(self)
self.projects_locations_phraseSets = self.ProjectsLocationsPhraseSetsService(self)
self.projects_locations = self.ProjectsLocationsService(self)
self.projects = self.ProjectsService(self)
self.speech = self.SpeechService(self)
class OperationsService(base_api.BaseApiService):
"""Service class for the operations resource."""
_NAME = 'operations'
def __init__(self, client):
super(SpeechV1.OperationsService, self).__init__(client)
self._upload_configs = {
}
def Get(self, request, global_params=None):
r"""Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Args:
request: (SpeechOperationsGetRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(Operation) The response message.
"""
config = self.GetMethodConfig('Get')
return self._RunMethod(
config, request, global_params=global_params)
Get.method_config = lambda: base_api.ApiMethodInfo(
flat_path='v1/operations/{operationsId}',
http_method='GET',
method_id='speech.operations.get',
ordered_params=['name'],
path_params=['name'],
query_params=[],
relative_path='v1/operations/{+name}',
request_field='',
request_type_name='SpeechOperationsGetRequest',
response_type_name='Operation',
supports_download=False,
)
def List(self, request, global_params=None):
r"""Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Args:
request: (SpeechOperationsListRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(ListOperationsResponse) The response message.
"""
config = self.GetMethodConfig('List')
return self._RunMethod(
config, request, global_params=global_params)
List.method_config = lambda: base_api.ApiMethodInfo(
http_method='GET',
method_id='speech.operations.list',
ordered_params=[],
path_params=[],
query_params=['filter', 'name', 'pageSize', 'pageToken'],
relative_path='v1/operations',
request_field='',
request_type_name='SpeechOperationsListRequest',
response_type_name='ListOperationsResponse',
supports_download=False,
)
class ProjectsLocationsCustomClassesService(base_api.BaseApiService):
"""Service class for the projects_locations_customClasses resource."""
_NAME = 'projects_locations_customClasses'
def __init__(self, client):
super(SpeechV1.ProjectsLocationsCustomClassesService, self).__init__(client)
self._upload_configs = {
}
def Create(self, request, global_params=None):
r"""Create a custom class.
Args:
request: (SpeechProjectsLocationsCustomClassesCreateRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(CustomClass) The response message.
"""
config = self.GetMethodConfig('Create')
return self._RunMethod(
config, request, global_params=global_params)
Create.method_config = lambda: base_api.ApiMethodInfo(
flat_path='v1/projects/{projectsId}/locations/{locationsId}/customClasses',
http_method='POST',
method_id='speech.projects.locations.customClasses.create',
ordered_params=['parent'],
path_params=['parent'],
query_params=[],
relative_path='v1/{+parent}/customClasses',
request_field='createCustomClassRequest',
request_type_name='SpeechProjectsLocationsCustomClassesCreateRequest',
response_type_name='CustomClass',
supports_download=False,
)
def Delete(self, request, global_params=None):
r"""Delete a custom class.
Args:
request: (SpeechProjectsLocationsCustomClassesDeleteRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(Empty) The response message.
"""
config = self.GetMethodConfig('Delete')
return self._RunMethod(
config, request, global_params=global_params)
Delete.method_config = lambda: base_api.ApiMethodInfo(
flat_path='v1/projects/{projectsId}/locations/{locationsId}/customClasses/{customClassesId}',
http_method='DELETE',
method_id='speech.projects.locations.customClasses.delete',
ordered_params=['name'],
path_params=['name'],
query_params=[],
relative_path='v1/{+name}',
request_field='',
request_type_name='SpeechProjectsLocationsCustomClassesDeleteRequest',
response_type_name='Empty',
supports_download=False,
)
def Get(self, request, global_params=None):
r"""Get a custom class.
Args:
request: (SpeechProjectsLocationsCustomClassesGetRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(CustomClass) The response message.
"""
config = self.GetMethodConfig('Get')
return self._RunMethod(
config, request, global_params=global_params)
Get.method_config = lambda: base_api.ApiMethodInfo(
flat_path='v1/projects/{projectsId}/locations/{locationsId}/customClasses/{customClassesId}',
http_method='GET',
method_id='speech.projects.locations.customClasses.get',
ordered_params=['name'],
path_params=['name'],
query_params=[],
relative_path='v1/{+name}',
request_field='',
request_type_name='SpeechProjectsLocationsCustomClassesGetRequest',
response_type_name='CustomClass',
supports_download=False,
)
def List(self, request, global_params=None):
r"""List custom classes.
Args:
request: (SpeechProjectsLocationsCustomClassesListRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(ListCustomClassesResponse) The response message.
"""
config = self.GetMethodConfig('List')
return self._RunMethod(
config, request, global_params=global_params)
List.method_config = lambda: base_api.ApiMethodInfo(
flat_path='v1/projects/{projectsId}/locations/{locationsId}/customClasses',
http_method='GET',
method_id='speech.projects.locations.customClasses.list',
ordered_params=['parent'],
path_params=['parent'],
query_params=['pageSize', 'pageToken'],
relative_path='v1/{+parent}/customClasses',
request_field='',
request_type_name='SpeechProjectsLocationsCustomClassesListRequest',
response_type_name='ListCustomClassesResponse',
supports_download=False,
)
def Patch(self, request, global_params=None):
r"""Update a custom class.
Args:
request: (SpeechProjectsLocationsCustomClassesPatchRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(CustomClass) The response message.
"""
config = self.GetMethodConfig('Patch')
return self._RunMethod(
config, request, global_params=global_params)
Patch.method_config = lambda: base_api.ApiMethodInfo(
flat_path='v1/projects/{projectsId}/locations/{locationsId}/customClasses/{customClassesId}',
http_method='PATCH',
method_id='speech.projects.locations.customClasses.patch',
ordered_params=['name'],
path_params=['name'],
query_params=['updateMask'],
relative_path='v1/{+name}',
request_field='customClass',
request_type_name='SpeechProjectsLocationsCustomClassesPatchRequest',
response_type_name='CustomClass',
supports_download=False,
)
class ProjectsLocationsPhraseSetsService(base_api.BaseApiService):
"""Service class for the projects_locations_phraseSets resource."""
_NAME = 'projects_locations_phraseSets'
def __init__(self, client):
super(SpeechV1.ProjectsLocationsPhraseSetsService, self).__init__(client)
self._upload_configs = {
}
def Create(self, request, global_params=None):
r"""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.
Args:
request: (SpeechProjectsLocationsPhraseSetsCreateRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(PhraseSet) The response message.
"""
config = self.GetMethodConfig('Create')
return self._RunMethod(
config, request, global_params=global_params)
Create.method_config = lambda: base_api.ApiMethodInfo(
flat_path='v1/projects/{projectsId}/locations/{locationsId}/phraseSets',
http_method='POST',
method_id='speech.projects.locations.phraseSets.create',
ordered_params=['parent'],
path_params=['parent'],
query_params=[],
relative_path='v1/{+parent}/phraseSets',
request_field='createPhraseSetRequest',
request_type_name='SpeechProjectsLocationsPhraseSetsCreateRequest',
response_type_name='PhraseSet',
supports_download=False,
)
def Delete(self, request, global_params=None):
r"""Delete a phrase set.
Args:
request: (SpeechProjectsLocationsPhraseSetsDeleteRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(Empty) The response message.
"""
config = self.GetMethodConfig('Delete')
return self._RunMethod(
config, request, global_params=global_params)
Delete.method_config = lambda: base_api.ApiMethodInfo(
flat_path='v1/projects/{projectsId}/locations/{locationsId}/phraseSets/{phraseSetsId}',
http_method='DELETE',
method_id='speech.projects.locations.phraseSets.delete',
ordered_params=['name'],
path_params=['name'],
query_params=[],
relative_path='v1/{+name}',
request_field='',
request_type_name='SpeechProjectsLocationsPhraseSetsDeleteRequest',
response_type_name='Empty',
supports_download=False,
)
def Get(self, request, global_params=None):
r"""Get a phrase set.
Args:
request: (SpeechProjectsLocationsPhraseSetsGetRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(PhraseSet) The response message.
"""
config = self.GetMethodConfig('Get')
return self._RunMethod(
config, request, global_params=global_params)
Get.method_config = lambda: base_api.ApiMethodInfo(
flat_path='v1/projects/{projectsId}/locations/{locationsId}/phraseSets/{phraseSetsId}',
http_method='GET',
method_id='speech.projects.locations.phraseSets.get',
ordered_params=['name'],
path_params=['name'],
query_params=[],
relative_path='v1/{+name}',
request_field='',
request_type_name='SpeechProjectsLocationsPhraseSetsGetRequest',
response_type_name='PhraseSet',
supports_download=False,
)
def List(self, request, global_params=None):
r"""List phrase sets.
Args:
request: (SpeechProjectsLocationsPhraseSetsListRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(ListPhraseSetResponse) The response message.
"""
config = self.GetMethodConfig('List')
return self._RunMethod(
config, request, global_params=global_params)
List.method_config = lambda: base_api.ApiMethodInfo(
flat_path='v1/projects/{projectsId}/locations/{locationsId}/phraseSets',
http_method='GET',
method_id='speech.projects.locations.phraseSets.list',
ordered_params=['parent'],
path_params=['parent'],
query_params=['pageSize', 'pageToken'],
relative_path='v1/{+parent}/phraseSets',
request_field='',
request_type_name='SpeechProjectsLocationsPhraseSetsListRequest',
response_type_name='ListPhraseSetResponse',
supports_download=False,
)
def Patch(self, request, global_params=None):
r"""Update a phrase set.
Args:
request: (SpeechProjectsLocationsPhraseSetsPatchRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(PhraseSet) The response message.
"""
config = self.GetMethodConfig('Patch')
return self._RunMethod(
config, request, global_params=global_params)
Patch.method_config = lambda: base_api.ApiMethodInfo(
flat_path='v1/projects/{projectsId}/locations/{locationsId}/phraseSets/{phraseSetsId}',
http_method='PATCH',
method_id='speech.projects.locations.phraseSets.patch',
ordered_params=['name'],
path_params=['name'],
query_params=['updateMask'],
relative_path='v1/{+name}',
request_field='phraseSet',
request_type_name='SpeechProjectsLocationsPhraseSetsPatchRequest',
response_type_name='PhraseSet',
supports_download=False,
)
class ProjectsLocationsService(base_api.BaseApiService):
"""Service class for the projects_locations resource."""
_NAME = 'projects_locations'
def __init__(self, client):
super(SpeechV1.ProjectsLocationsService, self).__init__(client)
self._upload_configs = {
}
class ProjectsService(base_api.BaseApiService):
"""Service class for the projects resource."""
_NAME = 'projects'
def __init__(self, client):
super(SpeechV1.ProjectsService, self).__init__(client)
self._upload_configs = {
}
class SpeechService(base_api.BaseApiService):
"""Service class for the speech resource."""
_NAME = 'speech'
def __init__(self, client):
super(SpeechV1.SpeechService, self).__init__(client)
self._upload_configs = {
}
def Longrunningrecognize(self, request, global_params=None):
r"""Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface. Returns either an `Operation.error` or an `Operation.response` which contains a `LongRunningRecognizeResponse` message. For more information on asynchronous speech recognition, see the [how-to](https://cloud.google.com/speech-to-text/docs/async-recognize).
Args:
request: (LongRunningRecognizeRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(Operation) The response message.
"""
config = self.GetMethodConfig('Longrunningrecognize')
return self._RunMethod(
config, request, global_params=global_params)
Longrunningrecognize.method_config = lambda: base_api.ApiMethodInfo(
http_method='POST',
method_id='speech.speech.longrunningrecognize',
ordered_params=[],
path_params=[],
query_params=[],
relative_path='v1/speech:longrunningrecognize',
request_field='<request>',
request_type_name='LongRunningRecognizeRequest',
response_type_name='Operation',
supports_download=False,
)
def Recognize(self, request, global_params=None):
r"""Performs synchronous speech recognition: receive results after all audio has been sent and processed.
Args:
request: (RecognizeRequest) input message
global_params: (StandardQueryParameters, default: None) global arguments
Returns:
(RecognizeResponse) The response message.
"""
config = self.GetMethodConfig('Recognize')
return self._RunMethod(
config, request, global_params=global_params)
Recognize.method_config = lambda: base_api.ApiMethodInfo(
http_method='POST',
method_id='speech.speech.recognize',
ordered_params=[],
path_params=[],
query_params=[],
relative_path='v1/speech:recognize',
request_field='<request>',
request_type_name='RecognizeRequest',
response_type_name='RecognizeResponse',
supports_download=False,
)