AppProject

toloka.client.app.AppProject | Source code

AppProject(
    self,
    *,
    app_id: Optional[str] = None,
    parent_app_project_id: Optional[str] = None,
    name: Optional[str] = None,
    parameters: Optional[Dict] = None,
    id: Optional[str] = None,
    status: Union[Status, str, None] = None,
    created: Optional[datetime] = None,
    item_price: Optional[Decimal] = None,
    errors: Optional[List[_AppError]] = None,
    read_only: Optional[bool] = None,
    app: Optional[AppLightestResult] = None
)

An Bespoke project.

An Bespoke project is based on one of Bespoke solutions. It is created with a template interface and preconfigured data specification and quality control rules.

To get available App solutions use the get_apps method.

Parameters description

Parameters	Type	Description
`app_id`	Optional[str]	The ID of the App solution used to create the project.
`parent_app_project_id`	Optional[str]	The ID of the parent project. It is set if this project is a clone of other project. Otherwise it is empty.
`name`	Optional[str]	The project name.
`parameters`	Optional[Dict]	Parameters of the solution. The parameters should follow the schema described in the `param_spec` field of the solution.
`id`	Optional[str]	The ID of the project.
`status`	Optional[Status]	The project status: `CREATING` — Toloka is checking the project. `READY` — The project is active. `ARCHIVED` — The project was archived. `ERROR` — Project creation failed due to errors.
`created`	Optional[datetime]	The date and time when the project was created.
`item_price`	Optional[Decimal]	The price you pay for a processed item.
`errors`	Optional[List[_AppError]]	Errors found during a project check.
`read_only`	Optional[bool]	`True` — The project is read-only. `False` — The project can be modified.
`app`	Optional[AppLightestResult]	Brief information about the project template.

Examples:

Creating an App project.

app_project = toloka.client.AppProject(
    app_id='9lZaMl363jahzra1rrYq',
    name='Example project (product relevance)',
    parameters={
        'default_language': 'en',
        'name': 'Product relevance project',
        'instruction_classes': [
            {
                'description': 'The product is relevant to the query.',
                'label': 'Relevant',
                'value': 'relevant'
            },
            {
                'description': 'The product is not completely relevant to the query.',
                'label': 'Irrelevant',
                'value': 'irrelevant'
            }
        ],
        'instruction_examples': [
            {
                'description': 'The product exactly matches the query.',
                'label': 'relevant',
                'query': 'some search query',
                'screenshot_url': 'https://example.com/1'
            },
            {
                'description': 'The product shape matches but the product color does not.',
                'label': 'irrelevant',
                'query': 'other search query',
                'screenshot_url': 'https://example.com/2'
            }
        ]
    }
)
app_project = toloka_client.create_app_project(app_project)
print(app_project.id, app_project.status)

Last updated: August 28, 2023

Toloka-Kit

Overview Getting API key Quick start

Recipes

Reference

toloka.client

toloka.async_client

toloka.autoquality [autoquality]

toloka.metrics

toloka.streaming