Class: CloudmersiveNlpApiClient::AnalyticsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AnalyticsApi

Returns a new instance of AnalyticsApi.



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

def api_client
  @api_client
end

Instance Method Details

#analytics_hate_speech(input, opts = {}) ⇒ HateSpeechAnalysisResponse

Perform Hate Speech Analysis and Detection on Text Analyze input text using advanced Hate Speech Analysis to determine if the input contains hate speech language. Supports English language input. Consumes 1-2 API calls per sentence.

Parameters:

  • input —

    Input hate speech analysis request

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

    the optional parameters

Returns:



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

def analytics_hate_speech(input, opts = {})
  data, _status_code, _headers = analytics_hate_speech_with_http_info(input, opts)
  return data
end

#analytics_hate_speech_with_http_info(input, opts = {}) ⇒ Array<(HateSpeechAnalysisResponse, Fixnum, Hash)>

Perform Hate Speech Analysis and Detection on Text Analyze input text using advanced Hate Speech Analysis to determine if the input contains hate speech language. Supports English language input. Consumes 1-2 API calls per sentence.

Parameters:

  • input —

    Input hate speech analysis request

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

    the optional parameters

Returns:

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

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

def analytics_hate_speech_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi.analytics_hate_speech ..."
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling AnalyticsApi.analytics_hate_speech"
  end
  # resource path
  local_var_path = "/nlp-v2/analytics/hate-speech"

  # 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(input)
  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 => 'HateSpeechAnalysisResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#analytics_hate_speech\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#analytics_profanity(input, opts = {}) ⇒ ProfanityAnalysisResponse

Perform Profanity and Obscene Language Analysis and Detection on Text Analyze input text using advanced Profanity and Obscene Language Analysis to determine if the input contains profane language. Supports English language input. Consumes 1-2 API calls per sentence.

Parameters:

  • input —

    Input profanity analysis request

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

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/cloudmersive-nlp-api-client/api/analytics_api.rb', line 83

def analytics_profanity(input, opts = {})
  data, _status_code, _headers = analytics_profanity_with_http_info(input, opts)
  return data
end

#analytics_profanity_with_http_info(input, opts = {}) ⇒ Array<(ProfanityAnalysisResponse, Fixnum, Hash)>

Perform Profanity and Obscene Language Analysis and Detection on Text Analyze input text using advanced Profanity and Obscene Language Analysis to determine if the input contains profane language. Supports English language input. Consumes 1-2 API calls per sentence.

Parameters:

  • input —

    Input profanity analysis request

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

    the optional parameters

Returns:

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

    ProfanityAnalysisResponse data, response status code and response headers



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
130
131
 
# File 'lib/cloudmersive-nlp-api-client/api/analytics_api.rb', line 93

def analytics_profanity_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi.analytics_profanity ..."
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling AnalyticsApi.analytics_profanity"
  end
  # resource path
  local_var_path = "/nlp-v2/analytics/profanity"

  # 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(input)
  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 => 'ProfanityAnalysisResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#analytics_profanity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#analytics_sentiment(input, opts = {}) ⇒ SentimentAnalysisResponse

Perform Sentiment Analysis and Classification on Text Analyze input text using advanced Sentiment Analysis to determine if the input is positive, negative, or neutral. Supports English language input. Consumes 1-2 API calls per sentence.

Parameters:

  • input —

    Input sentiment analysis request

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

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/cloudmersive-nlp-api-client/api/analytics_api.rb', line 138

def analytics_sentiment(input, opts = {})
  data, _status_code, _headers = analytics_sentiment_with_http_info(input, opts)
  return data
end

#analytics_sentiment_with_http_info(input, opts = {}) ⇒ Array<(SentimentAnalysisResponse, Fixnum, Hash)>

Perform Sentiment Analysis and Classification on Text Analyze input text using advanced Sentiment Analysis to determine if the input is positive, negative, or neutral. Supports English language input. Consumes 1-2 API calls per sentence.

Parameters:

  • input —

    Input sentiment analysis request

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

    the optional parameters

Returns:

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

    SentimentAnalysisResponse data, response status code and response headers



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/cloudmersive-nlp-api-client/api/analytics_api.rb', line 148

def analytics_sentiment_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi.analytics_sentiment ..."
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling AnalyticsApi.analytics_sentiment"
  end
  # resource path
  local_var_path = "/nlp-v2/analytics/sentiment"

  # 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(input)
  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 => 'SentimentAnalysisResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#analytics_sentiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#analytics_similarity(input, opts = {}) ⇒ SimilarityAnalysisResponse

Perform Semantic Similarity Comparison of Two Strings Analyze two input text strings, typically sentences, and determine the semantic similarity of each. Semantic similarity refers to the degree to which two sentences mean the same thing semantically. Uses advanced Deep Learning to perform the semantic similarity comparison. Consumes 1-2 API calls per sentence.

Parameters:

  • input —

    Input similarity analysis request

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

    the optional parameters

Returns:



193
194
195
196
 
# File 'lib/cloudmersive-nlp-api-client/api/analytics_api.rb', line 193

def analytics_similarity(input, opts = {})
  data, _status_code, _headers = analytics_similarity_with_http_info(input, opts)
  return data
end

#analytics_similarity_with_http_info(input, opts = {}) ⇒ Array<(SimilarityAnalysisResponse, Fixnum, Hash)>

Perform Semantic Similarity Comparison of Two Strings Analyze two input text strings, typically sentences, and determine the semantic similarity of each. Semantic similarity refers to the degree to which two sentences mean the same thing semantically. Uses advanced Deep Learning to perform the semantic similarity comparison. Consumes 1-2 API calls per sentence.

Parameters:

  • input —

    Input similarity analysis request

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

    the optional parameters

Returns:

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

    SimilarityAnalysisResponse data, response status code and response headers



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/cloudmersive-nlp-api-client/api/analytics_api.rb', line 203

def analytics_similarity_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi.analytics_similarity ..."
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling AnalyticsApi.analytics_similarity"
  end
  # resource path
  local_var_path = "/nlp-v2/analytics/similarity"

  # 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(input)
  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 => 'SimilarityAnalysisResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#analytics_similarity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#analytics_subjectivity(input, opts = {}) ⇒ SubjectivityAnalysisResponse

Perform Subjectivity and Objectivity Analysis on Text Analyze input text using advanced Subjectivity and Objectivity Language Analysis to determine if the input text is objective or subjective, and how much. Supports English language input. Consumes 1-2 API calls per sentence.

Parameters:

  • input —

    Input subjectivity analysis request

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

    the optional parameters

Returns:



248
249
250
251
 
# File 'lib/cloudmersive-nlp-api-client/api/analytics_api.rb', line 248

def analytics_subjectivity(input, opts = {})
  data, _status_code, _headers = analytics_subjectivity_with_http_info(input, opts)
  return data
end

#analytics_subjectivity_with_http_info(input, opts = {}) ⇒ Array<(SubjectivityAnalysisResponse, Fixnum, Hash)>

Perform Subjectivity and Objectivity Analysis on Text Analyze input text using advanced Subjectivity and Objectivity Language Analysis to determine if the input text is objective or subjective, and how much. Supports English language input. Consumes 1-2 API calls per sentence.

Parameters:

  • input —

    Input subjectivity analysis request

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

    the optional parameters

Returns:



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/cloudmersive-nlp-api-client/api/analytics_api.rb', line 258

def analytics_subjectivity_with_http_info(input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsApi.analytics_subjectivity ..."
  end
  # verify the required parameter 'input' is set
  if @api_client.config.client_side_validation && input.nil?
    fail ArgumentError, "Missing the required parameter 'input' when calling AnalyticsApi.analytics_subjectivity"
  end
  # resource path
  local_var_path = "/nlp-v2/analytics/subjectivity"

  # 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(input)
  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 => 'SubjectivityAnalysisResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#analytics_subjectivity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end