Toloka documentation

get_app_batches

toloka.client.TolokaClient.get_app_batches

Finds all batches in the App project that match certain rules and returns them in an iterable object.

Unlike find_app_batches, returns generator. Does not sort batches in the App project. While iterating over the result, several requests to the Toloka server is possible.

Parameters Description

Parameters Type Description
after_id Optional[str]

ID of the batch used for cursor pagination

status Optional[AppBatch.Status]

batches with this status.

id_gt Optional[str]

batches with an ID greater than the specified value.

id_gte Optional[str]

batches with an ID greater than or equal to the specified value.

id_lt Optional[str]

batches with an ID less than the specified value.

id_lte Optional[str]

batches with an ID less than or equal to the specified value.

name_gt Optional[str]

batches with the name lexicographically greater than the specified value.

name_gte Optional[str]

batches with a name lexicographically greater than or equal to the specified value.

name_lt Optional[str]

batches with a name lexicographically less than the specified value.

name_lte Optional[str]

batches with a name lexicographically less than or equal to the specified value.

created_gt -

batches created after the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

created_gte -

batches created after the specified date, inclusive. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

created_lt -

batches created before the specified date. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

created_lte -

batches created before the specified date, inclusive. The date is specified in UTC in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss].

  • Yields:

    The next object corresponding to the request parameters.

  • Yield type:

    Generator[AppBatch, None, None]