Class: Google::Apis::SpeechV1::SpeechService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::SpeechV1::SpeechService
- Defined in:
- lib/google/apis/speech_v1/service.rb
Overview
Cloud Speech-to-Text API
Converts audio to text by applying powerful neural network models.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#create_custom_class(parent, create_custom_class_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::CustomClass
Create a custom class.
-
#create_phrase_set(parent, create_phrase_set_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::PhraseSet
Create a set of phrase hints.
-
#delete_project_location_custom_class(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::Empty
Delete a custom class.
-
#delete_project_location_phrase_set(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::Empty
Delete a phrase set.
-
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::Operation
Gets the latest state of a long-running operation.
-
#get_project_location_custom_class(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::CustomClass
Get a custom class.
-
#get_project_location_phrase_set(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::PhraseSet
Get a phrase set.
-
#initialize ⇒ SpeechService
constructor
A new instance of SpeechService.
-
#list_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::ListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_location_custom_classes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::ListCustomClassesResponse
List custom classes.
-
#list_project_location_phrase_sets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::ListPhraseSetResponse
List phrase sets.
-
#longrunningrecognize_speech(long_running_recognize_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::Operation
Performs asynchronous speech recognition: receive results via the google.
-
#patch_project_location_custom_class(name, custom_class_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::CustomClass
Update a custom class.
-
#patch_project_location_phrase_set(name, phrase_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::PhraseSet
Update a phrase set.
-
#recognize_speech(recognize_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::RecognizeResponse
Performs synchronous speech recognition: receive results after all audio has been sent and processed.
Constructor Details
#initialize ⇒ SpeechService
Returns a new instance of SpeechService.
45 46 47 48 49 50 |
# File 'lib/google/apis/speech_v1/service.rb', line 45 def initialize super('https://speech.googleapis.com/', '', client_name: 'google-apis-speech_v1', client_version: Google::Apis::SpeechV1::GEM_VERSION) @batch_path = 'batch' 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.
38 39 40 |
# File 'lib/google/apis/speech_v1/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.
43 44 45 |
# File 'lib/google/apis/speech_v1/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#create_custom_class(parent, create_custom_class_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::CustomClass
Create a custom class.
151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/google/apis/speech_v1/service.rb', line 151 def create_custom_class(parent, create_custom_class_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/customClasses', ) command.request_representation = Google::Apis::SpeechV1::CreateCustomClassRequest::Representation command.request_object = create_custom_class_request_object command.response_representation = Google::Apis::SpeechV1::CustomClass::Representation command.response_class = Google::Apis::SpeechV1::CustomClass command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_phrase_set(parent, create_phrase_set_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::PhraseSet
Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.
326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/google/apis/speech_v1/service.rb', line 326 def create_phrase_set(parent, create_phrase_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/phraseSets', ) command.request_representation = Google::Apis::SpeechV1::CreatePhraseSetRequest::Representation command.request_object = create_phrase_set_request_object command.response_representation = Google::Apis::SpeechV1::PhraseSet::Representation command.response_class = Google::Apis::SpeechV1::PhraseSet command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_custom_class(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::Empty
Delete a custom class.
184 185 186 187 188 189 190 191 192 |
# File 'lib/google/apis/speech_v1/service.rb', line 184 def delete_project_location_custom_class(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::SpeechV1::Empty::Representation command.response_class = Google::Apis::SpeechV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_phrase_set(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::Empty
Delete a phrase set.
359 360 361 362 363 364 365 366 367 |
# File 'lib/google/apis/speech_v1/service.rb', line 359 def delete_project_location_phrase_set(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::SpeechV1::Empty::Representation command.response_class = Google::Apis::SpeechV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::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.
73 74 75 76 77 78 79 80 81 |
# File 'lib/google/apis/speech_v1/service.rb', line 73 def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/operations/{+name}', ) command.response_representation = Google::Apis::SpeechV1::Operation::Representation command.response_class = Google::Apis::SpeechV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_custom_class(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::CustomClass
Get a custom class.
215 216 217 218 219 220 221 222 223 |
# File 'lib/google/apis/speech_v1/service.rb', line 215 def get_project_location_custom_class(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::SpeechV1::CustomClass::Representation command.response_class = Google::Apis::SpeechV1::CustomClass command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_phrase_set(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::PhraseSet
Get a phrase set.
390 391 392 393 394 395 396 397 398 |
# File 'lib/google/apis/speech_v1/service.rb', line 390 def get_project_location_phrase_set(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::SpeechV1::PhraseSet::Representation command.response_class = Google::Apis::SpeechV1::PhraseSet command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::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 allows API services to override the binding to use different resource
name schemes, such as users/*/operations. To override the binding, API
services can add a binding such as "/v1/name=users/*/operations" to their
service configuration. For backwards compatibility, the default name includes
the operations collection id, however overriding users must ensure the name
binding is the parent resource, without the operations collection id.
116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/google/apis/speech_v1/service.rb', line 116 def list_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/operations', ) command.response_representation = Google::Apis::SpeechV1::ListOperationsResponse::Representation command.response_class = Google::Apis::SpeechV1::ListOperationsResponse command.query['filter'] = filter unless filter.nil? command.query['name'] = name unless name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_custom_classes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::ListCustomClassesResponse
List custom classes.
254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/google/apis/speech_v1/service.rb', line 254 def list_project_location_custom_classes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/customClasses', ) command.response_representation = Google::Apis::SpeechV1::ListCustomClassesResponse::Representation command.response_class = Google::Apis::SpeechV1::ListCustomClassesResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_phrase_sets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::ListPhraseSetResponse
List phrase sets.
429 430 431 432 433 434 435 436 437 438 439 |
# File 'lib/google/apis/speech_v1/service.rb', line 429 def list_project_location_phrase_sets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/phraseSets', ) command.response_representation = Google::Apis::SpeechV1::ListPhraseSetResponse::Representation command.response_class = Google::Apis::SpeechV1::ListPhraseSetResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#longrunningrecognize_speech(long_running_recognize_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::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.
500 501 502 503 504 505 506 507 508 509 |
# File 'lib/google/apis/speech_v1/service.rb', line 500 def longrunningrecognize_speech(long_running_recognize_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/speech:longrunningrecognize', ) command.request_representation = Google::Apis::SpeechV1::LongRunningRecognizeRequest::Representation command.request_object = long_running_recognize_request_object command.response_representation = Google::Apis::SpeechV1::Operation::Representation command.response_class = Google::Apis::SpeechV1::Operation command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_custom_class(name, custom_class_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::CustomClass
Update a custom class.
289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/google/apis/speech_v1/service.rb', line 289 def patch_project_location_custom_class(name, custom_class_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::SpeechV1::CustomClass::Representation command.request_object = custom_class_object command.response_representation = Google::Apis::SpeechV1::CustomClass::Representation command.response_class = Google::Apis::SpeechV1::CustomClass command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_phrase_set(name, phrase_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::PhraseSet
Update a phrase set.
464 465 466 467 468 469 470 471 472 473 474 475 |
# File 'lib/google/apis/speech_v1/service.rb', line 464 def patch_project_location_phrase_set(name, phrase_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::SpeechV1::PhraseSet::Representation command.request_object = phrase_set_object command.response_representation = Google::Apis::SpeechV1::PhraseSet::Representation command.response_class = Google::Apis::SpeechV1::PhraseSet command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#recognize_speech(recognize_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::SpeechV1::RecognizeResponse
Performs synchronous speech recognition: receive results after all audio has been sent and processed.
531 532 533 534 535 536 537 538 539 540 |
# File 'lib/google/apis/speech_v1/service.rb', line 531 def recognize_speech(recognize_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/speech:recognize', ) command.request_representation = Google::Apis::SpeechV1::RecognizeRequest::Representation command.request_object = recognize_request_object command.response_representation = Google::Apis::SpeechV1::RecognizeResponse::Representation command.response_class = Google::Apis::SpeechV1::RecognizeResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |