Class: Google::Apis::SpeechV1beta1::SpeechService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/speech_v1beta1/service.rb

Overview

Google Cloud Speech API

Google Cloud Speech API.

Examples:

require 'google/apis/speech_v1beta1'

Speech = Google::Apis::SpeechV1beta1 # Alias the module
service = Speech::SpeechService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initialize ⇒ SpeechService

Returns a new instance of SpeechService.



45
46
47
 
# File 'generated/google/apis/speech_v1beta1/service.rb', line 45

def initialize
  super('https://speech.googleapis.com/', '')
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'generated/google/apis/speech_v1beta1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
 
# File 'generated/google/apis/speech_v1beta1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#async_recognize_speech(async_recognize_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1beta1::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.

Parameters:

  • async_recognize_request_object (Google::Apis::SpeechV1beta1::AsyncRecognizeRequest) (defaults to: nil)
  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



251
252
253
254
255
256
257
258
259
260
 
# File 'generated/google/apis/speech_v1beta1/service.rb', line 251

def async_recognize_speech(async_recognize_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/speech:asyncrecognize', options)
  command.request_representation = Google::Apis::SpeechV1beta1::AsyncRecognizeRequest::Representation
  command.request_object = async_recognize_request_object
  command.response_representation = Google::Apis::SpeechV1beta1::Operation::Representation
  command.response_class = Google::Apis::SpeechV1beta1::Operation
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#cancel_operation(name, cancel_operation_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1beta1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::SpeechV1beta1::CancelOperationRequest) (defaults to: nil)
  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



153
154
155
156
157
158
159
160
161
162
163
 
# File 'generated/google/apis/speech_v1beta1/service.rb', line 153

def cancel_operation(name, cancel_operation_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/operations/{+name}:cancel', options)
  command.request_representation = Google::Apis::SpeechV1beta1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::SpeechV1beta1::Empty::Representation
  command.response_class = Google::Apis::SpeechV1beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_operation(name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1beta1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



188
189
190
191
192
193
194
195
196
 
# File 'generated/google/apis/speech_v1beta1/service.rb', line 188

def delete_operation(name, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/operations/{+name}', options)
  command.response_representation = Google::Apis::SpeechV1beta1::Empty::Representation
  command.response_class = Google::Apis::SpeechV1beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_operation(name, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1beta1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



71
72
73
74
75
76
77
78
79
 
# File 'generated/google/apis/speech_v1beta1/service.rb', line 71

def get_operation(name, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/operations/{+name}', options)
  command.response_representation = Google::Apis::SpeechV1beta1::Operation::Representation
  command.response_class = Google::Apis::SpeechV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_operations(page_size: nil, filter: nil, name: nil, page_token: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1beta1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.

Parameters:

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • name (String) (defaults to: nil) —

    The name of the operation collection.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'generated/google/apis/speech_v1beta1/service.rb', line 110

def list_operations(page_size: nil, filter: nil, name: nil, page_token: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/operations', options)
  command.response_representation = Google::Apis::SpeechV1beta1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::SpeechV1beta1::ListOperationsResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['name'] = name unless name.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#sync_recognize_speech(sync_recognize_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1beta1::SyncRecognizeResponse

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

Parameters:

  • sync_recognize_request_object (Google::Apis::SpeechV1beta1::SyncRecognizeRequest) (defaults to: nil)
  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



218
219
220
221
222
223
224
225
226
227
 
# File 'generated/google/apis/speech_v1beta1/service.rb', line 218

def sync_recognize_speech(sync_recognize_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/speech:syncrecognize', options)
  command.request_representation = Google::Apis::SpeechV1beta1::SyncRecognizeRequest::Representation
  command.request_object = sync_recognize_request_object
  command.response_representation = Google::Apis::SpeechV1beta1::SyncRecognizeResponse::Representation
  command.response_class = Google::Apis::SpeechV1beta1::SyncRecognizeResponse
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end