get_assignments

toloka.client.TolokaClient.get_assignments | Source code

Finds all assignments that match certain criteria.

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

If you need to sort assignments use the find_assignments method.

Parameters description

ParametersTypeDescription
statusUnion[str, Assignment.Status, List[Union[str, Assignment.Status]], None]

Assignment status or a list of statuses. Refer to the Assignment.Status page for more information on the available status values.

task_idOptional[str]

Assignments containing the task with the specified ID.

task_suite_idOptional[str]

Assignments for a task suite with the specified ID.

pool_idOptional[str]

Assignments in a pool with the specified ID.

user_idOptional[str]

Assignments from a Toloker with the specified ID.

id_ltOptional[str]

Assignments with IDs less than the specified value.

id_lteOptional[str]

Assignments with IDs less than or equal to the specified value.

id_gtOptional[str]

Assignments with IDs greater than the specified value.

id_gteOptional[str]

Assignments with IDs greater than or equal to the specified value.

created_ltOptional[datetime]

Task suites assigned before the specified date.

created_lteOptional[datetime]

Task suites assigned before or on the specified date.

created_gtOptional[datetime]

Task suites assigned after the specified date.

created_gteOptional[datetime]

Task suites assigned after or on the specified date.

submitted_ltOptional[datetime]

Assignments completed before the specified date.

submitted_lteOptional[datetime]

Assignments completed before or on the specified date.

submitted_gtOptional[datetime]

Assignments completed after the specified date.

submitted_gteOptional[datetime]

Assignments completed after or on the specified date.

accepted_ltOptional[datetime]

Assignments accepted before the specified date.

accepted_lteOptional[datetime]

Assignments accepted before or on the specified date.

accepted_gtOptional[datetime]

Assignments accepted after the specified date.

accepted_gteOptional[datetime]

Assignments accepted after or on the specified date.

rejected_ltOptional[datetime]

Assignments rejected before the specified date.

rejected_lteOptional[datetime]

Assignments rejected before or on the specified date.

rejected_gtOptional[datetime]

Assignments rejected after the specified date.

rejected_gteOptional[datetime]

Assignments rejected after or on the specified date.

skipped_ltOptional[datetime]

Assigned task suites skipped before the specified date.

skipped_lteOptional[datetime]

Assigned task suites skipped before or on the specified date.

skipped_gtOptional[datetime]

Assigned task suites skipped after the specified date.

skipped_gteOptional[datetime]

Assigned task suites skipped after or on the specified date.

expired_ltOptional[datetime]

Assigned task suites expired before the specified date.

expired_lteOptional[datetime]

Assigned task suites expired before or on the specified date.

expired_gtOptional[datetime]

Assigned task suites expired after the specified date.

expired_gteOptional[datetime]

Assigned task suites expired after or on the specified date.

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

  • Yield type:

    Generator[Assignment, None, None]

Examples:

The following example creates a list with IDs of SUBMITTED assignments in the specified pool.

from toloka.client import Assignment
assignments = toloka_client.get_assignments(pool_id='1080020', status=Assignment.SUBMITTED)
assignment_ids = [assignment.id for assignment in assignments]

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