cloudmersive-image-recognition-api-client 1.4.4 → 1.4.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -14
  3. data/docs/ConvertApi.md +6 -6
  4. data/docs/EditApi.md +15 -15
  5. data/docs/FaceApi.md +12 -12
  6. data/docs/FaceLocateResponse.md +1 -1
  7. data/docs/FilterApi.md +3 -3
  8. data/docs/ImageMetadata.md +2 -0
  9. data/docs/InfoApi.md +3 -3
  10. data/docs/NsfwApi.md +3 -3
  11. data/docs/RecognizeApi.md +6 -6
  12. data/docs/ResizeApi.md +6 -6
  13. data/lib/cloudmersive-image-recognition-api-client/api/convert_api.rb +5 -5
  14. data/lib/cloudmersive-image-recognition-api-client/api/edit_api.rb +15 -15
  15. data/lib/cloudmersive-image-recognition-api-client/api/face_api.rb +8 -8
  16. data/lib/cloudmersive-image-recognition-api-client/api/filter_api.rb +2 -2
  17. data/lib/cloudmersive-image-recognition-api-client/api/info_api.rb +2 -2
  18. data/lib/cloudmersive-image-recognition-api-client/api/nsfw_api.rb +2 -2
  19. data/lib/cloudmersive-image-recognition-api-client/api/recognize_api.rb +4 -4
  20. data/lib/cloudmersive-image-recognition-api-client/api/resize_api.rb +6 -6
  21. data/lib/cloudmersive-image-recognition-api-client/models/face_locate_response.rb +14 -13
  22. data/lib/cloudmersive-image-recognition-api-client/models/image_metadata.rb +21 -1
  23. data/lib/cloudmersive-image-recognition-api-client/version.rb +1 -1
  24. data/spec/api/convert_api_spec.rb +1 -1
  25. data/spec/api/edit_api_spec.rb +5 -5
  26. data/spec/api/face_api_spec.rb +4 -4
  27. data/spec/api/filter_api_spec.rb +1 -1
  28. data/spec/api/info_api_spec.rb +1 -1
  29. data/spec/api/nsfw_api_spec.rb +1 -1
  30. data/spec/api/recognize_api_spec.rb +2 -2
  31. data/spec/api/resize_api_spec.rb +2 -2
  32. data/spec/models/face_locate_response_spec.rb +4 -4
  33. data/spec/models/image_metadata_spec.rb +12 -0
  34. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b8c62bd4a59e2811d2a064f1c157bd1eeabf69517b2f74828a37c430e167d5b5
4
- data.tar.gz: 81a32ecb933c7ef55ea65fa906f017885ed9462eef988b50815bdd06c34eca17
3
+ metadata.gz: 26eafa4156eec2851a69c4ab7407eab2c6d0f0d8cb0287e7359b22f78ccbc40b
4
+ data.tar.gz: 7db96fea3c6b5d45590e4055fdb9970156c8e25dee5ea17379bd8a46798d2952
5
5
  SHA512:
6
- metadata.gz: 4f86e6707e094cc9d50549887ac3a99edf7f0a88e0db9351653511415cd468e5ba5a70b9d332fac9a067c6bfbf411e91607a16de803c9d73e35ad3770d87cd59
7
- data.tar.gz: 10ec8539e812d38bbf771319994b5ac94a4c33d2fb575df786e6a4335d7021256c423704db0cc919756506051541e95a0c3fc487bec53c3c1f07ab3f5346360d
6
+ metadata.gz: efe66c1194903a392d58046c68632348d658d7c7b8473bf2fdac054044908cc6d7ef8d5bf10666ada52b143a984f86044b62dc268b8c5757ab39b9e3d4d3365f
7
+ data.tar.gz: e923a10ccb91effa880324fbdd6d294ae3620b5856bc1a104ae51f82e7d3da23e20c1026c608f4d5d58ea66b637d2b97d0e470bcea51ce127828f78100cd2da9
data/README.md CHANGED
@@ -7,7 +7,7 @@ Image Recognition and Processing APIs let you use Machine Learning to recognize
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 1.4.4
10
+ - Package version: 1.4.5
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-image-recognition-api-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./cloudmersive-image-recognition-api-client-1.4.4.gem
26
+ gem install ./cloudmersive-image-recognition-api-client-1.4.5.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-image-recognition-api-client-1.4.4.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-image-recognition-api-client-1.4.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-image-recognition-api-client', '~> 1.4.4'
34
+ gem 'cloudmersive-image-recognition-api-client', '~> 1.4.5'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -88,7 +88,7 @@ Class | Method | HTTP request | Description
88
88
  *CloudmersiveImageRecognitionApiClient::ArtisticApi* | [**artistic_painting**](docs/ArtisticApi.md#artistic_painting) | **POST** /image/artistic/painting/{style} | Transform an image into an artistic painting automatically
89
89
  *CloudmersiveImageRecognitionApiClient::ConvertApi* | [**convert_to_bmp**](docs/ConvertApi.md#convert_to_bmp) | **POST** /image/convert/to/bmp | Convert input image to Bitmap BMP format
90
90
  *CloudmersiveImageRecognitionApiClient::ConvertApi* | [**convert_to_gif**](docs/ConvertApi.md#convert_to_gif) | **POST** /image/convert/to/gif | Convert input image to GIF format
91
- *CloudmersiveImageRecognitionApiClient::ConvertApi* | [**convert_to_jpg**](docs/ConvertApi.md#convert_to_jpg) | **POST** /image/convert/to/jpg/{quality} | Convert input image to JPG/JPEG format
91
+ *CloudmersiveImageRecognitionApiClient::ConvertApi* | [**convert_to_jpg**](docs/ConvertApi.md#convert_to_jpg) | **POST** /image/convert/to/jpg/{quality} | Convert input image to JPG, JPEG format
92
92
  *CloudmersiveImageRecognitionApiClient::ConvertApi* | [**convert_to_photoshop**](docs/ConvertApi.md#convert_to_photoshop) | **POST** /image/convert/to/psd | Convert input image to Photoshop PSD format
93
93
  *CloudmersiveImageRecognitionApiClient::ConvertApi* | [**convert_to_png**](docs/ConvertApi.md#convert_to_png) | **POST** /image/convert/to/png | Convert input image to PNG format
94
94
  *CloudmersiveImageRecognitionApiClient::ConvertApi* | [**convert_to_tiff**](docs/ConvertApi.md#convert_to_tiff) | **POST** /image/convert/to/tiff | Convert input image to TIFF format
@@ -104,14 +104,14 @@ Class | Method | HTTP request | Description
104
104
  *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_remove_transparency**](docs/EditApi.md#edit_remove_transparency) | **POST** /image/edit/remove-transparency | Remove transparency from the image
105
105
  *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_rotate**](docs/EditApi.md#edit_rotate) | **POST** /image/edit/rotate/{degrees}/angle | Rotate an image any number of degrees
106
106
  *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_compare**](docs/FaceApi.md#face_compare) | **POST** /image/face/compare-and-match | Compare and match faces
107
- *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_crop_first**](docs/FaceApi.md#face_crop_first) | **POST** /image/face/crop/first | Crop image to face (square)
108
- *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_crop_first_round**](docs/FaceApi.md#face_crop_first_round) | **POST** /image/face/crop/first/round | Crop image to face (round)
107
+ *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_crop_first**](docs/FaceApi.md#face_crop_first) | **POST** /image/face/crop/first | Crop image to face with square crop
108
+ *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_crop_first_round**](docs/FaceApi.md#face_crop_first_round) | **POST** /image/face/crop/first/round | Crop image to face with round crop
109
109
  *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_detect_age**](docs/FaceApi.md#face_detect_age) | **POST** /image/face/detect-age | Detect the age of people in an image
110
110
  *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_detect_gender**](docs/FaceApi.md#face_detect_gender) | **POST** /image/face/detect-gender | Detect the gender of people in an image
111
- *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_locate**](docs/FaceApi.md#face_locate) | **POST** /image/face/locate | Find faces in an image
112
- *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_locate_with_landmarks**](docs/FaceApi.md#face_locate_with_landmarks) | **POST** /image/face/locate-with-landmarks | Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image
111
+ *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_locate**](docs/FaceApi.md#face_locate) | **POST** /image/face/locate | Detect and find faces in an image
112
+ *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_locate_with_landmarks**](docs/FaceApi.md#face_locate_with_landmarks) | **POST** /image/face/locate-with-landmarks | Detect and find faces and landmarks eyes and nose and mouth in image
113
113
  *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_black_and_white**](docs/FilterApi.md#filter_black_and_white) | **POST** /image/filter/black-and-white | Convert image to black-and-white grayscale
114
- *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_despeckle**](docs/FilterApi.md#filter_despeckle) | **POST** /image/filter/despeckle | Despeckle (remove point noise) from the image
114
+ *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_despeckle**](docs/FilterApi.md#filter_despeckle) | **POST** /image/filter/despeckle | Despeckle to remove point noise from the image
115
115
  *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_edge_detect**](docs/FilterApi.md#filter_edge_detect) | **POST** /image/filter/edge-detect/{radius} | Detect and highlight edges in an image
116
116
  *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_emboss**](docs/FilterApi.md#filter_emboss) | **POST** /image/filter/emboss/{radius}/{sigma} | Emboss an image
117
117
  *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_gaussian_blur**](docs/FilterApi.md#filter_gaussian_blur) | **POST** /image/filter/blur/guassian/{radius}/{sigma} | Perform a guassian blur on the input image
@@ -119,12 +119,12 @@ Class | Method | HTTP request | Description
119
119
  *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_posterize**](docs/FilterApi.md#filter_posterize) | **POST** /image/filter/posterize | Posterize the image by reducing distinct colors
120
120
  *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_swirl**](docs/FilterApi.md#filter_swirl) | **POST** /image/filter/swirl | Swirl distort the image
121
121
  *CloudmersiveImageRecognitionApiClient::InfoApi* | [**info_get_dominant_color**](docs/InfoApi.md#info_get_dominant_color) | **POST** /image/get-info/dominant-color | Returns the dominant colors of the image
122
- *CloudmersiveImageRecognitionApiClient::InfoApi* | [**info_get_metadata**](docs/InfoApi.md#info_get_metadata) | **POST** /image/get-info/metadata | Returns the image metadata, including EXIF and resolution
123
- *CloudmersiveImageRecognitionApiClient::NsfwApi* | [**nsfw_classify**](docs/NsfwApi.md#nsfw_classify) | **POST** /image/nsfw/classify | Not safe for work (NSFW) racy content classification
122
+ *CloudmersiveImageRecognitionApiClient::InfoApi* | [**info_get_metadata**](docs/InfoApi.md#info_get_metadata) | **POST** /image/get-info/metadata | Returns the image metadata including EXIF and resolution
123
+ *CloudmersiveImageRecognitionApiClient::NsfwApi* | [**nsfw_classify**](docs/NsfwApi.md#nsfw_classify) | **POST** /image/nsfw/classify | Not safe for work NSFW racy content classification
124
124
  *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_describe**](docs/RecognizeApi.md#recognize_describe) | **POST** /image/recognize/describe | Describe an image in natural language
125
125
  *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_and_unskew_document**](docs/RecognizeApi.md#recognize_detect_and_unskew_document) | **POST** /image/recognize/detect-document/unskew | Detect and unskew a photo of a document
126
- *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_objects**](docs/RecognizeApi.md#recognize_detect_objects) | **POST** /image/recognize/detect-objects | Detect objects, including types and locations, in an image
127
- *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_people**](docs/RecognizeApi.md#recognize_detect_people) | **POST** /image/recognize/detect-people | Detect people, including locations, in an image
126
+ *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_objects**](docs/RecognizeApi.md#recognize_detect_objects) | **POST** /image/recognize/detect-objects | Detect objects including types and locations in an image
127
+ *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_people**](docs/RecognizeApi.md#recognize_detect_people) | **POST** /image/recognize/detect-people | Detect people including locations in an image
128
128
  *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_text_fine**](docs/RecognizeApi.md#recognize_detect_text_fine) | **POST** /image/recognize/detect-text/fine | Detect fine text in a photo of a document
129
129
  *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_text_large**](docs/RecognizeApi.md#recognize_detect_text_large) | **POST** /image/recognize/detect-text/large | Detect large text in a photo
130
130
  *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_vehicle_license_plates**](docs/RecognizeApi.md#recognize_detect_vehicle_license_plates) | **POST** /image/recognize/detect-vehicle-license-plates | Detect vehicle license plates in an image
data/docs/ConvertApi.md CHANGED
@@ -6,7 +6,7 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**convert_to_bmp**](ConvertApi.md#convert_to_bmp) | **POST** /image/convert/to/bmp | Convert input image to Bitmap BMP format
8
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
9
+ [**convert_to_jpg**](ConvertApi.md#convert_to_jpg) | **POST** /image/convert/to/jpg/{quality} | Convert input image to JPG, JPEG format
10
10
  [**convert_to_photoshop**](ConvertApi.md#convert_to_photoshop) | **POST** /image/convert/to/psd | Convert input image to Photoshop PSD format
11
11
  [**convert_to_png**](ConvertApi.md#convert_to_png) | **POST** /image/convert/to/png | Convert input image to PNG format
12
12
  [**convert_to_tiff**](ConvertApi.md#convert_to_tiff) | **POST** /image/convert/to/tiff | Convert input image to TIFF format
@@ -117,14 +117,14 @@ Name | Type | Description | Notes
117
117
  ### HTTP request headers
118
118
 
119
119
  - **Content-Type**: multipart/form-data
120
- - **Accept**: image/gif
120
+ - **Accept**: application/octet-stream
121
121
 
122
122
 
123
123
 
124
124
  # **convert_to_jpg**
125
125
  > String convert_to_jpg(quality, image_file)
126
126
 
127
- Convert input image to JPG/JPEG format
127
+ Convert input image to JPG, JPEG format
128
128
 
129
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
130
 
@@ -148,7 +148,7 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform the op
148
148
 
149
149
 
150
150
  begin
151
- #Convert input image to JPG/JPEG format
151
+ #Convert input image to JPG, JPEG format
152
152
  result = api_instance.convert_to_jpg(quality, image_file)
153
153
  p result
154
154
  rescue CloudmersiveImageRecognitionApiClient::ApiError => e
@@ -174,7 +174,7 @@ Name | Type | Description | Notes
174
174
  ### HTTP request headers
175
175
 
176
176
  - **Content-Type**: multipart/form-data
177
- - **Accept**: image/jpg
177
+ - **Accept**: application/octet-stream
178
178
 
179
179
 
180
180
 
@@ -282,7 +282,7 @@ Name | Type | Description | Notes
282
282
  ### HTTP request headers
283
283
 
284
284
  - **Content-Type**: multipart/form-data
285
- - **Accept**: image/png
285
+ - **Accept**: application/octet-stream
286
286
 
287
287
 
288
288
 
data/docs/EditApi.md CHANGED
@@ -126,7 +126,7 @@ Name | Type | Description | Notes
126
126
  ### HTTP request headers
127
127
 
128
128
  - **Content-Type**: multipart/form-data
129
- - **Accept**: image/png
129
+ - **Accept**: application/octet-stream
130
130
 
131
131
 
132
132
 
@@ -183,7 +183,7 @@ Name | Type | Description | Notes
183
183
  ### HTTP request headers
184
184
 
185
185
  - **Content-Type**: multipart/form-data
186
- - **Accept**: image/png
186
+ - **Accept**: application/octet-stream
187
187
 
188
188
 
189
189
 
@@ -274,7 +274,7 @@ end
274
274
 
275
275
  api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
276
276
 
277
- request = CloudmersiveImageRecognitionApiClient::DrawPolygonRequest.new # DrawPolygonRequest |
277
+ request = CloudmersiveImageRecognitionApiClient::DrawPolygonRequest.new # DrawPolygonRequest | Polygon drawing request parameters
278
278
 
279
279
 
280
280
  begin
@@ -290,7 +290,7 @@ end
290
290
 
291
291
  Name | Type | Description | Notes
292
292
  ------------- | ------------- | ------------- | -------------
293
- **request** | [**DrawPolygonRequest**](DrawPolygonRequest.md)| |
293
+ **request** | [**DrawPolygonRequest**](DrawPolygonRequest.md)| Polygon drawing request parameters |
294
294
 
295
295
  ### Return type
296
296
 
@@ -303,7 +303,7 @@ Name | Type | Description | Notes
303
303
  ### HTTP request headers
304
304
 
305
305
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
306
- - **Accept**: image/png
306
+ - **Accept**: application/octet-stream
307
307
 
308
308
 
309
309
 
@@ -328,7 +328,7 @@ end
328
328
 
329
329
  api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
330
330
 
331
- request = CloudmersiveImageRecognitionApiClient::DrawRectangleRequest.new # DrawRectangleRequest |
331
+ request = CloudmersiveImageRecognitionApiClient::DrawRectangleRequest.new # DrawRectangleRequest | Draw rectangle parameters
332
332
 
333
333
 
334
334
  begin
@@ -344,7 +344,7 @@ end
344
344
 
345
345
  Name | Type | Description | Notes
346
346
  ------------- | ------------- | ------------- | -------------
347
- **request** | [**DrawRectangleRequest**](DrawRectangleRequest.md)| |
347
+ **request** | [**DrawRectangleRequest**](DrawRectangleRequest.md)| Draw rectangle parameters |
348
348
 
349
349
  ### Return type
350
350
 
@@ -357,7 +357,7 @@ Name | Type | Description | Notes
357
357
  ### HTTP request headers
358
358
 
359
359
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
360
- - **Accept**: image/png
360
+ - **Accept**: application/octet-stream
361
361
 
362
362
 
363
363
 
@@ -382,7 +382,7 @@ end
382
382
 
383
383
  api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
384
384
 
385
- request = CloudmersiveImageRecognitionApiClient::DrawTextRequest.new # DrawTextRequest |
385
+ request = CloudmersiveImageRecognitionApiClient::DrawTextRequest.new # DrawTextRequest | Draw text parameters
386
386
 
387
387
 
388
388
  begin
@@ -398,7 +398,7 @@ end
398
398
 
399
399
  Name | Type | Description | Notes
400
400
  ------------- | ------------- | ------------- | -------------
401
- **request** | [**DrawTextRequest**](DrawTextRequest.md)| |
401
+ **request** | [**DrawTextRequest**](DrawTextRequest.md)| Draw text parameters |
402
402
 
403
403
  ### Return type
404
404
 
@@ -411,7 +411,7 @@ Name | Type | Description | Notes
411
411
  ### HTTP request headers
412
412
 
413
413
  - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
414
- - **Accept**: image/png
414
+ - **Accept**: application/octet-stream
415
415
 
416
416
 
417
417
 
@@ -436,9 +436,9 @@ end
436
436
 
437
437
  api_instance = CloudmersiveImageRecognitionApiClient::EditApi.new
438
438
 
439
- x = 56 # Integer |
439
+ x = 56 # Integer | Horizontal (X) offset of the drop shadow
440
440
 
441
- y = 56 # Integer |
441
+ y = 56 # Integer | Vertical (Y) offset of the drop shadow
442
442
 
443
443
  sigma = 56 # Integer | Sigma (blur distance) of the drop shadow
444
444
 
@@ -460,8 +460,8 @@ end
460
460
 
461
461
  Name | Type | Description | Notes
462
462
  ------------- | ------------- | ------------- | -------------
463
- **x** | **Integer**| |
464
- **y** | **Integer**| |
463
+ **x** | **Integer**| Horizontal (X) offset of the drop shadow |
464
+ **y** | **Integer**| Vertical (Y) offset of the drop shadow |
465
465
  **sigma** | **Integer**| Sigma (blur distance) of the drop shadow |
466
466
  **opacity** | **Integer**| Opacity of the drop shadow; 0 is 0% and 100 is 100% |
467
467
  **image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
data/docs/FaceApi.md CHANGED
@@ -5,12 +5,12 @@ All URIs are relative to *https://api.cloudmersive.com*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**face_compare**](FaceApi.md#face_compare) | **POST** /image/face/compare-and-match | Compare and match faces
8
- [**face_crop_first**](FaceApi.md#face_crop_first) | **POST** /image/face/crop/first | Crop image to face (square)
9
- [**face_crop_first_round**](FaceApi.md#face_crop_first_round) | **POST** /image/face/crop/first/round | Crop image to face (round)
8
+ [**face_crop_first**](FaceApi.md#face_crop_first) | **POST** /image/face/crop/first | Crop image to face with square crop
9
+ [**face_crop_first_round**](FaceApi.md#face_crop_first_round) | **POST** /image/face/crop/first/round | Crop image to face with round crop
10
10
  [**face_detect_age**](FaceApi.md#face_detect_age) | **POST** /image/face/detect-age | Detect the age of people in an image
11
11
  [**face_detect_gender**](FaceApi.md#face_detect_gender) | **POST** /image/face/detect-gender | Detect the gender of people in an image
12
- [**face_locate**](FaceApi.md#face_locate) | **POST** /image/face/locate | Find faces in an image
13
- [**face_locate_with_landmarks**](FaceApi.md#face_locate_with_landmarks) | **POST** /image/face/locate-with-landmarks | Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image
12
+ [**face_locate**](FaceApi.md#face_locate) | **POST** /image/face/locate | Detect and find faces in an image
13
+ [**face_locate_with_landmarks**](FaceApi.md#face_locate_with_landmarks) | **POST** /image/face/locate-with-landmarks | Detect and find faces and landmarks eyes and nose and mouth in image
14
14
 
15
15
 
16
16
  # **face_compare**
@@ -73,7 +73,7 @@ Name | Type | Description | Notes
73
73
  # **face_crop_first**
74
74
  > String face_crop_first(image_file)
75
75
 
76
- Crop image to face (square)
76
+ Crop image to face with square crop
77
77
 
78
78
  Crop an image to the face (rectangular crop). If there is more than one face present, choose the first one.
79
79
 
@@ -95,7 +95,7 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform the op
95
95
 
96
96
 
97
97
  begin
98
- #Crop image to face (square)
98
+ #Crop image to face with square crop
99
99
  result = api_instance.face_crop_first(image_file)
100
100
  p result
101
101
  rescue CloudmersiveImageRecognitionApiClient::ApiError => e
@@ -127,7 +127,7 @@ Name | Type | Description | Notes
127
127
  # **face_crop_first_round**
128
128
  > String face_crop_first_round(image_file)
129
129
 
130
- Crop image to face (round)
130
+ Crop image to face with round crop
131
131
 
132
132
  Crop an image to the face (circular/round crop). If there is more than one face present, choose the first one.
133
133
 
@@ -149,7 +149,7 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform the op
149
149
 
150
150
 
151
151
  begin
152
- #Crop image to face (round)
152
+ #Crop image to face with round crop
153
153
  result = api_instance.face_crop_first_round(image_file)
154
154
  p result
155
155
  rescue CloudmersiveImageRecognitionApiClient::ApiError => e
@@ -289,7 +289,7 @@ Name | Type | Description | Notes
289
289
  # **face_locate**
290
290
  > FaceLocateResponse face_locate(image_file)
291
291
 
292
- Find faces in an image
292
+ Detect and find faces in an image
293
293
 
294
294
  Locate the positions of all faces in an image
295
295
 
@@ -311,7 +311,7 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform the op
311
311
 
312
312
 
313
313
  begin
314
- #Find faces in an image
314
+ #Detect and find faces in an image
315
315
  result = api_instance.face_locate(image_file)
316
316
  p result
317
317
  rescue CloudmersiveImageRecognitionApiClient::ApiError => e
@@ -343,7 +343,7 @@ Name | Type | Description | Notes
343
343
  # **face_locate_with_landmarks**
344
344
  > FaceLocateWithLandmarksResponse face_locate_with_landmarks(image_file)
345
345
 
346
- Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image
346
+ Detect and find faces and landmarks eyes and nose and mouth in image
347
347
 
348
348
  Locate the positions of all faces in an image, along with the eyes, eye brows, nose and mouth components of each
349
349
 
@@ -365,7 +365,7 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform the op
365
365
 
366
366
 
367
367
  begin
368
- #Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image
368
+ #Detect and find faces and landmarks eyes and nose and mouth in image
369
369
  result = api_instance.face_locate_with_landmarks(image_file)
370
370
  p result
371
371
  rescue CloudmersiveImageRecognitionApiClient::ApiError => e
data/docs/FaceLocateResponse.md CHANGED
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **error_details** | **String** | | [optional]
7
6
  **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
8
7
  **faces** | [**Array<Face>**](Face.md) | Array of faces found in the image | [optional]
9
8
  **face_count** | **Integer** | Number of faces found in the image | [optional]
9
+ **error_details** | **String** | Details of any errors that occurred | [optional]
10
10
 
11
11
 
data/docs/FilterApi.md CHANGED
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**filter_black_and_white**](FilterApi.md#filter_black_and_white) | **POST** /image/filter/black-and-white | Convert image to black-and-white grayscale
8
- [**filter_despeckle**](FilterApi.md#filter_despeckle) | **POST** /image/filter/despeckle | Despeckle (remove point noise) from the image
8
+ [**filter_despeckle**](FilterApi.md#filter_despeckle) | **POST** /image/filter/despeckle | Despeckle to remove point noise from the image
9
9
  [**filter_edge_detect**](FilterApi.md#filter_edge_detect) | **POST** /image/filter/edge-detect/{radius} | Detect and highlight edges in an image
10
10
  [**filter_emboss**](FilterApi.md#filter_emboss) | **POST** /image/filter/emboss/{radius}/{sigma} | Emboss an image
11
11
  [**filter_gaussian_blur**](FilterApi.md#filter_gaussian_blur) | **POST** /image/filter/blur/guassian/{radius}/{sigma} | Perform a guassian blur on the input image
@@ -71,7 +71,7 @@ Name | Type | Description | Notes
71
71
  # **filter_despeckle**
72
72
  > String filter_despeckle(image_file)
73
73
 
74
- Despeckle (remove point noise) from the image
74
+ Despeckle to remove point noise from the image
75
75
 
76
76
  Remove point noise / despeckle the input image
77
77
 
@@ -93,7 +93,7 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform the op
93
93
 
94
94
 
95
95
  begin
96
- #Despeckle (remove point noise) from the image
96
+ #Despeckle to remove point noise from the image
97
97
  result = api_instance.filter_despeckle(image_file)
98
98
  p result
99
99
  rescue CloudmersiveImageRecognitionApiClient::ApiError => e
data/docs/ImageMetadata.md CHANGED
@@ -4,10 +4,12 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **is_valid_image** | **BOOLEAN** | True if the input image is a valid image file, false otherwise | [optional]
7
8
  **file_format** | **String** | File format of the image | [optional]
8
9
  **width** | **Integer** | Width of the image in pixels | [optional]
9
10
  **height** | **Integer** | Height of the image in pixels | [optional]
10
11
  **bit_depth** | **Integer** | Bits per pixel | [optional]
12
+ **has_transparency** | **BOOLEAN** | True if the image has transaprency in the form of an alpha channel, false otherwise | [optional]
11
13
  **color_space** | **String** | Color space of the image | [optional]
12
14
  **exif_profile_name** | **String** | Name of the EXIF profile used | [optional]
13
15
  **exif_values** | [**Array<ImageMetadataExifValue>**](ImageMetadataExifValue.md) | EXIF tags and values embedded in the image | [optional]
data/docs/InfoApi.md CHANGED
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**info_get_dominant_color**](InfoApi.md#info_get_dominant_color) | **POST** /image/get-info/dominant-color | Returns the dominant colors of the image
8
- [**info_get_metadata**](InfoApi.md#info_get_metadata) | **POST** /image/get-info/metadata | Returns the image metadata, including EXIF and resolution
8
+ [**info_get_metadata**](InfoApi.md#info_get_metadata) | **POST** /image/get-info/metadata | Returns the image metadata including EXIF and resolution
9
9
 
10
10
 
11
11
  # **info_get_dominant_color**
@@ -65,7 +65,7 @@ Name | Type | Description | Notes
65
65
  # **info_get_metadata**
66
66
  > ImageMetadata info_get_metadata(image_file)
67
67
 
68
- Returns the image metadata, including EXIF and resolution
68
+ Returns the image metadata including EXIF and resolution
69
69
 
70
70
  Returns the metadata information on the image, including file type, EXIF (if available), and resolution.
71
71
 
@@ -87,7 +87,7 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform the op
87
87
 
88
88
 
89
89
  begin
90
- #Returns the image metadata, including EXIF and resolution
90
+ #Returns the image metadata including EXIF and resolution
91
91
  result = api_instance.info_get_metadata(image_file)
92
92
  p result
93
93
  rescue CloudmersiveImageRecognitionApiClient::ApiError => e
data/docs/NsfwApi.md CHANGED
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.cloudmersive.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**nsfw_classify**](NsfwApi.md#nsfw_classify) | **POST** /image/nsfw/classify | Not safe for work (NSFW) racy content classification
7
+ [**nsfw_classify**](NsfwApi.md#nsfw_classify) | **POST** /image/nsfw/classify | Not safe for work NSFW racy content classification
8
8
 
9
9
 
10
10
  # **nsfw_classify**
11
11
  > NsfwResult nsfw_classify(image_file)
12
12
 
13
- Not safe for work (NSFW) racy content classification
13
+ Not safe for work NSFW racy content classification
14
14
 
15
15
  Classify an image into Not Safe For Work (NSFW)/Porn/Racy content and Safe Content.
16
16
 
@@ -32,7 +32,7 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform the op
32
32
 
33
33
 
34
34
  begin
35
- #Not safe for work (NSFW) racy content classification
35
+ #Not safe for work NSFW racy content classification
36
36
  result = api_instance.nsfw_classify(image_file)
37
37
  p result
38
38
  rescue CloudmersiveImageRecognitionApiClient::ApiError => e
data/docs/RecognizeApi.md CHANGED
@@ -6,8 +6,8 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**recognize_describe**](RecognizeApi.md#recognize_describe) | **POST** /image/recognize/describe | Describe an image in natural language
8
8
  [**recognize_detect_and_unskew_document**](RecognizeApi.md#recognize_detect_and_unskew_document) | **POST** /image/recognize/detect-document/unskew | Detect and unskew a photo of a document
9
- [**recognize_detect_objects**](RecognizeApi.md#recognize_detect_objects) | **POST** /image/recognize/detect-objects | Detect objects, including types and locations, in an image
10
- [**recognize_detect_people**](RecognizeApi.md#recognize_detect_people) | **POST** /image/recognize/detect-people | Detect people, including locations, in an image
9
+ [**recognize_detect_objects**](RecognizeApi.md#recognize_detect_objects) | **POST** /image/recognize/detect-objects | Detect objects including types and locations in an image
10
+ [**recognize_detect_people**](RecognizeApi.md#recognize_detect_people) | **POST** /image/recognize/detect-people | Detect people including locations in an image
11
11
  [**recognize_detect_text_fine**](RecognizeApi.md#recognize_detect_text_fine) | **POST** /image/recognize/detect-text/fine | Detect fine text in a photo of a document
12
12
  [**recognize_detect_text_large**](RecognizeApi.md#recognize_detect_text_large) | **POST** /image/recognize/detect-text/large | Detect large text in a photo
13
13
  [**recognize_detect_vehicle_license_plates**](RecognizeApi.md#recognize_detect_vehicle_license_plates) | **POST** /image/recognize/detect-vehicle-license-plates | Detect vehicle license plates in an image
@@ -129,7 +129,7 @@ Name | Type | Description | Notes
129
129
  # **recognize_detect_objects**
130
130
  > ObjectDetectionResult recognize_detect_objects(image_file)
131
131
 
132
- Detect objects, including types and locations, in an image
132
+ Detect objects including types and locations in an image
133
133
 
134
134
  Identify the position, size and description of objects in an image, along with a recognition confidence level. Detects both human people and objects in an image.
135
135
 
@@ -151,7 +151,7 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform the op
151
151
 
152
152
 
153
153
  begin
154
- #Detect objects, including types and locations, in an image
154
+ #Detect objects including types and locations in an image
155
155
  result = api_instance.recognize_detect_objects(image_file)
156
156
  p result
157
157
  rescue CloudmersiveImageRecognitionApiClient::ApiError => e
@@ -183,7 +183,7 @@ Name | Type | Description | Notes
183
183
  # **recognize_detect_people**
184
184
  > ObjectDetectionResult recognize_detect_people(image_file)
185
185
 
186
- Detect people, including locations, in an image
186
+ Detect people including locations in an image
187
187
 
188
188
  Identify the position, and size of human people in an image, along with a recognition confidence level. People in the image do NOT need to be facing the camera; they can be facing away, edge-on, etc.
189
189
 
@@ -205,7 +205,7 @@ image_file = File.new("/path/to/file.txt") # File | Image file to perform the op
205
205
 
206
206
 
207
207
  begin
208
- #Detect people, including locations, in an image
208
+ #Detect people including locations in an image
209
209
  result = api_instance.recognize_detect_people(image_file)
210
210
  p result
211
211
  rescue CloudmersiveImageRecognitionApiClient::ApiError => e