Class: Google::Cloud::Speech::V1p1beta1::Speech::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Speech::V1p1beta1::Speech::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/speech/v1p1beta1/speech/client.rb
Overview
Client for the Speech service.
Service that implements Google Cloud Speech API.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#operations_client ⇒ ::Google::Cloud::Speech::V1p1beta1::Speech::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the Speech Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the Speech Client instance.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new Speech client object.
-
#long_running_recognize(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface.
-
#recognize(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Speech::V1p1beta1::RecognizeResponse
Performs synchronous speech recognition: receive results after all audio has been sent and processed.
-
#streaming_recognize(request, options = nil) {|response, operation| ... } ⇒ ::Enumerable<::Google::Cloud::Speech::V1p1beta1::StreamingRecognizeResponse>
Performs bidirectional streaming speech recognition: receive results while sending audio.
Methods included from Paths
#custom_class_path, #phrase_set_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new Speech client object.
Examples
To create a new Speech client with the default configuration:
client = ::Google::Cloud::Speech::V1p1beta1::Speech::Client.new
To create a new Speech client with a custom configuration:
client = ::Google::Cloud::Speech::V1p1beta1::Speech::Client.new do |config|
config.timeout = 10.0
end
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 |
# File 'lib/google/cloud/speech/v1p1beta1/speech/client.rb', line 132 def initialize # 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 "gapic/grpc" require "google/cloud/speech/v1p1beta1/cloud_speech_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials credentials ||= Credentials.default scope: @config.scope if credentials.is_a?(String) || credentials.is_a?(Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @speech_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Speech::V1p1beta1::Speech::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Instance Attribute Details
#operations_client ⇒ ::Google::Cloud::Speech::V1p1beta1::Speech::Operations (readonly)
Get the associated client for long-running operations.
173 174 175 |
# File 'lib/google/cloud/speech/v1p1beta1/speech/client.rb', line 173 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
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 |
# File 'lib/google/cloud/speech/v1p1beta1/speech/client.rb', line 57 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Speech", "V1p1beta1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const&.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.recognize.timeout = 5000.0 default_config.rpcs.recognize.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.long_running_recognize.timeout = 5000.0 default_config.rpcs.streaming_recognize.timeout = 5000.0 default_config.rpcs.streaming_recognize.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the Speech Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
107 108 109 110 |
# File 'lib/google/cloud/speech/v1p1beta1/speech/client.rb', line 107 def configure yield @config if block_given? @config end |
#long_running_recognize(request, options = nil) ⇒ ::Gapic::Operation #long_running_recognize(config: nil, audio: nil) ⇒ ::Gapic::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.
For more information on asynchronous speech recognition, see the
how-to.
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 |
# File 'lib/google/cloud/speech/v1p1beta1/speech/client.rb', line 278 def long_running_recognize request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::LongRunningRecognizeRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.long_running_recognize..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.long_running_recognize.timeout, metadata: , retry_policy: @config.rpcs.long_running_recognize.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @speech_stub.call_rpc :long_running_recognize, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#recognize(request, options = nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::RecognizeResponse #recognize(config: nil, audio: nil) ⇒ ::Google::Cloud::Speech::V1p1beta1::RecognizeResponse
Performs synchronous speech recognition: receive results after all audio has been sent and processed.
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 |
# File 'lib/google/cloud/speech/v1p1beta1/speech/client.rb', line 210 def recognize request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::RecognizeRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.recognize..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.recognize.timeout, metadata: , retry_policy: @config.rpcs.recognize.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @speech_stub.call_rpc :recognize, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#streaming_recognize(request, options = nil) {|response, operation| ... } ⇒ ::Enumerable<::Google::Cloud::Speech::V1p1beta1::StreamingRecognizeResponse>
Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/google/cloud/speech/v1p1beta1/speech/client.rb', line 327 def streaming_recognize request, = nil unless request.is_a? ::Enumerable raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum request = request.to_enum end request = request.lazy.map do |req| ::Gapic::Protobuf.coerce req, to: ::Google::Cloud::Speech::V1p1beta1::StreamingRecognizeRequest end # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.streaming_recognize..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Speech::V1p1beta1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.streaming_recognize.timeout, metadata: , retry_policy: @config.rpcs.streaming_recognize.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @speech_stub.call_rpc :streaming_recognize, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |