cloudmersive-ocr-api-client 1.3.9 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +10 -4
- data/docs/FieldResult.md +9 -0
- data/docs/FormDefinitionTemplate.md +8 -0
- data/docs/FormFieldDefinition.md +20 -0
- data/docs/FormRecognitionResult.md +9 -0
- data/docs/ImageOcrApi.md +67 -0
- data/docs/ReceiptLineItem.md +9 -0
- data/docs/ReceiptRecognitionResult.md +2 -0
- data/lib/cloudmersive-ocr-api-client.rb +5 -0
- data/lib/cloudmersive-ocr-api-client/api/image_ocr_api.rb +71 -0
- data/lib/cloudmersive-ocr-api-client/models/field_result.rb +199 -0
- data/lib/cloudmersive-ocr-api-client/models/form_definition_template.rb +190 -0
- data/lib/cloudmersive-ocr-api-client/models/form_field_definition.rb +298 -0
- data/lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb +199 -0
- data/lib/cloudmersive-ocr-api-client/models/receipt_line_item.rb +197 -0
- data/lib/cloudmersive-ocr-api-client/models/receipt_recognition_result.rb +21 -1
- data/lib/cloudmersive-ocr-api-client/version.rb +1 -1
- data/spec/api/image_ocr_api_spec.rb +17 -0
- data/spec/models/field_result_spec.rb +48 -0
- data/spec/models/form_definition_template_spec.rb +42 -0
- data/spec/models/form_field_definition_spec.rb +114 -0
- data/spec/models/form_recognition_result_spec.rb +48 -0
- data/spec/models/receipt_line_item_spec.rb +48 -0
- data/spec/models/receipt_recognition_result_spec.rb +12 -0
- metadata +17 -2
@@ -0,0 +1,199 @@
|
|
1
|
+
=begin
|
2
|
+
#ocrapi
|
3
|
+
|
4
|
+
#The powerful Optical Character Recognition (OCR) APIs let you convert scanned images of pages into recognized text.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: unset
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module CloudmersiveOcrApiClient
|
16
|
+
# The result of extracting form field values
|
17
|
+
class FormRecognitionResult
|
18
|
+
attr_accessor :successful
|
19
|
+
|
20
|
+
attr_accessor :field_value_extraction_result
|
21
|
+
|
22
|
+
|
23
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
24
|
+
def self.attribute_map
|
25
|
+
{
|
26
|
+
:'successful' => :'Successful',
|
27
|
+
:'field_value_extraction_result' => :'FieldValueExtractionResult'
|
28
|
+
}
|
29
|
+
end
|
30
|
+
|
31
|
+
# Attribute type mapping.
|
32
|
+
def self.swagger_types
|
33
|
+
{
|
34
|
+
:'successful' => :'BOOLEAN',
|
35
|
+
:'field_value_extraction_result' => :'Array<FieldResult>'
|
36
|
+
}
|
37
|
+
end
|
38
|
+
|
39
|
+
# Initializes the object
|
40
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
41
|
+
def initialize(attributes = {})
|
42
|
+
return unless attributes.is_a?(Hash)
|
43
|
+
|
44
|
+
# convert string to symbol for hash key
|
45
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
46
|
+
|
47
|
+
if attributes.has_key?(:'Successful')
|
48
|
+
self.successful = attributes[:'Successful']
|
49
|
+
end
|
50
|
+
|
51
|
+
if attributes.has_key?(:'FieldValueExtractionResult')
|
52
|
+
if (value = attributes[:'FieldValueExtractionResult']).is_a?(Array)
|
53
|
+
self.field_value_extraction_result = value
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
end
|
58
|
+
|
59
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
60
|
+
# @return Array for valid properties with the reasons
|
61
|
+
def list_invalid_properties
|
62
|
+
invalid_properties = Array.new
|
63
|
+
return invalid_properties
|
64
|
+
end
|
65
|
+
|
66
|
+
# Check to see if the all the properties in the model are valid
|
67
|
+
# @return true if the model is valid
|
68
|
+
def valid?
|
69
|
+
return true
|
70
|
+
end
|
71
|
+
|
72
|
+
# Checks equality by comparing each attribute.
|
73
|
+
# @param [Object] Object to be compared
|
74
|
+
def ==(o)
|
75
|
+
return true if self.equal?(o)
|
76
|
+
self.class == o.class &&
|
77
|
+
successful == o.successful &&
|
78
|
+
field_value_extraction_result == o.field_value_extraction_result
|
79
|
+
end
|
80
|
+
|
81
|
+
# @see the `==` method
|
82
|
+
# @param [Object] Object to be compared
|
83
|
+
def eql?(o)
|
84
|
+
self == o
|
85
|
+
end
|
86
|
+
|
87
|
+
# Calculates hash code according to all attributes.
|
88
|
+
# @return [Fixnum] Hash code
|
89
|
+
def hash
|
90
|
+
[successful, field_value_extraction_result].hash
|
91
|
+
end
|
92
|
+
|
93
|
+
# Builds the object from hash
|
94
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
95
|
+
# @return [Object] Returns the model itself
|
96
|
+
def build_from_hash(attributes)
|
97
|
+
return nil unless attributes.is_a?(Hash)
|
98
|
+
self.class.swagger_types.each_pair do |key, type|
|
99
|
+
if type =~ /\AArray<(.*)>/i
|
100
|
+
# check to ensure the input is an array given that the the attribute
|
101
|
+
# is documented as an array but the input is not
|
102
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
103
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
104
|
+
end
|
105
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
106
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
107
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
108
|
+
end
|
109
|
+
|
110
|
+
self
|
111
|
+
end
|
112
|
+
|
113
|
+
# Deserializes the data based on type
|
114
|
+
# @param string type Data type
|
115
|
+
# @param string value Value to be deserialized
|
116
|
+
# @return [Object] Deserialized data
|
117
|
+
def _deserialize(type, value)
|
118
|
+
case type.to_sym
|
119
|
+
when :DateTime
|
120
|
+
DateTime.parse(value)
|
121
|
+
when :Date
|
122
|
+
Date.parse(value)
|
123
|
+
when :String
|
124
|
+
value.to_s
|
125
|
+
when :Integer
|
126
|
+
value.to_i
|
127
|
+
when :Float
|
128
|
+
value.to_f
|
129
|
+
when :BOOLEAN
|
130
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
131
|
+
true
|
132
|
+
else
|
133
|
+
false
|
134
|
+
end
|
135
|
+
when :Object
|
136
|
+
# generic object (usually a Hash), return directly
|
137
|
+
value
|
138
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
139
|
+
inner_type = Regexp.last_match[:inner_type]
|
140
|
+
value.map { |v| _deserialize(inner_type, v) }
|
141
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
142
|
+
k_type = Regexp.last_match[:k_type]
|
143
|
+
v_type = Regexp.last_match[:v_type]
|
144
|
+
{}.tap do |hash|
|
145
|
+
value.each do |k, v|
|
146
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
147
|
+
end
|
148
|
+
end
|
149
|
+
else # model
|
150
|
+
temp_model = CloudmersiveOcrApiClient.const_get(type).new
|
151
|
+
temp_model.build_from_hash(value)
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
155
|
+
# Returns the string representation of the object
|
156
|
+
# @return [String] String presentation of the object
|
157
|
+
def to_s
|
158
|
+
to_hash.to_s
|
159
|
+
end
|
160
|
+
|
161
|
+
# to_body is an alias to to_hash (backward compatibility)
|
162
|
+
# @return [Hash] Returns the object in the form of hash
|
163
|
+
def to_body
|
164
|
+
to_hash
|
165
|
+
end
|
166
|
+
|
167
|
+
# Returns the object in the form of hash
|
168
|
+
# @return [Hash] Returns the object in the form of hash
|
169
|
+
def to_hash
|
170
|
+
hash = {}
|
171
|
+
self.class.attribute_map.each_pair do |attr, param|
|
172
|
+
value = self.send(attr)
|
173
|
+
next if value.nil?
|
174
|
+
hash[param] = _to_hash(value)
|
175
|
+
end
|
176
|
+
hash
|
177
|
+
end
|
178
|
+
|
179
|
+
# Outputs non-array value in the form of hash
|
180
|
+
# For object, use to_hash. Otherwise, just return the value
|
181
|
+
# @param [Object] value Any valid value
|
182
|
+
# @return [Hash] Returns the value in the form of hash
|
183
|
+
def _to_hash(value)
|
184
|
+
if value.is_a?(Array)
|
185
|
+
value.compact.map{ |v| _to_hash(v) }
|
186
|
+
elsif value.is_a?(Hash)
|
187
|
+
{}.tap do |hash|
|
188
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
189
|
+
end
|
190
|
+
elsif value.respond_to? :to_hash
|
191
|
+
value.to_hash
|
192
|
+
else
|
193
|
+
value
|
194
|
+
end
|
195
|
+
end
|
196
|
+
|
197
|
+
end
|
198
|
+
|
199
|
+
end
|
@@ -0,0 +1,197 @@
|
|
1
|
+
=begin
|
2
|
+
#ocrapi
|
3
|
+
|
4
|
+
#The powerful Optical Character Recognition (OCR) APIs let you convert scanned images of pages into recognized text.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: unset
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module CloudmersiveOcrApiClient
|
16
|
+
# Receipt line item, comprised of a product or item and a price (if available)
|
17
|
+
class ReceiptLineItem
|
18
|
+
attr_accessor :item_description
|
19
|
+
|
20
|
+
attr_accessor :item_price
|
21
|
+
|
22
|
+
|
23
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
24
|
+
def self.attribute_map
|
25
|
+
{
|
26
|
+
:'item_description' => :'ItemDescription',
|
27
|
+
:'item_price' => :'ItemPrice'
|
28
|
+
}
|
29
|
+
end
|
30
|
+
|
31
|
+
# Attribute type mapping.
|
32
|
+
def self.swagger_types
|
33
|
+
{
|
34
|
+
:'item_description' => :'String',
|
35
|
+
:'item_price' => :'Float'
|
36
|
+
}
|
37
|
+
end
|
38
|
+
|
39
|
+
# Initializes the object
|
40
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
41
|
+
def initialize(attributes = {})
|
42
|
+
return unless attributes.is_a?(Hash)
|
43
|
+
|
44
|
+
# convert string to symbol for hash key
|
45
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
46
|
+
|
47
|
+
if attributes.has_key?(:'ItemDescription')
|
48
|
+
self.item_description = attributes[:'ItemDescription']
|
49
|
+
end
|
50
|
+
|
51
|
+
if attributes.has_key?(:'ItemPrice')
|
52
|
+
self.item_price = attributes[:'ItemPrice']
|
53
|
+
end
|
54
|
+
|
55
|
+
end
|
56
|
+
|
57
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
58
|
+
# @return Array for valid properties with the reasons
|
59
|
+
def list_invalid_properties
|
60
|
+
invalid_properties = Array.new
|
61
|
+
return invalid_properties
|
62
|
+
end
|
63
|
+
|
64
|
+
# Check to see if the all the properties in the model are valid
|
65
|
+
# @return true if the model is valid
|
66
|
+
def valid?
|
67
|
+
return true
|
68
|
+
end
|
69
|
+
|
70
|
+
# Checks equality by comparing each attribute.
|
71
|
+
# @param [Object] Object to be compared
|
72
|
+
def ==(o)
|
73
|
+
return true if self.equal?(o)
|
74
|
+
self.class == o.class &&
|
75
|
+
item_description == o.item_description &&
|
76
|
+
item_price == o.item_price
|
77
|
+
end
|
78
|
+
|
79
|
+
# @see the `==` method
|
80
|
+
# @param [Object] Object to be compared
|
81
|
+
def eql?(o)
|
82
|
+
self == o
|
83
|
+
end
|
84
|
+
|
85
|
+
# Calculates hash code according to all attributes.
|
86
|
+
# @return [Fixnum] Hash code
|
87
|
+
def hash
|
88
|
+
[item_description, item_price].hash
|
89
|
+
end
|
90
|
+
|
91
|
+
# Builds the object from hash
|
92
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
93
|
+
# @return [Object] Returns the model itself
|
94
|
+
def build_from_hash(attributes)
|
95
|
+
return nil unless attributes.is_a?(Hash)
|
96
|
+
self.class.swagger_types.each_pair do |key, type|
|
97
|
+
if type =~ /\AArray<(.*)>/i
|
98
|
+
# check to ensure the input is an array given that the the attribute
|
99
|
+
# is documented as an array but the input is not
|
100
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
101
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
102
|
+
end
|
103
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
104
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
105
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
106
|
+
end
|
107
|
+
|
108
|
+
self
|
109
|
+
end
|
110
|
+
|
111
|
+
# Deserializes the data based on type
|
112
|
+
# @param string type Data type
|
113
|
+
# @param string value Value to be deserialized
|
114
|
+
# @return [Object] Deserialized data
|
115
|
+
def _deserialize(type, value)
|
116
|
+
case type.to_sym
|
117
|
+
when :DateTime
|
118
|
+
DateTime.parse(value)
|
119
|
+
when :Date
|
120
|
+
Date.parse(value)
|
121
|
+
when :String
|
122
|
+
value.to_s
|
123
|
+
when :Integer
|
124
|
+
value.to_i
|
125
|
+
when :Float
|
126
|
+
value.to_f
|
127
|
+
when :BOOLEAN
|
128
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
129
|
+
true
|
130
|
+
else
|
131
|
+
false
|
132
|
+
end
|
133
|
+
when :Object
|
134
|
+
# generic object (usually a Hash), return directly
|
135
|
+
value
|
136
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
137
|
+
inner_type = Regexp.last_match[:inner_type]
|
138
|
+
value.map { |v| _deserialize(inner_type, v) }
|
139
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
140
|
+
k_type = Regexp.last_match[:k_type]
|
141
|
+
v_type = Regexp.last_match[:v_type]
|
142
|
+
{}.tap do |hash|
|
143
|
+
value.each do |k, v|
|
144
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
145
|
+
end
|
146
|
+
end
|
147
|
+
else # model
|
148
|
+
temp_model = CloudmersiveOcrApiClient.const_get(type).new
|
149
|
+
temp_model.build_from_hash(value)
|
150
|
+
end
|
151
|
+
end
|
152
|
+
|
153
|
+
# Returns the string representation of the object
|
154
|
+
# @return [String] String presentation of the object
|
155
|
+
def to_s
|
156
|
+
to_hash.to_s
|
157
|
+
end
|
158
|
+
|
159
|
+
# to_body is an alias to to_hash (backward compatibility)
|
160
|
+
# @return [Hash] Returns the object in the form of hash
|
161
|
+
def to_body
|
162
|
+
to_hash
|
163
|
+
end
|
164
|
+
|
165
|
+
# Returns the object in the form of hash
|
166
|
+
# @return [Hash] Returns the object in the form of hash
|
167
|
+
def to_hash
|
168
|
+
hash = {}
|
169
|
+
self.class.attribute_map.each_pair do |attr, param|
|
170
|
+
value = self.send(attr)
|
171
|
+
next if value.nil?
|
172
|
+
hash[param] = _to_hash(value)
|
173
|
+
end
|
174
|
+
hash
|
175
|
+
end
|
176
|
+
|
177
|
+
# Outputs non-array value in the form of hash
|
178
|
+
# For object, use to_hash. Otherwise, just return the value
|
179
|
+
# @param [Object] value Any valid value
|
180
|
+
# @return [Hash] Returns the value in the form of hash
|
181
|
+
def _to_hash(value)
|
182
|
+
if value.is_a?(Array)
|
183
|
+
value.compact.map{ |v| _to_hash(v) }
|
184
|
+
elsif value.is_a?(Hash)
|
185
|
+
{}.tap do |hash|
|
186
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
187
|
+
end
|
188
|
+
elsif value.respond_to? :to_hash
|
189
|
+
value.to_hash
|
190
|
+
else
|
191
|
+
value
|
192
|
+
end
|
193
|
+
end
|
194
|
+
|
195
|
+
end
|
196
|
+
|
197
|
+
end
|
@@ -21,10 +21,14 @@ module CloudmersiveOcrApiClient
|
|
21
21
|
|
22
22
|
attr_accessor :business_name
|
23
23
|
|
24
|
+
attr_accessor :business_website
|
25
|
+
|
24
26
|
attr_accessor :address_string
|
25
27
|
|
26
28
|
attr_accessor :phone_number
|
27
29
|
|
30
|
+
attr_accessor :receipt_items
|
31
|
+
|
28
32
|
attr_accessor :receipt_total
|
29
33
|
|
30
34
|
|
@@ -34,8 +38,10 @@ module CloudmersiveOcrApiClient
|
|
34
38
|
:'successful' => :'Successful',
|
35
39
|
:'timestamp' => :'Timestamp',
|
36
40
|
:'business_name' => :'BusinessName',
|
41
|
+
:'business_website' => :'BusinessWebsite',
|
37
42
|
:'address_string' => :'AddressString',
|
38
43
|
:'phone_number' => :'PhoneNumber',
|
44
|
+
:'receipt_items' => :'ReceiptItems',
|
39
45
|
:'receipt_total' => :'ReceiptTotal'
|
40
46
|
}
|
41
47
|
end
|
@@ -46,8 +52,10 @@ module CloudmersiveOcrApiClient
|
|
46
52
|
:'successful' => :'BOOLEAN',
|
47
53
|
:'timestamp' => :'DateTime',
|
48
54
|
:'business_name' => :'String',
|
55
|
+
:'business_website' => :'String',
|
49
56
|
:'address_string' => :'String',
|
50
57
|
:'phone_number' => :'String',
|
58
|
+
:'receipt_items' => :'Array<ReceiptLineItem>',
|
51
59
|
:'receipt_total' => :'Float'
|
52
60
|
}
|
53
61
|
end
|
@@ -72,6 +80,10 @@ module CloudmersiveOcrApiClient
|
|
72
80
|
self.business_name = attributes[:'BusinessName']
|
73
81
|
end
|
74
82
|
|
83
|
+
if attributes.has_key?(:'BusinessWebsite')
|
84
|
+
self.business_website = attributes[:'BusinessWebsite']
|
85
|
+
end
|
86
|
+
|
75
87
|
if attributes.has_key?(:'AddressString')
|
76
88
|
self.address_string = attributes[:'AddressString']
|
77
89
|
end
|
@@ -80,6 +92,12 @@ module CloudmersiveOcrApiClient
|
|
80
92
|
self.phone_number = attributes[:'PhoneNumber']
|
81
93
|
end
|
82
94
|
|
95
|
+
if attributes.has_key?(:'ReceiptItems')
|
96
|
+
if (value = attributes[:'ReceiptItems']).is_a?(Array)
|
97
|
+
self.receipt_items = value
|
98
|
+
end
|
99
|
+
end
|
100
|
+
|
83
101
|
if attributes.has_key?(:'ReceiptTotal')
|
84
102
|
self.receipt_total = attributes[:'ReceiptTotal']
|
85
103
|
end
|
@@ -107,8 +125,10 @@ module CloudmersiveOcrApiClient
|
|
107
125
|
successful == o.successful &&
|
108
126
|
timestamp == o.timestamp &&
|
109
127
|
business_name == o.business_name &&
|
128
|
+
business_website == o.business_website &&
|
110
129
|
address_string == o.address_string &&
|
111
130
|
phone_number == o.phone_number &&
|
131
|
+
receipt_items == o.receipt_items &&
|
112
132
|
receipt_total == o.receipt_total
|
113
133
|
end
|
114
134
|
|
@@ -121,7 +141,7 @@ module CloudmersiveOcrApiClient
|
|
121
141
|
# Calculates hash code according to all attributes.
|
122
142
|
# @return [Fixnum] Hash code
|
123
143
|
def hash
|
124
|
-
[successful, timestamp, business_name, address_string, phone_number, receipt_total].hash
|
144
|
+
[successful, timestamp, business_name, business_website, address_string, phone_number, receipt_items, receipt_total].hash
|
125
145
|
end
|
126
146
|
|
127
147
|
# Builds the object from hash
|