cloudmersive-ocr-api-client 1.4.5 → 1.4.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +4 -4
- data/docs/FormFieldDefinition.md +2 -1
- data/docs/FormRecognitionResult.md +1 -0
- data/lib/cloudmersive-ocr-api-client/models/form_field_definition.rb +12 -2
- data/lib/cloudmersive-ocr-api-client/models/form_recognition_result.rb +14 -4
- data/lib/cloudmersive-ocr-api-client/version.rb +1 -1
- data/spec/models/form_field_definition_spec.rb +6 -0
- data/spec/models/form_recognition_result_spec.rb +6 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 27ea16852320b70be6efa10ca58337df1e3b61f4e8de81c1c34d5c67bbe93606
|
4
|
+
data.tar.gz: 9e8cdc8e600b156fdb0a74b50448e903290f75b88cad6c226ff985abc143ee1c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7ed28e34f349a54f15cb03671406a543f934ead6a927caf9c954cc6fd4e3703b3433e0379df2a08333d43a077612824750c721194335dcd28883075bf1d20439
|
7
|
+
data.tar.gz: b0543976fe37c801ef3b6046caf8744c4d471c2fd0dda1a87f9a12dcdf6a387f0c7b3d84dee0c3bdfc0ddee44370dcd88bf931b490e1056fc58aaa21c05ec219
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The powerful Optical Character Recognition (OCR) APIs let you convert scanned im
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 1.4.
|
10
|
+
- Package version: 1.4.6
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-ocr-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-ocr-api-client-1.4.
|
26
|
+
gem install ./cloudmersive-ocr-api-client-1.4.6.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-ocr-api-client-1.4.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-ocr-api-client-1.4.6.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'cloudmersive-ocr-api-client', '~> 1.4.
|
34
|
+
gem 'cloudmersive-ocr-api-client', '~> 1.4.6'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
data/docs/FormFieldDefinition.md
CHANGED
@@ -3,9 +3,10 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**field_id** | **String** | The identifier of the field; use this to identify which field is being referenced | [optional]
|
6
|
+
**field_id** | **String** | The identifier of the field; use this to identify which field is being referenced. Set to SkipField if you do not wish to return the value of this field in the result. | [optional]
|
7
7
|
**left_anchor** | **String** | Optional - the left-hand anchor of the field | [optional]
|
8
8
|
**top_anchor** | **String** | Optional - the top anchor of the field | [optional]
|
9
|
+
**bottom_anchor** | **String** | Optional - the bottom anchor of the field | [optional]
|
9
10
|
**anchor_mode** | **String** | Optional - the matching mode for the anchor. Possible values are Complete (requires the entire anchor to match) and Partial (allows only part of the anchor to match) and Horizontal (anchor must be laid out horizontally). Default is Partial. | [optional]
|
10
11
|
**data_type** | **String** | The data type of the field; possible values are INTEGER (Integer value), STRING (Arbitrary string value, spaces are permitted), DATE (Date in a structured format), DECIMAL (Decimal number), ALPHANUMERIC (Continuous alphanumeric string with no spaces), STRINGNOWHITESPACE (A string that contains no whitespace characters), SERIALNUMBER (A serial-number style string that contains letters and numbers, and certain symbols; must contain at least one number), ALPHAONLY (Alphabet characters only, no numbers or symbols or whitespace) | [optional]
|
11
12
|
**target_digit_count** | **Integer** | Optional - the target number of digits in the field; useful for fixed-length fields | [optional]
|
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
|
|
7
7
|
**field_value_extraction_result** | [**Array<FieldResult>**](FieldResult.md) | Result of form field OCR data extraction | [optional]
|
8
8
|
**table_value_extraction_results** | [**Array<TableResult>**](TableResult.md) | Result of form table OCR data extraction | [optional]
|
9
9
|
**diagnostics** | **Array<String>** | Diagnostic images - default is null, enable diagnostics=true to populate this parameter with one image per field | [optional]
|
10
|
+
**best_match_form_setting_name** | **String** | Optional; populated when using photo/recognize/form/advanced with the Setting Name of the best-matching highest-relevance form | [optional]
|
10
11
|
|
11
12
|
|
@@ -15,7 +15,7 @@ require 'date'
|
|
15
15
|
module CloudmersiveOcrApiClient
|
16
16
|
# Definition of a form field for OCR data extraction from images
|
17
17
|
class FormFieldDefinition
|
18
|
-
# The identifier of the field; use this to identify which field is being referenced
|
18
|
+
# The identifier of the field; use this to identify which field is being referenced. Set to SkipField if you do not wish to return the value of this field in the result.
|
19
19
|
attr_accessor :field_id
|
20
20
|
|
21
21
|
# Optional - the left-hand anchor of the field
|
@@ -24,6 +24,9 @@ module CloudmersiveOcrApiClient
|
|
24
24
|
# Optional - the top anchor of the field
|
25
25
|
attr_accessor :top_anchor
|
26
26
|
|
27
|
+
# Optional - the bottom anchor of the field
|
28
|
+
attr_accessor :bottom_anchor
|
29
|
+
|
27
30
|
# Optional - the matching mode for the anchor. Possible values are Complete (requires the entire anchor to match) and Partial (allows only part of the anchor to match) and Horizontal (anchor must be laid out horizontally). Default is Partial.
|
28
31
|
attr_accessor :anchor_mode
|
29
32
|
|
@@ -67,6 +70,7 @@ module CloudmersiveOcrApiClient
|
|
67
70
|
:'field_id' => :'FieldID',
|
68
71
|
:'left_anchor' => :'LeftAnchor',
|
69
72
|
:'top_anchor' => :'TopAnchor',
|
73
|
+
:'bottom_anchor' => :'BottomAnchor',
|
70
74
|
:'anchor_mode' => :'AnchorMode',
|
71
75
|
:'data_type' => :'DataType',
|
72
76
|
:'target_digit_count' => :'TargetDigitCount',
|
@@ -88,6 +92,7 @@ module CloudmersiveOcrApiClient
|
|
88
92
|
:'field_id' => :'String',
|
89
93
|
:'left_anchor' => :'String',
|
90
94
|
:'top_anchor' => :'String',
|
95
|
+
:'bottom_anchor' => :'String',
|
91
96
|
:'anchor_mode' => :'String',
|
92
97
|
:'data_type' => :'String',
|
93
98
|
:'target_digit_count' => :'Integer',
|
@@ -123,6 +128,10 @@ module CloudmersiveOcrApiClient
|
|
123
128
|
self.top_anchor = attributes[:'TopAnchor']
|
124
129
|
end
|
125
130
|
|
131
|
+
if attributes.has_key?(:'BottomAnchor')
|
132
|
+
self.bottom_anchor = attributes[:'BottomAnchor']
|
133
|
+
end
|
134
|
+
|
126
135
|
if attributes.has_key?(:'AnchorMode')
|
127
136
|
self.anchor_mode = attributes[:'AnchorMode']
|
128
137
|
end
|
@@ -196,6 +205,7 @@ module CloudmersiveOcrApiClient
|
|
196
205
|
field_id == o.field_id &&
|
197
206
|
left_anchor == o.left_anchor &&
|
198
207
|
top_anchor == o.top_anchor &&
|
208
|
+
bottom_anchor == o.bottom_anchor &&
|
199
209
|
anchor_mode == o.anchor_mode &&
|
200
210
|
data_type == o.data_type &&
|
201
211
|
target_digit_count == o.target_digit_count &&
|
@@ -219,7 +229,7 @@ module CloudmersiveOcrApiClient
|
|
219
229
|
# Calculates hash code according to all attributes.
|
220
230
|
# @return [Fixnum] Hash code
|
221
231
|
def hash
|
222
|
-
[field_id, left_anchor, top_anchor, anchor_mode, data_type, target_digit_count, minimum_character_count, allow_numeric_digits, vertical_alignment_type, horizontal_alignment_type, target_field_width_relative, target_field_height_relative, target_field_horizontal_adjustment, target_field_vertical_adjustment, ignore].hash
|
232
|
+
[field_id, left_anchor, top_anchor, bottom_anchor, anchor_mode, data_type, target_digit_count, minimum_character_count, allow_numeric_digits, vertical_alignment_type, horizontal_alignment_type, target_field_width_relative, target_field_height_relative, target_field_horizontal_adjustment, target_field_vertical_adjustment, ignore].hash
|
223
233
|
end
|
224
234
|
|
225
235
|
# Builds the object from hash
|
@@ -27,6 +27,9 @@ module CloudmersiveOcrApiClient
|
|
27
27
|
# Diagnostic images - default is null, enable diagnostics=true to populate this parameter with one image per field
|
28
28
|
attr_accessor :diagnostics
|
29
29
|
|
30
|
+
# Optional; populated when using photo/recognize/form/advanced with the Setting Name of the best-matching highest-relevance form
|
31
|
+
attr_accessor :best_match_form_setting_name
|
32
|
+
|
30
33
|
|
31
34
|
# Attribute mapping from ruby-style variable name to JSON key.
|
32
35
|
def self.attribute_map
|
@@ -34,7 +37,8 @@ module CloudmersiveOcrApiClient
|
|
34
37
|
:'successful' => :'Successful',
|
35
38
|
:'field_value_extraction_result' => :'FieldValueExtractionResult',
|
36
39
|
:'table_value_extraction_results' => :'TableValueExtractionResults',
|
37
|
-
:'diagnostics' => :'Diagnostics'
|
40
|
+
:'diagnostics' => :'Diagnostics',
|
41
|
+
:'best_match_form_setting_name' => :'BestMatchFormSettingName'
|
38
42
|
}
|
39
43
|
end
|
40
44
|
|
@@ -44,7 +48,8 @@ module CloudmersiveOcrApiClient
|
|
44
48
|
:'successful' => :'BOOLEAN',
|
45
49
|
:'field_value_extraction_result' => :'Array<FieldResult>',
|
46
50
|
:'table_value_extraction_results' => :'Array<TableResult>',
|
47
|
-
:'diagnostics' => :'Array<String>'
|
51
|
+
:'diagnostics' => :'Array<String>',
|
52
|
+
:'best_match_form_setting_name' => :'String'
|
48
53
|
}
|
49
54
|
end
|
50
55
|
|
@@ -78,6 +83,10 @@ module CloudmersiveOcrApiClient
|
|
78
83
|
end
|
79
84
|
end
|
80
85
|
|
86
|
+
if attributes.has_key?(:'BestMatchFormSettingName')
|
87
|
+
self.best_match_form_setting_name = attributes[:'BestMatchFormSettingName']
|
88
|
+
end
|
89
|
+
|
81
90
|
end
|
82
91
|
|
83
92
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -101,7 +110,8 @@ module CloudmersiveOcrApiClient
|
|
101
110
|
successful == o.successful &&
|
102
111
|
field_value_extraction_result == o.field_value_extraction_result &&
|
103
112
|
table_value_extraction_results == o.table_value_extraction_results &&
|
104
|
-
diagnostics == o.diagnostics
|
113
|
+
diagnostics == o.diagnostics &&
|
114
|
+
best_match_form_setting_name == o.best_match_form_setting_name
|
105
115
|
end
|
106
116
|
|
107
117
|
# @see the `==` method
|
@@ -113,7 +123,7 @@ module CloudmersiveOcrApiClient
|
|
113
123
|
# Calculates hash code according to all attributes.
|
114
124
|
# @return [Fixnum] Hash code
|
115
125
|
def hash
|
116
|
-
[successful, field_value_extraction_result, table_value_extraction_results, diagnostics].hash
|
126
|
+
[successful, field_value_extraction_result, table_value_extraction_results, diagnostics, best_match_form_setting_name].hash
|
117
127
|
end
|
118
128
|
|
119
129
|
# Builds the object from hash
|
@@ -50,6 +50,12 @@ describe 'FormFieldDefinition' do
|
|
50
50
|
end
|
51
51
|
end
|
52
52
|
|
53
|
+
describe 'test attribute "bottom_anchor"' do
|
54
|
+
it 'should work' do
|
55
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
53
59
|
describe 'test attribute "anchor_mode"' do
|
54
60
|
it 'should work' do
|
55
61
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -56,5 +56,11 @@ describe 'FormRecognitionResult' do
|
|
56
56
|
end
|
57
57
|
end
|
58
58
|
|
59
|
+
describe 'test attribute "best_match_form_setting_name"' do
|
60
|
+
it 'should work' do
|
61
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
59
65
|
end
|
60
66
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: cloudmersive-ocr-api-client
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.4.
|
4
|
+
version: 1.4.6
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Cloudmersive
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-
|
11
|
+
date: 2019-12-09 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|