Tìm kiếm khuôn mặt#

Tạo Face Collection để đăng kí và kiểm tra người dùng trong hệ thống.

B1. Đăng ký collection ID#

Bạn tự tạo Collection ID và add vào hệ thống để đăng kí Collectio ID. Các thông tin tối thiểu cần kèm theo:

  • external_person_id: ID của người (nhân viên/ khách hàng) trong hệ thống của bạn.

  • id: Collection ID muốn đăng ký vào hệ thống.

Response trả về sẽ gồm các field sau:

  • id: Collection ID bạn muốn đăng ký.

  • message: Thông báo kết quả đăng ký.

Ví dụ:

CLI:

jo -d. id="1d4a05fb-136f-4b80-92c6-d22b1a709ad9" external_person_id="minhnn" | http -a $MY_AUTH https://api.unicloud.ai/ekyc/face-collections/sign-collection-id

Response:

{
    "id": "989b281d-1542-557f-873a-510f4c3bfd22",
    "message": "Success",
    "result_code": 200
}

Trong trường hợp collection ID đã tồn tài trong hệ thống sẽ trả về message:

Response:

{
    "id": "989b281d-1542-557f-873a-510f4c3bfd22",
    "message": "Face Collection Id Exists",
    "result_code": 138
}

B2. Đăng ký ảnh chuẩn của người đã biết#

Bạn sẽ được Unicloud cung cấp một hay nhiều Collection ID. Việc nhận diện tìm kiếm được giới hạn trong collection cụ thể để tránh trả về thông tin của người không liên quan, ví dụ bạn có thể dành collection cho nhân viên công ty, collection cho khách hàng.

Để đăng ký ảnh chuẩn, gọi vào API POST /face-collections/{collection_id}. Các thông tin tối thiểu cần kèm theo:

  • external_person_id: ID của người (nhân viên/ khách hàng) trong hệ thống của bạn.

  • reference_photo: Nội dung của file ảnh, dưới dạng base64.

Response trả về sẽ gồm các field sau:

  • external_person_id: ID của người (nhân viên/ khách hàng) trong hệ thống của bạn.

  • id: ID trong hệ thống của Unicloud.

  • file_id: ID của file trong hệ thống của Unicloud.

Ví dụ:

CLI:

jo external_person_id=quan reference_photo=%BGM.jpg | http -a $MY_AUTH https://api.unicloud.ai/ekyc/face-collections/989b281d-1542-557f-873a-510f4c3bfd22

Response:

{
    "external_person_id": "quan",
    "file_id": "cda17cfa-208a-4222-1254-b5a11fc5d16b",
    "id": "91f5ab10-1451-4a41-8571-c0ec173d55c1",
    "message": "Success",
    "result_code": 200
}

B3. Đưa hình ảnh bất kì và lấy ID của người trong ảnh#

Gọi vào API POST face-collections/{collection_id}/identify, kèm theo thông tin tối thiểu sau:

  • photo: Nội dung của file ảnh dưới dạng base64.

  • liveness_threshold: [Optional] Ngưỡng tự tin hệ thống cần đạt được khi nhận diện được ảnh người thật, mặc định 0.5 (tương ứng 50%).

Response trả về sẽ gồm các field sau:

  • external_person_id: ID của người (nhân viên/ khách hàng) trong hệ thống của bạn, đã đăng ký trước đó.

  • id: ID trong hệ thống của Unicloud.

  • confidence: Mức độ tự tin của hệ thống khi nhận ra được mặt người trong ảnh.

  • similarity: Mức độ tương đồng của khuôn mặt trong ảnh dang quét so với ảnh đã đăng ký.

  • liveness_check: Kết quả kiểm tra khuôn mặt chân thật.

Ví dụ:

CLI:

jo photo=%Dirung.jpg | http -a $MY_AUTH https://api.unicloud.ai/ekyc/face-collections/989b281d-1542-557f-873a-510f4c3bfd22/identify

Response:

{
    "confidence": 1.0,
    "external_person_id": "quan",
    "file_id": "cda17cfa-208a-4222-1254-b5a11fc5d16b",
    "id": "91f5ab10-1451-4a41-8571-c0ec173d55c1",
    "message": "Success",
    "result_code": 200,
    "similarity": 1.0
}

B4. Xóa đăng kí 1 người trong Collection#

Request

Gọi vào API POST face-collections/{collection_id}/delete, kèm theo thông tin tối thiểu sau:

  • id: ID trong hệ thống của Unicloud.

  • file_id: ID của file trong hệ thống của Unicloud.

Ví dụ:

CLI:

http -a $MY_AUTH https://api-uat.unicloud.ai/ekyc/face-collections/989b281d-1542-557f-873a-510f4c3bfd22/delete \
                  id=91f5ab10-1451-4a41-8571-c0ec173d55c1 \
                  file_id=cda17cfa-208a-4222-1254-b5a11fc5d16b

Response

Trả về sẽ gồm các field sau:

  • id: ID trong hệ thống của Unicloud.

  • file_id: ID của file trong hệ thống của Unicloud.

  • message: Thông báo kết quả đăng ký.

  • result_code: Mã kết quả.

Result code

Message

Note

200

Delete Face Successfully

Xóa khuôn mặt khỏi Collection thành công

159

Face Not Registered

Khuôn mặt không được đăng kí

158

Collection Not Found

Không tìm thấy Collection ID

Trường hợp thành công

{
    "file_id": "cda17cfa-208a-4222-1254-b5a11fc5d16b",
    "id": "91f5ab10-1451-4a41-8571-c0ec173d55c1",
    "message": "Delete Face Successfully",
    "result_code": 200
}