cloudmersive-image-recognition-api-client 1.4.6 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- metadata +3 -145
- data/Gemfile +0 -7
- data/README.md +0 -184
- data/Rakefile +0 -8
- data/cloudmersive-image-recognition-api-client.gemspec +0 -45
- data/docs/AgeDetectionResult.md +0 -10
- data/docs/ArtisticApi.md +0 -66
- data/docs/ColorResult.md +0 -10
- data/docs/ConvertApi.md +0 -396
- data/docs/DetectedLicensePlate.md +0 -14
- data/docs/DetectedObject.md +0 -13
- data/docs/DominantColorResult.md +0 -9
- data/docs/DrawPolygonInstance.md +0 -11
- data/docs/DrawPolygonRequest.md +0 -10
- data/docs/DrawRectangleInstance.md +0 -14
- data/docs/DrawRectangleRequest.md +0 -10
- data/docs/DrawTextInstance.md +0 -15
- data/docs/DrawTextRequest.md +0 -10
- data/docs/EditApi.md +0 -704
- data/docs/Face.md +0 -11
- data/docs/FaceApi.md +0 -396
- data/docs/FaceCompareResponse.md +0 -11
- data/docs/FaceLocateResponse.md +0 -11
- data/docs/FaceLocateWithLandmarksResponse.md +0 -11
- data/docs/FaceMatch.md +0 -13
- data/docs/FacePoint.md +0 -9
- data/docs/FaceWithLandmarks.md +0 -20
- data/docs/FilterApi.md +0 -478
- data/docs/FindSymbolResult.md +0 -13
- data/docs/FineTextDetectionResult.md +0 -10
- data/docs/FineTextItem.md +0 -18
- data/docs/GenderDetectionResult.md +0 -10
- data/docs/ImageDescriptionResponse.md +0 -11
- data/docs/ImageMetadata.md +0 -17
- data/docs/ImageMetadataExifValue.md +0 -10
- data/docs/InfoApi.md +0 -118
- data/docs/NsfwApi.md +0 -63
- data/docs/NsfwResult.md +0 -10
- data/docs/ObjectDetectionResult.md +0 -10
- data/docs/PersonWithAge.md +0 -11
- data/docs/PersonWithGender.md +0 -10
- data/docs/PolygonPoint.md +0 -9
- data/docs/RecognitionOutcome.md +0 -9
- data/docs/RecognizeApi.md +0 -455
- data/docs/ResizeApi.md +0 -130
- data/docs/TextDetectionResult.md +0 -10
- data/docs/TextItem.md +0 -11
- data/docs/VehicleLicensePlateDetectionResult.md +0 -10
- data/git_push.sh +0 -55
- data/lib/cloudmersive-image-recognition-api-client.rb +0 -82
- data/lib/cloudmersive-image-recognition-api-client/api/artistic_api.rb +0 -85
- data/lib/cloudmersive-image-recognition-api-client/api/convert_api.rb +0 -421
- data/lib/cloudmersive-image-recognition-api-client/api/edit_api.rb +0 -765
- data/lib/cloudmersive-image-recognition-api-client/api/face_api.rb +0 -422
- data/lib/cloudmersive-image-recognition-api-client/api/filter_api.rb +0 -533
- data/lib/cloudmersive-image-recognition-api-client/api/info_api.rb +0 -135
- data/lib/cloudmersive-image-recognition-api-client/api/nsfw_api.rb +0 -79
- data/lib/cloudmersive-image-recognition-api-client/api/recognize_api.rb +0 -481
- data/lib/cloudmersive-image-recognition-api-client/api/resize_api.rb +0 -159
- data/lib/cloudmersive-image-recognition-api-client/api_client.rb +0 -389
- data/lib/cloudmersive-image-recognition-api-client/api_error.rb +0 -38
- data/lib/cloudmersive-image-recognition-api-client/configuration.rb +0 -209
- data/lib/cloudmersive-image-recognition-api-client/models/age_detection_result.rb +0 -211
- data/lib/cloudmersive-image-recognition-api-client/models/color_result.rb +0 -209
- data/lib/cloudmersive-image-recognition-api-client/models/detected_license_plate.rb +0 -249
- data/lib/cloudmersive-image-recognition-api-client/models/detected_object.rb +0 -239
- data/lib/cloudmersive-image-recognition-api-client/models/dominant_color_result.rb +0 -201
- data/lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb +0 -221
- data/lib/cloudmersive-image-recognition-api-client/models/draw_polygon_request.rb +0 -227
- data/lib/cloudmersive-image-recognition-api-client/models/draw_rectangle_instance.rb +0 -249
- data/lib/cloudmersive-image-recognition-api-client/models/draw_rectangle_request.rb +0 -227
- data/lib/cloudmersive-image-recognition-api-client/models/draw_text_instance.rb +0 -259
- data/lib/cloudmersive-image-recognition-api-client/models/draw_text_request.rb +0 -227
- data/lib/cloudmersive-image-recognition-api-client/models/face.rb +0 -219
- data/lib/cloudmersive-image-recognition-api-client/models/face_compare_response.rb +0 -221
- data/lib/cloudmersive-image-recognition-api-client/models/face_locate_response.rb +0 -221
- data/lib/cloudmersive-image-recognition-api-client/models/face_locate_with_landmarks_response.rb +0 -221
- data/lib/cloudmersive-image-recognition-api-client/models/face_match.rb +0 -239
- data/lib/cloudmersive-image-recognition-api-client/models/face_point.rb +0 -199
- data/lib/cloudmersive-image-recognition-api-client/models/face_with_landmarks.rb +0 -327
- data/lib/cloudmersive-image-recognition-api-client/models/find_symbol_result.rb +0 -239
- data/lib/cloudmersive-image-recognition-api-client/models/fine_text_detection_result.rb +0 -211
- data/lib/cloudmersive-image-recognition-api-client/models/fine_text_item.rb +0 -289
- data/lib/cloudmersive-image-recognition-api-client/models/gender_detection_result.rb +0 -211
- data/lib/cloudmersive-image-recognition-api-client/models/image_description_response.rb +0 -219
- data/lib/cloudmersive-image-recognition-api-client/models/image_metadata.rb +0 -281
- data/lib/cloudmersive-image-recognition-api-client/models/image_metadata_exif_value.rb +0 -209
- data/lib/cloudmersive-image-recognition-api-client/models/nsfw_result.rb +0 -209
- data/lib/cloudmersive-image-recognition-api-client/models/object_detection_result.rb +0 -211
- data/lib/cloudmersive-image-recognition-api-client/models/person_with_age.rb +0 -218
- data/lib/cloudmersive-image-recognition-api-client/models/person_with_gender.rb +0 -209
- data/lib/cloudmersive-image-recognition-api-client/models/polygon_point.rb +0 -199
- data/lib/cloudmersive-image-recognition-api-client/models/recognition_outcome.rb +0 -199
- data/lib/cloudmersive-image-recognition-api-client/models/text_detection_result.rb +0 -211
- data/lib/cloudmersive-image-recognition-api-client/models/text_item.rb +0 -219
- data/lib/cloudmersive-image-recognition-api-client/models/vehicle_license_plate_detection_result.rb +0 -211
- data/lib/cloudmersive-image-recognition-api-client/version.rb +0 -15
- data/spec/api/artistic_api_spec.rb +0 -48
- data/spec/api/convert_api_spec.rb +0 -120
- data/spec/api/edit_api_spec.rb +0 -191
- data/spec/api/face_api_spec.rb +0 -120
- data/spec/api/filter_api_spec.rb +0 -141
- data/spec/api/info_api_spec.rb +0 -59
- data/spec/api/nsfw_api_spec.rb +0 -47
- data/spec/api/recognize_api_spec.rb +0 -133
- data/spec/api/resize_api_spec.rb +0 -63
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- data/spec/models/age_detection_result_spec.rb +0 -54
- data/spec/models/color_result_spec.rb +0 -54
- data/spec/models/detected_license_plate_spec.rb +0 -78
- data/spec/models/detected_object_spec.rb +0 -72
- data/spec/models/dominant_color_result_spec.rb +0 -48
- data/spec/models/draw_polygon_instance_spec.rb +0 -60
- data/spec/models/draw_polygon_request_spec.rb +0 -54
- data/spec/models/draw_rectangle_instance_spec.rb +0 -78
- data/spec/models/draw_rectangle_request_spec.rb +0 -54
- data/spec/models/draw_text_instance_spec.rb +0 -84
- data/spec/models/draw_text_request_spec.rb +0 -54
- data/spec/models/face_compare_response_spec.rb +0 -60
- data/spec/models/face_locate_response_spec.rb +0 -60
- data/spec/models/face_locate_with_landmarks_response_spec.rb +0 -60
- data/spec/models/face_match_spec.rb +0 -72
- data/spec/models/face_point_spec.rb +0 -48
- data/spec/models/face_spec.rb +0 -60
- data/spec/models/face_with_landmarks_spec.rb +0 -114
- data/spec/models/find_symbol_result_spec.rb +0 -72
- data/spec/models/fine_text_detection_result_spec.rb +0 -54
- data/spec/models/fine_text_item_spec.rb +0 -102
- data/spec/models/gender_detection_result_spec.rb +0 -54
- data/spec/models/image_description_response_spec.rb +0 -60
- data/spec/models/image_metadata_exif_value_spec.rb +0 -54
- data/spec/models/image_metadata_spec.rb +0 -96
- data/spec/models/nsfw_result_spec.rb +0 -54
- data/spec/models/object_detection_result_spec.rb +0 -54
- data/spec/models/person_with_age_spec.rb +0 -60
- data/spec/models/person_with_gender_spec.rb +0 -54
- data/spec/models/polygon_point_spec.rb +0 -48
- data/spec/models/recognition_outcome_spec.rb +0 -48
- data/spec/models/text_detection_result_spec.rb +0 -54
- data/spec/models/text_item_spec.rb +0 -60
- data/spec/models/vehicle_license_plate_detection_result_spec.rb +0 -54
- data/spec/spec_helper.rb +0 -111
data/docs/FindSymbolResult.md
DELETED
@@ -1,13 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::FindSymbolResult
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
-
**match_score** | **Float** | Score between 0.0 and 1.0 that measures how closely the symbol matched; scores above 0.2 are good | [optional]
|
8
|
-
**x_left** | **Integer** | X location of the left edge of the found location in pixels | [optional]
|
9
|
-
**y_top** | **Integer** | Y location of the top edge of the found location in pixels | [optional]
|
10
|
-
**width** | **Integer** | Width of the found location in pixels | [optional]
|
11
|
-
**height** | **Integer** | Height of the found location in pixels | [optional]
|
12
|
-
|
13
|
-
|
@@ -1,10 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::FineTextDetectionResult
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
-
**text_items** | [**Array<FineTextItem>**](FineTextItem.md) | Text items found in the input image | [optional]
|
8
|
-
**text_items_count** | **Integer** | Count of text items found in the input image | [optional]
|
9
|
-
|
10
|
-
|
data/docs/FineTextItem.md
DELETED
@@ -1,18 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::FineTextItem
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**top_left_x** | **Integer** | X coordinate of the top/left text location; 0 represents the left edge of the input image | [optional]
|
7
|
-
**top_left_y** | **Integer** | Y coordinate of the top/left text location; 0 represents the top edge of the input image | [optional]
|
8
|
-
**top_right_x** | **Integer** | X coordinate of the top/right text location; 0 represents the left edge of the input image | [optional]
|
9
|
-
**top_right_y** | **Integer** | Y coordinate of the top/right text location; 0 represents the top edge of the input image | [optional]
|
10
|
-
**bottom_left_x** | **Integer** | X coordinate of the bottom/left text location; 0 represents the left edge of the input image | [optional]
|
11
|
-
**bottom_left_y** | **Integer** | Y coordinate of the bottom/left text location; 0 represents the top edge of the input image | [optional]
|
12
|
-
**bottom_right_x** | **Integer** | X coordinate of the bottom/right text location; 0 represents the left edge of the input image | [optional]
|
13
|
-
**bottom_right_y** | **Integer** | Y coordinate of the bottom/right text location; 0 represents the top edge of the input image | [optional]
|
14
|
-
**width** | **Integer** | Width in pixels of the text | [optional]
|
15
|
-
**height** | **Integer** | Height in pixels of the text | [optional]
|
16
|
-
**angle** | **Float** | Rotation Angle in radians of the text | [optional]
|
17
|
-
|
18
|
-
|
@@ -1,10 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::GenderDetectionResult
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
|
7
|
-
**person_with_gender** | [**Array<PersonWithGender>**](PersonWithGender.md) | People in the image annotated with gender information | [optional]
|
8
|
-
**people_identified** | **Integer** | Number of people identified in the image with a gender | [optional]
|
9
|
-
|
10
|
-
|
@@ -1,11 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::ImageDescriptionResponse
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**successful** | **BOOLEAN** | Was the image processed successfully? | [optional]
|
7
|
-
**highconfidence** | **BOOLEAN** | Is the resulting best outcome recognition a high confidence outcome? | [optional]
|
8
|
-
**best_outcome** | [**RecognitionOutcome**](RecognitionOutcome.md) | The best Machine Learning outcome | [optional]
|
9
|
-
**runner_up_outcome** | [**RecognitionOutcome**](RecognitionOutcome.md) | Best backup (\"runner up\") Machine Learning outcome | [optional]
|
10
|
-
|
11
|
-
|
data/docs/ImageMetadata.md
DELETED
@@ -1,17 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::ImageMetadata
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
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]
|
8
|
-
**file_format** | **String** | File format of the image | [optional]
|
9
|
-
**width** | **Integer** | Width of the image in pixels | [optional]
|
10
|
-
**height** | **Integer** | Height of the image in pixels | [optional]
|
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]
|
13
|
-
**color_space** | **String** | Color space of the image | [optional]
|
14
|
-
**exif_profile_name** | **String** | Name of the EXIF profile used | [optional]
|
15
|
-
**exif_values** | [**Array<ImageMetadataExifValue>**](ImageMetadataExifValue.md) | EXIF tags and values embedded in the image | [optional]
|
16
|
-
|
17
|
-
|
@@ -1,10 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::ImageMetadataExifValue
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**tag** | **String** | Tag name for the EXIF value | [optional]
|
7
|
-
**data_type** | **String** | Date type of the EXIF value | [optional]
|
8
|
-
**data_value** | **String** | Value, formatted as a string of the EXIF value | [optional]
|
9
|
-
|
10
|
-
|
data/docs/InfoApi.md
DELETED
@@ -1,118 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::InfoApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**info_get_dominant_color**](InfoApi.md#info_get_dominant_color) | **POST** /image/get-info/dominant-color | Returns the dominant colors of the image
|
8
|
-
[**info_get_metadata**](InfoApi.md#info_get_metadata) | **POST** /image/get-info/metadata | Returns the image metadata including EXIF and resolution
|
9
|
-
|
10
|
-
|
11
|
-
# **info_get_dominant_color**
|
12
|
-
> DominantColorResult info_get_dominant_color(image_file)
|
13
|
-
|
14
|
-
Returns the dominant colors of the image
|
15
|
-
|
16
|
-
Uses advanced image processing to extract the top 5 dominant colors in the image, returned in the order of dominance with the most-dominant color first. These are the primary perceptual colors used in the image as perceived by a viewer.
|
17
|
-
|
18
|
-
### Example
|
19
|
-
```ruby
|
20
|
-
# load the gem
|
21
|
-
require 'cloudmersive-image-recognition-api-client'
|
22
|
-
# setup authorization
|
23
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
24
|
-
# Configure API key authorization: Apikey
|
25
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
26
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
28
|
-
end
|
29
|
-
|
30
|
-
api_instance = CloudmersiveImageRecognitionApiClient::InfoApi.new
|
31
|
-
|
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
|
-
|
34
|
-
|
35
|
-
begin
|
36
|
-
#Returns the dominant colors of the image
|
37
|
-
result = api_instance.info_get_dominant_color(image_file)
|
38
|
-
p result
|
39
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
40
|
-
puts "Exception when calling InfoApi->info_get_dominant_color: #{e}"
|
41
|
-
end
|
42
|
-
```
|
43
|
-
|
44
|
-
### Parameters
|
45
|
-
|
46
|
-
Name | Type | Description | Notes
|
47
|
-
------------- | ------------- | ------------- | -------------
|
48
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
49
|
-
|
50
|
-
### Return type
|
51
|
-
|
52
|
-
[**DominantColorResult**](DominantColorResult.md)
|
53
|
-
|
54
|
-
### Authorization
|
55
|
-
|
56
|
-
[Apikey](../README.md#Apikey)
|
57
|
-
|
58
|
-
### HTTP request headers
|
59
|
-
|
60
|
-
- **Content-Type**: multipart/form-data
|
61
|
-
- **Accept**: application/json, text/json, application/xml, text/xml
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
# **info_get_metadata**
|
66
|
-
> ImageMetadata info_get_metadata(image_file)
|
67
|
-
|
68
|
-
Returns the image metadata including EXIF and resolution
|
69
|
-
|
70
|
-
Returns the metadata information on the image, including file type, EXIF (if available), and resolution.
|
71
|
-
|
72
|
-
### Example
|
73
|
-
```ruby
|
74
|
-
# load the gem
|
75
|
-
require 'cloudmersive-image-recognition-api-client'
|
76
|
-
# setup authorization
|
77
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
78
|
-
# Configure API key authorization: Apikey
|
79
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
80
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
81
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
82
|
-
end
|
83
|
-
|
84
|
-
api_instance = CloudmersiveImageRecognitionApiClient::InfoApi.new
|
85
|
-
|
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
|
-
|
88
|
-
|
89
|
-
begin
|
90
|
-
#Returns the image metadata including EXIF and resolution
|
91
|
-
result = api_instance.info_get_metadata(image_file)
|
92
|
-
p result
|
93
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
94
|
-
puts "Exception when calling InfoApi->info_get_metadata: #{e}"
|
95
|
-
end
|
96
|
-
```
|
97
|
-
|
98
|
-
### Parameters
|
99
|
-
|
100
|
-
Name | Type | Description | Notes
|
101
|
-
------------- | ------------- | ------------- | -------------
|
102
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
103
|
-
|
104
|
-
### Return type
|
105
|
-
|
106
|
-
[**ImageMetadata**](ImageMetadata.md)
|
107
|
-
|
108
|
-
### Authorization
|
109
|
-
|
110
|
-
[Apikey](../README.md#Apikey)
|
111
|
-
|
112
|
-
### HTTP request headers
|
113
|
-
|
114
|
-
- **Content-Type**: multipart/form-data
|
115
|
-
- **Accept**: application/json, text/json, application/xml, text/xml
|
116
|
-
|
117
|
-
|
118
|
-
|
data/docs/NsfwApi.md
DELETED
@@ -1,63 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::NsfwApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**nsfw_classify**](NsfwApi.md#nsfw_classify) | **POST** /image/nsfw/classify | Not safe for work NSFW racy content classification
|
8
|
-
|
9
|
-
|
10
|
-
# **nsfw_classify**
|
11
|
-
> NsfwResult nsfw_classify(image_file)
|
12
|
-
|
13
|
-
Not safe for work NSFW racy content classification
|
14
|
-
|
15
|
-
Classify an image into Not Safe For Work (NSFW)/Porn/Racy content and Safe Content.
|
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::NsfwApi.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
|
-
#Not safe for work NSFW racy content classification
|
36
|
-
result = api_instance.nsfw_classify(image_file)
|
37
|
-
p result
|
38
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
39
|
-
puts "Exception when calling NsfwApi->nsfw_classify: #{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
|
-
[**NsfwResult**](NsfwResult.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/json, text/json, application/xml, text/xml
|
61
|
-
|
62
|
-
|
63
|
-
|
data/docs/NsfwResult.md
DELETED
@@ -1,10 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::NsfwResult
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**successful** | **BOOLEAN** | True if the classification was successfully run, false otherwise | [optional]
|
7
|
-
**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]
|
8
|
-
**classification_outcome** | **String** | Classification result into four categories: SafeContent_HighProbability, UnsafeContent_HighProbability, RacyContent, SafeContent_ModerateProbability | [optional]
|
9
|
-
|
10
|
-
|
@@ -1,10 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::ObjectDetectionResult
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**successful** | **BOOLEAN** | Was the image processed successfully? | [optional]
|
7
|
-
**objects** | [**Array<DetectedObject>**](DetectedObject.md) | Array of objects detected in the scene | [optional]
|
8
|
-
**object_count** | **Integer** | Number of objects detected in the scene | [optional]
|
9
|
-
|
10
|
-
|
data/docs/PersonWithAge.md
DELETED
@@ -1,11 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::PersonWithAge
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**face_location** | [**Face**](Face.md) | Location and other information about the person's face corresponding to this age classification | [optional]
|
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
|
-
**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** | | [optional]
|
10
|
-
|
11
|
-
|
data/docs/PersonWithGender.md
DELETED
@@ -1,10 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::PersonWithGender
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**face_location** | [**Face**](Face.md) | Location and other information about the person's face corresponding to this age classification | [optional]
|
7
|
-
**gender_classification_confidence** | **Float** | Confidence level of gender classification; possible values are between 0.0 and 1.0; higher is better, with values &gt; 0.50 being high confidence results | [optional]
|
8
|
-
**gender_class** | **String** | The person's identified gender; possible values are \"Male\", \"Female\" and \"Unknown\" | [optional]
|
9
|
-
|
10
|
-
|
data/docs/PolygonPoint.md
DELETED
@@ -1,9 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::PolygonPoint
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**x** | **Float** | X location in pixels of this point in the polygon | [optional]
|
7
|
-
**y** | **Float** | Y location in pixels of this point in the polygon | [optional]
|
8
|
-
|
9
|
-
|
data/docs/RecognitionOutcome.md
DELETED
@@ -1,9 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::RecognitionOutcome
|
2
|
-
|
3
|
-
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**confidence_score** | **Float** | Scores closer to 1 are better than scores closer to 0 | [optional]
|
7
|
-
**description** | **String** | English language description of the image | [optional]
|
8
|
-
|
9
|
-
|
data/docs/RecognizeApi.md
DELETED
@@ -1,455 +0,0 @@
|
|
1
|
-
# CloudmersiveImageRecognitionApiClient::RecognizeApi
|
2
|
-
|
3
|
-
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**recognize_describe**](RecognizeApi.md#recognize_describe) | **POST** /image/recognize/describe | Describe an image in natural language
|
8
|
-
[**recognize_detect_and_unskew_document**](RecognizeApi.md#recognize_detect_and_unskew_document) | **POST** /image/recognize/detect-document/unskew | Detect and unskew a photo of a document
|
9
|
-
[**recognize_detect_objects**](RecognizeApi.md#recognize_detect_objects) | **POST** /image/recognize/detect-objects | Detect objects including types and locations in an image
|
10
|
-
[**recognize_detect_people**](RecognizeApi.md#recognize_detect_people) | **POST** /image/recognize/detect-people | Detect people including locations in an image
|
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
|
-
[**recognize_detect_text_large**](RecognizeApi.md#recognize_detect_text_large) | **POST** /image/recognize/detect-text/large | Detect large text in a photo
|
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
|
14
|
-
[**recognize_find_symbol**](RecognizeApi.md#recognize_find_symbol) | **POST** /image/recognize/find/symbol | Find the location of a symbol in an image
|
15
|
-
|
16
|
-
|
17
|
-
# **recognize_describe**
|
18
|
-
> ImageDescriptionResponse recognize_describe(image_file)
|
19
|
-
|
20
|
-
Describe an image in natural language
|
21
|
-
|
22
|
-
Generate an English language text description of the image as a sentence.
|
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::RecognizeApi.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
|
-
#Describe an image in natural language
|
43
|
-
result = api_instance.recognize_describe(image_file)
|
44
|
-
p result
|
45
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
46
|
-
puts "Exception when calling RecognizeApi->recognize_describe: #{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
|
-
[**ImageDescriptionResponse**](ImageDescriptionResponse.md)
|
59
|
-
|
60
|
-
### Authorization
|
61
|
-
|
62
|
-
[Apikey](../README.md#Apikey)
|
63
|
-
|
64
|
-
### HTTP request headers
|
65
|
-
|
66
|
-
- **Content-Type**: multipart/form-data
|
67
|
-
- **Accept**: application/json, text/json, application/xml, text/xml
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
# **recognize_detect_and_unskew_document**
|
72
|
-
> String recognize_detect_and_unskew_document(image_file, opts)
|
73
|
-
|
74
|
-
Detect and unskew a photo of a document
|
75
|
-
|
76
|
-
Detect and unskew a photo of a document (e.g. taken on a cell phone) into a perfectly square image. Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.
|
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::RecognizeApi.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
|
-
opts = {
|
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
|
-
}
|
97
|
-
|
98
|
-
begin
|
99
|
-
#Detect and unskew a photo of a document
|
100
|
-
result = api_instance.recognize_detect_and_unskew_document(image_file, opts)
|
101
|
-
p result
|
102
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
103
|
-
puts "Exception when calling RecognizeApi->recognize_detect_and_unskew_document: #{e}"
|
104
|
-
end
|
105
|
-
```
|
106
|
-
|
107
|
-
### Parameters
|
108
|
-
|
109
|
-
Name | Type | Description | Notes
|
110
|
-
------------- | ------------- | ------------- | -------------
|
111
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
112
|
-
**post_processing_effect** | **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). | [optional]
|
113
|
-
|
114
|
-
### Return type
|
115
|
-
|
116
|
-
**String**
|
117
|
-
|
118
|
-
### Authorization
|
119
|
-
|
120
|
-
[Apikey](../README.md#Apikey)
|
121
|
-
|
122
|
-
### HTTP request headers
|
123
|
-
|
124
|
-
- **Content-Type**: multipart/form-data
|
125
|
-
- **Accept**: application/json, text/json, application/xml, text/xml
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
# **recognize_detect_objects**
|
130
|
-
> ObjectDetectionResult recognize_detect_objects(image_file)
|
131
|
-
|
132
|
-
Detect objects including types and locations in an image
|
133
|
-
|
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
|
-
|
136
|
-
### Example
|
137
|
-
```ruby
|
138
|
-
# load the gem
|
139
|
-
require 'cloudmersive-image-recognition-api-client'
|
140
|
-
# setup authorization
|
141
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
142
|
-
# Configure API key authorization: Apikey
|
143
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
144
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
145
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
146
|
-
end
|
147
|
-
|
148
|
-
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
149
|
-
|
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
|
-
|
152
|
-
|
153
|
-
begin
|
154
|
-
#Detect objects including types and locations in an image
|
155
|
-
result = api_instance.recognize_detect_objects(image_file)
|
156
|
-
p result
|
157
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
158
|
-
puts "Exception when calling RecognizeApi->recognize_detect_objects: #{e}"
|
159
|
-
end
|
160
|
-
```
|
161
|
-
|
162
|
-
### Parameters
|
163
|
-
|
164
|
-
Name | Type | Description | Notes
|
165
|
-
------------- | ------------- | ------------- | -------------
|
166
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
167
|
-
|
168
|
-
### Return type
|
169
|
-
|
170
|
-
[**ObjectDetectionResult**](ObjectDetectionResult.md)
|
171
|
-
|
172
|
-
### Authorization
|
173
|
-
|
174
|
-
[Apikey](../README.md#Apikey)
|
175
|
-
|
176
|
-
### HTTP request headers
|
177
|
-
|
178
|
-
- **Content-Type**: multipart/form-data
|
179
|
-
- **Accept**: application/json, text/json, application/xml, text/xml
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
# **recognize_detect_people**
|
184
|
-
> ObjectDetectionResult recognize_detect_people(image_file)
|
185
|
-
|
186
|
-
Detect people including locations in an image
|
187
|
-
|
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
|
-
|
190
|
-
### Example
|
191
|
-
```ruby
|
192
|
-
# load the gem
|
193
|
-
require 'cloudmersive-image-recognition-api-client'
|
194
|
-
# setup authorization
|
195
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
196
|
-
# Configure API key authorization: Apikey
|
197
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
198
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
199
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
200
|
-
end
|
201
|
-
|
202
|
-
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
203
|
-
|
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
|
-
|
206
|
-
|
207
|
-
begin
|
208
|
-
#Detect people including locations in an image
|
209
|
-
result = api_instance.recognize_detect_people(image_file)
|
210
|
-
p result
|
211
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
212
|
-
puts "Exception when calling RecognizeApi->recognize_detect_people: #{e}"
|
213
|
-
end
|
214
|
-
```
|
215
|
-
|
216
|
-
### Parameters
|
217
|
-
|
218
|
-
Name | Type | Description | Notes
|
219
|
-
------------- | ------------- | ------------- | -------------
|
220
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
221
|
-
|
222
|
-
### Return type
|
223
|
-
|
224
|
-
[**ObjectDetectionResult**](ObjectDetectionResult.md)
|
225
|
-
|
226
|
-
### Authorization
|
227
|
-
|
228
|
-
[Apikey](../README.md#Apikey)
|
229
|
-
|
230
|
-
### HTTP request headers
|
231
|
-
|
232
|
-
- **Content-Type**: multipart/form-data
|
233
|
-
- **Accept**: application/json, text/json, application/xml, text/xml
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
# **recognize_detect_text_fine**
|
238
|
-
> FineTextDetectionResult recognize_detect_text_fine(image_file)
|
239
|
-
|
240
|
-
Detect fine text in a photo of a document
|
241
|
-
|
242
|
-
Identify the position, and size of small/fine text within a photograph of a document. Identify the location of small text in a photo - such as words and other forms of high density text. Can be used on a scan of a document or a photograph (e.g. smartphone camera) of a document, page or receipt. For OCR purposes - please see our Deep Learning OCR APIs.
|
243
|
-
|
244
|
-
### Example
|
245
|
-
```ruby
|
246
|
-
# load the gem
|
247
|
-
require 'cloudmersive-image-recognition-api-client'
|
248
|
-
# setup authorization
|
249
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
250
|
-
# Configure API key authorization: Apikey
|
251
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
252
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
253
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
254
|
-
end
|
255
|
-
|
256
|
-
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
257
|
-
|
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
|
-
|
260
|
-
|
261
|
-
begin
|
262
|
-
#Detect fine text in a photo of a document
|
263
|
-
result = api_instance.recognize_detect_text_fine(image_file)
|
264
|
-
p result
|
265
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
266
|
-
puts "Exception when calling RecognizeApi->recognize_detect_text_fine: #{e}"
|
267
|
-
end
|
268
|
-
```
|
269
|
-
|
270
|
-
### Parameters
|
271
|
-
|
272
|
-
Name | Type | Description | Notes
|
273
|
-
------------- | ------------- | ------------- | -------------
|
274
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
275
|
-
|
276
|
-
### Return type
|
277
|
-
|
278
|
-
[**FineTextDetectionResult**](FineTextDetectionResult.md)
|
279
|
-
|
280
|
-
### Authorization
|
281
|
-
|
282
|
-
[Apikey](../README.md#Apikey)
|
283
|
-
|
284
|
-
### HTTP request headers
|
285
|
-
|
286
|
-
- **Content-Type**: multipart/form-data
|
287
|
-
- **Accept**: application/json, text/json, application/xml, text/xml
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
# **recognize_detect_text_large**
|
292
|
-
> TextDetectionResult recognize_detect_text_large(image_file)
|
293
|
-
|
294
|
-
Detect large text in a photo
|
295
|
-
|
296
|
-
Identify the position, and size of large text within a photograph. Identify the location of large text in a photo - such as signs, titles, etc. and other forms of large, low-density text. Not suitable for high-density text (e.g. scans of documents, receipts, etc.) for OCR purposes - for OCR, please see our Deep Learning OCR APIs.
|
297
|
-
|
298
|
-
### Example
|
299
|
-
```ruby
|
300
|
-
# load the gem
|
301
|
-
require 'cloudmersive-image-recognition-api-client'
|
302
|
-
# setup authorization
|
303
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
304
|
-
# Configure API key authorization: Apikey
|
305
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
306
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
307
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
308
|
-
end
|
309
|
-
|
310
|
-
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
311
|
-
|
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
|
-
|
314
|
-
|
315
|
-
begin
|
316
|
-
#Detect large text in a photo
|
317
|
-
result = api_instance.recognize_detect_text_large(image_file)
|
318
|
-
p result
|
319
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
320
|
-
puts "Exception when calling RecognizeApi->recognize_detect_text_large: #{e}"
|
321
|
-
end
|
322
|
-
```
|
323
|
-
|
324
|
-
### Parameters
|
325
|
-
|
326
|
-
Name | Type | Description | Notes
|
327
|
-
------------- | ------------- | ------------- | -------------
|
328
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
329
|
-
|
330
|
-
### Return type
|
331
|
-
|
332
|
-
[**TextDetectionResult**](TextDetectionResult.md)
|
333
|
-
|
334
|
-
### Authorization
|
335
|
-
|
336
|
-
[Apikey](../README.md#Apikey)
|
337
|
-
|
338
|
-
### HTTP request headers
|
339
|
-
|
340
|
-
- **Content-Type**: multipart/form-data
|
341
|
-
- **Accept**: application/json, text/json, application/xml, text/xml
|
342
|
-
|
343
|
-
|
344
|
-
|
345
|
-
# **recognize_detect_vehicle_license_plates**
|
346
|
-
> VehicleLicensePlateDetectionResult recognize_detect_vehicle_license_plates(image_file)
|
347
|
-
|
348
|
-
Detect vehicle license plates in an image
|
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.
|
351
|
-
|
352
|
-
### Example
|
353
|
-
```ruby
|
354
|
-
# load the gem
|
355
|
-
require 'cloudmersive-image-recognition-api-client'
|
356
|
-
# setup authorization
|
357
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
358
|
-
# Configure API key authorization: Apikey
|
359
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
360
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
361
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
362
|
-
end
|
363
|
-
|
364
|
-
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
365
|
-
|
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
|
-
|
368
|
-
|
369
|
-
begin
|
370
|
-
#Detect vehicle license plates in an image
|
371
|
-
result = api_instance.recognize_detect_vehicle_license_plates(image_file)
|
372
|
-
p result
|
373
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
374
|
-
puts "Exception when calling RecognizeApi->recognize_detect_vehicle_license_plates: #{e}"
|
375
|
-
end
|
376
|
-
```
|
377
|
-
|
378
|
-
### Parameters
|
379
|
-
|
380
|
-
Name | Type | Description | Notes
|
381
|
-
------------- | ------------- | ------------- | -------------
|
382
|
-
**image_file** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
|
383
|
-
|
384
|
-
### Return type
|
385
|
-
|
386
|
-
[**VehicleLicensePlateDetectionResult**](VehicleLicensePlateDetectionResult.md)
|
387
|
-
|
388
|
-
### Authorization
|
389
|
-
|
390
|
-
[Apikey](../README.md#Apikey)
|
391
|
-
|
392
|
-
### HTTP request headers
|
393
|
-
|
394
|
-
- **Content-Type**: multipart/form-data
|
395
|
-
- **Accept**: application/json, text/json, application/xml, text/xml
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
# **recognize_find_symbol**
|
400
|
-
> FindSymbolResult recognize_find_symbol(input_image, target_image)
|
401
|
-
|
402
|
-
Find the location of a symbol in an image
|
403
|
-
|
404
|
-
Determine if an image contains a symbol, and if so, the location of that symbol in the image.
|
405
|
-
|
406
|
-
### Example
|
407
|
-
```ruby
|
408
|
-
# load the gem
|
409
|
-
require 'cloudmersive-image-recognition-api-client'
|
410
|
-
# setup authorization
|
411
|
-
CloudmersiveImageRecognitionApiClient.configure do |config|
|
412
|
-
# Configure API key authorization: Apikey
|
413
|
-
config.api_key['Apikey'] = 'YOUR API KEY'
|
414
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
415
|
-
#config.api_key_prefix['Apikey'] = 'Bearer'
|
416
|
-
end
|
417
|
-
|
418
|
-
api_instance = CloudmersiveImageRecognitionApiClient::RecognizeApi.new
|
419
|
-
|
420
|
-
input_image = File.new("/path/to/file.txt") # File | Image file to search through for the target image.
|
421
|
-
|
422
|
-
target_image = File.new("/path/to/file.txt") # File | Image to find in the input image.
|
423
|
-
|
424
|
-
|
425
|
-
begin
|
426
|
-
#Find the location of a symbol in an image
|
427
|
-
result = api_instance.recognize_find_symbol(input_image, target_image)
|
428
|
-
p result
|
429
|
-
rescue CloudmersiveImageRecognitionApiClient::ApiError => e
|
430
|
-
puts "Exception when calling RecognizeApi->recognize_find_symbol: #{e}"
|
431
|
-
end
|
432
|
-
```
|
433
|
-
|
434
|
-
### Parameters
|
435
|
-
|
436
|
-
Name | Type | Description | Notes
|
437
|
-
------------- | ------------- | ------------- | -------------
|
438
|
-
**input_image** | **File**| Image file to search through for the target image. |
|
439
|
-
**target_image** | **File**| Image to find in the input image. |
|
440
|
-
|
441
|
-
### Return type
|
442
|
-
|
443
|
-
[**FindSymbolResult**](FindSymbolResult.md)
|
444
|
-
|
445
|
-
### Authorization
|
446
|
-
|
447
|
-
[Apikey](../README.md#Apikey)
|
448
|
-
|
449
|
-
### HTTP request headers
|
450
|
-
|
451
|
-
- **Content-Type**: multipart/form-data
|
452
|
-
- **Accept**: application/json, text/json, application/xml, text/xml
|
453
|
-
|
454
|
-
|
455
|
-
|