cloudmersive-image-recognition-api-client 1.4.2 → 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 -139
- data/Gemfile +0 -7
- data/README.md +0 -174
- 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 -176
- 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 -539
- 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/InfoApi.md +0 -63
- 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 -80
- 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 -197
- data/lib/cloudmersive-image-recognition-api-client/api/edit_api.rb +0 -597
- 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 -79
- 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 -220
- 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/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 -72
- data/spec/api/edit_api_spec.rb +0 -155
- 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 -47
- 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/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,176 +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_gif**](ConvertApi.md#convert_to_gif) | **POST** /image/convert/to/gif | Convert input image to GIF format
|
8
|
-
[**convert_to_jpg**](ConvertApi.md#convert_to_jpg) | **POST** /image/convert/to/jpg/{quality} | Convert input image to JPG/JPEG format
|
9
|
-
[**convert_to_png**](ConvertApi.md#convert_to_png) | **POST** /image/convert/to/png | Convert input image to PNG format
|
10
|
-
|
11
|
-
|
12
|
-
# **convert_to_gif**
|
13
|
-
> String convert_to_gif(image_file)
|
14
|
-
|
15
|
-
Convert input image to GIF format
|
16
|
-
|
17
|
-
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.
|
18
|
-
|
19
|
-
### Example
|
20
|
-
```ruby
|
21
|
-
# load the gem
|
22
|
-
require 'cloudmersive-image-recognition-api-client'
|
23
|
-
# setup authorization
|
24
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
25
|
-
# Configure API key authorization: Apikey
|
26
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
27
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
29
|
-
end
|
30
|
-
|
31
|
-
api_instance = CloudmersiveImageRecognitionApiClient::ConvertApi.new
|
32
|
-
|
33
|
-
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.
|
34
|
-
|
35
|
-
|
36
|
-
begin
|
37
|
-
#Convert input image to GIF format
|
38
|
-
result = api_instance.convert_to_gif(image_file)
|
39
|
-
p result
|
40
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
41
|
-
puts "Exception when calling ConvertApi->convert_to_gif: #{e}"
|
42
|
-
end
|
43
|
-
```
|
44
|
-
|
45
|
-
### Parameters
|
46
|
-
|
47
|
-
Name | Type | Description | Notes
|
48
|
-
------------- | ------------- | ------------- | -------------
|
49
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
50
|
-
|
51
|
-
### Return type
|
52
|
-
|
53
|
-
**String**
|
54
|
-
|
55
|
-
### Authorization
|
56
|
-
|
57
|
-
[Apikey](../README.md#Apikey)
|
58
|
-
|
59
|
-
### HTTP request headers
|
60
|
-
|
61
|
-
- **Content-Type**: multipart/form-data
|
62
|
-
- **Accept**: image/gif
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
# **convert_to_jpg**
|
67
|
-
> String convert_to_jpg(quality, image_file)
|
68
|
-
|
69
|
-
Convert input image to JPG/JPEG format
|
70
|
-
|
71
|
-
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.
|
72
|
-
|
73
|
-
### Example
|
74
|
-
```ruby
|
75
|
-
# load the gem
|
76
|
-
require 'cloudmersive-image-recognition-api-client'
|
77
|
-
# setup authorization
|
78
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
79
|
-
# Configure API key authorization: Apikey
|
80
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
81
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
82
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
83
|
-
end
|
84
|
-
|
85
|
-
api_instance = CloudmersiveImageRecognitionApiClient::ConvertApi.new
|
86
|
-
|
87
|
-
quality = 56 # Integer | Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75
|
88
|
-
|
89
|
-
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.
|
90
|
-
|
91
|
-
|
92
|
-
begin
|
93
|
-
#Convert input image to JPG/JPEG format
|
94
|
-
result = api_instance.convert_to_jpg(quality, image_file)
|
95
|
-
p result
|
96
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
97
|
-
puts "Exception when calling ConvertApi->convert_to_jpg: #{e}"
|
98
|
-
end
|
99
|
-
```
|
100
|
-
|
101
|
-
### Parameters
|
102
|
-
|
103
|
-
Name | Type | Description | Notes
|
104
|
-
------------- | ------------- | ------------- | -------------
|
105
|
-
**quality** | **Integer**| Set the JPEG quality level; lowest quality is 1 (highest compression), highest quality (lowest compression) is 100; recommended value is 75 |
|
106
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
107
|
-
|
108
|
-
### Return type
|
109
|
-
|
110
|
-
**String**
|
111
|
-
|
112
|
-
### Authorization
|
113
|
-
|
114
|
-
[Apikey](../README.md#Apikey)
|
115
|
-
|
116
|
-
### HTTP request headers
|
117
|
-
|
118
|
-
- **Content-Type**: multipart/form-data
|
119
|
-
- **Accept**: image/jpg
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
# **convert_to_png**
|
124
|
-
> String convert_to_png(image_file)
|
125
|
-
|
126
|
-
Convert input image to PNG format
|
127
|
-
|
128
|
-
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.
|
129
|
-
|
130
|
-
### Example
|
131
|
-
```ruby
|
132
|
-
# load the gem
|
133
|
-
require 'cloudmersive-image-recognition-api-client'
|
134
|
-
# setup authorization
|
135
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
136
|
-
# Configure API key authorization: Apikey
|
137
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
138
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
139
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
140
|
-
end
|
141
|
-
|
142
|
-
api_instance = CloudmersiveImageRecognitionApiClient::ConvertApi.new
|
143
|
-
|
144
|
-
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.
|
145
|
-
|
146
|
-
|
147
|
-
begin
|
148
|
-
#Convert input image to PNG format
|
149
|
-
result = api_instance.convert_to_png(image_file)
|
150
|
-
p result
|
151
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
152
|
-
puts "Exception when calling ConvertApi->convert_to_png: #{e}"
|
153
|
-
end
|
154
|
-
```
|
155
|
-
|
156
|
-
### Parameters
|
157
|
-
|
158
|
-
Name | Type | Description | Notes
|
159
|
-
------------- | ------------- | ------------- | -------------
|
160
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
161
|
-
|
162
|
-
### Return type
|
163
|
-
|
164
|
-
**String**
|
165
|
-
|
166
|
-
### Authorization
|
167
|
-
|
168
|
-
[Apikey](../README.md#Apikey)
|
169
|
-
|
170
|
-
### HTTP request headers
|
171
|
-
|
172
|
-
- **Content-Type**: multipart/form-data
|
173
|
-
- **Accept**: image/png
|
174
|
-
|
175
|
-
|
176
|
-
|
@@ -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
|
-
|
data/docs/DrawPolygonRequest.md
DELETED
@@ -1,10 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::DrawPolygonRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**base_image_bytes** | **String** | Image to draw polygons on, in bytes. You can also use the BaseImageUrl instead to supply image input as a URL | [optional]
|
7
|
-
**base_image_url** | **String** | Image to draw polygons on, as an HTTP or HTTPS fully-qualified URL | [optional]
|
8
|
-
**polygons_to_draw** | [**Array<DrawPolygonInstance>**](DrawPolygonInstance.md) | Polygons to draw on the image. Polygons are drawn in index order. | [optional]
|
9
|
-
|
10
|
-
|
@@ -1,14 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::DrawRectangleInstance
|
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 rectangle 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 rectangle. | [optional]
|
9
|
-
**x** | **Float** | Pixel location of the left edge of the rectangle location | [optional]
|
10
|
-
**y** | **Float** | Pixel location of the top edge of the rectangle location | [optional]
|
11
|
-
**width** | **Float** | Width in pixels of the rectangle | [optional]
|
12
|
-
**height** | **Float** | Height in pixels of the rectangle | [optional]
|
13
|
-
|
14
|
-
|
@@ -1,10 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::DrawRectangleRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**base_image_bytes** | **String** | Image to draw rectangles on, in bytes. You can also use the BaseImageUrl instead to supply image input as a URL | [optional]
|
7
|
-
**base_image_url** | **String** | Image to draw rectangles on, as an HTTP or HTTPS fully-qualified URL | [optional]
|
8
|
-
**rectangles_to_draw** | [**Array<DrawRectangleInstance>**](DrawRectangleInstance.md) | Rectangles to draw on the image. Rectangles are drawn in index order. | [optional]
|
9
|
-
|
10
|
-
|
data/docs/DrawTextInstance.md
DELETED
@@ -1,15 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::DrawTextInstance
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**text** | **String** | Text string to draw | [optional]
|
7
|
-
**font_family_name** | **String** | Font Family to use. Leave blank to default to \"Arial\". | [optional]
|
8
|
-
**font_size** | **Float** | Font size to use. | [optional]
|
9
|
-
**color** | **String** | Color to use - can be a hex value (with #) or HTML common color name | [optional]
|
10
|
-
**x** | **Float** | Pixel location of the left edge of the text location | [optional]
|
11
|
-
**y** | **Float** | Pixel location of the top edge of the text location | [optional]
|
12
|
-
**width** | **Float** | Width in pixels of the text box to draw the text in; text will wrap inside this box | [optional]
|
13
|
-
**height** | **Float** | Height in pixels of the text box to draw the text in; text will wrap inside this box | [optional]
|
14
|
-
|
15
|
-
|
data/docs/DrawTextRequest.md
DELETED
@@ -1,10 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::DrawTextRequest
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**base_image_bytes** | **String** | Image to draw text on, in bytes. You can also use the BaseImageUrl instead to supply image input as a URL | [optional]
|
7
|
-
**base_image_url** | **String** | Image to draw text on, as an HTTP or HTTPS fully-qualified URL | [optional]
|
8
|
-
**text_to_draw** | [**Array<DrawTextInstance>**](DrawTextInstance.md) | One or more pieces of text to draw onto the image | [optional]
|
9
|
-
|
10
|
-
|
data/docs/EditApi.md
DELETED
@@ -1,539 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::EditApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**edit_auto_orient**](EditApi.md#edit_auto_orient) | **POST** /image/edit/auto-orient/remove-exif | Normalizes image rotation and removes EXIF rotation data
|
8
|
-
[**edit_composite_basic**](EditApi.md#edit_composite_basic) | **POST** /image/edit/composite/{location} | Composite two images together
|
9
|
-
[**edit_contrast_adaptive**](EditApi.md#edit_contrast_adaptive) | **POST** /image/edit/contrast/{gamma}/adaptive | Adaptively adjust the contrast of the image to be more appealing and easy to see
|
10
|
-
[**edit_crop_rectangle**](EditApi.md#edit_crop_rectangle) | **POST** /image/edit/crop/rectangle/{left}/{top}/{width}/{height} | Crop an image to a rectangular area
|
11
|
-
[**edit_draw_polygon**](EditApi.md#edit_draw_polygon) | **POST** /image/edit/draw/polygon | Draw a polygon onto an image
|
12
|
-
[**edit_draw_rectangle**](EditApi.md#edit_draw_rectangle) | **POST** /image/edit/draw/rectangle | Draw a rectangle onto an image
|
13
|
-
[**edit_draw_text**](EditApi.md#edit_draw_text) | **POST** /image/edit/draw/text | Draw text onto an image
|
14
|
-
[**edit_drop_shadow**](EditApi.md#edit_drop_shadow) | **POST** /image/edit/drop-shadow/{X}/{Y}/{sigma}/{opacity} | Add a customizeable drop shadow to an image
|
15
|
-
[**edit_rotate**](EditApi.md#edit_rotate) | **POST** /image/edit/rotate/{degrees}/angle | Rotate an image any number of degrees
|
16
|
-
|
17
|
-
|
18
|
-
# **edit_auto_orient**
|
19
|
-
> String edit_auto_orient(image_file)
|
20
|
-
|
21
|
-
Normalizes image rotation and removes EXIF rotation data
|
22
|
-
|
23
|
-
Automatically orients the input image based on EXIF information and then removes the EXIF information. EXIF is an additional set of information stored in some images taken with cell phone cameras based on the orientation of the camera. By normalizing rotation and removing EXIF data these images become much easier to process.
|
24
|
-
|
25
|
-
### Example
|
26
|
-
```ruby
|
27
|
-
# load the gem
|
28
|
-
require 'cloudmersive-image-recognition-api-client'
|
29
|
-
# setup authorization
|
30
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
31
|
-
# Configure API key authorization: Apikey
|
32
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
33
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
34
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
35
|
-
end
|
36
|
-
|
37
|
-
api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
|
38
|
-
|
39
|
-
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.
|
40
|
-
|
41
|
-
|
42
|
-
begin
|
43
|
-
#Normalizes image rotation and removes EXIF rotation data
|
44
|
-
result = api_instance.edit_auto_orient(image_file)
|
45
|
-
p result
|
46
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
47
|
-
puts "Exception when calling EditApi->edit_auto_orient: #{e}"
|
48
|
-
end
|
49
|
-
```
|
50
|
-
|
51
|
-
### Parameters
|
52
|
-
|
53
|
-
Name | Type | Description | Notes
|
54
|
-
------------- | ------------- | ------------- | -------------
|
55
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
56
|
-
|
57
|
-
### Return type
|
58
|
-
|
59
|
-
**String**
|
60
|
-
|
61
|
-
### Authorization
|
62
|
-
|
63
|
-
[Apikey](../README.md#Apikey)
|
64
|
-
|
65
|
-
### HTTP request headers
|
66
|
-
|
67
|
-
- **Content-Type**: multipart/form-data
|
68
|
-
- **Accept**: application/octet-stream
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
# **edit_composite_basic**
|
73
|
-
> String edit_composite_basic(location, base_image, layered_image)
|
74
|
-
|
75
|
-
Composite two images together
|
76
|
-
|
77
|
-
Composites two input images together; a layered image onto a base image. The first image you input is the base image. The second image (the layered image) will be composited on top of this base image. Supports PNG transparency. To control padding you can include transparent pixels at the border(s) of your layered images as appropriate.
|
78
|
-
|
79
|
-
### Example
|
80
|
-
```ruby
|
81
|
-
# load the gem
|
82
|
-
require 'cloudmersive-image-recognition-api-client'
|
83
|
-
# setup authorization
|
84
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
85
|
-
# Configure API key authorization: Apikey
|
86
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
87
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
88
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
89
|
-
end
|
90
|
-
|
91
|
-
api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
|
92
|
-
|
93
|
-
location = "location_example" # String | Location to composite the layered images; possible values are: \"center\", \"top-left\", \"top-center\", \"top-right\", \"center-left\", \"center-right\", \"bottom-left\", \"bottom-center\", \"bottom-right\"
|
94
|
-
|
95
|
-
base_image = File.new("/path/to/file.txt") # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
96
|
-
|
97
|
-
layered_image = File.new("/path/to/file.txt") # File | Image to layer on top of the base image.
|
98
|
-
|
99
|
-
|
100
|
-
begin
|
101
|
-
#Composite two images together
|
102
|
-
result = api_instance.edit_composite_basic(location, base_image, layered_image)
|
103
|
-
p result
|
104
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
105
|
-
puts "Exception when calling EditApi->edit_composite_basic: #{e}"
|
106
|
-
end
|
107
|
-
```
|
108
|
-
|
109
|
-
### Parameters
|
110
|
-
|
111
|
-
Name | Type | Description | Notes
|
112
|
-
------------- | ------------- | ------------- | -------------
|
113
|
-
**location** | **String**| Location to composite the layered images; possible values are: \"center\", \"top-left\", \"top-center\", \"top-right\", \"center-left\", \"center-right\", \"bottom-left\", \"bottom-center\", \"bottom-right\" |
|
114
|
-
**base_image** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
115
|
-
**layered_image** | **File**| Image to layer on top of the base image. |
|
116
|
-
|
117
|
-
### Return type
|
118
|
-
|
119
|
-
**String**
|
120
|
-
|
121
|
-
### Authorization
|
122
|
-
|
123
|
-
[Apikey](../README.md#Apikey)
|
124
|
-
|
125
|
-
### HTTP request headers
|
126
|
-
|
127
|
-
- **Content-Type**: multipart/form-data
|
128
|
-
- **Accept**: image/png
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
# **edit_contrast_adaptive**
|
133
|
-
> String edit_contrast_adaptive(gamma, image_file)
|
134
|
-
|
135
|
-
Adaptively adjust the contrast of the image to be more appealing and easy to see
|
136
|
-
|
137
|
-
Uses Gamma to adjust the contrast adaptively the way the human eye sees the world. Results significantly improve the viewability and visual appeal of the image.
|
138
|
-
|
139
|
-
### Example
|
140
|
-
```ruby
|
141
|
-
# load the gem
|
142
|
-
require 'cloudmersive-image-recognition-api-client'
|
143
|
-
# setup authorization
|
144
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
145
|
-
# Configure API key authorization: Apikey
|
146
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
147
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
148
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
149
|
-
end
|
150
|
-
|
151
|
-
api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
|
152
|
-
|
153
|
-
gamma = 1.2 # Float | Gamma value to adjust the contrast in the image. Recommended value is 2.0. Values between 0.0 and 1.0 will reduce contrast, while values above 1.0 will increase contrast.
|
154
|
-
|
155
|
-
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.
|
156
|
-
|
157
|
-
|
158
|
-
begin
|
159
|
-
#Adaptively adjust the contrast of the image to be more appealing and easy to see
|
160
|
-
result = api_instance.edit_contrast_adaptive(gamma, image_file)
|
161
|
-
p result
|
162
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
163
|
-
puts "Exception when calling EditApi->edit_contrast_adaptive: #{e}"
|
164
|
-
end
|
165
|
-
```
|
166
|
-
|
167
|
-
### Parameters
|
168
|
-
|
169
|
-
Name | Type | Description | Notes
|
170
|
-
------------- | ------------- | ------------- | -------------
|
171
|
-
**gamma** | **Float**| Gamma value to adjust the contrast in the image. Recommended value is 2.0. Values between 0.0 and 1.0 will reduce contrast, while values above 1.0 will increase contrast. |
|
172
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
173
|
-
|
174
|
-
### Return type
|
175
|
-
|
176
|
-
**String**
|
177
|
-
|
178
|
-
### Authorization
|
179
|
-
|
180
|
-
[Apikey](../README.md#Apikey)
|
181
|
-
|
182
|
-
### HTTP request headers
|
183
|
-
|
184
|
-
- **Content-Type**: multipart/form-data
|
185
|
-
- **Accept**: image/png
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
# **edit_crop_rectangle**
|
190
|
-
> String edit_crop_rectangle(left, top, width, height, image_file)
|
191
|
-
|
192
|
-
Crop an image to a rectangular area
|
193
|
-
|
194
|
-
Crop an image to a target rectangular area
|
195
|
-
|
196
|
-
### Example
|
197
|
-
```ruby
|
198
|
-
# load the gem
|
199
|
-
require 'cloudmersive-image-recognition-api-client'
|
200
|
-
# setup authorization
|
201
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
202
|
-
# Configure API key authorization: Apikey
|
203
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
204
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
205
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
206
|
-
end
|
207
|
-
|
208
|
-
api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
|
209
|
-
|
210
|
-
left = 56 # Integer | The left edge of the rectangular crop area in pixels (X).
|
211
|
-
|
212
|
-
top = 56 # Integer | The top edge of the rectangular crop area in pixels (Y).
|
213
|
-
|
214
|
-
width = 56 # Integer | The width of the rectangular crop area in pixels.
|
215
|
-
|
216
|
-
height = 56 # Integer | The height of the rectangular crop area in pixels.
|
217
|
-
|
218
|
-
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.
|
219
|
-
|
220
|
-
|
221
|
-
begin
|
222
|
-
#Crop an image to a rectangular area
|
223
|
-
result = api_instance.edit_crop_rectangle(left, top, width, height, image_file)
|
224
|
-
p result
|
225
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
226
|
-
puts "Exception when calling EditApi->edit_crop_rectangle: #{e}"
|
227
|
-
end
|
228
|
-
```
|
229
|
-
|
230
|
-
### Parameters
|
231
|
-
|
232
|
-
Name | Type | Description | Notes
|
233
|
-
------------- | ------------- | ------------- | -------------
|
234
|
-
**left** | **Integer**| The left edge of the rectangular crop area in pixels (X). |
|
235
|
-
**top** | **Integer**| The top edge of the rectangular crop area in pixels (Y). |
|
236
|
-
**width** | **Integer**| The width of the rectangular crop area in pixels. |
|
237
|
-
**height** | **Integer**| The height of the rectangular crop area in pixels. |
|
238
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
239
|
-
|
240
|
-
### Return type
|
241
|
-
|
242
|
-
**String**
|
243
|
-
|
244
|
-
### Authorization
|
245
|
-
|
246
|
-
[Apikey](../README.md#Apikey)
|
247
|
-
|
248
|
-
### HTTP request headers
|
249
|
-
|
250
|
-
- **Content-Type**: multipart/form-data
|
251
|
-
- **Accept**: application/octet-stream
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
# **edit_draw_polygon**
|
256
|
-
> String edit_draw_polygon(request)
|
257
|
-
|
258
|
-
Draw a polygon onto an image
|
259
|
-
|
260
|
-
Draw one or more polygons, with customized visuals, onto an image
|
261
|
-
|
262
|
-
### Example
|
263
|
-
```ruby
|
264
|
-
# load the gem
|
265
|
-
require 'cloudmersive-image-recognition-api-client'
|
266
|
-
# setup authorization
|
267
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
268
|
-
# Configure API key authorization: Apikey
|
269
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
270
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
271
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
272
|
-
end
|
273
|
-
|
274
|
-
api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
|
275
|
-
|
276
|
-
request = CloudmersiveImageRecognitionApiClient::DrawPolygonRequest.new # DrawPolygonRequest |
|
277
|
-
|
278
|
-
|
279
|
-
begin
|
280
|
-
#Draw a polygon onto an image
|
281
|
-
result = api_instance.edit_draw_polygon(request)
|
282
|
-
p result
|
283
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
284
|
-
puts "Exception when calling EditApi->edit_draw_polygon: #{e}"
|
285
|
-
end
|
286
|
-
```
|
287
|
-
|
288
|
-
### Parameters
|
289
|
-
|
290
|
-
Name | Type | Description | Notes
|
291
|
-
------------- | ------------- | ------------- | -------------
|
292
|
-
**request** | [**DrawPolygonRequest**](DrawPolygonRequest.md)| |
|
293
|
-
|
294
|
-
### Return type
|
295
|
-
|
296
|
-
**String**
|
297
|
-
|
298
|
-
### Authorization
|
299
|
-
|
300
|
-
[Apikey](../README.md#Apikey)
|
301
|
-
|
302
|
-
### HTTP request headers
|
303
|
-
|
304
|
-
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
305
|
-
- **Accept**: image/png
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
# **edit_draw_rectangle**
|
310
|
-
> String edit_draw_rectangle(request)
|
311
|
-
|
312
|
-
Draw a rectangle onto an image
|
313
|
-
|
314
|
-
Draw one or more rectangles, with customized visuals, onto an image
|
315
|
-
|
316
|
-
### Example
|
317
|
-
```ruby
|
318
|
-
# load the gem
|
319
|
-
require 'cloudmersive-image-recognition-api-client'
|
320
|
-
# setup authorization
|
321
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
322
|
-
# Configure API key authorization: Apikey
|
323
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
324
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
325
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
326
|
-
end
|
327
|
-
|
328
|
-
api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
|
329
|
-
|
330
|
-
request = CloudmersiveImageRecognitionApiClient::DrawRectangleRequest.new # DrawRectangleRequest |
|
331
|
-
|
332
|
-
|
333
|
-
begin
|
334
|
-
#Draw a rectangle onto an image
|
335
|
-
result = api_instance.edit_draw_rectangle(request)
|
336
|
-
p result
|
337
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
338
|
-
puts "Exception when calling EditApi->edit_draw_rectangle: #{e}"
|
339
|
-
end
|
340
|
-
```
|
341
|
-
|
342
|
-
### Parameters
|
343
|
-
|
344
|
-
Name | Type | Description | Notes
|
345
|
-
------------- | ------------- | ------------- | -------------
|
346
|
-
**request** | [**DrawRectangleRequest**](DrawRectangleRequest.md)| |
|
347
|
-
|
348
|
-
### Return type
|
349
|
-
|
350
|
-
**String**
|
351
|
-
|
352
|
-
### Authorization
|
353
|
-
|
354
|
-
[Apikey](../README.md#Apikey)
|
355
|
-
|
356
|
-
### HTTP request headers
|
357
|
-
|
358
|
-
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
359
|
-
- **Accept**: image/png
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
# **edit_draw_text**
|
364
|
-
> String edit_draw_text(request)
|
365
|
-
|
366
|
-
Draw text onto an image
|
367
|
-
|
368
|
-
Draw one or more pieces of text, with customized visuals, onto an image
|
369
|
-
|
370
|
-
### Example
|
371
|
-
```ruby
|
372
|
-
# load the gem
|
373
|
-
require 'cloudmersive-image-recognition-api-client'
|
374
|
-
# setup authorization
|
375
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
376
|
-
# Configure API key authorization: Apikey
|
377
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
378
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
379
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
380
|
-
end
|
381
|
-
|
382
|
-
api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
|
383
|
-
|
384
|
-
request = CloudmersiveImageRecognitionApiClient::DrawTextRequest.new # DrawTextRequest |
|
385
|
-
|
386
|
-
|
387
|
-
begin
|
388
|
-
#Draw text onto an image
|
389
|
-
result = api_instance.edit_draw_text(request)
|
390
|
-
p result
|
391
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
392
|
-
puts "Exception when calling EditApi->edit_draw_text: #{e}"
|
393
|
-
end
|
394
|
-
```
|
395
|
-
|
396
|
-
### Parameters
|
397
|
-
|
398
|
-
Name | Type | Description | Notes
|
399
|
-
------------- | ------------- | ------------- | -------------
|
400
|
-
**request** | [**DrawTextRequest**](DrawTextRequest.md)| |
|
401
|
-
|
402
|
-
### Return type
|
403
|
-
|
404
|
-
**String**
|
405
|
-
|
406
|
-
### Authorization
|
407
|
-
|
408
|
-
[Apikey](../README.md#Apikey)
|
409
|
-
|
410
|
-
### HTTP request headers
|
411
|
-
|
412
|
-
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
413
|
-
- **Accept**: image/png
|
414
|
-
|
415
|
-
|
416
|
-
|
417
|
-
# **edit_drop_shadow**
|
418
|
-
> String edit_drop_shadow(x, y, sigma, opacity, image_file)
|
419
|
-
|
420
|
-
Add a customizeable drop shadow to an image
|
421
|
-
|
422
|
-
Add a customizeable drop shadow to the image
|
423
|
-
|
424
|
-
### Example
|
425
|
-
```ruby
|
426
|
-
# load the gem
|
427
|
-
require 'cloudmersive-image-recognition-api-client'
|
428
|
-
# setup authorization
|
429
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
430
|
-
# Configure API key authorization: Apikey
|
431
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
432
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
433
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
434
|
-
end
|
435
|
-
|
436
|
-
api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
|
437
|
-
|
438
|
-
x = 56 # Integer |
|
439
|
-
|
440
|
-
y = 56 # Integer |
|
441
|
-
|
442
|
-
sigma = 56 # Integer | Sigma (blur distance) of the drop shadow
|
443
|
-
|
444
|
-
opacity = 56 # Integer | Opacity of the drop shadow; 0 is 0% and 100 is 100%
|
445
|
-
|
446
|
-
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.
|
447
|
-
|
448
|
-
|
449
|
-
begin
|
450
|
-
#Add a customizeable drop shadow to an image
|
451
|
-
result = api_instance.edit_drop_shadow(x, y, sigma, opacity, image_file)
|
452
|
-
p result
|
453
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
454
|
-
puts "Exception when calling EditApi->edit_drop_shadow: #{e}"
|
455
|
-
end
|
456
|
-
```
|
457
|
-
|
458
|
-
### Parameters
|
459
|
-
|
460
|
-
Name | Type | Description | Notes
|
461
|
-
------------- | ------------- | ------------- | -------------
|
462
|
-
**x** | **Integer**| |
|
463
|
-
**y** | **Integer**| |
|
464
|
-
**sigma** | **Integer**| Sigma (blur distance) of the drop shadow |
|
465
|
-
**opacity** | **Integer**| Opacity of the drop shadow; 0 is 0% and 100 is 100% |
|
466
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
467
|
-
|
468
|
-
### Return type
|
469
|
-
|
470
|
-
**String**
|
471
|
-
|
472
|
-
### Authorization
|
473
|
-
|
474
|
-
[Apikey](../README.md#Apikey)
|
475
|
-
|
476
|
-
### HTTP request headers
|
477
|
-
|
478
|
-
- **Content-Type**: multipart/form-data
|
479
|
-
- **Accept**: application/octet-stream
|
480
|
-
|
481
|
-
|
482
|
-
|
483
|
-
# **edit_rotate**
|
484
|
-
> String edit_rotate(degrees, image_file)
|
485
|
-
|
486
|
-
Rotate an image any number of degrees
|
487
|
-
|
488
|
-
Rotates an image by an arbitrary number of degrees
|
489
|
-
|
490
|
-
### Example
|
491
|
-
```ruby
|
492
|
-
# load the gem
|
493
|
-
require 'cloudmersive-image-recognition-api-client'
|
494
|
-
# setup authorization
|
495
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
496
|
-
# Configure API key authorization: Apikey
|
497
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
498
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
499
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
500
|
-
end
|
501
|
-
|
502
|
-
api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
|
503
|
-
|
504
|
-
degrees = 1.2 # Float | Degrees to rotate the image; values range from 0.0 to 360.0.
|
505
|
-
|
506
|
-
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.
|
507
|
-
|
508
|
-
|
509
|
-
begin
|
510
|
-
#Rotate an image any number of degrees
|
511
|
-
result = api_instance.edit_rotate(degrees, image_file)
|
512
|
-
p result
|
513
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
514
|
-
puts "Exception when calling EditApi->edit_rotate: #{e}"
|
515
|
-
end
|
516
|
-
```
|
517
|
-
|
518
|
-
### Parameters
|
519
|
-
|
520
|
-
Name | Type | Description | Notes
|
521
|
-
------------- | ------------- | ------------- | -------------
|
522
|
-
**degrees** | **Float**| Degrees to rotate the image; values range from 0.0 to 360.0. |
|
523
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
524
|
-
|
525
|
-
### Return type
|
526
|
-
|
527
|
-
**String**
|
528
|
-
|
529
|
-
### Authorization
|
530
|
-
|
531
|
-
[Apikey](../README.md#Apikey)
|
532
|
-
|
533
|
-
### HTTP request headers
|
534
|
-
|
535
|
-
- **Content-Type**: multipart/form-data
|
536
|
-
- **Accept**: application/octet-stream
|
537
|
-
|
538
|
-
|
539
|
-
|