Toloka documentation

find_task_suites

toloka.client.TolokaClient.find_task_suites

Finds all task suites that match certain rules

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

Parameters Description

Parameters Type Description
task_id Optional[str]

The task ID in suites generated automatically using "smart mixing". You will get task suites that contain the specified task.

pool_id Optional[str]

ID of the pool to get task suites from.

overlap Optional[int]

Suites with an overlap equal to the specified value.

id_lt Optional[str]

Task suites with an ID less than the specified value.

id_lte Optional[str]

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

id_gt Optional[str]

Task suites with an ID greater than the specified value.

id_gte Optional[str]

Task suites with an ID 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]

Suites with an overlap less than the specified value.

overlap_lte Optional[int]

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

overlap_gt Optional[int]

Suites with an overlap greater than the specified value.

overlap_gte Optional[int]

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

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

How to sort result. Defaults to None.

limit Optional[int]

Limit on the number of results returned. The maximum is 100 000. Defaults to None, in which case it returns first 50 results.

  • Returns:

    The first limit task suites in items. And a mark that there is more.

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

If method finds more objects than custom or system limit allows to operate, it will also show an indicator has_more=True.