cloudmersive-image-recognition-api-client 2.0.5 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +19 -19
- data/cloudmersive-image-recognition-api-client.gemspec +1 -1
- data/docs/AgeDetectionResult.md +1 -1
- data/docs/AiImageDetectionApi.md +63 -0
- data/docs/ConvertApi.md +58 -3
- data/docs/FaceApi.md +4 -4
- data/docs/FineTextItem.md +1 -0
- data/docs/ImageAiDetectionResult.md +10 -0
- data/docs/NsfwAdvancedResult.md +19 -0
- data/docs/NsfwApi.md +169 -4
- data/docs/PersonWithAge.md +4 -1
- data/docs/RecognizeApi.md +0 -110
- data/docs/ResizeApi.md +55 -0
- data/docs/TextItem.md +1 -0
- data/lib/cloudmersive-image-recognition-api-client/api/ai_image_detection_api.rb +78 -0
- data/lib/cloudmersive-image-recognition-api-client/api/artistic_api.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/api/convert_api.rb +58 -3
- data/lib/cloudmersive-image-recognition-api-client/api/edit_api.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/api/face_api.rb +8 -8
- data/lib/cloudmersive-image-recognition-api-client/api/filter_api.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/api/info_api.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/api/nsfw_api.rb +170 -5
- data/lib/cloudmersive-image-recognition-api-client/api/recognize_api.rb +1 -111
- data/lib/cloudmersive-image-recognition-api-client/api/resize_api.rb +56 -1
- data/lib/cloudmersive-image-recognition-api-client/api/text_generation_api.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/api_client.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/api_error.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/configuration.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/age_detection_result.rb +3 -3
- data/lib/cloudmersive-image-recognition-api-client/models/color_result.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/create_handwriting_request.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/detected_license_plate.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/dominant_color_result.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/draw_polygon_request.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/draw_rectangle_instance.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/draw_rectangle_request.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/draw_text_instance.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/draw_text_request.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/face.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/face_compare_response.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/face_locate_response.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/face_locate_with_landmarks_response.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/face_match.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/face_point.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/face_with_landmarks.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/find_symbol_result.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/fine_text_detection_result.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/fine_text_item.rb +12 -2
- data/lib/cloudmersive-image-recognition-api-client/models/{gender_detection_result.rb → image_ai_detection_result.rb} +25 -27
- data/lib/cloudmersive-image-recognition-api-client/models/image_description_response.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/image_metadata.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/image_metadata_exif_value.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/image_similarity_comparison_response.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/image_similarity_hash_distance_request.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/image_similarity_hash_distance_response.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/image_similarity_hash_response.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/nsfw_advanced_result.rb +296 -0
- data/lib/cloudmersive-image-recognition-api-client/models/nsfw_result.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/person_with_age.rb +36 -5
- data/lib/cloudmersive-image-recognition-api-client/models/polygon_point.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/recognition_outcome.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/text_detection_result.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/models/text_item.rb +12 -2
- data/lib/cloudmersive-image-recognition-api-client/models/vehicle_license_plate_detection_result.rb +1 -1
- data/lib/cloudmersive-image-recognition-api-client/version.rb +2 -2
- data/lib/cloudmersive-image-recognition-api-client.rb +4 -5
- data/spec/api/ai_image_detection_api_spec.rb +47 -0
- data/spec/api/artistic_api_spec.rb +1 -1
- data/spec/api/convert_api_spec.rb +14 -2
- data/spec/api/edit_api_spec.rb +1 -1
- data/spec/api/face_api_spec.rb +4 -4
- data/spec/api/filter_api_spec.rb +1 -1
- data/spec/api/info_api_spec.rb +1 -1
- data/spec/api/nsfw_api_spec.rb +39 -3
- data/spec/api/recognize_api_spec.rb +1 -25
- data/spec/api/resize_api_spec.rb +13 -1
- data/spec/api/text_generation_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/age_detection_result_spec.rb +1 -1
- data/spec/models/color_result_spec.rb +1 -1
- data/spec/models/create_handwriting_request_spec.rb +1 -1
- data/spec/models/detected_license_plate_spec.rb +1 -1
- data/spec/models/dominant_color_result_spec.rb +1 -1
- data/spec/models/draw_polygon_instance_spec.rb +1 -1
- data/spec/models/draw_polygon_request_spec.rb +1 -1
- data/spec/models/draw_rectangle_instance_spec.rb +1 -1
- data/spec/models/draw_rectangle_request_spec.rb +1 -1
- data/spec/models/draw_text_instance_spec.rb +1 -1
- data/spec/models/draw_text_request_spec.rb +1 -1
- data/spec/models/face_compare_response_spec.rb +1 -1
- data/spec/models/face_locate_response_spec.rb +1 -1
- data/spec/models/face_locate_with_landmarks_response_spec.rb +1 -1
- data/spec/models/face_match_spec.rb +1 -1
- data/spec/models/face_point_spec.rb +1 -1
- data/spec/models/face_spec.rb +1 -1
- data/spec/models/face_with_landmarks_spec.rb +1 -1
- data/spec/models/find_symbol_result_spec.rb +1 -1
- data/spec/models/fine_text_detection_result_spec.rb +1 -1
- data/spec/models/fine_text_item_spec.rb +7 -1
- data/spec/models/{person_with_gender_spec.rb → image_ai_detection_result_spec.rb} +10 -10
- data/spec/models/image_description_response_spec.rb +1 -1
- data/spec/models/image_metadata_exif_value_spec.rb +1 -1
- data/spec/models/image_metadata_spec.rb +1 -1
- data/spec/models/image_similarity_comparison_response_spec.rb +1 -1
- data/spec/models/image_similarity_hash_distance_request_spec.rb +1 -1
- data/spec/models/image_similarity_hash_distance_response_spec.rb +1 -1
- data/spec/models/image_similarity_hash_response_spec.rb +1 -1
- data/spec/models/nsfw_advanced_result_spec.rb +107 -0
- data/spec/models/nsfw_result_spec.rb +1 -1
- data/spec/models/person_with_age_spec.rb +19 -1
- data/spec/models/polygon_point_spec.rb +1 -1
- data/spec/models/recognition_outcome_spec.rb +1 -1
- data/spec/models/text_detection_result_spec.rb +1 -1
- data/spec/models/text_item_spec.rb +7 -1
- data/spec/models/vehicle_license_plate_detection_result_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +27 -30
- data/docs/DetectedObject.md +0 -13
- data/docs/GenderDetectionResult.md +0 -10
- data/docs/ObjectDetectionResult.md +0 -10
- data/docs/PersonWithGender.md +0 -10
- data/lib/cloudmersive-image-recognition-api-client/models/detected_object.rb +0 -236
- data/lib/cloudmersive-image-recognition-api-client/models/object_detection_result.rb +0 -208
- data/lib/cloudmersive-image-recognition-api-client/models/person_with_gender.rb +0 -206
- data/spec/models/detected_object_spec.rb +0 -71
- data/spec/models/gender_detection_result_spec.rb +0 -53
- data/spec/models/object_detection_result_spec.rb +0 -53
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 596e6db4ce3daec8b568e0f97c84c3975e0358bad826188ba2e2a883136465a2
|
|
4
|
+
data.tar.gz: 28f3f5bf870b84fe13b8a9c4d18dfb63b16dfc1220c6231aa33b2fe6b94d52ca
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0b2831164731cc294e5e5a5651f448e5b46770a0b7e68afe1816d63d60650b2c4bb8a5c8fcc886d29a333ee9238338f8eeda3a5a12eefaede0e904b1267ee9b3
|
|
7
|
+
data.tar.gz: 0fa7181ec1eb91611d0f5abe3dd6bdef5a4d069d277071f052959b51817409e21bcad03009978747c7f4e5d1acdf602f88b1ccf667ddca9d97ff5ed7ee9c1231
|
data/README.md
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
CloudmersiveImageRecognitionApiClient - the Ruby gem for the imageapi
|
|
4
4
|
|
|
5
|
-
Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.
|
|
5
|
+
Image Recognition and Processing APIs let you use Artificial Intelligence and Machine Learning to recognize and process images, and also perform useful image modification operations.
|
|
6
6
|
|
|
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: 2.0
|
|
10
|
+
- Package version: 2.1.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-2.0.
|
|
26
|
+
gem install ./cloudmersive-image-recognition-api-client-2.1.0.gem
|
|
27
27
|
```
|
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-image-recognition-api-client-2.0.
|
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-image-recognition-api-client-2.1.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', '~> 2.0
|
|
34
|
+
gem 'cloudmersive-image-recognition-api-client', '~> 2.1.0'
|
|
35
35
|
|
|
36
36
|
### Install from Git
|
|
37
37
|
|
|
@@ -62,19 +62,17 @@ CloudmersiveImageRecognitionApiClient.configure do |config|
|
|
|
62
62
|
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
63
63
|
end
|
|
64
64
|
|
|
65
|
-
api_instance = CloudmersiveImageRecognitionApiClient::
|
|
66
|
-
|
|
67
|
-
style = 'style_example' # String | The style of the painting to apply. To start, try \"udnie\" a painting style. Possible values are: \"udnie\", \"wave\", \"la_muse\", \"rain_princess\".
|
|
65
|
+
api_instance = CloudmersiveImageRecognitionApiClient::AiImageDetectionApi.new
|
|
68
66
|
|
|
69
67
|
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.
|
|
70
68
|
|
|
71
69
|
|
|
72
70
|
begin
|
|
73
|
-
#
|
|
74
|
-
result = api_instance.
|
|
71
|
+
#Detect if an input image was generated using AI
|
|
72
|
+
result = api_instance.ai_image_detection_detect_file(image_file)
|
|
75
73
|
p result
|
|
76
74
|
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
|
77
|
-
puts "Exception when calling
|
|
75
|
+
puts "Exception when calling AiImageDetectionApi->ai_image_detection_detect_file: #{e}"
|
|
78
76
|
end
|
|
79
77
|
|
|
80
78
|
```
|
|
@@ -85,10 +83,12 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
|
85
83
|
|
|
86
84
|
Class | Method | HTTP request | Description
|
|
87
85
|
------------ | ------------- | ------------- | -------------
|
|
86
|
+
*CloudmersiveImageRecognitionApiClient::AiImageDetectionApi* | [**ai_image_detection_detect_file**](docs/AiImageDetectionApi.md#ai_image_detection_detect_file) | **POST** /image/ai-detection/file | Detect if an input image was generated using AI
|
|
88
87
|
*CloudmersiveImageRecognitionApiClient::ArtisticApi* | [**artistic_painting**](docs/ArtisticApi.md#artistic_painting) | **POST** /image/artistic/painting/{style} | Transform an image into an artistic painting automatically
|
|
89
88
|
*CloudmersiveImageRecognitionApiClient::ConvertApi* | [**convert_to_bmp**](docs/ConvertApi.md#convert_to_bmp) | **POST** /image/convert/to/bmp | Convert input image to Bitmap BMP format
|
|
90
89
|
*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
|
|
90
|
+
*CloudmersiveImageRecognitionApiClient::ConvertApi* | [**convert_to_jpg**](docs/ConvertApi.md#convert_to_jpg) | **POST** /image/convert/to/jpg/{quality} | Convert input image to JPG, JPEG format at specific quality
|
|
91
|
+
*CloudmersiveImageRecognitionApiClient::ConvertApi* | [**convert_to_jpg_default_quality**](docs/ConvertApi.md#convert_to_jpg_default_quality) | **POST** /image/convert/to/jpg | 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
|
|
@@ -124,11 +124,12 @@ Class | Method | HTTP request | Description
|
|
|
124
124
|
*CloudmersiveImageRecognitionApiClient::FilterApi* | [**filter_swirl**](docs/FilterApi.md#filter_swirl) | **POST** /image/filter/swirl | Swirl distort the image
|
|
125
125
|
*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
|
|
126
126
|
*CloudmersiveImageRecognitionApiClient::InfoApi* | [**info_get_metadata**](docs/InfoApi.md#info_get_metadata) | **POST** /image/get-info/metadata | Returns the image metadata including EXIF and resolution
|
|
127
|
-
*CloudmersiveImageRecognitionApiClient::NsfwApi* | [**nsfw_classify**](docs/NsfwApi.md#nsfw_classify) | **POST** /image/nsfw/classify | Not safe for work NSFW
|
|
127
|
+
*CloudmersiveImageRecognitionApiClient::NsfwApi* | [**nsfw_classify**](docs/NsfwApi.md#nsfw_classify) | **POST** /image/nsfw/classify | Not safe for work (NSFW) content classification for Images
|
|
128
|
+
*CloudmersiveImageRecognitionApiClient::NsfwApi* | [**nsfw_classify_advanced**](docs/NsfwApi.md#nsfw_classify_advanced) | **POST** /image/nsfw/classify/advanced | Advanced content moderation and not safe for work (NSFW) content classification for Images
|
|
129
|
+
*CloudmersiveImageRecognitionApiClient::NsfwApi* | [**nsfw_classify_document**](docs/NsfwApi.md#nsfw_classify_document) | **POST** /image/nsfw/classify/document | Not safe for work (NSFW) content classification for Documents
|
|
130
|
+
*CloudmersiveImageRecognitionApiClient::NsfwApi* | [**nsfw_classify_video**](docs/NsfwApi.md#nsfw_classify_video) | **POST** /image/nsfw/classify/video | Not safe for work (NSFW) content classification for Video
|
|
128
131
|
*CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_describe**](docs/RecognizeApi.md#recognize_describe) | **POST** /image/recognize/describe | Describe an image in natural language
|
|
129
132
|
*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
|
|
130
|
-
*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
|
|
131
|
-
*CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_detect_people**](docs/RecognizeApi.md#recognize_detect_people) | **POST** /image/recognize/detect-people | Detect people including locations in an image
|
|
132
133
|
*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
|
|
133
134
|
*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
|
|
134
135
|
*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
|
|
@@ -137,6 +138,7 @@ Class | Method | HTTP request | Description
|
|
|
137
138
|
*CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_similarity_hash**](docs/RecognizeApi.md#recognize_similarity_hash) | **POST** /image/recognize/similarity/hash | Generate a perceptual image hash
|
|
138
139
|
*CloudmersiveImageRecognitionApiClient::RecognizeApi* | [**recognize_similarity_hash_distance**](docs/RecognizeApi.md#recognize_similarity_hash_distance) | **POST** /image/recognize/similarity/hash/distance | Calculates the similarity between two perceptual image hashes
|
|
139
140
|
*CloudmersiveImageRecognitionApiClient::ResizeApi* | [**resize_post**](docs/ResizeApi.md#resize_post) | **POST** /image/resize/preserveAspectRatio/{maxWidth}/{maxHeight} | Resize an image while preserving aspect ratio
|
|
141
|
+
*CloudmersiveImageRecognitionApiClient::ResizeApi* | [**resize_resize_ai_super_sampling**](docs/ResizeApi.md#resize_resize_ai_super_sampling) | **POST** /image/resize/ai/target | Resize an image with AI super sampling
|
|
140
142
|
*CloudmersiveImageRecognitionApiClient::ResizeApi* | [**resize_resize_simple**](docs/ResizeApi.md#resize_resize_simple) | **POST** /image/resize/target/{width}/{height} | Resize an image
|
|
141
143
|
*CloudmersiveImageRecognitionApiClient::TextGenerationApi* | [**text_generation_create_handwriting_png**](docs/TextGenerationApi.md#text_generation_create_handwriting_png) | **POST** /image/text/create/handwriting/png | Create an image of handwriting in PNG format
|
|
142
144
|
|
|
@@ -147,7 +149,6 @@ Class | Method | HTTP request | Description
|
|
|
147
149
|
- [CloudmersiveImageRecognitionApiClient::ColorResult](docs/ColorResult.md)
|
|
148
150
|
- [CloudmersiveImageRecognitionApiClient::CreateHandwritingRequest](docs/CreateHandwritingRequest.md)
|
|
149
151
|
- [CloudmersiveImageRecognitionApiClient::DetectedLicensePlate](docs/DetectedLicensePlate.md)
|
|
150
|
-
- [CloudmersiveImageRecognitionApiClient::DetectedObject](docs/DetectedObject.md)
|
|
151
152
|
- [CloudmersiveImageRecognitionApiClient::DominantColorResult](docs/DominantColorResult.md)
|
|
152
153
|
- [CloudmersiveImageRecognitionApiClient::DrawPolygonInstance](docs/DrawPolygonInstance.md)
|
|
153
154
|
- [CloudmersiveImageRecognitionApiClient::DrawPolygonRequest](docs/DrawPolygonRequest.md)
|
|
@@ -165,7 +166,7 @@ Class | Method | HTTP request | Description
|
|
|
165
166
|
- [CloudmersiveImageRecognitionApiClient::FindSymbolResult](docs/FindSymbolResult.md)
|
|
166
167
|
- [CloudmersiveImageRecognitionApiClient::FineTextDetectionResult](docs/FineTextDetectionResult.md)
|
|
167
168
|
- [CloudmersiveImageRecognitionApiClient::FineTextItem](docs/FineTextItem.md)
|
|
168
|
-
- [CloudmersiveImageRecognitionApiClient::
|
|
169
|
+
- [CloudmersiveImageRecognitionApiClient::ImageAiDetectionResult](docs/ImageAiDetectionResult.md)
|
|
169
170
|
- [CloudmersiveImageRecognitionApiClient::ImageDescriptionResponse](docs/ImageDescriptionResponse.md)
|
|
170
171
|
- [CloudmersiveImageRecognitionApiClient::ImageMetadata](docs/ImageMetadata.md)
|
|
171
172
|
- [CloudmersiveImageRecognitionApiClient::ImageMetadataExifValue](docs/ImageMetadataExifValue.md)
|
|
@@ -173,10 +174,9 @@ Class | Method | HTTP request | Description
|
|
|
173
174
|
- [CloudmersiveImageRecognitionApiClient::ImageSimilarityHashDistanceRequest](docs/ImageSimilarityHashDistanceRequest.md)
|
|
174
175
|
- [CloudmersiveImageRecognitionApiClient::ImageSimilarityHashDistanceResponse](docs/ImageSimilarityHashDistanceResponse.md)
|
|
175
176
|
- [CloudmersiveImageRecognitionApiClient::ImageSimilarityHashResponse](docs/ImageSimilarityHashResponse.md)
|
|
177
|
+
- [CloudmersiveImageRecognitionApiClient::NsfwAdvancedResult](docs/NsfwAdvancedResult.md)
|
|
176
178
|
- [CloudmersiveImageRecognitionApiClient::NsfwResult](docs/NsfwResult.md)
|
|
177
|
-
- [CloudmersiveImageRecognitionApiClient::ObjectDetectionResult](docs/ObjectDetectionResult.md)
|
|
178
179
|
- [CloudmersiveImageRecognitionApiClient::PersonWithAge](docs/PersonWithAge.md)
|
|
179
|
-
- [CloudmersiveImageRecognitionApiClient::PersonWithGender](docs/PersonWithGender.md)
|
|
180
180
|
- [CloudmersiveImageRecognitionApiClient::PolygonPoint](docs/PolygonPoint.md)
|
|
181
181
|
- [CloudmersiveImageRecognitionApiClient::RecognitionOutcome](docs/RecognitionOutcome.md)
|
|
182
182
|
- [CloudmersiveImageRecognitionApiClient::TextDetectionResult](docs/TextDetectionResult.md)
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
=begin
|
|
4
4
|
#imageapi
|
|
5
5
|
|
|
6
|
-
#Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.
|
|
6
|
+
#Image Recognition and Processing APIs let you use Artificial Intelligence and Machine Learning to recognize and process images, and also perform useful image modification operations.
|
|
7
7
|
|
|
8
8
|
OpenAPI spec version: v1
|
|
9
9
|
|
data/docs/AgeDetectionResult.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
|
7
|
-
**people_with_age** | [**Array<PersonWithAge>**](PersonWithAge.md) | People in the image annotated with age information | [optional]
|
|
7
|
+
**people_with_age** | [**Array<PersonWithAge>**](PersonWithAge.md) | People in the image annotated with age and gender information | [optional]
|
|
8
8
|
**people_identified** | **Integer** | Number of people identified in the image with an age | [optional]
|
|
9
9
|
|
|
10
10
|
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# CloudmersiveImageRecognitionApiClient::AiImageDetectionApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**ai_image_detection_detect_file**](AiImageDetectionApi.md#ai_image_detection_detect_file) | **POST** /image/ai-detection/file | Detect if an input image was generated using AI
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
# **ai_image_detection_detect_file**
|
|
11
|
+
> ImageAiDetectionResult ai_image_detection_detect_file(image_file)
|
|
12
|
+
|
|
13
|
+
Detect if an input image was generated using AI
|
|
14
|
+
|
|
15
|
+
Detects if the input image was generated using AI tools.
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
```ruby
|
|
19
|
+
# load the gem
|
|
20
|
+
require 'cloudmersive-image-recognition-api-client'
|
|
21
|
+
# setup authorization
|
|
22
|
+
CloudmersiveImageRecognitionApiClient.configure do |config|
|
|
23
|
+
# Configure API key authorization: Apikey
|
|
24
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
25
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
26
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
api_instance = CloudmersiveImageRecognitionApiClient::AiImageDetectionApi.new
|
|
30
|
+
|
|
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
|
+
|
|
33
|
+
|
|
34
|
+
begin
|
|
35
|
+
#Detect if an input image was generated using AI
|
|
36
|
+
result = api_instance.ai_image_detection_detect_file(image_file)
|
|
37
|
+
p result
|
|
38
|
+
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
|
39
|
+
puts "Exception when calling AiImageDetectionApi->ai_image_detection_detect_file: #{e}"
|
|
40
|
+
end
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Parameters
|
|
44
|
+
|
|
45
|
+
Name | Type | Description | Notes
|
|
46
|
+
------------- | ------------- | ------------- | -------------
|
|
47
|
+
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
|
48
|
+
|
|
49
|
+
### Return type
|
|
50
|
+
|
|
51
|
+
[**ImageAiDetectionResult**](ImageAiDetectionResult.md)
|
|
52
|
+
|
|
53
|
+
### Authorization
|
|
54
|
+
|
|
55
|
+
[Apikey](../README.md#Apikey)
|
|
56
|
+
|
|
57
|
+
### HTTP request headers
|
|
58
|
+
|
|
59
|
+
- **Content-Type**: multipart/form-data
|
|
60
|
+
- **Accept**: application/octet-stream
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
data/docs/ConvertApi.md
CHANGED
|
@@ -6,7 +6,8 @@ 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 at specific quality
|
|
10
|
+
[**convert_to_jpg_default_quality**](ConvertApi.md#convert_to_jpg_default_quality) | **POST** /image/convert/to/jpg | Convert input image to JPG, JPEG format
|
|
10
11
|
[**convert_to_photoshop**](ConvertApi.md#convert_to_photoshop) | **POST** /image/convert/to/psd | Convert input image to Photoshop PSD format
|
|
11
12
|
[**convert_to_png**](ConvertApi.md#convert_to_png) | **POST** /image/convert/to/png | Convert input image to PNG format
|
|
12
13
|
[**convert_to_tiff**](ConvertApi.md#convert_to_tiff) | **POST** /image/convert/to/tiff | Convert input image to TIFF format
|
|
@@ -124,7 +125,7 @@ Name | Type | Description | Notes
|
|
|
124
125
|
# **convert_to_jpg**
|
|
125
126
|
> String convert_to_jpg(quality, image_file)
|
|
126
127
|
|
|
127
|
-
Convert input image to JPG, JPEG format
|
|
128
|
+
Convert input image to JPG, JPEG format at specific quality
|
|
128
129
|
|
|
129
130
|
Converts the input image into JPEG/JPG format. Customize encoding parameters. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
|
|
130
131
|
|
|
@@ -148,7 +149,7 @@ image_file = File.new('/path/to/file.txt') # File | Image file to perform the op
|
|
|
148
149
|
|
|
149
150
|
|
|
150
151
|
begin
|
|
151
|
-
#Convert input image to JPG, JPEG format
|
|
152
|
+
#Convert input image to JPG, JPEG format at specific quality
|
|
152
153
|
result = api_instance.convert_to_jpg(quality, image_file)
|
|
153
154
|
p result
|
|
154
155
|
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
|
@@ -178,6 +179,60 @@ Name | Type | Description | Notes
|
|
|
178
179
|
|
|
179
180
|
|
|
180
181
|
|
|
182
|
+
# **convert_to_jpg_default_quality**
|
|
183
|
+
> Object convert_to_jpg_default_quality(image_file)
|
|
184
|
+
|
|
185
|
+
Convert input image to JPG, JPEG format
|
|
186
|
+
|
|
187
|
+
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.
|
|
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::ConvertApi.new
|
|
202
|
+
|
|
203
|
+
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.
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
begin
|
|
207
|
+
#Convert input image to JPG, JPEG format
|
|
208
|
+
result = api_instance.convert_to_jpg_default_quality(image_file)
|
|
209
|
+
p result
|
|
210
|
+
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
|
211
|
+
puts "Exception when calling ConvertApi->convert_to_jpg_default_quality: #{e}"
|
|
212
|
+
end
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Parameters
|
|
216
|
+
|
|
217
|
+
Name | Type | Description | Notes
|
|
218
|
+
------------- | ------------- | ------------- | -------------
|
|
219
|
+
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
|
220
|
+
|
|
221
|
+
### Return type
|
|
222
|
+
|
|
223
|
+
**Object**
|
|
224
|
+
|
|
225
|
+
### Authorization
|
|
226
|
+
|
|
227
|
+
[Apikey](../README.md#Apikey)
|
|
228
|
+
|
|
229
|
+
### HTTP request headers
|
|
230
|
+
|
|
231
|
+
- **Content-Type**: multipart/form-data
|
|
232
|
+
- **Accept**: application/octet-stream
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
181
236
|
# **convert_to_photoshop**
|
|
182
237
|
> String convert_to_photoshop(image_file)
|
|
183
238
|
|
data/docs/FaceApi.md
CHANGED
|
@@ -183,7 +183,7 @@ Name | Type | Description | Notes
|
|
|
183
183
|
|
|
184
184
|
Detect the age of people in an image
|
|
185
185
|
|
|
186
|
-
Identify the age, position, and size of human faces 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.
|
|
186
|
+
Identify the age, position, and size of human faces 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. Input image should be a PNG or JPG. Consumes 20 API calls.
|
|
187
187
|
|
|
188
188
|
### Example
|
|
189
189
|
```ruby
|
|
@@ -233,11 +233,11 @@ Name | Type | Description | Notes
|
|
|
233
233
|
|
|
234
234
|
|
|
235
235
|
# **face_detect_gender**
|
|
236
|
-
>
|
|
236
|
+
> AgeDetectionResult face_detect_gender(image_file)
|
|
237
237
|
|
|
238
238
|
Detect the gender of people in an image
|
|
239
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.
|
|
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. Input image should be a PNG or JPG. Consumes 20 API calls.
|
|
241
241
|
|
|
242
242
|
### Example
|
|
243
243
|
```ruby
|
|
@@ -273,7 +273,7 @@ Name | Type | Description | Notes
|
|
|
273
273
|
|
|
274
274
|
### Return type
|
|
275
275
|
|
|
276
|
-
[**
|
|
276
|
+
[**AgeDetectionResult**](AgeDetectionResult.md)
|
|
277
277
|
|
|
278
278
|
### Authorization
|
|
279
279
|
|
data/docs/FineTextItem.md
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**detected_text** | **String** | Detected text in the image | [optional]
|
|
6
7
|
**top_left_x** | **Integer** | X coordinate of the top/left text location; 0 represents the left edge of the input image | [optional]
|
|
7
8
|
**top_left_y** | **Integer** | Y coordinate of the top/left text location; 0 represents the top edge of the input image | [optional]
|
|
8
9
|
**top_right_x** | **Integer** | X coordinate of the top/right text location; 0 represents the left edge of the input image | [optional]
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveImageRecognitionApiClient::ImageAiDetectionResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**clean_result** | **BOOLEAN** | True if the image is clean (not AI generated) and false otherwise | [optional]
|
|
7
|
+
**ai_generated_risk_score** | **Float** | Risk score between 0.0 (no risk) and 1.0 (highest risk), with anything over 0.8 being high risk | [optional]
|
|
8
|
+
**ai_source** | **String** | Tool used to generate the image, if identified (this cannot always be identified) | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CloudmersiveImageRecognitionApiClient::NsfwAdvancedResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if the classification was successfully run, false otherwise | [optional]
|
|
7
|
+
**clean_result** | **BOOLEAN** | True if the result was clean, false otherwise | [optional]
|
|
8
|
+
**contains_nudity** | **BOOLEAN** | True if the image contains nudity or sex, false otherwise | [optional]
|
|
9
|
+
**contains_graphic_violence** | **BOOLEAN** | True if the image contains graphic violence and/or gore, false otherwise | [optional]
|
|
10
|
+
**contains_non_graphic_violence** | **BOOLEAN** | True if the image contains non-graphic violence, e.g. weapons, false otherwise | [optional]
|
|
11
|
+
**contains_self_harm** | **BOOLEAN** | True if the image contains self-harm or suicide imagery, false otherwise | [optional]
|
|
12
|
+
**contains_hate** | **BOOLEAN** | True if the image contains hate, false otherwise | [optional]
|
|
13
|
+
**contains_potential_illegal_activity** | **BOOLEAN** | True if the image contains potentially illegal activity such as drugs, false otherwise | [optional]
|
|
14
|
+
**contains_medical_imagery** | **BOOLEAN** | True if the image contains medical imagery, false otherwise | [optional]
|
|
15
|
+
**contains_profanity** | **BOOLEAN** | True if the image contains profanity or obscenities, false otherwise | [optional]
|
|
16
|
+
**score** | **Float** | Score between 0.0 and 1.0. Scores of 0.0-0.2 represent high probability safe content, while scores 0.8-1.0 represent high probability unsafe content. Content between 0.2 and 0.8 is of increasing raciness. | [optional]
|
|
17
|
+
**classification_outcome** | **String** | Classification result into four categories: SafeContent_HighProbability, UnsafeContent_HighProbability, RacyContent, SafeContent_ModerateProbability | [optional]
|
|
18
|
+
|
|
19
|
+
|
data/docs/NsfwApi.md
CHANGED
|
@@ -4,15 +4,18 @@ 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
|
|
7
|
+
[**nsfw_classify**](NsfwApi.md#nsfw_classify) | **POST** /image/nsfw/classify | Not safe for work (NSFW) content classification for Images
|
|
8
|
+
[**nsfw_classify_advanced**](NsfwApi.md#nsfw_classify_advanced) | **POST** /image/nsfw/classify/advanced | Advanced content moderation and not safe for work (NSFW) content classification for Images
|
|
9
|
+
[**nsfw_classify_document**](NsfwApi.md#nsfw_classify_document) | **POST** /image/nsfw/classify/document | Not safe for work (NSFW) content classification for Documents
|
|
10
|
+
[**nsfw_classify_video**](NsfwApi.md#nsfw_classify_video) | **POST** /image/nsfw/classify/video | Not safe for work (NSFW) content classification for Video
|
|
8
11
|
|
|
9
12
|
|
|
10
13
|
# **nsfw_classify**
|
|
11
14
|
> NsfwResult nsfw_classify(image_file)
|
|
12
15
|
|
|
13
|
-
Not safe for work NSFW
|
|
16
|
+
Not safe for work (NSFW) content classification for Images
|
|
14
17
|
|
|
15
|
-
Classify an image into Not Safe For Work (NSFW)/
|
|
18
|
+
Classify an image into Not Safe For Work (NSFW)/Pornographic/Nudity/Racy content and Safe Content. Helpful for filtering out unsafe content when processing user images. Input image should be JPG, PNG or GIF. Consumes 20 API calls.
|
|
16
19
|
|
|
17
20
|
### Example
|
|
18
21
|
```ruby
|
|
@@ -32,7 +35,7 @@ image_file = File.new('/path/to/file.txt') # File | Image file to perform the op
|
|
|
32
35
|
|
|
33
36
|
|
|
34
37
|
begin
|
|
35
|
-
#Not safe for work NSFW
|
|
38
|
+
#Not safe for work (NSFW) content classification for Images
|
|
36
39
|
result = api_instance.nsfw_classify(image_file)
|
|
37
40
|
p result
|
|
38
41
|
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
|
@@ -61,3 +64,165 @@ Name | Type | Description | Notes
|
|
|
61
64
|
|
|
62
65
|
|
|
63
66
|
|
|
67
|
+
# **nsfw_classify_advanced**
|
|
68
|
+
> NsfwAdvancedResult nsfw_classify_advanced(image_file)
|
|
69
|
+
|
|
70
|
+
Advanced content moderation and not safe for work (NSFW) content classification for Images
|
|
71
|
+
|
|
72
|
+
Uses advanced AI to classify an image into Not Safe For Work (NSFW) or not and determine if it contains nudity, graphic violence, non-graphic violence, self-harm, hate, potential illegal activity, medical imagery, or profanity. Helpful for filtering out unsafe content when processing user images. Input image should be JPG, PNG. Consumes 100 API calls. Requires Managed Instance or Private Cloud deployment, and a GPU.
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
```ruby
|
|
76
|
+
# load the gem
|
|
77
|
+
require 'cloudmersive-image-recognition-api-client'
|
|
78
|
+
# setup authorization
|
|
79
|
+
CloudmersiveImageRecognitionApiClient.configure do |config|
|
|
80
|
+
# Configure API key authorization: Apikey
|
|
81
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
82
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
83
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
api_instance = CloudmersiveImageRecognitionApiClient::NsfwApi.new
|
|
87
|
+
|
|
88
|
+
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.
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
begin
|
|
92
|
+
#Advanced content moderation and not safe for work (NSFW) content classification for Images
|
|
93
|
+
result = api_instance.nsfw_classify_advanced(image_file)
|
|
94
|
+
p result
|
|
95
|
+
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
|
96
|
+
puts "Exception when calling NsfwApi->nsfw_classify_advanced: #{e}"
|
|
97
|
+
end
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Parameters
|
|
101
|
+
|
|
102
|
+
Name | Type | Description | Notes
|
|
103
|
+
------------- | ------------- | ------------- | -------------
|
|
104
|
+
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
|
105
|
+
|
|
106
|
+
### Return type
|
|
107
|
+
|
|
108
|
+
[**NsfwAdvancedResult**](NsfwAdvancedResult.md)
|
|
109
|
+
|
|
110
|
+
### Authorization
|
|
111
|
+
|
|
112
|
+
[Apikey](../README.md#Apikey)
|
|
113
|
+
|
|
114
|
+
### HTTP request headers
|
|
115
|
+
|
|
116
|
+
- **Content-Type**: multipart/form-data
|
|
117
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
# **nsfw_classify_document**
|
|
122
|
+
> NsfwResult nsfw_classify_document(image_file)
|
|
123
|
+
|
|
124
|
+
Not safe for work (NSFW) content classification for Documents
|
|
125
|
+
|
|
126
|
+
Classify a document (PDF, DOCX, DOC, XLSX, XLS, PPTX, PPT) into Not Safe For Work (NSFW)/Pornographic/Nudity/Racy content and Safe Content. Helpful for filtering out unsafe content when processing user images. Consumes 20 API calls per image.
|
|
127
|
+
|
|
128
|
+
### Example
|
|
129
|
+
```ruby
|
|
130
|
+
# load the gem
|
|
131
|
+
require 'cloudmersive-image-recognition-api-client'
|
|
132
|
+
# setup authorization
|
|
133
|
+
CloudmersiveImageRecognitionApiClient.configure do |config|
|
|
134
|
+
# Configure API key authorization: Apikey
|
|
135
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
136
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
137
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
api_instance = CloudmersiveImageRecognitionApiClient::NsfwApi.new
|
|
141
|
+
|
|
142
|
+
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.
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
begin
|
|
146
|
+
#Not safe for work (NSFW) content classification for Documents
|
|
147
|
+
result = api_instance.nsfw_classify_document(image_file)
|
|
148
|
+
p result
|
|
149
|
+
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
|
150
|
+
puts "Exception when calling NsfwApi->nsfw_classify_document: #{e}"
|
|
151
|
+
end
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Parameters
|
|
155
|
+
|
|
156
|
+
Name | Type | Description | Notes
|
|
157
|
+
------------- | ------------- | ------------- | -------------
|
|
158
|
+
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
|
159
|
+
|
|
160
|
+
### Return type
|
|
161
|
+
|
|
162
|
+
[**NsfwResult**](NsfwResult.md)
|
|
163
|
+
|
|
164
|
+
### Authorization
|
|
165
|
+
|
|
166
|
+
[Apikey](../README.md#Apikey)
|
|
167
|
+
|
|
168
|
+
### HTTP request headers
|
|
169
|
+
|
|
170
|
+
- **Content-Type**: multipart/form-data
|
|
171
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
# **nsfw_classify_video**
|
|
176
|
+
> NsfwResult nsfw_classify_video(video_file)
|
|
177
|
+
|
|
178
|
+
Not safe for work (NSFW) content classification for Video
|
|
179
|
+
|
|
180
|
+
Classify a video into Not Safe For Work (NSFW)/Pornographic/Nudity/Racy content and Safe Content. Helpful for filtering out unsafe content when processing user images. Input image should be MP4, MOV, WEBM, MKV, AVI, FLV, MPG, GIF. Consumes 20 API calls per frame analyzed. Requires Cloudmersive Managed Instance or Private Cloud deployment.
|
|
181
|
+
|
|
182
|
+
### Example
|
|
183
|
+
```ruby
|
|
184
|
+
# load the gem
|
|
185
|
+
require 'cloudmersive-image-recognition-api-client'
|
|
186
|
+
# setup authorization
|
|
187
|
+
CloudmersiveImageRecognitionApiClient.configure do |config|
|
|
188
|
+
# Configure API key authorization: Apikey
|
|
189
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
190
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
191
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
192
|
+
end
|
|
193
|
+
|
|
194
|
+
api_instance = CloudmersiveImageRecognitionApiClient::NsfwApi.new
|
|
195
|
+
|
|
196
|
+
video_file = File.new('/path/to/file.txt') # File | Video file to perform the operation on. Common file formats such as MP4, MPG are supported.
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
begin
|
|
200
|
+
#Not safe for work (NSFW) content classification for Video
|
|
201
|
+
result = api_instance.nsfw_classify_video(video_file)
|
|
202
|
+
p result
|
|
203
|
+
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
|
204
|
+
puts "Exception when calling NsfwApi->nsfw_classify_video: #{e}"
|
|
205
|
+
end
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Parameters
|
|
209
|
+
|
|
210
|
+
Name | Type | Description | Notes
|
|
211
|
+
------------- | ------------- | ------------- | -------------
|
|
212
|
+
**video_file** | **File**| Video file to perform the operation on. Common file formats such as MP4, MPG are supported. |
|
|
213
|
+
|
|
214
|
+
### Return type
|
|
215
|
+
|
|
216
|
+
[**NsfwResult**](NsfwResult.md)
|
|
217
|
+
|
|
218
|
+
### Authorization
|
|
219
|
+
|
|
220
|
+
[Apikey](../README.md#Apikey)
|
|
221
|
+
|
|
222
|
+
### HTTP request headers
|
|
223
|
+
|
|
224
|
+
- **Content-Type**: multipart/form-data
|
|
225
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
data/docs/PersonWithAge.md
CHANGED
|
@@ -6,6 +6,9 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**face_location** | [**Face**](Face.md) | Location and other information about the person's face corresponding to this age classification | [optional]
|
|
7
7
|
**age_classification_confidence** | **Float** | Confidence level of age classification; possible values are between 0.0 and 1.0; higher is better, with values &gt; 0.50 being high confidence results | [optional]
|
|
8
8
|
**age_class** | **String** | The person's age range classification result in years; possible values are \"0-2\", \"4-6\", \"8-13\", \"15-20\", \"25-32\", \"38-43\", \"48-53\", \"60+\" | [optional]
|
|
9
|
-
**age** | **Float** |
|
|
9
|
+
**age** | **Float** | The specific estimated age of the person | [optional]
|
|
10
|
+
**gender_classification** | **String** | Gender estimation classification as Female or Male | [optional]
|
|
11
|
+
**gender_female_confidence** | **Float** | Confidence level of classification as female; possible values are between 0.0 and 1.0 | [optional]
|
|
12
|
+
**gender_male_confidence** | **Float** | Confidence level of classification as male; possible values are between 0.0 and 1.0 | [optional]
|
|
10
13
|
|
|
11
14
|
|