Class: WordsRubySdk::ClassifyDocumentRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/words_ruby_sdk/models/requests/ClassifyDocumentRequest.rb

Overview

Request model for classify_document operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document_name, folder = nil, storage = nil, load_encoding = nil, password = nil, best_classes_count = nil) ⇒ ClassifyDocumentRequest

Initializes a new instance.

Parameters:

  • document_name —

    The document name.

  • folder (defaults to: nil) —

    Original document folder.

  • storage (defaults to: nil) —

    File storage, which have to be used.

  • load_encoding (defaults to: nil) —

    Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

  • password (defaults to: nil) —

    Password for opening an encrypted document.

  • best_classes_count (defaults to: nil) —

    Count of the best classes to return.



56
57
58
59
60
61
62
63
 
# File 'lib/words_ruby_sdk/models/requests/ClassifyDocumentRequest.rb', line 56

def initialize(document_name, folder = nil, storage = nil, load_encoding = nil, password = nil, best_classes_count = nil)
   self.document_name = document_name
   self.folder = folder
   self.storage = storage
   self.load_encoding = load_encoding
   self.password = password
   self.best_classes_count = best_classes_count
end

Instance Attribute Details

#best_classes_count ⇒ Object

Count of the best classes to return.



46
47
48
 
# File 'lib/words_ruby_sdk/models/requests/ClassifyDocumentRequest.rb', line 46

def best_classes_count
  @best_classes_count
end

#document_name ⇒ Object

The document name.



36
37
38
 
# File 'lib/words_ruby_sdk/models/requests/ClassifyDocumentRequest.rb', line 36

def document_name
  @document_name
end

#folder ⇒ Object

Original document folder.



38
39
40
 
# File 'lib/words_ruby_sdk/models/requests/ClassifyDocumentRequest.rb', line 38

def folder
  @folder
end

#load_encoding ⇒ Object

Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.



42
43
44
 
# File 'lib/words_ruby_sdk/models/requests/ClassifyDocumentRequest.rb', line 42

def load_encoding
  @load_encoding
end

#password ⇒ Object

Password for opening an encrypted document.



44
45
46
 
# File 'lib/words_ruby_sdk/models/requests/ClassifyDocumentRequest.rb', line 44

def password
  @password
end

#storage ⇒ Object

File storage, which have to be used.



40
41
42
 
# File 'lib/words_ruby_sdk/models/requests/ClassifyDocumentRequest.rb', line 40

def storage
  @storage
end