Toloka documentation

AppBatch

toloka.client.app.AppBatch | Source code

AppBatch(
    self,
    *,
    id: Optional[str] = None,
    app_project_id: Optional[str] = None,
    name: Optional[str] = None,
    status: Union[Status, str, None] = None,
    items_count: Optional[int] = None,
    item_price: Optional[Decimal] = None,
    cost: Optional[Decimal] = None,
    cost_of_processed: Optional[Decimal] = None,
    created_at: Optional[datetime] = None,
    started_at: Optional[datetime] = None,
    finished_at: Optional[datetime] = None,
    read_only: Optional[bool] = None,
    last_items_import: Optional[AppItemImport] = None,
    confidence_avg: Optional[float] = None,
    items_processed_count: Optional[int] = None,
    eta: Optional[datetime] = None,
    items_per_state: Optional[Dict] = None
)

An App batch.

A batch contains task items that are sent for labeling together.

Parameters Description

Parameters Type Description
id Optional[str]

The ID of the batch.

app_project_id Optional[str]

The ID of the project containing the batch.

name Optional[str]

The batch name.

status Optional[Status]

The batch status:

  • NEW — The processing of the batch items is not started.
  • PROCESSING — Batch items are being processed by Tolokers.
  • COMPLETED — Annotation of all batch items is completed.
  • ERROR — An error occurred during processing.
  • CANCELLED — Batch processing cancelled.
  • ARCHIVE — The batch is archived.
  • NO_MONEY — There are not enough money for processing.
items_count Optional[int]

The number of items in the batch.

item_price Optional[Decimal]

The cost of processing a single item in the batch.

cost Optional[Decimal]

The cost of processing the batch.

cost_of_processed Optional[Decimal]

Cost of already processed task items.

created_at Optional[datetime]

The date and time when the batch was created.

started_at Optional[datetime]

The date and time when batch processing started.

finished_at Optional[datetime]

The date and time when batch processing was completed.

read_only Optional[bool]
last_items_import Optional[AppItemImport]

Meta-information on asynchronous loading operation (possible via UI).

confidence_avg Optional[float]

Average labeling quality.

items_processed_count Optional[int]

Number of labeled items.

eta Optional[datetime]

Expected date and time when batch processing will be completed.

items_per_state Optional[Dict]

Statistics on the number of items in each state.