Class: Google::Cloud::Speech::V1::SpeechClient
- Inherits:
-
Object
- Object
- Google::Cloud::Speech::V1::SpeechClient
- Defined in:
- lib/google/cloud/speech/v1/speech_client.rb
Overview
Service that implements Google Cloud Speech API.
Constant Summary collapse
- SERVICE_ADDRESS =
The default address of the service.
"speech.googleapis.com".freeze
- DEFAULT_SERVICE_PORT =
The default port of the service.
443
- DEFAULT_TIMEOUT =
30
- ALL_SCOPES =
The scopes needed to make gRPC calls to all of the methods defined in this service.
[ "https://www.googleapis.com/auth/cloud-platform" ].freeze
Instance Attribute Summary collapse
Instance Method Summary collapse
-
#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "") ⇒ SpeechClient
constructor
A new instance of SpeechClient.
-
#long_running_recognize(config, audio, options: nil) ⇒ Google::Gax::Operation
Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface.
-
#recognize(config, audio, options: nil) ⇒ Google::Cloud::Speech::V1::RecognizeResponse
Performs synchronous speech recognition: receive results after all audio has been sent and processed.
-
#streaming_recognize(reqs, options: nil) ⇒ Enumerable<Google::Cloud::Speech::V1::StreamingRecognizeResponse>
Performs bidirectional streaming speech recognition: receive results while sending audio.
Constructor Details
#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "") ⇒ SpeechClient
Returns a new instance of SpeechClient
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/google/cloud/speech/v1/speech_client.rb', line 80 def initialize \ service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: 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/v1/cloud_speech_services_pb" @operations_client = Google::Longrunning::OperationsClient.new( service_path: service_path, port: port, channel: channel, chan_creds: chan_creds, updater_proc: updater_proc, scopes: scopes, client_config: client_config, timeout: timeout, app_name: app_name, app_version: app_version, lib_name: lib_name, lib_version: lib_version, ) if app_name || app_version warn "`app_name` and `app_version` are no longer being used in the request headers." end google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}" google_api_client << " grpc/#{GRPC::VERSION}" google_api_client.freeze headers = { :"x-goog-api-client" => google_api_client } 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.v1.Speech", JSON.parse(f.read), client_config, Google::Gax::Grpc::STATUS_CODE_NAMES, timeout, errors: Google::Gax::Grpc::API_ERRORS, kwargs: headers ) end @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::V1::Speech::Stub.method(:new) ) @recognize = Google::Gax.create_api_call( @speech_stub.method(:recognize), defaults["recognize"] ) @long_running_recognize = Google::Gax.create_api_call( @speech_stub.method(:long_running_recognize), defaults["long_running_recognize"] ) @streaming_recognize = Google::Gax.create_api_call( @speech_stub.method(:streaming_recognize), defaults["streaming_recognize"] ) end |
Instance Attribute Details
#speech_stub ⇒ Google::Cloud::Speech::V1::Speech::Stub (readonly)
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/google/cloud/speech/v1/speech_client.rb', line 42 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 # @param service_path [String] # The domain name of the API remote host. # @param port [Integer] # The port on which to connect to the remote host. # @param channel [Channel] # A Channel object through which to make calls. # @param chan_creds [Grpc::ChannelCredentials] # A ChannelCredentials for the setting up the RPC client. # @param updater_proc [Proc] # A function that transforms the metadata for requests, e.g., to give # OAuth credentials. # @param scopes [Array<String>] # 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. def initialize \ service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: 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/v1/cloud_speech_services_pb" @operations_client = Google::Longrunning::OperationsClient.new( service_path: service_path, port: port, channel: channel, chan_creds: chan_creds, updater_proc: updater_proc, scopes: scopes, client_config: client_config, timeout: timeout, app_name: app_name, app_version: app_version, lib_name: lib_name, lib_version: lib_version, ) if app_name || app_version warn "`app_name` and `app_version` are no longer being used in the request headers." end google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}" google_api_client << " grpc/#{GRPC::VERSION}" google_api_client.freeze headers = { :"x-goog-api-client" => google_api_client } 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.v1.Speech", JSON.parse(f.read), client_config, Google::Gax::Grpc::STATUS_CODE_NAMES, timeout, errors: Google::Gax::Grpc::API_ERRORS, kwargs: headers ) end @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::V1::Speech::Stub.method(:new) ) @recognize = Google::Gax.create_api_call( @speech_stub.method(:recognize), defaults["recognize"] ) @long_running_recognize = Google::Gax.create_api_call( @speech_stub.method(:long_running_recognize), defaults["long_running_recognize"] ) @streaming_recognize = Google::Gax.create_api_call( @speech_stub.method(:streaming_recognize), defaults["streaming_recognize"] ) end # Service calls # Performs synchronous speech recognition: receive results after all audio # has been sent and processed. # # @param config [Google::Cloud::Speech::V1::RecognitionConfig] # *Required* Provides information to the recognizer that specifies how to # process the request. # @param audio [Google::Cloud::Speech::V1::RecognitionAudio] # *Required* The audio data to be recognized. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Cloud::Speech::V1::RecognizeResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/speech/v1" # # AudioEncoding = Google::Cloud::Speech::V1::RecognitionConfig::AudioEncoding # RecognitionAudio = Google::Cloud::Speech::V1::RecognitionAudio # RecognitionConfig = Google::Cloud::Speech::V1::RecognitionConfig # SpeechClient = Google::Cloud::Speech::V1::SpeechClient # # speech_client = SpeechClient.new # encoding = AudioEncoding::FLAC # sample_rate_hertz = 44100 # language_code = "en-US" # config = RecognitionConfig.new # config.encoding = encoding # config.sample_rate_hertz = sample_rate_hertz # config.language_code = language_code # uri = "gs://bucket_name/file_name.flac" # audio = RecognitionAudio.new # audio.uri = uri # response = speech_client.recognize(config, audio) def recognize \ config, audio, options: nil req = Google::Cloud::Speech::V1::RecognizeRequest.new({ config: config, audio: audio }.delete_if { |_, v| v.nil? }) @recognize.call(req, ) 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::V1::RecognitionConfig] # *Required* Provides information to the recognizer that specifies how to # process the request. # @param audio [Google::Cloud::Speech::V1::RecognitionAudio] # *Required* The audio data to be recognized. # @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/v1" # # AudioEncoding = Google::Cloud::Speech::V1::RecognitionConfig::AudioEncoding # RecognitionAudio = Google::Cloud::Speech::V1::RecognitionAudio # RecognitionConfig = Google::Cloud::Speech::V1::RecognitionConfig # SpeechClient = Google::Cloud::Speech::V1::SpeechClient # # speech_client = SpeechClient.new # encoding = AudioEncoding::FLAC # sample_rate_hertz = 44100 # language_code = "en-US" # config = RecognitionConfig.new # config.encoding = encoding # config.sample_rate_hertz = sample_rate_hertz # config.language_code = language_code # uri = "gs://bucket_name/file_name.flac" # audio = RecognitionAudio.new # 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 = Google::Cloud::Speech::V1::LongRunningRecognizeRequest.new({ config: config, audio: audio }.delete_if { |_, v| v.nil? }) operation = Google::Gax::Operation.new( @long_running_recognize.call(req, ), @operations_client, Google::Cloud::Speech::V1::LongRunningRecognizeResponse, Google::Cloud::Speech::V1::LongRunningRecognizeMetadata, call_options: ) operation.on_done { |operation| yield(operation) } if block_given? operation end # Performs bidirectional streaming speech recognition: receive results while # sending audio. This method is only available via the gRPC API (not REST). # # @param reqs [Enumerable<Google::Cloud::Speech::V1::StreamingRecognizeRequest>] # The input requests. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Enumerable<Google::Cloud::Speech::V1::StreamingRecognizeResponse>] # An enumerable of Google::Cloud::Speech::V1::StreamingRecognizeResponse instances. # # @raise [Google::Gax::GaxError] if the RPC is aborted. # # @note # EXPERIMENTAL: # Streaming requests are still undergoing review. # This method interface might change in the future. # # @example # require "google/cloud/speech/v1" # # SpeechClient = Google::Cloud::Speech::V1::SpeechClient # StreamingRecognizeRequest = Google::Cloud::Speech::V1::StreamingRecognizeRequest # # speech_client = SpeechClient.new # request = StreamingRecognizeRequest.new # requests = [request] # speech_client.streaming_recognize(requests).each do |element| # # Process element. # end def streaming_recognize reqs, options: nil @streaming_recognize.call(reqs, ) end end |
Instance Method Details
#long_running_recognize(config, audio, options: nil) ⇒ Google::Gax::Operation
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.
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'lib/google/cloud/speech/v1/speech_client.rb', line 272 def long_running_recognize \ config, audio, options: nil req = Google::Cloud::Speech::V1::LongRunningRecognizeRequest.new({ config: config, audio: audio }.delete_if { |_, v| v.nil? }) operation = Google::Gax::Operation.new( @long_running_recognize.call(req, ), @operations_client, Google::Cloud::Speech::V1::LongRunningRecognizeResponse, Google::Cloud::Speech::V1::LongRunningRecognizeMetadata, call_options: ) operation.on_done { |operation| yield(operation) } if block_given? operation end |
#recognize(config, audio, options: nil) ⇒ Google::Cloud::Speech::V1::RecognizeResponse
Performs synchronous speech recognition: receive results after all audio has been sent and processed.
199 200 201 202 203 204 205 206 207 208 |
# File 'lib/google/cloud/speech/v1/speech_client.rb', line 199 def recognize \ config, audio, options: nil req = Google::Cloud::Speech::V1::RecognizeRequest.new({ config: config, audio: audio }.delete_if { |_, v| v.nil? }) @recognize.call(req, ) end |
#streaming_recognize(reqs, options: nil) ⇒ Enumerable<Google::Cloud::Speech::V1::StreamingRecognizeResponse>
EXPERIMENTAL: Streaming requests are still undergoing review. This method interface might change in the future.
Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).
322 323 324 |
# File 'lib/google/cloud/speech/v1/speech_client.rb', line 322 def streaming_recognize reqs, options: nil @streaming_recognize.call(reqs, ) end |