cloudmersive-image-recognition-api-client 1.3.7 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (108) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +24 -5
  3. data/cloudmersive-image-recognition-api-client.gemspec +1 -1
  4. data/docs/ColorResult.md +10 -0
  5. data/docs/DetectedLicensePlate.md +4 -4
  6. data/docs/DominantColorResult.md +9 -0
  7. data/docs/EditApi.md +134 -0
  8. data/docs/FaceApi.md +55 -0
  9. data/docs/FaceCompareResponse.md +1 -1
  10. data/docs/FaceLocateWithLandmarksResponse.md +1 -1
  11. data/docs/FaceWithLandmarks.md +9 -9
  12. data/docs/FilterApi.md +475 -0
  13. data/docs/FindSymbolResult.md +12 -0
  14. data/docs/GenderDetectionResult.md +10 -0
  15. data/docs/InfoApi.md +63 -0
  16. data/docs/PersonWithAge.md +1 -0
  17. data/docs/PersonWithGender.md +10 -0
  18. data/docs/RecognizeApi.md +68 -4
  19. data/docs/ResizeApi.md +64 -3
  20. data/lib/cloudmersive-image-recognition-api-client.rb +8 -1
  21. data/lib/cloudmersive-image-recognition-api-client/api/artistic_api.rb +1 -1
  22. data/lib/cloudmersive-image-recognition-api-client/api/edit_api.rb +161 -1
  23. data/lib/cloudmersive-image-recognition-api-client/api/face_api.rb +57 -1
  24. data/lib/cloudmersive-image-recognition-api-client/api/filter_api.rb +524 -0
  25. data/lib/cloudmersive-image-recognition-api-client/api/info_api.rb +79 -0
  26. data/lib/cloudmersive-image-recognition-api-client/api/nsfw_api.rb +1 -1
  27. data/lib/cloudmersive-image-recognition-api-client/api/recognize_api.rb +76 -4
  28. data/lib/cloudmersive-image-recognition-api-client/api/resize_api.rb +71 -3
  29. data/lib/cloudmersive-image-recognition-api-client/api_client.rb +1 -1
  30. data/lib/cloudmersive-image-recognition-api-client/api_error.rb +1 -1
  31. data/lib/cloudmersive-image-recognition-api-client/configuration.rb +1 -1
  32. data/lib/cloudmersive-image-recognition-api-client/models/age_detection_result.rb +1 -1
  33. data/lib/cloudmersive-image-recognition-api-client/models/color_result.rb +209 -0
  34. data/lib/cloudmersive-image-recognition-api-client/models/detected_license_plate.rb +26 -22
  35. data/lib/cloudmersive-image-recognition-api-client/models/detected_object.rb +1 -1
  36. data/lib/cloudmersive-image-recognition-api-client/models/dominant_color_result.rb +201 -0
  37. data/lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb +1 -1
  38. data/lib/cloudmersive-image-recognition-api-client/models/draw_polygon_request.rb +1 -1
  39. data/lib/cloudmersive-image-recognition-api-client/models/draw_rectangle_instance.rb +1 -1
  40. data/lib/cloudmersive-image-recognition-api-client/models/draw_rectangle_request.rb +1 -1
  41. data/lib/cloudmersive-image-recognition-api-client/models/draw_text_instance.rb +1 -1
  42. data/lib/cloudmersive-image-recognition-api-client/models/draw_text_request.rb +1 -1
  43. data/lib/cloudmersive-image-recognition-api-client/models/face.rb +1 -1
  44. data/lib/cloudmersive-image-recognition-api-client/models/face_compare_response.rb +15 -14
  45. data/lib/cloudmersive-image-recognition-api-client/models/face_locate_response.rb +1 -1
  46. data/lib/cloudmersive-image-recognition-api-client/models/face_locate_with_landmarks_response.rb +15 -14
  47. data/lib/cloudmersive-image-recognition-api-client/models/face_match.rb +1 -1
  48. data/lib/cloudmersive-image-recognition-api-client/models/face_point.rb +1 -1
  49. data/lib/cloudmersive-image-recognition-api-client/models/face_with_landmarks.rb +54 -45
  50. data/lib/cloudmersive-image-recognition-api-client/models/find_symbol_result.rb +229 -0
  51. data/lib/cloudmersive-image-recognition-api-client/models/fine_text_detection_result.rb +1 -1
  52. data/lib/cloudmersive-image-recognition-api-client/models/fine_text_item.rb +1 -1
  53. data/lib/cloudmersive-image-recognition-api-client/models/gender_detection_result.rb +211 -0
  54. data/lib/cloudmersive-image-recognition-api-client/models/image_description_response.rb +1 -1
  55. data/lib/cloudmersive-image-recognition-api-client/models/nsfw_result.rb +1 -1
  56. data/lib/cloudmersive-image-recognition-api-client/models/object_detection_result.rb +1 -1
  57. data/lib/cloudmersive-image-recognition-api-client/models/person_with_age.rb +14 -5
  58. data/lib/cloudmersive-image-recognition-api-client/models/person_with_gender.rb +209 -0
  59. data/lib/cloudmersive-image-recognition-api-client/models/polygon_point.rb +1 -1
  60. data/lib/cloudmersive-image-recognition-api-client/models/recognition_outcome.rb +1 -1
  61. data/lib/cloudmersive-image-recognition-api-client/models/text_detection_result.rb +1 -1
  62. data/lib/cloudmersive-image-recognition-api-client/models/text_item.rb +1 -1
  63. data/lib/cloudmersive-image-recognition-api-client/models/vehicle_license_plate_detection_result.rb +1 -1
  64. data/lib/cloudmersive-image-recognition-api-client/version.rb +2 -2
  65. data/spec/api/artistic_api_spec.rb +1 -1
  66. data/spec/api/edit_api_spec.rb +33 -1
  67. data/spec/api/face_api_spec.rb +13 -1
  68. data/spec/api/filter_api_spec.rb +140 -0
  69. data/spec/api/info_api_spec.rb +47 -0
  70. data/spec/api/nsfw_api_spec.rb +1 -1
  71. data/spec/api/recognize_api_spec.rb +15 -1
  72. data/spec/api/resize_api_spec.rb +16 -2
  73. data/spec/api_client_spec.rb +1 -1
  74. data/spec/configuration_spec.rb +1 -1
  75. data/spec/models/age_detection_result_spec.rb +1 -1
  76. data/spec/models/color_result_spec.rb +54 -0
  77. data/spec/models/detected_license_plate_spec.rb +7 -7
  78. data/spec/models/detected_object_spec.rb +1 -1
  79. data/spec/models/dominant_color_result_spec.rb +48 -0
  80. data/spec/models/draw_polygon_instance_spec.rb +1 -1
  81. data/spec/models/draw_polygon_request_spec.rb +1 -1
  82. data/spec/models/draw_rectangle_instance_spec.rb +1 -1
  83. data/spec/models/draw_rectangle_request_spec.rb +1 -1
  84. data/spec/models/draw_text_instance_spec.rb +1 -1
  85. data/spec/models/draw_text_request_spec.rb +1 -1
  86. data/spec/models/face_compare_response_spec.rb +5 -5
  87. data/spec/models/face_locate_response_spec.rb +1 -1
  88. data/spec/models/face_locate_with_landmarks_response_spec.rb +5 -5
  89. data/spec/models/face_match_spec.rb +1 -1
  90. data/spec/models/face_point_spec.rb +1 -1
  91. data/spec/models/face_spec.rb +1 -1
  92. data/spec/models/face_with_landmarks_spec.rb +14 -14
  93. data/spec/models/find_symbol_result_spec.rb +66 -0
  94. data/spec/models/fine_text_detection_result_spec.rb +1 -1
  95. data/spec/models/fine_text_item_spec.rb +1 -1
  96. data/spec/models/gender_detection_result_spec.rb +54 -0
  97. data/spec/models/image_description_response_spec.rb +1 -1
  98. data/spec/models/nsfw_result_spec.rb +1 -1
  99. data/spec/models/object_detection_result_spec.rb +1 -1
  100. data/spec/models/person_with_age_spec.rb +7 -1
  101. data/spec/models/person_with_gender_spec.rb +54 -0
  102. data/spec/models/polygon_point_spec.rb +1 -1
  103. data/spec/models/recognition_outcome_spec.rb +1 -1
  104. data/spec/models/text_detection_result_spec.rb +1 -1
  105. data/spec/models/text_item_spec.rb +1 -1
  106. data/spec/models/vehicle_license_plate_detection_result_spec.rb +1 -1
  107. data/spec/spec_helper.rb +1 -1
  108. metadata +36 -16
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5cfd12fff010b4cc8d51955603aab29cf9fcbb203fe38bc1a6181f4269dc8342
4
- data.tar.gz: 137246e5d6cdfbe43262a6fc3aedf94c38dcf2531ff7fd3546da31aaa0632860
3
+ metadata.gz: 8c4a448a04b6792e8e4bd63f01cf36fa6afd4a18876cd81acb7cf7cee792050b
4
+ data.tar.gz: d543a4b32059e81977403bf8fb56329c7b666a64e9aa7c6259db7f53ce5b8850
5
5
  SHA512:
6
- metadata.gz: a025f66ba32766c4b34a38c141915ccaabe9639190a07413350c30ab4545759efd07c2d8f2699bf1bab2d5086971d34306b48d0926b460aa11cc30335ba7111c
7
- data.tar.gz: a419e831cdb736bb55cb520c735da1e82595b514347130459613975f7e13a65aa5d18385981d41e8c3c8d1a802cabce8ebeba3ec6f5793bab2d26efcd641726d
6
+ metadata.gz: 293f61c50c9ed46e755c962ad13a58debfe33278b896abeacf045735b94cdf93441626620ee32a25b6ebd06b795500416c7396c5ade7dff1eff800869e72ae04
7
+ data.tar.gz: 3f320581935ce3452fafbabbd1630c6337c29a78fc434114ee6a526166723edbd9d187b622e1f07fd393a8b1aa8b01f692eea9ecf26e581e8a564be654249708
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.3.7
10
+ - Package version: 1.4.0
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.3.7.gem
26
+ gem install ./cloudmersive-image-recognition-api-client-1.4.0.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-image-recognition-api-client-1.3.7.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-image-recognition-api-client-1.4.0.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.3.7'
34
+ gem 'cloudmersive-image-recognition-api-client', '~> 1.4.0'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -89,16 +89,28 @@ Class | Method | HTTP request | Description
89
89
  *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_auto_orient**](docs/EditApi.md#edit_auto_orient) | **POST** /image/edit/auto-orient/remove-exif | Normalizes image rotation and removes EXIF rotation data
90
90
  *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_composite_basic**](docs/EditApi.md#edit_composite_basic) | **POST** /image/edit/composite/{location} | Composite two images together
91
91
  *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_contrast_adaptive**](docs/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
92
+ *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_crop_rectangle**](docs/EditApi.md#edit_crop_rectangle) | **POST** /image/edit/crop/rectangle/{left}/{top}/{width}/{height} | Crop an image to a rectangular area
92
93
  *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_draw_polygon**](docs/EditApi.md#edit_draw_polygon) | **POST** /image/edit/draw/polygon | Draw a polygon onto an image
93
94
  *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_draw_rectangle**](docs/EditApi.md#edit_draw_rectangle) | **POST** /image/edit/draw/rectangle | Draw a rectangle onto an image
94
95
  *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_draw_text**](docs/EditApi.md#edit_draw_text) | **POST** /image/edit/draw/text | Draw text onto an image
96
+ *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_drop_shadow**](docs/EditApi.md#edit_drop_shadow) | **POST** /image/edit/drop-shadow/{x}/{y}/{sigma}/{opacity} | Add a customizeable drop shadow to an image
95
97
  *CloudmersiveImageRecognitionApiClient::EditApi* | [**edit_rotate**](docs/EditApi.md#edit_rotate) | **POST** /image/edit/rotate/{degrees}/angle | Rotate an image any number of degrees
96
98
  *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_compare**](docs/FaceApi.md#face_compare) | **POST** /image/face/compare-and-match | Compare and match faces
97
99
  *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_crop_first**](docs/FaceApi.md#face_crop_first) | **POST** /image/face/crop/first | Crop image to face (square)
98
100
  *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_crop_first_round**](docs/FaceApi.md#face_crop_first_round) | **POST** /image/face/crop/first/round | Crop image to face (round)
99
101
  *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_detect_age**](docs/FaceApi.md#face_detect_age) | **POST** /image/face/detect-age | Detect the age of people in an image
102
+ *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_detect_gender**](docs/FaceApi.md#face_detect_gender) | **POST** /image/face/detect-gender | Detect the gender of people in an image
100
103
  *CloudmersiveImageRecognitionApiClient::FaceApi* | [**face_locate**](docs/FaceApi.md#face_locate) | **POST** /image/face/locate | Find faces in an image
101
104
  *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
105
+ *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
106
+ *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_despeckle**](docs/FilterApi.md#filter_despeckle) | **POST** /image/filter/despeckle | Despeckle (remove point noise) from the image
107
+ *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_edge_detect**](docs/FilterApi.md#filter_edge_detect) | **POST** /image/filter/edge-detect/{radius} | Detect and highlight edges in an image
108
+ *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_emboss**](docs/FilterApi.md#filter_emboss) | **POST** /image/filter/emboss/{radius}/{sigma} | Emboss an image
109
+ *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
110
+ *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_motion_blur**](docs/FilterApi.md#filter_motion_blur) | **POST** /image/filter/blur/motion/{radius}/{sigma}/{angle} | Perform a motion blur on the input image
111
+ *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_posterize**](docs/FilterApi.md#filter_posterize) | **POST** /image/filter/posterize | Posterize the image by reducing distinct colors
112
+ *CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_swirl**](docs/FilterApi.md#filter_swirl) | **POST** /image/filter/swirl | Swirl distort the image
113
+ *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
102
114
  *CloudmersiveImageRecognitionApiClient::NsfwApi* | [**nsfw_classify**](docs/NsfwApi.md#nsfw_classify) | **POST** /image/nsfw/classify | Not safe for work (NSFW) racy content classification
103
115
  *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_describe**](docs/RecognizeApi.md#recognize_describe) | **POST** /image/recognize/describe | Describe an image in natural language
104
116
  *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
@@ -107,14 +119,18 @@ Class | Method | HTTP request | Description
107
119
  *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
108
120
  *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
109
121
  *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
110
- *CloudmersiveImageRecognitionApiClient::ResizeApi* | [**resize_post**](docs/ResizeApi.md#resize_post) | **POST** /image/resize/preserveAspectRatio/{maxWidth}/{maxHeight} | Resize an image with parameters
122
+ *CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_find_symbol**](docs/RecognizeApi.md#recognize_find_symbol) | **POST** /image/recognize/find/symbol | Find the location of a symbol in an image
123
+ *CloudmersiveImageRecognitionApiClient::ResizeApi* | [**resize_post**](docs/ResizeApi.md#resize_post) | **POST** /image/resize/preserveAspectRatio/{maxWidth}/{maxHeight} | Resize an image while preserving aspect ratio
124
+ *CloudmersiveImageRecognitionApiClient::ResizeApi* | [**resize_resize_simple**](docs/ResizeApi.md#resize_resize_simple) | **POST** /image/resize/target/{width}/{height} | Resize an image
111
125
 
112
126
 
113
127
  ## Documentation for Models
114
128
 
115
129
  - [CloudmersiveImageRecognitionApiClient::AgeDetectionResult](docs/AgeDetectionResult.md)
130
+ - [CloudmersiveImageRecognitionApiClient::ColorResult](docs/ColorResult.md)
116
131
  - [CloudmersiveImageRecognitionApiClient::DetectedLicensePlate](docs/DetectedLicensePlate.md)
117
132
  - [CloudmersiveImageRecognitionApiClient::DetectedObject](docs/DetectedObject.md)
133
+ - [CloudmersiveImageRecognitionApiClient::DominantColorResult](docs/DominantColorResult.md)
118
134
  - [CloudmersiveImageRecognitionApiClient::DrawPolygonInstance](docs/DrawPolygonInstance.md)
119
135
  - [CloudmersiveImageRecognitionApiClient::DrawPolygonRequest](docs/DrawPolygonRequest.md)
120
136
  - [CloudmersiveImageRecognitionApiClient::DrawRectangleInstance](docs/DrawRectangleInstance.md)
@@ -128,12 +144,15 @@ Class | Method | HTTP request | Description
128
144
  - [CloudmersiveImageRecognitionApiClient::FaceMatch](docs/FaceMatch.md)
129
145
  - [CloudmersiveImageRecognitionApiClient::FacePoint](docs/FacePoint.md)
130
146
  - [CloudmersiveImageRecognitionApiClient::FaceWithLandmarks](docs/FaceWithLandmarks.md)
147
+ - [CloudmersiveImageRecognitionApiClient::FindSymbolResult](docs/FindSymbolResult.md)
131
148
  - [CloudmersiveImageRecognitionApiClient::FineTextDetectionResult](docs/FineTextDetectionResult.md)
132
149
  - [CloudmersiveImageRecognitionApiClient::FineTextItem](docs/FineTextItem.md)
150
+ - [CloudmersiveImageRecognitionApiClient::GenderDetectionResult](docs/GenderDetectionResult.md)
133
151
  - [CloudmersiveImageRecognitionApiClient::ImageDescriptionResponse](docs/ImageDescriptionResponse.md)
134
152
  - [CloudmersiveImageRecognitionApiClient::NsfwResult](docs/NsfwResult.md)
135
153
  - [CloudmersiveImageRecognitionApiClient::ObjectDetectionResult](docs/ObjectDetectionResult.md)
136
154
  - [CloudmersiveImageRecognitionApiClient::PersonWithAge](docs/PersonWithAge.md)
155
+ - [CloudmersiveImageRecognitionApiClient::PersonWithGender](docs/PersonWithGender.md)
137
156
  - [CloudmersiveImageRecognitionApiClient::PolygonPoint](docs/PolygonPoint.md)
138
157
  - [CloudmersiveImageRecognitionApiClient::RecognitionOutcome](docs/RecognitionOutcome.md)
139
158
  - [CloudmersiveImageRecognitionApiClient::TextDetectionResult](docs/TextDetectionResult.md)
@@ -8,7 +8,7 @@
8
8
  OpenAPI spec version: v1
9
9
 
10
10
  Generated by: https://github.com/swagger-api/swagger-codegen.git
11
- Swagger Codegen version: unset
11
+ Swagger Codegen version: 2.3.1
12
12
 
13
13
  =end
14
14
 
@@ -0,0 +1,10 @@
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
+
@@ -3,12 +3,12 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **location_x** | **Integer** | | [optional]
7
- **location_y** | **Integer** | | [optional]
8
- **width** | **Integer** | | [optional]
9
- **height** | **Integer** | | [optional]
10
6
  **license_plate_text_best_match** | **String** | Text from the license plate, highest-confidence result | [optional]
11
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
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
13
 
14
14
 
@@ -0,0 +1,9 @@
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/EditApi.md CHANGED
@@ -7,9 +7,11 @@ Method | HTTP request | Description
7
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
8
  [**edit_composite_basic**](EditApi.md#edit_composite_basic) | **POST** /image/edit/composite/{location} | Composite two images together
9
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
10
11
  [**edit_draw_polygon**](EditApi.md#edit_draw_polygon) | **POST** /image/edit/draw/polygon | Draw a polygon onto an image
11
12
  [**edit_draw_rectangle**](EditApi.md#edit_draw_rectangle) | **POST** /image/edit/draw/rectangle | Draw a rectangle onto an image
12
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
13
15
  [**edit_rotate**](EditApi.md#edit_rotate) | **POST** /image/edit/rotate/{degrees}/angle | Rotate an image any number of degrees
14
16
 
15
17
 
@@ -184,6 +186,72 @@ Name | Type | Description | Notes
184
186
 
185
187
 
186
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
+
187
255
  # **edit_draw_polygon**
188
256
  > String edit_draw_polygon(request)
189
257
 
@@ -346,6 +414,72 @@ Name | Type | Description | Notes
346
414
 
347
415
 
348
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 | Horizontal (X) offset of the drop shadow
439
+
440
+ y = 56 # Integer | Vertical (Y) offset of the drop shadow
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**| Horizontal (X) offset of the drop shadow |
463
+ **y** | **Integer**| Vertical (Y) offset of the drop shadow |
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
+
349
483
  # **edit_rotate**
350
484
  > String edit_rotate(degrees, image_file)
351
485
 
data/docs/FaceApi.md CHANGED
@@ -8,6 +8,7 @@ Method | HTTP request | Description
8
8
  [**face_crop_first**](FaceApi.md#face_crop_first) | **POST** /image/face/crop/first | Crop image to face (square)
9
9
  [**face_crop_first_round**](FaceApi.md#face_crop_first_round) | **POST** /image/face/crop/first/round | Crop image to face (round)
10
10
  [**face_detect_age**](FaceApi.md#face_detect_age) | **POST** /image/face/detect-age | Detect the age of people in an image
11
+ [**face_detect_gender**](FaceApi.md#face_detect_gender) | **POST** /image/face/detect-gender | Detect the gender of people in an image
11
12
  [**face_locate**](FaceApi.md#face_locate) | **POST** /image/face/locate | Find faces in an image
12
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
13
14
 
@@ -231,6 +232,60 @@ Name | Type | Description | Notes
231
232
 
232
233
 
233
234
 
235
+ # **face_detect_gender**
236
+ > GenderDetectionResult face_detect_gender(image_file)
237
+
238
+ Detect the gender of people in an image
239
+
240
+ Identify the gender, position, and size of human faces in an image, along with a recognition confidence level. People in the image should be facing the camera.
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::FaceApi.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
+ #Detect the gender of people in an image
261
+ result = api_instance.face_detect_gender(image_file)
262
+ p result
263
+ rescue CloudmersiveImageRecognitionApiClient::ApiError => e
264
+ puts "Exception when calling FaceApi->face_detect_gender: #{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
+ [**GenderDetectionResult**](GenderDetectionResult.md)
277
+
278
+ ### Authorization
279
+
280
+ [Apikey](../README.md#Apikey)
281
+
282
+ ### HTTP request headers
283
+
284
+ - **Content-Type**: multipart/form-data
285
+ - **Accept**: application/json, text/json, application/xml, text/xml
286
+
287
+
288
+
234
289
  # **face_locate**
235
290
  > FaceLocateResponse face_locate(image_file)
236
291
 
@@ -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<FaceMatch>**](FaceMatch.md) | Array of faces found in the input 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
 
@@ -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<FaceWithLandmarks>**](FaceWithLandmarks.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
 
@@ -3,18 +3,18 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **left_eyebrow** | [**Array<FacePoint>**](FacePoint.md) | | [optional]
7
- **right_eyebrow** | [**Array<FacePoint>**](FacePoint.md) | | [optional]
8
- **left_eye** | [**Array<FacePoint>**](FacePoint.md) | | [optional]
9
- **right_eye** | [**Array<FacePoint>**](FacePoint.md) | | [optional]
10
- **bottom_and_sides_of_face** | [**Array<FacePoint>**](FacePoint.md) | | [optional]
11
- **nose_bridge** | [**Array<FacePoint>**](FacePoint.md) | | [optional]
12
- **nose_bottom** | [**Array<FacePoint>**](FacePoint.md) | | [optional]
13
- **lips_inner_outline** | [**Array<FacePoint>**](FacePoint.md) | | [optional]
14
- **lips_outer_outline** | [**Array<FacePoint>**](FacePoint.md) | | [optional]
15
6
  **left_x** | **Integer** | X coordinate of the left side of the face | [optional]
16
7
  **top_y** | **Integer** | Y coordinate of the top side of the face | [optional]
17
8
  **right_x** | **Integer** | X coordinate of the right side of the face | [optional]
18
9
  **bottom_y** | **Integer** | Y coordinate of the bottom side of the face | [optional]
10
+ **left_eyebrow** | [**Array<FacePoint>**](FacePoint.md) | Point locations of the left eyebrow (the eyebrow cloesest to the left side of the picture) | [optional]
11
+ **right_eyebrow** | [**Array<FacePoint>**](FacePoint.md) | Point locations of the right eyebrow (the eyebrow cloesest to the right side of the picture) | [optional]
12
+ **left_eye** | [**Array<FacePoint>**](FacePoint.md) | Point locations of the left eye (the eye closest to the left side of the picture) | [optional]
13
+ **right_eye** | [**Array<FacePoint>**](FacePoint.md) | Point locations of the right eye (the eye closest to the right side of the picture) | [optional]
14
+ **bottom_and_sides_of_face** | [**Array<FacePoint>**](FacePoint.md) | Point locations of the bottom and sides of the face (cheeks and chin) | [optional]
15
+ **nose_bridge** | [**Array<FacePoint>**](FacePoint.md) | Point locations of the nose bridge (the vertical portion of the nose) | [optional]
16
+ **nose_bottom** | [**Array<FacePoint>**](FacePoint.md) | Point locations of the bottom (nostrils) of the nose | [optional]
17
+ **lips_inner_outline** | [**Array<FacePoint>**](FacePoint.md) | Point locations of the inner outline of the lips | [optional]
18
+ **lips_outer_outline** | [**Array<FacePoint>**](FacePoint.md) | Point locations of the outer outline of the lips | [optional]
19
19
 
20
20
 
data/docs/FilterApi.md ADDED
@@ -0,0 +1,475 @@
1
+ # CloudmersiveImageRecognitionApiClient::FilterApi
2
+
3
+ All URIs are relative to *https://api.cloudmersive.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
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
9
+ [**filter_edge_detect**](FilterApi.md#filter_edge_detect) | **POST** /image/filter/edge-detect/{radius} | Detect and highlight edges in an image
10
+ [**filter_emboss**](FilterApi.md#filter_emboss) | **POST** /image/filter/emboss/{radius}/{sigma} | Emboss an image
11
+ [**filter_gaussian_blur**](FilterApi.md#filter_gaussian_blur) | **POST** /image/filter/blur/guassian/{radius}/{sigma} | Perform a guassian blur on the input image
12
+ [**filter_motion_blur**](FilterApi.md#filter_motion_blur) | **POST** /image/filter/blur/motion/{radius}/{sigma}/{angle} | Perform a motion blur on the input image
13
+ [**filter_posterize**](FilterApi.md#filter_posterize) | **POST** /image/filter/posterize | Posterize the image by reducing distinct colors
14
+ [**filter_swirl**](FilterApi.md#filter_swirl) | **POST** /image/filter/swirl | Swirl distort the image
15
+
16
+
17
+ # **filter_black_and_white**
18
+ > String filter_black_and_white(image_file)
19
+
20
+ Convert image to black-and-white grayscale
21
+
22
+ Remove color from the image by converting to a grayscale, black-and-white image
23
+
24
+ ### Example
25
+ ```ruby
26
+ # load the gem
27
+ require 'cloudmersive-image-recognition-api-client'
28
+ # setup authorization
29
+ CloudmersiveImageRecognitionApiClient.configure do |config|
30
+ # Configure API key authorization: Apikey
31
+ config.api_key['Apikey'] = 'YOUR API KEY'
32
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
33
+ #config.api_key_prefix['Apikey'] = 'Bearer'
34
+ end
35
+
36
+ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
37
+
38
+ 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.
39
+
40
+
41
+ begin
42
+ #Convert image to black-and-white grayscale
43
+ result = api_instance.filter_black_and_white(image_file)
44
+ p result
45
+ rescue CloudmersiveImageRecognitionApiClient::ApiError => e
46
+ puts "Exception when calling FilterApi->filter_black_and_white: #{e}"
47
+ end
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+ Name | Type | Description | Notes
53
+ ------------- | ------------- | ------------- | -------------
54
+ **image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
55
+
56
+ ### Return type
57
+
58
+ **String**
59
+
60
+ ### Authorization
61
+
62
+ [Apikey](../README.md#Apikey)
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: multipart/form-data
67
+ - **Accept**: application/octet-stream
68
+
69
+
70
+
71
+ # **filter_despeckle**
72
+ > String filter_despeckle(image_file)
73
+
74
+ Despeckle (remove point noise) from the image
75
+
76
+ Remove point noise / despeckle the input image
77
+
78
+ ### Example
79
+ ```ruby
80
+ # load the gem
81
+ require 'cloudmersive-image-recognition-api-client'
82
+ # setup authorization
83
+ CloudmersiveImageRecognitionApiClient.configure do |config|
84
+ # Configure API key authorization: Apikey
85
+ config.api_key['Apikey'] = 'YOUR API KEY'
86
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
87
+ #config.api_key_prefix['Apikey'] = 'Bearer'
88
+ end
89
+
90
+ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
91
+
92
+ 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.
93
+
94
+
95
+ begin
96
+ #Despeckle (remove point noise) from the image
97
+ result = api_instance.filter_despeckle(image_file)
98
+ p result
99
+ rescue CloudmersiveImageRecognitionApiClient::ApiError => e
100
+ puts "Exception when calling FilterApi->filter_despeckle: #{e}"
101
+ end
102
+ ```
103
+
104
+ ### Parameters
105
+
106
+ Name | Type | Description | Notes
107
+ ------------- | ------------- | ------------- | -------------
108
+ **image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
109
+
110
+ ### Return type
111
+
112
+ **String**
113
+
114
+ ### Authorization
115
+
116
+ [Apikey](../README.md#Apikey)
117
+
118
+ ### HTTP request headers
119
+
120
+ - **Content-Type**: multipart/form-data
121
+ - **Accept**: application/octet-stream
122
+
123
+
124
+
125
+ # **filter_edge_detect**
126
+ > String filter_edge_detect(radius, image_file)
127
+
128
+ Detect and highlight edges in an image
129
+
130
+ Perform an edge detection operation on the input image
131
+
132
+ ### Example
133
+ ```ruby
134
+ # load the gem
135
+ require 'cloudmersive-image-recognition-api-client'
136
+ # setup authorization
137
+ CloudmersiveImageRecognitionApiClient.configure do |config|
138
+ # Configure API key authorization: Apikey
139
+ config.api_key['Apikey'] = 'YOUR API KEY'
140
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
141
+ #config.api_key_prefix['Apikey'] = 'Bearer'
142
+ end
143
+
144
+ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
145
+
146
+ radius = 56 # Integer | Radius in pixels of the edge detection operation; a larger radius will produce a greater effect
147
+
148
+ 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.
149
+
150
+
151
+ begin
152
+ #Detect and highlight edges in an image
153
+ result = api_instance.filter_edge_detect(radius, image_file)
154
+ p result
155
+ rescue CloudmersiveImageRecognitionApiClient::ApiError => e
156
+ puts "Exception when calling FilterApi->filter_edge_detect: #{e}"
157
+ end
158
+ ```
159
+
160
+ ### Parameters
161
+
162
+ Name | Type | Description | Notes
163
+ ------------- | ------------- | ------------- | -------------
164
+ **radius** | **Integer**| Radius in pixels of the edge detection operation; a larger radius will produce a greater effect |
165
+ **image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
166
+
167
+ ### Return type
168
+
169
+ **String**
170
+
171
+ ### Authorization
172
+
173
+ [Apikey](../README.md#Apikey)
174
+
175
+ ### HTTP request headers
176
+
177
+ - **Content-Type**: multipart/form-data
178
+ - **Accept**: application/octet-stream
179
+
180
+
181
+
182
+ # **filter_emboss**
183
+ > String filter_emboss(radius, sigma, image_file)
184
+
185
+ Emboss an image
186
+
187
+ Perform an emboss operation on the input image
188
+
189
+ ### Example
190
+ ```ruby
191
+ # load the gem
192
+ require 'cloudmersive-image-recognition-api-client'
193
+ # setup authorization
194
+ CloudmersiveImageRecognitionApiClient.configure do |config|
195
+ # Configure API key authorization: Apikey
196
+ config.api_key['Apikey'] = 'YOUR API KEY'
197
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
198
+ #config.api_key_prefix['Apikey'] = 'Bearer'
199
+ end
200
+
201
+ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
202
+
203
+ radius = 56 # Integer | Radius in pixels of the emboss operation; a larger radius will produce a greater effect
204
+
205
+ sigma = 56 # Integer | Sigma, or variance, of the emboss operation
206
+
207
+ 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.
208
+
209
+
210
+ begin
211
+ #Emboss an image
212
+ result = api_instance.filter_emboss(radius, sigma, image_file)
213
+ p result
214
+ rescue CloudmersiveImageRecognitionApiClient::ApiError => e
215
+ puts "Exception when calling FilterApi->filter_emboss: #{e}"
216
+ end
217
+ ```
218
+
219
+ ### Parameters
220
+
221
+ Name | Type | Description | Notes
222
+ ------------- | ------------- | ------------- | -------------
223
+ **radius** | **Integer**| Radius in pixels of the emboss operation; a larger radius will produce a greater effect |
224
+ **sigma** | **Integer**| Sigma, or variance, of the emboss operation |
225
+ **image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
226
+
227
+ ### Return type
228
+
229
+ **String**
230
+
231
+ ### Authorization
232
+
233
+ [Apikey](../README.md#Apikey)
234
+
235
+ ### HTTP request headers
236
+
237
+ - **Content-Type**: multipart/form-data
238
+ - **Accept**: application/octet-stream
239
+
240
+
241
+
242
+ # **filter_gaussian_blur**
243
+ > String filter_gaussian_blur(radius, sigma, image_file)
244
+
245
+ Perform a guassian blur on the input image
246
+
247
+ Perform a gaussian blur on the input image
248
+
249
+ ### Example
250
+ ```ruby
251
+ # load the gem
252
+ require 'cloudmersive-image-recognition-api-client'
253
+ # setup authorization
254
+ CloudmersiveImageRecognitionApiClient.configure do |config|
255
+ # Configure API key authorization: Apikey
256
+ config.api_key['Apikey'] = 'YOUR API KEY'
257
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
258
+ #config.api_key_prefix['Apikey'] = 'Bearer'
259
+ end
260
+
261
+ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
262
+
263
+ radius = 56 # Integer | Radius in pixels of the blur operation; a larger radius will produce a greater blur effect
264
+
265
+ sigma = 56 # Integer | Sigma, or variance, of the gaussian blur operation
266
+
267
+ 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.
268
+
269
+
270
+ begin
271
+ #Perform a guassian blur on the input image
272
+ result = api_instance.filter_gaussian_blur(radius, sigma, image_file)
273
+ p result
274
+ rescue CloudmersiveImageRecognitionApiClient::ApiError => e
275
+ puts "Exception when calling FilterApi->filter_gaussian_blur: #{e}"
276
+ end
277
+ ```
278
+
279
+ ### Parameters
280
+
281
+ Name | Type | Description | Notes
282
+ ------------- | ------------- | ------------- | -------------
283
+ **radius** | **Integer**| Radius in pixels of the blur operation; a larger radius will produce a greater blur effect |
284
+ **sigma** | **Integer**| Sigma, or variance, of the gaussian blur operation |
285
+ **image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
286
+
287
+ ### Return type
288
+
289
+ **String**
290
+
291
+ ### Authorization
292
+
293
+ [Apikey](../README.md#Apikey)
294
+
295
+ ### HTTP request headers
296
+
297
+ - **Content-Type**: multipart/form-data
298
+ - **Accept**: application/octet-stream
299
+
300
+
301
+
302
+ # **filter_motion_blur**
303
+ > String filter_motion_blur(radius, sigma, angle, image_file)
304
+
305
+ Perform a motion blur on the input image
306
+
307
+ Perform a motion blur on the input image at a specific angle
308
+
309
+ ### Example
310
+ ```ruby
311
+ # load the gem
312
+ require 'cloudmersive-image-recognition-api-client'
313
+ # setup authorization
314
+ CloudmersiveImageRecognitionApiClient.configure do |config|
315
+ # Configure API key authorization: Apikey
316
+ config.api_key['Apikey'] = 'YOUR API KEY'
317
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
318
+ #config.api_key_prefix['Apikey'] = 'Bearer'
319
+ end
320
+
321
+ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
322
+
323
+ radius = 56 # Integer | Radius in pixels of the blur operation; a larger radius will produce a greater blur effect
324
+
325
+ sigma = 56 # Integer | Sigma, or variance, of the motion blur operation
326
+
327
+ angle = 56 # Integer | Angle of the motion blur in degrees
328
+
329
+ 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.
330
+
331
+
332
+ begin
333
+ #Perform a motion blur on the input image
334
+ result = api_instance.filter_motion_blur(radius, sigma, angle, image_file)
335
+ p result
336
+ rescue CloudmersiveImageRecognitionApiClient::ApiError => e
337
+ puts "Exception when calling FilterApi->filter_motion_blur: #{e}"
338
+ end
339
+ ```
340
+
341
+ ### Parameters
342
+
343
+ Name | Type | Description | Notes
344
+ ------------- | ------------- | ------------- | -------------
345
+ **radius** | **Integer**| Radius in pixels of the blur operation; a larger radius will produce a greater blur effect |
346
+ **sigma** | **Integer**| Sigma, or variance, of the motion blur operation |
347
+ **angle** | **Integer**| Angle of the motion blur in degrees |
348
+ **image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
349
+
350
+ ### Return type
351
+
352
+ **String**
353
+
354
+ ### Authorization
355
+
356
+ [Apikey](../README.md#Apikey)
357
+
358
+ ### HTTP request headers
359
+
360
+ - **Content-Type**: multipart/form-data
361
+ - **Accept**: application/octet-stream
362
+
363
+
364
+
365
+ # **filter_posterize**
366
+ > Object filter_posterize(levels)
367
+
368
+ Posterize the image by reducing distinct colors
369
+
370
+ Reduce the unique number of colors in the image to the specified level
371
+
372
+ ### Example
373
+ ```ruby
374
+ # load the gem
375
+ require 'cloudmersive-image-recognition-api-client'
376
+ # setup authorization
377
+ CloudmersiveImageRecognitionApiClient.configure do |config|
378
+ # Configure API key authorization: Apikey
379
+ config.api_key['Apikey'] = 'YOUR API KEY'
380
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
381
+ #config.api_key_prefix['Apikey'] = 'Bearer'
382
+ end
383
+
384
+ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
385
+
386
+ levels = 56 # Integer | Number of unique colors to retain in the output image
387
+
388
+
389
+ begin
390
+ #Posterize the image by reducing distinct colors
391
+ result = api_instance.filter_posterize(levels)
392
+ p result
393
+ rescue CloudmersiveImageRecognitionApiClient::ApiError => e
394
+ puts "Exception when calling FilterApi->filter_posterize: #{e}"
395
+ end
396
+ ```
397
+
398
+ ### Parameters
399
+
400
+ Name | Type | Description | Notes
401
+ ------------- | ------------- | ------------- | -------------
402
+ **levels** | **Integer**| Number of unique colors to retain in the output image |
403
+
404
+ ### Return type
405
+
406
+ **Object**
407
+
408
+ ### Authorization
409
+
410
+ [Apikey](../README.md#Apikey)
411
+
412
+ ### HTTP request headers
413
+
414
+ - **Content-Type**: Not defined
415
+ - **Accept**: application/octet-stream
416
+
417
+
418
+
419
+ # **filter_swirl**
420
+ > String filter_swirl(degrees, image_file)
421
+
422
+ Swirl distort the image
423
+
424
+ Swirl distort the image by the specified number of degrees
425
+
426
+ ### Example
427
+ ```ruby
428
+ # load the gem
429
+ require 'cloudmersive-image-recognition-api-client'
430
+ # setup authorization
431
+ CloudmersiveImageRecognitionApiClient.configure do |config|
432
+ # Configure API key authorization: Apikey
433
+ config.api_key['Apikey'] = 'YOUR API KEY'
434
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
435
+ #config.api_key_prefix['Apikey'] = 'Bearer'
436
+ end
437
+
438
+ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
439
+
440
+ degrees = 56 # Integer | Degrees of swirl
441
+
442
+ 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.
443
+
444
+
445
+ begin
446
+ #Swirl distort the image
447
+ result = api_instance.filter_swirl(degrees, image_file)
448
+ p result
449
+ rescue CloudmersiveImageRecognitionApiClient::ApiError => e
450
+ puts "Exception when calling FilterApi->filter_swirl: #{e}"
451
+ end
452
+ ```
453
+
454
+ ### Parameters
455
+
456
+ Name | Type | Description | Notes
457
+ ------------- | ------------- | ------------- | -------------
458
+ **degrees** | **Integer**| Degrees of swirl |
459
+ **image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
460
+
461
+ ### Return type
462
+
463
+ **String**
464
+
465
+ ### Authorization
466
+
467
+ [Apikey](../README.md#Apikey)
468
+
469
+ ### HTTP request headers
470
+
471
+ - **Content-Type**: multipart/form-data
472
+ - **Accept**: application/octet-stream
473
+
474
+
475
+