Module: Google::Cloud::Speech

Defined in:
lib/google/cloud/speech.rb,
lib/google/cloud/speech/version.rb

Constant Summary collapse

VERSION =
"1.1.1".freeze

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.speech| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-speech library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Integer) - Default timeout in milliseconds.
  • metadata (type: Hash{Symbol=>String}) - Additional gRPC headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config)

    The default configuration used by this library



105
106
107
108
109
# File 'lib/google/cloud/speech.rb', line 105

def self.configure
  yield ::Google::Cloud.configure.speech if block_given?

  ::Google::Cloud.configure.speech
end

.speech(version: :v1, &block) ⇒ Speech::Client

Create a new client object for Speech.

By default, this returns an instance of Google::Cloud::Speech::V1::Speech::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the Speech service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About Speech

Service that implements Google Cloud Speech API.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1)

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (Speech::Client)

    A client object for the specified version.



66
67
68
69
70
71
72
73
74
75
# File 'lib/google/cloud/speech.rb', line 66

def self.speech version: :v1, &block
  require "google/cloud/speech/#{version.to_s.downcase}"

  package_name = Google::Cloud::Speech
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Speech.const_get package_name
  package_module.const_get(:Speech).const_get(:Client).new(&block)
end