find_app_batches

toloka.client.TolokaClient.find_app_batches | Source code

Finds batches that match certain criteria in an App project.

The number of returned batches is limited. To find remaining batches call find_app_batches with updated search criteria.

To iterate over all matching batches you may use the get_app_batches method.

Parameters description

Parameters	Type	Description
`app_project_id`	str	The ID of the App project.
`after_id`	Optional[str]	The ID of the batch used for cursor pagination.
`status`	Optional[AppBatch.Status]	Refer to the AppBatch.Status page for more information on the available `status` values.
`id_gt`	Optional[str]	Batches with IDs greater than the specified value.
`id_gte`	Optional[str]	Batches with IDs greater than or equal to the specified value.
`id_lt`	Optional[str]	Batches with IDs less than the specified value.
`id_lte`	Optional[str]	Batches with IDs less than or equal to the specified value.
`name_gt`	Optional[str]	Batches with names lexicographically greater than the specified value.
`name_gte`	Optional[str]	Batches with names lexicographically greater than or equal to the specified value.
`name_lt`	Optional[str]	Batches with names lexicographically less than the specified value.
`name_lte`	Optional[str]	Batches with names lexicographically less than or equal to the specified value.
`created_gt`	Optional[datetime]	Batches created after the specified date.
`created_gte`	Optional[datetime]	Batches created after or on the specified date.
`created_lt`	Optional[datetime]	Batches created before the specified date.
`created_lte`	Optional[datetime]	Batches created before or on the specified date.
`sort`	Union[List[str], AppBatchSortItems, None]	Sorting options. Default: `None`.
`limit`	Optional[int]	Returned batches limit. The maximum allowed value: 1000.

Returns:

Found batches and a flag showing whether there are more matching batches exceeding the limit.
Return type:

AppBatchSearchResult

Examples:

result = toloka_client.find_app_batches(
    app_project_id='Q2d15QBjpwWuDz8Z321g', status='NEW', sort='id'
)
batches = result.content
if result.has_more:
    print('There are more NEW batches...')

Last updated: August 28, 2023

Toloka-Kit

Overview Getting API key Quick start

Recipes

Reference

toloka.client

toloka.async_client

toloka.autoquality [autoquality]

toloka.metrics

toloka.streaming