Toloka documentation

find_task_suites

toloka.client.TolokaClient.find_task_suites | Source code

Finds task suites that match certain criteria.

The number of returned task suites is limited. To find remaining task suites call find_task_suites with updated search criteria.

To iterate over all matching task suites you may use the get_task_suites method.

Parameters Description

Parameters Type Description
task_id Optional[str]

Task suite containing a task with the specified ID.

pool_id Optional[str]

Task suites from a pool with the specified ID.

overlap Optional[int]

Task suites with an overlap equal to the specified value.

id_lt Optional[str]

Task suites with IDs less than the specified value.

id_lte Optional[str]

Task suites with IDs less than or equal to the specified value.

id_gt Optional[str]

Task suites with IDs greater than the specified value.

id_gte Optional[str]

Task suites with IDs greater than or equal to the specified value.

created_lt Optional[datetime]

Task suites created before the specified date.

created_lte Optional[datetime]

Task suites created before or on the specified date.

created_gt Optional[datetime]

Task suites created after the specified date.

created_gte Optional[datetime]

Task suites created after or on the specified date.

overlap_lt Optional[int]

Task suites with an overlap less than the specified value.

overlap_lte Optional[int]

Task suites with an overlap less than or equal to the specified value.

overlap_gt Optional[int]

Task suites with an overlap greater than the specified value.

overlap_gte Optional[int]

Task suites with an overlap greater than or equal to the specified value.

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

Sorting options. Default: None.

limit Optional[int]

Returned task suites limit. The default limit is 50. The maximum allowed limit is 100,000.

  • Returns:

    Found task suites and a flag showing whether there are more matching task suites exceeding the limit.

  • Return type:

    TaskSuiteSearchResult

Examples:

Find three most recently created task suites in a specified pool.

toloka_client.find_task_suites(pool_id='1', sort=['-created', '-id'], limit=3)