Mục lục tài liệu
Kịch bản 1: Người dùng định danh
Nộp bài
Gửi kết quả gán nhãn theo định dạng Label Studio cho một lượt làm việc.
POST
/questlab/sdk/v1/annotations?assignedTaskId={assignedTaskId}- Kịch bản
- 1: Người dùng định danh
- Xác thực
- Header
token: {accessToken}(Xác thực)
Tham số
| Tên | Vị trí | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|---|
token | header | string | Bắt buộc | accessToken của người dùng. Không dùng Authorization: Bearer. |
transactionId | header | string | Tuỳ chọn | Nên gửi, mỗi lượt nộp một mã, để đối soát từng lượt nộp. |
Content-Type | header | string | Bắt buộc | application/json |
assignedTaskId | query | UUID | Bắt buộc | Mã lượt làm việc nhận được khi nhận nhiệm vụ. |
result | body | array | Bắt buộc | Kết quả gán nhãn theo định dạng Label Studio. |
lead_time | body | number | Tuỳ chọn | Thời gian làm bài, tính bằng giây. |
result theo định dạng Label Studio; bảng khoá theo từng loại nhãn nằm ở Quy ước & mã lỗi.
Cần chú ý
assignedTaskIdlà query param, không phải path.- Gửi
transactionId(mỗi lượt nộp một mã) để đối soát từng lượt nộp. - Sửa bài đã nộp:
POST /questlab/sdk/v1/annotations/{annotationId}vớiidtrả về. - Chỉ nộp được khi lượt làm việc còn
PENDINGvà chưa quáexpiredAt.
Request mẫu
POST /questlab/sdk/v1/annotations
bash
curl -X POST "$GW/questlab/sdk/v1/annotations?assignedTaskId=<assignedTaskId>" \
-H "token: $ACCESS_TOKEN" \
-H "transactionId: ACME-SUBMIT-0001" \
-H "Content-Type: application/json" \
-d '{
"result": [
{
"from_name": "label",
"to_name": "image",
"type": "rectanglelabels",
"value": {
"x": 10, "y": 20, "width": 30, "height": 40,
"rotation": 0,
"rectanglelabels": ["Product"]
}
}
],
"lead_time": 12.5
}'Biến $GW, $API_KEY, $ACCESS_TOKEN được giải thích ở trang Xác thực.
Response
| Trường trong `data` | Kiểu | Mô tả |
|---|---|---|
id | UUID | Mã bài nộp, dùng để sửa bài. |
result | array | Kết quả đã lưu. |
200 OK
json
{
"status": true,
"httpCode": 200,
"data": {
"id": "d4029aa4-f491-4042-b6dd-ad8f306ac195",
"result": [ ... ]
}
}Mã lỗi
| Mã | Ý nghĩa | Cách xử lý |
|---|---|---|
httpCode 401 | Header token thiếu hoặc đã hết hạn. | Làm mới phiên; thất bại thì khởi tạo lại qua backend. |
You have not permission. | Lượt làm việc thuộc người dùng khác. | Kiểm tra assignedTaskId và token thuộc cùng một người dùng. |
httpCode 400 | Lượt làm việc đã hết hạn. | Nhận nhiệm vụ mới. |
httpCode 404 | Lượt làm việc đã được nộp trước đó. | Không nộp lại; dùng API sửa bài nếu cần. |
