Class: Google::Cloud::Speech::V1beta1::SpeechApi

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/speech/v1beta1/speech_api.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
CODE_GEN_NAME_VERSION = 
"gapic/0.1.0".freeze
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(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: "gax", app_version: Google::Gax::VERSION) ⇒ SpeechApi

Returns a new instance of SpeechApi.

Parameters:

  • service_path (String) (defaults to: SERVICE_ADDRESS) —

    The domain name of the API remote host.

  • port (Integer) (defaults to: DEFAULT_SERVICE_PORT) —

    The port on which to connect to the remote host.

  • channel (Channel) (defaults to: nil) —

    A Channel object through which to make calls.

  • chan_creds (Grpc::ChannelCredentials) (defaults to: nil) —

    A ChannelCredentials for the setting up the RPC client.

  • client_config (Hash) (defaults to: {}) —

    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) (defaults to: DEFAULT_TIMEOUT) —

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

  • app_name (String) (defaults to: "gax") —

    The codename of the calling service.

  • app_version (String) (defaults to: Google::Gax::VERSION) —

    The version of the calling service.



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
 
# File 'lib/google/cloud/speech/v1beta1/speech_api.rb', line 77

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    channel: nil,
    chan_creds: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    app_name: "gax",
    app_version: Google::Gax::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/v1beta1/cloud_speech_services_pb"

  google_api_client = "#{app_name}/#{app_version} " \
    "#{CODE_GEN_NAME_VERSION} gax/#{Google::Gax::VERSION} " \
    "ruby/#{RUBY_VERSION}".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.v1beta1.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,
    scopes: scopes,
    &Google::Cloud::Speech::V1beta1::Speech::Stub.method(:new)
  )

  @sync_recognize = Google::Gax.create_api_call(
    @speech_stub.method(:sync_recognize),
    defaults["sync_recognize"]
  )
  @async_recognize = Google::Gax.create_api_call(
    @speech_stub.method(:async_recognize),
    defaults["async_recognize"]
  )
end

Instance Attribute Details

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

Returns:



39
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
 
# File 'lib/google/cloud/speech/v1beta1/speech_api.rb', line 39

class SpeechApi
  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

  CODE_GEN_NAME_VERSION = "gapic/0.1.0".freeze

  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 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 app_name [String]
  #   The codename of the calling service.
  # @param app_version [String]
  #   The version of the calling service.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      app_name: "gax",
      app_version: Google::Gax::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/v1beta1/cloud_speech_services_pb"

    google_api_client = "#{app_name}/#{app_version} " \
      "#{CODE_GEN_NAME_VERSION} gax/#{Google::Gax::VERSION} " \
      "ruby/#{RUBY_VERSION}".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.v1beta1.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,
      scopes: scopes,
      &Google::Cloud::Speech::V1beta1::Speech::Stub.method(:new)
    )

    @sync_recognize = Google::Gax.create_api_call(
      @speech_stub.method(:sync_recognize),
      defaults["sync_recognize"]
    )
    @async_recognize = Google::Gax.create_api_call(
      @speech_stub.method(:async_recognize),
      defaults["async_recognize"]
    )
  end

  # Service calls

  # Perform synchronous speech-recognition: receive results after all audio
  # has been sent and processed.
  #
  # @param config [Google::Cloud::Speech::V1beta1::RecognitionConfig]
  #   [Required] The +config+ message provides information to the recognizer
  #   that specifies how to process the request.
  # @param audio [Google::Cloud::Speech::V1beta1::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::V1beta1::SyncRecognizeResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/speech/v1beta1/speech_api"
  #
  #   RecognitionAudio = Google::Cloud::Speech::V1beta1::RecognitionAudio
  #   RecognitionConfig = Google::Cloud::Speech::V1beta1::RecognitionConfig
  #   SpeechApi = Google::Cloud::Speech::V1beta1::SpeechApi
  #
  #   speech_api = SpeechApi.new
  #   config = RecognitionConfig.new
  #   audio = RecognitionAudio.new
  #   response = speech_api.sync_recognize(config, audio)

  def sync_recognize \
      config,
      audio,
      options: nil
    req = Google::Cloud::Speech::V1beta1::SyncRecognizeRequest.new(
      config: config,
      audio: audio
    )
    @sync_recognize.call(req, options)
  end

  # Perform asynchronous speech-recognition: receive results via the
  # google.longrunning.Operations interface. Returns either an
  # +Operation.error+ or an +Operation.response+ which contains
  # an +AsyncRecognizeResponse+ message.
  #
  # @param config [Google::Cloud::Speech::V1beta1::RecognitionConfig]
  #   [Required] The +config+ message provides information to the recognizer
  #   that specifies how to process the request.
  # @param audio [Google::Cloud::Speech::V1beta1::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::Longrunning::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/speech/v1beta1/speech_api"
  #
  #   RecognitionAudio = Google::Cloud::Speech::V1beta1::RecognitionAudio
  #   RecognitionConfig = Google::Cloud::Speech::V1beta1::RecognitionConfig
  #   SpeechApi = Google::Cloud::Speech::V1beta1::SpeechApi
  #
  #   speech_api = SpeechApi.new
  #   config = RecognitionConfig.new
  #   audio = RecognitionAudio.new
  #   response = speech_api.async_recognize(config, audio)

  def async_recognize \
      config,
      audio,
      options: nil
    req = Google::Cloud::Speech::V1beta1::AsyncRecognizeRequest.new(
      config: config,
      audio: audio
    )
    @async_recognize.call(req, options)
  end
end

Instance Method Details

#async_recognize(config, audio, options: nil) ⇒ Google::Longrunning::Operation

Perform asynchronous speech-recognition: receive results via the google.longrunning.Operations interface. Returns either an Operation.error or an Operation.response which contains an AsyncRecognizeResponse message.

Examples:

require "google/cloud/speech/v1beta1/speech_api"

RecognitionAudio = Google::Cloud::Speech::V1beta1::RecognitionAudio
RecognitionConfig = Google::Cloud::Speech::V1beta1::RecognitionConfig
SpeechApi = Google::Cloud::Speech::V1beta1::SpeechApi

speech_api = SpeechApi.new
config = RecognitionConfig.new
audio = RecognitionAudio.new
response = speech_api.async_recognize(config, audio)

Parameters:

Returns:

  • (Google::Longrunning::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/google/cloud/speech/v1beta1/speech_api.rb', line 195

def async_recognize \
    config,
    audio,
    options: nil
  req = Google::Cloud::Speech::V1beta1::AsyncRecognizeRequest.new(
    config: config,
    audio: audio
  )
  @async_recognize.call(req, options)
end

#sync_recognize(config, audio, options: nil) ⇒ Google::Cloud::Speech::V1beta1::SyncRecognizeResponse

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

Examples:

require "google/cloud/speech/v1beta1/speech_api"

RecognitionAudio = Google::Cloud::Speech::V1beta1::RecognitionAudio
RecognitionConfig = Google::Cloud::Speech::V1beta1::RecognitionConfig
SpeechApi = Google::Cloud::Speech::V1beta1::SpeechApi

speech_api = SpeechApi.new
config = RecognitionConfig.new
audio = RecognitionAudio.new
response = speech_api.sync_recognize(config, audio)

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/google/cloud/speech/v1beta1/speech_api.rb', line 157

def sync_recognize \
    config,
    audio,
    options: nil
  req = Google::Cloud::Speech::V1beta1::SyncRecognizeRequest.new(
    config: config,
    audio: audio
  )
  @sync_recognize.call(req, options)
end