Socket
Socket
Sign inDemoInstall

cloudmersive-image-api-client

Package Overview
Dependencies
Maintainers
1
Versions
26
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

cloudmersive-image-api-client - npm Package Compare versions

Comparing version 1.1.4 to 1.1.5

docs/FaceCompareResponse.md

111

docs/FaceApi.md

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

------------- | ------------- | -------------
[**faceCompare**](FaceApi.md#faceCompare) | **POST** /image/face/compare-and-match | Compare and match faces
[**faceCropFirst**](FaceApi.md#faceCropFirst) | **POST** /image/face/crop/first | Crop image to face (square)

@@ -12,4 +13,61 @@ [**faceCropFirstRound**](FaceApi.md#faceCropFirstRound) | **POST** /image/face/crop/first/round | Crop image to face (round)

[**faceLocate**](FaceApi.md#faceLocate) | **POST** /image/face/locate | Find faces in an image
[**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="faceCompare"></a>
# **faceCompare**
> FaceCompareResponse faceCompare(inputImage, matchFace)
Compare and match faces
Find the faces in an input image, and compare against a reference image to determine if there is a match against the face in the reference image. The reference image (second parameter) should contain exactly one face.
### 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 inputImage = "/path/to/file.txt"; // File | Image file to perform the operation on; this image can contain one or more faces which will be matched against face provided in the second image. Common file formats such as PNG, JPEG are supported.
var matchFace = "/path/to/file.txt"; // File | Image of a single face to compare and match against.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.faceCompare(inputImage, matchFace, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**inputImage** | **File**| Image file to perform the operation on; this image can contain one or more faces which will be matched against face provided in the second image. Common file formats such as PNG, JPEG are supported. |
**matchFace** | **File**| Image of a single face to compare and match against. |
### Return type
[**FaceCompareResponse**](FaceCompareResponse.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="faceCropFirst"></a>

@@ -227,1 +285,54 @@ # **faceCropFirst**

<a name="faceLocateWithLandmarks"></a>
# **faceLocateWithLandmarks**
> FaceLocateWithLandmarksResponse faceLocateWithLandmarks(imageFile)
Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image
Locate the positions of all faces in an image, along with the eyes, eye brows, nose and mouth components of each
### 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.faceLocateWithLandmarks(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
[**FaceLocateWithLandmarksResponse**](FaceLocateWithLandmarksResponse.md)
### Authorization
[Apikey](../README.md#Apikey)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json, text/json, application/xml, text/xml

2

package.json
{
"name": "cloudmersive-image-api-client",
"version": "1.1.4",
"version": "1.1.5",
"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.1.4
- Package version: 1.1.5

@@ -135,2 +135,3 @@

*CloudmersiveImageApiClient.EditApi* | [**editDrawText**](docs/EditApi.md#editDrawText) | **POST** /image/edit/draw/text | Draw text onto an image
*CloudmersiveImageApiClient.FaceApi* | [**faceCompare**](docs/FaceApi.md#faceCompare) | **POST** /image/face/compare-and-match | Compare and match faces
*CloudmersiveImageApiClient.FaceApi* | [**faceCropFirst**](docs/FaceApi.md#faceCropFirst) | **POST** /image/face/crop/first | Crop image to face (square)

@@ -140,2 +141,3 @@ *CloudmersiveImageApiClient.FaceApi* | [**faceCropFirstRound**](docs/FaceApi.md#faceCropFirstRound) | **POST** /image/face/crop/first/round | Crop image to face (round)

*CloudmersiveImageApiClient.FaceApi* | [**faceLocate**](docs/FaceApi.md#faceLocate) | **POST** /image/face/locate | Find faces in an image
*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.NsfwApi* | [**nsfwClassify**](docs/NsfwApi.md#nsfwClassify) | **POST** /image/nsfw/classify | Not safe for work (NSFW) racy content classification

@@ -160,3 +162,8 @@ *CloudmersiveImageApiClient.RecognizeApi* | [**recognizeDescribe**](docs/RecognizeApi.md#recognizeDescribe) | **POST** /image/recognize/describe | Describe an image in natural language

- [CloudmersiveImageApiClient.Face](docs/Face.md)
- [CloudmersiveImageApiClient.FaceCompareResponse](docs/FaceCompareResponse.md)
- [CloudmersiveImageApiClient.FaceLocateResponse](docs/FaceLocateResponse.md)
- [CloudmersiveImageApiClient.FaceLocateWithLandmarksResponse](docs/FaceLocateWithLandmarksResponse.md)
- [CloudmersiveImageApiClient.FaceMatch](docs/FaceMatch.md)
- [CloudmersiveImageApiClient.FacePoint](docs/FacePoint.md)
- [CloudmersiveImageApiClient.FaceWithLandmarks](docs/FaceWithLandmarks.md)
- [CloudmersiveImageApiClient.ImageDescriptionResponse](docs/ImageDescriptionResponse.md)

@@ -163,0 +170,0 @@ - [CloudmersiveImageApiClient.NsfwResult](docs/NsfwResult.md)

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

* @module api/ArtisticApi
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module api/EditApi
* @version 1.1.4
* @version 1.1.5
*/

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

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

// AMD. Register as an anonymous module.
define(['ApiClient', 'model/AgeDetectionResult', 'model/FaceLocateResponse'], factory);
define(['ApiClient', 'model/AgeDetectionResult', 'model/FaceCompareResponse', 'model/FaceLocateResponse', 'model/FaceLocateWithLandmarksResponse'], 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/FaceLocateResponse'));
module.exports = factory(require('../ApiClient'), require('../model/AgeDetectionResult'), require('../model/FaceCompareResponse'), require('../model/FaceLocateResponse'), require('../model/FaceLocateWithLandmarksResponse'));
} else {

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

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

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

* @module api/FaceApi
* @version 1.1.4
* @version 1.1.5
*/

@@ -54,2 +54,57 @@

/**
* Callback function to receive the result of the faceCompare operation.
* @callback module:api/FaceApi~faceCompareCallback
* @param {String} error Error message, if any.
* @param {module:model/FaceCompareResponse} data The data returned by the service call.
* @param {String} response The complete HTTP response.
*/
/**
* Compare and match faces
* Find the faces in an input image, and compare against a reference image to determine if there is a match against the face in the reference image. The reference image (second parameter) should contain exactly one face.
* @param {File} inputImage Image file to perform the operation on; this image can contain one or more faces which will be matched against face provided in the second image. Common file formats such as PNG, JPEG are supported.
* @param {File} matchFace Image of a single face to compare and match against.
* @param {module:api/FaceApi~faceCompareCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link module:model/FaceCompareResponse}
*/
this.faceCompare = function(inputImage, matchFace, callback) {
var postBody = null;
// verify the required parameter 'inputImage' is set
if (inputImage === undefined || inputImage === null) {
throw new Error("Missing the required parameter 'inputImage' when calling faceCompare");
}
// verify the required parameter 'matchFace' is set
if (matchFace === undefined || matchFace === null) {
throw new Error("Missing the required parameter 'matchFace' when calling faceCompare");
}
var pathParams = {
};
var queryParams = {
};
var collectionQueryParams = {
};
var headerParams = {
};
var formParams = {
'inputImage': inputImage,
'matchFace': matchFace
};
var authNames = ['Apikey'];
var contentTypes = ['multipart/form-data'];
var accepts = ['application/json', 'text/json', 'application/xml', 'text/xml'];
var returnType = FaceCompareResponse;
return this.apiClient.callApi(
'/image/face/compare-and-match', 'POST',
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType, callback
);
}
/**
* Callback function to receive the result of the faceCropFirst operation.

@@ -245,2 +300,50 @@ * @callback module:api/FaceApi~faceCropFirstCallback

}
/**
* Callback function to receive the result of the faceLocateWithLandmarks operation.
* @callback module:api/FaceApi~faceLocateWithLandmarksCallback
* @param {String} error Error message, if any.
* @param {module:model/FaceLocateWithLandmarksResponse} data The data returned by the service call.
* @param {String} response The complete HTTP response.
*/
/**
* Find faces and face landmarks (eyes, eye brows, nose, mouth) in an image
* Locate the positions of all faces in an image, along with the eyes, eye brows, nose and mouth components of each
* @param {File} imageFile Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
* @param {module:api/FaceApi~faceLocateWithLandmarksCallback} callback The callback function, accepting three arguments: error, data, response
* data is of type: {@link module:model/FaceLocateWithLandmarksResponse}
*/
this.faceLocateWithLandmarks = 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 faceLocateWithLandmarks");
}
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 = FaceLocateWithLandmarksResponse;
return this.apiClient.callApi(
'/image/face/locate-with-landmarks', 'POST',
pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType, callback
);
}
};

@@ -247,0 +350,0 @@

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

* @module api/NsfwApi
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module api/RecognizeApi
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module api/ResizeApi
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module ApiClient
* @version 1.1.4
* @version 1.1.5
*/

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

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

// AMD. Register as an anonymous module.
define(['ApiClient', 'model/AgeDetectionResult', 'model/DetectedLicensePlate', 'model/DetectedObject', 'model/DrawRectangleInstance', 'model/DrawRectangleRequest', 'model/DrawTextInstance', 'model/DrawTextRequest', 'model/Face', 'model/FaceLocateResponse', 'model/ImageDescriptionResponse', 'model/NsfwResult', 'model/ObjectDetectionResult', 'model/PersonWithAge', 'model/RecognitionOutcome', 'model/VehicleLicensePlateDetectionResult', 'api/ArtisticApi', 'api/EditApi', 'api/FaceApi', 'api/NsfwApi', 'api/RecognizeApi', 'api/ResizeApi'], factory);
define(['ApiClient', 'model/AgeDetectionResult', 'model/DetectedLicensePlate', 'model/DetectedObject', 'model/DrawRectangleInstance', 'model/DrawRectangleRequest', 'model/DrawTextInstance', 'model/DrawTextRequest', 'model/Face', 'model/FaceCompareResponse', 'model/FaceLocateResponse', 'model/FaceLocateWithLandmarksResponse', 'model/FaceMatch', 'model/FacePoint', 'model/FaceWithLandmarks', 'model/ImageDescriptionResponse', 'model/NsfwResult', 'model/ObjectDetectionResult', 'model/PersonWithAge', 'model/RecognitionOutcome', '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/DrawRectangleInstance'), require('./model/DrawRectangleRequest'), require('./model/DrawTextInstance'), require('./model/DrawTextRequest'), require('./model/Face'), require('./model/FaceLocateResponse'), require('./model/ImageDescriptionResponse'), require('./model/NsfwResult'), require('./model/ObjectDetectionResult'), require('./model/PersonWithAge'), require('./model/RecognitionOutcome'), 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/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/ImageDescriptionResponse'), require('./model/NsfwResult'), require('./model/ObjectDetectionResult'), require('./model/PersonWithAge'), require('./model/RecognitionOutcome'), 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, DrawRectangleInstance, DrawRectangleRequest, DrawTextInstance, DrawTextRequest, Face, FaceLocateResponse, ImageDescriptionResponse, NsfwResult, ObjectDetectionResult, PersonWithAge, RecognitionOutcome, VehicleLicensePlateDetectionResult, ArtisticApi, EditApi, FaceApi, NsfwApi, RecognizeApi, ResizeApi) {
}(function(ApiClient, AgeDetectionResult, DetectedLicensePlate, DetectedObject, DrawRectangleInstance, DrawRectangleRequest, DrawTextInstance, DrawTextRequest, Face, FaceCompareResponse, FaceLocateResponse, FaceLocateWithLandmarksResponse, FaceMatch, FacePoint, FaceWithLandmarks, ImageDescriptionResponse, NsfwResult, ObjectDetectionResult, PersonWithAge, RecognitionOutcome, VehicleLicensePlateDetectionResult, ArtisticApi, EditApi, FaceApi, NsfwApi, RecognizeApi, ResizeApi) {
'use strict';

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

* @module index
* @version 1.1.4
* @version 1.1.5
*/

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

/**
* The FaceCompareResponse model constructor.
* @property {module:model/FaceCompareResponse}
*/
FaceCompareResponse: FaceCompareResponse,
/**
* The FaceLocateResponse model constructor.

@@ -113,2 +118,22 @@ * @property {module:model/FaceLocateResponse}

/**
* The FaceLocateWithLandmarksResponse model constructor.
* @property {module:model/FaceLocateWithLandmarksResponse}
*/
FaceLocateWithLandmarksResponse: FaceLocateWithLandmarksResponse,
/**
* The FaceMatch model constructor.
* @property {module:model/FaceMatch}
*/
FaceMatch: FaceMatch,
/**
* The FacePoint model constructor.
* @property {module:model/FacePoint}
*/
FacePoint: FacePoint,
/**
* The FaceWithLandmarks model constructor.
* @property {module:model/FaceWithLandmarks}
*/
FaceWithLandmarks: FaceWithLandmarks,
/**
* The ImageDescriptionResponse model constructor.

@@ -115,0 +140,0 @@ * @property {module:model/ImageDescriptionResponse}

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

* @module model/AgeDetectionResult
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/DetectedLicensePlate
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/DetectedObject
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/DrawRectangleInstance
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/DrawRectangleRequest
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/DrawTextInstance
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/DrawTextRequest
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/Face
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/FaceLocateResponse
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/ImageDescriptionResponse
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/NsfwResult
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/ObjectDetectionResult
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/PersonWithAge
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/RecognitionOutcome
* @version 1.1.4
* @version 1.1.5
*/

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

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

* @module model/VehicleLicensePlateDetectionResult
* @version 1.1.4
* @version 1.1.5
*/

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

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

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

@@ -94,4 +104,14 @@ it('should call faceCropFirst successfully', function(done) {

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

Product

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

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc