Class: CloudmersiveNlpApiClient::SpellcheckApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-nlp-api-client/api/spellcheck_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SpellcheckApi

Returns a new instance of SpellcheckApi.



19
20
21
 
# File 'lib/cloudmersive-nlp-api-client/api/spellcheck_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-nlp-api-client/api/spellcheck_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#spellcheck_check_sentence(value, opts = {}) ⇒ CheckSentenceResponse

Check if sentence is spelled correctly Checks whether the sentence is spelled correctly and returns the result as JSON

Parameters:

  • value —

    Input sentence

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cloudmersive-nlp-api-client/api/spellcheck_api.rb', line 27

def spellcheck_check_sentence(value, opts = {})
  data, _status_code, _headers = spellcheck_check_sentence_with_http_info(value, opts)
  data
end

#spellcheck_check_sentence_with_http_info(value, opts = {}) ⇒ Array<(CheckSentenceResponse, Fixnum, Hash)>

Check if sentence is spelled correctly Checks whether the sentence is spelled correctly and returns the result as JSON

Parameters:

  • value —

    Input sentence

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

    the optional parameters

Returns:

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

    CheckSentenceResponse data, response status code and response headers



37
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
 
# File 'lib/cloudmersive-nlp-api-client/api/spellcheck_api.rb', line 37

def spellcheck_check_sentence_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpellcheckApi.spellcheck_check_sentence ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling SpellcheckApi.spellcheck_check_sentence"
  end
  # resource path
  local_var_path = '/nlp-v2/spellcheck/check/sentence'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  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 => 'CheckSentenceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpellcheckApi#spellcheck_check_sentence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#spellcheck_correct_json(value, opts = {}) ⇒ CheckWordResponse

Find spelling corrections Find spelling correction suggestions and return result as JSON

Parameters:

  • value —

    Input string

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/cloudmersive-nlp-api-client/api/spellcheck_api.rb', line 81

def spellcheck_correct_json(value, opts = {})
  data, _status_code, _headers = spellcheck_correct_json_with_http_info(value, opts)
  data
end

#spellcheck_correct_json_with_http_info(value, opts = {}) ⇒ Array<(CheckWordResponse, Fixnum, Hash)>

Find spelling corrections Find spelling correction suggestions and return result as JSON

Parameters:

  • value —

    Input string

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

    the optional parameters

Returns:

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

    CheckWordResponse data, response status code and response headers



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
 
# File 'lib/cloudmersive-nlp-api-client/api/spellcheck_api.rb', line 91

def spellcheck_correct_json_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpellcheckApi.spellcheck_correct_json ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling SpellcheckApi.spellcheck_correct_json"
  end
  # resource path
  local_var_path = '/nlp-v2/spellcheck/check/word'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  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 => 'CheckWordResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpellcheckApi#spellcheck_correct_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end