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

ParametersTypeDescription
task_idOptional[str]

Task suite containing a task with the specified ID.

pool_idOptional[str]

Task suites from a pool with the specified ID.

overlapOptional[int]

Task suites with an overlap equal to the specified value.

id_ltOptional[str]

Task suites with IDs less than the specified value.

id_lteOptional[str]

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

id_gtOptional[str]

Task suites with IDs greater than the specified value.

id_gteOptional[str]

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

created_ltOptional[datetime]

Task suites created before the specified date.

created_lteOptional[datetime]

Task suites created before or on the specified date.

created_gtOptional[datetime]

Task suites created after the specified date.

created_gteOptional[datetime]

Task suites created after or on the specified date.

overlap_ltOptional[int]

Task suites with an overlap less than the specified value.

overlap_lteOptional[int]

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

overlap_gtOptional[int]

Task suites with an overlap greater than the specified value.

overlap_gteOptional[int]

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

sortUnion[List[str], TaskSuiteSortItems, None]

Sorting options. Default: None.

limitOptional[int]

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

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

find_result = toloka_client.find_task_suites(pool_id='1086170', sort=['-created', '-id'], limit=3)
task_suites = find_result.items

Last updated: August 28, 2023

Toloka-Kit
OverviewGetting API keyQuick start
Recipes
Reference
toloka.client
toloka.async_client
toloka.autoquality [autoquality]
toloka.metrics
toloka.streaming