Socket
Socket
Sign inDemoInstall

cloudmersive-image-api-client

Package Overview
Dependencies
38
Maintainers
1
Versions
26
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 1.2.2 to 1.2.3

docs/GenderDetectionResult.md

54

docs/FaceApi.md

@@ -11,2 +11,3 @@ # CloudmersiveImageApiClient.FaceApi

[**faceDetectAge**](FaceApi.md#faceDetectAge) | **POST** /image/face/detect-age | Detect the age of people in an image
[**faceDetectGender**](FaceApi.md#faceDetectGender) | **POST** /image/face/detect-gender | Detect the gender of people in an image
[**faceLocate**](FaceApi.md#faceLocate) | **POST** /image/face/locate | Find faces in an image

@@ -231,2 +232,55 @@ [**faceLocateWithLandmarks**](FaceApi.md#faceLocateWithLandmarks) | **POST** /image/face/locate-with-landmarks | Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image

<a name="faceDetectGender"></a>
# **faceDetectGender**
> GenderDetectionResult faceDetectGender(imageFile)
Detect the gender of people in an image
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.
### Example
```javascript
var CloudmersiveImageApiClient = require('cloudmersive-image-api-client');
var defaultClient = CloudmersiveImageApiClient.ApiClient.instance;
// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';
var apiInstance = new CloudmersiveImageApiClient.FaceApi();
var imageFile = "/path/to/file.txt"; // File | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.faceDetectGender(imageFile, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**imageFile** | **File**| Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. |
### Return type
[**GenderDetectionResult**](GenderDetectionResult.md)
### Authorization
[Apikey](../README.md#Apikey)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json, text/json, application/xml, text/xml
<a name="faceLocate"></a>

@@ -233,0 +287,0 @@ # **faceLocate**

1

docs/PersonWithAge.md

@@ -9,3 +9,4 @@ # CloudmersiveImageApiClient.PersonWithAge

**ageClass** | **String** | The person&#39;s age range classification result in years; possible values are \&quot;0-2\&quot;, \&quot;4-6\&quot;, \&quot;8-13\&quot;, \&quot;15-20\&quot;, \&quot;25-32\&quot;, \&quot;38-43\&quot;, \&quot;48-53\&quot;, \&quot;60+\&quot; | [optional]
**age** | **Number** | | [optional]

2

package.json
{
"name": "cloudmersive-image-api-client",
"version": "1.2.2",
"version": "1.2.3",
"description": "Image_Recognition_and_Processing_APIs_let_you_use_Machine_Learning_to_recognize_and_process_images_and_also_perform_useful_image_modification_operations_",

@@ -5,0 +5,0 @@ "license": "Unlicense",

@@ -8,3 +8,3 @@ # cloudmersive-image-api-client

- API version: v1
- Package version: 1.2.2
- Package version: 1.2.3

@@ -143,2 +143,3 @@

*CloudmersiveImageApiClient.FaceApi* | [**faceDetectAge**](docs/FaceApi.md#faceDetectAge) | **POST** /image/face/detect-age | Detect the age of people in an image
*CloudmersiveImageApiClient.FaceApi* | [**faceDetectGender**](docs/FaceApi.md#faceDetectGender) | **POST** /image/face/detect-gender | Detect the gender of people in an image
*CloudmersiveImageApiClient.FaceApi* | [**faceLocate**](docs/FaceApi.md#faceLocate) | **POST** /image/face/locate | Find faces in an image

@@ -177,2 +178,3 @@ *CloudmersiveImageApiClient.FaceApi* | [**faceLocateWithLandmarks**](docs/FaceApi.md#faceLocateWithLandmarks) | **POST** /image/face/locate-with-landmarks | Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image

- [CloudmersiveImageApiClient.FineTextItem](docs/FineTextItem.md)
- [CloudmersiveImageApiClient.GenderDetectionResult](docs/GenderDetectionResult.md)
- [CloudmersiveImageApiClient.ImageDescriptionResponse](docs/ImageDescriptionResponse.md)

@@ -182,2 +184,3 @@ - [CloudmersiveImageApiClient.NsfwResult](docs/NsfwResult.md)

- [CloudmersiveImageApiClient.PersonWithAge](docs/PersonWithAge.md)
- [CloudmersiveImageApiClient.PersonWithGender](docs/PersonWithGender.md)
- [CloudmersiveImageApiClient.PolygonPoint](docs/PolygonPoint.md)

@@ -184,0 +187,0 @@ - [CloudmersiveImageApiClient.RecognitionOutcome](docs/RecognitionOutcome.md)

@@ -36,3 +36,3 @@ /**

* @module api/ArtisticApi
* @version 1.2.2
* @version 1.2.3
*/

@@ -39,0 +39,0 @@

@@ -36,3 +36,3 @@ /**

* @module api/EditApi
* @version 1.2.2
* @version 1.2.3
*/

@@ -39,0 +39,0 @@

@@ -19,6 +19,6 @@ /**

// AMD. Register as an anonymous module.
define(['ApiClient', 'model/AgeDetectionResult', 'model/FaceCompareResponse', 'model/FaceLocateResponse', 'model/FaceLocateWithLandmarksResponse'], factory);
define(['ApiClient', 'model/AgeDetectionResult', 'model/FaceCompareResponse', 'model/FaceLocateResponse', 'model/FaceLocateWithLandmarksResponse', 'model/GenderDetectionResult'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'), require('../model/AgeDetectionResult'), require('../model/FaceCompareResponse'), require('../model/FaceLocateResponse'), require('../model/FaceLocateWithLandmarksResponse'));
module.exports = factory(require('../ApiClient'), require('../model/AgeDetectionResult'), require('../model/FaceCompareResponse'), require('../model/FaceLocateResponse'), require('../model/FaceLocateWithLandmarksResponse'), require('../model/GenderDetectionResult'));
} else {

@@ -29,5 +29,5 @@ // Browser globals (root is window)

}
root.CloudmersiveImageApiClient.FaceApi = factory(root.CloudmersiveImageApiClient.ApiClient, root.CloudmersiveImageApiClient.AgeDetectionResult, root.CloudmersiveImageApiClient.FaceCompareResponse, root.CloudmersiveImageApiClient.FaceLocateResponse, root.CloudmersiveImageApiClient.FaceLocateWithLandmarksResponse);
root.CloudmersiveImageApiClient.FaceApi = factory(root.CloudmersiveImageApiClient.ApiClient, root.CloudmersiveImageApiClient.AgeDetectionResult, root.CloudmersiveImageApiClient.FaceCompareResponse, root.CloudmersiveImageApiClient.FaceLocateResponse, root.CloudmersiveImageApiClient.FaceLocateWithLandmarksResponse, root.CloudmersiveImageApiClient.GenderDetectionResult);
}
}(this, function(ApiClient, AgeDetectionResult, FaceCompareResponse, FaceLocateResponse, FaceLocateWithLandmarksResponse) {
}(this, function(ApiClient, AgeDetectionResult, FaceCompareResponse, FaceLocateResponse, FaceLocateWithLandmarksResponse, GenderDetectionResult) {
'use strict';

@@ -38,3 +38,3 @@

* @module api/FaceApi
* @version 1.2.2
* @version 1.2.3
*/

@@ -253,2 +253,50 @@

/**
* Callback function to receive the result of the faceDetectGender operation.
* @callback module:api/FaceApi~faceDetectGenderCallback
* @param {String} error Error message, if any.
* @param {module:model/GenderDetectionResult} data The data returned by the service call.
* @param {String} response The complete HTTP response.
*/
/**
* Detect the gender of people in an image
* 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.
* @param {File} imageFile Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
* @param {module:api/FaceApi~faceDetectGenderCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link module:model/GenderDetectionResult}
*/
this.faceDetectGender = function(imageFile, callback) {
var postBody = null;
// verify the required parameter 'imageFile' is set
if (imageFile === undefined || imageFile === null) {
throw new Error("Missing the required parameter 'imageFile' when calling faceDetectGender");
}
var pathParams = {
};
var queryParams = {
};
var collectionQueryParams = {
};
var headerParams = {
};
var formParams = {
'imageFile': imageFile
};
var authNames = ['Apikey'];
var contentTypes = ['multipart/form-data'];
var accepts = ['application/json', 'text/json', 'application/xml', 'text/xml'];
var returnType = GenderDetectionResult;
return this.apiClient.callApi(
'/image/face/detect-gender', 'POST',
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType, callback
);
}
/**
* Callback function to receive the result of the faceLocate operation.

@@ -255,0 +303,0 @@ * @callback module:api/FaceApi~faceLocateCallback

@@ -36,3 +36,3 @@ /**

* @module api/NsfwApi
* @version 1.2.2
* @version 1.2.3
*/

@@ -39,0 +39,0 @@

@@ -36,3 +36,3 @@ /**

* @module api/RecognizeApi
* @version 1.2.2
* @version 1.2.3
*/

@@ -39,0 +39,0 @@

@@ -36,3 +36,3 @@ /**

* @module api/ResizeApi
* @version 1.2.2
* @version 1.2.3
*/

@@ -39,0 +39,0 @@

@@ -35,3 +35,3 @@ /**

* @module ApiClient
* @version 1.2.2
* @version 1.2.3
*/

@@ -38,0 +38,0 @@

@@ -19,8 +19,8 @@ /**

// AMD. Register as an anonymous module.
define(['ApiClient', 'model/AgeDetectionResult', 'model/DetectedLicensePlate', 'model/DetectedObject', 'model/DrawPolygonInstance', 'model/DrawPolygonRequest', 'model/DrawRectangleInstance', 'model/DrawRectangleRequest', 'model/DrawTextInstance', 'model/DrawTextRequest', 'model/Face', 'model/FaceCompareResponse', 'model/FaceLocateResponse', 'model/FaceLocateWithLandmarksResponse', 'model/FaceMatch', 'model/FacePoint', 'model/FaceWithLandmarks', 'model/FineTextDetectionResult', 'model/FineTextItem', 'model/ImageDescriptionResponse', 'model/NsfwResult', 'model/ObjectDetectionResult', 'model/PersonWithAge', 'model/PolygonPoint', 'model/RecognitionOutcome', 'model/TextDetectionResult', 'model/TextItem', 'model/VehicleLicensePlateDetectionResult', 'api/ArtisticApi', 'api/EditApi', 'api/FaceApi', 'api/NsfwApi', 'api/RecognizeApi', 'api/ResizeApi'], factory);
define(['ApiClient', 'model/AgeDetectionResult', 'model/DetectedLicensePlate', 'model/DetectedObject', 'model/DrawPolygonInstance', 'model/DrawPolygonRequest', 'model/DrawRectangleInstance', 'model/DrawRectangleRequest', 'model/DrawTextInstance', 'model/DrawTextRequest', 'model/Face', 'model/FaceCompareResponse', 'model/FaceLocateResponse', 'model/FaceLocateWithLandmarksResponse', 'model/FaceMatch', 'model/FacePoint', 'model/FaceWithLandmarks', 'model/FineTextDetectionResult', 'model/FineTextItem', 'model/GenderDetectionResult', 'model/ImageDescriptionResponse', 'model/NsfwResult', 'model/ObjectDetectionResult', 'model/PersonWithAge', 'model/PersonWithGender', 'model/PolygonPoint', 'model/RecognitionOutcome', 'model/TextDetectionResult', 'model/TextItem', 'model/VehicleLicensePlateDetectionResult', 'api/ArtisticApi', 'api/EditApi', 'api/FaceApi', 'api/NsfwApi', 'api/RecognizeApi', 'api/ResizeApi'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('./ApiClient'), require('./model/AgeDetectionResult'), require('./model/DetectedLicensePlate'), require('./model/DetectedObject'), require('./model/DrawPolygonInstance'), require('./model/DrawPolygonRequest'), require('./model/DrawRectangleInstance'), require('./model/DrawRectangleRequest'), require('./model/DrawTextInstance'), require('./model/DrawTextRequest'), require('./model/Face'), require('./model/FaceCompareResponse'), require('./model/FaceLocateResponse'), require('./model/FaceLocateWithLandmarksResponse'), require('./model/FaceMatch'), require('./model/FacePoint'), require('./model/FaceWithLandmarks'), require('./model/FineTextDetectionResult'), require('./model/FineTextItem'), require('./model/ImageDescriptionResponse'), require('./model/NsfwResult'), require('./model/ObjectDetectionResult'), require('./model/PersonWithAge'), require('./model/PolygonPoint'), require('./model/RecognitionOutcome'), require('./model/TextDetectionResult'), require('./model/TextItem'), require('./model/VehicleLicensePlateDetectionResult'), require('./api/ArtisticApi'), require('./api/EditApi'), require('./api/FaceApi'), require('./api/NsfwApi'), require('./api/RecognizeApi'), require('./api/ResizeApi'));
module.exports = factory(require('./ApiClient'), require('./model/AgeDetectionResult'), require('./model/DetectedLicensePlate'), require('./model/DetectedObject'), require('./model/DrawPolygonInstance'), require('./model/DrawPolygonRequest'), require('./model/DrawRectangleInstance'), require('./model/DrawRectangleRequest'), require('./model/DrawTextInstance'), require('./model/DrawTextRequest'), require('./model/Face'), require('./model/FaceCompareResponse'), require('./model/FaceLocateResponse'), require('./model/FaceLocateWithLandmarksResponse'), require('./model/FaceMatch'), require('./model/FacePoint'), require('./model/FaceWithLandmarks'), require('./model/FineTextDetectionResult'), require('./model/FineTextItem'), require('./model/GenderDetectionResult'), require('./model/ImageDescriptionResponse'), require('./model/NsfwResult'), require('./model/ObjectDetectionResult'), require('./model/PersonWithAge'), require('./model/PersonWithGender'), require('./model/PolygonPoint'), require('./model/RecognitionOutcome'), require('./model/TextDetectionResult'), require('./model/TextItem'), require('./model/VehicleLicensePlateDetectionResult'), require('./api/ArtisticApi'), require('./api/EditApi'), require('./api/FaceApi'), require('./api/NsfwApi'), require('./api/RecognizeApi'), require('./api/ResizeApi'));
}
}(function(ApiClient, AgeDetectionResult, DetectedLicensePlate, DetectedObject, DrawPolygonInstance, DrawPolygonRequest, DrawRectangleInstance, DrawRectangleRequest, DrawTextInstance, DrawTextRequest, Face, FaceCompareResponse, FaceLocateResponse, FaceLocateWithLandmarksResponse, FaceMatch, FacePoint, FaceWithLandmarks, FineTextDetectionResult, FineTextItem, ImageDescriptionResponse, NsfwResult, ObjectDetectionResult, PersonWithAge, PolygonPoint, RecognitionOutcome, TextDetectionResult, TextItem, VehicleLicensePlateDetectionResult, ArtisticApi, EditApi, FaceApi, NsfwApi, RecognizeApi, ResizeApi) {
}(function(ApiClient, AgeDetectionResult, DetectedLicensePlate, DetectedObject, DrawPolygonInstance, DrawPolygonRequest, DrawRectangleInstance, DrawRectangleRequest, DrawTextInstance, DrawTextRequest, Face, FaceCompareResponse, FaceLocateResponse, FaceLocateWithLandmarksResponse, FaceMatch, FacePoint, FaceWithLandmarks, FineTextDetectionResult, FineTextItem, GenderDetectionResult, ImageDescriptionResponse, NsfwResult, ObjectDetectionResult, PersonWithAge, PersonWithGender, PolygonPoint, RecognitionOutcome, TextDetectionResult, TextItem, VehicleLicensePlateDetectionResult, ArtisticApi, EditApi, FaceApi, NsfwApi, RecognizeApi, ResizeApi) {
'use strict';

@@ -57,3 +57,3 @@

* @module index
* @version 1.2.2
* @version 1.2.3
*/

@@ -157,2 +157,7 @@ var exports = {

/**
* The GenderDetectionResult model constructor.
* @property {module:model/GenderDetectionResult}
*/
GenderDetectionResult: GenderDetectionResult,
/**
* The ImageDescriptionResponse model constructor.

@@ -178,2 +183,7 @@ * @property {module:model/ImageDescriptionResponse}

/**
* The PersonWithGender model constructor.
* @property {module:model/PersonWithGender}
*/
PersonWithGender: PersonWithGender,
/**
* The PolygonPoint model constructor.

@@ -180,0 +190,0 @@ * @property {module:model/PolygonPoint}

@@ -39,3 +39,3 @@ /**

* @module model/AgeDetectionResult
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/DetectedLicensePlate
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/DetectedObject
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/DrawPolygonInstance
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/DrawPolygonRequest
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/DrawRectangleInstance
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/DrawRectangleRequest
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/DrawTextInstance
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/DrawTextRequest
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/Face
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/FaceCompareResponse
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/FaceLocateResponse
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/FaceLocateWithLandmarksResponse
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/FaceMatch
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/FacePoint
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/FaceWithLandmarks
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/FineTextDetectionResult
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/FineTextItem
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/ImageDescriptionResponse
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/NsfwResult
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/ObjectDetectionResult
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/PersonWithAge
* @version 1.2.2
* @version 1.2.3
*/

@@ -55,2 +55,3 @@

};

@@ -78,2 +79,5 @@

}
if (data.hasOwnProperty('Age')) {
obj['Age'] = ApiClient.convertToType(data['Age'], 'Number');
}
}

@@ -98,2 +102,6 @@ return obj;

exports.prototype['AgeClass'] = undefined;
/**
* @member {Number} Age
*/
exports.prototype['Age'] = undefined;

@@ -100,0 +108,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/PolygonPoint
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/RecognitionOutcome
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/TextDetectionResult
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/TextItem
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -39,3 +39,3 @@ /**

* @module model/VehicleLicensePlateDetectionResult
* @version 1.2.2
* @version 1.2.3
*/

@@ -42,0 +42,0 @@

@@ -93,2 +93,12 @@ /**

});
describe('faceDetectGender', function() {
it('should call faceDetectGender successfully', function(done) {
//uncomment below and update the code to test faceDetectGender
//instance.faceDetectGender(function(error) {
// if (error) throw error;
//expect().to.be();
//});
done();
});
});
describe('faceLocate', function() {

@@ -95,0 +105,0 @@ it('should call faceLocate successfully', function(done) {

@@ -77,4 +77,10 @@ /**

it('should have the property age (base name: "Age")', function() {
// uncomment below and update the code to test the property age
//var instane = new CloudmersiveImageApiClient.PersonWithAge();
//expect(instance).to.be();
});
});
}));
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc