Toloka documentation

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

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.

  • Yields:

    The next matching task suite.

  • Yield type:

    Generator[TaskSuite, None, None]

Examples:

Get task suites from a specific pool.

results_list = list(toloka_client.get_task_suites(pool_id='1'))