cloudmersive-image-recognition-api-client 1.4.6 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- metadata +3 -145
- data/Gemfile +0 -7
- data/README.md +0 -184
- data/Rakefile +0 -8
- data/cloudmersive-image-recognition-api-client.gemspec +0 -45
- data/docs/AgeDetectionResult.md +0 -10
- data/docs/ArtisticApi.md +0 -66
- data/docs/ColorResult.md +0 -10
- data/docs/ConvertApi.md +0 -396
- data/docs/DetectedLicensePlate.md +0 -14
- data/docs/DetectedObject.md +0 -13
- data/docs/DominantColorResult.md +0 -9
- data/docs/DrawPolygonInstance.md +0 -11
- data/docs/DrawPolygonRequest.md +0 -10
- data/docs/DrawRectangleInstance.md +0 -14
- data/docs/DrawRectangleRequest.md +0 -10
- data/docs/DrawTextInstance.md +0 -15
- data/docs/DrawTextRequest.md +0 -10
- data/docs/EditApi.md +0 -704
- data/docs/Face.md +0 -11
- data/docs/FaceApi.md +0 -396
- data/docs/FaceCompareResponse.md +0 -11
- data/docs/FaceLocateResponse.md +0 -11
- data/docs/FaceLocateWithLandmarksResponse.md +0 -11
- data/docs/FaceMatch.md +0 -13
- data/docs/FacePoint.md +0 -9
- data/docs/FaceWithLandmarks.md +0 -20
- data/docs/FilterApi.md +0 -478
- data/docs/FindSymbolResult.md +0 -13
- data/docs/FineTextDetectionResult.md +0 -10
- data/docs/FineTextItem.md +0 -18
- data/docs/GenderDetectionResult.md +0 -10
- data/docs/ImageDescriptionResponse.md +0 -11
- data/docs/ImageMetadata.md +0 -17
- data/docs/ImageMetadataExifValue.md +0 -10
- data/docs/InfoApi.md +0 -118
- data/docs/NsfwApi.md +0 -63
- data/docs/NsfwResult.md +0 -10
- data/docs/ObjectDetectionResult.md +0 -10
- data/docs/PersonWithAge.md +0 -11
- data/docs/PersonWithGender.md +0 -10
- data/docs/PolygonPoint.md +0 -9
- data/docs/RecognitionOutcome.md +0 -9
- data/docs/RecognizeApi.md +0 -455
- data/docs/ResizeApi.md +0 -130
- data/docs/TextDetectionResult.md +0 -10
- data/docs/TextItem.md +0 -11
- data/docs/VehicleLicensePlateDetectionResult.md +0 -10
- data/git_push.sh +0 -55
- data/lib/cloudmersive-image-recognition-api-client.rb +0 -82
- data/lib/cloudmersive-image-recognition-api-client/api/artistic_api.rb +0 -85
- data/lib/cloudmersive-image-recognition-api-client/api/convert_api.rb +0 -421
- data/lib/cloudmersive-image-recognition-api-client/api/edit_api.rb +0 -765
- data/lib/cloudmersive-image-recognition-api-client/api/face_api.rb +0 -422
- data/lib/cloudmersive-image-recognition-api-client/api/filter_api.rb +0 -533
- data/lib/cloudmersive-image-recognition-api-client/api/info_api.rb +0 -135
- data/lib/cloudmersive-image-recognition-api-client/api/nsfw_api.rb +0 -79
- data/lib/cloudmersive-image-recognition-api-client/api/recognize_api.rb +0 -481
- data/lib/cloudmersive-image-recognition-api-client/api/resize_api.rb +0 -159
- data/lib/cloudmersive-image-recognition-api-client/api_client.rb +0 -389
- data/lib/cloudmersive-image-recognition-api-client/api_error.rb +0 -38
- data/lib/cloudmersive-image-recognition-api-client/configuration.rb +0 -209
- data/lib/cloudmersive-image-recognition-api-client/models/age_detection_result.rb +0 -211
- data/lib/cloudmersive-image-recognition-api-client/models/color_result.rb +0 -209
- data/lib/cloudmersive-image-recognition-api-client/models/detected_license_plate.rb +0 -249
- data/lib/cloudmersive-image-recognition-api-client/models/detected_object.rb +0 -239
- data/lib/cloudmersive-image-recognition-api-client/models/dominant_color_result.rb +0 -201
- data/lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb +0 -221
- data/lib/cloudmersive-image-recognition-api-client/models/draw_polygon_request.rb +0 -227
- data/lib/cloudmersive-image-recognition-api-client/models/draw_rectangle_instance.rb +0 -249
- data/lib/cloudmersive-image-recognition-api-client/models/draw_rectangle_request.rb +0 -227
- data/lib/cloudmersive-image-recognition-api-client/models/draw_text_instance.rb +0 -259
- data/lib/cloudmersive-image-recognition-api-client/models/draw_text_request.rb +0 -227
- data/lib/cloudmersive-image-recognition-api-client/models/face.rb +0 -219
- data/lib/cloudmersive-image-recognition-api-client/models/face_compare_response.rb +0 -221
- data/lib/cloudmersive-image-recognition-api-client/models/face_locate_response.rb +0 -221
- data/lib/cloudmersive-image-recognition-api-client/models/face_locate_with_landmarks_response.rb +0 -221
- data/lib/cloudmersive-image-recognition-api-client/models/face_match.rb +0 -239
- data/lib/cloudmersive-image-recognition-api-client/models/face_point.rb +0 -199
- data/lib/cloudmersive-image-recognition-api-client/models/face_with_landmarks.rb +0 -327
- data/lib/cloudmersive-image-recognition-api-client/models/find_symbol_result.rb +0 -239
- data/lib/cloudmersive-image-recognition-api-client/models/fine_text_detection_result.rb +0 -211
- data/lib/cloudmersive-image-recognition-api-client/models/fine_text_item.rb +0 -289
- data/lib/cloudmersive-image-recognition-api-client/models/gender_detection_result.rb +0 -211
- data/lib/cloudmersive-image-recognition-api-client/models/image_description_response.rb +0 -219
- data/lib/cloudmersive-image-recognition-api-client/models/image_metadata.rb +0 -281
- data/lib/cloudmersive-image-recognition-api-client/models/image_metadata_exif_value.rb +0 -209
- data/lib/cloudmersive-image-recognition-api-client/models/nsfw_result.rb +0 -209
- data/lib/cloudmersive-image-recognition-api-client/models/object_detection_result.rb +0 -211
- data/lib/cloudmersive-image-recognition-api-client/models/person_with_age.rb +0 -218
- data/lib/cloudmersive-image-recognition-api-client/models/person_with_gender.rb +0 -209
- data/lib/cloudmersive-image-recognition-api-client/models/polygon_point.rb +0 -199
- data/lib/cloudmersive-image-recognition-api-client/models/recognition_outcome.rb +0 -199
- data/lib/cloudmersive-image-recognition-api-client/models/text_detection_result.rb +0 -211
- data/lib/cloudmersive-image-recognition-api-client/models/text_item.rb +0 -219
- data/lib/cloudmersive-image-recognition-api-client/models/vehicle_license_plate_detection_result.rb +0 -211
- data/lib/cloudmersive-image-recognition-api-client/version.rb +0 -15
- data/spec/api/artistic_api_spec.rb +0 -48
- data/spec/api/convert_api_spec.rb +0 -120
- data/spec/api/edit_api_spec.rb +0 -191
- data/spec/api/face_api_spec.rb +0 -120
- data/spec/api/filter_api_spec.rb +0 -141
- data/spec/api/info_api_spec.rb +0 -59
- data/spec/api/nsfw_api_spec.rb +0 -47
- data/spec/api/recognize_api_spec.rb +0 -133
- data/spec/api/resize_api_spec.rb +0 -63
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/age_detection_result_spec.rb +0 -54
- data/spec/models/color_result_spec.rb +0 -54
- data/spec/models/detected_license_plate_spec.rb +0 -78
- data/spec/models/detected_object_spec.rb +0 -72
- data/spec/models/dominant_color_result_spec.rb +0 -48
- data/spec/models/draw_polygon_instance_spec.rb +0 -60
- data/spec/models/draw_polygon_request_spec.rb +0 -54
- data/spec/models/draw_rectangle_instance_spec.rb +0 -78
- data/spec/models/draw_rectangle_request_spec.rb +0 -54
- data/spec/models/draw_text_instance_spec.rb +0 -84
- data/spec/models/draw_text_request_spec.rb +0 -54
- data/spec/models/face_compare_response_spec.rb +0 -60
- data/spec/models/face_locate_response_spec.rb +0 -60
- data/spec/models/face_locate_with_landmarks_response_spec.rb +0 -60
- data/spec/models/face_match_spec.rb +0 -72
- data/spec/models/face_point_spec.rb +0 -48
- data/spec/models/face_spec.rb +0 -60
- data/spec/models/face_with_landmarks_spec.rb +0 -114
- data/spec/models/find_symbol_result_spec.rb +0 -72
- data/spec/models/fine_text_detection_result_spec.rb +0 -54
- data/spec/models/fine_text_item_spec.rb +0 -102
- data/spec/models/gender_detection_result_spec.rb +0 -54
- data/spec/models/image_description_response_spec.rb +0 -60
- data/spec/models/image_metadata_exif_value_spec.rb +0 -54
- data/spec/models/image_metadata_spec.rb +0 -96
- data/spec/models/nsfw_result_spec.rb +0 -54
- data/spec/models/object_detection_result_spec.rb +0 -54
- data/spec/models/person_with_age_spec.rb +0 -60
- data/spec/models/person_with_gender_spec.rb +0 -54
- data/spec/models/polygon_point_spec.rb +0 -48
- data/spec/models/recognition_outcome_spec.rb +0 -48
- data/spec/models/text_detection_result_spec.rb +0 -54
- data/spec/models/text_item_spec.rb +0 -60
- data/spec/models/vehicle_license_plate_detection_result_spec.rb +0 -54
- data/spec/spec_helper.rb +0 -111
data/docs/ColorResult.md
DELETED
@@ -1,10 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::ColorResult
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**r** | **Integer** | Red (R) channel pixel value of this color | [optional]
|
7
|
-
**g** | **Integer** | Green (G) channel pixel value of this color | [optional]
|
8
|
-
**b** | **Integer** | Blue (B) channel pixel value of this color | [optional]
|
9
|
-
|
10
|
-
|
data/docs/ConvertApi.md
DELETED
@@ -1,396 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::ConvertApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**convert_to_bmp**](ConvertApi.md#convert_to_bmp) | **POST** /image/convert/to/bmp | Convert input image to Bitmap BMP format
|
8
|
-
[**convert_to_gif**](ConvertApi.md#convert_to_gif) | **POST** /image/convert/to/gif | Convert input image to GIF format
|
9
|
-
[**convert_to_jpg**](ConvertApi.md#convert_to_jpg) | **POST** /image/convert/to/jpg/{quality} | Convert input image to JPG, JPEG format
|
10
|
-
[**convert_to_photoshop**](ConvertApi.md#convert_to_photoshop) | **POST** /image/convert/to/psd | Convert input image to Photoshop PSD format
|
11
|
-
[**convert_to_png**](ConvertApi.md#convert_to_png) | **POST** /image/convert/to/png | Convert input image to PNG format
|
12
|
-
[**convert_to_tiff**](ConvertApi.md#convert_to_tiff) | **POST** /image/convert/to/tiff | Convert input image to TIFF format
|
13
|
-
[**convert_to_web_p**](ConvertApi.md#convert_to_web_p) | **POST** /image/convert/to/webp | Convert input image to WebP format
|
14
|
-
|
15
|
-
|
16
|
-
# **convert_to_bmp**
|
17
|
-
> String convert_to_bmp(image_file)
|
18
|
-
|
19
|
-
Convert input image to Bitmap BMP format
|
20
|
-
|
21
|
-
Converts the input image into PSD format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
|
22
|
-
|
23
|
-
### Example
|
24
|
-
```ruby
|
25
|
-
# load the gem
|
26
|
-
require 'cloudmersive-image-recognition-api-client'
|
27
|
-
# setup authorization
|
28
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
29
|
-
# Configure API key authorization: Apikey
|
30
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
31
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
33
|
-
end
|
34
|
-
|
35
|
-
api_instance = CloudmersiveImageRecognitionApiClient::ConvertApi.new
|
36
|
-
|
37
|
-
image_file = File.new("/path/to/file.txt") # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
38
|
-
|
39
|
-
|
40
|
-
begin
|
41
|
-
#Convert input image to Bitmap BMP format
|
42
|
-
result = api_instance.convert_to_bmp(image_file)
|
43
|
-
p result
|
44
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
45
|
-
puts "Exception when calling ConvertApi->convert_to_bmp: #{e}"
|
46
|
-
end
|
47
|
-
```
|
48
|
-
|
49
|
-
### Parameters
|
50
|
-
|
51
|
-
Name | Type | Description | Notes
|
52
|
-
------------- | ------------- | ------------- | -------------
|
53
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
54
|
-
|
55
|
-
### Return type
|
56
|
-
|
57
|
-
**String**
|
58
|
-
|
59
|
-
### Authorization
|
60
|
-
|
61
|
-
[Apikey](../README.md#Apikey)
|
62
|
-
|
63
|
-
### HTTP request headers
|
64
|
-
|
65
|
-
- **Content-Type**: multipart/form-data
|
66
|
-
- **Accept**: application/octet-stream
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
# **convert_to_gif**
|
71
|
-
> String convert_to_gif(image_file)
|
72
|
-
|
73
|
-
Convert input image to GIF format
|
74
|
-
|
75
|
-
Converts the input image into GIF format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
|
76
|
-
|
77
|
-
### Example
|
78
|
-
```ruby
|
79
|
-
# load the gem
|
80
|
-
require 'cloudmersive-image-recognition-api-client'
|
81
|
-
# setup authorization
|
82
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
83
|
-
# Configure API key authorization: Apikey
|
84
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
85
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
86
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
87
|
-
end
|
88
|
-
|
89
|
-
api_instance = CloudmersiveImageRecognitionApiClient::ConvertApi.new
|
90
|
-
|
91
|
-
image_file = File.new("/path/to/file.txt") # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
92
|
-
|
93
|
-
|
94
|
-
begin
|
95
|
-
#Convert input image to GIF format
|
96
|
-
result = api_instance.convert_to_gif(image_file)
|
97
|
-
p result
|
98
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
99
|
-
puts "Exception when calling ConvertApi->convert_to_gif: #{e}"
|
100
|
-
end
|
101
|
-
```
|
102
|
-
|
103
|
-
### Parameters
|
104
|
-
|
105
|
-
Name | Type | Description | Notes
|
106
|
-
------------- | ------------- | ------------- | -------------
|
107
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
108
|
-
|
109
|
-
### Return type
|
110
|
-
|
111
|
-
**String**
|
112
|
-
|
113
|
-
### Authorization
|
114
|
-
|
115
|
-
[Apikey](../README.md#Apikey)
|
116
|
-
|
117
|
-
### HTTP request headers
|
118
|
-
|
119
|
-
- **Content-Type**: multipart/form-data
|
120
|
-
- **Accept**: application/octet-stream
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
# **convert_to_jpg**
|
125
|
-
> String convert_to_jpg(quality, image_file)
|
126
|
-
|
127
|
-
Convert input image to JPG, JPEG format
|
128
|
-
|
129
|
-
Converts the input image into JPEG/JPG format. Customize encoding parameters. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
|
130
|
-
|
131
|
-
### Example
|
132
|
-
```ruby
|
133
|
-
# load the gem
|
134
|
-
require 'cloudmersive-image-recognition-api-client'
|
135
|
-
# setup authorization
|
136
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
137
|
-
# Configure API key authorization: Apikey
|
138
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
139
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
140
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
141
|
-
end
|
142
|
-
|
143
|
-
api_instance = CloudmersiveImageRecognitionApiClient::ConvertApi.new
|
144
|
-
|
145
|
-
quality = 56 # Integer | Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75
|
146
|
-
|
147
|
-
image_file = File.new("/path/to/file.txt") # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
148
|
-
|
149
|
-
|
150
|
-
begin
|
151
|
-
#Convert input image to JPG, JPEG format
|
152
|
-
result = api_instance.convert_to_jpg(quality, image_file)
|
153
|
-
p result
|
154
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
155
|
-
puts "Exception when calling ConvertApi->convert_to_jpg: #{e}"
|
156
|
-
end
|
157
|
-
```
|
158
|
-
|
159
|
-
### Parameters
|
160
|
-
|
161
|
-
Name | Type | Description | Notes
|
162
|
-
------------- | ------------- | ------------- | -------------
|
163
|
-
**quality** | **Integer**| Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75 |
|
164
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
165
|
-
|
166
|
-
### Return type
|
167
|
-
|
168
|
-
**String**
|
169
|
-
|
170
|
-
### Authorization
|
171
|
-
|
172
|
-
[Apikey](../README.md#Apikey)
|
173
|
-
|
174
|
-
### HTTP request headers
|
175
|
-
|
176
|
-
- **Content-Type**: multipart/form-data
|
177
|
-
- **Accept**: application/octet-stream
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
# **convert_to_photoshop**
|
182
|
-
> String convert_to_photoshop(image_file)
|
183
|
-
|
184
|
-
Convert input image to Photoshop PSD format
|
185
|
-
|
186
|
-
Converts the input image into PSD format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
|
187
|
-
|
188
|
-
### Example
|
189
|
-
```ruby
|
190
|
-
# load the gem
|
191
|
-
require 'cloudmersive-image-recognition-api-client'
|
192
|
-
# setup authorization
|
193
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
194
|
-
# Configure API key authorization: Apikey
|
195
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
196
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
197
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
198
|
-
end
|
199
|
-
|
200
|
-
api_instance = CloudmersiveImageRecognitionApiClient::ConvertApi.new
|
201
|
-
|
202
|
-
image_file = File.new("/path/to/file.txt") # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
203
|
-
|
204
|
-
|
205
|
-
begin
|
206
|
-
#Convert input image to Photoshop PSD format
|
207
|
-
result = api_instance.convert_to_photoshop(image_file)
|
208
|
-
p result
|
209
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
210
|
-
puts "Exception when calling ConvertApi->convert_to_photoshop: #{e}"
|
211
|
-
end
|
212
|
-
```
|
213
|
-
|
214
|
-
### Parameters
|
215
|
-
|
216
|
-
Name | Type | Description | Notes
|
217
|
-
------------- | ------------- | ------------- | -------------
|
218
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
219
|
-
|
220
|
-
### Return type
|
221
|
-
|
222
|
-
**String**
|
223
|
-
|
224
|
-
### Authorization
|
225
|
-
|
226
|
-
[Apikey](../README.md#Apikey)
|
227
|
-
|
228
|
-
### HTTP request headers
|
229
|
-
|
230
|
-
- **Content-Type**: multipart/form-data
|
231
|
-
- **Accept**: application/octet-stream
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
# **convert_to_png**
|
236
|
-
> String convert_to_png(image_file)
|
237
|
-
|
238
|
-
Convert input image to PNG format
|
239
|
-
|
240
|
-
Converts the input image into PNG format. Transparency is preserved when present. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
|
241
|
-
|
242
|
-
### Example
|
243
|
-
```ruby
|
244
|
-
# load the gem
|
245
|
-
require 'cloudmersive-image-recognition-api-client'
|
246
|
-
# setup authorization
|
247
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
248
|
-
# Configure API key authorization: Apikey
|
249
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
250
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
251
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
252
|
-
end
|
253
|
-
|
254
|
-
api_instance = CloudmersiveImageRecognitionApiClient::ConvertApi.new
|
255
|
-
|
256
|
-
image_file = File.new("/path/to/file.txt") # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
257
|
-
|
258
|
-
|
259
|
-
begin
|
260
|
-
#Convert input image to PNG format
|
261
|
-
result = api_instance.convert_to_png(image_file)
|
262
|
-
p result
|
263
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
264
|
-
puts "Exception when calling ConvertApi->convert_to_png: #{e}"
|
265
|
-
end
|
266
|
-
```
|
267
|
-
|
268
|
-
### Parameters
|
269
|
-
|
270
|
-
Name | Type | Description | Notes
|
271
|
-
------------- | ------------- | ------------- | -------------
|
272
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
273
|
-
|
274
|
-
### Return type
|
275
|
-
|
276
|
-
**String**
|
277
|
-
|
278
|
-
### Authorization
|
279
|
-
|
280
|
-
[Apikey](../README.md#Apikey)
|
281
|
-
|
282
|
-
### HTTP request headers
|
283
|
-
|
284
|
-
- **Content-Type**: multipart/form-data
|
285
|
-
- **Accept**: application/octet-stream
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
# **convert_to_tiff**
|
290
|
-
> String convert_to_tiff(image_file)
|
291
|
-
|
292
|
-
Convert input image to TIFF format
|
293
|
-
|
294
|
-
Converts the input image into TIFF format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
|
295
|
-
|
296
|
-
### Example
|
297
|
-
```ruby
|
298
|
-
# load the gem
|
299
|
-
require 'cloudmersive-image-recognition-api-client'
|
300
|
-
# setup authorization
|
301
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
302
|
-
# Configure API key authorization: Apikey
|
303
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
304
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
305
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
306
|
-
end
|
307
|
-
|
308
|
-
api_instance = CloudmersiveImageRecognitionApiClient::ConvertApi.new
|
309
|
-
|
310
|
-
image_file = File.new("/path/to/file.txt") # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
311
|
-
|
312
|
-
|
313
|
-
begin
|
314
|
-
#Convert input image to TIFF format
|
315
|
-
result = api_instance.convert_to_tiff(image_file)
|
316
|
-
p result
|
317
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
318
|
-
puts "Exception when calling ConvertApi->convert_to_tiff: #{e}"
|
319
|
-
end
|
320
|
-
```
|
321
|
-
|
322
|
-
### Parameters
|
323
|
-
|
324
|
-
Name | Type | Description | Notes
|
325
|
-
------------- | ------------- | ------------- | -------------
|
326
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
327
|
-
|
328
|
-
### Return type
|
329
|
-
|
330
|
-
**String**
|
331
|
-
|
332
|
-
### Authorization
|
333
|
-
|
334
|
-
[Apikey](../README.md#Apikey)
|
335
|
-
|
336
|
-
### HTTP request headers
|
337
|
-
|
338
|
-
- **Content-Type**: multipart/form-data
|
339
|
-
- **Accept**: application/octet-stream
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
# **convert_to_web_p**
|
344
|
-
> String convert_to_web_p(image_file)
|
345
|
-
|
346
|
-
Convert input image to WebP format
|
347
|
-
|
348
|
-
Converts the input image into WebP format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
|
349
|
-
|
350
|
-
### Example
|
351
|
-
```ruby
|
352
|
-
# load the gem
|
353
|
-
require 'cloudmersive-image-recognition-api-client'
|
354
|
-
# setup authorization
|
355
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
356
|
-
# Configure API key authorization: Apikey
|
357
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
358
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
359
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
360
|
-
end
|
361
|
-
|
362
|
-
api_instance = CloudmersiveImageRecognitionApiClient::ConvertApi.new
|
363
|
-
|
364
|
-
image_file = File.new("/path/to/file.txt") # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
365
|
-
|
366
|
-
|
367
|
-
begin
|
368
|
-
#Convert input image to WebP format
|
369
|
-
result = api_instance.convert_to_web_p(image_file)
|
370
|
-
p result
|
371
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
372
|
-
puts "Exception when calling ConvertApi->convert_to_web_p: #{e}"
|
373
|
-
end
|
374
|
-
```
|
375
|
-
|
376
|
-
### Parameters
|
377
|
-
|
378
|
-
Name | Type | Description | Notes
|
379
|
-
------------- | ------------- | ------------- | -------------
|
380
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
381
|
-
|
382
|
-
### Return type
|
383
|
-
|
384
|
-
**String**
|
385
|
-
|
386
|
-
### Authorization
|
387
|
-
|
388
|
-
[Apikey](../README.md#Apikey)
|
389
|
-
|
390
|
-
### HTTP request headers
|
391
|
-
|
392
|
-
- **Content-Type**: multipart/form-data
|
393
|
-
- **Accept**: application/octet-stream
|
394
|
-
|
395
|
-
|
396
|
-
|
@@ -1,14 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::DetectedLicensePlate
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**license_plate_text_best_match** | **String** | Text from the license plate, highest-confidence result | [optional]
|
7
|
-
**license_plate_text_runner_up** | **String** | Alternate text from the license plate, based on second-highest-confidence result | [optional]
|
8
|
-
**location_x** | **Integer** | X location of the left edge of the license plate, starting from the left edge of the photo (X = 0) | [optional]
|
9
|
-
**location_y** | **Integer** | Y location of the top edge of the license plate, starting from the top edge of the photo (Y = 0) | [optional]
|
10
|
-
**width** | **Integer** | Width of the license plate's location in pixels | [optional]
|
11
|
-
**height** | **Integer** | Height of the license plate's location in pixels | [optional]
|
12
|
-
**license_plate_recognition_confidence_level** | **Float** | Confidence score on a range of 0.0 - 1.0 of the accuracy of the detected license plate, with higher scores being better; values about 0.75 are high confidence | [optional]
|
13
|
-
|
14
|
-
|
data/docs/DetectedObject.md
DELETED
@@ -1,13 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::DetectedObject
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**object_class_name** | **String** | Class of the object. Example values are \"person\", \"car\", \"dining table\", etc. | [optional]
|
7
|
-
**height** | **Integer** | Height, in pixels, of the object | [optional]
|
8
|
-
**width** | **Integer** | Width, in pixels, of the object | [optional]
|
9
|
-
**score** | **Float** | Confidence score of detected object; possible values are between 0.0 and 1.0; values closer to 1.0 are higher confidence | [optional]
|
10
|
-
**x** | **Integer** | X location, in pixels, of the left side location of the object, with the right side being X + Width | [optional]
|
11
|
-
**y** | **Integer** | Y location, in pixels, of the top side location of the object, with the bottom side being Y + Height | [optional]
|
12
|
-
|
13
|
-
|
data/docs/DominantColorResult.md
DELETED
@@ -1,9 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::DominantColorResult
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
-
**dominant_colors** | [**Array<ColorResult>**](ColorResult.md) | Dominant colors in the image, in order where most dominant color is in the first index position (0), the second most-dominant color is in index position 1 and so on | [optional]
|
8
|
-
|
9
|
-
|
data/docs/DrawPolygonInstance.md
DELETED
@@ -1,11 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::DrawPolygonInstance
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**border_color** | **String** | Border Color to use - can be a hex value (with #) or HTML common color name. Transparent colors are supported. | [optional]
|
7
|
-
**border_width** | **Float** | Width in pixels of the border. Pass in 0 to draw a polygon with no border | [optional]
|
8
|
-
**fill_color** | **String** | Fill Color to use - can be a hex value (with #) or HTML common color name. Transparent colors are supported. Leave blank to not fill the polygon. | [optional]
|
9
|
-
**points** | [**Array<PolygonPoint>**](PolygonPoint.md) | Points (vertices) which comprise the polygon; valid polygons must have at least 3 points | [optional]
|
10
|
-
|
11
|
-
|