Class: AsposeWordsCloud::ClassifyDocumentOnlineRequest
- Inherits:
-
Object
- Object
- AsposeWordsCloud::ClassifyDocumentOnlineRequest
- Defined in:
- lib/aspose_words_cloud/models/requests/classify_document_online_request.rb
Overview
Request model for classify_document_online operation.
Instance Attribute Summary collapse
-
#best_classes_count ⇒ Object
The number of the best classes to return.
-
#document ⇒ Object
The document.
-
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
-
#password ⇒ Object
Password for opening an encrypted document.
-
#taxonomy ⇒ Object
The taxonomy to use.
Instance Method Summary collapse
- #create_http_request(api_client) ⇒ Object
-
#downcase_first_letter(str) ⇒ Object
Helper method to convert first letter to downcase.
-
#get_response_type ⇒ Object
Get response type.
-
#initialize(document:, load_encoding: nil, password: nil, best_classes_count: nil, taxonomy: nil) ⇒ ClassifyDocumentOnlineRequest
constructor
Initializes a new instance.
-
#to_batch_part(api_client) ⇒ Object
Creating batch part from request.
Constructor Details
#initialize(document:, load_encoding: nil, password: nil, best_classes_count: nil, taxonomy: nil) ⇒ ClassifyDocumentOnlineRequest
Initializes a new instance.
55 56 57 58 59 60 61 |
# File 'lib/aspose_words_cloud/models/requests/classify_document_online_request.rb', line 55 def initialize(document:, load_encoding: nil, password: nil, best_classes_count: nil, taxonomy: nil) self.document = document self.load_encoding = load_encoding self.password = password self.best_classes_count = best_classes_count self.taxonomy = taxonomy end |
Instance Attribute Details
#best_classes_count ⇒ Object
The number of the best classes to return.
42 43 44 |
# File 'lib/aspose_words_cloud/models/requests/classify_document_online_request.rb', line 42 def best_classes_count @best_classes_count end |
#document ⇒ Object
The document.
33 34 35 |
# File 'lib/aspose_words_cloud/models/requests/classify_document_online_request.rb', line 33 def document @document end |
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
36 37 38 |
# File 'lib/aspose_words_cloud/models/requests/classify_document_online_request.rb', line 36 def load_encoding @load_encoding end |
#password ⇒ Object
Password for opening an encrypted document.
39 40 41 |
# File 'lib/aspose_words_cloud/models/requests/classify_document_online_request.rb', line 39 def password @password end |
#taxonomy ⇒ Object
The taxonomy to use.
45 46 47 |
# File 'lib/aspose_words_cloud/models/requests/classify_document_online_request.rb', line 45 def taxonomy @taxonomy end |
Instance Method Details
#create_http_request(api_client) ⇒ Object
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/aspose_words_cloud/models/requests/classify_document_online_request.rb', line 115 def create_http_request(api_client) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.classify_document_online' if api_client.config.client_side_validation && self.document.nil? # resource path local_var_path = '/words/online/get/classify'[1..-1] local_var_path = local_var_path.sub('//', '/') # query parameters query_params = {} query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil? query_params[downcase_first_letter('Password')] = self.password unless self.password.nil? query_params[downcase_first_letter('BestClassesCount')] = self.best_classes_count unless self.best_classes_count.nil? query_params[downcase_first_letter('Taxonomy')] = self.taxonomy unless self.taxonomy.nil? # header parameters header_params = {} # HTTP header 'Content-Type' header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data']) # form parameters form_params = {} form_params[downcase_first_letter('Document')] = self.document # http body (model) post_body = nil body = api_client.build_request_body(header_params, form_params, 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
155 156 157 |
# File 'lib/aspose_words_cloud/models/requests/classify_document_online_request.rb', line 155 def downcase_first_letter(str) str[0].downcase + str[1..-1] end |
#get_response_type ⇒ Object
Get response type
160 161 162 |
# File 'lib/aspose_words_cloud/models/requests/classify_document_online_request.rb', line 160 def get_response_type 'ClassificationResponse' end |
#to_batch_part(api_client) ⇒ Object
Creating batch part from request
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 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/aspose_words_cloud/models/requests/classify_document_online_request.rb', line 64 def to_batch_part(api_client) # verify the required parameter 'document' is set raise ArgumentError, 'Missing the required parameter document when calling WordsApi.classify_document_online' if api_client.config.client_side_validation && self.document.nil? # resource path local_var_path = '/words/online/get/classify'[7..-1] local_var_path = local_var_path.sub('//', '/') # query parameters query_params = {} query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil? query_params[downcase_first_letter('Password')] = self.password unless self.password.nil? query_params[downcase_first_letter('BestClassesCount')] = self.best_classes_count unless self.best_classes_count.nil? query_params[downcase_first_letter('Taxonomy')] = self.taxonomy unless self.taxonomy.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(['multipart/form-data']) # form parameters form_params = {} form_params[downcase_first_letter('Document')] = self.document # http body (model) post_body = nil body = api_client.build_request_body_batch(header_params, form_params, 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 |