Client

mashape-animetrics-face-api module

new Client()

Instance Members

▸ gallery(id)

Get one gallery by id

gallery(id: String): Gallery

Parameters

id (String) The gallery id

Returns

Gallery: Instance of EnrollClient class

▸ galleries()

Get all client galleries

galleries(): Array<Gallery>

Returns

Array<Gallery>: Instance of EnrollClient class

Detect

mashape-animetrics-face-api module

new Detect()

Instance Members

▸ getImage()

Get image data

getImage(): Object

Returns

Object: The image object

▸ getFaces()

Get faces list

getFaces(): Array

Returns

Array: The list of faces

▸ getFacesCount()

Get faces count

getFacesCount(): Integer

Returns

Integer: The count of faces

▸ hasFaces()

Check if the image has faces found

hasFaces(): Boolean

Returns

Boolean:

▸ getFace(index?)

Get face by index

getFace(index: Integer?= ): Object

Parameters

index (Integer?= ) Face index

Returns

Object:

▸ enroll(galleryId, subjectId, index?)

Enrol one face from image

enroll(galleryId: String, subjectId: String, index: Integer?= e): Enroll

Parameters

galleryId (String) Gallery id

subjectId (String) Subject id

index (Integer?= e) Face index

Returns

Enroll:

▸ recognize(galleryId, index)

Recognize image from detect

recognize(galleryId: String, index: Integer): Recognize

Parameters

galleryId (String) Gallery id

index (Integer) Face index

Returns

Recognize:

DetectClient

mashape-animetrics-face-api module

new DetectClient()

Instance Members

▸ fromUrl(url, selector)

Get detector from url

fromUrl(url: String, selector: String): Detect

Parameters

url (String) Image url

selector (String) Selectors for find filter, default: FULL, ex: 'FACE, EYES, FULL'

Returns

Detect: Instance of detect class

Enroll

mashape-animetrics-face-api module

new Enroll()

EnrollClient

mashape-animetrics-face-api module

new EnrollClient()

Instance Members

▸ _enroll(galleryId, subjectId)

Enroll in the group

_enroll(galleryId: String, subjectId: String): Enroll

Parameters

galleryId (String) Gallery id to enroll

subjectId (String) Subject id

Returns

Enroll:

Gallery

mashape-animetrics-face-api module

new Gallery()

Instance Members

▸ getSubjects()

Get subjects from gallery

getSubjects(): Array

Returns

Array:

▸ enroll(image, face, subjectId)

Enroll in this gallery

enroll(image: Object, face: Object, subjectId: String): Enroll

Parameters

image (Object) Image data

face (Object) Face data

subjectId (String) Face index

Returns

Enroll:

▸ recognize(image, face)

Recognize face in this group

recognize(image: Object, face: Object): Recognize

Parameters

image (Object) Image object - mast contain image_id

face (Object) FAce object - mast contain face data

Returns

Recognize:

GalleryClient

mashape-animetrics-face-api module

new GalleryClient()

Instance Members

▸ get(id)

Get one subjects from gallery

get(id: String): Gallery

Parameters

id (String) Gallery id

Returns

Gallery:

▸ list()

Get list subjects from gallery

list(): Array<Gallery>

Returns

Array<Gallery>:

Recognize

mashape-animetrics-face-api module

new Recognize()

Instance Members

▸ get()

Get candidates list

get(): Array<Object>

Returns

Array<Object>:

▸ get()

Get top candidates

get(): Object

Returns

Object:

RecognizeClient

mashape-animetrics-face-api module

new RecognizeClient()

Instance Members

▸ execute(galleryId, image, face)

Recognize face

execute(galleryId: String, image: Object, face: Object): Recognize

Parameters

galleryId (String) Gallery Id

image (Object) Image object - mast contain image_id

face (Object) FAce object - mast contain face data

Returns

Recognize: