Class: CloudmersiveVoiceRecognitionApiClient::RecognizeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-voice-recognition-api-client/api/recognize_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RecognizeApi

Returns a new instance of RecognizeApi.



19
20
21
 
# File 'lib/cloudmersive-voice-recognition-api-client/api/recognize_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudmersive-voice-recognition-api-client/api/recognize_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#recognize_file(speech_file, opts = {}) ⇒ SpeechRecognitionResult

Recognize audio input as text using machine learning Uses advanced machine learning to convert input audio, which can be mp3 or wav, into text.

Parameters:

  • speech_file —

    Speech file to perform the operation on. Common file formats such as WAV, MP3 are supported.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/cloudmersive-voice-recognition-api-client/api/recognize_api.rb', line 28

def recognize_file(speech_file, opts = {})
  data, _status_code, _headers = recognize_file_with_http_info(speech_file, opts)
  return data
end

#recognize_file_with_http_info(speech_file, opts = {}) ⇒ Array<(SpeechRecognitionResult, Fixnum, Hash)>

Recognize audio input as text using machine learning Uses advanced machine learning to convert input audio, which can be mp3 or wav, into text.

Parameters:

  • speech_file —

    Speech file to perform the operation on. Common file formats such as WAV, MP3 are supported.

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

    the optional parameters

Returns:

  • (Array<(SpeechRecognitionResult, Fixnum, Hash)>) —

    SpeechRecognitionResult data, response status code and response headers



38
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
 
# File 'lib/cloudmersive-voice-recognition-api-client/api/recognize_api.rb', line 38

def recognize_file_with_http_info(speech_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RecognizeApi.recognize_file ..."
  end
  # verify the required parameter 'speech_file' is set
  if @api_client.config.client_side_validation && speech_file.nil?
    fail ArgumentError, "Missing the required parameter 'speech_file' when calling RecognizeApi.recognize_file"
  end
  # resource path
  local_var_path = "/speech/recognize/file"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["speechFile"] = speech_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SpeechRecognitionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RecognizeApi#recognize_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end