cloudmersive-ocr-api-client 1.3.4 → 1.3.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +9 -5
- data/cloudmersive-ocr-api-client.gemspec +1 -1
- data/docs/GetPageAngleResult.md +9 -0
- data/docs/ImageOcrApi.md +3 -1
- data/docs/PreprocessingApi.md +114 -4
- data/docs/ReceiptsApi.md +63 -0
- data/lib/cloudmersive-ocr-api-client.rb +3 -1
- data/lib/cloudmersive-ocr-api-client/api/image_ocr_api.rb +4 -1
- data/lib/cloudmersive-ocr-api-client/api/pdf_ocr_api.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/api/preprocessing_api.rb +117 -5
- data/lib/cloudmersive-ocr-api-client/api/receipts_api.rb +79 -0
- data/lib/cloudmersive-ocr-api-client/api_client.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/api_error.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/configuration.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/get_page_angle_result.rb +199 -0
- data/lib/cloudmersive-ocr-api-client/models/image_to_lines_with_location_result.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/image_to_text_response.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/image_to_words_with_location_result.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/ocr_line_element.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/ocr_page_result.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/ocr_page_result_with_lines_with_location.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/ocr_page_result_with_words_with_location.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/ocr_photo_text_element.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/ocr_word_element.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/pdf_to_lines_with_location_result.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/pdf_to_text_response.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/pdf_to_words_with_location_result.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/models/photo_to_words_with_location_result.rb +1 -1
- data/lib/cloudmersive-ocr-api-client/version.rb +2 -2
- data/spec/api/image_ocr_api_spec.rb +2 -1
- data/spec/api/pdf_ocr_api_spec.rb +1 -1
- data/spec/api/preprocessing_api_spec.rb +27 -3
- data/spec/api/receipts_api_spec.rb +47 -0
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/get_page_angle_result_spec.rb +48 -0
- data/spec/models/image_to_lines_with_location_result_spec.rb +1 -1
- data/spec/models/image_to_text_response_spec.rb +1 -1
- data/spec/models/image_to_words_with_location_result_spec.rb +1 -1
- data/spec/models/ocr_line_element_spec.rb +1 -1
- data/spec/models/ocr_page_result_spec.rb +1 -1
- data/spec/models/ocr_page_result_with_lines_with_location_spec.rb +1 -1
- data/spec/models/ocr_page_result_with_words_with_location_spec.rb +1 -1
- data/spec/models/ocr_photo_text_element_spec.rb +1 -1
- data/spec/models/ocr_word_element_spec.rb +1 -1
- data/spec/models/pdf_to_lines_with_location_result_spec.rb +1 -1
- data/spec/models/pdf_to_text_response_spec.rb +1 -1
- data/spec/models/pdf_to_words_with_location_result_spec.rb +1 -1
- data/spec/models/photo_to_words_with_location_result_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +22 -15
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 37f50fd7764a8a7bc526bea186b74a8d29209bae63a30061a695946775570ee0
|
4
|
+
data.tar.gz: 5056bd844cfa0b6041a81a20577780e605a93fad757c92f3c923f231da535023
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1bba5aec42d5498ec2397f9e385749093683c0b96951b3cec3bbd7af8d571f682c880b277e499101b4ed151b60cb34a4c3ec7fe1538d1c2b923f9451a8616283
|
7
|
+
data.tar.gz: b11a833bee4add22b521fbab250822a801fdcef0737dafcb7fb0e7dea8ceea7ebb4f9db44ccd0c1adb7c251a93f058db7e43cdca998661e499523fa993328497
|
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.3.
|
10
|
+
- Package version: 1.3.5
|
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.3.
|
26
|
+
gem install ./cloudmersive-ocr-api-client-1.3.5.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-ocr-api-client-1.3.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-ocr-api-client-1.3.5.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.3.
|
34
|
+
gem 'cloudmersive-ocr-api-client', '~> 1.3.5'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -95,13 +95,17 @@ Class | Method | HTTP request | Description
|
|
95
95
|
*CloudmersiveOcrApiClient::PdfOcrApi* | [**pdf_ocr_pdf_to_lines_with_location**](docs/PdfOcrApi.md#pdf_ocr_pdf_to_lines_with_location) | **POST** /ocr/pdf/to/lines-with-location | Convert a PDF into text lines with location
|
96
96
|
*CloudmersiveOcrApiClient::PdfOcrApi* | [**pdf_ocr_pdf_to_words_with_location**](docs/PdfOcrApi.md#pdf_ocr_pdf_to_words_with_location) | **POST** /ocr/pdf/to/words-with-location | Convert a PDF into words with location
|
97
97
|
*CloudmersiveOcrApiClient::PdfOcrApi* | [**pdf_ocr_post**](docs/PdfOcrApi.md#pdf_ocr_post) | **POST** /ocr/pdf/toText | Converts an uploaded PDF file into text via Optical Character Recognition.
|
98
|
-
*CloudmersiveOcrApiClient::PreprocessingApi* | [**preprocessing_binarize**](docs/PreprocessingApi.md#preprocessing_binarize) | **POST** /ocr/preprocessing/image/binarize | Convert an image of text into a
|
98
|
+
*CloudmersiveOcrApiClient::PreprocessingApi* | [**preprocessing_binarize**](docs/PreprocessingApi.md#preprocessing_binarize) | **POST** /ocr/preprocessing/image/binarize | Convert an image of text into a binarized (light and dark) view
|
99
|
+
*CloudmersiveOcrApiClient::PreprocessingApi* | [**preprocessing_binarize_advanced**](docs/PreprocessingApi.md#preprocessing_binarize_advanced) | **POST** /ocr/preprocessing/image/binarize/advanced | Convert an image of text into a binary (light and dark) view with ML
|
100
|
+
*CloudmersiveOcrApiClient::PreprocessingApi* | [**preprocessing_get_page_angle**](docs/PreprocessingApi.md#preprocessing_get_page_angle) | **POST** /ocr/preprocessing/image/get-page-angle | Get the angle of the page / document / receipt
|
99
101
|
*CloudmersiveOcrApiClient::PreprocessingApi* | [**preprocessing_unrotate**](docs/PreprocessingApi.md#preprocessing_unrotate) | **POST** /ocr/preprocessing/image/unrotate | Detect and unrotate a document image
|
100
102
|
*CloudmersiveOcrApiClient::PreprocessingApi* | [**preprocessing_unskew**](docs/PreprocessingApi.md#preprocessing_unskew) | **POST** /ocr/preprocessing/image/unskew | Detect and unskew a photo of a document
|
103
|
+
*CloudmersiveOcrApiClient::ReceiptsApi* | [**receipts_photo_to_csv**](docs/ReceiptsApi.md#receipts_photo_to_csv) | **POST** /ocr/receipts/photo/to/csv | Convert a photo of a receipt into a CSV file containing structured information from the receipt
|
101
104
|
|
102
105
|
|
103
106
|
## Documentation for Models
|
104
107
|
|
108
|
+
- [CloudmersiveOcrApiClient::GetPageAngleResult](docs/GetPageAngleResult.md)
|
105
109
|
- [CloudmersiveOcrApiClient::ImageToLinesWithLocationResult](docs/ImageToLinesWithLocationResult.md)
|
106
110
|
- [CloudmersiveOcrApiClient::ImageToTextResponse](docs/ImageToTextResponse.md)
|
107
111
|
- [CloudmersiveOcrApiClient::ImageToWordsWithLocationResult](docs/ImageToWordsWithLocationResult.md)
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveOcrApiClient::GetPageAngleResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
+
**angle** | **Float** | Angle of the page in radians; 0 represents perfectly horizontal | [optional]
|
8
|
+
|
9
|
+
|
data/docs/ImageOcrApi.md
CHANGED
@@ -213,7 +213,8 @@ api_instance = CloudmersiveOcrApiClient::ImageOcrApi.new
|
|
213
213
|
image_file = File.new("/path/to/file.txt") # File | Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|
214
214
|
|
215
215
|
opts = {
|
216
|
-
language: "language_example" # String | Optional, language of the input document, default is English (ENG). Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)
|
216
|
+
language: "language_example", # String | Optional, language of the input document, default is English (ENG). Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)
|
217
|
+
preprocessing: "preprocessing_example" # String | Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).
|
217
218
|
}
|
218
219
|
|
219
220
|
begin
|
@@ -231,6 +232,7 @@ Name | Type | Description | Notes
|
|
231
232
|
------------- | ------------- | ------------- | -------------
|
232
233
|
**image_file** | **File**| Image file to perform OCR on. Common file formats such as PNG, JPEG are supported. |
|
233
234
|
**language** | **String**| Optional, language of the input document, default is English (ENG). Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish) | [optional]
|
235
|
+
**preprocessing** | **String**| Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended). | [optional]
|
234
236
|
|
235
237
|
### Return type
|
236
238
|
|
data/docs/PreprocessingApi.md
CHANGED
@@ -4,7 +4,9 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**preprocessing_binarize**](PreprocessingApi.md#preprocessing_binarize) | **POST** /ocr/preprocessing/image/binarize | Convert an image of text into a
|
7
|
+
[**preprocessing_binarize**](PreprocessingApi.md#preprocessing_binarize) | **POST** /ocr/preprocessing/image/binarize | Convert an image of text into a binarized (light and dark) view
|
8
|
+
[**preprocessing_binarize_advanced**](PreprocessingApi.md#preprocessing_binarize_advanced) | **POST** /ocr/preprocessing/image/binarize/advanced | Convert an image of text into a binary (light and dark) view with ML
|
9
|
+
[**preprocessing_get_page_angle**](PreprocessingApi.md#preprocessing_get_page_angle) | **POST** /ocr/preprocessing/image/get-page-angle | Get the angle of the page / document / receipt
|
8
10
|
[**preprocessing_unrotate**](PreprocessingApi.md#preprocessing_unrotate) | **POST** /ocr/preprocessing/image/unrotate | Detect and unrotate a document image
|
9
11
|
[**preprocessing_unskew**](PreprocessingApi.md#preprocessing_unskew) | **POST** /ocr/preprocessing/image/unskew | Detect and unskew a photo of a document
|
10
12
|
|
@@ -12,9 +14,9 @@ Method | HTTP request | Description
|
|
12
14
|
# **preprocessing_binarize**
|
13
15
|
> Object preprocessing_binarize(image_file)
|
14
16
|
|
15
|
-
Convert an image of text into a
|
17
|
+
Convert an image of text into a binarized (light and dark) view
|
16
18
|
|
17
|
-
Perform an
|
19
|
+
Perform an adaptive binarization algorithm on the input image to prepare it for further OCR operations.
|
18
20
|
|
19
21
|
### Example
|
20
22
|
```ruby
|
@@ -34,7 +36,7 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform OCR on
|
|
34
36
|
|
35
37
|
|
36
38
|
begin
|
37
|
-
#Convert an image of text into a
|
39
|
+
#Convert an image of text into a binarized (light and dark) view
|
38
40
|
result = api_instance.preprocessing_binarize(image_file)
|
39
41
|
p result
|
40
42
|
rescue CloudmersiveOcrApiClient::ApiError => e
|
@@ -63,6 +65,114 @@ Name | Type | Description | Notes
|
|
63
65
|
|
64
66
|
|
65
67
|
|
68
|
+
# **preprocessing_binarize_advanced**
|
69
|
+
> Object preprocessing_binarize_advanced(image_file)
|
70
|
+
|
71
|
+
Convert an image of text into a binary (light and dark) view with ML
|
72
|
+
|
73
|
+
Perform an advanced adaptive, Deep Learning-based binarization algorithm on the input image to prepare it for further OCR operations. Provides enhanced accuracy than adaptive binarization. Image will be upsampled to 300 DPI if it has a DPI below 300.
|
74
|
+
|
75
|
+
### Example
|
76
|
+
```ruby
|
77
|
+
# load the gem
|
78
|
+
require 'cloudmersive-ocr-api-client'
|
79
|
+
# setup authorization
|
80
|
+
CloudmersiveOcrApiClient.configure do |config|
|
81
|
+
# Configure API key authorization: Apikey
|
82
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
83
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
84
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
85
|
+
end
|
86
|
+
|
87
|
+
api_instance = CloudmersiveOcrApiClient::PreprocessingApi.new
|
88
|
+
|
89
|
+
image_file = File.new("/path/to/file.txt") # File | Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|
90
|
+
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Convert an image of text into a binary (light and dark) view with ML
|
94
|
+
result = api_instance.preprocessing_binarize_advanced(image_file)
|
95
|
+
p result
|
96
|
+
rescue CloudmersiveOcrApiClient::ApiError => e
|
97
|
+
puts "Exception when calling PreprocessingApi->preprocessing_binarize_advanced: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
Name | Type | Description | Notes
|
104
|
+
------------- | ------------- | ------------- | -------------
|
105
|
+
**image_file** | **File**| Image file to perform OCR on. Common file formats such as PNG, JPEG are supported. |
|
106
|
+
|
107
|
+
### Return type
|
108
|
+
|
109
|
+
**Object**
|
110
|
+
|
111
|
+
### Authorization
|
112
|
+
|
113
|
+
[Apikey](../README.md#Apikey)
|
114
|
+
|
115
|
+
### HTTP request headers
|
116
|
+
|
117
|
+
- **Content-Type**: multipart/form-data
|
118
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
# **preprocessing_get_page_angle**
|
123
|
+
> GetPageAngleResult preprocessing_get_page_angle(image_file)
|
124
|
+
|
125
|
+
Get the angle of the page / document / receipt
|
126
|
+
|
127
|
+
Analyzes a photo or image of a document and identifies the rotation angle of the page.
|
128
|
+
|
129
|
+
### Example
|
130
|
+
```ruby
|
131
|
+
# load the gem
|
132
|
+
require 'cloudmersive-ocr-api-client'
|
133
|
+
# setup authorization
|
134
|
+
CloudmersiveOcrApiClient.configure do |config|
|
135
|
+
# Configure API key authorization: Apikey
|
136
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
137
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
138
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
139
|
+
end
|
140
|
+
|
141
|
+
api_instance = CloudmersiveOcrApiClient::PreprocessingApi.new
|
142
|
+
|
143
|
+
image_file = File.new("/path/to/file.txt") # File | Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|
144
|
+
|
145
|
+
|
146
|
+
begin
|
147
|
+
#Get the angle of the page / document / receipt
|
148
|
+
result = api_instance.preprocessing_get_page_angle(image_file)
|
149
|
+
p result
|
150
|
+
rescue CloudmersiveOcrApiClient::ApiError => e
|
151
|
+
puts "Exception when calling PreprocessingApi->preprocessing_get_page_angle: #{e}"
|
152
|
+
end
|
153
|
+
```
|
154
|
+
|
155
|
+
### Parameters
|
156
|
+
|
157
|
+
Name | Type | Description | Notes
|
158
|
+
------------- | ------------- | ------------- | -------------
|
159
|
+
**image_file** | **File**| Image file to perform OCR on. Common file formats such as PNG, JPEG are supported. |
|
160
|
+
|
161
|
+
### Return type
|
162
|
+
|
163
|
+
[**GetPageAngleResult**](GetPageAngleResult.md)
|
164
|
+
|
165
|
+
### Authorization
|
166
|
+
|
167
|
+
[Apikey](../README.md#Apikey)
|
168
|
+
|
169
|
+
### HTTP request headers
|
170
|
+
|
171
|
+
- **Content-Type**: multipart/form-data
|
172
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
173
|
+
|
174
|
+
|
175
|
+
|
66
176
|
# **preprocessing_unrotate**
|
67
177
|
> Object preprocessing_unrotate(image_file)
|
68
178
|
|
data/docs/ReceiptsApi.md
ADDED
@@ -0,0 +1,63 @@
|
|
1
|
+
# CloudmersiveOcrApiClient::ReceiptsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**receipts_photo_to_csv**](ReceiptsApi.md#receipts_photo_to_csv) | **POST** /ocr/receipts/photo/to/csv | Convert a photo of a receipt into a CSV file containing structured information from the receipt
|
8
|
+
|
9
|
+
|
10
|
+
# **receipts_photo_to_csv**
|
11
|
+
> Object receipts_photo_to_csv(image_file)
|
12
|
+
|
13
|
+
Convert a photo of a receipt into a CSV file containing structured information from the receipt
|
14
|
+
|
15
|
+
Leverage Deep Learning to automatically turn a photo of a receipt into a CSV file containing the structured information from the receipt.
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'cloudmersive-ocr-api-client'
|
21
|
+
# setup authorization
|
22
|
+
CloudmersiveOcrApiClient.configure do |config|
|
23
|
+
# Configure API key authorization: Apikey
|
24
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
25
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
26
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
27
|
+
end
|
28
|
+
|
29
|
+
api_instance = CloudmersiveOcrApiClient::ReceiptsApi.new
|
30
|
+
|
31
|
+
image_file = File.new("/path/to/file.txt") # File | Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|
32
|
+
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Convert a photo of a receipt into a CSV file containing structured information from the receipt
|
36
|
+
result = api_instance.receipts_photo_to_csv(image_file)
|
37
|
+
p result
|
38
|
+
rescue CloudmersiveOcrApiClient::ApiError => e
|
39
|
+
puts "Exception when calling ReceiptsApi->receipts_photo_to_csv: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**image_file** | **File**| Image file to perform OCR on. Common file formats such as PNG, JPEG are supported. |
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
**Object**
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
[Apikey](../README.md#Apikey)
|
56
|
+
|
57
|
+
### HTTP request headers
|
58
|
+
|
59
|
+
- **Content-Type**: multipart/form-data
|
60
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
61
|
+
|
62
|
+
|
63
|
+
|
@@ -6,7 +6,7 @@
|
|
6
6
|
OpenAPI spec version: v1
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version:
|
9
|
+
Swagger Codegen version: unset
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -17,6 +17,7 @@ require 'cloudmersive-ocr-api-client/version'
|
|
17
17
|
require 'cloudmersive-ocr-api-client/configuration'
|
18
18
|
|
19
19
|
# Models
|
20
|
+
require 'cloudmersive-ocr-api-client/models/get_page_angle_result'
|
20
21
|
require 'cloudmersive-ocr-api-client/models/image_to_lines_with_location_result'
|
21
22
|
require 'cloudmersive-ocr-api-client/models/image_to_text_response'
|
22
23
|
require 'cloudmersive-ocr-api-client/models/image_to_words_with_location_result'
|
@@ -35,6 +36,7 @@ require 'cloudmersive-ocr-api-client/models/photo_to_words_with_location_result'
|
|
35
36
|
require 'cloudmersive-ocr-api-client/api/image_ocr_api'
|
36
37
|
require 'cloudmersive-ocr-api-client/api/pdf_ocr_api'
|
37
38
|
require 'cloudmersive-ocr-api-client/api/preprocessing_api'
|
39
|
+
require 'cloudmersive-ocr-api-client/api/receipts_api'
|
38
40
|
|
39
41
|
module CloudmersiveOcrApiClient
|
40
42
|
class << self
|
@@ -6,7 +6,7 @@
|
|
6
6
|
OpenAPI spec version: v1
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version:
|
9
|
+
Swagger Codegen version: unset
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -208,6 +208,7 @@ module CloudmersiveOcrApiClient
|
|
208
208
|
# @param image_file Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|
209
209
|
# @param [Hash] opts the optional parameters
|
210
210
|
# @option opts [String] :language Optional, language of the input document, default is English (ENG). Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)
|
211
|
+
# @option opts [String] :preprocessing Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).
|
211
212
|
# @return [PhotoToWordsWithLocationResult]
|
212
213
|
def image_ocr_photo_words_with_location(image_file, opts = {})
|
213
214
|
data, _status_code, _headers = image_ocr_photo_words_with_location_with_http_info(image_file, opts)
|
@@ -219,6 +220,7 @@ module CloudmersiveOcrApiClient
|
|
219
220
|
# @param image_file Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|
220
221
|
# @param [Hash] opts the optional parameters
|
221
222
|
# @option opts [String] :language Optional, language of the input document, default is English (ENG). Possible values are ENG (English), ARA (Arabic), ZHO (Chinese - Simplified), ZHO-HANT (Chinese - Traditional), ASM (Assamese), AFR (Afrikaans), AMH (Amharic), AZE (Azerbaijani), AZE-CYRL (Azerbaijani - Cyrillic), BEL (Belarusian), BEN (Bengali), BOD (Tibetan), BOS (Bosnian), BUL (Bulgarian), CAT (Catalan; Valencian), CEB (Cebuano), CES (Czech), CHR (Cherokee), CYM (Welsh), DAN (Danish), DEU (German), DZO (Dzongkha), ELL (Greek), ENM (Archaic/Middle English), EPO (Esperanto), EST (Estonian), EUS (Basque), FAS (Persian), FIN (Finnish), FRA (French), FRK (Frankish), FRM (Middle-French), GLE (Irish), GLG (Galician), GRC (Ancient Greek), HAT (Hatian), HEB (Hebrew), HIN (Hindi), HRV (Croatian), HUN (Hungarian), IKU (Inuktitut), IND (Indonesian), ISL (Icelandic), ITA (Italian), ITA-OLD (Old - Italian), JAV (Javanese), JPN (Japanese), KAN (Kannada), KAT (Georgian), KAT-OLD (Old-Georgian), KAZ (Kazakh), KHM (Central Khmer), KIR (Kirghiz), KOR (Korean), KUR (Kurdish), LAO (Lao), LAT (Latin), LAV (Latvian), LIT (Lithuanian), MAL (Malayalam), MAR (Marathi), MKD (Macedonian), MLT (Maltese), MSA (Malay), MYA (Burmese), NEP (Nepali), NLD (Dutch), NOR (Norwegian), ORI (Oriya), PAN (Panjabi), POL (Polish), POR (Portuguese), PUS (Pushto), RON (Romanian), RUS (Russian), SAN (Sanskrit), SIN (Sinhala), SLK (Slovak), SLV (Slovenian), SPA (Spanish), SPA-OLD (Old Spanish), SQI (Albanian), SRP (Serbian), SRP-LAT (Latin Serbian), SWA (Swahili), SWE (Swedish), SYR (Syriac), TAM (Tamil), TEL (Telugu), TGK (Tajik), TGL (Tagalog), THA (Thai), TIR (Tigrinya), TUR (Turkish), UIG (Uighur), UKR (Ukrainian), URD (Urdu), UZB (Uzbek), UZB-CYR (Cyrillic Uzbek), VIE (Vietnamese), YID (Yiddish)
|
223
|
+
# @option opts [String] :preprocessing Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image before OCR is applied; this is recommended).
|
222
224
|
# @return [Array<(PhotoToWordsWithLocationResult, Fixnum, Hash)>] PhotoToWordsWithLocationResult data, response status code and response headers
|
223
225
|
def image_ocr_photo_words_with_location_with_http_info(image_file, opts = {})
|
224
226
|
if @api_client.config.debugging
|
@@ -241,6 +243,7 @@ module CloudmersiveOcrApiClient
|
|
241
243
|
# HTTP header 'Content-Type'
|
242
244
|
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
243
245
|
header_params[:'language'] = opts[:'language'] if !opts[:'language'].nil?
|
246
|
+
header_params[:'preprocessing'] = opts[:'preprocessing'] if !opts[:'preprocessing'].nil?
|
244
247
|
|
245
248
|
# form parameters
|
246
249
|
form_params = {}
|
@@ -6,7 +6,7 @@
|
|
6
6
|
OpenAPI spec version: v1
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version:
|
9
|
+
Swagger Codegen version: unset
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -20,8 +20,8 @@ module CloudmersiveOcrApiClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
|
23
|
-
# Convert an image of text into a
|
24
|
-
# Perform an
|
23
|
+
# Convert an image of text into a binarized (light and dark) view
|
24
|
+
# Perform an adaptive binarization algorithm on the input image to prepare it for further OCR operations.
|
25
25
|
# @param image_file Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
27
|
# @return [Object]
|
@@ -30,8 +30,8 @@ module CloudmersiveOcrApiClient
|
|
30
30
|
return data
|
31
31
|
end
|
32
32
|
|
33
|
-
# Convert an image of text into a
|
34
|
-
# Perform an
|
33
|
+
# Convert an image of text into a binarized (light and dark) view
|
34
|
+
# Perform an adaptive binarization algorithm on the input image to prepare it for further OCR operations.
|
35
35
|
# @param image_file Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|
36
36
|
# @param [Hash] opts the optional parameters
|
37
37
|
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
@@ -76,6 +76,118 @@ module CloudmersiveOcrApiClient
|
|
76
76
|
return data, status_code, headers
|
77
77
|
end
|
78
78
|
|
79
|
+
# Convert an image of text into a binary (light and dark) view with ML
|
80
|
+
# Perform an advanced adaptive, Deep Learning-based binarization algorithm on the input image to prepare it for further OCR operations. Provides enhanced accuracy than adaptive binarization. Image will be upsampled to 300 DPI if it has a DPI below 300.
|
81
|
+
# @param image_file Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|
82
|
+
# @param [Hash] opts the optional parameters
|
83
|
+
# @return [Object]
|
84
|
+
def preprocessing_binarize_advanced(image_file, opts = {})
|
85
|
+
data, _status_code, _headers = preprocessing_binarize_advanced_with_http_info(image_file, opts)
|
86
|
+
return data
|
87
|
+
end
|
88
|
+
|
89
|
+
# Convert an image of text into a binary (light and dark) view with ML
|
90
|
+
# Perform an advanced adaptive, Deep Learning-based binarization algorithm on the input image to prepare it for further OCR operations. Provides enhanced accuracy than adaptive binarization. Image will be upsampled to 300 DPI if it has a DPI below 300.
|
91
|
+
# @param image_file Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|
92
|
+
# @param [Hash] opts the optional parameters
|
93
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
94
|
+
def preprocessing_binarize_advanced_with_http_info(image_file, opts = {})
|
95
|
+
if @api_client.config.debugging
|
96
|
+
@api_client.config.logger.debug "Calling API: PreprocessingApi.preprocessing_binarize_advanced ..."
|
97
|
+
end
|
98
|
+
# verify the required parameter 'image_file' is set
|
99
|
+
if @api_client.config.client_side_validation && image_file.nil?
|
100
|
+
fail ArgumentError, "Missing the required parameter 'image_file' when calling PreprocessingApi.preprocessing_binarize_advanced"
|
101
|
+
end
|
102
|
+
# resource path
|
103
|
+
local_var_path = "/ocr/preprocessing/image/binarize/advanced"
|
104
|
+
|
105
|
+
# query parameters
|
106
|
+
query_params = {}
|
107
|
+
|
108
|
+
# header parameters
|
109
|
+
header_params = {}
|
110
|
+
# HTTP header 'Accept' (if needed)
|
111
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
112
|
+
# HTTP header 'Content-Type'
|
113
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
114
|
+
|
115
|
+
# form parameters
|
116
|
+
form_params = {}
|
117
|
+
form_params["imageFile"] = image_file
|
118
|
+
|
119
|
+
# http body (model)
|
120
|
+
post_body = nil
|
121
|
+
auth_names = ['Apikey']
|
122
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
123
|
+
:header_params => header_params,
|
124
|
+
:query_params => query_params,
|
125
|
+
:form_params => form_params,
|
126
|
+
:body => post_body,
|
127
|
+
:auth_names => auth_names,
|
128
|
+
:return_type => 'Object')
|
129
|
+
if @api_client.config.debugging
|
130
|
+
@api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_binarize_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
131
|
+
end
|
132
|
+
return data, status_code, headers
|
133
|
+
end
|
134
|
+
|
135
|
+
# Get the angle of the page / document / receipt
|
136
|
+
# Analyzes a photo or image of a document and identifies the rotation angle of the page.
|
137
|
+
# @param image_file Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|
138
|
+
# @param [Hash] opts the optional parameters
|
139
|
+
# @return [GetPageAngleResult]
|
140
|
+
def preprocessing_get_page_angle(image_file, opts = {})
|
141
|
+
data, _status_code, _headers = preprocessing_get_page_angle_with_http_info(image_file, opts)
|
142
|
+
return data
|
143
|
+
end
|
144
|
+
|
145
|
+
# Get the angle of the page / document / receipt
|
146
|
+
# Analyzes a photo or image of a document and identifies the rotation angle of the page.
|
147
|
+
# @param image_file Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|
148
|
+
# @param [Hash] opts the optional parameters
|
149
|
+
# @return [Array<(GetPageAngleResult, Fixnum, Hash)>] GetPageAngleResult data, response status code and response headers
|
150
|
+
def preprocessing_get_page_angle_with_http_info(image_file, opts = {})
|
151
|
+
if @api_client.config.debugging
|
152
|
+
@api_client.config.logger.debug "Calling API: PreprocessingApi.preprocessing_get_page_angle ..."
|
153
|
+
end
|
154
|
+
# verify the required parameter 'image_file' is set
|
155
|
+
if @api_client.config.client_side_validation && image_file.nil?
|
156
|
+
fail ArgumentError, "Missing the required parameter 'image_file' when calling PreprocessingApi.preprocessing_get_page_angle"
|
157
|
+
end
|
158
|
+
# resource path
|
159
|
+
local_var_path = "/ocr/preprocessing/image/get-page-angle"
|
160
|
+
|
161
|
+
# query parameters
|
162
|
+
query_params = {}
|
163
|
+
|
164
|
+
# header parameters
|
165
|
+
header_params = {}
|
166
|
+
# HTTP header 'Accept' (if needed)
|
167
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
168
|
+
# HTTP header 'Content-Type'
|
169
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
170
|
+
|
171
|
+
# form parameters
|
172
|
+
form_params = {}
|
173
|
+
form_params["imageFile"] = image_file
|
174
|
+
|
175
|
+
# http body (model)
|
176
|
+
post_body = nil
|
177
|
+
auth_names = ['Apikey']
|
178
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
179
|
+
:header_params => header_params,
|
180
|
+
:query_params => query_params,
|
181
|
+
:form_params => form_params,
|
182
|
+
:body => post_body,
|
183
|
+
:auth_names => auth_names,
|
184
|
+
:return_type => 'GetPageAngleResult')
|
185
|
+
if @api_client.config.debugging
|
186
|
+
@api_client.config.logger.debug "API called: PreprocessingApi#preprocessing_get_page_angle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
187
|
+
end
|
188
|
+
return data, status_code, headers
|
189
|
+
end
|
190
|
+
|
79
191
|
# Detect and unrotate a document image
|
80
192
|
# Detect and unrotate an image of a document (e.g. that was scanned at an angle). Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.
|
81
193
|
# @param image_file Image file to perform OCR on. Common file formats such as PNG, JPEG are supported.
|