Skip to content

Commit 750c487

Browse files
author
ammkk
committed
Updated readme
1 parent 52e1a66 commit 750c487

File tree

1 file changed

+124
-0
lines changed

1 file changed

+124
-0
lines changed

README.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- [Task](#task)
99
- [Image](#image)
1010
- [Image Classification](#image-classification)
11+
- [Multi Image Classification](#multi-image-classification)
1112
- [Sequential Image](#sequential-image)
1213
- [Video](#video)
1314
- [Video Classification](#video-classification)
@@ -560,6 +561,129 @@ Example of a single image classification task object
560561
}
561562
```
562563

564+
### Multi Image Classification
565+
566+
Supported following project types:
567+
568+
- Multi Image - Classification
569+
570+
#### Create Task
571+
572+
Create a new task.
573+
574+
```python
575+
task = client.create_multi_image_classification_task(
576+
project="YOUR_PROJECT_SLUG",
577+
name="sample",
578+
folder_path="./sample",
579+
priority=10, # (optional) none: 0, low: 10, medium: 20, high: 30
580+
attributes=[
581+
{
582+
"type": "text",
583+
"key": "attribute-key",
584+
"value": "attribute-value"
585+
}
586+
]
587+
)
588+
```
589+
590+
##### Limitation
591+
592+
593+
- You can upload up to a size of 20 MB.
594+
- You can upload up to a total size of 2 GB.
595+
- You can upload up to 6 files in total.
596+
597+
#### Find Task
598+
599+
Find a single task.
600+
601+
```python
602+
task = client.find_multi_image_classification_task(task_id="YOUR_TASK_ID")
603+
```
604+
605+
Find a single task by name.
606+
607+
```python
608+
tasks = client.find_multi_image_classification_task_by_name(project="YOUR_PROJECT_SLUG", task_name="YOUR_TASK_NAME")
609+
```
610+
611+
#### Get Tasks
612+
613+
Get tasks.
614+
615+
```python
616+
tasks = client.get_multi_image_classification_tasks(project="YOUR_PROJECT_SLUG")
617+
```
618+
619+
#### Update Task
620+
621+
Update a single task.
622+
623+
```python
624+
task_id = client.update_multi_image_classification_task(
625+
task_id="YOUR_TASK_ID",
626+
status="approved",
627+
assignee="USER_SLUG",
628+
tags=["tag1", "tag2"],
629+
priority=10, # (optional) none: 0, low: 10, medium: 20, high: 30
630+
attributes=[
631+
{
632+
"type": "text",
633+
"key": "attribute-key",
634+
"value": "attribute-value"
635+
}
636+
]
637+
)
638+
```
639+
640+
#### Response
641+
642+
Example of a single task object
643+
644+
```python
645+
{
646+
"id": "YOUR_TASK_ID",
647+
"name": "sample",
648+
"contents": [
649+
{
650+
"name": "content-name-1",
651+
"url": "content-url-1",
652+
"width": 100,
653+
"height": 100,
654+
},
655+
{
656+
"name": "content-name-2",
657+
"url": "content-url-2",
658+
"width": 100,
659+
"height": 100,
660+
}
661+
],
662+
"status": "registered",
663+
"externalStatus": "registered",
664+
"priority": 10,
665+
"tags": [],
666+
"assignee": "ASSIGNEE_NAME",
667+
"reviewer": "REVIEWER_NAME",
668+
"externalAssignee": "EXTERNAL_ASSIGNEE_NAME",
669+
"externalReviewer": "EXTERNAL_REVIEWER_NAME",
670+
"attributes": [
671+
{
672+
"type": "text",
673+
"key": "attribute-key-1",
674+
"value": "attribute-value-1"
675+
},
676+
{
677+
"type": "text",
678+
"key": "attribute-key-2",
679+
"value": "attribute-value-2"
680+
}
681+
],
682+
"createdAt": "2021-02-22T11:25:27.158Z",
683+
"updatedAt": "2021-02-22T11:25:27.158Z"
684+
}
685+
```
686+
563687
### Sequential Image
564688

565689
Supported following project types:

0 commit comments

Comments
 (0)