Class: Google::Cloud::Speech::V1::SpeechClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/speech/v1/speech_client.rb,
lib/google/cloud/speech/v1/helpers.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
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
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

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ SpeechClient

Returns a new instance of SpeechClient

Parameters:

  • 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.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • 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.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



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
 
# File 'lib/google/cloud/speech/v1/speech_client.rb', line 95

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/v1/cloud_speech_services_pb"

  credentials ||= Google::Cloud::Speech::V1::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::V1::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.v1.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
  interceptors = self.class::GRPC_INTERCEPTORS
  @speech_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Speech::V1::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

Instance Attribute Details

#speech_stub ⇒ Google::Cloud::Speech::V1::Speech::Stub (readonly)

Returns:

  • (Google::Cloud::Speech::V1::Speech::Stub) 


40
41
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 40

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

  # The default set of gRPC interceptors.
  GRPC_INTERCEPTORS = []

  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

  # @private
  class OperationsClient < Google::Longrunning::OperationsClient
    self::SERVICE_ADDRESS = SpeechClient::SERVICE_ADDRESS
    self::GRPC_INTERCEPTORS = SpeechClient::GRPC_INTERCEPTORS
  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<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.
  # @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/v1/cloud_speech_services_pb"

    credentials ||= Google::Cloud::Speech::V1::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::V1::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.v1.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
    interceptors = self.class::GRPC_INTERCEPTORS
    @speech_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      interceptors: interceptors,
      &Google::Cloud::Speech::V1::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::V1::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::V1::RecognitionConfig`
  #   can also be provided.
  # @param audio [Google::Cloud::Speech::V1::RecognitionAudio | Hash]
  #   *Required* The audio data to be recognized.
  #   A hash of the same form as `Google::Cloud::Speech::V1::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::V1::RecognizeResponse]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Cloud::Speech::V1::RecognizeResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/speech"
  #
  #   speech_client = Google::Cloud::Speech.new(version: :v1)
  #   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::V1::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::V1::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::V1::RecognitionConfig`
  #   can also be provided.
  # @param audio [Google::Cloud::Speech::V1::RecognitionAudio | Hash]
  #   *Required* The audio data to be recognized.
  #   A hash of the same form as `Google::Cloud::Speech::V1::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"
  #
  #   speech_client = Google::Cloud::Speech.new(version: :v1)
  #   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::V1::LongRunningRecognizeRequest)
    operation = Google::Gax::Operation.new(
      @long_running_recognize.call(req, options),
      @operations_client,
      Google::Cloud::Speech::V1::LongRunningRecognizeResponse,
      Google::Cloud::Speech::V1::LongRunningRecognizeMetadata,
      call_options: options
    )
    operation.on_done { |operation| yield(operation) } if block_given?
    operation
  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.

Examples:

require "google/cloud/speech"

speech_client = Google::Cloud::Speech.new(version: :v1)
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!

Parameters:

  • config (Google::Cloud::Speech::V1::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::V1::RecognitionConfig can also be provided.

  • audio (Google::Cloud::Speech::V1::RecognitionAudio | Hash) —

    Required The audio data to be recognized. A hash of the same form as Google::Cloud::Speech::V1::RecognitionAudio can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/google/cloud/speech/v1/speech_client.rb', line 306

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::V1::LongRunningRecognizeRequest)
  operation = Google::Gax::Operation.new(
    @long_running_recognize.call(req, options),
    @operations_client,
    Google::Cloud::Speech::V1::LongRunningRecognizeResponse,
    Google::Cloud::Speech::V1::LongRunningRecognizeMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#recognize(config, audio, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Speech::V1::RecognizeResponse

Performs synchronous speech recognition: receive results after all audio has been sent and processed.

Examples:

require "google/cloud/speech"

speech_client = Google::Cloud::Speech.new(version: :v1)
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)

Parameters:

  • config (Google::Cloud::Speech::V1::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::V1::RecognitionConfig can also be provided.

  • audio (Google::Cloud::Speech::V1::RecognitionAudio | Hash) —

    Required The audio data to be recognized. A hash of the same form as Google::Cloud::Speech::V1::RecognitionAudio can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/google/cloud/speech/v1/speech_client.rb', line 232

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::V1::RecognizeRequest)
  @recognize.call(req, options, &block)
end

#streaming_recognize(streaming_config, options: nil) ⇒ Google::Cloud::Speech::V1::Stream

Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).

Provides information to the recognizer that specifies how to process the request. A hash of the same form as +Google::Cloud::Speech::V1::StreamingRecognitionConfig+ can also be provided.

Examples:

require "google/cloud/speech"

speech_client = Google::Cloud::Speech.new
streaming_config = {
  config: {
    encoding: :linear16,
    language_code: "en-US",
    sample_rate_hertz: 16000
  }
}
stream = speech_client.streaming_recognize(streaming_config)

# Stream 5 seconds of audio from the microphone
# Actual implementation of microphone input varies by platform
5.times do
  stream.send MicrophoneInput.read(32000)
end

stream.stop
stream.wait_until_complete!

results = stream.results
result = results.first.alternatives.first
result.transcript #=> "how old is the Brooklyn Bridge"
result.confidence #=> 0.9826789498329163

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/cloud/speech/v1/helpers.rb', line 69

def streaming_recognize streaming_config, options: nil
  if streaming_config.is_a?(::Hash) &&
     streaming_config[:config] &&
     streaming_config[:config][:encoding]
    streaming_config[:config][:encoding] =
      streaming_config[:config][:encoding].upcase
  end
  V1::Stream.new(
    streaming_config,
    proc do |reqs|
      request_protos = reqs.lazy.map do |req|
        Google::Gax.to_proto(
          req,
          Google::Cloud::Speech::V1::StreamingRecognizeRequest
        )
      end
      @streaming_recognize.call(request_protos, options)
    end
  )
end