The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Net::Azure::CognitiveServices::Face::FaceList - Face List API class of Cognitive Services API

DESCRIPTION

Face List API wrapper.

METHODS

create

Send "Create a Face List" request.

    $obj->create($face_list_id, 
        name     => 'my_face_list',
        userData => 'created_date:2016-08-01',
    );

Please see https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524b for detail.

add

Send "Add a Face to Face List" request and fetch result as hashref.

    my $result = $obj->add($face_list_id, $image_url,
        userData   => 'added_date:2016-08-01',
        targetFace => '10,10,100,100',
    );
    say $result->{persistedFaceId}; ## output persistedFaceId

Please see https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250 for detail.

delete

Send "Delete a Face from Face List" request.

    $obj->delete($face_list_id, $remove_face_id);

Please see https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395251 for detail.

flush

Send "Delete a Face List" request.

    my $result = $obj->flush($face_list_id);

Please see https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f for detail.

get

Send "Get a Face List" request and fetch result as hashref.

    my $result = $obj->get($face_list_id);
    say $result->{name}; ## output Face List name

Please see https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524c for detail.

list

Send "List Face Lists" request and fetch result as arrayref.

    my $result = $obj->list;
    say join("%s\n", map {$_->{faceListId}} @$result); ## output list of faceListId

Please see https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524d for detail.

update

Send "Update a Face List" request.

    $obj->update($face_list_id,
        name     => 'new Face List Name',
        userData => 'update:2016-08-01',  
    );

Please see https://dev.projectoxford.ai/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524e for detail.

LICENSE

Copyright (C) ytnobody.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

ytnobody <ytnobody@gmail.com>