class Google::Cloud::Speech::V1::Speech::Client
Attributes
Get the associated client for long-running operations.
@return [::Google::Cloud::Speech::V1::Speech::Operations]
@private
Public Class Methods
Configure the Speech
Client
class.
See {::Google::Cloud::Speech::V1::Speech::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all Speech clients ::Google::Cloud::Speech::V1::Speech::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/speech/v1/speech/client.rb, line 54 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Speech", "V1"] 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: [14, 4] } 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: [14, 4] } default_config end yield @configure if block_given? @configure end
Create a new Speech
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Speech::V1::Speech::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Speech::V1::Speech::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the Speech
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/speech/v1/speech/client.rb, line 119 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/v1/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 # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt 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::V1::Speech::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
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 {Client.configure}.
See {::Google::Cloud::Speech::V1::Speech::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/speech/v1/speech/client.rb, line 98 def configure yield @config if block_given? @config 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. For more information on asynchronous speech recognition, see the [how-to](cloud.google.com/speech-to-text/docs/async-recognize).
@overload long_running_recognize
(request, options = nil)
Pass arguments to `long_running_recognize` via a request object, either of type {::Google::Cloud::Speech::V1::LongRunningRecognizeRequest} or an equivalent Hash. @param request [::Google::Cloud::Speech::V1::LongRunningRecognizeRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload long_running_recognize
(config: nil, audio: nil)
Pass arguments to `long_running_recognize` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param config [::Google::Cloud::Speech::V1::RecognitionConfig, ::Hash] Required. Provides information to the recognizer that specifies how to process the request. @param audio [::Google::Cloud::Speech::V1::RecognitionAudio, ::Hash] Required. The audio data to be recognized.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/speech/v1/speech/client.rb, line 272 def long_running_recognize request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1::LongRunningRecognizeRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.long_running_recognize.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.long_running_recognize.timeout, metadata: metadata, retry_policy: @config.rpcs.long_running_recognize.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @speech_stub.call_rpc :long_running_recognize, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Performs synchronous speech recognition: receive results after all audio has been sent and processed.
@overload recognize(request, options = nil)
Pass arguments to `recognize` via a request object, either of type {::Google::Cloud::Speech::V1::RecognizeRequest} or an equivalent Hash. @param request [::Google::Cloud::Speech::V1::RecognizeRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload recognize(config: nil, audio: nil)
Pass arguments to `recognize` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param config [::Google::Cloud::Speech::V1::RecognitionConfig, ::Hash] Required. Provides information to the recognizer that specifies how to process the request. @param audio [::Google::Cloud::Speech::V1::RecognitionAudio, ::Hash] Required. The audio data to be recognized.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Speech::V1::RecognizeResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Speech::V1::RecognizeResponse]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/speech/v1/speech/client.rb, line 202 def recognize request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1::RecognizeRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.recognize.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.recognize.timeout, metadata: metadata, retry_policy: @config.rpcs.recognize.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @speech_stub.call_rpc :recognize, request, options: 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
Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).
@param request [::Gapic::StreamInput, ::Enumerable<::Google::Cloud::Speech::V1::StreamingRecognizeRequest, ::Hash>]
An enumerable of {::Google::Cloud::Speech::V1::StreamingRecognizeRequest} instances.
@param options [::Gapic::CallOptions, ::Hash]
Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Enumerable<::Google::Cloud::Speech::V1::StreamingRecognizeResponse>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Enumerable<::Google::Cloud::Speech::V1::StreamingRecognizeResponse>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/speech/v1/speech/client.rb, line 323 def streaming_recognize request, options = 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::V1::StreamingRecognizeRequest end # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.streaming_recognize.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.streaming_recognize.timeout, metadata: metadata, retry_policy: @config.rpcs.streaming_recognize.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @speech_stub.call_rpc :streaming_recognize, request, options: 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