Batch
A Batch is the core unit for submitting and tracking work on the platform… It serves as a container, holding all necessary information to create, process, manage, and monitor the status of tasks. Clients can submit batches via the submitBatch API.
¶ Key characteristics of a Batch:
- Each batch is identified by a unique identifier within a project.
- A batch acts as a container of tasks, capable of holding up to 100,000 tasks.
- Tasks within a batch are typically structured as rows within a CSV file.
- Clients can track batch progress, manage tasks, and download results.
Below are all possible statuses of a batch
| Batch status | Description |
|---|---|
| submitted | Staged work request. Batch would be created if it has some work-items |
| processing | Batch is successfully/partially dispatched to domain service for processing. Partial dispatch can happen in the scenario where domain service rejected a specific work item due to invalid payload |
| processed | Batch is fully processed by domain service. |
| partially_processed | Batch is partially processed by domain service i.e. few work items can not be processed. Example: some of the labeling tasks cannot be processed because of invalid image or image can not be rendered. |
| failed | Failed to create batch.This scenario can happen if the work request is invalid or failed to pull work data from clients cloud storage. |
| All work items in the batch failed to dispatch to domain service for processing | |
| Batch failed to get processed by domain service | |
| cancelled | Batch is successfully cancelled |