Class: AsposeWordsCloud::ClassifyRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/requests/classify_request.rb

Overview

Request model for classify operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(text:, best_classes_count: nil) ⇒ ClassifyRequest

Initializes a new instance.

Parameters:

  • text —

    The text to classify.

  • best_classes_count (defaults to: nil) —

    The number of the best classes to return.



43
44
45
46
 
# File 'lib/aspose_words_cloud/models/requests/classify_request.rb', line 43

def initialize(text:, best_classes_count: nil)
  self.text = text
  self.best_classes_count = best_classes_count
end

Instance Attribute Details

#best_classes_count ⇒ Object

The number of the best classes to return.



36
37
38
 
# File 'lib/aspose_words_cloud/models/requests/classify_request.rb', line 36

def best_classes_count
  @best_classes_count
end

#text ⇒ Object

The text to classify.



33
34
35
 
# File 'lib/aspose_words_cloud/models/requests/classify_request.rb', line 33

def text
  @text
end

Instance Method Details

#create_http_request(api_client) ⇒ Object

Raises:

  • (ArgumentError) 


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
 
# File 'lib/aspose_words_cloud/models/requests/classify_request.rb', line 96

def create_http_request(api_client)
  # verify the required parameter 'text' is set
  raise ArgumentError, 'Missing the required parameter text when calling WordsApi.classify' if api_client.config.client_side_validation && self.text.nil?

  # resource path
  local_var_path = '/words/classify'[1..-1]
  local_var_path = local_var_path.sub('//', '/')

  # query parameters
  query_params = {}
  query_params[downcase_first_letter('BestClassesCount')] = self.best_classes_count unless self.best_classes_count.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/xml', 'application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(self.text)
  body = post_body
  {
    'method': :PUT,
    'path': local_var_path,
    'header_params': header_params,
    'query_params': query_params,
    'body': body,
    'auth_names': ['JWT']
  }
end

#downcase_first_letter(str) ⇒ Object

Helper method to convert first letter to downcase



132
133
134
 
# File 'lib/aspose_words_cloud/models/requests/classify_request.rb', line 132

def downcase_first_letter(str)
  str[0].downcase + str[1..-1]
end

#get_response_type ⇒ Object

Get response type



137
138
139
 
# File 'lib/aspose_words_cloud/models/requests/classify_request.rb', line 137

def get_response_type
  'ClassificationResponse'
end

#to_batch_part(api_client) ⇒ Object

Creating batch part from request

Raises:

  • (ArgumentError) 


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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/aspose_words_cloud/models/requests/classify_request.rb', line 49

def to_batch_part(api_client)
  # verify the required parameter 'text' is set
  raise ArgumentError, 'Missing the required parameter text when calling WordsApi.classify' if api_client.config.client_side_validation && self.text.nil?

  # resource path
  local_var_path = '/words/classify'[7..-1]
  local_var_path = local_var_path.sub('//', '/')

  # query parameters
  query_params = {}
  query_params[downcase_first_letter('BestClassesCount')] = self.best_classes_count unless self.best_classes_count.nil?

  if query_params
    query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
  end

  header_params = {}
  # header parameters
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = api_client.select_header_content_type(['application/xml', 'application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = api_client.object_to_http_body(self.text)
  body = post_body
  part = ""
  part.concat("PUT".force_encoding('UTF-8'))
  part.concat(" ".force_encoding('UTF-8'))
  part.concat(local_var_path.force_encoding('UTF-8'))
  part.concat(" \r\n".force_encoding('UTF-8'))

  header_params.each_pair {|key, value| part.concat(key.dup.force_encoding('UTF-8') , ": ".force_encoding('UTF-8'), value.dup.force_encoding('UTF-8'), "\r\n".force_encoding('UTF-8')) }
  part.concat("\r\n".force_encoding('UTF-8'))
  if body
    if body.is_a?(Hash)
      body.each do |key, value|
      part.concat(value, "\r\n")
    end
    else
      part.concat(body)
    end
  end
 part
end