Toloka documentation

find_app_batches

toloka.client.TolokaClient.find_app_batches

Finds all batches in the App project that match certain rules.

As a result, it returns an object that contains the first part of the found batches in the App project and whether there are any more results. It is better to use the "get_app_batches" method, they allow to iterate trought all results and not just the first output.

Parameters Description

Parameters Type Description
app_project_id str

Project ID.

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].

sort Union[List[str], AppBatchSortItems, None]

The order and direction of sorting the results.

limit Optional[int]

number of objects per page.

  • Returns:

    The first limit batches in content. And a mark that there is more.

  • Return type:

    AppBatchSearchResult