API

FPT.AI Reader - Tìm kiếm khuôn mặt

Quy định ảnh đầu vào

  • Phải là ảnh có định dạng jpg hoặc jpeg

  • Ảnh đầu vào không vượt quá 5 MB và độ phân giải tối thiểu khoảng 640x480 để đảm bảo tỉ lệ đọc chính xác

  • Tỉ lệ diện tích khuôn mặt phải chiếm tối thiểu ¼ tổng diện tích ảnh.

Ảnh tiêu chuẩn

1

Ảnh kém chất lượng

  • Ảnh chất lượng thấp hoặc mặt bị che

Thông tin API

1. Tạo người dùng trên hệ thống (để thêm ảnh index)

Request Url

POST https://api.fpt.ai/dmp/facesearch/v2/create

Request Headers

Tham sốYêu cầuMặc địnhMô tả
api_keyCóapi_key của bạn (lấy từ console.fpt.ai)

Request Body

FormData chứa tên collection và thông tin người dùng (id, name)

Tham sốYêu cầuMô tả
collectioncóMỗi collection sẽ được index và search riêng, không liên quan đến collection khác
idcóid của người dùng phải khác nhau
namecó

Sample Request

curl --location --request POST 'https://api.fpt.ai/dmp/facesearch/v2/create' \\

\--header 'api_key: xxxxxxxxxxxxxxxx' \\

\--form 'collection=test2' \\

\--form 'id=1234' \\

\--form 'name=Nam'

Response

JSON

{

"data": "User created/updated",

"code": "200"

}

Response Code

CodeÝ nghĩa
200Tạo/cập nhật thông tin user thành công

Sample Response: Success

{

"data": "User created/updated",

"code": "200"

}

2. Index ảnh của người dùng

Request Url

POST https://api.fpt.ai/dmp/facesearch/v2/add

Request Headers

Tham sốYêu cầuMặc địnhMô tả
api_keyCóapi_key của bạn (lấy từ console.fpt.ai)

Request Body

FormData chứa tên collection, id người dùng và ảnh khuôn mặt

Tham sốYêu cầuMô tả
collectioncóMỗi collection sẽ được index và search riêng, không liên quan đến collection khác
idcóid của người dùng đã được tạo
filecóChứa ảnh khuôn mặt
allow_id_cardkhôngtrue/false: cho phép ảnh ID

Sample Request

curl --location --request POST 'https://api.fpt.ai/dmp/facesearch/v2/add' \\

\--header 'api_key: xxxxxxxxxxxxxxxx' \\

\--form 'file=\@/path/to/photo.jpg' \\

\--form 'collection=test2' \\

\--form 'id=1234'

Response

JSON

{

"data": "Add photo success",

"code": "200"

}

Response Code

Codeý nghĩa
200Index ảnh thành công
400Ảnh không đúng định dạng / Có nhiều mặt / Không tìm thấy mặt
406Ảnh không chứa toàn bộ mặt, đeo khẩu trang, mũ hoặc kính râm
410Ảnh đầu vào là chứng minh nhân dân
Sample Response: Success
{

"data": "Add photo success",

"code": "200"

}

Sample Response: Error

{

"data": "No face detected",

"code": "400"

}

{

"data": "Photo is id card",

"code": "410"

}

3. Tìm kiếm khuôn mặt

Request Url

POST https://api.fpt.ai/dmp/facesearch/v2/search

Request Headers

Tham sốYêu cầuMặc địnhMô tả
api_keyCóapi_key của bạn (lấy từ console.fpt.ai)

Request Body

FormData chứa tên collection, ảnh khuôn mặt cần tìm kiếm

Tham sốYêu cầuMô tả
collectioncóMỗi collection sẽ được index và search riêng, không liên quan đến collection khác
filecóChứa ảnh khuôn mặt
thresholdkhôngNgưỡng để xác định là 2 khuông mặt giống nhau, giá trị mặc định là 0.85
allow_id_cardkhôngtrue/false: cho phép ảnh ID

Sample Request

curl --location --request POST 'https://api.fpt.ai/dmp/facesearch/v2/search' \\

\--header 'api_key: xxxxxxxxxxxxxxxx' \\

\--form 'file=\@/path/to/search_photo.jpg' \\

\--form 'collection=test2' \\

\--form 'threshold=0.9'

Response

JSON

{

"data": {

"id": "1234",

"name": "Nam",

"similarity": 0.9999998807907104

},

"code": "200"

}

Response Code

Codeý nghĩa
200Tìm kiếm thành công
400Ảnh không đúng định dạng / Có nhiều mặt / Không tìm thấy mặt
404Không tìm thấy kết quả
406Ảnh không chứa toàn bộ mặt, đeo khẩu trang, mũ hoặc kính râm
410Ảnh đầu vào là chứng minh nhân dân

Sample Response: Success

{

"data": {

"id": "1234",

"name": "Nam",

"similarity": 0.9999998807907104

},

"code": "200"

}

Sample Response: Error

{

"data": "No face detected",

"code": "400"

}

{

"data": "Photo is id card",

"code": "410"

}

{

"data": "Not found",

"code": "404"

}

4. Xoá dữ liệu khuôn mặt của một người dùng

Request Url

DELETE https://api.fpt.ai/dmp/facesearch/v2/delete_faces

Request Headers

Tham sốYêu cầuMặc địnhMô tả
api_keyCóapi_key của bạn (lấy từ console.fpt.ai)

Request Body

FormData chứa tên collection và id người dùng

Tham sốYêu cầuMô tả
collectionCótên collection
idCóid của người dùng

Sample Request

curl --location --request DELETE 'https://api.fpt.ai/dmp/facesearch/v2/delete_faces' \
--header 'api_key: xxxxxx' \
--form 'collection="test1"' \
--form 'id="2"'

Response

JSON

{
    "data": "User faces deleted",
    "code": "200"
}

Response Code

Codeý nghĩa
200Xoá khuôn mặt thành công
404Không tìm thấy người dùng

5. Xoá người dùng

Request Url

DELETE https://api.fpt.ai/dmp/facesearch/v2/delete

Request Headers

Tham sốYêu cầuMặc địnhMô tả
api_keyCóapi_key của bạn (lấy từ console.fpt.ai)

Request Body

FormData chứa tên collection và id người dùng

Tham sốYêu cầuMô tả
collectionCótên collection
idCóid của người dùng

Sample Request

curl --location --request DELETE 'https://api.fpt.ai/dmp/facesearch/v2/delete' \
--header 'api_key: xxxxxxxx' \
--form 'collection="test2"' \
--form 'id="1234"'

Response

JSON

{
    "data": "User deleted",
    "code": "200"
}

Response Code

Codeý nghĩa
200Xoá người dùng thành công
404Không tìm thấy người dùng

6. Liệt kê người dùng trong một collection

Request Url

GET https://api.fpt.ai/dmp/facesearch/v2/list

Request Headers

Tham sốYêu cầuMặc địnhMô tả
api_keyCóapi_key của bạn (lấy từ console.fpt.ai)

Request Params

Request string chứa tên collection

Tham sốYêu cầuMô tả
collectionCóThe tên collection cần liệt kê người dùng

Sample Request

curl --location --request GET 'https://api.fpt.ai/dmp/facesearch/v2/list?collection=test1' \
--header 'api_key: xxxxxx' \

Response

JSON

{
    "data": [
        {
            "id": "1",
            "name": "Nguyen Van A"
        },
        {
            "id": "3",
            "name": "Nguyen Van B"
        }
    ],
    "code": "200"
}

Response Code

Codeý nghĩa
200Request thành công

7. Xoá collection

Request Url

DELETE https://api.fpt.ai/dmp/facesearch/v2/delete_collection

Request Headers

Tham sốYêu cầuMặc địnhMô tả
api_keyCóapi_key của bạn (lấy từ console.fpt.ai)

Request Body

FormData chứa tên collection

Tham sốYêu cầuMô tả
collectionCótên collection

Sample Request

curl --location --request DELETE 'https://api.fpt.ai/dmp/facesearch/v2/delete_collection' \
--header 'api_key: xxxxxx' \
--form 'collection="test1"'

Response

JSON

{
    "data": "Remove collection success",
    "code": "200"
}

Response Code

Codemeaning
200Xoá collection thành công
404Không tìm thấy collection
← Nhận diện Hộ ChiếuXác thực khuôn mặt →