Face Search

Thử nghiệm nhanh API:Run in Postman

1. Xem toàn bộ ảnh

API:

MethodURL
GEThttps://cloud.computervision.com.vn/api/v2/face_search/images

Params:

KeyValueMô tả
offset100Số bản ghi sẽ bỏ qua
limit50Số bản ghi tối đa sẽ trả về

Demo Python:

import requests
api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"
offset = 100
limit = 50
response = requests.get(
"https://cloud.computervision.com.vn/api/v2/face_search/images?offset=%s&limit=%s"
% (offset, limit),
auth = (api_key, api_secret)
)
print(response.json())

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

API:

MethodURLcontent-type
POSThttps://cloud.computervision.com.vn/api/v2/face_search/searchapplication/json

Body:

{
"image": {
"base64": string // Mã hóa base64 của hình ảnh
}
}

Demo Python:

import requests
api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"
payload = "{\"image\":{\"base64\":\"iVBORw0KGgoAAAANSU...\"}}"
response = requests.post(
"https://cloud.computervision.com.vn/api/v2/face_search/search",
auth=(api_key, api_secret),
data = payload
print(response.json())

3. Thêm ảnh

API:

MethodURLcontent-type
POSThttps://cloud.computervision.com.vn/api/v2/face_search/imagesapplication/json

Body:

{
"image": {
"base64": string, // Mã hóa base64 của hình ảnh,
"metadata": json // Tùy chọn, Bất kỳ metadata key-value nào để lưu cùng với ảnh, trừ những key "user", "encoding", "_id" đã được hệ thống sử dụng
}
}

Demo Python:

import requests
api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"
payload = "{\"image\":{\"base64\":\"iVBORw0KGgoAAAANSU...\"}}"
response = requests.post(
"https://cloud.computervision.com.vn/api/v2/face_search/images",
auth=(api_key, api_secret),
data = payload
print(response.json())

4. Cập nhật metadata

API:

MethodURLcontent-type
PUThttps://cloud.computervision.com.vn/api/v2/face_search/images/<image_id>application/json

Body:

{
"image_id": 123456,
"metadata": { // Tùy chọn. Bất kỳ metadata key-value nào để lưu cùng với ảnh, trừ những key `"user"`, `"encoding"`, `"_id"` đã được hệ thống sử dụng
"name": "example",
"label": "for bar",
...
}
}

Demo Python:

import requests
api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"
payload = "{\"image_id\":123456,\"metadata\":{\"name\":\"example\",\"label\":\"for bar\"}}"
response = requests.post(
"https://cloud.computervision.com.vn/api/v2/face_search/images/<image_id>",
data = payload,
auth = (api_key, api_secret)
)
print(response.json())

5. Xoá nhiều ảnh

API:

MethodURLcontent-type
DELETEhttps://cloud.computervision.com.vn/api/v2/face_search/imagesapplication/json

Body:

{
"ids": [
123456, // id ảnh cần xoá
987654, // id ảnh cần xoá
...
]
}

Demo Python:

import requests
api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"
payload = "{\"ids\":[<image-id-you-want-to-delete>,<image-id-you-want-to-delete>,...]}"
response = requests.post(
"https://cloud.computervision.com.vn/api/v2/face_search/images",
data = payload,
auth = (api_key, api_secret)
)
print(response.json())

6. Thông tin trả về

Phản hồi sẽ là một JSON với định dạng sau:

{
"result": [xxxx],
"status_code": int, // Mã lỗi
"message": string // Thông báo lỗi
}

Mỗi api khác nhau sẽ trả về kết quả khác nhau.

Xem toàn bộ ảnh:

  • result: Mảng chứa các phần tử ảnh, mỗi phần tử gồm id của ảnh và URL ảnh tương ứng.

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

  • result: Mảng chứa các phần tử ảnh phù hợp, mỗi phần tử gồm id của ảnh và URL ảnh tương ứng.

Thêm ảnh:

  • result: JSON chứa thông tin ảnh mới được thêm vào.

Xoá nhiều ảnh:

  • result: None.

Bảng mã lỗi:

Mã lỗiMessageMô tả
0SuccessSo khớp thành công
1The photo does not contain contentUpload ảnh bị lỗi khi dùng POST
2Url is unavailableDownload ảnh bị lỗi khi dùng GET
3Incorrect image formatTồn tại ảnh không có mặt người
4Out of requestsHết số lượng request
5Incorrect api_key or api_secretKhi api_key hoặc api_secret sai
6Incorrect format typeLoại format khai báo trong format_type không đúng với ảnh truyền vào