From 99fd13547233ebf59db493c337c9f6cc6a961972 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Mon, 3 Oct 2022 11:23:56 -0400 Subject: [PATCH] feat: added Speech-to-Text V2 API (#447) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * build: enable Speech v2 client library generation PiperOrigin-RevId: 477910378 Source-Link: https://github.com/googleapis/googleapis/commit/3fde7ab75e8161d7fa66984dd1705b02a354a035 Source-Link: https://github.com/googleapis/googleapis-gen/commit/636957906cc7868065a50cef61f5e995a75ae3e6 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNjM2OTU3OTA2Y2M3ODY4MDY1YTUwY2VmNjFmNWU5OTVhNzVhZTNlNiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * chore: regenerate docs/index.rst * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot Co-authored-by: Anthonios Partheniou --- .../google-cloud-python-speech/docs/index.rst | 35 +- .../docs/speech_v2/services.rst | 6 + .../docs/speech_v2/speech.rst | 10 + .../docs/speech_v2/types.rst | 7 + .../google/cloud/speech_v2/__init__.py | 133 + .../cloud/speech_v2/gapic_metadata.json | 253 + .../google/cloud/speech_v2/py.typed | 2 + .../cloud/speech_v2/services/__init__.py | 15 + .../speech_v2/services/speech/__init__.py | 22 + .../speech_v2/services/speech/async_client.py | 3414 +++++++ .../cloud/speech_v2/services/speech/client.py | 3752 ++++++++ .../cloud/speech_v2/services/speech/pagers.py | 411 + .../services/speech/transports/__init__.py | 33 + .../services/speech/transports/base.py | 523 ++ .../services/speech/transports/grpc.py | 946 ++ .../speech/transports/grpc_asyncio.py | 984 ++ .../google/cloud/speech_v2/types/__init__.py | 122 + .../cloud/speech_v2/types/cloud_speech.py | 2820 ++++++ packages/google-cloud-python-speech/owlbot.py | 5 +- .../snippet_metadata_speech_v2.json | 3845 ++++++++ ..._generated_speech_batch_recognize_async.py | 56 + ...2_generated_speech_batch_recognize_sync.py | 56 + ...erated_speech_create_custom_class_async.py | 56 + ...nerated_speech_create_custom_class_sync.py | 56 + ...enerated_speech_create_phrase_set_async.py | 56 + ...generated_speech_create_phrase_set_sync.py | 56 + ...enerated_speech_create_recognizer_async.py | 61 + ...generated_speech_create_recognizer_sync.py | 61 + ...erated_speech_delete_custom_class_async.py | 56 + ...nerated_speech_delete_custom_class_sync.py | 56 + ...enerated_speech_delete_phrase_set_async.py | 56 + ...generated_speech_delete_phrase_set_sync.py | 56 + ...enerated_speech_delete_recognizer_async.py | 56 + ...generated_speech_delete_recognizer_sync.py | 56 + ...ch_v2_generated_speech_get_config_async.py | 52 + ...ech_v2_generated_speech_get_config_sync.py | 52 + ...generated_speech_get_custom_class_async.py | 52 + ..._generated_speech_get_custom_class_sync.py | 52 + ...2_generated_speech_get_phrase_set_async.py | 52 + ...v2_generated_speech_get_phrase_set_sync.py | 52 + ...2_generated_speech_get_recognizer_async.py | 52 + ...v2_generated_speech_get_recognizer_sync.py | 52 + ...erated_speech_list_custom_classes_async.py | 53 + ...nerated_speech_list_custom_classes_sync.py | 53 + ...generated_speech_list_phrase_sets_async.py | 53 + ..._generated_speech_list_phrase_sets_sync.py | 53 + ...generated_speech_list_recognizers_async.py | 53 + ..._generated_speech_list_recognizers_sync.py | 53 + ...ech_v2_generated_speech_recognize_async.py | 53 + ...eech_v2_generated_speech_recognize_sync.py | 53 + ...erated_speech_streaming_recognize_async.py | 63 + ...nerated_speech_streaming_recognize_sync.py | 63 + ...ated_speech_undelete_custom_class_async.py | 56 + ...rated_speech_undelete_custom_class_sync.py | 56 + ...erated_speech_undelete_phrase_set_async.py | 56 + ...nerated_speech_undelete_phrase_set_sync.py | 56 + ...erated_speech_undelete_recognizer_async.py | 56 + ...nerated_speech_undelete_recognizer_sync.py | 56 + ...v2_generated_speech_update_config_async.py | 51 + ..._v2_generated_speech_update_config_sync.py | 51 + ...erated_speech_update_custom_class_async.py | 55 + ...nerated_speech_update_custom_class_sync.py | 55 + ...enerated_speech_update_phrase_set_async.py | 55 + ...generated_speech_update_phrase_set_sync.py | 55 + ...enerated_speech_update_recognizer_async.py | 60 + ...generated_speech_update_recognizer_sync.py | 60 + .../scripts/fixup_speech_v2_keywords.py | 198 + .../tests/unit/gapic/speech_v2/__init__.py | 15 + .../tests/unit/gapic/speech_v2/test_speech.py | 8228 +++++++++++++++++ 69 files changed, 28302 insertions(+), 15 deletions(-) create mode 100644 packages/google-cloud-python-speech/docs/speech_v2/services.rst create mode 100644 packages/google-cloud-python-speech/docs/speech_v2/speech.rst create mode 100644 packages/google-cloud-python-speech/docs/speech_v2/types.rst create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/__init__.py create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/gapic_metadata.json create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/py.typed create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/services/__init__.py create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/__init__.py create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/async_client.py create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/client.py create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/pagers.py create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/__init__.py create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/base.py create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/grpc.py create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/grpc_asyncio.py create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/types/__init__.py create mode 100644 packages/google-cloud-python-speech/google/cloud/speech_v2/types/cloud_speech.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/snippet_metadata_speech_v2.json create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_batch_recognize_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_batch_recognize_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_custom_class_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_custom_class_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_recognizer_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_recognizer_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_config_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_config_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_custom_class_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_custom_class_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_recognizer_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_recognizer_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_recognizers_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_recognizers_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_recognize_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_recognize_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_config_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_config_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_custom_class_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_custom_class_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_sync.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_recognizer_async.py create mode 100644 packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_recognizer_sync.py create mode 100644 packages/google-cloud-python-speech/scripts/fixup_speech_v2_keywords.py create mode 100644 packages/google-cloud-python-speech/tests/unit/gapic/speech_v2/__init__.py create mode 100644 packages/google-cloud-python-speech/tests/unit/gapic/speech_v2/test_speech.py diff --git a/packages/google-cloud-python-speech/docs/index.rst b/packages/google-cloud-python-speech/docs/index.rst index de7430796564..8c7d97b2bd8b 100644 --- a/packages/google-cloud-python-speech/docs/index.rst +++ b/packages/google-cloud-python-speech/docs/index.rst @@ -2,33 +2,44 @@ .. include:: multiprocessing.rst +This package includes clients for multiple versions of Cloud Speech. +By default, you will get version ``speech_v1``. + API Reference ------------- - .. toctree:: - :maxdepth: 2 + :maxdepth: 2 - speech_v1/services - speech_v1/types + speech_v1/services + speech_v1/types -An API and type reference is provided the first beta also: +API Reference +------------- +.. toctree:: + :maxdepth: 2 + speech_v1p1beta1/services + speech_v1p1beta1/types + +API Reference +------------- .. toctree:: - :maxdepth: 2 + :maxdepth: 2 + + speech_v2/services + speech_v2/types - speech_v1p1beta1/services - speech_v1p1beta1/types Migration Guide --------------- -See the guide below for instructions on migrating to the 2.x release of this library. +See the guide below for instructions on migrating to the latest version. .. toctree:: :maxdepth: 2 - UPGRADING +  UPGRADING Changelog @@ -37,6 +48,6 @@ Changelog For a list of all ``google-cloud-speech`` releases: .. toctree:: - :maxdepth: 2 + :maxdepth: 2 - changelog + changelog diff --git a/packages/google-cloud-python-speech/docs/speech_v2/services.rst b/packages/google-cloud-python-speech/docs/speech_v2/services.rst new file mode 100644 index 000000000000..b74a632d990b --- /dev/null +++ b/packages/google-cloud-python-speech/docs/speech_v2/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Speech v2 API +======================================= +.. toctree:: + :maxdepth: 2 + + speech diff --git a/packages/google-cloud-python-speech/docs/speech_v2/speech.rst b/packages/google-cloud-python-speech/docs/speech_v2/speech.rst new file mode 100644 index 000000000000..54fe79f4e9b1 --- /dev/null +++ b/packages/google-cloud-python-speech/docs/speech_v2/speech.rst @@ -0,0 +1,10 @@ +Speech +------------------------ + +.. automodule:: google.cloud.speech_v2.services.speech + :members: + :inherited-members: + +.. automodule:: google.cloud.speech_v2.services.speech.pagers + :members: + :inherited-members: diff --git a/packages/google-cloud-python-speech/docs/speech_v2/types.rst b/packages/google-cloud-python-speech/docs/speech_v2/types.rst new file mode 100644 index 000000000000..0b0ee74b7345 --- /dev/null +++ b/packages/google-cloud-python-speech/docs/speech_v2/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Speech v2 API +==================================== + +.. automodule:: google.cloud.speech_v2.types + :members: + :undoc-members: + :show-inheritance: diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/__init__.py b/packages/google-cloud-python-speech/google/cloud/speech_v2/__init__.py new file mode 100644 index 000000000000..2e218826be6d --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/__init__.py @@ -0,0 +1,133 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .services.speech import SpeechClient +from .services.speech import SpeechAsyncClient + +from .types.cloud_speech import AutoDetectDecodingConfig +from .types.cloud_speech import BatchRecognizeFileMetadata +from .types.cloud_speech import BatchRecognizeFileResult +from .types.cloud_speech import BatchRecognizeMetadata +from .types.cloud_speech import BatchRecognizeRequest +from .types.cloud_speech import BatchRecognizeResponse +from .types.cloud_speech import BatchRecognizeTranscriptionMetadata +from .types.cloud_speech import Config +from .types.cloud_speech import CreateCustomClassRequest +from .types.cloud_speech import CreatePhraseSetRequest +from .types.cloud_speech import CreateRecognizerRequest +from .types.cloud_speech import CustomClass +from .types.cloud_speech import DeleteCustomClassRequest +from .types.cloud_speech import DeletePhraseSetRequest +from .types.cloud_speech import DeleteRecognizerRequest +from .types.cloud_speech import ExplicitDecodingConfig +from .types.cloud_speech import GetConfigRequest +from .types.cloud_speech import GetCustomClassRequest +from .types.cloud_speech import GetPhraseSetRequest +from .types.cloud_speech import GetRecognizerRequest +from .types.cloud_speech import ListCustomClassesRequest +from .types.cloud_speech import ListCustomClassesResponse +from .types.cloud_speech import ListPhraseSetsRequest +from .types.cloud_speech import ListPhraseSetsResponse +from .types.cloud_speech import ListRecognizersRequest +from .types.cloud_speech import ListRecognizersResponse +from .types.cloud_speech import OperationMetadata +from .types.cloud_speech import PhraseSet +from .types.cloud_speech import RecognitionConfig +from .types.cloud_speech import RecognitionFeatures +from .types.cloud_speech import RecognitionResponseMetadata +from .types.cloud_speech import Recognizer +from .types.cloud_speech import RecognizeRequest +from .types.cloud_speech import RecognizeResponse +from .types.cloud_speech import SpeakerDiarizationConfig +from .types.cloud_speech import SpeechAdaptation +from .types.cloud_speech import SpeechRecognitionAlternative +from .types.cloud_speech import SpeechRecognitionResult +from .types.cloud_speech import StreamingRecognitionConfig +from .types.cloud_speech import StreamingRecognitionFeatures +from .types.cloud_speech import StreamingRecognitionResult +from .types.cloud_speech import StreamingRecognizeRequest +from .types.cloud_speech import StreamingRecognizeResponse +from .types.cloud_speech import UndeleteCustomClassRequest +from .types.cloud_speech import UndeletePhraseSetRequest +from .types.cloud_speech import UndeleteRecognizerRequest +from .types.cloud_speech import UpdateConfigRequest +from .types.cloud_speech import UpdateCustomClassRequest +from .types.cloud_speech import UpdatePhraseSetRequest +from .types.cloud_speech import UpdateRecognizerRequest +from .types.cloud_speech import WordInfo + +from google.cloud.speech_v1.helpers import SpeechHelpers + + +class SpeechClient(SpeechHelpers, SpeechClient): + __doc__ = SpeechClient.__doc__ + + +__all__ = ( + "SpeechAsyncClient", + "AutoDetectDecodingConfig", + "BatchRecognizeFileMetadata", + "BatchRecognizeFileResult", + "BatchRecognizeMetadata", + "BatchRecognizeRequest", + "BatchRecognizeResponse", + "BatchRecognizeTranscriptionMetadata", + "Config", + "CreateCustomClassRequest", + "CreatePhraseSetRequest", + "CreateRecognizerRequest", + "CustomClass", + "DeleteCustomClassRequest", + "DeletePhraseSetRequest", + "DeleteRecognizerRequest", + "ExplicitDecodingConfig", + "GetConfigRequest", + "GetCustomClassRequest", + "GetPhraseSetRequest", + "GetRecognizerRequest", + "ListCustomClassesRequest", + "ListCustomClassesResponse", + "ListPhraseSetsRequest", + "ListPhraseSetsResponse", + "ListRecognizersRequest", + "ListRecognizersResponse", + "OperationMetadata", + "PhraseSet", + "RecognitionConfig", + "RecognitionFeatures", + "RecognitionResponseMetadata", + "RecognizeRequest", + "RecognizeResponse", + "Recognizer", + "SpeakerDiarizationConfig", + "SpeechAdaptation", + "SpeechClient", + "SpeechRecognitionAlternative", + "SpeechRecognitionResult", + "StreamingRecognitionConfig", + "StreamingRecognitionFeatures", + "StreamingRecognitionResult", + "StreamingRecognizeRequest", + "StreamingRecognizeResponse", + "UndeleteCustomClassRequest", + "UndeletePhraseSetRequest", + "UndeleteRecognizerRequest", + "UpdateConfigRequest", + "UpdateCustomClassRequest", + "UpdatePhraseSetRequest", + "UpdateRecognizerRequest", + "WordInfo", +) diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/gapic_metadata.json b/packages/google-cloud-python-speech/google/cloud/speech_v2/gapic_metadata.json new file mode 100644 index 000000000000..cfce81272ecb --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/gapic_metadata.json @@ -0,0 +1,253 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.speech_v2", + "protoPackage": "google.cloud.speech.v2", + "schema": "1.0", + "services": { + "Speech": { + "clients": { + "grpc": { + "libraryClient": "SpeechClient", + "rpcs": { + "BatchRecognize": { + "methods": [ + "batch_recognize" + ] + }, + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "CreateRecognizer": { + "methods": [ + "create_recognizer" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "DeleteRecognizer": { + "methods": [ + "delete_recognizer" + ] + }, + "GetConfig": { + "methods": [ + "get_config" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "GetRecognizer": { + "methods": [ + "get_recognizer" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSets": { + "methods": [ + "list_phrase_sets" + ] + }, + "ListRecognizers": { + "methods": [ + "list_recognizers" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + }, + "UndeleteCustomClass": { + "methods": [ + "undelete_custom_class" + ] + }, + "UndeletePhraseSet": { + "methods": [ + "undelete_phrase_set" + ] + }, + "UndeleteRecognizer": { + "methods": [ + "undelete_recognizer" + ] + }, + "UpdateConfig": { + "methods": [ + "update_config" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + }, + "UpdateRecognizer": { + "methods": [ + "update_recognizer" + ] + } + } + }, + "grpc-async": { + "libraryClient": "SpeechAsyncClient", + "rpcs": { + "BatchRecognize": { + "methods": [ + "batch_recognize" + ] + }, + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "CreateRecognizer": { + "methods": [ + "create_recognizer" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "DeleteRecognizer": { + "methods": [ + "delete_recognizer" + ] + }, + "GetConfig": { + "methods": [ + "get_config" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "GetRecognizer": { + "methods": [ + "get_recognizer" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSets": { + "methods": [ + "list_phrase_sets" + ] + }, + "ListRecognizers": { + "methods": [ + "list_recognizers" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + }, + "UndeleteCustomClass": { + "methods": [ + "undelete_custom_class" + ] + }, + "UndeletePhraseSet": { + "methods": [ + "undelete_phrase_set" + ] + }, + "UndeleteRecognizer": { + "methods": [ + "undelete_recognizer" + ] + }, + "UpdateConfig": { + "methods": [ + "update_config" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + }, + "UpdateRecognizer": { + "methods": [ + "update_recognizer" + ] + } + } + } + } + } + } +} diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/py.typed b/packages/google-cloud-python-speech/google/cloud/speech_v2/py.typed new file mode 100644 index 000000000000..02081c09b9ab --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-speech package uses inline types. diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/services/__init__.py b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/__init__.py new file mode 100644 index 000000000000..e8e1c3845db5 --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/__init__.py b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/__init__.py new file mode 100644 index 000000000000..80fcdb775bb2 --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import SpeechClient +from .async_client import SpeechAsyncClient + +__all__ = ( + "SpeechClient", + "SpeechAsyncClient", +) diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/async_client.py b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/async_client.py new file mode 100644 index 000000000000..f44234e11a3c --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/async_client.py @@ -0,0 +1,3414 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import ( + Dict, + Mapping, + Optional, + AsyncIterable, + Awaitable, + AsyncIterator, + Sequence, + Tuple, + Type, + Union, +) +import pkg_resources + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.speech_v2.services.speech import pagers +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport +from .client import SpeechClient + + +class SpeechAsyncClient: + """Enables speech transcription and resource management.""" + + _client: SpeechClient + + DEFAULT_ENDPOINT = SpeechClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = SpeechClient.DEFAULT_MTLS_ENDPOINT + + config_path = staticmethod(SpeechClient.config_path) + parse_config_path = staticmethod(SpeechClient.parse_config_path) + crypto_key_path = staticmethod(SpeechClient.crypto_key_path) + parse_crypto_key_path = staticmethod(SpeechClient.parse_crypto_key_path) + crypto_key_version_path = staticmethod(SpeechClient.crypto_key_version_path) + parse_crypto_key_version_path = staticmethod( + SpeechClient.parse_crypto_key_version_path + ) + custom_class_path = staticmethod(SpeechClient.custom_class_path) + parse_custom_class_path = staticmethod(SpeechClient.parse_custom_class_path) + phrase_set_path = staticmethod(SpeechClient.phrase_set_path) + parse_phrase_set_path = staticmethod(SpeechClient.parse_phrase_set_path) + recognizer_path = staticmethod(SpeechClient.recognizer_path) + parse_recognizer_path = staticmethod(SpeechClient.parse_recognizer_path) + common_billing_account_path = staticmethod(SpeechClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod( + SpeechClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod(SpeechClient.common_folder_path) + parse_common_folder_path = staticmethod(SpeechClient.parse_common_folder_path) + common_organization_path = staticmethod(SpeechClient.common_organization_path) + parse_common_organization_path = staticmethod( + SpeechClient.parse_common_organization_path + ) + common_project_path = staticmethod(SpeechClient.common_project_path) + parse_common_project_path = staticmethod(SpeechClient.parse_common_project_path) + common_location_path = staticmethod(SpeechClient.common_location_path) + parse_common_location_path = staticmethod(SpeechClient.parse_common_location_path) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + 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: + SpeechAsyncClient: The constructed client. + """ + return SpeechClient.from_service_account_info.__func__(SpeechAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + 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: + SpeechAsyncClient: The constructed client. + """ + return SpeechClient.from_service_account_file.__func__(SpeechAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[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. + + Args: + 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: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return SpeechClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> SpeechTransport: + """Returns the transport used by the client instance. + + Returns: + SpeechTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial( + type(SpeechClient).get_transport_class, type(SpeechClient) + ) + + def __init__( + self, + *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, SpeechTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the speech client. + + Args: + 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, ~.SpeechTransport]): 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. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = SpeechClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + ) + + async def create_recognizer( + self, + request: Union[cloud_speech.CreateRecognizerRequest, dict] = None, + *, + parent: str = None, + recognizer: cloud_speech.Recognizer = None, + recognizer_id: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # 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) + recognizer = speech_v2.Recognizer() + recognizer.model = "model_value" + recognizer.language_codes = ['language_codes_value1', 'language_codes_value2'] + + request = speech_v2.CreateRecognizerRequest( + recognizer=recognizer, + 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) + + Args: + 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 (:class:`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 (:class:`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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, recognizer, recognizer_id]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.CreateRecognizerRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if recognizer is not None: + request.recognizer = recognizer + if recognizer_id is not None: + request.recognizer_id = recognizer_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_recognizer, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_recognizers( + self, + request: Union[cloud_speech.ListRecognizersRequest, dict] = None, + *, + parent: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRecognizersAsyncPager: + r"""Lists Recognizers. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + google.cloud.speech_v2.services.speech.pagers.ListRecognizersAsyncPager: + Response message for the + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.ListRecognizersRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_recognizers, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListRecognizersAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_recognizer( + self, + request: Union[cloud_speech.GetRecognizerRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.Recognizer: + r"""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. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + google.cloud.speech_v2.types.Recognizer: + A Recognizer message. Stores + recognition configuration and metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.GetRecognizerRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_recognizer, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_recognizer( + self, + request: Union[cloud_speech.UpdateRecognizerRequest, dict] = None, + *, + recognizer: cloud_speech.Recognizer = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # 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) + recognizer = speech_v2.Recognizer() + recognizer.model = "model_value" + recognizer.language_codes = ['language_codes_value1', 'language_codes_value2'] + + request = speech_v2.UpdateRecognizerRequest( + recognizer=recognizer, + ) + + # Make the request + operation = client.update_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = await operation.result() + + # Handle the response + print(response) + + Args: + 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 (:class:`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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([recognizer, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.UpdateRecognizerRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if recognizer is not None: + request.recognizer = recognizer + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_recognizer, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("recognizer.name", request.recognizer.name),) + ), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_recognizer( + self, + request: Union[cloud_speech.DeleteRecognizerRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.DeleteRecognizerRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_recognizer, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def undelete_recognizer( + self, + request: Union[cloud_speech.UndeleteRecognizerRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Undeletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.UndeleteRecognizerRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.undelete_recognizer, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def recognize( + self, + request: Union[cloud_speech.RecognizeRequest, dict] = None, + *, + recognizer: str = None, + config: cloud_speech.RecognitionConfig = None, + config_mask: field_mask_pb2.FieldMask = None, + content: bytes = None, + uri: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.RecognizeResponse: + r"""Performs synchronous Speech recognition: receive + results after all audio has been sent and processed. + + .. code-block:: python + + # 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) + + Args: + 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](https://cloud.google.com/speech-to-text/quotas#content). + recognizer (:class:`str`): + Required. The name of the Recognizer to use during + recognition. The expected format is + ``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. + config (:class:`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 (:class:`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 (:class:`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 (:class:`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: + google.cloud.speech_v2.types.RecognizeResponse: + Response message for the + [Recognize][google.cloud.speech.v2.Speech.Recognize] + method. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([recognizer, config, config_mask, content, uri]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.RecognizeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if recognizer is not None: + request.recognizer = recognizer + if config is not None: + request.config = config + if config_mask is not None: + request.config_mask = config_mask + if content is not None: + request.content = content + if uri is not None: + request.uri = uri + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.recognize, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("recognizer", request.recognizer),) + ), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def streaming_recognize( + self, + requests: AsyncIterator[cloud_speech.StreamingRecognizeRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> Awaitable[AsyncIterable[cloud_speech.StreamingRecognizeResponse]]: + r"""Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + .. code-block:: python + + # 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) + + Args: + 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. The first message must contain a + [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] + and optionally a + [streaming_config][google.cloud.speech.v2.StreamingRecognizeRequest.streaming_config] + message and must not contain + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio]. + All subsequent messages must contain + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] + and must not contain a + [streaming_config][google.cloud.speech.v2.StreamingRecognizeRequest.streaming_config] + message. + 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: + AsyncIterable[google.cloud.speech_v2.types.StreamingRecognizeResponse]: + 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: + + 1. results { alternatives { transcript: "tube" } + stability: 0.01 } + 2. results { alternatives { transcript: "to be a" } + stability: 0.01 } + 3. results { alternatives { transcript: "to be" } + stability: 0.9 } results { alternatives { + transcript: " or not to be" } stability: 0.01 } + 4. + + results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } + + alternatives { transcript: "to bee or not to bee" } + is_final: true } + + 5. results { alternatives { transcript: " that's" } + stability: 0.01 } + 6. results { alternatives { transcript: " that is" } + stability: 0.9 } results { alternatives { + transcript: " the question" } stability: 0.01 } + 7. + + 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. + + """ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.streaming_recognize, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = rpc( + requests, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def batch_recognize( + self, + request: Union[cloud_speech.BatchRecognizeRequest, dict] = None, + *, + recognizer: str = None, + config: cloud_speech.RecognitionConfig = None, + config_mask: field_mask_pb2.FieldMask = None, + files: Sequence[cloud_speech.BatchRecognizeFileMetadata] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""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. + + .. code-block:: python + + # 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_batch_recognize(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # 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 = await operation.result() + + # Handle the response + print(response) + + Args: + 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 (:class:`str`): + Required. Resource name of the + recognizer to be used for ASR. + + This corresponds to the ``recognizer`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + config (:class:`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 (:class:`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 (:class:`Sequence[google.cloud.speech_v2.types.BatchRecognizeFileMetadata]`): + Audio files with file metadata for + ASR. + + 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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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]. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([recognizer, config, config_mask, files]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.BatchRecognizeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if recognizer is not None: + request.recognizer = recognizer + if config is not None: + request.config = config + if config_mask is not None: + request.config_mask = config_mask + if files: + request.files.extend(files) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.batch_recognize, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("recognizer", request.recognizer),) + ), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.BatchRecognizeResponse, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def get_config( + self, + request: Union[cloud_speech.GetConfigRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.Config: + r"""Returns the requested [Config][google.cloud.speech.v2.Config]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + google.cloud.speech_v2.types.Config: + 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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.GetConfigRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_config, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_config( + self, + request: Union[cloud_speech.UpdateConfigRequest, dict] = None, + *, + config: cloud_speech.Config = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.Config: + r"""Updates the [Config][google.cloud.speech.v2.Config]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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 (:class:`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: + google.cloud.speech_v2.types.Config: + 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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.UpdateConfigRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_config, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("config.name", request.config.name),) + ), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def create_custom_class( + self, + request: Union[cloud_speech.CreateCustomClassRequest, dict] = None, + *, + parent: str = None, + custom_class: cloud_speech.CustomClass = None, + custom_class_id: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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 (: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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, custom_class, custom_class_id]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.CreateCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if custom_class is not None: + request.custom_class = custom_class + if custom_class_id is not None: + request.custom_class_id = custom_class_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_custom_class, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_custom_classes( + self, + request: Union[cloud_speech.ListCustomClassesRequest, dict] = None, + *, + parent: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListCustomClassesAsyncPager: + r"""Lists CustomClasses. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + google.cloud.speech_v2.services.speech.pagers.ListCustomClassesAsyncPager: + Response message for the + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.ListCustomClassesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_custom_classes, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListCustomClassesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_custom_class( + self, + request: Union[cloud_speech.GetCustomClassRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.CustomClass: + r"""Returns the requested + [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + 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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.GetCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_custom_class, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_custom_class( + self, + request: Union[cloud_speech.UpdateCustomClassRequest, dict] = None, + *, + custom_class: cloud_speech.CustomClass = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # 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) + + Args: + 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 (: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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([custom_class, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.UpdateCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if custom_class is not None: + request.custom_class = custom_class + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_custom_class, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("custom_class.name", request.custom_class.name),) + ), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_custom_class( + self, + request: Union[cloud_speech.DeleteCustomClassRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.DeleteCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_custom_class, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def undelete_custom_class( + self, + request: Union[cloud_speech.UndeleteCustomClassRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Undeletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.UndeleteCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.undelete_custom_class, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def create_phrase_set( + self, + request: Union[cloud_speech.CreatePhraseSetRequest, dict] = None, + *, + parent: str = None, + phrase_set: cloud_speech.PhraseSet = None, + phrase_set_id: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Creates a [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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 (:class:`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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, phrase_set, phrase_set_id]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.CreatePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if phrase_set is not None: + request.phrase_set = phrase_set + if phrase_set_id is not None: + request.phrase_set_id = phrase_set_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.create_phrase_set, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_phrase_sets( + self, + request: Union[cloud_speech.ListPhraseSetsRequest, dict] = None, + *, + parent: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListPhraseSetsAsyncPager: + r"""Lists PhraseSets. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + google.cloud.speech_v2.services.speech.pagers.ListPhraseSetsAsyncPager: + Response message for the + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.ListPhraseSetsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_phrase_sets, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListPhraseSetsAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_phrase_set( + self, + request: Union[cloud_speech.GetPhraseSetRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.PhraseSet: + r"""Returns the requested + [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + 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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.GetPhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_phrase_set, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_phrase_set( + self, + request: Union[cloud_speech.UpdatePhraseSetRequest, dict] = None, + *, + phrase_set: cloud_speech.PhraseSet = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Updates the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([phrase_set, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.UpdatePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if phrase_set is not None: + request.phrase_set = phrase_set + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_phrase_set, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("phrase_set.name", request.phrase_set.name),) + ), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def delete_phrase_set( + self, + request: Union[cloud_speech.DeletePhraseSetRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Deletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.DeletePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_phrase_set, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def undelete_phrase_set( + self, + request: Union[cloud_speech.UndeletePhraseSetRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Undeletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # 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) + + Args: + 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 (:class:`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: + google.api_core.operation_async.AsyncOperation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + request = cloud_speech.UndeletePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.undelete_phrase_set, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation_async.from_gapic( + response, + self._client._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + async def list_operations( + self, + request: operations_pb2.ListOperationsRequest = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_operation( + self, + request: operations_pb2.GetOperationRequest = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.get_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_operation( + self, + request: operations_pb2.DeleteOperationRequest = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""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`. + + Args: + request (:class:`~.operations_pb2.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 + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.DeleteOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.delete_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def cancel_operation( + self, + request: operations_pb2.CancelOperationRequest = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""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`. + + Args: + request (:class:`~.operations_pb2.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 + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.CancelOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._client._transport.cancel_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-speech", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ("SpeechAsyncClient",) diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/client.py b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/client.py new file mode 100644 index 000000000000..e35c88d08ff3 --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/client.py @@ -0,0 +1,3752 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import ( + Dict, + Mapping, + Optional, + Iterable, + Iterator, + Sequence, + Tuple, + Type, + Union, +) +import pkg_resources + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.speech_v2.services.speech import pagers +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import SpeechGrpcTransport +from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport + + +class SpeechClientMeta(type): + """Metaclass for the Speech client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + + _transport_registry = OrderedDict() # type: Dict[str, Type[SpeechTransport]] + _transport_registry["grpc"] = SpeechGrpcTransport + _transport_registry["grpc_asyncio"] = SpeechGrpcAsyncIOTransport + + def get_transport_class( + cls, + label: str = None, + ) -> Type[SpeechTransport]: + """Returns an appropriate transport class. + + Args: + 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. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class SpeechClient(metaclass=SpeechClientMeta): + """Enables speech transcription and resource management.""" + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "speech.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + 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: + SpeechClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + 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: + SpeechClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file(filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> SpeechTransport: + """Returns the transport used by the client instance. + + Returns: + SpeechTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def config_path( + project: str, + location: str, + ) -> str: + """Returns a fully-qualified config string.""" + return "projects/{project}/locations/{location}/config".format( + project=project, + location=location, + ) + + @staticmethod + def parse_config_path(path: str) -> Dict[str, str]: + """Parses a config path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/config$", path + ) + return m.groupdict() if m else {} + + @staticmethod + def crypto_key_path( + project: str, + location: str, + key_ring: str, + crypto_key: str, + ) -> str: + """Returns a fully-qualified crypto_key string.""" + return "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}".format( + project=project, + location=location, + key_ring=key_ring, + crypto_key=crypto_key, + ) + + @staticmethod + def parse_crypto_key_path(path: str) -> Dict[str, str]: + """Parses a crypto_key path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/keyRings/(?P.+?)/cryptoKeys/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def 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.""" + return "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}".format( + project=project, + location=location, + key_ring=key_ring, + crypto_key=crypto_key, + crypto_key_version=crypto_key_version, + ) + + @staticmethod + def parse_crypto_key_version_path(path: str) -> Dict[str, str]: + """Parses a crypto_key_version path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/keyRings/(?P.+?)/cryptoKeys/(?P.+?)/cryptoKeyVersions/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def custom_class_path( + project: str, + location: str, + custom_class: str, + ) -> str: + """Returns a fully-qualified custom_class string.""" + return "projects/{project}/locations/{location}/customClasses/{custom_class}".format( + project=project, + location=location, + custom_class=custom_class, + ) + + @staticmethod + def parse_custom_class_path(path: str) -> Dict[str, str]: + """Parses a custom_class path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/customClasses/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def phrase_set_path( + project: str, + location: str, + phrase_set: str, + ) -> str: + """Returns a fully-qualified phrase_set string.""" + return "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format( + project=project, + location=location, + phrase_set=phrase_set, + ) + + @staticmethod + def parse_phrase_set_path(path: str) -> Dict[str, str]: + """Parses a phrase_set path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/phraseSets/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def recognizer_path( + project: str, + location: str, + recognizer: str, + ) -> str: + """Returns a fully-qualified recognizer string.""" + return ( + "projects/{project}/locations/{location}/recognizers/{recognizer}".format( + project=project, + location=location, + recognizer=recognizer, + ) + ) + + @staticmethod + def parse_recognizer_path(path: str) -> Dict[str, str]: + """Parses a recognizer path into its component segments.""" + m = re.match( + r"^projects/(?P.+?)/locations/(?P.+?)/recognizers/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path( + billing_account: str, + ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str, str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path( + folder: str, + ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format( + folder=folder, + ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str, str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path( + organization: str, + ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format( + organization=organization, + ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str, str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path( + project: str, + ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format( + project=project, + ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str, str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path( + project: str, + location: str, + ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str, str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[client_options_lib.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. + + Args: + 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: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError( + "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError( + "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or ( + use_mtls_endpoint == "auto" and client_cert_source + ): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, SpeechTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the speech client. + + Args: + 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, SpeechTransport]): 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 ``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. + 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. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source( + client_options + ) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError( + "client_options.api_key and credentials are mutually exclusive" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, SpeechTransport): + # transport is a SpeechTransport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError( + "When providing a transport instance, " + "provide its credentials directly." + ) + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr( + google.auth._default, "get_api_key_credentials" + ): + credentials = google.auth._default.get_api_key_credentials( + api_key_value + ) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=client_options.api_audience, + ) + + def create_recognizer( + self, + request: Union[cloud_speech.CreateRecognizerRequest, dict] = None, + *, + parent: str = None, + recognizer: cloud_speech.Recognizer = None, + recognizer_id: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # 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) + recognizer = speech_v2.Recognizer() + recognizer.model = "model_value" + recognizer.language_codes = ['language_codes_value1', 'language_codes_value2'] + + request = speech_v2.CreateRecognizerRequest( + recognizer=recognizer, + 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) + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, recognizer, recognizer_id]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.CreateRecognizerRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.CreateRecognizerRequest): + request = cloud_speech.CreateRecognizerRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if recognizer is not None: + request.recognizer = recognizer + if recognizer_id is not None: + request.recognizer_id = recognizer_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_recognizer] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_recognizers( + self, + request: Union[cloud_speech.ListRecognizersRequest, dict] = None, + *, + parent: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListRecognizersPager: + r"""Lists Recognizers. + + .. code-block:: python + + # 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) + + Args: + 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: + google.cloud.speech_v2.services.speech.pagers.ListRecognizersPager: + Response message for the + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.ListRecognizersRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.ListRecognizersRequest): + request = cloud_speech.ListRecognizersRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_recognizers] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListRecognizersPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_recognizer( + self, + request: Union[cloud_speech.GetRecognizerRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.Recognizer: + r"""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. + + .. code-block:: python + + # 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) + + Args: + 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: + google.cloud.speech_v2.types.Recognizer: + A Recognizer message. Stores + recognition configuration and metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.GetRecognizerRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.GetRecognizerRequest): + request = cloud_speech.GetRecognizerRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_recognizer] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_recognizer( + self, + request: Union[cloud_speech.UpdateRecognizerRequest, dict] = None, + *, + recognizer: cloud_speech.Recognizer = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # 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) + recognizer = speech_v2.Recognizer() + recognizer.model = "model_value" + recognizer.language_codes = ['language_codes_value1', 'language_codes_value2'] + + request = speech_v2.UpdateRecognizerRequest( + recognizer=recognizer, + ) + + # Make the request + operation = client.update_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([recognizer, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.UpdateRecognizerRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UpdateRecognizerRequest): + request = cloud_speech.UpdateRecognizerRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if recognizer is not None: + request.recognizer = recognizer + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_recognizer] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("recognizer.name", request.recognizer.name),) + ), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_recognizer( + self, + request: Union[cloud_speech.DeleteRecognizerRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # 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) + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.DeleteRecognizerRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.DeleteRecognizerRequest): + request = cloud_speech.DeleteRecognizerRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_recognizer] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def undelete_recognizer( + self, + request: Union[cloud_speech.UndeleteRecognizerRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Undeletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + .. code-block:: python + + # 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) + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be + :class:`google.cloud.speech_v2.types.Recognizer` A + Recognizer message. Stores recognition configuration and + metadata. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.UndeleteRecognizerRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UndeleteRecognizerRequest): + request = cloud_speech.UndeleteRecognizerRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.undelete_recognizer] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.Recognizer, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def recognize( + self, + request: Union[cloud_speech.RecognizeRequest, dict] = None, + *, + recognizer: str = None, + config: cloud_speech.RecognitionConfig = None, + config_mask: field_mask_pb2.FieldMask = None, + content: bytes = None, + uri: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.RecognizeResponse: + r"""Performs synchronous Speech recognition: receive + results after all audio has been sent and processed. + + .. code-block:: python + + # 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) + + Args: + 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](https://cloud.google.com/speech-to-text/quotas#content). + recognizer (str): + Required. The name of the Recognizer to use during + recognition. The expected format is + ``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. + 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: + google.cloud.speech_v2.types.RecognizeResponse: + Response message for the + [Recognize][google.cloud.speech.v2.Speech.Recognize] + method. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([recognizer, config, config_mask, content, uri]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.RecognizeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.RecognizeRequest): + request = cloud_speech.RecognizeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if recognizer is not None: + request.recognizer = recognizer + if config is not None: + request.config = config + if config_mask is not None: + request.config_mask = config_mask + if content is not None: + request.content = content + if uri is not None: + request.uri = uri + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.recognize] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("recognizer", request.recognizer),) + ), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def streaming_recognize( + self, + requests: Iterator[cloud_speech.StreamingRecognizeRequest] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> Iterable[cloud_speech.StreamingRecognizeResponse]: + r"""Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + .. code-block:: python + + # 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) + + Args: + 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. The first message must contain a + [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] + and optionally a + [streaming_config][google.cloud.speech.v2.StreamingRecognizeRequest.streaming_config] + message and must not contain + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio]. + All subsequent messages must contain + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] + and must not contain a + [streaming_config][google.cloud.speech.v2.StreamingRecognizeRequest.streaming_config] + message. + 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: + Iterable[google.cloud.speech_v2.types.StreamingRecognizeResponse]: + 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: + + 1. results { alternatives { transcript: "tube" } + stability: 0.01 } + 2. results { alternatives { transcript: "to be a" } + stability: 0.01 } + 3. results { alternatives { transcript: "to be" } + stability: 0.9 } results { alternatives { + transcript: " or not to be" } stability: 0.01 } + 4. + + results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } + + alternatives { transcript: "to bee or not to bee" } + is_final: true } + + 5. results { alternatives { transcript: " that's" } + stability: 0.01 } + 6. results { alternatives { transcript: " that is" } + stability: 0.9 } results { alternatives { + transcript: " the question" } stability: 0.01 } + 7. + + 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. + + """ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.streaming_recognize] + + # Send the request. + response = rpc( + requests, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def batch_recognize( + self, + request: Union[cloud_speech.BatchRecognizeRequest, dict] = None, + *, + recognizer: str = None, + config: cloud_speech.RecognitionConfig = None, + config_mask: field_mask_pb2.FieldMask = None, + files: Sequence[cloud_speech.BatchRecognizeFileMetadata] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""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. + + .. code-block:: python + + # 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) + + Args: + 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. Resource name of the + recognizer to be used for ASR. + + 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 (Sequence[google.cloud.speech_v2.types.BatchRecognizeFileMetadata]): + Audio files with file metadata for + ASR. + + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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]. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([recognizer, config, config_mask, files]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.BatchRecognizeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.BatchRecognizeRequest): + request = cloud_speech.BatchRecognizeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if recognizer is not None: + request.recognizer = recognizer + if config is not None: + request.config = config + if config_mask is not None: + request.config_mask = config_mask + if files is not None: + request.files = files + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.batch_recognize] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("recognizer", request.recognizer),) + ), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.BatchRecognizeResponse, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def get_config( + self, + request: Union[cloud_speech.GetConfigRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.Config: + r"""Returns the requested [Config][google.cloud.speech.v2.Config]. + + .. code-block:: python + + # 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) + + Args: + 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: + google.cloud.speech_v2.types.Config: + 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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.GetConfigRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.GetConfigRequest): + request = cloud_speech.GetConfigRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_config] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_config( + self, + request: Union[cloud_speech.UpdateConfigRequest, dict] = None, + *, + config: cloud_speech.Config = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.Config: + r"""Updates the [Config][google.cloud.speech.v2.Config]. + + .. code-block:: python + + # 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) + + Args: + 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: + google.cloud.speech_v2.types.Config: + 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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.UpdateConfigRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UpdateConfigRequest): + request = cloud_speech.UpdateConfigRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_config] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("config.name", request.config.name),) + ), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def create_custom_class( + self, + request: Union[cloud_speech.CreateCustomClassRequest, dict] = None, + *, + parent: str = None, + custom_class: cloud_speech.CustomClass = None, + custom_class_id: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # 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) + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, custom_class, custom_class_id]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.CreateCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.CreateCustomClassRequest): + request = cloud_speech.CreateCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if custom_class is not None: + request.custom_class = custom_class + if custom_class_id is not None: + request.custom_class_id = custom_class_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_custom_classes( + self, + request: Union[cloud_speech.ListCustomClassesRequest, dict] = None, + *, + parent: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListCustomClassesPager: + r"""Lists CustomClasses. + + .. code-block:: python + + # 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) + + Args: + 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: + google.cloud.speech_v2.services.speech.pagers.ListCustomClassesPager: + Response message for the + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.ListCustomClassesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.ListCustomClassesRequest): + request = cloud_speech.ListCustomClassesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_custom_classes] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListCustomClassesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_custom_class( + self, + request: Union[cloud_speech.GetCustomClassRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.CustomClass: + r"""Returns the requested + [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # 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) + + Args: + 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: + 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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.GetCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.GetCustomClassRequest): + request = cloud_speech.GetCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_custom_class( + self, + request: Union[cloud_speech.UpdateCustomClassRequest, dict] = None, + *, + custom_class: cloud_speech.CustomClass = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # 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) + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([custom_class, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.UpdateCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UpdateCustomClassRequest): + request = cloud_speech.UpdateCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if custom_class is not None: + request.custom_class = custom_class + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("custom_class.name", request.custom_class.name),) + ), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_custom_class( + self, + request: Union[cloud_speech.DeleteCustomClassRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # 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) + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.DeleteCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.DeleteCustomClassRequest): + request = cloud_speech.DeleteCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def undelete_custom_class( + self, + request: Union[cloud_speech.UndeleteCustomClassRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Undeletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + .. code-block:: python + + # 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) + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.UndeleteCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UndeleteCustomClassRequest): + request = cloud_speech.UndeleteCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.undelete_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.CustomClass, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def create_phrase_set( + self, + request: Union[cloud_speech.CreatePhraseSetRequest, dict] = None, + *, + parent: str = None, + phrase_set: cloud_speech.PhraseSet = None, + phrase_set_id: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Creates a [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # 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) + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent, phrase_set, phrase_set_id]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.CreatePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.CreatePhraseSetRequest): + request = cloud_speech.CreatePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if phrase_set is not None: + request.phrase_set = phrase_set + if phrase_set_id is not None: + request.phrase_set_id = phrase_set_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def list_phrase_sets( + self, + request: Union[cloud_speech.ListPhraseSetsRequest, dict] = None, + *, + parent: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListPhraseSetsPager: + r"""Lists PhraseSets. + + .. code-block:: python + + # 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) + + Args: + 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: + google.cloud.speech_v2.services.speech.pagers.ListPhraseSetsPager: + Response message for the + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([parent]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.ListPhraseSetsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.ListPhraseSetsRequest): + request = cloud_speech.ListPhraseSetsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_phrase_sets] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListPhraseSetsPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_phrase_set( + self, + request: Union[cloud_speech.GetPhraseSetRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.PhraseSet: + r"""Returns the requested + [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # 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) + + Args: + 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: + 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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.GetPhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.GetPhraseSetRequest): + request = cloud_speech.GetPhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_phrase_set( + self, + request: Union[cloud_speech.UpdatePhraseSetRequest, dict] = None, + *, + phrase_set: cloud_speech.PhraseSet = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Updates the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # 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) + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([phrase_set, update_mask]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.UpdatePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UpdatePhraseSetRequest): + request = cloud_speech.UpdatePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if phrase_set is not None: + request.phrase_set = phrase_set + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + (("phrase_set.name", request.phrase_set.name),) + ), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def delete_phrase_set( + self, + request: Union[cloud_speech.DeletePhraseSetRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Deletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # 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) + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.DeletePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.DeletePhraseSetRequest): + request = cloud_speech.DeletePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def undelete_phrase_set( + self, + request: Union[cloud_speech.UndeletePhraseSetRequest, dict] = None, + *, + name: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Undeletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + .. code-block:: python + + # 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) + + Args: + 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: + google.api_core.operation.Operation: + An object representing a long-running operation. + + The result type for the operation will be :class:`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. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([name]) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # Minor optimization to avoid making a copy if the user passes + # in a cloud_speech.UndeletePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.UndeletePhraseSetRequest): + request = cloud_speech.UndeletePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.undelete_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Wrap the response in an operation future. + response = operation.from_gapic( + response, + self._transport.operations_client, + cloud_speech.PhraseSet, + metadata_type=cloud_speech.OperationMetadata, + ) + + # Done; return the response. + return response + + def __enter__(self): + return self + + def __exit__(self, type, value, traceback): + """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! + """ + self.transport.close() + + def list_operations( + self, + request: operations_pb2.ListOperationsRequest = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.ListOperationsResponse: + r"""Lists operations that match the specified filter in the request. + + Args: + request (:class:`~.operations_pb2.ListOperationsRequest`): + The request object. Request message for + `ListOperations` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.ListOperationsResponse: + Response message for ``ListOperations`` method. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.ListOperationsRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.list_operations, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_operation( + self, + request: operations_pb2.GetOperationRequest = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operations_pb2.Operation: + r"""Gets the latest state of a long-running operation. + + Args: + request (:class:`~.operations_pb2.GetOperationRequest`): + The request object. Request message for + `GetOperation` method. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + Returns: + ~.operations_pb2.Operation: + An ``Operation`` object. + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.GetOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.get_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_operation( + self, + request: operations_pb2.DeleteOperationRequest = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""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`. + + Args: + request (:class:`~.operations_pb2.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 + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.DeleteOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.delete_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def cancel_operation( + self, + request: operations_pb2.CancelOperationRequest = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""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`. + + Args: + request (:class:`~.operations_pb2.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 + """ + # Create or coerce a protobuf request object. + # The request isn't a proto-plus wrapped type, + # so it must be constructed via keyword expansion. + if isinstance(request, dict): + request = operations_pb2.CancelOperationRequest(**request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method.wrap_method( + self._transport.cancel_operation, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-speech", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ("SpeechClient",) diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/pagers.py b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/pagers.py new file mode 100644 index 000000000000..81a6873ddf11 --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/pagers.py @@ -0,0 +1,411 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import ( + Any, + AsyncIterator, + Awaitable, + Callable, + Sequence, + Tuple, + Optional, + Iterator, +) + +from google.cloud.speech_v2.types import cloud_speech + + +class ListRecognizersPager: + """A pager for iterating through ``list_recognizers`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v2.types.ListRecognizersResponse` object, and + provides an ``__iter__`` method to iterate through its + ``recognizers`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListRecognizers`` requests and continue to iterate + through the ``recognizers`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v2.types.ListRecognizersResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., cloud_speech.ListRecognizersResponse], + request: cloud_speech.ListRecognizersRequest, + response: cloud_speech.ListRecognizersResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v2.types.ListRecognizersRequest): + The initial request object. + response (google.cloud.speech_v2.types.ListRecognizersResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech.ListRecognizersRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_speech.ListRecognizersResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_speech.Recognizer]: + for page in self.pages: + yield from page.recognizers + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListRecognizersAsyncPager: + """A pager for iterating through ``list_recognizers`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v2.types.ListRecognizersResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``recognizers`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListRecognizers`` requests and continue to iterate + through the ``recognizers`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v2.types.ListRecognizersResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., Awaitable[cloud_speech.ListRecognizersResponse]], + request: cloud_speech.ListRecognizersRequest, + response: cloud_speech.ListRecognizersResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v2.types.ListRecognizersRequest): + The initial request object. + response (google.cloud.speech_v2.types.ListRecognizersResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech.ListRecognizersRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_speech.ListRecognizersResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterator[cloud_speech.Recognizer]: + async def async_generator(): + async for page in self.pages: + for response in page.recognizers: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListCustomClassesPager: + """A pager for iterating through ``list_custom_classes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v2.types.ListCustomClassesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``custom_classes`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListCustomClasses`` requests and continue to iterate + through the ``custom_classes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v2.types.ListCustomClassesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., cloud_speech.ListCustomClassesResponse], + request: cloud_speech.ListCustomClassesRequest, + response: cloud_speech.ListCustomClassesResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v2.types.ListCustomClassesRequest): + The initial request object. + response (google.cloud.speech_v2.types.ListCustomClassesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech.ListCustomClassesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_speech.ListCustomClassesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_speech.CustomClass]: + for page in self.pages: + yield from page.custom_classes + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListCustomClassesAsyncPager: + """A pager for iterating through ``list_custom_classes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v2.types.ListCustomClassesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``custom_classes`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListCustomClasses`` requests and continue to iterate + through the ``custom_classes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v2.types.ListCustomClassesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., Awaitable[cloud_speech.ListCustomClassesResponse]], + request: cloud_speech.ListCustomClassesRequest, + response: cloud_speech.ListCustomClassesResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v2.types.ListCustomClassesRequest): + The initial request object. + response (google.cloud.speech_v2.types.ListCustomClassesResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech.ListCustomClassesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_speech.ListCustomClassesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterator[cloud_speech.CustomClass]: + async def async_generator(): + async for page in self.pages: + for response in page.custom_classes: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListPhraseSetsPager: + """A pager for iterating through ``list_phrase_sets`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v2.types.ListPhraseSetsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``phrase_sets`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListPhraseSets`` requests and continue to iterate + through the ``phrase_sets`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v2.types.ListPhraseSetsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., cloud_speech.ListPhraseSetsResponse], + request: cloud_speech.ListPhraseSetsRequest, + response: cloud_speech.ListPhraseSetsResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v2.types.ListPhraseSetsRequest): + The initial request object. + response (google.cloud.speech_v2.types.ListPhraseSetsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech.ListPhraseSetsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterator[cloud_speech.ListPhraseSetsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method(self._request, metadata=self._metadata) + yield self._response + + def __iter__(self) -> Iterator[cloud_speech.PhraseSet]: + for page in self.pages: + yield from page.phrase_sets + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListPhraseSetsAsyncPager: + """A pager for iterating through ``list_phrase_sets`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v2.types.ListPhraseSetsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``phrase_sets`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListPhraseSets`` requests and continue to iterate + through the ``phrase_sets`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v2.types.ListPhraseSetsResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[..., Awaitable[cloud_speech.ListPhraseSetsResponse]], + request: cloud_speech.ListPhraseSetsRequest, + response: cloud_speech.ListPhraseSetsResponse, + *, + metadata: Sequence[Tuple[str, str]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.cloud.speech_v2.types.ListPhraseSetsRequest): + The initial request object. + response (google.cloud.speech_v2.types.ListPhraseSetsResponse): + The initial response object. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + self._method = method + self._request = cloud_speech.ListPhraseSetsRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterator[cloud_speech.ListPhraseSetsResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method(self._request, metadata=self._metadata) + yield self._response + + def __aiter__(self) -> AsyncIterator[cloud_speech.PhraseSet]: + async def async_generator(): + async for page in self.pages: + for response in page.phrase_sets: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/__init__.py b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/__init__.py new file mode 100644 index 000000000000..4f7834ee2dfa --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import SpeechTransport +from .grpc import SpeechGrpcTransport +from .grpc_asyncio import SpeechGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[SpeechTransport]] +_transport_registry["grpc"] = SpeechGrpcTransport +_transport_registry["grpc_asyncio"] = SpeechGrpcAsyncIOTransport + +__all__ = ( + "SpeechTransport", + "SpeechGrpcTransport", + "SpeechGrpcAsyncIOTransport", +) diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/base.py b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/base.py new file mode 100644 index 000000000000..b2823d5ff1a7 --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/base.py @@ -0,0 +1,523 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import pkg_resources + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-speech", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +class SpeechTransport(abc.ABC): + """Abstract transport class for Speech.""" + + AUTH_SCOPES = ("https://www.googleapis.com/auth/cloud-platform",) + + DEFAULT_HOST: str = "speech.googleapis.com" + + def __init__( + self, + *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + 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. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + 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. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs( + "'credentials_file' and 'credentials' are mutually exclusive" + ) + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, **scopes_kwargs, quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default( + **scopes_kwargs, quota_project_id=quota_project_id + ) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience( + api_audience if api_audience else host + ) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if ( + always_use_jwt_access + and isinstance(credentials, service_account.Credentials) + and hasattr(service_account.Credentials, "with_always_use_jwt_access") + ): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ":" not in host: + host += ":443" + self._host = host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_recognizer: gapic_v1.method.wrap_method( + self.create_recognizer, + default_timeout=None, + client_info=client_info, + ), + self.list_recognizers: gapic_v1.method.wrap_method( + self.list_recognizers, + default_timeout=None, + client_info=client_info, + ), + self.get_recognizer: gapic_v1.method.wrap_method( + self.get_recognizer, + default_timeout=None, + client_info=client_info, + ), + self.update_recognizer: gapic_v1.method.wrap_method( + self.update_recognizer, + default_timeout=None, + client_info=client_info, + ), + self.delete_recognizer: gapic_v1.method.wrap_method( + self.delete_recognizer, + default_timeout=None, + client_info=client_info, + ), + self.undelete_recognizer: gapic_v1.method.wrap_method( + self.undelete_recognizer, + default_timeout=None, + client_info=client_info, + ), + self.recognize: gapic_v1.method.wrap_method( + self.recognize, + default_timeout=None, + client_info=client_info, + ), + self.streaming_recognize: gapic_v1.method.wrap_method( + self.streaming_recognize, + default_timeout=None, + client_info=client_info, + ), + self.batch_recognize: gapic_v1.method.wrap_method( + self.batch_recognize, + default_timeout=None, + client_info=client_info, + ), + self.get_config: gapic_v1.method.wrap_method( + self.get_config, + default_timeout=None, + client_info=client_info, + ), + self.update_config: gapic_v1.method.wrap_method( + self.update_config, + default_timeout=None, + client_info=client_info, + ), + self.create_custom_class: gapic_v1.method.wrap_method( + self.create_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.list_custom_classes: gapic_v1.method.wrap_method( + self.list_custom_classes, + default_timeout=None, + client_info=client_info, + ), + self.get_custom_class: gapic_v1.method.wrap_method( + self.get_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.update_custom_class: gapic_v1.method.wrap_method( + self.update_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.delete_custom_class: gapic_v1.method.wrap_method( + self.delete_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.undelete_custom_class: gapic_v1.method.wrap_method( + self.undelete_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.create_phrase_set: gapic_v1.method.wrap_method( + self.create_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.list_phrase_sets: gapic_v1.method.wrap_method( + self.list_phrase_sets, + default_timeout=None, + client_info=client_info, + ), + self.get_phrase_set: gapic_v1.method.wrap_method( + self.get_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.update_phrase_set: gapic_v1.method.wrap_method( + self.update_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.delete_phrase_set: gapic_v1.method.wrap_method( + self.delete_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.undelete_phrase_set: gapic_v1.method.wrap_method( + self.undelete_phrase_set, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def operations_client(self): + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def create_recognizer( + self, + ) -> Callable[ + [cloud_speech.CreateRecognizerRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def list_recognizers( + self, + ) -> Callable[ + [cloud_speech.ListRecognizersRequest], + Union[ + cloud_speech.ListRecognizersResponse, + Awaitable[cloud_speech.ListRecognizersResponse], + ], + ]: + raise NotImplementedError() + + @property + def get_recognizer( + self, + ) -> Callable[ + [cloud_speech.GetRecognizerRequest], + Union[cloud_speech.Recognizer, Awaitable[cloud_speech.Recognizer]], + ]: + raise NotImplementedError() + + @property + def update_recognizer( + self, + ) -> Callable[ + [cloud_speech.UpdateRecognizerRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def delete_recognizer( + self, + ) -> Callable[ + [cloud_speech.DeleteRecognizerRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def undelete_recognizer( + self, + ) -> Callable[ + [cloud_speech.UndeleteRecognizerRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def recognize( + self, + ) -> Callable[ + [cloud_speech.RecognizeRequest], + Union[ + cloud_speech.RecognizeResponse, Awaitable[cloud_speech.RecognizeResponse] + ], + ]: + raise NotImplementedError() + + @property + def streaming_recognize( + self, + ) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + Union[ + cloud_speech.StreamingRecognizeResponse, + Awaitable[cloud_speech.StreamingRecognizeResponse], + ], + ]: + raise NotImplementedError() + + @property + def batch_recognize( + self, + ) -> Callable[ + [cloud_speech.BatchRecognizeRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def get_config( + self, + ) -> Callable[ + [cloud_speech.GetConfigRequest], + Union[cloud_speech.Config, Awaitable[cloud_speech.Config]], + ]: + raise NotImplementedError() + + @property + def update_config( + self, + ) -> Callable[ + [cloud_speech.UpdateConfigRequest], + Union[cloud_speech.Config, Awaitable[cloud_speech.Config]], + ]: + raise NotImplementedError() + + @property + def create_custom_class( + self, + ) -> Callable[ + [cloud_speech.CreateCustomClassRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def list_custom_classes( + self, + ) -> Callable[ + [cloud_speech.ListCustomClassesRequest], + Union[ + cloud_speech.ListCustomClassesResponse, + Awaitable[cloud_speech.ListCustomClassesResponse], + ], + ]: + raise NotImplementedError() + + @property + def get_custom_class( + self, + ) -> Callable[ + [cloud_speech.GetCustomClassRequest], + Union[cloud_speech.CustomClass, Awaitable[cloud_speech.CustomClass]], + ]: + raise NotImplementedError() + + @property + def update_custom_class( + self, + ) -> Callable[ + [cloud_speech.UpdateCustomClassRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def delete_custom_class( + self, + ) -> Callable[ + [cloud_speech.DeleteCustomClassRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def undelete_custom_class( + self, + ) -> Callable[ + [cloud_speech.UndeleteCustomClassRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def create_phrase_set( + self, + ) -> Callable[ + [cloud_speech.CreatePhraseSetRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def list_phrase_sets( + self, + ) -> Callable[ + [cloud_speech.ListPhraseSetsRequest], + Union[ + cloud_speech.ListPhraseSetsResponse, + Awaitable[cloud_speech.ListPhraseSetsResponse], + ], + ]: + raise NotImplementedError() + + @property + def get_phrase_set( + self, + ) -> Callable[ + [cloud_speech.GetPhraseSetRequest], + Union[cloud_speech.PhraseSet, Awaitable[cloud_speech.PhraseSet]], + ]: + raise NotImplementedError() + + @property + def update_phrase_set( + self, + ) -> Callable[ + [cloud_speech.UpdatePhraseSetRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def delete_phrase_set( + self, + ) -> Callable[ + [cloud_speech.DeletePhraseSetRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def undelete_phrase_set( + self, + ) -> Callable[ + [cloud_speech.UndeletePhraseSetRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], + Union[ + operations_pb2.ListOperationsResponse, + Awaitable[operations_pb2.ListOperationsResponse], + ], + ]: + raise NotImplementedError() + + @property + def get_operation( + self, + ) -> Callable[ + [operations_pb2.GetOperationRequest], + Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]], + ]: + raise NotImplementedError() + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None,]: + raise NotImplementedError() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None,]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ("SpeechTransport",) diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/grpc.py b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/grpc.py new file mode 100644 index 000000000000..dec4648e8054 --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/grpc.py @@ -0,0 +1,946 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import operations_v1 +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore +from .base import SpeechTransport, DEFAULT_CLIENT_INFO + + +class SpeechGrpcTransport(SpeechTransport): + """gRPC backend transport for Speech. + + Enables speech transcription and resource management. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _stubs: Dict[str, Callable] + + def __init__( + self, + *, + host: str = "speech.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + 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. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + 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. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel( + cls, + host: str = "speech.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service.""" + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsClient(self.grpc_channel) + + # Return the client from cache. + return self._operations_client + + @property + def create_recognizer( + self, + ) -> Callable[[cloud_speech.CreateRecognizerRequest], operations_pb2.Operation]: + r"""Return a callable for the create recognizer method over gRPC. + + Creates a [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.CreateRecognizerRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_recognizer" not in self._stubs: + self._stubs["create_recognizer"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/CreateRecognizer", + request_serializer=cloud_speech.CreateRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["create_recognizer"] + + @property + def list_recognizers( + self, + ) -> Callable[ + [cloud_speech.ListRecognizersRequest], cloud_speech.ListRecognizersResponse + ]: + r"""Return a callable for the list recognizers method over gRPC. + + Lists Recognizers. + + Returns: + Callable[[~.ListRecognizersRequest], + ~.ListRecognizersResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_recognizers" not in self._stubs: + self._stubs["list_recognizers"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/ListRecognizers", + request_serializer=cloud_speech.ListRecognizersRequest.serialize, + response_deserializer=cloud_speech.ListRecognizersResponse.deserialize, + ) + return self._stubs["list_recognizers"] + + @property + def get_recognizer( + self, + ) -> Callable[[cloud_speech.GetRecognizerRequest], cloud_speech.Recognizer]: + r"""Return a callable for the get recognizer method over gRPC. + + 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. + + Returns: + Callable[[~.GetRecognizerRequest], + ~.Recognizer]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_recognizer" not in self._stubs: + self._stubs["get_recognizer"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/GetRecognizer", + request_serializer=cloud_speech.GetRecognizerRequest.serialize, + response_deserializer=cloud_speech.Recognizer.deserialize, + ) + return self._stubs["get_recognizer"] + + @property + def update_recognizer( + self, + ) -> Callable[[cloud_speech.UpdateRecognizerRequest], operations_pb2.Operation]: + r"""Return a callable for the update recognizer method over gRPC. + + Updates the [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.UpdateRecognizerRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_recognizer" not in self._stubs: + self._stubs["update_recognizer"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UpdateRecognizer", + request_serializer=cloud_speech.UpdateRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["update_recognizer"] + + @property + def delete_recognizer( + self, + ) -> Callable[[cloud_speech.DeleteRecognizerRequest], operations_pb2.Operation]: + r"""Return a callable for the delete recognizer method over gRPC. + + Deletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.DeleteRecognizerRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_recognizer" not in self._stubs: + self._stubs["delete_recognizer"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/DeleteRecognizer", + request_serializer=cloud_speech.DeleteRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["delete_recognizer"] + + @property + def undelete_recognizer( + self, + ) -> Callable[[cloud_speech.UndeleteRecognizerRequest], operations_pb2.Operation]: + r"""Return a callable for the undelete recognizer method over gRPC. + + Undeletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.UndeleteRecognizerRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "undelete_recognizer" not in self._stubs: + self._stubs["undelete_recognizer"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UndeleteRecognizer", + request_serializer=cloud_speech.UndeleteRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["undelete_recognizer"] + + @property + def recognize( + self, + ) -> Callable[[cloud_speech.RecognizeRequest], cloud_speech.RecognizeResponse]: + r"""Return a callable for the recognize method over gRPC. + + Performs synchronous Speech recognition: receive + results after all audio has been sent and processed. + + Returns: + Callable[[~.RecognizeRequest], + ~.RecognizeResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "recognize" not in self._stubs: + self._stubs["recognize"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/Recognize", + request_serializer=cloud_speech.RecognizeRequest.serialize, + response_deserializer=cloud_speech.RecognizeResponse.deserialize, + ) + return self._stubs["recognize"] + + @property + def streaming_recognize( + self, + ) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + cloud_speech.StreamingRecognizeResponse, + ]: + r"""Return a callable for the streaming recognize method over gRPC. + + Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Returns: + Callable[[~.StreamingRecognizeRequest], + ~.StreamingRecognizeResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "streaming_recognize" not in self._stubs: + self._stubs["streaming_recognize"] = self.grpc_channel.stream_stream( + "/google.cloud.speech.v2.Speech/StreamingRecognize", + request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, + response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, + ) + return self._stubs["streaming_recognize"] + + @property + def batch_recognize( + self, + ) -> Callable[[cloud_speech.BatchRecognizeRequest], operations_pb2.Operation]: + r"""Return a callable for the batch recognize method over gRPC. + + 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. + + Returns: + Callable[[~.BatchRecognizeRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "batch_recognize" not in self._stubs: + self._stubs["batch_recognize"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/BatchRecognize", + request_serializer=cloud_speech.BatchRecognizeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["batch_recognize"] + + @property + def get_config( + self, + ) -> Callable[[cloud_speech.GetConfigRequest], cloud_speech.Config]: + r"""Return a callable for the get config method over gRPC. + + Returns the requested [Config][google.cloud.speech.v2.Config]. + + Returns: + Callable[[~.GetConfigRequest], + ~.Config]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_config" not in self._stubs: + self._stubs["get_config"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/GetConfig", + request_serializer=cloud_speech.GetConfigRequest.serialize, + response_deserializer=cloud_speech.Config.deserialize, + ) + return self._stubs["get_config"] + + @property + def update_config( + self, + ) -> Callable[[cloud_speech.UpdateConfigRequest], cloud_speech.Config]: + r"""Return a callable for the update config method over gRPC. + + Updates the [Config][google.cloud.speech.v2.Config]. + + Returns: + Callable[[~.UpdateConfigRequest], + ~.Config]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_config" not in self._stubs: + self._stubs["update_config"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UpdateConfig", + request_serializer=cloud_speech.UpdateConfigRequest.serialize, + response_deserializer=cloud_speech.Config.deserialize, + ) + return self._stubs["update_config"] + + @property + def create_custom_class( + self, + ) -> Callable[[cloud_speech.CreateCustomClassRequest], operations_pb2.Operation]: + r"""Return a callable for the create custom class method over gRPC. + + Creates a [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.CreateCustomClassRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_custom_class" not in self._stubs: + self._stubs["create_custom_class"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/CreateCustomClass", + request_serializer=cloud_speech.CreateCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["create_custom_class"] + + @property + def list_custom_classes( + self, + ) -> Callable[ + [cloud_speech.ListCustomClassesRequest], cloud_speech.ListCustomClassesResponse + ]: + r"""Return a callable for the list custom classes method over gRPC. + + Lists CustomClasses. + + Returns: + Callable[[~.ListCustomClassesRequest], + ~.ListCustomClassesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_custom_classes" not in self._stubs: + self._stubs["list_custom_classes"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/ListCustomClasses", + request_serializer=cloud_speech.ListCustomClassesRequest.serialize, + response_deserializer=cloud_speech.ListCustomClassesResponse.deserialize, + ) + return self._stubs["list_custom_classes"] + + @property + def get_custom_class( + self, + ) -> Callable[[cloud_speech.GetCustomClassRequest], cloud_speech.CustomClass]: + r"""Return a callable for the get custom class method over gRPC. + + Returns the requested + [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.GetCustomClassRequest], + ~.CustomClass]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_custom_class" not in self._stubs: + self._stubs["get_custom_class"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/GetCustomClass", + request_serializer=cloud_speech.GetCustomClassRequest.serialize, + response_deserializer=cloud_speech.CustomClass.deserialize, + ) + return self._stubs["get_custom_class"] + + @property + def update_custom_class( + self, + ) -> Callable[[cloud_speech.UpdateCustomClassRequest], operations_pb2.Operation]: + r"""Return a callable for the update custom class method over gRPC. + + Updates the [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.UpdateCustomClassRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_custom_class" not in self._stubs: + self._stubs["update_custom_class"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UpdateCustomClass", + request_serializer=cloud_speech.UpdateCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["update_custom_class"] + + @property + def delete_custom_class( + self, + ) -> Callable[[cloud_speech.DeleteCustomClassRequest], operations_pb2.Operation]: + r"""Return a callable for the delete custom class method over gRPC. + + Deletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.DeleteCustomClassRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_custom_class" not in self._stubs: + self._stubs["delete_custom_class"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/DeleteCustomClass", + request_serializer=cloud_speech.DeleteCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["delete_custom_class"] + + @property + def undelete_custom_class( + self, + ) -> Callable[[cloud_speech.UndeleteCustomClassRequest], operations_pb2.Operation]: + r"""Return a callable for the undelete custom class method over gRPC. + + Undeletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.UndeleteCustomClassRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "undelete_custom_class" not in self._stubs: + self._stubs["undelete_custom_class"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UndeleteCustomClass", + request_serializer=cloud_speech.UndeleteCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["undelete_custom_class"] + + @property + def create_phrase_set( + self, + ) -> Callable[[cloud_speech.CreatePhraseSetRequest], operations_pb2.Operation]: + r"""Return a callable for the create phrase set method over gRPC. + + Creates a [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.CreatePhraseSetRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_phrase_set" not in self._stubs: + self._stubs["create_phrase_set"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/CreatePhraseSet", + request_serializer=cloud_speech.CreatePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["create_phrase_set"] + + @property + def list_phrase_sets( + self, + ) -> Callable[ + [cloud_speech.ListPhraseSetsRequest], cloud_speech.ListPhraseSetsResponse + ]: + r"""Return a callable for the list phrase sets method over gRPC. + + Lists PhraseSets. + + Returns: + Callable[[~.ListPhraseSetsRequest], + ~.ListPhraseSetsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_phrase_sets" not in self._stubs: + self._stubs["list_phrase_sets"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/ListPhraseSets", + request_serializer=cloud_speech.ListPhraseSetsRequest.serialize, + response_deserializer=cloud_speech.ListPhraseSetsResponse.deserialize, + ) + return self._stubs["list_phrase_sets"] + + @property + def get_phrase_set( + self, + ) -> Callable[[cloud_speech.GetPhraseSetRequest], cloud_speech.PhraseSet]: + r"""Return a callable for the get phrase set method over gRPC. + + Returns the requested + [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.GetPhraseSetRequest], + ~.PhraseSet]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_phrase_set" not in self._stubs: + self._stubs["get_phrase_set"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/GetPhraseSet", + request_serializer=cloud_speech.GetPhraseSetRequest.serialize, + response_deserializer=cloud_speech.PhraseSet.deserialize, + ) + return self._stubs["get_phrase_set"] + + @property + def update_phrase_set( + self, + ) -> Callable[[cloud_speech.UpdatePhraseSetRequest], operations_pb2.Operation]: + r"""Return a callable for the update phrase set method over gRPC. + + Updates the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.UpdatePhraseSetRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_phrase_set" not in self._stubs: + self._stubs["update_phrase_set"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UpdatePhraseSet", + request_serializer=cloud_speech.UpdatePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["update_phrase_set"] + + @property + def delete_phrase_set( + self, + ) -> Callable[[cloud_speech.DeletePhraseSetRequest], operations_pb2.Operation]: + r"""Return a callable for the delete phrase set method over gRPC. + + Deletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.DeletePhraseSetRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_phrase_set" not in self._stubs: + self._stubs["delete_phrase_set"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/DeletePhraseSet", + request_serializer=cloud_speech.DeletePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["delete_phrase_set"] + + @property + def undelete_phrase_set( + self, + ) -> Callable[[cloud_speech.UndeletePhraseSetRequest], operations_pb2.Operation]: + r"""Return a callable for the undelete phrase set method over gRPC. + + Undeletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.UndeletePhraseSetRequest], + ~.Operation]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "undelete_phrase_set" not in self._stubs: + self._stubs["undelete_phrase_set"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UndeletePhraseSet", + request_serializer=cloud_speech.UndeletePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["undelete_phrase_set"] + + def close(self): + self.grpc_channel.close() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None]: + r"""Return a callable for the delete_operation method over gRPC.""" + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_operation" not in self._stubs: + self._stubs["delete_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/DeleteOperation", + request_serializer=operations_pb2.DeleteOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["delete_operation"] + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None]: + r"""Return a callable for the cancel_operation method over gRPC.""" + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "cancel_operation" not in self._stubs: + self._stubs["cancel_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/CancelOperation", + request_serializer=operations_pb2.CancelOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["cancel_operation"] + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC.""" + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse + ]: + r"""Return a callable for the list_operations method over gRPC.""" + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ("SpeechGrpcTransport",) diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/grpc_asyncio.py b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/grpc_asyncio.py new file mode 100644 index 000000000000..99b5c99ebbfc --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/services/speech/transports/grpc_asyncio.py @@ -0,0 +1,984 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 +from google.longrunning import operations_pb2 # type: ignore +from .base import SpeechTransport, DEFAULT_CLIENT_INFO +from .grpc import SpeechGrpcTransport + + +class SpeechGrpcAsyncIOTransport(SpeechTransport): + """gRPC AsyncIO backend transport for Speech. + + Enables speech transcription and resource management. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel( + cls, + host: str = "speech.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + def __init__( + self, + *, + host: str = "speech.googleapis.com", + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + 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. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + 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. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def operations_client(self) -> operations_v1.OperationsAsyncClient: + """Create the client designed to process long-running operations. + + This property caches on the instance; repeated calls return the same + client. + """ + # Quick check: Only create a new client if we do not already have one. + if self._operations_client is None: + self._operations_client = operations_v1.OperationsAsyncClient( + self.grpc_channel + ) + + # Return the client from cache. + return self._operations_client + + @property + def create_recognizer( + self, + ) -> Callable[ + [cloud_speech.CreateRecognizerRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the create recognizer method over gRPC. + + Creates a [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.CreateRecognizerRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_recognizer" not in self._stubs: + self._stubs["create_recognizer"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/CreateRecognizer", + request_serializer=cloud_speech.CreateRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["create_recognizer"] + + @property + def list_recognizers( + self, + ) -> Callable[ + [cloud_speech.ListRecognizersRequest], + Awaitable[cloud_speech.ListRecognizersResponse], + ]: + r"""Return a callable for the list recognizers method over gRPC. + + Lists Recognizers. + + Returns: + Callable[[~.ListRecognizersRequest], + Awaitable[~.ListRecognizersResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_recognizers" not in self._stubs: + self._stubs["list_recognizers"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/ListRecognizers", + request_serializer=cloud_speech.ListRecognizersRequest.serialize, + response_deserializer=cloud_speech.ListRecognizersResponse.deserialize, + ) + return self._stubs["list_recognizers"] + + @property + def get_recognizer( + self, + ) -> Callable[ + [cloud_speech.GetRecognizerRequest], Awaitable[cloud_speech.Recognizer] + ]: + r"""Return a callable for the get recognizer method over gRPC. + + 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. + + Returns: + Callable[[~.GetRecognizerRequest], + Awaitable[~.Recognizer]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_recognizer" not in self._stubs: + self._stubs["get_recognizer"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/GetRecognizer", + request_serializer=cloud_speech.GetRecognizerRequest.serialize, + response_deserializer=cloud_speech.Recognizer.deserialize, + ) + return self._stubs["get_recognizer"] + + @property + def update_recognizer( + self, + ) -> Callable[ + [cloud_speech.UpdateRecognizerRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the update recognizer method over gRPC. + + Updates the [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.UpdateRecognizerRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_recognizer" not in self._stubs: + self._stubs["update_recognizer"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UpdateRecognizer", + request_serializer=cloud_speech.UpdateRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["update_recognizer"] + + @property + def delete_recognizer( + self, + ) -> Callable[ + [cloud_speech.DeleteRecognizerRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the delete recognizer method over gRPC. + + Deletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.DeleteRecognizerRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_recognizer" not in self._stubs: + self._stubs["delete_recognizer"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/DeleteRecognizer", + request_serializer=cloud_speech.DeleteRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["delete_recognizer"] + + @property + def undelete_recognizer( + self, + ) -> Callable[ + [cloud_speech.UndeleteRecognizerRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the undelete recognizer method over gRPC. + + Undeletes the [Recognizer][google.cloud.speech.v2.Recognizer]. + + Returns: + Callable[[~.UndeleteRecognizerRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "undelete_recognizer" not in self._stubs: + self._stubs["undelete_recognizer"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UndeleteRecognizer", + request_serializer=cloud_speech.UndeleteRecognizerRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["undelete_recognizer"] + + @property + def recognize( + self, + ) -> Callable[ + [cloud_speech.RecognizeRequest], Awaitable[cloud_speech.RecognizeResponse] + ]: + r"""Return a callable for the recognize method over gRPC. + + Performs synchronous Speech recognition: receive + results after all audio has been sent and processed. + + Returns: + Callable[[~.RecognizeRequest], + Awaitable[~.RecognizeResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "recognize" not in self._stubs: + self._stubs["recognize"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/Recognize", + request_serializer=cloud_speech.RecognizeRequest.serialize, + response_deserializer=cloud_speech.RecognizeResponse.deserialize, + ) + return self._stubs["recognize"] + + @property + def streaming_recognize( + self, + ) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + Awaitable[cloud_speech.StreamingRecognizeResponse], + ]: + r"""Return a callable for the streaming recognize method over gRPC. + + Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Returns: + Callable[[~.StreamingRecognizeRequest], + Awaitable[~.StreamingRecognizeResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "streaming_recognize" not in self._stubs: + self._stubs["streaming_recognize"] = self.grpc_channel.stream_stream( + "/google.cloud.speech.v2.Speech/StreamingRecognize", + request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, + response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, + ) + return self._stubs["streaming_recognize"] + + @property + def batch_recognize( + self, + ) -> Callable[ + [cloud_speech.BatchRecognizeRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the batch recognize method over gRPC. + + 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. + + Returns: + Callable[[~.BatchRecognizeRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "batch_recognize" not in self._stubs: + self._stubs["batch_recognize"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/BatchRecognize", + request_serializer=cloud_speech.BatchRecognizeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["batch_recognize"] + + @property + def get_config( + self, + ) -> Callable[[cloud_speech.GetConfigRequest], Awaitable[cloud_speech.Config]]: + r"""Return a callable for the get config method over gRPC. + + Returns the requested [Config][google.cloud.speech.v2.Config]. + + Returns: + Callable[[~.GetConfigRequest], + Awaitable[~.Config]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_config" not in self._stubs: + self._stubs["get_config"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/GetConfig", + request_serializer=cloud_speech.GetConfigRequest.serialize, + response_deserializer=cloud_speech.Config.deserialize, + ) + return self._stubs["get_config"] + + @property + def update_config( + self, + ) -> Callable[[cloud_speech.UpdateConfigRequest], Awaitable[cloud_speech.Config]]: + r"""Return a callable for the update config method over gRPC. + + Updates the [Config][google.cloud.speech.v2.Config]. + + Returns: + Callable[[~.UpdateConfigRequest], + Awaitable[~.Config]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_config" not in self._stubs: + self._stubs["update_config"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UpdateConfig", + request_serializer=cloud_speech.UpdateConfigRequest.serialize, + response_deserializer=cloud_speech.Config.deserialize, + ) + return self._stubs["update_config"] + + @property + def create_custom_class( + self, + ) -> Callable[ + [cloud_speech.CreateCustomClassRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the create custom class method over gRPC. + + Creates a [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.CreateCustomClassRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_custom_class" not in self._stubs: + self._stubs["create_custom_class"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/CreateCustomClass", + request_serializer=cloud_speech.CreateCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["create_custom_class"] + + @property + def list_custom_classes( + self, + ) -> Callable[ + [cloud_speech.ListCustomClassesRequest], + Awaitable[cloud_speech.ListCustomClassesResponse], + ]: + r"""Return a callable for the list custom classes method over gRPC. + + Lists CustomClasses. + + Returns: + Callable[[~.ListCustomClassesRequest], + Awaitable[~.ListCustomClassesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_custom_classes" not in self._stubs: + self._stubs["list_custom_classes"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/ListCustomClasses", + request_serializer=cloud_speech.ListCustomClassesRequest.serialize, + response_deserializer=cloud_speech.ListCustomClassesResponse.deserialize, + ) + return self._stubs["list_custom_classes"] + + @property + def get_custom_class( + self, + ) -> Callable[ + [cloud_speech.GetCustomClassRequest], Awaitable[cloud_speech.CustomClass] + ]: + r"""Return a callable for the get custom class method over gRPC. + + Returns the requested + [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.GetCustomClassRequest], + Awaitable[~.CustomClass]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_custom_class" not in self._stubs: + self._stubs["get_custom_class"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/GetCustomClass", + request_serializer=cloud_speech.GetCustomClassRequest.serialize, + response_deserializer=cloud_speech.CustomClass.deserialize, + ) + return self._stubs["get_custom_class"] + + @property + def update_custom_class( + self, + ) -> Callable[ + [cloud_speech.UpdateCustomClassRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the update custom class method over gRPC. + + Updates the [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.UpdateCustomClassRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_custom_class" not in self._stubs: + self._stubs["update_custom_class"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UpdateCustomClass", + request_serializer=cloud_speech.UpdateCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["update_custom_class"] + + @property + def delete_custom_class( + self, + ) -> Callable[ + [cloud_speech.DeleteCustomClassRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the delete custom class method over gRPC. + + Deletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.DeleteCustomClassRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_custom_class" not in self._stubs: + self._stubs["delete_custom_class"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/DeleteCustomClass", + request_serializer=cloud_speech.DeleteCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["delete_custom_class"] + + @property + def undelete_custom_class( + self, + ) -> Callable[ + [cloud_speech.UndeleteCustomClassRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the undelete custom class method over gRPC. + + Undeletes the [CustomClass][google.cloud.speech.v2.CustomClass]. + + Returns: + Callable[[~.UndeleteCustomClassRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "undelete_custom_class" not in self._stubs: + self._stubs["undelete_custom_class"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UndeleteCustomClass", + request_serializer=cloud_speech.UndeleteCustomClassRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["undelete_custom_class"] + + @property + def create_phrase_set( + self, + ) -> Callable[ + [cloud_speech.CreatePhraseSetRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the create phrase set method over gRPC. + + Creates a [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.CreatePhraseSetRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "create_phrase_set" not in self._stubs: + self._stubs["create_phrase_set"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/CreatePhraseSet", + request_serializer=cloud_speech.CreatePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["create_phrase_set"] + + @property + def list_phrase_sets( + self, + ) -> Callable[ + [cloud_speech.ListPhraseSetsRequest], + Awaitable[cloud_speech.ListPhraseSetsResponse], + ]: + r"""Return a callable for the list phrase sets method over gRPC. + + Lists PhraseSets. + + Returns: + Callable[[~.ListPhraseSetsRequest], + Awaitable[~.ListPhraseSetsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_phrase_sets" not in self._stubs: + self._stubs["list_phrase_sets"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/ListPhraseSets", + request_serializer=cloud_speech.ListPhraseSetsRequest.serialize, + response_deserializer=cloud_speech.ListPhraseSetsResponse.deserialize, + ) + return self._stubs["list_phrase_sets"] + + @property + def get_phrase_set( + self, + ) -> Callable[ + [cloud_speech.GetPhraseSetRequest], Awaitable[cloud_speech.PhraseSet] + ]: + r"""Return a callable for the get phrase set method over gRPC. + + Returns the requested + [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.GetPhraseSetRequest], + Awaitable[~.PhraseSet]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_phrase_set" not in self._stubs: + self._stubs["get_phrase_set"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/GetPhraseSet", + request_serializer=cloud_speech.GetPhraseSetRequest.serialize, + response_deserializer=cloud_speech.PhraseSet.deserialize, + ) + return self._stubs["get_phrase_set"] + + @property + def update_phrase_set( + self, + ) -> Callable[ + [cloud_speech.UpdatePhraseSetRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the update phrase set method over gRPC. + + Updates the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.UpdatePhraseSetRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "update_phrase_set" not in self._stubs: + self._stubs["update_phrase_set"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UpdatePhraseSet", + request_serializer=cloud_speech.UpdatePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["update_phrase_set"] + + @property + def delete_phrase_set( + self, + ) -> Callable[ + [cloud_speech.DeletePhraseSetRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the delete phrase set method over gRPC. + + Deletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.DeletePhraseSetRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_phrase_set" not in self._stubs: + self._stubs["delete_phrase_set"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/DeletePhraseSet", + request_serializer=cloud_speech.DeletePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["delete_phrase_set"] + + @property + def undelete_phrase_set( + self, + ) -> Callable[ + [cloud_speech.UndeletePhraseSetRequest], Awaitable[operations_pb2.Operation] + ]: + r"""Return a callable for the undelete phrase set method over gRPC. + + Undeletes the [PhraseSet][google.cloud.speech.v2.PhraseSet]. + + Returns: + Callable[[~.UndeletePhraseSetRequest], + Awaitable[~.Operation]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "undelete_phrase_set" not in self._stubs: + self._stubs["undelete_phrase_set"] = self.grpc_channel.unary_unary( + "/google.cloud.speech.v2.Speech/UndeletePhraseSet", + request_serializer=cloud_speech.UndeletePhraseSetRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["undelete_phrase_set"] + + def close(self): + return self.grpc_channel.close() + + @property + def delete_operation( + self, + ) -> Callable[[operations_pb2.DeleteOperationRequest], None]: + r"""Return a callable for the delete_operation method over gRPC.""" + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "delete_operation" not in self._stubs: + self._stubs["delete_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/DeleteOperation", + request_serializer=operations_pb2.DeleteOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["delete_operation"] + + @property + def cancel_operation( + self, + ) -> Callable[[operations_pb2.CancelOperationRequest], None]: + r"""Return a callable for the cancel_operation method over gRPC.""" + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "cancel_operation" not in self._stubs: + self._stubs["cancel_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/CancelOperation", + request_serializer=operations_pb2.CancelOperationRequest.SerializeToString, + response_deserializer=None, + ) + return self._stubs["cancel_operation"] + + @property + def get_operation( + self, + ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]: + r"""Return a callable for the get_operation method over gRPC.""" + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "get_operation" not in self._stubs: + self._stubs["get_operation"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/GetOperation", + request_serializer=operations_pb2.GetOperationRequest.SerializeToString, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs["get_operation"] + + @property + def list_operations( + self, + ) -> Callable[ + [operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse + ]: + r"""Return a callable for the list_operations method over gRPC.""" + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_operations" not in self._stubs: + self._stubs["list_operations"] = self.grpc_channel.unary_unary( + "/google.longrunning.Operations/ListOperations", + request_serializer=operations_pb2.ListOperationsRequest.SerializeToString, + response_deserializer=operations_pb2.ListOperationsResponse.FromString, + ) + return self._stubs["list_operations"] + + +__all__ = ("SpeechGrpcAsyncIOTransport",) diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/types/__init__.py b/packages/google-cloud-python-speech/google/cloud/speech_v2/types/__init__.py new file mode 100644 index 000000000000..252e4f479830 --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/types/__init__.py @@ -0,0 +1,122 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .cloud_speech import ( + AutoDetectDecodingConfig, + BatchRecognizeFileMetadata, + BatchRecognizeFileResult, + BatchRecognizeMetadata, + BatchRecognizeRequest, + BatchRecognizeResponse, + BatchRecognizeTranscriptionMetadata, + Config, + CreateCustomClassRequest, + CreatePhraseSetRequest, + CreateRecognizerRequest, + CustomClass, + DeleteCustomClassRequest, + DeletePhraseSetRequest, + DeleteRecognizerRequest, + ExplicitDecodingConfig, + GetConfigRequest, + GetCustomClassRequest, + GetPhraseSetRequest, + GetRecognizerRequest, + ListCustomClassesRequest, + ListCustomClassesResponse, + ListPhraseSetsRequest, + ListPhraseSetsResponse, + ListRecognizersRequest, + ListRecognizersResponse, + OperationMetadata, + PhraseSet, + RecognitionConfig, + RecognitionFeatures, + RecognitionResponseMetadata, + Recognizer, + RecognizeRequest, + RecognizeResponse, + SpeakerDiarizationConfig, + SpeechAdaptation, + SpeechRecognitionAlternative, + SpeechRecognitionResult, + StreamingRecognitionConfig, + StreamingRecognitionFeatures, + StreamingRecognitionResult, + StreamingRecognizeRequest, + StreamingRecognizeResponse, + UndeleteCustomClassRequest, + UndeletePhraseSetRequest, + UndeleteRecognizerRequest, + UpdateConfigRequest, + UpdateCustomClassRequest, + UpdatePhraseSetRequest, + UpdateRecognizerRequest, + WordInfo, +) + +__all__ = ( + "AutoDetectDecodingConfig", + "BatchRecognizeFileMetadata", + "BatchRecognizeFileResult", + "BatchRecognizeMetadata", + "BatchRecognizeRequest", + "BatchRecognizeResponse", + "BatchRecognizeTranscriptionMetadata", + "Config", + "CreateCustomClassRequest", + "CreatePhraseSetRequest", + "CreateRecognizerRequest", + "CustomClass", + "DeleteCustomClassRequest", + "DeletePhraseSetRequest", + "DeleteRecognizerRequest", + "ExplicitDecodingConfig", + "GetConfigRequest", + "GetCustomClassRequest", + "GetPhraseSetRequest", + "GetRecognizerRequest", + "ListCustomClassesRequest", + "ListCustomClassesResponse", + "ListPhraseSetsRequest", + "ListPhraseSetsResponse", + "ListRecognizersRequest", + "ListRecognizersResponse", + "OperationMetadata", + "PhraseSet", + "RecognitionConfig", + "RecognitionFeatures", + "RecognitionResponseMetadata", + "Recognizer", + "RecognizeRequest", + "RecognizeResponse", + "SpeakerDiarizationConfig", + "SpeechAdaptation", + "SpeechRecognitionAlternative", + "SpeechRecognitionResult", + "StreamingRecognitionConfig", + "StreamingRecognitionFeatures", + "StreamingRecognitionResult", + "StreamingRecognizeRequest", + "StreamingRecognizeResponse", + "UndeleteCustomClassRequest", + "UndeletePhraseSetRequest", + "UndeleteRecognizerRequest", + "UpdateConfigRequest", + "UpdateCustomClassRequest", + "UpdatePhraseSetRequest", + "UpdateRecognizerRequest", + "WordInfo", +) diff --git a/packages/google-cloud-python-speech/google/cloud/speech_v2/types/cloud_speech.py b/packages/google-cloud-python-speech/google/cloud/speech_v2/types/cloud_speech.py new file mode 100644 index 000000000000..3f6ac7969191 --- /dev/null +++ b/packages/google-cloud-python-speech/google/cloud/speech_v2/types/cloud_speech.py @@ -0,0 +1,2820 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore + + +__protobuf__ = proto.module( + package="google.cloud.speech.v2", + manifest={ + "CreateRecognizerRequest", + "OperationMetadata", + "ListRecognizersRequest", + "ListRecognizersResponse", + "GetRecognizerRequest", + "UpdateRecognizerRequest", + "DeleteRecognizerRequest", + "UndeleteRecognizerRequest", + "Recognizer", + "AutoDetectDecodingConfig", + "ExplicitDecodingConfig", + "SpeakerDiarizationConfig", + "RecognitionFeatures", + "SpeechAdaptation", + "RecognitionConfig", + "RecognizeRequest", + "RecognitionResponseMetadata", + "SpeechRecognitionAlternative", + "WordInfo", + "SpeechRecognitionResult", + "RecognizeResponse", + "StreamingRecognitionFeatures", + "StreamingRecognitionConfig", + "StreamingRecognizeRequest", + "BatchRecognizeRequest", + "BatchRecognizeResponse", + "BatchRecognizeFileResult", + "BatchRecognizeTranscriptionMetadata", + "BatchRecognizeMetadata", + "BatchRecognizeFileMetadata", + "StreamingRecognitionResult", + "StreamingRecognizeResponse", + "Config", + "GetConfigRequest", + "UpdateConfigRequest", + "CustomClass", + "PhraseSet", + "CreateCustomClassRequest", + "ListCustomClassesRequest", + "ListCustomClassesResponse", + "GetCustomClassRequest", + "UpdateCustomClassRequest", + "DeleteCustomClassRequest", + "UndeleteCustomClassRequest", + "CreatePhraseSetRequest", + "ListPhraseSetsRequest", + "ListPhraseSetsResponse", + "GetPhraseSetRequest", + "UpdatePhraseSetRequest", + "DeletePhraseSetRequest", + "UndeletePhraseSetRequest", + }, +) + + +class CreateRecognizerRequest(proto.Message): + r"""Request message for the + [CreateRecognizer][google.cloud.speech.v2.Speech.CreateRecognizer] + method. + + Attributes: + recognizer (google.cloud.speech_v2.types.Recognizer): + Required. The Recognizer to create. + validate_only (bool): + If set, validate the request and preview the + Recognizer, but do not actually create it. + 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]-/. + parent (str): + Required. The project and location where this Recognizer + will be created. The expected format is + ``projects/{project}/locations/{location}``. + """ + + recognizer = proto.Field( + proto.MESSAGE, + number=1, + message="Recognizer", + ) + validate_only = proto.Field( + proto.BOOL, + number=2, + ) + recognizer_id = proto.Field( + proto.STRING, + number=3, + ) + parent = proto.Field( + proto.STRING, + number=4, + ) + + +class OperationMetadata(proto.Message): + r"""Represents the metadata of a long-running operation. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + create_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation was created. + update_time (google.protobuf.timestamp_pb2.Timestamp): + The time the operation was last updated. + resource (str): + The resource path for the target of the + operation. + method (str): + The method that triggered the operation. + kms_key_name (str): + The `KMS key + name `__ + with which the content of the Operation is encrypted. The + expected format is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``. + kms_key_version_name (str): + The `KMS key version + name `__ + with which content of the Operation is encrypted. The + expected format is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}``. + batch_recognize_request (google.cloud.speech_v2.types.BatchRecognizeRequest): + The BatchRecognizeRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + create_recognizer_request (google.cloud.speech_v2.types.CreateRecognizerRequest): + The CreateRecognizerRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + update_recognizer_request (google.cloud.speech_v2.types.UpdateRecognizerRequest): + The UpdateRecognizerRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + delete_recognizer_request (google.cloud.speech_v2.types.DeleteRecognizerRequest): + The DeleteRecognizerRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + undelete_recognizer_request (google.cloud.speech_v2.types.UndeleteRecognizerRequest): + The UndeleteRecognizerRequest that spawned + the Operation. + + This field is a member of `oneof`_ ``request``. + create_custom_class_request (google.cloud.speech_v2.types.CreateCustomClassRequest): + The CreateCustomClassRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + update_custom_class_request (google.cloud.speech_v2.types.UpdateCustomClassRequest): + The UpdateCustomClassRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + delete_custom_class_request (google.cloud.speech_v2.types.DeleteCustomClassRequest): + The DeleteCustomClassRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + undelete_custom_class_request (google.cloud.speech_v2.types.UndeleteCustomClassRequest): + The UndeleteCustomClassRequest that spawned + the Operation. + + This field is a member of `oneof`_ ``request``. + create_phrase_set_request (google.cloud.speech_v2.types.CreatePhraseSetRequest): + The CreatePhraseSetRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + update_phrase_set_request (google.cloud.speech_v2.types.UpdatePhraseSetRequest): + The UpdatePhraseSetRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + delete_phrase_set_request (google.cloud.speech_v2.types.DeletePhraseSetRequest): + The DeletePhraseSetRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + undelete_phrase_set_request (google.cloud.speech_v2.types.UndeletePhraseSetRequest): + The UndeletePhraseSetRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + update_config_request (google.cloud.speech_v2.types.UpdateConfigRequest): + The UpdateConfigRequest that spawned the + Operation. + + This field is a member of `oneof`_ ``request``. + progress_percent (int): + The percent progress of the Operation. Values + can range from 0-100. If the value is 100, then + the operation is finished. + batch_recognize_metadata (google.cloud.speech_v2.types.BatchRecognizeMetadata): + Metadata specific to the BatchRecognize + method. + + This field is a member of `oneof`_ ``metadata``. + """ + + create_time = proto.Field( + proto.MESSAGE, + number=1, + message=timestamp_pb2.Timestamp, + ) + update_time = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + resource = proto.Field( + proto.STRING, + number=3, + ) + method = proto.Field( + proto.STRING, + number=4, + ) + kms_key_name = proto.Field( + proto.STRING, + number=6, + ) + kms_key_version_name = proto.Field( + proto.STRING, + number=7, + ) + batch_recognize_request = proto.Field( + proto.MESSAGE, + number=8, + oneof="request", + message="BatchRecognizeRequest", + ) + create_recognizer_request = proto.Field( + proto.MESSAGE, + number=9, + oneof="request", + message="CreateRecognizerRequest", + ) + update_recognizer_request = proto.Field( + proto.MESSAGE, + number=10, + oneof="request", + message="UpdateRecognizerRequest", + ) + delete_recognizer_request = proto.Field( + proto.MESSAGE, + number=11, + oneof="request", + message="DeleteRecognizerRequest", + ) + undelete_recognizer_request = proto.Field( + proto.MESSAGE, + number=12, + oneof="request", + message="UndeleteRecognizerRequest", + ) + create_custom_class_request = proto.Field( + proto.MESSAGE, + number=13, + oneof="request", + message="CreateCustomClassRequest", + ) + update_custom_class_request = proto.Field( + proto.MESSAGE, + number=14, + oneof="request", + message="UpdateCustomClassRequest", + ) + delete_custom_class_request = proto.Field( + proto.MESSAGE, + number=15, + oneof="request", + message="DeleteCustomClassRequest", + ) + undelete_custom_class_request = proto.Field( + proto.MESSAGE, + number=16, + oneof="request", + message="UndeleteCustomClassRequest", + ) + create_phrase_set_request = proto.Field( + proto.MESSAGE, + number=17, + oneof="request", + message="CreatePhraseSetRequest", + ) + update_phrase_set_request = proto.Field( + proto.MESSAGE, + number=18, + oneof="request", + message="UpdatePhraseSetRequest", + ) + delete_phrase_set_request = proto.Field( + proto.MESSAGE, + number=19, + oneof="request", + message="DeletePhraseSetRequest", + ) + undelete_phrase_set_request = proto.Field( + proto.MESSAGE, + number=20, + oneof="request", + message="UndeletePhraseSetRequest", + ) + update_config_request = proto.Field( + proto.MESSAGE, + number=21, + oneof="request", + message="UpdateConfigRequest", + ) + progress_percent = proto.Field( + proto.INT32, + number=22, + ) + batch_recognize_metadata = proto.Field( + proto.MESSAGE, + number=23, + oneof="metadata", + message="BatchRecognizeMetadata", + ) + + +class ListRecognizersRequest(proto.Message): + r"""Request message for the + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + method. + + Attributes: + parent (str): + Required. The project and location of Recognizers to list. + The expected format is + ``projects/{project}/locations/{location}``. + page_size (int): + The maximum number of Recognizers to return. + The service may return fewer than this value. If + unspecified, at most 20 Recognizers will be + returned. The maximum value is 20; values above + 20 will be coerced to 20. + page_token (str): + A page token, received from a previous + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + call. Provide this to retrieve the subsequent page. + + When paginating, all other parameters provided to + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + must match the call that provided the page token. + show_deleted (bool): + Whether, or not, to show resources that have + been deleted. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + show_deleted = proto.Field( + proto.BOOL, + number=4, + ) + + +class ListRecognizersResponse(proto.Message): + r"""Response message for the + [ListRecognizers][google.cloud.speech.v2.Speech.ListRecognizers] + method. + + Attributes: + recognizers (Sequence[google.cloud.speech_v2.types.Recognizer]): + The list of requested Recognizers. + next_page_token (str): + A token, which can be sent as + [page_token][google.cloud.speech.v2.ListRecognizersRequest.page_token] + to retrieve the next page. If this field is omitted, there + are no subsequent pages. This token expires after 72 hours. + """ + + @property + def raw_page(self): + return self + + recognizers = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="Recognizer", + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class GetRecognizerRequest(proto.Message): + r"""Request message for the + [GetRecognizer][google.cloud.speech.v2.Speech.GetRecognizer] method. + + Attributes: + name (str): + Required. The name of the Recognizer to retrieve. The + expected format is + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateRecognizerRequest(proto.Message): + r"""Request message for the + [UpdateRecognizer][google.cloud.speech.v2.Speech.UpdateRecognizer] + method. + + Attributes: + 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}``. + 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. + validate_only (bool): + If set, validate the request and preview the + updated Recognizer, but do not actually update + it. + """ + + recognizer = proto.Field( + proto.MESSAGE, + number=1, + message="Recognizer", + ) + update_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + validate_only = proto.Field( + proto.BOOL, + number=4, + ) + + +class DeleteRecognizerRequest(proto.Message): + r"""Request message for the + [DeleteRecognizer][google.cloud.speech.v2.Speech.DeleteRecognizer] + method. + + Attributes: + name (str): + Required. The name of the Recognizer to delete. Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}`` + validate_only (bool): + If set, validate the request and preview the + deleted Recognizer, but do not actually delete + it. + allow_missing (bool): + If set to true, and the Recognizer is not + found, the request will succeed and be a no-op + (no Operation is recorded in this case). + etag (str): + This checksum is computed by the server based + on the value of other fields. This may be sent + on update, undelete, and delete requests to + ensure the client has an up-to-date value before + proceeding. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + validate_only = proto.Field( + proto.BOOL, + number=2, + ) + allow_missing = proto.Field( + proto.BOOL, + number=4, + ) + etag = proto.Field( + proto.STRING, + number=3, + ) + + +class UndeleteRecognizerRequest(proto.Message): + r"""Request message for the + [UndeleteRecognizer][google.cloud.speech.v2.Speech.UndeleteRecognizer] + method. + + Attributes: + name (str): + Required. The name of the Recognizer to undelete. Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}`` + validate_only (bool): + If set, validate the request and preview the + undeleted Recognizer, but do not actually + undelete it. + etag (str): + This checksum is computed by the server based + on the value of other fields. This may be sent + on update, undelete, and delete requests to + ensure the client has an up-to-date value before + proceeding. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + validate_only = proto.Field( + proto.BOOL, + number=3, + ) + etag = proto.Field( + proto.STRING, + number=4, + ) + + +class Recognizer(proto.Message): + r"""A Recognizer message. Stores recognition configuration and + metadata. + + Attributes: + name (str): + Output only. The resource name of the Recognizer. Format: + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + uid (str): + Output only. System-assigned unique + identifier for the Recognizer. + display_name (str): + User-settable, human-readable name for the + Recognizer. Must be 63 characters or less. + model (str): + Required. Which model to use for recognition requests. + Select the model best suited to your domain to get best + results. + + Supported models: + + - ``latest_long`` + + Best for long form content like media or conversation. + + - ``latest_short`` + + Best for short form content like commands or single shot + directed speech. When using this model, the service will + stop transcribing audio after the first utterance is + detected and completed. + + When using this model, + [SEPARATE_RECOGNITION_PER_CHANNEL][google.cloud.speech.v2.RecognitionFeatures.MultiChannelMode.SEPARATE_RECOGNITION_PER_CHANNEL] + is not supported; multi-channel audio is accepted, but only + the first channel will be processed and transcribed. + language_codes (Sequence[str]): + Required. The language of the supplied audio as a + `BCP-47 `__ + language tag. + + Supported languages: + + - ``en-US`` + + - ``en-GB`` + + - ``fr-FR`` + + If additional languages are provided, recognition result + will contain recognition in the most likely language + detected. The recognition result will include the language + tag of the language detected in the audio. When you create + or update a Recognizer, these values are stored in + normalized BCP-47 form. For example, "en-us" is stored as + "en-US". + default_recognition_config (google.cloud.speech_v2.types.RecognitionConfig): + Default configuration to use for requests with this + Recognizer. This can be overwritten by inline configuration + in the + [RecognizeRequest.config][google.cloud.speech.v2.RecognizeRequest.config] + field. + annotations (Mapping[str, str]): + Allows users to store small amounts of + arbitrary data. Both the key and the value must + be 63 characters or less each. At most 100 + annotations. + state (google.cloud.speech_v2.types.Recognizer.State): + Output only. The Recognizer lifecycle state. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Creation time. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The most recent time this + Recognizer was modified. + delete_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which this + Recognizer was requested for deletion. + expire_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which this + Recognizer will be purged. + etag (str): + Output only. This checksum is computed by the + server based on the value of other fields. This + may be sent on update, undelete, and delete + requests to ensure the client has an up-to-date + value before proceeding. + reconciling (bool): + Output only. Whether or not this Recognizer + is in the process of being updated. + kms_key_name (str): + Output only. The `KMS key + name `__ + with which the Recognizer is encrypted. The expected format + is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``. + kms_key_version_name (str): + Output only. The `KMS key version + name `__ + with which the Recognizer is encrypted. The expected format + is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}``. + """ + + class State(proto.Enum): + r"""Set of states that define the lifecycle of a Recognizer.""" + STATE_UNSPECIFIED = 0 + ACTIVE = 2 + DELETED = 4 + + name = proto.Field( + proto.STRING, + number=1, + ) + uid = proto.Field( + proto.STRING, + number=2, + ) + display_name = proto.Field( + proto.STRING, + number=3, + ) + model = proto.Field( + proto.STRING, + number=4, + ) + language_codes = proto.RepeatedField( + proto.STRING, + number=17, + ) + default_recognition_config = proto.Field( + proto.MESSAGE, + number=6, + message="RecognitionConfig", + ) + annotations = proto.MapField( + proto.STRING, + proto.STRING, + number=7, + ) + state = proto.Field( + proto.ENUM, + number=8, + enum=State, + ) + create_time = proto.Field( + proto.MESSAGE, + number=9, + message=timestamp_pb2.Timestamp, + ) + update_time = proto.Field( + proto.MESSAGE, + number=10, + message=timestamp_pb2.Timestamp, + ) + delete_time = proto.Field( + proto.MESSAGE, + number=11, + message=timestamp_pb2.Timestamp, + ) + expire_time = proto.Field( + proto.MESSAGE, + number=14, + message=timestamp_pb2.Timestamp, + ) + etag = proto.Field( + proto.STRING, + number=12, + ) + reconciling = proto.Field( + proto.BOOL, + number=13, + ) + kms_key_name = proto.Field( + proto.STRING, + number=15, + ) + kms_key_version_name = proto.Field( + proto.STRING, + number=16, + ) + + +class AutoDetectDecodingConfig(proto.Message): + r"""Automatically detected decoding parameters. Supported for the + following encodings: + + - WAV_LINEAR16: 16-bit signed little-endian PCM samples in a WAV + container. + - WAV_MULAW: 8-bit companded mulaw samples in a WAV container. + - WAV_ALAW: 8-bit companded alaw samples in a WAV container. + - RFC4867_5_AMR: AMR frames with an rfc4867.5 header. + - RFC4867_5_AMRWB: AMR-WB frames with an rfc4867.5 header. + - FLAC: FLAC frames in the "native FLAC" container format. + - MP3: MPEG audio frames with optional (ignored) ID3 metadata. + - OGG_OPUS: Opus audio frames in an Ogg container. + - WEBM_OPUS: Opus audio frames in a WebM container. + + """ + + +class ExplicitDecodingConfig(proto.Message): + r"""Explicitly specified decoding parameters. + + Attributes: + encoding (google.cloud.speech_v2.types.ExplicitDecodingConfig.AudioEncoding): + Required. Encoding of the audio data sent for + recognition. + sample_rate_hertz (int): + Sample rate in Hertz of the audio data sent for recognition. + Valid values are: 8000-48000. 16000 is optimal. For best + results, set the sampling rate of the audio source to 16000 + Hz. If that's not possible, use the native sample rate of + the audio source (instead of re-sampling). Supported for the + following encodings: + + - LINEAR16: Headerless 16-bit signed little-endian PCM + samples. + - MULAW: Headerless 8-bit companded mulaw samples. + - ALAW: Headerless 8-bit companded alaw samples. + audio_channel_count (int): + Number of channels present in the audio data sent for + recognition. Supported for the following encodings: + + - LINEAR16: Headerless 16-bit signed little-endian PCM + samples. + - MULAW: Headerless 8-bit companded mulaw samples. + - ALAW: Headerless 8-bit companded alaw samples. + """ + + class AudioEncoding(proto.Enum): + r"""Supported audio data encodings.""" + AUDIO_ENCODING_UNSPECIFIED = 0 + LINEAR16 = 1 + MULAW = 2 + ALAW = 3 + + encoding = proto.Field( + proto.ENUM, + number=1, + enum=AudioEncoding, + ) + sample_rate_hertz = proto.Field( + proto.INT32, + number=2, + ) + audio_channel_count = proto.Field( + proto.INT32, + number=3, + ) + + +class SpeakerDiarizationConfig(proto.Message): + r"""Configuration to enable speaker diarization. + + Attributes: + min_speaker_count (int): + Required. Minimum number of speakers in the conversation. + This range gives you more flexibility by allowing the system + to automatically determine the correct number of speakers. + If not set, the default value is 2. + + To fix the number of speakers detected in the audio, set + ``min_speaker_count`` = ``max_speaker_count``. + max_speaker_count (int): + Required. Maximum number of speakers in the conversation. + Valid values are: 1-6. Must be >= ``min_speaker_count``. + This range gives you more flexibility by allowing the system + to automatically determine the correct number of speakers. + """ + + min_speaker_count = proto.Field( + proto.INT32, + number=2, + ) + max_speaker_count = proto.Field( + proto.INT32, + number=3, + ) + + +class RecognitionFeatures(proto.Message): + r"""Available recognition features. + + Attributes: + profanity_filter (bool): + If set to ``true``, the server will attempt to filter out + profanities, replacing all but the initial character in each + filtered word with asterisks, for instance, "f***". If set + to ``false`` or omitted, profanities won't be filtered out. + enable_word_time_offsets (bool): + If ``true``, the top result includes a list of words and the + start and end time offsets (timestamps) for those words. If + ``false``, no word-level time offset information is + returned. The default is ``false``. + enable_word_confidence (bool): + If ``true``, the top result includes a list of words and the + confidence for those words. If ``false``, no word-level + confidence information is returned. The default is + ``false``. + enable_automatic_punctuation (bool): + If ``true``, adds punctuation to recognition result + hypotheses. This feature is only available in select + languages. The default ``false`` value does not add + punctuation to result hypotheses. + enable_spoken_punctuation (bool): + The spoken punctuation behavior for the call. If ``true``, + replaces spoken punctuation with the corresponding symbols + in the request. For example, "how are you question mark" + becomes "how are you?". See + https://cloud.google.com/speech-to-text/docs/spoken-punctuation + for support. If ``false``, spoken punctuation is not + replaced. + enable_spoken_emojis (bool): + The spoken emoji behavior for the call. If ``true``, adds + spoken emoji formatting for the request. This will replace + spoken emojis with the corresponding Unicode symbols in the + final transcript. If ``false``, spoken emojis are not + replaced. + multi_channel_mode (google.cloud.speech_v2.types.RecognitionFeatures.MultiChannelMode): + Mode for recognizing multi-channel audio. + diarization_config (google.cloud.speech_v2.types.SpeakerDiarizationConfig): + Configuration to enable speaker diarization + and set additional parameters to make + diarization better suited for your application. + When this is enabled, we send all the words from + the beginning of the audio for the top + alternative in every consecutive STREAMING + responses. This is done in order to improve our + speaker tags as our models learn to identify the + speakers in the conversation over time. For + non-streaming requests, the diarization results + will be provided only in the top alternative of + the FINAL SpeechRecognitionResult. + max_alternatives (int): + Maximum number of recognition hypotheses to be returned. The + server may return fewer than ``max_alternatives``. Valid + values are ``0``-``30``. A value of ``0`` or ``1`` will + return a maximum of one. If omitted, will return a maximum + of one. + """ + + class MultiChannelMode(proto.Enum): + r"""Options for how to recognize multi-channel audio.""" + MULTI_CHANNEL_MODE_UNSPECIFIED = 0 + SEPARATE_RECOGNITION_PER_CHANNEL = 1 + + profanity_filter = proto.Field( + proto.BOOL, + number=1, + ) + enable_word_time_offsets = proto.Field( + proto.BOOL, + number=2, + ) + enable_word_confidence = proto.Field( + proto.BOOL, + number=3, + ) + enable_automatic_punctuation = proto.Field( + proto.BOOL, + number=4, + ) + enable_spoken_punctuation = proto.Field( + proto.BOOL, + number=14, + ) + enable_spoken_emojis = proto.Field( + proto.BOOL, + number=15, + ) + multi_channel_mode = proto.Field( + proto.ENUM, + number=17, + enum=MultiChannelMode, + ) + diarization_config = proto.Field( + proto.MESSAGE, + number=9, + message="SpeakerDiarizationConfig", + ) + max_alternatives = proto.Field( + proto.INT32, + number=16, + ) + + +class SpeechAdaptation(proto.Message): + r"""Provides "hints" to the speech recognizer to favor specific + words and phrases in the results. Phrase sets can be specified + as an inline resource, or a reference to an existing phrase set + resource. + + Attributes: + phrase_sets (Sequence[google.cloud.speech_v2.types.SpeechAdaptation.AdaptationPhraseSet]): + A list of inline or referenced phrase sets. + custom_classes (Sequence[google.cloud.speech_v2.types.CustomClass]): + A list of inline custom classes. Existing + custom class resources can be referenced + directly in a phrase set. + """ + + class AdaptationPhraseSet(proto.Message): + r"""A biasing phrase set, which can be either a string + referencing the name of an existing phrase set resource, or an + inline definition of a phrase set. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + phrase_set (str): + The name of an existing phrase set resource. + The user must have read access to the resource + and it must not be deleted. + + This field is a member of `oneof`_ ``value``. + inline_phrase_set (google.cloud.speech_v2.types.PhraseSet): + An inline defined phrase set. + + This field is a member of `oneof`_ ``value``. + """ + + phrase_set = proto.Field( + proto.STRING, + number=1, + oneof="value", + ) + inline_phrase_set = proto.Field( + proto.MESSAGE, + number=2, + oneof="value", + message="PhraseSet", + ) + + phrase_sets = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=AdaptationPhraseSet, + ) + custom_classes = proto.RepeatedField( + proto.MESSAGE, + number=2, + message="CustomClass", + ) + + +class RecognitionConfig(proto.Message): + r"""Provides information to the Recognizer that specifies how to + process the recognition request. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + auto_decoding_config (google.cloud.speech_v2.types.AutoDetectDecodingConfig): + Automatically detect decoding parameters. + Preferred for supported formats. + + This field is a member of `oneof`_ ``decoding_config``. + explicit_decoding_config (google.cloud.speech_v2.types.ExplicitDecodingConfig): + Explicitly specified decoding parameters. + Required if using headerless PCM audio + (linear16, mulaw, alaw). + + This field is a member of `oneof`_ ``decoding_config``. + features (google.cloud.speech_v2.types.RecognitionFeatures): + Speech recognition features to enable. + adaptation (google.cloud.speech_v2.types.SpeechAdaptation): + Speech adaptation context that weights + recognizer predictions for specific words and + phrases. + """ + + auto_decoding_config = proto.Field( + proto.MESSAGE, + number=7, + oneof="decoding_config", + message="AutoDetectDecodingConfig", + ) + explicit_decoding_config = proto.Field( + proto.MESSAGE, + number=8, + oneof="decoding_config", + message="ExplicitDecodingConfig", + ) + features = proto.Field( + proto.MESSAGE, + number=2, + message="RecognitionFeatures", + ) + adaptation = proto.Field( + proto.MESSAGE, + number=6, + message="SpeechAdaptation", + ) + + +class RecognizeRequest(proto.Message): + r"""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 `__. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + recognizer (str): + Required. The name of the Recognizer to use during + recognition. The expected format is + ``projects/{project}/locations/{location}/recognizers/{recognizer}``. + 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. + 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. + 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 field is a member of `oneof`_ ``audio_source``. + 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 field is a member of `oneof`_ ``audio_source``. + """ + + recognizer = proto.Field( + proto.STRING, + number=3, + ) + config = proto.Field( + proto.MESSAGE, + number=1, + message="RecognitionConfig", + ) + config_mask = proto.Field( + proto.MESSAGE, + number=8, + message=field_mask_pb2.FieldMask, + ) + content = proto.Field( + proto.BYTES, + number=5, + oneof="audio_source", + ) + uri = proto.Field( + proto.STRING, + number=6, + oneof="audio_source", + ) + + +class RecognitionResponseMetadata(proto.Message): + r"""Metadata about the recognition request and response. + + Attributes: + total_billed_duration (google.protobuf.duration_pb2.Duration): + When available, billed audio seconds for the + corresponding request. + """ + + total_billed_duration = proto.Field( + proto.MESSAGE, + number=6, + message=duration_pb2.Duration, + ) + + +class SpeechRecognitionAlternative(proto.Message): + r"""Alternative hypotheses (a.k.a. n-best list). + + Attributes: + transcript (str): + Transcript text representing the words that + the user spoke. + confidence (float): + The confidence estimate between 0.0 and 1.0. A higher number + indicates an estimated greater likelihood that the + recognized words are correct. This field is set only for the + top alternative of a non-streaming result or, of a streaming + result where + [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final] + is set to ``true``. This field is not guaranteed to be + accurate and users should not rely on it to be always + provided. The default of 0.0 is a sentinel value indicating + ``confidence`` was not set. + words (Sequence[google.cloud.speech_v2.types.WordInfo]): + A list of word-specific information for each recognized + word. When + [enable_speaker_diarization][google.cloud.speech.v2.SpeakerDiarizationConfig.enable_speaker_diarization] + is true, you will see all the words from the beginning of + the audio. + """ + + transcript = proto.Field( + proto.STRING, + number=1, + ) + confidence = proto.Field( + proto.FLOAT, + number=2, + ) + words = proto.RepeatedField( + proto.MESSAGE, + number=3, + message="WordInfo", + ) + + +class WordInfo(proto.Message): + r"""Word-specific information for recognized words. + + Attributes: + start_offset (google.protobuf.duration_pb2.Duration): + Time offset relative to the beginning of the audio, and + corresponding to the start of the spoken word. This field is + only set if + [enable_word_time_offsets][google.cloud.speech.v2.RecognitionFeatures.enable_word_time_offsets] + is ``true`` and only in the top hypothesis. This is an + experimental feature and the accuracy of the time offset can + vary. + end_offset (google.protobuf.duration_pb2.Duration): + Time offset relative to the beginning of the audio, and + corresponding to the end of the spoken word. This field is + only set if + [enable_word_time_offsets][google.cloud.speech.v2.RecognitionFeatures.enable_word_time_offsets] + is ``true`` and only in the top hypothesis. This is an + experimental feature and the accuracy of the time offset can + vary. + word (str): + The word corresponding to this set of + information. + confidence (float): + The confidence estimate between 0.0 and 1.0. A higher number + indicates an estimated greater likelihood that the + recognized words are correct. This field is set only for the + top alternative of a non-streaming result or, of a streaming + result where + [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final] + is set to ``true``. This field is not guaranteed to be + accurate and users should not rely on it to be always + provided. The default of 0.0 is a sentinel value indicating + ``confidence`` was not set. + speaker_label (str): + A distinct label is assigned for every speaker within the + audio. This field specifies which one of those speakers was + detected to have spoken this word. ``speaker_label`` is set + if + [enable_speaker_diarization][google.cloud.speech.v2.SpeakerDiarizationConfig.enable_speaker_diarization] + is ``true`` and only in the top alternative. + """ + + start_offset = proto.Field( + proto.MESSAGE, + number=1, + message=duration_pb2.Duration, + ) + end_offset = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + word = proto.Field( + proto.STRING, + number=3, + ) + confidence = proto.Field( + proto.FLOAT, + number=4, + ) + speaker_label = proto.Field( + proto.STRING, + number=6, + ) + + +class SpeechRecognitionResult(proto.Message): + r"""A speech recognition result corresponding to a portion of the + audio. + + Attributes: + alternatives (Sequence[google.cloud.speech_v2.types.SpeechRecognitionAlternative]): + May contain one or more recognition + hypotheses. These alternatives are ordered in + terms of accuracy, with the top (first) + alternative being the most probable, as ranked + by the recognizer. + channel_tag (int): + For multi-channel audio, this is the channel number + corresponding to the recognized result for the audio from + that channel. For ``audio_channel_count`` = ``N``, its + output values can range from ``1`` to ``N``. + result_end_offset (google.protobuf.duration_pb2.Duration): + Time offset of the end of this result + relative to the beginning of the audio. + language_code (str): + Output only. The + `BCP-47 `__ + language tag of the language in this result. This language + code was detected to have the most likelihood of being + spoken in the audio. + """ + + alternatives = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="SpeechRecognitionAlternative", + ) + channel_tag = proto.Field( + proto.INT32, + number=2, + ) + result_end_offset = proto.Field( + proto.MESSAGE, + number=4, + message=duration_pb2.Duration, + ) + language_code = proto.Field( + proto.STRING, + number=5, + ) + + +class RecognizeResponse(proto.Message): + r"""Response message for the + [Recognize][google.cloud.speech.v2.Speech.Recognize] method. + + Attributes: + results (Sequence[google.cloud.speech_v2.types.SpeechRecognitionResult]): + Sequential list of transcription results + corresponding to sequential portions of audio. + metadata (google.cloud.speech_v2.types.RecognitionResponseMetadata): + Metadata about the recognition. + """ + + results = proto.RepeatedField( + proto.MESSAGE, + number=3, + message="SpeechRecognitionResult", + ) + metadata = proto.Field( + proto.MESSAGE, + number=2, + message="RecognitionResponseMetadata", + ) + + +class StreamingRecognitionFeatures(proto.Message): + r"""Available recognition features specific to streaming + recognition requests. + + Attributes: + enable_voice_activity_events (bool): + If ``true``, responses with voice activity speech events + will be returned as they are detected. + interim_results (bool): + Whether or not to stream interim results to + the client. If set to true, interim results will + be streamed to the client. Otherwise, only the + final response will be streamed back. + voice_activity_timeout (google.cloud.speech_v2.types.StreamingRecognitionFeatures.VoiceActivityTimeout): + If set, the server will automatically close the stream after + the specified duration has elapsed after the last + VOICE_ACTIVITY speech event has been sent. The field + ``voice_activity_events`` must also be set to true. + """ + + class VoiceActivityTimeout(proto.Message): + r"""Events that a timeout can be set on for voice activity. + + Attributes: + speech_start_timeout (google.protobuf.duration_pb2.Duration): + Duration to timeout the stream if no speech + begins. If this is set and no speech is detected + in this duration at the start of the stream, the + server will close the stream. + speech_end_timeout (google.protobuf.duration_pb2.Duration): + Duration to timeout the stream after speech + ends. If this is set and no speech is detected + in this duration after speech was detected, the + server will close the stream. + """ + + speech_start_timeout = proto.Field( + proto.MESSAGE, + number=1, + message=duration_pb2.Duration, + ) + speech_end_timeout = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + + enable_voice_activity_events = proto.Field( + proto.BOOL, + number=1, + ) + interim_results = proto.Field( + proto.BOOL, + number=2, + ) + voice_activity_timeout = proto.Field( + proto.MESSAGE, + number=3, + message=VoiceActivityTimeout, + ) + + +class StreamingRecognitionConfig(proto.Message): + r"""Provides configuration information for the StreamingRecognize + request. + + Attributes: + config (google.cloud.speech_v2.types.RecognitionConfig): + Required. Features and audio metadata to use for the + Automatic Speech Recognition. This field in combination with + the + [config_mask][google.cloud.speech.v2.StreamingRecognitionConfig.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. + config_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields in + [config][google.cloud.speech.v2.StreamingRecognitionConfig.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.StreamingRecognitionConfig.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.StreamingRecognitionConfig.config] + completely overrides and replaces the config in the + recognizer for this recognition request. + streaming_features (google.cloud.speech_v2.types.StreamingRecognitionFeatures): + Speech recognition features to enable + specific to streaming audio recognition + requests. + """ + + config = proto.Field( + proto.MESSAGE, + number=1, + message="RecognitionConfig", + ) + config_mask = proto.Field( + proto.MESSAGE, + number=3, + message=field_mask_pb2.FieldMask, + ) + streaming_features = proto.Field( + proto.MESSAGE, + number=2, + message="StreamingRecognitionFeatures", + ) + + +class StreamingRecognizeRequest(proto.Message): + r"""Request message for the + [StreamingRecognize][google.cloud.speech.v2.Speech.StreamingRecognize] + method. Multiple + [StreamingRecognizeRequest][google.cloud.speech.v2.StreamingRecognizeRequest] + messages are sent. The first message must contain a + [recognizer][google.cloud.speech.v2.StreamingRecognizeRequest.recognizer] + and optionally a + [streaming_config][google.cloud.speech.v2.StreamingRecognizeRequest.streaming_config] + message and must not contain + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio]. All + subsequent messages must contain + [audio][google.cloud.speech.v2.StreamingRecognizeRequest.audio] and + must not contain a + [streaming_config][google.cloud.speech.v2.StreamingRecognizeRequest.streaming_config] + message. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + recognizer (str): + Required. Streaming recognition should start with an initial + request having a ``recognizer``. Subsequent requests carry + the audio data to be recognized. + + The initial request with configuration can be omitted if the + Recognizer being used has a + [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config]. + streaming_config (google.cloud.speech_v2.types.StreamingRecognitionConfig): + StreamingRecognitionConfig to be used in this + recognition attempt. If provided, it will + override the default RecognitionConfig stored in + the Recognizer. + + This field is a member of `oneof`_ ``streaming_request``. + audio (bytes): + Inline audio bytes to be Recognized. + + This field is a member of `oneof`_ ``streaming_request``. + """ + + recognizer = proto.Field( + proto.STRING, + number=3, + ) + streaming_config = proto.Field( + proto.MESSAGE, + number=6, + oneof="streaming_request", + message="StreamingRecognitionConfig", + ) + audio = proto.Field( + proto.BYTES, + number=5, + oneof="streaming_request", + ) + + +class BatchRecognizeRequest(proto.Message): + r"""Request message for the + [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] + method. + + Attributes: + recognizer (str): + Required. Resource name of the recognizer to + be used for ASR. + 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. + 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. + files (Sequence[google.cloud.speech_v2.types.BatchRecognizeFileMetadata]): + Audio files with file metadata for ASR. + """ + + recognizer = proto.Field( + proto.STRING, + number=1, + ) + config = proto.Field( + proto.MESSAGE, + number=4, + message="RecognitionConfig", + ) + config_mask = proto.Field( + proto.MESSAGE, + number=5, + message=field_mask_pb2.FieldMask, + ) + files = proto.RepeatedField( + proto.MESSAGE, + number=3, + message="BatchRecognizeFileMetadata", + ) + + +class BatchRecognizeResponse(proto.Message): + r"""Response message for + [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize] that + is packaged into a longrunning + [Operation][google.longrunning.Operation]. + + Attributes: + results (Mapping[str, google.cloud.speech_v2.types.BatchRecognizeFileResult]): + Map from filename to the final result for + that file. + """ + + results = proto.MapField( + proto.STRING, + proto.MESSAGE, + number=1, + message="BatchRecognizeFileResult", + ) + + +class BatchRecognizeFileResult(proto.Message): + r"""Final results for a single file. + + Attributes: + uri (str): + The GCS URI to which recognition results were + written. + error (google.rpc.status_pb2.Status): + Error if one was encountered. + """ + + uri = proto.Field( + proto.STRING, + number=1, + ) + error = proto.Field( + proto.MESSAGE, + number=2, + message=status_pb2.Status, + ) + + +class BatchRecognizeTranscriptionMetadata(proto.Message): + r"""Metadata about transcription for a single file (for example, + progress percent). + + Attributes: + progress_percent (int): + How much of the file has been transcribed so + far. + error (google.rpc.status_pb2.Status): + Error if one was encountered. + uri (str): + The GCS URI to which recognition results will + be written. + """ + + progress_percent = proto.Field( + proto.INT32, + number=1, + ) + error = proto.Field( + proto.MESSAGE, + number=2, + message=status_pb2.Status, + ) + uri = proto.Field( + proto.STRING, + number=3, + ) + + +class BatchRecognizeMetadata(proto.Message): + r"""Operation metadata for + [BatchRecognize][google.cloud.speech.v2.Speech.BatchRecognize]. + + Attributes: + transcription_metadata (Mapping[str, google.cloud.speech_v2.types.BatchRecognizeTranscriptionMetadata]): + Map from provided filename to the + transcription metadata for that file. + """ + + transcription_metadata = proto.MapField( + proto.STRING, + proto.MESSAGE, + number=1, + message="BatchRecognizeTranscriptionMetadata", + ) + + +class BatchRecognizeFileMetadata(proto.Message): + r"""Metadata about a single file in a batch for BatchRecognize. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + uri (str): + Cloud Storage URI for the audio file. + + This field is a member of `oneof`_ ``audio_source``. + 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.BatchRecognizeFileMetadata.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 as well as the + [config][google.cloud.speech.v2.BatchRecognizeRequest.config] + at the request level. + config_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields in + [config][google.cloud.speech.v2.BatchRecognizeFileMetadata.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.BatchRecognizeFileMetadata.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.BatchRecognizeFileMetadata.config] + completely overrides and replaces the config in the + recognizer for this recognition request. + """ + + uri = proto.Field( + proto.STRING, + number=1, + oneof="audio_source", + ) + config = proto.Field( + proto.MESSAGE, + number=4, + message="RecognitionConfig", + ) + config_mask = proto.Field( + proto.MESSAGE, + number=5, + message=field_mask_pb2.FieldMask, + ) + + +class StreamingRecognitionResult(proto.Message): + r"""A streaming speech recognition result corresponding to a + portion of the audio that is currently being processed. + + Attributes: + alternatives (Sequence[google.cloud.speech_v2.types.SpeechRecognitionAlternative]): + May contain one or more recognition + hypotheses. These alternatives are ordered in + terms of accuracy, with the top (first) + alternative being the most probable, as ranked + by the recognizer. + is_final (bool): + If ``false``, this + [StreamingRecognitionResult][google.cloud.speech.v2.StreamingRecognitionResult] + represents an interim result that may change. If ``true``, + this is the final time the speech service will return this + particular + [StreamingRecognitionResult][google.cloud.speech.v2.StreamingRecognitionResult], + the recognizer will not return any further hypotheses for + this portion of the transcript and corresponding audio. + stability (float): + An estimate of the likelihood that the recognizer will not + change its guess about this interim result. Values range + from 0.0 (completely unstable) to 1.0 (completely stable). + This field is only provided for interim results + ([is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=``false``). + The default of 0.0 is a sentinel value indicating + ``stability`` was not set. + result_end_offset (google.protobuf.duration_pb2.Duration): + Time offset of the end of this result + relative to the beginning of the audio. + channel_tag (int): + For multi-channel audio, this is the channel number + corresponding to the recognized result for the audio from + that channel. For ``audio_channel_count`` = ``N``, its + output values can range from ``1`` to ``N``. + language_code (str): + Output only. The + `BCP-47 `__ + language tag of the language in this result. This language + code was detected to have the most likelihood of being + spoken in the audio. + """ + + alternatives = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="SpeechRecognitionAlternative", + ) + is_final = proto.Field( + proto.BOOL, + number=2, + ) + stability = proto.Field( + proto.FLOAT, + number=3, + ) + result_end_offset = proto.Field( + proto.MESSAGE, + number=4, + message=duration_pb2.Duration, + ) + channel_tag = proto.Field( + proto.INT32, + number=5, + ) + language_code = proto.Field( + proto.STRING, + number=6, + ) + + +class StreamingRecognizeResponse(proto.Message): + r"""``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 ``StreamingRecognizeResponse``\ s that + might be returned while processing audio: + + 1. results { alternatives { transcript: "tube" } stability: 0.01 } + + 2. results { alternatives { transcript: "to be a" } stability: 0.01 + } + + 3. results { alternatives { transcript: "to be" } stability: 0.9 } + results { alternatives { transcript: " or not to be" } stability: + 0.01 } + + 4. results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } alternatives { transcript: "to bee or not to + bee" } is_final: true } + + 5. results { alternatives { transcript: " that's" } stability: 0.01 + } + + 6. results { alternatives { transcript: " that is" } stability: 0.9 + } results { alternatives { transcript: " the question" } + stability: 0.01 } + + 7. 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``. + + Attributes: + results (Sequence[google.cloud.speech_v2.types.StreamingRecognitionResult]): + This repeated list contains zero or more results that + correspond to consecutive portions of the audio currently + being processed. It contains zero or one + [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=``true`` + result (the newly settled portion), followed by zero or more + [is_final][google.cloud.speech.v2.StreamingRecognitionResult.is_final]=``false`` + results (the interim results). + speech_event_type (google.cloud.speech_v2.types.StreamingRecognizeResponse.SpeechEventType): + Indicates the type of speech event. + speech_event_offset (google.protobuf.duration_pb2.Duration): + Time offset between the beginning of the + audio and event emission. + metadata (google.cloud.speech_v2.types.RecognitionResponseMetadata): + Metadata about the recognition. + """ + + class SpeechEventType(proto.Enum): + r"""Indicates the type of speech event.""" + SPEECH_EVENT_TYPE_UNSPECIFIED = 0 + END_OF_SINGLE_UTTERANCE = 1 + SPEECH_ACTIVITY_BEGIN = 2 + SPEECH_ACTIVITY_END = 3 + + results = proto.RepeatedField( + proto.MESSAGE, + number=6, + message="StreamingRecognitionResult", + ) + speech_event_type = proto.Field( + proto.ENUM, + number=3, + enum=SpeechEventType, + ) + speech_event_offset = proto.Field( + proto.MESSAGE, + number=7, + message=duration_pb2.Duration, + ) + metadata = proto.Field( + proto.MESSAGE, + number=5, + message="RecognitionResponseMetadata", + ) + + +class Config(proto.Message): + r"""Message representing the config for the Speech-to-Text API. This + includes an optional `KMS + key `__ + with which incoming data will be encrypted. + + Attributes: + name (str): + Output only. The name of the config resource. There is + exactly one config resource per project per location. The + expected format is + ``projects/{project}/locations/{location}/config``. + kms_key_name (str): + Optional. An optional `KMS key + name `__ + that if present, will be used to encrypt Speech-to-Text + resources at-rest. Updating this key will not encrypt + existing resources using this key; only new resources will + be encrypted using this key. The expected format is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The most recent time this + resource was modified. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + kms_key_name = proto.Field( + proto.STRING, + number=2, + ) + update_time = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + + +class GetConfigRequest(proto.Message): + r"""Request message for the + [GetConfig][google.cloud.speech.v2.Speech.GetConfig] method. + + Attributes: + 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``. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateConfigRequest(proto.Message): + r"""Request message for the + [UpdateConfig][google.cloud.speech.v2.Speech.UpdateConfig] method. + + Attributes: + 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``. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. + """ + + config = proto.Field( + proto.MESSAGE, + number=1, + message="Config", + ) + update_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class CustomClass(proto.Message): + r"""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. + + Attributes: + name (str): + Output only. The resource name of the CustomClass. Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}``. + uid (str): + Output only. System-assigned unique + identifier for the CustomClass. + display_name (str): + User-settable, human-readable name for the + CustomClass. Must be 63 characters or less. + items (Sequence[google.cloud.speech_v2.types.CustomClass.ClassItem]): + A collection of class items. + state (google.cloud.speech_v2.types.CustomClass.State): + Output only. The CustomClass lifecycle state. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Creation time. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The most recent time this + resource was modified. + delete_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which this resource + was requested for deletion. + expire_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which this resource + will be purged. + annotations (Mapping[str, str]): + Allows users to store small amounts of + arbitrary data. Both the key and the value must + be 63 characters or less each. At most 100 + annotations. + etag (str): + Output only. This checksum is computed by the + server based on the value of other fields. This + may be sent on update, undelete, and delete + requests to ensure the client has an up-to-date + value before proceeding. + reconciling (bool): + Output only. Whether or not this CustomClass + is in the process of being updated. + kms_key_name (str): + Output only. The `KMS key + name `__ + with which the CustomClass is encrypted. The expected format + is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``. + kms_key_version_name (str): + Output only. The `KMS key version + name `__ + with which the CustomClass is encrypted. The expected format + is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}``. + """ + + class State(proto.Enum): + r"""Set of states that define the lifecycle of a CustomClass.""" + STATE_UNSPECIFIED = 0 + ACTIVE = 2 + DELETED = 4 + + class ClassItem(proto.Message): + r"""An item of the class. + + Attributes: + value (str): + The class item's value. + """ + + value = proto.Field( + proto.STRING, + number=1, + ) + + name = proto.Field( + proto.STRING, + number=1, + ) + uid = proto.Field( + proto.STRING, + number=2, + ) + display_name = proto.Field( + proto.STRING, + number=4, + ) + items = proto.RepeatedField( + proto.MESSAGE, + number=5, + message=ClassItem, + ) + state = proto.Field( + proto.ENUM, + number=15, + enum=State, + ) + create_time = proto.Field( + proto.MESSAGE, + number=6, + message=timestamp_pb2.Timestamp, + ) + update_time = proto.Field( + proto.MESSAGE, + number=7, + message=timestamp_pb2.Timestamp, + ) + delete_time = proto.Field( + proto.MESSAGE, + number=8, + message=timestamp_pb2.Timestamp, + ) + expire_time = proto.Field( + proto.MESSAGE, + number=9, + message=timestamp_pb2.Timestamp, + ) + annotations = proto.MapField( + proto.STRING, + proto.STRING, + number=10, + ) + etag = proto.Field( + proto.STRING, + number=11, + ) + reconciling = proto.Field( + proto.BOOL, + number=12, + ) + kms_key_name = proto.Field( + proto.STRING, + number=13, + ) + kms_key_version_name = proto.Field( + proto.STRING, + number=14, + ) + + +class PhraseSet(proto.Message): + r"""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. + + Attributes: + name (str): + Output only. The resource name of the PhraseSet. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}``. + uid (str): + Output only. System-assigned unique + identifier for the PhraseSet. + phrases (Sequence[google.cloud.speech_v2.types.PhraseSet.Phrase]): + A list of word and phrases. + boost (float): + Hint Boost. Positive value will increase the probability + that a specific phrase will be recognized over other similar + sounding phrases. The higher the boost, the higher the + chance of false positive recognition as well. Valid + ``boost`` values are between 0 (exclusive) and 20. We + recommend using a binary search approach to finding the + optimal value for your use case. + display_name (str): + User-settable, human-readable name for the + PhraseSet. Must be 63 characters or less. + state (google.cloud.speech_v2.types.PhraseSet.State): + Output only. The PhraseSet lifecycle state. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. Creation time. + update_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The most recent time this + resource was modified. + delete_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which this resource + was requested for deletion. + expire_time (google.protobuf.timestamp_pb2.Timestamp): + Output only. The time at which this resource + will be purged. + annotations (Mapping[str, str]): + Allows users to store small amounts of + arbitrary data. Both the key and the value must + be 63 characters or less each. At most 100 + annotations. + etag (str): + Output only. This checksum is computed by the + server based on the value of other fields. This + may be sent on update, undelete, and delete + requests to ensure the client has an up-to-date + value before proceeding. + reconciling (bool): + Output only. Whether or not this PhraseSet is + in the process of being updated. + kms_key_name (str): + Output only. The `KMS key + name `__ + with which the PhraseSet is encrypted. The expected format + is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}``. + kms_key_version_name (str): + Output only. The `KMS key version + name `__ + with which the PhraseSet is encrypted. The expected format + is + ``projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}``. + """ + + class State(proto.Enum): + r"""Set of states that define the lifecycle of a PhraseSet.""" + STATE_UNSPECIFIED = 0 + ACTIVE = 2 + DELETED = 4 + + class Phrase(proto.Message): + r"""A Phrase contains words and phrase "hints" so that the speech + recognition is more likely to recognize them. This can be used + to improve the accuracy for specific words and phrases, for + example, if specific commands are typically spoken by the user. + This can also be used to add additional words to the vocabulary + of the recognizer. + + List items can also include CustomClass references containing + groups of words that represent common concepts that occur in + natural language. + + Attributes: + value (str): + The phrase itself. + boost (float): + Hint Boost. Overrides the boost set at the phrase set level. + Positive value will increase the probability that a specific + phrase will be recognized over other similar sounding + phrases. The higher the boost, the higher the chance of + false positive recognition as well. Negative boost values + would correspond to anti-biasing. Anti-biasing is not + enabled, so negative boost will simply be ignored. Though + ``boost`` can accept a wide range of positive values, most + use cases are best served with values between 0 and 20. We + recommend using a binary search approach to finding the + optimal value for your use case. Speech recognition will + skip PhraseSets with a boost value of 0. + """ + + value = proto.Field( + proto.STRING, + number=1, + ) + boost = proto.Field( + proto.FLOAT, + number=2, + ) + + name = proto.Field( + proto.STRING, + number=1, + ) + uid = proto.Field( + proto.STRING, + number=2, + ) + phrases = proto.RepeatedField( + proto.MESSAGE, + number=3, + message=Phrase, + ) + boost = proto.Field( + proto.FLOAT, + number=4, + ) + display_name = proto.Field( + proto.STRING, + number=5, + ) + state = proto.Field( + proto.ENUM, + number=15, + enum=State, + ) + create_time = proto.Field( + proto.MESSAGE, + number=6, + message=timestamp_pb2.Timestamp, + ) + update_time = proto.Field( + proto.MESSAGE, + number=7, + message=timestamp_pb2.Timestamp, + ) + delete_time = proto.Field( + proto.MESSAGE, + number=8, + message=timestamp_pb2.Timestamp, + ) + expire_time = proto.Field( + proto.MESSAGE, + number=9, + message=timestamp_pb2.Timestamp, + ) + annotations = proto.MapField( + proto.STRING, + proto.STRING, + number=10, + ) + etag = proto.Field( + proto.STRING, + number=11, + ) + reconciling = proto.Field( + proto.BOOL, + number=12, + ) + kms_key_name = proto.Field( + proto.STRING, + number=13, + ) + kms_key_version_name = proto.Field( + proto.STRING, + number=14, + ) + + +class CreateCustomClassRequest(proto.Message): + r"""Request message for the + [CreateCustomClass][google.cloud.speech.v2.Speech.CreateCustomClass] + method. + + Attributes: + custom_class (google.cloud.speech_v2.types.CustomClass): + Required. The CustomClass to create. + validate_only (bool): + If set, validate the request and preview the + CustomClass, but do not actually create it. + 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]-/. + parent (str): + Required. The project and location where this CustomClass + will be created. The expected format is + ``projects/{project}/locations/{location}``. + """ + + custom_class = proto.Field( + proto.MESSAGE, + number=1, + message="CustomClass", + ) + validate_only = proto.Field( + proto.BOOL, + number=2, + ) + custom_class_id = proto.Field( + proto.STRING, + number=3, + ) + parent = proto.Field( + proto.STRING, + number=4, + ) + + +class ListCustomClassesRequest(proto.Message): + r"""Request message for the + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + method. + + Attributes: + parent (str): + Required. The project and location of CustomClass resources + to list. The expected format is + ``projects/{project}/locations/{location}``. + page_size (int): + Number of results per requests. A valid page_size ranges + from 0 to 20 inclusive. If the page_size is zero or + unspecified, a page size of 5 will be chosen. If the page + size exceeds 20, it will be coerced down to 20. Note that a + call might return fewer results than the requested page + size. + page_token (str): + A page token, received from a previous + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + call. Provide this to retrieve the subsequent page. + + When paginating, all other parameters provided to + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + must match the call that provided the page token. + show_deleted (bool): + Whether, or not, to show resources that have + been deleted. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + show_deleted = proto.Field( + proto.BOOL, + number=4, + ) + + +class ListCustomClassesResponse(proto.Message): + r"""Response message for the + [ListCustomClasses][google.cloud.speech.v2.Speech.ListCustomClasses] + method. + + Attributes: + custom_classes (Sequence[google.cloud.speech_v2.types.CustomClass]): + The list of requested CustomClasses. + next_page_token (str): + A token, which can be sent as + [page_token][google.cloud.speech.v2.ListCustomClassesRequest.page_token] + to retrieve the next page. If this field is omitted, there + are no subsequent pages. This token expires after 72 hours. + """ + + @property + def raw_page(self): + return self + + custom_classes = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="CustomClass", + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class GetCustomClassRequest(proto.Message): + r"""Request message for the + [GetCustomClass][google.cloud.speech.v2.Speech.GetCustomClass] + method. + + Attributes: + name (str): + Required. The name of the CustomClass to retrieve. The + expected format is + ``projects/{project}/locations/{location}/customClasses/{custom_class}``. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdateCustomClassRequest(proto.Message): + r"""Request message for the + [UpdateCustomClass][google.cloud.speech.v2.Speech.UpdateCustomClass] + method. + + Attributes: + 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}``. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. If empty, + all fields are considered for update. + validate_only (bool): + If set, validate the request and preview the + updated CustomClass, but do not actually update + it. + """ + + custom_class = proto.Field( + proto.MESSAGE, + number=1, + message="CustomClass", + ) + update_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + validate_only = proto.Field( + proto.BOOL, + number=4, + ) + + +class DeleteCustomClassRequest(proto.Message): + r"""Request message for the + [DeleteCustomClass][google.cloud.speech.v2.Speech.DeleteCustomClass] + method. + + Attributes: + name (str): + Required. The name of the CustomClass to delete. Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + validate_only (bool): + If set, validate the request and preview the + deleted CustomClass, but do not actually delete + it. + allow_missing (bool): + If set to true, and the CustomClass is not + found, the request will succeed and be a no-op + (no Operation is recorded in this case). + etag (str): + This checksum is computed by the server based + on the value of other fields. This may be sent + on update, undelete, and delete requests to + ensure the client has an up-to-date value before + proceeding. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + validate_only = proto.Field( + proto.BOOL, + number=2, + ) + allow_missing = proto.Field( + proto.BOOL, + number=4, + ) + etag = proto.Field( + proto.STRING, + number=3, + ) + + +class UndeleteCustomClassRequest(proto.Message): + r"""Request message for the + [UndeleteCustomClass][google.cloud.speech.v2.Speech.UndeleteCustomClass] + method. + + Attributes: + name (str): + Required. The name of the CustomClass to undelete. Format: + ``projects/{project}/locations/{location}/customClasses/{custom_class}`` + validate_only (bool): + If set, validate the request and preview the + undeleted CustomClass, but do not actually + undelete it. + etag (str): + This checksum is computed by the server based + on the value of other fields. This may be sent + on update, undelete, and delete requests to + ensure the client has an up-to-date value before + proceeding. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + validate_only = proto.Field( + proto.BOOL, + number=3, + ) + etag = proto.Field( + proto.STRING, + number=4, + ) + + +class CreatePhraseSetRequest(proto.Message): + r"""Request message for the + [CreatePhraseSet][google.cloud.speech.v2.Speech.CreatePhraseSet] + method. + + Attributes: + phrase_set (google.cloud.speech_v2.types.PhraseSet): + Required. The PhraseSet to create. + validate_only (bool): + If set, validate the request and preview the + PhraseSet, but do not actually create it. + 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]-/. + parent (str): + Required. The project and location where this PhraseSet will + be created. The expected format is + ``projects/{project}/locations/{location}``. + """ + + phrase_set = proto.Field( + proto.MESSAGE, + number=1, + message="PhraseSet", + ) + validate_only = proto.Field( + proto.BOOL, + number=2, + ) + phrase_set_id = proto.Field( + proto.STRING, + number=3, + ) + parent = proto.Field( + proto.STRING, + number=4, + ) + + +class ListPhraseSetsRequest(proto.Message): + r"""Request message for the + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + method. + + Attributes: + parent (str): + Required. The project and location of PhraseSet resources to + list. The expected format is + ``projects/{project}/locations/{location}``. + page_size (int): + The maximum number of PhraseSets to return. + The service may return fewer than this value. If + unspecified, at most 20 PhraseSets will be + returned. The maximum value is 20; values above + 20 will be coerced to 20. + page_token (str): + A page token, received from a previous + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + call. Provide this to retrieve the subsequent page. + + When paginating, all other parameters provided to + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + must match the call that provided the page token. + show_deleted (bool): + Whether, or not, to show resources that have + been deleted. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + show_deleted = proto.Field( + proto.BOOL, + number=4, + ) + + +class ListPhraseSetsResponse(proto.Message): + r"""Response message for the + [ListPhraseSets][google.cloud.speech.v2.Speech.ListPhraseSets] + method. + + Attributes: + phrase_sets (Sequence[google.cloud.speech_v2.types.PhraseSet]): + The list of requested PhraseSets. + next_page_token (str): + A token, which can be sent as + [page_token][google.cloud.speech.v2.ListPhraseSetsRequest.page_token] + to retrieve the next page. If this field is omitted, there + are no subsequent pages. This token expires after 72 hours. + """ + + @property + def raw_page(self): + return self + + phrase_sets = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="PhraseSet", + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class GetPhraseSetRequest(proto.Message): + r"""Request message for the + [GetPhraseSet][google.cloud.speech.v2.Speech.GetPhraseSet] method. + + Attributes: + name (str): + Required. The name of the PhraseSet to retrieve. The + expected format is + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}``. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class UpdatePhraseSetRequest(proto.Message): + r"""Request message for the + [UpdatePhraseSet][google.cloud.speech.v2.Speech.UpdatePhraseSet] + method. + + Attributes: + 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}``. + 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. + validate_only (bool): + If set, validate the request and preview the + updated PhraseSet, but do not actually update + it. + """ + + phrase_set = proto.Field( + proto.MESSAGE, + number=1, + message="PhraseSet", + ) + update_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + validate_only = proto.Field( + proto.BOOL, + number=4, + ) + + +class DeletePhraseSetRequest(proto.Message): + r"""Request message for the + [DeletePhraseSet][google.cloud.speech.v2.Speech.DeletePhraseSet] + method. + + Attributes: + name (str): + Required. The name of the PhraseSet to delete. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + validate_only (bool): + If set, validate the request and preview the + deleted PhraseSet, but do not actually delete + it. + allow_missing (bool): + If set to true, and the PhraseSet is not + found, the request will succeed and be a no-op + (no Operation is recorded in this case). + etag (str): + This checksum is computed by the server based + on the value of other fields. This may be sent + on update, undelete, and delete requests to + ensure the client has an up-to-date value before + proceeding. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + validate_only = proto.Field( + proto.BOOL, + number=2, + ) + allow_missing = proto.Field( + proto.BOOL, + number=4, + ) + etag = proto.Field( + proto.STRING, + number=3, + ) + + +class UndeletePhraseSetRequest(proto.Message): + r"""Request message for the + [UndeletePhraseSet][google.cloud.speech.v2.Speech.UndeletePhraseSet] + method. + + Attributes: + name (str): + Required. The name of the PhraseSet to undelete. Format: + ``projects/{project}/locations/{location}/phraseSets/{phrase_set}`` + validate_only (bool): + If set, validate the request and preview the + undeleted PhraseSet, but do not actually + undelete it. + etag (str): + This checksum is computed by the server based + on the value of other fields. This may be sent + on update, undelete, and delete requests to + ensure the client has an up-to-date value before + proceeding. + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + validate_only = proto.Field( + proto.BOOL, + number=3, + ) + etag = proto.Field( + proto.STRING, + number=4, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-cloud-python-speech/owlbot.py b/packages/google-cloud-python-speech/owlbot.py index 5f1c771eb1f1..4c19677961e4 100644 --- a/packages/google-cloud-python-speech/owlbot.py +++ b/packages/google-cloud-python-speech/owlbot.py @@ -45,7 +45,7 @@ class SpeechClient(SpeechHelpers, SpeechClient): # Don't move over __init__.py, as we modify it to make the generated client # use helpers.py. - s.move(library, excludes=["setup.py", "docs/index.rst", "README.rst"]) + s.move(library, excludes=["setup.py"]) s.remove_staging_dirs() @@ -53,9 +53,8 @@ class SpeechClient(SpeechHelpers, SpeechClient): # Add templated files # ---------------------------------------------------------------------------- templated_files = common.py_library( - samples=True, # set to True only if there are samples microgenerator=True, - cov_level=100, + versions=gcp.common.detect_versions(path="./google", default_first=True), ) s.move( templated_files, excludes=[".coveragerc"] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/snippet_metadata_speech_v2.json b/packages/google-cloud-python-speech/samples/generated_samples/snippet_metadata_speech_v2.json new file mode 100644 index 000000000000..cd0f56ae8397 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/snippet_metadata_speech_v2.json @@ -0,0 +1,3845 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.speech.v2", + "version": "v2" + } + ], + "language": "PYTHON", + "name": "google-cloud-speech" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.batch_recognize", + "method": { + "fullName": "google.cloud.speech.v2.Speech.BatchRecognize", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "BatchRecognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.BatchRecognizeRequest" + }, + { + "name": "recognizer", + "type": "str" + }, + { + "name": "config", + "type": "google.cloud.speech_v2.types.RecognitionConfig" + }, + { + "name": "config_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "files", + "type": "Sequence[google.cloud.speech_v2.types.BatchRecognizeFileMetadata]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "batch_recognize" + }, + "description": "Sample for BatchRecognize", + "file": "speech_v2_generated_speech_batch_recognize_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_BatchRecognize_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_batch_recognize_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.batch_recognize", + "method": { + "fullName": "google.cloud.speech.v2.Speech.BatchRecognize", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "BatchRecognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.BatchRecognizeRequest" + }, + { + "name": "recognizer", + "type": "str" + }, + { + "name": "config", + "type": "google.cloud.speech_v2.types.RecognitionConfig" + }, + { + "name": "config_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "files", + "type": "Sequence[google.cloud.speech_v2.types.BatchRecognizeFileMetadata]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "batch_recognize" + }, + "description": "Sample for BatchRecognize", + "file": "speech_v2_generated_speech_batch_recognize_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_BatchRecognize_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_batch_recognize_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.create_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.CreateCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "CreateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.CreateCustomClassRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v2.types.CustomClass" + }, + { + "name": "custom_class_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_custom_class" + }, + "description": "Sample for CreateCustomClass", + "file": "speech_v2_generated_speech_create_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_CreateCustomClass_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_create_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.create_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.CreateCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "CreateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.CreateCustomClassRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v2.types.CustomClass" + }, + { + "name": "custom_class_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_custom_class" + }, + "description": "Sample for CreateCustomClass", + "file": "speech_v2_generated_speech_create_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_CreateCustomClass_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_create_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.create_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.CreatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "CreatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.CreatePhraseSetRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v2.types.PhraseSet" + }, + { + "name": "phrase_set_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_phrase_set" + }, + "description": "Sample for CreatePhraseSet", + "file": "speech_v2_generated_speech_create_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_CreatePhraseSet_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_create_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.create_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.CreatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "CreatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.CreatePhraseSetRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v2.types.PhraseSet" + }, + { + "name": "phrase_set_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_phrase_set" + }, + "description": "Sample for CreatePhraseSet", + "file": "speech_v2_generated_speech_create_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_CreatePhraseSet_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_create_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.create_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.CreateRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "CreateRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.CreateRecognizerRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "recognizer", + "type": "google.cloud.speech_v2.types.Recognizer" + }, + { + "name": "recognizer_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "create_recognizer" + }, + "description": "Sample for CreateRecognizer", + "file": "speech_v2_generated_speech_create_recognizer_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_CreateRecognizer_async", + "segments": [ + { + "end": 60, + "start": 27, + "type": "FULL" + }, + { + "end": 60, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 57, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 61, + "start": 58, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_create_recognizer_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.create_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.CreateRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "CreateRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.CreateRecognizerRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "recognizer", + "type": "google.cloud.speech_v2.types.Recognizer" + }, + { + "name": "recognizer_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "create_recognizer" + }, + "description": "Sample for CreateRecognizer", + "file": "speech_v2_generated_speech_create_recognizer_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_CreateRecognizer_sync", + "segments": [ + { + "end": 60, + "start": 27, + "type": "FULL" + }, + { + "end": 60, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 50, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 57, + "start": 51, + "type": "REQUEST_EXECUTION" + }, + { + "end": 61, + "start": 58, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_create_recognizer_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.delete_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.DeleteCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "DeleteCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.DeleteCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "delete_custom_class" + }, + "description": "Sample for DeleteCustomClass", + "file": "speech_v2_generated_speech_delete_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_DeleteCustomClass_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_delete_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.delete_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.DeleteCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "DeleteCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.DeleteCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "delete_custom_class" + }, + "description": "Sample for DeleteCustomClass", + "file": "speech_v2_generated_speech_delete_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_DeleteCustomClass_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_delete_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.delete_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.DeletePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "DeletePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.DeletePhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "delete_phrase_set" + }, + "description": "Sample for DeletePhraseSet", + "file": "speech_v2_generated_speech_delete_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_DeletePhraseSet_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_delete_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.delete_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.DeletePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "DeletePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.DeletePhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "delete_phrase_set" + }, + "description": "Sample for DeletePhraseSet", + "file": "speech_v2_generated_speech_delete_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_DeletePhraseSet_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_delete_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.delete_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.DeleteRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "DeleteRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.DeleteRecognizerRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "delete_recognizer" + }, + "description": "Sample for DeleteRecognizer", + "file": "speech_v2_generated_speech_delete_recognizer_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_DeleteRecognizer_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_delete_recognizer_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.delete_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.DeleteRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "DeleteRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.DeleteRecognizerRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "delete_recognizer" + }, + "description": "Sample for DeleteRecognizer", + "file": "speech_v2_generated_speech_delete_recognizer_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_DeleteRecognizer_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_delete_recognizer_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.get_config", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetConfig", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetConfig" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetConfigRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.Config", + "shortName": "get_config" + }, + "description": "Sample for GetConfig", + "file": "speech_v2_generated_speech_get_config_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetConfig_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_config_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.get_config", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetConfig", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetConfig" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetConfigRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.Config", + "shortName": "get_config" + }, + "description": "Sample for GetConfig", + "file": "speech_v2_generated_speech_get_config_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetConfig_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_config_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.get_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.CustomClass", + "shortName": "get_custom_class" + }, + "description": "Sample for GetCustomClass", + "file": "speech_v2_generated_speech_get_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetCustomClass_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.get_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.CustomClass", + "shortName": "get_custom_class" + }, + "description": "Sample for GetCustomClass", + "file": "speech_v2_generated_speech_get_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetCustomClass_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.get_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetPhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetPhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetPhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.PhraseSet", + "shortName": "get_phrase_set" + }, + "description": "Sample for GetPhraseSet", + "file": "speech_v2_generated_speech_get_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetPhraseSet_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.get_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetPhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetPhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetPhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.PhraseSet", + "shortName": "get_phrase_set" + }, + "description": "Sample for GetPhraseSet", + "file": "speech_v2_generated_speech_get_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetPhraseSet_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.get_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetRecognizerRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.Recognizer", + "shortName": "get_recognizer" + }, + "description": "Sample for GetRecognizer", + "file": "speech_v2_generated_speech_get_recognizer_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetRecognizer_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_recognizer_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.get_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.GetRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "GetRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.GetRecognizerRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.Recognizer", + "shortName": "get_recognizer" + }, + "description": "Sample for GetRecognizer", + "file": "speech_v2_generated_speech_get_recognizer_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_GetRecognizer_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_get_recognizer_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.list_custom_classes", + "method": { + "fullName": "google.cloud.speech.v2.Speech.ListCustomClasses", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "ListCustomClasses" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.ListCustomClassesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.services.speech.pagers.ListCustomClassesAsyncPager", + "shortName": "list_custom_classes" + }, + "description": "Sample for ListCustomClasses", + "file": "speech_v2_generated_speech_list_custom_classes_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_ListCustomClasses_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_list_custom_classes_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.list_custom_classes", + "method": { + "fullName": "google.cloud.speech.v2.Speech.ListCustomClasses", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "ListCustomClasses" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.ListCustomClassesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.services.speech.pagers.ListCustomClassesPager", + "shortName": "list_custom_classes" + }, + "description": "Sample for ListCustomClasses", + "file": "speech_v2_generated_speech_list_custom_classes_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_ListCustomClasses_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_list_custom_classes_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.list_phrase_sets", + "method": { + "fullName": "google.cloud.speech.v2.Speech.ListPhraseSets", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "ListPhraseSets" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.ListPhraseSetsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.services.speech.pagers.ListPhraseSetsAsyncPager", + "shortName": "list_phrase_sets" + }, + "description": "Sample for ListPhraseSets", + "file": "speech_v2_generated_speech_list_phrase_sets_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_ListPhraseSets_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_list_phrase_sets_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.list_phrase_sets", + "method": { + "fullName": "google.cloud.speech.v2.Speech.ListPhraseSets", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "ListPhraseSets" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.ListPhraseSetsRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.services.speech.pagers.ListPhraseSetsPager", + "shortName": "list_phrase_sets" + }, + "description": "Sample for ListPhraseSets", + "file": "speech_v2_generated_speech_list_phrase_sets_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_ListPhraseSets_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_list_phrase_sets_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.list_recognizers", + "method": { + "fullName": "google.cloud.speech.v2.Speech.ListRecognizers", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "ListRecognizers" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.ListRecognizersRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.services.speech.pagers.ListRecognizersAsyncPager", + "shortName": "list_recognizers" + }, + "description": "Sample for ListRecognizers", + "file": "speech_v2_generated_speech_list_recognizers_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_ListRecognizers_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_list_recognizers_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.list_recognizers", + "method": { + "fullName": "google.cloud.speech.v2.Speech.ListRecognizers", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "ListRecognizers" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.ListRecognizersRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.services.speech.pagers.ListRecognizersPager", + "shortName": "list_recognizers" + }, + "description": "Sample for ListRecognizers", + "file": "speech_v2_generated_speech_list_recognizers_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_ListRecognizers_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_list_recognizers_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.recognize", + "method": { + "fullName": "google.cloud.speech.v2.Speech.Recognize", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "Recognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.RecognizeRequest" + }, + { + "name": "recognizer", + "type": "str" + }, + { + "name": "config", + "type": "google.cloud.speech_v2.types.RecognitionConfig" + }, + { + "name": "config_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "content", + "type": "bytes" + }, + { + "name": "uri", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.RecognizeResponse", + "shortName": "recognize" + }, + "description": "Sample for Recognize", + "file": "speech_v2_generated_speech_recognize_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_Recognize_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_recognize_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.recognize", + "method": { + "fullName": "google.cloud.speech.v2.Speech.Recognize", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "Recognize" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.RecognizeRequest" + }, + { + "name": "recognizer", + "type": "str" + }, + { + "name": "config", + "type": "google.cloud.speech_v2.types.RecognitionConfig" + }, + { + "name": "config_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "content", + "type": "bytes" + }, + { + "name": "uri", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.RecognizeResponse", + "shortName": "recognize" + }, + "description": "Sample for Recognize", + "file": "speech_v2_generated_speech_recognize_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_Recognize_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_recognize_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.streaming_recognize", + "method": { + "fullName": "google.cloud.speech.v2.Speech.StreamingRecognize", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "StreamingRecognize" + }, + "parameters": [ + { + "name": "requests", + "type": "Iterator[google.cloud.speech_v2.types.StreamingRecognizeRequest]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "Iterable[google.cloud.speech_v2.types.StreamingRecognizeResponse]", + "shortName": "streaming_recognize" + }, + "description": "Sample for StreamingRecognize", + "file": "speech_v2_generated_speech_streaming_recognize_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_StreamingRecognize_async", + "segments": [ + { + "end": 62, + "start": 27, + "type": "FULL" + }, + { + "end": 62, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 55, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 58, + "start": 56, + "type": "REQUEST_EXECUTION" + }, + { + "end": 63, + "start": 59, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_streaming_recognize_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.streaming_recognize", + "method": { + "fullName": "google.cloud.speech.v2.Speech.StreamingRecognize", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "StreamingRecognize" + }, + "parameters": [ + { + "name": "requests", + "type": "Iterator[google.cloud.speech_v2.types.StreamingRecognizeRequest]" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "Iterable[google.cloud.speech_v2.types.StreamingRecognizeResponse]", + "shortName": "streaming_recognize" + }, + "description": "Sample for StreamingRecognize", + "file": "speech_v2_generated_speech_streaming_recognize_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_StreamingRecognize_sync", + "segments": [ + { + "end": 62, + "start": 27, + "type": "FULL" + }, + { + "end": 62, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 55, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 58, + "start": 56, + "type": "REQUEST_EXECUTION" + }, + { + "end": 63, + "start": 59, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_streaming_recognize_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.undelete_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UndeleteCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UndeleteCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UndeleteCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "undelete_custom_class" + }, + "description": "Sample for UndeleteCustomClass", + "file": "speech_v2_generated_speech_undelete_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UndeleteCustomClass_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_undelete_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.undelete_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UndeleteCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UndeleteCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UndeleteCustomClassRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "undelete_custom_class" + }, + "description": "Sample for UndeleteCustomClass", + "file": "speech_v2_generated_speech_undelete_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UndeleteCustomClass_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_undelete_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.undelete_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UndeletePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UndeletePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UndeletePhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "undelete_phrase_set" + }, + "description": "Sample for UndeletePhraseSet", + "file": "speech_v2_generated_speech_undelete_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UndeletePhraseSet_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_undelete_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.undelete_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UndeletePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UndeletePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UndeletePhraseSetRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "undelete_phrase_set" + }, + "description": "Sample for UndeletePhraseSet", + "file": "speech_v2_generated_speech_undelete_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UndeletePhraseSet_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_undelete_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.undelete_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UndeleteRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UndeleteRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UndeleteRecognizerRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "undelete_recognizer" + }, + "description": "Sample for UndeleteRecognizer", + "file": "speech_v2_generated_speech_undelete_recognizer_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UndeleteRecognizer_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_undelete_recognizer_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.undelete_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UndeleteRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UndeleteRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UndeleteRecognizerRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "undelete_recognizer" + }, + "description": "Sample for UndeleteRecognizer", + "file": "speech_v2_generated_speech_undelete_recognizer_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UndeleteRecognizer_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_undelete_recognizer_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.update_config", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdateConfig", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdateConfig" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdateConfigRequest" + }, + { + "name": "config", + "type": "google.cloud.speech_v2.types.Config" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.Config", + "shortName": "update_config" + }, + "description": "Sample for UpdateConfig", + "file": "speech_v2_generated_speech_update_config_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdateConfig_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_config_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.update_config", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdateConfig", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdateConfig" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdateConfigRequest" + }, + { + "name": "config", + "type": "google.cloud.speech_v2.types.Config" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.speech_v2.types.Config", + "shortName": "update_config" + }, + "description": "Sample for UpdateConfig", + "file": "speech_v2_generated_speech_update_config_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdateConfig_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_config_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.update_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdateCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdateCustomClassRequest" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v2.types.CustomClass" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "update_custom_class" + }, + "description": "Sample for UpdateCustomClass", + "file": "speech_v2_generated_speech_update_custom_class_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdateCustomClass_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_custom_class_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.update_custom_class", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdateCustomClass", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdateCustomClass" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdateCustomClassRequest" + }, + { + "name": "custom_class", + "type": "google.cloud.speech_v2.types.CustomClass" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "update_custom_class" + }, + "description": "Sample for UpdateCustomClass", + "file": "speech_v2_generated_speech_update_custom_class_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdateCustomClass_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_custom_class_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.update_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdatePhraseSetRequest" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v2.types.PhraseSet" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "update_phrase_set" + }, + "description": "Sample for UpdatePhraseSet", + "file": "speech_v2_generated_speech_update_phrase_set_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdatePhraseSet_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_phrase_set_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.update_phrase_set", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdatePhraseSet", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdatePhraseSet" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdatePhraseSetRequest" + }, + { + "name": "phrase_set", + "type": "google.cloud.speech_v2.types.PhraseSet" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "update_phrase_set" + }, + "description": "Sample for UpdatePhraseSet", + "file": "speech_v2_generated_speech_update_phrase_set_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdatePhraseSet_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_phrase_set_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.speech_v2.SpeechAsyncClient", + "shortName": "SpeechAsyncClient" + }, + "fullName": "google.cloud.speech_v2.SpeechAsyncClient.update_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdateRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdateRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdateRecognizerRequest" + }, + { + "name": "recognizer", + "type": "google.cloud.speech_v2.types.Recognizer" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation_async.AsyncOperation", + "shortName": "update_recognizer" + }, + "description": "Sample for UpdateRecognizer", + "file": "speech_v2_generated_speech_update_recognizer_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdateRecognizer_async", + "segments": [ + { + "end": 59, + "start": 27, + "type": "FULL" + }, + { + "end": 59, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 49, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 56, + "start": 50, + "type": "REQUEST_EXECUTION" + }, + { + "end": 60, + "start": 57, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_recognizer_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.speech_v2.SpeechClient", + "shortName": "SpeechClient" + }, + "fullName": "google.cloud.speech_v2.SpeechClient.update_recognizer", + "method": { + "fullName": "google.cloud.speech.v2.Speech.UpdateRecognizer", + "service": { + "fullName": "google.cloud.speech.v2.Speech", + "shortName": "Speech" + }, + "shortName": "UpdateRecognizer" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.speech_v2.types.UpdateRecognizerRequest" + }, + { + "name": "recognizer", + "type": "google.cloud.speech_v2.types.Recognizer" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.api_core.operation.Operation", + "shortName": "update_recognizer" + }, + "description": "Sample for UpdateRecognizer", + "file": "speech_v2_generated_speech_update_recognizer_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "speech_v2_generated_Speech_UpdateRecognizer_sync", + "segments": [ + { + "end": 59, + "start": 27, + "type": "FULL" + }, + { + "end": 59, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 49, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 56, + "start": 50, + "type": "REQUEST_EXECUTION" + }, + { + "end": 60, + "start": 57, + "type": "RESPONSE_HANDLING" + } + ], + "title": "speech_v2_generated_speech_update_recognizer_sync.py" + } + ] +} diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_batch_recognize_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_batch_recognize_async.py new file mode 100644 index 000000000000..64de219fe419 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_batch_recognize_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for BatchRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_BatchRecognize_async] +# 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_batch_recognize(): + # Create a client + client = speech_v2.SpeechAsyncClient() + + # 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 = await operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_BatchRecognize_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_batch_recognize_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_batch_recognize_sync.py new file mode 100644 index 000000000000..f306ea7af090 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_batch_recognize_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for BatchRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_BatchRecognize_sync] +# 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) + +# [END speech_v2_generated_Speech_BatchRecognize_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_custom_class_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_custom_class_async.py new file mode 100644 index 000000000000..cad6b2f12694 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_custom_class_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_CreateCustomClass_async] +# 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) + +# [END speech_v2_generated_Speech_CreateCustomClass_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_custom_class_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_custom_class_sync.py new file mode 100644 index 000000000000..3001c42053d3 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_custom_class_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_CreateCustomClass_sync] +# 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) + +# [END speech_v2_generated_Speech_CreateCustomClass_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_async.py new file mode 100644 index 000000000000..d2932bee3778 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_CreatePhraseSet_async] +# 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) + +# [END speech_v2_generated_Speech_CreatePhraseSet_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_sync.py new file mode 100644 index 000000000000..c311d648c15f --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_phrase_set_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_CreatePhraseSet_sync] +# 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) + +# [END speech_v2_generated_Speech_CreatePhraseSet_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_recognizer_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_recognizer_async.py new file mode 100644 index 000000000000..eb62638eb3a9 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_recognizer_async.py @@ -0,0 +1,61 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_CreateRecognizer_async] +# 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) + recognizer = speech_v2.Recognizer() + recognizer.model = "model_value" + recognizer.language_codes = ['language_codes_value1', 'language_codes_value2'] + + request = speech_v2.CreateRecognizerRequest( + recognizer=recognizer, + 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) + +# [END speech_v2_generated_Speech_CreateRecognizer_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_recognizer_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_recognizer_sync.py new file mode 100644 index 000000000000..af0ffdc76996 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_create_recognizer_sync.py @@ -0,0 +1,61 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_CreateRecognizer_sync] +# 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) + recognizer = speech_v2.Recognizer() + recognizer.model = "model_value" + recognizer.language_codes = ['language_codes_value1', 'language_codes_value2'] + + request = speech_v2.CreateRecognizerRequest( + recognizer=recognizer, + 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) + +# [END speech_v2_generated_Speech_CreateRecognizer_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_async.py new file mode 100644 index 000000000000..64dce73c81da --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_DeleteCustomClass_async] +# 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) + +# [END speech_v2_generated_Speech_DeleteCustomClass_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_sync.py new file mode 100644 index 000000000000..e6a15dd450c8 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_custom_class_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_DeleteCustomClass_sync] +# 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) + +# [END speech_v2_generated_Speech_DeleteCustomClass_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_async.py new file mode 100644 index 000000000000..d5f1c64bfd9a --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeletePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_DeletePhraseSet_async] +# 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) + +# [END speech_v2_generated_Speech_DeletePhraseSet_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_sync.py new file mode 100644 index 000000000000..cc874b06330c --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_phrase_set_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeletePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_DeletePhraseSet_sync] +# 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) + +# [END speech_v2_generated_Speech_DeletePhraseSet_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_async.py new file mode 100644 index 000000000000..8de3bedd71bb --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_DeleteRecognizer_async] +# 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) + +# [END speech_v2_generated_Speech_DeleteRecognizer_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_sync.py new file mode 100644 index 000000000000..72e49f256e4e --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_delete_recognizer_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_DeleteRecognizer_sync] +# 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) + +# [END speech_v2_generated_Speech_DeleteRecognizer_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_config_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_config_async.py new file mode 100644 index 000000000000..0f430b8c62c8 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_config_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetConfig +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetConfig_async] +# 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) + +# [END speech_v2_generated_Speech_GetConfig_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_config_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_config_sync.py new file mode 100644 index 000000000000..802dfae519ca --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_config_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetConfig +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetConfig_sync] +# 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) + +# [END speech_v2_generated_Speech_GetConfig_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_custom_class_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_custom_class_async.py new file mode 100644 index 000000000000..c82070aec09d --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_custom_class_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetCustomClass_async] +# 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) + +# [END speech_v2_generated_Speech_GetCustomClass_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_custom_class_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_custom_class_sync.py new file mode 100644 index 000000000000..121b9eaeb918 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_custom_class_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetCustomClass_sync] +# 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) + +# [END speech_v2_generated_Speech_GetCustomClass_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_async.py new file mode 100644 index 000000000000..e5f861fe8a6b --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetPhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetPhraseSet_async] +# 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) + +# [END speech_v2_generated_Speech_GetPhraseSet_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_sync.py new file mode 100644 index 000000000000..b02f3c23de02 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_phrase_set_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetPhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetPhraseSet_sync] +# 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) + +# [END speech_v2_generated_Speech_GetPhraseSet_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_recognizer_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_recognizer_async.py new file mode 100644 index 000000000000..733bffb82e46 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_recognizer_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetRecognizer_async] +# 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) + +# [END speech_v2_generated_Speech_GetRecognizer_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_recognizer_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_recognizer_sync.py new file mode 100644 index 000000000000..d7ecb25460df --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_get_recognizer_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_GetRecognizer_sync] +# 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) + +# [END speech_v2_generated_Speech_GetRecognizer_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_async.py new file mode 100644 index 000000000000..9ff98b68a27d --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListCustomClasses +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_ListCustomClasses_async] +# 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) + +# [END speech_v2_generated_Speech_ListCustomClasses_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_sync.py new file mode 100644 index 000000000000..9c95e926a4c7 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_custom_classes_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListCustomClasses +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_ListCustomClasses_sync] +# 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) + +# [END speech_v2_generated_Speech_ListCustomClasses_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_async.py new file mode 100644 index 000000000000..da27848f2168 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListPhraseSets +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_ListPhraseSets_async] +# 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) + +# [END speech_v2_generated_Speech_ListPhraseSets_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_sync.py new file mode 100644 index 000000000000..306eb5b5368e --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_phrase_sets_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListPhraseSets +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_ListPhraseSets_sync] +# 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) + +# [END speech_v2_generated_Speech_ListPhraseSets_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_recognizers_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_recognizers_async.py new file mode 100644 index 000000000000..c645fbe093ed --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_recognizers_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListRecognizers +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_ListRecognizers_async] +# 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) + +# [END speech_v2_generated_Speech_ListRecognizers_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_recognizers_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_recognizers_sync.py new file mode 100644 index 000000000000..ad1460e5f7a4 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_list_recognizers_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListRecognizers +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_ListRecognizers_sync] +# 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) + +# [END speech_v2_generated_Speech_ListRecognizers_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_recognize_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_recognize_async.py new file mode 100644 index 000000000000..440fcf82acac --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_recognize_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for Recognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_Recognize_async] +# 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) + +# [END speech_v2_generated_Speech_Recognize_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_recognize_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_recognize_sync.py new file mode 100644 index 000000000000..aae737216478 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_recognize_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for Recognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_Recognize_sync] +# 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) + +# [END speech_v2_generated_Speech_Recognize_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_async.py new file mode 100644 index 000000000000..46598611112f --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_async.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StreamingRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_StreamingRecognize_async] +# 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) + +# [END speech_v2_generated_Speech_StreamingRecognize_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_sync.py new file mode 100644 index 000000000000..057843eec944 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_streaming_recognize_sync.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for StreamingRecognize +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_StreamingRecognize_sync] +# 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) + +# [END speech_v2_generated_Speech_StreamingRecognize_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_async.py new file mode 100644 index 000000000000..2ae43d7f72d3 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UndeleteCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UndeleteCustomClass_async] +# 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) + +# [END speech_v2_generated_Speech_UndeleteCustomClass_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_sync.py new file mode 100644 index 000000000000..0ef956125c5c --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_custom_class_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UndeleteCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UndeleteCustomClass_sync] +# 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) + +# [END speech_v2_generated_Speech_UndeleteCustomClass_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_async.py new file mode 100644 index 000000000000..77808995b1c8 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UndeletePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UndeletePhraseSet_async] +# 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) + +# [END speech_v2_generated_Speech_UndeletePhraseSet_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_sync.py new file mode 100644 index 000000000000..594399fcb771 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_phrase_set_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UndeletePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UndeletePhraseSet_sync] +# 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) + +# [END speech_v2_generated_Speech_UndeletePhraseSet_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_async.py new file mode 100644 index 000000000000..eb58be11bd8f --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_async.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UndeleteRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UndeleteRecognizer_async] +# 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) + +# [END speech_v2_generated_Speech_UndeleteRecognizer_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_sync.py new file mode 100644 index 000000000000..f4a3137249ea --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_undelete_recognizer_sync.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UndeleteRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UndeleteRecognizer_sync] +# 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) + +# [END speech_v2_generated_Speech_UndeleteRecognizer_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_config_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_config_async.py new file mode 100644 index 000000000000..28fb331fb7a7 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_config_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateConfig +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdateConfig_async] +# 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) + +# [END speech_v2_generated_Speech_UpdateConfig_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_config_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_config_sync.py new file mode 100644 index 000000000000..930c59c40996 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_config_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateConfig +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdateConfig_sync] +# 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) + +# [END speech_v2_generated_Speech_UpdateConfig_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_custom_class_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_custom_class_async.py new file mode 100644 index 000000000000..959038979403 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_custom_class_async.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdateCustomClass_async] +# 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) + +# [END speech_v2_generated_Speech_UpdateCustomClass_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_custom_class_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_custom_class_sync.py new file mode 100644 index 000000000000..f877fb6c3526 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_custom_class_sync.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateCustomClass +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdateCustomClass_sync] +# 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) + +# [END speech_v2_generated_Speech_UpdateCustomClass_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_async.py new file mode 100644 index 000000000000..02ee5d96efc0 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_async.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdatePhraseSet_async] +# 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) + +# [END speech_v2_generated_Speech_UpdatePhraseSet_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_sync.py new file mode 100644 index 000000000000..b65577aeb837 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_phrase_set_sync.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdatePhraseSet +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdatePhraseSet_sync] +# 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) + +# [END speech_v2_generated_Speech_UpdatePhraseSet_sync] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_recognizer_async.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_recognizer_async.py new file mode 100644 index 000000000000..d29f724c271f --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_recognizer_async.py @@ -0,0 +1,60 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdateRecognizer_async] +# 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) + recognizer = speech_v2.Recognizer() + recognizer.model = "model_value" + recognizer.language_codes = ['language_codes_value1', 'language_codes_value2'] + + request = speech_v2.UpdateRecognizerRequest( + recognizer=recognizer, + ) + + # Make the request + operation = client.update_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = await operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UpdateRecognizer_async] diff --git a/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_recognizer_sync.py b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_recognizer_sync.py new file mode 100644 index 000000000000..2c38e4fc9a60 --- /dev/null +++ b/packages/google-cloud-python-speech/samples/generated_samples/speech_v2_generated_speech_update_recognizer_sync.py @@ -0,0 +1,60 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateRecognizer +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-speech + + +# [START speech_v2_generated_Speech_UpdateRecognizer_sync] +# 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) + recognizer = speech_v2.Recognizer() + recognizer.model = "model_value" + recognizer.language_codes = ['language_codes_value1', 'language_codes_value2'] + + request = speech_v2.UpdateRecognizerRequest( + recognizer=recognizer, + ) + + # Make the request + operation = client.update_recognizer(request=request) + + print("Waiting for operation to complete...") + + response = operation.result() + + # Handle the response + print(response) + +# [END speech_v2_generated_Speech_UpdateRecognizer_sync] diff --git a/packages/google-cloud-python-speech/scripts/fixup_speech_v2_keywords.py b/packages/google-cloud-python-speech/scripts/fixup_speech_v2_keywords.py new file mode 100644 index 000000000000..845fa5c99319 --- /dev/null +++ b/packages/google-cloud-python-speech/scripts/fixup_speech_v2_keywords.py @@ -0,0 +1,198 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class speechCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'batch_recognize': ('recognizer', 'config', 'config_mask', 'files', ), + 'create_custom_class': ('custom_class', 'parent', 'validate_only', 'custom_class_id', ), + 'create_phrase_set': ('phrase_set', 'parent', 'validate_only', 'phrase_set_id', ), + 'create_recognizer': ('recognizer', 'parent', 'validate_only', 'recognizer_id', ), + 'delete_custom_class': ('name', 'validate_only', 'allow_missing', 'etag', ), + 'delete_phrase_set': ('name', 'validate_only', 'allow_missing', 'etag', ), + 'delete_recognizer': ('name', 'validate_only', 'allow_missing', 'etag', ), + 'get_config': ('name', ), + 'get_custom_class': ('name', ), + 'get_phrase_set': ('name', ), + 'get_recognizer': ('name', ), + 'list_custom_classes': ('parent', 'page_size', 'page_token', 'show_deleted', ), + 'list_phrase_sets': ('parent', 'page_size', 'page_token', 'show_deleted', ), + 'list_recognizers': ('parent', 'page_size', 'page_token', 'show_deleted', ), + 'recognize': ('recognizer', 'config', 'config_mask', 'content', 'uri', ), + 'streaming_recognize': ('recognizer', 'streaming_config', 'audio', ), + 'undelete_custom_class': ('name', 'validate_only', 'etag', ), + 'undelete_phrase_set': ('name', 'validate_only', 'etag', ), + 'undelete_recognizer': ('name', 'validate_only', 'etag', ), + 'update_config': ('config', 'update_mask', ), + 'update_custom_class': ('custom_class', 'update_mask', 'validate_only', ), + 'update_phrase_set': ('phrase_set', 'update_mask', 'validate_only', ), + 'update_recognizer': ('recognizer', 'update_mask', 'validate_only', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=speechCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the speech client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/packages/google-cloud-python-speech/tests/unit/gapic/speech_v2/__init__.py b/packages/google-cloud-python-speech/tests/unit/gapic/speech_v2/__init__.py new file mode 100644 index 000000000000..e8e1c3845db5 --- /dev/null +++ b/packages/google-cloud-python-speech/tests/unit/gapic/speech_v2/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/packages/google-cloud-python-speech/tests/unit/gapic/speech_v2/test_speech.py b/packages/google-cloud-python-speech/tests/unit/gapic/speech_v2/test_speech.py new file mode 100644 index 000000000000..941427b0e1ba --- /dev/null +++ b/packages/google-cloud-python-speech/tests/unit/gapic/speech_v2/test_speech.py @@ -0,0 +1,8228 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os + +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import future +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import operation +from google.api_core import operation_async # type: ignore +from google.api_core import operations_v1 +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.speech_v2.services.speech import SpeechAsyncClient +from google.cloud.speech_v2.services.speech import SpeechClient +from google.cloud.speech_v2.services.speech import pagers +from google.cloud.speech_v2.services.speech import transports +from google.cloud.speech_v2.types import cloud_speech +from google.longrunning import operations_pb2 +from google.oauth2 import service_account +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import field_mask_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return ( + "foo.googleapis.com" + if ("localhost" in client.DEFAULT_ENDPOINT) + else client.DEFAULT_ENDPOINT + ) + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert SpeechClient._get_default_mtls_endpoint(None) is None + assert SpeechClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert ( + SpeechClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + ) + assert ( + SpeechClient._get_default_mtls_endpoint(sandbox_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + SpeechClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) + == sandbox_mtls_endpoint + ) + assert SpeechClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (SpeechClient, "grpc"), + (SpeechAsyncClient, "grpc_asyncio"), + ], +) +def test_speech_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_info" + ) as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ("speech.googleapis.com:443") + + +@pytest.mark.parametrize( + "transport_class,transport_name", + [ + (transports.SpeechGrpcTransport, "grpc"), + (transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), + ], +) +def test_speech_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (SpeechClient, "grpc"), + (SpeechAsyncClient, "grpc_asyncio"), + ], +) +def test_speech_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_file" + ) as factory: + factory.return_value = creds + client = client_class.from_service_account_file( + "dummy/file/path.json", transport=transport_name + ) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json( + "dummy/file/path.json", transport=transport_name + ) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ("speech.googleapis.com:443") + + +def test_speech_client_get_transport_class(): + transport = SpeechClient.get_transport_class() + available_transports = [ + transports.SpeechGrpcTransport, + ] + assert transport in available_transports + + transport = SpeechClient.get_transport_class("grpc") + assert transport == transports.SpeechGrpcTransport + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), + ], +) +@mock.patch.object( + SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient) +) +@mock.patch.object( + SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient) +) +def test_speech_client_client_options(client_class, transport_class, transport_name): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(SpeechClient, "get_transport_class") as gtc: + transport = transport_class(credentials=ga_credentials.AnonymousCredentials()) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(SpeechClient, "get_transport_class") as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions( + api_audience="https://language.googleapis.com" + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com", + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,use_client_cert_env", + [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", "true"), + ( + SpeechAsyncClient, + transports.SpeechGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + (SpeechClient, transports.SpeechGrpcTransport, "grpc", "false"), + ( + SpeechAsyncClient, + transports.SpeechGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + ], +) +@mock.patch.object( + SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient) +) +@mock.patch.object( + SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient) +) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_speech_client_mtls_env_auto( + client_class, transport_class, transport_name, use_client_cert_env +): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + options = client_options.ClientOptions( + client_cert_source=client_cert_source_callback + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=client_cert_source_callback, + ): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [SpeechClient, SpeechAsyncClient]) +@mock.patch.object( + SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient) +) +@mock.patch.object( + SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient) +) +def test_speech_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_client_cert_source, + ): + ( + api_endpoint, + cert_source, + ) = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), + ], +) +def test_speech_client_client_options_scopes( + client_class, transport_class, transport_name +): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", grpc_helpers), + ( + SpeechAsyncClient, + transports.SpeechGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_speech_client_client_options_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +def test_speech_client_client_options_from_dict(): + with mock.patch( + "google.cloud.speech_v2.services.speech.transports.SpeechGrpcTransport.__init__" + ) as grpc_transport: + grpc_transport.return_value = None + client = SpeechClient(client_options={"api_endpoint": "squid.clam.whelk"}) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", grpc_helpers), + ( + SpeechAsyncClient, + transports.SpeechGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_speech_client_create_channel_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "speech.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + scopes=None, + default_host="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.CreateRecognizerRequest, + dict, + ], +) +def test_create_recognizer(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.create_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreateRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_recognizer_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_recognizer), "__call__" + ) as call: + client.create_recognizer() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreateRecognizerRequest() + + +@pytest.mark.asyncio +async def test_create_recognizer_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.CreateRecognizerRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.create_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreateRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_recognizer_async_from_dict(): + await test_create_recognizer_async(request_type=dict) + + +def test_create_recognizer_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.CreateRecognizerRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_recognizer), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.create_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_create_recognizer_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.CreateRecognizerRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_recognizer), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.create_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +def test_create_recognizer_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_recognizer( + parent="parent_value", + recognizer=cloud_speech.Recognizer(name="name_value"), + recognizer_id="recognizer_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + arg = args[0].recognizer + mock_val = cloud_speech.Recognizer(name="name_value") + assert arg == mock_val + arg = args[0].recognizer_id + mock_val = "recognizer_id_value" + assert arg == mock_val + + +def test_create_recognizer_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_recognizer( + cloud_speech.CreateRecognizerRequest(), + parent="parent_value", + recognizer=cloud_speech.Recognizer(name="name_value"), + recognizer_id="recognizer_id_value", + ) + + +@pytest.mark.asyncio +async def test_create_recognizer_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_recognizer( + parent="parent_value", + recognizer=cloud_speech.Recognizer(name="name_value"), + recognizer_id="recognizer_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + arg = args[0].recognizer + mock_val = cloud_speech.Recognizer(name="name_value") + assert arg == mock_val + arg = args[0].recognizer_id + mock_val = "recognizer_id_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_create_recognizer_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_recognizer( + cloud_speech.CreateRecognizerRequest(), + parent="parent_value", + recognizer=cloud_speech.Recognizer(name="name_value"), + recognizer_id="recognizer_id_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.ListRecognizersRequest, + dict, + ], +) +def test_list_recognizers(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_recognizers), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListRecognizersResponse( + next_page_token="next_page_token_value", + ) + response = client.list_recognizers(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListRecognizersRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRecognizersPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_recognizers_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_recognizers), "__call__") as call: + client.list_recognizers() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListRecognizersRequest() + + +@pytest.mark.asyncio +async def test_list_recognizers_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.ListRecognizersRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_recognizers), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.ListRecognizersResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_recognizers(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListRecognizersRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListRecognizersAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_recognizers_async_from_dict(): + await test_list_recognizers_async(request_type=dict) + + +def test_list_recognizers_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.ListRecognizersRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_recognizers), "__call__") as call: + call.return_value = cloud_speech.ListRecognizersResponse() + client.list_recognizers(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_recognizers_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.ListRecognizersRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_recognizers), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.ListRecognizersResponse() + ) + await client.list_recognizers(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +def test_list_recognizers_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_recognizers), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListRecognizersResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_recognizers( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +def test_list_recognizers_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_recognizers( + cloud_speech.ListRecognizersRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_recognizers_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_recognizers), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListRecognizersResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.ListRecognizersResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_recognizers( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_list_recognizers_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_recognizers( + cloud_speech.ListRecognizersRequest(), + parent="parent_value", + ) + + +def test_list_recognizers_pager(transport_name: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_recognizers), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + next_page_token="abc", + ), + cloud_speech.ListRecognizersResponse( + recognizers=[], + next_page_token="def", + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + ], + next_page_token="ghi", + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_recognizers(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_speech.Recognizer) for i in results) + + +def test_list_recognizers_pages(transport_name: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_recognizers), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + next_page_token="abc", + ), + cloud_speech.ListRecognizersResponse( + recognizers=[], + next_page_token="def", + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + ], + next_page_token="ghi", + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + ), + RuntimeError, + ) + pages = list(client.list_recognizers(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_recognizers_async_pager(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + next_page_token="abc", + ), + cloud_speech.ListRecognizersResponse( + recognizers=[], + next_page_token="def", + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + ], + next_page_token="ghi", + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_recognizers( + request={}, + ) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_speech.Recognizer) for i in responses) + + +@pytest.mark.asyncio +async def test_list_recognizers_async_pages(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_recognizers), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + next_page_token="abc", + ), + cloud_speech.ListRecognizersResponse( + recognizers=[], + next_page_token="def", + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + ], + next_page_token="ghi", + ), + cloud_speech.ListRecognizersResponse( + recognizers=[ + cloud_speech.Recognizer(), + cloud_speech.Recognizer(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in ( + await client.list_recognizers(request={}) + ).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.GetRecognizerRequest, + dict, + ], +) +def test_get_recognizer(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_recognizer), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Recognizer( + name="name_value", + uid="uid_value", + display_name="display_name_value", + model="model_value", + language_codes=["language_codes_value"], + state=cloud_speech.Recognizer.State.ACTIVE, + etag="etag_value", + reconciling=True, + kms_key_name="kms_key_name_value", + kms_key_version_name="kms_key_version_name_value", + ) + response = client.get_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Recognizer) + assert response.name == "name_value" + assert response.uid == "uid_value" + assert response.display_name == "display_name_value" + assert response.model == "model_value" + assert response.language_codes == ["language_codes_value"] + assert response.state == cloud_speech.Recognizer.State.ACTIVE + assert response.etag == "etag_value" + assert response.reconciling is True + assert response.kms_key_name == "kms_key_name_value" + assert response.kms_key_version_name == "kms_key_version_name_value" + + +def test_get_recognizer_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_recognizer), "__call__") as call: + client.get_recognizer() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetRecognizerRequest() + + +@pytest.mark.asyncio +async def test_get_recognizer_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.GetRecognizerRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_recognizer), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.Recognizer( + name="name_value", + uid="uid_value", + display_name="display_name_value", + model="model_value", + language_codes=["language_codes_value"], + state=cloud_speech.Recognizer.State.ACTIVE, + etag="etag_value", + reconciling=True, + kms_key_name="kms_key_name_value", + kms_key_version_name="kms_key_version_name_value", + ) + ) + response = await client.get_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Recognizer) + assert response.name == "name_value" + assert response.uid == "uid_value" + assert response.display_name == "display_name_value" + assert response.model == "model_value" + assert response.language_codes == ["language_codes_value"] + assert response.state == cloud_speech.Recognizer.State.ACTIVE + assert response.etag == "etag_value" + assert response.reconciling is True + assert response.kms_key_name == "kms_key_name_value" + assert response.kms_key_version_name == "kms_key_version_name_value" + + +@pytest.mark.asyncio +async def test_get_recognizer_async_from_dict(): + await test_get_recognizer_async(request_type=dict) + + +def test_get_recognizer_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.GetRecognizerRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_recognizer), "__call__") as call: + call.return_value = cloud_speech.Recognizer() + client.get_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_recognizer_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.GetRecognizerRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_recognizer), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.Recognizer() + ) + await client.get_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_get_recognizer_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_recognizer), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Recognizer() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_recognizer( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_get_recognizer_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_recognizer( + cloud_speech.GetRecognizerRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_recognizer_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_recognizer), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Recognizer() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.Recognizer() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_recognizer( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_get_recognizer_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_recognizer( + cloud_speech.GetRecognizerRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.UpdateRecognizerRequest, + dict, + ], +) +def test_update_recognizer(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.update_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_recognizer_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_recognizer), "__call__" + ) as call: + client.update_recognizer() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateRecognizerRequest() + + +@pytest.mark.asyncio +async def test_update_recognizer_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.UpdateRecognizerRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.update_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_recognizer_async_from_dict(): + await test_update_recognizer_async(request_type=dict) + + +def test_update_recognizer_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UpdateRecognizerRequest() + + request.recognizer.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_recognizer), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.update_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "recognizer.name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_update_recognizer_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UpdateRecognizerRequest() + + request.recognizer.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_recognizer), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.update_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "recognizer.name=name_value", + ) in kw["metadata"] + + +def test_update_recognizer_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_recognizer( + recognizer=cloud_speech.Recognizer(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].recognizer + mock_val = cloud_speech.Recognizer(name="name_value") + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +def test_update_recognizer_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_recognizer( + cloud_speech.UpdateRecognizerRequest(), + recognizer=cloud_speech.Recognizer(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.asyncio +async def test_update_recognizer_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_recognizer( + recognizer=cloud_speech.Recognizer(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].recognizer + mock_val = cloud_speech.Recognizer(name="name_value") + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_update_recognizer_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_recognizer( + cloud_speech.UpdateRecognizerRequest(), + recognizer=cloud_speech.Recognizer(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.DeleteRecognizerRequest, + dict, + ], +) +def test_delete_recognizer(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.delete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeleteRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_recognizer_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), "__call__" + ) as call: + client.delete_recognizer() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeleteRecognizerRequest() + + +@pytest.mark.asyncio +async def test_delete_recognizer_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.DeleteRecognizerRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.delete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeleteRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_recognizer_async_from_dict(): + await test_delete_recognizer_async(request_type=dict) + + +def test_delete_recognizer_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.DeleteRecognizerRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.delete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_delete_recognizer_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.DeleteRecognizerRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.delete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_delete_recognizer_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_recognizer( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_delete_recognizer_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_recognizer( + cloud_speech.DeleteRecognizerRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_delete_recognizer_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_recognizer( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_delete_recognizer_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_recognizer( + cloud_speech.DeleteRecognizerRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.UndeleteRecognizerRequest, + dict, + ], +) +def test_undelete_recognizer(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.undelete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeleteRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_undelete_recognizer_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_recognizer), "__call__" + ) as call: + client.undelete_recognizer() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeleteRecognizerRequest() + + +@pytest.mark.asyncio +async def test_undelete_recognizer_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.UndeleteRecognizerRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.undelete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeleteRecognizerRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_undelete_recognizer_async_from_dict(): + await test_undelete_recognizer_async(request_type=dict) + + +def test_undelete_recognizer_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UndeleteRecognizerRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_recognizer), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.undelete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_undelete_recognizer_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UndeleteRecognizerRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_recognizer), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.undelete_recognizer(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_undelete_recognizer_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.undelete_recognizer( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_undelete_recognizer_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.undelete_recognizer( + cloud_speech.UndeleteRecognizerRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_undelete_recognizer_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_recognizer), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.undelete_recognizer( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_undelete_recognizer_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.undelete_recognizer( + cloud_speech.UndeleteRecognizerRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.RecognizeRequest, + dict, + ], +) +def test_recognize(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.recognize), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + response = client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + + +def test_recognize_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.recognize), "__call__") as call: + client.recognize() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + +@pytest.mark.asyncio +async def test_recognize_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.RecognizeRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.recognize), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.RecognizeResponse() + ) + response = await client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + + +@pytest.mark.asyncio +async def test_recognize_async_from_dict(): + await test_recognize_async(request_type=dict) + + +def test_recognize_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.RecognizeRequest() + + request.recognizer = "recognizer_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.recognize), "__call__") as call: + call.return_value = cloud_speech.RecognizeResponse() + client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "recognizer=recognizer_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_recognize_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.RecognizeRequest() + + request.recognizer = "recognizer_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.recognize), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.RecognizeResponse() + ) + await client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "recognizer=recognizer_value", + ) in kw["metadata"] + + +def test_recognize_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.recognize), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.recognize( + recognizer="recognizer_value", + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + content=b"content_blob", + uri="uri_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].recognizer + mock_val = "recognizer_value" + assert arg == mock_val + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(auto_decoding_config=None) + assert arg == mock_val + arg = args[0].config_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + assert args[0].uri == "uri_value" + + +def test_recognize_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.recognize( + cloud_speech.RecognizeRequest(), + recognizer="recognizer_value", + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + content=b"content_blob", + uri="uri_value", + ) + + +@pytest.mark.asyncio +async def test_recognize_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.recognize), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.RecognizeResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.recognize( + recognizer="recognizer_value", + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + content=b"content_blob", + uri="uri_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].recognizer + mock_val = "recognizer_value" + assert arg == mock_val + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(auto_decoding_config=None) + assert arg == mock_val + arg = args[0].config_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + assert args[0].uri == "uri_value" + + +@pytest.mark.asyncio +async def test_recognize_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.recognize( + cloud_speech.RecognizeRequest(), + recognizer="recognizer_value", + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + content=b"content_blob", + uri="uri_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.StreamingRecognizeRequest, + dict, + ], +) +def test_streaming_recognize(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + requests = [request] + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.streaming_recognize), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = iter([cloud_speech.StreamingRecognizeResponse()]) + response = client.streaming_recognize(iter(requests)) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert next(args[0]) == request + + # Establish that the response is the type that we expect. + for message in response: + assert isinstance(message, cloud_speech.StreamingRecognizeResponse) + + +@pytest.mark.asyncio +async def test_streaming_recognize_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.StreamingRecognizeRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + requests = [request] + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.streaming_recognize), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = mock.Mock(aio.StreamStreamCall, autospec=True) + call.return_value.read = mock.AsyncMock( + side_effect=[cloud_speech.StreamingRecognizeResponse()] + ) + response = await client.streaming_recognize(iter(requests)) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert next(args[0]) == request + + # Establish that the response is the type that we expect. + message = await response.read() + assert isinstance(message, cloud_speech.StreamingRecognizeResponse) + + +@pytest.mark.asyncio +async def test_streaming_recognize_async_from_dict(): + await test_streaming_recognize_async(request_type=dict) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.BatchRecognizeRequest, + dict, + ], +) +def test_batch_recognize(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.batch_recognize), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.batch_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.BatchRecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_batch_recognize_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.batch_recognize), "__call__") as call: + client.batch_recognize() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.BatchRecognizeRequest() + + +@pytest.mark.asyncio +async def test_batch_recognize_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.BatchRecognizeRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.batch_recognize), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.batch_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.BatchRecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_batch_recognize_async_from_dict(): + await test_batch_recognize_async(request_type=dict) + + +def test_batch_recognize_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.BatchRecognizeRequest() + + request.recognizer = "recognizer_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.batch_recognize), "__call__") as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.batch_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "recognizer=recognizer_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_batch_recognize_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.BatchRecognizeRequest() + + request.recognizer = "recognizer_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.batch_recognize), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.batch_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "recognizer=recognizer_value", + ) in kw["metadata"] + + +def test_batch_recognize_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.batch_recognize), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.batch_recognize( + recognizer="recognizer_value", + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + files=[cloud_speech.BatchRecognizeFileMetadata(uri="uri_value")], + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].recognizer + mock_val = "recognizer_value" + assert arg == mock_val + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(auto_decoding_config=None) + assert arg == mock_val + arg = args[0].config_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + arg = args[0].files + mock_val = [cloud_speech.BatchRecognizeFileMetadata(uri="uri_value")] + assert arg == mock_val + + +def test_batch_recognize_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.batch_recognize( + cloud_speech.BatchRecognizeRequest(), + recognizer="recognizer_value", + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + files=[cloud_speech.BatchRecognizeFileMetadata(uri="uri_value")], + ) + + +@pytest.mark.asyncio +async def test_batch_recognize_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.batch_recognize), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.batch_recognize( + recognizer="recognizer_value", + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + files=[cloud_speech.BatchRecognizeFileMetadata(uri="uri_value")], + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].recognizer + mock_val = "recognizer_value" + assert arg == mock_val + arg = args[0].config + mock_val = cloud_speech.RecognitionConfig(auto_decoding_config=None) + assert arg == mock_val + arg = args[0].config_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + arg = args[0].files + mock_val = [cloud_speech.BatchRecognizeFileMetadata(uri="uri_value")] + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_batch_recognize_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.batch_recognize( + cloud_speech.BatchRecognizeRequest(), + recognizer="recognizer_value", + config=cloud_speech.RecognitionConfig(auto_decoding_config=None), + config_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + files=[cloud_speech.BatchRecognizeFileMetadata(uri="uri_value")], + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.GetConfigRequest, + dict, + ], +) +def test_get_config(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_config), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Config( + name="name_value", + kms_key_name="kms_key_name_value", + ) + response = client.get_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Config) + assert response.name == "name_value" + assert response.kms_key_name == "kms_key_name_value" + + +def test_get_config_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_config), "__call__") as call: + client.get_config() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetConfigRequest() + + +@pytest.mark.asyncio +async def test_get_config_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.GetConfigRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_config), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.Config( + name="name_value", + kms_key_name="kms_key_name_value", + ) + ) + response = await client.get_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Config) + assert response.name == "name_value" + assert response.kms_key_name == "kms_key_name_value" + + +@pytest.mark.asyncio +async def test_get_config_async_from_dict(): + await test_get_config_async(request_type=dict) + + +def test_get_config_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.GetConfigRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_config), "__call__") as call: + call.return_value = cloud_speech.Config() + client.get_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_config_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.GetConfigRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_config), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Config()) + await client.get_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_get_config_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_config), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Config() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_config( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_get_config_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_config( + cloud_speech.GetConfigRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_config_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_config), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Config() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Config()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_config( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_get_config_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_config( + cloud_speech.GetConfigRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.UpdateConfigRequest, + dict, + ], +) +def test_update_config(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_config), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Config( + name="name_value", + kms_key_name="kms_key_name_value", + ) + response = client.update_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Config) + assert response.name == "name_value" + assert response.kms_key_name == "kms_key_name_value" + + +def test_update_config_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_config), "__call__") as call: + client.update_config() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateConfigRequest() + + +@pytest.mark.asyncio +async def test_update_config_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.UpdateConfigRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_config), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.Config( + name="name_value", + kms_key_name="kms_key_name_value", + ) + ) + response = await client.update_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateConfigRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.Config) + assert response.name == "name_value" + assert response.kms_key_name == "kms_key_name_value" + + +@pytest.mark.asyncio +async def test_update_config_async_from_dict(): + await test_update_config_async(request_type=dict) + + +def test_update_config_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UpdateConfigRequest() + + request.config.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_config), "__call__") as call: + call.return_value = cloud_speech.Config() + client.update_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "config.name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_update_config_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UpdateConfigRequest() + + request.config.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_config), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Config()) + await client.update_config(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "config.name=name_value", + ) in kw["metadata"] + + +def test_update_config_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_config), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Config() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_config( + config=cloud_speech.Config(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].config + mock_val = cloud_speech.Config(name="name_value") + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +def test_update_config_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_config( + cloud_speech.UpdateConfigRequest(), + config=cloud_speech.Config(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.asyncio +async def test_update_config_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.update_config), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.Config() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.Config()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_config( + config=cloud_speech.Config(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].config + mock_val = cloud_speech.Config(name="name_value") + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_update_config_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_config( + cloud_speech.UpdateConfigRequest(), + config=cloud_speech.Config(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.CreateCustomClassRequest, + dict, + ], +) +def test_create_custom_class(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.create_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_custom_class_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), "__call__" + ) as call: + client.create_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreateCustomClassRequest() + + +@pytest.mark.asyncio +async def test_create_custom_class_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.CreateCustomClassRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.create_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_custom_class_async_from_dict(): + await test_create_custom_class_async(request_type=dict) + + +def test_create_custom_class_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.CreateCustomClassRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.create_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_create_custom_class_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.CreateCustomClassRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.create_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +def test_create_custom_class_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_custom_class( + parent="parent_value", + custom_class=cloud_speech.CustomClass(name="name_value"), + custom_class_id="custom_class_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + arg = args[0].custom_class + mock_val = cloud_speech.CustomClass(name="name_value") + assert arg == mock_val + arg = args[0].custom_class_id + mock_val = "custom_class_id_value" + assert arg == mock_val + + +def test_create_custom_class_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_custom_class( + cloud_speech.CreateCustomClassRequest(), + parent="parent_value", + custom_class=cloud_speech.CustomClass(name="name_value"), + custom_class_id="custom_class_id_value", + ) + + +@pytest.mark.asyncio +async def test_create_custom_class_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_custom_class( + parent="parent_value", + custom_class=cloud_speech.CustomClass(name="name_value"), + custom_class_id="custom_class_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + arg = args[0].custom_class + mock_val = cloud_speech.CustomClass(name="name_value") + assert arg == mock_val + arg = args[0].custom_class_id + mock_val = "custom_class_id_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_create_custom_class_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_custom_class( + cloud_speech.CreateCustomClassRequest(), + parent="parent_value", + custom_class=cloud_speech.CustomClass(name="name_value"), + custom_class_id="custom_class_id_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.ListCustomClassesRequest, + dict, + ], +) +def test_list_custom_classes(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListCustomClassesResponse( + next_page_token="next_page_token_value", + ) + response = client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListCustomClassesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_custom_classes_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), "__call__" + ) as call: + client.list_custom_classes() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListCustomClassesRequest() + + +@pytest.mark.asyncio +async def test_list_custom_classes_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.ListCustomClassesRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.ListCustomClassesResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListCustomClassesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_custom_classes_async_from_dict(): + await test_list_custom_classes_async(request_type=dict) + + +def test_list_custom_classes_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.ListCustomClassesRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), "__call__" + ) as call: + call.return_value = cloud_speech.ListCustomClassesResponse() + client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_custom_classes_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.ListCustomClassesRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.ListCustomClassesResponse() + ) + await client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +def test_list_custom_classes_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListCustomClassesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_custom_classes( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +def test_list_custom_classes_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_custom_classes( + cloud_speech.ListCustomClassesRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_custom_classes_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListCustomClassesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.ListCustomClassesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_custom_classes( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_list_custom_classes_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_custom_classes( + cloud_speech.ListCustomClassesRequest(), + parent="parent_value", + ) + + +def test_list_custom_classes_pager(transport_name: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + next_page_token="abc", + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[], + next_page_token="def", + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + ], + next_page_token="ghi", + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_custom_classes(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_speech.CustomClass) for i in results) + + +def test_list_custom_classes_pages(transport_name: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + next_page_token="abc", + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[], + next_page_token="def", + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + ], + next_page_token="ghi", + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + ), + RuntimeError, + ) + pages = list(client.list_custom_classes(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_custom_classes_async_pager(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + next_page_token="abc", + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[], + next_page_token="def", + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + ], + next_page_token="ghi", + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_custom_classes( + request={}, + ) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_speech.CustomClass) for i in responses) + + +@pytest.mark.asyncio +async def test_list_custom_classes_async_pages(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + next_page_token="abc", + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[], + next_page_token="def", + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + ], + next_page_token="ghi", + ), + cloud_speech.ListCustomClassesResponse( + custom_classes=[ + cloud_speech.CustomClass(), + cloud_speech.CustomClass(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in ( + await client.list_custom_classes(request={}) + ).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.GetCustomClassRequest, + dict, + ], +) +def test_get_custom_class(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_custom_class), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.CustomClass( + name="name_value", + uid="uid_value", + display_name="display_name_value", + state=cloud_speech.CustomClass.State.ACTIVE, + etag="etag_value", + reconciling=True, + kms_key_name="kms_key_name_value", + kms_key_version_name="kms_key_version_name_value", + ) + response = client.get_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.CustomClass) + assert response.name == "name_value" + assert response.uid == "uid_value" + assert response.display_name == "display_name_value" + assert response.state == cloud_speech.CustomClass.State.ACTIVE + assert response.etag == "etag_value" + assert response.reconciling is True + assert response.kms_key_name == "kms_key_name_value" + assert response.kms_key_version_name == "kms_key_version_name_value" + + +def test_get_custom_class_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_custom_class), "__call__") as call: + client.get_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetCustomClassRequest() + + +@pytest.mark.asyncio +async def test_get_custom_class_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.GetCustomClassRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_custom_class), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.CustomClass( + name="name_value", + uid="uid_value", + display_name="display_name_value", + state=cloud_speech.CustomClass.State.ACTIVE, + etag="etag_value", + reconciling=True, + kms_key_name="kms_key_name_value", + kms_key_version_name="kms_key_version_name_value", + ) + ) + response = await client.get_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.CustomClass) + assert response.name == "name_value" + assert response.uid == "uid_value" + assert response.display_name == "display_name_value" + assert response.state == cloud_speech.CustomClass.State.ACTIVE + assert response.etag == "etag_value" + assert response.reconciling is True + assert response.kms_key_name == "kms_key_name_value" + assert response.kms_key_version_name == "kms_key_version_name_value" + + +@pytest.mark.asyncio +async def test_get_custom_class_async_from_dict(): + await test_get_custom_class_async(request_type=dict) + + +def test_get_custom_class_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.GetCustomClassRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_custom_class), "__call__") as call: + call.return_value = cloud_speech.CustomClass() + client.get_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_custom_class_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.GetCustomClassRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_custom_class), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.CustomClass() + ) + await client.get_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_get_custom_class_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_custom_class), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.CustomClass() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_custom_class( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_get_custom_class_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_custom_class( + cloud_speech.GetCustomClassRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_custom_class_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_custom_class), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.CustomClass() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.CustomClass() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_custom_class( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_get_custom_class_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_custom_class( + cloud_speech.GetCustomClassRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.UpdateCustomClassRequest, + dict, + ], +) +def test_update_custom_class(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.update_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_custom_class_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), "__call__" + ) as call: + client.update_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateCustomClassRequest() + + +@pytest.mark.asyncio +async def test_update_custom_class_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.UpdateCustomClassRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.update_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_custom_class_async_from_dict(): + await test_update_custom_class_async(request_type=dict) + + +def test_update_custom_class_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UpdateCustomClassRequest() + + request.custom_class.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.update_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "custom_class.name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_update_custom_class_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UpdateCustomClassRequest() + + request.custom_class.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.update_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "custom_class.name=name_value", + ) in kw["metadata"] + + +def test_update_custom_class_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_custom_class( + custom_class=cloud_speech.CustomClass(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].custom_class + mock_val = cloud_speech.CustomClass(name="name_value") + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +def test_update_custom_class_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_custom_class( + cloud_speech.UpdateCustomClassRequest(), + custom_class=cloud_speech.CustomClass(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.asyncio +async def test_update_custom_class_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_custom_class( + custom_class=cloud_speech.CustomClass(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].custom_class + mock_val = cloud_speech.CustomClass(name="name_value") + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_update_custom_class_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_custom_class( + cloud_speech.UpdateCustomClassRequest(), + custom_class=cloud_speech.CustomClass(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.DeleteCustomClassRequest, + dict, + ], +) +def test_delete_custom_class(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_custom_class_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), "__call__" + ) as call: + client.delete_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeleteCustomClassRequest() + + +@pytest.mark.asyncio +async def test_delete_custom_class_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.DeleteCustomClassRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_custom_class_async_from_dict(): + await test_delete_custom_class_async(request_type=dict) + + +def test_delete_custom_class_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.DeleteCustomClassRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_delete_custom_class_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.DeleteCustomClassRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_delete_custom_class_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_custom_class( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_delete_custom_class_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_custom_class( + cloud_speech.DeleteCustomClassRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_delete_custom_class_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_custom_class( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_delete_custom_class_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_custom_class( + cloud_speech.DeleteCustomClassRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.UndeleteCustomClassRequest, + dict, + ], +) +def test_undelete_custom_class(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.undelete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_undelete_custom_class_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_custom_class), "__call__" + ) as call: + client.undelete_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeleteCustomClassRequest() + + +@pytest.mark.asyncio +async def test_undelete_custom_class_async( + transport: str = "grpc_asyncio", + request_type=cloud_speech.UndeleteCustomClassRequest, +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.undelete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_undelete_custom_class_async_from_dict(): + await test_undelete_custom_class_async(request_type=dict) + + +def test_undelete_custom_class_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UndeleteCustomClassRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_custom_class), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.undelete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_undelete_custom_class_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UndeleteCustomClassRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_custom_class), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.undelete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_undelete_custom_class_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.undelete_custom_class( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_undelete_custom_class_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.undelete_custom_class( + cloud_speech.UndeleteCustomClassRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_undelete_custom_class_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_custom_class), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.undelete_custom_class( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_undelete_custom_class_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.undelete_custom_class( + cloud_speech.UndeleteCustomClassRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.CreatePhraseSetRequest, + dict, + ], +) +def test_create_phrase_set(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.create_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_create_phrase_set_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), "__call__" + ) as call: + client.create_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreatePhraseSetRequest() + + +@pytest.mark.asyncio +async def test_create_phrase_set_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.CreatePhraseSetRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.create_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.CreatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_create_phrase_set_async_from_dict(): + await test_create_phrase_set_async(request_type=dict) + + +def test_create_phrase_set_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.CreatePhraseSetRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.create_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_create_phrase_set_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.CreatePhraseSetRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.create_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +def test_create_phrase_set_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_phrase_set( + parent="parent_value", + phrase_set=cloud_speech.PhraseSet(name="name_value"), + phrase_set_id="phrase_set_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + arg = args[0].phrase_set + mock_val = cloud_speech.PhraseSet(name="name_value") + assert arg == mock_val + arg = args[0].phrase_set_id + mock_val = "phrase_set_id_value" + assert arg == mock_val + + +def test_create_phrase_set_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_phrase_set( + cloud_speech.CreatePhraseSetRequest(), + parent="parent_value", + phrase_set=cloud_speech.PhraseSet(name="name_value"), + phrase_set_id="phrase_set_id_value", + ) + + +@pytest.mark.asyncio +async def test_create_phrase_set_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_phrase_set( + parent="parent_value", + phrase_set=cloud_speech.PhraseSet(name="name_value"), + phrase_set_id="phrase_set_id_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + arg = args[0].phrase_set + mock_val = cloud_speech.PhraseSet(name="name_value") + assert arg == mock_val + arg = args[0].phrase_set_id + mock_val = "phrase_set_id_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_create_phrase_set_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_phrase_set( + cloud_speech.CreatePhraseSetRequest(), + parent="parent_value", + phrase_set=cloud_speech.PhraseSet(name="name_value"), + phrase_set_id="phrase_set_id_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.ListPhraseSetsRequest, + dict, + ], +) +def test_list_phrase_sets(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_phrase_sets), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListPhraseSetsResponse( + next_page_token="next_page_token_value", + ) + response = client.list_phrase_sets(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListPhraseSetsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_phrase_sets_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_phrase_sets), "__call__") as call: + client.list_phrase_sets() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListPhraseSetsRequest() + + +@pytest.mark.asyncio +async def test_list_phrase_sets_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.ListPhraseSetsRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_phrase_sets), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.ListPhraseSetsResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_phrase_sets(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.ListPhraseSetsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetsAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_phrase_sets_async_from_dict(): + await test_list_phrase_sets_async(request_type=dict) + + +def test_list_phrase_sets_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.ListPhraseSetsRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_phrase_sets), "__call__") as call: + call.return_value = cloud_speech.ListPhraseSetsResponse() + client.list_phrase_sets(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_phrase_sets_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.ListPhraseSetsRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_phrase_sets), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.ListPhraseSetsResponse() + ) + await client.list_phrase_sets(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +def test_list_phrase_sets_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_phrase_sets), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListPhraseSetsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_phrase_sets( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +def test_list_phrase_sets_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_phrase_sets( + cloud_speech.ListPhraseSetsRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_phrase_sets_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_phrase_sets), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.ListPhraseSetsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.ListPhraseSetsResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_phrase_sets( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_list_phrase_sets_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_phrase_sets( + cloud_speech.ListPhraseSetsRequest(), + parent="parent_value", + ) + + +def test_list_phrase_sets_pager(transport_name: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_phrase_sets), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + next_page_token="abc", + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[], + next_page_token="def", + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + ], + next_page_token="ghi", + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_phrase_sets(request={}) + + assert pager._metadata == metadata + + results = list(pager) + assert len(results) == 6 + assert all(isinstance(i, cloud_speech.PhraseSet) for i in results) + + +def test_list_phrase_sets_pages(transport_name: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials, + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_phrase_sets), "__call__") as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + next_page_token="abc", + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[], + next_page_token="def", + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + ], + next_page_token="ghi", + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + ), + RuntimeError, + ) + pages = list(client.list_phrase_sets(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_phrase_sets_async_pager(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + next_page_token="abc", + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[], + next_page_token="def", + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + ], + next_page_token="ghi", + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_phrase_sets( + request={}, + ) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, cloud_speech.PhraseSet) for i in responses) + + +@pytest.mark.asyncio +async def test_list_phrase_sets_async_pages(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_sets), "__call__", new_callable=mock.AsyncMock + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + next_page_token="abc", + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[], + next_page_token="def", + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + ], + next_page_token="ghi", + ), + cloud_speech.ListPhraseSetsResponse( + phrase_sets=[ + cloud_speech.PhraseSet(), + cloud_speech.PhraseSet(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in ( + await client.list_phrase_sets(request={}) + ).pages: # pragma: no branch + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.GetPhraseSetRequest, + dict, + ], +) +def test_get_phrase_set(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_phrase_set), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.PhraseSet( + name="name_value", + uid="uid_value", + boost=0.551, + display_name="display_name_value", + state=cloud_speech.PhraseSet.State.ACTIVE, + etag="etag_value", + reconciling=True, + kms_key_name="kms_key_name_value", + kms_key_version_name="kms_key_version_name_value", + ) + response = client.get_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.PhraseSet) + assert response.name == "name_value" + assert response.uid == "uid_value" + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + assert response.display_name == "display_name_value" + assert response.state == cloud_speech.PhraseSet.State.ACTIVE + assert response.etag == "etag_value" + assert response.reconciling is True + assert response.kms_key_name == "kms_key_name_value" + assert response.kms_key_version_name == "kms_key_version_name_value" + + +def test_get_phrase_set_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_phrase_set), "__call__") as call: + client.get_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetPhraseSetRequest() + + +@pytest.mark.asyncio +async def test_get_phrase_set_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.GetPhraseSetRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_phrase_set), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.PhraseSet( + name="name_value", + uid="uid_value", + boost=0.551, + display_name="display_name_value", + state=cloud_speech.PhraseSet.State.ACTIVE, + etag="etag_value", + reconciling=True, + kms_key_name="kms_key_name_value", + kms_key_version_name="kms_key_version_name_value", + ) + ) + response = await client.get_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.GetPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.PhraseSet) + assert response.name == "name_value" + assert response.uid == "uid_value" + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + assert response.display_name == "display_name_value" + assert response.state == cloud_speech.PhraseSet.State.ACTIVE + assert response.etag == "etag_value" + assert response.reconciling is True + assert response.kms_key_name == "kms_key_name_value" + assert response.kms_key_version_name == "kms_key_version_name_value" + + +@pytest.mark.asyncio +async def test_get_phrase_set_async_from_dict(): + await test_get_phrase_set_async(request_type=dict) + + +def test_get_phrase_set_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.GetPhraseSetRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_phrase_set), "__call__") as call: + call.return_value = cloud_speech.PhraseSet() + client.get_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_phrase_set_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.GetPhraseSetRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_phrase_set), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.PhraseSet() + ) + await client.get_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_get_phrase_set_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_phrase_set), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.PhraseSet() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_phrase_set( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_get_phrase_set_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_phrase_set( + cloud_speech.GetPhraseSetRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_phrase_set_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_phrase_set), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.PhraseSet() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + cloud_speech.PhraseSet() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_phrase_set( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_get_phrase_set_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_phrase_set( + cloud_speech.GetPhraseSetRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.UpdatePhraseSetRequest, + dict, + ], +) +def test_update_phrase_set(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.update_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_update_phrase_set_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), "__call__" + ) as call: + client.update_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdatePhraseSetRequest() + + +@pytest.mark.asyncio +async def test_update_phrase_set_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.UpdatePhraseSetRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.update_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UpdatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_update_phrase_set_async_from_dict(): + await test_update_phrase_set_async(request_type=dict) + + +def test_update_phrase_set_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UpdatePhraseSetRequest() + + request.phrase_set.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.update_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "phrase_set.name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_update_phrase_set_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UpdatePhraseSetRequest() + + request.phrase_set.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.update_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "phrase_set.name=name_value", + ) in kw["metadata"] + + +def test_update_phrase_set_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_phrase_set( + phrase_set=cloud_speech.PhraseSet(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].phrase_set + mock_val = cloud_speech.PhraseSet(name="name_value") + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +def test_update_phrase_set_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_phrase_set( + cloud_speech.UpdatePhraseSetRequest(), + phrase_set=cloud_speech.PhraseSet(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.asyncio +async def test_update_phrase_set_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_phrase_set( + phrase_set=cloud_speech.PhraseSet(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].phrase_set + mock_val = cloud_speech.PhraseSet(name="name_value") + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_update_phrase_set_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_phrase_set( + cloud_speech.UpdatePhraseSetRequest(), + phrase_set=cloud_speech.PhraseSet(name="name_value"), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.DeletePhraseSetRequest, + dict, + ], +) +def test_delete_phrase_set(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_delete_phrase_set_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), "__call__" + ) as call: + client.delete_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeletePhraseSetRequest() + + +@pytest.mark.asyncio +async def test_delete_phrase_set_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.DeletePhraseSetRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.DeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_delete_phrase_set_async_from_dict(): + await test_delete_phrase_set_async(request_type=dict) + + +def test_delete_phrase_set_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.DeletePhraseSetRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_delete_phrase_set_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.DeletePhraseSetRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_delete_phrase_set_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_phrase_set( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_delete_phrase_set_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_phrase_set( + cloud_speech.DeletePhraseSetRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_delete_phrase_set_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_phrase_set( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_delete_phrase_set_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_phrase_set( + cloud_speech.DeletePhraseSetRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + cloud_speech.UndeletePhraseSetRequest, + dict, + ], +) +def test_undelete_phrase_set(request_type, transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/spam") + response = client.undelete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_undelete_phrase_set_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_phrase_set), "__call__" + ) as call: + client.undelete_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeletePhraseSetRequest() + + +@pytest.mark.asyncio +async def test_undelete_phrase_set_async( + transport: str = "grpc_asyncio", request_type=cloud_speech.UndeletePhraseSetRequest +): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + response = await client.undelete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.UndeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_undelete_phrase_set_async_from_dict(): + await test_undelete_phrase_set_async(request_type=dict) + + +def test_undelete_phrase_set_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UndeletePhraseSetRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_phrase_set), "__call__" + ) as call: + call.return_value = operations_pb2.Operation(name="operations/op") + client.undelete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_undelete_phrase_set_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = cloud_speech.UndeletePhraseSetRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_phrase_set), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/op") + ) + await client.undelete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_undelete_phrase_set_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.undelete_phrase_set( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_undelete_phrase_set_flattened_error(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.undelete_phrase_set( + cloud_speech.UndeletePhraseSetRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_undelete_phrase_set_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.undelete_phrase_set), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name="operations/op") + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation(name="operations/spam") + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.undelete_phrase_set( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_undelete_phrase_set_flattened_error_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.undelete_phrase_set( + cloud_speech.UndeletePhraseSetRequest(), + name="name_value", + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = SpeechClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = SpeechClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = SpeechClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.SpeechGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + ], +) +def test_transport_kind(transport_name): + transport = SpeechClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.SpeechGrpcTransport, + ) + + +def test_speech_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.SpeechTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_speech_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.cloud.speech_v2.services.speech.transports.SpeechTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.SpeechTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "create_recognizer", + "list_recognizers", + "get_recognizer", + "update_recognizer", + "delete_recognizer", + "undelete_recognizer", + "recognize", + "streaming_recognize", + "batch_recognize", + "get_config", + "update_config", + "create_custom_class", + "list_custom_classes", + "get_custom_class", + "update_custom_class", + "delete_custom_class", + "undelete_custom_class", + "create_phrase_set", + "list_phrase_sets", + "get_phrase_set", + "update_phrase_set", + "delete_phrase_set", + "undelete_phrase_set", + "get_operation", + "cancel_operation", + "delete_operation", + "list_operations", + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_speech_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.cloud.speech_v2.services.speech.transports.SpeechTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +def test_speech_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( + "google.cloud.speech_v2.services.speech.transports.SpeechTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport() + adc.assert_called_once() + + +def test_speech_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + SpeechClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + ], +) +def test_speech_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + ], +) +def test_speech_transport_auth_gdch_credentials(transport_class): + host = "https://language.com" + api_audience_tests = [None, "https://language2.com"] + api_audience_expect = [host, "https://language2.com"] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, "default", autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock( + return_value=gdch_mock + ) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with(e) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.SpeechGrpcTransport, grpc_helpers), + (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async), + ], +) +def test_speech_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + + create_channel.assert_called_with( + "speech.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=("https://www.googleapis.com/auth/cloud-platform",), + scopes=["1", "2"], + default_host="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class", + [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport], +) +def test_speech_grpc_transport_client_cert_source_for_mtls(transport_class): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds, + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback, + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, private_key=expected_key + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + ], +) +def test_speech_host_no_port(transport_name): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="speech.googleapis.com" + ), + transport=transport_name, + ) + assert client.transport._host == ("speech.googleapis.com:443") + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + ], +) +def test_speech_host_with_port(transport_name): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="speech.googleapis.com:8000" + ), + transport=transport_name, + ) + assert client.transport._host == ("speech.googleapis.com:8000") + + +def test_speech_grpc_transport_channel(): + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SpeechGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_speech_grpc_asyncio_transport_channel(): + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SpeechGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport], +) +def test_speech_transport_channel_mtls_with_client_cert_source(transport_class): + with mock.patch( + "grpc.ssl_channel_credentials", autospec=True + ) as grpc_ssl_channel_cred: + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport], +) +def test_speech_transport_channel_mtls_with_adc(transport_class): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_speech_grpc_lro_client(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_speech_grpc_lro_async_client(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + transport = client.transport + + # Ensure that we have a api-core operations client. + assert isinstance( + transport.operations_client, + operations_v1.OperationsAsyncClient, + ) + + # Ensure that subsequent calls to the property send the exact same object. + assert transport.operations_client is transport.operations_client + + +def test_config_path(): + project = "squid" + location = "clam" + expected = "projects/{project}/locations/{location}/config".format( + project=project, + location=location, + ) + actual = SpeechClient.config_path(project, location) + assert expected == actual + + +def test_parse_config_path(): + expected = { + "project": "whelk", + "location": "octopus", + } + path = SpeechClient.config_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_config_path(path) + assert expected == actual + + +def test_crypto_key_path(): + project = "oyster" + location = "nudibranch" + key_ring = "cuttlefish" + crypto_key = "mussel" + expected = "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}".format( + project=project, + location=location, + key_ring=key_ring, + crypto_key=crypto_key, + ) + actual = SpeechClient.crypto_key_path(project, location, key_ring, crypto_key) + assert expected == actual + + +def test_parse_crypto_key_path(): + expected = { + "project": "winkle", + "location": "nautilus", + "key_ring": "scallop", + "crypto_key": "abalone", + } + path = SpeechClient.crypto_key_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_crypto_key_path(path) + assert expected == actual + + +def test_crypto_key_version_path(): + project = "squid" + location = "clam" + key_ring = "whelk" + crypto_key = "octopus" + crypto_key_version = "oyster" + expected = "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}".format( + project=project, + location=location, + key_ring=key_ring, + crypto_key=crypto_key, + crypto_key_version=crypto_key_version, + ) + actual = SpeechClient.crypto_key_version_path( + project, location, key_ring, crypto_key, crypto_key_version + ) + assert expected == actual + + +def test_parse_crypto_key_version_path(): + expected = { + "project": "nudibranch", + "location": "cuttlefish", + "key_ring": "mussel", + "crypto_key": "winkle", + "crypto_key_version": "nautilus", + } + path = SpeechClient.crypto_key_version_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_crypto_key_version_path(path) + assert expected == actual + + +def test_custom_class_path(): + project = "scallop" + location = "abalone" + custom_class = "squid" + expected = ( + "projects/{project}/locations/{location}/customClasses/{custom_class}".format( + project=project, + location=location, + custom_class=custom_class, + ) + ) + actual = SpeechClient.custom_class_path(project, location, custom_class) + assert expected == actual + + +def test_parse_custom_class_path(): + expected = { + "project": "clam", + "location": "whelk", + "custom_class": "octopus", + } + path = SpeechClient.custom_class_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_custom_class_path(path) + assert expected == actual + + +def test_phrase_set_path(): + project = "oyster" + location = "nudibranch" + phrase_set = "cuttlefish" + expected = "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format( + project=project, + location=location, + phrase_set=phrase_set, + ) + actual = SpeechClient.phrase_set_path(project, location, phrase_set) + assert expected == actual + + +def test_parse_phrase_set_path(): + expected = { + "project": "mussel", + "location": "winkle", + "phrase_set": "nautilus", + } + path = SpeechClient.phrase_set_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_phrase_set_path(path) + assert expected == actual + + +def test_recognizer_path(): + project = "scallop" + location = "abalone" + recognizer = "squid" + expected = ( + "projects/{project}/locations/{location}/recognizers/{recognizer}".format( + project=project, + location=location, + recognizer=recognizer, + ) + ) + actual = SpeechClient.recognizer_path(project, location, recognizer) + assert expected == actual + + +def test_parse_recognizer_path(): + expected = { + "project": "clam", + "location": "whelk", + "recognizer": "octopus", + } + path = SpeechClient.recognizer_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_recognizer_path(path) + assert expected == actual + + +def test_common_billing_account_path(): + billing_account = "oyster" + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = SpeechClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "nudibranch", + } + path = SpeechClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_billing_account_path(path) + assert expected == actual + + +def test_common_folder_path(): + folder = "cuttlefish" + expected = "folders/{folder}".format( + folder=folder, + ) + actual = SpeechClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "mussel", + } + path = SpeechClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_folder_path(path) + assert expected == actual + + +def test_common_organization_path(): + organization = "winkle" + expected = "organizations/{organization}".format( + organization=organization, + ) + actual = SpeechClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nautilus", + } + path = SpeechClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_organization_path(path) + assert expected == actual + + +def test_common_project_path(): + project = "scallop" + expected = "projects/{project}".format( + project=project, + ) + actual = SpeechClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "abalone", + } + path = SpeechClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_project_path(path) + assert expected == actual + + +def test_common_location_path(): + project = "squid" + location = "clam" + expected = "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + actual = SpeechClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "whelk", + "location": "octopus", + } + path = SpeechClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object( + transports.SpeechTransport, "_prep_wrapped_messages" + ) as prep: + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object( + transports.SpeechTransport, "_prep_wrapped_messages" + ) as prep: + transport_class = SpeechClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object( + type(getattr(client.transport, "grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_delete_operation(transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.DeleteOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_operation_async(transport: str = "grpc"): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.DeleteOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_operation_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.DeleteOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + call.return_value = None + + client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=locations", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_delete_operation_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.DeleteOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=locations", + ) in kw["metadata"] + + +def test_delete_operation_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + + response = client.delete_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +@pytest.mark.asyncio +async def test_delete_operation_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.delete_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_cancel_operation(transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.CancelOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_cancel_operation_async(transport: str = "grpc"): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.CancelOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +def test_cancel_operation_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.CancelOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + call.return_value = None + + client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=locations", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_cancel_operation_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.CancelOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.cancel_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=locations", + ) in kw["metadata"] + + +def test_cancel_operation_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = None + + response = client.cancel_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +@pytest.mark.asyncio +async def test_cancel_operation_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.cancel_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.cancel_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_get_operation(transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + response = client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + + +@pytest.mark.asyncio +async def test_get_operation_async(transport: str = "grpc"): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.GetOperationRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.Operation) + + +def test_get_operation_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = operations_pb2.Operation() + + client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=locations", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_get_operation_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.GetOperationRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + await client.get_operation(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=locations", + ) in kw["metadata"] + + +def test_get_operation_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation() + + response = client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +@pytest.mark.asyncio +async def test_get_operation_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.get_operation), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.Operation() + ) + response = await client.get_operation( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_list_operations(transport: str = "grpc"): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + response = client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + + +@pytest.mark.asyncio +async def test_list_operations_async(transport: str = "grpc"): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = operations_pb2.ListOperationsRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, operations_pb2.ListOperationsResponse) + + +def test_list_operations_field_headers(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = operations_pb2.ListOperationsResponse() + + client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=locations", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_operations_field_headers_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = operations_pb2.ListOperationsRequest() + request.name = "locations" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + await client.list_operations(request) + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=locations", + ) in kw["metadata"] + + +def test_list_operations_from_dict(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.ListOperationsResponse() + + response = client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +@pytest.mark.asyncio +async def test_list_operations_from_dict_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.list_operations), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + operations_pb2.ListOperationsResponse() + ) + response = await client.list_operations( + request={ + "name": "locations", + } + ) + call.assert_called() + + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + with mock.patch.object( + type(getattr(client.transport, close_name)), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "grpc", + ] + for transport in transports: + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + + +@pytest.mark.parametrize( + "client_class,transport_class", + [ + (SpeechClient, transports.SpeechGrpcTransport), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport), + ], +) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + )