cloudmersive-image-recognition-api-client 1.4.3 → 2.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +19 -16
- data/cloudmersive-image-recognition-api-client.gemspec +3 -3
- data/docs/ArtisticApi.md +2 -2
- data/docs/ConvertApi.md +13 -13
- data/docs/DrawTextInstance.md +1 -1
- data/docs/EditApi.md +188 -23
- data/docs/FaceApi.md +20 -20
- data/docs/FaceLocateResponse.md +1 -1
- data/docs/FilterApi.md +11 -11
- data/docs/ImageMetadata.md +2 -0
- data/docs/InfoApi.md +5 -5
- data/docs/NsfwApi.md +4 -4
- data/docs/RecognizeApi.md +17 -17
- data/docs/ResizeApi.md +10 -10
- data/lib/cloudmersive-image-recognition-api-client.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/api/artistic_api.rb +6 -7
- data/lib/cloudmersive-image-recognition-api-client/api/convert_api.rb +35 -42
- data/lib/cloudmersive-image-recognition-api-client/api/edit_api.rb +215 -59
- data/lib/cloudmersive-image-recognition-api-client/api/face_api.rb +39 -46
- data/lib/cloudmersive-image-recognition-api-client/api/filter_api.rb +36 -44
- data/lib/cloudmersive-image-recognition-api-client/api/info_api.rb +12 -14
- data/lib/cloudmersive-image-recognition-api-client/api/nsfw_api.rb +8 -9
- data/lib/cloudmersive-image-recognition-api-client/api/recognize_api.rb +41 -49
- data/lib/cloudmersive-image-recognition-api-client/api/resize_api.rb +20 -22
- data/lib/cloudmersive-image-recognition-api-client/api_client.rb +11 -9
- data/lib/cloudmersive-image-recognition-api-client/api_error.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/configuration.rb +2 -2
- data/lib/cloudmersive-image-recognition-api-client/models/age_detection_result.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/color_result.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/detected_license_plate.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/detected_object.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/dominant_color_result.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/draw_polygon_request.rb +9 -13
- data/lib/cloudmersive-image-recognition-api-client/models/draw_rectangle_instance.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/draw_rectangle_request.rb +9 -13
- data/lib/cloudmersive-image-recognition-api-client/models/draw_text_instance.rb +8 -11
- data/lib/cloudmersive-image-recognition-api-client/models/draw_text_request.rb +9 -13
- data/lib/cloudmersive-image-recognition-api-client/models/face.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/face_compare_response.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/face_locate_response.rb +19 -21
- data/lib/cloudmersive-image-recognition-api-client/models/face_locate_with_landmarks_response.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/face_match.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/face_point.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/face_with_landmarks.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/find_symbol_result.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/fine_text_detection_result.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/fine_text_item.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/gender_detection_result.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/image_description_response.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/image_metadata.rb +28 -11
- data/lib/cloudmersive-image-recognition-api-client/models/image_metadata_exif_value.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/nsfw_result.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/object_detection_result.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/person_with_age.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/person_with_gender.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/polygon_point.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/recognition_outcome.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/text_detection_result.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/text_item.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/models/vehicle_license_plate_detection_result.rb +7 -10
- data/lib/cloudmersive-image-recognition-api-client/version.rb +2 -2
- data/spec/api/artistic_api_spec.rb +2 -2
- data/spec/api/convert_api_spec.rb +9 -9
- data/spec/api/edit_api_spec.rb +51 -15
- data/spec/api/face_api_spec.rb +12 -12
- data/spec/api/filter_api_spec.rb +10 -10
- data/spec/api/info_api_spec.rb +4 -4
- data/spec/api/nsfw_api_spec.rb +3 -3
- data/spec/api/recognize_api_spec.rb +12 -12
- data/spec/api/resize_api_spec.rb +7 -7
- data/spec/api_client_spec.rb +52 -35
- data/spec/configuration_spec.rb +9 -9
- data/spec/models/age_detection_result_spec.rb +4 -5
- data/spec/models/color_result_spec.rb +4 -5
- data/spec/models/detected_license_plate_spec.rb +8 -9
- data/spec/models/detected_object_spec.rb +7 -8
- data/spec/models/dominant_color_result_spec.rb +3 -4
- data/spec/models/draw_polygon_instance_spec.rb +5 -6
- data/spec/models/draw_polygon_request_spec.rb +4 -5
- data/spec/models/draw_rectangle_instance_spec.rb +8 -9
- data/spec/models/draw_rectangle_request_spec.rb +4 -5
- data/spec/models/draw_text_instance_spec.rb +9 -10
- data/spec/models/draw_text_request_spec.rb +4 -5
- data/spec/models/face_compare_response_spec.rb +5 -6
- data/spec/models/face_locate_response_spec.rb +9 -10
- data/spec/models/face_locate_with_landmarks_response_spec.rb +5 -6
- data/spec/models/face_match_spec.rb +7 -8
- data/spec/models/face_point_spec.rb +3 -4
- data/spec/models/face_spec.rb +5 -6
- data/spec/models/face_with_landmarks_spec.rb +14 -15
- data/spec/models/find_symbol_result_spec.rb +7 -8
- data/spec/models/fine_text_detection_result_spec.rb +4 -5
- data/spec/models/fine_text_item_spec.rb +12 -13
- data/spec/models/gender_detection_result_spec.rb +4 -5
- data/spec/models/image_description_response_spec.rb +5 -6
- data/spec/models/image_metadata_exif_value_spec.rb +4 -5
- data/spec/models/image_metadata_spec.rb +21 -10
- data/spec/models/nsfw_result_spec.rb +4 -5
- data/spec/models/object_detection_result_spec.rb +4 -5
- data/spec/models/person_with_age_spec.rb +5 -6
- data/spec/models/person_with_gender_spec.rb +4 -5
- data/spec/models/polygon_point_spec.rb +3 -4
- data/spec/models/recognition_outcome_spec.rb +3 -4
- data/spec/models/text_detection_result_spec.rb +4 -5
- data/spec/models/text_item_spec.rb +5 -6
- data/spec/models/vehicle_license_plate_detection_result_spec.rb +4 -5
- data/spec/spec_helper.rb +1 -1
- metadata +2 -2
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
|
9
|
-
[**face_crop_first_round**](FaceApi.md#face_crop_first_round) | **POST** /image/face/crop/first/round | Crop image to face
|
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 |
|
13
|
-
[**face_locate_with_landmarks**](FaceApi.md#face_locate_with_landmarks) | **POST** /image/face/locate-with-landmarks |
|
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**
|
@@ -34,9 +34,9 @@ end
|
|
34
34
|
|
35
35
|
api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.new
|
36
36
|
|
37
|
-
input_image = File.new(
|
37
|
+
input_image = File.new('/path/to/file.txt') # File | Image file to perform the operation on; this image can contain one or more faces which will be matched against face provided in the second image. Common file formats such as PNG, JPEG are supported.
|
38
38
|
|
39
|
-
match_face = File.new(
|
39
|
+
match_face = File.new('/path/to/file.txt') # File | Image of a single face to compare and match against.
|
40
40
|
|
41
41
|
|
42
42
|
begin
|
@@ -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
|
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
|
|
@@ -91,11 +91,11 @@ end
|
|
91
91
|
|
92
92
|
api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.new
|
93
93
|
|
94
|
-
image_file = File.new(
|
94
|
+
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.
|
95
95
|
|
96
96
|
|
97
97
|
begin
|
98
|
-
#Crop image to face
|
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
|
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
|
|
@@ -145,11 +145,11 @@ end
|
|
145
145
|
|
146
146
|
api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.new
|
147
147
|
|
148
|
-
image_file = File.new(
|
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
149
|
|
150
150
|
|
151
151
|
begin
|
152
|
-
#Crop image to face
|
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
|
@@ -199,7 +199,7 @@ end
|
|
199
199
|
|
200
200
|
api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.new
|
201
201
|
|
202
|
-
image_file = File.new(
|
202
|
+
image_file = File.new('/path/to/file.txt') # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
203
203
|
|
204
204
|
|
205
205
|
begin
|
@@ -253,7 +253,7 @@ end
|
|
253
253
|
|
254
254
|
api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.new
|
255
255
|
|
256
|
-
image_file = File.new(
|
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
257
|
|
258
258
|
|
259
259
|
begin
|
@@ -289,7 +289,7 @@ Name | Type | Description | Notes
|
|
289
289
|
# **face_locate**
|
290
290
|
> FaceLocateResponse face_locate(image_file)
|
291
291
|
|
292
|
-
|
292
|
+
Detect and find faces in an image
|
293
293
|
|
294
294
|
Locate the positions of all faces in an image
|
295
295
|
|
@@ -307,11 +307,11 @@ end
|
|
307
307
|
|
308
308
|
api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.new
|
309
309
|
|
310
|
-
image_file = File.new(
|
310
|
+
image_file = File.new('/path/to/file.txt') # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
311
311
|
|
312
312
|
|
313
313
|
begin
|
314
|
-
#
|
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
|
-
|
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
|
|
@@ -361,11 +361,11 @@ end
|
|
361
361
|
|
362
362
|
api_instance = CloudmersiveImageRecognitionApiClient::FaceApi.new
|
363
363
|
|
364
|
-
image_file = File.new(
|
364
|
+
image_file = File.new('/path/to/file.txt') # File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
|
365
365
|
|
366
366
|
|
367
367
|
begin
|
368
|
-
#
|
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
|
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
|
@@ -35,7 +35,7 @@ end
|
|
35
35
|
|
36
36
|
api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
|
37
37
|
|
38
|
-
image_file = File.new(
|
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
39
|
|
40
40
|
|
41
41
|
begin
|
@@ -71,7 +71,7 @@ Name | Type | Description | Notes
|
|
71
71
|
# **filter_despeckle**
|
72
72
|
> String filter_despeckle(image_file)
|
73
73
|
|
74
|
-
Despeckle
|
74
|
+
Despeckle to remove point noise from the image
|
75
75
|
|
76
76
|
Remove point noise / despeckle the input image
|
77
77
|
|
@@ -89,11 +89,11 @@ end
|
|
89
89
|
|
90
90
|
api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
|
91
91
|
|
92
|
-
image_file = File.new(
|
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
93
|
|
94
94
|
|
95
95
|
begin
|
96
|
-
#Despeckle
|
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
|
@@ -145,7 +145,7 @@ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
|
|
145
145
|
|
146
146
|
radius = 56 # Integer | Radius in pixels of the edge detection operation; a larger radius will produce a greater effect
|
147
147
|
|
148
|
-
image_file = File.new(
|
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
149
|
|
150
150
|
|
151
151
|
begin
|
@@ -204,7 +204,7 @@ radius = 56 # Integer | Radius in pixels of the emboss operation; a larger radiu
|
|
204
204
|
|
205
205
|
sigma = 56 # Integer | Sigma, or variance, of the emboss operation
|
206
206
|
|
207
|
-
image_file = File.new(
|
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
208
|
|
209
209
|
|
210
210
|
begin
|
@@ -264,7 +264,7 @@ radius = 56 # Integer | Radius in pixels of the blur operation; a larger radius
|
|
264
264
|
|
265
265
|
sigma = 56 # Integer | Sigma, or variance, of the gaussian blur operation
|
266
266
|
|
267
|
-
image_file = File.new(
|
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
268
|
|
269
269
|
|
270
270
|
begin
|
@@ -326,7 +326,7 @@ sigma = 56 # Integer | Sigma, or variance, of the motion blur operation
|
|
326
326
|
|
327
327
|
angle = 56 # Integer | Angle of the motion blur in degrees
|
328
328
|
|
329
|
-
image_file = File.new(
|
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
330
|
|
331
331
|
|
332
332
|
begin
|
@@ -385,7 +385,7 @@ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
|
|
385
385
|
|
386
386
|
levels = 56 # Integer | Number of unique colors to retain in the output image
|
387
387
|
|
388
|
-
image_file = File.new(
|
388
|
+
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.
|
389
389
|
|
390
390
|
|
391
391
|
begin
|
@@ -442,7 +442,7 @@ api_instance = CloudmersiveImageRecognitionApiClient::FilterApi.new
|
|
442
442
|
|
443
443
|
degrees = 56 # Integer | Degrees of swirl
|
444
444
|
|
445
|
-
image_file = File.new(
|
445
|
+
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.
|
446
446
|
|
447
447
|
|
448
448
|
begin
|
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
|
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**
|
@@ -29,7 +29,7 @@ end
|
|
29
29
|
|
30
30
|
api_instance = CloudmersiveImageRecognitionApiClient::InfoApi.new
|
31
31
|
|
32
|
-
image_file = File.new(
|
32
|
+
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.
|
33
33
|
|
34
34
|
|
35
35
|
begin
|
@@ -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
|
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
|
|
@@ -83,11 +83,11 @@ end
|
|
83
83
|
|
84
84
|
api_instance = CloudmersiveImageRecognitionApiClient::InfoApi.new
|
85
85
|
|
86
|
-
image_file = File.new(
|
86
|
+
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.
|
87
87
|
|
88
88
|
|
89
89
|
begin
|
90
|
-
#Returns the image metadata
|
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
|
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
|
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
|
|
@@ -28,11 +28,11 @@ end
|
|
28
28
|
|
29
29
|
api_instance = CloudmersiveImageRecognitionApiClient::NsfwApi.new
|
30
30
|
|
31
|
-
image_file = File.new(
|
31
|
+
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.
|
32
32
|
|
33
33
|
|
34
34
|
begin
|
35
|
-
#Not safe for work
|
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
|
10
|
-
[**recognize_detect_people**](RecognizeApi.md#recognize_detect_people) | **POST** /image/recognize/detect-people | Detect people
|
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
|
@@ -35,7 +35,7 @@ end
|
|
35
35
|
|
36
36
|
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
37
37
|
|
38
|
-
image_file = File.new(
|
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
39
|
|
40
40
|
|
41
41
|
begin
|
@@ -89,10 +89,10 @@ end
|
|
89
89
|
|
90
90
|
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
91
91
|
|
92
|
-
image_file = File.new(
|
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
93
|
|
94
94
|
opts = {
|
95
|
-
post_processing_effect:
|
95
|
+
post_processing_effect: 'post_processing_effect_example' # String | Optional, post-processing effects to apply to the email, default is None. Possible values are None and BlackAndWhite (force the image into a black and white view to aid in OCR operations).
|
96
96
|
}
|
97
97
|
|
98
98
|
begin
|
@@ -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
|
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
|
|
@@ -147,11 +147,11 @@ end
|
|
147
147
|
|
148
148
|
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
149
149
|
|
150
|
-
image_file = File.new(
|
150
|
+
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.
|
151
151
|
|
152
152
|
|
153
153
|
begin
|
154
|
-
#Detect objects
|
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
|
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
|
|
@@ -201,11 +201,11 @@ end
|
|
201
201
|
|
202
202
|
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
203
203
|
|
204
|
-
image_file = File.new(
|
204
|
+
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.
|
205
205
|
|
206
206
|
|
207
207
|
begin
|
208
|
-
#Detect people
|
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
|
@@ -255,7 +255,7 @@ end
|
|
255
255
|
|
256
256
|
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
257
257
|
|
258
|
-
image_file = File.new(
|
258
|
+
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.
|
259
259
|
|
260
260
|
|
261
261
|
begin
|
@@ -309,7 +309,7 @@ end
|
|
309
309
|
|
310
310
|
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
311
311
|
|
312
|
-
image_file = File.new(
|
312
|
+
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.
|
313
313
|
|
314
314
|
|
315
315
|
begin
|
@@ -347,7 +347,7 @@ Name | Type | Description | Notes
|
|
347
347
|
|
348
348
|
Detect vehicle license plates in an image
|
349
349
|
|
350
|
-
Identify the position, and size, and content of vehicle license plates in an image. License plates should be within 15-20 degrees on-axis to the camera.
|
350
|
+
Identify the position, and size, and content of vehicle license plates in an image. License plates should be within 15-20 degrees on-axis to the camera. Supported image formats are JPG, PNG and BMP.
|
351
351
|
|
352
352
|
### Example
|
353
353
|
```ruby
|
@@ -363,7 +363,7 @@ end
|
|
363
363
|
|
364
364
|
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
365
365
|
|
366
|
-
image_file = File.new(
|
366
|
+
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.
|
367
367
|
|
368
368
|
|
369
369
|
begin
|
@@ -417,9 +417,9 @@ end
|
|
417
417
|
|
418
418
|
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
419
419
|
|
420
|
-
input_image = File.new(
|
420
|
+
input_image = File.new('/path/to/file.txt') # File | Image file to search through for the target image.
|
421
421
|
|
422
|
-
target_image = File.new(
|
422
|
+
target_image = File.new('/path/to/file.txt') # File | Image to find in the input image.
|
423
423
|
|
424
424
|
|
425
425
|
begin
|
data/docs/ResizeApi.md
CHANGED
@@ -13,7 +13,7 @@ Method | HTTP request | Description
|
|
13
13
|
|
14
14
|
Resize an image while preserving aspect ratio
|
15
15
|
|
16
|
-
Resize an image to a maximum width and maximum height, while preserving the image's original aspect ratio
|
16
|
+
Resize an image to a maximum width and maximum height, while preserving the image's original aspect ratio. Resize is EXIF-aware.
|
17
17
|
|
18
18
|
### Example
|
19
19
|
```ruby
|
@@ -33,7 +33,7 @@ max_width = 56 # Integer | Maximum width of the output image - final image will
|
|
33
33
|
|
34
34
|
max_height = 56 # Integer | Maximum height of the output image - final image will be as large as possible while less than or equial to this height
|
35
35
|
|
36
|
-
image_file = File.new(
|
36
|
+
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.
|
37
37
|
|
38
38
|
|
39
39
|
begin
|
@@ -64,7 +64,7 @@ Name | Type | Description | Notes
|
|
64
64
|
### HTTP request headers
|
65
65
|
|
66
66
|
- **Content-Type**: multipart/form-data
|
67
|
-
- **Accept**:
|
67
|
+
- **Accept**: application/octet-stream
|
68
68
|
|
69
69
|
|
70
70
|
|
@@ -73,7 +73,7 @@ Name | Type | Description | Notes
|
|
73
73
|
|
74
74
|
Resize an image
|
75
75
|
|
76
|
-
Resize an image to a specific width and specific height
|
76
|
+
Resize an image to a specific width and specific height. Resize is EXIF-aware.
|
77
77
|
|
78
78
|
### Example
|
79
79
|
```ruby
|
@@ -89,11 +89,11 @@ end
|
|
89
89
|
|
90
90
|
api_instance = CloudmersiveImageRecognitionApiClient::ResizeApi.new
|
91
91
|
|
92
|
-
width = 56 # Integer |
|
92
|
+
width = 56 # Integer | Width of the output image - final image will be exactly this width
|
93
93
|
|
94
|
-
height = 56 # Integer |
|
94
|
+
height = 56 # Integer | Height of the output image - final image will be exactly this height
|
95
95
|
|
96
|
-
image_file = File.new(
|
96
|
+
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.
|
97
97
|
|
98
98
|
|
99
99
|
begin
|
@@ -109,8 +109,8 @@ end
|
|
109
109
|
|
110
110
|
Name | Type | Description | Notes
|
111
111
|
------------- | ------------- | ------------- | -------------
|
112
|
-
**width** | **Integer**|
|
113
|
-
**height** | **Integer**|
|
112
|
+
**width** | **Integer**| Width of the output image - final image will be exactly this width |
|
113
|
+
**height** | **Integer**| Height of the output image - final image will be exactly this height |
|
114
114
|
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
115
115
|
|
116
116
|
### Return type
|
@@ -124,7 +124,7 @@ Name | Type | Description | Notes
|
|
124
124
|
### HTTP request headers
|
125
125
|
|
126
126
|
- **Content-Type**: multipart/form-data
|
127
|
-
- **Accept**:
|
127
|
+
- **Accept**: application/octet-stream
|
128
128
|
|
129
129
|
|
130
130
|
|