get_task_suites

toloka.client.TolokaClient.get_task_suites | Source code

Finds all task suites that match certain criteria.

get_task_suites returns a generator. You can iterate over all found task suites using the generator. Several requests to the Toloka server are possible while iterating.

If you need to sort task suites use the find_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.

batch_sizeOptional[int]

A limit of items returned by each request to Toloka. The maximum allowed value: 100,000. The default value: 50.

  • Yields:

    The next matching task suite.

  • Yield type:

    Generator[TaskSuite, None, None]

Examples:

task_suites = list(toloka_client.get_task_suites(pool_id='1086170'))

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