# Copyright 2018 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 # # https://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. # # EDITING INSTRUCTIONS # This file was generated from the file # https://github.com/googleapis/googleapis/blob/master/google/cloud/speech/v1p1beta1/cloud_speech.proto, # and updates to that file get reflected here through a refresh process. # For the short term, the refresh process will only be runnable by Google # engineers. require "json" require "pathname" require "google/gax" require "google/gax/operation" require "google/longrunning/operations_client" require "google/cloud/speech/v1p1beta1/cloud_speech_pb" require "google/cloud/speech/v1p1beta1/credentials" module Google module Cloud module Speech module V1p1beta1 # Service that implements Google Cloud Speech API. # # @!attribute [r] speech_stub # @return [Google::Cloud::Speech::V1p1beta1::Speech::Stub] class SpeechClient attr_reader :speech_stub # The default address of the service. SERVICE_ADDRESS = "speech.googleapis.com".freeze # The default port of the service. DEFAULT_SERVICE_PORT = 443 DEFAULT_TIMEOUT = 30 # The scopes needed to make gRPC calls to all of the methods defined in # this service. ALL_SCOPES = [ "https://www.googleapis.com/auth/cloud-platform" ].freeze class OperationsClient < Google::Longrunning::OperationsClient self::SERVICE_ADDRESS = SpeechClient::SERVICE_ADDRESS end # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc] # Provides the means for authenticating requests made by the client. This parameter can # be many types. # A `Google::Auth::Credentials` uses a the properties of its represented keyfile for # authenticating requests made by this client. # A `String` will be treated as the path to the keyfile to be used for the construction of # credentials for this client. # A `Hash` will be treated as the contents of a keyfile to be used for the construction of # credentials for this client. # A `GRPC::Core::Channel` will be used to make calls through. # A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials # should already be composed with a `GRPC::Core::CallCredentials` object. # A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the # metadata for requests, generally, to give OAuth credentials. # @param scopes [Array] # The OAuth scopes for this service. This parameter is ignored if # an updater_proc is supplied. # @param client_config [Hash] # A Hash for call options for each method. See # Google::Gax#construct_settings for the structure of # this data. Falls back to the default config if not specified # or the specified config is missing data points. # @param timeout [Numeric] # The default timeout, in seconds, for calls made through this client. # @param metadata [Hash] # Default metadata to be sent with each request. This can be overridden on a per call basis. # @param exception_transformer [Proc] # An optional proc that intercepts any exceptions raised during an API call to inject # custom error handling. def initialize \ credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "" # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "google/gax/grpc" require "google/cloud/speech/v1p1beta1/cloud_speech_services_pb" credentials ||= Google::Cloud::Speech::V1p1beta1::Credentials.default @operations_client = OperationsClient.new( credentials: credentials, scopes: scopes, client_config: client_config, timeout: timeout, lib_name: lib_name, lib_version: lib_version, ) if credentials.is_a?(String) || credentials.is_a?(Hash) updater_proc = Google::Cloud::Speech::V1p1beta1::Credentials.new(credentials).updater_proc end if credentials.is_a?(GRPC::Core::Channel) channel = credentials end if credentials.is_a?(GRPC::Core::ChannelCredentials) chan_creds = credentials end if credentials.is_a?(Proc) updater_proc = credentials end if credentials.is_a?(Google::Auth::Credentials) updater_proc = credentials.updater_proc end package_version = Gem.loaded_specs['google-cloud-speech'].version.version google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}" google_api_client << " grpc/#{GRPC::VERSION}" google_api_client.freeze headers = { :"x-goog-api-client" => google_api_client } headers.merge!(metadata) unless metadata.nil? client_config_file = Pathname.new(__dir__).join( "speech_client_config.json" ) defaults = client_config_file.open do |f| Google::Gax.construct_settings( "google.cloud.speech.v1p1beta1.Speech", JSON.parse(f.read), client_config, Google::Gax::Grpc::STATUS_CODE_NAMES, timeout, errors: Google::Gax::Grpc::API_ERRORS, metadata: headers ) end # Allow overriding the service path/port in subclasses. service_path = self.class::SERVICE_ADDRESS port = self.class::DEFAULT_SERVICE_PORT @speech_stub = Google::Gax::Grpc.create_stub( service_path, port, chan_creds: chan_creds, channel: channel, updater_proc: updater_proc, scopes: scopes, &Google::Cloud::Speech::V1p1beta1::Speech::Stub.method(:new) ) @recognize = Google::Gax.create_api_call( @speech_stub.method(:recognize), defaults["recognize"], exception_transformer: exception_transformer ) @long_running_recognize = Google::Gax.create_api_call( @speech_stub.method(:long_running_recognize), defaults["long_running_recognize"], exception_transformer: exception_transformer ) @streaming_recognize = Google::Gax.create_api_call( @speech_stub.method(:streaming_recognize), defaults["streaming_recognize"], exception_transformer: exception_transformer ) end # Service calls # Performs synchronous speech recognition: receive results after all audio # has been sent and processed. # # @param config [Google::Cloud::Speech::V1p1beta1::RecognitionConfig | Hash] # *Required* Provides information to the recognizer that specifies how to # process the request. # A hash of the same form as `Google::Cloud::Speech::V1p1beta1::RecognitionConfig` # can also be provided. # @param audio [Google::Cloud::Speech::V1p1beta1::RecognitionAudio | Hash] # *Required* The audio data to be recognized. # A hash of the same form as `Google::Cloud::Speech::V1p1beta1::RecognitionAudio` # can also be provided. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @yield [result, operation] Access the result along with the RPC operation # @yieldparam result [Google::Cloud::Speech::V1p1beta1::RecognizeResponse] # @yieldparam operation [GRPC::ActiveCall::Operation] # @return [Google::Cloud::Speech::V1p1beta1::RecognizeResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/speech/v1p1beta1" # # speech_client = Google::Cloud::Speech::V1p1beta1.new # encoding = :FLAC # sample_rate_hertz = 44100 # language_code = "en-US" # config = { # encoding: encoding, # sample_rate_hertz: sample_rate_hertz, # language_code: language_code # } # uri = "gs://bucket_name/file_name.flac" # audio = { uri: uri } # response = speech_client.recognize(config, audio) def recognize \ config, audio, options: nil, &block req = { config: config, audio: audio }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Speech::V1p1beta1::RecognizeRequest) @recognize.call(req, options, &block) end # Performs asynchronous speech recognition: receive results via the # google.longrunning.Operations interface. Returns either an # +Operation.error+ or an +Operation.response+ which contains # a +LongRunningRecognizeResponse+ message. # # @param config [Google::Cloud::Speech::V1p1beta1::RecognitionConfig | Hash] # *Required* Provides information to the recognizer that specifies how to # process the request. # A hash of the same form as `Google::Cloud::Speech::V1p1beta1::RecognitionConfig` # can also be provided. # @param audio [Google::Cloud::Speech::V1p1beta1::RecognitionAudio | Hash] # *Required* The audio data to be recognized. # A hash of the same form as `Google::Cloud::Speech::V1p1beta1::RecognitionAudio` # can also be provided. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Gax::Operation] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/speech/v1p1beta1" # # speech_client = Google::Cloud::Speech::V1p1beta1.new # encoding = :FLAC # sample_rate_hertz = 44100 # language_code = "en-US" # config = { # encoding: encoding, # sample_rate_hertz: sample_rate_hertz, # language_code: language_code # } # uri = "gs://bucket_name/file_name.flac" # audio = { uri: uri } # # # Register a callback during the method call. # operation = speech_client.long_running_recognize(config, audio) do |op| # raise op.results.message if op.error? # op_results = op.results # # Process the results. # # metadata = op.metadata # # Process the metadata. # end # # # Or use the return value to register a callback. # operation.on_done do |op| # raise op.results.message if op.error? # op_results = op.results # # Process the results. # # metadata = op.metadata # # Process the metadata. # end # # # Manually reload the operation. # operation.reload! # # # Or block until the operation completes, triggering callbacks on # # completion. # operation.wait_until_done! def long_running_recognize \ config, audio, options: nil req = { config: config, audio: audio }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Speech::V1p1beta1::LongRunningRecognizeRequest) operation = Google::Gax::Operation.new( @long_running_recognize.call(req, options), @operations_client, Google::Cloud::Speech::V1p1beta1::LongRunningRecognizeResponse, Google::Cloud::Speech::V1p1beta1::LongRunningRecognizeMetadata, call_options: options ) operation.on_done { |operation| yield(operation) } if block_given? operation end end end end end end