Class: Google::Apis::SpeechV1::SpeechService

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

Overview

Cloud Speech API

Converts audio to text by applying powerful neural network models.

Examples:

require 'google/apis/speech_v1'

Speech = Google::Apis::SpeechV1 # 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

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ SpeechService

Returns a new instance of SpeechService



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

def initialize
  super('https://speech.googleapis.com/', '')
  @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.

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_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.

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_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/operations/{+name}', options)
  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

#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.

Parameters:

  • long_running_recognize_request_object (Google::Apis::SpeechV1::LongRunningRecognizeRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



104
105
106
107
108
109
110
111
112
113
 
# File 'generated/google/apis/speech_v1/service.rb', line 104

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', options)
  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

#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.

Parameters:

  • recognize_request_object (Google::Apis::SpeechV1::RecognizeRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



135
136
137
138
139
140
141
142
143
144
 
# File 'generated/google/apis/speech_v1/service.rb', line 135

def recognize_speech(recognize_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/speech:recognize', options)
  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