diff --git a/CHANGELOG.md b/CHANGELOG.md index f50866b1..29ec4924 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,24 @@ +0.1.24 +------------------- + +Fixes: +* Status code 409 is no longer retried by default. +* Status code 504 is now retried by default. +* Fixed bug when `AppItem.errors` have been structured incorrectly. +* Fixed the bug when an incorrect version of the `urllib3` was used. + +Changes: +* `toloka.client.filters.Rating` was removed according to changes in Toloka API. +* All time data now have a UTC timezone by default (instead of a local timezone). + +Streaming improvements: +* `toloka.streaming.Pipeline` now supports "gentle shutdown": the first SIGINT received will force the `Pipeline` to process all observers in the current iteration and then exit. On the second SIGINT received, the `Pipeline` will be interrupted (warning: this may lead to errors such as incorrect saved observers states). +* `toloka.streaming.Pipeline` now supports registering new observers during execution. +* Observers now support `delete`, `disable`, and `enable` methods: these methods change the target Observer state such that `toloka.streaming.Pipeline` handles it accordingly. + +Other improvements: +* Added [MapView](https://toloka.ai/en/docs/toloka-kit/reference/toloka.client.project.template_builder.view.MapViewV1) Template Builder component. + 0.1.23 ------------------- Python versions support: diff --git a/a.yaml b/a.yaml index 6b082b51..7f687663 100644 --- a/a.yaml +++ b/a.yaml @@ -9,3 +9,27 @@ ci: large-autostart: target: library/python/toloka-kit/functional_tests toolchains: default-linux-x86_64-release +# +# Review the commented section, replace logins and other texts inside !!! blocks and uncomment "review" section. +# If your a.yaml file has settings of 'arcanum\approve' merge requirement - remove it. +# Remove .devexp.json file with commiting your changes. +# In case of any questions: +# 1. Look at documentation: +# https://docs.yandex-team.ru/arcanum/pr/devexp +# https://docs.yandex-team.ru/arcanum/pr/review_configuration +# 2. Write to devtools support https://forms.yandex-team.ru/surveys/devtools/?service=arcanum +# 3. Join telegram channel https://t.me/+5mNt-TYK_fozNWEy +# +#arcanum: +# review: +# auto_assign: true +# groups: +# - name: "reviewers_group_1" +# roles: +# - "!!!!!! insert abc role code for logins: losev, sinosov, tulinev, vlad-mois, alexdrydew !!!!!!" +# override_policy: "override" +# rules: +# - reviewers: +# - name: "reviewers_group_1" +# ship: 1 +# assign: 1 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..16ddf741 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,25 @@ +# Introduction + +Toloka-Kit is an open source Python library allowing you to access [Toloka API](https://toloka.ai/docs/api/concepts/about.html). + +[Toloka](https://toloka.ai) is a cloud-based crowdsourcing platform that helps you to collect and analyze data for machine learning and other business purposes. + +Main advantages of Toloka are: + +* **Top-quality results** — Ready to use quality control methods allow you to get results that meet and exceed industry standards. +* **Scalable projects** — Have any amounts of image, text, speech, audio, or video data collected and annotated for you by millions of skilled Toloka workers. +* **Cost-efficiency** — Save time and money with this purpose-built platform for handling large scale data collection and annotation projects, on-demand 24/7, at your own price and within your timeframe. +* **Free, powerful API** — Build scalable and fully automated human-in-the-loop machine learning pipelines with a powerful open API. + +## Requirements + +To use the library you need to: + +* Install Python 3.6+ +* [Register](https://toloka.ai/docs/guide/concepts/access.html) as a requester in Toloka or in the Sandbox – the Toloka testing environment. +* [Top up your account](https://toloka.ai/docs/guide/concepts/refill.html) or use a promo code **TOLOKAKIT1**. You can also test your pipelines in the Sandbox for free. + +## Support + +* Join the [slack community](https://toloka.ai/community). +* [Contact support](https://toloka.ai/docs/guide/troubleshooting/support.html/?lang=en#troubleshooting__project-setting). diff --git a/docs/quick-start.md b/docs/quick-start.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/reference/_reference.ditamap b/docs/reference/_reference.ditamap deleted file mode 100644 index 9d84eb86..00000000 --- a/docs/reference/_reference.ditamap +++ /dev/null @@ -1,1047 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/reference/toc.yaml b/docs/reference/toc.yaml new file mode 100644 index 00000000..2bc49d8d --- /dev/null +++ b/docs/reference/toc.yaml @@ -0,0 +1,2288 @@ +title: Toloka-Kit Reference +items: +- name: toloka.client + items: + - name: Environment + href: toloka.client.TolokaClient.Environment.md + hidden: true + - name: TolokaClient methods + items: + - name: aggregation + items: + - name: aggregate_solutions_by_pool + href: toloka.client.TolokaClient.aggregate_solutions_by_pool.md + - name: aggregate_solutions_by_task + href: toloka.client.TolokaClient.aggregate_solutions_by_task.md + - name: find_aggregated_solutions + href: toloka.client.TolokaClient.find_aggregated_solutions.md + - name: get_aggregated_solutions + href: toloka.client.TolokaClient.get_aggregated_solutions.md + - name: analytics + items: + - name: get_analytics + href: toloka.client.TolokaClient.get_analytics.md + - name: app + items: + - name: archive_app_project + href: toloka.client.TolokaClient.archive_app_project.md + - name: create_app_batch + href: toloka.client.TolokaClient.create_app_batch.md + - name: create_app_item + href: toloka.client.TolokaClient.create_app_item.md + - name: create_app_items + href: toloka.client.TolokaClient.create_app_items.md + - name: create_app_project + href: toloka.client.TolokaClient.create_app_project.md + - name: find_app_batches + href: toloka.client.TolokaClient.find_app_batches.md + - name: find_app_items + href: toloka.client.TolokaClient.find_app_items.md + - name: find_app_projects + href: toloka.client.TolokaClient.find_app_projects.md + - name: find_apps + href: toloka.client.TolokaClient.find_apps.md + - name: get_app + href: toloka.client.TolokaClient.get_app.md + - name: get_app_batch + href: toloka.client.TolokaClient.get_app_batch.md + - name: get_app_batches + href: toloka.client.TolokaClient.get_app_batches.md + - name: get_app_item + href: toloka.client.TolokaClient.get_app_item.md + - name: get_app_items + href: toloka.client.TolokaClient.get_app_items.md + - name: get_app_project + href: toloka.client.TolokaClient.get_app_project.md + - name: get_app_projects + href: toloka.client.TolokaClient.get_app_projects.md + - name: get_apps + href: toloka.client.TolokaClient.get_apps.md + - name: start_app_batch + href: toloka.client.TolokaClient.start_app_batch.md + - name: unarchive_app_project + href: toloka.client.TolokaClient.unarchive_app_project.md + - name: assignments + items: + - name: accept_assignment + href: toloka.client.TolokaClient.accept_assignment.md + - name: find_assignments + href: toloka.client.TolokaClient.find_assignments.md + - name: get_assignment + href: toloka.client.TolokaClient.get_assignment.md + - name: get_assignments + href: toloka.client.TolokaClient.get_assignments.md + - name: get_assignments_df + href: toloka.client.TolokaClient.get_assignments_df.md + - name: patch_assignment + href: toloka.client.TolokaClient.patch_assignment.md + - name: reject_assignment + href: toloka.client.TolokaClient.reject_assignment.md + - name: attachments + items: + - name: find_attachments + href: toloka.client.TolokaClient.find_attachments.md + - name: get_attachment + href: toloka.client.TolokaClient.get_attachment.md + - name: get_attachments + href: toloka.client.TolokaClient.get_attachments.md + - name: download_attachment + href: toloka.client.TolokaClient.download_attachment.md + - name: messages + items: + - name: add_message_thread_to_folders + href: toloka.client.TolokaClient.add_message_thread_to_folders.md + - name: compose_message_thread + href: toloka.client.TolokaClient.compose_message_thread.md + - name: find_message_threads + href: toloka.client.TolokaClient.find_message_threads.md + - name: get_message_threads + href: toloka.client.TolokaClient.get_message_threads.md + - name: reply_message_thread + href: toloka.client.TolokaClient.reply_message_thread.md + - name: remove_message_thread_from_folders + href: toloka.client.TolokaClient.remove_message_thread_from_folders.md + - name: operations + items: + - name: get_operation + href: toloka.client.TolokaClient.get_operation.md + - name: get_operation_log + href: toloka.client.TolokaClient.get_operation_log.md + - name: wait_operation + href: toloka.client.TolokaClient.wait_operation.md + - name: pools + items: + - name: archive_pool + href: toloka.client.TolokaClient.archive_pool.md + - name: archive_pool_async + href: toloka.client.TolokaClient.archive_pool_async.md + - name: clone_pool + href: toloka.client.TolokaClient.clone_pool.md + - name: clone_pool_async + href: toloka.client.TolokaClient.clone_pool_async.md + - name: close_pool + href: toloka.client.TolokaClient.close_pool.md + - name: close_pool_async + href: toloka.client.TolokaClient.close_pool_async.md + - name: close_pool_for_update + href: toloka.client.TolokaClient.close_pool_for_update.md + - name: close_pool_for_update_async + href: toloka.client.TolokaClient.close_pool_for_update_async.md + - name: create_pool + href: toloka.client.TolokaClient.create_pool.md + - name: find_pools + href: toloka.client.TolokaClient.find_pools.md + - name: get_pool + href: toloka.client.TolokaClient.get_pool.md + - name: get_pools + href: toloka.client.TolokaClient.get_pools.md + - name: open_pool + href: toloka.client.TolokaClient.open_pool.md + - name: open_pool_async + href: toloka.client.TolokaClient.open_pool_async.md + - name: patch_pool + href: toloka.client.TolokaClient.patch_pool.md + - name: update_pool + href: toloka.client.TolokaClient.update_pool.md + - name: projects + items: + - name: archive_project + href: toloka.client.TolokaClient.archive_project.md + - name: archive_project_async + href: toloka.client.TolokaClient.archive_project_async.md + - name: create_project + href: toloka.client.TolokaClient.create_project.md + - name: clone_project + href: toloka.client.TolokaClient.clone_project.md + - name: find_projects + href: toloka.client.TolokaClient.find_projects.md + - name: get_project + href: toloka.client.TolokaClient.get_project.md + - name: get_projects + href: toloka.client.TolokaClient.get_projects.md + - name: update_project + href: toloka.client.TolokaClient.update_project.md + - name: requester + items: + - name: get_requester + href: toloka.client.TolokaClient.get_requester.md + - name: skills + items: + - name: create_skill + href: toloka.client.TolokaClient.create_skill.md + - name: find_skills + href: toloka.client.TolokaClient.find_skills.md + - name: get_skill + href: toloka.client.TolokaClient.get_skill.md + - name: get_skills + href: toloka.client.TolokaClient.get_skills.md + - name: update_skill + href: toloka.client.TolokaClient.update_skill.md + - name: tasks + items: + - name: create_task + href: toloka.client.TolokaClient.create_task.md + - name: create_tasks + href: toloka.client.TolokaClient.create_tasks.md + - name: create_tasks_async + href: toloka.client.TolokaClient.create_tasks_async.md + - name: find_tasks + href: toloka.client.TolokaClient.find_tasks.md + - name: get_task + href: toloka.client.TolokaClient.get_task.md + - name: get_tasks + href: toloka.client.TolokaClient.get_tasks.md + - name: patch_task + href: toloka.client.TolokaClient.patch_task.md + - name: patch_task_overlap_or_min + href: toloka.client.TolokaClient.patch_task_overlap_or_min.md + - name: task suites + items: + - name: create_task_suite + href: toloka.client.TolokaClient.create_task_suite.md + - name: create_task_suites + href: toloka.client.TolokaClient.create_task_suites.md + - name: create_task_suites_async + href: toloka.client.TolokaClient.create_task_suites_async.md + - name: find_task_suites + href: toloka.client.TolokaClient.find_task_suites.md + - name: get_task_suite + href: toloka.client.TolokaClient.get_task_suite.md + - name: get_task_suites + href: toloka.client.TolokaClient.get_task_suites.md + - name: patch_task_suite + href: toloka.client.TolokaClient.patch_task_suite.md + - name: patch_task_suite_overlap_or_min + href: toloka.client.TolokaClient.patch_task_suite_overlap_or_min.md + - name: training + items: + - name: archive_training + href: toloka.client.TolokaClient.archive_training.md + - name: archive_training_async + href: toloka.client.TolokaClient.archive_training_async.md + - name: clone_training + href: toloka.client.TolokaClient.clone_training.md + - name: clone_training_async + href: toloka.client.TolokaClient.clone_training_async.md + - name: close_training + href: toloka.client.TolokaClient.close_training.md + - name: close_training_async + href: toloka.client.TolokaClient.close_training_async.md + - name: create_training + href: toloka.client.TolokaClient.create_training.md + - name: find_trainings + href: toloka.client.TolokaClient.find_trainings.md + - name: get_training + href: toloka.client.TolokaClient.get_training.md + - name: get_trainings + href: toloka.client.TolokaClient.get_trainings.md + - name: open_training + href: toloka.client.TolokaClient.open_training.md + - name: open_training_async + href: toloka.client.TolokaClient.open_training_async.md + - name: update_training + href: toloka.client.TolokaClient.update_training.md + - name: user bonus + items: + - name: create_user_bonus + href: toloka.client.TolokaClient.create_user_bonus.md + - name: create_user_bonuses + href: toloka.client.TolokaClient.create_user_bonuses.md + - name: create_user_bonuses_async + href: toloka.client.TolokaClient.create_user_bonuses_async.md + - name: find_user_bonuses + href: toloka.client.TolokaClient.find_user_bonuses.md + - name: get_user_bonus + href: toloka.client.TolokaClient.get_user_bonus.md + - name: get_user_bonuses + href: toloka.client.TolokaClient.get_user_bonuses.md + - name: user restrictions + items: + - name: delete_user_restriction + href: toloka.client.TolokaClient.delete_user_restriction.md + - name: find_user_restrictions + href: toloka.client.TolokaClient.find_user_restrictions.md + - name: get_user_restriction + href: toloka.client.TolokaClient.get_user_restriction.md + - name: get_user_restrictions + href: toloka.client.TolokaClient.get_user_restrictions.md + - name: set_user_restriction + href: toloka.client.TolokaClient.set_user_restriction.md + - name: user skills + items: + - name: delete_user_skill + href: toloka.client.TolokaClient.delete_user_skill.md + - name: find_user_skills + href: toloka.client.TolokaClient.find_user_skills.md + - name: get_user_skill + href: toloka.client.TolokaClient.get_user_skill.md + - name: get_user_skills + href: toloka.client.TolokaClient.get_user_skills.md + - name: set_user_skill + href: toloka.client.TolokaClient.set_user_skill.md + - name: webhook subscription + items: + - name: delete_webhook_subscription + href: toloka.client.TolokaClient.delete_webhook_subscription.md + - name: find_webhook_subscriptions + href: toloka.client.TolokaClient.find_webhook_subscriptions.md + - name: get_webhook_subscription + href: toloka.client.TolokaClient.get_webhook_subscription.md + - name: get_webhook_subscriptions + href: toloka.client.TolokaClient.get_webhook_subscriptions.md + - name: upsert_webhook_subscriptions + href: toloka.client.TolokaClient.upsert_webhook_subscriptions.md + - name: actions + items: + - name: RuleType + href: toloka.client.actions.RuleType.md + hidden: true + - name: RuleAction + href: toloka.client.actions.RuleAction.md + hidden: true + - name: Restriction + href: toloka.client.actions.Restriction.md + - name: Parameters + href: toloka.client.actions.Restriction.Parameters.md + hidden: true + - name: RestrictionV2 + href: toloka.client.actions.RestrictionV2.md + - name: Parameters + href: toloka.client.actions.RestrictionV2.Parameters.md + hidden: true + - name: ChangeOverlap + href: toloka.client.actions.ChangeOverlap.md + - name: Parameters + href: toloka.client.actions.ChangeOverlap.Parameters.md + hidden: true + - name: SetSkill + href: toloka.client.actions.SetSkill.md + - name: Parameters + href: toloka.client.actions.SetSkill.Parameters.md + hidden: true + - name: SetSkillFromOutputField + href: toloka.client.actions.SetSkillFromOutputField.md + - name: Parameters + href: toloka.client.actions.SetSkillFromOutputField.Parameters.md + hidden: true + - name: ApproveAllAssignments + href: toloka.client.actions.ApproveAllAssignments.md + - name: RejectAllAssignments + href: toloka.client.actions.RejectAllAssignments.md + - name: Parameters + href: toloka.client.actions.RejectAllAssignments.Parameters.md + hidden: true + - name: aggregation + items: + - name: AggregatedSolution + href: toloka.client.aggregation.AggregatedSolution.md + - name: AggregatedSolutionType + href: toloka.client.aggregation.AggregatedSolutionType.md + hidden: true + - name: PoolAggregatedSolutionRequest.Field + href: toloka.client.aggregation.PoolAggregatedSolutionRequest.Field.md + hidden: true + - name: PoolAggregatedSolutionRequest + href: toloka.client.aggregation.PoolAggregatedSolutionRequest.md + - name: TaskAggregatedSolutionRequest + href: toloka.client.aggregation.TaskAggregatedSolutionRequest.md + - name: WeightedDynamicOverlapTaskAggregatedSolutionRequest.Field + href: toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.Field.md + hidden: true + - name: WeightedDynamicOverlapTaskAggregatedSolutionRequest + href: toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.md + - name: analytics_request + items: + - name: AnalyticsRequest + href: toloka.client.analytics_request.AnalyticsRequest.md + hidden: true + - name: ActiveWorkersByFilterCountPoolAnalytics + href: toloka.client.analytics_request.ActiveWorkersByFilterCountPoolAnalytics.md + - name: AnalyticsRequest.Subject + href: toloka.client.analytics_request.AnalyticsRequest.Subject.md + hidden: true + - name: ApprovedAssignmentsCountPoolAnalytics + href: toloka.client.analytics_request.ApprovedAssignmentsCountPoolAnalytics.md + - name: AvgSubmitAssignmentMillisPoolAnalytics + href: toloka.client.analytics_request.AvgSubmitAssignmentMillisPoolAnalytics.md + - name: CompletionPercentagePoolAnalytics + href: toloka.client.analytics_request.CompletionPercentagePoolAnalytics.md + - name: EstimatedAssignmentsCountPoolAnalytics + href: toloka.client.analytics_request.EstimatedAssignmentsCountPoolAnalytics.md + - name: PoolAnalyticsRequest + href: toloka.client.analytics_request.PoolAnalyticsRequest.md + hidden: true + - name: PoolAnalyticsRequest.Subject + href: toloka.client.analytics_request.PoolAnalyticsRequest.Subject.md + hidden: true + - name: RealTasksCountPoolAnalytics + href: toloka.client.analytics_request.RealTasksCountPoolAnalytics.md + - name: RejectedAssignmentsCountPoolAnalytics + href: toloka.client.analytics_request.RejectedAssignmentsCountPoolAnalytics.md + - name: SkippedAssignmentsCountPoolAnalytics + href: toloka.client.analytics_request.SkippedAssignmentsCountPoolAnalytics.md + - name: SpentBudgetPoolAnalytics + href: toloka.client.analytics_request.SpentBudgetPoolAnalytics.md + - name: SubmitedAssignmentsCountPoolAnalytics + href: toloka.client.analytics_request.SubmitedAssignmentsCountPoolAnalytics.md + - name: UniqueSubmittersCountPoolAnalytics + href: toloka.client.analytics_request.UniqueSubmittersCountPoolAnalytics.md + - name: UniqueWorkersCountPoolAnalytics + href: toloka.client.analytics_request.UniqueWorkersCountPoolAnalytics.md + - name: app + items: + - name: _AppError + href: toloka.client.app._AppError.md + hidden: true + - name: App + href: toloka.client.app.App.md + - name: AppBatch + href: toloka.client.app.AppBatch.md + - name: AppBatch.Status + href: toloka.client.app.AppBatch.Status.md + hidden: true + - name: AppBatchCreateRequest + href: toloka.client.app.AppBatchCreateRequest.md + - name: AppItem + href: toloka.client.app.AppItem.md + - name: AppItem.Status + href: toloka.client.app.AppItem.Status.md + hidden: true + - name: AppItemsCreateRequest + href: toloka.client.app.AppItemsCreateRequest.md + - name: AppProject + href: toloka.client.app.AppProject.md + - name: AppItem.Status + href: toloka.client.app.AppProject.Status.md + hidden: true + - name: assignment + items: + - name: Assignment + href: toloka.client.assignment.Assignment.md + - name: Assignment.Status + href: toloka.client.assignment.Assignment.Status.md + hidden: true + - name: AssignmentPatch + href: toloka.client.assignment.AssignmentPatch.md + - name: GetAssignmentsTsvParameters.Field + href: toloka.client.assignment.GetAssignmentsTsvParameters.Field.md + hidden: true + - name: GetAssignmentsTsvParameters + href: toloka.client.assignment.GetAssignmentsTsvParameters.md + - name: GetAssignmentsTsvParameters.Status + href: toloka.client.assignment.GetAssignmentsTsvParameters.Status.md + hidden: true + - name: attachment + items: + - name: Attachment + href: toloka.client.attachment.Attachment.md + hidden: true + - name: AssignmentAttachment + href: toloka.client.attachment.AssignmentAttachment.md + - name: Attachment.Details + href: toloka.client.attachment.Attachment.Details.md + hidden: true + - name: Attachment.Type + href: toloka.client.attachment.Attachment.Type.md + hidden: true + - name: batch_create_results + items: + - name: FieldValidationError + href: toloka.client.batch_create_results.FieldValidationError.md + hidden: true + - name: TaskBatchCreateResult + href: toloka.client.batch_create_results.TaskBatchCreateResult.md + - name: TaskSuiteBatchCreateResult + href: toloka.client.batch_create_results.TaskSuiteBatchCreateResult.md + - name: UserBonusBatchCreateResult + href: toloka.client.batch_create_results.UserBonusBatchCreateResult.md + - name: WebhookSubscriptionBatchCreateResult + href: toloka.client.batch_create_results.WebhookSubscriptionBatchCreateResult.md + - name: clone_results + items: + - name: CloneResults + href: toloka.client.clone_results.CloneResults.md + - name: collectors + items: + - name: CollectorConfig + href: toloka.client.collectors.CollectorConfig.md + hidden: true + - name: CollectorConfig.Type + href: toloka.client.collectors.CollectorConfig.Type.md + hidden: true + - name: CollectorConfig.validate_condition + href: toloka.client.collectors.CollectorConfig.validate_condition.md + hidden: true + - name: AcceptanceRate + href: toloka.client.collectors.AcceptanceRate.md + - name: AcceptanceRate.Parameters + href: toloka.client.collectors.AcceptanceRate.Parameters.md + hidden: true + - name: AnswerCount + href: toloka.client.collectors.AnswerCount.md + - name: AssignmentsAssessment + href: toloka.client.collectors.AssignmentsAssessment.md + - name: AssignmentSubmitTime + href: toloka.client.collectors.AssignmentSubmitTime.md + - name: AssignmentSubmitTime.Parameters + href: toloka.client.collectors.AssignmentSubmitTime.Parameters.md + hidden: true + - name: Captcha + href: toloka.client.collectors.Captcha.md + - name: Captcha.Parameters + href: toloka.client.collectors.Captcha.Parameters.md + hidden: true + - name: GoldenSet + href: toloka.client.collectors.GoldenSet.md + - name: GoldenSet.Parameters + href: toloka.client.collectors.GoldenSet.Parameters.md + hidden: true + - name: Income + href: toloka.client.collectors.Income.md + - name: MajorityVote + href: toloka.client.collectors.MajorityVote.md + - name: MajorityVote.Parameters + href: toloka.client.collectors.MajorityVote.Parameters.md + hidden: true + - name: SkippedInRowAssignments + href: toloka.client.collectors.SkippedInRowAssignments.md + - name: Training + href: toloka.client.collectors.Training.md + - name: UsersAssessment + href: toloka.client.collectors.UsersAssessment.md + - name: conditions + items: + - name: RuleCondition + href: toloka.client.conditions.RuleCondition.md + hidden: true + - name: RuleConditionKey + href: toloka.client.conditions.RuleConditionKey.md + hidden: true + - name: ComparableRuleCondition + href: toloka.client.conditions.ComparableRuleCondition.md + hidden: true + - name: IdentityRuleCondition + href: toloka.client.conditions.IdentityRuleCondition.md + hidden: true + - name: AcceptedAssignmentsRate + href: toloka.client.conditions.AcceptedAssignmentsRate.md + - name: AcceptedAssignmentsCount + href: toloka.client.conditions.AcceptedAssignmentsCount.md + - name: AssessmentEvent + href: toloka.client.conditions.AssessmentEvent.md + - name: AssessmentEvent.Type + href: toloka.client.conditions.AssessmentEvent.Type.md + hidden: true + - name: AssignmentsAcceptedCount + href: toloka.client.conditions.AssignmentsAcceptedCount.md + - name: CorrectAnswersRate + href: toloka.client.conditions.CorrectAnswersRate.md + - name: FailRate + href: toloka.client.conditions.FailRate.md + - name: FastSubmittedCount + href: toloka.client.conditions.FastSubmittedCount.md + - name: GoldenSetAnswersCount + href: toloka.client.conditions.GoldenSetAnswersCount.md + - name: GoldenSetCorrectAnswersRate + href: toloka.client.conditions.GoldenSetCorrectAnswersRate.md + - name: GoldenSetIncorrectAnswersRate + href: toloka.client.conditions.GoldenSetIncorrectAnswersRate.md + - name: IncomeSumForLast24Hours + href: toloka.client.conditions.IncomeSumForLast24Hours.md + - name: IncorrectAnswersRate + href: toloka.client.conditions.IncorrectAnswersRate.md + - name: NextAssignmentAvailable + href: toloka.client.conditions.NextAssignmentAvailable.md + - name: PendingAssignmentsCount + href: toloka.client.conditions.PendingAssignmentsCount.md + - name: PoolAccessRevokedReason + href: toloka.client.conditions.PoolAccessRevokedReason.md + - name: PoolAccessRevokedReason.Type + href: toloka.client.conditions.PoolAccessRevokedReason.Type.md + hidden: true + - name: RejectedAssignmentsCount + href: toloka.client.conditions.RejectedAssignmentsCount.md + - name: RejectedAssignmentsRate + href: toloka.client.conditions.RejectedAssignmentsRate.md + - name: SkillId + href: toloka.client.conditions.SkillId.md + - name: SkippedInRowCount + href: toloka.client.conditions.SkippedInRowCount.md + - name: StoredResultsCount + href: toloka.client.conditions.StoredResultsCount.md + - name: SubmittedAssignmentsCount + href: toloka.client.conditions.SubmittedAssignmentsCount.md + - name: SuccessRate + href: toloka.client.conditions.SuccessRate.md + - name: TotalAnswersCount + href: toloka.client.conditions.TotalAnswersCount.md + - name: TotalAssignmentsCount + href: toloka.client.conditions.TotalAssignmentsCount.md + - name: TotalSubmittedCount + href: toloka.client.conditions.TotalSubmittedCount.md + - name: error_codes + items: + - name: CommonErrorCodes + href: toloka.client.error_codes.CommonErrorCodes.md + - name: InternalErrorCodes + href: toloka.client.error_codes.InternalErrorCodes.md + - name: ValidationErrorCodes + href: toloka.client.error_codes.ValidationErrorCodes.md + - name: exceptions + items: + - name: SpecClassIdentificationError + href: toloka.client.exceptions.SpecClassIdentificationError.md + hidden: true + - name: ApiError + href: toloka.client.exceptions.ApiError.md + hidden: true + - name: AccessDeniedApiError + href: toloka.client.exceptions.AccessDeniedApiError.md + - name: AuthenticationApiError + href: toloka.client.exceptions.AuthenticationApiError.md + - name: ConflictStateApiError + href: toloka.client.exceptions.ConflictStateApiError.md + - name: DoesNotExistApiError + href: toloka.client.exceptions.DoesNotExistApiError.md + - name: FailedOperation + href: toloka.client.exceptions.FailedOperation.md + - name: IncorrectActionsApiError + href: toloka.client.exceptions.IncorrectActionsApiError.md + - name: InternalApiError + href: toloka.client.exceptions.InternalApiError.md + - name: raise_on_api_error + href: toloka.client.exceptions.raise_on_api_error.md + hidden: true + - name: RemoteServiceUnavailableApiError + href: toloka.client.exceptions.RemoteServiceUnavailableApiError.md + - name: TooManyRequestsApiError + href: toloka.client.exceptions.TooManyRequestsApiError.md + - name: ValidationApiError + href: toloka.client.exceptions.ValidationApiError.md + - name: filter + items: + - name: FilterCondition + href: toloka.client.filter.FilterCondition.md + hidden: true + - name: FilterOr + href: toloka.client.filter.FilterOr.md + hidden: true + - name: FilterAnd + href: toloka.client.filter.FilterAnd.md + hidden: true + - name: Condition + href: toloka.client.filter.Condition.md + hidden: true + - name: Condition.Category + href: toloka.client.filter.Condition.Category.md + hidden: true + - name: AdultAllowed + href: toloka.client.filter.AdultAllowed.md + - name: Citizenship + href: toloka.client.filter.Citizenship.md + - name: City + href: toloka.client.filter.City.md + - name: ClientType.ClientType + href: toloka.client.filter.ClientType.ClientType.md + hidden: true + - name: ClientType + href: toloka.client.filter.ClientType.md + - name: Computed + href: toloka.client.filter.Computed.md + - name: Computed.Key + href: toloka.client.filter.Computed.Key.md + hidden: true + - name: Country + href: toloka.client.filter.Country.md + - name: DateOfBirth + href: toloka.client.filter.DateOfBirth.md + - name: DeviceCategory.DeviceCategory + href: toloka.client.filter.DeviceCategory.DeviceCategory.md + hidden: true + - name: DeviceCategory + href: toloka.client.filter.DeviceCategory.md + - name: Education + href: toloka.client.filter.Education.md + - name: Education.Education + href: toloka.client.filter.Education.Education.md + hidden: true + - name: Gender + href: toloka.client.filter.Gender.md + - name: Gender.Gender + href: toloka.client.filter.Gender.Gender.md + hidden: true + - name: Languages + href: toloka.client.filter.Languages.md + - name: OSFamily + href: toloka.client.filter.OSFamily.md + - name: OSFamily.OSFamily + href: toloka.client.filter.OSFamily.OSFamily.md + hidden: true + - name: OSVersion + href: toloka.client.filter.OSVersion.md + - name: OSVersionBugfix + href: toloka.client.filter.OSVersionBugfix.md + - name: OSVersionMajor + href: toloka.client.filter.OSVersionMajor.md + - name: OSVersionMinor + href: toloka.client.filter.OSVersionMinor.md + - name: Profile + href: toloka.client.filter.Profile.md + - name: Profile.Key + href: toloka.client.filter.Profile.Key.md + hidden: true + - name: RegionByIp + href: toloka.client.filter.RegionByIp.md + - name: RegionByPhone + href: toloka.client.filter.RegionByPhone.md + - name: Skill + href: toloka.client.filter.Skill.md + - name: UserAgentFamily + href: toloka.client.filter.UserAgentFamily.md + - name: UserAgentFamily.UserAgentFamily + href: toloka.client.filter.UserAgentFamily.UserAgentFamily.md + - name: UserAgentType + href: toloka.client.filter.UserAgentType.md + - name: UserAgentType.UserAgentType + href: toloka.client.filter.UserAgentType.UserAgentType.md + hidden: true + - name: UserAgentVersion + href: toloka.client.filter.UserAgentVersion.md + - name: UserAgentVersionBugfix + href: toloka.client.filter.UserAgentVersionBugfix.md + - name: UserAgentVersionMajor + href: toloka.client.filter.UserAgentVersionMajor.md + - name: UserAgentVersionMinor + href: toloka.client.filter.UserAgentVersionMinor.md + - name: message_thread + items: + - name: MessageThread + href: toloka.client.message_thread.MessageThread.md + - name: Folder + href: toloka.client.message_thread.Folder.md + hidden: true + - name: InterlocutorRole + href: toloka.client.message_thread.Interlocutor.InterlocutorRole.md + hidden: true + - name: Interlocutor + href: toloka.client.message_thread.Interlocutor.md + - name: MessageThread.ComposeDetails + href: toloka.client.message_thread.MessageThread.ComposeDetails.md + hidden: true + - name: MessageThread.Message + href: toloka.client.message_thread.MessageThread.Message.md + hidden: true + - name: MessageThread.Meta + href: toloka.client.message_thread.MessageThread.Meta.md + hidden: true + - name: MessageThreadCompose + href: toloka.client.message_thread.MessageThreadCompose.md + - name: MessageThreadFolders + href: toloka.client.message_thread.MessageThreadFolders.md + - name: MessageThreadReply + href: toloka.client.message_thread.MessageThreadReply.md + - name: RecipientsSelectType + href: toloka.client.message_thread.RecipientsSelectType.md + hidden: true + - name: operations + items: + - name: Operation + href: toloka.client.operations.Operation.md + hidden: true + - name: AggregatedSolutionOperation + href: toloka.client.operations.AggregatedSolutionOperation.md + - name: AggregatedSolutionOperation.Parameters + href: toloka.client.operations.AggregatedSolutionOperation.Parameters.md + hidden: true + - name: AnalyticsOperation + href: toloka.client.operations.AnalyticsOperation.md + - name: Operation.is_completed + href: toloka.client.operations.Operation.is_completed.md + hidden: true + - name: Operation.Parameters + href: toloka.client.operations.Operation.Parameters.md + hidden: true + - name: Operation.Status + href: toloka.client.operations.Operation.Status.md + hidden: true + - name: OperationType + href: toloka.client.operations.OperationType.md + hidden: true + - name: PoolArchiveOperation + href: toloka.client.operations.PoolArchiveOperation.md + - name: PoolCloneOperation.Details + href: toloka.client.operations.PoolCloneOperation.Details.md + hidden: true + - name: PoolCloneOperation + href: toloka.client.operations.PoolCloneOperation.md + - name: PoolCloseOperation + href: toloka.client.operations.PoolCloseOperation.md + - name: PoolOpenOperation + href: toloka.client.operations.PoolOpenOperation.md + - name: PoolOperation + href: toloka.client.operations.PoolOperation.md + hidden: true + - name: PoolOperation.Parameters + href: toloka.client.operations.PoolOperation.Parameters.md + hidden: true + - name: ProjectArchiveOperation + href: toloka.client.operations.ProjectArchiveOperation.md + - name: ProjectArchiveOperation.Parameters + href: toloka.client.operations.ProjectArchiveOperation.Parameters.md + hidden: true + - name: Operation.raise_on_fail + href: toloka.client.operations.Operation.raise_on_fail.md + hidden: true + - name: TasksCreateOperation + href: toloka.client.operations.TasksCreateOperation.md + - name: TasksCreateOperation.Parameters + href: toloka.client.operations.TasksCreateOperation.Parameters.md + hidden: true + - name: TaskSuiteCreateBatchOperation + href: toloka.client.operations.TaskSuiteCreateBatchOperation.md + - name: TaskSuiteCreateBatchOperation.Parameters + href: toloka.client.operations.TaskSuiteCreateBatchOperation.Parameters.md + hidden: true + - name: TrainingArchiveOperation + href: toloka.client.operations.TrainingArchiveOperation.md + - name: TrainingCloneOperation.Details + href: toloka.client.operations.TrainingCloneOperation.Details.md + hidden: true + - name: TrainingCloneOperation + href: toloka.client.operations.TrainingCloneOperation.md + - name: TrainingCloseOperation + href: toloka.client.operations.TrainingCloseOperation.md + - name: TrainingOpenOperation + href: toloka.client.operations.TrainingOpenOperation.md + - name: TrainingOperation + href: toloka.client.operations.TrainingOperation.md + hidden: true + - name: TrainingOperation.Parameters + href: toloka.client.operations.TrainingOperation.Parameters.md + hidden: true + - name: UserBonusCreateBatchOperation.Details + href: toloka.client.operations.UserBonusCreateBatchOperation.Details.md + hidden: true + - name: UserBonusCreateBatchOperation + href: toloka.client.operations.UserBonusCreateBatchOperation.md + - name: UserBonusCreateBatchOperation.Parameters + href: toloka.client.operations.UserBonusCreateBatchOperation.Parameters.md + hidden: true + - name: operation_log + items: + - name: OperationLogItem + href: toloka.client.operation_log.OperationLogItem.md + - name: owner + items: + - name: Owner + href: toloka.client.owner.Owner.md + - name: pool + items: + - name: Pool + href: toloka.client.pool.Pool.md + - name: Pool.AssignmentsIssuingConfig + href: toloka.client.pool.Pool.AssignmentsIssuingConfig.md + hidden: true + - name: Pool.CloseReason + href: toloka.client.pool.Pool.CloseReason.md + hidden: true + - name: Pool.Defaults + href: toloka.client.pool.Pool.Defaults.md + hidden: true + - name: Pool.is_archived + href: toloka.client.pool.Pool.is_archived.md + hidden: true + - name: Pool.is_closed + href: toloka.client.pool.Pool.is_closed.md + hidden: true + - name: Pool.is_locked + href: toloka.client.pool.Pool.is_locked.md + hidden: true + - name: Pool.is_open + href: toloka.client.pool.Pool.is_open.md + hidden: true + - name: Pool.Status + href: toloka.client.pool.Pool.Status.md + hidden: true + - name: Pool.TrainingConfig + href: toloka.client.pool.Pool.TrainingConfig.md + hidden: true + - name: Pool.Type + href: toloka.client.pool.Pool.Type.md + hidden: true + - name: PoolPatchRequest + href: toloka.client.pool.PoolPatchRequest.md + - name: codegen_setter_for_assignments_issuing_config + href: toloka.client.pool.codegen_setter_for_assignments_issuing_config.md + hidden: true + - name: codegen_setter_for_defaults + href: toloka.client.pool.codegen_setter_for_defaults.md + hidden: true + - name: codegen_setter_for_dynamic_overlap_config + href: toloka.client.pool.codegen_setter_for_dynamic_overlap_config.md + hidden: true + - name: codegen_setter_for_dynamic_pricing_config + href: toloka.client.pool.codegen_setter_for_dynamic_pricing_config.md + hidden: true + - name: codegen_setter_for_filter + href: toloka.client.pool.codegen_setter_for_filter.md + hidden: true + - name: codegen_setter_for_mixer_config + href: toloka.client.pool.codegen_setter_for_mixer_config.md + hidden: true + - name: codegen_setter_for_owner + href: toloka.client.pool.codegen_setter_for_owner.md + hidden: true + - name: codegen_setter_for_quality_control + href: toloka.client.pool.codegen_setter_for_quality_control.md + hidden: true + - name: codegen_setter_for_quality_control_captcha_frequency + href: toloka.client.pool.codegen_setter_for_quality_control_captcha_frequency.md + hidden: true + - name: codegen_setter_for_quality_control_checkpoints_config + href: toloka.client.pool.codegen_setter_for_quality_control_checkpoints_config.md + hidden: true + - name: codegen_setter_for_quality_control_configs + href: toloka.client.pool.codegen_setter_for_quality_control_configs.md + hidden: true + - name: codegen_setter_for_quality_control_training_requirement + href: toloka.client.pool.codegen_setter_for_quality_control_training_requirement.md + hidden: true + - name: codegen_setter_for_training_config + href: toloka.client.pool.codegen_setter_for_training_config.md + hidden: true + - name: dynamic_overlap_config + items: + - name: DynamicOverlapConfig + href: toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.md + - name: DynamicOverlapConfig.Field + href: toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Field.md + hidden: true + - name: DynamicOverlapConfig.Type + href: toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Type.md + hidden: true + - name: DynamicPricingConfig + href: toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.md + - name: DynamicPricingConfig.Interval + href: toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Interval.md + hidden: true + - name: DynamicPricingConfig.Type + href: toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Type.md + hidden: true + - name: mixer_config + items: + - name: MixerConfig + href: toloka.client.pool.mixer_config.MixerConfig.md + - name: primitives + items: + - name: base + items: + - name: autocast_to_enum + href: toloka.client.primitives.base.autocast_to_enum.md + - name: BaseParameters + href: toloka.client.primitives.base.BaseParameters.md + - name: BaseParameters.Parameters + href: toloka.client.primitives.base.BaseParameters.Parameters.md + hidden: true + - name: BaseTolokaObject + href: toloka.client.primitives.base.BaseTolokaObject.md + - name: BaseTolokaObject.from_json + href: toloka.client.primitives.base.BaseTolokaObject.from_json.md + hidden: true + - name: BaseTolokaObject.get_spec_subclass_for_value + href: toloka.client.primitives.base.BaseTolokaObject.get_spec_subclass_for_value.md + hidden: true + - name: BaseTolokaObject.get_variant_specs + href: toloka.client.primitives.base.BaseTolokaObject.get_variant_specs.md + hidden: true + - name: BaseTolokaObject.is_variant_base + href: toloka.client.primitives.base.BaseTolokaObject.is_variant_base.md + hidden: true + - name: BaseTolokaObject.is_variant_incomplete + href: toloka.client.primitives.base.BaseTolokaObject.is_variant_incomplete.md + hidden: true + - name: BaseTolokaObject.is_variant_spec + href: toloka.client.primitives.base.BaseTolokaObject.is_variant_spec.md + hidden: true + - name: BaseTolokaObject.to_json + href: toloka.client.primitives.base.BaseTolokaObject.to_json.md + hidden: true + - name: BaseTolokaObjectMetaclass + href: toloka.client.primitives.base.BaseTolokaObjectMetaclass.md + hidden: true + - name: BaseTolokaObjectMetaclass.transformer + href: toloka.client.primitives.base.BaseTolokaObjectMetaclass.transformer.md + hidden: true + - name: VariantRegistry + href: toloka.client.primitives.base.VariantRegistry.md + hidden: true + - name: VariantRegistry.register + href: toloka.client.primitives.base.VariantRegistry.register.md + hidden: true + - name: infinite_overlap + items: + - name: InfiniteOverlapParametersMixin + href: toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin.md + - name: InfiniteOverlapParametersMixin.unset_overlap + href: toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin.unset_overlap.md + hidden: true + - name: operators + hidden: true + items: + - name: ComparableConditionMixin + href: toloka.client.primitives.operators.ComparableConditionMixin.md + - name: CompareOperator + href: toloka.client.primitives.operators.CompareOperator.md + - name: IdentityConditionMixin + href: toloka.client.primitives.operators.IdentityConditionMixin.md + - name: IdentityOperator + href: toloka.client.primitives.operators.IdentityOperator.md + - name: InclusionConditionMixin + href: toloka.client.primitives.operators.InclusionConditionMixin.md + - name: InclusionOperator + href: toloka.client.primitives.operators.InclusionOperator.md + - name: StatefulComparableConditionMixin.eq + href: toloka.client.primitives.operators.StatefulComparableConditionMixin.eq.md + hidden: true + - name: StatefulComparableConditionMixin.gt + href: toloka.client.primitives.operators.StatefulComparableConditionMixin.gt.md + hidden: true + - name: StatefulComparableConditionMixin.gte + href: toloka.client.primitives.operators.StatefulComparableConditionMixin.gte.md + hidden: true + - name: StatefulComparableConditionMixin.lt + href: toloka.client.primitives.operators.StatefulComparableConditionMixin.lt.md + hidden: true + - name: StatefulComparableConditionMixin.lte + href: toloka.client.primitives.operators.StatefulComparableConditionMixin.lte.md + hidden: true + - name: StatefulComparableConditionMixin.md + href: toloka.client.primitives.operators.StatefulComparableConditionMixin.md + - name: StatefulComparableConditionMixin.ne + href: toloka.client.primitives.operators.StatefulComparableConditionMixin.ne.md + hidden: true + - name: parameter + hidden: true + items: + - name: Parameters + href: toloka.client.primitives.parameter.Parameters.md + hidden: true + - name: retry + items: + - name: PreloadingHTTPAdapter + href: toloka.client.primitives.retry.PreloadingHTTPAdapter.md + - name: PreloadingHTTPAdapter.build_response + href: toloka.client.primitives.retry.PreloadingHTTPAdapter.build_response.md + hidden: true + - name: PreloadingHTTPAdapter.get_connection + href: toloka.client.primitives.retry.PreloadingHTTPAdapter.get_connection.md + hidden: true + - name: TolokaRetry + href: toloka.client.primitives.retry.TolokaRetry.md + - name: TolokaRetry.get_retry_after + href: toloka.client.primitives.retry.TolokaRetry.get_retry_after.md + hidden: true + - name: TolokaRetry.increment + href: toloka.client.primitives.retry.TolokaRetry.increment.md + hidden: true + - name: TolokaRetry.new + href: toloka.client.primitives.retry.TolokaRetry.new.md + hidden: true + - name: TolokaRetry.Unit + href: toloka.client.primitives.retry.TolokaRetry.Unit.md + hidden: true + - name: project + items: + - name: Project + href: toloka.client.project.Project.md + - name: Project.add_requester_translation + href: toloka.client.project.Project.add_requester_translation.md + hidden: true + - name: Project.AssignmentsIssuingType + href: toloka.client.project.Project.AssignmentsIssuingType.md + hidden: true + - name: Project.AssignmentsIssuingViewConfig + href: toloka.client.project.Project.AssignmentsIssuingViewConfig.md + hidden: true + - name: Project.ProjectStatus + href: toloka.client.project.Project.ProjectStatus.md + hidden: true + - name: Project.set_default_language + href: toloka.client.project.Project.set_default_language.md + hidden: true + - name: localization + items: + - name: AdditionalLanguage + href: toloka.client.project.localization.AdditionalLanguage.md + - name: AdditionalLanguage.FieldTranslation.Source + href: toloka.client.project.localization.AdditionalLanguage.FieldTranslation.Source.md + hidden: true + - name: AdditionalLanguage.FieldTranslation + href: toloka.client.project.localization.AdditionalLanguage.FieldTranslation.md + hidden: true + - name: LocalizationConfig + href: toloka.client.project.localization.LocalizationConfig.md + - name: field_spec + items: + - name: FieldSpec + href: toloka.client.project.field_spec.FieldSpec.md + hidden: true + - name: ArrayBooleanSpec + href: toloka.client.project.field_spec.ArrayBooleanSpec.md + - name: ArrayCoordinatesSpec + href: toloka.client.project.field_spec.ArrayCoordinatesSpec.md + - name: ArrayFileSpec + href: toloka.client.project.field_spec.ArrayFileSpec.md + - name: ArrayFloatSpec + href: toloka.client.project.field_spec.ArrayFloatSpec.md + - name: ArrayIntegerSpec + href: toloka.client.project.field_spec.ArrayIntegerSpec.md + - name: ArrayStringSpec + href: toloka.client.project.field_spec.ArrayStringSpec.md + - name: ArrayUrlSpec + href: toloka.client.project.field_spec.ArrayUrlSpec.md + - name: BooleanSpec + href: toloka.client.project.field_spec.BooleanSpec.md + - name: CoordinatesSpec + href: toloka.client.project.field_spec.CoordinatesSpec.md + - name: FieldType + href: toloka.client.project.field_spec.FieldType.md + - name: FileSpec + href: toloka.client.project.field_spec.FileSpec.md + - name: FloatSpec + href: toloka.client.project.field_spec.FloatSpec.md + - name: IntegerSpec + href: toloka.client.project.field_spec.IntegerSpec.md + - name: JsonSpec + href: toloka.client.project.field_spec.JsonSpec.md + - name: StringSpec + href: toloka.client.project.field_spec.StringSpec.md + - name: UrlSpec + href: toloka.client.project.field_spec.UrlSpec.md + - name: task_spec + items: + - name: TaskSpec + href: toloka.client.project.task_spec.TaskSpec.md + - name: view_spec + items: + - name: ViewSpec + href: toloka.client.project.view_spec.ViewSpec.md + hidden: true + - name: ViewSpec.Settings + href: toloka.client.project.view_spec.ViewSpec.Settings.md + hidden: true + - name: ViewSpec.Type + href: toloka.client.project.view_spec.ViewSpec.Type.md + hidden: true + - name: ClassicViewSpec + href: toloka.client.project.view_spec.ClassicViewSpec.md + - name: ClassicViewSpec.Assets + href: toloka.client.project.view_spec.ClassicViewSpec.Assets.md + hidden: true + - name: TemplateBuilderViewSpec + href: toloka.client.project.view_spec.TemplateBuilderViewSpec.md + - name: quality_control + items: + - name: QualityControl + href: toloka.client.quality_control.QualityControl.md + - name: QualityControl.add_action + href: toloka.client.quality_control.QualityControl.add_action.md + hidden: true + - name: QualityControl.CaptchaFrequency + href: toloka.client.quality_control.QualityControl.CaptchaFrequency.md + hidden: true + - name: QualityControl.CheckpointsConfig + href: toloka.client.quality_control.QualityControl.CheckpointsConfig.md + hidden: true + - name: QualityControl.CheckpointsConfig.Settings + href: toloka.client.quality_control.QualityControl.CheckpointsConfig.Settings.md + hidden: true + - name: QualityControl.QualityControlConfig + href: toloka.client.quality_control.QualityControl.QualityControlConfig.md + hidden: true + - name: QualityControl.QualityControlConfig.RuleConfig + href: toloka.client.quality_control.QualityControl.QualityControlConfig.RuleConfig.md + hidden: true + - name: QualityControl.TrainingRequirement + href: toloka.client.quality_control.QualityControl.TrainingRequirement.md + hidden: true + - name: requester + items: + - name: Requester + href: toloka.client.requester.Requester.md + - name: Requester.Company + href: toloka.client.requester.Requester.Company.md + hidden: true + - name: search_requests + items: + - name: BaseSortItem + href: toloka.client.search_requests.BaseSortItem.md + hidden: true + - name: BaseSortItem.for_fields + href: toloka.client.search_requests.BaseSortItem.for_fields.md + hidden: true + - name: BaseSortItems + href: toloka.client.search_requests.BaseSortItems.md + hidden: true + - name: BaseSortItems.for_fields + href: toloka.client.search_requests.BaseSortItems.for_fields.md + hidden: true + - name: AggregatedSolutionSortItems.SortItem.SortField + href: toloka.client.search_requests.AggregatedSolutionSortItems.SortItem.SortField.md + hidden: true + - name: AggregatedSolutionSortItems.SortItem + href: toloka.client.search_requests.AggregatedSolutionSortItems.SortItem.md + hidden: true + - name: AppBatchSortItems.SortItem.SortField + href: toloka.client.search_requests.AppBatchSortItems.SortItem.SortField.md + hidden: true + - name: AppBatchSortItems.SortItem + href: toloka.client.search_requests.AppBatchSortItems.SortItem.md + hidden: true + - name: AppItemSortItems.SortItem.SortField + href: toloka.client.search_requests.AppItemSortItems.SortItem.SortField.md + hidden: true + - name: AppItemSortItems.SortItem + href: toloka.client.search_requests.AppItemSortItems.SortItem.md + hidden: true + - name: AppProjectSortItems.SortItem.SortField + href: toloka.client.search_requests.AppProjectSortItems.SortItem.SortField.md + hidden: true + - name: AppProjectSortItems.SortItem + href: toloka.client.search_requests.AppProjectSortItems.SortItem.md + hidden: true + - name: AppSortItems.SortItem.SortField + href: toloka.client.search_requests.AppSortItems.SortItem.SortField.md + hidden: true + - name: AppSortItems.SortItem + href: toloka.client.search_requests.AppSortItems.SortItem.md + hidden: true + - name: AssignmentSortItems.SortItem.SortField + href: toloka.client.search_requests.AssignmentSortItems.SortItem.SortField.md + hidden: true + - name: AssignmentSortItems.SortItem + href: toloka.client.search_requests.AssignmentSortItems.SortItem.md + hidden: true + - name: AttachmentSortItems.SortItem.SortField + href: toloka.client.search_requests.AttachmentSortItems.SortItem.SortField.md + hidden: true + - name: AttachmentSortItems.SortItem + href: toloka.client.search_requests.AttachmentSortItems.SortItem.md + hidden: true + - name: MessageThreadSortItems.SortItem.SortField + href: toloka.client.search_requests.MessageThreadSortItems.SortItem.SortField.md + hidden: true + - name: MessageThreadSortItems.SortItem + href: toloka.client.search_requests.MessageThreadSortItems.SortItem.md + hidden: true + - name: PoolSortItems.SortItem.SortField + href: toloka.client.search_requests.PoolSortItems.SortItem.SortField.md + hidden: true + - name: PoolSortItems.SortItem + href: toloka.client.search_requests.PoolSortItems.SortItem.md + hidden: true + - name: ProjectSortItems.SortItem.SortField + href: toloka.client.search_requests.ProjectSortItems.SortItem.SortField.md + hidden: true + - name: ProjectSortItems.SortItem + href: toloka.client.search_requests.ProjectSortItems.SortItem.md + hidden: true + - name: SkillSortItems.SortItem.SortField + href: toloka.client.search_requests.SkillSortItems.SortItem.SortField.md + hidden: true + - name: SkillSortItems.SortItem + href: toloka.client.search_requests.SkillSortItems.SortItem.md + hidden: true + - name: TaskSortItems.SortItem.SortField + href: toloka.client.search_requests.TaskSortItems.SortItem.SortField.md + hidden: true + - name: TaskSortItems.SortItem + href: toloka.client.search_requests.TaskSortItems.SortItem.md + hidden: true + - name: TaskSuiteSortItems.SortItem.SortField + href: toloka.client.search_requests.TaskSuiteSortItems.SortItem.SortField.md + hidden: true + - name: TaskSuiteSortItems.SortItem + href: toloka.client.search_requests.TaskSuiteSortItems.SortItem.md + hidden: true + - name: TrainingSortItems.SortItem.SortField + href: toloka.client.search_requests.TrainingSortItems.SortItem.SortField.md + hidden: true + - name: TrainingSortItems.SortItem + href: toloka.client.search_requests.TrainingSortItems.SortItem.md + hidden: true + - name: UserBonusSortItems.SortItem.SortField + href: toloka.client.search_requests.UserBonusSortItems.SortItem.SortField.md + hidden: true + - name: UserBonusSortItems.SortItem + href: toloka.client.search_requests.UserBonusSortItems.SortItem.md + hidden: true + - name: UserRestrictionSortItems.SortItem.SortField + href: toloka.client.search_requests.UserRestrictionSortItems.SortItem.SortField.md + hidden: true + - name: UserRestrictionSortItems.SortItem + href: toloka.client.search_requests.UserRestrictionSortItems.SortItem.md + hidden: true + - name: UserSkillSortItems.SortItem.SortField + href: toloka.client.search_requests.UserSkillSortItems.SortItem.SortField.md + hidden: true + - name: UserSkillSortItems.SortItem + href: toloka.client.search_requests.UserSkillSortItems.SortItem.md + hidden: true + - name: WebhookSubscriptionSortItems.SortItem.SortField + href: toloka.client.search_requests.WebhookSubscriptionSortItems.SortItem.SortField.md + hidden: true + - name: WebhookSubscriptionSortItems.SortItem + href: toloka.client.search_requests.WebhookSubscriptionSortItems.SortItem.md + hidden: true + - name: AggregatedSolutionSortItems + href: toloka.client.search_requests.AggregatedSolutionSortItems.md + - name: AppBatchSortItems + href: toloka.client.search_requests.AppBatchSortItems.md + - name: AppItemSortItems + href: toloka.client.search_requests.AppItemSortItems.md + - name: AppProjectSortItems + href: toloka.client.search_requests.AppProjectSortItems.md + - name: AppSortItems + href: toloka.client.search_requests.AppSortItems.md + - name: AssignmentSortItems + href: toloka.client.search_requests.AssignmentSortItems.md + - name: AttachmentSortItems + href: toloka.client.search_requests.AttachmentSortItems.md + - name: MessageThreadSortItems + href: toloka.client.search_requests.MessageThreadSortItems.md + - name: PoolSortItems + href: toloka.client.search_requests.PoolSortItems.md + - name: ProjectSortItems + href: toloka.client.search_requests.ProjectSortItems.md + - name: SkillSortItems + href: toloka.client.search_requests.SkillSortItems.md + - name: TaskSortItems + href: toloka.client.search_requests.TaskSortItems.md + - name: TaskSuiteSortItems + href: toloka.client.search_requests.TaskSuiteSortItems.md + - name: TrainingSortItems + href: toloka.client.search_requests.TrainingSortItems.md + - name: UserBonusSortItems + href: toloka.client.search_requests.UserBonusSortItems.md + - name: UserRestrictionSortItems + href: toloka.client.search_requests.UserRestrictionSortItems.md + - name: UserSkillSortItems + href: toloka.client.search_requests.UserSkillSortItems.md + - name: WebhookSubscriptionSortItems + href: toloka.client.search_requests.WebhookSubscriptionSortItems.md + - name: BaseSearchRequest + href: toloka.client.search_requests.BaseSearchRequest.md + hidden: true + - name: BaseSearchRequest.CompareFields + href: toloka.client.search_requests.BaseSearchRequest.CompareFields.md + hidden: true + - name: AggregatedSolutionSearchRequest + href: toloka.client.search_requests.AggregatedSolutionSearchRequest.md + - name: AggregatedSolutionSearchRequest.CompareFields + href: toloka.client.search_requests.AggregatedSolutionSearchRequest.CompareFields.md + hidden: true + - name: AppBatchSearchRequest + href: toloka.client.search_requests.AppBatchSearchRequest.md + - name: AppBatchSearchRequest.CompareFields + href: toloka.client.search_requests.AppBatchSearchRequest.CompareFields.md + hidden: true + - name: AppItemSearchRequest + href: toloka.client.search_requests.AppItemSearchRequest.md + - name: AppItemSearchRequest.CompareFields + href: toloka.client.search_requests.AppItemSearchRequest.CompareFields.md + hidden: true + - name: AppProjectSearchRequest + href: toloka.client.search_requests.AppProjectSearchRequest.md + - name: AppProjectSearchRequest.CompareFields + href: toloka.client.search_requests.AppProjectSearchRequest.CompareFields.md + hidden: true + - name: AppProjectSearchRequest.Scope + href: toloka.client.search_requests.AppProjectSearchRequest.Scope.md + hidden: true + - name: AppSearchRequest + href: toloka.client.search_requests.AppSearchRequest.md + - name: AppSearchRequest.CompareFields + href: toloka.client.search_requests.AppSearchRequest.CompareFields.md + hidden: true + - name: AssignmentSearchRequest + href: toloka.client.search_requests.AssignmentSearchRequest.md + - name: AssignmentSearchRequest.CompareFields + href: toloka.client.search_requests.AssignmentSearchRequest.CompareFields.md + hidden: true + - name: AttachmentSearchRequest + href: toloka.client.search_requests.AttachmentSearchRequest.md + - name: AttachmentSearchRequest.CompareFields + href: toloka.client.search_requests.AttachmentSearchRequest.CompareFields.md + hidden: true + - name: MessageThreadSearchRequest + href: toloka.client.search_requests.MessageThreadSearchRequest.md + - name: MessageThreadSearchRequest.CompareFields + href: toloka.client.search_requests.MessageThreadSearchRequest.CompareFields.md + hidden: true + - name: ProjectSearchRequest + href: toloka.client.search_requests.ProjectSearchRequest.md + - name: ProjectSearchRequest.CompareFields + href: toloka.client.search_requests.ProjectSearchRequest.CompareFields.md + hidden: true + - name: PoolSearchRequest + href: toloka.client.search_requests.PoolSearchRequest.md + - name: PoolSearchRequest.CompareFields + href: toloka.client.search_requests.PoolSearchRequest.CompareFields.md + hidden: true + - name: SkillSearchRequest + href: toloka.client.search_requests.SkillSearchRequest.md + - name: SkillSearchRequest.CompareFields + href: toloka.client.search_requests.SkillSearchRequest.CompareFields.md + hidden: true + - name: TaskSearchRequest + href: toloka.client.search_requests.TaskSearchRequest.md + - name: TaskSearchRequest.CompareFields + href: toloka.client.search_requests.TaskSearchRequest.CompareFields.md + hidden: true + - name: TaskSuiteSearchRequest + href: toloka.client.search_requests.TaskSuiteSearchRequest.md + - name: TaskSuiteSearchRequest.CompareFields + href: toloka.client.search_requests.TaskSuiteSearchRequest.CompareFields.md + hidden: true + - name: TrainingSearchRequest + href: toloka.client.search_requests.TrainingSearchRequest.md + - name: TrainingSearchRequest.CompareFields + href: toloka.client.search_requests.TrainingSearchRequest.CompareFields.md + hidden: true + - name: UserBonusSearchRequest + href: toloka.client.search_requests.UserBonusSearchRequest.md + - name: UserBonusSearchRequest.CompareFields + href: toloka.client.search_requests.UserBonusSearchRequest.CompareFields.md + hidden: true + - name: UserRestrictionSearchRequest + href: toloka.client.search_requests.UserRestrictionSearchRequest.md + - name: UserRestrictionSearchRequest.CompareFields + href: toloka.client.search_requests.UserRestrictionSearchRequest.CompareFields.md + hidden: true + - name: UserSkillSearchRequest + href: toloka.client.search_requests.UserSkillSearchRequest.md + - name: UserSkillSearchRequest.CompareFields + href: toloka.client.search_requests.UserSkillSearchRequest.CompareFields.md + hidden: true + - name: WebhookSubscriptionSearchRequest + href: toloka.client.search_requests.WebhookSubscriptionSearchRequest.md + - name: WebhookSubscriptionSearchRequest.CompareFields + href: toloka.client.search_requests.WebhookSubscriptionSearchRequest.CompareFields.md + hidden: true + - name: SearchRequestMetaclass + href: toloka.client.search_requests.SearchRequestMetaclass.md + hidden: true + - name: SortOrder + href: toloka.client.search_requests.SortOrder.md + hidden: true + - name: search_results + items: + - name: AggregatedSolutionSearchResult + href: toloka.client.search_results.AggregatedSolutionSearchResult.md + - name: AppBatchSearchResult + href: toloka.client.search_results.AppBatchSearchResult.md + - name: AppItemSearchResult + href: toloka.client.search_results.AppItemSearchResult.md + - name: AppProjectSearchResult + href: toloka.client.search_results.AppProjectSearchResult.md + - name: AppSearchResult + href: toloka.client.search_results.AppSearchResult.md + - name: AssignmentSearchResult + href: toloka.client.search_results.AssignmentSearchResult.md + - name: AttachmentSearchResult + href: toloka.client.search_results.AttachmentSearchResult.md + - name: MessageThreadSearchResult + href: toloka.client.search_results.MessageThreadSearchResult.md + - name: PoolSearchResult + href: toloka.client.search_results.PoolSearchResult.md + - name: ProjectSearchResult + href: toloka.client.search_results.ProjectSearchResult.md + - name: SkillSearchResult + href: toloka.client.search_results.SkillSearchResult.md + - name: TaskSearchResult + href: toloka.client.search_results.TaskSearchResult.md + - name: TaskSuiteSearchResult + href: toloka.client.search_results.TaskSuiteSearchResult.md + - name: TrainingSearchResult + href: toloka.client.search_results.TrainingSearchResult.md + - name: UserBonusSearchResult + href: toloka.client.search_results.UserBonusSearchResult.md + - name: UserRestrictionSearchResult + href: toloka.client.search_results.UserRestrictionSearchResult.md + - name: UserSkillSearchResult + href: toloka.client.search_results.UserSkillSearchResult.md + - name: WebhookSubscriptionSearchResult + href: toloka.client.search_results.WebhookSubscriptionSearchResult.md + - name: skill + items: + - name: Skill + href: toloka.client.skill.Skill.md + - name: solution + items: + - name: Solution + href: toloka.client.solution.Solution.md + - name: task + items: + - name: BaseTask + href: toloka.client.task.BaseTask.md + hidden: true + - name: BaseTask.KnownSolution + href: toloka.client.task.BaseTask.KnownSolution.md + hidden: true + - name: Task + href: toloka.client.task.Task.md + - name: Task.BaselineSolution + href: toloka.client.task.Task.BaselineSolution.md + hidden: true + - name: CreateTaskParameters + href: toloka.client.task.CreateTaskParameters.md + - name: CreateTaskAsyncParameters + href: toloka.client.task.CreateTaskAsyncParameters.md + - name: CreateTasksParameters + href: toloka.client.task.CreateTasksParameters.md + - name: TaskOverlapPatch + href: toloka.client.task.TaskOverlapPatch.md + - name: TaskPatch + href: toloka.client.task.TaskPatch.md + - name: task_distribution_function + items: + - name: TaskDistributionFunction + href: toloka.client.task_distribution_function.TaskDistributionFunction.md + - name: TaskDistributionFunction.Distribution + href: toloka.client.task_distribution_function.TaskDistributionFunction.Distribution.md + hidden: true + - name: TaskDistributionFunction.Interval + href: toloka.client.task_distribution_function.TaskDistributionFunction.Interval.md + hidden: true + - name: TaskDistributionFunction.Scope + href: toloka.client.task_distribution_function.TaskDistributionFunction.Scope.md + hidden: true + - name: task_suite + items: + - name: TaskSuite + href: toloka.client.task_suite.TaskSuite.md + - name: TaskSuite.add_base_task + href: toloka.client.task_suite.TaskSuite.add_base_task.md + hidden: true + - name: TaskSuiteCreateRequestParameters + href: toloka.client.task_suite.TaskSuiteCreateRequestParameters.md + - name: TaskSuiteOverlapPatch + href: toloka.client.task_suite.TaskSuiteOverlapPatch.md + - name: TaskSuitePatch + href: toloka.client.task_suite.TaskSuitePatch.md + - name: template_builder + items: + - name: get_input_and_output + href: toloka.client.project.template_builder.get_input_and_output.md + - name: TemplateBuilder + href: toloka.client.project.template_builder.TemplateBuilder.md + - name: actions + items: + - name: BaseActionV1 + href: toloka.client.project.template_builder.actions.BaseActionV1.md + hidden: true + - name: BulkActionV1 + href: toloka.client.project.template_builder.actions.BulkActionV1.md + - name: NotifyActionV1 + href: toloka.client.project.template_builder.actions.NotifyActionV1.md + - name: NotifyActionV1.Payload + href: toloka.client.project.template_builder.actions.NotifyActionV1.Payload.md + hidden: true + - name: NotifyActionV1.Payload.Theme + href: toloka.client.project.template_builder.actions.NotifyActionV1.Payload.Theme.md + hidden: true + - name: OpenCloseActionV1 + href: toloka.client.project.template_builder.actions.OpenCloseActionV1.md + - name: OpenLinkActionV1 + href: toloka.client.project.template_builder.actions.OpenLinkActionV1.md + - name: PlayPauseActionV1 + href: toloka.client.project.template_builder.actions.PlayPauseActionV1.md + - name: RotateActionV1 + href: toloka.client.project.template_builder.actions.RotateActionV1.md + - name: RotateActionV1.Payload + href: toloka.client.project.template_builder.actions.RotateActionV1.Payload.md + hidden: true + - name: SetActionV1 + href: toloka.client.project.template_builder.actions.SetActionV1.md + - name: ToggleActionV1 + href: toloka.client.project.template_builder.actions.ToggleActionV1.md + - name: base + items: + - name: BaseComponent + href: toloka.client.project.template_builder.base.BaseComponent.md + hidden: true + - name: BaseComponentOr + href: toloka.client.project.template_builder.base.BaseComponentOr.md + hidden: true + - name: BaseTemplate + href: toloka.client.project.template_builder.base.BaseTemplate.md + hidden: true + - name: BaseTemplateMetaclass + href: toloka.client.project.template_builder.base.BaseTemplateMetaclass.md + hidden: true + - name: base_component_or + href: toloka.client.project.template_builder.base.base_component_or.md + hidden: true + - name: ComponentType + href: toloka.client.project.template_builder.base.ComponentType.md + hidden: true + - name: ListDirection + href: toloka.client.project.template_builder.base.ListDirection.md + hidden: true + - name: ListSize + href: toloka.client.project.template_builder.base.ListSize.md + hidden: true + - name: RefComponent + href: toloka.client.project.template_builder.base.RefComponent.md + - name: UnknownComponent + href: toloka.client.project.template_builder.base.UnknownComponent.md + - name: VersionedBaseComponentMetaclass + href: toloka.client.project.template_builder.base.VersionedBaseComponentMetaclass.md + hidden: true + - name: conditions + items: + - name: AllConditionV1 + href: toloka.client.project.template_builder.conditions.AllConditionV1.md + - name: AnyConditionV1 + href: toloka.client.project.template_builder.conditions.AnyConditionV1.md + - name: BaseConditionV1 + href: toloka.client.project.template_builder.conditions.BaseConditionV1.md + hidden: true + - name: DistanceConditionV1 + href: toloka.client.project.template_builder.conditions.DistanceConditionV1.md + - name: EmptyConditionV1 + href: toloka.client.project.template_builder.conditions.EmptyConditionV1.md + - name: EqualsConditionV1 + href: toloka.client.project.template_builder.conditions.EqualsConditionV1.md + - name: LinkOpenedConditionV1 + href: toloka.client.project.template_builder.conditions.LinkOpenedConditionV1.md + - name: NotConditionV1 + href: toloka.client.project.template_builder.conditions.NotConditionV1.md + - name: PlayedConditionV1 + href: toloka.client.project.template_builder.conditions.PlayedConditionV1.md + - name: PlayedFullyConditionV1 + href: toloka.client.project.template_builder.conditions.PlayedFullyConditionV1.md + - name: RequiredConditionV1 + href: toloka.client.project.template_builder.conditions.RequiredConditionV1.md + - name: SameDomainConditionV1 + href: toloka.client.project.template_builder.conditions.SameDomainConditionV1.md + - name: SchemaConditionV1 + href: toloka.client.project.template_builder.conditions.SchemaConditionV1.md + - name: SubArrayConditionV1 + href: toloka.client.project.template_builder.conditions.SubArrayConditionV1.md + - name: data + items: + - name: BaseData + href: toloka.client.project.template_builder.data.BaseData.md + hidden: true + - name: InputData + href: toloka.client.project.template_builder.data.InputData.md + - name: InternalData + href: toloka.client.project.template_builder.data.InternalData.md + - name: LocalData + href: toloka.client.project.template_builder.data.LocalData.md + - name: LocationData + href: toloka.client.project.template_builder.data.LocationData.md + - name: OutputData + href: toloka.client.project.template_builder.data.OutputData.md + - name: RelativeData + href: toloka.client.project.template_builder.data.RelativeData.md + - name: fields + items: + - name: BaseFieldV1 + href: toloka.client.project.template_builder.fields.BaseFieldV1.md + hidden: true + - name: AudioFieldV1 + href: toloka.client.project.template_builder.fields.AudioFieldV1.md + - name: ButtonRadioFieldV1 + href: toloka.client.project.template_builder.fields.ButtonRadioFieldV1.md + - name: ButtonRadioGroupFieldV1 + href: toloka.client.project.template_builder.fields.ButtonRadioGroupFieldV1.md + - name: CheckboxFieldV1 + href: toloka.client.project.template_builder.fields.CheckboxFieldV1.md + - name: CheckboxGroupFieldV1 + href: toloka.client.project.template_builder.fields.CheckboxGroupFieldV1.md + - name: DateFieldV1 + href: toloka.client.project.template_builder.fields.DateFieldV1.md + - name: EmailFieldV1 + href: toloka.client.project.template_builder.fields.EmailFieldV1.md + - name: FileFieldV1 + href: toloka.client.project.template_builder.fields.FileFieldV1.md + - name: GroupFieldOption + href: toloka.client.project.template_builder.fields.GroupFieldOption.md + hidden: true + - name: ImageAnnotationFieldV1 + href: toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.md + - name: ImageAnnotationFieldV1.Label + href: toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Label.md + hidden: true + - name: ImageAnnotationFieldV1.Shape + href: toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Shape.md + hidden: true + - name: ListFieldV1 + href: toloka.client.project.template_builder.fields.ListFieldV1.md + - name: MediaFileFieldV1 + href: toloka.client.project.template_builder.fields.MediaFileFieldV1.md + - name: MediaFileFieldV1.Accept + href: toloka.client.project.template_builder.fields.MediaFileFieldV1.Accept.md + hidden: true + - name: NumberFieldV1 + href: toloka.client.project.template_builder.fields.NumberFieldV1.md + - name: PhoneNumberFieldV1 + href: toloka.client.project.template_builder.fields.PhoneNumberFieldV1.md + - name: RadioGroupFieldV1 + href: toloka.client.project.template_builder.fields.RadioGroupFieldV1.md + - name: SelectFieldV1 + href: toloka.client.project.template_builder.fields.SelectFieldV1.md + - name: SelectFieldV1.Option + href: toloka.client.project.template_builder.fields.SelectFieldV1.Option.md + hidden: true + - name: TextAnnotationFieldV1 + href: toloka.client.project.template_builder.fields.TextAnnotationFieldV1.md + - name: TextAnnotationFieldV1.Label + href: toloka.client.project.template_builder.fields.TextAnnotationFieldV1.Label.md + hidden: true + - name: TextareaFieldV1 + href: toloka.client.project.template_builder.fields.TextareaFieldV1.md + - name: TextFieldV1 + href: toloka.client.project.template_builder.fields.TextFieldV1.md + - name: helpers + items: + - name: BaseHelperV1 + href: toloka.client.project.template_builder.helpers.BaseHelperV1.md + hidden: true + - name: ConcatArraysHelperV1 + href: toloka.client.project.template_builder.helpers.ConcatArraysHelperV1.md + - name: Entries2ObjectHelperV1 + href: toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1.md + - name: Entries2ObjectHelperV1.Entry + href: toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1.Entry.md + hidden: true + - name: IfHelperV1 + href: toloka.client.project.template_builder.helpers.IfHelperV1.md + - name: JoinHelperV1 + href: toloka.client.project.template_builder.helpers.JoinHelperV1.md + - name: Object2EntriesHelperV1 + href: toloka.client.project.template_builder.helpers.Object2EntriesHelperV1.md + - name: ReplaceHelperV1 + href: toloka.client.project.template_builder.helpers.ReplaceHelperV1.md + - name: SearchQueryHelperV1 + href: toloka.client.project.template_builder.helpers.SearchQueryHelperV1.md + - name: SearchQueryHelperV1.Engine + href: toloka.client.project.template_builder.helpers.SearchQueryHelperV1.Engine.md + hidden: true + - name: SwitchHelperV1 + href: toloka.client.project.template_builder.helpers.SwitchHelperV1.md + - name: SwitchHelperV1.Case + href: toloka.client.project.template_builder.helpers.SwitchHelperV1.Case.md + hidden: true + - name: TextTransformHelperV1 + href: toloka.client.project.template_builder.helpers.TextTransformHelperV1.md + - name: TextTransformHelperV1.Transformation + href: toloka.client.project.template_builder.helpers.TextTransformHelperV1.Transformation.md + hidden: true + - name: TransformHelperV1 + href: toloka.client.project.template_builder.helpers.TransformHelperV1.md + - name: TranslateHelperV1 + href: toloka.client.project.template_builder.helpers.TranslateHelperV1.md + - name: YandexDiskProxyHelperV1 + href: toloka.client.project.template_builder.helpers.YandexDiskProxyHelperV1.md + - name: layouts + items: + - name: BarsLayoutV1 + href: toloka.client.project.template_builder.layouts.BarsLayoutV1.md + - name: BaseLayoutV1 + href: toloka.client.project.template_builder.layouts.BaseLayoutV1.md + hidden: true + - name: ColumnsLayoutV1 + href: toloka.client.project.template_builder.layouts.ColumnsLayoutV1.md + - name: ColumnsLayoutV1.VerticalAlign + href: toloka.client.project.template_builder.layouts.ColumnsLayoutV1.VerticalAlign.md + hidden: true + - name: CompareLayoutV1 + href: toloka.client.project.template_builder.layouts.CompareLayoutV1.md + - name: CompareLayoutItem + href: toloka.client.project.template_builder.layouts.CompareLayoutItem.md + hidden: true + - name: SidebarLayoutV1 + href: toloka.client.project.template_builder.layouts.SidebarLayoutV1.md + - name: SideBySideLayoutV1 + href: toloka.client.project.template_builder.layouts.SideBySideLayoutV1.md + - name: plugins + items: + - name: BasePluginV1 + href: toloka.client.project.template_builder.plugins.BasePluginV1.md + hidden: true + - name: HotkeysPluginV1 + href: toloka.client.project.template_builder.plugins.HotkeysPluginV1.md + - name: ImageAnnotationHotkeysPluginV1 + href: toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1.md + - name: ImageAnnotationHotkeysPluginV1.Mode + href: toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1.Mode.md + hidden: true + - name: TextAnnotationHotkeysPluginV1 + href: toloka.client.project.template_builder.plugins.TextAnnotationHotkeysPluginV1.md + - name: TolokaPluginV1 + href: toloka.client.project.template_builder.plugins.TolokaPluginV1.md + - name: TolokaPluginV1.TolokaPluginLayout + href: toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout.md + hidden: true + - name: TolokaPluginV1.TolokaPluginLayout.Kind + href: toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout.Kind.md + hidden: true + - name: TriggerPluginV1 + href: toloka.client.project.template_builder.plugins.TriggerPluginV1.md + - name: views + items: + - name: ActionButtonViewV1 + href: toloka.client.project.template_builder.view.ActionButtonViewV1.md + - name: AlertViewV1 + href: toloka.client.project.template_builder.view.AlertViewV1.md + - name: AlertViewV1.Theme + href: toloka.client.project.template_builder.view.AlertViewV1.Theme.md + hidden: true + - name: AudioViewV1 + href: toloka.client.project.template_builder.view.AudioViewV1.md + - name: BaseViewV1 + href: toloka.client.project.template_builder.view.BaseViewV1.md + hidden: true + - name: CollapseViewV1 + href: toloka.client.project.template_builder.view.CollapseViewV1.md + - name: DeviceFrameViewV1 + href: toloka.client.project.template_builder.view.DeviceFrameViewV1.md + - name: DividerViewV1 + href: toloka.client.project.template_builder.view.DividerViewV1.md + - name: GroupViewV1 + href: toloka.client.project.template_builder.view.GroupViewV1.md + - name: IframeViewV1 + href: toloka.client.project.template_builder.view.IframeViewV1.md + - name: ImageViewV1 + href: toloka.client.project.template_builder.view.ImageViewV1.md + - name: LabeledListViewV1.Item + href: toloka.client.project.template_builder.view.LabeledListViewV1.Item.md + hidden: true + - name: LabeledListViewV1 + href: toloka.client.project.template_builder.view.LabeledListViewV1.md + - name: LinkViewV1 + href: toloka.client.project.template_builder.view.LinkViewV1.md + - name: LinkGroupViewV1.Link + href: toloka.client.project.template_builder.view.LinkGroupViewV1.Link.md + hidden: true + - name: LinkGroupViewV1 + href: toloka.client.project.template_builder.view.LinkGroupViewV1.md + - name: ListViewV1 + href: toloka.client.project.template_builder.view.ListViewV1.md + - name: MapViewV1.Marker + href: toloka.client.project.template_builder.view.MapViewV1.Marker.md + hidden: true + - name: MapViewV1.Polygon + href: toloka.client.project.template_builder.view.MapViewV1.Polygon.md + hidden: true + - name: MapViewV1 + href: toloka.client.project.template_builder.view.MapViewV1.md + - name: MarkdownViewV1 + href: toloka.client.project.template_builder.view.MarkdownViewV1.md + - name: TextViewV1 + href: toloka.client.project.template_builder.view.TextViewV1.md + - name: VideoViewV1 + href: toloka.client.project.template_builder.view.VideoViewV1.md + - name: training + items: + - name: Training + href: toloka.client.training.Training.md + - name: Training.CloseReason + href: toloka.client.training.Training.CloseReason.md + hidden: true + - name: Training.is_archived + href: toloka.client.training.Training.is_archived.md + hidden: true + - name: Training.is_closed + href: toloka.client.training.Training.is_closed.md + hidden: true + - name: Training.is_locked + href: toloka.client.training.Training.is_locked.md + hidden: true + - name: Training.is_open + href: toloka.client.training.Training.is_open.md + hidden: true + - name: Training.Status + href: toloka.client.training.Training.Status.md + hidden: true + - name: codegen_setter_for_owner + href: toloka.client.training.codegen_setter_for_owner.md + hidden: true + - name: user_bonus + items: + - name: UserBonus + href: toloka.client.user_bonus.UserBonus.md + - name: UserBonusCreateRequestParameters + href: toloka.client.user_bonus.UserBonusCreateRequestParameters.md + - name: user_restriction + items: + - name: UserRestriction + href: toloka.client.user_restriction.UserRestriction.md + hidden: true + - name: UserRestriction.Scope + href: toloka.client.user_restriction.UserRestriction.Scope.md + hidden: true + - name: AllProjectsUserRestriction + href: toloka.client.user_restriction.AllProjectsUserRestriction.md + - name: DurationUnit + href: toloka.client.user_restriction.DurationUnit.md + - name: PoolUserRestriction + href: toloka.client.user_restriction.PoolUserRestriction.md + - name: ProjectUserRestriction + href: toloka.client.user_restriction.ProjectUserRestriction.md + - name: SystemUserRestriction + href: toloka.client.user_restriction.SystemUserRestriction.md + - name: user_skill + items: + - name: UserSkill + href: toloka.client.user_skill.UserSkill.md + - name: SetUserSkillRequest + href: toloka.client.user_skill.SetUserSkillRequest.md + - name: webhook_subscription + items: + - name: WebhookSubscription + href: toloka.client.webhook_subscription.WebhookSubscription.md + - name: WebhookSubscription.EventType + href: toloka.client.webhook_subscription.WebhookSubscription.EventType.md + hidden: true +- name: toloka.async_client + items: + - name: AsyncTolokaClient + href: toloka.async_client.client.AsyncTolokaClient.md + - name: AsyncTolokaClient.from_sync_client + href: toloka.async_client.client.AsyncTolokaClient.from_sync_client.md + hidden: true + - name: AsyncTolokaClient.wait_operation + href: toloka.async_client.client.AsyncTolokaClient.wait_operation.md + hidden: true +- name: toloka.metrics + items: + - name: collector + items: + - name: MetricCollector + href: toloka.metrics.collector.MetricCollector.md + - name: MetricCollector.create_async_tasks + href: toloka.metrics.collector.MetricCollector.create_async_tasks.md + hidden: true + - name: MetricCollector.run + href: toloka.metrics.collector.MetricCollector.run.md + - name: jupyter_dashboard + items: + - name: Chart + href: toloka.metrics.jupyter_dashboard.Chart.md + - name: Chart.create_async_tasks + href: toloka.metrics.jupyter_dashboard.Chart.create_async_tasks.md + hidden: true + - name: Chart.create_figure + href: toloka.metrics.jupyter_dashboard.Chart.create_figure.md + hidden: true + - name: Chart.update_metrics + href: toloka.metrics.jupyter_dashboard.Chart.update_metrics.md + hidden: true + - name: DashBoard + href: toloka.metrics.jupyter_dashboard.DashBoard.md + - name: DashBoard.run_dash + href: toloka.metrics.jupyter_dashboard.DashBoard.run_dash.md + hidden: true + - name: DashBoard.stop_dash + href: toloka.metrics.jupyter_dashboard.DashBoard.stop_dash.md + hidden: true + - name: DashBoard.update_charts + href: toloka.metrics.jupyter_dashboard.DashBoard.update_charts.md + hidden: true + - name: LineStats + href: toloka.metrics.jupyter_dashboard.LineStats.md + hidden: true + - name: metrics + items: + - name: BaseMetric.md + href: toloka.metrics.metrics.BaseMetric.md + hidden: true + - name: BaseMetric.get_lines + href: toloka.metrics.metrics.BaseMetric.get_lines.md + hidden: true + - name: BaseMetric.get_line_names + href: toloka.metrics.metrics.BaseMetric.get_line_names.md + hidden: true + - name: bind_client + href: toloka.metrics.metrics.bind_client.md + - name: Balance + href: toloka.metrics.metrics.Balance.md + - name: Balance.get_line_names + href: toloka.metrics.metrics.Balance.get_line_names.md + hidden: true + - name: NewMessageThreads + href: toloka.metrics.metrics.NewMessageThreads.md + - name: NewMessageThreads.get_line_names + href: toloka.metrics.metrics.NewMessageThreads.get_line_names.md + hidden: true + - name: NewUserBonuses + href: toloka.metrics.metrics.NewUserBonuses.md + - name: NewUserBonuses.get_line_names + href: toloka.metrics.metrics.NewUserBonuses.get_line_names.md + hidden: true + - name: NewUserSkills + href: toloka.metrics.metrics.NewUserSkills.md + - name: NewUserSkills.get_line_names + href: toloka.metrics.metrics.NewUserSkills.get_line_names.md + hidden: true + - name: pool_metrics + items: + - name: AssignmentEventsInPool + href: toloka.metrics.pool_metrics.AssignmentEventsInPool.md + - name: AssignmentEventsInPool.get_line_names + href: toloka.metrics.pool_metrics.AssignmentEventsInPool.get_line_names.md + hidden: true + - name: AssignmentsInPool + href: toloka.metrics.pool_metrics.AssignmentsInPool.md + - name: AssignmentsInPool.get_line_names + href: toloka.metrics.pool_metrics.AssignmentsInPool.get_line_names.md + hidden: true + - name: BansInPool + href: toloka.metrics.pool_metrics.BansInPool.md + - name: BansInPool.get_line_names + href: toloka.metrics.pool_metrics.BansInPool.get_line_names.md + hidden: true + - name: BasePoolMetric + href: toloka.metrics.pool_metrics.BasePoolMetric.md + hidden: true + - name: PoolCompletedPercentage + href: toloka.metrics.pool_metrics.PoolCompletedPercentage.md + - name: PoolCompletedPercentage.get_line_names + href: toloka.metrics.pool_metrics.PoolCompletedPercentage.get_line_names.md + hidden: true + - name: SpentBudgetOnPool + href: toloka.metrics.pool_metrics.SpentBudgetOnPool.md + - name: SpentBudgetOnPool.get_line_names + href: toloka.metrics.pool_metrics.SpentBudgetOnPool.get_line_names.md + hidden: true + - name: TasksInPool + href: toloka.metrics.pool_metrics.TasksInPool.md + - name: TasksInPool.get_line_names + href: toloka.metrics.pool_metrics.TasksInPool.get_line_names.md + hidden: true + - name: WorkersByFilterOnPool + href: toloka.metrics.pool_metrics.WorkersByFilterOnPool.md + - name: WorkersByFilterOnPool.get_line_names + href: toloka.metrics.pool_metrics.WorkersByFilterOnPool.get_line_names.md + hidden: true +- name: toloka.streaming + items: + - name: cursor + items: + - name: BaseCursor.inject + href: toloka.streaming.cursor.BaseCursor.inject.md + hidden: true + - name: BaseCursor + href: toloka.streaming.cursor.BaseCursor.md + hidden: true + - name: BaseCursor.CursorFetchContext + href: toloka.streaming.cursor.BaseCursor.CursorFetchContext.md + hidden: true + - name: BaseCursor.try_fetch_all + href: toloka.streaming.cursor.BaseCursor.try_fetch_all.md + hidden: true + - name: AssignmentCursor + href: toloka.streaming.cursor.AssignmentCursor.md + - name: MessageThreadCursor + href: toloka.streaming.cursor.MessageThreadCursor.md + - name: TaskCursor + href: toloka.streaming.cursor.TaskCursor.md + - name: UserBonusCursor + href: toloka.streaming.cursor.UserBonusCursor.md + - name: UserRestrictionCursor + href: toloka.streaming.cursor.UserRestrictionCursor.md + - name: UserSkillCursor + href: toloka.streaming.cursor.UserSkillCursor.md + - name: locker + hidden: true + items: + - name: BaseLocker.cleanup + href: toloka.streaming.locker.BaseLocker.cleanup.md + hidden: true + - name: BaseLocker + href: toloka.streaming.locker.BaseLocker.md + hidden: true + - name: FileLocker.cleanup + href: toloka.streaming.locker.FileLocker.cleanup.md + hidden: true + - name: FileLocker + href: toloka.streaming.locker.FileLocker.md + hidden: true + - name: NewerInstanceDetectedError + href: toloka.streaming.locker.NewerInstanceDetectedError.md + hidden: true + - name: ZooKeeperLocker + href: toloka.streaming.locker.ZooKeeperLocker.md + hidden: true + - name: event + items: + - name: BaseEvent + href: toloka.streaming.event.BaseEvent.md + hidden: true + - name: AssignmentEvent + href: toloka.streaming.event.AssignmentEvent.md + - name: AssignmentEvent.Type + href: toloka.streaming.event.AssignmentEvent.Type.md + hidden: true + - name: MessageThreadEvent + href: toloka.streaming.event.MessageThreadEvent.md + - name: TaskEvent + href: toloka.streaming.event.TaskEvent.md + - name: UserBonusEvent + href: toloka.streaming.event.UserBonusEvent.md + - name: UserRestrictionEvent + href: toloka.streaming.event.UserRestrictionEvent.md + - name: UserSkillEvent + href: toloka.streaming.event.UserSkillEvent.md + - name: UserSkillEvent.Type + href: toloka.streaming.event.UserSkillEvent.Type.md + hidden: true + - name: observer + items: + - name: AssignmentsObserver.inject + href: toloka.streaming.observer.AssignmentsObserver.inject.md + hidden: true + - name: BaseObserver.inject + href: toloka.streaming.observer.BaseObserver.inject.md + hidden: true + - name: PoolStatusObserver.inject + href: toloka.streaming.observer.PoolStatusObserver.inject.md + hidden: true + - name: BaseObserver + href: toloka.streaming.observer.BaseObserver.md + hidden: true + - name: BaseObserver.delete + href: toloka.streaming.observer.BaseObserver.delete.md + hidden: true + - name: BaseObserver.disable + href: toloka.streaming.observer.BaseObserver.disable.md + hidden: true + - name: BaseObserver.enable + href: toloka.streaming.observer.BaseObserver.enable.md + hidden: true + - name: BaseObserver.run + href: toloka.streaming.observer.BaseObserver.run.md + hidden: true + - name: BaseObserver.should_resume + href: toloka.streaming.observer.BaseObserver.should_resume.md + hidden: true + - name: AssignmentsObserver + href: toloka.streaming.observer.AssignmentsObserver.md + - name: AssignmentsObserver.on_accepted + href: toloka.streaming.observer.AssignmentsObserver.on_accepted.md + hidden: true + - name: AssignmentsObserver.on_any_event + href: toloka.streaming.observer.AssignmentsObserver.on_any_event.md + hidden: true + - name: AssignmentsObserver.on_created + href: toloka.streaming.observer.AssignmentsObserver.on_created.md + hidden: true + - name: AssignmentsObserver.on_expired + href: toloka.streaming.observer.AssignmentsObserver.on_expired.md + hidden: true + - name: AssignmentsObserver.on_rejected + href: toloka.streaming.observer.AssignmentsObserver.on_rejected.md + hidden: true + - name: AssignmentsObserver.on_skipped + href: toloka.streaming.observer.AssignmentsObserver.on_skipped.md + hidden: true + - name: AssignmentsObserver.on_submitted + href: toloka.streaming.observer.AssignmentsObserver.on_submitted.md + hidden: true + - name: AssignmentsObserver.register_callback + href: toloka.streaming.observer.AssignmentsObserver.register_callback.md + hidden: true + - name: PoolStatusObserver + href: toloka.streaming.observer.PoolStatusObserver.md + - name: PoolStatusObserver.on_archieved + href: toloka.streaming.observer.PoolStatusObserver.on_archieved.md + hidden: true + - name: PoolStatusObserver.on_closed + href: toloka.streaming.observer.PoolStatusObserver.on_closed.md + hidden: true + - name: PoolStatusObserver.on_locked + href: toloka.streaming.observer.PoolStatusObserver.on_locked.md + hidden: true + - name: PoolStatusObserver.on_open + href: toloka.streaming.observer.PoolStatusObserver.on_open.md + hidden: true + - name: PoolStatusObserver.on_status_change + href: toloka.streaming.observer.PoolStatusObserver.on_status_change.md + hidden: true + - name: PoolStatusObserver.register_callback + href: toloka.streaming.observer.PoolStatusObserver.register_callback.md + hidden: true + - name: pipeline + items: + - name: Pipeline + href: toloka.streaming.pipeline.Pipeline.md + - name: Pipeline.observers_iter + href: toloka.streaming.pipeline.Pipeline.observers_iter.md + hidden: true + - name: Pipeline.register + href: toloka.streaming.pipeline.Pipeline.register.md + hidden: true + - name: Pipeline.run + href: toloka.streaming.pipeline.Pipeline.run.md + hidden: true + - name: storage + hidden: true + items: + - name: BaseStorage.cleanup + href: toloka.streaming.storage.BaseStorage.cleanup.md + hidden: true + - name: BaseStorage.load + href: toloka.streaming.storage.BaseStorage.load.md + hidden: true + - name: BaseStorage.lock + href: toloka.streaming.storage.BaseStorage.lock.md + hidden: true + - name: BaseStorage + href: toloka.streaming.storage.BaseStorage.md + - name: BaseStorage.save + href: toloka.streaming.storage.BaseStorage.save.md + hidden: true + - name: JSONLocalStorage.DefaultNearbyFileLocker + href: toloka.streaming.storage.JSONLocalStorage.DefaultNearbyFileLocker.md + hidden: true + - name: JSONLocalStorage.cleanup + href: toloka.streaming.storage.JSONLocalStorage.cleanup.md + hidden: true + - name: JSONLocalStorage.load + href: toloka.streaming.storage.JSONLocalStorage.load.md + hidden: true + - name: JSONLocalStorage + href: toloka.streaming.storage.JSONLocalStorage.md + - name: JSONLocalStorage.save + href: toloka.streaming.storage.JSONLocalStorage.save.md + hidden: true + - name: S3Storage.cleanup + href: toloka.streaming.storage.S3Storage.cleanup.md + hidden: true + - name: S3Storage.load + href: toloka.streaming.storage.S3Storage.load.md + hidden: true + - name: S3Storage + href: toloka.streaming.storage.S3Storage.md + - name: S3Storage.save + href: toloka.streaming.storage.S3Storage.save.md + hidden: true +- name: toloka.util + hidden: true + items: + - name: add_headers + href: toloka.util._managing_headers.add_headers.md + hidden: true + - name: _codegen.attribute + href: toloka.util._codegen.attribute.md + hidden: true + - name: _codegen.fix_attrs_converters + href: toloka.util._codegen.fix_attrs_converters.md + hidden: true + - name: _docstrings.inherit_docstrings + href: toloka.util._docstrings.inherit_docstrings.md + hidden: true + - name: extend_enum + href: toloka.util._extendable_enum.extend_enum.md + hidden: true + - name: ExtendableStrEnum + href: toloka.util._extendable_enum.ExtendableStrEnum.md + hidden: true + - name: ExtendableStrEnumMetaclass + href: toloka.util._extendable_enum.ExtendableStrEnumMetaclass.md + hidden: true + - name: add_headers + href: toloka.util._managing_headers.async_add_headers.md + hidden: true + - name: AsyncInterfaceWrapper + href: toloka.util.async_utils.AsyncInterfaceWrapper.md + - name: AsyncMultithreadWrapper + href: toloka.util.async_utils.AsyncMultithreadWrapper.md + - name: Cooldown + href: toloka.util.async_utils.Cooldown.md + - name: ComplexException + href: toloka.util.async_utils.ComplexException.md + - name: ensure_async + href: toloka.util.async_utils.ensure_async.md + - name: get_task_traceback + href: toloka.util.async_utils.get_task_traceback.md + - name: get_signature + href: toloka.util.get_signature.md + - name: identity + href: toloka.util.identity.md + - name: get_base64_digest + href: toloka.util.stored.get_base64_digest.md + hidden: true + - name: get_stored_meta + href: toloka.util.stored.get_stored_meta.md + hidden: true + - name: pickle_dumps_base64 + href: toloka.util.stored.pickle_dumps_base64.md + hidden: true + - name: pickle_loads_base64 + href: toloka.util.stored.pickle_loads_base64.md + hidden: true diff --git a/docs/reference/toloka.async_client.client.AsyncTolokaClient.from_sync_client.md b/docs/reference/toloka.async_client.client.AsyncTolokaClient.from_sync_client.md index 7c9cf40e..30975a60 100644 --- a/docs/reference/toloka.async_client.client.AsyncTolokaClient.from_sync_client.md +++ b/docs/reference/toloka.async_client.client.AsyncTolokaClient.from_sync_client.md @@ -1,7 +1,7 @@ # from_sync_client -`toloka.async_client.client.AsyncTolokaClient.from_sync_client` +`toloka.async_client.client.AsyncTolokaClient.from_sync_client` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/async_client/client.py#L26) -``` +```python from_sync_client(cls, client: TolokaClient) ``` diff --git a/docs/reference/toloka.async_client.client.AsyncTolokaClient.md b/docs/reference/toloka.async_client.client.AsyncTolokaClient.md index c6806c3b..4775d83b 100644 --- a/docs/reference/toloka.async_client.client.AsyncTolokaClient.md +++ b/docs/reference/toloka.async_client.client.AsyncTolokaClient.md @@ -1,7 +1,7 @@ # AsyncTolokaClient -`toloka.async_client.client.AsyncTolokaClient` +`toloka.async_client.client.AsyncTolokaClient` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/async_client/client.py#L14) -``` +```python AsyncTolokaClient( self, *args, @@ -15,7 +15,7 @@ Class that implements interaction with [Toloka API](https://toloka.ai/docs/api/c All methods are wrapped as async. So all methods calls must be awaited. All arguments, same as in TolokaClient. -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.async_client.client.AsyncTolokaClient.wait_operation.md b/docs/reference/toloka.async_client.client.AsyncTolokaClient.wait_operation.md index 8a5b30a9..388becb7 100644 --- a/docs/reference/toloka.async_client.client.AsyncTolokaClient.wait_operation.md +++ b/docs/reference/toloka.async_client.client.AsyncTolokaClient.wait_operation.md @@ -1,7 +1,7 @@ # wait_operation -`toloka.async_client.client.AsyncTolokaClient.wait_operation` +`toloka.async_client.client.AsyncTolokaClient.wait_operation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/async_client/client.py#L35) -``` +```python wait_operation( self, op: Operation, diff --git a/docs/reference/toloka.client.TolokaClient.Environment.md b/docs/reference/toloka.client.TolokaClient.Environment.md index 1423a70f..288f9329 100644 --- a/docs/reference/toloka.client.TolokaClient.Environment.md +++ b/docs/reference/toloka.client.TolokaClient.Environment.md @@ -1,5 +1,5 @@ # Environment -`toloka.client.TolokaClient.Environment` +`toloka.client.TolokaClient.Environment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L214) An enumeration. diff --git a/docs/reference/toloka.client.TolokaClient.accept_assignment.md b/docs/reference/toloka.client.TolokaClient.accept_assignment.md index 0a0232fc..ed2c73ba 100644 --- a/docs/reference/toloka.client.TolokaClient.accept_assignment.md +++ b/docs/reference/toloka.client.TolokaClient.accept_assignment.md @@ -1,7 +1,7 @@ # accept_assignment -`toloka.client.TolokaClient.accept_assignment` +`toloka.client.TolokaClient.accept_assignment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python accept_assignment( self, assignment_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.add_message_thread_to_folders.md b/docs/reference/toloka.client.TolokaClient.add_message_thread_to_folders.md index 040fb88c..311719d3 100644 --- a/docs/reference/toloka.client.TolokaClient.add_message_thread_to_folders.md +++ b/docs/reference/toloka.client.TolokaClient.add_message_thread_to_folders.md @@ -1,11 +1,11 @@ # add_message_thread_to_folders -`toloka.client.TolokaClient.add_message_thread_to_folders` +`toloka.client.TolokaClient.add_message_thread_to_folders` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L323) -``` +```python add_message_thread_to_folders( self, message_thread_id: str, - folders: Union[List[Union[Folder, str]], MessageThreadFolders] + folders: Union[List[Folder], MessageThreadFolders] ) ``` @@ -16,7 +16,7 @@ Adds a message chain to one or more folders ("unread", "important" etc.) | Parameters | Type | Description | | :----------| :----| :-----------| `message_thread_id`|**str**|

ID of message chain.

-`folders`|**Union\[List\[Union\[[Folder](toloka.client.message_thread.Folder.md), str\]\], [MessageThreadFolders](toloka.client.message_thread.MessageThreadFolders.md)\]**|

List of folders, where to move chain.

+`folders`|**Union\[List\[[Folder](toloka.client.message_thread.Folder.md)\], [MessageThreadFolders](toloka.client.message_thread.MessageThreadFolders.md)\]**|

List of folders, where to move chain.

* **Returns:** diff --git a/docs/reference/toloka.client.TolokaClient.aggregate_solutions_by_pool.md b/docs/reference/toloka.client.TolokaClient.aggregate_solutions_by_pool.md index f5c754ef..44baec0d 100644 --- a/docs/reference/toloka.client.TolokaClient.aggregate_solutions_by_pool.md +++ b/docs/reference/toloka.client.TolokaClient.aggregate_solutions_by_pool.md @@ -7,9 +7,13 @@ Starts aggregation of solutions in the pool Responses to all completed tasks will be aggregated. The method only starts the aggregation and returns the operation for further tracking. -**Note**: In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), +{% note info %} + +In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), that have more aggregation methods and can perform on your computers. +{% endnote %} + ## Parameters Description | Parameters | Type | Description | diff --git a/docs/reference/toloka.client.TolokaClient.archive_app_project.md b/docs/reference/toloka.client.TolokaClient.archive_app_project.md index ce638d94..e6dcdb25 100644 --- a/docs/reference/toloka.client.TolokaClient.archive_app_project.md +++ b/docs/reference/toloka.client.TolokaClient.archive_app_project.md @@ -1,7 +1,7 @@ # archive_app_project -`toloka.client.TolokaClient.archive_app_project` +`toloka.client.TolokaClient.archive_app_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python archive_app_project(self, app_project_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.archive_pool.md b/docs/reference/toloka.client.TolokaClient.archive_pool.md index b4f465f6..e021fe91 100644 --- a/docs/reference/toloka.client.TolokaClient.archive_pool.md +++ b/docs/reference/toloka.client.TolokaClient.archive_pool.md @@ -1,7 +1,7 @@ # archive_pool -`toloka.client.TolokaClient.archive_pool` +`toloka.client.TolokaClient.archive_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python archive_pool(self, pool_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.archive_pool_async.md b/docs/reference/toloka.client.TolokaClient.archive_pool_async.md index 87c5e2f5..7c4b25fe 100644 --- a/docs/reference/toloka.client.TolokaClient.archive_pool_async.md +++ b/docs/reference/toloka.client.TolokaClient.archive_pool_async.md @@ -1,7 +1,7 @@ # archive_pool_async -`toloka.client.TolokaClient.archive_pool_async` +`toloka.client.TolokaClient.archive_pool_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python archive_pool_async(self, pool_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.archive_project.md b/docs/reference/toloka.client.TolokaClient.archive_project.md index 3ad81dde..96a60896 100644 --- a/docs/reference/toloka.client.TolokaClient.archive_project.md +++ b/docs/reference/toloka.client.TolokaClient.archive_project.md @@ -1,7 +1,7 @@ # archive_project -`toloka.client.TolokaClient.archive_project` +`toloka.client.TolokaClient.archive_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python archive_project(self, project_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.archive_project_async.md b/docs/reference/toloka.client.TolokaClient.archive_project_async.md index efbc9ccb..91779560 100644 --- a/docs/reference/toloka.client.TolokaClient.archive_project_async.md +++ b/docs/reference/toloka.client.TolokaClient.archive_project_async.md @@ -1,7 +1,7 @@ # archive_project_async -`toloka.client.TolokaClient.archive_project_async` +`toloka.client.TolokaClient.archive_project_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python archive_project_async(self, project_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.archive_training.md b/docs/reference/toloka.client.TolokaClient.archive_training.md index 54c80c43..73f3285a 100644 --- a/docs/reference/toloka.client.TolokaClient.archive_training.md +++ b/docs/reference/toloka.client.TolokaClient.archive_training.md @@ -1,7 +1,7 @@ # archive_training -`toloka.client.TolokaClient.archive_training` +`toloka.client.TolokaClient.archive_training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python archive_training(self, training_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.archive_training_async.md b/docs/reference/toloka.client.TolokaClient.archive_training_async.md index fb110284..7e77db41 100644 --- a/docs/reference/toloka.client.TolokaClient.archive_training_async.md +++ b/docs/reference/toloka.client.TolokaClient.archive_training_async.md @@ -1,7 +1,7 @@ # archive_training_async -`toloka.client.TolokaClient.archive_training_async` +`toloka.client.TolokaClient.archive_training_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python archive_training_async(self, training_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.clone_pool.md b/docs/reference/toloka.client.TolokaClient.clone_pool.md index 60fad9b0..348d8da8 100644 --- a/docs/reference/toloka.client.TolokaClient.clone_pool.md +++ b/docs/reference/toloka.client.TolokaClient.clone_pool.md @@ -1,7 +1,7 @@ # clone_pool -`toloka.client.TolokaClient.clone_pool` +`toloka.client.TolokaClient.clone_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python clone_pool(self, pool_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.clone_pool_async.md b/docs/reference/toloka.client.TolokaClient.clone_pool_async.md index 084a2a82..a12f0c5b 100644 --- a/docs/reference/toloka.client.TolokaClient.clone_pool_async.md +++ b/docs/reference/toloka.client.TolokaClient.clone_pool_async.md @@ -1,7 +1,7 @@ # clone_pool_async -`toloka.client.TolokaClient.clone_pool_async` +`toloka.client.TolokaClient.clone_pool_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python clone_pool_async(self, pool_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.clone_project.md b/docs/reference/toloka.client.TolokaClient.clone_project.md index 1f9ee25d..31037029 100644 --- a/docs/reference/toloka.client.TolokaClient.clone_project.md +++ b/docs/reference/toloka.client.TolokaClient.clone_project.md @@ -1,7 +1,7 @@ # clone_project -`toloka.client.TolokaClient.clone_project` +`toloka.client.TolokaClient.clone_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python clone_project( self, project_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.clone_training.md b/docs/reference/toloka.client.TolokaClient.clone_training.md index 634ffaa9..24d9a9e7 100644 --- a/docs/reference/toloka.client.TolokaClient.clone_training.md +++ b/docs/reference/toloka.client.TolokaClient.clone_training.md @@ -1,7 +1,7 @@ # clone_training -`toloka.client.TolokaClient.clone_training` +`toloka.client.TolokaClient.clone_training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python clone_training(self, training_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.clone_training_async.md b/docs/reference/toloka.client.TolokaClient.clone_training_async.md index 9485ea8e..5f2f7747 100644 --- a/docs/reference/toloka.client.TolokaClient.clone_training_async.md +++ b/docs/reference/toloka.client.TolokaClient.clone_training_async.md @@ -1,7 +1,7 @@ # clone_training_async -`toloka.client.TolokaClient.clone_training_async` +`toloka.client.TolokaClient.clone_training_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python clone_training_async(self, training_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.close_pool.md b/docs/reference/toloka.client.TolokaClient.close_pool.md index db837660..e73b430c 100644 --- a/docs/reference/toloka.client.TolokaClient.close_pool.md +++ b/docs/reference/toloka.client.TolokaClient.close_pool.md @@ -1,7 +1,7 @@ # close_pool -`toloka.client.TolokaClient.close_pool` +`toloka.client.TolokaClient.close_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python close_pool(self, pool_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.close_pool_async.md b/docs/reference/toloka.client.TolokaClient.close_pool_async.md index 195d4e7c..16827a3b 100644 --- a/docs/reference/toloka.client.TolokaClient.close_pool_async.md +++ b/docs/reference/toloka.client.TolokaClient.close_pool_async.md @@ -1,7 +1,7 @@ # close_pool_async -`toloka.client.TolokaClient.close_pool_async` +`toloka.client.TolokaClient.close_pool_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python close_pool_async(self, pool_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.close_pool_for_update.md b/docs/reference/toloka.client.TolokaClient.close_pool_for_update.md index 582e5bc0..3499a708 100644 --- a/docs/reference/toloka.client.TolokaClient.close_pool_for_update.md +++ b/docs/reference/toloka.client.TolokaClient.close_pool_for_update.md @@ -1,7 +1,7 @@ # close_pool_for_update -`toloka.client.TolokaClient.close_pool_for_update` +`toloka.client.TolokaClient.close_pool_for_update` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python close_pool_for_update(self, pool_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.close_pool_for_update_async.md b/docs/reference/toloka.client.TolokaClient.close_pool_for_update_async.md index fc96d29b..ba82c48f 100644 --- a/docs/reference/toloka.client.TolokaClient.close_pool_for_update_async.md +++ b/docs/reference/toloka.client.TolokaClient.close_pool_for_update_async.md @@ -1,7 +1,7 @@ # close_pool_for_update_async -`toloka.client.TolokaClient.close_pool_for_update_async` +`toloka.client.TolokaClient.close_pool_for_update_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python close_pool_for_update_async(self, pool_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.close_training.md b/docs/reference/toloka.client.TolokaClient.close_training.md index 6a8cce2f..50f29ce3 100644 --- a/docs/reference/toloka.client.TolokaClient.close_training.md +++ b/docs/reference/toloka.client.TolokaClient.close_training.md @@ -1,7 +1,7 @@ # close_training -`toloka.client.TolokaClient.close_training` +`toloka.client.TolokaClient.close_training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python close_training(self, training_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.close_training_async.md b/docs/reference/toloka.client.TolokaClient.close_training_async.md index 10da9a0e..81aec261 100644 --- a/docs/reference/toloka.client.TolokaClient.close_training_async.md +++ b/docs/reference/toloka.client.TolokaClient.close_training_async.md @@ -1,7 +1,7 @@ # close_training_async -`toloka.client.TolokaClient.close_training_async` +`toloka.client.TolokaClient.close_training_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python close_training_async(self, training_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.compose_message_thread.md b/docs/reference/toloka.client.TolokaClient.compose_message_thread.md index f8241852..dcce4b5c 100644 --- a/docs/reference/toloka.client.TolokaClient.compose_message_thread.md +++ b/docs/reference/toloka.client.TolokaClient.compose_message_thread.md @@ -30,10 +30,10 @@ The sent message is added to a new message thread. If you want to thank Toloka performers who have tried to complete your tasks, send them a nice message. ```python -message_text = 'Amazing job! We've just trained our first model with the data YOU prepared for us. Thank you!' +message_text = "Amazing job! We've just trained our first model with the data YOU prepared for us. Thank you!" toloka_client.compose_message_thread( recipients_select_type='ALL', - topic={'EN':'Thank you, performer!'}, + topic={'EN': 'Thank you, performer!'}, text={'EN': message_text}, answerable=False ) diff --git a/docs/reference/toloka.client.TolokaClient.create_app_item.md b/docs/reference/toloka.client.TolokaClient.create_app_item.md index 2062c472..1efb2976 100644 --- a/docs/reference/toloka.client.TolokaClient.create_app_item.md +++ b/docs/reference/toloka.client.TolokaClient.create_app_item.md @@ -1,7 +1,7 @@ # create_app_item -`toloka.client.TolokaClient.create_app_item` +`toloka.client.TolokaClient.create_app_item` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python create_app_item( self, app_project_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.create_app_project.md b/docs/reference/toloka.client.TolokaClient.create_app_project.md index 305e68e0..f4be947b 100644 --- a/docs/reference/toloka.client.TolokaClient.create_app_project.md +++ b/docs/reference/toloka.client.TolokaClient.create_app_project.md @@ -1,7 +1,7 @@ # create_app_project -`toloka.client.TolokaClient.create_app_project` +`toloka.client.TolokaClient.create_app_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python create_app_project(self, app_project: AppProject) ``` diff --git a/docs/reference/toloka.client.TolokaClient.create_pool.md b/docs/reference/toloka.client.TolokaClient.create_pool.md index ec13e861..4f8d6836 100644 --- a/docs/reference/toloka.client.TolokaClient.create_pool.md +++ b/docs/reference/toloka.client.TolokaClient.create_pool.md @@ -1,7 +1,7 @@ # create_pool -`toloka.client.TolokaClient.create_pool` +`toloka.client.TolokaClient.create_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python create_pool(self, pool: Pool) ``` @@ -33,7 +33,7 @@ new_pool = toloka.pool.Pool( project_id=existing_project_id, private_name='Pool 1', may_contain_adult_content=False, - will_expire=datetime.datetime.utcnow() + datetime.timedelta(days=365), + will_expire=datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(days=365), reward_per_assignment=0.01, assignment_max_duration_seconds=60*20, defaults=toloka.pool.Pool.Defaults(default_overlap_for_new_task_suites=3), diff --git a/docs/reference/toloka.client.TolokaClient.create_project.md b/docs/reference/toloka.client.TolokaClient.create_project.md index 083313ac..5cac4cce 100644 --- a/docs/reference/toloka.client.TolokaClient.create_project.md +++ b/docs/reference/toloka.client.TolokaClient.create_project.md @@ -1,7 +1,7 @@ # create_project -`toloka.client.TolokaClient.create_project` +`toloka.client.TolokaClient.create_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python create_project(self, project: Project) ``` diff --git a/docs/reference/toloka.client.TolokaClient.create_skill.md b/docs/reference/toloka.client.TolokaClient.create_skill.md index a42ed6b0..a3cbf62b 100644 --- a/docs/reference/toloka.client.TolokaClient.create_skill.md +++ b/docs/reference/toloka.client.TolokaClient.create_skill.md @@ -37,7 +37,7 @@ new_skill = toloka_client.create_skill( name='Area selection of road signs', public_requester_description={ 'EN': 'Performer is annotating road signs', - 'FR': 'L'exécuteur marque les signaux routier', + 'FR': "L'exécuteur marque les signaux routier", }, ) print(new_skill.id) diff --git a/docs/reference/toloka.client.TolokaClient.create_task.md b/docs/reference/toloka.client.TolokaClient.create_task.md index 281ef1d3..a4cd67fc 100644 --- a/docs/reference/toloka.client.TolokaClient.create_task.md +++ b/docs/reference/toloka.client.TolokaClient.create_task.md @@ -1,23 +1,23 @@ # create_task `toloka.client.TolokaClient.create_task` -Creates a new task +Creates a new task in Toloka. -It's better to use "create_tasks", if you need to insert several tasks. You can send a maximum of 100,000 requests of this kind per minute and a maximum of 2,000,000 requests per day. +To create several tasks at once use [create_tasks](./toloka.client.TolokaClient.create_tasks.md). ## Parameters Description | Parameters | Type | Description | | :----------| :----| :-----------| -`task`|**[Task](toloka.client.task.Task.md)**|

Task that need to be created.

-`allow_defaults`|**Optional\[bool\]**|

Overlap settings:

+`task`|**[Task](toloka.client.task.Task.md)**|

Task to be created.

+`allow_defaults`|**Optional\[bool\]**|

Overlap setting:

`open_pool`|**Optional\[bool\]**|

Open the pool immediately after creating a task suite, if the pool is closed.

* **Returns:** - Created task. + The created task. * **Return type:** @@ -27,7 +27,8 @@ You can send a maximum of 100,000 requests of this kind per minute and a maximum ```python task = toloka.task.Task( - input_values={'image': 'https://tlk.s3.yandex.net/dataset/cats_vs_dogs/dogs/048e5760fc5a46faa434922b2447a527.jpg'}, - pool_id='1') + input_values={'image': 'https://tlk.s3.yandex.net/dataset/cats_vs_dogs/dogs/048e5760fc5a46faa434922b2447a527.jpg'}, + pool_id='1' +) toloka_client.create_task(task=task, allow_defaults=True) ``` diff --git a/docs/reference/toloka.client.TolokaClient.create_tasks.md b/docs/reference/toloka.client.TolokaClient.create_tasks.md index 16a073d5..ae08633c 100644 --- a/docs/reference/toloka.client.TolokaClient.create_tasks.md +++ b/docs/reference/toloka.client.TolokaClient.create_tasks.md @@ -1,29 +1,29 @@ # create_tasks `toloka.client.TolokaClient.create_tasks` -Creates many tasks in pools +Creates several tasks in Toloka using a single request. -By default uses asynchronous operation inside. It's better not to set "async_mode=False", if you not understand -clearly why you need it. -Tasks can be from different pools. You can insert both regular tasks and golden-tasks. +Tasks can be added to different pools. You can add together regular tasks and control tasks. You can send a maximum of 100,000 requests of this kind per minute and a maximum of 2,000,000 requests per day. -Recomended maximum of 10,000 task per request if async_mode is True. + +By default, `create_tasks` starts asynchronous operation internally and waits for the completion of it. Do not +change `async_mode` to False, if you do not understand clearly why you need it. ## Parameters Description | Parameters | Type | Description | | :----------| :----| :-----------| -`tasks`|**List\[[Task](toloka.client.task.Task.md)\]**|

List of tasks, that will be created.

-`allow_defaults`|**Optional\[bool\]**|

Overlap settings:

+`tasks`|**List\[[Task](toloka.client.task.Task.md)\]**|

List of tasks to be created.

+`allow_defaults`|**Optional\[bool\]**|

Overlap setting:

`open_pool`|**Optional\[bool\]**|

Open the pool immediately after creating a task suite, if the pool is closed.

-`skip_invalid_items`|**Optional\[bool\]**|

Validation parameters:

-`async_mode`|**Optional\[bool\]**|

How the request is processed:

+`skip_invalid_items`|**Optional\[bool\]**|

Task validation option:

+`async_mode`|**Optional\[bool\]**|

Request processing mode:

* **Returns:** - Result of tasks creating. Contains created tasks in `items` and -problems in "validation_errors". + An object with created tasks in `items` and invalid tasks in +`validation_errors`. * **Return type:** @@ -31,7 +31,7 @@ problems in "validation_errors". **Examples:** -How to create regular tasks from tsv. +The first example shows how to create regular tasks using a TSV file. ```python dataset = pandas.read_csv('dataset.tsv', sep=' ') @@ -43,7 +43,7 @@ created_result = toloka_client.create_tasks(tasks, allow_defaults=True) print(len(created_result.items)) ``` -How to create golden-tasks. +The second example shows how to create control tasks. ```python dataset = pd.read_csv('dateset.tsv', sep=';') diff --git a/docs/reference/toloka.client.TolokaClient.create_tasks_async.md b/docs/reference/toloka.client.TolokaClient.create_tasks_async.md index 4db702b4..eeefc9f4 100644 --- a/docs/reference/toloka.client.TolokaClient.create_tasks_async.md +++ b/docs/reference/toloka.client.TolokaClient.create_tasks_async.md @@ -1,25 +1,24 @@ # create_tasks_async `toloka.client.TolokaClient.create_tasks_async` -Creates many tasks in pools, asynchronous version +Creates tasks in Toloka asynchronously. You can send a maximum of 100,000 requests of this kind per minute and a maximum of 2,000,000 requests per day. -Recomended maximum of 10,000 task per request if async_mode is True. ## Parameters Description | Parameters | Type | Description | | :----------| :----| :-----------| -`tasks`|**List\[[Task](toloka.client.task.Task.md)\]**|

List of tasks, that will be created.

-`allow_defaults`|**Optional\[bool\]**|

Overlap settings:

+`tasks`|**List\[[Task](toloka.client.task.Task.md)\]**|

List of tasks to be created.

+`allow_defaults`|**Optional\[bool\]**|

Overlap setting:

`open_pool`|**Optional\[bool\]**|

Open the pool immediately after creating a task suite, if the pool is closed.

-`skip_invalid_items`|**Optional\[bool\]**|

Validation parameters:

-`async_mode`|**Optional\[bool\]**|

How the request is processed:

+`skip_invalid_items`|**Optional\[bool\]**|

Task validation option:

+`async_mode`|**Optional\[bool\]**|

Request processing mode:

* **Returns:** - An operation upon completion of which you can get the created tasks. + An object to track the progress of the operation. * **Return type:** diff --git a/docs/reference/toloka.client.TolokaClient.create_training.md b/docs/reference/toloka.client.TolokaClient.create_training.md index 2802ca87..72c89450 100644 --- a/docs/reference/toloka.client.TolokaClient.create_training.md +++ b/docs/reference/toloka.client.TolokaClient.create_training.md @@ -1,7 +1,7 @@ # create_training -`toloka.client.TolokaClient.create_training` +`toloka.client.TolokaClient.create_training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python create_training(self, training: Training) ``` diff --git a/docs/reference/toloka.client.TolokaClient.delete_user_restriction.md b/docs/reference/toloka.client.TolokaClient.delete_user_restriction.md index 4d8e461d..480f4cde 100644 --- a/docs/reference/toloka.client.TolokaClient.delete_user_restriction.md +++ b/docs/reference/toloka.client.TolokaClient.delete_user_restriction.md @@ -1,7 +1,7 @@ # delete_user_restriction -`toloka.client.TolokaClient.delete_user_restriction` +`toloka.client.TolokaClient.delete_user_restriction` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python delete_user_restriction(self, user_restriction_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.delete_user_skill.md b/docs/reference/toloka.client.TolokaClient.delete_user_skill.md index b0c4e2e0..9e3a9454 100644 --- a/docs/reference/toloka.client.TolokaClient.delete_user_skill.md +++ b/docs/reference/toloka.client.TolokaClient.delete_user_skill.md @@ -1,7 +1,7 @@ # delete_user_skill -`toloka.client.TolokaClient.delete_user_skill` +`toloka.client.TolokaClient.delete_user_skill` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python delete_user_skill(self, user_skill_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.delete_webhook_subscription.md b/docs/reference/toloka.client.TolokaClient.delete_webhook_subscription.md index bd4b0193..257452f9 100644 --- a/docs/reference/toloka.client.TolokaClient.delete_webhook_subscription.md +++ b/docs/reference/toloka.client.TolokaClient.delete_webhook_subscription.md @@ -1,7 +1,7 @@ # delete_webhook_subscription -`toloka.client.TolokaClient.delete_webhook_subscription` +`toloka.client.TolokaClient.delete_webhook_subscription` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python delete_webhook_subscription(self, webhook_subscription_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.download_attachment.md b/docs/reference/toloka.client.TolokaClient.download_attachment.md index 6c9254af..b76277b9 100644 --- a/docs/reference/toloka.client.TolokaClient.download_attachment.md +++ b/docs/reference/toloka.client.TolokaClient.download_attachment.md @@ -1,7 +1,7 @@ # download_attachment -`toloka.client.TolokaClient.download_attachment` +`toloka.client.TolokaClient.download_attachment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python download_attachment( self, attachment_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.find_aggregated_solutions.md b/docs/reference/toloka.client.TolokaClient.find_aggregated_solutions.md index 03b24662..c947dec8 100644 --- a/docs/reference/toloka.client.TolokaClient.find_aggregated_solutions.md +++ b/docs/reference/toloka.client.TolokaClient.find_aggregated_solutions.md @@ -6,9 +6,13 @@ Gets aggregated responses after the AggregatedSolutionOperation completes. It is better to use the "get_aggregated_solutions" method, that allows to iterate through all results. -**Note**: In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), +{% note info %} + +In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), that have more aggregation methods and can perform on your computers. +{% endnote %} + ## Parameters Description | Parameters | Type | Description | diff --git a/docs/reference/toloka.client.TolokaClient.find_app_projects.md b/docs/reference/toloka.client.TolokaClient.find_app_projects.md index a35b4dc9..b6aadcc6 100644 --- a/docs/reference/toloka.client.TolokaClient.find_app_projects.md +++ b/docs/reference/toloka.client.TolokaClient.find_app_projects.md @@ -18,7 +18,7 @@ and not just the first output. `status`|**Optional\[[AppProject.Status](toloka.client.app.AppProject.Status.md)\]**|

project status.

`after_id`|**Optional\[str\]**|

ID of the project used for cursor pagination.

`scope`|**Optional\[[AppProjectSearchRequest.Scope](toloka.client.search_requests.AppProjectSearchRequest.Scope.md)\]**|

projects created by a specified range of requesters:

-`requester_ids`|**Union\[str, List\[str\]\]**|

List of requester IDs separated by a comma, for scope = REQUESTER_LIST.

+`requester_ids`|**Union\[str, List\[str\], None\]**|

List of requester IDs separated by a comma, for scope = REQUESTER_LIST.

`id_gt`|**Optional\[str\]**|

projects with an ID greater than the specified value.

`id_gte`|**Optional\[str\]**|

projects with an ID greater than or equal to the specified value.

`id_lt`|**Optional\[str\]**|

projects with an ID less than the specified value.

diff --git a/docs/reference/toloka.client.TolokaClient.find_assignments.md b/docs/reference/toloka.client.TolokaClient.find_assignments.md index fc305066..0d5495ef 100644 --- a/docs/reference/toloka.client.TolokaClient.find_assignments.md +++ b/docs/reference/toloka.client.TolokaClient.find_assignments.md @@ -13,7 +13,7 @@ and not just the first output. | Parameters | Type | Description | | :----------| :----| :-----------| -`status`|**Union\[str, [Assignment.Status](toloka.client.assignment.Assignment.Status.md), List\[Union\[str, [Assignment.Status](toloka.client.assignment.Assignment.Status.md)\]\]\]**|

Status of an assigned task suite (Detailed status description in Assignment.Status):

+`status`|**Union\[str, [Assignment.Status](toloka.client.assignment.Assignment.Status.md), List\[Union\[str, [Assignment.Status](toloka.client.assignment.Assignment.Status.md)\]\], None\]**|

Status of an assigned task suite (Detailed status description in Assignment.Status):

`task_id`|**Optional\[str\]**|

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

`task_suite_id`|**Optional\[str\]**|

ID of a task suite.

`pool_id`|**Optional\[str\]**|

Pool ID.

diff --git a/docs/reference/toloka.client.TolokaClient.find_message_threads.md b/docs/reference/toloka.client.TolokaClient.find_message_threads.md index 1175a6a0..4975b198 100644 --- a/docs/reference/toloka.client.TolokaClient.find_message_threads.md +++ b/docs/reference/toloka.client.TolokaClient.find_message_threads.md @@ -13,8 +13,8 @@ and not just the first output. | Parameters | Type | Description | | :----------| :----| :-----------| -`folder`|**Union\[str, [Folder](toloka.client.message_thread.Folder.md), List\[Union\[str, [Folder](toloka.client.message_thread.Folder.md)\]\]\]**|

Folders to search for the thread

-`folder_ne`|**Union\[str, [Folder](toloka.client.message_thread.Folder.md), List\[Union\[str, [Folder](toloka.client.message_thread.Folder.md)\]\]\]**|

Folders to not search for the thread

+`folder`|**Union\[str, [Folder](toloka.client.message_thread.Folder.md), List\[Union\[str, [Folder](toloka.client.message_thread.Folder.md)\]\], None\]**|

Folders to search for the thread

+`folder_ne`|**Union\[str, [Folder](toloka.client.message_thread.Folder.md), List\[Union\[str, [Folder](toloka.client.message_thread.Folder.md)\]\], None\]**|

Folders to not search for the thread

`id_lt`|**Optional\[str\]**|

Threads with an ID less than the specified value.

`id_lte`|**Optional\[str\]**|

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

`id_gt`|**Optional\[str\]**|

Threads with an ID greater than the specified value.

diff --git a/docs/reference/toloka.client.TolokaClient.find_pools.md b/docs/reference/toloka.client.TolokaClient.find_pools.md index 1a3cba92..c1ba3085 100644 --- a/docs/reference/toloka.client.TolokaClient.find_pools.md +++ b/docs/reference/toloka.client.TolokaClient.find_pools.md @@ -59,4 +59,5 @@ Find open pools in a specific project. toloka_client.find_pools(status='OPEN', project_id='1') ``` -If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator `has_more=True`. +If method finds more objects than custom or system `limit` allows to operate, it will also show an +indicator `has_more=True`. diff --git a/docs/reference/toloka.client.TolokaClient.find_skills.md b/docs/reference/toloka.client.TolokaClient.find_skills.md index 482a37cb..97023634 100644 --- a/docs/reference/toloka.client.TolokaClient.find_skills.md +++ b/docs/reference/toloka.client.TolokaClient.find_skills.md @@ -42,4 +42,5 @@ Find ten most recently created skills. toloka_client.find_skills(sort=['-created', '-id'], limit=10) ``` -If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator `has_more=True`. +If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator +`has_more=True`. diff --git a/docs/reference/toloka.client.TolokaClient.find_task_suites.md b/docs/reference/toloka.client.TolokaClient.find_task_suites.md index 0d6282ba..ab569833 100644 --- a/docs/reference/toloka.client.TolokaClient.find_task_suites.md +++ b/docs/reference/toloka.client.TolokaClient.find_task_suites.md @@ -47,4 +47,5 @@ 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`. +If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator +`has_more=True`. diff --git a/docs/reference/toloka.client.TolokaClient.find_tasks.md b/docs/reference/toloka.client.TolokaClient.find_tasks.md index 44c47b72..e71b332b 100644 --- a/docs/reference/toloka.client.TolokaClient.find_tasks.md +++ b/docs/reference/toloka.client.TolokaClient.find_tasks.md @@ -1,19 +1,17 @@ # find_tasks `toloka.client.TolokaClient.find_tasks` -Finds all tasks that match certain rules +Finds tasks that match certain criteria. -As a result, it returns an object that contains the first part of the found tasks and whether there -are any more results. -It is better to use the "get_tasks" method, they allow to iterate trought all results -and not just the first output. +The number of returned tasks is limited. `find_tasks` additionally returns a flag showing whether there are more matching tasks. +Consider using [get_tasks](./toloka.client.TolokaClient.get_tasks.md) to iterate over all matching tasks. ## Parameters Description | Parameters | Type | Description | | :----------| :----| :-----------| -`pool_id`|**Optional\[str\]**|

ID of the pool to get tasks from.

+`pool_id`|**Optional\[str\]**|

The ID of the pool to get tasks from.

`overlap`|**Optional\[int\]**|

Tasks with an overlap equal to the specified value.

`id_lt`|**Optional\[str\]**|

Tasks with an ID less than the specified value.

`id_lte`|**Optional\[str\]**|

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

@@ -24,15 +22,15 @@ and not just the first output. `created_gt`|**Optional\[datetime\]**|

Tasks created after the specified date.

`created_gte`|**Optional\[datetime\]**|

Tasks created after or on the specified date.

`overlap_lt`|**Optional\[int\]**|

Tasks with an overlap less than the specified value.

-`overlap_lte`|**Optional\[int\]**|

Tasks with an overlap equal to the specified value.

+`overlap_lte`|**Optional\[int\]**|

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

`overlap_gt`|**Optional\[int\]**|

Tasks with an overlap greater than the specified value.

-`overlap_gte`|**Optional\[int\]**|

Tasks with an overlap equal to the specified value.

-`sort`|**Union\[List\[str\], [TaskSortItems](toloka.client.search_requests.TaskSortItems.md), 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.

+`overlap_gte`|**Optional\[int\]**|

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

+`sort`|**Union\[List\[str\], [TaskSortItems](toloka.client.search_requests.TaskSortItems.md), None\]**|

Sorting options.

Default value: `None`.

+`limit`|**Optional\[int\]**|

Returned tasks limit. The maximum value is 100,000.

Default value: 50.

* **Returns:** - The first `limit` tasks in `items`. And a mark that there is more. + Found tasks and a flag showing whether there are more matching tasks. * **Return type:** @@ -40,10 +38,8 @@ and not just the first output. **Examples:** -Find three most recently created tasks in a specified pool. +To find three most recently created tasks in a pool, call the method with the following parameters: ```python toloka_client.find_tasks(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`. diff --git a/docs/reference/toloka.client.TolokaClient.find_user_bonuses.md b/docs/reference/toloka.client.TolokaClient.find_user_bonuses.md index 4194808d..25c19685 100644 --- a/docs/reference/toloka.client.TolokaClient.find_user_bonuses.md +++ b/docs/reference/toloka.client.TolokaClient.find_user_bonuses.md @@ -41,4 +41,5 @@ And a mark that there is more. toloka_client.find_user_bonuses(user_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`. +If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator +`has_more=True`. diff --git a/docs/reference/toloka.client.TolokaClient.find_user_skills.md b/docs/reference/toloka.client.TolokaClient.find_user_skills.md index 3919ac77..7c579af6 100644 --- a/docs/reference/toloka.client.TolokaClient.find_user_skills.md +++ b/docs/reference/toloka.client.TolokaClient.find_user_skills.md @@ -46,4 +46,5 @@ And a mark that there is more. toloka_client.find_user_skills(limit=10) ``` -If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator `has_more=True`. +If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator +`has_more=True`. diff --git a/docs/reference/toloka.client.TolokaClient.get_aggregated_solutions.md b/docs/reference/toloka.client.TolokaClient.get_aggregated_solutions.md index 7d4bffb5..a71ec8a7 100644 --- a/docs/reference/toloka.client.TolokaClient.get_aggregated_solutions.md +++ b/docs/reference/toloka.client.TolokaClient.get_aggregated_solutions.md @@ -4,9 +4,13 @@ Finds all aggregated responses after the AggregatedSolutionOperation completes -**Note**: In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), +{% note info %} + +In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), that have more aggregation methods and can perform on your computers. +{% endnote %} + ## Parameters Description | Parameters | Type | Description | diff --git a/docs/reference/toloka.client.TolokaClient.get_analytics.md b/docs/reference/toloka.client.TolokaClient.get_analytics.md index 02df91e0..7b35cae8 100644 --- a/docs/reference/toloka.client.TolokaClient.get_analytics.md +++ b/docs/reference/toloka.client.TolokaClient.get_analytics.md @@ -1,7 +1,7 @@ # get_analytics -`toloka.client.TolokaClient.get_analytics` +`toloka.client.TolokaClient.get_analytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_analytics(self, stats: List[AnalyticsRequest]) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_app.md b/docs/reference/toloka.client.TolokaClient.get_app.md index 4674c481..dd4ad07e 100644 --- a/docs/reference/toloka.client.TolokaClient.get_app.md +++ b/docs/reference/toloka.client.TolokaClient.get_app.md @@ -1,7 +1,7 @@ # get_app -`toloka.client.TolokaClient.get_app` +`toloka.client.TolokaClient.get_app` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_app(self, app_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_app_batch.md b/docs/reference/toloka.client.TolokaClient.get_app_batch.md index a1d55a2f..bde17c0e 100644 --- a/docs/reference/toloka.client.TolokaClient.get_app_batch.md +++ b/docs/reference/toloka.client.TolokaClient.get_app_batch.md @@ -1,7 +1,7 @@ # get_app_batch -`toloka.client.TolokaClient.get_app_batch` +`toloka.client.TolokaClient.get_app_batch` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_app_batch( self, app_project_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.get_app_item.md b/docs/reference/toloka.client.TolokaClient.get_app_item.md index 6c5a1e77..e687b18d 100644 --- a/docs/reference/toloka.client.TolokaClient.get_app_item.md +++ b/docs/reference/toloka.client.TolokaClient.get_app_item.md @@ -1,7 +1,7 @@ # get_app_item -`toloka.client.TolokaClient.get_app_item` +`toloka.client.TolokaClient.get_app_item` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_app_item( self, app_project_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.get_app_project.md b/docs/reference/toloka.client.TolokaClient.get_app_project.md index ca41328b..214fe791 100644 --- a/docs/reference/toloka.client.TolokaClient.get_app_project.md +++ b/docs/reference/toloka.client.TolokaClient.get_app_project.md @@ -1,7 +1,7 @@ # get_app_project -`toloka.client.TolokaClient.get_app_project` +`toloka.client.TolokaClient.get_app_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_app_project(self, app_project_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_app_projects.md b/docs/reference/toloka.client.TolokaClient.get_app_projects.md index d081e53d..43a26391 100644 --- a/docs/reference/toloka.client.TolokaClient.get_app_projects.md +++ b/docs/reference/toloka.client.TolokaClient.get_app_projects.md @@ -16,7 +16,7 @@ While iterating over the result, several requests to the Toloka server is possib `status`|**Optional\[[AppProject.Status](toloka.client.app.AppProject.Status.md)\]**|

project status.

`after_id`|**Optional\[str\]**|

ID of the project used for cursor pagination.

`scope`|**Optional\[[AppProjectSearchRequest.Scope](toloka.client.search_requests.AppProjectSearchRequest.Scope.md)\]**|

projects created by a specified range of requesters:

-`requester_ids`|**Union\[str, List\[str\]\]**|

List of requester IDs separated by a comma, for scope = REQUESTER_LIST.

+`requester_ids`|**Union\[str, List\[str\], None\]**|

List of requester IDs separated by a comma, for scope = REQUESTER_LIST.

`id_gt`|**Optional\[str\]**|

projects with an ID greater than the specified value.

`id_gte`|**Optional\[str\]**|

projects with an ID greater than or equal to the specified value.

`id_lt`|**Optional\[str\]**|

projects with an ID less than the specified value.

diff --git a/docs/reference/toloka.client.TolokaClient.get_assignment.md b/docs/reference/toloka.client.TolokaClient.get_assignment.md index 962104c2..f5cf1de4 100644 --- a/docs/reference/toloka.client.TolokaClient.get_assignment.md +++ b/docs/reference/toloka.client.TolokaClient.get_assignment.md @@ -1,7 +1,7 @@ # get_assignment -`toloka.client.TolokaClient.get_assignment` +`toloka.client.TolokaClient.get_assignment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_assignment(self, assignment_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_assignments.md b/docs/reference/toloka.client.TolokaClient.get_assignments.md index 7b928a21..6e9884cb 100644 --- a/docs/reference/toloka.client.TolokaClient.get_assignments.md +++ b/docs/reference/toloka.client.TolokaClient.get_assignments.md @@ -11,7 +11,7 @@ While iterating over the result, several requests to the Toloka server is possib | Parameters | Type | Description | | :----------| :----| :-----------| -`status`|**Union\[str, [Assignment.Status](toloka.client.assignment.Assignment.Status.md), List\[Union\[str, [Assignment.Status](toloka.client.assignment.Assignment.Status.md)\]\]\]**|

Status of an assigned task suite (Detailed status description in Assignment.Status):

+`status`|**Union\[str, [Assignment.Status](toloka.client.assignment.Assignment.Status.md), List\[Union\[str, [Assignment.Status](toloka.client.assignment.Assignment.Status.md)\]\], None\]**|

Status of an assigned task suite (Detailed status description in Assignment.Status):

`task_id`|**Optional\[str\]**|

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

`task_suite_id`|**Optional\[str\]**|

ID of a task suite.

`pool_id`|**Optional\[str\]**|

Pool ID.

diff --git a/docs/reference/toloka.client.TolokaClient.get_attachment.md b/docs/reference/toloka.client.TolokaClient.get_attachment.md index 556574d4..f3e0def4 100644 --- a/docs/reference/toloka.client.TolokaClient.get_attachment.md +++ b/docs/reference/toloka.client.TolokaClient.get_attachment.md @@ -1,7 +1,7 @@ # get_attachment -`toloka.client.TolokaClient.get_attachment` +`toloka.client.TolokaClient.get_attachment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_attachment(self, attachment_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_message_threads.md b/docs/reference/toloka.client.TolokaClient.get_message_threads.md index 1d992e54..5e00e8fe 100644 --- a/docs/reference/toloka.client.TolokaClient.get_message_threads.md +++ b/docs/reference/toloka.client.TolokaClient.get_message_threads.md @@ -11,8 +11,8 @@ While iterating over the result, several requests to the Toloka server is possib | Parameters | Type | Description | | :----------| :----| :-----------| -`folder`|**Union\[str, [Folder](toloka.client.message_thread.Folder.md), List\[Union\[str, [Folder](toloka.client.message_thread.Folder.md)\]\]\]**|

Folders to search for the thread

-`folder_ne`|**Union\[str, [Folder](toloka.client.message_thread.Folder.md), List\[Union\[str, [Folder](toloka.client.message_thread.Folder.md)\]\]\]**|

Folders to not search for the thread

+`folder`|**Union\[str, [Folder](toloka.client.message_thread.Folder.md), List\[Union\[str, [Folder](toloka.client.message_thread.Folder.md)\]\], None\]**|

Folders to search for the thread

+`folder_ne`|**Union\[str, [Folder](toloka.client.message_thread.Folder.md), List\[Union\[str, [Folder](toloka.client.message_thread.Folder.md)\]\], None\]**|

Folders to not search for the thread

`id_lt`|**Optional\[str\]**|

Threads with an ID less than the specified value.

`id_lte`|**Optional\[str\]**|

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

`id_gt`|**Optional\[str\]**|

Threads with an ID greater than the specified value.

diff --git a/docs/reference/toloka.client.TolokaClient.get_operation.md b/docs/reference/toloka.client.TolokaClient.get_operation.md index b7c4ad8f..6d9d1325 100644 --- a/docs/reference/toloka.client.TolokaClient.get_operation.md +++ b/docs/reference/toloka.client.TolokaClient.get_operation.md @@ -1,7 +1,7 @@ # get_operation -`toloka.client.TolokaClient.get_operation` +`toloka.client.TolokaClient.get_operation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_operation(self, operation_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_operation_log.md b/docs/reference/toloka.client.TolokaClient.get_operation_log.md index 53340197..d6755a9f 100644 --- a/docs/reference/toloka.client.TolokaClient.get_operation_log.md +++ b/docs/reference/toloka.client.TolokaClient.get_operation_log.md @@ -1,7 +1,7 @@ # get_operation_log -`toloka.client.TolokaClient.get_operation_log` +`toloka.client.TolokaClient.get_operation_log` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_operation_log(self, operation_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_pool.md b/docs/reference/toloka.client.TolokaClient.get_pool.md index c1a74457..8191e196 100644 --- a/docs/reference/toloka.client.TolokaClient.get_pool.md +++ b/docs/reference/toloka.client.TolokaClient.get_pool.md @@ -1,7 +1,7 @@ # get_pool -`toloka.client.TolokaClient.get_pool` +`toloka.client.TolokaClient.get_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_pool(self, pool_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_project.md b/docs/reference/toloka.client.TolokaClient.get_project.md index 13ffe341..32e02b22 100644 --- a/docs/reference/toloka.client.TolokaClient.get_project.md +++ b/docs/reference/toloka.client.TolokaClient.get_project.md @@ -1,7 +1,7 @@ # get_project -`toloka.client.TolokaClient.get_project` +`toloka.client.TolokaClient.get_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_project(self, project_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_requester.md b/docs/reference/toloka.client.TolokaClient.get_requester.md index b648e7cf..6f9082c0 100644 --- a/docs/reference/toloka.client.TolokaClient.get_requester.md +++ b/docs/reference/toloka.client.TolokaClient.get_requester.md @@ -1,7 +1,7 @@ # get_requester -`toloka.client.TolokaClient.get_requester` +`toloka.client.TolokaClient.get_requester` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_requester(self) ``` @@ -31,5 +31,5 @@ requester = toloka_client.get_requester() if requester.balance >= approx_pipeline_price: print('You have enough money on your account!') else: - print('You haven't got enough money on your account!') + print("You haven't got enough money on your account!") ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_skill.md b/docs/reference/toloka.client.TolokaClient.get_skill.md index ae6a8934..f47c350f 100644 --- a/docs/reference/toloka.client.TolokaClient.get_skill.md +++ b/docs/reference/toloka.client.TolokaClient.get_skill.md @@ -1,7 +1,7 @@ # get_skill -`toloka.client.TolokaClient.get_skill` +`toloka.client.TolokaClient.get_skill` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_skill(self, skill_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_task.md b/docs/reference/toloka.client.TolokaClient.get_task.md index 8c682486..72255c60 100644 --- a/docs/reference/toloka.client.TolokaClient.get_task.md +++ b/docs/reference/toloka.client.TolokaClient.get_task.md @@ -1,21 +1,21 @@ # get_task -`toloka.client.TolokaClient.get_task` +`toloka.client.TolokaClient.get_task` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_task(self, task_id: str) ``` -Reads one specific task +Gets a task with specified ID from Toloka. ## Parameters Description | Parameters | Type | Description | | :----------| :----| :-----------| -`task_id`|**str**|

ID of the task.

+`task_id`|**str**|

The ID of the task.

* **Returns:** - The task. + The task with the ID specified in the request. * **Return type:** diff --git a/docs/reference/toloka.client.TolokaClient.get_task_suite.md b/docs/reference/toloka.client.TolokaClient.get_task_suite.md index 1ff87c82..0d864bae 100644 --- a/docs/reference/toloka.client.TolokaClient.get_task_suite.md +++ b/docs/reference/toloka.client.TolokaClient.get_task_suite.md @@ -1,7 +1,7 @@ # get_task_suite -`toloka.client.TolokaClient.get_task_suite` +`toloka.client.TolokaClient.get_task_suite` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_task_suite(self, task_suite_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_tasks.md b/docs/reference/toloka.client.TolokaClient.get_tasks.md index 01b66347..846e426c 100644 --- a/docs/reference/toloka.client.TolokaClient.get_tasks.md +++ b/docs/reference/toloka.client.TolokaClient.get_tasks.md @@ -1,17 +1,19 @@ # get_tasks `toloka.client.TolokaClient.get_tasks` -Finds all tasks that match certain rules and returns them in an iterable object +Finds all tasks that match certain criteria. -Unlike find_tasks, returns generator. Does not sort tasks. -While iterating over the result, several requests to the Toloka server is possible. +`get_tasks` returns a generator and you can iterate over all found tasks. Several requests to the Toloka server +are possible while iterating. + +Note that tasks can not be sorted. If you need to sort tasks use [find_tasks](toloka.client.TolokaClient.find_tasks.md). ## Parameters Description | Parameters | Type | Description | | :----------| :----| :-----------| -`pool_id`|**Optional\[str\]**|

ID of the pool to get tasks from.

+`pool_id`|**Optional\[str\]**|

The ID of the pool to get tasks from.

`overlap`|**Optional\[int\]**|

Tasks with an overlap equal to the specified value.

`id_lt`|**Optional\[str\]**|

Tasks with an ID less than the specified value.

`id_lte`|**Optional\[str\]**|

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

@@ -22,13 +24,13 @@ While iterating over the result, several requests to the Toloka server is possib `created_gt`|**Optional\[datetime\]**|

Tasks created after the specified date.

`created_gte`|**Optional\[datetime\]**|

Tasks created after or on the specified date.

`overlap_lt`|**Optional\[int\]**|

Tasks with an overlap less than the specified value.

-`overlap_lte`|**Optional\[int\]**|

Tasks with an overlap equal to the specified value.

+`overlap_lte`|**Optional\[int\]**|

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

`overlap_gt`|**Optional\[int\]**|

Tasks with an overlap greater than the specified value.

-`overlap_gte`|**Optional\[int\]**|

Tasks with an overlap equal to the specified value.

+`overlap_gte`|**Optional\[int\]**|

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

* **Yields:** - The next object corresponding to the request parameters. + An iterable with found tasks. * **Yield type:** @@ -36,7 +38,7 @@ While iterating over the result, several requests to the Toloka server is possib **Examples:** -Get tasks from a specific pool. +Getting all tasks from a single pool. ```python results_list = [task for task in toloka_client.get_tasks(pool_id='1')] diff --git a/docs/reference/toloka.client.TolokaClient.get_training.md b/docs/reference/toloka.client.TolokaClient.get_training.md index d127c8e3..9364446a 100644 --- a/docs/reference/toloka.client.TolokaClient.get_training.md +++ b/docs/reference/toloka.client.TolokaClient.get_training.md @@ -1,7 +1,7 @@ # get_training -`toloka.client.TolokaClient.get_training` +`toloka.client.TolokaClient.get_training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_training(self, training_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_user_bonus.md b/docs/reference/toloka.client.TolokaClient.get_user_bonus.md index 9ebb1485..034f3cd1 100644 --- a/docs/reference/toloka.client.TolokaClient.get_user_bonus.md +++ b/docs/reference/toloka.client.TolokaClient.get_user_bonus.md @@ -1,7 +1,7 @@ # get_user_bonus -`toloka.client.TolokaClient.get_user_bonus` +`toloka.client.TolokaClient.get_user_bonus` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_user_bonus(self, user_bonus_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_user_restriction.md b/docs/reference/toloka.client.TolokaClient.get_user_restriction.md index 1e882288..bddee445 100644 --- a/docs/reference/toloka.client.TolokaClient.get_user_restriction.md +++ b/docs/reference/toloka.client.TolokaClient.get_user_restriction.md @@ -1,7 +1,7 @@ # get_user_restriction -`toloka.client.TolokaClient.get_user_restriction` +`toloka.client.TolokaClient.get_user_restriction` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_user_restriction(self, user_restriction_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_user_skill.md b/docs/reference/toloka.client.TolokaClient.get_user_skill.md index a0c0767f..f00f193a 100644 --- a/docs/reference/toloka.client.TolokaClient.get_user_skill.md +++ b/docs/reference/toloka.client.TolokaClient.get_user_skill.md @@ -1,7 +1,7 @@ # get_user_skill -`toloka.client.TolokaClient.get_user_skill` +`toloka.client.TolokaClient.get_user_skill` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_user_skill(self, user_skill_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.get_webhook_subscription.md b/docs/reference/toloka.client.TolokaClient.get_webhook_subscription.md index 2a7d4c24..bfb0a2b6 100644 --- a/docs/reference/toloka.client.TolokaClient.get_webhook_subscription.md +++ b/docs/reference/toloka.client.TolokaClient.get_webhook_subscription.md @@ -1,7 +1,7 @@ # get_webhook_subscription -`toloka.client.TolokaClient.get_webhook_subscription` +`toloka.client.TolokaClient.get_webhook_subscription` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python get_webhook_subscription(self, webhook_subscription_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.md b/docs/reference/toloka.client.TolokaClient.md index 15182e6e..909a64b6 100644 --- a/docs/reference/toloka.client.TolokaClient.md +++ b/docs/reference/toloka.client.TolokaClient.md @@ -1,7 +1,7 @@ # TolokaClient -`toloka.client.TolokaClient` +`toloka.client.TolokaClient` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L153) -``` +```python TolokaClient( self, token: str, @@ -47,8 +47,12 @@ your_oauth_token = input('Enter your token:') toloka_client = toloka.TolokaClient(your_oauth_token, 'PRODUCTION') # Or switch to 'SANDBOX' environment ``` -**Note**: `toloka_client` instance will be used to pass all API calls later on. -## Methods summary +{% note info %} + +`toloka_client` instance will be used to pass all API calls later on. + +{% endnote %} +## Methods Summary | Method | Description | | :------| :-----------| @@ -82,12 +86,12 @@ toloka_client = toloka.TolokaClient(your_oauth_token, 'PRODUCTION') # Or switch [create_pool](toloka.client.TolokaClient.create_pool.md)| Creates a new pool [create_project](toloka.client.TolokaClient.create_project.md)| Creates a new project [create_skill](toloka.client.TolokaClient.create_skill.md)| Creates a new Skill -[create_task](toloka.client.TolokaClient.create_task.md)| Creates a new task +[create_task](toloka.client.TolokaClient.create_task.md)| Creates a new task in Toloka. [create_task_suite](toloka.client.TolokaClient.create_task_suite.md)| Creates a new task suite [create_task_suites](toloka.client.TolokaClient.create_task_suites.md)| Creates many task suites in pools [create_task_suites_async](toloka.client.TolokaClient.create_task_suites_async.md)| Creates many task suites in pools, asynchronous version -[create_tasks](toloka.client.TolokaClient.create_tasks.md)| Creates many tasks in pools -[create_tasks_async](toloka.client.TolokaClient.create_tasks_async.md)| Creates many tasks in pools, asynchronous version +[create_tasks](toloka.client.TolokaClient.create_tasks.md)| Creates several tasks in Toloka using a single request. +[create_tasks_async](toloka.client.TolokaClient.create_tasks_async.md)| Creates tasks in Toloka asynchronously. [create_training](toloka.client.TolokaClient.create_training.md)| Creates a new training [create_user_bonus](toloka.client.TolokaClient.create_user_bonus.md)| Issues payments directly to the performer [create_user_bonuses](toloka.client.TolokaClient.create_user_bonuses.md)| Creates many user bonuses @@ -108,7 +112,7 @@ toloka_client = toloka.TolokaClient(your_oauth_token, 'PRODUCTION') # Or switch [find_projects](toloka.client.TolokaClient.find_projects.md)| Finds all projects that match certain rules [find_skills](toloka.client.TolokaClient.find_skills.md)| Finds all skills that match certain rules [find_task_suites](toloka.client.TolokaClient.find_task_suites.md)| Finds all task suites that match certain rules -[find_tasks](toloka.client.TolokaClient.find_tasks.md)| Finds all tasks that match certain rules +[find_tasks](toloka.client.TolokaClient.find_tasks.md)| Finds tasks that match certain criteria. [find_trainings](toloka.client.TolokaClient.find_trainings.md)| Finds all trainings that match certain rules [find_user_bonuses](toloka.client.TolokaClient.find_user_bonuses.md)| Finds all user bonuses that match certain rules [find_user_restrictions](toloka.client.TolokaClient.find_user_restrictions.md)| Finds all user restrictions that match certain rules @@ -139,10 +143,10 @@ toloka_client = toloka.TolokaClient(your_oauth_token, 'PRODUCTION') # Or switch [get_requester](toloka.client.TolokaClient.get_requester.md)| Reads information about the customer and the account balance [get_skill](toloka.client.TolokaClient.get_skill.md)| Reads one specific skill [get_skills](toloka.client.TolokaClient.get_skills.md)| Finds all skills that match certain rules and returns them in an iterable object -[get_task](toloka.client.TolokaClient.get_task.md)| Reads one specific task +[get_task](toloka.client.TolokaClient.get_task.md)| Gets a task with specified ID from Toloka. [get_task_suite](toloka.client.TolokaClient.get_task_suite.md)| Reads one specific task suite [get_task_suites](toloka.client.TolokaClient.get_task_suites.md)| Finds all task suites that match certain rules and returns them in an iterable object -[get_tasks](toloka.client.TolokaClient.get_tasks.md)| Finds all tasks that match certain rules and returns them in an iterable object +[get_tasks](toloka.client.TolokaClient.get_tasks.md)| Finds all tasks that match certain criteria. [get_training](toloka.client.TolokaClient.get_training.md)| Reads one specific training [get_trainings](toloka.client.TolokaClient.get_trainings.md)| Finds all trainings that match certain rules and returns them in an iterable object [get_user_bonus](toloka.client.TolokaClient.get_user_bonus.md)| Reads one specific user bonus @@ -159,8 +163,8 @@ toloka_client = toloka.TolokaClient(your_oauth_token, 'PRODUCTION') # Or switch [open_training_async](toloka.client.TolokaClient.open_training_async.md)| Starts distributing tasks from the training, asynchronous version [patch_assignment](toloka.client.TolokaClient.patch_assignment.md)| Changes status and comment on assignment [patch_pool](toloka.client.TolokaClient.patch_pool.md)| Changes the priority of the pool issue -[patch_task](toloka.client.TolokaClient.patch_task.md)| Changes the task overlap -[patch_task_overlap_or_min](toloka.client.TolokaClient.patch_task_overlap_or_min.md)| Stops issuing the task +[patch_task](toloka.client.TolokaClient.patch_task.md)| Changes a task overlap value. +[patch_task_overlap_or_min](toloka.client.TolokaClient.patch_task_overlap_or_min.md)| Stops assigning a task to users. [patch_task_suite](toloka.client.TolokaClient.patch_task_suite.md)| Changes the task suite overlap or priority [patch_task_suite_overlap_or_min](toloka.client.TolokaClient.patch_task_suite_overlap_or_min.md)| Stops issuing the task suites [reject_assignment](toloka.client.TolokaClient.reject_assignment.md)| Marks one assignment as rejected diff --git a/docs/reference/toloka.client.TolokaClient.open_pool.md b/docs/reference/toloka.client.TolokaClient.open_pool.md index 91514bc0..4860d7d6 100644 --- a/docs/reference/toloka.client.TolokaClient.open_pool.md +++ b/docs/reference/toloka.client.TolokaClient.open_pool.md @@ -1,7 +1,7 @@ # open_pool -`toloka.client.TolokaClient.open_pool` +`toloka.client.TolokaClient.open_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python open_pool(self, pool_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.open_pool_async.md b/docs/reference/toloka.client.TolokaClient.open_pool_async.md index 92af8a4e..fdb36eeb 100644 --- a/docs/reference/toloka.client.TolokaClient.open_pool_async.md +++ b/docs/reference/toloka.client.TolokaClient.open_pool_async.md @@ -1,7 +1,7 @@ # open_pool_async -`toloka.client.TolokaClient.open_pool_async` +`toloka.client.TolokaClient.open_pool_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python open_pool_async(self, pool_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.open_training.md b/docs/reference/toloka.client.TolokaClient.open_training.md index e27efbe8..c330155f 100644 --- a/docs/reference/toloka.client.TolokaClient.open_training.md +++ b/docs/reference/toloka.client.TolokaClient.open_training.md @@ -1,7 +1,7 @@ # open_training -`toloka.client.TolokaClient.open_training` +`toloka.client.TolokaClient.open_training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python open_training(self, training_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.open_training_async.md b/docs/reference/toloka.client.TolokaClient.open_training_async.md index 2c87e52b..b8914600 100644 --- a/docs/reference/toloka.client.TolokaClient.open_training_async.md +++ b/docs/reference/toloka.client.TolokaClient.open_training_async.md @@ -1,7 +1,7 @@ # open_training_async -`toloka.client.TolokaClient.open_training_async` +`toloka.client.TolokaClient.open_training_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python open_training_async(self, training_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.patch_task.md b/docs/reference/toloka.client.TolokaClient.patch_task.md index a53e66ba..853edae0 100644 --- a/docs/reference/toloka.client.TolokaClient.patch_task.md +++ b/docs/reference/toloka.client.TolokaClient.patch_task.md @@ -1,20 +1,20 @@ # patch_task `toloka.client.TolokaClient.patch_task` -Changes the task overlap +Changes a task overlap value. ## Parameters Description | Parameters | Type | Description | | :----------| :----| :-----------| -`task_id`|**str**|

ID of the task that will be changed.

-`overlap`|**Optional\[int\]**|

Overlapping a set of tasks.

-`infinite_overlap`|**Optional\[bool\]**|

Issue a task with infinite overlap. Used, for example, for sets of training tasks to give them to all users:

+`task_id`|**str**|

The ID of the task.

+`overlap`|**Optional\[int\]**|

Overlap value.

+`infinite_overlap`|**Optional\[bool\]**|

Infinite overlap:

Default value: False.

`baseline_solutions`|**Optional\[List\[[Task.BaselineSolution](toloka.client.task.Task.BaselineSolution.md)\]\]**|

* **Returns:** - Task with updated fields. + The task with updated fields. * **Return type:** diff --git a/docs/reference/toloka.client.TolokaClient.patch_task_overlap_or_min.md b/docs/reference/toloka.client.TolokaClient.patch_task_overlap_or_min.md index 351c2f0a..d66ec064 100644 --- a/docs/reference/toloka.client.TolokaClient.patch_task_overlap_or_min.md +++ b/docs/reference/toloka.client.TolokaClient.patch_task_overlap_or_min.md @@ -1,19 +1,19 @@ # patch_task_overlap_or_min `toloka.client.TolokaClient.patch_task_overlap_or_min` -Stops issuing the task +Stops assigning a task to users. ## Parameters Description | Parameters | Type | Description | | :----------| :----| :-----------| -`task_id`|**str**|

ID of the task.

-`overlap`|**Optional\[int\]**|

Overlapping a set of tasks.

-`infinite_overlap`|**Optional\[bool\]**|

Issue a task with infinite overlap. Used, for example, for sets of training tasks to give them to all users:

+`task_id`|**str**|

The ID of the task.

+`overlap`|**Optional\[int\]**|

Overlap value.

+`infinite_overlap`|**Optional\[bool\]**|

Infinite overlap:

Default value: False.

* **Returns:** - Task with updated fields. + The task with updated fields. * **Return type:** @@ -21,10 +21,14 @@ Stops issuing the task **Examples:** -Set an infinite overlap for a specific task in training. +Setting an infinite overlap for a training task. ```python toloka_client.patch_task_overlap_or_min(task_id='1', infinite_overlap=True) ``` -**Note**: you can't set infinite overlap in a regular pool. +{% note info %} + +You can't set infinite overlap in a regular pool. + +{% endnote %} diff --git a/docs/reference/toloka.client.TolokaClient.reject_assignment.md b/docs/reference/toloka.client.TolokaClient.reject_assignment.md index 507478e1..e87bbd61 100644 --- a/docs/reference/toloka.client.TolokaClient.reject_assignment.md +++ b/docs/reference/toloka.client.TolokaClient.reject_assignment.md @@ -1,7 +1,7 @@ # reject_assignment -`toloka.client.TolokaClient.reject_assignment` +`toloka.client.TolokaClient.reject_assignment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python reject_assignment( self, assignment_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.remove_message_thread_from_folders.md b/docs/reference/toloka.client.TolokaClient.remove_message_thread_from_folders.md index 7235d748..93ce1476 100644 --- a/docs/reference/toloka.client.TolokaClient.remove_message_thread_from_folders.md +++ b/docs/reference/toloka.client.TolokaClient.remove_message_thread_from_folders.md @@ -1,11 +1,11 @@ # remove_message_thread_from_folders -`toloka.client.TolokaClient.remove_message_thread_from_folders` +`toloka.client.TolokaClient.remove_message_thread_from_folders` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L323) -``` +```python remove_message_thread_from_folders( self, message_thread_id: str, - folders: Union[List[Union[Folder, str]], MessageThreadFolders] + folders: Union[List[Folder], MessageThreadFolders] ) ``` @@ -16,7 +16,7 @@ Deletes a message chain from one or more folders ("unread", "important" etc.) | Parameters | Type | Description | | :----------| :----| :-----------| `message_thread_id`|**str**|

ID of message chain.

-`folders`|**Union\[List\[Union\[[Folder](toloka.client.message_thread.Folder.md), str\]\], [MessageThreadFolders](toloka.client.message_thread.MessageThreadFolders.md)\]**|

List of folders, where from to remove chain.

+`folders`|**Union\[List\[[Folder](toloka.client.message_thread.Folder.md)\], [MessageThreadFolders](toloka.client.message_thread.MessageThreadFolders.md)\]**|

List of folders, where from to remove chain.

* **Returns:** diff --git a/docs/reference/toloka.client.TolokaClient.reply_message_thread.md b/docs/reference/toloka.client.TolokaClient.reply_message_thread.md index aa04c26e..87911a28 100644 --- a/docs/reference/toloka.client.TolokaClient.reply_message_thread.md +++ b/docs/reference/toloka.client.TolokaClient.reply_message_thread.md @@ -1,7 +1,7 @@ # reply_message_thread -`toloka.client.TolokaClient.reply_message_thread` +`toloka.client.TolokaClient.reply_message_thread` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python reply_message_thread( self, message_thread_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.set_user_restriction.md b/docs/reference/toloka.client.TolokaClient.set_user_restriction.md index 65647305..cd8ff04f 100644 --- a/docs/reference/toloka.client.TolokaClient.set_user_restriction.md +++ b/docs/reference/toloka.client.TolokaClient.set_user_restriction.md @@ -1,7 +1,7 @@ # set_user_restriction -`toloka.client.TolokaClient.set_user_restriction` +`toloka.client.TolokaClient.set_user_restriction` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python set_user_restriction(self, user_restriction: UserRestriction) ``` diff --git a/docs/reference/toloka.client.TolokaClient.start_app_batch.md b/docs/reference/toloka.client.TolokaClient.start_app_batch.md index 6cd9e783..1e3674fd 100644 --- a/docs/reference/toloka.client.TolokaClient.start_app_batch.md +++ b/docs/reference/toloka.client.TolokaClient.start_app_batch.md @@ -1,7 +1,7 @@ # start_app_batch -`toloka.client.TolokaClient.start_app_batch` +`toloka.client.TolokaClient.start_app_batch` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python start_app_batch( self, app_project_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.unarchive_app_project.md b/docs/reference/toloka.client.TolokaClient.unarchive_app_project.md index 3781e187..a676ec16 100644 --- a/docs/reference/toloka.client.TolokaClient.unarchive_app_project.md +++ b/docs/reference/toloka.client.TolokaClient.unarchive_app_project.md @@ -1,7 +1,7 @@ # unarchive_app_project -`toloka.client.TolokaClient.unarchive_app_project` +`toloka.client.TolokaClient.unarchive_app_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python unarchive_app_project(self, app_project_id: str) ``` diff --git a/docs/reference/toloka.client.TolokaClient.update_pool.md b/docs/reference/toloka.client.TolokaClient.update_pool.md index 1697965f..24b889aa 100644 --- a/docs/reference/toloka.client.TolokaClient.update_pool.md +++ b/docs/reference/toloka.client.TolokaClient.update_pool.md @@ -1,7 +1,7 @@ # update_pool -`toloka.client.TolokaClient.update_pool` +`toloka.client.TolokaClient.update_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python update_pool( self, pool_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.update_project.md b/docs/reference/toloka.client.TolokaClient.update_project.md index e10185dc..db1665f7 100644 --- a/docs/reference/toloka.client.TolokaClient.update_project.md +++ b/docs/reference/toloka.client.TolokaClient.update_project.md @@ -1,7 +1,7 @@ # update_project -`toloka.client.TolokaClient.update_project` +`toloka.client.TolokaClient.update_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python update_project( self, project_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.update_skill.md b/docs/reference/toloka.client.TolokaClient.update_skill.md index 7d048a76..6c2fb933 100644 --- a/docs/reference/toloka.client.TolokaClient.update_skill.md +++ b/docs/reference/toloka.client.TolokaClient.update_skill.md @@ -1,7 +1,7 @@ # update_skill -`toloka.client.TolokaClient.update_skill` +`toloka.client.TolokaClient.update_skill` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python update_skill( self, skill_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.update_training.md b/docs/reference/toloka.client.TolokaClient.update_training.md index 5046b67b..5a05307d 100644 --- a/docs/reference/toloka.client.TolokaClient.update_training.md +++ b/docs/reference/toloka.client.TolokaClient.update_training.md @@ -1,7 +1,7 @@ # update_training -`toloka.client.TolokaClient.update_training` +`toloka.client.TolokaClient.update_training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python update_training( self, training_id: str, diff --git a/docs/reference/toloka.client.TolokaClient.upsert_webhook_subscriptions.md b/docs/reference/toloka.client.TolokaClient.upsert_webhook_subscriptions.md index 90e6a64e..07c37fb7 100644 --- a/docs/reference/toloka.client.TolokaClient.upsert_webhook_subscriptions.md +++ b/docs/reference/toloka.client.TolokaClient.upsert_webhook_subscriptions.md @@ -1,7 +1,7 @@ # upsert_webhook_subscriptions -`toloka.client.TolokaClient.upsert_webhook_subscriptions` +`toloka.client.TolokaClient.upsert_webhook_subscriptions` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python upsert_webhook_subscriptions(self, subscriptions: List[WebhookSubscription]) ``` diff --git a/docs/reference/toloka.client.TolokaClient.wait_operation.md b/docs/reference/toloka.client.TolokaClient.wait_operation.md index 926324ec..06fe322f 100644 --- a/docs/reference/toloka.client.TolokaClient.wait_operation.md +++ b/docs/reference/toloka.client.TolokaClient.wait_operation.md @@ -1,7 +1,7 @@ # wait_operation -`toloka.client.TolokaClient.wait_operation` +`toloka.client.TolokaClient.wait_operation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/__init__.py#L44) -``` +```python wait_operation( self, op: Operation, diff --git a/docs/reference/toloka.client.actions.ApproveAllAssignments.md b/docs/reference/toloka.client.actions.ApproveAllAssignments.md index 6786e2fd..0867d562 100644 --- a/docs/reference/toloka.client.actions.ApproveAllAssignments.md +++ b/docs/reference/toloka.client.actions.ApproveAllAssignments.md @@ -1,7 +1,7 @@ # ApproveAllAssignments -`toloka.client.actions.ApproveAllAssignments` +`toloka.client.actions.ApproveAllAssignments` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L208) -``` +```python ApproveAllAssignments(self) ``` diff --git a/docs/reference/toloka.client.actions.ChangeOverlap.Parameters.md b/docs/reference/toloka.client.actions.ChangeOverlap.Parameters.md index 45488255..67c80aed 100644 --- a/docs/reference/toloka.client.actions.ChangeOverlap.Parameters.md +++ b/docs/reference/toloka.client.actions.ChangeOverlap.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.actions.ChangeOverlap.Parameters` +`toloka.client.actions.ChangeOverlap.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L155) -``` +```python Parameters( self, *, diff --git a/docs/reference/toloka.client.actions.ChangeOverlap.md b/docs/reference/toloka.client.actions.ChangeOverlap.md index 1585c083..673ce523 100644 --- a/docs/reference/toloka.client.actions.ChangeOverlap.md +++ b/docs/reference/toloka.client.actions.ChangeOverlap.md @@ -1,7 +1,7 @@ # ChangeOverlap -`toloka.client.actions.ChangeOverlap` +`toloka.client.actions.ChangeOverlap` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L131) -``` +```python ChangeOverlap( self, *, diff --git a/docs/reference/toloka.client.actions.RejectAllAssignments.Parameters.md b/docs/reference/toloka.client.actions.RejectAllAssignments.Parameters.md index f02c0c61..8c0449c7 100644 --- a/docs/reference/toloka.client.actions.RejectAllAssignments.Parameters.md +++ b/docs/reference/toloka.client.actions.RejectAllAssignments.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.actions.RejectAllAssignments.Parameters` +`toloka.client.actions.RejectAllAssignments.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L204) -``` +```python Parameters(self, *, public_comment: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.actions.RejectAllAssignments.md b/docs/reference/toloka.client.actions.RejectAllAssignments.md index c342ab74..900f5950 100644 --- a/docs/reference/toloka.client.actions.RejectAllAssignments.md +++ b/docs/reference/toloka.client.actions.RejectAllAssignments.md @@ -1,7 +1,7 @@ # RejectAllAssignments -`toloka.client.actions.RejectAllAssignments` +`toloka.client.actions.RejectAllAssignments` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L184) -``` +```python RejectAllAssignments(self, *, public_comment: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.actions.Restriction.Parameters.md b/docs/reference/toloka.client.actions.Restriction.Parameters.md index 091944a4..d0f9fe84 100644 --- a/docs/reference/toloka.client.actions.Restriction.Parameters.md +++ b/docs/reference/toloka.client.actions.Restriction.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.actions.Restriction.Parameters` +`toloka.client.actions.Restriction.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L52) -``` +```python Parameters( self, *, diff --git a/docs/reference/toloka.client.actions.Restriction.md b/docs/reference/toloka.client.actions.Restriction.md index f5d130e6..672ee83a 100644 --- a/docs/reference/toloka.client.actions.Restriction.md +++ b/docs/reference/toloka.client.actions.Restriction.md @@ -1,7 +1,7 @@ # Restriction -`toloka.client.actions.Restriction` +`toloka.client.actions.Restriction` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L38) -``` +```python Restriction( self, *, diff --git a/docs/reference/toloka.client.actions.RestrictionV2.Parameters.md b/docs/reference/toloka.client.actions.RestrictionV2.Parameters.md index b588046f..3aa6a2dc 100644 --- a/docs/reference/toloka.client.actions.RestrictionV2.Parameters.md +++ b/docs/reference/toloka.client.actions.RestrictionV2.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.actions.RestrictionV2.Parameters` +`toloka.client.actions.RestrictionV2.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L91) -``` +```python Parameters( self, *, diff --git a/docs/reference/toloka.client.actions.RestrictionV2.md b/docs/reference/toloka.client.actions.RestrictionV2.md index a79fa8d9..442cce2c 100644 --- a/docs/reference/toloka.client.actions.RestrictionV2.md +++ b/docs/reference/toloka.client.actions.RestrictionV2.md @@ -1,7 +1,7 @@ # RestrictionV2 -`toloka.client.actions.RestrictionV2` +`toloka.client.actions.RestrictionV2` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L58) -``` +```python RestrictionV2( self, *, diff --git a/docs/reference/toloka.client.actions.RuleAction.md b/docs/reference/toloka.client.actions.RuleAction.md index 374a21ea..c2b254c2 100644 --- a/docs/reference/toloka.client.actions.RuleAction.md +++ b/docs/reference/toloka.client.actions.RuleAction.md @@ -1,7 +1,7 @@ # RuleAction -`toloka.client.actions.RuleAction` +`toloka.client.actions.RuleAction` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L31) -``` +```python RuleAction(self) ``` diff --git a/docs/reference/toloka.client.actions.RuleType.md b/docs/reference/toloka.client.actions.RuleType.md index f70e5c4b..c25b5971 100644 --- a/docs/reference/toloka.client.actions.RuleType.md +++ b/docs/reference/toloka.client.actions.RuleType.md @@ -1,5 +1,5 @@ # RuleType -`toloka.client.actions.RuleType` +`toloka.client.actions.RuleType` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L20) An enumeration. diff --git a/docs/reference/toloka.client.actions.SetSkill.Parameters.md b/docs/reference/toloka.client.actions.SetSkill.Parameters.md index 524bf496..01e8e108 100644 --- a/docs/reference/toloka.client.actions.SetSkill.Parameters.md +++ b/docs/reference/toloka.client.actions.SetSkill.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.actions.SetSkill.Parameters` +`toloka.client.actions.SetSkill.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L179) -``` +```python Parameters( self, *, diff --git a/docs/reference/toloka.client.actions.SetSkill.md b/docs/reference/toloka.client.actions.SetSkill.md index f1c0ecbd..6ef4063e 100644 --- a/docs/reference/toloka.client.actions.SetSkill.md +++ b/docs/reference/toloka.client.actions.SetSkill.md @@ -1,7 +1,7 @@ # SetSkill -`toloka.client.actions.SetSkill` +`toloka.client.actions.SetSkill` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L160) -``` +```python SetSkill( self, *, diff --git a/docs/reference/toloka.client.actions.SetSkillFromOutputField.Parameters.md b/docs/reference/toloka.client.actions.SetSkillFromOutputField.Parameters.md index c283e22e..f83b8f58 100644 --- a/docs/reference/toloka.client.actions.SetSkillFromOutputField.Parameters.md +++ b/docs/reference/toloka.client.actions.SetSkillFromOutputField.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.actions.SetSkillFromOutputField.Parameters` +`toloka.client.actions.SetSkillFromOutputField.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L126) -``` +```python Parameters( self, *, diff --git a/docs/reference/toloka.client.actions.SetSkillFromOutputField.md b/docs/reference/toloka.client.actions.SetSkillFromOutputField.md index 6bd2701c..f7ff0980 100644 --- a/docs/reference/toloka.client.actions.SetSkillFromOutputField.md +++ b/docs/reference/toloka.client.actions.SetSkillFromOutputField.md @@ -1,7 +1,7 @@ # SetSkillFromOutputField -`toloka.client.actions.SetSkillFromOutputField` +`toloka.client.actions.SetSkillFromOutputField` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/actions.py#L98) -``` +```python SetSkillFromOutputField( self, *, diff --git a/docs/reference/toloka.client.aggregation.AggregatedSolution.md b/docs/reference/toloka.client.aggregation.AggregatedSolution.md index e9f40066..71e4cc9f 100644 --- a/docs/reference/toloka.client.aggregation.AggregatedSolution.md +++ b/docs/reference/toloka.client.aggregation.AggregatedSolution.md @@ -1,7 +1,7 @@ # AggregatedSolution -`toloka.client.aggregation.AggregatedSolution` +`toloka.client.aggregation.AggregatedSolution` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/aggregation.py#L95) -``` +```python AggregatedSolution( self, *, diff --git a/docs/reference/toloka.client.aggregation.AggregatedSolutionType.md b/docs/reference/toloka.client.aggregation.AggregatedSolutionType.md index a844a01c..6bdc7904 100644 --- a/docs/reference/toloka.client.aggregation.AggregatedSolutionType.md +++ b/docs/reference/toloka.client.aggregation.AggregatedSolutionType.md @@ -1,5 +1,5 @@ # AggregatedSolutionType -`toloka.client.aggregation.AggregatedSolutionType` +`toloka.client.aggregation.AggregatedSolutionType` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/aggregation.py#L28) An enumeration. diff --git a/docs/reference/toloka.client.aggregation.PoolAggregatedSolutionRequest.Field.md b/docs/reference/toloka.client.aggregation.PoolAggregatedSolutionRequest.Field.md index 1b251dbe..75f898a9 100644 --- a/docs/reference/toloka.client.aggregation.PoolAggregatedSolutionRequest.Field.md +++ b/docs/reference/toloka.client.aggregation.PoolAggregatedSolutionRequest.Field.md @@ -1,7 +1,7 @@ # Field -`toloka.client.aggregation.PoolAggregatedSolutionRequest.Field` +`toloka.client.aggregation.PoolAggregatedSolutionRequest.Field` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/aggregation.py#L54) -``` +```python Field(self, *, name: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.aggregation.PoolAggregatedSolutionRequest.md b/docs/reference/toloka.client.aggregation.PoolAggregatedSolutionRequest.md index ffe39f87..d4443708 100644 --- a/docs/reference/toloka.client.aggregation.PoolAggregatedSolutionRequest.md +++ b/docs/reference/toloka.client.aggregation.PoolAggregatedSolutionRequest.md @@ -1,7 +1,7 @@ # PoolAggregatedSolutionRequest -`toloka.client.aggregation.PoolAggregatedSolutionRequest` +`toloka.client.aggregation.PoolAggregatedSolutionRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/aggregation.py#L34) -``` +```python PoolAggregatedSolutionRequest( self, *, diff --git a/docs/reference/toloka.client.aggregation.TaskAggregatedSolutionRequest.md b/docs/reference/toloka.client.aggregation.TaskAggregatedSolutionRequest.md index 3511315c..af1c749e 100644 --- a/docs/reference/toloka.client.aggregation.TaskAggregatedSolutionRequest.md +++ b/docs/reference/toloka.client.aggregation.TaskAggregatedSolutionRequest.md @@ -1,7 +1,7 @@ # TaskAggregatedSolutionRequest -`toloka.client.aggregation.TaskAggregatedSolutionRequest` +`toloka.client.aggregation.TaskAggregatedSolutionRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/aggregation.py#L63) -``` +```python TaskAggregatedSolutionRequest( self, *, diff --git a/docs/reference/toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.Field.md b/docs/reference/toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.Field.md index d3d8c98b..8a0a4528 100644 --- a/docs/reference/toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.Field.md +++ b/docs/reference/toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.Field.md @@ -1,7 +1,7 @@ # Field -`toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.Field` +`toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.Field` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/aggregation.py#L88) -``` +```python Field(self, *, name: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.md b/docs/reference/toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.md index 321f02a3..a784adf7 100644 --- a/docs/reference/toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.md +++ b/docs/reference/toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.md @@ -1,7 +1,7 @@ # WeightedDynamicOverlapTaskAggregatedSolutionRequest -`toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest` +`toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/aggregation.py#L75) -``` +```python WeightedDynamicOverlapTaskAggregatedSolutionRequest( self, *, diff --git a/docs/reference/toloka.client.analytics_request.ActiveWorkersByFilterCountPoolAnalytics.md b/docs/reference/toloka.client.analytics_request.ActiveWorkersByFilterCountPoolAnalytics.md index 6d1239ee..4cb896fe 100644 --- a/docs/reference/toloka.client.analytics_request.ActiveWorkersByFilterCountPoolAnalytics.md +++ b/docs/reference/toloka.client.analytics_request.ActiveWorkersByFilterCountPoolAnalytics.md @@ -1,7 +1,7 @@ # ActiveWorkersByFilterCountPoolAnalytics -`toloka.client.analytics_request.ActiveWorkersByFilterCountPoolAnalytics` +`toloka.client.analytics_request.ActiveWorkersByFilterCountPoolAnalytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L147) -``` +```python ActiveWorkersByFilterCountPoolAnalytics( self, *, diff --git a/docs/reference/toloka.client.analytics_request.AnalyticsRequest.Subject.md b/docs/reference/toloka.client.analytics_request.AnalyticsRequest.Subject.md index 05e92304..36643331 100644 --- a/docs/reference/toloka.client.analytics_request.AnalyticsRequest.Subject.md +++ b/docs/reference/toloka.client.analytics_request.AnalyticsRequest.Subject.md @@ -1,5 +1,5 @@ # Subject -`toloka.client.analytics_request.AnalyticsRequest.Subject` +`toloka.client.analytics_request.AnalyticsRequest.Subject` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L32) An enumeration. diff --git a/docs/reference/toloka.client.analytics_request.AnalyticsRequest.md b/docs/reference/toloka.client.analytics_request.AnalyticsRequest.md index fb2b34d8..4fff1540 100644 --- a/docs/reference/toloka.client.analytics_request.AnalyticsRequest.md +++ b/docs/reference/toloka.client.analytics_request.AnalyticsRequest.md @@ -1,7 +1,7 @@ # AnalyticsRequest -`toloka.client.analytics_request.AnalyticsRequest` +`toloka.client.analytics_request.AnalyticsRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L24) -``` +```python AnalyticsRequest(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.analytics_request.ApprovedAssignmentsCountPoolAnalytics.md b/docs/reference/toloka.client.analytics_request.ApprovedAssignmentsCountPoolAnalytics.md index ae6a6843..c5e9b2d8 100644 --- a/docs/reference/toloka.client.analytics_request.ApprovedAssignmentsCountPoolAnalytics.md +++ b/docs/reference/toloka.client.analytics_request.ApprovedAssignmentsCountPoolAnalytics.md @@ -1,7 +1,7 @@ # ApprovedAssignmentsCountPoolAnalytics -`toloka.client.analytics_request.ApprovedAssignmentsCountPoolAnalytics` +`toloka.client.analytics_request.ApprovedAssignmentsCountPoolAnalytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L101) -``` +```python ApprovedAssignmentsCountPoolAnalytics(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.analytics_request.AvgSubmitAssignmentMillisPoolAnalytics.md b/docs/reference/toloka.client.analytics_request.AvgSubmitAssignmentMillisPoolAnalytics.md index 659eed59..73260fa2 100644 --- a/docs/reference/toloka.client.analytics_request.AvgSubmitAssignmentMillisPoolAnalytics.md +++ b/docs/reference/toloka.client.analytics_request.AvgSubmitAssignmentMillisPoolAnalytics.md @@ -1,7 +1,7 @@ # AvgSubmitAssignmentMillisPoolAnalytics -`toloka.client.analytics_request.AvgSubmitAssignmentMillisPoolAnalytics` +`toloka.client.analytics_request.AvgSubmitAssignmentMillisPoolAnalytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L119) -``` +```python AvgSubmitAssignmentMillisPoolAnalytics(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.analytics_request.CompletionPercentagePoolAnalytics.md b/docs/reference/toloka.client.analytics_request.CompletionPercentagePoolAnalytics.md index 492b4990..a882f32d 100644 --- a/docs/reference/toloka.client.analytics_request.CompletionPercentagePoolAnalytics.md +++ b/docs/reference/toloka.client.analytics_request.CompletionPercentagePoolAnalytics.md @@ -1,7 +1,7 @@ # CompletionPercentagePoolAnalytics -`toloka.client.analytics_request.CompletionPercentagePoolAnalytics` +`toloka.client.analytics_request.CompletionPercentagePoolAnalytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L112) -``` +```python CompletionPercentagePoolAnalytics(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.analytics_request.EstimatedAssignmentsCountPoolAnalytics.md b/docs/reference/toloka.client.analytics_request.EstimatedAssignmentsCountPoolAnalytics.md index 96ac2483..a0c64c2e 100644 --- a/docs/reference/toloka.client.analytics_request.EstimatedAssignmentsCountPoolAnalytics.md +++ b/docs/reference/toloka.client.analytics_request.EstimatedAssignmentsCountPoolAnalytics.md @@ -1,7 +1,7 @@ # EstimatedAssignmentsCountPoolAnalytics -`toloka.client.analytics_request.EstimatedAssignmentsCountPoolAnalytics` +`toloka.client.analytics_request.EstimatedAssignmentsCountPoolAnalytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L157) -``` +```python EstimatedAssignmentsCountPoolAnalytics(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.analytics_request.PoolAnalyticsRequest.Subject.md b/docs/reference/toloka.client.analytics_request.PoolAnalyticsRequest.Subject.md index d11d6a04..e7e115e6 100644 --- a/docs/reference/toloka.client.analytics_request.PoolAnalyticsRequest.Subject.md +++ b/docs/reference/toloka.client.analytics_request.PoolAnalyticsRequest.Subject.md @@ -1,5 +1,5 @@ # Subject -`toloka.client.analytics_request.PoolAnalyticsRequest.Subject` +`toloka.client.analytics_request.PoolAnalyticsRequest.Subject` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L51) An enumeration. diff --git a/docs/reference/toloka.client.analytics_request.PoolAnalyticsRequest.md b/docs/reference/toloka.client.analytics_request.PoolAnalyticsRequest.md index c08e1f5a..8ff96af0 100644 --- a/docs/reference/toloka.client.analytics_request.PoolAnalyticsRequest.md +++ b/docs/reference/toloka.client.analytics_request.PoolAnalyticsRequest.md @@ -1,7 +1,7 @@ # PoolAnalyticsRequest -`toloka.client.analytics_request.PoolAnalyticsRequest` +`toloka.client.analytics_request.PoolAnalyticsRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L39) -``` +```python PoolAnalyticsRequest(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.analytics_request.RealTasksCountPoolAnalytics.md b/docs/reference/toloka.client.analytics_request.RealTasksCountPoolAnalytics.md index 45579bcc..37b0bd21 100644 --- a/docs/reference/toloka.client.analytics_request.RealTasksCountPoolAnalytics.md +++ b/docs/reference/toloka.client.analytics_request.RealTasksCountPoolAnalytics.md @@ -1,7 +1,7 @@ # RealTasksCountPoolAnalytics -`toloka.client.analytics_request.RealTasksCountPoolAnalytics` +`toloka.client.analytics_request.RealTasksCountPoolAnalytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L67) -``` +```python RealTasksCountPoolAnalytics(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.analytics_request.RejectedAssignmentsCountPoolAnalytics.md b/docs/reference/toloka.client.analytics_request.RejectedAssignmentsCountPoolAnalytics.md index 72b32867..30ce15e4 100644 --- a/docs/reference/toloka.client.analytics_request.RejectedAssignmentsCountPoolAnalytics.md +++ b/docs/reference/toloka.client.analytics_request.RejectedAssignmentsCountPoolAnalytics.md @@ -1,7 +1,7 @@ # RejectedAssignmentsCountPoolAnalytics -`toloka.client.analytics_request.RejectedAssignmentsCountPoolAnalytics` +`toloka.client.analytics_request.RejectedAssignmentsCountPoolAnalytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L94) -``` +```python RejectedAssignmentsCountPoolAnalytics(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.analytics_request.SkippedAssignmentsCountPoolAnalytics.md b/docs/reference/toloka.client.analytics_request.SkippedAssignmentsCountPoolAnalytics.md index 3787c69a..76182ac7 100644 --- a/docs/reference/toloka.client.analytics_request.SkippedAssignmentsCountPoolAnalytics.md +++ b/docs/reference/toloka.client.analytics_request.SkippedAssignmentsCountPoolAnalytics.md @@ -1,7 +1,7 @@ # SkippedAssignmentsCountPoolAnalytics -`toloka.client.analytics_request.SkippedAssignmentsCountPoolAnalytics` +`toloka.client.analytics_request.SkippedAssignmentsCountPoolAnalytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L87) -``` +```python SkippedAssignmentsCountPoolAnalytics(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.analytics_request.SpentBudgetPoolAnalytics.md b/docs/reference/toloka.client.analytics_request.SpentBudgetPoolAnalytics.md index 09e78f7d..dff129a0 100644 --- a/docs/reference/toloka.client.analytics_request.SpentBudgetPoolAnalytics.md +++ b/docs/reference/toloka.client.analytics_request.SpentBudgetPoolAnalytics.md @@ -1,7 +1,7 @@ # SpentBudgetPoolAnalytics -`toloka.client.analytics_request.SpentBudgetPoolAnalytics` +`toloka.client.analytics_request.SpentBudgetPoolAnalytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L126) -``` +```python SpentBudgetPoolAnalytics(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.analytics_request.SubmitedAssignmentsCountPoolAnalytics.md b/docs/reference/toloka.client.analytics_request.SubmitedAssignmentsCountPoolAnalytics.md index 131be548..8c3b2a15 100644 --- a/docs/reference/toloka.client.analytics_request.SubmitedAssignmentsCountPoolAnalytics.md +++ b/docs/reference/toloka.client.analytics_request.SubmitedAssignmentsCountPoolAnalytics.md @@ -1,7 +1,7 @@ # SubmitedAssignmentsCountPoolAnalytics -`toloka.client.analytics_request.SubmitedAssignmentsCountPoolAnalytics` +`toloka.client.analytics_request.SubmitedAssignmentsCountPoolAnalytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L76) -``` +```python SubmitedAssignmentsCountPoolAnalytics(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.analytics_request.UniqueSubmittersCountPoolAnalytics.md b/docs/reference/toloka.client.analytics_request.UniqueSubmittersCountPoolAnalytics.md index bfd82a06..ef86e50d 100644 --- a/docs/reference/toloka.client.analytics_request.UniqueSubmittersCountPoolAnalytics.md +++ b/docs/reference/toloka.client.analytics_request.UniqueSubmittersCountPoolAnalytics.md @@ -1,7 +1,7 @@ # UniqueSubmittersCountPoolAnalytics -`toloka.client.analytics_request.UniqueSubmittersCountPoolAnalytics` +`toloka.client.analytics_request.UniqueSubmittersCountPoolAnalytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L140) -``` +```python UniqueSubmittersCountPoolAnalytics(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.analytics_request.UniqueWorkersCountPoolAnalytics.md b/docs/reference/toloka.client.analytics_request.UniqueWorkersCountPoolAnalytics.md index 764f0e42..18893d3d 100644 --- a/docs/reference/toloka.client.analytics_request.UniqueWorkersCountPoolAnalytics.md +++ b/docs/reference/toloka.client.analytics_request.UniqueWorkersCountPoolAnalytics.md @@ -1,7 +1,7 @@ # UniqueWorkersCountPoolAnalytics -`toloka.client.analytics_request.UniqueWorkersCountPoolAnalytics` +`toloka.client.analytics_request.UniqueWorkersCountPoolAnalytics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/analytics_request.py#L133) -``` +```python UniqueWorkersCountPoolAnalytics(self, *, subject_id: str) ``` diff --git a/docs/reference/toloka.client.app.App.md b/docs/reference/toloka.client.app.App.md index baf7faec..7807ce15 100644 --- a/docs/reference/toloka.client.app.App.md +++ b/docs/reference/toloka.client.app.App.md @@ -1,7 +1,7 @@ # App -`toloka.client.app.App` +`toloka.client.app.App` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/app/__init__.py#L71) -``` +```python App( self, *, diff --git a/docs/reference/toloka.client.app.AppBatch.Status.md b/docs/reference/toloka.client.app.AppBatch.Status.md index 6b1833a8..bd757c3e 100644 --- a/docs/reference/toloka.client.app.AppBatch.Status.md +++ b/docs/reference/toloka.client.app.AppBatch.Status.md @@ -1,5 +1,5 @@ # Status -`toloka.client.app.AppBatch.Status` +`toloka.client.app.AppBatch.Status` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/app/__init__.py#L187) An enumeration. diff --git a/docs/reference/toloka.client.app.AppBatch.md b/docs/reference/toloka.client.app.AppBatch.md index 93a5232f..8ebe78a5 100644 --- a/docs/reference/toloka.client.app.AppBatch.md +++ b/docs/reference/toloka.client.app.AppBatch.md @@ -1,7 +1,7 @@ # AppBatch -`toloka.client.app.AppBatch` +`toloka.client.app.AppBatch` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/app/__init__.py#L164) -``` +```python AppBatch( self, *, diff --git a/docs/reference/toloka.client.app.AppBatchCreateRequest.md b/docs/reference/toloka.client.app.AppBatchCreateRequest.md index 10d813d6..a6a7b10e 100644 --- a/docs/reference/toloka.client.app.AppBatchCreateRequest.md +++ b/docs/reference/toloka.client.app.AppBatchCreateRequest.md @@ -1,7 +1,7 @@ # AppBatchCreateRequest -`toloka.client.app.AppBatchCreateRequest` +`toloka.client.app.AppBatchCreateRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/app/__init__.py#L209) -``` +```python AppBatchCreateRequest(self, *, items: Optional[List[Dict[str, Any]]] = None) ``` diff --git a/docs/reference/toloka.client.app.AppItem.Status.md b/docs/reference/toloka.client.app.AppItem.Status.md index f4cfe1ef..bdf8e835 100644 --- a/docs/reference/toloka.client.app.AppItem.Status.md +++ b/docs/reference/toloka.client.app.AppItem.Status.md @@ -1,5 +1,5 @@ # Status -`toloka.client.app.AppItem.Status` +`toloka.client.app.AppItem.Status` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/app/__init__.py#L127) An enumeration. diff --git a/docs/reference/toloka.client.app.AppItem.md b/docs/reference/toloka.client.app.AppItem.md index 9d1311f2..e4ad049f 100644 --- a/docs/reference/toloka.client.app.AppItem.md +++ b/docs/reference/toloka.client.app.AppItem.md @@ -1,7 +1,7 @@ # AppItem -`toloka.client.app.AppItem` +`toloka.client.app.AppItem` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/app/__init__.py#L100) -``` +```python AppItem( self, *, @@ -13,7 +13,7 @@ AppItem( updated: Optional[datetime] = None, status: Union[Status, str, None] = None, output_data: Optional[Dict[str, Any]] = None, - errors: Optional[_AppError] = None, + errors: Optional[List[_AppError]] = None, created_at: Optional[datetime] = None, started_at: Optional[datetime] = None, finished_at: Optional[datetime] = None @@ -37,7 +37,7 @@ In a TSV file with tasks, each line is a work item. `updated`|**Optional\[datetime\]**|

`status`|**Optional\[[Status](toloka.client.app.AppItem.Status.md)\]**|

Processing status. If the item has the NEW status, it can be edited. In other statuses, the item is immutable. Allowed values:

`output_data`|**Optional\[Dict\[str, Any\]\]**|

Processing result.

-`errors`|**Optional\[[_AppError](toloka.client.app._AppError.md)\]**|

+`errors`|**Optional\[List\[[_AppError](toloka.client.app._AppError.md)\]\]**|

`created_at`|**Optional\[datetime\]**|

Date and time when the item was created.

`started_at`|**Optional\[datetime\]**|

Date and time when the item processing started.

`finished_at`|**Optional\[datetime\]**|

Date and time when the item processing was completed.

diff --git a/docs/reference/toloka.client.app.AppItemsCreateRequest.md b/docs/reference/toloka.client.app.AppItemsCreateRequest.md index a37debba..509de0d1 100644 --- a/docs/reference/toloka.client.app.AppItemsCreateRequest.md +++ b/docs/reference/toloka.client.app.AppItemsCreateRequest.md @@ -1,7 +1,7 @@ # AppItemsCreateRequest -`toloka.client.app.AppItemsCreateRequest` +`toloka.client.app.AppItemsCreateRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/app/__init__.py#L152) -``` +```python AppItemsCreateRequest( self, *, diff --git a/docs/reference/toloka.client.app.AppProject.Status.md b/docs/reference/toloka.client.app.AppProject.Status.md index 2934dccc..6cf3b135 100644 --- a/docs/reference/toloka.client.app.AppProject.Status.md +++ b/docs/reference/toloka.client.app.AppProject.Status.md @@ -1,5 +1,5 @@ # Status -`toloka.client.app.AppProject.Status` +`toloka.client.app.AppProject.Status` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/app/__init__.py#L52) An enumeration. diff --git a/docs/reference/toloka.client.app.AppProject.md b/docs/reference/toloka.client.app.AppProject.md index c1f9d379..ed8ce21a 100644 --- a/docs/reference/toloka.client.app.AppProject.md +++ b/docs/reference/toloka.client.app.AppProject.md @@ -1,7 +1,7 @@ # AppProject -`toloka.client.app.AppProject` +`toloka.client.app.AppProject` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/app/__init__.py#L31) -``` +```python AppProject( self, *, diff --git a/docs/reference/toloka.client.app._AppError.md b/docs/reference/toloka.client.app._AppError.md index d33eed81..41555ac4 100644 --- a/docs/reference/toloka.client.app._AppError.md +++ b/docs/reference/toloka.client.app._AppError.md @@ -1,7 +1,7 @@ # _AppError -`toloka.client.app._AppError` +`toloka.client.app._AppError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/app/__init__.py#L19) -``` +```python _AppError( self, *, diff --git a/docs/reference/toloka.client.assignment.Assignment.Status.md b/docs/reference/toloka.client.assignment.Assignment.Status.md index e6d0765c..2b1f8c3d 100644 --- a/docs/reference/toloka.client.assignment.Assignment.Status.md +++ b/docs/reference/toloka.client.assignment.Assignment.Status.md @@ -1,5 +1,5 @@ # Status -`toloka.client.assignment.Assignment.Status` +`toloka.client.assignment.Assignment.Status` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/assignment.py#L56) An enumeration. diff --git a/docs/reference/toloka.client.assignment.Assignment.md b/docs/reference/toloka.client.assignment.Assignment.md index 54294c0d..135bdfa8 100644 --- a/docs/reference/toloka.client.assignment.Assignment.md +++ b/docs/reference/toloka.client.assignment.Assignment.md @@ -1,7 +1,7 @@ # Assignment -`toloka.client.assignment.Assignment` +`toloka.client.assignment.Assignment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/assignment.py#L19) -``` +```python Assignment( self, *, diff --git a/docs/reference/toloka.client.assignment.AssignmentPatch.md b/docs/reference/toloka.client.assignment.AssignmentPatch.md index bc225b7a..c39fcf38 100644 --- a/docs/reference/toloka.client.assignment.AssignmentPatch.md +++ b/docs/reference/toloka.client.assignment.AssignmentPatch.md @@ -1,7 +1,7 @@ # AssignmentPatch -`toloka.client.assignment.AssignmentPatch` +`toloka.client.assignment.AssignmentPatch` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/assignment.py#L95) -``` +```python AssignmentPatch( self, *, diff --git a/docs/reference/toloka.client.assignment.GetAssignmentsTsvParameters.Field.md b/docs/reference/toloka.client.assignment.GetAssignmentsTsvParameters.Field.md index 046e15b4..027c1b4b 100644 --- a/docs/reference/toloka.client.assignment.GetAssignmentsTsvParameters.Field.md +++ b/docs/reference/toloka.client.assignment.GetAssignmentsTsvParameters.Field.md @@ -1,5 +1,5 @@ # Field -`toloka.client.assignment.GetAssignmentsTsvParameters.Field` +`toloka.client.assignment.GetAssignmentsTsvParameters.Field` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/assignment.py#L134) An enumeration. diff --git a/docs/reference/toloka.client.assignment.GetAssignmentsTsvParameters.Status.md b/docs/reference/toloka.client.assignment.GetAssignmentsTsvParameters.Status.md index fded7389..2dce9182 100644 --- a/docs/reference/toloka.client.assignment.GetAssignmentsTsvParameters.Status.md +++ b/docs/reference/toloka.client.assignment.GetAssignmentsTsvParameters.Status.md @@ -1,5 +1,5 @@ # Status -`toloka.client.assignment.GetAssignmentsTsvParameters.Status` +`toloka.client.assignment.GetAssignmentsTsvParameters.Status` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/assignment.py#L125) An enumeration. diff --git a/docs/reference/toloka.client.assignment.GetAssignmentsTsvParameters.md b/docs/reference/toloka.client.assignment.GetAssignmentsTsvParameters.md index e22613cd..8e23da95 100644 --- a/docs/reference/toloka.client.assignment.GetAssignmentsTsvParameters.md +++ b/docs/reference/toloka.client.assignment.GetAssignmentsTsvParameters.md @@ -1,7 +1,7 @@ # GetAssignmentsTsvParameters -`toloka.client.assignment.GetAssignmentsTsvParameters` +`toloka.client.assignment.GetAssignmentsTsvParameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/assignment.py#L110) -``` +```python GetAssignmentsTsvParameters( self, *, diff --git a/docs/reference/toloka.client.attachment.AssignmentAttachment.md b/docs/reference/toloka.client.attachment.AssignmentAttachment.md index 00975d9d..b6aef555 100644 --- a/docs/reference/toloka.client.attachment.AssignmentAttachment.md +++ b/docs/reference/toloka.client.attachment.AssignmentAttachment.md @@ -1,7 +1,7 @@ # AssignmentAttachment -`toloka.client.attachment.AssignmentAttachment` +`toloka.client.attachment.AssignmentAttachment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/attachment.py#L55) -``` +```python AssignmentAttachment( self, *, diff --git a/docs/reference/toloka.client.attachment.Attachment.Details.md b/docs/reference/toloka.client.attachment.Attachment.Details.md index c0dcb53e..b3a93bb2 100644 --- a/docs/reference/toloka.client.attachment.Attachment.Details.md +++ b/docs/reference/toloka.client.attachment.Attachment.Details.md @@ -1,7 +1,7 @@ # Details -`toloka.client.attachment.Attachment.Details` +`toloka.client.attachment.Attachment.Details` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/attachment.py#L33) -``` +```python Details( self, *, diff --git a/docs/reference/toloka.client.attachment.Attachment.Type.md b/docs/reference/toloka.client.attachment.Attachment.Type.md index 9ef30f34..b96228a0 100644 --- a/docs/reference/toloka.client.attachment.Attachment.Type.md +++ b/docs/reference/toloka.client.attachment.Attachment.Type.md @@ -1,5 +1,5 @@ # Type -`toloka.client.attachment.Attachment.Type` +`toloka.client.attachment.Attachment.Type` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/attachment.py#L27) An enumeration. diff --git a/docs/reference/toloka.client.attachment.Attachment.md b/docs/reference/toloka.client.attachment.Attachment.md index 7f3dddf7..32a73151 100644 --- a/docs/reference/toloka.client.attachment.Attachment.md +++ b/docs/reference/toloka.client.attachment.Attachment.md @@ -1,7 +1,7 @@ # Attachment -`toloka.client.attachment.Attachment` +`toloka.client.attachment.Attachment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/attachment.py#L14) -``` +```python Attachment( self, *, diff --git a/docs/reference/toloka.client.batch_create_results.FieldValidationError.md b/docs/reference/toloka.client.batch_create_results.FieldValidationError.md index d2b65531..32ea5de4 100644 --- a/docs/reference/toloka.client.batch_create_results.FieldValidationError.md +++ b/docs/reference/toloka.client.batch_create_results.FieldValidationError.md @@ -1,7 +1,7 @@ # FieldValidationError -`toloka.client.batch_create_results.FieldValidationError` +`toloka.client.batch_create_results.FieldValidationError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/batch_create_results.py#L16) -``` +```python FieldValidationError( self, *, diff --git a/docs/reference/toloka.client.batch_create_results.TaskBatchCreateResult.md b/docs/reference/toloka.client.batch_create_results.TaskBatchCreateResult.md index 91c2468a..d3763acf 100644 --- a/docs/reference/toloka.client.batch_create_results.TaskBatchCreateResult.md +++ b/docs/reference/toloka.client.batch_create_results.TaskBatchCreateResult.md @@ -1,7 +1,7 @@ # TaskBatchCreateResult `toloka.client.batch_create_results.TaskBatchCreateResult` -``` +```python TaskBatchCreateResult( self, *, diff --git a/docs/reference/toloka.client.batch_create_results.TaskSuiteBatchCreateResult.md b/docs/reference/toloka.client.batch_create_results.TaskSuiteBatchCreateResult.md index b07d81f8..33f09b67 100644 --- a/docs/reference/toloka.client.batch_create_results.TaskSuiteBatchCreateResult.md +++ b/docs/reference/toloka.client.batch_create_results.TaskSuiteBatchCreateResult.md @@ -1,7 +1,7 @@ # TaskSuiteBatchCreateResult `toloka.client.batch_create_results.TaskSuiteBatchCreateResult` -``` +```python TaskSuiteBatchCreateResult( self, *, diff --git a/docs/reference/toloka.client.batch_create_results.UserBonusBatchCreateResult.md b/docs/reference/toloka.client.batch_create_results.UserBonusBatchCreateResult.md index 7d4ad854..0c717431 100644 --- a/docs/reference/toloka.client.batch_create_results.UserBonusBatchCreateResult.md +++ b/docs/reference/toloka.client.batch_create_results.UserBonusBatchCreateResult.md @@ -1,7 +1,7 @@ # UserBonusBatchCreateResult `toloka.client.batch_create_results.UserBonusBatchCreateResult` -``` +```python UserBonusBatchCreateResult( self, *, diff --git a/docs/reference/toloka.client.batch_create_results.WebhookSubscriptionBatchCreateResult.md b/docs/reference/toloka.client.batch_create_results.WebhookSubscriptionBatchCreateResult.md index 00f35d34..f785b4e7 100644 --- a/docs/reference/toloka.client.batch_create_results.WebhookSubscriptionBatchCreateResult.md +++ b/docs/reference/toloka.client.batch_create_results.WebhookSubscriptionBatchCreateResult.md @@ -1,7 +1,7 @@ # WebhookSubscriptionBatchCreateResult `toloka.client.batch_create_results.WebhookSubscriptionBatchCreateResult` -``` +```python WebhookSubscriptionBatchCreateResult( self, *, diff --git a/docs/reference/toloka.client.clone_results.CloneResults.md b/docs/reference/toloka.client.clone_results.CloneResults.md index b04a76ed..f8e9bc6d 100644 --- a/docs/reference/toloka.client.clone_results.CloneResults.md +++ b/docs/reference/toloka.client.clone_results.CloneResults.md @@ -1,5 +1,5 @@ # CloneResults -`toloka.client.clone_results.CloneResults` +`toloka.client.clone_results.CloneResults` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/clone_results.py#L8) Objects created as a result of deep cloning of the project diff --git a/docs/reference/toloka.client.collectors.AcceptanceRate.Parameters.md b/docs/reference/toloka.client.collectors.AcceptanceRate.Parameters.md index 5dae84eb..ea77e859 100644 --- a/docs/reference/toloka.client.collectors.AcceptanceRate.Parameters.md +++ b/docs/reference/toloka.client.collectors.AcceptanceRate.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.collectors.AcceptanceRate.Parameters` +`toloka.client.collectors.AcceptanceRate.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L112) -``` +```python Parameters(self, *, history_size: Optional[int] = None) ``` diff --git a/docs/reference/toloka.client.collectors.AcceptanceRate.md b/docs/reference/toloka.client.collectors.AcceptanceRate.md index 78d45baa..70d86275 100644 --- a/docs/reference/toloka.client.collectors.AcceptanceRate.md +++ b/docs/reference/toloka.client.collectors.AcceptanceRate.md @@ -1,7 +1,7 @@ # AcceptanceRate -`toloka.client.collectors.AcceptanceRate` +`toloka.client.collectors.AcceptanceRate` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L62) -``` +```python AcceptanceRate( self, *, diff --git a/docs/reference/toloka.client.collectors.AnswerCount.md b/docs/reference/toloka.client.collectors.AnswerCount.md index e9ed5b94..0367dfa4 100644 --- a/docs/reference/toloka.client.collectors.AnswerCount.md +++ b/docs/reference/toloka.client.collectors.AnswerCount.md @@ -1,7 +1,7 @@ # AnswerCount -`toloka.client.collectors.AnswerCount` +`toloka.client.collectors.AnswerCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L116) -``` +```python AnswerCount(self, *, uuid: Optional[UUID] = None) ``` diff --git a/docs/reference/toloka.client.collectors.AssignmentSubmitTime.Parameters.md b/docs/reference/toloka.client.collectors.AssignmentSubmitTime.Parameters.md index 8f840c3b..12977626 100644 --- a/docs/reference/toloka.client.collectors.AssignmentSubmitTime.Parameters.md +++ b/docs/reference/toloka.client.collectors.AssignmentSubmitTime.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.collectors.AssignmentSubmitTime.Parameters` +`toloka.client.collectors.AssignmentSubmitTime.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L232) -``` +```python Parameters( self, *, diff --git a/docs/reference/toloka.client.collectors.AssignmentSubmitTime.md b/docs/reference/toloka.client.collectors.AssignmentSubmitTime.md index 96f0731d..ee672e2f 100644 --- a/docs/reference/toloka.client.collectors.AssignmentSubmitTime.md +++ b/docs/reference/toloka.client.collectors.AssignmentSubmitTime.md @@ -1,7 +1,7 @@ # AssignmentSubmitTime -`toloka.client.collectors.AssignmentSubmitTime` +`toloka.client.collectors.AssignmentSubmitTime` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L192) -``` +```python AssignmentSubmitTime( self, *, diff --git a/docs/reference/toloka.client.collectors.AssignmentsAssessment.md b/docs/reference/toloka.client.collectors.AssignmentsAssessment.md index d4da5e8f..bf5d6fa4 100644 --- a/docs/reference/toloka.client.collectors.AssignmentsAssessment.md +++ b/docs/reference/toloka.client.collectors.AssignmentsAssessment.md @@ -1,7 +1,7 @@ # AssignmentsAssessment -`toloka.client.collectors.AssignmentsAssessment` +`toloka.client.collectors.AssignmentsAssessment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L151) -``` +```python AssignmentsAssessment(self, *, uuid: Optional[UUID] = None) ``` diff --git a/docs/reference/toloka.client.collectors.Captcha.Parameters.md b/docs/reference/toloka.client.collectors.Captcha.Parameters.md index 34d72536..678519b4 100644 --- a/docs/reference/toloka.client.collectors.Captcha.Parameters.md +++ b/docs/reference/toloka.client.collectors.Captcha.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.collectors.Captcha.Parameters` +`toloka.client.collectors.Captcha.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L282) -``` +```python Parameters(self, *, history_size: Optional[int] = None) ``` diff --git a/docs/reference/toloka.client.collectors.Captcha.md b/docs/reference/toloka.client.collectors.Captcha.md index 4337a38f..005321ea 100644 --- a/docs/reference/toloka.client.collectors.Captcha.md +++ b/docs/reference/toloka.client.collectors.Captcha.md @@ -1,7 +1,7 @@ # Captcha -`toloka.client.collectors.Captcha` +`toloka.client.collectors.Captcha` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L237) -``` +```python Captcha( self, *, diff --git a/docs/reference/toloka.client.collectors.CollectorConfig.Type.md b/docs/reference/toloka.client.collectors.CollectorConfig.Type.md index 6c85bdd4..1e8f7536 100644 --- a/docs/reference/toloka.client.collectors.CollectorConfig.Type.md +++ b/docs/reference/toloka.client.collectors.CollectorConfig.Type.md @@ -1,5 +1,5 @@ # Type -`toloka.client.collectors.CollectorConfig.Type` +`toloka.client.collectors.CollectorConfig.Type` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L40) An enumeration. diff --git a/docs/reference/toloka.client.collectors.CollectorConfig.md b/docs/reference/toloka.client.collectors.CollectorConfig.md index f59ad03f..cf92b840 100644 --- a/docs/reference/toloka.client.collectors.CollectorConfig.md +++ b/docs/reference/toloka.client.collectors.CollectorConfig.md @@ -1,7 +1,7 @@ # CollectorConfig -`toloka.client.collectors.CollectorConfig` +`toloka.client.collectors.CollectorConfig` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L29) -``` +```python CollectorConfig(self, *, uuid: Optional[UUID] = None) ``` @@ -13,7 +13,7 @@ Attriutes: So collectors can behave a little unexpectedly. For example they start gather "history_size" patameter from both pools. -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.collectors.CollectorConfig.validate_condition.md b/docs/reference/toloka.client.collectors.CollectorConfig.validate_condition.md index 1bd3eb6c..fcf6164d 100644 --- a/docs/reference/toloka.client.collectors.CollectorConfig.validate_condition.md +++ b/docs/reference/toloka.client.collectors.CollectorConfig.validate_condition.md @@ -1,7 +1,7 @@ # validate_condition -`toloka.client.collectors.CollectorConfig.validate_condition` +`toloka.client.collectors.CollectorConfig.validate_condition` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L54) -``` +```python validate_condition(self, conditions: List[RuleCondition]) ``` diff --git a/docs/reference/toloka.client.collectors.GoldenSet.Parameters.md b/docs/reference/toloka.client.collectors.GoldenSet.Parameters.md index 6c9e9a39..36396798 100644 --- a/docs/reference/toloka.client.collectors.GoldenSet.Parameters.md +++ b/docs/reference/toloka.client.collectors.GoldenSet.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.collectors.GoldenSet.Parameters` +`toloka.client.collectors.GoldenSet.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L339) -``` +```python Parameters(self, *, history_size: Optional[int] = None) ``` diff --git a/docs/reference/toloka.client.collectors.GoldenSet.md b/docs/reference/toloka.client.collectors.GoldenSet.md index fd4b4536..b5d9dca9 100644 --- a/docs/reference/toloka.client.collectors.GoldenSet.md +++ b/docs/reference/toloka.client.collectors.GoldenSet.md @@ -1,7 +1,7 @@ # GoldenSet -`toloka.client.collectors.GoldenSet` +`toloka.client.collectors.GoldenSet` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L286) -``` +```python GoldenSet( self, *, diff --git a/docs/reference/toloka.client.collectors.Income.md b/docs/reference/toloka.client.collectors.Income.md index 44a042f0..acc9043e 100644 --- a/docs/reference/toloka.client.collectors.Income.md +++ b/docs/reference/toloka.client.collectors.Income.md @@ -1,7 +1,7 @@ # Income -`toloka.client.collectors.Income` +`toloka.client.collectors.Income` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L343) -``` +```python Income(self, *, uuid: Optional[UUID] = None) ``` diff --git a/docs/reference/toloka.client.collectors.MajorityVote.Parameters.md b/docs/reference/toloka.client.collectors.MajorityVote.Parameters.md index 21d5764b..e47aa7af 100644 --- a/docs/reference/toloka.client.collectors.MajorityVote.Parameters.md +++ b/docs/reference/toloka.client.collectors.MajorityVote.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.collectors.MajorityVote.Parameters` +`toloka.client.collectors.MajorityVote.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L427) -``` +```python Parameters( self, *, diff --git a/docs/reference/toloka.client.collectors.MajorityVote.md b/docs/reference/toloka.client.collectors.MajorityVote.md index d3026615..ebbcfdaf 100644 --- a/docs/reference/toloka.client.collectors.MajorityVote.md +++ b/docs/reference/toloka.client.collectors.MajorityVote.md @@ -1,7 +1,7 @@ # MajorityVote -`toloka.client.collectors.MajorityVote` +`toloka.client.collectors.MajorityVote` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L381) -``` +```python MajorityVote( self, *, diff --git a/docs/reference/toloka.client.collectors.SkippedInRowAssignments.md b/docs/reference/toloka.client.collectors.SkippedInRowAssignments.md index c5f31ee8..e156fa85 100644 --- a/docs/reference/toloka.client.collectors.SkippedInRowAssignments.md +++ b/docs/reference/toloka.client.collectors.SkippedInRowAssignments.md @@ -1,7 +1,7 @@ # SkippedInRowAssignments -`toloka.client.collectors.SkippedInRowAssignments` +`toloka.client.collectors.SkippedInRowAssignments` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L434) -``` +```python SkippedInRowAssignments(self, *, uuid: Optional[UUID] = None) ``` diff --git a/docs/reference/toloka.client.collectors.Training.md b/docs/reference/toloka.client.collectors.Training.md index c7f0c2d9..663a9d33 100644 --- a/docs/reference/toloka.client.collectors.Training.md +++ b/docs/reference/toloka.client.collectors.Training.md @@ -1,7 +1,7 @@ # Training -`toloka.client.collectors.Training` +`toloka.client.collectors.Training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L471) -``` +```python Training(self, *, uuid: Optional[UUID] = None) ``` diff --git a/docs/reference/toloka.client.collectors.UsersAssessment.md b/docs/reference/toloka.client.collectors.UsersAssessment.md index a368e218..13a12430 100644 --- a/docs/reference/toloka.client.collectors.UsersAssessment.md +++ b/docs/reference/toloka.client.collectors.UsersAssessment.md @@ -1,7 +1,7 @@ # UsersAssessment -`toloka.client.collectors.UsersAssessment` +`toloka.client.collectors.UsersAssessment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/collectors.py#L483) -``` +```python UsersAssessment(self, *, uuid: Optional[UUID] = None) ``` diff --git a/docs/reference/toloka.client.conditions.AcceptedAssignmentsCount.md b/docs/reference/toloka.client.conditions.AcceptedAssignmentsCount.md index 79cba5a1..1f733e66 100644 --- a/docs/reference/toloka.client.conditions.AcceptedAssignmentsCount.md +++ b/docs/reference/toloka.client.conditions.AcceptedAssignmentsCount.md @@ -1,7 +1,7 @@ # AcceptedAssignmentsCount -`toloka.client.conditions.AcceptedAssignmentsCount` +`toloka.client.conditions.AcceptedAssignmentsCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L82) -``` +```python AcceptedAssignmentsCount( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.AcceptedAssignmentsRate.md b/docs/reference/toloka.client.conditions.AcceptedAssignmentsRate.md index 4162ab4d..63187e01 100644 --- a/docs/reference/toloka.client.conditions.AcceptedAssignmentsRate.md +++ b/docs/reference/toloka.client.conditions.AcceptedAssignmentsRate.md @@ -1,7 +1,7 @@ # AcceptedAssignmentsRate -`toloka.client.conditions.AcceptedAssignmentsRate` +`toloka.client.conditions.AcceptedAssignmentsRate` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L94) -``` +```python AcceptedAssignmentsRate( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.AssessmentEvent.Type.md b/docs/reference/toloka.client.conditions.AssessmentEvent.Type.md index f274ed0e..ae3ba2b7 100644 --- a/docs/reference/toloka.client.conditions.AssessmentEvent.Type.md +++ b/docs/reference/toloka.client.conditions.AssessmentEvent.Type.md @@ -1,5 +1,5 @@ # Type -`toloka.client.conditions.AssessmentEvent.Type` +`toloka.client.conditions.AssessmentEvent.Type` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L124) An enumeration. diff --git a/docs/reference/toloka.client.conditions.AssessmentEvent.md b/docs/reference/toloka.client.conditions.AssessmentEvent.md index 8bd18db7..dbce061d 100644 --- a/docs/reference/toloka.client.conditions.AssessmentEvent.md +++ b/docs/reference/toloka.client.conditions.AssessmentEvent.md @@ -1,7 +1,7 @@ # AssessmentEvent -`toloka.client.conditions.AssessmentEvent` +`toloka.client.conditions.AssessmentEvent` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L101) -``` +```python AssessmentEvent( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.conditions.AssignmentsAcceptedCount.md b/docs/reference/toloka.client.conditions.AssignmentsAcceptedCount.md index f88e6d9c..fe70b891 100644 --- a/docs/reference/toloka.client.conditions.AssignmentsAcceptedCount.md +++ b/docs/reference/toloka.client.conditions.AssignmentsAcceptedCount.md @@ -1,7 +1,7 @@ # AssignmentsAcceptedCount -`toloka.client.conditions.AssignmentsAcceptedCount` +`toloka.client.conditions.AssignmentsAcceptedCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L137) -``` +```python AssignmentsAcceptedCount( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.ComparableRuleCondition.md b/docs/reference/toloka.client.conditions.ComparableRuleCondition.md index 774e4846..e73c77e9 100644 --- a/docs/reference/toloka.client.conditions.ComparableRuleCondition.md +++ b/docs/reference/toloka.client.conditions.ComparableRuleCondition.md @@ -1,7 +1,7 @@ # ComparableRuleCondition -`toloka.client.conditions.ComparableRuleCondition` +`toloka.client.conditions.ComparableRuleCondition` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L74) -``` +```python ComparableRuleCondition( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.CorrectAnswersRate.md b/docs/reference/toloka.client.conditions.CorrectAnswersRate.md index 16075bcc..9a128276 100644 --- a/docs/reference/toloka.client.conditions.CorrectAnswersRate.md +++ b/docs/reference/toloka.client.conditions.CorrectAnswersRate.md @@ -1,7 +1,7 @@ # CorrectAnswersRate -`toloka.client.conditions.CorrectAnswersRate` +`toloka.client.conditions.CorrectAnswersRate` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L149) -``` +```python CorrectAnswersRate( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.FailRate.md b/docs/reference/toloka.client.conditions.FailRate.md index 6cc3bb84..0c22ba96 100644 --- a/docs/reference/toloka.client.conditions.FailRate.md +++ b/docs/reference/toloka.client.conditions.FailRate.md @@ -1,7 +1,7 @@ # FailRate -`toloka.client.conditions.FailRate` +`toloka.client.conditions.FailRate` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L158) -``` +```python FailRate( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.FastSubmittedCount.md b/docs/reference/toloka.client.conditions.FastSubmittedCount.md index 0fca0b28..f0315591 100644 --- a/docs/reference/toloka.client.conditions.FastSubmittedCount.md +++ b/docs/reference/toloka.client.conditions.FastSubmittedCount.md @@ -1,7 +1,7 @@ # FastSubmittedCount -`toloka.client.conditions.FastSubmittedCount` +`toloka.client.conditions.FastSubmittedCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L165) -``` +```python FastSubmittedCount( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.GoldenSetAnswersCount.md b/docs/reference/toloka.client.conditions.GoldenSetAnswersCount.md index e6c9720c..e3e211dc 100644 --- a/docs/reference/toloka.client.conditions.GoldenSetAnswersCount.md +++ b/docs/reference/toloka.client.conditions.GoldenSetAnswersCount.md @@ -1,7 +1,7 @@ # GoldenSetAnswersCount -`toloka.client.conditions.GoldenSetAnswersCount` +`toloka.client.conditions.GoldenSetAnswersCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L172) -``` +```python GoldenSetAnswersCount( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.GoldenSetCorrectAnswersRate.md b/docs/reference/toloka.client.conditions.GoldenSetCorrectAnswersRate.md index 0ab51ff8..eaa540e1 100644 --- a/docs/reference/toloka.client.conditions.GoldenSetCorrectAnswersRate.md +++ b/docs/reference/toloka.client.conditions.GoldenSetCorrectAnswersRate.md @@ -1,7 +1,7 @@ # GoldenSetCorrectAnswersRate -`toloka.client.conditions.GoldenSetCorrectAnswersRate` +`toloka.client.conditions.GoldenSetCorrectAnswersRate` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L179) -``` +```python GoldenSetCorrectAnswersRate( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.GoldenSetIncorrectAnswersRate.md b/docs/reference/toloka.client.conditions.GoldenSetIncorrectAnswersRate.md index c97726f4..ab4372e8 100644 --- a/docs/reference/toloka.client.conditions.GoldenSetIncorrectAnswersRate.md +++ b/docs/reference/toloka.client.conditions.GoldenSetIncorrectAnswersRate.md @@ -1,7 +1,7 @@ # GoldenSetIncorrectAnswersRate -`toloka.client.conditions.GoldenSetIncorrectAnswersRate` +`toloka.client.conditions.GoldenSetIncorrectAnswersRate` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L186) -``` +```python GoldenSetIncorrectAnswersRate( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.IdentityRuleCondition.md b/docs/reference/toloka.client.conditions.IdentityRuleCondition.md index 4a0cf1d2..de6c1833 100644 --- a/docs/reference/toloka.client.conditions.IdentityRuleCondition.md +++ b/docs/reference/toloka.client.conditions.IdentityRuleCondition.md @@ -1,7 +1,7 @@ # IdentityRuleCondition -`toloka.client.conditions.IdentityRuleCondition` +`toloka.client.conditions.IdentityRuleCondition` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L78) -``` +```python IdentityRuleCondition( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.conditions.IncomeSumForLast24Hours.md b/docs/reference/toloka.client.conditions.IncomeSumForLast24Hours.md index 83d20622..92cdd643 100644 --- a/docs/reference/toloka.client.conditions.IncomeSumForLast24Hours.md +++ b/docs/reference/toloka.client.conditions.IncomeSumForLast24Hours.md @@ -1,7 +1,7 @@ # IncomeSumForLast24Hours -`toloka.client.conditions.IncomeSumForLast24Hours` +`toloka.client.conditions.IncomeSumForLast24Hours` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L193) -``` +```python IncomeSumForLast24Hours( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.IncorrectAnswersRate.md b/docs/reference/toloka.client.conditions.IncorrectAnswersRate.md index d17c74e2..362c463a 100644 --- a/docs/reference/toloka.client.conditions.IncorrectAnswersRate.md +++ b/docs/reference/toloka.client.conditions.IncorrectAnswersRate.md @@ -1,7 +1,7 @@ # IncorrectAnswersRate -`toloka.client.conditions.IncorrectAnswersRate` +`toloka.client.conditions.IncorrectAnswersRate` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L200) -``` +```python IncorrectAnswersRate( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.NextAssignmentAvailable.md b/docs/reference/toloka.client.conditions.NextAssignmentAvailable.md index 75c66528..df4b703a 100644 --- a/docs/reference/toloka.client.conditions.NextAssignmentAvailable.md +++ b/docs/reference/toloka.client.conditions.NextAssignmentAvailable.md @@ -1,7 +1,7 @@ # NextAssignmentAvailable -`toloka.client.conditions.NextAssignmentAvailable` +`toloka.client.conditions.NextAssignmentAvailable` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L209) -``` +```python NextAssignmentAvailable( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.PendingAssignmentsCount.md b/docs/reference/toloka.client.conditions.PendingAssignmentsCount.md index 8c9159a4..af8aef10 100644 --- a/docs/reference/toloka.client.conditions.PendingAssignmentsCount.md +++ b/docs/reference/toloka.client.conditions.PendingAssignmentsCount.md @@ -1,7 +1,7 @@ # PendingAssignmentsCount -`toloka.client.conditions.PendingAssignmentsCount` +`toloka.client.conditions.PendingAssignmentsCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L213) -``` +```python PendingAssignmentsCount( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.PoolAccessRevokedReason.Type.md b/docs/reference/toloka.client.conditions.PoolAccessRevokedReason.Type.md index dade69f1..1a5e499f 100644 --- a/docs/reference/toloka.client.conditions.PoolAccessRevokedReason.Type.md +++ b/docs/reference/toloka.client.conditions.PoolAccessRevokedReason.Type.md @@ -1,5 +1,5 @@ # Type -`toloka.client.conditions.PoolAccessRevokedReason.Type` +`toloka.client.conditions.PoolAccessRevokedReason.Type` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L230) An enumeration. diff --git a/docs/reference/toloka.client.conditions.PoolAccessRevokedReason.md b/docs/reference/toloka.client.conditions.PoolAccessRevokedReason.md index 1297512f..cdeab42b 100644 --- a/docs/reference/toloka.client.conditions.PoolAccessRevokedReason.md +++ b/docs/reference/toloka.client.conditions.PoolAccessRevokedReason.md @@ -1,7 +1,7 @@ # PoolAccessRevokedReason -`toloka.client.conditions.PoolAccessRevokedReason` +`toloka.client.conditions.PoolAccessRevokedReason` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L220) -``` +```python PoolAccessRevokedReason( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.conditions.RejectedAssignmentsCount.md b/docs/reference/toloka.client.conditions.RejectedAssignmentsCount.md index 66256692..738fc10f 100644 --- a/docs/reference/toloka.client.conditions.RejectedAssignmentsCount.md +++ b/docs/reference/toloka.client.conditions.RejectedAssignmentsCount.md @@ -1,7 +1,7 @@ # RejectedAssignmentsCount -`toloka.client.conditions.RejectedAssignmentsCount` +`toloka.client.conditions.RejectedAssignmentsCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L241) -``` +```python RejectedAssignmentsCount( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.RejectedAssignmentsRate.md b/docs/reference/toloka.client.conditions.RejectedAssignmentsRate.md index de5125e2..a8237d5e 100644 --- a/docs/reference/toloka.client.conditions.RejectedAssignmentsRate.md +++ b/docs/reference/toloka.client.conditions.RejectedAssignmentsRate.md @@ -1,7 +1,7 @@ # RejectedAssignmentsRate -`toloka.client.conditions.RejectedAssignmentsRate` +`toloka.client.conditions.RejectedAssignmentsRate` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L248) -``` +```python RejectedAssignmentsRate( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.RuleCondition.md b/docs/reference/toloka.client.conditions.RuleCondition.md index 00c97bab..ed3084b9 100644 --- a/docs/reference/toloka.client.conditions.RuleCondition.md +++ b/docs/reference/toloka.client.conditions.RuleCondition.md @@ -1,7 +1,7 @@ # RuleCondition -`toloka.client.conditions.RuleCondition` +`toloka.client.conditions.RuleCondition` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L69) -``` +```python RuleCondition( self, *, diff --git a/docs/reference/toloka.client.conditions.RuleConditionKey.md b/docs/reference/toloka.client.conditions.RuleConditionKey.md index f6c396bf..e73616c7 100644 --- a/docs/reference/toloka.client.conditions.RuleConditionKey.md +++ b/docs/reference/toloka.client.conditions.RuleConditionKey.md @@ -1,5 +1,5 @@ # RuleConditionKey -`toloka.client.conditions.RuleConditionKey` +`toloka.client.conditions.RuleConditionKey` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L40) An enumeration. diff --git a/docs/reference/toloka.client.conditions.SkillId.md b/docs/reference/toloka.client.conditions.SkillId.md index 0606f011..75a5db5a 100644 --- a/docs/reference/toloka.client.conditions.SkillId.md +++ b/docs/reference/toloka.client.conditions.SkillId.md @@ -1,7 +1,7 @@ # SkillId -`toloka.client.conditions.SkillId` +`toloka.client.conditions.SkillId` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L255) -``` +```python SkillId( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.conditions.SkippedInRowCount.md b/docs/reference/toloka.client.conditions.SkippedInRowCount.md index b71fe8cf..bb699572 100644 --- a/docs/reference/toloka.client.conditions.SkippedInRowCount.md +++ b/docs/reference/toloka.client.conditions.SkippedInRowCount.md @@ -1,7 +1,7 @@ # SkippedInRowCount -`toloka.client.conditions.SkippedInRowCount` +`toloka.client.conditions.SkippedInRowCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L262) -``` +```python SkippedInRowCount( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.StoredResultsCount.md b/docs/reference/toloka.client.conditions.StoredResultsCount.md index 793ac123..4bb7f96a 100644 --- a/docs/reference/toloka.client.conditions.StoredResultsCount.md +++ b/docs/reference/toloka.client.conditions.StoredResultsCount.md @@ -1,7 +1,7 @@ # StoredResultsCount -`toloka.client.conditions.StoredResultsCount` +`toloka.client.conditions.StoredResultsCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L269) -``` +```python StoredResultsCount( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.SubmittedAssignmentsCount.md b/docs/reference/toloka.client.conditions.SubmittedAssignmentsCount.md index e758b6a5..eb854a8e 100644 --- a/docs/reference/toloka.client.conditions.SubmittedAssignmentsCount.md +++ b/docs/reference/toloka.client.conditions.SubmittedAssignmentsCount.md @@ -1,7 +1,7 @@ # SubmittedAssignmentsCount -`toloka.client.conditions.SubmittedAssignmentsCount` +`toloka.client.conditions.SubmittedAssignmentsCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L276) -``` +```python SubmittedAssignmentsCount( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.SuccessRate.md b/docs/reference/toloka.client.conditions.SuccessRate.md index 427f187a..d7476a3a 100644 --- a/docs/reference/toloka.client.conditions.SuccessRate.md +++ b/docs/reference/toloka.client.conditions.SuccessRate.md @@ -1,7 +1,7 @@ # SuccessRate -`toloka.client.conditions.SuccessRate` +`toloka.client.conditions.SuccessRate` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L280) -``` +```python SuccessRate( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.TotalAnswersCount.md b/docs/reference/toloka.client.conditions.TotalAnswersCount.md index 05670701..1d5afd1a 100644 --- a/docs/reference/toloka.client.conditions.TotalAnswersCount.md +++ b/docs/reference/toloka.client.conditions.TotalAnswersCount.md @@ -1,7 +1,7 @@ # TotalAnswersCount -`toloka.client.conditions.TotalAnswersCount` +`toloka.client.conditions.TotalAnswersCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L287) -``` +```python TotalAnswersCount( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.TotalAssignmentsCount.md b/docs/reference/toloka.client.conditions.TotalAssignmentsCount.md index 02e01547..a9587502 100644 --- a/docs/reference/toloka.client.conditions.TotalAssignmentsCount.md +++ b/docs/reference/toloka.client.conditions.TotalAssignmentsCount.md @@ -1,7 +1,7 @@ # TotalAssignmentsCount -`toloka.client.conditions.TotalAssignmentsCount` +`toloka.client.conditions.TotalAssignmentsCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L296) -``` +```python TotalAssignmentsCount( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.conditions.TotalSubmittedCount.md b/docs/reference/toloka.client.conditions.TotalSubmittedCount.md index 19cdcb8e..260fd0d1 100644 --- a/docs/reference/toloka.client.conditions.TotalSubmittedCount.md +++ b/docs/reference/toloka.client.conditions.TotalSubmittedCount.md @@ -1,7 +1,7 @@ # TotalSubmittedCount -`toloka.client.conditions.TotalSubmittedCount` +`toloka.client.conditions.TotalSubmittedCount` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/conditions.py#L303) -``` +```python TotalSubmittedCount( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.error_codes.CommonErrorCodes.md b/docs/reference/toloka.client.error_codes.CommonErrorCodes.md index 30f8ad52..01a14739 100644 --- a/docs/reference/toloka.client.error_codes.CommonErrorCodes.md +++ b/docs/reference/toloka.client.error_codes.CommonErrorCodes.md @@ -1,5 +1,5 @@ # CommonErrorCodes -`toloka.client.error_codes.CommonErrorCodes` +`toloka.client.error_codes.CommonErrorCodes` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/error_codes.py#L8) Types of error codes returned by the API diff --git a/docs/reference/toloka.client.error_codes.InternalErrorCodes.md b/docs/reference/toloka.client.error_codes.InternalErrorCodes.md index 38b82eb0..73d3be40 100644 --- a/docs/reference/toloka.client.error_codes.InternalErrorCodes.md +++ b/docs/reference/toloka.client.error_codes.InternalErrorCodes.md @@ -1,5 +1,5 @@ # InternalErrorCodes -`toloka.client.error_codes.InternalErrorCodes` +`toloka.client.error_codes.InternalErrorCodes` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/error_codes.py#L23) Types of internal error codes returned by the API diff --git a/docs/reference/toloka.client.error_codes.ValidationErrorCodes.md b/docs/reference/toloka.client.error_codes.ValidationErrorCodes.md index 426638a0..77c3f159 100644 --- a/docs/reference/toloka.client.error_codes.ValidationErrorCodes.md +++ b/docs/reference/toloka.client.error_codes.ValidationErrorCodes.md @@ -1,5 +1,5 @@ # ValidationErrorCodes -`toloka.client.error_codes.ValidationErrorCodes` +`toloka.client.error_codes.ValidationErrorCodes` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/error_codes.py#L95) Types of validation error codes returned by the API diff --git a/docs/reference/toloka.client.exceptions.AccessDeniedApiError.md b/docs/reference/toloka.client.exceptions.AccessDeniedApiError.md index d6db5435..b4d90c55 100644 --- a/docs/reference/toloka.client.exceptions.AccessDeniedApiError.md +++ b/docs/reference/toloka.client.exceptions.AccessDeniedApiError.md @@ -1,5 +1,5 @@ # AccessDeniedApiError -`toloka.client.exceptions.AccessDeniedApiError` +`toloka.client.exceptions.AccessDeniedApiError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L98) ## Parameters Description diff --git a/docs/reference/toloka.client.exceptions.ApiError.md b/docs/reference/toloka.client.exceptions.ApiError.md index 55706607..83136b9b 100644 --- a/docs/reference/toloka.client.exceptions.ApiError.md +++ b/docs/reference/toloka.client.exceptions.ApiError.md @@ -1,7 +1,7 @@ # ApiError -`toloka.client.exceptions.ApiError` +`toloka.client.exceptions.ApiError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L51) -``` +```python ApiError( self, *, diff --git a/docs/reference/toloka.client.exceptions.AuthenticationApiError.md b/docs/reference/toloka.client.exceptions.AuthenticationApiError.md index e3581406..ddb905ab 100644 --- a/docs/reference/toloka.client.exceptions.AuthenticationApiError.md +++ b/docs/reference/toloka.client.exceptions.AuthenticationApiError.md @@ -1,5 +1,5 @@ # AuthenticationApiError -`toloka.client.exceptions.AuthenticationApiError` +`toloka.client.exceptions.AuthenticationApiError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L93) ## Parameters Description diff --git a/docs/reference/toloka.client.exceptions.ConflictStateApiError.md b/docs/reference/toloka.client.exceptions.ConflictStateApiError.md index ac32987b..6ebd1cab 100644 --- a/docs/reference/toloka.client.exceptions.ConflictStateApiError.md +++ b/docs/reference/toloka.client.exceptions.ConflictStateApiError.md @@ -1,5 +1,5 @@ # ConflictStateApiError -`toloka.client.exceptions.ConflictStateApiError` +`toloka.client.exceptions.ConflictStateApiError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L113) ## Parameters Description diff --git a/docs/reference/toloka.client.exceptions.DoesNotExistApiError.md b/docs/reference/toloka.client.exceptions.DoesNotExistApiError.md index a29cd924..abcc4f64 100644 --- a/docs/reference/toloka.client.exceptions.DoesNotExistApiError.md +++ b/docs/reference/toloka.client.exceptions.DoesNotExistApiError.md @@ -1,5 +1,5 @@ # DoesNotExistApiError -`toloka.client.exceptions.DoesNotExistApiError` +`toloka.client.exceptions.DoesNotExistApiError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L108) ## Parameters Description diff --git a/docs/reference/toloka.client.exceptions.FailedOperation.md b/docs/reference/toloka.client.exceptions.FailedOperation.md index 179c759d..969542dd 100644 --- a/docs/reference/toloka.client.exceptions.FailedOperation.md +++ b/docs/reference/toloka.client.exceptions.FailedOperation.md @@ -1,7 +1,7 @@ # FailedOperation -`toloka.client.exceptions.FailedOperation` +`toloka.client.exceptions.FailedOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L38) -``` +```python FailedOperation(self, *, operation: Optional[Any] = None) ``` diff --git a/docs/reference/toloka.client.exceptions.IncorrectActionsApiError.md b/docs/reference/toloka.client.exceptions.IncorrectActionsApiError.md index f020210b..9cb0526c 100644 --- a/docs/reference/toloka.client.exceptions.IncorrectActionsApiError.md +++ b/docs/reference/toloka.client.exceptions.IncorrectActionsApiError.md @@ -1,5 +1,5 @@ # IncorrectActionsApiError -`toloka.client.exceptions.IncorrectActionsApiError` +`toloka.client.exceptions.IncorrectActionsApiError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L123) ## Parameters Description diff --git a/docs/reference/toloka.client.exceptions.InternalApiError.md b/docs/reference/toloka.client.exceptions.InternalApiError.md index 3f3e0491..0211170e 100644 --- a/docs/reference/toloka.client.exceptions.InternalApiError.md +++ b/docs/reference/toloka.client.exceptions.InternalApiError.md @@ -1,5 +1,5 @@ # InternalApiError -`toloka.client.exceptions.InternalApiError` +`toloka.client.exceptions.InternalApiError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L88) ## Parameters Description diff --git a/docs/reference/toloka.client.exceptions.RemoteServiceUnavailableApiError.md b/docs/reference/toloka.client.exceptions.RemoteServiceUnavailableApiError.md index 5361e5e5..cde15e47 100644 --- a/docs/reference/toloka.client.exceptions.RemoteServiceUnavailableApiError.md +++ b/docs/reference/toloka.client.exceptions.RemoteServiceUnavailableApiError.md @@ -1,5 +1,5 @@ # RemoteServiceUnavailableApiError -`toloka.client.exceptions.RemoteServiceUnavailableApiError` +`toloka.client.exceptions.RemoteServiceUnavailableApiError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L103) ## Parameters Description diff --git a/docs/reference/toloka.client.exceptions.SpecClassIdentificationError.md b/docs/reference/toloka.client.exceptions.SpecClassIdentificationError.md index 56611525..acced8b2 100644 --- a/docs/reference/toloka.client.exceptions.SpecClassIdentificationError.md +++ b/docs/reference/toloka.client.exceptions.SpecClassIdentificationError.md @@ -1,7 +1,7 @@ # SpecClassIdentificationError -`toloka.client.exceptions.SpecClassIdentificationError` +`toloka.client.exceptions.SpecClassIdentificationError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L25) -``` +```python SpecClassIdentificationError( self, *, diff --git a/docs/reference/toloka.client.exceptions.TooManyRequestsApiError.md b/docs/reference/toloka.client.exceptions.TooManyRequestsApiError.md index 390bef30..5f8c5ea4 100644 --- a/docs/reference/toloka.client.exceptions.TooManyRequestsApiError.md +++ b/docs/reference/toloka.client.exceptions.TooManyRequestsApiError.md @@ -1,5 +1,5 @@ # TooManyRequestsApiError -`toloka.client.exceptions.TooManyRequestsApiError` +`toloka.client.exceptions.TooManyRequestsApiError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L118) ## Parameters Description diff --git a/docs/reference/toloka.client.exceptions.ValidationApiError.md b/docs/reference/toloka.client.exceptions.ValidationApiError.md index 9c8ff49e..6ec980ec 100644 --- a/docs/reference/toloka.client.exceptions.ValidationApiError.md +++ b/docs/reference/toloka.client.exceptions.ValidationApiError.md @@ -1,5 +1,5 @@ # ValidationApiError -`toloka.client.exceptions.ValidationApiError` +`toloka.client.exceptions.ValidationApiError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L70) Field validation error returned from the API Call. diff --git a/docs/reference/toloka.client.exceptions.raise_on_api_error.md b/docs/reference/toloka.client.exceptions.raise_on_api_error.md index 2791565e..1ca80ab5 100644 --- a/docs/reference/toloka.client.exceptions.raise_on_api_error.md +++ b/docs/reference/toloka.client.exceptions.raise_on_api_error.md @@ -1,7 +1,7 @@ # raise_on_api_error -`toloka.client.exceptions.raise_on_api_error` +`toloka.client.exceptions.raise_on_api_error` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/exceptions.py#L141) -``` +```python raise_on_api_error(response: Response) ``` diff --git a/docs/reference/toloka.client.filter.AdultAllowed.md b/docs/reference/toloka.client.filter.AdultAllowed.md index b16b6140..32740191 100644 --- a/docs/reference/toloka.client.filter.AdultAllowed.md +++ b/docs/reference/toloka.client.filter.AdultAllowed.md @@ -1,7 +1,7 @@ # AdultAllowed -`toloka.client.filter.AdultAllowed` +`toloka.client.filter.AdultAllowed` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L291) -``` +```python AdultAllowed( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.filter.Citizenship.md b/docs/reference/toloka.client.filter.Citizenship.md index 5e4fdcfb..eca29c50 100644 --- a/docs/reference/toloka.client.filter.Citizenship.md +++ b/docs/reference/toloka.client.filter.Citizenship.md @@ -1,7 +1,7 @@ # Citizenship -`toloka.client.filter.Citizenship` +`toloka.client.filter.Citizenship` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L256) -``` +```python Citizenship( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.filter.City.md b/docs/reference/toloka.client.filter.City.md index b9002316..1bb55ecf 100644 --- a/docs/reference/toloka.client.filter.City.md +++ b/docs/reference/toloka.client.filter.City.md @@ -1,7 +1,7 @@ # City -`toloka.client.filter.City` +`toloka.client.filter.City` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L313) -``` +```python City( self, operator: InclusionOperator, diff --git a/docs/reference/toloka.client.filter.ClientType.ClientType.md b/docs/reference/toloka.client.filter.ClientType.ClientType.md index 5c747e1f..388ccf29 100644 --- a/docs/reference/toloka.client.filter.ClientType.ClientType.md +++ b/docs/reference/toloka.client.filter.ClientType.ClientType.md @@ -1,5 +1,5 @@ # ClientType -`toloka.client.filter.ClientType.ClientType` +`toloka.client.filter.ClientType.ClientType` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L456) Client application type. diff --git a/docs/reference/toloka.client.filter.ClientType.md b/docs/reference/toloka.client.filter.ClientType.md index 0fe1daa5..ac1bde00 100644 --- a/docs/reference/toloka.client.filter.ClientType.md +++ b/docs/reference/toloka.client.filter.ClientType.md @@ -1,7 +1,7 @@ # ClientType -`toloka.client.filter.ClientType` +`toloka.client.filter.ClientType` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L448) -``` +```python ClientType( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.filter.Computed.Key.md b/docs/reference/toloka.client.filter.Computed.Key.md index bf3b199f..fc0388f3 100644 --- a/docs/reference/toloka.client.filter.Computed.Key.md +++ b/docs/reference/toloka.client.filter.Computed.Key.md @@ -1,5 +1,5 @@ # Key -`toloka.client.filter.Computed.Key` +`toloka.client.filter.Computed.Key` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L184) Possible criteria for filtering users by computed data. @@ -10,7 +10,6 @@ Possible criteria for filtering users by computed data. `CLIENT_TYPE`|'client_type'|

`REGION_BY_PHONE`|'region_by_phone'|

`REGION_BY_IP`|'region_by_ip'|

-`RATING`|'rating'|

`DEVICE_CATEGORY`|'device_category'|

`OS_FAMILY`|'os_family'|

`OS_VERSION`|'os_version'|

diff --git a/docs/reference/toloka.client.filter.Computed.md b/docs/reference/toloka.client.filter.Computed.md index 6a41276e..5a8bf465 100644 --- a/docs/reference/toloka.client.filter.Computed.md +++ b/docs/reference/toloka.client.filter.Computed.md @@ -1,7 +1,7 @@ # Computed -`toloka.client.filter.Computed` +`toloka.client.filter.Computed` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L179) -``` +```python Computed( self, *, diff --git a/docs/reference/toloka.client.filter.Condition.Category.md b/docs/reference/toloka.client.filter.Condition.Category.md index dcf2fcf6..7242d89f 100644 --- a/docs/reference/toloka.client.filter.Condition.Category.md +++ b/docs/reference/toloka.client.filter.Condition.Category.md @@ -1,5 +1,5 @@ # Category -`toloka.client.filter.Condition.Category` +`toloka.client.filter.Condition.Category` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L145) An enumeration. diff --git a/docs/reference/toloka.client.filter.Condition.md b/docs/reference/toloka.client.filter.Condition.md index 42893e41..c7e50ebe 100644 --- a/docs/reference/toloka.client.filter.Condition.md +++ b/docs/reference/toloka.client.filter.Condition.md @@ -1,7 +1,7 @@ # Condition -`toloka.client.filter.Condition` +`toloka.client.filter.Condition` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L134) -``` +```python Condition( self, *, diff --git a/docs/reference/toloka.client.filter.Country.md b/docs/reference/toloka.client.filter.Country.md index 027a20f2..2d9978d0 100644 --- a/docs/reference/toloka.client.filter.Country.md +++ b/docs/reference/toloka.client.filter.Country.md @@ -1,7 +1,7 @@ # Country -`toloka.client.filter.Country` +`toloka.client.filter.Country` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L245) -``` +```python Country( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.filter.DateOfBirth.md b/docs/reference/toloka.client.filter.DateOfBirth.md index 7a399ccd..8eb78dd3 100644 --- a/docs/reference/toloka.client.filter.DateOfBirth.md +++ b/docs/reference/toloka.client.filter.DateOfBirth.md @@ -1,7 +1,7 @@ # DateOfBirth -`toloka.client.filter.DateOfBirth` +`toloka.client.filter.DateOfBirth` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L302) -``` +```python DateOfBirth( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.filter.DeviceCategory.DeviceCategory.md b/docs/reference/toloka.client.filter.DeviceCategory.DeviceCategory.md index 11bf9396..7ef6fc0f 100644 --- a/docs/reference/toloka.client.filter.DeviceCategory.DeviceCategory.md +++ b/docs/reference/toloka.client.filter.DeviceCategory.DeviceCategory.md @@ -1,5 +1,5 @@ # DeviceCategory -`toloka.client.filter.DeviceCategory.DeviceCategory` +`toloka.client.filter.DeviceCategory.DeviceCategory` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L430) Device сategory. diff --git a/docs/reference/toloka.client.filter.DeviceCategory.md b/docs/reference/toloka.client.filter.DeviceCategory.md index f91714db..dfab1a5f 100644 --- a/docs/reference/toloka.client.filter.DeviceCategory.md +++ b/docs/reference/toloka.client.filter.DeviceCategory.md @@ -1,7 +1,7 @@ # DeviceCategory -`toloka.client.filter.DeviceCategory` +`toloka.client.filter.DeviceCategory` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L422) -``` +```python DeviceCategory( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.filter.Education.Education.md b/docs/reference/toloka.client.filter.Education.Education.md index 8dd0d4ef..5f175307 100644 --- a/docs/reference/toloka.client.filter.Education.Education.md +++ b/docs/reference/toloka.client.filter.Education.Education.md @@ -1,5 +1,5 @@ # Education -`toloka.client.filter.Education.Education` +`toloka.client.filter.Education.Education` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L275) User education. diff --git a/docs/reference/toloka.client.filter.Education.md b/docs/reference/toloka.client.filter.Education.md index 86f91b8c..89724e67 100644 --- a/docs/reference/toloka.client.filter.Education.md +++ b/docs/reference/toloka.client.filter.Education.md @@ -1,7 +1,7 @@ # Education -`toloka.client.filter.Education` +`toloka.client.filter.Education` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L267) -``` +```python Education( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.filter.FilterAnd.md b/docs/reference/toloka.client.filter.FilterAnd.md index 6227236c..b9b9697a 100644 --- a/docs/reference/toloka.client.filter.FilterAnd.md +++ b/docs/reference/toloka.client.filter.FilterAnd.md @@ -1,7 +1,7 @@ # FilterAnd -`toloka.client.filter.FilterAnd` +`toloka.client.filter.FilterAnd` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L110) -``` +```python FilterAnd(self, and_: List[FilterCondition]) ``` diff --git a/docs/reference/toloka.client.filter.FilterCondition.md b/docs/reference/toloka.client.filter.FilterCondition.md index 49fbee85..e4f6c1b9 100644 --- a/docs/reference/toloka.client.filter.FilterCondition.md +++ b/docs/reference/toloka.client.filter.FilterCondition.md @@ -1,7 +1,7 @@ # FilterCondition -`toloka.client.filter.FilterCondition` +`toloka.client.filter.FilterCondition` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L50) -``` +```python FilterCondition(self) ``` diff --git a/docs/reference/toloka.client.filter.FilterOr.md b/docs/reference/toloka.client.filter.FilterOr.md index 9b904f11..ba8ba56f 100644 --- a/docs/reference/toloka.client.filter.FilterOr.md +++ b/docs/reference/toloka.client.filter.FilterOr.md @@ -1,7 +1,7 @@ # FilterOr -`toloka.client.filter.FilterOr` +`toloka.client.filter.FilterOr` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L86) -``` +```python FilterOr(self, or_: List[FilterCondition]) ``` diff --git a/docs/reference/toloka.client.filter.Gender.Gender.md b/docs/reference/toloka.client.filter.Gender.Gender.md index fc2f193d..1f834bda 100644 --- a/docs/reference/toloka.client.filter.Gender.Gender.md +++ b/docs/reference/toloka.client.filter.Gender.Gender.md @@ -1,5 +1,5 @@ # Gender -`toloka.client.filter.Gender.Gender` +`toloka.client.filter.Gender.Gender` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L231) User gender. diff --git a/docs/reference/toloka.client.filter.Gender.md b/docs/reference/toloka.client.filter.Gender.md index 1d25a361..baef3816 100644 --- a/docs/reference/toloka.client.filter.Gender.md +++ b/docs/reference/toloka.client.filter.Gender.md @@ -1,7 +1,7 @@ # Gender -`toloka.client.filter.Gender` +`toloka.client.filter.Gender` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L223) -``` +```python Gender( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.filter.Languages.md b/docs/reference/toloka.client.filter.Languages.md index 51768658..7f5fd725 100644 --- a/docs/reference/toloka.client.filter.Languages.md +++ b/docs/reference/toloka.client.filter.Languages.md @@ -1,7 +1,7 @@ # Languages -`toloka.client.filter.Languages` +`toloka.client.filter.Languages` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L324) -``` +```python Languages( self, operator: InclusionOperator, diff --git a/docs/reference/toloka.client.filter.OSFamily.OSFamily.md b/docs/reference/toloka.client.filter.OSFamily.OSFamily.md index daf4320c..2914fb7c 100644 --- a/docs/reference/toloka.client.filter.OSFamily.OSFamily.md +++ b/docs/reference/toloka.client.filter.OSFamily.OSFamily.md @@ -1,5 +1,5 @@ # OSFamily -`toloka.client.filter.OSFamily.OSFamily` +`toloka.client.filter.OSFamily.OSFamily` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L475) The operating system family. diff --git a/docs/reference/toloka.client.filter.OSFamily.md b/docs/reference/toloka.client.filter.OSFamily.md index a755c2c7..f13f8e63 100644 --- a/docs/reference/toloka.client.filter.OSFamily.md +++ b/docs/reference/toloka.client.filter.OSFamily.md @@ -1,7 +1,7 @@ # OSFamily -`toloka.client.filter.OSFamily` +`toloka.client.filter.OSFamily` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L467) -``` +```python OSFamily( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.filter.OSVersion.md b/docs/reference/toloka.client.filter.OSVersion.md index 69d4b466..e3a2c3f2 100644 --- a/docs/reference/toloka.client.filter.OSVersion.md +++ b/docs/reference/toloka.client.filter.OSVersion.md @@ -1,7 +1,7 @@ # OSVersion -`toloka.client.filter.OSVersion` +`toloka.client.filter.OSVersion` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L501) -``` +```python OSVersion( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.filter.OSVersionBugfix.md b/docs/reference/toloka.client.filter.OSVersionBugfix.md index c7078a60..f868b1e9 100644 --- a/docs/reference/toloka.client.filter.OSVersionBugfix.md +++ b/docs/reference/toloka.client.filter.OSVersionBugfix.md @@ -1,7 +1,7 @@ # OSVersionBugfix -`toloka.client.filter.OSVersionBugfix` +`toloka.client.filter.OSVersionBugfix` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L537) -``` +```python OSVersionBugfix( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.filter.OSVersionMajor.md b/docs/reference/toloka.client.filter.OSVersionMajor.md index f5710379..69ae2dbe 100644 --- a/docs/reference/toloka.client.filter.OSVersionMajor.md +++ b/docs/reference/toloka.client.filter.OSVersionMajor.md @@ -1,7 +1,7 @@ # OSVersionMajor -`toloka.client.filter.OSVersionMajor` +`toloka.client.filter.OSVersionMajor` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L513) -``` +```python OSVersionMajor( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.filter.OSVersionMinor.md b/docs/reference/toloka.client.filter.OSVersionMinor.md index 352e4e64..796df0c3 100644 --- a/docs/reference/toloka.client.filter.OSVersionMinor.md +++ b/docs/reference/toloka.client.filter.OSVersionMinor.md @@ -1,7 +1,7 @@ # OSVersionMinor -`toloka.client.filter.OSVersionMinor` +`toloka.client.filter.OSVersionMinor` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L525) -``` +```python OSVersionMinor( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.filter.Profile.Key.md b/docs/reference/toloka.client.filter.Profile.Key.md index 6452c616..31a1ed81 100644 --- a/docs/reference/toloka.client.filter.Profile.Key.md +++ b/docs/reference/toloka.client.filter.Profile.Key.md @@ -1,5 +1,5 @@ # Key -`toloka.client.filter.Profile.Key` +`toloka.client.filter.Profile.Key` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L164) Possible criteria for filtering users by profile. diff --git a/docs/reference/toloka.client.filter.Profile.md b/docs/reference/toloka.client.filter.Profile.md index 2eb9d168..1bf2af1d 100644 --- a/docs/reference/toloka.client.filter.Profile.md +++ b/docs/reference/toloka.client.filter.Profile.md @@ -1,7 +1,7 @@ # Profile -`toloka.client.filter.Profile` +`toloka.client.filter.Profile` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L159) -``` +```python Profile( self, *, diff --git a/docs/reference/toloka.client.filter.Rating.md b/docs/reference/toloka.client.filter.Rating.md deleted file mode 100644 index 18b36de5..00000000 --- a/docs/reference/toloka.client.filter.Rating.md +++ /dev/null @@ -1,19 +0,0 @@ -# Rating -`toloka.client.filter.Rating` - -``` -Rating( - self, - operator: CompareOperator, - value: Optional[float] = None -) -``` - -Use to select users by user rating. - -## Parameters Description - -| Parameters | Type | Description | -| :----------| :----| :-----------| -`operator`|**[CompareOperator](toloka.client.primitives.operators.CompareOperator.md)**|

Comparison operator in the condition. For example, for a condition "The user must be 18 years old or older» used date of birth and operator GTE («Greater than or equal»). Possible key values operator depends on the data type in the field value

-`value`|**Optional\[float\]**|

User rating. Calculated based on earnings in all projects available to the user.

diff --git a/docs/reference/toloka.client.filter.RegionByIp.md b/docs/reference/toloka.client.filter.RegionByIp.md index 1ca76060..0a082215 100644 --- a/docs/reference/toloka.client.filter.RegionByIp.md +++ b/docs/reference/toloka.client.filter.RegionByIp.md @@ -1,7 +1,7 @@ # RegionByIp -`toloka.client.filter.RegionByIp` +`toloka.client.filter.RegionByIp` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L411) -``` +```python RegionByIp( self, operator: InclusionOperator, diff --git a/docs/reference/toloka.client.filter.RegionByPhone.md b/docs/reference/toloka.client.filter.RegionByPhone.md index f4e178eb..86037f85 100644 --- a/docs/reference/toloka.client.filter.RegionByPhone.md +++ b/docs/reference/toloka.client.filter.RegionByPhone.md @@ -1,7 +1,7 @@ # RegionByPhone -`toloka.client.filter.RegionByPhone` +`toloka.client.filter.RegionByPhone` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L400) -``` +```python RegionByPhone( self, operator: InclusionOperator, diff --git a/docs/reference/toloka.client.filter.Skill.md b/docs/reference/toloka.client.filter.Skill.md index 38fdb95f..daa1a65f 100644 --- a/docs/reference/toloka.client.filter.Skill.md +++ b/docs/reference/toloka.client.filter.Skill.md @@ -1,7 +1,7 @@ # Skill -`toloka.client.filter.Skill` +`toloka.client.filter.Skill` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L208) -``` +```python Skill( self, key: str, diff --git a/docs/reference/toloka.client.filter.UserAgentFamily.UserAgentFamily.md b/docs/reference/toloka.client.filter.UserAgentFamily.UserAgentFamily.md index 0cc6f065..eed252c1 100644 --- a/docs/reference/toloka.client.filter.UserAgentFamily.UserAgentFamily.md +++ b/docs/reference/toloka.client.filter.UserAgentFamily.UserAgentFamily.md @@ -1,5 +1,5 @@ # UserAgentFamily -`toloka.client.filter.UserAgentFamily.UserAgentFamily` +`toloka.client.filter.UserAgentFamily.UserAgentFamily` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L581) User agent family. diff --git a/docs/reference/toloka.client.filter.UserAgentFamily.md b/docs/reference/toloka.client.filter.UserAgentFamily.md index 15509f2e..166e0d0f 100644 --- a/docs/reference/toloka.client.filter.UserAgentFamily.md +++ b/docs/reference/toloka.client.filter.UserAgentFamily.md @@ -1,7 +1,7 @@ # UserAgentFamily -`toloka.client.filter.UserAgentFamily` +`toloka.client.filter.UserAgentFamily` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L573) -``` +```python UserAgentFamily( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.filter.UserAgentType.UserAgentType.md b/docs/reference/toloka.client.filter.UserAgentType.UserAgentType.md index 3f56dcb4..87148887 100644 --- a/docs/reference/toloka.client.filter.UserAgentType.UserAgentType.md +++ b/docs/reference/toloka.client.filter.UserAgentType.UserAgentType.md @@ -1,5 +1,5 @@ # UserAgentType -`toloka.client.filter.UserAgentType.UserAgentType` +`toloka.client.filter.UserAgentType.UserAgentType` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L557) User agent type. diff --git a/docs/reference/toloka.client.filter.UserAgentType.md b/docs/reference/toloka.client.filter.UserAgentType.md index ff3bb2e1..f87c8ccb 100644 --- a/docs/reference/toloka.client.filter.UserAgentType.md +++ b/docs/reference/toloka.client.filter.UserAgentType.md @@ -1,7 +1,7 @@ # UserAgentType -`toloka.client.filter.UserAgentType` +`toloka.client.filter.UserAgentType` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L549) -``` +```python UserAgentType( self, operator: IdentityOperator, diff --git a/docs/reference/toloka.client.filter.UserAgentVersion.md b/docs/reference/toloka.client.filter.UserAgentVersion.md index 091cb783..0d2205f7 100644 --- a/docs/reference/toloka.client.filter.UserAgentVersion.md +++ b/docs/reference/toloka.client.filter.UserAgentVersion.md @@ -1,7 +1,7 @@ # UserAgentVersion -`toloka.client.filter.UserAgentVersion` +`toloka.client.filter.UserAgentVersion` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L613) -``` +```python UserAgentVersion( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.filter.UserAgentVersionBugfix.md b/docs/reference/toloka.client.filter.UserAgentVersionBugfix.md index 32d7509a..4cccf38d 100644 --- a/docs/reference/toloka.client.filter.UserAgentVersionBugfix.md +++ b/docs/reference/toloka.client.filter.UserAgentVersionBugfix.md @@ -1,7 +1,7 @@ # UserAgentVersionBugfix -`toloka.client.filter.UserAgentVersionBugfix` +`toloka.client.filter.UserAgentVersionBugfix` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L646) -``` +```python UserAgentVersionBugfix( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.filter.UserAgentVersionMajor.md b/docs/reference/toloka.client.filter.UserAgentVersionMajor.md index fd55e14e..f647e8e5 100644 --- a/docs/reference/toloka.client.filter.UserAgentVersionMajor.md +++ b/docs/reference/toloka.client.filter.UserAgentVersionMajor.md @@ -1,7 +1,7 @@ # UserAgentVersionMajor -`toloka.client.filter.UserAgentVersionMajor` +`toloka.client.filter.UserAgentVersionMajor` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L624) -``` +```python UserAgentVersionMajor( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.filter.UserAgentVersionMinor.md b/docs/reference/toloka.client.filter.UserAgentVersionMinor.md index 93c8c164..a66de67c 100644 --- a/docs/reference/toloka.client.filter.UserAgentVersionMinor.md +++ b/docs/reference/toloka.client.filter.UserAgentVersionMinor.md @@ -1,7 +1,7 @@ # UserAgentVersionMinor -`toloka.client.filter.UserAgentVersionMinor` +`toloka.client.filter.UserAgentVersionMinor` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/filter.py#L635) -``` +```python UserAgentVersionMinor( self, operator: CompareOperator, diff --git a/docs/reference/toloka.client.message_thread.Folder.md b/docs/reference/toloka.client.message_thread.Folder.md index a845f42c..026f7be7 100644 --- a/docs/reference/toloka.client.message_thread.Folder.md +++ b/docs/reference/toloka.client.message_thread.Folder.md @@ -1,5 +1,5 @@ # Folder -`toloka.client.message_thread.Folder` +`toloka.client.message_thread.Folder` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/message_thread.py#L34) Folders for a thread. diff --git a/docs/reference/toloka.client.message_thread.Interlocutor.InterlocutorRole.md b/docs/reference/toloka.client.message_thread.Interlocutor.InterlocutorRole.md index a3471119..a9236a36 100644 --- a/docs/reference/toloka.client.message_thread.Interlocutor.InterlocutorRole.md +++ b/docs/reference/toloka.client.message_thread.Interlocutor.InterlocutorRole.md @@ -1,5 +1,5 @@ # InterlocutorRole -`toloka.client.message_thread.Interlocutor.InterlocutorRole` +`toloka.client.message_thread.Interlocutor.InterlocutorRole` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/message_thread.py#L55) Role of the sender or recipient in Toloka. diff --git a/docs/reference/toloka.client.message_thread.Interlocutor.md b/docs/reference/toloka.client.message_thread.Interlocutor.md index 104c5419..de2de203 100644 --- a/docs/reference/toloka.client.message_thread.Interlocutor.md +++ b/docs/reference/toloka.client.message_thread.Interlocutor.md @@ -1,7 +1,7 @@ # Interlocutor -`toloka.client.message_thread.Interlocutor` +`toloka.client.message_thread.Interlocutor` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/message_thread.py#L46) -``` +```python Interlocutor( self, *, diff --git a/docs/reference/toloka.client.message_thread.MessageThread.ComposeDetails.md b/docs/reference/toloka.client.message_thread.MessageThread.ComposeDetails.md index ab323f1a..7824673a 100644 --- a/docs/reference/toloka.client.message_thread.MessageThread.ComposeDetails.md +++ b/docs/reference/toloka.client.message_thread.MessageThread.ComposeDetails.md @@ -1,7 +1,7 @@ # ComposeDetails -`toloka.client.message_thread.MessageThread.ComposeDetails` +`toloka.client.message_thread.MessageThread.ComposeDetails` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/message_thread.py#L102) -``` +```python ComposeDetails( self, *, diff --git a/docs/reference/toloka.client.message_thread.MessageThread.Message.md b/docs/reference/toloka.client.message_thread.MessageThread.Message.md index c067e7db..8710793d 100644 --- a/docs/reference/toloka.client.message_thread.MessageThread.Message.md +++ b/docs/reference/toloka.client.message_thread.MessageThread.Message.md @@ -1,7 +1,7 @@ # Message -`toloka.client.message_thread.MessageThread.Message` +`toloka.client.message_thread.MessageThread.Message` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/message_thread.py#L120) -``` +```python Message( self, *, diff --git a/docs/reference/toloka.client.message_thread.MessageThread.Meta.md b/docs/reference/toloka.client.message_thread.MessageThread.Meta.md index b0515b7b..294f9be6 100644 --- a/docs/reference/toloka.client.message_thread.MessageThread.Meta.md +++ b/docs/reference/toloka.client.message_thread.MessageThread.Meta.md @@ -1,7 +1,7 @@ # Meta -`toloka.client.message_thread.MessageThread.Meta` +`toloka.client.message_thread.MessageThread.Meta` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/message_thread.py#L115) -``` +```python Meta( self, *, diff --git a/docs/reference/toloka.client.message_thread.MessageThread.md b/docs/reference/toloka.client.message_thread.MessageThread.md index dd2493d5..c8cad2ae 100644 --- a/docs/reference/toloka.client.message_thread.MessageThread.md +++ b/docs/reference/toloka.client.message_thread.MessageThread.md @@ -1,7 +1,7 @@ # MessageThread -`toloka.client.message_thread.MessageThread` +`toloka.client.message_thread.MessageThread` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/message_thread.py#L76) -``` +```python MessageThread( self, *, diff --git a/docs/reference/toloka.client.message_thread.MessageThreadCompose.md b/docs/reference/toloka.client.message_thread.MessageThreadCompose.md index c6d077d7..9a3b02fe 100644 --- a/docs/reference/toloka.client.message_thread.MessageThreadCompose.md +++ b/docs/reference/toloka.client.message_thread.MessageThreadCompose.md @@ -1,7 +1,7 @@ # MessageThreadCompose -`toloka.client.message_thread.MessageThreadCompose` +`toloka.client.message_thread.MessageThreadCompose` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/message_thread.py#L170) -``` +```python MessageThreadCompose( self, *, diff --git a/docs/reference/toloka.client.message_thread.MessageThreadFolders.md b/docs/reference/toloka.client.message_thread.MessageThreadFolders.md index 97a36d97..4324be96 100644 --- a/docs/reference/toloka.client.message_thread.MessageThreadFolders.md +++ b/docs/reference/toloka.client.message_thread.MessageThreadFolders.md @@ -1,7 +1,7 @@ # MessageThreadFolders -`toloka.client.message_thread.MessageThreadFolders` +`toloka.client.message_thread.MessageThreadFolders` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/message_thread.py#L160) -``` +```python MessageThreadFolders(self, *, folders: Optional[List[Folder]] = None) ``` diff --git a/docs/reference/toloka.client.message_thread.MessageThreadReply.md b/docs/reference/toloka.client.message_thread.MessageThreadReply.md index 408d065f..3f284588 100644 --- a/docs/reference/toloka.client.message_thread.MessageThreadReply.md +++ b/docs/reference/toloka.client.message_thread.MessageThreadReply.md @@ -1,7 +1,7 @@ # MessageThreadReply -`toloka.client.message_thread.MessageThreadReply` +`toloka.client.message_thread.MessageThreadReply` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/message_thread.py#L149) -``` +```python MessageThreadReply(self, *, text: Optional[Dict[str, str]] = None) ``` diff --git a/docs/reference/toloka.client.message_thread.RecipientsSelectType.md b/docs/reference/toloka.client.message_thread.RecipientsSelectType.md index d3115e73..40a61b6e 100644 --- a/docs/reference/toloka.client.message_thread.RecipientsSelectType.md +++ b/docs/reference/toloka.client.message_thread.RecipientsSelectType.md @@ -1,5 +1,5 @@ # RecipientsSelectType -`toloka.client.message_thread.RecipientsSelectType` +`toloka.client.message_thread.RecipientsSelectType` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/message_thread.py#L19) Method for specifying recipients. diff --git a/docs/reference/toloka.client.operation_log.OperationLogItem.md b/docs/reference/toloka.client.operation_log.OperationLogItem.md index 0c591f3b..a4e00f82 100644 --- a/docs/reference/toloka.client.operation_log.OperationLogItem.md +++ b/docs/reference/toloka.client.operation_log.OperationLogItem.md @@ -1,7 +1,7 @@ # OperationLogItem -`toloka.client.operation_log.OperationLogItem` +`toloka.client.operation_log.OperationLogItem` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operation_log.py#L6) -``` +```python OperationLogItem( self, *, diff --git a/docs/reference/toloka.client.operations.AggregatedSolutionOperation.Parameters.md b/docs/reference/toloka.client.operations.AggregatedSolutionOperation.Parameters.md index 6c781407..49ed9b3b 100644 --- a/docs/reference/toloka.client.operations.AggregatedSolutionOperation.Parameters.md +++ b/docs/reference/toloka.client.operations.AggregatedSolutionOperation.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.operations.AggregatedSolutionOperation.Parameters` +`toloka.client.operations.AggregatedSolutionOperation.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L335) -``` +```python Parameters(self, *, pool_id: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.operations.AggregatedSolutionOperation.md b/docs/reference/toloka.client.operations.AggregatedSolutionOperation.md index 90819783..e8b56e62 100644 --- a/docs/reference/toloka.client.operations.AggregatedSolutionOperation.md +++ b/docs/reference/toloka.client.operations.AggregatedSolutionOperation.md @@ -1,7 +1,7 @@ # AggregatedSolutionOperation -`toloka.client.operations.AggregatedSolutionOperation` +`toloka.client.operations.AggregatedSolutionOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L327) -``` +```python AggregatedSolutionOperation( self, *, diff --git a/docs/reference/toloka.client.operations.AnalyticsOperation.md b/docs/reference/toloka.client.operations.AnalyticsOperation.md index c3787546..ab483b3a 100644 --- a/docs/reference/toloka.client.operations.AnalyticsOperation.md +++ b/docs/reference/toloka.client.operations.AnalyticsOperation.md @@ -1,7 +1,7 @@ # AnalyticsOperation -`toloka.client.operations.AnalyticsOperation` +`toloka.client.operations.AnalyticsOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L120) -``` +```python AnalyticsOperation( self, *, diff --git a/docs/reference/toloka.client.operations.Operation.Parameters.md b/docs/reference/toloka.client.operations.Operation.Parameters.md index ec8fc0be..03e2c333 100644 --- a/docs/reference/toloka.client.operations.Operation.Parameters.md +++ b/docs/reference/toloka.client.operations.Operation.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.operations.Operation.Parameters` +`toloka.client.operations.Operation.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L88) -``` +```python Parameters(self) ``` diff --git a/docs/reference/toloka.client.operations.Operation.Status.md b/docs/reference/toloka.client.operations.Operation.Status.md index 82bf1f4f..a412e4cc 100644 --- a/docs/reference/toloka.client.operations.Operation.Status.md +++ b/docs/reference/toloka.client.operations.Operation.Status.md @@ -1,5 +1,5 @@ # Status -`toloka.client.operations.Operation.Status` +`toloka.client.operations.Operation.Status` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L67) The status of the operation: diff --git a/docs/reference/toloka.client.operations.Operation.is_completed.md b/docs/reference/toloka.client.operations.Operation.is_completed.md index 9e61a31d..bed3a6d3 100644 --- a/docs/reference/toloka.client.operations.Operation.is_completed.md +++ b/docs/reference/toloka.client.operations.Operation.is_completed.md @@ -1,7 +1,7 @@ # is_completed -`toloka.client.operations.Operation.is_completed` +`toloka.client.operations.Operation.is_completed` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L107) -``` +```python is_completed(self) ``` diff --git a/docs/reference/toloka.client.operations.Operation.md b/docs/reference/toloka.client.operations.Operation.md index b60394d8..06abc99d 100644 --- a/docs/reference/toloka.client.operations.Operation.md +++ b/docs/reference/toloka.client.operations.Operation.md @@ -1,7 +1,7 @@ # Operation -`toloka.client.operations.Operation` +`toloka.client.operations.Operation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L50) -``` +```python Operation( self, *, @@ -34,7 +34,7 @@ awarding bonuses) are processed as asynchronous operations that run in the backg `finished`|**Optional\[datetime\]**|

The UTC date and time the operation finished.

`progress`|**Optional\[int\]**|

The percentage of the operation completed.

`details`|**Optional\[Any\]**|

Details of the operation completion.

-## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.operations.Operation.raise_on_fail.md b/docs/reference/toloka.client.operations.Operation.raise_on_fail.md index 0be1560e..7d3e5068 100644 --- a/docs/reference/toloka.client.operations.Operation.raise_on_fail.md +++ b/docs/reference/toloka.client.operations.Operation.raise_on_fail.md @@ -1,7 +1,7 @@ # raise_on_fail -`toloka.client.operations.Operation.raise_on_fail` +`toloka.client.operations.Operation.raise_on_fail` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L111) -``` +```python raise_on_fail(self) ``` diff --git a/docs/reference/toloka.client.operations.OperationType.md b/docs/reference/toloka.client.operations.OperationType.md index ef343746..86acd13e 100644 --- a/docs/reference/toloka.client.operations.OperationType.md +++ b/docs/reference/toloka.client.operations.OperationType.md @@ -1,5 +1,5 @@ # OperationType -`toloka.client.operations.OperationType` +`toloka.client.operations.OperationType` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L31) An enumeration. diff --git a/docs/reference/toloka.client.operations.PoolArchiveOperation.md b/docs/reference/toloka.client.operations.PoolArchiveOperation.md index 092a652a..c423ac39 100644 --- a/docs/reference/toloka.client.operations.PoolArchiveOperation.md +++ b/docs/reference/toloka.client.operations.PoolArchiveOperation.md @@ -1,7 +1,7 @@ # PoolArchiveOperation -`toloka.client.operations.PoolArchiveOperation` +`toloka.client.operations.PoolArchiveOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L145) -``` +```python PoolArchiveOperation( self, *, diff --git a/docs/reference/toloka.client.operations.PoolCloneOperation.Details.md b/docs/reference/toloka.client.operations.PoolCloneOperation.Details.md index 9dadae29..11551585 100644 --- a/docs/reference/toloka.client.operations.PoolCloneOperation.Details.md +++ b/docs/reference/toloka.client.operations.PoolCloneOperation.Details.md @@ -1,7 +1,7 @@ # Details -`toloka.client.operations.PoolCloneOperation.Details` +`toloka.client.operations.PoolCloneOperation.Details` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L165) -``` +```python Details(self, *, pool_id: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.operations.PoolCloneOperation.md b/docs/reference/toloka.client.operations.PoolCloneOperation.md index 00d84244..544e8526 100644 --- a/docs/reference/toloka.client.operations.PoolCloneOperation.md +++ b/docs/reference/toloka.client.operations.PoolCloneOperation.md @@ -1,7 +1,7 @@ # PoolCloneOperation -`toloka.client.operations.PoolCloneOperation` +`toloka.client.operations.PoolCloneOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L153) -``` +```python PoolCloneOperation( self, *, diff --git a/docs/reference/toloka.client.operations.PoolCloseOperation.md b/docs/reference/toloka.client.operations.PoolCloseOperation.md index 359972c0..25171b95 100644 --- a/docs/reference/toloka.client.operations.PoolCloseOperation.md +++ b/docs/reference/toloka.client.operations.PoolCloseOperation.md @@ -1,7 +1,7 @@ # PoolCloseOperation -`toloka.client.operations.PoolCloseOperation` +`toloka.client.operations.PoolCloseOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L171) -``` +```python PoolCloseOperation( self, *, diff --git a/docs/reference/toloka.client.operations.PoolOpenOperation.md b/docs/reference/toloka.client.operations.PoolOpenOperation.md index fe2f3f47..4ef72e7c 100644 --- a/docs/reference/toloka.client.operations.PoolOpenOperation.md +++ b/docs/reference/toloka.client.operations.PoolOpenOperation.md @@ -1,7 +1,7 @@ # PoolOpenOperation -`toloka.client.operations.PoolOpenOperation` +`toloka.client.operations.PoolOpenOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L179) -``` +```python PoolOpenOperation( self, *, diff --git a/docs/reference/toloka.client.operations.PoolOperation.Parameters.md b/docs/reference/toloka.client.operations.PoolOperation.Parameters.md index 1d071a1c..c4861929 100644 --- a/docs/reference/toloka.client.operations.PoolOperation.Parameters.md +++ b/docs/reference/toloka.client.operations.PoolOperation.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.operations.PoolOperation.Parameters` +`toloka.client.operations.PoolOperation.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L139) -``` +```python Parameters(self, *, pool_id: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.operations.PoolOperation.md b/docs/reference/toloka.client.operations.PoolOperation.md index 6b0b20fc..a88fc1f0 100644 --- a/docs/reference/toloka.client.operations.PoolOperation.md +++ b/docs/reference/toloka.client.operations.PoolOperation.md @@ -1,7 +1,7 @@ # PoolOperation -`toloka.client.operations.PoolOperation` +`toloka.client.operations.PoolOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L131) -``` +```python PoolOperation( self, *, diff --git a/docs/reference/toloka.client.operations.ProjectArchiveOperation.Parameters.md b/docs/reference/toloka.client.operations.ProjectArchiveOperation.Parameters.md index 252634fc..f1ab01cb 100644 --- a/docs/reference/toloka.client.operations.ProjectArchiveOperation.Parameters.md +++ b/docs/reference/toloka.client.operations.ProjectArchiveOperation.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.operations.ProjectArchiveOperation.Parameters` +`toloka.client.operations.ProjectArchiveOperation.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L257) -``` +```python Parameters(self, *, project_id: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.operations.ProjectArchiveOperation.md b/docs/reference/toloka.client.operations.ProjectArchiveOperation.md index 52274c1f..91961ae7 100644 --- a/docs/reference/toloka.client.operations.ProjectArchiveOperation.md +++ b/docs/reference/toloka.client.operations.ProjectArchiveOperation.md @@ -1,7 +1,7 @@ # ProjectArchiveOperation -`toloka.client.operations.ProjectArchiveOperation` +`toloka.client.operations.ProjectArchiveOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L249) -``` +```python ProjectArchiveOperation( self, *, diff --git a/docs/reference/toloka.client.operations.TaskSuiteCreateBatchOperation.Parameters.md b/docs/reference/toloka.client.operations.TaskSuiteCreateBatchOperation.Parameters.md index b7e8b9fe..0a000ce5 100644 --- a/docs/reference/toloka.client.operations.TaskSuiteCreateBatchOperation.Parameters.md +++ b/docs/reference/toloka.client.operations.TaskSuiteCreateBatchOperation.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.operations.TaskSuiteCreateBatchOperation.Parameters` +`toloka.client.operations.TaskSuiteCreateBatchOperation.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L314) -``` +```python Parameters( self, *, diff --git a/docs/reference/toloka.client.operations.TaskSuiteCreateBatchOperation.md b/docs/reference/toloka.client.operations.TaskSuiteCreateBatchOperation.md index 2d4272f5..45abad64 100644 --- a/docs/reference/toloka.client.operations.TaskSuiteCreateBatchOperation.md +++ b/docs/reference/toloka.client.operations.TaskSuiteCreateBatchOperation.md @@ -1,7 +1,7 @@ # TaskSuiteCreateBatchOperation -`toloka.client.operations.TaskSuiteCreateBatchOperation` +`toloka.client.operations.TaskSuiteCreateBatchOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L297) -``` +```python TaskSuiteCreateBatchOperation( self, *, diff --git a/docs/reference/toloka.client.operations.TasksCreateOperation.Parameters.md b/docs/reference/toloka.client.operations.TasksCreateOperation.Parameters.md index 5cb0fca3..447d614d 100644 --- a/docs/reference/toloka.client.operations.TasksCreateOperation.Parameters.md +++ b/docs/reference/toloka.client.operations.TasksCreateOperation.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.operations.TasksCreateOperation.Parameters` +`toloka.client.operations.TasksCreateOperation.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L284) -``` +```python Parameters( self, *, diff --git a/docs/reference/toloka.client.operations.TasksCreateOperation.md b/docs/reference/toloka.client.operations.TasksCreateOperation.md index a816598b..f933771d 100644 --- a/docs/reference/toloka.client.operations.TasksCreateOperation.md +++ b/docs/reference/toloka.client.operations.TasksCreateOperation.md @@ -1,7 +1,7 @@ # TasksCreateOperation -`toloka.client.operations.TasksCreateOperation` +`toloka.client.operations.TasksCreateOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L266) -``` +```python TasksCreateOperation( self, *, diff --git a/docs/reference/toloka.client.operations.TrainingArchiveOperation.md b/docs/reference/toloka.client.operations.TrainingArchiveOperation.md index 650ef5e8..383075f5 100644 --- a/docs/reference/toloka.client.operations.TrainingArchiveOperation.md +++ b/docs/reference/toloka.client.operations.TrainingArchiveOperation.md @@ -1,7 +1,7 @@ # TrainingArchiveOperation -`toloka.client.operations.TrainingArchiveOperation` +`toloka.client.operations.TrainingArchiveOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L204) -``` +```python TrainingArchiveOperation( self, *, diff --git a/docs/reference/toloka.client.operations.TrainingCloneOperation.Details.md b/docs/reference/toloka.client.operations.TrainingCloneOperation.Details.md index 8d81c675..1f8363a5 100644 --- a/docs/reference/toloka.client.operations.TrainingCloneOperation.Details.md +++ b/docs/reference/toloka.client.operations.TrainingCloneOperation.Details.md @@ -1,7 +1,7 @@ # Details -`toloka.client.operations.TrainingCloneOperation.Details` +`toloka.client.operations.TrainingCloneOperation.Details` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L224) -``` +```python Details(self, *, training_id: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.operations.TrainingCloneOperation.md b/docs/reference/toloka.client.operations.TrainingCloneOperation.md index aa94fdc0..9a0cccca 100644 --- a/docs/reference/toloka.client.operations.TrainingCloneOperation.md +++ b/docs/reference/toloka.client.operations.TrainingCloneOperation.md @@ -1,7 +1,7 @@ # TrainingCloneOperation -`toloka.client.operations.TrainingCloneOperation` +`toloka.client.operations.TrainingCloneOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L212) -``` +```python TrainingCloneOperation( self, *, diff --git a/docs/reference/toloka.client.operations.TrainingCloseOperation.md b/docs/reference/toloka.client.operations.TrainingCloseOperation.md index 7674db0a..eb0841c7 100644 --- a/docs/reference/toloka.client.operations.TrainingCloseOperation.md +++ b/docs/reference/toloka.client.operations.TrainingCloseOperation.md @@ -1,7 +1,7 @@ # TrainingCloseOperation -`toloka.client.operations.TrainingCloseOperation` +`toloka.client.operations.TrainingCloseOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L230) -``` +```python TrainingCloseOperation( self, *, diff --git a/docs/reference/toloka.client.operations.TrainingOpenOperation.md b/docs/reference/toloka.client.operations.TrainingOpenOperation.md index 6670e960..fe241326 100644 --- a/docs/reference/toloka.client.operations.TrainingOpenOperation.md +++ b/docs/reference/toloka.client.operations.TrainingOpenOperation.md @@ -1,7 +1,7 @@ # TrainingOpenOperation -`toloka.client.operations.TrainingOpenOperation` +`toloka.client.operations.TrainingOpenOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L238) -``` +```python TrainingOpenOperation( self, *, diff --git a/docs/reference/toloka.client.operations.TrainingOperation.Parameters.md b/docs/reference/toloka.client.operations.TrainingOperation.Parameters.md index b9fe0ffd..18b79a47 100644 --- a/docs/reference/toloka.client.operations.TrainingOperation.Parameters.md +++ b/docs/reference/toloka.client.operations.TrainingOperation.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.operations.TrainingOperation.Parameters` +`toloka.client.operations.TrainingOperation.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L198) -``` +```python Parameters(self, *, training_id: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.operations.TrainingOperation.md b/docs/reference/toloka.client.operations.TrainingOperation.md index 61893164..a5ae6cc0 100644 --- a/docs/reference/toloka.client.operations.TrainingOperation.md +++ b/docs/reference/toloka.client.operations.TrainingOperation.md @@ -1,7 +1,7 @@ # TrainingOperation -`toloka.client.operations.TrainingOperation` +`toloka.client.operations.TrainingOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L190) -``` +```python TrainingOperation( self, *, diff --git a/docs/reference/toloka.client.operations.UserBonusCreateBatchOperation.Details.md b/docs/reference/toloka.client.operations.UserBonusCreateBatchOperation.Details.md index 2edcad42..7f6c528d 100644 --- a/docs/reference/toloka.client.operations.UserBonusCreateBatchOperation.Details.md +++ b/docs/reference/toloka.client.operations.UserBonusCreateBatchOperation.Details.md @@ -1,7 +1,7 @@ # Details -`toloka.client.operations.UserBonusCreateBatchOperation.Details` +`toloka.client.operations.UserBonusCreateBatchOperation.Details` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L366) -``` +```python Details( self, *, diff --git a/docs/reference/toloka.client.operations.UserBonusCreateBatchOperation.Parameters.md b/docs/reference/toloka.client.operations.UserBonusCreateBatchOperation.Parameters.md index fbd446f6..f6e74fd1 100644 --- a/docs/reference/toloka.client.operations.UserBonusCreateBatchOperation.Parameters.md +++ b/docs/reference/toloka.client.operations.UserBonusCreateBatchOperation.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.operations.UserBonusCreateBatchOperation.Parameters` +`toloka.client.operations.UserBonusCreateBatchOperation.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L363) -``` +```python Parameters(self, *, skip_invalid_items: Optional[bool] = None) ``` diff --git a/docs/reference/toloka.client.operations.UserBonusCreateBatchOperation.md b/docs/reference/toloka.client.operations.UserBonusCreateBatchOperation.md index 6c5c9492..cfd36c48 100644 --- a/docs/reference/toloka.client.operations.UserBonusCreateBatchOperation.md +++ b/docs/reference/toloka.client.operations.UserBonusCreateBatchOperation.md @@ -1,7 +1,7 @@ # UserBonusCreateBatchOperation -`toloka.client.operations.UserBonusCreateBatchOperation` +`toloka.client.operations.UserBonusCreateBatchOperation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/operations.py#L344) -``` +```python UserBonusCreateBatchOperation( self, *, diff --git a/docs/reference/toloka.client.owner.Owner.md b/docs/reference/toloka.client.owner.Owner.md index 1b708b27..744a560f 100644 --- a/docs/reference/toloka.client.owner.Owner.md +++ b/docs/reference/toloka.client.owner.Owner.md @@ -1,7 +1,7 @@ # Owner -`toloka.client.owner.Owner` +`toloka.client.owner.Owner` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/owner.py#L4) -``` +```python Owner( self, *, diff --git a/docs/reference/toloka.client.pool.Pool.AssignmentsIssuingConfig.md b/docs/reference/toloka.client.pool.Pool.AssignmentsIssuingConfig.md index 308ef950..6a16615c 100644 --- a/docs/reference/toloka.client.pool.Pool.AssignmentsIssuingConfig.md +++ b/docs/reference/toloka.client.pool.Pool.AssignmentsIssuingConfig.md @@ -1,7 +1,7 @@ # AssignmentsIssuingConfig -`toloka.client.pool.Pool.AssignmentsIssuingConfig` +`toloka.client.pool.Pool.AssignmentsIssuingConfig` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L117) -``` +```python AssignmentsIssuingConfig(self, issue_task_suites_in_creation_order: Optional[bool] = None) ``` diff --git a/docs/reference/toloka.client.pool.Pool.CloseReason.md b/docs/reference/toloka.client.pool.Pool.CloseReason.md index ad63b055..7a7b2dac 100644 --- a/docs/reference/toloka.client.pool.Pool.CloseReason.md +++ b/docs/reference/toloka.client.pool.Pool.CloseReason.md @@ -1,5 +1,5 @@ # CloseReason -`toloka.client.pool.Pool.CloseReason` +`toloka.client.pool.Pool.CloseReason` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L129) The reason for closing the pool the last time: diff --git a/docs/reference/toloka.client.pool.Pool.Defaults.md b/docs/reference/toloka.client.pool.Pool.Defaults.md index 023030bf..61678dc6 100644 --- a/docs/reference/toloka.client.pool.Pool.Defaults.md +++ b/docs/reference/toloka.client.pool.Pool.Defaults.md @@ -1,7 +1,7 @@ # Defaults -`toloka.client.pool.Pool.Defaults` +`toloka.client.pool.Pool.Defaults` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L151) -``` +```python Defaults( self, *, diff --git a/docs/reference/toloka.client.pool.Pool.Status.md b/docs/reference/toloka.client.pool.Pool.Status.md index 793285aa..022f0b37 100644 --- a/docs/reference/toloka.client.pool.Pool.Status.md +++ b/docs/reference/toloka.client.pool.Pool.Status.md @@ -1,5 +1,5 @@ # Status -`toloka.client.pool.Pool.Status` +`toloka.client.pool.Pool.Status` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L164) Status of the pool diff --git a/docs/reference/toloka.client.pool.Pool.TrainingConfig.md b/docs/reference/toloka.client.pool.Pool.TrainingConfig.md index 994767e1..e43108fb 100644 --- a/docs/reference/toloka.client.pool.Pool.TrainingConfig.md +++ b/docs/reference/toloka.client.pool.Pool.TrainingConfig.md @@ -1,7 +1,7 @@ # TrainingConfig -`toloka.client.pool.Pool.TrainingConfig` +`toloka.client.pool.Pool.TrainingConfig` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L180) -``` +```python TrainingConfig(self, training_skill_ttl_days: Optional[int] = None) ``` diff --git a/docs/reference/toloka.client.pool.Pool.Type.md b/docs/reference/toloka.client.pool.Pool.Type.md index 8cbf17d7..ba3114ed 100644 --- a/docs/reference/toloka.client.pool.Pool.Type.md +++ b/docs/reference/toloka.client.pool.Pool.Type.md @@ -1,5 +1,5 @@ # Type -`toloka.client.pool.Pool.Type` +`toloka.client.pool.Pool.Type` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L183) An enumeration. diff --git a/docs/reference/toloka.client.pool.Pool.is_archived.md b/docs/reference/toloka.client.pool.Pool.is_archived.md index b1768a7f..2f6f4527 100644 --- a/docs/reference/toloka.client.pool.Pool.is_archived.md +++ b/docs/reference/toloka.client.pool.Pool.is_archived.md @@ -1,7 +1,7 @@ # is_archived -`toloka.client.pool.Pool.is_archived` +`toloka.client.pool.Pool.is_archived` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L242) -``` +```python is_archived(self) ``` diff --git a/docs/reference/toloka.client.pool.Pool.is_closed.md b/docs/reference/toloka.client.pool.Pool.is_closed.md index e74fadcc..105ff0f2 100644 --- a/docs/reference/toloka.client.pool.Pool.is_closed.md +++ b/docs/reference/toloka.client.pool.Pool.is_closed.md @@ -1,7 +1,7 @@ # is_closed -`toloka.client.pool.Pool.is_closed` +`toloka.client.pool.Pool.is_closed` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L239) -``` +```python is_closed(self) ``` diff --git a/docs/reference/toloka.client.pool.Pool.is_locked.md b/docs/reference/toloka.client.pool.Pool.is_locked.md index 82d3322b..9d4ba6c3 100644 --- a/docs/reference/toloka.client.pool.Pool.is_locked.md +++ b/docs/reference/toloka.client.pool.Pool.is_locked.md @@ -1,7 +1,7 @@ # is_locked -`toloka.client.pool.Pool.is_locked` +`toloka.client.pool.Pool.is_locked` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L245) -``` +```python is_locked(self) ``` diff --git a/docs/reference/toloka.client.pool.Pool.is_open.md b/docs/reference/toloka.client.pool.Pool.is_open.md index b6ac63c2..1633ed1d 100644 --- a/docs/reference/toloka.client.pool.Pool.is_open.md +++ b/docs/reference/toloka.client.pool.Pool.is_open.md @@ -1,7 +1,7 @@ # is_open -`toloka.client.pool.Pool.is_open` +`toloka.client.pool.Pool.is_open` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L236) -``` +```python is_open(self) ``` diff --git a/docs/reference/toloka.client.pool.Pool.md b/docs/reference/toloka.client.pool.Pool.md index 22ac1ef8..5e545350 100644 --- a/docs/reference/toloka.client.pool.Pool.md +++ b/docs/reference/toloka.client.pool.Pool.md @@ -1,7 +1,7 @@ # Pool -`toloka.client.pool.Pool` +`toloka.client.pool.Pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L33) -``` +```python Pool( self, *, @@ -90,7 +90,7 @@ new_pool = toloka.pool.Pool( project_id=existing_project_id, private_name='Pool 1', may_contain_adult_content=False, - will_expire=datetime.datetime.utcnow() + datetime.timedelta(days=365), + will_expire=datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(days=365), reward_per_assignment=0.01, assignment_max_duration_seconds=60*20, defaults=toloka.pool.Pool.Defaults(default_overlap_for_new_task_suites=3), @@ -101,7 +101,7 @@ new_pool.quality_control.add_action(...) new_pool = toloka_client.create_pool(new_pool) print(new_pool.id) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.pool.PoolPatchRequest.md b/docs/reference/toloka.client.pool.PoolPatchRequest.md index 406913f9..f31d9d16 100644 --- a/docs/reference/toloka.client.pool.PoolPatchRequest.md +++ b/docs/reference/toloka.client.pool.PoolPatchRequest.md @@ -1,7 +1,7 @@ # PoolPatchRequest -`toloka.client.pool.PoolPatchRequest` +`toloka.client.pool.PoolPatchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L270) -``` +```python PoolPatchRequest(self, priority: Optional[int] = None) ``` diff --git a/docs/reference/toloka.client.pool.codegen_setter_for_quality_control_configs.md b/docs/reference/toloka.client.pool.codegen_setter_for_quality_control_configs.md index a50d9562..cb8edb57 100644 --- a/docs/reference/toloka.client.pool.codegen_setter_for_quality_control_configs.md +++ b/docs/reference/toloka.client.pool.codegen_setter_for_quality_control_configs.md @@ -1,7 +1,7 @@ # set_quality_control_configs -`toloka.client.pool.codegen_setter_for_quality_control_configs` +`toloka.client.pool.codegen_setter_for_quality_control_configs` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/__init__.py#L0) -``` +```python set_quality_control_configs(self, configs) ``` diff --git a/docs/reference/toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Field.md b/docs/reference/toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Field.md index 107b0e79..2ef86af1 100644 --- a/docs/reference/toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Field.md +++ b/docs/reference/toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Field.md @@ -1,7 +1,7 @@ # Field -`toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Field` +`toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Field` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/dynamic_overlap_config.py#L39) -``` +```python Field(self, name: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Type.md b/docs/reference/toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Type.md index c5198ab4..d8c873f3 100644 --- a/docs/reference/toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Type.md +++ b/docs/reference/toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Type.md @@ -1,5 +1,5 @@ # Type -`toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Type` +`toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.Type` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/dynamic_overlap_config.py#L25) The algorithm for dynamic overlap. diff --git a/docs/reference/toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.md b/docs/reference/toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.md index 92db6d0a..5b434806 100644 --- a/docs/reference/toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.md +++ b/docs/reference/toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig.md @@ -1,7 +1,7 @@ # DynamicOverlapConfig -`toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig` +`toloka.client.pool.dynamic_overlap_config.DynamicOverlapConfig` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/dynamic_overlap_config.py#L9) -``` +```python DynamicOverlapConfig( self, *, diff --git a/docs/reference/toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Interval.md b/docs/reference/toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Interval.md index 99908b2c..78a61e0f 100644 --- a/docs/reference/toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Interval.md +++ b/docs/reference/toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Interval.md @@ -1,7 +1,7 @@ # Interval -`toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Interval` +`toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Interval` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/dynamic_pricing_config.py#L25) -``` +```python Interval( self, *, diff --git a/docs/reference/toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Type.md b/docs/reference/toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Type.md index 4555fa11..388880d6 100644 --- a/docs/reference/toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Type.md +++ b/docs/reference/toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Type.md @@ -1,5 +1,5 @@ # Type -`toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Type` +`toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.Type` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/dynamic_pricing_config.py#L20) Dynamic pricing type diff --git a/docs/reference/toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.md b/docs/reference/toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.md index 20b74e83..e7d2e0fe 100644 --- a/docs/reference/toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.md +++ b/docs/reference/toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig.md @@ -1,7 +1,7 @@ # DynamicPricingConfig -`toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig` +`toloka.client.pool.dynamic_pricing_config.DynamicPricingConfig` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/dynamic_pricing_config.py#L9) -``` +```python DynamicPricingConfig( self, type: Union[Type, str, None] = None, diff --git a/docs/reference/toloka.client.pool.mixer_config.MixerConfig.md b/docs/reference/toloka.client.pool.mixer_config.MixerConfig.md index cd674555..65139579 100644 --- a/docs/reference/toloka.client.pool.mixer_config.MixerConfig.md +++ b/docs/reference/toloka.client.pool.mixer_config.MixerConfig.md @@ -1,7 +1,7 @@ # MixerConfig -`toloka.client.pool.mixer_config.MixerConfig` +`toloka.client.pool.mixer_config.MixerConfig` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/pool/mixer_config.py#L7) -``` +```python MixerConfig( self, *, diff --git a/docs/reference/toloka.client.primitives.base.BaseParameters.Parameters.md b/docs/reference/toloka.client.primitives.base.BaseParameters.Parameters.md index 3f58fb1e..c33025c4 100644 --- a/docs/reference/toloka.client.primitives.base.BaseParameters.Parameters.md +++ b/docs/reference/toloka.client.primitives.base.BaseParameters.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.primitives.base.BaseParameters.Parameters` +`toloka.client.primitives.base.BaseParameters.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L351) -``` +```python Parameters(self) ``` diff --git a/docs/reference/toloka.client.primitives.base.BaseParameters.md b/docs/reference/toloka.client.primitives.base.BaseParameters.md index 8d99d7f7..0068e5c9 100644 --- a/docs/reference/toloka.client.primitives.base.BaseParameters.md +++ b/docs/reference/toloka.client.primitives.base.BaseParameters.md @@ -1,7 +1,7 @@ # BaseParameters -`toloka.client.primitives.base.BaseParameters` +`toloka.client.primitives.base.BaseParameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L350) -``` +```python BaseParameters(self) ``` diff --git a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.from_json.md b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.from_json.md index 5591a622..af68314b 100644 --- a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.from_json.md +++ b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.from_json.md @@ -1,7 +1,7 @@ # from_json -`toloka.client.primitives.base.BaseTolokaObject.from_json` +`toloka.client.primitives.base.BaseTolokaObject.from_json` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L298) -``` +```python from_json(cls, json_str: str) ``` diff --git a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.get_spec_subclass_for_value.md b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.get_spec_subclass_for_value.md index 7c1d0285..dba2fce5 100644 --- a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.get_spec_subclass_for_value.md +++ b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.get_spec_subclass_for_value.md @@ -1,7 +1,7 @@ # get_spec_subclass_for_value -`toloka.client.primitives.base.BaseTolokaObject.get_spec_subclass_for_value` +`toloka.client.primitives.base.BaseTolokaObject.get_spec_subclass_for_value` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L225) -``` -get_spec_subclass_for_value(cls, spec_value: Union[str, TypeVar('E', bound=Enum)] = None) +```python +get_spec_subclass_for_value(cls, spec_value: Union[str, TypeVar('E', bound=Enum), None] = None) ``` diff --git a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.get_variant_specs.md b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.get_variant_specs.md index d36d8215..58a4139a 100644 --- a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.get_variant_specs.md +++ b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.get_variant_specs.md @@ -1,7 +1,7 @@ # get_variant_specs -`toloka.client.primitives.base.BaseTolokaObject.get_variant_specs` +`toloka.client.primitives.base.BaseTolokaObject.get_variant_specs` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L215) -``` +```python get_variant_specs(cls) ``` diff --git a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.is_variant_base.md b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.is_variant_base.md index 99e19b93..50f0a719 100644 --- a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.is_variant_base.md +++ b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.is_variant_base.md @@ -1,7 +1,7 @@ # is_variant_base -`toloka.client.primitives.base.BaseTolokaObject.is_variant_base` +`toloka.client.primitives.base.BaseTolokaObject.is_variant_base` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L203) -``` +```python is_variant_base(cls) ``` diff --git a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.is_variant_incomplete.md b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.is_variant_incomplete.md index f26eb2a1..5cea5489 100644 --- a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.is_variant_incomplete.md +++ b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.is_variant_incomplete.md @@ -1,7 +1,7 @@ # is_variant_incomplete -`toloka.client.primitives.base.BaseTolokaObject.is_variant_incomplete` +`toloka.client.primitives.base.BaseTolokaObject.is_variant_incomplete` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L207) -``` +```python is_variant_incomplete(cls) ``` diff --git a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.is_variant_spec.md b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.is_variant_spec.md index d796c679..3916e1a7 100644 --- a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.is_variant_spec.md +++ b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.is_variant_spec.md @@ -1,7 +1,7 @@ # is_variant_spec -`toloka.client.primitives.base.BaseTolokaObject.is_variant_spec` +`toloka.client.primitives.base.BaseTolokaObject.is_variant_spec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L211) -``` +```python is_variant_spec(cls) ``` diff --git a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.md b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.md index 6785b7ae..b6f467d1 100644 --- a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.md +++ b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.md @@ -1,7 +1,7 @@ # BaseTolokaObject -`toloka.client.primitives.base.BaseTolokaObject` +`toloka.client.primitives.base.BaseTolokaObject` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L146) -``` +```python BaseTolokaObject(self) ``` @@ -13,7 +13,7 @@ Subclasses of BaseTolokaObject will: if not explicitly configured otherwise * Skip missing optional fields during unstructuring with client's cattr converter -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.to_json.md b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.to_json.md index b1129f26..2d410bd4 100644 --- a/docs/reference/toloka.client.primitives.base.BaseTolokaObject.to_json.md +++ b/docs/reference/toloka.client.primitives.base.BaseTolokaObject.to_json.md @@ -1,7 +1,7 @@ # to_json -`toloka.client.primitives.base.BaseTolokaObject.to_json` +`toloka.client.primitives.base.BaseTolokaObject.to_json` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L288) -``` +```python to_json(self, pretty: bool = False) ``` diff --git a/docs/reference/toloka.client.primitives.base.BaseTolokaObjectMetaclass.md b/docs/reference/toloka.client.primitives.base.BaseTolokaObjectMetaclass.md index a4490f30..3034031b 100644 --- a/docs/reference/toloka.client.primitives.base.BaseTolokaObjectMetaclass.md +++ b/docs/reference/toloka.client.primitives.base.BaseTolokaObjectMetaclass.md @@ -1,7 +1,7 @@ # BaseTolokaObjectMetaclass -`toloka.client.primitives.base.BaseTolokaObjectMetaclass` +`toloka.client.primitives.base.BaseTolokaObjectMetaclass` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L93) -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.primitives.base.BaseTolokaObjectMetaclass.transformer.md b/docs/reference/toloka.client.primitives.base.BaseTolokaObjectMetaclass.transformer.md index 3148abcc..e350ce0b 100644 --- a/docs/reference/toloka.client.primitives.base.BaseTolokaObjectMetaclass.transformer.md +++ b/docs/reference/toloka.client.primitives.base.BaseTolokaObjectMetaclass.transformer.md @@ -1,7 +1,7 @@ # transformer -`toloka.client.primitives.base.BaseTolokaObjectMetaclass.transformer` +`toloka.client.primitives.base.BaseTolokaObjectMetaclass.transformer` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L120) -``` +```python transformer(type_: type, fields: List[Attribute]) ``` diff --git a/docs/reference/toloka.client.primitives.base.VariantRegistry.md b/docs/reference/toloka.client.primitives.base.VariantRegistry.md index 7858fadd..175f9ac9 100644 --- a/docs/reference/toloka.client.primitives.base.VariantRegistry.md +++ b/docs/reference/toloka.client.primitives.base.VariantRegistry.md @@ -1,7 +1,7 @@ # VariantRegistry -`toloka.client.primitives.base.VariantRegistry` +`toloka.client.primitives.base.VariantRegistry` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L26) -``` +```python VariantRegistry( self, field: str, @@ -9,7 +9,7 @@ VariantRegistry( ) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.primitives.base.VariantRegistry.register.md b/docs/reference/toloka.client.primitives.base.VariantRegistry.register.md index 79d6dbe0..7d629c75 100644 --- a/docs/reference/toloka.client.primitives.base.VariantRegistry.register.md +++ b/docs/reference/toloka.client.primitives.base.VariantRegistry.register.md @@ -1,7 +1,7 @@ # register -`toloka.client.primitives.base.VariantRegistry.register` +`toloka.client.primitives.base.VariantRegistry.register` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L33) -``` +```python register( self, type_: type, diff --git a/docs/reference/toloka.client.primitives.base.autocast_to_enum.md b/docs/reference/toloka.client.primitives.base.autocast_to_enum.md index 4704120a..2f9101f2 100644 --- a/docs/reference/toloka.client.primitives.base.autocast_to_enum.md +++ b/docs/reference/toloka.client.primitives.base.autocast_to_enum.md @@ -1,7 +1,7 @@ # autocast_to_enum -`toloka.client.primitives.base.autocast_to_enum` +`toloka.client.primitives.base.autocast_to_enum` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/base.py#L303) -``` +```python autocast_to_enum(func: Callable) ``` diff --git a/docs/reference/toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin.md b/docs/reference/toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin.md index 5f80ce76..3ab65ae9 100644 --- a/docs/reference/toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin.md +++ b/docs/reference/toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin.md @@ -1,7 +1,7 @@ # InfiniteOverlapParametersMixin -`toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin` +`toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/infinite_overlap.py#L6) -``` +```python InfiniteOverlapParametersMixin( self, infinite_overlap=None, @@ -24,7 +24,7 @@ Possible states: All other states are considered invalid -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin.unset_overlap.md b/docs/reference/toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin.unset_overlap.md index 4b246abb..f74bccda 100644 --- a/docs/reference/toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin.unset_overlap.md +++ b/docs/reference/toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin.unset_overlap.md @@ -1,7 +1,7 @@ # unset_overlap -`toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin.unset_overlap` +`toloka.client.primitives.infinite_overlap.InfiniteOverlapParametersMixin.unset_overlap` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/infinite_overlap.py#L38) -``` +```python unset_overlap(self) ``` diff --git a/docs/reference/toloka.client.primitives.operators.ComparableConditionMixin.md b/docs/reference/toloka.client.primitives.operators.ComparableConditionMixin.md index d437079c..d3314c1b 100644 --- a/docs/reference/toloka.client.primitives.operators.ComparableConditionMixin.md +++ b/docs/reference/toloka.client.primitives.operators.ComparableConditionMixin.md @@ -1,7 +1,7 @@ # ComparableConditionMixin -`toloka.client.primitives.operators.ComparableConditionMixin` +`toloka.client.primitives.operators.ComparableConditionMixin` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L141) -``` +```python ComparableConditionMixin(self, operator: CompareOperator) ``` diff --git a/docs/reference/toloka.client.primitives.operators.CompareOperator.md b/docs/reference/toloka.client.primitives.operators.CompareOperator.md index 1a08983c..6962a9b2 100644 --- a/docs/reference/toloka.client.primitives.operators.CompareOperator.md +++ b/docs/reference/toloka.client.primitives.operators.CompareOperator.md @@ -1,5 +1,5 @@ # CompareOperator -`toloka.client.primitives.operators.CompareOperator` +`toloka.client.primitives.operators.CompareOperator` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L21) An enumeration. diff --git a/docs/reference/toloka.client.primitives.operators.IdentityConditionMixin.md b/docs/reference/toloka.client.primitives.operators.IdentityConditionMixin.md index 1b3cde8e..adb5d4bc 100644 --- a/docs/reference/toloka.client.primitives.operators.IdentityConditionMixin.md +++ b/docs/reference/toloka.client.primitives.operators.IdentityConditionMixin.md @@ -1,7 +1,7 @@ # IdentityConditionMixin -`toloka.client.primitives.operators.IdentityConditionMixin` +`toloka.client.primitives.operators.IdentityConditionMixin` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L137) -``` +```python IdentityConditionMixin(self, operator: IdentityOperator) ``` diff --git a/docs/reference/toloka.client.primitives.operators.IdentityOperator.md b/docs/reference/toloka.client.primitives.operators.IdentityOperator.md index 4ad9765a..09c2ba41 100644 --- a/docs/reference/toloka.client.primitives.operators.IdentityOperator.md +++ b/docs/reference/toloka.client.primitives.operators.IdentityOperator.md @@ -1,5 +1,5 @@ # IdentityOperator -`toloka.client.primitives.operators.IdentityOperator` +`toloka.client.primitives.operators.IdentityOperator` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L37) An enumeration. diff --git a/docs/reference/toloka.client.primitives.operators.InclusionConditionMixin.md b/docs/reference/toloka.client.primitives.operators.InclusionConditionMixin.md index b67df656..52e64fd2 100644 --- a/docs/reference/toloka.client.primitives.operators.InclusionConditionMixin.md +++ b/docs/reference/toloka.client.primitives.operators.InclusionConditionMixin.md @@ -1,7 +1,7 @@ # InclusionConditionMixin -`toloka.client.primitives.operators.InclusionConditionMixin` +`toloka.client.primitives.operators.InclusionConditionMixin` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L133) -``` +```python InclusionConditionMixin(self, operator: InclusionOperator) ``` diff --git a/docs/reference/toloka.client.primitives.operators.InclusionOperator.md b/docs/reference/toloka.client.primitives.operators.InclusionOperator.md index 1c2966b8..13316c05 100644 --- a/docs/reference/toloka.client.primitives.operators.InclusionOperator.md +++ b/docs/reference/toloka.client.primitives.operators.InclusionOperator.md @@ -1,5 +1,5 @@ # InclusionOperator -`toloka.client.primitives.operators.InclusionOperator` +`toloka.client.primitives.operators.InclusionOperator` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L31) An enumeration. diff --git a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.eq.md b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.eq.md index 64059ca7..f713f496 100644 --- a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.eq.md +++ b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.eq.md @@ -1,7 +1,7 @@ # eq -`toloka.client.primitives.operators.StatefulComparableConditionMixin.eq` +`toloka.client.primitives.operators.StatefulComparableConditionMixin.eq` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L159) -``` +```python eq(self, value) ``` diff --git a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.gt.md b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.gt.md index 32045d95..22d61cae 100644 --- a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.gt.md +++ b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.gt.md @@ -1,7 +1,7 @@ # gt -`toloka.client.primitives.operators.StatefulComparableConditionMixin.gt` +`toloka.client.primitives.operators.StatefulComparableConditionMixin.gt` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L153) -``` +```python gt(self, value) ``` diff --git a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.gte.md b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.gte.md index 18a2b4a4..c3b4b40f 100644 --- a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.gte.md +++ b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.gte.md @@ -1,7 +1,7 @@ # gte -`toloka.client.primitives.operators.StatefulComparableConditionMixin.gte` +`toloka.client.primitives.operators.StatefulComparableConditionMixin.gte` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L156) -``` +```python gte(self, value) ``` diff --git a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.lt.md b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.lt.md index 8a95809e..f914d512 100644 --- a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.lt.md +++ b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.lt.md @@ -1,7 +1,7 @@ # lt -`toloka.client.primitives.operators.StatefulComparableConditionMixin.lt` +`toloka.client.primitives.operators.StatefulComparableConditionMixin.lt` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L147) -``` +```python lt(self, value) ``` diff --git a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.lte.md b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.lte.md index dde201c0..c9b1d085 100644 --- a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.lte.md +++ b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.lte.md @@ -1,7 +1,7 @@ # lte -`toloka.client.primitives.operators.StatefulComparableConditionMixin.lte` +`toloka.client.primitives.operators.StatefulComparableConditionMixin.lte` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L150) -``` +```python lte(self, value) ``` diff --git a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.md b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.md index 68f24490..c0a4427c 100644 --- a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.md +++ b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.md @@ -1,7 +1,7 @@ # StatefulComparableConditionMixin -`toloka.client.primitives.operators.StatefulComparableConditionMixin` +`toloka.client.primitives.operators.StatefulComparableConditionMixin` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L145) -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.ne.md b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.ne.md index 5a379e64..ce34948d 100644 --- a/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.ne.md +++ b/docs/reference/toloka.client.primitives.operators.StatefulComparableConditionMixin.ne.md @@ -1,7 +1,7 @@ # ne -`toloka.client.primitives.operators.StatefulComparableConditionMixin.ne` +`toloka.client.primitives.operators.StatefulComparableConditionMixin.ne` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/operators.py#L162) -``` +```python ne(self, value) ``` diff --git a/docs/reference/toloka.client.primitives.parameter.Parameters.md b/docs/reference/toloka.client.primitives.parameter.Parameters.md index 0d89db2e..ae58eccc 100644 --- a/docs/reference/toloka.client.primitives.parameter.Parameters.md +++ b/docs/reference/toloka.client.primitives.parameter.Parameters.md @@ -1,7 +1,7 @@ # Parameters -`toloka.client.primitives.parameter.Parameters` +`toloka.client.primitives.parameter.Parameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/parameter.py#L4) -``` +```python Parameters(self) ``` diff --git a/docs/reference/toloka.client.primitives.retry.PreloadingHTTPAdapter.build_response.md b/docs/reference/toloka.client.primitives.retry.PreloadingHTTPAdapter.build_response.md index d63ae17a..1220f2b9 100644 --- a/docs/reference/toloka.client.primitives.retry.PreloadingHTTPAdapter.build_response.md +++ b/docs/reference/toloka.client.primitives.retry.PreloadingHTTPAdapter.build_response.md @@ -1,7 +1,7 @@ # build_response -`toloka.client.primitives.retry.PreloadingHTTPAdapter.build_response` +`toloka.client.primitives.retry.PreloadingHTTPAdapter.build_response` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/retry.py#L112) -``` +```python build_response( self, req, diff --git a/docs/reference/toloka.client.primitives.retry.PreloadingHTTPAdapter.get_connection.md b/docs/reference/toloka.client.primitives.retry.PreloadingHTTPAdapter.get_connection.md index 146e336f..9d21f282 100644 --- a/docs/reference/toloka.client.primitives.retry.PreloadingHTTPAdapter.get_connection.md +++ b/docs/reference/toloka.client.primitives.retry.PreloadingHTTPAdapter.get_connection.md @@ -1,7 +1,7 @@ # get_connection -`toloka.client.primitives.retry.PreloadingHTTPAdapter.get_connection` +`toloka.client.primitives.retry.PreloadingHTTPAdapter.get_connection` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/retry.py#L117) -``` +```python get_connection( self, *args, diff --git a/docs/reference/toloka.client.primitives.retry.PreloadingHTTPAdapter.md b/docs/reference/toloka.client.primitives.retry.PreloadingHTTPAdapter.md index 41fded9e..9cbd59f8 100644 --- a/docs/reference/toloka.client.primitives.retry.PreloadingHTTPAdapter.md +++ b/docs/reference/toloka.client.primitives.retry.PreloadingHTTPAdapter.md @@ -1,5 +1,5 @@ # PreloadingHTTPAdapter -`toloka.client.primitives.retry.PreloadingHTTPAdapter` +`toloka.client.primitives.retry.PreloadingHTTPAdapter` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/retry.py#L88) HTTPAdapter subclass that forces preload_content=True during requests @@ -12,7 +12,7 @@ retrying failed body read can be achieved by passing preload_content=False to ur this using HTTPAdapter we need to use HTTP(S)ConnectionPool.urlopen with preload_content=True during send method and override build_response method to populate requests Response wrapper with content. -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.primitives.retry.TolokaRetry.Unit.md b/docs/reference/toloka.client.primitives.retry.TolokaRetry.Unit.md index 4e604503..10877be0 100644 --- a/docs/reference/toloka.client.primitives.retry.TolokaRetry.Unit.md +++ b/docs/reference/toloka.client.primitives.retry.TolokaRetry.Unit.md @@ -1,3 +1,3 @@ # Unit -`toloka.client.primitives.retry.TolokaRetry.Unit` +`toloka.client.primitives.retry.TolokaRetry.Unit` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/retry.py#L28) diff --git a/docs/reference/toloka.client.primitives.retry.TolokaRetry.get_retry_after.md b/docs/reference/toloka.client.primitives.retry.TolokaRetry.get_retry_after.md index 8c9620c9..49c0f9f7 100644 --- a/docs/reference/toloka.client.primitives.retry.TolokaRetry.get_retry_after.md +++ b/docs/reference/toloka.client.primitives.retry.TolokaRetry.get_retry_after.md @@ -1,7 +1,7 @@ # get_retry_after -`toloka.client.primitives.retry.TolokaRetry.get_retry_after` +`toloka.client.primitives.retry.TolokaRetry.get_retry_after` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/retry.py#L54) -``` +```python get_retry_after(self, response: HTTPResponse) ``` diff --git a/docs/reference/toloka.client.primitives.retry.TolokaRetry.increment.md b/docs/reference/toloka.client.primitives.retry.TolokaRetry.increment.md index 9a713806..8c0f8cf7 100644 --- a/docs/reference/toloka.client.primitives.retry.TolokaRetry.increment.md +++ b/docs/reference/toloka.client.primitives.retry.TolokaRetry.increment.md @@ -1,7 +1,7 @@ # increment -`toloka.client.primitives.retry.TolokaRetry.increment` +`toloka.client.primitives.retry.TolokaRetry.increment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/retry.py#L75) -``` +```python increment( self, *args, diff --git a/docs/reference/toloka.client.primitives.retry.TolokaRetry.md b/docs/reference/toloka.client.primitives.retry.TolokaRetry.md index d62aac59..07092a0d 100644 --- a/docs/reference/toloka.client.primitives.retry.TolokaRetry.md +++ b/docs/reference/toloka.client.primitives.retry.TolokaRetry.md @@ -1,7 +1,7 @@ # TolokaRetry -`toloka.client.primitives.retry.TolokaRetry` +`toloka.client.primitives.retry.TolokaRetry` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/retry.py#L17) -``` +```python TolokaRetry( self, *args, @@ -17,7 +17,7 @@ Retry toloka quotas. By default only minutes quotas. | Parameters | Type | Description | | :----------| :----| :-----------| `retry_quotas`|**Union\[List\[str\], str, None\]**|

List of quotas that will be retried. None or empty list for not retrying quotas. You can specify quotas:

-## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.primitives.retry.TolokaRetry.new.md b/docs/reference/toloka.client.primitives.retry.TolokaRetry.new.md index 0261db58..bb9212b4 100644 --- a/docs/reference/toloka.client.primitives.retry.TolokaRetry.new.md +++ b/docs/reference/toloka.client.primitives.retry.TolokaRetry.new.md @@ -1,7 +1,7 @@ # new -`toloka.client.primitives.retry.TolokaRetry.new` +`toloka.client.primitives.retry.TolokaRetry.new` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/primitives/retry.py#L50) -``` +```python new(self, **kwargs) ``` diff --git a/docs/reference/toloka.client.project.Project.AssignmentsIssuingType.md b/docs/reference/toloka.client.project.Project.AssignmentsIssuingType.md index a4d70505..53cd2718 100644 --- a/docs/reference/toloka.client.project.Project.AssignmentsIssuingType.md +++ b/docs/reference/toloka.client.project.Project.AssignmentsIssuingType.md @@ -1,5 +1,5 @@ # AssignmentsIssuingType -`toloka.client.project.Project.AssignmentsIssuingType` +`toloka.client.project.Project.AssignmentsIssuingType` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/__init__.py#L115) How to assign tasks: diff --git a/docs/reference/toloka.client.project.Project.AssignmentsIssuingViewConfig.MapProvider.md b/docs/reference/toloka.client.project.Project.AssignmentsIssuingViewConfig.MapProvider.md index 5f5003ea..ee7b7d80 100644 --- a/docs/reference/toloka.client.project.Project.AssignmentsIssuingViewConfig.MapProvider.md +++ b/docs/reference/toloka.client.project.Project.AssignmentsIssuingViewConfig.MapProvider.md @@ -1,5 +1,5 @@ # MapProvider -`toloka.client.project.Project.AssignmentsIssuingViewConfig.MapProvider` +`toloka.client.project.Project.AssignmentsIssuingViewConfig.MapProvider` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/__init__.py#L151) Map provider for assignments_issuing_view_config: diff --git a/docs/reference/toloka.client.project.Project.AssignmentsIssuingViewConfig.md b/docs/reference/toloka.client.project.Project.AssignmentsIssuingViewConfig.md index fafb1dc0..63277f12 100644 --- a/docs/reference/toloka.client.project.Project.AssignmentsIssuingViewConfig.md +++ b/docs/reference/toloka.client.project.Project.AssignmentsIssuingViewConfig.md @@ -1,7 +1,7 @@ # AssignmentsIssuingViewConfig -`toloka.client.project.Project.AssignmentsIssuingViewConfig` +`toloka.client.project.Project.AssignmentsIssuingViewConfig` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/__init__.py#L141) -``` +```python AssignmentsIssuingViewConfig( self, *, diff --git a/docs/reference/toloka.client.project.Project.ProjectStatus.md b/docs/reference/toloka.client.project.Project.ProjectStatus.md index 98646b3c..be0578d9 100644 --- a/docs/reference/toloka.client.project.Project.ProjectStatus.md +++ b/docs/reference/toloka.client.project.Project.ProjectStatus.md @@ -1,5 +1,5 @@ # ProjectStatus -`toloka.client.project.Project.ProjectStatus` +`toloka.client.project.Project.ProjectStatus` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/__init__.py#L129) Project status: diff --git a/docs/reference/toloka.client.project.Project.add_requester_translation.md b/docs/reference/toloka.client.project.Project.add_requester_translation.md index d12cf8ba..d7061a09 100644 --- a/docs/reference/toloka.client.project.Project.add_requester_translation.md +++ b/docs/reference/toloka.client.project.Project.add_requester_translation.md @@ -1,7 +1,7 @@ # add_requester_translation -`toloka.client.project.Project.add_requester_translation` +`toloka.client.project.Project.add_requester_translation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/__init__.py#L207) -``` +```python add_requester_translation( self, language: str, diff --git a/docs/reference/toloka.client.project.Project.md b/docs/reference/toloka.client.project.Project.md index 27834d39..662bda89 100644 --- a/docs/reference/toloka.client.project.Project.md +++ b/docs/reference/toloka.client.project.Project.md @@ -1,7 +1,7 @@ # Project -`toloka.client.project.Project` +`toloka.client.project.Project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/__init__.py#L63) -``` +```python Project( self, *, @@ -78,7 +78,7 @@ new_project = toloka.project.Project( new_project = toloka_client.create_project(new_project) print(new_project.id) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.project.Project.set_default_language.md b/docs/reference/toloka.client.project.Project.set_default_language.md index 17410176..19a2f921 100644 --- a/docs/reference/toloka.client.project.Project.set_default_language.md +++ b/docs/reference/toloka.client.project.Project.set_default_language.md @@ -1,7 +1,7 @@ # set_default_language -`toloka.client.project.Project.set_default_language` +`toloka.client.project.Project.set_default_language` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/__init__.py#L196) -``` +```python set_default_language(self, language: str) ``` diff --git a/docs/reference/toloka.client.project.field_spec.ArrayBooleanSpec.md b/docs/reference/toloka.client.project.field_spec.ArrayBooleanSpec.md index d50929be..1de39a6b 100644 --- a/docs/reference/toloka.client.project.field_spec.ArrayBooleanSpec.md +++ b/docs/reference/toloka.client.project.field_spec.ArrayBooleanSpec.md @@ -1,7 +1,7 @@ # ArrayBooleanSpec -`toloka.client.project.field_spec.ArrayBooleanSpec` +`toloka.client.project.field_spec.ArrayBooleanSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L141) -``` +```python ArrayBooleanSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.ArrayCoordinatesSpec.md b/docs/reference/toloka.client.project.field_spec.ArrayCoordinatesSpec.md index 929e75f4..b678b025 100644 --- a/docs/reference/toloka.client.project.field_spec.ArrayCoordinatesSpec.md +++ b/docs/reference/toloka.client.project.field_spec.ArrayCoordinatesSpec.md @@ -1,7 +1,7 @@ # ArrayCoordinatesSpec -`toloka.client.project.field_spec.ArrayCoordinatesSpec` +`toloka.client.project.field_spec.ArrayCoordinatesSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L213) -``` +```python ArrayCoordinatesSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.ArrayFileSpec.md b/docs/reference/toloka.client.project.field_spec.ArrayFileSpec.md index 79fd9d00..f4ef57dd 100644 --- a/docs/reference/toloka.client.project.field_spec.ArrayFileSpec.md +++ b/docs/reference/toloka.client.project.field_spec.ArrayFileSpec.md @@ -1,7 +1,7 @@ # ArrayFileSpec -`toloka.client.project.field_spec.ArrayFileSpec` +`toloka.client.project.field_spec.ArrayFileSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L201) -``` +```python ArrayFileSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.ArrayFloatSpec.md b/docs/reference/toloka.client.project.field_spec.ArrayFloatSpec.md index 00909da8..fea46a17 100644 --- a/docs/reference/toloka.client.project.field_spec.ArrayFloatSpec.md +++ b/docs/reference/toloka.client.project.field_spec.ArrayFloatSpec.md @@ -1,7 +1,7 @@ # ArrayFloatSpec -`toloka.client.project.field_spec.ArrayFloatSpec` +`toloka.client.project.field_spec.ArrayFloatSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L177) -``` +```python ArrayFloatSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.ArrayIntegerSpec.md b/docs/reference/toloka.client.project.field_spec.ArrayIntegerSpec.md index 4437a818..b04a4b0a 100644 --- a/docs/reference/toloka.client.project.field_spec.ArrayIntegerSpec.md +++ b/docs/reference/toloka.client.project.field_spec.ArrayIntegerSpec.md @@ -1,7 +1,7 @@ # ArrayIntegerSpec -`toloka.client.project.field_spec.ArrayIntegerSpec` +`toloka.client.project.field_spec.ArrayIntegerSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L165) -``` +```python ArrayIntegerSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.ArrayStringSpec.md b/docs/reference/toloka.client.project.field_spec.ArrayStringSpec.md index dd2625b6..cc7241ce 100644 --- a/docs/reference/toloka.client.project.field_spec.ArrayStringSpec.md +++ b/docs/reference/toloka.client.project.field_spec.ArrayStringSpec.md @@ -1,7 +1,7 @@ # ArrayStringSpec -`toloka.client.project.field_spec.ArrayStringSpec` +`toloka.client.project.field_spec.ArrayStringSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L153) -``` +```python ArrayStringSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.ArrayUrlSpec.md b/docs/reference/toloka.client.project.field_spec.ArrayUrlSpec.md index 33433e9c..81fcf667 100644 --- a/docs/reference/toloka.client.project.field_spec.ArrayUrlSpec.md +++ b/docs/reference/toloka.client.project.field_spec.ArrayUrlSpec.md @@ -1,7 +1,7 @@ # ArrayUrlSpec -`toloka.client.project.field_spec.ArrayUrlSpec` +`toloka.client.project.field_spec.ArrayUrlSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L189) -``` +```python ArrayUrlSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.BooleanSpec.md b/docs/reference/toloka.client.project.field_spec.BooleanSpec.md index 384e4a9e..544cabeb 100644 --- a/docs/reference/toloka.client.project.field_spec.BooleanSpec.md +++ b/docs/reference/toloka.client.project.field_spec.BooleanSpec.md @@ -1,7 +1,7 @@ # BooleanSpec -`toloka.client.project.field_spec.BooleanSpec` +`toloka.client.project.field_spec.BooleanSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L62) -``` +```python BooleanSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.CoordinatesSpec.md b/docs/reference/toloka.client.project.field_spec.CoordinatesSpec.md index d231853e..528c5fac 100644 --- a/docs/reference/toloka.client.project.field_spec.CoordinatesSpec.md +++ b/docs/reference/toloka.client.project.field_spec.CoordinatesSpec.md @@ -1,7 +1,7 @@ # CoordinatesSpec -`toloka.client.project.field_spec.CoordinatesSpec` +`toloka.client.project.field_spec.CoordinatesSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L124) -``` +```python CoordinatesSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.FieldSpec.md b/docs/reference/toloka.client.project.field_spec.FieldSpec.md index 764c8cb2..1b08a20e 100644 --- a/docs/reference/toloka.client.project.field_spec.FieldSpec.md +++ b/docs/reference/toloka.client.project.field_spec.FieldSpec.md @@ -1,7 +1,7 @@ # FieldSpec -`toloka.client.project.field_spec.FieldSpec` +`toloka.client.project.field_spec.FieldSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L48) -``` +```python FieldSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.FieldType.md b/docs/reference/toloka.client.project.field_spec.FieldType.md index 4bb0d656..ead7378d 100644 --- a/docs/reference/toloka.client.project.field_spec.FieldType.md +++ b/docs/reference/toloka.client.project.field_spec.FieldType.md @@ -1,5 +1,5 @@ # FieldType -`toloka.client.project.field_spec.FieldType` +`toloka.client.project.field_spec.FieldType` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L27) An enumeration. diff --git a/docs/reference/toloka.client.project.field_spec.FileSpec.md b/docs/reference/toloka.client.project.field_spec.FileSpec.md index 5def669c..3e82c731 100644 --- a/docs/reference/toloka.client.project.field_spec.FileSpec.md +++ b/docs/reference/toloka.client.project.field_spec.FileSpec.md @@ -1,7 +1,7 @@ # FileSpec -`toloka.client.project.field_spec.FileSpec` +`toloka.client.project.field_spec.FileSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L118) -``` +```python FileSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.FloatSpec.md b/docs/reference/toloka.client.project.field_spec.FloatSpec.md index 74a8b098..ce9ce834 100644 --- a/docs/reference/toloka.client.project.field_spec.FloatSpec.md +++ b/docs/reference/toloka.client.project.field_spec.FloatSpec.md @@ -1,7 +1,7 @@ # FloatSpec -`toloka.client.project.field_spec.FloatSpec` +`toloka.client.project.field_spec.FloatSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L100) -``` +```python FloatSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.IntegerSpec.md b/docs/reference/toloka.client.project.field_spec.IntegerSpec.md index bfa231b1..ea3f99b7 100644 --- a/docs/reference/toloka.client.project.field_spec.IntegerSpec.md +++ b/docs/reference/toloka.client.project.field_spec.IntegerSpec.md @@ -1,7 +1,7 @@ # IntegerSpec -`toloka.client.project.field_spec.IntegerSpec` +`toloka.client.project.field_spec.IntegerSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L86) -``` +```python IntegerSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.JsonSpec.md b/docs/reference/toloka.client.project.field_spec.JsonSpec.md index 1b9ba901..530a52ae 100644 --- a/docs/reference/toloka.client.project.field_spec.JsonSpec.md +++ b/docs/reference/toloka.client.project.field_spec.JsonSpec.md @@ -1,7 +1,7 @@ # JsonSpec -`toloka.client.project.field_spec.JsonSpec` +`toloka.client.project.field_spec.JsonSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L135) -``` +```python JsonSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.StringSpec.md b/docs/reference/toloka.client.project.field_spec.StringSpec.md index f962f073..7bf02bbf 100644 --- a/docs/reference/toloka.client.project.field_spec.StringSpec.md +++ b/docs/reference/toloka.client.project.field_spec.StringSpec.md @@ -1,7 +1,7 @@ # StringSpec -`toloka.client.project.field_spec.StringSpec` +`toloka.client.project.field_spec.StringSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L72) -``` +```python StringSpec( self, *, diff --git a/docs/reference/toloka.client.project.field_spec.UrlSpec.md b/docs/reference/toloka.client.project.field_spec.UrlSpec.md index 1db18612..f1bbec1c 100644 --- a/docs/reference/toloka.client.project.field_spec.UrlSpec.md +++ b/docs/reference/toloka.client.project.field_spec.UrlSpec.md @@ -1,7 +1,7 @@ # UrlSpec -`toloka.client.project.field_spec.UrlSpec` +`toloka.client.project.field_spec.UrlSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/field_spec.py#L112) -``` +```python UrlSpec( self, *, diff --git a/docs/reference/toloka.client.project.localization.AdditionalLanguage.FieldTranslation.Source.md b/docs/reference/toloka.client.project.localization.AdditionalLanguage.FieldTranslation.Source.md index 74d143c3..d5115383 100644 --- a/docs/reference/toloka.client.project.localization.AdditionalLanguage.FieldTranslation.Source.md +++ b/docs/reference/toloka.client.project.localization.AdditionalLanguage.FieldTranslation.Source.md @@ -1,5 +1,5 @@ # Source -`toloka.client.project.localization.AdditionalLanguage.FieldTranslation.Source` +`toloka.client.project.localization.AdditionalLanguage.FieldTranslation.Source` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/localization.py#L29) Possible values of sources diff --git a/docs/reference/toloka.client.project.localization.AdditionalLanguage.FieldTranslation.md b/docs/reference/toloka.client.project.localization.AdditionalLanguage.FieldTranslation.md index 2b0573be..f681369e 100644 --- a/docs/reference/toloka.client.project.localization.AdditionalLanguage.FieldTranslation.md +++ b/docs/reference/toloka.client.project.localization.AdditionalLanguage.FieldTranslation.md @@ -1,7 +1,7 @@ # FieldTranslation -`toloka.client.project.localization.AdditionalLanguage.FieldTranslation` +`toloka.client.project.localization.AdditionalLanguage.FieldTranslation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/localization.py#L21) -``` +```python FieldTranslation( self, *, diff --git a/docs/reference/toloka.client.project.localization.AdditionalLanguage.md b/docs/reference/toloka.client.project.localization.AdditionalLanguage.md index baa8b343..c4ec0228 100644 --- a/docs/reference/toloka.client.project.localization.AdditionalLanguage.md +++ b/docs/reference/toloka.client.project.localization.AdditionalLanguage.md @@ -1,7 +1,7 @@ # AdditionalLanguage -`toloka.client.project.localization.AdditionalLanguage` +`toloka.client.project.localization.AdditionalLanguage` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/localization.py#L11) -``` +```python AdditionalLanguage( self, *, diff --git a/docs/reference/toloka.client.project.localization.LocalizationConfig.md b/docs/reference/toloka.client.project.localization.LocalizationConfig.md index c73849c9..7a958482 100644 --- a/docs/reference/toloka.client.project.localization.LocalizationConfig.md +++ b/docs/reference/toloka.client.project.localization.LocalizationConfig.md @@ -1,7 +1,7 @@ # LocalizationConfig -`toloka.client.project.localization.LocalizationConfig` +`toloka.client.project.localization.LocalizationConfig` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/localization.py#L47) -``` +```python LocalizationConfig( self, *, diff --git a/docs/reference/toloka.client.project.task_spec.TaskSpec.md b/docs/reference/toloka.client.project.task_spec.TaskSpec.md index 947ac25d..7d8b8a7b 100644 --- a/docs/reference/toloka.client.project.task_spec.TaskSpec.md +++ b/docs/reference/toloka.client.project.task_spec.TaskSpec.md @@ -1,7 +1,7 @@ # TaskSpec -`toloka.client.project.task_spec.TaskSpec` +`toloka.client.project.task_spec.TaskSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/task_spec.py#L8) -``` +```python TaskSpec( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.TemplateBuilder.md b/docs/reference/toloka.client.project.template_builder.TemplateBuilder.md index f93c22db..0d4bad72 100644 --- a/docs/reference/toloka.client.project.template_builder.TemplateBuilder.md +++ b/docs/reference/toloka.client.project.template_builder.TemplateBuilder.md @@ -1,7 +1,7 @@ # TemplateBuilder -`toloka.client.project.template_builder.TemplateBuilder` +`toloka.client.project.template_builder.TemplateBuilder` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/__init__.py#L222) -``` +```python TemplateBuilder( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.actions.BaseActionV1.md b/docs/reference/toloka.client.project.template_builder.actions.BaseActionV1.md index 0a150489..4a2656db 100644 --- a/docs/reference/toloka.client.project.template_builder.actions.BaseActionV1.md +++ b/docs/reference/toloka.client.project.template_builder.actions.BaseActionV1.md @@ -1,7 +1,7 @@ # BaseActionV1 -`toloka.client.project.template_builder.actions.BaseActionV1` +`toloka.client.project.template_builder.actions.BaseActionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/actions.py#L26) -``` +```python BaseActionV1(self, *, version: Optional[str] = '1.0.0') ``` diff --git a/docs/reference/toloka.client.project.template_builder.actions.BulkActionV1.md b/docs/reference/toloka.client.project.template_builder.actions.BulkActionV1.md index 8dfc3e4c..271c572e 100644 --- a/docs/reference/toloka.client.project.template_builder.actions.BulkActionV1.md +++ b/docs/reference/toloka.client.project.template_builder.actions.BulkActionV1.md @@ -1,7 +1,7 @@ # BulkActionV1 -`toloka.client.project.template_builder.actions.BulkActionV1` +`toloka.client.project.template_builder.actions.BulkActionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/actions.py#L34) -``` +```python BulkActionV1( self, payload: Optional[Union[BaseComponent, List[BaseComponent]]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.actions.NotifyActionV1.Payload.Theme.md b/docs/reference/toloka.client.project.template_builder.actions.NotifyActionV1.Payload.Theme.md index 13b206b8..32922a8c 100644 --- a/docs/reference/toloka.client.project.template_builder.actions.NotifyActionV1.Payload.Theme.md +++ b/docs/reference/toloka.client.project.template_builder.actions.NotifyActionV1.Payload.Theme.md @@ -1,5 +1,5 @@ # Theme -`toloka.client.project.template_builder.actions.NotifyActionV1.Payload.Theme` +`toloka.client.project.template_builder.actions.NotifyActionV1.Payload.Theme` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/actions.py#L67) The background color of the message. diff --git a/docs/reference/toloka.client.project.template_builder.actions.NotifyActionV1.Payload.md b/docs/reference/toloka.client.project.template_builder.actions.NotifyActionV1.Payload.md index 503852ab..0ba797f9 100644 --- a/docs/reference/toloka.client.project.template_builder.actions.NotifyActionV1.Payload.md +++ b/docs/reference/toloka.client.project.template_builder.actions.NotifyActionV1.Payload.md @@ -1,7 +1,7 @@ # Payload -`toloka.client.project.template_builder.actions.NotifyActionV1.Payload` +`toloka.client.project.template_builder.actions.NotifyActionV1.Payload` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/actions.py#L54) -``` +```python Payload( self, content: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.actions.NotifyActionV1.md b/docs/reference/toloka.client.project.template_builder.actions.NotifyActionV1.md index f2d510e3..ef357912 100644 --- a/docs/reference/toloka.client.project.template_builder.actions.NotifyActionV1.md +++ b/docs/reference/toloka.client.project.template_builder.actions.NotifyActionV1.md @@ -1,7 +1,7 @@ # NotifyActionV1 -`toloka.client.project.template_builder.actions.NotifyActionV1` +`toloka.client.project.template_builder.actions.NotifyActionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/actions.py#L46) -``` +```python NotifyActionV1( self, payload: Optional[Union[BaseComponent, Payload]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.actions.OpenCloseActionV1.md b/docs/reference/toloka.client.project.template_builder.actions.OpenCloseActionV1.md index ee96430d..1697f9e9 100644 --- a/docs/reference/toloka.client.project.template_builder.actions.OpenCloseActionV1.md +++ b/docs/reference/toloka.client.project.template_builder.actions.OpenCloseActionV1.md @@ -1,7 +1,7 @@ # OpenCloseActionV1 -`toloka.client.project.template_builder.actions.OpenCloseActionV1` +`toloka.client.project.template_builder.actions.OpenCloseActionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/actions.py#L91) -``` +```python OpenCloseActionV1( self, view: Optional[Union[BaseComponent, RefComponent]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.actions.OpenLinkActionV1.md b/docs/reference/toloka.client.project.template_builder.actions.OpenLinkActionV1.md index e69a1579..60d5e7b6 100644 --- a/docs/reference/toloka.client.project.template_builder.actions.OpenLinkActionV1.md +++ b/docs/reference/toloka.client.project.template_builder.actions.OpenLinkActionV1.md @@ -1,7 +1,7 @@ # OpenLinkActionV1 -`toloka.client.project.template_builder.actions.OpenLinkActionV1` +`toloka.client.project.template_builder.actions.OpenLinkActionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/actions.py#L104) -``` +```python OpenLinkActionV1( self, payload: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.actions.PlayPauseActionV1.md b/docs/reference/toloka.client.project.template_builder.actions.PlayPauseActionV1.md index 0a51dbf0..1dedba0e 100644 --- a/docs/reference/toloka.client.project.template_builder.actions.PlayPauseActionV1.md +++ b/docs/reference/toloka.client.project.template_builder.actions.PlayPauseActionV1.md @@ -1,7 +1,7 @@ # PlayPauseActionV1 -`toloka.client.project.template_builder.actions.PlayPauseActionV1` +`toloka.client.project.template_builder.actions.PlayPauseActionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/actions.py#L115) -``` +```python PlayPauseActionV1( self, view: Optional[Union[BaseComponent, RefComponent]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.actions.RotateActionV1.Payload.md b/docs/reference/toloka.client.project.template_builder.actions.RotateActionV1.Payload.md index ce8f3e41..c95943a4 100644 --- a/docs/reference/toloka.client.project.template_builder.actions.RotateActionV1.Payload.md +++ b/docs/reference/toloka.client.project.template_builder.actions.RotateActionV1.Payload.md @@ -1,5 +1,5 @@ # Payload -`toloka.client.project.template_builder.actions.RotateActionV1.Payload` +`toloka.client.project.template_builder.actions.RotateActionV1.Payload` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/actions.py#L137) An enumeration. diff --git a/docs/reference/toloka.client.project.template_builder.actions.RotateActionV1.md b/docs/reference/toloka.client.project.template_builder.actions.RotateActionV1.md index 83c6ad54..dd7703d6 100644 --- a/docs/reference/toloka.client.project.template_builder.actions.RotateActionV1.md +++ b/docs/reference/toloka.client.project.template_builder.actions.RotateActionV1.md @@ -1,7 +1,7 @@ # RotateActionV1 -`toloka.client.project.template_builder.actions.RotateActionV1` +`toloka.client.project.template_builder.actions.RotateActionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/actions.py#L128) -``` +```python RotateActionV1( self, view: Optional[Union[BaseComponent, RefComponent]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.actions.SetActionV1.md b/docs/reference/toloka.client.project.template_builder.actions.SetActionV1.md index 9629fd11..23a79176 100644 --- a/docs/reference/toloka.client.project.template_builder.actions.SetActionV1.md +++ b/docs/reference/toloka.client.project.template_builder.actions.SetActionV1.md @@ -1,7 +1,7 @@ # SetActionV1 -`toloka.client.project.template_builder.actions.SetActionV1` +`toloka.client.project.template_builder.actions.SetActionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/actions.py#L146) -``` +```python SetActionV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.actions.ToggleActionV1.md b/docs/reference/toloka.client.project.template_builder.actions.ToggleActionV1.md index 094eeec6..58fbb9f7 100644 --- a/docs/reference/toloka.client.project.template_builder.actions.ToggleActionV1.md +++ b/docs/reference/toloka.client.project.template_builder.actions.ToggleActionV1.md @@ -1,7 +1,7 @@ # ToggleActionV1 -`toloka.client.project.template_builder.actions.ToggleActionV1` +`toloka.client.project.template_builder.actions.ToggleActionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/actions.py#L158) -``` +```python ToggleActionV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.base.BaseComponent.md b/docs/reference/toloka.client.project.template_builder.base.BaseComponent.md index 3b91b5d7..0caad9dc 100644 --- a/docs/reference/toloka.client.project.template_builder.base.BaseComponent.md +++ b/docs/reference/toloka.client.project.template_builder.base.BaseComponent.md @@ -1,7 +1,7 @@ # BaseComponent -`toloka.client.project.template_builder.base.BaseComponent` +`toloka.client.project.template_builder.base.BaseComponent` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/base.py#L126) -``` +```python BaseComponent(self) ``` diff --git a/docs/reference/toloka.client.project.template_builder.base.BaseComponentOr.md b/docs/reference/toloka.client.project.template_builder.base.BaseComponentOr.md index fc93fdb6..8d1f31af 100644 --- a/docs/reference/toloka.client.project.template_builder.base.BaseComponentOr.md +++ b/docs/reference/toloka.client.project.template_builder.base.BaseComponentOr.md @@ -1,7 +1,7 @@ # BaseComponentOr -`toloka.client.project.template_builder.base.BaseComponentOr` +`toloka.client.project.template_builder.base.BaseComponentOr` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/base.py#L139) -``` +```python BaseComponentOr(self) ``` diff --git a/docs/reference/toloka.client.project.template_builder.base.BaseTemplate.md b/docs/reference/toloka.client.project.template_builder.base.BaseTemplate.md index f573f46e..f11fc014 100644 --- a/docs/reference/toloka.client.project.template_builder.base.BaseTemplate.md +++ b/docs/reference/toloka.client.project.template_builder.base.BaseTemplate.md @@ -1,7 +1,7 @@ # BaseTemplate -`toloka.client.project.template_builder.base.BaseTemplate` +`toloka.client.project.template_builder.base.BaseTemplate` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/base.py#L117) -``` +```python BaseTemplate(self) ``` diff --git a/docs/reference/toloka.client.project.template_builder.base.BaseTemplateMetaclass.md b/docs/reference/toloka.client.project.template_builder.base.BaseTemplateMetaclass.md index 631b56a5..46edaa28 100644 --- a/docs/reference/toloka.client.project.template_builder.base.BaseTemplateMetaclass.md +++ b/docs/reference/toloka.client.project.template_builder.base.BaseTemplateMetaclass.md @@ -1,3 +1,3 @@ # BaseTemplateMetaclass -`toloka.client.project.template_builder.base.BaseTemplateMetaclass` +`toloka.client.project.template_builder.base.BaseTemplateMetaclass` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/base.py#L112) diff --git a/docs/reference/toloka.client.project.template_builder.base.ComponentType.md b/docs/reference/toloka.client.project.template_builder.base.ComponentType.md index dccc0fe1..bf4a5357 100644 --- a/docs/reference/toloka.client.project.template_builder.base.ComponentType.md +++ b/docs/reference/toloka.client.project.template_builder.base.ComponentType.md @@ -1,5 +1,5 @@ # ComponentType -`toloka.client.project.template_builder.base.ComponentType` +`toloka.client.project.template_builder.base.ComponentType` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/base.py#L24) An enumeration. @@ -87,6 +87,7 @@ An enumeration. `VIEW_LINK`|'view.link'|

`VIEW_LINK_GROUP`|'view.link-group'|

`VIEW_LIST`|'view.list'|

+`VIEW_MAP`|'view.map'|

`VIEW_MARKDOWN`|'view.markdown'|

`VIEW_TEXT`|'view.text'|

`VIEW_VIDEO`|'view.video'|

diff --git a/docs/reference/toloka.client.project.template_builder.base.ListDirection.md b/docs/reference/toloka.client.project.template_builder.base.ListDirection.md index bce64d19..0839d926 100644 --- a/docs/reference/toloka.client.project.template_builder.base.ListDirection.md +++ b/docs/reference/toloka.client.project.template_builder.base.ListDirection.md @@ -1,5 +1,5 @@ # ListDirection -`toloka.client.project.template_builder.base.ListDirection` +`toloka.client.project.template_builder.base.ListDirection` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/base.py#L206) An enumeration. diff --git a/docs/reference/toloka.client.project.template_builder.base.ListSize.md b/docs/reference/toloka.client.project.template_builder.base.ListSize.md index 691f5b16..dd793804 100644 --- a/docs/reference/toloka.client.project.template_builder.base.ListSize.md +++ b/docs/reference/toloka.client.project.template_builder.base.ListSize.md @@ -1,5 +1,5 @@ # ListSize -`toloka.client.project.template_builder.base.ListSize` +`toloka.client.project.template_builder.base.ListSize` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/base.py#L212) An enumeration. diff --git a/docs/reference/toloka.client.project.template_builder.base.RefComponent.md b/docs/reference/toloka.client.project.template_builder.base.RefComponent.md index 4ed61693..086bbf5c 100644 --- a/docs/reference/toloka.client.project.template_builder.base.RefComponent.md +++ b/docs/reference/toloka.client.project.template_builder.base.RefComponent.md @@ -1,7 +1,7 @@ # RefComponent -`toloka.client.project.template_builder.base.RefComponent` +`toloka.client.project.template_builder.base.RefComponent` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/base.py#L191) -``` +```python RefComponent(self, ref: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.project.template_builder.base.UnknownComponent.md b/docs/reference/toloka.client.project.template_builder.base.UnknownComponent.md index 4103bc6e..502a9c4a 100644 --- a/docs/reference/toloka.client.project.template_builder.base.UnknownComponent.md +++ b/docs/reference/toloka.client.project.template_builder.base.UnknownComponent.md @@ -1,7 +1,7 @@ # UnknownComponent -`toloka.client.project.template_builder.base.UnknownComponent` +`toloka.client.project.template_builder.base.UnknownComponent` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/base.py#L187) -``` +```python UnknownComponent(self) ``` diff --git a/docs/reference/toloka.client.project.template_builder.base.VersionedBaseComponentMetaclass.md b/docs/reference/toloka.client.project.template_builder.base.VersionedBaseComponentMetaclass.md index c390c204..cc659570 100644 --- a/docs/reference/toloka.client.project.template_builder.base.VersionedBaseComponentMetaclass.md +++ b/docs/reference/toloka.client.project.template_builder.base.VersionedBaseComponentMetaclass.md @@ -1,3 +1,3 @@ # VersionedBaseComponentMetaclass -`toloka.client.project.template_builder.base.VersionedBaseComponentMetaclass` +`toloka.client.project.template_builder.base.VersionedBaseComponentMetaclass` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/base.py#L168) diff --git a/docs/reference/toloka.client.project.template_builder.base.base_component_or.md b/docs/reference/toloka.client.project.template_builder.base.base_component_or.md index 2d631a23..a3f2b538 100644 --- a/docs/reference/toloka.client.project.template_builder.base.base_component_or.md +++ b/docs/reference/toloka.client.project.template_builder.base.base_component_or.md @@ -1,7 +1,7 @@ # base_component_or -`toloka.client.project.template_builder.base.base_component_or` +`toloka.client.project.template_builder.base.base_component_or` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/base.py#L153) -``` +```python base_component_or(type_: Type, class_name_suffix: Optional[str] = None) ``` diff --git a/docs/reference/toloka.client.project.template_builder.conditions.AllConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.AllConditionV1.md index bad71c08..9e6eec02 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.AllConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.AllConditionV1.md @@ -1,7 +1,7 @@ # AllConditionV1 -`toloka.client.project.template_builder.conditions.AllConditionV1` +`toloka.client.project.template_builder.conditions.AllConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L45) -``` +```python AllConditionV1( self, conditions: Optional[Union[BaseComponent, List[BaseComponent]]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.AnyConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.AnyConditionV1.md index 48e7823c..079202fb 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.AnyConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.AnyConditionV1.md @@ -1,7 +1,7 @@ # AnyConditionV1 -`toloka.client.project.template_builder.conditions.AnyConditionV1` +`toloka.client.project.template_builder.conditions.AnyConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L79) -``` +```python AnyConditionV1( self, conditions: Optional[Union[BaseComponent, List[BaseComponent]]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.BaseConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.BaseConditionV1.md index a48eb59f..92375138 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.BaseConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.BaseConditionV1.md @@ -1,7 +1,7 @@ # BaseConditionV1 -`toloka.client.project.template_builder.conditions.BaseConditionV1` +`toloka.client.project.template_builder.conditions.BaseConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L33) -``` +```python BaseConditionV1( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.DistanceConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.DistanceConditionV1.md index a2cde0d8..fc1685be 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.DistanceConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.DistanceConditionV1.md @@ -1,7 +1,7 @@ # DistanceConditionV1 -`toloka.client.project.template_builder.conditions.DistanceConditionV1` +`toloka.client.project.template_builder.conditions.DistanceConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L93) -``` +```python DistanceConditionV1( self, from_: Optional[Union[BaseComponent, str]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.EmptyConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.EmptyConditionV1.md index f3bb55b9..3a0641cd 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.EmptyConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.EmptyConditionV1.md @@ -1,7 +1,7 @@ # EmptyConditionV1 -`toloka.client.project.template_builder.conditions.EmptyConditionV1` +`toloka.client.project.template_builder.conditions.EmptyConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L122) -``` +```python EmptyConditionV1( self, data: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.EqualsConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.EqualsConditionV1.md index eade3121..ef16bf81 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.EqualsConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.EqualsConditionV1.md @@ -1,7 +1,7 @@ # EqualsConditionV1 -`toloka.client.project.template_builder.conditions.EqualsConditionV1` +`toloka.client.project.template_builder.conditions.EqualsConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L138) -``` +```python EqualsConditionV1( self, to: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.LinkOpenedConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.LinkOpenedConditionV1.md index 6bca2cc6..e64fa2a8 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.LinkOpenedConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.LinkOpenedConditionV1.md @@ -1,7 +1,7 @@ # LinkOpenedConditionV1 -`toloka.client.project.template_builder.conditions.LinkOpenedConditionV1` +`toloka.client.project.template_builder.conditions.LinkOpenedConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L166) -``` +```python LinkOpenedConditionV1( self, url: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.NotConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.NotConditionV1.md index 7be65be1..428f750b 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.NotConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.NotConditionV1.md @@ -1,7 +1,7 @@ # NotConditionV1 -`toloka.client.project.template_builder.conditions.NotConditionV1` +`toloka.client.project.template_builder.conditions.NotConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L181) -``` +```python NotConditionV1( self, condition: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.PlayedConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.PlayedConditionV1.md index 6c4a2f0d..2b53c96c 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.PlayedConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.PlayedConditionV1.md @@ -1,7 +1,7 @@ # PlayedConditionV1 -`toloka.client.project.template_builder.conditions.PlayedConditionV1` +`toloka.client.project.template_builder.conditions.PlayedConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L193) -``` +```python PlayedConditionV1( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.PlayedFullyConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.PlayedFullyConditionV1.md index 93d4d154..13f6fef5 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.PlayedFullyConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.PlayedFullyConditionV1.md @@ -1,7 +1,7 @@ # PlayedFullyConditionV1 -`toloka.client.project.template_builder.conditions.PlayedFullyConditionV1` +`toloka.client.project.template_builder.conditions.PlayedFullyConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L204) -``` +```python PlayedFullyConditionV1( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.RequiredConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.RequiredConditionV1.md index 4492e4fa..a28ca4a6 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.RequiredConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.RequiredConditionV1.md @@ -1,7 +1,7 @@ # RequiredConditionV1 -`toloka.client.project.template_builder.conditions.RequiredConditionV1` +`toloka.client.project.template_builder.conditions.RequiredConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L215) -``` +```python RequiredConditionV1( self, data: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.SameDomainConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.SameDomainConditionV1.md index 16a87a36..3fb2a414 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.SameDomainConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.SameDomainConditionV1.md @@ -1,7 +1,7 @@ # SameDomainConditionV1 -`toloka.client.project.template_builder.conditions.SameDomainConditionV1` +`toloka.client.project.template_builder.conditions.SameDomainConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L239) -``` +```python SameDomainConditionV1( self, data: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.SchemaConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.SchemaConditionV1.md index c459caa3..f96eed89 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.SchemaConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.SchemaConditionV1.md @@ -1,7 +1,7 @@ # SchemaConditionV1 -`toloka.client.project.template_builder.conditions.SchemaConditionV1` +`toloka.client.project.template_builder.conditions.SchemaConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L265) -``` +```python SchemaConditionV1( self, data: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.conditions.SubArrayConditionV1.md b/docs/reference/toloka.client.project.template_builder.conditions.SubArrayConditionV1.md index abcd1765..29cd5f82 100644 --- a/docs/reference/toloka.client.project.template_builder.conditions.SubArrayConditionV1.md +++ b/docs/reference/toloka.client.project.template_builder.conditions.SubArrayConditionV1.md @@ -1,7 +1,7 @@ # SubArrayConditionV1 -`toloka.client.project.template_builder.conditions.SubArrayConditionV1` +`toloka.client.project.template_builder.conditions.SubArrayConditionV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/conditions.py#L284) -``` +```python SubArrayConditionV1( self, data: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.data.BaseData.md b/docs/reference/toloka.client.project.template_builder.data.BaseData.md index bd14a7b1..d8f6bcf6 100644 --- a/docs/reference/toloka.client.project.template_builder.data.BaseData.md +++ b/docs/reference/toloka.client.project.template_builder.data.BaseData.md @@ -1,7 +1,7 @@ # BaseData -`toloka.client.project.template_builder.data.BaseData` +`toloka.client.project.template_builder.data.BaseData` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/data.py#L29) -``` +```python BaseData( self, path: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.data.InputData.md b/docs/reference/toloka.client.project.template_builder.data.InputData.md index c0f06799..959d2a99 100644 --- a/docs/reference/toloka.client.project.template_builder.data.InputData.md +++ b/docs/reference/toloka.client.project.template_builder.data.InputData.md @@ -1,7 +1,7 @@ # InputData -`toloka.client.project.template_builder.data.InputData` +`toloka.client.project.template_builder.data.InputData` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/data.py#L42) -``` +```python InputData( self, path: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.data.InternalData.md b/docs/reference/toloka.client.project.template_builder.data.InternalData.md index 2a80715d..89b6f81c 100644 --- a/docs/reference/toloka.client.project.template_builder.data.InternalData.md +++ b/docs/reference/toloka.client.project.template_builder.data.InternalData.md @@ -1,7 +1,7 @@ # InternalData -`toloka.client.project.template_builder.data.InternalData` +`toloka.client.project.template_builder.data.InternalData` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/data.py#L53) -``` +```python InternalData( self, path: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.data.LocalData.md b/docs/reference/toloka.client.project.template_builder.data.LocalData.md index 67c3ab16..3702dd46 100644 --- a/docs/reference/toloka.client.project.template_builder.data.LocalData.md +++ b/docs/reference/toloka.client.project.template_builder.data.LocalData.md @@ -1,7 +1,7 @@ # LocalData -`toloka.client.project.template_builder.data.LocalData` +`toloka.client.project.template_builder.data.LocalData` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/data.py#L63) -``` +```python LocalData( self, path: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.data.LocationData.md b/docs/reference/toloka.client.project.template_builder.data.LocationData.md index 793be06e..9c105551 100644 --- a/docs/reference/toloka.client.project.template_builder.data.LocationData.md +++ b/docs/reference/toloka.client.project.template_builder.data.LocationData.md @@ -1,7 +1,7 @@ # LocationData -`toloka.client.project.template_builder.data.LocationData` +`toloka.client.project.template_builder.data.LocationData` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/data.py#L73) -``` +```python LocationData(self) ``` diff --git a/docs/reference/toloka.client.project.template_builder.data.OutputData.md b/docs/reference/toloka.client.project.template_builder.data.OutputData.md index 22256ef1..34627c78 100644 --- a/docs/reference/toloka.client.project.template_builder.data.OutputData.md +++ b/docs/reference/toloka.client.project.template_builder.data.OutputData.md @@ -1,7 +1,7 @@ # OutputData -`toloka.client.project.template_builder.data.OutputData` +`toloka.client.project.template_builder.data.OutputData` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/data.py#L82) -``` +```python OutputData( self, path: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.data.RelativeData.md b/docs/reference/toloka.client.project.template_builder.data.RelativeData.md index 5878f663..697aaa36 100644 --- a/docs/reference/toloka.client.project.template_builder.data.RelativeData.md +++ b/docs/reference/toloka.client.project.template_builder.data.RelativeData.md @@ -1,7 +1,7 @@ # RelativeData -`toloka.client.project.template_builder.data.RelativeData` +`toloka.client.project.template_builder.data.RelativeData` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/data.py#L92) -``` +```python RelativeData( self, path: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.AudioFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.AudioFieldV1.md index 746e5d5a..9fdb7599 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.AudioFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.AudioFieldV1.md @@ -1,7 +1,7 @@ # AudioFieldV1 -`toloka.client.project.template_builder.fields.AudioFieldV1` +`toloka.client.project.template_builder.fields.AudioFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L72) -``` +```python AudioFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.BaseFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.BaseFieldV1.md index a04f0b03..d7818605 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.BaseFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.BaseFieldV1.md @@ -1,7 +1,7 @@ # BaseFieldV1 -`toloka.client.project.template_builder.fields.BaseFieldV1` +`toloka.client.project.template_builder.fields.BaseFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L59) -``` +```python BaseFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.ButtonRadioFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.ButtonRadioFieldV1.md index c438bef6..b03a0a30 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.ButtonRadioFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.ButtonRadioFieldV1.md @@ -1,7 +1,7 @@ # ButtonRadioFieldV1 -`toloka.client.project.template_builder.fields.ButtonRadioFieldV1` +`toloka.client.project.template_builder.fields.ButtonRadioFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L87) -``` +```python ButtonRadioFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.ButtonRadioGroupFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.ButtonRadioGroupFieldV1.md index fcd689f9..6339438e 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.ButtonRadioGroupFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.ButtonRadioGroupFieldV1.md @@ -1,7 +1,7 @@ # ButtonRadioGroupFieldV1 -`toloka.client.project.template_builder.fields.ButtonRadioGroupFieldV1` +`toloka.client.project.template_builder.fields.ButtonRadioGroupFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L115) -``` +```python ButtonRadioGroupFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.CheckboxFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.CheckboxFieldV1.md index fdda749e..096cca1e 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.CheckboxFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.CheckboxFieldV1.md @@ -1,7 +1,7 @@ # CheckboxFieldV1 -`toloka.client.project.template_builder.fields.CheckboxFieldV1` +`toloka.client.project.template_builder.fields.CheckboxFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L142) -``` +```python CheckboxFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.CheckboxGroupFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.CheckboxGroupFieldV1.md index 500639c4..94001e19 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.CheckboxGroupFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.CheckboxGroupFieldV1.md @@ -1,7 +1,7 @@ # CheckboxGroupFieldV1 -`toloka.client.project.template_builder.fields.CheckboxGroupFieldV1` +`toloka.client.project.template_builder.fields.CheckboxGroupFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L157) -``` +```python CheckboxGroupFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.DateFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.DateFieldV1.md index c9b915b3..492f7e40 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.DateFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.DateFieldV1.md @@ -1,7 +1,7 @@ # DateFieldV1 -`toloka.client.project.template_builder.fields.DateFieldV1` +`toloka.client.project.template_builder.fields.DateFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L174) -``` +```python DateFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.EmailFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.EmailFieldV1.md index 22726d45..273be362 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.EmailFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.EmailFieldV1.md @@ -1,7 +1,7 @@ # EmailFieldV1 -`toloka.client.project.template_builder.fields.EmailFieldV1` +`toloka.client.project.template_builder.fields.EmailFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L214) -``` +```python EmailFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.FileFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.FileFieldV1.md index 36756940..26331511 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.FileFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.FileFieldV1.md @@ -1,7 +1,7 @@ # FileFieldV1 -`toloka.client.project.template_builder.fields.FileFieldV1` +`toloka.client.project.template_builder.fields.FileFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L226) -``` +```python FileFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.GroupFieldOption.md b/docs/reference/toloka.client.project.template_builder.fields.GroupFieldOption.md index 0856d6d8..b76076b1 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.GroupFieldOption.md +++ b/docs/reference/toloka.client.project.template_builder.fields.GroupFieldOption.md @@ -1,7 +1,7 @@ # GroupFieldOption -`toloka.client.project.template_builder.fields.GroupFieldOption` +`toloka.client.project.template_builder.fields.GroupFieldOption` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L101) -``` +```python GroupFieldOption( self, value: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Label.md b/docs/reference/toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Label.md index a2f82012..f7ba524e 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Label.md +++ b/docs/reference/toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Label.md @@ -1,7 +1,7 @@ # Label -`toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Label` +`toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Label` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L278) -``` +```python Label( self, label: Optional[Union[BaseComponent, str]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Shape.md b/docs/reference/toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Shape.md index 4a86b63a..142d926c 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Shape.md +++ b/docs/reference/toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Shape.md @@ -1,5 +1,5 @@ # Shape -`toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Shape` +`toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.Shape` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L290) An enumeration. diff --git a/docs/reference/toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.md index 8439e07b..8d3f710d 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.ImageAnnotationFieldV1.md @@ -1,7 +1,7 @@ # ImageAnnotationFieldV1 -`toloka.client.project.template_builder.fields.ImageAnnotationFieldV1` +`toloka.client.project.template_builder.fields.ImageAnnotationFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L248) -``` +```python ImageAnnotationFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.ListFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.ListFieldV1.md index 7aac6498..e5801453 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.ListFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.ListFieldV1.md @@ -1,7 +1,7 @@ # ListFieldV1 -`toloka.client.project.template_builder.fields.ListFieldV1` +`toloka.client.project.template_builder.fields.ListFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L306) -``` +```python ListFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.MediaFileFieldV1.Accept.md b/docs/reference/toloka.client.project.template_builder.fields.MediaFileFieldV1.Accept.md index ecdc0343..90175a54 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.MediaFileFieldV1.Accept.md +++ b/docs/reference/toloka.client.project.template_builder.fields.MediaFileFieldV1.Accept.md @@ -1,7 +1,7 @@ # Accept -`toloka.client.project.template_builder.fields.MediaFileFieldV1.Accept` +`toloka.client.project.template_builder.fields.MediaFileFieldV1.Accept` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L366) -``` +```python Accept( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.fields.MediaFileFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.MediaFileFieldV1.md index f2d21c04..33c78642 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.MediaFileFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.MediaFileFieldV1.md @@ -1,7 +1,7 @@ # MediaFileFieldV1 -`toloka.client.project.template_builder.fields.MediaFileFieldV1` +`toloka.client.project.template_builder.fields.MediaFileFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L340) -``` +```python MediaFileFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.NumberFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.NumberFieldV1.md index 8abbdfde..1dcc8d57 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.NumberFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.NumberFieldV1.md @@ -1,7 +1,7 @@ # NumberFieldV1 -`toloka.client.project.template_builder.fields.NumberFieldV1` +`toloka.client.project.template_builder.fields.NumberFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L385) -``` +```python NumberFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.PhoneNumberFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.PhoneNumberFieldV1.md index 18479f2f..047004ab 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.PhoneNumberFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.PhoneNumberFieldV1.md @@ -1,7 +1,7 @@ # PhoneNumberFieldV1 -`toloka.client.project.template_builder.fields.PhoneNumberFieldV1` +`toloka.client.project.template_builder.fields.PhoneNumberFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L408) -``` +```python PhoneNumberFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.RadioGroupFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.RadioGroupFieldV1.md index 7e3b0fee..b89a621e 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.RadioGroupFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.RadioGroupFieldV1.md @@ -1,7 +1,7 @@ # RadioGroupFieldV1 -`toloka.client.project.template_builder.fields.RadioGroupFieldV1` +`toloka.client.project.template_builder.fields.RadioGroupFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L421) -``` +```python RadioGroupFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.SelectFieldV1.Option.md b/docs/reference/toloka.client.project.template_builder.fields.SelectFieldV1.Option.md index 140b1628..bab48b34 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.SelectFieldV1.Option.md +++ b/docs/reference/toloka.client.project.template_builder.fields.SelectFieldV1.Option.md @@ -1,7 +1,7 @@ # Option -`toloka.client.project.template_builder.fields.SelectFieldV1.Option` +`toloka.client.project.template_builder.fields.SelectFieldV1.Option` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L466) -``` +```python Option( self, label: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.SelectFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.SelectFieldV1.md index 8a97243b..5049bf4f 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.SelectFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.SelectFieldV1.md @@ -1,7 +1,7 @@ # SelectFieldV1 -`toloka.client.project.template_builder.fields.SelectFieldV1` +`toloka.client.project.template_builder.fields.SelectFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L451) -``` +```python SelectFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.TextAnnotationFieldV1.Label.md b/docs/reference/toloka.client.project.template_builder.fields.TextAnnotationFieldV1.Label.md index 6425e0e1..f37d02cd 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.TextAnnotationFieldV1.Label.md +++ b/docs/reference/toloka.client.project.template_builder.fields.TextAnnotationFieldV1.Label.md @@ -1,7 +1,7 @@ # Label -`toloka.client.project.template_builder.fields.TextAnnotationFieldV1.Label` +`toloka.client.project.template_builder.fields.TextAnnotationFieldV1.Label` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L512) -``` +```python Label( self, label: Optional[Union[BaseComponent, str]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.TextAnnotationFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.TextAnnotationFieldV1.md index c575f8fc..3615e513 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.TextAnnotationFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.TextAnnotationFieldV1.md @@ -1,7 +1,7 @@ # TextAnnotationFieldV1 -`toloka.client.project.template_builder.fields.TextAnnotationFieldV1` +`toloka.client.project.template_builder.fields.TextAnnotationFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L494) -``` +```python TextAnnotationFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.TextFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.TextFieldV1.md index b58b517e..a86b1e35 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.TextFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.TextFieldV1.md @@ -1,7 +1,7 @@ # TextFieldV1 -`toloka.client.project.template_builder.fields.TextFieldV1` +`toloka.client.project.template_builder.fields.TextFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L481) -``` +```python TextFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.fields.TextareaFieldV1.md b/docs/reference/toloka.client.project.template_builder.fields.TextareaFieldV1.md index 0a72b3c4..b1273cd0 100644 --- a/docs/reference/toloka.client.project.template_builder.fields.TextareaFieldV1.md +++ b/docs/reference/toloka.client.project.template_builder.fields.TextareaFieldV1.md @@ -1,7 +1,7 @@ # TextareaFieldV1 -`toloka.client.project.template_builder.fields.TextareaFieldV1` +`toloka.client.project.template_builder.fields.TextareaFieldV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/fields.py#L528) -``` +```python TextareaFieldV1( self, data: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.get_input_and_output.md b/docs/reference/toloka.client.project.template_builder.get_input_and_output.md index 80c33a65..5951cc20 100644 --- a/docs/reference/toloka.client.project.template_builder.get_input_and_output.md +++ b/docs/reference/toloka.client.project.template_builder.get_input_and_output.md @@ -1,7 +1,7 @@ # get_input_and_output -`toloka.client.project.template_builder.get_input_and_output` +`toloka.client.project.template_builder.get_input_and_output` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/__init__.py#L229) -``` +```python get_input_and_output(tb_config: Union[dict, TemplateBuilder]) ``` diff --git a/docs/reference/toloka.client.project.template_builder.helpers.BaseHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.BaseHelperV1.md index 11802812..11ea45b1 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.BaseHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.BaseHelperV1.md @@ -1,7 +1,7 @@ # BaseHelperV1 -`toloka.client.project.template_builder.helpers.BaseHelperV1` +`toloka.client.project.template_builder.helpers.BaseHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L23) -``` +```python BaseHelperV1(self, *, version: Optional[str] = '1.0.0') ``` diff --git a/docs/reference/toloka.client.project.template_builder.helpers.ConcatArraysHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.ConcatArraysHelperV1.md index c43be013..b388b6e3 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.ConcatArraysHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.ConcatArraysHelperV1.md @@ -1,7 +1,7 @@ # ConcatArraysHelperV1 -`toloka.client.project.template_builder.helpers.ConcatArraysHelperV1` +`toloka.client.project.template_builder.helpers.ConcatArraysHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L31) -``` +```python ConcatArraysHelperV1( self, items: Optional[Union[BaseComponent, List[Any]]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1.Entry.md b/docs/reference/toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1.Entry.md index 8bd32c5e..0d979fad 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1.Entry.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1.Entry.md @@ -1,7 +1,7 @@ # Entry -`toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1.Entry` +`toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1.Entry` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L65) -``` +```python Entry( self, key: Optional[Union[BaseComponent, str]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1.md index 5ba09edd..c6fe045f 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1.md @@ -1,7 +1,7 @@ # Entries2ObjectHelperV1 -`toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1` +`toloka.client.project.template_builder.helpers.Entries2ObjectHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L45) -``` +```python Entries2ObjectHelperV1( self, entries: Optional[Union[BaseComponent, List[Union[BaseComponent, Entry]]]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.IfHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.IfHelperV1.md index 55372d09..7014c1af 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.IfHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.IfHelperV1.md @@ -1,7 +1,7 @@ # IfHelperV1 -`toloka.client.project.template_builder.helpers.IfHelperV1` +`toloka.client.project.template_builder.helpers.IfHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L72) -``` +```python IfHelperV1( self, condition: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.JoinHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.JoinHelperV1.md index d6c20a7c..e4acaaea 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.JoinHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.JoinHelperV1.md @@ -1,7 +1,7 @@ # JoinHelperV1 -`toloka.client.project.template_builder.helpers.JoinHelperV1` +`toloka.client.project.template_builder.helpers.JoinHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L104) -``` +```python JoinHelperV1( self, items: Optional[Union[BaseComponent, List[Union[BaseComponent, str]]]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.Object2EntriesHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.Object2EntriesHelperV1.md index e62aca5f..589c8fbe 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.Object2EntriesHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.Object2EntriesHelperV1.md @@ -1,7 +1,7 @@ # Object2EntriesHelperV1 -`toloka.client.project.template_builder.helpers.Object2EntriesHelperV1` +`toloka.client.project.template_builder.helpers.Object2EntriesHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L117) -``` +```python Object2EntriesHelperV1( self, data: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.ReplaceHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.ReplaceHelperV1.md index d2813cb8..2b6b3bda 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.ReplaceHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.ReplaceHelperV1.md @@ -1,7 +1,7 @@ # ReplaceHelperV1 -`toloka.client.project.template_builder.helpers.ReplaceHelperV1` +`toloka.client.project.template_builder.helpers.ReplaceHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L143) -``` +```python ReplaceHelperV1( self, data: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.SearchQueryHelperV1.Engine.md b/docs/reference/toloka.client.project.template_builder.helpers.SearchQueryHelperV1.Engine.md index 1746e17b..22eb8910 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.SearchQueryHelperV1.Engine.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.SearchQueryHelperV1.Engine.md @@ -1,5 +1,5 @@ # Engine -`toloka.client.project.template_builder.helpers.SearchQueryHelperV1.Engine` +`toloka.client.project.template_builder.helpers.SearchQueryHelperV1.Engine` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L169) An enumeration. diff --git a/docs/reference/toloka.client.project.template_builder.helpers.SearchQueryHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.SearchQueryHelperV1.md index 4a072b45..e63dac72 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.SearchQueryHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.SearchQueryHelperV1.md @@ -1,7 +1,7 @@ # SearchQueryHelperV1 -`toloka.client.project.template_builder.helpers.SearchQueryHelperV1` +`toloka.client.project.template_builder.helpers.SearchQueryHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L160) -``` +```python SearchQueryHelperV1( self, query: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.SwitchHelperV1.Case.md b/docs/reference/toloka.client.project.template_builder.helpers.SwitchHelperV1.Case.md index d6501761..5e7b3fce 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.SwitchHelperV1.Case.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.SwitchHelperV1.Case.md @@ -1,7 +1,7 @@ # Case -`toloka.client.project.template_builder.helpers.SwitchHelperV1.Case` +`toloka.client.project.template_builder.helpers.SwitchHelperV1.Case` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L211) -``` +```python Case( self, condition: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.SwitchHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.SwitchHelperV1.md index 62d1ce2f..e24f1296 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.SwitchHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.SwitchHelperV1.md @@ -1,7 +1,7 @@ # SwitchHelperV1 -`toloka.client.project.template_builder.helpers.SwitchHelperV1` +`toloka.client.project.template_builder.helpers.SwitchHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L187) -``` +```python SwitchHelperV1( self, cases: Optional[Union[BaseComponent, List[Union[BaseComponent, Case]]]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.TextTransformHelperV1.Transformation.md b/docs/reference/toloka.client.project.template_builder.helpers.TextTransformHelperV1.Transformation.md index 0e21df26..7889cc99 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.TextTransformHelperV1.Transformation.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.TextTransformHelperV1.Transformation.md @@ -1,5 +1,5 @@ # Transformation -`toloka.client.project.template_builder.helpers.TextTransformHelperV1.Transformation` +`toloka.client.project.template_builder.helpers.TextTransformHelperV1.Transformation` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L238) An enumeration. diff --git a/docs/reference/toloka.client.project.template_builder.helpers.TextTransformHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.TextTransformHelperV1.md index a774e951..dbf093b3 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.TextTransformHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.TextTransformHelperV1.md @@ -1,7 +1,7 @@ # TextTransformHelperV1 -`toloka.client.project.template_builder.helpers.TextTransformHelperV1` +`toloka.client.project.template_builder.helpers.TextTransformHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L226) -``` +```python TextTransformHelperV1( self, data: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.TransformHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.TransformHelperV1.md index 607ac7a2..1ec37711 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.TransformHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.TransformHelperV1.md @@ -1,7 +1,7 @@ # TransformHelperV1 -`toloka.client.project.template_builder.helpers.TransformHelperV1` +`toloka.client.project.template_builder.helpers.TransformHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L248) -``` +```python TransformHelperV1( self, into: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.TranslateHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.TranslateHelperV1.md index dbbff07c..aeb4e76c 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.TranslateHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.TranslateHelperV1.md @@ -1,7 +1,7 @@ # TranslateHelperV1 -`toloka.client.project.template_builder.helpers.TranslateHelperV1` +`toloka.client.project.template_builder.helpers.TranslateHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L267) -``` +```python TranslateHelperV1( self, key: Optional[Union[BaseComponent, str]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.helpers.YandexDiskProxyHelperV1.md b/docs/reference/toloka.client.project.template_builder.helpers.YandexDiskProxyHelperV1.md index b422e94b..0426ebf2 100644 --- a/docs/reference/toloka.client.project.template_builder.helpers.YandexDiskProxyHelperV1.md +++ b/docs/reference/toloka.client.project.template_builder.helpers.YandexDiskProxyHelperV1.md @@ -1,7 +1,7 @@ # YandexDiskProxyHelperV1 -`toloka.client.project.template_builder.helpers.YandexDiskProxyHelperV1` +`toloka.client.project.template_builder.helpers.YandexDiskProxyHelperV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/helpers.py#L288) -``` +```python YandexDiskProxyHelperV1( self, path: Optional[Union[BaseComponent, str]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.layouts.BarsLayoutV1.md b/docs/reference/toloka.client.project.template_builder.layouts.BarsLayoutV1.md index 3b866a03..e5ce7e7e 100644 --- a/docs/reference/toloka.client.project.template_builder.layouts.BarsLayoutV1.md +++ b/docs/reference/toloka.client.project.template_builder.layouts.BarsLayoutV1.md @@ -1,7 +1,7 @@ # BarsLayoutV1 -`toloka.client.project.template_builder.layouts.BarsLayoutV1` +`toloka.client.project.template_builder.layouts.BarsLayoutV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/layouts.py#L39) -``` +```python BarsLayoutV1( self, content: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.layouts.BaseLayoutV1.md b/docs/reference/toloka.client.project.template_builder.layouts.BaseLayoutV1.md index da6bc3ee..8d623042 100644 --- a/docs/reference/toloka.client.project.template_builder.layouts.BaseLayoutV1.md +++ b/docs/reference/toloka.client.project.template_builder.layouts.BaseLayoutV1.md @@ -1,7 +1,7 @@ # BaseLayoutV1 -`toloka.client.project.template_builder.layouts.BaseLayoutV1` +`toloka.client.project.template_builder.layouts.BaseLayoutV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/layouts.py#L27) -``` +```python BaseLayoutV1( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.layouts.ColumnsLayoutV1.VerticalAlign.md b/docs/reference/toloka.client.project.template_builder.layouts.ColumnsLayoutV1.VerticalAlign.md index 5a6d226e..a66261bc 100644 --- a/docs/reference/toloka.client.project.template_builder.layouts.ColumnsLayoutV1.VerticalAlign.md +++ b/docs/reference/toloka.client.project.template_builder.layouts.ColumnsLayoutV1.VerticalAlign.md @@ -1,5 +1,5 @@ # VerticalAlign -`toloka.client.project.template_builder.layouts.ColumnsLayoutV1.VerticalAlign` +`toloka.client.project.template_builder.layouts.ColumnsLayoutV1.VerticalAlign` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/layouts.py#L78) Vertical alignment of column content. diff --git a/docs/reference/toloka.client.project.template_builder.layouts.ColumnsLayoutV1.md b/docs/reference/toloka.client.project.template_builder.layouts.ColumnsLayoutV1.md index 6c9818cd..b6eb4d68 100644 --- a/docs/reference/toloka.client.project.template_builder.layouts.ColumnsLayoutV1.md +++ b/docs/reference/toloka.client.project.template_builder.layouts.ColumnsLayoutV1.md @@ -1,7 +1,7 @@ # ColumnsLayoutV1 -`toloka.client.project.template_builder.layouts.ColumnsLayoutV1` +`toloka.client.project.template_builder.layouts.ColumnsLayoutV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/layouts.py#L58) -``` +```python ColumnsLayoutV1( self, items: Optional[Union[BaseComponent, List[BaseComponent]]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.layouts.CompareLayoutItem.md b/docs/reference/toloka.client.project.template_builder.layouts.CompareLayoutItem.md index 2bbf9dfa..47f0e871 100644 --- a/docs/reference/toloka.client.project.template_builder.layouts.CompareLayoutItem.md +++ b/docs/reference/toloka.client.project.template_builder.layouts.CompareLayoutItem.md @@ -1,7 +1,7 @@ # CompareLayoutItem -`toloka.client.project.template_builder.layouts.CompareLayoutItem` +`toloka.client.project.template_builder.layouts.CompareLayoutItem` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/layouts.py#L99) -``` +```python CompareLayoutItem( self, content: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.layouts.CompareLayoutV1.md b/docs/reference/toloka.client.project.template_builder.layouts.CompareLayoutV1.md index 6eb64211..b488a917 100644 --- a/docs/reference/toloka.client.project.template_builder.layouts.CompareLayoutV1.md +++ b/docs/reference/toloka.client.project.template_builder.layouts.CompareLayoutV1.md @@ -1,7 +1,7 @@ # CompareLayoutV1 -`toloka.client.project.template_builder.layouts.CompareLayoutV1` +`toloka.client.project.template_builder.layouts.CompareLayoutV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/layouts.py#L112) -``` +```python CompareLayoutV1( self, common_controls: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.layouts.SideBySideLayoutV1.md b/docs/reference/toloka.client.project.template_builder.layouts.SideBySideLayoutV1.md index 7a5a88ad..420fe6c3 100644 --- a/docs/reference/toloka.client.project.template_builder.layouts.SideBySideLayoutV1.md +++ b/docs/reference/toloka.client.project.template_builder.layouts.SideBySideLayoutV1.md @@ -1,7 +1,7 @@ # SideBySideLayoutV1 -`toloka.client.project.template_builder.layouts.SideBySideLayoutV1` +`toloka.client.project.template_builder.layouts.SideBySideLayoutV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/layouts.py#L141) -``` +```python SideBySideLayoutV1( self, controls: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.layouts.SidebarLayoutV1.md b/docs/reference/toloka.client.project.template_builder.layouts.SidebarLayoutV1.md index 217ea60c..73493cfa 100644 --- a/docs/reference/toloka.client.project.template_builder.layouts.SidebarLayoutV1.md +++ b/docs/reference/toloka.client.project.template_builder.layouts.SidebarLayoutV1.md @@ -1,7 +1,7 @@ # SidebarLayoutV1 -`toloka.client.project.template_builder.layouts.SidebarLayoutV1` +`toloka.client.project.template_builder.layouts.SidebarLayoutV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/layouts.py#L160) -``` +```python SidebarLayoutV1( self, content: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.plugins.BasePluginV1.md b/docs/reference/toloka.client.project.template_builder.plugins.BasePluginV1.md index 0f5ab8ff..a09440f8 100644 --- a/docs/reference/toloka.client.project.template_builder.plugins.BasePluginV1.md +++ b/docs/reference/toloka.client.project.template_builder.plugins.BasePluginV1.md @@ -1,7 +1,7 @@ # BasePluginV1 -`toloka.client.project.template_builder.plugins.BasePluginV1` +`toloka.client.project.template_builder.plugins.BasePluginV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/plugins.py#L18) -``` +```python BasePluginV1(self, *, version: Optional[str] = '1.0.0') ``` diff --git a/docs/reference/toloka.client.project.template_builder.plugins.HotkeysPluginV1.md b/docs/reference/toloka.client.project.template_builder.plugins.HotkeysPluginV1.md index 8aea6e49..5176c0c9 100644 --- a/docs/reference/toloka.client.project.template_builder.plugins.HotkeysPluginV1.md +++ b/docs/reference/toloka.client.project.template_builder.plugins.HotkeysPluginV1.md @@ -1,7 +1,7 @@ # HotkeysPluginV1 -`toloka.client.project.template_builder.plugins.HotkeysPluginV1` +`toloka.client.project.template_builder.plugins.HotkeysPluginV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/plugins.py#L79) -``` +```python HotkeysPluginV1( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1.Mode.md b/docs/reference/toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1.Mode.md index 714a3943..b07bc822 100644 --- a/docs/reference/toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1.Mode.md +++ b/docs/reference/toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1.Mode.md @@ -1,7 +1,7 @@ # Mode -`toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1.Mode` +`toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1.Mode` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/plugins.py#L40) -``` +```python Mode( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1.md b/docs/reference/toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1.md index 5d1e6a65..bf75d6ae 100644 --- a/docs/reference/toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1.md +++ b/docs/reference/toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1.md @@ -1,7 +1,7 @@ # ImageAnnotationHotkeysPluginV1 -`toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1` +`toloka.client.project.template_builder.plugins.ImageAnnotationHotkeysPluginV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/plugins.py#L26) -``` +```python ImageAnnotationHotkeysPluginV1( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.plugins.TextAnnotationHotkeysPluginV1.md b/docs/reference/toloka.client.project.template_builder.plugins.TextAnnotationHotkeysPluginV1.md index 36edccb7..105853bb 100644 --- a/docs/reference/toloka.client.project.template_builder.plugins.TextAnnotationHotkeysPluginV1.md +++ b/docs/reference/toloka.client.project.template_builder.plugins.TextAnnotationHotkeysPluginV1.md @@ -1,7 +1,7 @@ # TextAnnotationHotkeysPluginV1 -`toloka.client.project.template_builder.plugins.TextAnnotationHotkeysPluginV1` +`toloka.client.project.template_builder.plugins.TextAnnotationHotkeysPluginV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/plugins.py#L65) -``` +```python TextAnnotationHotkeysPluginV1( self, labels: Optional[Union[BaseComponent, List[str]]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout.Kind.md b/docs/reference/toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout.Kind.md index 81dcb53d..49852f60 100644 --- a/docs/reference/toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout.Kind.md +++ b/docs/reference/toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout.Kind.md @@ -1,5 +1,5 @@ # Kind -`toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout.Kind` +`toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout.Kind` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/plugins.py#L193) An enumeration. diff --git a/docs/reference/toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout.md b/docs/reference/toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout.md index d2b39b2b..bbf95893 100644 --- a/docs/reference/toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout.md +++ b/docs/reference/toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout.md @@ -1,7 +1,7 @@ # TolokaPluginLayout -`toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout` +`toloka.client.project.template_builder.plugins.TolokaPluginV1.TolokaPluginLayout` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/plugins.py#L188) -``` +```python TolokaPluginLayout( self, kind: Optional[Kind] = None, diff --git a/docs/reference/toloka.client.project.template_builder.plugins.TolokaPluginV1.md b/docs/reference/toloka.client.project.template_builder.plugins.TolokaPluginV1.md index 6815ef2d..5778f040 100644 --- a/docs/reference/toloka.client.project.template_builder.plugins.TolokaPluginV1.md +++ b/docs/reference/toloka.client.project.template_builder.plugins.TolokaPluginV1.md @@ -1,7 +1,7 @@ # TolokaPluginV1 -`toloka.client.project.template_builder.plugins.TolokaPluginV1` +`toloka.client.project.template_builder.plugins.TolokaPluginV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/plugins.py#L171) -``` +```python TolokaPluginV1( self, kind: Optional[TolokaPluginLayout.Kind] = None, diff --git a/docs/reference/toloka.client.project.template_builder.plugins.TriggerPluginV1.md b/docs/reference/toloka.client.project.template_builder.plugins.TriggerPluginV1.md index 1053e511..be3207f4 100644 --- a/docs/reference/toloka.client.project.template_builder.plugins.TriggerPluginV1.md +++ b/docs/reference/toloka.client.project.template_builder.plugins.TriggerPluginV1.md @@ -1,7 +1,7 @@ # TriggerPluginV1 -`toloka.client.project.template_builder.plugins.TriggerPluginV1` +`toloka.client.project.template_builder.plugins.TriggerPluginV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/plugins.py#L137) -``` +```python TriggerPluginV1( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.view.ActionButtonViewV1.md b/docs/reference/toloka.client.project.template_builder.view.ActionButtonViewV1.md index fcf1bf22..1d3401c3 100644 --- a/docs/reference/toloka.client.project.template_builder.view.ActionButtonViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.ActionButtonViewV1.md @@ -1,7 +1,7 @@ # ActionButtonViewV1 -`toloka.client.project.template_builder.view.ActionButtonViewV1` +`toloka.client.project.template_builder.view.ActionButtonViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L64) -``` +```python ActionButtonViewV1( self, action: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.AlertViewV1.Theme.md b/docs/reference/toloka.client.project.template_builder.view.AlertViewV1.Theme.md index 4da63a90..3df93e29 100644 --- a/docs/reference/toloka.client.project.template_builder.view.AlertViewV1.Theme.md +++ b/docs/reference/toloka.client.project.template_builder.view.AlertViewV1.Theme.md @@ -1,5 +1,5 @@ # Theme -`toloka.client.project.template_builder.view.AlertViewV1.Theme` +`toloka.client.project.template_builder.view.AlertViewV1.Theme` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L87) An enumeration diff --git a/docs/reference/toloka.client.project.template_builder.view.AlertViewV1.md b/docs/reference/toloka.client.project.template_builder.view.AlertViewV1.md index 85545974..c6921bcf 100644 --- a/docs/reference/toloka.client.project.template_builder.view.AlertViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.AlertViewV1.md @@ -1,7 +1,7 @@ # AlertViewV1 -`toloka.client.project.template_builder.view.AlertViewV1` +`toloka.client.project.template_builder.view.AlertViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L77) -``` +```python AlertViewV1( self, content: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.AudioViewV1.md b/docs/reference/toloka.client.project.template_builder.view.AudioViewV1.md index 29962599..edba9a10 100644 --- a/docs/reference/toloka.client.project.template_builder.view.AudioViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.AudioViewV1.md @@ -1,7 +1,7 @@ # AudioViewV1 -`toloka.client.project.template_builder.view.AudioViewV1` +`toloka.client.project.template_builder.view.AudioViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L107) -``` +```python AudioViewV1( self, url: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.BaseViewV1.md b/docs/reference/toloka.client.project.template_builder.view.BaseViewV1.md index 051cd127..feecb57d 100644 --- a/docs/reference/toloka.client.project.template_builder.view.BaseViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.BaseViewV1.md @@ -1,7 +1,7 @@ # BaseViewV1 -`toloka.client.project.template_builder.view.BaseViewV1` +`toloka.client.project.template_builder.view.BaseViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L52) -``` +```python BaseViewV1( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.view.CollapseViewV1.md b/docs/reference/toloka.client.project.template_builder.view.CollapseViewV1.md index 2be8c143..e107072b 100644 --- a/docs/reference/toloka.client.project.template_builder.view.CollapseViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.CollapseViewV1.md @@ -1,7 +1,7 @@ # CollapseViewV1 -`toloka.client.project.template_builder.view.CollapseViewV1` +`toloka.client.project.template_builder.view.CollapseViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L121) -``` +```python CollapseViewV1( self, content: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.DeviceFrameViewV1.md b/docs/reference/toloka.client.project.template_builder.view.DeviceFrameViewV1.md index 5f02e169..97d0a23a 100644 --- a/docs/reference/toloka.client.project.template_builder.view.DeviceFrameViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.DeviceFrameViewV1.md @@ -1,7 +1,7 @@ # DeviceFrameViewV1 -`toloka.client.project.template_builder.view.DeviceFrameViewV1` +`toloka.client.project.template_builder.view.DeviceFrameViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L142) -``` +```python DeviceFrameViewV1( self, content: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.DividerViewV1.md b/docs/reference/toloka.client.project.template_builder.view.DividerViewV1.md index 6f22e28e..48124a5f 100644 --- a/docs/reference/toloka.client.project.template_builder.view.DividerViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.DividerViewV1.md @@ -1,7 +1,7 @@ # DividerViewV1 -`toloka.client.project.template_builder.view.DividerViewV1` +`toloka.client.project.template_builder.view.DividerViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L164) -``` +```python DividerViewV1( self, *, diff --git a/docs/reference/toloka.client.project.template_builder.view.GroupViewV1.md b/docs/reference/toloka.client.project.template_builder.view.GroupViewV1.md index 69df38ca..92d803e5 100644 --- a/docs/reference/toloka.client.project.template_builder.view.GroupViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.GroupViewV1.md @@ -1,7 +1,7 @@ # GroupViewV1 -`toloka.client.project.template_builder.view.GroupViewV1` +`toloka.client.project.template_builder.view.GroupViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L176) -``` +```python GroupViewV1( self, content: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.IframeViewV1.md b/docs/reference/toloka.client.project.template_builder.view.IframeViewV1.md index bb2730f6..5603b543 100644 --- a/docs/reference/toloka.client.project.template_builder.view.IframeViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.IframeViewV1.md @@ -1,7 +1,7 @@ # IframeViewV1 -`toloka.client.project.template_builder.view.IframeViewV1` +`toloka.client.project.template_builder.view.IframeViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L190) -``` +```python IframeViewV1( self, url: Optional[Union[BaseComponent, str]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.ImageViewV1.md b/docs/reference/toloka.client.project.template_builder.view.ImageViewV1.md index 2362027f..1849aecc 100644 --- a/docs/reference/toloka.client.project.template_builder.view.ImageViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.ImageViewV1.md @@ -1,7 +1,7 @@ # ImageViewV1 -`toloka.client.project.template_builder.view.ImageViewV1` +`toloka.client.project.template_builder.view.ImageViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L211) -``` +```python ImageViewV1( self, url: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.LabeledListViewV1.Item.md b/docs/reference/toloka.client.project.template_builder.view.LabeledListViewV1.Item.md index 1622c65f..9f17b106 100644 --- a/docs/reference/toloka.client.project.template_builder.view.LabeledListViewV1.Item.md +++ b/docs/reference/toloka.client.project.template_builder.view.LabeledListViewV1.Item.md @@ -1,7 +1,7 @@ # Item -`toloka.client.project.template_builder.view.LabeledListViewV1.Item` +`toloka.client.project.template_builder.view.LabeledListViewV1.Item` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L258) -``` +```python Item( self, content: Optional[BaseComponent] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.LabeledListViewV1.md b/docs/reference/toloka.client.project.template_builder.view.LabeledListViewV1.md index 97c5234b..a63b9cf7 100644 --- a/docs/reference/toloka.client.project.template_builder.view.LabeledListViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.LabeledListViewV1.md @@ -1,7 +1,7 @@ # LabeledListViewV1 -`toloka.client.project.template_builder.view.LabeledListViewV1` +`toloka.client.project.template_builder.view.LabeledListViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L247) -``` +```python LabeledListViewV1( self, items: Optional[Union[BaseComponent, List[Union[BaseComponent, Item]]]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.LinkGroupViewV1.Link.md b/docs/reference/toloka.client.project.template_builder.view.LinkGroupViewV1.Link.md index d4bfd007..98795c29 100644 --- a/docs/reference/toloka.client.project.template_builder.view.LinkGroupViewV1.Link.md +++ b/docs/reference/toloka.client.project.template_builder.view.LinkGroupViewV1.Link.md @@ -1,7 +1,7 @@ # Link -`toloka.client.project.template_builder.view.LinkGroupViewV1.Link` +`toloka.client.project.template_builder.view.LinkGroupViewV1.Link` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L327) -``` +```python Link( self, url: Optional[Union[BaseComponent, str]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.LinkGroupViewV1.md b/docs/reference/toloka.client.project.template_builder.view.LinkGroupViewV1.md index e42110ba..bb4b10c8 100644 --- a/docs/reference/toloka.client.project.template_builder.view.LinkGroupViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.LinkGroupViewV1.md @@ -1,7 +1,7 @@ # LinkGroupViewV1 -`toloka.client.project.template_builder.view.LinkGroupViewV1` +`toloka.client.project.template_builder.view.LinkGroupViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L299) -``` +```python LinkGroupViewV1( self, links: Optional[Union[BaseComponent, List[Union[BaseComponent, Link]]]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.LinkViewV1.md b/docs/reference/toloka.client.project.template_builder.view.LinkViewV1.md index 1ed7367f..7026e374 100644 --- a/docs/reference/toloka.client.project.template_builder.view.LinkViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.LinkViewV1.md @@ -1,7 +1,7 @@ # LinkViewV1 -`toloka.client.project.template_builder.view.LinkViewV1` +`toloka.client.project.template_builder.view.LinkViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L279) -``` +```python LinkViewV1( self, url: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.ListViewV1.md b/docs/reference/toloka.client.project.template_builder.view.ListViewV1.md index cea5935e..a34b7aad 100644 --- a/docs/reference/toloka.client.project.template_builder.view.ListViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.ListViewV1.md @@ -1,7 +1,7 @@ # ListViewV1 -`toloka.client.project.template_builder.view.ListViewV1` +`toloka.client.project.template_builder.view.ListViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L343) -``` +```python ListViewV1( self, items: Optional[Union[BaseComponent, List[BaseComponent]]] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.MapViewV1.Marker.md b/docs/reference/toloka.client.project.template_builder.view.MapViewV1.Marker.md new file mode 100644 index 00000000..e75f9c01 --- /dev/null +++ b/docs/reference/toloka.client.project.template_builder.view.MapViewV1.Marker.md @@ -0,0 +1,22 @@ +# Marker +`toloka.client.project.template_builder.view.MapViewV1.Marker` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L446) + +```python +Marker( + self, + position: Optional[Union[BaseComponent, str]] = None, + *, + color: Optional[Union[BaseComponent, str]] = None, + label: Optional[Union[BaseComponent, str]] = None +) +``` + +Marker parameters. + +## Parameters Description + +| Parameters | Type | Description | +| :----------| :----| :-----------| +`position`|**Optional\[Union\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md), str\]\]**|

Determines the marker position. Specify the coordinates in the string format, for example, "29.748713,-95.404287", or use the data.location component to set the marker to the Toloker's current position.

+`color`|**Optional\[Union\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md), str\]\]**|

Determines the marker color. Use the hexadecimal values preceded by the # sign to specify the color.

+`label`|**Optional\[Union\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md), str\]\]**|

The label for the marker that tells Tolokers what this marker is for and helps distinguish it from other markers.

diff --git a/docs/reference/toloka.client.project.template_builder.view.MapViewV1.Polygon.md b/docs/reference/toloka.client.project.template_builder.view.MapViewV1.Polygon.md new file mode 100644 index 00000000..59846f3b --- /dev/null +++ b/docs/reference/toloka.client.project.template_builder.view.MapViewV1.Polygon.md @@ -0,0 +1,20 @@ +# Polygon +`toloka.client.project.template_builder.view.MapViewV1.Polygon` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L461) + +```python +Polygon( + self, + points: Optional[Union[BaseComponent, List[Union[BaseComponent, str]]]] = None, + *, + color: Optional[Union[BaseComponent, str]] = None +) +``` + +Polygon parameters. + +## Parameters Description + +| Parameters | Type | Description | +| :----------| :----| :-----------| +`points`|**Optional\[Union\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md), List\[Union\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md), str\]\]\]\]**|

The list of the polygonal selection area points. Specify the coordinates in the string format, for example, "29.748713,-95.404287".

+`color`|**Optional\[Union\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md), str\]\]**|

Determines the polygonal selection area color. Use the hexadecimal values preceded by the # sign to specify the color.

diff --git a/docs/reference/toloka.client.project.template_builder.view.MapViewV1.md b/docs/reference/toloka.client.project.template_builder.view.MapViewV1.md new file mode 100644 index 00000000..cb2191f4 --- /dev/null +++ b/docs/reference/toloka.client.project.template_builder.view.MapViewV1.md @@ -0,0 +1,37 @@ +# MapViewV1 +`toloka.client.project.template_builder.view.MapViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L429) + +```python +MapViewV1( + self, + center: Optional[Union[BaseComponent, str]] = None, + *, + markers: Optional[Union[BaseComponent, List[Union[BaseComponent, Marker]]]] = None, + polygons: Optional[Union[BaseComponent, List[Union[BaseComponent, Polygon]]]] = None, + zoom: Optional[Union[BaseComponent, int]] = None, + hint: Optional[Any] = None, + label: Optional[Any] = None, + validation: Optional[BaseComponent] = None, + version: Optional[str] = '1.0.0' +) +``` + +Adds a map to your task. + + +Use this component to set the targets for the tasks with the markers, select the areas with polygons. +Specify the position and colors for the elements on the map. + +You can set the following map properties: scale, position of the map center, label, and hint for the users. + +## Parameters Description + +| Parameters | Type | Description | +| :----------| :----| :-----------| +`center`|**Optional\[Union\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md), str\]\]**|

Determines the position of the map center. Specify the coordinates in the string format, for example, "29.748713,-95.404287", or use the data.location component to set the center of the map to the Toloker's current position.

+`markers`|**Optional\[Union\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md), List\[Union\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md), [Marker](toloka.client.project.template_builder.view.MapViewV1.Marker.md)\]\]\]\]**|

Specifies the markers present on the map.

+`polygons`|**Optional\[Union\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md), List\[Union\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md), [Polygon](toloka.client.project.template_builder.view.MapViewV1.Polygon.md)\]\]\]\]**|

Specifies the polygonal objects that you can use to select areas on the map.

+`zoom`|**Optional\[Union\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md), int\]\]**|

The map initial scale. Use the values from 0 to 19. Bigger values give a more detailed map view.

+`hint`|**Optional\[Any\]**|

Hint text.

+`label`|**Optional\[Any\]**|

Label above the component.

+`validation`|**Optional\[[BaseComponent](toloka.client.project.template_builder.base.BaseComponent.md)\]**|

Validation based on condition.

diff --git a/docs/reference/toloka.client.project.template_builder.view.MarkdownViewV1.md b/docs/reference/toloka.client.project.template_builder.view.MarkdownViewV1.md index 65324aa8..17728dc3 100644 --- a/docs/reference/toloka.client.project.template_builder.view.MarkdownViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.MarkdownViewV1.md @@ -1,7 +1,7 @@ # MarkdownViewV1 -`toloka.client.project.template_builder.view.MarkdownViewV1` +`toloka.client.project.template_builder.view.MarkdownViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L359) -``` +```python MarkdownViewV1( self, content: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.TextViewV1.md b/docs/reference/toloka.client.project.template_builder.view.TextViewV1.md index 658febfa..d22635c8 100644 --- a/docs/reference/toloka.client.project.template_builder.view.TextViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.TextViewV1.md @@ -1,7 +1,7 @@ # TextViewV1 -`toloka.client.project.template_builder.view.TextViewV1` +`toloka.client.project.template_builder.view.TextViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L385) -``` +```python TextViewV1( self, content: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.template_builder.view.VideoViewV1.md b/docs/reference/toloka.client.project.template_builder.view.VideoViewV1.md index 25a5d85b..664966fe 100644 --- a/docs/reference/toloka.client.project.template_builder.view.VideoViewV1.md +++ b/docs/reference/toloka.client.project.template_builder.view.VideoViewV1.md @@ -1,7 +1,7 @@ # VideoViewV1 -`toloka.client.project.template_builder.view.VideoViewV1` +`toloka.client.project.template_builder.view.VideoViewV1` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/template_builder/view.py#L403) -``` +```python VideoViewV1( self, url: Optional[Any] = None, diff --git a/docs/reference/toloka.client.project.view_spec.ClassicViewSpec.Assets.md b/docs/reference/toloka.client.project.view_spec.ClassicViewSpec.Assets.md index 0dd9c492..ccb8b816 100644 --- a/docs/reference/toloka.client.project.view_spec.ClassicViewSpec.Assets.md +++ b/docs/reference/toloka.client.project.view_spec.ClassicViewSpec.Assets.md @@ -1,7 +1,7 @@ # Assets -`toloka.client.project.view_spec.ClassicViewSpec.Assets` +`toloka.client.project.view_spec.ClassicViewSpec.Assets` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/view_spec.py#L80) -``` +```python Assets( self, *, diff --git a/docs/reference/toloka.client.project.view_spec.ClassicViewSpec.md b/docs/reference/toloka.client.project.view_spec.ClassicViewSpec.md index b3ef93ba..61e864f0 100644 --- a/docs/reference/toloka.client.project.view_spec.ClassicViewSpec.md +++ b/docs/reference/toloka.client.project.view_spec.ClassicViewSpec.md @@ -1,7 +1,7 @@ # ClassicViewSpec -`toloka.client.project.view_spec.ClassicViewSpec` +`toloka.client.project.view_spec.ClassicViewSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/view_spec.py#L64) -``` +```python ClassicViewSpec( self, *, diff --git a/docs/reference/toloka.client.project.view_spec.TemplateBuilderViewSpec.md b/docs/reference/toloka.client.project.view_spec.TemplateBuilderViewSpec.md index 3b6a4927..73a9d3ba 100644 --- a/docs/reference/toloka.client.project.view_spec.TemplateBuilderViewSpec.md +++ b/docs/reference/toloka.client.project.view_spec.TemplateBuilderViewSpec.md @@ -1,7 +1,7 @@ # TemplateBuilderViewSpec -`toloka.client.project.view_spec.TemplateBuilderViewSpec` +`toloka.client.project.view_spec.TemplateBuilderViewSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/view_spec.py#L115) -``` +```python TemplateBuilderViewSpec( self, *, diff --git a/docs/reference/toloka.client.project.view_spec.ViewSpec.Settings.md b/docs/reference/toloka.client.project.view_spec.ViewSpec.Settings.md index 326fe645..bc894e3d 100644 --- a/docs/reference/toloka.client.project.view_spec.ViewSpec.Settings.md +++ b/docs/reference/toloka.client.project.view_spec.ViewSpec.Settings.md @@ -1,7 +1,7 @@ # Settings -`toloka.client.project.view_spec.ViewSpec.Settings` +`toloka.client.project.view_spec.ViewSpec.Settings` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/view_spec.py#L36) -``` +```python Settings( self, *, diff --git a/docs/reference/toloka.client.project.view_spec.ViewSpec.Type.md b/docs/reference/toloka.client.project.view_spec.ViewSpec.Type.md index f31466ef..1afa260d 100644 --- a/docs/reference/toloka.client.project.view_spec.ViewSpec.Type.md +++ b/docs/reference/toloka.client.project.view_spec.ViewSpec.Type.md @@ -1,5 +1,5 @@ # Type -`toloka.client.project.view_spec.ViewSpec.Type` +`toloka.client.project.view_spec.ViewSpec.Type` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/view_spec.py#L22) A view spec type diff --git a/docs/reference/toloka.client.project.view_spec.ViewSpec.md b/docs/reference/toloka.client.project.view_spec.ViewSpec.md index 6e3e846e..f3a9392a 100644 --- a/docs/reference/toloka.client.project.view_spec.ViewSpec.md +++ b/docs/reference/toloka.client.project.view_spec.ViewSpec.md @@ -1,7 +1,7 @@ # ViewSpec -`toloka.client.project.view_spec.ViewSpec` +`toloka.client.project.view_spec.ViewSpec` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/project/view_spec.py#L19) -``` +```python ViewSpec(self, *, settings: Optional[Settings] = None) ``` diff --git a/docs/reference/toloka.client.quality_control.QualityControl.CaptchaFrequency.md b/docs/reference/toloka.client.quality_control.QualityControl.CaptchaFrequency.md index be0f8d40..3d557464 100644 --- a/docs/reference/toloka.client.quality_control.QualityControl.CaptchaFrequency.md +++ b/docs/reference/toloka.client.quality_control.QualityControl.CaptchaFrequency.md @@ -1,5 +1,5 @@ # CaptchaFrequency -`toloka.client.quality_control.QualityControl.CaptchaFrequency` +`toloka.client.quality_control.QualityControl.CaptchaFrequency` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/quality_control.py#L56) An enumeration. diff --git a/docs/reference/toloka.client.quality_control.QualityControl.CheckpointsConfig.Settings.md b/docs/reference/toloka.client.quality_control.QualityControl.CheckpointsConfig.Settings.md index 76a9908c..75529a02 100644 --- a/docs/reference/toloka.client.quality_control.QualityControl.CheckpointsConfig.Settings.md +++ b/docs/reference/toloka.client.quality_control.QualityControl.CheckpointsConfig.Settings.md @@ -1,7 +1,7 @@ # Settings -`toloka.client.quality_control.QualityControl.CheckpointsConfig.Settings` +`toloka.client.quality_control.QualityControl.CheckpointsConfig.Settings` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/quality_control.py#L80) -``` +```python Settings( self, *, diff --git a/docs/reference/toloka.client.quality_control.QualityControl.CheckpointsConfig.md b/docs/reference/toloka.client.quality_control.QualityControl.CheckpointsConfig.md index b11ee7fd..12c837c6 100644 --- a/docs/reference/toloka.client.quality_control.QualityControl.CheckpointsConfig.md +++ b/docs/reference/toloka.client.quality_control.QualityControl.CheckpointsConfig.md @@ -1,7 +1,7 @@ # CheckpointsConfig -`toloka.client.quality_control.QualityControl.CheckpointsConfig` +`toloka.client.quality_control.QualityControl.CheckpointsConfig` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/quality_control.py#L62) -``` +```python CheckpointsConfig( self, *, diff --git a/docs/reference/toloka.client.quality_control.QualityControl.QualityControlConfig.RuleConfig.md b/docs/reference/toloka.client.quality_control.QualityControl.QualityControlConfig.RuleConfig.md index 120f52c4..7666be6d 100644 --- a/docs/reference/toloka.client.quality_control.QualityControl.QualityControlConfig.RuleConfig.md +++ b/docs/reference/toloka.client.quality_control.QualityControl.QualityControlConfig.RuleConfig.md @@ -1,7 +1,7 @@ # RuleConfig -`toloka.client.quality_control.QualityControl.QualityControlConfig.RuleConfig` +`toloka.client.quality_control.QualityControl.QualityControlConfig.RuleConfig` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/quality_control.py#L109) -``` +```python RuleConfig( self, *, diff --git a/docs/reference/toloka.client.quality_control.QualityControl.QualityControlConfig.md b/docs/reference/toloka.client.quality_control.QualityControl.QualityControlConfig.md index eb81595c..383888b0 100644 --- a/docs/reference/toloka.client.quality_control.QualityControl.QualityControlConfig.md +++ b/docs/reference/toloka.client.quality_control.QualityControl.QualityControlConfig.md @@ -1,7 +1,7 @@ # QualityControlConfig -`toloka.client.quality_control.QualityControl.QualityControlConfig` +`toloka.client.quality_control.QualityControl.QualityControlConfig` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/quality_control.py#L95) -``` +```python QualityControlConfig( self, *, diff --git a/docs/reference/toloka.client.quality_control.QualityControl.TrainingRequirement.md b/docs/reference/toloka.client.quality_control.QualityControl.TrainingRequirement.md index 24d3f4a4..05ffc720 100644 --- a/docs/reference/toloka.client.quality_control.QualityControl.TrainingRequirement.md +++ b/docs/reference/toloka.client.quality_control.QualityControl.TrainingRequirement.md @@ -1,7 +1,7 @@ # TrainingRequirement -`toloka.client.quality_control.QualityControl.TrainingRequirement` +`toloka.client.quality_control.QualityControl.TrainingRequirement` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/quality_control.py#L44) -``` +```python TrainingRequirement( self, *, diff --git a/docs/reference/toloka.client.quality_control.QualityControl.add_action.md b/docs/reference/toloka.client.quality_control.QualityControl.add_action.md index 3004854f..a2329a2a 100644 --- a/docs/reference/toloka.client.quality_control.QualityControl.add_action.md +++ b/docs/reference/toloka.client.quality_control.QualityControl.add_action.md @@ -1,7 +1,7 @@ # add_action -`toloka.client.quality_control.QualityControl.add_action` +`toloka.client.quality_control.QualityControl.add_action` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/quality_control.py#L130) -``` +```python add_action( self, collector: CollectorConfig, diff --git a/docs/reference/toloka.client.quality_control.QualityControl.md b/docs/reference/toloka.client.quality_control.QualityControl.md index abae6753..dd40685a 100644 --- a/docs/reference/toloka.client.quality_control.QualityControl.md +++ b/docs/reference/toloka.client.quality_control.QualityControl.md @@ -1,7 +1,7 @@ # QualityControl -`toloka.client.quality_control.QualityControl` +`toloka.client.quality_control.QualityControl` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/quality_control.py#L13) -``` +```python QualityControl( self, *, @@ -44,7 +44,7 @@ new_pool.quality_control.add_action( ) ) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.requester.Requester.Company.md b/docs/reference/toloka.client.requester.Requester.Company.md index 1a744922..98b0a05a 100644 --- a/docs/reference/toloka.client.requester.Requester.Company.md +++ b/docs/reference/toloka.client.requester.Requester.Company.md @@ -1,7 +1,7 @@ # Company -`toloka.client.requester.Requester.Company` +`toloka.client.requester.Requester.Company` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/requester.py#L19) -``` +```python Company( self, *, diff --git a/docs/reference/toloka.client.requester.Requester.md b/docs/reference/toloka.client.requester.Requester.md index 5c0dad0d..97b014bf 100644 --- a/docs/reference/toloka.client.requester.Requester.md +++ b/docs/reference/toloka.client.requester.Requester.md @@ -1,7 +1,7 @@ # Requester -`toloka.client.requester.Requester` +`toloka.client.requester.Requester` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/requester.py#L9) -``` +```python Requester( self, *, diff --git a/docs/reference/toloka.client.search_requests.AggregatedSolutionSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.AggregatedSolutionSearchRequest.CompareFields.md index 3934f459..322eacae 100644 --- a/docs/reference/toloka.client.search_requests.AggregatedSolutionSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.AggregatedSolutionSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.AggregatedSolutionSearchRequest.CompareFields` +`toloka.client.search_requests.AggregatedSolutionSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L505) diff --git a/docs/reference/toloka.client.search_requests.AggregatedSolutionSearchRequest.md b/docs/reference/toloka.client.search_requests.AggregatedSolutionSearchRequest.md index 93b3ea56..088a3f28 100644 --- a/docs/reference/toloka.client.search_requests.AggregatedSolutionSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.AggregatedSolutionSearchRequest.md @@ -1,7 +1,7 @@ # AggregatedSolutionSearchRequest -`toloka.client.search_requests.AggregatedSolutionSearchRequest` +`toloka.client.search_requests.AggregatedSolutionSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L495) -``` +```python AggregatedSolutionSearchRequest( self, task_id_lt: Optional[str] = None, diff --git a/docs/reference/toloka.client.search_requests.AggregatedSolutionSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.AggregatedSolutionSortItems.SortItem.md index 87a7c22d..8e7626be 100644 --- a/docs/reference/toloka.client.search_requests.AggregatedSolutionSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.AggregatedSolutionSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.AggregatedSolutionSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.AggregatedSolutionSortItems.md b/docs/reference/toloka.client.search_requests.AggregatedSolutionSortItems.md index 190242cd..eff8dfd4 100644 --- a/docs/reference/toloka.client.search_requests.AggregatedSolutionSortItems.md +++ b/docs/reference/toloka.client.search_requests.AggregatedSolutionSortItems.md @@ -1,7 +1,7 @@ # AggregatedSolutionSortItems `toloka.client.search_requests.AggregatedSolutionSortItems` -``` +```python AggregatedSolutionSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.AppBatchSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.AppBatchSearchRequest.CompareFields.md index c075534c..cb2d99e8 100644 --- a/docs/reference/toloka.client.search_requests.AppBatchSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.AppBatchSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.AppBatchSearchRequest.CompareFields` +`toloka.client.search_requests.AppBatchSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L1136) diff --git a/docs/reference/toloka.client.search_requests.AppBatchSearchRequest.md b/docs/reference/toloka.client.search_requests.AppBatchSearchRequest.md index 17da7fdb..f60724da 100644 --- a/docs/reference/toloka.client.search_requests.AppBatchSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.AppBatchSearchRequest.md @@ -1,7 +1,7 @@ # AppBatchSearchRequest -`toloka.client.search_requests.AppBatchSearchRequest` +`toloka.client.search_requests.AppBatchSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L1112) -``` +```python AppBatchSearchRequest( self, after_id: Optional[str] = None, diff --git a/docs/reference/toloka.client.search_requests.AppBatchSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.AppBatchSortItems.SortItem.md index 581e7bd9..0ad0ee72 100644 --- a/docs/reference/toloka.client.search_requests.AppBatchSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.AppBatchSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.AppBatchSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.AppBatchSortItems.md b/docs/reference/toloka.client.search_requests.AppBatchSortItems.md index d1234d2f..81bf8978 100644 --- a/docs/reference/toloka.client.search_requests.AppBatchSortItems.md +++ b/docs/reference/toloka.client.search_requests.AppBatchSortItems.md @@ -1,7 +1,7 @@ # AppBatchSortItems `toloka.client.search_requests.AppBatchSortItems` -``` +```python AppBatchSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.AppItemSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.AppItemSearchRequest.CompareFields.md index 6044a9bc..6c2bf495 100644 --- a/docs/reference/toloka.client.search_requests.AppItemSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.AppItemSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.AppItemSearchRequest.CompareFields` +`toloka.client.search_requests.AppItemSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L1087) diff --git a/docs/reference/toloka.client.search_requests.AppItemSearchRequest.md b/docs/reference/toloka.client.search_requests.AppItemSearchRequest.md index 175d3317..00a5638b 100644 --- a/docs/reference/toloka.client.search_requests.AppItemSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.AppItemSearchRequest.md @@ -1,7 +1,7 @@ # AppItemSearchRequest -`toloka.client.search_requests.AppItemSearchRequest` +`toloka.client.search_requests.AppItemSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L1065) -``` +```python AppItemSearchRequest( self, after_id: Optional[str] = None, diff --git a/docs/reference/toloka.client.search_requests.AppItemSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.AppItemSortItems.SortItem.md index bbfb3e1b..60ef47d2 100644 --- a/docs/reference/toloka.client.search_requests.AppItemSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.AppItemSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.AppItemSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.AppItemSortItems.md b/docs/reference/toloka.client.search_requests.AppItemSortItems.md index 3bce6130..d10b96cf 100644 --- a/docs/reference/toloka.client.search_requests.AppItemSortItems.md +++ b/docs/reference/toloka.client.search_requests.AppItemSortItems.md @@ -1,7 +1,7 @@ # AppItemSortItems `toloka.client.search_requests.AppItemSortItems` -``` +```python AppItemSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.AppProjectSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.AppProjectSearchRequest.CompareFields.md index 256473e3..a1b5f1ea 100644 --- a/docs/reference/toloka.client.search_requests.AppProjectSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.AppProjectSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.AppProjectSearchRequest.CompareFields` +`toloka.client.search_requests.AppProjectSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L988) diff --git a/docs/reference/toloka.client.search_requests.AppProjectSearchRequest.Scope.md b/docs/reference/toloka.client.search_requests.AppProjectSearchRequest.Scope.md index 72a1d6cc..31283f51 100644 --- a/docs/reference/toloka.client.search_requests.AppProjectSearchRequest.Scope.md +++ b/docs/reference/toloka.client.search_requests.AppProjectSearchRequest.Scope.md @@ -1,5 +1,5 @@ # Scope -`toloka.client.search_requests.AppProjectSearchRequest.Scope` +`toloka.client.search_requests.AppProjectSearchRequest.Scope` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L982) An enumeration. diff --git a/docs/reference/toloka.client.search_requests.AppProjectSearchRequest.md b/docs/reference/toloka.client.search_requests.AppProjectSearchRequest.md index 9d85bef6..2c450c38 100644 --- a/docs/reference/toloka.client.search_requests.AppProjectSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.AppProjectSearchRequest.md @@ -1,7 +1,7 @@ # AppProjectSearchRequest -`toloka.client.search_requests.AppProjectSearchRequest` +`toloka.client.search_requests.AppProjectSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L950) -``` +```python AppProjectSearchRequest( self, app_id: Optional[str] = None, @@ -9,7 +9,7 @@ AppProjectSearchRequest( status: Optional[AppProject.Status] = None, after_id: Optional[str] = None, scope: Optional[Scope] = None, - requester_ids: Union[str, List[str]] = None, + requester_ids: Union[str, List[str], None] = None, id_lt: Optional[str] = None, id_lte: Optional[str] = None, id_gt: Optional[str] = None, diff --git a/docs/reference/toloka.client.search_requests.AppProjectSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.AppProjectSortItems.SortItem.md index 0a43d62b..4cca001e 100644 --- a/docs/reference/toloka.client.search_requests.AppProjectSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.AppProjectSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.AppProjectSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.AppProjectSortItems.md b/docs/reference/toloka.client.search_requests.AppProjectSortItems.md index 8971a09a..14e12e2c 100644 --- a/docs/reference/toloka.client.search_requests.AppProjectSortItems.md +++ b/docs/reference/toloka.client.search_requests.AppProjectSortItems.md @@ -1,7 +1,7 @@ # AppProjectSortItems `toloka.client.search_requests.AppProjectSortItems` -``` +```python AppProjectSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.AppSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.AppSearchRequest.CompareFields.md index b90c1f19..e82ff616 100644 --- a/docs/reference/toloka.client.search_requests.AppSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.AppSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.AppSearchRequest.CompareFields` +`toloka.client.search_requests.AppSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L1042) diff --git a/docs/reference/toloka.client.search_requests.AppSearchRequest.md b/docs/reference/toloka.client.search_requests.AppSearchRequest.md index 760236ba..37003c94 100644 --- a/docs/reference/toloka.client.search_requests.AppSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.AppSearchRequest.md @@ -1,7 +1,7 @@ # AppSearchRequest -`toloka.client.search_requests.AppSearchRequest` +`toloka.client.search_requests.AppSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L1027) -``` +```python AppSearchRequest( self, after_id: Optional[str] = None, diff --git a/docs/reference/toloka.client.search_requests.AppSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.AppSortItems.SortItem.md index c892b9d5..68ed0f0f 100644 --- a/docs/reference/toloka.client.search_requests.AppSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.AppSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.AppSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.AppSortItems.md b/docs/reference/toloka.client.search_requests.AppSortItems.md index 386ca956..41539a1a 100644 --- a/docs/reference/toloka.client.search_requests.AppSortItems.md +++ b/docs/reference/toloka.client.search_requests.AppSortItems.md @@ -1,7 +1,7 @@ # AppSortItems `toloka.client.search_requests.AppSortItems` -``` +```python AppSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.AssignmentSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.AssignmentSearchRequest.CompareFields.md index 52f7c6e0..ae60aaed 100644 --- a/docs/reference/toloka.client.search_requests.AssignmentSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.AssignmentSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.AssignmentSearchRequest.CompareFields` +`toloka.client.search_requests.AssignmentSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L430) diff --git a/docs/reference/toloka.client.search_requests.AssignmentSearchRequest.md b/docs/reference/toloka.client.search_requests.AssignmentSearchRequest.md index 7166473d..0ba6daae 100644 --- a/docs/reference/toloka.client.search_requests.AssignmentSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.AssignmentSearchRequest.md @@ -1,10 +1,10 @@ # AssignmentSearchRequest -`toloka.client.search_requests.AssignmentSearchRequest` +`toloka.client.search_requests.AssignmentSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L384) -``` +```python AssignmentSearchRequest( self, - status: Union[str, Assignment.Status, List[Union[str, Assignment.Status]]] = None, + status: Union[str, Assignment.Status, List[Union[str, Assignment.Status]], None] = None, task_id: Optional[str] = None, task_suite_id: Optional[str] = None, pool_id: Optional[str] = None, diff --git a/docs/reference/toloka.client.search_requests.AssignmentSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.AssignmentSortItems.SortItem.md index 69a7fa70..aee5e3f6 100644 --- a/docs/reference/toloka.client.search_requests.AssignmentSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.AssignmentSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.AssignmentSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.AssignmentSortItems.md b/docs/reference/toloka.client.search_requests.AssignmentSortItems.md index 6c843453..07c79478 100644 --- a/docs/reference/toloka.client.search_requests.AssignmentSortItems.md +++ b/docs/reference/toloka.client.search_requests.AssignmentSortItems.md @@ -1,7 +1,7 @@ # AssignmentSortItems `toloka.client.search_requests.AssignmentSortItems` -``` +```python AssignmentSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.AttachmentSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.AttachmentSearchRequest.CompareFields.md index 408a352a..6546f1f6 100644 --- a/docs/reference/toloka.client.search_requests.AttachmentSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.AttachmentSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.AttachmentSearchRequest.CompareFields` +`toloka.client.search_requests.AttachmentSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L651) diff --git a/docs/reference/toloka.client.search_requests.AttachmentSearchRequest.md b/docs/reference/toloka.client.search_requests.AttachmentSearchRequest.md index 3a2dff78..ab73f2fd 100644 --- a/docs/reference/toloka.client.search_requests.AttachmentSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.AttachmentSearchRequest.md @@ -1,7 +1,7 @@ # AttachmentSearchRequest -`toloka.client.search_requests.AttachmentSearchRequest` +`toloka.client.search_requests.AttachmentSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L630) -``` +```python AttachmentSearchRequest( self, name: Optional[str] = None, diff --git a/docs/reference/toloka.client.search_requests.AttachmentSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.AttachmentSortItems.SortItem.md index 9165dea2..887bfa93 100644 --- a/docs/reference/toloka.client.search_requests.AttachmentSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.AttachmentSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.AttachmentSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.AttachmentSortItems.md b/docs/reference/toloka.client.search_requests.AttachmentSortItems.md index d76380d9..0bcdcfb7 100644 --- a/docs/reference/toloka.client.search_requests.AttachmentSortItems.md +++ b/docs/reference/toloka.client.search_requests.AttachmentSortItems.md @@ -1,7 +1,7 @@ # AttachmentSortItems `toloka.client.search_requests.AttachmentSortItems` -``` +```python AttachmentSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.BaseSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.BaseSearchRequest.CompareFields.md index 898a37b2..a85c6e87 100644 --- a/docs/reference/toloka.client.search_requests.BaseSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.BaseSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.BaseSearchRequest.CompareFields` +`toloka.client.search_requests.BaseSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L171) diff --git a/docs/reference/toloka.client.search_requests.BaseSearchRequest.md b/docs/reference/toloka.client.search_requests.BaseSearchRequest.md index 9ea37484..097f271c 100644 --- a/docs/reference/toloka.client.search_requests.BaseSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.BaseSearchRequest.md @@ -1,7 +1,7 @@ # BaseSearchRequest -`toloka.client.search_requests.BaseSearchRequest` +`toloka.client.search_requests.BaseSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L167) -``` +```python BaseSearchRequest(self) ``` diff --git a/docs/reference/toloka.client.search_requests.BaseSortItem.for_fields.md b/docs/reference/toloka.client.search_requests.BaseSortItem.for_fields.md index db22eb06..79c3e8fa 100644 --- a/docs/reference/toloka.client.search_requests.BaseSortItem.for_fields.md +++ b/docs/reference/toloka.client.search_requests.BaseSortItem.for_fields.md @@ -1,7 +1,7 @@ # for_fields -`toloka.client.search_requests.BaseSortItem.for_fields` +`toloka.client.search_requests.BaseSortItem.for_fields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L96) -``` +```python for_fields( cls, qualname: str, diff --git a/docs/reference/toloka.client.search_requests.BaseSortItem.md b/docs/reference/toloka.client.search_requests.BaseSortItem.md index aea287f0..84b2a860 100644 --- a/docs/reference/toloka.client.search_requests.BaseSortItem.md +++ b/docs/reference/toloka.client.search_requests.BaseSortItem.md @@ -1,11 +1,11 @@ # BaseSortItem -`toloka.client.search_requests.BaseSortItem` +`toloka.client.search_requests.BaseSortItem` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L73) -``` +```python BaseSortItem(self) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.search_requests.BaseSortItems.for_fields.md b/docs/reference/toloka.client.search_requests.BaseSortItems.for_fields.md index 64481d98..6bd1c3c1 100644 --- a/docs/reference/toloka.client.search_requests.BaseSortItems.for_fields.md +++ b/docs/reference/toloka.client.search_requests.BaseSortItems.for_fields.md @@ -1,7 +1,7 @@ # for_fields -`toloka.client.search_requests.BaseSortItems.for_fields` +`toloka.client.search_requests.BaseSortItems.for_fields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L125) -``` +```python for_fields( cls, qualname: str, diff --git a/docs/reference/toloka.client.search_requests.BaseSortItems.md b/docs/reference/toloka.client.search_requests.BaseSortItems.md index 18764531..5205207c 100644 --- a/docs/reference/toloka.client.search_requests.BaseSortItems.md +++ b/docs/reference/toloka.client.search_requests.BaseSortItems.md @@ -1,11 +1,11 @@ # BaseSortItems -`toloka.client.search_requests.BaseSortItems` +`toloka.client.search_requests.BaseSortItems` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L114) -``` +```python BaseSortItems(self) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.search_requests.MessageThreadSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.MessageThreadSearchRequest.CompareFields.md index 96c55a12..61a30c21 100644 --- a/docs/reference/toloka.client.search_requests.MessageThreadSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.MessageThreadSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.MessageThreadSearchRequest.CompareFields` +`toloka.client.search_requests.MessageThreadSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L858) diff --git a/docs/reference/toloka.client.search_requests.MessageThreadSearchRequest.md b/docs/reference/toloka.client.search_requests.MessageThreadSearchRequest.md index c3301a3e..fcbbb2db 100644 --- a/docs/reference/toloka.client.search_requests.MessageThreadSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.MessageThreadSearchRequest.md @@ -1,11 +1,11 @@ # MessageThreadSearchRequest -`toloka.client.search_requests.MessageThreadSearchRequest` +`toloka.client.search_requests.MessageThreadSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L842) -``` +```python MessageThreadSearchRequest( self, - folder: Union[str, Folder, List[Union[str, Folder]]] = None, - folder_ne: Union[str, Folder, List[Union[str, Folder]]] = None, + folder: Union[str, Folder, List[Union[str, Folder]], None] = None, + folder_ne: Union[str, Folder, List[Union[str, Folder]], None] = None, id_lt: Optional[str] = None, id_lte: Optional[str] = None, id_gt: Optional[str] = None, diff --git a/docs/reference/toloka.client.search_requests.MessageThreadSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.MessageThreadSortItems.SortItem.md index 8f795582..c8015230 100644 --- a/docs/reference/toloka.client.search_requests.MessageThreadSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.MessageThreadSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.MessageThreadSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.MessageThreadSortItems.md b/docs/reference/toloka.client.search_requests.MessageThreadSortItems.md index fe04a019..9fceaf84 100644 --- a/docs/reference/toloka.client.search_requests.MessageThreadSortItems.md +++ b/docs/reference/toloka.client.search_requests.MessageThreadSortItems.md @@ -1,7 +1,7 @@ # MessageThreadSortItems `toloka.client.search_requests.MessageThreadSortItems` -``` +```python MessageThreadSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.PoolSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.PoolSearchRequest.CompareFields.md index 08ecf61e..476e8b5a 100644 --- a/docs/reference/toloka.client.search_requests.PoolSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.PoolSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.PoolSearchRequest.CompareFields` +`toloka.client.search_requests.PoolSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L248) diff --git a/docs/reference/toloka.client.search_requests.PoolSearchRequest.md b/docs/reference/toloka.client.search_requests.PoolSearchRequest.md index 40dd8122..8006902f 100644 --- a/docs/reference/toloka.client.search_requests.PoolSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.PoolSearchRequest.md @@ -1,7 +1,7 @@ # PoolSearchRequest -`toloka.client.search_requests.PoolSearchRequest` +`toloka.client.search_requests.PoolSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L224) -``` +```python PoolSearchRequest( self, status: Optional[Pool.Status] = None, diff --git a/docs/reference/toloka.client.search_requests.PoolSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.PoolSortItems.SortItem.md index 48c966db..8f5bfc1d 100644 --- a/docs/reference/toloka.client.search_requests.PoolSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.PoolSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.PoolSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.PoolSortItems.md b/docs/reference/toloka.client.search_requests.PoolSortItems.md index 5a3979f7..44214de9 100644 --- a/docs/reference/toloka.client.search_requests.PoolSortItems.md +++ b/docs/reference/toloka.client.search_requests.PoolSortItems.md @@ -1,7 +1,7 @@ # PoolSortItems `toloka.client.search_requests.PoolSortItems` -``` +```python PoolSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.ProjectSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.ProjectSearchRequest.CompareFields.md index e50e2321..b4d4695d 100644 --- a/docs/reference/toloka.client.search_requests.ProjectSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.ProjectSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.ProjectSearchRequest.CompareFields` +`toloka.client.search_requests.ProjectSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L192) diff --git a/docs/reference/toloka.client.search_requests.ProjectSearchRequest.md b/docs/reference/toloka.client.search_requests.ProjectSearchRequest.md index 43ded01d..61d46612 100644 --- a/docs/reference/toloka.client.search_requests.ProjectSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.ProjectSearchRequest.md @@ -1,7 +1,7 @@ # ProjectSearchRequest -`toloka.client.search_requests.ProjectSearchRequest` +`toloka.client.search_requests.ProjectSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L175) -``` +```python ProjectSearchRequest( self, status: Optional[Project.ProjectStatus] = None, diff --git a/docs/reference/toloka.client.search_requests.ProjectSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.ProjectSortItems.SortItem.md index 378cee1a..72f920c2 100644 --- a/docs/reference/toloka.client.search_requests.ProjectSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.ProjectSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.ProjectSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.ProjectSortItems.md b/docs/reference/toloka.client.search_requests.ProjectSortItems.md index 0ccf612d..2e42cdb6 100644 --- a/docs/reference/toloka.client.search_requests.ProjectSortItems.md +++ b/docs/reference/toloka.client.search_requests.ProjectSortItems.md @@ -1,7 +1,7 @@ # ProjectSortItems `toloka.client.search_requests.ProjectSortItems` -``` +```python ProjectSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.SearchRequestMetaclass.md b/docs/reference/toloka.client.search_requests.SearchRequestMetaclass.md index ea3de3dc..98692a7e 100644 --- a/docs/reference/toloka.client.search_requests.SearchRequestMetaclass.md +++ b/docs/reference/toloka.client.search_requests.SearchRequestMetaclass.md @@ -1,3 +1,3 @@ # SearchRequestMetaclass -`toloka.client.search_requests.SearchRequestMetaclass` +`toloka.client.search_requests.SearchRequestMetaclass` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L148) diff --git a/docs/reference/toloka.client.search_requests.SkillSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.SkillSearchRequest.CompareFields.md index 5e461b88..1cd22614 100644 --- a/docs/reference/toloka.client.search_requests.SkillSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.SkillSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.SkillSearchRequest.CompareFields` +`toloka.client.search_requests.SkillSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L354) diff --git a/docs/reference/toloka.client.search_requests.SkillSearchRequest.md b/docs/reference/toloka.client.search_requests.SkillSearchRequest.md index 7f5a42c4..10fdb772 100644 --- a/docs/reference/toloka.client.search_requests.SkillSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.SkillSearchRequest.md @@ -1,7 +1,7 @@ # SkillSearchRequest -`toloka.client.search_requests.SkillSearchRequest` +`toloka.client.search_requests.SkillSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L339) -``` +```python SkillSearchRequest( self, name: Optional[str] = None, diff --git a/docs/reference/toloka.client.search_requests.SkillSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.SkillSortItems.SortItem.md index 62387111..58a3414c 100644 --- a/docs/reference/toloka.client.search_requests.SkillSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.SkillSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.SkillSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.SkillSortItems.md b/docs/reference/toloka.client.search_requests.SkillSortItems.md index 68df013b..e4267f5f 100644 --- a/docs/reference/toloka.client.search_requests.SkillSortItems.md +++ b/docs/reference/toloka.client.search_requests.SkillSortItems.md @@ -1,7 +1,7 @@ # SkillSortItems `toloka.client.search_requests.SkillSortItems` -``` +```python SkillSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.SortOrder.md b/docs/reference/toloka.client.search_requests.SortOrder.md index 934c8498..0eb07ee6 100644 --- a/docs/reference/toloka.client.search_requests.SortOrder.md +++ b/docs/reference/toloka.client.search_requests.SortOrder.md @@ -1,5 +1,5 @@ # SortOrder -`toloka.client.search_requests.SortOrder` +`toloka.client.search_requests.SortOrder` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L67) An enumeration. diff --git a/docs/reference/toloka.client.search_requests.TaskSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.TaskSearchRequest.CompareFields.md index ac8927a6..c2b6eaf3 100644 --- a/docs/reference/toloka.client.search_requests.TaskSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.TaskSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.TaskSearchRequest.CompareFields` +`toloka.client.search_requests.TaskSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L543) diff --git a/docs/reference/toloka.client.search_requests.TaskSearchRequest.md b/docs/reference/toloka.client.search_requests.TaskSearchRequest.md index cb978b34..72d8a323 100644 --- a/docs/reference/toloka.client.search_requests.TaskSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.TaskSearchRequest.md @@ -1,7 +1,7 @@ # TaskSearchRequest -`toloka.client.search_requests.TaskSearchRequest` +`toloka.client.search_requests.TaskSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L523) -``` +```python TaskSearchRequest( self, pool_id: Optional[str] = None, @@ -27,7 +27,7 @@ Parameters for searching tasks | Parameters | Type | Description | | :----------| :----| :-----------| -`pool_id`|**Optional\[str\]**|

ID of the pool to get tasks from.

+`pool_id`|**Optional\[str\]**|

The ID of the pool to get tasks from.

`overlap`|**Optional\[int\]**|

Tasks with an overlap equal to the specified value.

`id_lt`|**Optional\[str\]**|

Tasks with an ID less than the specified value.

`id_lte`|**Optional\[str\]**|

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

@@ -38,6 +38,6 @@ Parameters for searching tasks `created_gt`|**Optional\[datetime\]**|

Tasks created after the specified date.

`created_gte`|**Optional\[datetime\]**|

Tasks created after or on the specified date.

`overlap_lt`|**Optional\[int\]**|

Tasks with an overlap less than the specified value.

-`overlap_lte`|**Optional\[int\]**|

Tasks with an overlap equal to the specified value.

+`overlap_lte`|**Optional\[int\]**|

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

`overlap_gt`|**Optional\[int\]**|

Tasks with an overlap greater than the specified value.

-`overlap_gte`|**Optional\[int\]**|

Tasks with an overlap equal to the specified value.

+`overlap_gte`|**Optional\[int\]**|

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

diff --git a/docs/reference/toloka.client.search_requests.TaskSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.TaskSortItems.SortItem.md index bbf768e2..63e5af49 100644 --- a/docs/reference/toloka.client.search_requests.TaskSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.TaskSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.TaskSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.TaskSortItems.md b/docs/reference/toloka.client.search_requests.TaskSortItems.md index b2c59fe6..a93de337 100644 --- a/docs/reference/toloka.client.search_requests.TaskSortItems.md +++ b/docs/reference/toloka.client.search_requests.TaskSortItems.md @@ -1,7 +1,7 @@ # TaskSortItems `toloka.client.search_requests.TaskSortItems` -``` +```python TaskSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.TaskSuiteSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.TaskSuiteSearchRequest.CompareFields.md index 66aac6c0..a9821a66 100644 --- a/docs/reference/toloka.client.search_requests.TaskSuiteSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.TaskSuiteSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.TaskSuiteSearchRequest.CompareFields` +`toloka.client.search_requests.TaskSuiteSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L597) diff --git a/docs/reference/toloka.client.search_requests.TaskSuiteSearchRequest.md b/docs/reference/toloka.client.search_requests.TaskSuiteSearchRequest.md index d06fedf9..5c38aa71 100644 --- a/docs/reference/toloka.client.search_requests.TaskSuiteSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.TaskSuiteSearchRequest.md @@ -1,7 +1,7 @@ # TaskSuiteSearchRequest -`toloka.client.search_requests.TaskSuiteSearchRequest` +`toloka.client.search_requests.TaskSuiteSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L575) -``` +```python TaskSuiteSearchRequest( self, task_id: Optional[str] = None, diff --git a/docs/reference/toloka.client.search_requests.TaskSuiteSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.TaskSuiteSortItems.SortItem.md index ba54c9be..fd4fdf6a 100644 --- a/docs/reference/toloka.client.search_requests.TaskSuiteSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.TaskSuiteSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.TaskSuiteSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.TaskSuiteSortItems.md b/docs/reference/toloka.client.search_requests.TaskSuiteSortItems.md index 8ca1f2ba..d95057dc 100644 --- a/docs/reference/toloka.client.search_requests.TaskSuiteSortItems.md +++ b/docs/reference/toloka.client.search_requests.TaskSuiteSortItems.md @@ -1,7 +1,7 @@ # TaskSuiteSortItems `toloka.client.search_requests.TaskSuiteSortItems` -``` +```python TaskSuiteSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.TrainingSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.TrainingSearchRequest.CompareFields.md index 3e3f3cdb..d4d63bc2 100644 --- a/docs/reference/toloka.client.search_requests.TrainingSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.TrainingSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.TrainingSearchRequest.CompareFields` +`toloka.client.search_requests.TrainingSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L306) diff --git a/docs/reference/toloka.client.search_requests.TrainingSearchRequest.md b/docs/reference/toloka.client.search_requests.TrainingSearchRequest.md index e4557e59..6672240f 100644 --- a/docs/reference/toloka.client.search_requests.TrainingSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.TrainingSearchRequest.md @@ -1,7 +1,7 @@ # TrainingSearchRequest -`toloka.client.search_requests.TrainingSearchRequest` +`toloka.client.search_requests.TrainingSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L282) -``` +```python TrainingSearchRequest( self, status: Optional[Training.Status] = None, diff --git a/docs/reference/toloka.client.search_requests.TrainingSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.TrainingSortItems.SortItem.md index bef69130..a8a90fa8 100644 --- a/docs/reference/toloka.client.search_requests.TrainingSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.TrainingSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.TrainingSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.TrainingSortItems.md b/docs/reference/toloka.client.search_requests.TrainingSortItems.md index 1410eea8..b3fbc7e7 100644 --- a/docs/reference/toloka.client.search_requests.TrainingSortItems.md +++ b/docs/reference/toloka.client.search_requests.TrainingSortItems.md @@ -1,7 +1,7 @@ # TrainingSortItems `toloka.client.search_requests.TrainingSortItems` -``` +```python TrainingSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.UserBonusSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.UserBonusSearchRequest.CompareFields.md index ca6ef2c1..fec243eb 100644 --- a/docs/reference/toloka.client.search_requests.UserBonusSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.UserBonusSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.UserBonusSearchRequest.CompareFields` +`toloka.client.search_requests.UserBonusSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L811) diff --git a/docs/reference/toloka.client.search_requests.UserBonusSearchRequest.md b/docs/reference/toloka.client.search_requests.UserBonusSearchRequest.md index f19b2d26..970440a3 100644 --- a/docs/reference/toloka.client.search_requests.UserBonusSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.UserBonusSearchRequest.md @@ -1,7 +1,7 @@ # UserBonusSearchRequest -`toloka.client.search_requests.UserBonusSearchRequest` +`toloka.client.search_requests.UserBonusSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L795) -``` +```python UserBonusSearchRequest( self, user_id: Optional[str] = None, diff --git a/docs/reference/toloka.client.search_requests.UserBonusSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.UserBonusSortItems.SortItem.md index 97780e15..31f909d3 100644 --- a/docs/reference/toloka.client.search_requests.UserBonusSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.UserBonusSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.UserBonusSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.UserBonusSortItems.md b/docs/reference/toloka.client.search_requests.UserBonusSortItems.md index 6d212247..196b9039 100644 --- a/docs/reference/toloka.client.search_requests.UserBonusSortItems.md +++ b/docs/reference/toloka.client.search_requests.UserBonusSortItems.md @@ -1,7 +1,7 @@ # UserBonusSortItems `toloka.client.search_requests.UserBonusSortItems` -``` +```python UserBonusSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.UserRestrictionSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.UserRestrictionSearchRequest.CompareFields.md index 88e978b4..66bfc26d 100644 --- a/docs/reference/toloka.client.search_requests.UserRestrictionSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.UserRestrictionSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.UserRestrictionSearchRequest.CompareFields` +`toloka.client.search_requests.UserRestrictionSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L762) diff --git a/docs/reference/toloka.client.search_requests.UserRestrictionSearchRequest.md b/docs/reference/toloka.client.search_requests.UserRestrictionSearchRequest.md index 8ce72f92..75cc1d29 100644 --- a/docs/reference/toloka.client.search_requests.UserRestrictionSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.UserRestrictionSearchRequest.md @@ -1,7 +1,7 @@ # UserRestrictionSearchRequest -`toloka.client.search_requests.UserRestrictionSearchRequest` +`toloka.client.search_requests.UserRestrictionSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L741) -``` +```python UserRestrictionSearchRequest( self, scope: Optional[UserRestriction.Scope] = None, diff --git a/docs/reference/toloka.client.search_requests.UserRestrictionSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.UserRestrictionSortItems.SortItem.md index c9785270..b9388305 100644 --- a/docs/reference/toloka.client.search_requests.UserRestrictionSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.UserRestrictionSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.UserRestrictionSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.UserRestrictionSortItems.md b/docs/reference/toloka.client.search_requests.UserRestrictionSortItems.md index 62eb35c2..bec0e69b 100644 --- a/docs/reference/toloka.client.search_requests.UserRestrictionSortItems.md +++ b/docs/reference/toloka.client.search_requests.UserRestrictionSortItems.md @@ -1,7 +1,7 @@ # UserRestrictionSortItems `toloka.client.search_requests.UserRestrictionSortItems` -``` +```python UserRestrictionSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.UserSkillSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.UserSkillSearchRequest.CompareFields.md index 82c542ca..ea13ec15 100644 --- a/docs/reference/toloka.client.search_requests.UserSkillSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.UserSkillSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.UserSkillSearchRequest.CompareFields` +`toloka.client.search_requests.UserSkillSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L708) diff --git a/docs/reference/toloka.client.search_requests.UserSkillSearchRequest.md b/docs/reference/toloka.client.search_requests.UserSkillSearchRequest.md index 373cc242..d3fa905e 100644 --- a/docs/reference/toloka.client.search_requests.UserSkillSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.UserSkillSearchRequest.md @@ -1,7 +1,7 @@ # UserSkillSearchRequest -`toloka.client.search_requests.UserSkillSearchRequest` +`toloka.client.search_requests.UserSkillSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L688) -``` +```python UserSkillSearchRequest( self, user_id: Optional[str] = None, diff --git a/docs/reference/toloka.client.search_requests.UserSkillSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.UserSkillSortItems.SortItem.md index 284fd5ff..93d4b346 100644 --- a/docs/reference/toloka.client.search_requests.UserSkillSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.UserSkillSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.UserSkillSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.UserSkillSortItems.md b/docs/reference/toloka.client.search_requests.UserSkillSortItems.md index 91f18c2d..64fb54e1 100644 --- a/docs/reference/toloka.client.search_requests.UserSkillSortItems.md +++ b/docs/reference/toloka.client.search_requests.UserSkillSortItems.md @@ -1,7 +1,7 @@ # UserSkillSortItems `toloka.client.search_requests.UserSkillSortItems` -``` +```python UserSkillSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_requests.WebhookSubscriptionSearchRequest.CompareFields.md b/docs/reference/toloka.client.search_requests.WebhookSubscriptionSearchRequest.CompareFields.md index 1bc890bb..11a1a283 100644 --- a/docs/reference/toloka.client.search_requests.WebhookSubscriptionSearchRequest.CompareFields.md +++ b/docs/reference/toloka.client.search_requests.WebhookSubscriptionSearchRequest.CompareFields.md @@ -1,3 +1,3 @@ # CompareFields -`toloka.client.search_requests.WebhookSubscriptionSearchRequest.CompareFields` +`toloka.client.search_requests.WebhookSubscriptionSearchRequest.CompareFields` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L919) diff --git a/docs/reference/toloka.client.search_requests.WebhookSubscriptionSearchRequest.md b/docs/reference/toloka.client.search_requests.WebhookSubscriptionSearchRequest.md index 2ed779cc..fca96dae 100644 --- a/docs/reference/toloka.client.search_requests.WebhookSubscriptionSearchRequest.md +++ b/docs/reference/toloka.client.search_requests.WebhookSubscriptionSearchRequest.md @@ -1,7 +1,7 @@ # WebhookSubscriptionSearchRequest -`toloka.client.search_requests.WebhookSubscriptionSearchRequest` +`toloka.client.search_requests.WebhookSubscriptionSearchRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/search_requests.py#L903) -``` +```python WebhookSubscriptionSearchRequest( self, event_type: Optional[WebhookSubscription.EventType] = None, diff --git a/docs/reference/toloka.client.search_requests.WebhookSubscriptionSortItems.SortItem.md b/docs/reference/toloka.client.search_requests.WebhookSubscriptionSortItems.SortItem.md index 21121cf8..bfe39d9e 100644 --- a/docs/reference/toloka.client.search_requests.WebhookSubscriptionSortItems.SortItem.md +++ b/docs/reference/toloka.client.search_requests.WebhookSubscriptionSortItems.SortItem.md @@ -1,7 +1,7 @@ # SortItem `toloka.client.search_requests.WebhookSubscriptionSortItems.SortItem` -``` +```python SortItem( self, field: Optional[SortField] = None, diff --git a/docs/reference/toloka.client.search_requests.WebhookSubscriptionSortItems.md b/docs/reference/toloka.client.search_requests.WebhookSubscriptionSortItems.md index 3af12b14..923b2090 100644 --- a/docs/reference/toloka.client.search_requests.WebhookSubscriptionSortItems.md +++ b/docs/reference/toloka.client.search_requests.WebhookSubscriptionSortItems.md @@ -1,7 +1,7 @@ # WebhookSubscriptionSortItems `toloka.client.search_requests.WebhookSubscriptionSortItems` -``` +```python WebhookSubscriptionSortItems(self, items=None) ``` diff --git a/docs/reference/toloka.client.search_results.AggregatedSolutionSearchResult.md b/docs/reference/toloka.client.search_results.AggregatedSolutionSearchResult.md index 3b99f586..ca91dd92 100644 --- a/docs/reference/toloka.client.search_results.AggregatedSolutionSearchResult.md +++ b/docs/reference/toloka.client.search_results.AggregatedSolutionSearchResult.md @@ -1,7 +1,7 @@ # AggregatedSolutionSearchResult `toloka.client.search_results.AggregatedSolutionSearchResult` -``` +```python AggregatedSolutionSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.AppBatchSearchResult.md b/docs/reference/toloka.client.search_results.AppBatchSearchResult.md index 0974f8db..aa24297f 100644 --- a/docs/reference/toloka.client.search_results.AppBatchSearchResult.md +++ b/docs/reference/toloka.client.search_results.AppBatchSearchResult.md @@ -1,7 +1,7 @@ # AppBatchSearchResult `toloka.client.search_results.AppBatchSearchResult` -``` +```python AppBatchSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.AppItemSearchResult.md b/docs/reference/toloka.client.search_results.AppItemSearchResult.md index 08a1e763..9343bbcb 100644 --- a/docs/reference/toloka.client.search_results.AppItemSearchResult.md +++ b/docs/reference/toloka.client.search_results.AppItemSearchResult.md @@ -1,7 +1,7 @@ # AppItemSearchResult `toloka.client.search_results.AppItemSearchResult` -``` +```python AppItemSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.AppProjectSearchResult.md b/docs/reference/toloka.client.search_results.AppProjectSearchResult.md index 1567472f..ea4fbd8b 100644 --- a/docs/reference/toloka.client.search_results.AppProjectSearchResult.md +++ b/docs/reference/toloka.client.search_results.AppProjectSearchResult.md @@ -1,7 +1,7 @@ # AppProjectSearchResult `toloka.client.search_results.AppProjectSearchResult` -``` +```python AppProjectSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.AppSearchResult.md b/docs/reference/toloka.client.search_results.AppSearchResult.md index 29629fe4..cc48d34d 100644 --- a/docs/reference/toloka.client.search_results.AppSearchResult.md +++ b/docs/reference/toloka.client.search_results.AppSearchResult.md @@ -1,7 +1,7 @@ # AppSearchResult `toloka.client.search_results.AppSearchResult` -``` +```python AppSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.AssignmentSearchResult.md b/docs/reference/toloka.client.search_results.AssignmentSearchResult.md index a28a3c01..a6c14cd4 100644 --- a/docs/reference/toloka.client.search_results.AssignmentSearchResult.md +++ b/docs/reference/toloka.client.search_results.AssignmentSearchResult.md @@ -1,7 +1,7 @@ # AssignmentSearchResult `toloka.client.search_results.AssignmentSearchResult` -``` +```python AssignmentSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.AttachmentSearchResult.md b/docs/reference/toloka.client.search_results.AttachmentSearchResult.md index f45f069c..483a8b2a 100644 --- a/docs/reference/toloka.client.search_results.AttachmentSearchResult.md +++ b/docs/reference/toloka.client.search_results.AttachmentSearchResult.md @@ -1,7 +1,7 @@ # AttachmentSearchResult `toloka.client.search_results.AttachmentSearchResult` -``` +```python AttachmentSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.MessageThreadSearchResult.md b/docs/reference/toloka.client.search_results.MessageThreadSearchResult.md index d74742cd..c633a951 100644 --- a/docs/reference/toloka.client.search_results.MessageThreadSearchResult.md +++ b/docs/reference/toloka.client.search_results.MessageThreadSearchResult.md @@ -1,7 +1,7 @@ # MessageThreadSearchResult `toloka.client.search_results.MessageThreadSearchResult` -``` +```python MessageThreadSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.PoolSearchResult.md b/docs/reference/toloka.client.search_results.PoolSearchResult.md index 80997426..4248073a 100644 --- a/docs/reference/toloka.client.search_results.PoolSearchResult.md +++ b/docs/reference/toloka.client.search_results.PoolSearchResult.md @@ -1,7 +1,7 @@ # PoolSearchResult `toloka.client.search_results.PoolSearchResult` -``` +```python PoolSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.ProjectSearchResult.md b/docs/reference/toloka.client.search_results.ProjectSearchResult.md index 72f208ab..bd763fae 100644 --- a/docs/reference/toloka.client.search_results.ProjectSearchResult.md +++ b/docs/reference/toloka.client.search_results.ProjectSearchResult.md @@ -1,7 +1,7 @@ # ProjectSearchResult `toloka.client.search_results.ProjectSearchResult` -``` +```python ProjectSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.SkillSearchResult.md b/docs/reference/toloka.client.search_results.SkillSearchResult.md index 344bf48c..ee4d6a99 100644 --- a/docs/reference/toloka.client.search_results.SkillSearchResult.md +++ b/docs/reference/toloka.client.search_results.SkillSearchResult.md @@ -1,7 +1,7 @@ # SkillSearchResult `toloka.client.search_results.SkillSearchResult` -``` +```python SkillSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.TaskSearchResult.md b/docs/reference/toloka.client.search_results.TaskSearchResult.md index 43af1505..46a24405 100644 --- a/docs/reference/toloka.client.search_results.TaskSearchResult.md +++ b/docs/reference/toloka.client.search_results.TaskSearchResult.md @@ -1,7 +1,7 @@ # TaskSearchResult `toloka.client.search_results.TaskSearchResult` -``` +```python TaskSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.TaskSuiteSearchResult.md b/docs/reference/toloka.client.search_results.TaskSuiteSearchResult.md index bd7e17dc..619be19e 100644 --- a/docs/reference/toloka.client.search_results.TaskSuiteSearchResult.md +++ b/docs/reference/toloka.client.search_results.TaskSuiteSearchResult.md @@ -1,7 +1,7 @@ # TaskSuiteSearchResult `toloka.client.search_results.TaskSuiteSearchResult` -``` +```python TaskSuiteSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.TrainingSearchResult.md b/docs/reference/toloka.client.search_results.TrainingSearchResult.md index 9864b8cf..0259a088 100644 --- a/docs/reference/toloka.client.search_results.TrainingSearchResult.md +++ b/docs/reference/toloka.client.search_results.TrainingSearchResult.md @@ -1,7 +1,7 @@ # TrainingSearchResult `toloka.client.search_results.TrainingSearchResult` -``` +```python TrainingSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.UserBonusSearchResult.md b/docs/reference/toloka.client.search_results.UserBonusSearchResult.md index 06071dc4..0b34be77 100644 --- a/docs/reference/toloka.client.search_results.UserBonusSearchResult.md +++ b/docs/reference/toloka.client.search_results.UserBonusSearchResult.md @@ -1,7 +1,7 @@ # UserBonusSearchResult `toloka.client.search_results.UserBonusSearchResult` -``` +```python UserBonusSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.UserRestrictionSearchResult.md b/docs/reference/toloka.client.search_results.UserRestrictionSearchResult.md index fb3e9449..c2701ef0 100644 --- a/docs/reference/toloka.client.search_results.UserRestrictionSearchResult.md +++ b/docs/reference/toloka.client.search_results.UserRestrictionSearchResult.md @@ -1,7 +1,7 @@ # UserRestrictionSearchResult `toloka.client.search_results.UserRestrictionSearchResult` -``` +```python UserRestrictionSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.UserSkillSearchResult.md b/docs/reference/toloka.client.search_results.UserSkillSearchResult.md index eb04c324..0eeaed22 100644 --- a/docs/reference/toloka.client.search_results.UserSkillSearchResult.md +++ b/docs/reference/toloka.client.search_results.UserSkillSearchResult.md @@ -1,7 +1,7 @@ # UserSkillSearchResult `toloka.client.search_results.UserSkillSearchResult` -``` +```python UserSkillSearchResult( self, *, diff --git a/docs/reference/toloka.client.search_results.WebhookSubscriptionSearchResult.md b/docs/reference/toloka.client.search_results.WebhookSubscriptionSearchResult.md index 548da5d0..f250ff37 100644 --- a/docs/reference/toloka.client.search_results.WebhookSubscriptionSearchResult.md +++ b/docs/reference/toloka.client.search_results.WebhookSubscriptionSearchResult.md @@ -1,7 +1,7 @@ # WebhookSubscriptionSearchResult `toloka.client.search_results.WebhookSubscriptionSearchResult` -``` +```python WebhookSubscriptionSearchResult( self, *, diff --git a/docs/reference/toloka.client.skill.Skill.md b/docs/reference/toloka.client.skill.Skill.md index fa4ee4d1..6f9e4dd9 100644 --- a/docs/reference/toloka.client.skill.Skill.md +++ b/docs/reference/toloka.client.skill.Skill.md @@ -1,7 +1,7 @@ # Skill -`toloka.client.skill.Skill` +`toloka.client.skill.Skill` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/skill.py#L10) -``` +```python Skill( self, *, diff --git a/docs/reference/toloka.client.solution.Solution.md b/docs/reference/toloka.client.solution.Solution.md index 7e9fab7d..29978065 100644 --- a/docs/reference/toloka.client.solution.Solution.md +++ b/docs/reference/toloka.client.solution.Solution.md @@ -1,7 +1,7 @@ # Solution -`toloka.client.solution.Solution` +`toloka.client.solution.Solution` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/solution.py#L6) -``` +```python Solution(self, output_values: Dict[str, Any]) ``` diff --git a/docs/reference/toloka.client.task.BaseTask.KnownSolution.md b/docs/reference/toloka.client.task.BaseTask.KnownSolution.md index 2c8b38bb..df7acd08 100644 --- a/docs/reference/toloka.client.task.BaseTask.KnownSolution.md +++ b/docs/reference/toloka.client.task.BaseTask.KnownSolution.md @@ -1,7 +1,7 @@ # KnownSolution -`toloka.client.task.BaseTask.KnownSolution` +`toloka.client.task.BaseTask.KnownSolution` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task.py#L36) -``` +```python KnownSolution( self, *, diff --git a/docs/reference/toloka.client.task.BaseTask.md b/docs/reference/toloka.client.task.BaseTask.md index 1cfa20ce..79af3627 100644 --- a/docs/reference/toloka.client.task.BaseTask.md +++ b/docs/reference/toloka.client.task.BaseTask.md @@ -1,7 +1,7 @@ # BaseTask -`toloka.client.task.BaseTask` +`toloka.client.task.BaseTask` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task.py#L20) -``` +```python BaseTask( self, *, diff --git a/docs/reference/toloka.client.task.CreateTaskAsyncParameters.md b/docs/reference/toloka.client.task.CreateTaskAsyncParameters.md index 043cdddc..fbd7cd01 100644 --- a/docs/reference/toloka.client.task.CreateTaskAsyncParameters.md +++ b/docs/reference/toloka.client.task.CreateTaskAsyncParameters.md @@ -1,7 +1,7 @@ # CreateTaskAsyncParameters -`toloka.client.task.CreateTaskAsyncParameters` +`toloka.client.task.CreateTaskAsyncParameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task.py#L128) -``` +```python CreateTaskAsyncParameters( self, *, @@ -15,5 +15,5 @@ CreateTaskAsyncParameters( | Parameters | Type | Description | | :----------| :----| :-----------| -`allow_defaults`|**Optional\[bool\]**|

Overlap settings:

+`allow_defaults`|**Optional\[bool\]**|

Overlap setting:

`open_pool`|**Optional\[bool\]**|

Open the pool immediately after creating a task suite, if the pool is closed.

diff --git a/docs/reference/toloka.client.task.CreateTaskParameters.md b/docs/reference/toloka.client.task.CreateTaskParameters.md index 2db0a470..6ecc24fe 100644 --- a/docs/reference/toloka.client.task.CreateTaskParameters.md +++ b/docs/reference/toloka.client.task.CreateTaskParameters.md @@ -1,7 +1,7 @@ # CreateTaskParameters -`toloka.client.task.CreateTaskParameters` +`toloka.client.task.CreateTaskParameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task.py#L112) -``` +```python CreateTaskParameters( self, *, @@ -19,5 +19,5 @@ Used when creating one Task. | Parameters | Type | Description | | :----------| :----| :-----------| -`allow_defaults`|**Optional\[bool\]**|

Overlap settings:

+`allow_defaults`|**Optional\[bool\]**|

Overlap setting:

`open_pool`|**Optional\[bool\]**|

Open the pool immediately after creating a task suite, if the pool is closed.

diff --git a/docs/reference/toloka.client.task.CreateTasksParameters.md b/docs/reference/toloka.client.task.CreateTasksParameters.md index f72b1857..1cf1a75c 100644 --- a/docs/reference/toloka.client.task.CreateTasksParameters.md +++ b/docs/reference/toloka.client.task.CreateTasksParameters.md @@ -1,7 +1,7 @@ # CreateTasksParameters -`toloka.client.task.CreateTasksParameters` +`toloka.client.task.CreateTasksParameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task.py#L133) -``` +```python CreateTasksParameters( self, *, @@ -22,7 +22,7 @@ Used when creating many Tasks. | Parameters | Type | Description | | :----------| :----| :-----------| -`allow_defaults`|**Optional\[bool\]**|

Overlap settings:

+`allow_defaults`|**Optional\[bool\]**|

Overlap setting:

`open_pool`|**Optional\[bool\]**|

Open the pool immediately after creating a task suite, if the pool is closed.

-`skip_invalid_items`|**Optional\[bool\]**|

Validation parameters:

-`async_mode`|**Optional\[bool\]**|

How the request is processed:

+`skip_invalid_items`|**Optional\[bool\]**|

Task validation option:

+`async_mode`|**Optional\[bool\]**|

Request processing mode:

diff --git a/docs/reference/toloka.client.task.Task.BaselineSolution.md b/docs/reference/toloka.client.task.Task.BaselineSolution.md index 59bfd8bc..b0612a50 100644 --- a/docs/reference/toloka.client.task.Task.BaselineSolution.md +++ b/docs/reference/toloka.client.task.Task.BaselineSolution.md @@ -1,7 +1,7 @@ # BaselineSolution -`toloka.client.task.Task.BaselineSolution` +`toloka.client.task.Task.BaselineSolution` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task.py#L95) -``` +```python BaselineSolution( self, *, diff --git a/docs/reference/toloka.client.task.Task.md b/docs/reference/toloka.client.task.Task.md index 6af48939..e0f380c3 100644 --- a/docs/reference/toloka.client.task.Task.md +++ b/docs/reference/toloka.client.task.Task.md @@ -1,7 +1,7 @@ # Task -`toloka.client.task.Task` +`toloka.client.task.Task` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task.py#L65) -``` +```python Task( self, *, diff --git a/docs/reference/toloka.client.task.TaskOverlapPatch.md b/docs/reference/toloka.client.task.TaskOverlapPatch.md index 22b212e1..f0539b27 100644 --- a/docs/reference/toloka.client.task.TaskOverlapPatch.md +++ b/docs/reference/toloka.client.task.TaskOverlapPatch.md @@ -1,7 +1,7 @@ # TaskOverlapPatch -`toloka.client.task.TaskOverlapPatch` +`toloka.client.task.TaskOverlapPatch` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task.py#L153) -``` +```python TaskOverlapPatch( self, *, @@ -16,5 +16,5 @@ Parameters for changing the overlap of a specific Task | Parameters | Type | Description | | :----------| :----| :-----------| -`overlap`|**Optional\[int\]**|

Overlapping a set of tasks.

-`infinite_overlap`|**Optional\[bool\]**|

Issue a task with infinite overlap. Used, for example, for sets of training tasks to give them to all users:

+`overlap`|**Optional\[int\]**|

Overlap value.

+`infinite_overlap`|**Optional\[bool\]**|

Infinite overlap:

Default value: False.

diff --git a/docs/reference/toloka.client.task.TaskPatch.md b/docs/reference/toloka.client.task.TaskPatch.md index 2cbdad31..30e438fc 100644 --- a/docs/reference/toloka.client.task.TaskPatch.md +++ b/docs/reference/toloka.client.task.TaskPatch.md @@ -1,7 +1,7 @@ # TaskPatch -`toloka.client.task.TaskPatch` +`toloka.client.task.TaskPatch` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task.py#L167) -``` +```python TaskPatch( self, *, @@ -17,6 +17,6 @@ Parameters for changing overlap or baseline_solutions of a specific Task | Parameters | Type | Description | | :----------| :----| :-----------| -`overlap`|**Optional\[int\]**|

Overlapping a set of tasks.

-`infinite_overlap`|**Optional\[bool\]**|

Issue a task with infinite overlap. Used, for example, for sets of training tasks to give them to all users:

+`overlap`|**Optional\[int\]**|

Overlap value.

+`infinite_overlap`|**Optional\[bool\]**|

Infinite overlap:

Default value: False.

`baseline_solutions`|**Optional\[List\[[Task.BaselineSolution](toloka.client.task.Task.BaselineSolution.md)\]\]**|

diff --git a/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.Distribution.md b/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.Distribution.md index 950a1316..80c73e22 100644 --- a/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.Distribution.md +++ b/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.Distribution.md @@ -1,5 +1,5 @@ # Distribution -`toloka.client.task_distribution_function.TaskDistributionFunction.Distribution` +`toloka.client.task_distribution_function.TaskDistributionFunction.Distribution` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task_distribution_function.py#L32) An enumeration. diff --git a/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.Interval.md b/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.Interval.md index f3cc567f..da9e49d8 100644 --- a/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.Interval.md +++ b/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.Interval.md @@ -1,7 +1,7 @@ # Interval -`toloka.client.task_distribution_function.TaskDistributionFunction.Interval` +`toloka.client.task_distribution_function.TaskDistributionFunction.Interval` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task_distribution_function.py#L36) -``` +```python Interval( self, *, diff --git a/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.Scope.md b/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.Scope.md index 9364deb4..82041f92 100644 --- a/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.Scope.md +++ b/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.Scope.md @@ -1,5 +1,5 @@ # Scope -`toloka.client.task_distribution_function.TaskDistributionFunction.Scope` +`toloka.client.task_distribution_function.TaskDistributionFunction.Scope` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task_distribution_function.py#L27) An enumeration. diff --git a/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.md b/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.md index d50ded7a..60528371 100644 --- a/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.md +++ b/docs/reference/toloka.client.task_distribution_function.TaskDistributionFunction.md @@ -1,7 +1,7 @@ # TaskDistributionFunction -`toloka.client.task_distribution_function.TaskDistributionFunction` +`toloka.client.task_distribution_function.TaskDistributionFunction` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task_distribution_function.py#L9) -``` +```python TaskDistributionFunction( self, *, diff --git a/docs/reference/toloka.client.task_suite.TaskSuite.md b/docs/reference/toloka.client.task_suite.TaskSuite.md index 583fb2b5..f605d5ac 100644 --- a/docs/reference/toloka.client.task_suite.TaskSuite.md +++ b/docs/reference/toloka.client.task_suite.TaskSuite.md @@ -1,7 +1,7 @@ # TaskSuite -`toloka.client.task_suite.TaskSuite` +`toloka.client.task_suite.TaskSuite` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task_suite.py#L19) -``` +```python TaskSuite( self, *, @@ -50,7 +50,7 @@ Performers receive exactly one TaskSuite when they take on your task. `remaining_overlap`|**Optional\[int\]**|

How many times will this Task Suite be issued to performers. Read only field.

`automerged`|**Optional\[bool\]**|

The task suite flag is created after task merging. Read Only field. Value:

`created`|**Optional\[datetime\]**|

The UTC date and time when the task suite was created. Read Only field.

-## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.task_suite.TaskSuiteCreateRequestParameters.md b/docs/reference/toloka.client.task_suite.TaskSuiteCreateRequestParameters.md index 8db47f17..a2baa45d 100644 --- a/docs/reference/toloka.client.task_suite.TaskSuiteCreateRequestParameters.md +++ b/docs/reference/toloka.client.task_suite.TaskSuiteCreateRequestParameters.md @@ -1,7 +1,7 @@ # TaskSuiteCreateRequestParameters -`toloka.client.task_suite.TaskSuiteCreateRequestParameters` +`toloka.client.task_suite.TaskSuiteCreateRequestParameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task_suite.py#L77) -``` +```python TaskSuiteCreateRequestParameters( self, *, diff --git a/docs/reference/toloka.client.task_suite.TaskSuiteOverlapPatch.md b/docs/reference/toloka.client.task_suite.TaskSuiteOverlapPatch.md index f5b60df4..37774254 100644 --- a/docs/reference/toloka.client.task_suite.TaskSuiteOverlapPatch.md +++ b/docs/reference/toloka.client.task_suite.TaskSuiteOverlapPatch.md @@ -1,7 +1,7 @@ # TaskSuiteOverlapPatch -`toloka.client.task_suite.TaskSuiteOverlapPatch` +`toloka.client.task_suite.TaskSuiteOverlapPatch` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task_suite.py#L104) -``` +```python TaskSuiteOverlapPatch(self, *, overlap: Optional[int] = None) ``` diff --git a/docs/reference/toloka.client.task_suite.TaskSuitePatch.md b/docs/reference/toloka.client.task_suite.TaskSuitePatch.md index af756970..c3112b20 100644 --- a/docs/reference/toloka.client.task_suite.TaskSuitePatch.md +++ b/docs/reference/toloka.client.task_suite.TaskSuitePatch.md @@ -1,7 +1,7 @@ # TaskSuitePatch -`toloka.client.task_suite.TaskSuitePatch` +`toloka.client.task_suite.TaskSuitePatch` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/task_suite.py#L111) -``` +```python TaskSuitePatch( self, *, diff --git a/docs/reference/toloka.client.training.Training.CloseReason.md b/docs/reference/toloka.client.training.Training.CloseReason.md index d259200a..18baf844 100644 --- a/docs/reference/toloka.client.training.Training.CloseReason.md +++ b/docs/reference/toloka.client.training.Training.CloseReason.md @@ -1,5 +1,5 @@ # CloseReason -`toloka.client.training.Training.CloseReason` +`toloka.client.training.Training.CloseReason` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/training.py#L49) The reason for closing the pool the last time: diff --git a/docs/reference/toloka.client.training.Training.Status.md b/docs/reference/toloka.client.training.Training.Status.md index 2988dce2..cac66e23 100644 --- a/docs/reference/toloka.client.training.Training.Status.md +++ b/docs/reference/toloka.client.training.Training.Status.md @@ -1,5 +1,5 @@ # Status -`toloka.client.training.Training.Status` +`toloka.client.training.Training.Status` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/training.py#L70) Status of the training pool diff --git a/docs/reference/toloka.client.training.Training.is_archived.md b/docs/reference/toloka.client.training.Training.is_archived.md index 8dd85278..f1900bfd 100644 --- a/docs/reference/toloka.client.training.Training.is_archived.md +++ b/docs/reference/toloka.client.training.Training.is_archived.md @@ -1,7 +1,7 @@ # is_archived -`toloka.client.training.Training.is_archived` +`toloka.client.training.Training.is_archived` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/training.py#L114) -``` +```python is_archived(self) ``` diff --git a/docs/reference/toloka.client.training.Training.is_closed.md b/docs/reference/toloka.client.training.Training.is_closed.md index 315ddb32..0a552658 100644 --- a/docs/reference/toloka.client.training.Training.is_closed.md +++ b/docs/reference/toloka.client.training.Training.is_closed.md @@ -1,7 +1,7 @@ # is_closed -`toloka.client.training.Training.is_closed` +`toloka.client.training.Training.is_closed` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/training.py#L111) -``` +```python is_closed(self) ``` diff --git a/docs/reference/toloka.client.training.Training.is_locked.md b/docs/reference/toloka.client.training.Training.is_locked.md index 129a608a..d0f70369 100644 --- a/docs/reference/toloka.client.training.Training.is_locked.md +++ b/docs/reference/toloka.client.training.Training.is_locked.md @@ -1,7 +1,7 @@ # is_locked -`toloka.client.training.Training.is_locked` +`toloka.client.training.Training.is_locked` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/training.py#L117) -``` +```python is_locked(self) ``` diff --git a/docs/reference/toloka.client.training.Training.is_open.md b/docs/reference/toloka.client.training.Training.is_open.md index a7c17b51..787864e7 100644 --- a/docs/reference/toloka.client.training.Training.is_open.md +++ b/docs/reference/toloka.client.training.Training.is_open.md @@ -1,7 +1,7 @@ # is_open -`toloka.client.training.Training.is_open` +`toloka.client.training.Training.is_open` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/training.py#L108) -``` +```python is_open(self) ``` diff --git a/docs/reference/toloka.client.training.Training.md b/docs/reference/toloka.client.training.Training.md index e3fff0f4..bbb6015e 100644 --- a/docs/reference/toloka.client.training.Training.md +++ b/docs/reference/toloka.client.training.Training.md @@ -1,7 +1,7 @@ # Training -`toloka.client.training.Training` +`toloka.client.training.Training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/training.py#L11) -``` +```python Training( self, *, @@ -57,7 +57,7 @@ Allows: `created`|**Optional\[datetime\]**|

UTC date and time of creation of the training pool in ISO 8601 format. Read only.

`last_started`|**Optional\[datetime\]**|

UTC date and time of the last start of the training pool in ISO 8601 format. Read only.

`last_stopped`|**Optional\[datetime\]**|

UTC date and time of the last stop of the training pool in ISO 8601 format. Read only.

-## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.client.user_bonus.UserBonus.md b/docs/reference/toloka.client.user_bonus.UserBonus.md index 83d4c182..733b7ba0 100644 --- a/docs/reference/toloka.client.user_bonus.UserBonus.md +++ b/docs/reference/toloka.client.user_bonus.UserBonus.md @@ -1,7 +1,7 @@ # UserBonus -`toloka.client.user_bonus.UserBonus` +`toloka.client.user_bonus.UserBonus` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/user_bonus.py#L14) -``` +```python UserBonus( self, *, diff --git a/docs/reference/toloka.client.user_bonus.UserBonusCreateRequestParameters.md b/docs/reference/toloka.client.user_bonus.UserBonusCreateRequestParameters.md index 2838cfd4..a30ca844 100644 --- a/docs/reference/toloka.client.user_bonus.UserBonusCreateRequestParameters.md +++ b/docs/reference/toloka.client.user_bonus.UserBonusCreateRequestParameters.md @@ -1,7 +1,7 @@ # UserBonusCreateRequestParameters -`toloka.client.user_bonus.UserBonusCreateRequestParameters` +`toloka.client.user_bonus.UserBonusCreateRequestParameters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/user_bonus.py#L85) -``` +```python UserBonusCreateRequestParameters( self, *, diff --git a/docs/reference/toloka.client.user_restriction.AllProjectsUserRestriction.md b/docs/reference/toloka.client.user_restriction.AllProjectsUserRestriction.md index 156b4324..48d200f7 100644 --- a/docs/reference/toloka.client.user_restriction.AllProjectsUserRestriction.md +++ b/docs/reference/toloka.client.user_restriction.AllProjectsUserRestriction.md @@ -1,7 +1,7 @@ # AllProjectsUserRestriction -`toloka.client.user_restriction.AllProjectsUserRestriction` +`toloka.client.user_restriction.AllProjectsUserRestriction` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/user_restriction.py#L85) -``` +```python AllProjectsUserRestriction( self, *, diff --git a/docs/reference/toloka.client.user_restriction.DurationUnit.md b/docs/reference/toloka.client.user_restriction.DurationUnit.md index b4d6973c..981b75fb 100644 --- a/docs/reference/toloka.client.user_restriction.DurationUnit.md +++ b/docs/reference/toloka.client.user_restriction.DurationUnit.md @@ -1,5 +1,5 @@ # DurationUnit -`toloka.client.user_restriction.DurationUnit` +`toloka.client.user_restriction.DurationUnit` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/user_restriction.py#L17) An enumeration. diff --git a/docs/reference/toloka.client.user_restriction.PoolUserRestriction.md b/docs/reference/toloka.client.user_restriction.PoolUserRestriction.md index ce50e5b0..7c4e0c1e 100644 --- a/docs/reference/toloka.client.user_restriction.PoolUserRestriction.md +++ b/docs/reference/toloka.client.user_restriction.PoolUserRestriction.md @@ -1,7 +1,7 @@ # PoolUserRestriction -`toloka.client.user_restriction.PoolUserRestriction` +`toloka.client.user_restriction.PoolUserRestriction` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/user_restriction.py#L93) -``` +```python PoolUserRestriction( self, *, diff --git a/docs/reference/toloka.client.user_restriction.ProjectUserRestriction.md b/docs/reference/toloka.client.user_restriction.ProjectUserRestriction.md index 23864751..387f9fc3 100644 --- a/docs/reference/toloka.client.user_restriction.ProjectUserRestriction.md +++ b/docs/reference/toloka.client.user_restriction.ProjectUserRestriction.md @@ -1,7 +1,7 @@ # ProjectUserRestriction -`toloka.client.user_restriction.ProjectUserRestriction` +`toloka.client.user_restriction.ProjectUserRestriction` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/user_restriction.py#L104) -``` +```python ProjectUserRestriction( self, *, diff --git a/docs/reference/toloka.client.user_restriction.SystemUserRestriction.md b/docs/reference/toloka.client.user_restriction.SystemUserRestriction.md index 26890555..0393a4f0 100644 --- a/docs/reference/toloka.client.user_restriction.SystemUserRestriction.md +++ b/docs/reference/toloka.client.user_restriction.SystemUserRestriction.md @@ -1,7 +1,7 @@ # SystemUserRestriction -`toloka.client.user_restriction.SystemUserRestriction` +`toloka.client.user_restriction.SystemUserRestriction` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/user_restriction.py#L115) -``` +```python SystemUserRestriction( self, *, diff --git a/docs/reference/toloka.client.user_restriction.UserRestriction.Scope.md b/docs/reference/toloka.client.user_restriction.UserRestriction.Scope.md index 43273c8b..1bb8dfdf 100644 --- a/docs/reference/toloka.client.user_restriction.UserRestriction.Scope.md +++ b/docs/reference/toloka.client.user_restriction.UserRestriction.Scope.md @@ -1,5 +1,5 @@ # Scope -`toloka.client.user_restriction.UserRestriction.Scope` +`toloka.client.user_restriction.UserRestriction.Scope` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/user_restriction.py#L57) Restriction scope diff --git a/docs/reference/toloka.client.user_restriction.UserRestriction.md b/docs/reference/toloka.client.user_restriction.UserRestriction.md index c104f80a..4e534a23 100644 --- a/docs/reference/toloka.client.user_restriction.UserRestriction.md +++ b/docs/reference/toloka.client.user_restriction.UserRestriction.md @@ -1,7 +1,7 @@ # UserRestriction -`toloka.client.user_restriction.UserRestriction` +`toloka.client.user_restriction.UserRestriction` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/user_restriction.py#L25) -``` +```python UserRestriction( self, *, diff --git a/docs/reference/toloka.client.user_skill.SetUserSkillRequest.md b/docs/reference/toloka.client.user_skill.SetUserSkillRequest.md index 89303a86..2850925c 100644 --- a/docs/reference/toloka.client.user_skill.SetUserSkillRequest.md +++ b/docs/reference/toloka.client.user_skill.SetUserSkillRequest.md @@ -1,7 +1,7 @@ # SetUserSkillRequest -`toloka.client.user_skill.SetUserSkillRequest` +`toloka.client.user_skill.SetUserSkillRequest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/user_skill.py#L12) -``` +```python SetUserSkillRequest( self, *, diff --git a/docs/reference/toloka.client.user_skill.UserSkill.md b/docs/reference/toloka.client.user_skill.UserSkill.md index 7acd75c4..4a160e5a 100644 --- a/docs/reference/toloka.client.user_skill.UserSkill.md +++ b/docs/reference/toloka.client.user_skill.UserSkill.md @@ -1,7 +1,7 @@ # UserSkill -`toloka.client.user_skill.UserSkill` +`toloka.client.user_skill.UserSkill` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/user_skill.py#L29) -``` +```python UserSkill( self, *, diff --git a/docs/reference/toloka.client.webhook_subscription.WebhookSubscription.EventType.md b/docs/reference/toloka.client.webhook_subscription.WebhookSubscription.EventType.md index 92f90f67..3c67e8ee 100644 --- a/docs/reference/toloka.client.webhook_subscription.WebhookSubscription.EventType.md +++ b/docs/reference/toloka.client.webhook_subscription.WebhookSubscription.EventType.md @@ -1,5 +1,5 @@ # EventType -`toloka.client.webhook_subscription.WebhookSubscription.EventType` +`toloka.client.webhook_subscription.WebhookSubscription.EventType` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/webhook_subscription.py#L22) Webhook subscription event type: diff --git a/docs/reference/toloka.client.webhook_subscription.WebhookSubscription.md b/docs/reference/toloka.client.webhook_subscription.WebhookSubscription.md index e51bbdc4..966e9639 100644 --- a/docs/reference/toloka.client.webhook_subscription.WebhookSubscription.md +++ b/docs/reference/toloka.client.webhook_subscription.WebhookSubscription.md @@ -1,7 +1,7 @@ # WebhookSubscription -`toloka.client.webhook_subscription.WebhookSubscription` +`toloka.client.webhook_subscription.WebhookSubscription` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/client/webhook_subscription.py#L11) -``` +```python WebhookSubscription( self, *, diff --git a/docs/reference/toloka.metrics.collector.MetricCollector.create_async_tasks.md b/docs/reference/toloka.metrics.collector.MetricCollector.create_async_tasks.md index 02c9b2cd..90249154 100644 --- a/docs/reference/toloka.metrics.collector.MetricCollector.create_async_tasks.md +++ b/docs/reference/toloka.metrics.collector.MetricCollector.create_async_tasks.md @@ -1,7 +1,7 @@ # create_async_tasks -`toloka.metrics.collector.MetricCollector.create_async_tasks` +`toloka.metrics.collector.MetricCollector.create_async_tasks` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/collector.py#L66) -``` +```python create_async_tasks(coro) ``` diff --git a/docs/reference/toloka.metrics.collector.MetricCollector.md b/docs/reference/toloka.metrics.collector.MetricCollector.md index c18dbee4..60619188 100644 --- a/docs/reference/toloka.metrics.collector.MetricCollector.md +++ b/docs/reference/toloka.metrics.collector.MetricCollector.md @@ -1,7 +1,7 @@ # MetricCollector -`toloka.metrics.collector.MetricCollector` +`toloka.metrics.collector.MetricCollector` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/collector.py#L18) -``` +```python MetricCollector( self, metrics: List[BaseMetric], @@ -32,7 +32,7 @@ collector = MetricCollector( bind_client(collector.metrics, toloka_client) asyncio.run(collector.run()) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.collector.MetricCollector.run.md b/docs/reference/toloka.metrics.collector.MetricCollector.run.md index 6ec75df8..7fb3ef3f 100644 --- a/docs/reference/toloka.metrics.collector.MetricCollector.run.md +++ b/docs/reference/toloka.metrics.collector.MetricCollector.run.md @@ -1,7 +1,7 @@ # run -`toloka.metrics.collector.MetricCollector.run` +`toloka.metrics.collector.MetricCollector.run` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/collector.py#L74) -``` +```python run(self) ``` diff --git a/docs/reference/toloka.metrics.jupyter_dashboard.Chart.create_async_tasks.md b/docs/reference/toloka.metrics.jupyter_dashboard.Chart.create_async_tasks.md index c55e6a8b..22a444ff 100644 --- a/docs/reference/toloka.metrics.jupyter_dashboard.Chart.create_async_tasks.md +++ b/docs/reference/toloka.metrics.jupyter_dashboard.Chart.create_async_tasks.md @@ -1,7 +1,7 @@ # create_async_tasks -`toloka.metrics.jupyter_dashboard.Chart.create_async_tasks` +`toloka.metrics.jupyter_dashboard.Chart.create_async_tasks` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/jupyter_dashboard.py#L92) -``` +```python create_async_tasks(metric: BaseMetric, loop: AbstractEventLoop) ``` diff --git a/docs/reference/toloka.metrics.jupyter_dashboard.Chart.create_figure.md b/docs/reference/toloka.metrics.jupyter_dashboard.Chart.create_figure.md index 1b6d2053..6a98b221 100644 --- a/docs/reference/toloka.metrics.jupyter_dashboard.Chart.create_figure.md +++ b/docs/reference/toloka.metrics.jupyter_dashboard.Chart.create_figure.md @@ -1,7 +1,7 @@ # create_figure -`toloka.metrics.jupyter_dashboard.Chart.create_figure` +`toloka.metrics.jupyter_dashboard.Chart.create_figure` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/jupyter_dashboard.py#L126) -``` +```python create_figure(self) ``` diff --git a/docs/reference/toloka.metrics.jupyter_dashboard.Chart.md b/docs/reference/toloka.metrics.jupyter_dashboard.Chart.md index 37974118..20e6dd2b 100644 --- a/docs/reference/toloka.metrics.jupyter_dashboard.Chart.md +++ b/docs/reference/toloka.metrics.jupyter_dashboard.Chart.md @@ -1,7 +1,7 @@ # Chart -`toloka.metrics.jupyter_dashboard.Chart` +`toloka.metrics.jupyter_dashboard.Chart` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/jupyter_dashboard.py#L44) -``` +```python Chart( self, name: Optional[str], @@ -32,7 +32,7 @@ Chart( [ ) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.jupyter_dashboard.Chart.update_metrics.md b/docs/reference/toloka.metrics.jupyter_dashboard.Chart.update_metrics.md index 87a65d02..ebf560b3 100644 --- a/docs/reference/toloka.metrics.jupyter_dashboard.Chart.update_metrics.md +++ b/docs/reference/toloka.metrics.jupyter_dashboard.Chart.update_metrics.md @@ -1,7 +1,7 @@ # update_metrics -`toloka.metrics.jupyter_dashboard.Chart.update_metrics` +`toloka.metrics.jupyter_dashboard.Chart.update_metrics` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/jupyter_dashboard.py#L44) -``` +```python update_metrics(self) ``` diff --git a/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.md b/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.md index a9f96b0f..e89c3f15 100644 --- a/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.md +++ b/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.md @@ -1,7 +1,7 @@ # DashBoard -`toloka.metrics.jupyter_dashboard.DashBoard` +`toloka.metrics.jupyter_dashboard.DashBoard` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/jupyter_dashboard.py#L174) -``` +```python DashBoard( self, metrics: List[Union[BaseMetric, Chart]], @@ -49,7 +49,7 @@ metrics.bind_client(new_dash.metrics, toloka_client) new_dash.run_dash() new_dash.stop_dash() ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.run_dash.md b/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.run_dash.md index ccee1d5c..16437e69 100644 --- a/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.run_dash.md +++ b/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.run_dash.md @@ -1,7 +1,7 @@ # run_dash -`toloka.metrics.jupyter_dashboard.DashBoard.run_dash` +`toloka.metrics.jupyter_dashboard.DashBoard.run_dash` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/jupyter_dashboard.py#L44) -``` +```python run_dash( self, mode: str = 'inline', diff --git a/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.stop_dash.md b/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.stop_dash.md index d473f886..e1d4baf0 100644 --- a/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.stop_dash.md +++ b/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.stop_dash.md @@ -1,7 +1,7 @@ # stop_dash -`toloka.metrics.jupyter_dashboard.DashBoard.stop_dash` +`toloka.metrics.jupyter_dashboard.DashBoard.stop_dash` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/jupyter_dashboard.py#L44) -``` +```python stop_dash(self) ``` diff --git a/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.update_charts.md b/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.update_charts.md index 744c6360..ee2d7eaf 100644 --- a/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.update_charts.md +++ b/docs/reference/toloka.metrics.jupyter_dashboard.DashBoard.update_charts.md @@ -1,7 +1,7 @@ # update_charts -`toloka.metrics.jupyter_dashboard.DashBoard.update_charts` +`toloka.metrics.jupyter_dashboard.DashBoard.update_charts` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/jupyter_dashboard.py#L291) -``` +```python update_charts(self, n_intervals: int) ``` diff --git a/docs/reference/toloka.metrics.metrics.Balance.get_line_names.md b/docs/reference/toloka.metrics.metrics.Balance.get_line_names.md index f9da8a4e..a72d5134 100644 --- a/docs/reference/toloka.metrics.metrics.Balance.get_line_names.md +++ b/docs/reference/toloka.metrics.metrics.Balance.get_line_names.md @@ -1,7 +1,7 @@ # get_line_names -`toloka.metrics.metrics.Balance.get_line_names` +`toloka.metrics.metrics.Balance.get_line_names` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/metrics.py#L154) -``` +```python get_line_names(self) ``` diff --git a/docs/reference/toloka.metrics.metrics.Balance.md b/docs/reference/toloka.metrics.metrics.Balance.md index 53d4d37b..53eae014 100644 --- a/docs/reference/toloka.metrics.metrics.Balance.md +++ b/docs/reference/toloka.metrics.metrics.Balance.md @@ -1,12 +1,12 @@ # Balance -`toloka.metrics.metrics.Balance` +`toloka.metrics.metrics.Balance` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/metrics.py#L124) -``` +```python Balance( self, balance_name: Optional[str] = None, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` @@ -31,7 +31,7 @@ def print_metric(metric_dict): collector = MetricCollector([Balance(toloka_client=toloka_client)], print_metric) asyncio.run(collector.run()) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.metrics.BaseMetric.get_line_names.md b/docs/reference/toloka.metrics.metrics.BaseMetric.get_line_names.md index cbd7bc91..405237c0 100644 --- a/docs/reference/toloka.metrics.metrics.BaseMetric.get_line_names.md +++ b/docs/reference/toloka.metrics.metrics.BaseMetric.get_line_names.md @@ -1,7 +1,7 @@ # get_line_names -`toloka.metrics.metrics.BaseMetric.get_line_names` +`toloka.metrics.metrics.BaseMetric.get_line_names` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/metrics.py#L109) -``` +```python get_line_names(self) ``` diff --git a/docs/reference/toloka.metrics.metrics.BaseMetric.get_lines.md b/docs/reference/toloka.metrics.metrics.BaseMetric.get_lines.md index ab80ddf9..b90e9d51 100644 --- a/docs/reference/toloka.metrics.metrics.BaseMetric.get_lines.md +++ b/docs/reference/toloka.metrics.metrics.BaseMetric.get_lines.md @@ -1,7 +1,7 @@ # get_lines -`toloka.metrics.metrics.BaseMetric.get_lines` +`toloka.metrics.metrics.BaseMetric.get_lines` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/metrics.py#L74) -``` +```python get_lines(self) ``` diff --git a/docs/reference/toloka.metrics.metrics.BaseMetric.md b/docs/reference/toloka.metrics.metrics.BaseMetric.md index ee3ba67c..884dd13a 100644 --- a/docs/reference/toloka.metrics.metrics.BaseMetric.md +++ b/docs/reference/toloka.metrics.metrics.BaseMetric.md @@ -1,11 +1,11 @@ # BaseMetric -`toloka.metrics.metrics.BaseMetric` +`toloka.metrics.metrics.BaseMetric` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/metrics.py#L65) -``` +```python BaseMetric( self, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` @@ -15,7 +15,7 @@ Base class for all metrics. Stores TolokaClient instance for this metric. -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.metrics.NewMessageThreads.get_line_names.md b/docs/reference/toloka.metrics.metrics.NewMessageThreads.get_line_names.md index 9a308df3..4b72816f 100644 --- a/docs/reference/toloka.metrics.metrics.NewMessageThreads.get_line_names.md +++ b/docs/reference/toloka.metrics.metrics.NewMessageThreads.get_line_names.md @@ -1,7 +1,7 @@ # get_line_names -`toloka.metrics.metrics.NewMessageThreads.get_line_names` +`toloka.metrics.metrics.NewMessageThreads.get_line_names` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/metrics.py#L376) -``` +```python get_line_names(self) ``` diff --git a/docs/reference/toloka.metrics.metrics.NewMessageThreads.md b/docs/reference/toloka.metrics.metrics.NewMessageThreads.md index 7f372a83..23c384b5 100644 --- a/docs/reference/toloka.metrics.metrics.NewMessageThreads.md +++ b/docs/reference/toloka.metrics.metrics.NewMessageThreads.md @@ -1,7 +1,7 @@ # NewMessageThreads -`toloka.metrics.metrics.NewMessageThreads` +`toloka.metrics.metrics.NewMessageThreads` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/metrics.py#L320) -``` +```python NewMessageThreads( self, count_name: Optional[str] = None, @@ -9,7 +9,7 @@ NewMessageThreads( pools_name: Dict[str, str] = ..., join_events: bool = False, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` @@ -25,9 +25,9 @@ NewMessageThreads instance. You can gather all in one instance. | Parameters | Type | Description | | :----------| :----| :-----------| `count_name`|**Optional\[str\]**|

Metric name for a count of new messages.

-`projects_name`|**Dict\[str, str\]**|

Dictyonary that allows count messages on exact projects. {project_id: line_name}

-`pools_name`|**Dict\[str, str\]**|

Dictyonary that allows count messages on exact pools. {pool_id: line_name}

-`join_events`|**bool**|

Count all events in one point. Default False. "Values" never join.

+`projects_name`|**Dict\[str, str\]**|

Dictionary that allows count messages on exact projects. {project_id: line_name}

+`pools_name`|**Dict\[str, str\]**|

Dictionary that allows count messages on exact pools. {pool_id: line_name}

+`join_events`|**bool**|

Count all events in one point. Default False. "Values" never join.

**Examples:** @@ -50,7 +50,7 @@ collector = MetricCollector ) asyncio.run(collector.run()) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.metrics.NewUserBonuses.get_line_names.md b/docs/reference/toloka.metrics.metrics.NewUserBonuses.get_line_names.md index e8a9f07a..4a3fe4b8 100644 --- a/docs/reference/toloka.metrics.metrics.NewUserBonuses.get_line_names.md +++ b/docs/reference/toloka.metrics.metrics.NewUserBonuses.get_line_names.md @@ -1,7 +1,7 @@ # get_line_names -`toloka.metrics.metrics.NewUserBonuses.get_line_names` +`toloka.metrics.metrics.NewUserBonuses.get_line_names` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/metrics.py#L199) -``` +```python get_line_names(self) ``` diff --git a/docs/reference/toloka.metrics.metrics.NewUserBonuses.md b/docs/reference/toloka.metrics.metrics.NewUserBonuses.md index 79ea62c5..1b237ed4 100644 --- a/docs/reference/toloka.metrics.metrics.NewUserBonuses.md +++ b/docs/reference/toloka.metrics.metrics.NewUserBonuses.md @@ -1,14 +1,14 @@ # NewUserBonuses -`toloka.metrics.metrics.NewUserBonuses` +`toloka.metrics.metrics.NewUserBonuses` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/metrics.py#L165) -``` +```python NewUserBonuses( self, count_name: Optional[str] = None, money_name: Optional[str] = None, join_events: bool = False, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` @@ -32,7 +32,7 @@ def print_metric(metric_dict): collector = MetricCollector([NewUserBonuses(toloka_client=toloka_client)], print_metric) asyncio.run(collector.run()) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.metrics.NewUserSkills.get_line_names.md b/docs/reference/toloka.metrics.metrics.NewUserSkills.get_line_names.md index eca99bc3..3393d1d9 100644 --- a/docs/reference/toloka.metrics.metrics.NewUserSkills.get_line_names.md +++ b/docs/reference/toloka.metrics.metrics.NewUserSkills.get_line_names.md @@ -1,7 +1,7 @@ # get_line_names -`toloka.metrics.metrics.NewUserSkills.get_line_names` +`toloka.metrics.metrics.NewUserSkills.get_line_names` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/metrics.py#L283) -``` +```python get_line_names(self) ``` diff --git a/docs/reference/toloka.metrics.metrics.NewUserSkills.md b/docs/reference/toloka.metrics.metrics.NewUserSkills.md index 63399757..c4d60fab 100644 --- a/docs/reference/toloka.metrics.metrics.NewUserSkills.md +++ b/docs/reference/toloka.metrics.metrics.NewUserSkills.md @@ -1,7 +1,7 @@ # NewUserSkills -`toloka.metrics.metrics.NewUserSkills` +`toloka.metrics.metrics.NewUserSkills` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/metrics.py#L238) -``` +```python NewUserSkills( self, skill_id: str, @@ -9,7 +9,7 @@ NewUserSkills( value_name: Optional[str] = None, join_events: bool = False, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` @@ -44,7 +44,7 @@ collector = MetricCollector ) asyncio.run(collector.run()) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.metrics.bind_client.md b/docs/reference/toloka.metrics.metrics.bind_client.md index 8d6e13ae..146d4f7b 100644 --- a/docs/reference/toloka.metrics.metrics.bind_client.md +++ b/docs/reference/toloka.metrics.metrics.bind_client.md @@ -1,8 +1,8 @@ # bind_client -`toloka.metrics.metrics.bind_client` +`toloka.metrics.metrics.bind_client` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/metrics.py#L34) -``` -bind_client(metrics: List['BaseMetric'], toloka_client: TolokaClient) +```python +bind_client(metrics: List[BaseMetric], toloka_client: TolokaClient) ``` Sets/updates toloka_client for all metrics in list. diff --git a/docs/reference/toloka.metrics.pool_metrics.AssignmentEventsInPool.get_line_names.md b/docs/reference/toloka.metrics.pool_metrics.AssignmentEventsInPool.get_line_names.md index d8cdf2ae..b08b5758 100644 --- a/docs/reference/toloka.metrics.pool_metrics.AssignmentEventsInPool.get_line_names.md +++ b/docs/reference/toloka.metrics.pool_metrics.AssignmentEventsInPool.get_line_names.md @@ -1,7 +1,7 @@ # get_line_names -`toloka.metrics.pool_metrics.AssignmentEventsInPool.get_line_names` +`toloka.metrics.pool_metrics.AssignmentEventsInPool.get_line_names` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L117) -``` +```python get_line_names(self) ``` diff --git a/docs/reference/toloka.metrics.pool_metrics.AssignmentEventsInPool.md b/docs/reference/toloka.metrics.pool_metrics.AssignmentEventsInPool.md index b156f46f..34301f30 100644 --- a/docs/reference/toloka.metrics.pool_metrics.AssignmentEventsInPool.md +++ b/docs/reference/toloka.metrics.pool_metrics.AssignmentEventsInPool.md @@ -1,7 +1,7 @@ # AssignmentEventsInPool -`toloka.metrics.pool_metrics.AssignmentEventsInPool` +`toloka.metrics.pool_metrics.AssignmentEventsInPool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L56) -``` +```python AssignmentEventsInPool( self, pool_id: str, @@ -13,7 +13,7 @@ AssignmentEventsInPool( expired_name: Optional[str] = None, join_events: bool = False, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` @@ -48,7 +48,7 @@ def print_metric(metric_dict): collector = MetricCollector([AssignmentEventsInPool(pool_id, toloka_client=toloka_client)], print_metric) asyncio.run(collector.run()) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.pool_metrics.AssignmentsInPool.get_line_names.md b/docs/reference/toloka.metrics.pool_metrics.AssignmentsInPool.get_line_names.md index 492a2eff..b22f40e1 100644 --- a/docs/reference/toloka.metrics.pool_metrics.AssignmentsInPool.get_line_names.md +++ b/docs/reference/toloka.metrics.pool_metrics.AssignmentsInPool.get_line_names.md @@ -1,7 +1,7 @@ # get_line_names -`toloka.metrics.pool_metrics.AssignmentsInPool.get_line_names` +`toloka.metrics.pool_metrics.AssignmentsInPool.get_line_names` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L249) -``` +```python get_line_names(self) ``` diff --git a/docs/reference/toloka.metrics.pool_metrics.AssignmentsInPool.md b/docs/reference/toloka.metrics.pool_metrics.AssignmentsInPool.md index ac509277..937395c1 100644 --- a/docs/reference/toloka.metrics.pool_metrics.AssignmentsInPool.md +++ b/docs/reference/toloka.metrics.pool_metrics.AssignmentsInPool.md @@ -1,7 +1,7 @@ # AssignmentsInPool -`toloka.metrics.pool_metrics.AssignmentsInPool` +`toloka.metrics.pool_metrics.AssignmentsInPool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L199) -``` +```python AssignmentsInPool( self, pool_id: str, @@ -10,7 +10,7 @@ AssignmentsInPool( rejected_name: Optional[str] = None, skipped_name: Optional[str] = None, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` @@ -39,7 +39,7 @@ def print_metric(metric_dict): collector = MetricCollector([AssignmentsInPool(pool_id, toloka_client=toloka_client)], print_metric) asyncio.run(collector.run()) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.pool_metrics.BansInPool.get_line_names.md b/docs/reference/toloka.metrics.pool_metrics.BansInPool.get_line_names.md index a5c66a95..9212f615 100644 --- a/docs/reference/toloka.metrics.pool_metrics.BansInPool.get_line_names.md +++ b/docs/reference/toloka.metrics.pool_metrics.BansInPool.get_line_names.md @@ -1,7 +1,7 @@ # get_line_names -`toloka.metrics.pool_metrics.BansInPool.get_line_names` +`toloka.metrics.pool_metrics.BansInPool.get_line_names` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L473) -``` +```python get_line_names(self) ``` diff --git a/docs/reference/toloka.metrics.pool_metrics.BansInPool.md b/docs/reference/toloka.metrics.pool_metrics.BansInPool.md index 20e278fc..32c226ad 100644 --- a/docs/reference/toloka.metrics.pool_metrics.BansInPool.md +++ b/docs/reference/toloka.metrics.pool_metrics.BansInPool.md @@ -1,7 +1,7 @@ # BansInPool -`toloka.metrics.pool_metrics.BansInPool` +`toloka.metrics.pool_metrics.BansInPool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L420) -``` +```python BansInPool( self, pool_id: str, @@ -9,7 +9,7 @@ BansInPool( filter_by_comment: Optional[Dict[str, str]] = None, join_events: bool = False, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` @@ -52,7 +52,7 @@ collector = MetricCollector( ) asyncio.run(collector.run()) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.pool_metrics.BasePoolMetric.md b/docs/reference/toloka.metrics.pool_metrics.BasePoolMetric.md index 4e1b9c09..6268c659 100644 --- a/docs/reference/toloka.metrics.pool_metrics.BasePoolMetric.md +++ b/docs/reference/toloka.metrics.pool_metrics.BasePoolMetric.md @@ -1,12 +1,12 @@ # BasePoolMetric -`toloka.metrics.pool_metrics.BasePoolMetric` +`toloka.metrics.pool_metrics.BasePoolMetric` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L44) -``` +```python BasePoolMetric( self, pool_id: str, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` diff --git a/docs/reference/toloka.metrics.pool_metrics.PoolCompletedPercentage.get_line_names.md b/docs/reference/toloka.metrics.pool_metrics.PoolCompletedPercentage.get_line_names.md index 9747f53d..1d4c3339 100644 --- a/docs/reference/toloka.metrics.pool_metrics.PoolCompletedPercentage.get_line_names.md +++ b/docs/reference/toloka.metrics.pool_metrics.PoolCompletedPercentage.get_line_names.md @@ -1,7 +1,7 @@ # get_line_names -`toloka.metrics.pool_metrics.PoolCompletedPercentage.get_line_names` +`toloka.metrics.pool_metrics.PoolCompletedPercentage.get_line_names` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L182) -``` +```python get_line_names(self) ``` diff --git a/docs/reference/toloka.metrics.pool_metrics.PoolCompletedPercentage.md b/docs/reference/toloka.metrics.pool_metrics.PoolCompletedPercentage.md index 27d5cb3b..02bb9085 100644 --- a/docs/reference/toloka.metrics.pool_metrics.PoolCompletedPercentage.md +++ b/docs/reference/toloka.metrics.pool_metrics.PoolCompletedPercentage.md @@ -1,13 +1,13 @@ # PoolCompletedPercentage -`toloka.metrics.pool_metrics.PoolCompletedPercentage` +`toloka.metrics.pool_metrics.PoolCompletedPercentage` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L154) -``` +```python PoolCompletedPercentage( self, pool_id: str, percents_name: Optional[str] = None, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` @@ -23,7 +23,7 @@ You can't gather this metric from a pool with infinite task suites. For example, | :----------| :----| :-----------| `pool_id`|**str**|

From which pool track metrics.

`percents_name`|**Optional\[str\]**|

Metric name for pool completion percentage. Default 'completion_percentage'.

-`toloka_client`|**[TolokaClient](toloka.client.TolokaClient.md)**|

Client for connection to Toloka. You can set toloka_client for several metrics via "bind_client" function.

+`toloka_client`|**Optional\[[TolokaClient](toloka.client.TolokaClient.md)\]**|

Client for connection to Toloka. You can set toloka_client for several metrics via "bind_client" function.

**Examples:** @@ -34,7 +34,7 @@ def print_metric(metric_dict): collector = MetricCollector([PoolCompletedPercentage(pool_id, toloka_client=toloka_client)], print_metric) asyncio.run(collector.run()) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.pool_metrics.SpentBudgetOnPool.get_line_names.md b/docs/reference/toloka.metrics.pool_metrics.SpentBudgetOnPool.get_line_names.md index 634e5e5c..5858f1e8 100644 --- a/docs/reference/toloka.metrics.pool_metrics.SpentBudgetOnPool.get_line_names.md +++ b/docs/reference/toloka.metrics.pool_metrics.SpentBudgetOnPool.get_line_names.md @@ -1,7 +1,7 @@ # get_line_names -`toloka.metrics.pool_metrics.SpentBudgetOnPool.get_line_names` +`toloka.metrics.pool_metrics.SpentBudgetOnPool.get_line_names` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L351) -``` +```python get_line_names(self) ``` diff --git a/docs/reference/toloka.metrics.pool_metrics.SpentBudgetOnPool.md b/docs/reference/toloka.metrics.pool_metrics.SpentBudgetOnPool.md index 6ab64fbb..d35d440a 100644 --- a/docs/reference/toloka.metrics.pool_metrics.SpentBudgetOnPool.md +++ b/docs/reference/toloka.metrics.pool_metrics.SpentBudgetOnPool.md @@ -1,13 +1,13 @@ # SpentBudgetOnPool -`toloka.metrics.pool_metrics.SpentBudgetOnPool` +`toloka.metrics.pool_metrics.SpentBudgetOnPool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L326) -``` +```python SpentBudgetOnPool( self, pool_id: str, money_name: Optional[str] = None, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` @@ -30,7 +30,7 @@ def print_metric(metric_dict): collector = MetricCollector([SpentBudgetOnPool(pool_id, toloka_client=toloka_client)], print_metric) asyncio.run(collector.run()) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.pool_metrics.TasksInPool.get_line_names.md b/docs/reference/toloka.metrics.pool_metrics.TasksInPool.get_line_names.md index a7876518..89f257e0 100644 --- a/docs/reference/toloka.metrics.pool_metrics.TasksInPool.get_line_names.md +++ b/docs/reference/toloka.metrics.pool_metrics.TasksInPool.get_line_names.md @@ -1,7 +1,7 @@ # get_line_names -`toloka.metrics.pool_metrics.TasksInPool.get_line_names` +`toloka.metrics.pool_metrics.TasksInPool.get_line_names` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L308) -``` +```python get_line_names(self) ``` diff --git a/docs/reference/toloka.metrics.pool_metrics.TasksInPool.md b/docs/reference/toloka.metrics.pool_metrics.TasksInPool.md index 963331f5..33a84f4a 100644 --- a/docs/reference/toloka.metrics.pool_metrics.TasksInPool.md +++ b/docs/reference/toloka.metrics.pool_metrics.TasksInPool.md @@ -1,13 +1,13 @@ # TasksInPool -`toloka.metrics.pool_metrics.TasksInPool` +`toloka.metrics.pool_metrics.TasksInPool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L283) -``` +```python TasksInPool( self, pool_id: str, tasks_name: Optional[str] = None, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` @@ -30,7 +30,7 @@ def print_metric(metric_dict): collector = MetricCollector([TasksInPool(pool_id, toloka_client=toloka_client)], print_metric) asyncio.run(collector.run()) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.metrics.pool_metrics.WorkersByFilterOnPool.get_line_names.md b/docs/reference/toloka.metrics.pool_metrics.WorkersByFilterOnPool.get_line_names.md index 917bb508..3cd78950 100644 --- a/docs/reference/toloka.metrics.pool_metrics.WorkersByFilterOnPool.get_line_names.md +++ b/docs/reference/toloka.metrics.pool_metrics.WorkersByFilterOnPool.get_line_names.md @@ -1,7 +1,7 @@ # get_line_names -`toloka.metrics.pool_metrics.WorkersByFilterOnPool.get_line_names` +`toloka.metrics.pool_metrics.WorkersByFilterOnPool.get_line_names` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L396) -``` +```python get_line_names(self) ``` diff --git a/docs/reference/toloka.metrics.pool_metrics.WorkersByFilterOnPool.md b/docs/reference/toloka.metrics.pool_metrics.WorkersByFilterOnPool.md index 89c3461e..b4ffdcbc 100644 --- a/docs/reference/toloka.metrics.pool_metrics.WorkersByFilterOnPool.md +++ b/docs/reference/toloka.metrics.pool_metrics.WorkersByFilterOnPool.md @@ -1,14 +1,14 @@ # WorkersByFilterOnPool -`toloka.metrics.pool_metrics.WorkersByFilterOnPool` +`toloka.metrics.pool_metrics.WorkersByFilterOnPool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/metrics/pool_metrics.py#L369) -``` +```python WorkersByFilterOnPool( self, pool_id: str, workers_name: Optional[str] = None, interval_hours: int = 1, *, - toloka_client: TolokaClient = None, + toloka_client: Optional[TolokaClient] = None, timeout: timedelta = ... ) ``` @@ -32,7 +32,7 @@ def print_metric(metric_dict): collector = MetricCollector([WorkersByFilterOnPool(pool_id, toloka_client=toloka_client)], print_metric) asyncio.run(collector.run()) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.streaming.cursor.AssignmentCursor.md b/docs/reference/toloka.streaming.cursor.AssignmentCursor.md index dfc8add6..8650aaff 100644 --- a/docs/reference/toloka.streaming.cursor.AssignmentCursor.md +++ b/docs/reference/toloka.streaming.cursor.AssignmentCursor.md @@ -1,12 +1,12 @@ # AssignmentCursor -`toloka.streaming.cursor.AssignmentCursor` +`toloka.streaming.cursor.AssignmentCursor` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/cursor.py#L216) -``` +```python AssignmentCursor( self, toloka_client: Union[TolokaClient, AsyncMultithreadWrapper[TolokaClient]], event_type: Any, - status: Union[str, Assignment.Status, List[Union[str, Assignment.Status]]] = None, + status: Union[str, Assignment.Status, List[Union[str, Assignment.Status]], None] = None, task_id: Optional[str] = None, task_suite_id: Optional[str] = None, pool_id: Optional[str] = None, diff --git a/docs/reference/toloka.streaming.cursor.BaseCursor.CursorFetchContext.md b/docs/reference/toloka.streaming.cursor.BaseCursor.CursorFetchContext.md index 46c82397..8b45dbf5 100644 --- a/docs/reference/toloka.streaming.cursor.BaseCursor.CursorFetchContext.md +++ b/docs/reference/toloka.streaming.cursor.BaseCursor.CursorFetchContext.md @@ -1,8 +1,8 @@ # CursorFetchContext -`toloka.streaming.cursor.BaseCursor.CursorFetchContext` +`toloka.streaming.cursor.BaseCursor.CursorFetchContext` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/cursor.py#L83) -``` -CursorFetchContext(self, cursor: 'BaseCursor') +```python +CursorFetchContext(self, cursor: BaseCursor) ``` Context manager to return from `BaseCursor.try_fetch_all method`. diff --git a/docs/reference/toloka.streaming.cursor.BaseCursor.inject.md b/docs/reference/toloka.streaming.cursor.BaseCursor.inject.md index 3863bab9..bc7ed242 100644 --- a/docs/reference/toloka.streaming.cursor.BaseCursor.inject.md +++ b/docs/reference/toloka.streaming.cursor.BaseCursor.inject.md @@ -1,7 +1,7 @@ # inject -`toloka.streaming.cursor.BaseCursor.inject` +`toloka.streaming.cursor.BaseCursor.inject` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/cursor.py#L120) -``` -inject(self, injection: 'BaseCursor') +```python +inject(self, injection: BaseCursor) ``` diff --git a/docs/reference/toloka.streaming.cursor.BaseCursor.md b/docs/reference/toloka.streaming.cursor.BaseCursor.md index 986ddcf0..6616b60e 100644 --- a/docs/reference/toloka.streaming.cursor.BaseCursor.md +++ b/docs/reference/toloka.streaming.cursor.BaseCursor.md @@ -1,7 +1,7 @@ # BaseCursor -`toloka.streaming.cursor.BaseCursor` +`toloka.streaming.cursor.BaseCursor` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/cursor.py#L76) -``` +```python BaseCursor( self, toloka_client: Union[TolokaClient, AsyncMultithreadWrapper[TolokaClient]], @@ -9,7 +9,7 @@ BaseCursor( ) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.streaming.cursor.BaseCursor.try_fetch_all.md b/docs/reference/toloka.streaming.cursor.BaseCursor.try_fetch_all.md index 44efa9df..0e7a2ee1 100644 --- a/docs/reference/toloka.streaming.cursor.BaseCursor.try_fetch_all.md +++ b/docs/reference/toloka.streaming.cursor.BaseCursor.try_fetch_all.md @@ -1,7 +1,7 @@ # try_fetch_all -`toloka.streaming.cursor.BaseCursor.try_fetch_all` +`toloka.streaming.cursor.BaseCursor.try_fetch_all` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/cursor.py#L123) -``` +```python try_fetch_all(self) ``` diff --git a/docs/reference/toloka.streaming.cursor.MessageThreadCursor.md b/docs/reference/toloka.streaming.cursor.MessageThreadCursor.md index f62f3f02..8810d35e 100644 --- a/docs/reference/toloka.streaming.cursor.MessageThreadCursor.md +++ b/docs/reference/toloka.streaming.cursor.MessageThreadCursor.md @@ -1,12 +1,12 @@ # MessageThreadCursor -`toloka.streaming.cursor.MessageThreadCursor` +`toloka.streaming.cursor.MessageThreadCursor` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/cursor.py#L402) -``` +```python MessageThreadCursor( self, toloka_client: Union[TolokaClient, AsyncMultithreadWrapper[TolokaClient]], - folder: Union[str, Folder, List[Union[str, Folder]]] = None, - folder_ne: Union[str, Folder, List[Union[str, Folder]]] = None, + folder: Union[str, Folder, List[Union[str, Folder]], None] = None, + folder_ne: Union[str, Folder, List[Union[str, Folder]], None] = None, id_lt: Optional[str] = None, id_lte: Optional[str] = None, id_gt: Optional[str] = None, diff --git a/docs/reference/toloka.streaming.cursor.TaskCursor.md b/docs/reference/toloka.streaming.cursor.TaskCursor.md index 1e9180a6..0355ab50 100644 --- a/docs/reference/toloka.streaming.cursor.TaskCursor.md +++ b/docs/reference/toloka.streaming.cursor.TaskCursor.md @@ -1,7 +1,7 @@ # TaskCursor -`toloka.streaming.cursor.TaskCursor` +`toloka.streaming.cursor.TaskCursor` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/cursor.py#L262) -``` +```python TaskCursor( self, toloka_client: Union[TolokaClient, AsyncMultithreadWrapper[TolokaClient]], diff --git a/docs/reference/toloka.streaming.cursor.UserBonusCursor.md b/docs/reference/toloka.streaming.cursor.UserBonusCursor.md index d52cb1a7..011d250f 100644 --- a/docs/reference/toloka.streaming.cursor.UserBonusCursor.md +++ b/docs/reference/toloka.streaming.cursor.UserBonusCursor.md @@ -1,7 +1,7 @@ # UserBonusCursor -`toloka.streaming.cursor.UserBonusCursor` +`toloka.streaming.cursor.UserBonusCursor` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/cursor.py#L296) -``` +```python UserBonusCursor( self, toloka_client: Union[TolokaClient, AsyncMultithreadWrapper[TolokaClient]], diff --git a/docs/reference/toloka.streaming.cursor.UserRestrictionCursor.md b/docs/reference/toloka.streaming.cursor.UserRestrictionCursor.md index a820ad2a..31fc928f 100644 --- a/docs/reference/toloka.streaming.cursor.UserRestrictionCursor.md +++ b/docs/reference/toloka.streaming.cursor.UserRestrictionCursor.md @@ -1,7 +1,7 @@ # UserRestrictionCursor -`toloka.streaming.cursor.UserRestrictionCursor` +`toloka.streaming.cursor.UserRestrictionCursor` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/cursor.py#L368) -``` +```python UserRestrictionCursor( self, toloka_client: Union[TolokaClient, AsyncMultithreadWrapper[TolokaClient]], diff --git a/docs/reference/toloka.streaming.cursor.UserSkillCursor.md b/docs/reference/toloka.streaming.cursor.UserSkillCursor.md index a5431b9e..8de73019 100644 --- a/docs/reference/toloka.streaming.cursor.UserSkillCursor.md +++ b/docs/reference/toloka.streaming.cursor.UserSkillCursor.md @@ -1,7 +1,7 @@ # UserSkillCursor -`toloka.streaming.cursor.UserSkillCursor` +`toloka.streaming.cursor.UserSkillCursor` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/cursor.py#L330) -``` +```python UserSkillCursor( self, toloka_client: Union[TolokaClient, AsyncMultithreadWrapper[TolokaClient]], diff --git a/docs/reference/toloka.streaming.event.AssignmentEvent.Type.md b/docs/reference/toloka.streaming.event.AssignmentEvent.Type.md index 64dc18b4..f8ea949c 100644 --- a/docs/reference/toloka.streaming.event.AssignmentEvent.Type.md +++ b/docs/reference/toloka.streaming.event.AssignmentEvent.Type.md @@ -1,5 +1,5 @@ # Type -`toloka.streaming.event.AssignmentEvent.Type` +`toloka.streaming.event.AssignmentEvent.Type` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/event.py#L42) An enumeration. diff --git a/docs/reference/toloka.streaming.event.AssignmentEvent.md b/docs/reference/toloka.streaming.event.AssignmentEvent.md index 493889bf..755d1b0b 100644 --- a/docs/reference/toloka.streaming.event.AssignmentEvent.md +++ b/docs/reference/toloka.streaming.event.AssignmentEvent.md @@ -1,7 +1,7 @@ # AssignmentEvent -`toloka.streaming.event.AssignmentEvent` +`toloka.streaming.event.AssignmentEvent` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/event.py#L27) -``` +```python AssignmentEvent( self, *, diff --git a/docs/reference/toloka.streaming.event.BaseEvent.md b/docs/reference/toloka.streaming.event.BaseEvent.md index d7b23530..59e1e3ef 100644 --- a/docs/reference/toloka.streaming.event.BaseEvent.md +++ b/docs/reference/toloka.streaming.event.BaseEvent.md @@ -1,7 +1,7 @@ # BaseEvent -`toloka.streaming.event.BaseEvent` +`toloka.streaming.event.BaseEvent` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/event.py#L23) -``` +```python BaseEvent(self, *, event_time: Optional[datetime] = None) ``` diff --git a/docs/reference/toloka.streaming.event.MessageThreadEvent.md b/docs/reference/toloka.streaming.event.MessageThreadEvent.md index 171fa2d6..e204c393 100644 --- a/docs/reference/toloka.streaming.event.MessageThreadEvent.md +++ b/docs/reference/toloka.streaming.event.MessageThreadEvent.md @@ -1,7 +1,7 @@ # MessageThreadEvent -`toloka.streaming.event.MessageThreadEvent` +`toloka.streaming.event.MessageThreadEvent` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/event.py#L106) -``` +```python MessageThreadEvent( self, *, diff --git a/docs/reference/toloka.streaming.event.TaskEvent.md b/docs/reference/toloka.streaming.event.TaskEvent.md index 02109555..7f820023 100644 --- a/docs/reference/toloka.streaming.event.TaskEvent.md +++ b/docs/reference/toloka.streaming.event.TaskEvent.md @@ -1,7 +1,7 @@ # TaskEvent -`toloka.streaming.event.TaskEvent` +`toloka.streaming.event.TaskEvent` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/event.py#L55) -``` +```python TaskEvent( self, *, diff --git a/docs/reference/toloka.streaming.event.UserBonusEvent.md b/docs/reference/toloka.streaming.event.UserBonusEvent.md index ed214d02..ae2d86de 100644 --- a/docs/reference/toloka.streaming.event.UserBonusEvent.md +++ b/docs/reference/toloka.streaming.event.UserBonusEvent.md @@ -1,7 +1,7 @@ # UserBonusEvent -`toloka.streaming.event.UserBonusEvent` +`toloka.streaming.event.UserBonusEvent` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/event.py#L65) -``` +```python UserBonusEvent( self, *, diff --git a/docs/reference/toloka.streaming.event.UserRestrictionEvent.md b/docs/reference/toloka.streaming.event.UserRestrictionEvent.md index d92ae456..19becfb7 100644 --- a/docs/reference/toloka.streaming.event.UserRestrictionEvent.md +++ b/docs/reference/toloka.streaming.event.UserRestrictionEvent.md @@ -1,7 +1,7 @@ # UserRestrictionEvent -`toloka.streaming.event.UserRestrictionEvent` +`toloka.streaming.event.UserRestrictionEvent` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/event.py#L95) -``` +```python UserRestrictionEvent( self, *, diff --git a/docs/reference/toloka.streaming.event.UserSkillEvent.Type.md b/docs/reference/toloka.streaming.event.UserSkillEvent.Type.md index 921c6cae..eaaf8f8c 100644 --- a/docs/reference/toloka.streaming.event.UserSkillEvent.Type.md +++ b/docs/reference/toloka.streaming.event.UserSkillEvent.Type.md @@ -1,5 +1,5 @@ # Type -`toloka.streaming.event.UserSkillEvent.Type` +`toloka.streaming.event.UserSkillEvent.Type` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/event.py#L86) An enumeration. diff --git a/docs/reference/toloka.streaming.event.UserSkillEvent.md b/docs/reference/toloka.streaming.event.UserSkillEvent.md index d30806f8..3cae28f8 100644 --- a/docs/reference/toloka.streaming.event.UserSkillEvent.md +++ b/docs/reference/toloka.streaming.event.UserSkillEvent.md @@ -1,7 +1,7 @@ # UserSkillEvent -`toloka.streaming.event.UserSkillEvent` +`toloka.streaming.event.UserSkillEvent` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/event.py#L75) -``` +```python UserSkillEvent( self, *, diff --git a/docs/reference/toloka.streaming.locker.BaseLocker.cleanup.md b/docs/reference/toloka.streaming.locker.BaseLocker.cleanup.md index 4d382076..ba2ad4bd 100644 --- a/docs/reference/toloka.streaming.locker.BaseLocker.cleanup.md +++ b/docs/reference/toloka.streaming.locker.BaseLocker.cleanup.md @@ -1,7 +1,7 @@ # cleanup -`toloka.streaming.locker.BaseLocker.cleanup` +`toloka.streaming.locker.BaseLocker.cleanup` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/locker.py#L29) -``` +```python cleanup(self, lock: Any) ``` diff --git a/docs/reference/toloka.streaming.locker.BaseLocker.md b/docs/reference/toloka.streaming.locker.BaseLocker.md index 5b685633..6f2fb04d 100644 --- a/docs/reference/toloka.streaming.locker.BaseLocker.md +++ b/docs/reference/toloka.streaming.locker.BaseLocker.md @@ -1,7 +1,7 @@ # BaseLocker -`toloka.streaming.locker.BaseLocker` +`toloka.streaming.locker.BaseLocker` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/locker.py#L25) -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.streaming.locker.FileLocker.cleanup.md b/docs/reference/toloka.streaming.locker.FileLocker.cleanup.md index 946af15d..64c2bfee 100644 --- a/docs/reference/toloka.streaming.locker.FileLocker.cleanup.md +++ b/docs/reference/toloka.streaming.locker.FileLocker.cleanup.md @@ -1,7 +1,7 @@ # cleanup -`toloka.streaming.locker.FileLocker.cleanup` +`toloka.streaming.locker.FileLocker.cleanup` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/locker.py#L101) -``` +```python cleanup(self, lock: BaseFileLock) ``` diff --git a/docs/reference/toloka.streaming.locker.FileLocker.md b/docs/reference/toloka.streaming.locker.FileLocker.md index 6a01601d..5fc62cd2 100644 --- a/docs/reference/toloka.streaming.locker.FileLocker.md +++ b/docs/reference/toloka.streaming.locker.FileLocker.md @@ -1,7 +1,7 @@ # FileLocker -`toloka.streaming.locker.FileLocker` +`toloka.streaming.locker.FileLocker` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/locker.py#L49) -``` +```python FileLocker( self, dirname: str = '/tmp', @@ -46,7 +46,7 @@ with locker_2('some_key'): with locker_1('some_key'): # raise an error: NewerInstanceDetectedError pass ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.streaming.locker.NewerInstanceDetectedError.md b/docs/reference/toloka.streaming.locker.NewerInstanceDetectedError.md index 286d69e8..2fbb8dbd 100644 --- a/docs/reference/toloka.streaming.locker.NewerInstanceDetectedError.md +++ b/docs/reference/toloka.streaming.locker.NewerInstanceDetectedError.md @@ -1,5 +1,5 @@ # NewerInstanceDetectedError -`toloka.streaming.locker.NewerInstanceDetectedError` +`toloka.streaming.locker.NewerInstanceDetectedError` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/locker.py#L18) Exception being thrown in case of new concurrent pipeline was detected. diff --git a/docs/reference/toloka.streaming.locker.ZooKeeperLocker.md b/docs/reference/toloka.streaming.locker.ZooKeeperLocker.md index 5f2e71a1..35ff8e16 100644 --- a/docs/reference/toloka.streaming.locker.ZooKeeperLocker.md +++ b/docs/reference/toloka.streaming.locker.ZooKeeperLocker.md @@ -1,7 +1,7 @@ # ZooKeeperLocker -`toloka.streaming.locker.ZooKeeperLocker` +`toloka.streaming.locker.ZooKeeperLocker` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/locker.py#L109) -``` +```python ZooKeeperLocker( self, client: KazooClient, diff --git a/docs/reference/toloka.streaming.observer.AssignmentsObserver.inject.md b/docs/reference/toloka.streaming.observer.AssignmentsObserver.inject.md index 4c4d4487..af9196e4 100644 --- a/docs/reference/toloka.streaming.observer.AssignmentsObserver.inject.md +++ b/docs/reference/toloka.streaming.observer.AssignmentsObserver.inject.md @@ -1,7 +1,7 @@ # inject -`toloka.streaming.observer.AssignmentsObserver.inject` +`toloka.streaming.observer.AssignmentsObserver.inject` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L345) -``` -inject(self, injection: 'AssignmentsObserver') +```python +inject(self, injection: AssignmentsObserver) ``` diff --git a/docs/reference/toloka.streaming.observer.AssignmentsObserver.md b/docs/reference/toloka.streaming.observer.AssignmentsObserver.md index 85485751..ea2690dc 100644 --- a/docs/reference/toloka.streaming.observer.AssignmentsObserver.md +++ b/docs/reference/toloka.streaming.observer.AssignmentsObserver.md @@ -1,7 +1,7 @@ # AssignmentsObserver -`toloka.streaming.observer.AssignmentsObserver` +`toloka.streaming.observer.AssignmentsObserver` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L306) -``` +```python AssignmentsObserver( self, toloka_client: Union[TolokaClient, AsyncMultithreadWrapper[TolokaClient]], @@ -44,7 +44,7 @@ def handle_submitted(evets: List[AssignmentEvent]) -> None: observer = AssignmentsObserver(toloka_client, pool_id='123') observer.on_submitted(handle_submitted) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_accepted.md b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_accepted.md index 09670900..0af37a2e 100644 --- a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_accepted.md +++ b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_accepted.md @@ -1,7 +1,7 @@ # on_accepted -`toloka.streaming.observer.AssignmentsObserver.on_accepted` +`toloka.streaming.observer.AssignmentsObserver.on_accepted` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L389) -``` +```python on_accepted(self, callback: Union[Callable[[List[AssignmentEvent]], None], Callable[[List[AssignmentEvent]], Awaitable[None]]]) ``` diff --git a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_any_event.md b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_any_event.md index 0f5eaf3e..47a3dec0 100644 --- a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_any_event.md +++ b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_any_event.md @@ -1,7 +1,7 @@ # on_any_event -`toloka.streaming.observer.AssignmentsObserver.on_any_event` +`toloka.streaming.observer.AssignmentsObserver.on_any_event` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L378) -``` +```python on_any_event(self, callback: Union[Callable[[List[AssignmentEvent]], None], Callable[[List[AssignmentEvent]], Awaitable[None]]]) ``` diff --git a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_created.md b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_created.md index 664e93d1..1b561b35 100644 --- a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_created.md +++ b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_created.md @@ -1,7 +1,7 @@ # on_created -`toloka.streaming.observer.AssignmentsObserver.on_created` +`toloka.streaming.observer.AssignmentsObserver.on_created` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L383) -``` +```python on_created(self, callback: Union[Callable[[List[AssignmentEvent]], None], Callable[[List[AssignmentEvent]], Awaitable[None]]]) ``` diff --git a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_expired.md b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_expired.md index 098eca58..ab7bc0e1 100644 --- a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_expired.md +++ b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_expired.md @@ -1,7 +1,7 @@ # on_expired -`toloka.streaming.observer.AssignmentsObserver.on_expired` +`toloka.streaming.observer.AssignmentsObserver.on_expired` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L398) -``` +```python on_expired(self, callback: Union[Callable[[List[AssignmentEvent]], None], Callable[[List[AssignmentEvent]], Awaitable[None]]]) ``` diff --git a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_rejected.md b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_rejected.md index a2b7ffe5..6facf91b 100644 --- a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_rejected.md +++ b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_rejected.md @@ -1,7 +1,7 @@ # on_rejected -`toloka.streaming.observer.AssignmentsObserver.on_rejected` +`toloka.streaming.observer.AssignmentsObserver.on_rejected` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L392) -``` +```python on_rejected(self, callback: Union[Callable[[List[AssignmentEvent]], None], Callable[[List[AssignmentEvent]], Awaitable[None]]]) ``` diff --git a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_skipped.md b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_skipped.md index 1aca5aaa..b4b00ed4 100644 --- a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_skipped.md +++ b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_skipped.md @@ -1,7 +1,7 @@ # on_skipped -`toloka.streaming.observer.AssignmentsObserver.on_skipped` +`toloka.streaming.observer.AssignmentsObserver.on_skipped` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L395) -``` +```python on_skipped(self, callback: Union[Callable[[List[AssignmentEvent]], None], Callable[[List[AssignmentEvent]], Awaitable[None]]]) ``` diff --git a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_submitted.md b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_submitted.md index 6f8ffb1b..1835951a 100644 --- a/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_submitted.md +++ b/docs/reference/toloka.streaming.observer.AssignmentsObserver.on_submitted.md @@ -1,7 +1,7 @@ # on_submitted -`toloka.streaming.observer.AssignmentsObserver.on_submitted` +`toloka.streaming.observer.AssignmentsObserver.on_submitted` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L386) -``` +```python on_submitted(self, callback: Union[Callable[[List[AssignmentEvent]], None], Callable[[List[AssignmentEvent]], Awaitable[None]]]) ``` diff --git a/docs/reference/toloka.streaming.observer.AssignmentsObserver.register_callback.md b/docs/reference/toloka.streaming.observer.AssignmentsObserver.register_callback.md index 96f927cc..160a6600 100644 --- a/docs/reference/toloka.streaming.observer.AssignmentsObserver.register_callback.md +++ b/docs/reference/toloka.streaming.observer.AssignmentsObserver.register_callback.md @@ -1,11 +1,11 @@ # register_callback -`toloka.streaming.observer.AssignmentsObserver.register_callback` +`toloka.streaming.observer.AssignmentsObserver.register_callback` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L323) -``` +```python register_callback( self, callback: Union[Callable[[List[AssignmentEvent]], None], Callable[[List[AssignmentEvent]], Awaitable[None]]], - event_type: Union[AssignmentEvent.Type, str] + event_type: AssignmentEvent.Type ) ``` @@ -19,7 +19,7 @@ Callback will be called multiple times if it has been registered for multiple ev | Parameters | Type | Description | | :----------| :----| :-----------| `callback`|**Union\[Callable\[\[List\[[AssignmentEvent](toloka.streaming.event.AssignmentEvent.md)\]\], None\], Callable\[\[List\[[AssignmentEvent](toloka.streaming.event.AssignmentEvent.md)\]\], Awaitable\[None\]\]\]**|

Sync or async callable that pass List[AssignmentEvent] of desired event type.

-`event_type`|**Union\[[AssignmentEvent.Type](toloka.streaming.event.AssignmentEvent.Type.md), str\]**|

Selected event type.

+`event_type`|**[AssignmentEvent.Type](toloka.streaming.event.AssignmentEvent.Type.md)**|

Selected event type.

* **Returns:** diff --git a/docs/reference/toloka.streaming.observer.BaseObserver.delete.md b/docs/reference/toloka.streaming.observer.BaseObserver.delete.md new file mode 100644 index 00000000..0bd52284 --- /dev/null +++ b/docs/reference/toloka.streaming.observer.BaseObserver.delete.md @@ -0,0 +1,9 @@ +# delete +`toloka.streaming.observer.BaseObserver.delete` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L43) + +```python +delete(self) +``` + +Schedule observer to be removed from the pipeline. + diff --git a/docs/reference/toloka.streaming.observer.BaseObserver.disable.md b/docs/reference/toloka.streaming.observer.BaseObserver.disable.md new file mode 100644 index 00000000..a10ef2b7 --- /dev/null +++ b/docs/reference/toloka.streaming.observer.BaseObserver.disable.md @@ -0,0 +1,9 @@ +# disable +`toloka.streaming.observer.BaseObserver.disable` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L47) + +```python +disable(self) +``` + +Prevent observer from being called. + diff --git a/docs/reference/toloka.streaming.observer.BaseObserver.enable.md b/docs/reference/toloka.streaming.observer.BaseObserver.enable.md new file mode 100644 index 00000000..fa0be7d3 --- /dev/null +++ b/docs/reference/toloka.streaming.observer.BaseObserver.enable.md @@ -0,0 +1,9 @@ +# enable +`toloka.streaming.observer.BaseObserver.enable` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L51) + +```python +enable(self) +``` + +Enable observer to be called during pipeline execution. + diff --git a/docs/reference/toloka.streaming.observer.BaseObserver.inject.md b/docs/reference/toloka.streaming.observer.BaseObserver.inject.md index 1d548378..9a2d6d6e 100644 --- a/docs/reference/toloka.streaming.observer.BaseObserver.inject.md +++ b/docs/reference/toloka.streaming.observer.BaseObserver.inject.md @@ -1,7 +1,7 @@ # inject -`toloka.streaming.observer.BaseObserver.inject` +`toloka.streaming.observer.BaseObserver.inject` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L34) -``` +```python inject(self, injection: Any) ``` diff --git a/docs/reference/toloka.streaming.observer.BaseObserver.md b/docs/reference/toloka.streaming.observer.BaseObserver.md index aebfbbe3..d4864871 100644 --- a/docs/reference/toloka.streaming.observer.BaseObserver.md +++ b/docs/reference/toloka.streaming.observer.BaseObserver.md @@ -1,14 +1,17 @@ # BaseObserver -`toloka.streaming.observer.BaseObserver` +`toloka.streaming.observer.BaseObserver` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L25) -``` +```python BaseObserver(self, *, name: Optional[str] = None) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| +[delete](toloka.streaming.observer.BaseObserver.delete.md)| Schedule observer to be removed from the pipeline. +[disable](toloka.streaming.observer.BaseObserver.disable.md)| Prevent observer from being called. +[enable](toloka.streaming.observer.BaseObserver.enable.md)| Enable observer to be called during pipeline execution. [inject](toloka.streaming.observer.BaseObserver.inject.md)| None [run](toloka.streaming.observer.BaseObserver.run.md)| For standalone usage (out of a Pipeline). [should_resume](toloka.streaming.observer.BaseObserver.should_resume.md)| None diff --git a/docs/reference/toloka.streaming.observer.BaseObserver.run.md b/docs/reference/toloka.streaming.observer.BaseObserver.run.md index f130ff57..64d26412 100644 --- a/docs/reference/toloka.streaming.observer.BaseObserver.run.md +++ b/docs/reference/toloka.streaming.observer.BaseObserver.run.md @@ -1,7 +1,7 @@ # run -`toloka.streaming.observer.BaseObserver.run` +`toloka.streaming.observer.BaseObserver.run` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L74) -``` +```python run(self, period: timedelta = ...) ``` diff --git a/docs/reference/toloka.streaming.observer.BaseObserver.should_resume.md b/docs/reference/toloka.streaming.observer.BaseObserver.should_resume.md index 894b4798..a1a4eddb 100644 --- a/docs/reference/toloka.streaming.observer.BaseObserver.should_resume.md +++ b/docs/reference/toloka.streaming.observer.BaseObserver.should_resume.md @@ -1,7 +1,7 @@ # should_resume -`toloka.streaming.observer.BaseObserver.should_resume` +`toloka.streaming.observer.BaseObserver.should_resume` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L40) -``` +```python should_resume(self) ``` diff --git a/docs/reference/toloka.streaming.observer.PoolStatusObserver.inject.md b/docs/reference/toloka.streaming.observer.PoolStatusObserver.inject.md index 6ee110cd..3f0726ec 100644 --- a/docs/reference/toloka.streaming.observer.PoolStatusObserver.inject.md +++ b/docs/reference/toloka.streaming.observer.PoolStatusObserver.inject.md @@ -1,7 +1,7 @@ # inject -`toloka.streaming.observer.PoolStatusObserver.inject` +`toloka.streaming.observer.PoolStatusObserver.inject` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L195) -``` -inject(self, injection: 'PoolStatusObserver') +```python +inject(self, injection: PoolStatusObserver) ``` diff --git a/docs/reference/toloka.streaming.observer.PoolStatusObserver.md b/docs/reference/toloka.streaming.observer.PoolStatusObserver.md index 304dfeb4..de729784 100644 --- a/docs/reference/toloka.streaming.observer.PoolStatusObserver.md +++ b/docs/reference/toloka.streaming.observer.PoolStatusObserver.md @@ -1,7 +1,7 @@ # PoolStatusObserver -`toloka.streaming.observer.PoolStatusObserver` +`toloka.streaming.observer.PoolStatusObserver` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L151) -``` +```python PoolStatusObserver( self, toloka_client: Union[TolokaClient, AsyncMultithreadWrapper[TolokaClient]], @@ -49,7 +49,7 @@ Call something at any status change. ```python observer.on_status_change(lambda pool: ...) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_archieved.md b/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_archieved.md index 353f66c1..178d4348 100644 --- a/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_archieved.md +++ b/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_archieved.md @@ -1,7 +1,7 @@ # on_archieved -`toloka.streaming.observer.PoolStatusObserver.on_archieved` +`toloka.streaming.observer.PoolStatusObserver.on_archieved` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L230) -``` +```python on_archieved(self, callback: Union[Callable[[Pool], None], Callable[[Pool], Awaitable[None]]]) ``` diff --git a/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_closed.md b/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_closed.md index 52ac0cc6..e18600f1 100644 --- a/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_closed.md +++ b/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_closed.md @@ -1,7 +1,7 @@ # on_closed -`toloka.streaming.observer.PoolStatusObserver.on_closed` +`toloka.streaming.observer.PoolStatusObserver.on_closed` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L227) -``` +```python on_closed(self, callback: Union[Callable[[Pool], None], Callable[[Pool], Awaitable[None]]]) ``` diff --git a/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_locked.md b/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_locked.md index e1ccc7cf..37de59e2 100644 --- a/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_locked.md +++ b/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_locked.md @@ -1,7 +1,7 @@ # on_locked -`toloka.streaming.observer.PoolStatusObserver.on_locked` +`toloka.streaming.observer.PoolStatusObserver.on_locked` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L233) -``` +```python on_locked(self, callback: Union[Callable[[Pool], None], Callable[[Pool], Awaitable[None]]]) ``` diff --git a/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_open.md b/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_open.md index 27dbfea8..2b887ffe 100644 --- a/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_open.md +++ b/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_open.md @@ -1,7 +1,7 @@ # on_open -`toloka.streaming.observer.PoolStatusObserver.on_open` +`toloka.streaming.observer.PoolStatusObserver.on_open` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L224) -``` +```python on_open(self, callback: Union[Callable[[Pool], None], Callable[[Pool], Awaitable[None]]]) ``` diff --git a/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_status_change.md b/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_status_change.md index 380ee387..49e57c94 100644 --- a/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_status_change.md +++ b/docs/reference/toloka.streaming.observer.PoolStatusObserver.on_status_change.md @@ -1,7 +1,7 @@ # on_status_change -`toloka.streaming.observer.PoolStatusObserver.on_status_change` +`toloka.streaming.observer.PoolStatusObserver.on_status_change` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L236) -``` +```python on_status_change(self, callback: Union[Callable[[Pool], None], Callable[[Pool], Awaitable[None]]]) ``` diff --git a/docs/reference/toloka.streaming.observer.PoolStatusObserver.register_callback.md b/docs/reference/toloka.streaming.observer.PoolStatusObserver.register_callback.md index 18e76d45..a32e9300 100644 --- a/docs/reference/toloka.streaming.observer.PoolStatusObserver.register_callback.md +++ b/docs/reference/toloka.streaming.observer.PoolStatusObserver.register_callback.md @@ -1,11 +1,11 @@ # register_callback -`toloka.streaming.observer.PoolStatusObserver.register_callback` +`toloka.streaming.observer.PoolStatusObserver.register_callback` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/observer.py#L323) -``` +```python register_callback( self, callback: Union[Callable[[Pool], None], Callable[[Pool], Awaitable[None]]], - changed_to: Union[Pool.Status, str] + changed_to: Pool.Status ) ``` @@ -16,7 +16,7 @@ Register given callable for pool status change to given value. | Parameters | Type | Description | | :----------| :----| :-----------| `callback`|**Union\[Callable\[\[[Pool](toloka.client.pool.Pool.md)\], None\], Callable\[\[[Pool](toloka.client.pool.Pool.md)\], Awaitable\[None\]\]\]**|

Sync or async callable that pass Pool object.

-`changed_to`|**Union\[[Pool.Status](toloka.client.pool.Pool.Status.md), str\]**|

Pool status value to register for.

+`changed_to`|**[Pool.Status](toloka.client.pool.Pool.Status.md)**|

Pool status value to register for.

* **Returns:** diff --git a/docs/reference/toloka.streaming.pipeline.Pipeline.inject.md b/docs/reference/toloka.streaming.pipeline.Pipeline.inject.md deleted file mode 100644 index 4d597499..00000000 --- a/docs/reference/toloka.streaming.pipeline.Pipeline.inject.md +++ /dev/null @@ -1,7 +0,0 @@ -# inject -`toloka.streaming.pipeline.Pipeline.inject` - -``` -inject(self, injection: 'Pipeline') -``` - diff --git a/docs/reference/toloka.streaming.pipeline.Pipeline.md b/docs/reference/toloka.streaming.pipeline.Pipeline.md index 5a288f21..393c414b 100644 --- a/docs/reference/toloka.streaming.pipeline.Pipeline.md +++ b/docs/reference/toloka.streaming.pipeline.Pipeline.md @@ -1,7 +1,7 @@ # Pipeline -`toloka.streaming.pipeline.Pipeline` +`toloka.streaming.pipeline.Pipeline` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/pipeline.py#L65) -``` +```python Pipeline( self, period: timedelta = ..., @@ -63,9 +63,10 @@ storage = S3Storage(locker=locker, ...) pipeline = Pipeline(storage=storage) await pipeline.run() # Save state after each iteration. Try to load saved at start. ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| +[observers_iter](toloka.streaming.pipeline.Pipeline.observers_iter.md)| Iterate over registered observers. [register](toloka.streaming.pipeline.Pipeline.register.md)| Register given observer. [run](toloka.streaming.pipeline.Pipeline.run.md)| None diff --git a/docs/reference/toloka.streaming.pipeline.Pipeline.observers_iter.md b/docs/reference/toloka.streaming.pipeline.Pipeline.observers_iter.md new file mode 100644 index 00000000..8ac2ec9e --- /dev/null +++ b/docs/reference/toloka.streaming.pipeline.Pipeline.observers_iter.md @@ -0,0 +1,18 @@ +# observers_iter +`toloka.streaming.pipeline.Pipeline.observers_iter` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/pipeline.py#L193) + +```python +observers_iter(self) +``` + +Iterate over registered observers. + + +* **Returns:** + + An iterator over all registered observers except deleted ones. +May contain observers sheduled to deletion and not deleted yet. + +* **Return type:** + + Iterator\[[BaseObserver](toloka.streaming.observer.BaseObserver.md)\] diff --git a/docs/reference/toloka.streaming.pipeline.Pipeline.register.md b/docs/reference/toloka.streaming.pipeline.Pipeline.register.md index d54a14d3..65ad47ec 100644 --- a/docs/reference/toloka.streaming.pipeline.Pipeline.register.md +++ b/docs/reference/toloka.streaming.pipeline.Pipeline.register.md @@ -1,7 +1,7 @@ # register -`toloka.streaming.pipeline.Pipeline.register` +`toloka.streaming.pipeline.Pipeline.register` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/pipeline.py#L168) -``` +```python register(self, observer: BaseObserver) ``` diff --git a/docs/reference/toloka.streaming.pipeline.Pipeline.run.md b/docs/reference/toloka.streaming.pipeline.Pipeline.run.md index dec2cd9b..c8819ef5 100644 --- a/docs/reference/toloka.streaming.pipeline.Pipeline.run.md +++ b/docs/reference/toloka.streaming.pipeline.Pipeline.run.md @@ -1,7 +1,7 @@ # run -`toloka.streaming.pipeline.Pipeline.run` +`toloka.streaming.pipeline.Pipeline.run` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/pipeline.py#L236) -``` +```python run(self) ``` diff --git a/docs/reference/toloka.streaming.storage.BaseStorage.cleanup.md b/docs/reference/toloka.streaming.storage.BaseStorage.cleanup.md index 880bc033..267037a0 100644 --- a/docs/reference/toloka.streaming.storage.BaseStorage.cleanup.md +++ b/docs/reference/toloka.streaming.storage.BaseStorage.cleanup.md @@ -1,7 +1,7 @@ # cleanup -`toloka.streaming.storage.BaseStorage.cleanup` +`toloka.streaming.storage.BaseStorage.cleanup` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L35) -``` +```python cleanup( self, base_key: str, diff --git a/docs/reference/toloka.streaming.storage.BaseStorage.load.md b/docs/reference/toloka.streaming.storage.BaseStorage.load.md index 2452affb..5ab999f2 100644 --- a/docs/reference/toloka.streaming.storage.BaseStorage.load.md +++ b/docs/reference/toloka.streaming.storage.BaseStorage.load.md @@ -1,7 +1,7 @@ # load -`toloka.streaming.storage.BaseStorage.load` +`toloka.streaming.storage.BaseStorage.load` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L32) -``` +```python load( self, base_key: str, diff --git a/docs/reference/toloka.streaming.storage.BaseStorage.lock.md b/docs/reference/toloka.streaming.storage.BaseStorage.lock.md index dc7a6b34..fbdc009d 100644 --- a/docs/reference/toloka.streaming.storage.BaseStorage.lock.md +++ b/docs/reference/toloka.streaming.storage.BaseStorage.lock.md @@ -1,7 +1,7 @@ # lock -`toloka.streaming.storage.BaseStorage.lock` +`toloka.streaming.storage.BaseStorage.lock` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L26) -``` +```python lock(self, key: str) ``` diff --git a/docs/reference/toloka.streaming.storage.BaseStorage.md b/docs/reference/toloka.streaming.storage.BaseStorage.md index be5a57b8..ef34cd23 100644 --- a/docs/reference/toloka.streaming.storage.BaseStorage.md +++ b/docs/reference/toloka.streaming.storage.BaseStorage.md @@ -1,7 +1,7 @@ # BaseStorage -`toloka.streaming.storage.BaseStorage` +`toloka.streaming.storage.BaseStorage` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L21) -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.streaming.storage.BaseStorage.save.md b/docs/reference/toloka.streaming.storage.BaseStorage.save.md index 481d4fe4..4c3722b1 100644 --- a/docs/reference/toloka.streaming.storage.BaseStorage.save.md +++ b/docs/reference/toloka.streaming.storage.BaseStorage.save.md @@ -1,7 +1,7 @@ # save -`toloka.streaming.storage.BaseStorage.save` +`toloka.streaming.storage.BaseStorage.save` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L29) -``` +```python save( self, base_key: str, diff --git a/docs/reference/toloka.streaming.storage.JSONLocalStorage.DefaultNearbyFileLocker.md b/docs/reference/toloka.streaming.storage.JSONLocalStorage.DefaultNearbyFileLocker.md index 4254a5ee..ddb06ad9 100644 --- a/docs/reference/toloka.streaming.storage.JSONLocalStorage.DefaultNearbyFileLocker.md +++ b/docs/reference/toloka.streaming.storage.JSONLocalStorage.DefaultNearbyFileLocker.md @@ -1,3 +1,3 @@ # DefaultNearbyFileLocker -`toloka.streaming.storage.JSONLocalStorage.DefaultNearbyFileLocker` +`toloka.streaming.storage.JSONLocalStorage.DefaultNearbyFileLocker` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L78) diff --git a/docs/reference/toloka.streaming.storage.JSONLocalStorage.cleanup.md b/docs/reference/toloka.streaming.storage.JSONLocalStorage.cleanup.md index 97f54c09..1ad1829f 100644 --- a/docs/reference/toloka.streaming.storage.JSONLocalStorage.cleanup.md +++ b/docs/reference/toloka.streaming.storage.JSONLocalStorage.cleanup.md @@ -1,7 +1,7 @@ # cleanup -`toloka.streaming.storage.JSONLocalStorage.cleanup` +`toloka.streaming.storage.JSONLocalStorage.cleanup` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L129) -``` +```python cleanup( self, base_key: str, diff --git a/docs/reference/toloka.streaming.storage.JSONLocalStorage.load.md b/docs/reference/toloka.streaming.storage.JSONLocalStorage.load.md index f5b11c74..16f74177 100644 --- a/docs/reference/toloka.streaming.storage.JSONLocalStorage.load.md +++ b/docs/reference/toloka.streaming.storage.JSONLocalStorage.load.md @@ -1,7 +1,7 @@ # load -`toloka.streaming.storage.JSONLocalStorage.load` +`toloka.streaming.storage.JSONLocalStorage.load` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L112) -``` +```python load( self, base_key: str, diff --git a/docs/reference/toloka.streaming.storage.JSONLocalStorage.md b/docs/reference/toloka.streaming.storage.JSONLocalStorage.md index 53d2216d..ba3a8d18 100644 --- a/docs/reference/toloka.streaming.storage.JSONLocalStorage.md +++ b/docs/reference/toloka.streaming.storage.JSONLocalStorage.md @@ -1,7 +1,7 @@ # JSONLocalStorage -`toloka.streaming.storage.JSONLocalStorage` +`toloka.streaming.storage.JSONLocalStorage` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L56) -``` +```python JSONLocalStorage( self, dirname: str = '/tmp', @@ -34,7 +34,7 @@ Set locker explicitly. ```python storage = JSONLocalStorage('/store-data-here', locker=FileLocker('/store-locks-here')) ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.streaming.storage.JSONLocalStorage.save.md b/docs/reference/toloka.streaming.storage.JSONLocalStorage.save.md index a310f34e..a4b0f832 100644 --- a/docs/reference/toloka.streaming.storage.JSONLocalStorage.save.md +++ b/docs/reference/toloka.streaming.storage.JSONLocalStorage.save.md @@ -1,7 +1,7 @@ # save -`toloka.streaming.storage.JSONLocalStorage.save` +`toloka.streaming.storage.JSONLocalStorage.save` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L96) -``` +```python save( self, base_key: str, diff --git a/docs/reference/toloka.streaming.storage.S3Storage.cleanup.md b/docs/reference/toloka.streaming.storage.S3Storage.cleanup.md index 187c6ce0..8494d3e0 100644 --- a/docs/reference/toloka.streaming.storage.S3Storage.cleanup.md +++ b/docs/reference/toloka.streaming.storage.S3Storage.cleanup.md @@ -1,7 +1,7 @@ # cleanup -`toloka.streaming.storage.S3Storage.cleanup` +`toloka.streaming.storage.S3Storage.cleanup` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L217) -``` +```python cleanup( self, base_key: str, diff --git a/docs/reference/toloka.streaming.storage.S3Storage.load.md b/docs/reference/toloka.streaming.storage.S3Storage.load.md index 05804ed4..28e4dd96 100644 --- a/docs/reference/toloka.streaming.storage.S3Storage.load.md +++ b/docs/reference/toloka.streaming.storage.S3Storage.load.md @@ -1,7 +1,7 @@ # load -`toloka.streaming.storage.S3Storage.load` +`toloka.streaming.storage.S3Storage.load` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L197) -``` +```python load( self, base_key: str, diff --git a/docs/reference/toloka.streaming.storage.S3Storage.md b/docs/reference/toloka.streaming.storage.S3Storage.md index 0ceca6bc..0394460e 100644 --- a/docs/reference/toloka.streaming.storage.S3Storage.md +++ b/docs/reference/toloka.streaming.storage.S3Storage.md @@ -1,7 +1,7 @@ # S3Storage -`toloka.streaming.storage.S3Storage` +`toloka.streaming.storage.S3Storage` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L141) -``` +```python S3Storage( self, bucket: Type, @@ -44,7 +44,7 @@ pipeline = Pipeline(storage=storage) ... await pipeline.run() # Will load from storage at the start and save after each iteration. ``` -## Methods summary +## Methods Summary | Method | Description | | :------| :-----------| diff --git a/docs/reference/toloka.streaming.storage.S3Storage.save.md b/docs/reference/toloka.streaming.storage.S3Storage.save.md index dc34ddd8..7047e485 100644 --- a/docs/reference/toloka.streaming.storage.S3Storage.save.md +++ b/docs/reference/toloka.streaming.storage.S3Storage.save.md @@ -1,7 +1,7 @@ # save -`toloka.streaming.storage.S3Storage.save` +`toloka.streaming.storage.S3Storage.save` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/streaming/storage.py#L187) -``` +```python save( self, base_key: str, diff --git a/docs/reference/toloka.util._codegen.attribute.md b/docs/reference/toloka.util._codegen.attribute.md index 629411be..4562f75e 100644 --- a/docs/reference/toloka.util._codegen.attribute.md +++ b/docs/reference/toloka.util._codegen.attribute.md @@ -1,7 +1,7 @@ # attribute -`toloka.util._codegen.attribute` +`toloka.util._codegen.attribute` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/_codegen.py#L242) -``` +```python attribute( *args, required: bool = False, diff --git a/docs/reference/toloka.util._codegen.fix_attrs_converters.md b/docs/reference/toloka.util._codegen.fix_attrs_converters.md index 0ae9f413..d6fb55ea 100644 --- a/docs/reference/toloka.util._codegen.fix_attrs_converters.md +++ b/docs/reference/toloka.util._codegen.fix_attrs_converters.md @@ -1,7 +1,7 @@ # fix_attrs_converters -`toloka.util._codegen.fix_attrs_converters` +`toloka.util._codegen.fix_attrs_converters` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/_codegen.py#L266) -``` +```python fix_attrs_converters(cls) ``` diff --git a/docs/reference/toloka.util._docstrings.inherit_docstrings.md b/docs/reference/toloka.util._docstrings.inherit_docstrings.md index 064af1dd..d9b03af7 100644 --- a/docs/reference/toloka.util._docstrings.inherit_docstrings.md +++ b/docs/reference/toloka.util._docstrings.inherit_docstrings.md @@ -1,7 +1,7 @@ # inherit_docstrings -`toloka.util._docstrings.inherit_docstrings` +`toloka.util._docstrings.inherit_docstrings` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/_docstrings.py#L31) -``` +```python inherit_docstrings(cls: Type[TypeVar('T')]) ``` diff --git a/docs/reference/toloka.util._extendable_enum.ExtendableStrEnum.md b/docs/reference/toloka.util._extendable_enum.ExtendableStrEnum.md index 882a17cc..59547f65 100644 --- a/docs/reference/toloka.util._extendable_enum.ExtendableStrEnum.md +++ b/docs/reference/toloka.util._extendable_enum.ExtendableStrEnum.md @@ -1,5 +1,5 @@ # ExtendableStrEnum -`toloka.util._extendable_enum.ExtendableStrEnum` +`toloka.util._extendable_enum.ExtendableStrEnum` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/_extendable_enum.py#L67) An enumeration. diff --git a/docs/reference/toloka.util._extendable_enum.ExtendableStrEnumMetaclass.md b/docs/reference/toloka.util._extendable_enum.ExtendableStrEnumMetaclass.md index dd238291..5ec069f3 100644 --- a/docs/reference/toloka.util._extendable_enum.ExtendableStrEnumMetaclass.md +++ b/docs/reference/toloka.util._extendable_enum.ExtendableStrEnumMetaclass.md @@ -1,3 +1,3 @@ # ExtendableStrEnumMetaclass -`toloka.util._extendable_enum.ExtendableStrEnumMetaclass` +`toloka.util._extendable_enum.ExtendableStrEnumMetaclass` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/_extendable_enum.py#L38) diff --git a/docs/reference/toloka.util._extendable_enum.extend_enum.md b/docs/reference/toloka.util._extendable_enum.extend_enum.md index b3c0ca40..a5d168bd 100644 --- a/docs/reference/toloka.util._extendable_enum.extend_enum.md +++ b/docs/reference/toloka.util._extendable_enum.extend_enum.md @@ -1,7 +1,7 @@ # extend_enum -`toloka.util._extendable_enum.extend_enum` +`toloka.util._extendable_enum.extend_enum` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/_extendable_enum.py#L12) -``` +```python extend_enum( enumeration: Enum, name: str, diff --git a/docs/reference/toloka.util._managing_headers.add_headers.md b/docs/reference/toloka.util._managing_headers.add_headers.md index 5b24287b..63aad262 100644 --- a/docs/reference/toloka.util._managing_headers.add_headers.md +++ b/docs/reference/toloka.util._managing_headers.add_headers.md @@ -1,7 +1,7 @@ # add_headers -`toloka.util._managing_headers.add_headers` +`toloka.util._managing_headers.add_headers` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/_managing_headers.py#L31) -``` +```python add_headers(client: str) ``` diff --git a/docs/reference/toloka.util._managing_headers.async_add_headers.md b/docs/reference/toloka.util._managing_headers.async_add_headers.md index 17f047b7..1d405588 100644 --- a/docs/reference/toloka.util._managing_headers.async_add_headers.md +++ b/docs/reference/toloka.util._managing_headers.async_add_headers.md @@ -1,7 +1,7 @@ # async_add_headers -`toloka.util._managing_headers.async_add_headers` +`toloka.util._managing_headers.async_add_headers` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/_managing_headers.py#L61) -``` +```python async_add_headers(client: str) ``` diff --git a/docs/reference/toloka.util.async_utils.AsyncInterfaceWrapper.md b/docs/reference/toloka.util.async_utils.AsyncInterfaceWrapper.md index b33976be..97327a85 100644 --- a/docs/reference/toloka.util.async_utils.AsyncInterfaceWrapper.md +++ b/docs/reference/toloka.util.async_utils.AsyncInterfaceWrapper.md @@ -1,7 +1,7 @@ # AsyncInterfaceWrapper -`toloka.util.async_utils.AsyncInterfaceWrapper` +`toloka.util.async_utils.AsyncInterfaceWrapper` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/async_utils.py#L81) -``` +```python AsyncInterfaceWrapper(self, wrapped: TypeVar('T')) ``` diff --git a/docs/reference/toloka.util.async_utils.AsyncMultithreadWrapper.md b/docs/reference/toloka.util.async_utils.AsyncMultithreadWrapper.md index 29c3bd92..e1fc4140 100644 --- a/docs/reference/toloka.util.async_utils.AsyncMultithreadWrapper.md +++ b/docs/reference/toloka.util.async_utils.AsyncMultithreadWrapper.md @@ -1,7 +1,7 @@ # AsyncMultithreadWrapper -`toloka.util.async_utils.AsyncMultithreadWrapper` +`toloka.util.async_utils.AsyncMultithreadWrapper` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/async_utils.py#L102) -``` +```python AsyncMultithreadWrapper( self, wrapped: TypeVar('T'), diff --git a/docs/reference/toloka.util.async_utils.ComplexException.md b/docs/reference/toloka.util.async_utils.ComplexException.md index bd40085c..5d20bffa 100644 --- a/docs/reference/toloka.util.async_utils.ComplexException.md +++ b/docs/reference/toloka.util.async_utils.ComplexException.md @@ -1,7 +1,7 @@ # ComplexException -`toloka.util.async_utils.ComplexException` +`toloka.util.async_utils.ComplexException` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/async_utils.py#L21) -``` +```python ComplexException(self, exceptions: List[Exception]) ``` diff --git a/docs/reference/toloka.util.async_utils.Cooldown.md b/docs/reference/toloka.util.async_utils.Cooldown.md index e7a6de6f..c442ea5e 100644 --- a/docs/reference/toloka.util.async_utils.Cooldown.md +++ b/docs/reference/toloka.util.async_utils.Cooldown.md @@ -1,7 +1,7 @@ # Cooldown -`toloka.util.async_utils.Cooldown` +`toloka.util.async_utils.Cooldown` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/async_utils.py#L162) -``` +```python Cooldown(self, cooldown_time) ``` diff --git a/docs/reference/toloka.util.async_utils.ensure_async.md b/docs/reference/toloka.util.async_utils.ensure_async.md index d3546545..49059b29 100644 --- a/docs/reference/toloka.util.async_utils.ensure_async.md +++ b/docs/reference/toloka.util.async_utils.ensure_async.md @@ -1,7 +1,7 @@ # ensure_async -`toloka.util.async_utils.ensure_async` +`toloka.util.async_utils.ensure_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/async_utils.py#L61) -``` +```python ensure_async(func: Callable) ``` diff --git a/docs/reference/toloka.util.async_utils.get_task_traceback.md b/docs/reference/toloka.util.async_utils.get_task_traceback.md index 8b6d9c35..652e8694 100644 --- a/docs/reference/toloka.util.async_utils.get_task_traceback.md +++ b/docs/reference/toloka.util.async_utils.get_task_traceback.md @@ -1,7 +1,7 @@ # get_task_traceback -`toloka.util.async_utils.get_task_traceback` +`toloka.util.async_utils.get_task_traceback` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/async_utils.py#L149) -``` +```python get_task_traceback(task: Task) ``` diff --git a/docs/reference/toloka.util.get_signature.md b/docs/reference/toloka.util.get_signature.md index 2417aa55..017e8f67 100644 --- a/docs/reference/toloka.util.get_signature.md +++ b/docs/reference/toloka.util.get_signature.md @@ -1,7 +1,7 @@ # get_signature -`toloka.util.get_signature` +`toloka.util.get_signature` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/__init__.py#L48) -``` +```python get_signature(func: Callable) ``` diff --git a/docs/reference/toloka.util.identity.md b/docs/reference/toloka.util.identity.md index 93550760..b809fac0 100644 --- a/docs/reference/toloka.util.identity.md +++ b/docs/reference/toloka.util.identity.md @@ -1,7 +1,7 @@ # identity -`toloka.util.identity` +`toloka.util.identity` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/__init__.py#L60) -``` +```python identity(arg: Any) ``` diff --git a/docs/reference/toloka.util.stored.get_base64_digest.md b/docs/reference/toloka.util.stored.get_base64_digest.md index 22bf7b61..50eba19f 100644 --- a/docs/reference/toloka.util.stored.get_base64_digest.md +++ b/docs/reference/toloka.util.stored.get_base64_digest.md @@ -1,7 +1,7 @@ # get_base64_digest -`toloka.util.stored.get_base64_digest` +`toloka.util.stored.get_base64_digest` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/stored.py#L24) -``` +```python get_base64_digest(key: str) ``` diff --git a/docs/reference/toloka.util.stored.get_stored_meta.md b/docs/reference/toloka.util.stored.get_stored_meta.md index 20900552..2b871d2a 100644 --- a/docs/reference/toloka.util.stored.get_stored_meta.md +++ b/docs/reference/toloka.util.stored.get_stored_meta.md @@ -1,7 +1,7 @@ # get_stored_meta -`toloka.util.stored.get_stored_meta` +`toloka.util.stored.get_stored_meta` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/stored.py#L29) -``` +```python get_stored_meta() ``` diff --git a/docs/reference/toloka.util.stored.pickle_dumps_base64.md b/docs/reference/toloka.util.stored.pickle_dumps_base64.md index b59f5a7e..b9d878d3 100644 --- a/docs/reference/toloka.util.stored.pickle_dumps_base64.md +++ b/docs/reference/toloka.util.stored.pickle_dumps_base64.md @@ -1,7 +1,7 @@ # pickle_dumps_base64 -`toloka.util.stored.pickle_dumps_base64` +`toloka.util.stored.pickle_dumps_base64` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/stored.py#L42) -``` +```python pickle_dumps_base64(obj) ``` diff --git a/docs/reference/toloka.util.stored.pickle_loads_base64.md b/docs/reference/toloka.util.stored.pickle_loads_base64.md index f33c0e9d..5abd103e 100644 --- a/docs/reference/toloka.util.stored.pickle_loads_base64.md +++ b/docs/reference/toloka.util.stored.pickle_loads_base64.md @@ -1,7 +1,7 @@ # pickle_loads_base64 -`toloka.util.stored.pickle_loads_base64` +`toloka.util.stored.pickle_loads_base64` | [Source code](https://github.com/Toloka/toloka-kit/blob/v0.1.24/src/util/stored.py#L46) -``` +```python pickle_loads_base64(dumped) ``` diff --git a/docs/toc.yaml b/docs/toc.yaml new file mode 100644 index 00000000..82051a65 --- /dev/null +++ b/docs/toc.yaml @@ -0,0 +1,15 @@ +title: Toloka-Kit Documentation +href: index.md +items: + - name: Overview + href: index.md + - name: Quick Start + href: quick-start.md + - name: TolokaClient + href: reference/toloka.client.TolokaClient.md + - name: Reference + expanded: true + include: + path: reference/toc.yaml + mode: link +base: en diff --git a/docs/toloka-kit.ditamap b/docs/toloka-kit.ditamap deleted file mode 100644 index 2ac4a3c4..00000000 --- a/docs/toloka-kit.ditamap +++ /dev/null @@ -1,15 +0,0 @@ - - - - - Toloka-Kit - - - - - - - - - - diff --git a/examples/README.md b/examples/README.md index 0d4dfef1..9c38ea3b 100644 --- a/examples/README.md +++ b/examples/README.md @@ -38,8 +38,9 @@ Why it may be usefull: | | **Pipelines** | | [Simple Toloka+ML pipeline on Prefect](https://github.com/Toloka/toloka-kit/tree/main/examples/9.toloka_and_ml_on_prefect)

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Toloka/toloka-kit/blob/main/examples/9.toloka_and_ml_on_prefect/example.ipynb) | This example illustrates how crowdsourcing using Toloka can be made easier and cheaper by integrating an ML model. Furthermore, it shows how to run the whole project in the cloud using Prefect, which makes workflow orchestration much simpler. |```Prefect```, ```ML```, ```Autohelper```| | [Building streaming pipelines in Toloka](https://github.com/Toloka/toloka-kit/tree/main/examples/6.streaming_pipelines)

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Toloka/toloka-kit/blob/main/examples/6.streaming_pipelines/streaming_pipelines.ipynb) | Let's solve the following task: find the goods in the online-store by given image and aggange found results by relevance. In this example we unite 3 different Toloka projects into one useful Pipeline. |```Pipeline```, ```Collecting```, ```Dataset```| -| | **Search relevance** | +| | **Relevance** | | [Search relevance](https://github.com/Toloka/toloka-kit/tree/main/examples/8.search_relevance)

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Toloka/toloka-kit/blob/main/examples/8.search_relevance/search_relevance.ipynb) | We have a set of search queries and products on a website. We need to determine the extent to which each query is relevant to the corresponding product on the website. We ask performers to look at the search query and the product image from the website and rate the relevance level. |```Relevance```| +| [Ad relevance](https://github.com/oleg-cat/checkadv/blob/main/checkadv.ipynb)

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/oleg-cat/checkadv/blob/main/checkadv.ipynb) | In this example we aim to explore webpages containing ads and their descriptions. We will run the project using new Toloka Ready-to-go solutions (App Services). |```Relevance```| | | **Benchmarks** | | [Image classification](https://github.com/Toloka/toloka-kit/tree/main/examples/benchmarks/image_classification_cinic10.ipynb)

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Toloka/toloka-kit/blob/main/examples/benchmarks/image_classification_cinic10.ipynb) | Image classification on CINIC-10. Minimal configuration to achieve the described levels of quality. Accuracy on Test = 88% |```Benchmark```, ```CV```, ```Classification```| | [Text classification](https://github.com/Toloka/toloka-kit/tree/main/examples/benchmarks/text_classification_imdb.ipynb)

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Toloka/toloka-kit/blob/main/examples/benchmarks/text_classification_imdb.ipynb) | Text classification on IMDB movie reviews. Minimal configuration to achieve the described levels of quality. Accuracy on Test = 89% |```Benchmark```, ```NLP```, ```Classification```| diff --git a/examples/metrics/graphite.ipynb b/examples/metrics/graphite.ipynb index 070e3cbd..5e6b22e2 100644 --- a/examples/metrics/graphite.ipynb +++ b/examples/metrics/graphite.ipynb @@ -2,26 +2,23 @@ "cells": [ { "cell_type": "markdown", + "metadata": {}, "source": [ "# Collect and show metrics in Graphite" - ], - "metadata": { - "collapsed": false - } + ] }, { "cell_type": "markdown", + "metadata": {}, "source": [ "In this example we will learn how to collect metrics using Toloka-kit and\n", "send them to remote metrics server (we will use [Graphite](https://graphiteapp.org) but switching to any other solution is very easy)." - ], - "metadata": { - "collapsed": false - } + ] }, { "cell_type": "code", "execution_count": null, + "metadata": {}, "outputs": [], "source": [ "%%capture\n", @@ -35,107 +32,76 @@ "import toloka.metrics as metrics\n", "import toloka.client as toloka\n", "from toloka.metrics import MetricCollector" - ], - "metadata": { - "collapsed": false, - "pycharm": { - "name": "#%%\n" - } - } + ] }, { "cell_type": "code", "execution_count": null, + "metadata": {}, "outputs": [], "source": [ "toloka_client = toloka.TolokaClient(input(\"Enter your token:\"), 'PRODUCTION')\n", "print(toloka_client.get_requester())" - ], - "metadata": { - "collapsed": false, - "pycharm": { - "name": "#%%\n" - } - } + ] }, { "cell_type": "markdown", + "metadata": {}, "source": [ "For this example we will run pipeline from [Streaming pipeline example](https://github.com/Toloka/toloka-kit/tree/main/examples/6.streaming_pipelines/streaming_pipelines.ipynb) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Toloka/toloka-kit/blob/main/examples/6.streaming_pipelines/streaming_pipelines.ipynb).\n", "If you are running this jupyter notebook in colab please download necessary script with the following line of code:" - ], - "metadata": { - "collapsed": false - } + ] }, { "cell_type": "code", "execution_count": null, + "metadata": {}, "outputs": [], "source": [ "!wget --quiet --show-progress \"https://raw.githubusercontent.com/Toloka/toloka-kit/main/examples/metrics/find_items_pipeline.py\"" - ], - "metadata": { - "collapsed": false, - "pycharm": { - "name": "#%%\n" - } - } + ] }, { "cell_type": "code", "execution_count": null, + "metadata": {}, "outputs": [], "source": [ "from find_items_pipeline import FindItemsPipeline\n", "pipeline = FindItemsPipeline(client=toloka_client)" - ], - "metadata": { - "collapsed": false, - "pycharm": { - "name": "#%%\n" - } - } + ] }, { "cell_type": "markdown", + "metadata": {}, "source": [ "Create projects and pools needed for pipeline" - ], - "metadata": { - "collapsed": false - } + ] }, { "cell_type": "code", "execution_count": null, + "metadata": {}, "outputs": [], "source": [ "pipeline.init_pipeline()" - ], - "metadata": { - "collapsed": false, - "pycharm": { - "name": "#%%\n" - } - } + ] }, { "cell_type": "markdown", + "metadata": {}, "source": [ "## Configuring metrics collection in Graphite\n", "\n", "You need to [configure](https://graphite.readthedocs.io/en/stable/install.html) Graphite server before proceeding\n", "to this section. An easy option might be using official docker container. Selection of user interface is up to you\n", "(during creation of this example we used [Grafana](https://grafana.com))." - ], - "metadata": { - "collapsed": false - } + ] }, { "cell_type": "code", "execution_count": null, + "metadata": {}, "outputs": [], "source": [ "# specify your Graphite instance url and port\n", @@ -150,27 +116,19 @@ " raise RuntimeError('Graphite server is unreachable!')\n", "else:\n", " print('Congratulations, connected to Graphite server!')" - ], - "metadata": { - "collapsed": false, - "pycharm": { - "name": "#%%\n" - } - } + ] }, { "cell_type": "markdown", + "metadata": {}, "source": [ - "Firstly we will define callback that will be used to send metrics to graphite. This callback defines the process of\n", - "collected metrics logging (in our case logging is implemented by sending logs to Graphite server in plaintext format for the simplicity sake)." - ], - "metadata": { - "collapsed": false - } + "First, let's define a callback for handling metrics values. We'll use it to store the data on a Graphite server." + ] }, { "cell_type": "code", "execution_count": null, + "metadata": {}, "outputs": [], "source": [ "class GraphiteLogger:\n", @@ -206,27 +164,25 @@ " # (this may be the case if you are running Graphite inside docker hosted in MacOS)\n", " use_ipv6=False,\n", ")" - ], - "metadata": { - "collapsed": false, - "pycharm": { - "name": "#%%\n" - } - } + ] }, { "cell_type": "markdown", + "metadata": {}, "source": [ - "Before sending metrics to Graphite we need to collect them with the `MetricCollector`. For this example we will collect\n", - "a number of submitted assignments, accepted assignments and total expenses for each pool. All available metrics can be found in the [documentation](https://toloka.ai/docs/toloka-kit/reference/toloka.metrics.metrics.BaseMetric.html)." - ], - "metadata": { - "collapsed": false - } + "For sending metrics to Graphite we have to:\n", + "- Define which metrics we'll collect.\n", + "- Describe what we'll do with these metrics, as a callable functor.\n", + "- Define a TolokaClient for each metric.\n", + "- Asynchronously call `run` for the MetricCollector instance.\n", + "\n", + "For this example we will collect a number of submitted assignments, accepted assignments and total expenses for each pool. All available metrics can be found in the [documentation](https://toloka.ai/docs/toloka-kit/reference/toloka.metrics.metrics.BaseMetric.html)." + ] }, { "cell_type": "code", "execution_count": null, + "metadata": {}, "outputs": [], "source": [ "metric_collector = MetricCollector(\n", @@ -268,16 +224,11 @@ "# You can specify toloka_client argument in each metric instead of calling\n", "# bind_client if you want to use different clients for different metrics\n", "metrics.bind_client(metric_collector.metrics, toloka_client)" - ], - "metadata": { - "collapsed": false, - "pycharm": { - "name": "#%%\n" - } - } + ] }, { "cell_type": "markdown", + "metadata": {}, "source": [ "## Running pipeline\n", "\n", @@ -285,14 +236,12 @@ "\n", "⚠️ **Be careful**:\n", "real projects will be created and money will be spent in case of running in production environment! ⚠️\n" - ], - "metadata": { - "collapsed": false - } + ] }, { "cell_type": "code", "execution_count": null, + "metadata": {}, "outputs": [], "source": [ "# Google Colab is using a global event pool,\n", @@ -303,16 +252,11 @@ " asyncio.get_event_loop().run_until_complete(asyncio.gather(metric_collector.run(), pipeline.run()))\n", "else:\n", " await asyncio.gather(metric_collector.run(), pipeline.run())" - ], - "metadata": { - "collapsed": false, - "pycharm": { - "name": "#%%\n" - } - } + ] }, { "cell_type": "markdown", + "metadata": {}, "source": [ "Here is an example of metrics displayed in Grafana with Graphite as the Datasource after pipeline completion.\n", "\n", @@ -324,34 +268,68 @@ " Figure 2. Grafana web view.\n", " \n", "" - ], - "metadata": { - "collapsed": false, - "pycharm": { - "name": "#%% md\n" - } - } + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Using Graphite in production\n", + "In normal usage it's better to gather metrics from Toloka once in ten minutes or less often. So you must prepare your graphite for that. Typically it already has `count` type of aggregation, that looks like that:\n", + "```\n", + " [count]\n", + " pattern = \\.count$\n", + " xFilesFactor = 0\n", + " aggregationMethod = sum\n", + "```\n", + "\n", + "\n", + "It means, that all new metrics that end on ```.count``` will be processed like that: sum all of their values when graphite needs to aggregate this metric on some interval.\n", + "\n", + "\n", + "But for metrics that cannot be summed, for example, completion percentage, by default it's no useful type. So you need to add them to the ```storage-aggregation.conf```:\n", + "```\n", + " [metric]\n", + " pattern=_metric$\n", + " xFileFactor = 0\n", + " aggregationMethod = average\n", + "```\n", + "\n", + "It means if you send a metric that ends on ```_metric``` to graphite, it will aggregate this metric like an average on any interval." + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "And you need to set up right retention for this metric in ```storage-schemas.conf```, for example:\n", + "```\n", + " [metric]\n", + " pattern = _metric$\n", + " retentions = 10m:7d,1h:360d\n", + "```" + ] } ], "metadata": { "kernelspec": { - "display_name": "Python 3", + "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", - "version": 2 + "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", - "pygments_lexer": "ipython2", - "version": "2.7.6" + "pygments_lexer": "ipython3", + "version": "3.7.12" } }, "nbformat": 4, - "nbformat_minor": 0 -} \ No newline at end of file + "nbformat_minor": 1 +} diff --git a/examples/metrics/jupyter_dashboard.ipynb b/examples/metrics/jupyter_dashboard.ipynb index f1fa785f..8f44873b 100644 --- a/examples/metrics/jupyter_dashboard.ipynb +++ b/examples/metrics/jupyter_dashboard.ipynb @@ -10,9 +10,6 @@ { "cell_type": "markdown", "metadata": { - "pycharm": { - "name": "#%% md\n" - } }, "source": [ "In this example we will learn how to collect metrics using Toloka-kit and\n", @@ -38,9 +35,6 @@ "cell_type": "code", "execution_count": null, "metadata": { - "pycharm": { - "name": "#%%\n" - } }, "outputs": [], "source": [ @@ -65,18 +59,12 @@ ], "metadata": { "collapsed": false, - "pycharm": { - "name": "#%%\n" - } } }, { "cell_type": "code", "execution_count": null, "metadata": { - "pycharm": { - "name": "#%%\n" - } }, "outputs": [], "source": [ @@ -87,9 +75,6 @@ { "cell_type": "markdown", "metadata": { - "pycharm": { - "name": "#%% md\n" - } }, "source": [ "Create projects and pools needed for pipeline." @@ -99,9 +84,6 @@ "cell_type": "code", "execution_count": null, "metadata": { - "pycharm": { - "name": "#%%\n" - } }, "outputs": [], "source": [ @@ -111,9 +93,6 @@ { "cell_type": "markdown", "metadata": { - "pycharm": { - "name": "#%% md\n" - } }, "source": [ "## Configuring jupyter dashboard\n", @@ -126,9 +105,6 @@ "cell_type": "code", "execution_count": null, "metadata": { - "pycharm": { - "name": "#%%\n" - } }, "outputs": [], "source": [ @@ -191,9 +167,6 @@ "cell_type": "code", "execution_count": null, "metadata": { - "pycharm": { - "name": "#%%\n" - } }, "outputs": [], "source": [ @@ -203,9 +176,6 @@ { "cell_type": "markdown", "metadata": { - "pycharm": { - "name": "#%% md\n" - } }, "source": [ "---\n", @@ -232,9 +202,6 @@ "cell_type": "code", "execution_count": null, "metadata": { - "pycharm": { - "name": "#%%\n" - } }, "outputs": [], "source": [ @@ -293,9 +260,6 @@ { "cell_type": "markdown", "metadata": { - "pycharm": { - "name": "#%% md\n" - } }, "source": [ "---\n", diff --git a/functional_tests/client/test_project.py b/functional_tests/client/test_project.py index 83060215..ad1fe950 100644 --- a/functional_tests/client/test_project.py +++ b/functional_tests/client/test_project.py @@ -1,5 +1,10 @@ +import asyncio +import datetime + import pytest from toloka.client.project import Project +from ..template_builder import compare_view_specs +from toloka.metrics import TasksInPool def test_project_is_created(client, empty_project): @@ -28,6 +33,10 @@ def test_clone_project(cloned_project_with_pool, project_with_pool): sorted(project_with_pool.unstructure().items()) ): if key1 not in {'status', 'created', 'id'}: + if key1 == 'task_spec': + compare_view_specs(value1['view_spec'], value2['view_spec']) + value1.pop('view_spec') + value2.pop('view_spec') assert value1 == value2, f'Projects are different in {key1}' @@ -45,3 +54,8 @@ def test_update_project(client, cloned_project_with_pool): cloned_project_with_pool.public_name = 'Updated public name' client.update_project(cloned_project_with_pool.id, cloned_project_with_pool) assert client.get_project(cloned_project_with_pool.id).public_name == 'Updated public name' + + +def test_metrics_time_format(client, pool_in_project_with_pool): + lines = asyncio.run(TasksInPool(pool_in_project_with_pool.id, tasks_name='test', toloka_client=client).get_lines()) + assert lines['test'][0][0].tzinfo == datetime.timezone.utc diff --git a/functional_tests/client/test_tasks.py b/functional_tests/client/test_tasks.py index a45741e5..4b8fd2dc 100644 --- a/functional_tests/client/test_tasks.py +++ b/functional_tests/client/test_tasks.py @@ -11,7 +11,7 @@ def pool(client, empty_project): private_name='Test pool', reward_per_assignment=0.01, assignment_max_duration_seconds=100, - will_expire=datetime.datetime.utcnow() + datetime.timedelta(days=365), + will_expire=datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(days=365), ) new_pool.set_mixer_config(real_tasks_count=1) new_pool = client.create_pool(new_pool) diff --git a/functional_tests/template_builder/__init__.py b/functional_tests/template_builder/__init__.py index 5c24eabb..75491050 100644 --- a/functional_tests/template_builder/__init__.py +++ b/functional_tests/template_builder/__init__.py @@ -1,22 +1,24 @@ import json -def assert_view_spec_uploads_to_project(client, project, view_spec): - def compare_recursively(left, right): - if not isinstance(left, dict): - assert left == right - else: - keys = left.keys() | right.keys() - keys.discard('_unexpected') - keys.discard('localizationConfig') - for key in keys: - # config is serialized to string so to compare two dicts serialized to strings we need to deserialize - # them first - if key == 'config': - compare_recursively(json.loads(left[key]), json.loads(right[key])) - else: - compare_recursively(left[key], right[key]) +def compare_view_specs(left, right): + if not isinstance(left, dict): + assert left == right + else: + keys = left.keys() | right.keys() + keys.discard('_unexpected') + keys.discard('localizationConfig') + keys.discard('inputExample') + for key in keys: + # config is serialized to string so to compare two dicts serialized to strings we need to deserialize + # them first + if key == 'config': + compare_view_specs(json.loads(left[key]), json.loads(right[key])) + else: + compare_view_specs(left[key], right[key]) + +def assert_view_spec_uploads_to_project(client, project, view_spec): project.task_spec.view_spec = view_spec created_project = client.update_project(project.id, project) - compare_recursively(created_project.task_spec.view_spec.unstructure(), view_spec.unstructure()) + compare_view_specs(created_project.task_spec.view_spec.unstructure(), view_spec.unstructure()) diff --git a/functional_tests/template_builder/test_views.py b/functional_tests/template_builder/test_views.py index 85028a19..0ec5fb44 100644 --- a/functional_tests/template_builder/test_views.py +++ b/functional_tests/template_builder/test_views.py @@ -168,6 +168,23 @@ def list_view(text_view, add_label_hint_validation): ) +@pytest.fixture +def map_view(add_label_hint_validation): + return add_label_hint_validation(tb.MapViewV1)( + '29.748713,-95.404287', + markers=[tb.MapViewV1.Marker( + position='29.748713,-95.404287', + color='red', + label='label' + )], + polygons=[tb.MapViewV1.Polygon( + points=['29.748713,-95.404287', '29.748713,-95.404287'], + color='blue' + )], + zoom=1 + ) + + @pytest.fixture def markdown_view(add_label_hint_validation): return add_label_hint_validation(tb.MarkdownViewV1)( @@ -204,6 +221,7 @@ def video_view(add_label_hint_validation): lazy_fixture('link_view'), lazy_fixture('link_group_view'), lazy_fixture('list_view'), + lazy_fixture('map_view'), lazy_fixture('markdown_view'), lazy_fixture('text_view'), lazy_fixture('video_view'), diff --git a/setup.py b/setup.py index cfb28f16..b85f7a81 100755 --- a/setup.py +++ b/setup.py @@ -39,7 +39,7 @@ 'kazoo >= 2.6.1', 'requests', 'typing-extensions', - 'urllib3', + 'urllib3 >= 1.26.0', 'pandas', 'plotly', 'simplejson', diff --git a/src/__version__.py b/src/__version__.py index cded50a7..b9099aee 100644 --- a/src/__version__.py +++ b/src/__version__.py @@ -1,3 +1,3 @@ __title__ = 'toloka-kit' -__version__ = '0.1.23' +__version__ = '0.1.24' __license__ = 'Apache 2.0' diff --git a/src/async_client/client.py b/src/async_client/client.py index 1566a55f..50ecc43a 100644 --- a/src/async_client/client.py +++ b/src/async_client/client.py @@ -42,7 +42,7 @@ async def wait_operation(self, op: operations.Operation, timeout: datetime.timed if op.is_completed(): return op - utcnow = datetime.datetime.utcnow() + utcnow = datetime.datetime.now(datetime.timezone.utc) wait_until_time = utcnow + timeout if not op.started or utcnow - op.started < default_initial_delay: @@ -53,5 +53,5 @@ async def wait_operation(self, op: operations.Operation, timeout: datetime.timed if op.is_completed(): return op await asyncio.sleep(default_time_to_wait.total_seconds()) - if datetime.datetime.utcnow() > wait_until_time: + if datetime.datetime.now(datetime.timezone.utc) > wait_until_time: raise TimeoutError diff --git a/src/client/__init__.py b/src/client/__init__.py index eda9c391..cf6bd5a5 100644 --- a/src/client/__init__.py +++ b/src/client/__init__.py @@ -31,20 +31,35 @@ 'user_skill', 'webhook_subscription', + 'structure', + 'unstructure', + 'TolokaClient', + 'AggregatedSolution', + 'AnalyticsRequest', 'Assignment', + 'AssignmentPatch', + 'CloneResults', + 'GetAssignmentsTsvParameters', 'Attachment', 'Folder', 'MessageThread', 'MessageThreadReply', 'MessageThreadFolders', 'MessageThreadCompose', + 'OperationLogItem', + 'Requester', 'Skill', + 'SetUserSkillRequest', 'TaskSuite', 'Task', 'Training', 'UserBonus', + 'UserBonusCreateRequestParameters', + 'UserRestriction', + 'UserSkill', 'Pool', + 'PoolPatchRequest', 'Project', 'AppProject', 'App', @@ -68,7 +83,7 @@ from decimal import Decimal from enum import Enum, unique -from typing import BinaryIO, Callable, Generator, List, Optional, Tuple, Union +from typing import BinaryIO, Callable, Generator, List, Optional, Sequence, Tuple, Union from urllib3.util.retry import Retry from . import actions @@ -117,7 +132,7 @@ ) from .operation_log import OperationLogItem from .pool import Pool, PoolPatchRequest -from .primitives.retry import TolokaRetry, PreloadingHTTPAdapter +from .primitives.retry import TolokaRetry, PreloadingHTTPAdapter, STATUSES_TO_RETRY from .primitives.base import autocast_to_enum from .project import Project from .training import Training @@ -190,7 +205,11 @@ class TolokaClient: >>> toloka_client = toloka.TolokaClient(your_oauth_token, 'PRODUCTION') # Or switch to 'SANDBOX' environment ... - **Note**: `toloka_client` instance will be used to pass all API calls later on. + {% note info %} + + `toloka_client` instance will be used to pass all API calls later on. + + {% endnote %} """ @unique @@ -243,12 +262,12 @@ def __init__( def _default_retryer_factory( retries: int, retry_quotas: Union[List[str], str, None], - status_list: Tuple[int] = (408, 409, 429, 500, 503), + status_list: Optional[Sequence[int]] = None, ) -> Retry: return TolokaRetry( retry_quotas=retry_quotas, total=retries, - status_forcelist=list(status_list), + status_forcelist=list(status_list or STATUSES_TO_RETRY), allowed_methods=['HEAD', 'GET', 'PUT', 'DELETE', 'OPTIONS', 'TRACE', 'POST', 'PATCH'], backoff_factor=2, # summary retry time more than 10 seconds ) @@ -383,15 +402,22 @@ def _sync_via_async(self, objects, parameters, url, result_type, operation_type, @expand('request') @add_headers('client') - def aggregate_solutions_by_pool(self, request: aggregation.PoolAggregatedSolutionRequest) -> operations.AggregatedSolutionOperation: + def aggregate_solutions_by_pool( + self, + request: aggregation.PoolAggregatedSolutionRequest + ) -> operations.AggregatedSolutionOperation: """Starts aggregation of solutions in the pool Responses to all completed tasks will be aggregated. The method only starts the aggregation and returns the operation for further tracking. - **Note**: In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), + {% note info %} + + In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), that have more aggregation methods and can perform on your computers. + {% endnote %} + Args: request: Parameters describing in which pool to aggregate solutions and by what rules. @@ -452,9 +478,13 @@ def find_aggregated_solutions(self, operation_id: str, request: search_requests. """Gets aggregated responses after the AggregatedSolutionOperation completes. It is better to use the "get_aggregated_solutions" method, that allows to iterate through all results. - **Note**: In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), + {% note info %} + + In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), that have more aggregation methods and can perform on your computers. + {% endnote %} + Args: operation_id: From what aggregation operation you want to get results. request: How to filter search results. @@ -487,12 +517,19 @@ def find_aggregated_solutions(self, operation_id: str, request: search_requests. @expand('request') @add_headers('client') - def get_aggregated_solutions(self, operation_id: str, request: search_requests.AggregatedSolutionSearchRequest) -> Generator[AggregatedSolution, None, None]: + def get_aggregated_solutions( + self, + operation_id: str, request: search_requests.AggregatedSolutionSearchRequest + ) -> Generator[AggregatedSolution, None, None]: """Finds all aggregated responses after the AggregatedSolutionOperation completes - **Note**: In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), + {% note info %} + + In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), that have more aggregation methods and can perform on your computers. + {% endnote %} + Args: operation_id: From what aggregation operation you want to get results. request: How to filter search results. @@ -793,10 +830,10 @@ def compose_message_thread(self, compose: MessageThreadCompose) -> MessageThread Example: If you want to thank Toloka performers who have tried to complete your tasks, send them a nice message. - >>> message_text = 'Amazing job! We\'ve just trained our first model with the data YOU prepared for us. Thank you!' + >>> message_text = "Amazing job! We've just trained our first model with the data YOU prepared for us. Thank you!" >>> toloka_client.compose_message_thread( >>> recipients_select_type='ALL', - >>> topic={'EN':'Thank you, performer!'}, + >>> topic={'EN': 'Thank you, performer!'}, >>> text={'EN': message_text}, >>> answerable=False >>> ) @@ -1316,7 +1353,10 @@ def clone_pool(self, pool_id: str) -> Pool: operation = self.clone_pool_async(pool_id) operation = self.wait_operation(operation) result = self.get_pool(operation.details.pool_id) - logger.info(f'A new pool with ID "{result.id}" has been cloned. Link to open in web interface: {self.url}/requester/project/{result.project_id}/pool/{result.id}') + logger.info( + f'A new pool with ID "{result.id}" has been cloned. Link to open in web interface: ' + f'{self.url}/requester/project/{result.project_id}/pool/{result.id}' + ) return result @add_headers('client') @@ -1359,7 +1399,7 @@ def create_pool(self, pool: Pool) -> Pool: >>> project_id=existing_project_id, >>> private_name='Pool 1', >>> may_contain_adult_content=False, - >>> will_expire=datetime.datetime.utcnow() + datetime.timedelta(days=365), + >>> will_expire=datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(days=365), >>> reward_per_assignment=0.01, >>> assignment_max_duration_seconds=60*20, >>> defaults=toloka.pool.Pool.Defaults(default_overlap_for_new_task_suites=3), @@ -1376,7 +1416,10 @@ def create_pool(self, pool: Pool) -> Pool: response = self._request('post', '/v1/pools', json=unstructure(pool)) result = structure(response, Pool) - logger.info(f'A new pool with ID "{result.id}" has been created. Link to open in web interface: {self.url}/requester/project/{result.project_id}/pool/{result.id}') + logger.info( + f'A new pool with ID "{result.id}" has been created. Link to open in web interface: ' + f'{self.url}/requester/project/{result.project_id}/pool/{result.id}' + ) return result @expand('request') @@ -1417,7 +1460,8 @@ def find_pools(self, request: search_requests.PoolSearchRequest, >>> toloka_client.find_pools(status='OPEN', project_id='1') ... - If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator `has_more=True`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an + indicator `has_more=True`. """ sort = None if sort is None else structure(sort, search_requests.PoolSortItems) response = self._search_request('get', '/v1/pools', request, sort, limit) @@ -1677,7 +1721,10 @@ def clone_training(self, training_id: str) -> Training: operation = self.clone_training_async(training_id) operation = self.wait_operation(operation) result = self.get_training(operation.details.training_id) - logger.info(f'A new training with ID "{result.id}" has been cloned. Link to open in web interface: {self.url}/requester/project/{result.project_id}/training/{result.id}') + logger.info( + f'A new training with ID "{result.id}" has been cloned. Link to open in web interface: ' + f'{self.url}/requester/project/{result.project_id}/training/{result.id}' + ) return result @add_headers('client') @@ -1733,7 +1780,10 @@ def create_training(self, training: Training) -> Training: """ response = self._request('post', '/v1/trainings', json=unstructure(training)) result = structure(response, Training) - logger.info(f'A new training with ID "{result.id}" has been created. Link to open in web interface: {self.url}/requester/project/{result.project_id}/training/{result.id}') + logger.info( + f'A new training with ID "{result.id}" has been created. Link to open in web interface: ' + f'{self.url}/requester/project/{result.project_id}/training/{result.id}' + ) return result @expand('request') @@ -1908,7 +1958,7 @@ def create_skill(self, skill: Skill) -> Skill: >>> name='Area selection of road signs', >>> public_requester_description={ >>> 'EN': 'Performer is annotating road signs', - >>> 'FR': 'L'exécuteur marque les signaux routier', + >>> 'FR': "L'exécuteur marque les signaux routier", >>> }, >>> ) >>> print(new_skill.id) @@ -1916,7 +1966,10 @@ def create_skill(self, skill: Skill) -> Skill: """ response = self._request('post', '/v1/skills', json=unstructure(skill)) result = structure(response, Skill) - logger.info(f'A new skill with ID "{result.id}" has been created. Link to open in web interface: {self.url}/requester/quality/skill/{result.id}') + logger.info( + f'A new skill with ID "{result.id}" has been created. Link to open in web interface: ' + f'{self.url}/requester/quality/skill/{result.id}' + ) return result @expand('request') @@ -1946,7 +1999,8 @@ def find_skills(self, request: search_requests.SkillSearchRequest, >>> toloka_client.find_skills(sort=['-created', '-id'], limit=10) ... - If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator `has_more=True`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator + `has_more=True`. """ sort = None if sort is None else structure(sort, search_requests.SkillSortItems) response = self._search_request('get', '/v1/skills', request, sort, limit) @@ -2049,23 +2103,24 @@ def get_analytics(self, stats: List[AnalyticsRequest]) -> operations.Operation: @expand('parameters') @add_headers('client') def create_task(self, task: Task, parameters: Optional[task.CreateTaskParameters] = None) -> Task: - """Creates a new task + """Creates a new task in Toloka. - It's better to use "create_tasks", if you need to insert several tasks. You can send a maximum of 100,000 requests of this kind per minute and a maximum of 2,000,000 requests per day. + To create several tasks at once use [create_tasks](./toloka.client.TolokaClient.create_tasks.md). Args: - task: Task that need to be created. + task: Task to be created. parameters: Parameters for Task creation controlling. Defaults to None. Allows you to use default overlap and start pool after task creation. Returns: - Task: Created task. + Task: The created task. Example: >>> task = toloka.task.Task( - >>> input_values={'image': 'https://tlk.s3.yandex.net/dataset/cats_vs_dogs/dogs/048e5760fc5a46faa434922b2447a527.jpg'}, - >>> pool_id='1') + >>> input_values={'image': 'https://tlk.s3.yandex.net/dataset/cats_vs_dogs/dogs/048e5760fc5a46faa434922b2447a527.jpg'}, + >>> pool_id='1' + >>> ) >>> toloka_client.create_task(task=task, allow_defaults=True) ... """ @@ -2074,30 +2129,33 @@ def create_task(self, task: Task, parameters: Optional[task.CreateTaskParameters @expand('parameters') @add_headers('client') - def create_tasks(self, tasks: List[Task], parameters: Optional[task.CreateTasksParameters] = None) -> batch_create_results.TaskBatchCreateResult: - """Creates many tasks in pools + def create_tasks( + self, + tasks: List[Task], parameters: Optional[task.CreateTasksParameters] = None + ) -> batch_create_results.TaskBatchCreateResult: + """Creates several tasks in Toloka using a single request. - By default uses asynchronous operation inside. It's better not to set "async_mode=False", if you not understand - clearly why you need it. - Tasks can be from different pools. You can insert both regular tasks and golden-tasks. + Tasks can be added to different pools. You can add together regular tasks and control tasks. You can send a maximum of 100,000 requests of this kind per minute and a maximum of 2,000,000 requests per day. - Recomended maximum of 10,000 task per request if async_mode is True. + + By default, `create_tasks` starts asynchronous operation internally and waits for the completion of it. Do not + change `async_mode` to False, if you do not understand clearly why you need it. Args: - tasks: List of tasks, that will be created. + tasks: List of tasks to be created. parameters: Parameters for Tasks creation controlling. Defaults to None, in which case the asynchronous operations is used. Returns: - batch_create_results.TaskBatchCreateResult: Result of tasks creating. Contains created tasks in `items` and - problems in "validation_errors". + batch_create_results.TaskBatchCreateResult: An object with created tasks in `items` and invalid tasks in + `validation_errors`. Raises: ValidationApiError: If no tasks were created, or skip_invalid_items==False and there is a problem when checking any task. Example: - How to create regular tasks from tsv. + The first example shows how to create regular tasks using a TSV file. >>> dataset = pandas.read_csv('dataset.tsv', sep='\t') >>> tasks = [ @@ -2108,7 +2166,7 @@ def create_tasks(self, tasks: List[Task], parameters: Optional[task.CreateTasksP >>> print(len(created_result.items)) ... - How to create golden-tasks. + The second example shows how to create control tasks. >>> dataset = pd.read_csv('dateset.tsv', sep=';') >>> golden_tasks = [] @@ -2138,18 +2196,18 @@ def create_tasks(self, tasks: List[Task], parameters: Optional[task.CreateTasksP @expand('parameters') @add_headers('client') - def create_tasks_async(self, tasks: List[Task], parameters: Optional[task.CreateTasksParameters] = None) -> operations.TasksCreateOperation: - """Creates many tasks in pools, asynchronous version + def create_tasks_async(self, tasks: List[Task], + parameters: Optional[task.CreateTasksParameters] = None) -> operations.TasksCreateOperation: + """Creates tasks in Toloka asynchronously. You can send a maximum of 100,000 requests of this kind per minute and a maximum of 2,000,000 requests per day. - Recomended maximum of 10,000 task per request if async_mode is True. Args: - tasks: List of tasks, that will be created. + tasks: List of tasks to be created. parameters: Parameters for Tasks creation controlling. Defaults to None. Returns: - TasksCreateOperation: An operation upon completion of which you can get the created tasks. + TasksCreateOperation: An object to track the progress of the operation. Example: >>> training_tasks = [ @@ -2173,29 +2231,24 @@ def create_tasks_async(self, tasks: List[Task], parameters: Optional[task.Create def find_tasks(self, request: search_requests.TaskSearchRequest, sort: Union[List[str], search_requests.TaskSortItems, None] = None, limit: Optional[int] = None) -> search_results.TaskSearchResult: - """Finds all tasks that match certain rules + """Finds tasks that match certain criteria. - As a result, it returns an object that contains the first part of the found tasks and whether there - are any more results. - It is better to use the "get_tasks" method, they allow to iterate trought all results - and not just the first output. + The number of returned tasks is limited. `find_tasks` additionally returns a flag showing whether there are more matching tasks. + Consider using [get_tasks](./toloka.client.TolokaClient.get_tasks.md) to iterate over all matching tasks. Args: request: How to search tasks. - sort: How to sort result. Defaults to None. - limit: Limit on the number of results returned. The maximum is 100 000. - Defaults to None, in which case it returns first 50 results. + sort: Sorting options. Default value: `None`. + limit: Returned tasks limit. The maximum value is 100,000. Default value: 50. Returns: - TaskSearchResult: The first `limit` tasks in `items`. And a mark that there is more. + TaskSearchResult: Found tasks and a flag showing whether there are more matching tasks. Example: - Find three most recently created tasks in a specified pool. + To find three most recently created tasks in a pool, call the method with the following parameters: >>> toloka_client.find_tasks(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`. """ sort = None if sort is None else structure(sort, search_requests.TaskSortItems) response = self._search_request('get', '/v1/tasks', request, sort, limit) @@ -2203,13 +2256,13 @@ def find_tasks(self, request: search_requests.TaskSearchRequest, @add_headers('client') def get_task(self, task_id: str) -> Task: - """Reads one specific task + """Gets a task with specified ID from Toloka. Args: - task_id: ID of the task. + task_id: The ID of the task. Returns: - Task: The task. + Task: The task with the ID specified in the request. Example: >>> toloka_client.get_task(task_id='1') @@ -2221,19 +2274,21 @@ def get_task(self, task_id: str) -> Task: @expand('request') @add_headers('client') def get_tasks(self, request: search_requests.TaskSearchRequest) -> Generator[Task, None, None]: - """Finds all tasks that match certain rules and returns them in an iterable object + """Finds all tasks that match certain criteria. - Unlike find_tasks, returns generator. Does not sort tasks. - While iterating over the result, several requests to the Toloka server is possible. + `get_tasks` returns a generator and you can iterate over all found tasks. Several requests to the Toloka server + are possible while iterating. + + Note that tasks can not be sorted. If you need to sort tasks use [find_tasks](toloka.client.TolokaClient.find_tasks.md). Args: request: How to search tasks. Yields: - Task: The next object corresponding to the request parameters. + Task: An iterable with found tasks. Example: - Get tasks from a specific pool. + Getting all tasks from a single pool. >>> results_list = [task for task in toloka_client.get_tasks(pool_id='1')] ... @@ -2245,14 +2300,14 @@ def get_tasks(self, request: search_requests.TaskSearchRequest) -> Generator[Tas @expand('patch') @add_headers('client') def patch_task(self, task_id: str, patch: task.TaskPatch) -> Task: - """Changes the task overlap + """Changes a task overlap value. Args: - task_id: ID of the task that will be changed. + task_id: The ID of the task. patch: New overlap value. Returns: - Task: Task with updated fields. + Task: The task with updated fields. """ response = self._request('patch', f'/v1/tasks/{task_id}', json=unstructure(patch)) return structure(response, Task) @@ -2260,22 +2315,26 @@ def patch_task(self, task_id: str, patch: task.TaskPatch) -> Task: @expand('patch') @add_headers('client') def patch_task_overlap_or_min(self, task_id: str, patch: task.TaskOverlapPatch) -> Task: - """Stops issuing the task + """Stops assigning a task to users. Args: - task_id: ID of the task. + task_id: The ID of the task. patch: New overlap value. Returns: - Task: Task with updated fields. + Task: The task with updated fields. Example: - Set an infinite overlap for a specific task in training. + Setting an infinite overlap for a training task. >>> toloka_client.patch_task_overlap_or_min(task_id='1', infinite_overlap=True) ... - **Note**: you can't set infinite overlap in a regular pool. + {% note info %} + + You can't set infinite overlap in a regular pool. + + {% endnote %} """ response = self._request('patch', f'/v1/tasks/{task_id}/set-overlap-or-min', json=unstructure(patch)) return structure(response, Task) @@ -2284,7 +2343,10 @@ def patch_task_overlap_or_min(self, task_id: str, patch: task.TaskOverlapPatch) @expand('parameters') @add_headers('client') - def create_task_suite(self, task_suite: TaskSuite, parameters: Optional[task_suite.TaskSuiteCreateRequestParameters] = None) -> TaskSuite: + def create_task_suite( + self, + task_suite: TaskSuite, parameters: Optional[task_suite.TaskSuiteCreateRequestParameters] = None + ) -> TaskSuite: """Creates a new task suite Generally, you don't need to create a task set yourself, because you can create tasks and Toloka will create @@ -2314,7 +2376,10 @@ def create_task_suite(self, task_suite: TaskSuite, parameters: Optional[task_sui @expand('parameters') @add_headers('client') - def create_task_suites(self, task_suites: List[TaskSuite], parameters: Optional[task_suite.TaskSuiteCreateRequestParameters] = None) -> batch_create_results.TaskSuiteBatchCreateResult: + def create_task_suites( + self, + task_suites: List[TaskSuite], parameters: Optional[task_suite.TaskSuiteCreateRequestParameters] = None + ) -> batch_create_results.TaskSuiteBatchCreateResult: """Creates many task suites in pools Generally, you don't need to create a task set yourself, because you can create tasks and Toloka will create @@ -2369,8 +2434,10 @@ def create_task_suites(self, task_suites: List[TaskSuite], parameters: Optional[ @expand('parameters') @add_headers('client') - def create_task_suites_async(self, task_suites: List[TaskSuite], - parameters: Optional[task_suite.TaskSuiteCreateRequestParameters] = None) -> operations.TaskSuiteCreateBatchOperation: + def create_task_suites_async( + self, + task_suites: List[TaskSuite], parameters: Optional[task_suite.TaskSuiteCreateRequestParameters] = None + ) -> operations.TaskSuiteCreateBatchOperation: """Creates many task suites in pools, asynchronous version You can send a maximum of 100,000 requests of this kind per minute and 2,000,000 requests per day. @@ -2406,9 +2473,10 @@ def create_task_suites_async(self, task_suites: List[TaskSuite], @expand('request') @add_headers('client') - def find_task_suites(self, request: search_requests.TaskSuiteSearchRequest, - sort: Union[List[str], search_requests.TaskSuiteSortItems, None] = None, - limit: Optional[int] = None) -> search_results.TaskSuiteSearchResult: + def find_task_suites( + self, request: search_requests.TaskSuiteSearchRequest, + sort: Union[List[str], search_requests.TaskSuiteSortItems, None] = None, limit: Optional[int] = None + ) -> search_results.TaskSuiteSearchResult: """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 @@ -2431,7 +2499,8 @@ def find_task_suites(self, request: search_requests.TaskSuiteSearchRequest, >>> 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`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator + `has_more=True`. """ sort = None if sort is None else structure(sort, search_requests.TaskSuiteSortItems) response = self._search_request('get', '/v1/task-suites', request, sort, limit) @@ -2545,7 +2614,10 @@ def get_operation(self, operation_id: str) -> operations.Operation: return structure(response, operations.Operation) @add_headers('client') - def wait_operation(self, op: operations.Operation, timeout: datetime.timedelta = datetime.timedelta(minutes=10)) -> operations.Operation: + def wait_operation( + self, + op: operations.Operation, timeout: datetime.timedelta = datetime.timedelta(minutes=10) + ) -> operations.Operation: """Waits for the operation to complete, and return it Args: @@ -2581,7 +2653,7 @@ def wait_operation(self, op: operations.Operation, timeout: datetime.timedelta = if op.is_completed(): return op - utcnow = datetime.datetime.utcnow() + utcnow = datetime.datetime.now(datetime.timezone.utc) wait_until_time = utcnow + timeout if not op.started or utcnow - op.started < default_initial_delay: @@ -2592,7 +2664,7 @@ def wait_operation(self, op: operations.Operation, timeout: datetime.timedelta = if op.is_completed(): return op time.sleep(default_time_to_wait.total_seconds()) - if datetime.datetime.utcnow() > wait_until_time: + if datetime.datetime.now(datetime.timezone.utc) > wait_until_time: raise TimeoutError @add_headers('client') @@ -2620,7 +2692,10 @@ def get_operation_log(self, operation_id: str) -> List[OperationLogItem]: @expand('parameters') @add_headers('client') - def create_user_bonus(self, user_bonus: UserBonus, parameters: Optional[UserBonusCreateRequestParameters] = None) -> UserBonus: + def create_user_bonus( + self, + user_bonus: UserBonus, parameters: Optional[UserBonusCreateRequestParameters] = None + ) -> UserBonus: """Issues payments directly to the performer You can send a maximum of 10,000 requests of this kind per day. @@ -2661,7 +2736,10 @@ def create_user_bonus(self, user_bonus: UserBonus, parameters: Optional[UserBonu @expand('parameters') @add_headers('client') - def create_user_bonuses(self, user_bonuses: List[UserBonus], parameters: Optional[UserBonusCreateRequestParameters] = None) -> batch_create_results.UserBonusBatchCreateResult: + def create_user_bonuses( + self, + user_bonuses: List[UserBonus], parameters: Optional[UserBonusCreateRequestParameters] = None + ) -> batch_create_results.UserBonusBatchCreateResult: """Creates many user bonuses Right now it's safer to use asynchronous version: "create_user_bonuses_async" @@ -2714,7 +2792,9 @@ def create_user_bonuses(self, user_bonuses: List[UserBonus], parameters: Optiona @expand('parameters') @add_headers('client') - def create_user_bonuses_async(self, user_bonuses: List[UserBonus], parameters: Optional[UserBonusCreateRequestParameters] = None) -> operations.UserBonusCreateBatchOperation: + def create_user_bonuses_async( + self, user_bonuses: List[UserBonus], parameters: Optional[UserBonusCreateRequestParameters] = None + ) -> operations.UserBonusCreateBatchOperation: """Issues payments directly to the performers, asynchronously creates many user bonuses You can send a maximum of 10,000 requests of this kind per day. @@ -2787,7 +2867,8 @@ def find_user_bonuses(self, request: search_requests.UserBonusSearchRequest, >>> toloka_client.find_user_bonuses(user_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`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator + `has_more=True`. """ sort = None if sort is None else structure(sort, search_requests.UserBonusSortItems) response = self._search_request('get', '/v1/user-bonuses', request, sort, limit) @@ -2884,7 +2965,10 @@ def get_user_restriction(self, user_restriction_id: str) -> UserRestriction: @expand('request') @add_headers('client') - def get_user_restrictions(self, request: search_requests.UserRestrictionSearchRequest) -> Generator[UserRestriction, None, None]: + def get_user_restrictions( + self, + request: search_requests.UserRestrictionSearchRequest + ) -> Generator[UserRestriction, None, None]: """Finds all user restrictions that match certain rules and returns them in an iterable object Unlike find_user_restrictions, returns generator. Does not sort user restrictions. @@ -2963,7 +3047,7 @@ def get_requester(self) -> Requester: >>> if requester.balance >= approx_pipeline_price: >>> print('You have enough money on your account!') >>> else: - >>> print('You haven\'t got enough money on your account!') + >>> print("You haven't got enough money on your account!") ... """ response = self._request('get', '/v1/requester') @@ -2997,7 +3081,8 @@ def find_user_skills(self, request: search_requests.UserSkillSearchRequest, >>> toloka_client.find_user_skills(limit=10) ... - If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator `has_more=True`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator + `has_more=True`. """ sort = None if sort is None else structure(sort, search_requests.UserSkillSortItems) response = self._search_request('get', '/v1/user-skills', request, sort, limit) @@ -3080,7 +3165,10 @@ def delete_user_skill(self, user_skill_id: str) -> None: self._raw_request('delete', f'/v1/user-skills/{user_skill_id}') @add_headers('client') - def upsert_webhook_subscriptions(self, subscriptions: List[WebhookSubscription]) -> batch_create_results.WebhookSubscriptionBatchCreateResult: + def upsert_webhook_subscriptions( + self, + subscriptions: List[WebhookSubscription] + ) -> batch_create_results.WebhookSubscriptionBatchCreateResult: """Creates (upsert) many webhook-subscriptions. Args: @@ -3155,7 +3243,10 @@ def find_webhook_subscriptions(self, request: search_requests.WebhookSubscriptio @expand('request') @add_headers('client') - def get_webhook_subscriptions(self, request: search_requests.WebhookSubscriptionSearchRequest) -> Generator[WebhookSubscription, None, None]: + def get_webhook_subscriptions( + self, + request: search_requests.WebhookSubscriptionSearchRequest + ) -> Generator[WebhookSubscription, None, None]: """Finds all webhook-subscriptions that match certain rules and returns them in an iterable object Unlike find_webhook-subscriptions, returns generator. Does not sort webhook-subscriptions. @@ -3346,9 +3437,11 @@ def unarchive_app_project(self, app_project_id: str) -> AppProject: @expand('request') @add_headers('client') - def find_apps(self, request: search_requests.AppSearchRequest, - sort: Union[List[str], search_requests.AppSortItems, None] = None, - limit: Optional[int] = None) -> search_results.AppSearchResult: + def find_apps( + self, + request: search_requests.AppSearchRequest, sort: Union[List[str], search_requests.AppSortItems, None] = None, + limit: Optional[int] = None + ) -> search_results.AppSearchResult: """Finds all Apps that match certain rules. As a result, it returns an object that contains the first part of the found Apps and whether there @@ -3413,10 +3506,11 @@ def get_app(self, app_id: str) -> App: @expand('request') @add_headers('client') - def find_app_items(self, app_project_id: str, - request: search_requests.AppItemSearchRequest, - sort: Union[List[str], search_requests.AppItemSortItems, None] = None, - limit: Optional[int] = None) -> search_results.AppItemSearchResult: + def find_app_items( + self, + app_project_id: str, request: search_requests.AppItemSearchRequest, + sort: Union[List[str], search_requests.AppItemSortItems, None] = None, limit: Optional[int] = None + ) -> search_results.AppItemSearchResult: """Finds all work items in the App project that match certain rules. As a result, it returns an object that contains the first part of the found work items in the App project @@ -3443,9 +3537,10 @@ def find_app_items(self, app_project_id: str, @expand('request') @add_headers('client') - def get_app_items(self, - app_project_id: str, - request: search_requests.AppItemSearchRequest) -> Generator[AppItem, None, None]: + def get_app_items( + self, + app_project_id: str, request: search_requests.AppItemSearchRequest + ) -> Generator[AppItem, None, None]: """Finds all work items in the App project that match certain rules and returns them in an iterable object. Unlike find_app_items, returns generator. Does not sort work items in the App project. diff --git a/src/client/__init__.pyi b/src/client/__init__.pyi index 373314a7..2b79215d 100644 --- a/src/client/__init__.pyi +++ b/src/client/__init__.pyi @@ -30,20 +30,34 @@ __all__ = [ 'user_restriction', 'user_skill', 'webhook_subscription', + 'structure', + 'unstructure', 'TolokaClient', + 'AggregatedSolution', + 'AnalyticsRequest', 'Assignment', + 'AssignmentPatch', + 'CloneResults', + 'GetAssignmentsTsvParameters', 'Attachment', 'Folder', 'MessageThread', 'MessageThreadReply', 'MessageThreadFolders', 'MessageThreadCompose', + 'OperationLogItem', + 'Requester', 'Skill', + 'SetUserSkillRequest', 'TaskSuite', 'Task', 'Training', 'UserBonus', + 'UserBonusCreateRequestParameters', + 'UserRestriction', + 'UserSkill', 'Pool', + 'PoolPatchRequest', 'Project', 'AppProject', 'App', @@ -117,6 +131,8 @@ from toloka.client import ( user_skill, webhook_subscription, ) +from toloka.client.aggregation import AggregatedSolution +from toloka.client.analytics_request import AnalyticsRequest from toloka.client.app import ( App, AppBatch, @@ -125,8 +141,13 @@ from toloka.client.app import ( AppItemsCreateRequest, AppProject, ) -from toloka.client.assignment import Assignment +from toloka.client.assignment import ( + Assignment, + AssignmentPatch, + GetAssignmentsTsvParameters, +) from toloka.client.attachment import Attachment +from toloka.client.clone_results import CloneResults from toloka.client.message_thread import ( Folder, MessageThread, @@ -134,13 +155,26 @@ from toloka.client.message_thread import ( MessageThreadFolders, MessageThreadReply, ) -from toloka.client.pool import Pool +from toloka.client.operation_log import OperationLogItem +from toloka.client.pool import ( + Pool, + PoolPatchRequest, +) from toloka.client.project import Project +from toloka.client.requester import Requester from toloka.client.skill import Skill from toloka.client.task import Task from toloka.client.task_suite import TaskSuite from toloka.client.training import Training -from toloka.client.user_bonus import UserBonus +from toloka.client.user_bonus import ( + UserBonus, + UserBonusCreateRequestParameters, +) +from toloka.client.user_restriction import UserRestriction +from toloka.client.user_skill import ( + SetUserSkillRequest, + UserSkill, +) class TolokaClient: @@ -197,7 +231,11 @@ class TolokaClient: >>> toloka_client = toloka.TolokaClient(your_oauth_token, 'PRODUCTION') # Or switch to 'SANDBOX' environment ... - **Note**: `toloka_client` instance will be used to pass all API calls later on. + {% note info %} + + `toloka_client` instance will be used to pass all API calls later on. + + {% endnote %} """ class Environment(enum.Enum): @@ -225,9 +263,13 @@ class TolokaClient: Responses to all completed tasks will be aggregated. The method only starts the aggregation and returns the operation for further tracking. - **Note**: In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), + {% note info %} + + In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), that have more aggregation methods and can perform on your computers. + {% endnote %} + Args: request: Parameters describing in which pool to aggregate solutions and by what rules. @@ -263,9 +305,13 @@ class TolokaClient: Responses to all completed tasks will be aggregated. The method only starts the aggregation and returns the operation for further tracking. - **Note**: In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), + {% note info %} + + In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), that have more aggregation methods and can perform on your computers. + {% endnote %} + Args: request: Parameters describing in which pool to aggregate solutions and by what rules. @@ -359,9 +405,13 @@ class TolokaClient: """Gets aggregated responses after the AggregatedSolutionOperation completes. It is better to use the "get_aggregated_solutions" method, that allows to iterate through all results. - **Note**: In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), + {% note info %} + + In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), that have more aggregation methods and can perform on your computers. + {% endnote %} + Args: operation_id: From what aggregation operation you want to get results. request: How to filter search results. @@ -404,9 +454,13 @@ class TolokaClient: """Gets aggregated responses after the AggregatedSolutionOperation completes. It is better to use the "get_aggregated_solutions" method, that allows to iterate through all results. - **Note**: In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), + {% note info %} + + In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), that have more aggregation methods and can perform on your computers. + {% endnote %} + Args: operation_id: From what aggregation operation you want to get results. request: How to filter search results. @@ -443,9 +497,13 @@ class TolokaClient: ) -> typing.Generator[toloka.client.aggregation.AggregatedSolution, None, None]: """Finds all aggregated responses after the AggregatedSolutionOperation completes - **Note**: In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), + {% note info %} + + In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), that have more aggregation methods and can perform on your computers. + {% endnote %} + Args: operation_id: From what aggregation operation you want to get results. request: How to filter search results. @@ -473,9 +531,13 @@ class TolokaClient: ) -> typing.Generator[toloka.client.aggregation.AggregatedSolution, None, None]: """Finds all aggregated responses after the AggregatedSolutionOperation completes - **Note**: In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), + {% note info %} + + In all aggregation purposes we are strongly recommending using our [crowd-kit library](https://github.com/Toloka/crowd-kit), that have more aggregation methods and can perform on your computers. + {% endnote %} + Args: operation_id: From what aggregation operation you want to get results. request: How to filter search results. @@ -995,10 +1057,10 @@ class TolokaClient: Example: If you want to thank Toloka performers who have tried to complete your tasks, send them a nice message. - >>> message_text = 'Amazing job! We've just trained our first model with the data YOU prepared for us. Thank you!' + >>> message_text = "Amazing job! We've just trained our first model with the data YOU prepared for us. Thank you!" >>> toloka_client.compose_message_thread( >>> recipients_select_type='ALL', - >>> topic={'EN':'Thank you, performer!'}, + >>> topic={'EN': 'Thank you, performer!'}, >>> text={'EN': message_text}, >>> answerable=False >>> ) @@ -1030,10 +1092,10 @@ class TolokaClient: Example: If you want to thank Toloka performers who have tried to complete your tasks, send them a nice message. - >>> message_text = 'Amazing job! We've just trained our first model with the data YOU prepared for us. Thank you!' + >>> message_text = "Amazing job! We've just trained our first model with the data YOU prepared for us. Thank you!" >>> toloka_client.compose_message_thread( >>> recipients_select_type='ALL', - >>> topic={'EN':'Thank you, performer!'}, + >>> topic={'EN': 'Thank you, performer!'}, >>> text={'EN': message_text}, >>> answerable=False >>> ) @@ -1649,7 +1711,7 @@ class TolokaClient: >>> project_id=existing_project_id, >>> private_name='Pool 1', >>> may_contain_adult_content=False, - >>> will_expire=datetime.datetime.utcnow() + datetime.timedelta(days=365), + >>> will_expire=datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(days=365), >>> reward_per_assignment=0.01, >>> assignment_max_duration_seconds=60*20, >>> defaults=toloka.pool.Pool.Defaults(default_overlap_for_new_task_suites=3), @@ -1703,7 +1765,8 @@ class TolokaClient: >>> toloka_client.find_pools(status='OPEN', project_id='1') ... - If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator `has_more=True`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an + indicator `has_more=True`. """ ... @@ -1760,7 +1823,8 @@ class TolokaClient: >>> toloka_client.find_pools(status='OPEN', project_id='1') ... - If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator `has_more=True`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an + indicator `has_more=True`. """ ... @@ -2344,7 +2408,7 @@ class TolokaClient: >>> name='Area selection of road signs', >>> public_requester_description={ >>> 'EN': 'Performer is annotating road signs', - >>> 'FR': 'L'exécuteur marque les signaux routier', + >>> 'FR': "L'exécuteur marque les signaux routier", >>> }, >>> ) >>> print(new_skill.id) @@ -2381,7 +2445,7 @@ class TolokaClient: >>> name='Area selection of road signs', >>> public_requester_description={ >>> 'EN': 'Performer is annotating road signs', - >>> 'FR': 'L'exécuteur marque les signaux routier', + >>> 'FR': "L'exécuteur marque les signaux routier", >>> }, >>> ) >>> print(new_skill.id) @@ -2418,7 +2482,8 @@ class TolokaClient: >>> toloka_client.find_skills(sort=['-created', '-id'], limit=10) ... - If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator `has_more=True`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator + `has_more=True`. """ ... @@ -2459,7 +2524,8 @@ class TolokaClient: >>> toloka_client.find_skills(sort=['-created', '-id'], limit=10) ... - If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator `has_more=True`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator + `has_more=True`. """ ... @@ -2590,23 +2656,24 @@ class TolokaClient: task: toloka.client.task.Task, parameters: typing.Optional[toloka.client.task.CreateTaskParameters] = None ) -> toloka.client.task.Task: - """Creates a new task + """Creates a new task in Toloka. - It's better to use "create_tasks", if you need to insert several tasks. You can send a maximum of 100,000 requests of this kind per minute and a maximum of 2,000,000 requests per day. + To create several tasks at once use [create_tasks](./toloka.client.TolokaClient.create_tasks.md). Args: - task: Task that need to be created. + task: Task to be created. parameters: Parameters for Task creation controlling. Defaults to None. Allows you to use default overlap and start pool after task creation. Returns: - Task: Created task. + Task: The created task. Example: >>> task = toloka.task.Task( - >>> input_values={'image': 'https://tlk.s3.yandex.net/dataset/cats_vs_dogs/dogs/048e5760fc5a46faa434922b2447a527.jpg'}, - >>> pool_id='1') + >>> input_values={'image': 'https://tlk.s3.yandex.net/dataset/cats_vs_dogs/dogs/048e5760fc5a46faa434922b2447a527.jpg'}, + >>> pool_id='1' + >>> ) >>> toloka_client.create_task(task=task, allow_defaults=True) ... """ @@ -2620,23 +2687,24 @@ class TolokaClient: allow_defaults: typing.Optional[bool] = None, open_pool: typing.Optional[bool] = None ) -> toloka.client.task.Task: - """Creates a new task + """Creates a new task in Toloka. - It's better to use "create_tasks", if you need to insert several tasks. You can send a maximum of 100,000 requests of this kind per minute and a maximum of 2,000,000 requests per day. + To create several tasks at once use [create_tasks](./toloka.client.TolokaClient.create_tasks.md). Args: - task: Task that need to be created. + task: Task to be created. parameters: Parameters for Task creation controlling. Defaults to None. Allows you to use default overlap and start pool after task creation. Returns: - Task: Created task. + Task: The created task. Example: >>> task = toloka.task.Task( - >>> input_values={'image': 'https://tlk.s3.yandex.net/dataset/cats_vs_dogs/dogs/048e5760fc5a46faa434922b2447a527.jpg'}, - >>> pool_id='1') + >>> input_values={'image': 'https://tlk.s3.yandex.net/dataset/cats_vs_dogs/dogs/048e5760fc5a46faa434922b2447a527.jpg'}, + >>> pool_id='1' + >>> ) >>> toloka_client.create_task(task=task, allow_defaults=True) ... """ @@ -2648,29 +2716,29 @@ class TolokaClient: tasks: typing.List[toloka.client.task.Task], parameters: typing.Optional[toloka.client.task.CreateTasksParameters] = None ) -> toloka.client.batch_create_results.TaskBatchCreateResult: - """Creates many tasks in pools + """Creates several tasks in Toloka using a single request. - By default uses asynchronous operation inside. It's better not to set "async_mode=False", if you not understand - clearly why you need it. - Tasks can be from different pools. You can insert both regular tasks and golden-tasks. + Tasks can be added to different pools. You can add together regular tasks and control tasks. You can send a maximum of 100,000 requests of this kind per minute and a maximum of 2,000,000 requests per day. - Recomended maximum of 10,000 task per request if async_mode is True. + + By default, `create_tasks` starts asynchronous operation internally and waits for the completion of it. Do not + change `async_mode` to False, if you do not understand clearly why you need it. Args: - tasks: List of tasks, that will be created. + tasks: List of tasks to be created. parameters: Parameters for Tasks creation controlling. Defaults to None, in which case the asynchronous operations is used. Returns: - batch_create_results.TaskBatchCreateResult: Result of tasks creating. Contains created tasks in `items` and - problems in "validation_errors". + batch_create_results.TaskBatchCreateResult: An object with created tasks in `items` and invalid tasks in + `validation_errors`. Raises: ValidationApiError: If no tasks were created, or skip_invalid_items==False and there is a problem when checking any task. Example: - How to create regular tasks from tsv. + The first example shows how to create regular tasks using a TSV file. >>> dataset = pandas.read_csv('dataset.tsv', sep=' ') >>> tasks = [ @@ -2681,7 +2749,7 @@ class TolokaClient: >>> print(len(created_result.items)) ... - How to create golden-tasks. + The second example shows how to create control tasks. >>> dataset = pd.read_csv('dateset.tsv', sep=';') >>> golden_tasks = [] @@ -2710,29 +2778,29 @@ class TolokaClient: operation_id: typing.Optional[uuid.UUID] = None, async_mode: typing.Optional[bool] = True ) -> toloka.client.batch_create_results.TaskBatchCreateResult: - """Creates many tasks in pools + """Creates several tasks in Toloka using a single request. - By default uses asynchronous operation inside. It's better not to set "async_mode=False", if you not understand - clearly why you need it. - Tasks can be from different pools. You can insert both regular tasks and golden-tasks. + Tasks can be added to different pools. You can add together regular tasks and control tasks. You can send a maximum of 100,000 requests of this kind per minute and a maximum of 2,000,000 requests per day. - Recomended maximum of 10,000 task per request if async_mode is True. + + By default, `create_tasks` starts asynchronous operation internally and waits for the completion of it. Do not + change `async_mode` to False, if you do not understand clearly why you need it. Args: - tasks: List of tasks, that will be created. + tasks: List of tasks to be created. parameters: Parameters for Tasks creation controlling. Defaults to None, in which case the asynchronous operations is used. Returns: - batch_create_results.TaskBatchCreateResult: Result of tasks creating. Contains created tasks in `items` and - problems in "validation_errors". + batch_create_results.TaskBatchCreateResult: An object with created tasks in `items` and invalid tasks in + `validation_errors`. Raises: ValidationApiError: If no tasks were created, or skip_invalid_items==False and there is a problem when checking any task. Example: - How to create regular tasks from tsv. + The first example shows how to create regular tasks using a TSV file. >>> dataset = pandas.read_csv('dataset.tsv', sep=' ') >>> tasks = [ @@ -2743,7 +2811,7 @@ class TolokaClient: >>> print(len(created_result.items)) ... - How to create golden-tasks. + The second example shows how to create control tasks. >>> dataset = pd.read_csv('dateset.tsv', sep=';') >>> golden_tasks = [] @@ -2767,17 +2835,16 @@ class TolokaClient: tasks: typing.List[toloka.client.task.Task], parameters: typing.Optional[toloka.client.task.CreateTasksParameters] = None ) -> toloka.client.operations.TasksCreateOperation: - """Creates many tasks in pools, asynchronous version + """Creates tasks in Toloka asynchronously. You can send a maximum of 100,000 requests of this kind per minute and a maximum of 2,000,000 requests per day. - Recomended maximum of 10,000 task per request if async_mode is True. Args: - tasks: List of tasks, that will be created. + tasks: List of tasks to be created. parameters: Parameters for Tasks creation controlling. Defaults to None. Returns: - TasksCreateOperation: An operation upon completion of which you can get the created tasks. + TasksCreateOperation: An object to track the progress of the operation. Example: >>> training_tasks = [ @@ -2805,17 +2872,16 @@ class TolokaClient: operation_id: typing.Optional[uuid.UUID] = None, async_mode: typing.Optional[bool] = True ) -> toloka.client.operations.TasksCreateOperation: - """Creates many tasks in pools, asynchronous version + """Creates tasks in Toloka asynchronously. You can send a maximum of 100,000 requests of this kind per minute and a maximum of 2,000,000 requests per day. - Recomended maximum of 10,000 task per request if async_mode is True. Args: - tasks: List of tasks, that will be created. + tasks: List of tasks to be created. parameters: Parameters for Tasks creation controlling. Defaults to None. Returns: - TasksCreateOperation: An operation upon completion of which you can get the created tasks. + TasksCreateOperation: An object to track the progress of the operation. Example: >>> training_tasks = [ @@ -2839,29 +2905,24 @@ class TolokaClient: sort: typing.Union[typing.List[str], toloka.client.search_requests.TaskSortItems, None] = None, limit: typing.Optional[int] = None ) -> toloka.client.search_results.TaskSearchResult: - """Finds all tasks that match certain rules + """Finds tasks that match certain criteria. - As a result, it returns an object that contains the first part of the found tasks and whether there - are any more results. - It is better to use the "get_tasks" method, they allow to iterate trought all results - and not just the first output. + The number of returned tasks is limited. `find_tasks` additionally returns a flag showing whether there are more matching tasks. + Consider using [get_tasks](./toloka.client.TolokaClient.get_tasks.md) to iterate over all matching tasks. Args: request: How to search tasks. - sort: How to sort result. Defaults to None. - limit: Limit on the number of results returned. The maximum is 100 000. - Defaults to None, in which case it returns first 50 results. + sort: Sorting options. Default value: `None`. + limit: Returned tasks limit. The maximum value is 100,000. Default value: 50. Returns: - TaskSearchResult: The first `limit` tasks in `items`. And a mark that there is more. + TaskSearchResult: Found tasks and a flag showing whether there are more matching tasks. Example: - Find three most recently created tasks in a specified pool. + To find three most recently created tasks in a pool, call the method with the following parameters: >>> toloka_client.find_tasks(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`. """ ... @@ -2885,40 +2946,35 @@ class TolokaClient: sort: typing.Union[typing.List[str], toloka.client.search_requests.TaskSortItems, None] = None, limit: typing.Optional[int] = None ) -> toloka.client.search_results.TaskSearchResult: - """Finds all tasks that match certain rules + """Finds tasks that match certain criteria. - As a result, it returns an object that contains the first part of the found tasks and whether there - are any more results. - It is better to use the "get_tasks" method, they allow to iterate trought all results - and not just the first output. + The number of returned tasks is limited. `find_tasks` additionally returns a flag showing whether there are more matching tasks. + Consider using [get_tasks](./toloka.client.TolokaClient.get_tasks.md) to iterate over all matching tasks. Args: request: How to search tasks. - sort: How to sort result. Defaults to None. - limit: Limit on the number of results returned. The maximum is 100 000. - Defaults to None, in which case it returns first 50 results. + sort: Sorting options. Default value: `None`. + limit: Returned tasks limit. The maximum value is 100,000. Default value: 50. Returns: - TaskSearchResult: The first `limit` tasks in `items`. And a mark that there is more. + TaskSearchResult: Found tasks and a flag showing whether there are more matching tasks. Example: - Find three most recently created tasks in a specified pool. + To find three most recently created tasks in a pool, call the method with the following parameters: >>> toloka_client.find_tasks(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`. """ ... def get_task(self, task_id: str) -> toloka.client.task.Task: - """Reads one specific task + """Gets a task with specified ID from Toloka. Args: - task_id: ID of the task. + task_id: The ID of the task. Returns: - Task: The task. + Task: The task with the ID specified in the request. Example: >>> toloka_client.get_task(task_id='1') @@ -2928,19 +2984,21 @@ class TolokaClient: @typing.overload def get_tasks(self, request: toloka.client.search_requests.TaskSearchRequest) -> typing.Generator[toloka.client.task.Task, None, None]: - """Finds all tasks that match certain rules and returns them in an iterable object + """Finds all tasks that match certain criteria. - Unlike find_tasks, returns generator. Does not sort tasks. - While iterating over the result, several requests to the Toloka server is possible. + `get_tasks` returns a generator and you can iterate over all found tasks. Several requests to the Toloka server + are possible while iterating. + + Note that tasks can not be sorted. If you need to sort tasks use [find_tasks](toloka.client.TolokaClient.find_tasks.md). Args: request: How to search tasks. Yields: - Task: The next object corresponding to the request parameters. + Task: An iterable with found tasks. Example: - Get tasks from a specific pool. + Getting all tasks from a single pool. >>> results_list = [task for task in toloka_client.get_tasks(pool_id='1')] ... @@ -2965,19 +3023,21 @@ class TolokaClient: overlap_gt: typing.Optional[int] = None, overlap_gte: typing.Optional[int] = None ) -> typing.Generator[toloka.client.task.Task, None, None]: - """Finds all tasks that match certain rules and returns them in an iterable object + """Finds all tasks that match certain criteria. - Unlike find_tasks, returns generator. Does not sort tasks. - While iterating over the result, several requests to the Toloka server is possible. + `get_tasks` returns a generator and you can iterate over all found tasks. Several requests to the Toloka server + are possible while iterating. + + Note that tasks can not be sorted. If you need to sort tasks use [find_tasks](toloka.client.TolokaClient.find_tasks.md). Args: request: How to search tasks. Yields: - Task: The next object corresponding to the request parameters. + Task: An iterable with found tasks. Example: - Get tasks from a specific pool. + Getting all tasks from a single pool. >>> results_list = [task for task in toloka_client.get_tasks(pool_id='1')] ... @@ -2990,14 +3050,14 @@ class TolokaClient: task_id: str, patch: toloka.client.task.TaskPatch ) -> toloka.client.task.Task: - """Changes the task overlap + """Changes a task overlap value. Args: - task_id: ID of the task that will be changed. + task_id: The ID of the task. patch: New overlap value. Returns: - Task: Task with updated fields. + Task: The task with updated fields. """ ... @@ -3010,14 +3070,14 @@ class TolokaClient: infinite_overlap: typing.Optional[bool] = None, baseline_solutions: typing.Optional[typing.List[toloka.client.task.Task.BaselineSolution]] = None ) -> toloka.client.task.Task: - """Changes the task overlap + """Changes a task overlap value. Args: - task_id: ID of the task that will be changed. + task_id: The ID of the task. patch: New overlap value. Returns: - Task: Task with updated fields. + Task: The task with updated fields. """ ... @@ -3027,22 +3087,26 @@ class TolokaClient: task_id: str, patch: toloka.client.task.TaskOverlapPatch ) -> toloka.client.task.Task: - """Stops issuing the task + """Stops assigning a task to users. Args: - task_id: ID of the task. + task_id: The ID of the task. patch: New overlap value. Returns: - Task: Task with updated fields. + Task: The task with updated fields. Example: - Set an infinite overlap for a specific task in training. + Setting an infinite overlap for a training task. >>> toloka_client.patch_task_overlap_or_min(task_id='1', infinite_overlap=True) ... - **Note**: you can't set infinite overlap in a regular pool. + {% note info %} + + You can't set infinite overlap in a regular pool. + + {% endnote %} """ ... @@ -3054,22 +3118,26 @@ class TolokaClient: overlap: typing.Optional[int] = None, infinite_overlap: typing.Optional[bool] = None ) -> toloka.client.task.Task: - """Stops issuing the task + """Stops assigning a task to users. Args: - task_id: ID of the task. + task_id: The ID of the task. patch: New overlap value. Returns: - Task: Task with updated fields. + Task: The task with updated fields. Example: - Set an infinite overlap for a specific task in training. + Setting an infinite overlap for a training task. >>> toloka_client.patch_task_overlap_or_min(task_id='1', infinite_overlap=True) ... - **Note**: you can't set infinite overlap in a regular pool. + {% note info %} + + You can't set infinite overlap in a regular pool. + + {% endnote %} """ ... @@ -3349,7 +3417,8 @@ class TolokaClient: >>> 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`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator + `has_more=True`. """ ... @@ -3396,7 +3465,8 @@ class TolokaClient: >>> 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`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator + `has_more=True`. """ ... @@ -3959,7 +4029,8 @@ class TolokaClient: >>> toloka_client.find_user_bonuses(user_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`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator + `has_more=True`. """ ... @@ -3999,7 +4070,8 @@ class TolokaClient: >>> toloka_client.find_user_bonuses(user_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`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator + `has_more=True`. """ ... @@ -4261,7 +4333,7 @@ class TolokaClient: >>> if requester.balance >= approx_pipeline_price: >>> print('You have enough money on your account!') >>> else: - >>> print('You haven't got enough money on your account!') + >>> print("You haven't got enough money on your account!") ... """ ... @@ -4294,7 +4366,8 @@ class TolokaClient: >>> toloka_client.find_user_skills(limit=10) ... - If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator `has_more=True`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator + `has_more=True`. """ ... @@ -4339,7 +4412,8 @@ class TolokaClient: >>> toloka_client.find_user_skills(limit=10) ... - If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator `has_more=True`. + If method finds more objects than custom or system `limit` allows to operate, it will also show an indicator + `has_more=True`. """ ... diff --git a/src/client/_converter.py b/src/client/_converter.py index c97d6d18..9a59e3ee 100644 --- a/src/client/_converter.py +++ b/src/client/_converter.py @@ -40,16 +40,30 @@ def str_to_datetime(str_dt: str) -> datetime.datetime: def fill_miliseconds(miliseconds) -> str: return miliseconds.group().ljust(7 if len(miliseconds.group()) > 4 else 4, '0') - return datetime.datetime.fromisoformat(MS_IN_ISO_REGEX.sub(fill_miliseconds, str_dt)) + str_dt = MS_IN_ISO_REGEX.sub(fill_miliseconds, str_dt) + return ensure_timezone(datetime.datetime.fromisoformat(str_dt)) + + +def ensure_timezone(dt: datetime.datetime): + return dt.replace(tzinfo=datetime.timezone.utc) if dt.tzinfo is None else dt # Dates are represented as ISO 8601: YYYY-MM-DDThh:mm:ss[.sss] # and structured to datetime.datetime converter.register_structure_hook( datetime.datetime, - lambda data, type_: data if isinstance(data, datetime.datetime) else str_to_datetime(data) # type: ignore + lambda data, type_: ensure_timezone(data) if isinstance(data, datetime.datetime) else str_to_datetime(data) # type: ignore ) -converter.register_unstructure_hook(datetime.datetime, lambda data: data.isoformat()) # type: ignore + + +def datetime_to_naive_utc(dt: datetime.datetime): + # consider naive time as utc time + if dt.tzinfo is not None: + dt = dt.astimezone(datetime.timezone.utc) + return dt.replace(tzinfo=None) + + +converter.register_unstructure_hook(datetime.datetime, lambda data: datetime_to_naive_utc(data).isoformat()) # type: ignore converter.register_structure_hook( diff --git a/src/client/app/__init__.py b/src/client/app/__init__.py index 9b921382..4a08417d 100644 --- a/src/client/app/__init__.py +++ b/src/client/app/__init__.py @@ -144,7 +144,7 @@ class Status(ExtendableStrEnum): updated: datetime.datetime = attribute(readonly=True) status: Status = attribute(readonly=True, autocast=True) output_data: Dict[str, Any] = attribute(readonly=True) - errors: _AppError = attribute(readonly=True) + errors: List[_AppError] = attribute(readonly=True) created_at: datetime.datetime = attribute(readonly=True) started_at: datetime.datetime = attribute(readonly=True) finished_at: datetime.datetime = attribute(readonly=True) diff --git a/src/client/app/__init__.pyi b/src/client/app/__init__.pyi index a498e3a4..fa71aaaa 100644 --- a/src/client/app/__init__.pyi +++ b/src/client/app/__init__.pyi @@ -195,7 +195,7 @@ class AppItem(toloka.client.primitives.base.BaseTolokaObject): updated: typing.Optional[datetime.datetime] = None, status: typing.Union[Status, str, None] = None, output_data: typing.Optional[typing.Dict[str, typing.Any]] = None, - errors: typing.Optional[_AppError] = None, + errors: typing.Optional[typing.List[_AppError]] = None, created_at: typing.Optional[datetime.datetime] = None, started_at: typing.Optional[datetime.datetime] = None, finished_at: typing.Optional[datetime.datetime] = None @@ -213,7 +213,7 @@ class AppItem(toloka.client.primitives.base.BaseTolokaObject): updated: typing.Optional[datetime.datetime] status: typing.Optional[Status] output_data: typing.Optional[typing.Dict[str, typing.Any]] - errors: typing.Optional[_AppError] + errors: typing.Optional[typing.List[_AppError]] created_at: typing.Optional[datetime.datetime] started_at: typing.Optional[datetime.datetime] finished_at: typing.Optional[datetime.datetime] diff --git a/src/client/filter.py b/src/client/filter.py index 266c30ed..b2e4b984 100644 --- a/src/client/filter.py +++ b/src/client/filter.py @@ -29,7 +29,6 @@ 'UserAgentVersionMajor', 'UserAgentVersionMinor', 'UserAgentVersionBugfix', - 'Rating' ] import inspect from enum import unique @@ -192,7 +191,6 @@ class Key(ExtendableStrEnum): REGION_BY_PHONE = 'region_by_phone' REGION_BY_IP = 'region_by_ip' - RATING = 'rating' DEVICE_CATEGORY = 'device_category' OS_FAMILY = 'os_family' OS_VERSION = 'os_version' @@ -384,6 +382,10 @@ def __new__(cls, *args, **kwargs): raise ValueError('"Language not in" filter does not support verified=True argument') return super().__new__(cls, *args, **kwargs) + def __getnewargs__(self): + """Due to redefined __new__ method class can't be deepcopied or pickled without __getnewargs__ definition""" + return self.operator, self.value + # add fake parameter "verified: bool = False" to Languages.__init__ signature. This parameter will be consumed in # Languages.__new__ while the actual __init__ is managed by attrs. @@ -392,6 +394,7 @@ def __new__(cls, *args, **kwargs): languages_init_signature_parameters['verified'] = inspect.Parameter( name='verified', kind=inspect.Parameter.POSITIONAL_OR_KEYWORD, default=False, annotation=bool, ) +Languages.__init__.__annotations__['verified'] = bool Languages.__init__.__signature__ = languages_init_signature.replace(parameters=languages_init_signature_parameters.values()) @@ -650,14 +653,3 @@ class UserAgentVersionBugfix(Computed, ComparableConditionMixin, spec_value=Comp """ value: int - - -@inherit_docstrings -class Rating(Computed, ComparableConditionMixin, spec_value=Computed.Key.RATING): - """Use to select users by user rating. - - Attributes: - value: User rating. Calculated based on earnings in all projects available to the user. - """ - - value: float diff --git a/src/client/filter.pyi b/src/client/filter.pyi index 2fcba510..ad65832f 100644 --- a/src/client/filter.pyi +++ b/src/client/filter.pyi @@ -29,7 +29,6 @@ __all__ = [ 'UserAgentVersionMajor', 'UserAgentVersionMinor', 'UserAgentVersionBugfix', - 'Rating', ] import toloka.client.primitives.base import toloka.client.primitives.operators @@ -196,7 +195,6 @@ class Computed(Condition): CLIENT_TYPE = 'client_type' REGION_BY_PHONE = 'region_by_phone' REGION_BY_IP = 'region_by_ip' - RATING = 'rating' DEVICE_CATEGORY = 'device_category' OS_FAMILY = 'os_family' OS_VERSION = 'os_version' @@ -879,27 +877,3 @@ class UserAgentVersionBugfix(Computed, toloka.client.primitives.operators.Compar operator: toloka.client.primitives.operators.CompareOperator _unexpected: typing.Optional[typing.Dict[str, typing.Any]] value: typing.Optional[int] - - -class Rating(Computed, toloka.client.primitives.operators.ComparableConditionMixin): - """Use to select users by user rating. - - Attributes: - operator: Comparison operator in the condition. - For example, for a condition "The user must be 18 years old or older» used date of birth and operator - GTE («Greater than or equal»). Possible key values operator depends on the data type in the field value - value: User rating. Calculated based on earnings in all projects available to the user. - """ - - def __init__( - self, - operator: toloka.client.primitives.operators.CompareOperator, - value: typing.Optional[float] = None - ) -> None: - """Method generated by attrs for class Rating. - """ - ... - - operator: toloka.client.primitives.operators.CompareOperator - _unexpected: typing.Optional[typing.Dict[str, typing.Any]] - value: typing.Optional[float] diff --git a/src/client/pool/__init__.py b/src/client/pool/__init__.py index 76f4e5ad..9b1d4077 100644 --- a/src/client/pool/__init__.py +++ b/src/client/pool/__init__.py @@ -102,7 +102,7 @@ class Pool(BaseTolokaObject): >>> project_id=existing_project_id, >>> private_name='Pool 1', >>> may_contain_adult_content=False, - >>> will_expire=datetime.datetime.utcnow() + datetime.timedelta(days=365), + >>> will_expire=datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(days=365), >>> reward_per_assignment=0.01, >>> assignment_max_duration_seconds=60*20, >>> defaults=toloka.pool.Pool.Defaults(default_overlap_for_new_task_suites=3), diff --git a/src/client/pool/__init__.pyi b/src/client/pool/__init__.pyi index 07f25ce1..d6e9d0e4 100644 --- a/src/client/pool/__init__.pyi +++ b/src/client/pool/__init__.pyi @@ -100,7 +100,7 @@ class Pool(toloka.client.primitives.base.BaseTolokaObject): >>> project_id=existing_project_id, >>> private_name='Pool 1', >>> may_contain_adult_content=False, - >>> will_expire=datetime.datetime.utcnow() + datetime.timedelta(days=365), + >>> will_expire=datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(days=365), >>> reward_per_assignment=0.01, >>> assignment_max_duration_seconds=60*20, >>> defaults=toloka.pool.Pool.Defaults(default_overlap_for_new_task_suites=3), diff --git a/src/client/primitives/retry.py b/src/client/primitives/retry.py index 351b3d14..4803867a 100644 --- a/src/client/primitives/retry.py +++ b/src/client/primitives/retry.py @@ -12,6 +12,8 @@ logger = logging.getLogger(__name__) +STATUSES_TO_RETRY = {408, 429, 500, 503, 504} + class TolokaRetry(Retry): """Retry toloka quotas. By default only minutes quotas. diff --git a/src/client/project/template_builder/__init__.py b/src/client/project/template_builder/__init__.py index c21505bd..cdbe04dd 100644 --- a/src/client/project/template_builder/__init__.py +++ b/src/client/project/template_builder/__init__.py @@ -94,6 +94,7 @@ 'LinkViewV1', 'LinkGroupViewV1', 'ListViewV1', + 'MapViewV1', 'MarkdownViewV1', 'TextViewV1', 'VideoViewV1', @@ -208,6 +209,7 @@ LinkViewV1, LinkGroupViewV1, ListViewV1, + MapViewV1, MarkdownViewV1, TextViewV1, VideoViewV1, diff --git a/src/client/project/template_builder/__init__.pyi b/src/client/project/template_builder/__init__.pyi index 85b11a0d..7e72e782 100644 --- a/src/client/project/template_builder/__init__.pyi +++ b/src/client/project/template_builder/__init__.pyi @@ -92,6 +92,7 @@ __all__ = [ 'LinkViewV1', 'LinkGroupViewV1', 'ListViewV1', + 'MapViewV1', 'MarkdownViewV1', 'TextViewV1', 'VideoViewV1', @@ -209,6 +210,7 @@ from toloka.client.project.template_builder.view import ( LinkGroupViewV1, LinkViewV1, ListViewV1, + MapViewV1, MarkdownViewV1, TextViewV1, VideoViewV1, diff --git a/src/client/project/template_builder/base.py b/src/client/project/template_builder/base.py index 256abdfd..cdd59438 100644 --- a/src/client/project/template_builder/base.py +++ b/src/client/project/template_builder/base.py @@ -104,6 +104,7 @@ class ComponentType(ExtendableStrEnum): VIEW_LINK = 'view.link' VIEW_LINK_GROUP = 'view.link-group' VIEW_LIST = 'view.list' + VIEW_MAP = 'view.map' VIEW_MARKDOWN = 'view.markdown' VIEW_TEXT = 'view.text' VIEW_VIDEO = 'view.video' diff --git a/src/client/project/template_builder/base.pyi b/src/client/project/template_builder/base.pyi index 16752d58..f866a612 100644 --- a/src/client/project/template_builder/base.pyi +++ b/src/client/project/template_builder/base.pyi @@ -100,6 +100,7 @@ class ComponentType(toloka.util._extendable_enum.ExtendableStrEnum): VIEW_LINK = 'view.link' VIEW_LINK_GROUP = 'view.link-group' VIEW_LIST = 'view.list' + VIEW_MAP = 'view.map' VIEW_MARKDOWN = 'view.markdown' VIEW_TEXT = 'view.text' VIEW_VIDEO = 'view.video' diff --git a/src/client/project/template_builder/view.py b/src/client/project/template_builder/view.py index c7104549..92702a52 100644 --- a/src/client/project/template_builder/view.py +++ b/src/client/project/template_builder/view.py @@ -13,6 +13,7 @@ 'LinkViewV1', 'LinkGroupViewV1', 'ListViewV1', + 'MapViewV1', 'MarkdownViewV1', 'TextViewV1', 'VideoViewV1' @@ -424,3 +425,54 @@ class VideoViewV1(BaseViewV1, spec_value=ComponentType.VIEW_VIDEO): max_width: base_component_or(float) = attribute(origin='maxWidth', kw_only=True) min_width: base_component_or(float) = attribute(origin='minWidth', kw_only=True) ratio: base_component_or(List[base_component_or(float)], 'ListBaseComponentOrFloat') = attribute(kw_only=True) + + +@inherit_docstrings +class MapViewV1(BaseViewV1, spec_value=ComponentType.VIEW_MAP): + """Adds a map to your task. + + Use this component to set the targets for the tasks with the markers, select the areas with polygons. + Specify the position and colors for the elements on the map. + + You can set the following map properties: scale, position of the map center, label, and hint for the users. + Attributes: + center: Determines the position of the map center. Specify the coordinates in the string format, for example, + "29.748713,-95.404287", or use the data.location component to set the center of the map to the + Toloker's current position. + markers: Specifies the markers present on the map. + polygons: Specifies the polygonal objects that you can use to select areas on the map. + zoom: The map initial scale. Use the values from 0 to 19. Bigger values give a more detailed map view. + """ + + class Marker(BaseTemplate): + """Marker parameters. + + Attributes: + position: Determines the marker position. Specify the coordinates in the string format, for example, + "29.748713,-95.404287", or use the data.location component to set the marker to the Toloker's current + position. + color: Determines the marker color. Use the hexadecimal values preceded by the # sign to specify the color. + label: The label for the marker that tells Tolokers what this marker is for and helps distinguish it + from other markers. + """ + position: base_component_or(str) + color: base_component_or(str) = attribute(kw_only=True) + label: base_component_or(str) = attribute(kw_only=True) + + class Polygon(BaseTemplate): + """Polygon parameters. + + Attributes: + points: The list of the polygonal selection area points. + Specify the coordinates in the string format, for example, "29.748713,-95.404287". + color: Determines the polygonal selection area color. Use the hexadecimal values preceded by the # sign to + specify the color. + """ + points: base_component_or(List[base_component_or(str)], 'ListBaseComponentOrStr') + color: base_component_or(str) = attribute(kw_only=True) + + center: base_component_or(str) + markers: base_component_or(List[base_component_or(Marker)], 'ListBaseComponentOrMarker') = attribute(kw_only=True) + polygons: base_component_or(List[base_component_or(Polygon)], 'ListBaseComponentOrPolygon') = attribute( + kw_only=True) + zoom: base_component_or(int) = attribute(kw_only=True) diff --git a/src/client/project/template_builder/view.pyi b/src/client/project/template_builder/view.pyi index e4be732d..a163c272 100644 --- a/src/client/project/template_builder/view.pyi +++ b/src/client/project/template_builder/view.pyi @@ -13,6 +13,7 @@ __all__ = [ 'LinkViewV1', 'LinkGroupViewV1', 'ListViewV1', + 'MapViewV1', 'MarkdownViewV1', 'TextViewV1', 'VideoViewV1', @@ -791,3 +792,102 @@ class VideoViewV1(BaseViewV1): max_width: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, float]] min_width: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, float]] ratio: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, typing.List[typing.Union[toloka.client.project.template_builder.base.BaseComponent, float]]]] + + +class MapViewV1(BaseViewV1): + """Adds a map to your task. + + Use this component to set the targets for the tasks with the markers, select the areas with polygons. + Specify the position and colors for the elements on the map. + + You can set the following map properties: scale, position of the map center, label, and hint for the users. + + Attributes: + center: Determines the position of the map center. Specify the coordinates in the string format, for example, + "29.748713,-95.404287", or use the data.location component to set the center of the map to the + Toloker's current position. + markers: Specifies the markers present on the map. + polygons: Specifies the polygonal objects that you can use to select areas on the map. + zoom: The map initial scale. Use the values from 0 to 19. Bigger values give a more detailed map view. + hint: Hint text. + label: Label above the component. + validation: Validation based on condition. + """ + + class Marker(toloka.client.project.template_builder.base.BaseTemplate): + """Marker parameters. + + Attributes: + position: Determines the marker position. Specify the coordinates in the string format, for example, + "29.748713,-95.404287", or use the data.location component to set the marker to the Toloker's current + position. + color: Determines the marker color. Use the hexadecimal values preceded by the # sign to specify the color. + label: The label for the marker that tells Tolokers what this marker is for and helps distinguish it + from other markers. + """ + + def __init__( + self, + position: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, str]] = None, + *, + color: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, str]] = None, + label: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, str]] = None + ) -> None: + """Method generated by attrs for class MapViewV1.Marker. + """ + ... + + _unexpected: typing.Optional[typing.Dict[str, typing.Any]] + position: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, str]] + color: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, str]] + label: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, str]] + + class Polygon(toloka.client.project.template_builder.base.BaseTemplate): + """Polygon parameters. + + Attributes: + points: The list of the polygonal selection area points. + Specify the coordinates in the string format, for example, "29.748713,-95.404287". + color: Determines the polygonal selection area color. Use the hexadecimal values preceded by the # sign to + specify the color. + """ + + def __init__( + self, + points: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, typing.List[typing.Union[toloka.client.project.template_builder.base.BaseComponent, str]]]] = None, + *, + color: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, str]] = None + ) -> None: + """Method generated by attrs for class MapViewV1.Polygon. + """ + ... + + _unexpected: typing.Optional[typing.Dict[str, typing.Any]] + points: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, typing.List[typing.Union[toloka.client.project.template_builder.base.BaseComponent, str]]]] + color: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, str]] + + def __init__( + self, + center: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, str]] = None, + *, + markers: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, typing.List[typing.Union[toloka.client.project.template_builder.base.BaseComponent, Marker]]]] = None, + polygons: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, typing.List[typing.Union[toloka.client.project.template_builder.base.BaseComponent, Polygon]]]] = None, + zoom: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, int]] = None, + hint: typing.Optional[typing.Any] = None, + label: typing.Optional[typing.Any] = None, + validation: typing.Optional[toloka.client.project.template_builder.base.BaseComponent] = None, + version: typing.Optional[str] = '1.0.0' + ) -> None: + """Method generated by attrs for class MapViewV1. + """ + ... + + _unexpected: typing.Optional[typing.Dict[str, typing.Any]] + hint: typing.Optional[typing.Any] + label: typing.Optional[typing.Any] + validation: typing.Optional[toloka.client.project.template_builder.base.BaseComponent] + version: typing.Optional[str] + center: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, str]] + markers: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, typing.List[typing.Union[toloka.client.project.template_builder.base.BaseComponent, Marker]]]] + polygons: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, typing.List[typing.Union[toloka.client.project.template_builder.base.BaseComponent, Polygon]]]] + zoom: typing.Optional[typing.Union[toloka.client.project.template_builder.base.BaseComponent, int]] diff --git a/src/client/search_requests.py b/src/client/search_requests.py index 0ab7ac0d..2b449bf0 100644 --- a/src/client/search_requests.py +++ b/src/client/search_requests.py @@ -525,7 +525,7 @@ class TaskSearchRequest(BaseSearchRequest): """Parameters for searching tasks Attributes: - pool_id: ID of the pool to get tasks from. + pool_id: The ID of the pool to get tasks from. overlap: Tasks with an overlap equal to the specified value. id_lt: Tasks with an ID less than the specified value. id_lte: Tasks with an ID less than or equal to the specified value. @@ -536,9 +536,9 @@ class TaskSearchRequest(BaseSearchRequest): created_gt: Tasks created after the specified date. created_gte: Tasks created after or on the specified date. overlap_lt: Tasks with an overlap less than the specified value. - overlap_lte: Tasks with an overlap equal to the specified value. + overlap_lte: Tasks with an overlap less than or equal to the specified value. overlap_gt: Tasks with an overlap greater than the specified value. - overlap_gte: Tasks with an overlap equal to the specified value. + overlap_gte: Tasks with an overlap greater than or equal to the specified value. """ class CompareFields: diff --git a/src/client/search_requests.pyi b/src/client/search_requests.pyi index d7cd9a17..d3eb6ff3 100644 --- a/src/client/search_requests.pyi +++ b/src/client/search_requests.pyi @@ -832,7 +832,7 @@ class TaskSearchRequest(BaseSearchRequest): """Parameters for searching tasks Attributes: - pool_id: ID of the pool to get tasks from. + pool_id: The ID of the pool to get tasks from. overlap: Tasks with an overlap equal to the specified value. id_lt: Tasks with an ID less than the specified value. id_lte: Tasks with an ID less than or equal to the specified value. @@ -843,9 +843,9 @@ class TaskSearchRequest(BaseSearchRequest): created_gt: Tasks created after the specified date. created_gte: Tasks created after or on the specified date. overlap_lt: Tasks with an overlap less than the specified value. - overlap_lte: Tasks with an overlap equal to the specified value. + overlap_lte: Tasks with an overlap less than or equal to the specified value. overlap_gt: Tasks with an overlap greater than the specified value. - overlap_gte: Tasks with an overlap equal to the specified value. + overlap_gte: Tasks with an overlap greater than or equal to the specified value. """ class CompareFields: diff --git a/src/client/task.py b/src/client/task.py index 8266d2c5..626acfbf 100644 --- a/src/client/task.py +++ b/src/client/task.py @@ -116,9 +116,9 @@ class CreateTaskParameters(Parameters): Used when creating one Task. Attributes: - allow_defaults: Overlap settings: - * True - Use the overlap that is set in the pool parameters (in the defaults.default_overlap_for_new_task_suites key). - * False - Use the overlap that is set in the task suite parameters (in the overlap field). + allow_defaults: Overlap setting: + * True — Use the overlap value that is set in the `defaults.default_overlap_for_new_task_suites` pool parameter. + * False — Use the overlap value that is set in the `overlap` task suite parameter. open_pool: Open the pool immediately after creating a task suite, if the pool is closed. """ @@ -138,15 +138,12 @@ class CreateTasksParameters(CreateTaskParameters): Used when creating many Tasks. Attributes: - skip_invalid_items: Validation parameters: - * True — Create the tasks that passed validation. Skip the rest of the tasks (errors will - be listed in the response to the request). - * False — If at least one of the tasks didn't pass validation, stop the operation and don't create any tasks. - async_mode: How the request is processed: - * True — deferred. The query results in an asynchronous operation running in the background. - The response contains information about the operation (start and end time, status, number of sets). - * False — synchronous. The response contains information about the created tasks. - A maximum of 5000 tasks can be sent in a single request. + skip_invalid_items: Task validation option: + * True — All valid tasks are added. If a task does not pass validation, then it is not added to Toloka. All such tasks are listed in the response. + * False — If any task does not pass validation, then operation is cancelled and no tasks are added to Toloka. + async_mode: Request processing mode: + * True — Asynchronous operation is started internally and `create_tasks` waits for the completion of it. It is recommended to create no more than 10,000 tasks per request in this mode. + * False — The request is processed synchronously. A maximum of 5000 tasks can be added in a single request in this mode. """ skip_invalid_items: bool @@ -158,10 +155,10 @@ class TaskOverlapPatch(BaseTolokaObject): """Parameters for changing the overlap of a specific Task Attributes: - overlap: Overlapping a set of tasks. - infinite_overlap: Issue a task with infinite overlap. Used, for example, for sets of training tasks to give them to all users: - * True - Set infinite overlap. - * False - Leave the overlap specified for the task or pool. Default Behaviour. + overlap: Overlap value. + infinite_overlap: Infinite overlap: + * True — Assign the task to all users. It is useful for training tasks. + * False — Overlap value specified for the task or for the pool is used. Default value: False. """ overlap: int diff --git a/src/client/task.pyi b/src/client/task.pyi index 67c617f6..1247615c 100644 --- a/src/client/task.pyi +++ b/src/client/task.pyi @@ -186,9 +186,9 @@ class CreateTaskParameters(toloka.client.primitives.parameter.Parameters): Used when creating one Task. Attributes: - allow_defaults: Overlap settings: - * True - Use the overlap that is set in the pool parameters (in the defaults.default_overlap_for_new_task_suites key). - * False - Use the overlap that is set in the task suite parameters (in the overlap field). + allow_defaults: Overlap setting: + * True — Use the overlap value that is set in the `defaults.default_overlap_for_new_task_suites` pool parameter. + * False — Use the overlap value that is set in the `overlap` task suite parameter. open_pool: Open the pool immediately after creating a task suite, if the pool is closed. """ @@ -209,9 +209,9 @@ class CreateTaskParameters(toloka.client.primitives.parameter.Parameters): class CreateTaskAsyncParameters(CreateTaskParameters): """Attributes: - allow_defaults: Overlap settings: - * True - Use the overlap that is set in the pool parameters (in the defaults.default_overlap_for_new_task_suites key). - * False - Use the overlap that is set in the task suite parameters (in the overlap field). + allow_defaults: Overlap setting: + * True — Use the overlap value that is set in the `defaults.default_overlap_for_new_task_suites` pool parameter. + * False — Use the overlap value that is set in the `overlap` task suite parameter. open_pool: Open the pool immediately after creating a task suite, if the pool is closed. """ @@ -238,19 +238,16 @@ class CreateTasksParameters(CreateTaskParameters): Used when creating many Tasks. Attributes: - allow_defaults: Overlap settings: - * True - Use the overlap that is set in the pool parameters (in the defaults.default_overlap_for_new_task_suites key). - * False - Use the overlap that is set in the task suite parameters (in the overlap field). + allow_defaults: Overlap setting: + * True — Use the overlap value that is set in the `defaults.default_overlap_for_new_task_suites` pool parameter. + * False — Use the overlap value that is set in the `overlap` task suite parameter. open_pool: Open the pool immediately after creating a task suite, if the pool is closed. - skip_invalid_items: Validation parameters: - * True — Create the tasks that passed validation. Skip the rest of the tasks (errors will - be listed in the response to the request). - * False — If at least one of the tasks didn't pass validation, stop the operation and don't create any tasks. - async_mode: How the request is processed: - * True — deferred. The query results in an asynchronous operation running in the background. - The response contains information about the operation (start and end time, status, number of sets). - * False — synchronous. The response contains information about the created tasks. - A maximum of 5000 tasks can be sent in a single request. + skip_invalid_items: Task validation option: + * True — All valid tasks are added. If a task does not pass validation, then it is not added to Toloka. All such tasks are listed in the response. + * False — If any task does not pass validation, then operation is cancelled and no tasks are added to Toloka. + async_mode: Request processing mode: + * True — Asynchronous operation is started internally and `create_tasks` waits for the completion of it. It is recommended to create no more than 10,000 tasks per request in this mode. + * False — The request is processed synchronously. A maximum of 5000 tasks can be added in a single request in this mode. """ def __init__( @@ -278,10 +275,10 @@ class TaskOverlapPatch(toloka.client.primitives.base.BaseTolokaObject): """Parameters for changing the overlap of a specific Task Attributes: - overlap: Overlapping a set of tasks. - infinite_overlap: Issue a task with infinite overlap. Used, for example, for sets of training tasks to give them to all users: - * True - Set infinite overlap. - * False - Leave the overlap specified for the task or pool. Default Behaviour. + overlap: Overlap value. + infinite_overlap: Infinite overlap: + * True — Assign the task to all users. It is useful for training tasks. + * False — Overlap value specified for the task or for the pool is used. Default value: False. """ def __init__( @@ -303,10 +300,10 @@ class TaskPatch(TaskOverlapPatch): """Parameters for changing overlap or baseline_solutions of a specific Task Attributes: - overlap: Overlapping a set of tasks. - infinite_overlap: Issue a task with infinite overlap. Used, for example, for sets of training tasks to give them to all users: - * True - Set infinite overlap. - * False - Leave the overlap specified for the task or pool. Default Behaviour. + overlap: Overlap value. + infinite_overlap: Infinite overlap: + * True — Assign the task to all users. It is useful for training tasks. + * False — Overlap value specified for the task or for the pool is used. Default value: False. baseline_solutions: """ diff --git a/src/metrics/collector.py b/src/metrics/collector.py index 1aa7cb2f..316652b8 100644 --- a/src/metrics/collector.py +++ b/src/metrics/collector.py @@ -3,7 +3,6 @@ ] import asyncio -import datetime import logging from typing import Any, Callable, Dict, List, Tuple @@ -94,7 +93,7 @@ async def run(self): for name, points in done_task.result().items(): if name in metrics_points: logger.error(f'Duplicated metrics name detected: "{name}". Only one metric was returned.') - metrics_points[name] = [(dt.replace(tzinfo=datetime.timezone.utc), val) for dt, val in points] + metrics_points[name] = points if metrics_points: self._callback(metrics_points) diff --git a/src/metrics/jupyter_dashboard.py b/src/metrics/jupyter_dashboard.py index 7472c40d..72ccdd32 100644 --- a/src/metrics/jupyter_dashboard.py +++ b/src/metrics/jupyter_dashboard.py @@ -140,7 +140,7 @@ def create_figure(self) -> go.Figure: for x_points, y_points, line_name in self._lines.values(): figure.add_trace( go.Scatter( - x=x_points if x_points else [datetime.datetime.utcnow()], + x=x_points if x_points else [datetime.datetime.now(datetime.timezone.utc)], y=y_points if y_points else [0], name=line_name, mode='lines', @@ -300,7 +300,7 @@ def update_charts(self, n_intervals: int) -> Union[go.Figure, List[go.Figure]]: Must have the same length on each iteration. """ # Because many metrics easily take at least 1 second, for the simplest operations - now = datetime.datetime.utcnow() + now = datetime.datetime.now(datetime.timezone.utc) if self._time_from is None: self._time_from = now time_from = self._time_from diff --git a/src/metrics/metrics.py b/src/metrics/metrics.py index 1a533945..72c9ce5b 100644 --- a/src/metrics/metrics.py +++ b/src/metrics/metrics.py @@ -159,7 +159,7 @@ def get_line_names(self) -> List[str]: async def _get_lines_impl(self) -> Dict[str, List[Tuple[Any, Any]]]: requester: Requester = await self.atoloka_client.get_requester() - result = {self.balance_name: [(datetime.datetime.utcnow(), requester.balance)]} + result = {self.balance_name: [(datetime.datetime.now(datetime.timezone.utc), requester.balance)]} return result @@ -206,7 +206,7 @@ def get_line_names(self) -> List[str]: def _cursor(self) -> cursor.UserBonusCursor: return cursor.UserBonusCursor( toloka_client=self.atoloka_client, - created_gte=datetime.datetime.utcnow(), + created_gte=datetime.datetime.now(datetime.timezone.utc), ) async def _get_lines_impl(self) -> Dict[str, List[Tuple[Any, Any]]]: @@ -218,9 +218,9 @@ async def _get_lines_impl(self) -> Dict[str, List[Tuple[Any, Any]]]: count = len(event_list) money = sum(event.user_bonus.amount for event in event_list) if self._count_name is not None: - result[self._count_name] = [(event_list[-1].event_time, count)] if count else [(datetime.datetime.utcnow(), 0)] + result[self._count_name] = [(event_list[-1].event_time, count)] if count else [(datetime.datetime.now(datetime.timezone.utc), 0)] if self._money_name is not None: - result[self._money_name] = [(event_list[-1].event_time, money)] if money else [(datetime.datetime.utcnow(), Decimal(0))] + result[self._money_name] = [(event_list[-1].event_time, money)] if money else [(datetime.datetime.now(datetime.timezone.utc), Decimal(0))] else: if self._count_name is not None: result[self._count_name] = [ @@ -291,7 +291,7 @@ def _cursor(self) -> cursor.UserSkillCursor: return cursor.UserSkillCursor( toloka_client=self.atoloka_client, skill_id=self._skill_id, - created_gte=datetime.datetime.utcnow(), + created_gte=datetime.datetime.now(datetime.timezone.utc), event_type='MODIFIED', ) @@ -303,7 +303,7 @@ async def _get_lines_impl(self) -> Dict[str, List[Tuple[Any, Any]]]: if self._count_name is not None: if self._join_events: count = len(event_list) - result[self._count_name] = [(event_list[-1].event_time, count)] if count else [(datetime.datetime.utcnow(), 0)] + result[self._count_name] = [(event_list[-1].event_time, count)] if count else [(datetime.datetime.now(datetime.timezone.utc), 0)] else: result[self._count_name] = [ (event_time, len(events)) @@ -327,9 +327,9 @@ class NewMessageThreads(BaseMetric): Args: count_name: Metric name for a count of new messages. - projects_name: Dictyonary that allows count messages on exact projects. {project_id: line_name} - pools_name: Dictyonary that allows count messages on exact pools. {pool_id: line_name} - join_events: Count all events in one point. Default False. "Values" never join. + projects_name: Dictionary that allows count messages on exact projects. {project_id: line_name} + pools_name: Dictionary that allows count messages on exact pools. {pool_id: line_name} + join_events: Count all events in one point. Default False. "Values" never join. Example: How to collect this metrics: @@ -355,7 +355,7 @@ class NewMessageThreads(BaseMetric): 'messages_count': [(datetime.datetime(2021, 11, 19, 9, 40, 15, 970000), 10)], # messages on this exact pool 'my_train_pool': [(datetime.datetime(2021, 11, 19, 12, 42, 50, 554830), 4)], - # with 'join_evants=True' it will be zero if no messages + # with 'join_events=True' it will be zero if no messages 'my_working_pool': [(datetime.datetime(2021, 11, 19, 12, 42, 50, 554830), 0)], 'pedestrian_proj': [(datetime.datetime(2021, 11, 19, 12, 42, 50, 554830), 1)], # total count != sum of other counts, because could exist different pools and projects @@ -390,7 +390,7 @@ def get_line_names(self) -> List[str]: def _cursor(self) -> cursor.MessageThreadCursor: return cursor.MessageThreadCursor( toloka_client=self.atoloka_client, - created_gte=datetime.datetime.utcnow(), + created_gte=datetime.datetime.now(datetime.timezone.utc), ) async def _get_lines_impl(self) -> Dict[str, List[Tuple[Any, Any]]]: @@ -400,7 +400,7 @@ async def _get_lines_impl(self) -> Dict[str, List[Tuple[Any, Any]]]: event_list = [event async for event in it] if self._join_events: if self._count_name is not None: - result[self._count_name] = [(event_list[-1].event_time, len(event_list))] if event_list else [(datetime.datetime.utcnow(), 0)] + result[self._count_name] = [(event_list[-1].event_time, len(event_list))] if event_list else [(datetime.datetime.now(datetime.timezone.utc), 0)] if self._projects_name or self._pools_name: pools_count = defaultdict(int) @@ -412,10 +412,12 @@ async def _get_lines_impl(self) -> Dict[str, List[Tuple[Any, Any]]]: pools_count[pool_id] += 1 if project_id in self._projects_name: projects_count[project_id] += 1 + + datetime_now = datetime.datetime.now(datetime.timezone.utc) for project_id, line_name in self._projects_name.items(): - result[line_name] = [(datetime.datetime.utcnow(), projects_count[project_id] if project_id in projects_count else 0)] + result[line_name] = [(datetime_now, projects_count.get(project_id, 0))] for pool_id, line_name in self._pools_name.items(): - result[line_name] = [(datetime.datetime.utcnow(), pools_count[pool_id] if pool_id in pools_count else 0)] + result[line_name] = [(datetime_now, pools_count.get(pool_id, 0))] else: if self._count_name is not None: result[self._count_name] = [ diff --git a/src/metrics/metrics.pyi b/src/metrics/metrics.pyi index f2ff8292..96551d9a 100644 --- a/src/metrics/metrics.pyi +++ b/src/metrics/metrics.pyi @@ -243,9 +243,9 @@ class NewMessageThreads(BaseMetric): Args: count_name: Metric name for a count of new messages. - projects_name: Dictyonary that allows count messages on exact projects. {project_id: line_name} - pools_name: Dictyonary that allows count messages on exact pools. {pool_id: line_name} - join_events: Count all events in one point. Default False. "Values" never join. + projects_name: Dictionary that allows count messages on exact projects. {project_id: line_name} + pools_name: Dictionary that allows count messages on exact pools. {pool_id: line_name} + join_events: Count all events in one point. Default False. "Values" never join. Example: How to collect this metrics: @@ -271,7 +271,7 @@ class NewMessageThreads(BaseMetric): 'messages_count': [(datetime.datetime(2021, 11, 19, 9, 40, 15, 970000), 10)], # messages on this exact pool 'my_train_pool': [(datetime.datetime(2021, 11, 19, 12, 42, 50, 554830), 4)], - # with 'join_evants=True' it will be zero if no messages + # with 'join_events=True' it will be zero if no messages 'my_working_pool': [(datetime.datetime(2021, 11, 19, 12, 42, 50, 554830), 0)], 'pedestrian_proj': [(datetime.datetime(2021, 11, 19, 12, 42, 50, 554830), 1)], # total count != sum of other counts, because could exist different pools and projects diff --git a/src/metrics/pool_metrics.py b/src/metrics/pool_metrics.py index bf8e5108..d4ebfb59 100644 --- a/src/metrics/pool_metrics.py +++ b/src/metrics/pool_metrics.py @@ -125,7 +125,7 @@ def _cursors(self) -> Dict[str, cursor.AssignmentCursor]: # key - metric name. One of the value of paramets: created_name, submitted_name, etc. # val - cursor configured for gathering this metric cursors = {} - start_time = datetime.datetime.utcnow() + start_time = datetime.datetime.now(datetime.timezone.utc) for attr_name, status_value in self._status_dict.items(): metric_name = getattr(self, attr_name) if metric_name: @@ -143,7 +143,7 @@ async def _get_lines_impl(self) -> Dict[str, List[Tuple[Any, Any]]]: event_list = [event async for event in it] if self._join_events: count = len(event_list) - result[metric_name] = [(event_list[-1].event_time, count)] if count else [(datetime.datetime.utcnow(), 0)] + result[metric_name] = [(event_list[-1].event_time, count)] if count else [(datetime.datetime.now(datetime.timezone.utc), 0)] else: result[metric_name] = [ (event_time, len(events)) @@ -483,7 +483,7 @@ def get_line_names(self) -> List[str]: def _cursor(self) -> cursor.UserRestrictionCursor: return cursor.UserRestrictionCursor( toloka_client=self.atoloka_client, - created_gte=datetime.datetime.utcnow(), + created_gte=datetime.datetime.now(datetime.timezone.utc), pool_id=self.pool_id ) @@ -494,13 +494,14 @@ async def _get_lines_impl(self) -> Dict[str, List[Tuple[Any, Any]]]: event_list = [event async for event in it] if self._join_events: if self._count_name is not None: - result[self._count_name] = [(event_list[-1].event_time, len(event_list))] if event_list else [(datetime.datetime.utcnow(), 0)] + result[self._count_name] = [(event_list[-1].event_time, len(event_list))] if event_list else [(datetime.datetime.now(datetime.timezone.utc), 0)] if self._filter_by_comment is not None: comments_count = defaultdict(int) for event in event_list: comments_count[event.user_restriction.private_comment] += 1 + datetime_now = datetime.datetime.now(datetime.timezone.utc) for comment, line_name in self._filter_by_comment.items(): - result[line_name] = [(datetime.datetime.utcnow(), comments_count[comment] if comment in comments_count else 0)] + result[line_name] = [(datetime_now, comments_count.get(comment, 0))] else: if self._count_name is not None: result[self._count_name] = [ diff --git a/src/streaming/cursor.py b/src/streaming/cursor.py index 2a4fee73..a8d9ed84 100644 --- a/src/streaming/cursor.py +++ b/src/streaming/cursor.py @@ -10,6 +10,7 @@ 'UserSkillCursor', ] +import asyncio import attr import copy import functools @@ -234,13 +235,21 @@ class AssignmentCursor(BaseCursor): ... """ + BATCH_SIZE = 1000 + _event_type: AssignmentEvent.Type = attr.ib(converter=functools.partial(structure, cl=AssignmentEvent.Type)) _request: search_requests.AssignmentSearchRequest = attr.ib( factory=search_requests.AssignmentSearchRequest, ) def _get_fetcher(self) -> Callable[..., search_results.AssignmentSearchResult]: - return self.toloka_client.find_assignments + async def _async_fetcher(*args, **kwargs): + return await self.toloka_client.find_assignments(*args, limit=self.BATCH_SIZE, **kwargs) + + method = self.toloka_client.find_assignments + if asyncio.iscoroutinefunction(method) or asyncio.iscoroutinefunction(getattr(method, '__call__', None)): + return _async_fetcher + return functools.partial(self.toloka_client.find_assignments, limit=self.BATCH_SIZE) def _get_time_field(self) -> str: return self._event_type.time_key diff --git a/src/streaming/observer.py b/src/streaming/observer.py index c23b9ccd..a997d8d1 100644 --- a/src/streaming/observer.py +++ b/src/streaming/observer.py @@ -26,6 +26,8 @@ @attr.s class BaseObserver: name: Optional[str] = attr.ib(default=None, kw_only=True) + _enabled: bool = attr.ib(default=True, init=False) + _deleted: bool = attr.ib(default=False, init=False) def _get_unique_key(self) -> Tuple: return (self.__class__.__name__, self.name or '') @@ -39,6 +41,18 @@ async def __call__(self) -> None: async def should_resume(self) -> bool: return False + def delete(self) -> None: + """Schedule observer to be removed from the pipeline.""" + self._deleted = True + + def disable(self) -> None: + """Prevent observer from being called.""" + self._enabled = False + + def enable(self) -> None: + """Enable observer to be called during pipeline execution.""" + self._enabled = True + @async_add_headers('streaming') async def run(self, period: datetime.timedelta = datetime.timedelta(seconds=60)) -> None: """For standalone usage (out of a Pipeline).""" diff --git a/src/streaming/observer.pyi b/src/streaming/observer.pyi index 7638b092..1d7efea6 100644 --- a/src/streaming/observer.pyi +++ b/src/streaming/observer.pyi @@ -17,6 +17,21 @@ class BaseObserver: def should_resume(self) -> bool: ... + def delete(self) -> None: + """Schedule observer to be removed from the pipeline. + """ + ... + + def disable(self) -> None: + """Prevent observer from being called. + """ + ... + + def enable(self) -> None: + """Enable observer to be called during pipeline execution. + """ + ... + def run(self, period: datetime.timedelta = ...) -> None: """For standalone usage (out of a Pipeline). """ @@ -28,6 +43,8 @@ class BaseObserver: ... name: typing.Optional[str] + _enabled: bool + _deleted: bool class BasePoolObserver(BaseObserver): @@ -45,6 +62,8 @@ class BasePoolObserver(BaseObserver): ... name: typing.Optional[str] + _enabled: bool + _deleted: bool toloka_client: toloka.util.async_utils.AsyncInterfaceWrapper[typing.Union[toloka.client.TolokaClient, toloka.util.async_utils.AsyncMultithreadWrapper[toloka.client.TolokaClient]]] pool_id: str @@ -123,6 +142,8 @@ class PoolStatusObserver(BasePoolObserver): ... name: typing.Optional[str] + _enabled: bool + _deleted: bool toloka_client: toloka.util.async_utils.AsyncInterfaceWrapper[typing.Union[toloka.client.TolokaClient, toloka.util.async_utils.AsyncMultithreadWrapper[toloka.client.TolokaClient]]] pool_id: str _callbacks: typing.Dict[toloka.client.pool.Pool.Status, typing.List[typing.Callable[[toloka.client.pool.Pool], typing.Awaitable[None]]]] @@ -222,6 +243,8 @@ class AssignmentsObserver(BasePoolObserver): ... name: typing.Optional[str] + _enabled: bool + _deleted: bool toloka_client: toloka.util.async_utils.AsyncInterfaceWrapper[typing.Union[toloka.client.TolokaClient, toloka.util.async_utils.AsyncMultithreadWrapper[toloka.client.TolokaClient]]] pool_id: str _callbacks: typing.Dict[toloka.streaming.event.AssignmentEvent.Type, _CallbacksCursorConsumer] diff --git a/src/streaming/pipeline.py b/src/streaming/pipeline.py index 0fbab85f..60df71ec 100644 --- a/src/streaming/pipeline.py +++ b/src/streaming/pipeline.py @@ -6,10 +6,11 @@ import attr import itertools import logging +import signal from contextlib import contextmanager from datetime import datetime, timedelta -from typing import Any, ContextManager, Dict, Iterable, List, Optional, Set, Tuple +from typing import Any, Container, ContextManager, Dict, Iterable, Iterator, List, Optional, Set, Tuple from .observer import BaseObserver from .storage import BaseStorage @@ -19,6 +20,9 @@ logger = logging.getLogger(__name__) +_OrderedSet = dict.fromkeys + + @attr.s(eq=False, hash=False) class _Worker: """_Worker object that run observer's __call__() and should_resume() methods. @@ -35,8 +39,11 @@ class _Worker: @async_add_headers('streaming') async def __call__(self) -> None: - await self.observer() - self.should_resume = await self.observer.should_resume() + if getattr(self.observer, '_enabled', True): + await self.observer() + self.should_resume = await self.observer.should_resume() + else: + self.should_resume = False def __hash__(self) -> int: return hash(self.name) @@ -52,6 +59,9 @@ def _from_observer(cls, observer: BaseObserver) -> '_Worker': def _no_one_should_resume(workers: Iterable['_Worker']) -> bool: return all(not worker.should_resume for worker in workers) + def _is_deleted(self) -> bool: + return getattr(self.observer, '_deleted', False) + @attr.s class Pipeline: @@ -112,6 +122,7 @@ class Pipeline: storage: Optional[BaseStorage] = attr.ib(default=None) name: Optional[str] = attr.ib(default=None, kw_only=True) _observers: Dict[int, BaseObserver] = attr.ib(factory=dict, init=False) + _got_sigint: bool = attr.ib(default=False, init=False) @contextmanager def _lock(self, key: str) -> ContextManager[Any]: @@ -121,7 +132,7 @@ def _lock(self, key: str) -> ContextManager[Any]: return yield None - def _storage_load(self, pipeline_key: str, workers: List[_Worker]) -> None: + def _storage_load(self, pipeline_key: str, workers: Iterable[_Worker]) -> None: if self.storage: logger.info('Loading state from storage: %s', type(self.storage).__name__) observer_by_key = {worker.name: worker.observer for worker in workers} @@ -133,14 +144,14 @@ def _storage_load(self, pipeline_key: str, workers: List[_Worker]) -> None: else: logger.info('No saved states found') - def _storage_save(self, pipeline_key: str, workers: List[_Worker]) -> None: + def _storage_save(self, pipeline_key: str, workers: Iterable[_Worker]) -> None: if self.storage: logger.info('Save state to: %s', type(self.storage).__name__) observer_by_key = {worker.name: worker.observer for worker in workers} self.storage.save(pipeline_key, observer_by_key) logger.info('Saved count: %d', len(observer_by_key)) - def _storage_cleanup(self, pipeline_key: str, workers: List[_Worker], lock: Any) -> None: + def _storage_cleanup(self, pipeline_key: str, workers: Iterable[_Worker], lock: Any) -> None: if self.storage: try: keys = {worker.name for worker in workers} @@ -180,6 +191,24 @@ def register(self, observer: BaseObserver) -> BaseObserver: self._observers[id(observer)] = observer return observer + def observers_iter(self) -> Iterator[BaseObserver]: + """Iterate over registered observers. + + Returns: + An iterator over all registered observers except deleted ones. + May contain observers sheduled to deletion and not deleted yet. + """ + return iter(self._observers.values()) + + def _sigint_handler(self, loop: asyncio.AbstractEventLoop, waiting: Container[_Worker]) -> None: + """Is being called in case of KeyboardInterrupt during workers run.""" + logger.error('Gracefully shutdown...') + loop.remove_signal_handler(signal.SIGINT) + self._got_sigint = True + if not waiting: + logger.warning('No workers to wait') + raise KeyboardInterrupt + def _process_done_tasks( self, pipeline_key: str, @@ -200,21 +229,28 @@ def _process_done_tasks( pending[task.worker] = task.start_time + self.period self._storage_save(pipeline_key, workers_to_dump) if errored: + asyncio.get_event_loop().remove_signal_handler(signal.SIGINT) for task in errored: logger.error('Got error in: %s', task) raise ComplexException([task.exception() for task in errored]) - @async_add_headers('streaming') async def run(self) -> None: if not self._observers: raise ValueError('No observers registered') + self._got_sigint = False pipeline_key: str = str(self._get_unique_key()) - workers = [_Worker._from_observer(observer) for observer in self._observers.values()] - + workers = _OrderedSet(()) waiting: Dict[_Worker, asyncio.Task] = {} - pending: Dict[_Worker, datetime] = {worker: datetime.min for worker in workers} + pending: Dict[_Worker, datetime] = {} + + def _add_new_observers(new_observers: Iterable[BaseObserver]) -> None: + new_workers = _OrderedSet(_Worker._from_observer(observer) for observer in new_observers) + workers.update(new_workers) + pending.update({worker: datetime.min for worker in new_workers}) + + _add_new_observers(self.observers_iter()) check_mode = False @@ -224,37 +260,63 @@ async def run(self) -> None: with self._lock(pipeline_key) as lock: if iteration == 1: # Get checkpoint from the storage. self._storage_load(pipeline_key, workers) + loop = asyncio.get_event_loop() + loop.add_signal_handler(signal.SIGINT, self._sigint_handler, loop, waiting) iteration_start = datetime.now() still_pending = {} to_start: List[_Worker] = [] + to_remove: List[_Worker] = [] for worker, time_to_start in pending.items(): - if time_to_start <= iteration_start or check_mode: + if worker._is_deleted(): + to_remove.append(worker) + elif time_to_start <= iteration_start or check_mode: assert worker not in waiting to_start.append(worker) else: still_pending[worker] = time_to_start pending = still_pending - logger.info('Observers to run count: %d', len(to_start)) - for worker in to_start: - task = asyncio.get_event_loop().create_task(worker()) - task.worker = worker - task.start_time = iteration_start - waiting[worker] = task + if to_remove: + logger.info('Found observers to remove count: %d', len(to_remove)) + for worker in to_remove: + self._observers.pop(id(worker.observer)) + workers.pop(worker) + + if self._got_sigint: + logger.warning('Not starting new workers due to SIGINT received') + to_start = [] + else: + logger.info('Observers to run count: %d', len(to_start)) + for worker in to_start: + task = asyncio.get_event_loop().create_task(worker()) + task.worker = worker + task.start_time = iteration_start + waiting[worker] = task return_when = asyncio.FIRST_COMPLETED if check_mode: return_when = asyncio.ALL_COMPLETED logger.info('Check resume all') - done, _ = await asyncio.wait(waiting.values(), return_when=return_when) - self._process_done_tasks(pipeline_key, done, waiting, pending) + if self._got_sigint: + return_when = asyncio.ALL_COMPLETED + logger.warning('Need to wait all working') + + if waiting: # It may be empty due to SIGINT. + done, _ = await asyncio.wait(waiting.values(), return_when=return_when) + self._process_done_tasks(pipeline_key, done, waiting, pending) + elif self._got_sigint: + raise KeyboardInterrupt + else: + logger.info('No workers to process. Finish') + return if _Worker._no_one_should_resume(workers): # But some of them may still work. if check_mode: self._storage_cleanup(pipeline_key, workers, lock) logger.info('Finish') + asyncio.get_event_loop().remove_signal_handler(signal.SIGINT) return logger.info('No one should resume yet. Waiting for remaining ones...') @@ -263,15 +325,25 @@ async def run(self) -> None: else: done = set() self._process_done_tasks(pipeline_key, done, waiting, pending) + if self._got_sigint: + raise KeyboardInterrupt if _Worker._no_one_should_resume(workers): # If stop condition at all workers, run in check_mode. check_mode = True - start_soon = max(pending.values()) + start_soon = max(pending.values(), default=None) else: check_mode = False - start_soon = min(pending.values()) + start_soon = min(pending.values(), default=None) + + if self._got_sigint: + logger.warning('No sleeping while SIGINT handling') + else: + sleep_time = (start_soon - datetime.now()).total_seconds() + sleep_time = max(sleep_time, self.MIN_SLEEP_SECONDS) - sleep_time = (start_soon - datetime.now()).total_seconds() - sleep_time = max(sleep_time, self.MIN_SLEEP_SECONDS) + logger.info('Sleeping for %f seconds', sleep_time) + await asyncio.sleep(sleep_time) - logger.info('Sleeping for %f seconds', sleep_time) - await asyncio.sleep(sleep_time) + new_observers = self._observers.keys() - {id(worker.observer) for worker in workers} + if new_observers: + logger.info('New observers found in quantity: %d', len(new_observers)) + _add_new_observers(new_observers) diff --git a/src/streaming/pipeline.pyi b/src/streaming/pipeline.pyi index 484f4389..31eef140 100644 --- a/src/streaming/pipeline.pyi +++ b/src/streaming/pipeline.pyi @@ -83,6 +83,15 @@ class Pipeline: """ ... + def observers_iter(self) -> typing.Iterator[toloka.streaming.observer.BaseObserver]: + """Iterate over registered observers. + + Returns: + An iterator over all registered observers except deleted ones. + May contain observers sheduled to deletion and not deleted yet. + """ + ... + def run(self) -> None: ... def __init__( @@ -100,3 +109,4 @@ class Pipeline: storage: typing.Optional[toloka.streaming.storage.BaseStorage] name: typing.Optional[str] _observers: typing.Dict[int, toloka.streaming.observer.BaseObserver] + _got_sigint: bool diff --git a/tests/app/conftest.py b/tests/app/conftest.py index b5dbb0b0..aa7e7f68 100644 --- a/tests/app/conftest.py +++ b/tests/app/conftest.py @@ -149,7 +149,8 @@ def app_item_map(): 'input_data': { 'id': '124', 'text': 'I smell bad after the last night.' - } + }, + 'errors': [], } @@ -166,7 +167,8 @@ def app_item_map_with_readonly(app_item_map): }, 'created_at': '2021-09-28T15:56:25.193000', 'started_at': '2021-09-28T15:56:30.309920', - 'finished_at': '2021-09-28T16:07:12.307169' + 'finished_at': '2021-09-28T16:07:12.307169', + 'errors': [], } diff --git a/tests/app/test_app.py b/tests/app/test_app.py index 13fd223b..aa266de0 100644 --- a/tests/app/test_app.py +++ b/tests/app/test_app.py @@ -187,7 +187,7 @@ def get_app_projects(request, context): # Request object syntax request = client.search_requests.AppProjectSearchRequest( id_gt='20', - created_gt=datetime.datetime(2016, 3, 23, 12, 59, 0) + created_gt=datetime.datetime(2016, 3, 23, 12, 59, 0, tzinfo=datetime.timezone.utc) ) result = toloka_client_prod.get_app_projects(request) assert expected_app_projects == client.unstructure(list(result)) @@ -195,7 +195,7 @@ def get_app_projects(request, context): # Expanded syntax result = toloka_client_prod.get_app_projects( id_gt='20', - created_gt=datetime.datetime(2016, 3, 23, 12, 59, 0) + created_gt=datetime.datetime(2016, 3, 23, 12, 59, 0, tzinfo=datetime.timezone.utc) ) assert expected_app_projects == client.unstructure(list(result)) @@ -377,7 +377,7 @@ def get_app_items(request, context): # Request object syntax request = client.search_requests.AppItemSearchRequest( id_gt='20', - created_at_gt=datetime.datetime(2016, 3, 23, 12, 59, 0) + created_at_gt=datetime.datetime(2016, 3, 23, 12, 59, 0, tzinfo=datetime.timezone.utc) ) result = toloka_client_prod.get_app_items('123', request) assert expected_app_items == client.unstructure(list(result)) @@ -386,7 +386,7 @@ def get_app_items(request, context): result = toloka_client_prod.get_app_items( '123', id_gt='20', - created_at_gt=datetime.datetime(2016, 3, 23, 12, 59, 0) + created_at_gt=datetime.datetime(2016, 3, 23, 12, 59, 0, tzinfo=datetime.timezone.utc) ) assert expected_app_items == client.unstructure(list(result)) diff --git a/tests/pool/test_pool.py b/tests/pool/test_pool.py index 170d4a17..f6957d0d 100644 --- a/tests/pool/test_pool.py +++ b/tests/pool/test_pool.py @@ -1,11 +1,12 @@ import datetime -from operator import itemgetter import logging -import simplejson as json +from operator import itemgetter from urllib.parse import urlparse, parse_qs import pytest +import simplejson as json import toloka.client as client +from toloka.client.pool import Pool from ..testutils.util_functions import check_headers @@ -35,7 +36,7 @@ def pools(request, context): request = client.search_requests.PoolSearchRequest( project_id='10', id_gt='20', - last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0), + last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0, tzinfo=datetime.timezone.utc), ) sort = client.search_requests.PoolSortItems(['created', '-id']) result = toloka_client.find_pools(request, sort=sort) @@ -45,7 +46,7 @@ def pools(request, context): result = toloka_client.find_pools( project_id='10', id_gt='20', - last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0), + last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0, tzinfo=datetime.timezone.utc), sort=['created', '-id'], ) assert raw_result == client.unstructure(result) @@ -81,7 +82,7 @@ def get_pools(request, context): request = client.search_requests.PoolSearchRequest( project_id='10', id_gt='20', - last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0), + last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0, tzinfo=datetime.timezone.utc), ) result = toloka_client.get_pools(request) assert expected_pools == client.unstructure(list(result)) @@ -90,7 +91,7 @@ def get_pools(request, context): result = toloka_client.get_pools( project_id='10', id_gt='20', - last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0), + last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0, tzinfo=datetime.timezone.utc), ) assert expected_pools == client.unstructure(list(result)) @@ -212,7 +213,6 @@ def test_create_pool_check_all_filters(requests_mock, toloka_client, toloka_url, {'category': 'computed', 'key': 'user_agent_version_major', 'operator': 'LT', 'value': 11}, {'category': 'computed', 'key': 'user_agent_version_minor', 'operator': 'LT', 'value': 12}, {'category': 'computed', 'key': 'user_agent_version_bugfix', 'operator': 'GT', 'value': 2026}, - {'category': 'computed', 'key': 'rating', 'operator': 'GTE', 'value': 885.15}, { 'or': [ {'category': 'skill', 'key': '224', 'operator': 'GTE', 'value': 85}, @@ -260,7 +260,6 @@ def pools(request, context): (filter.UserAgentVersionMajor < 11) & (filter.UserAgentVersionMinor < 12) & (filter.UserAgentVersionBugfix > 2026) & - (filter.Rating >= 885.15) & ((filter.Skill('224') >= 85) | (filter.Skill('300') != None) | (filter.Skill('350') == 75.512)) # noqa: E711 ) result = toloka_client.create_pool(pool) @@ -268,6 +267,20 @@ def pools(request, context): assert pool_map == client.unstructure(result) +@pytest.mark.parametrize('expire_time', [ + datetime.datetime.now(), + datetime.datetime.now(tz=datetime.timezone(datetime.timedelta(hours=10))), + datetime.datetime.now(tz=datetime.timezone.utc), +]) +def test_create_pool_time_format(expire_time): + pool = Pool(will_expire=expire_time) + pool = Pool.structure(pool.unstructure()) + assert pool.will_expire.tzinfo == datetime.timezone.utc + if expire_time.tzinfo is None: + expire_time = expire_time.replace(tzinfo=datetime.timezone.utc) + assert expire_time.astimezone(datetime.timezone.utc) == pool.will_expire + + @pytest.fixture def pool_map_without_filter(pool_map_with_readonly): pool_map_without_filter = pool_map_with_readonly.copy() diff --git a/tests/streaming/test_cursor.py b/tests/streaming/test_cursor.py index ecf5f46a..97104b73 100644 --- a/tests/streaming/test_cursor.py +++ b/tests/streaming/test_cursor.py @@ -103,7 +103,7 @@ def fetch_async(cursor): async def _fetch(): return [item async for item in cursor] - loop = asyncio.get_event_loop() + loop = asyncio.new_event_loop() return unstructure(loop.run_until_complete(_fetch())) diff --git a/tests/streaming/test_pipeline.py b/tests/streaming/test_pipeline.py index c46b9f43..28840cea 100644 --- a/tests/streaming/test_pipeline.py +++ b/tests/streaming/test_pipeline.py @@ -8,7 +8,8 @@ from toloka.client import unstructure from toloka.util.async_utils import ComplexException, AsyncMultithreadWrapper -from toloka.streaming import AssignmentsObserver, PoolStatusObserver, Pipeline +from toloka.streaming import Pipeline +from toloka.streaming.observer import AssignmentsObserver, BaseObserver, PoolStatusObserver from toloka.streaming.storage import JSONLocalStorage from toloka.streaming.locker import NewerInstanceDetectedError @@ -72,13 +73,15 @@ def __call__(self, events): observer = pipeline.register(AssignmentsObserver(toloka_client, pool_id='100')) handler = observer.on_submitted(HandlerRaiseSometimes()) + loop = asyncio.new_event_loop() + with pytest.raises(ComplexException) as exc: - asyncio.get_event_loop().run_until_complete(pipeline.run()) + loop.run_until_complete(pipeline.run()) assert 'Raised from callback' in str(exc) assert 1 == handler.calls_count assert [] == handler.received - asyncio.get_event_loop().run_until_complete(pipeline.run()) + loop.run_until_complete(pipeline.run()) assert 2 == handler.calls_count events_expected = [{'assignment': item, 'event_type': 'SUBMITTED', 'event_time': item['submitted']} for item in storage] @@ -135,8 +138,7 @@ async def _main(): _expire_active_and_close_pool(after_sec=2), )))) - loop = asyncio.get_event_loop() - loop.run_until_complete(_main()) + asyncio.new_event_loop().run_until_complete(_main()) expected_saved = [item for item in backend.storage if item.get('submitted')] assert expected_saved == unstructure(save_submitted_here) @@ -269,7 +271,7 @@ async def _main_old(): _expire_active_and_close_pool(after_sec=2), )))) - res_old: Tuple[Set[asyncio.Task], Set] = asyncio.get_event_loop().run_until_complete(_main_old()) + res_old: Tuple[Set[asyncio.Task], Set] = asyncio.new_event_loop().run_until_complete(_main_old()) # There should be one successfull (with initial assignments) iteration. # and one failed (with new assignments). @@ -306,7 +308,7 @@ async def _main_new(): _expire_active_and_close_pool(after_sec=2), )))) - res_new = asyncio.get_event_loop().run_until_complete(_main_new()) + res_new = asyncio.new_event_loop().run_until_complete(_main_new()) assert all(task.exception() is None for task in res_new[0]), res_new assert 3 == handler_new.iteration # One successfull iteration before restore + 2 after. The errored one wasn't saved. @@ -356,7 +358,7 @@ async def should_resume(self): pipeline.register(CountingObserver('fast', 0.10, enough_iterations=4)) pipeline.register(CountingObserver('slow', 0.55, enough_iterations=1)) - asyncio.get_event_loop().run_until_complete(pipeline.run()) + asyncio.new_event_loop().run_until_complete(pipeline.run()) assert [ ('fast', 'start'), @@ -439,7 +441,7 @@ async def _main(): _expire_active_and_close_pool(after_sec=2.5), )))) - done, _ = asyncio.get_event_loop().run_until_complete(_main()) + done, _ = asyncio.new_event_loop().run_until_complete(_main()) first_run_task = next(task for task in done if '_run_1' in str(task)) assert isinstance(first_run_task.exception(), NewerInstanceDetectedError), first_run_task.exception() @@ -448,3 +450,46 @@ async def _main(): assert 2 == handler_2.iterations assert 10 == len(handler_2.history) + + +def test_disable_observer(): + @attr.s + class ObserverToDisableSelf(BaseObserver): + count: int = attr.ib(default=0) + + async def should_resume(self) -> bool: + return True + + async def __call__(self) -> None: + self.count += 1 + self.disable() + + Pipeline.MIN_SLEEP_SECONDS = 0.01 + pipeline = Pipeline(period=datetime.timedelta(seconds=Pipeline.MIN_SLEEP_SECONDS)) + observer = pipeline.register(ObserverToDisableSelf()) + asyncio.new_event_loop().run_until_complete(pipeline.run()) + + assert observer.count == 1 + + +def test_delete_observer(): + @attr.s + class ObserverToDeleteSelf(BaseObserver): + count: int = attr.ib(default=0) + + async def should_resume(self) -> bool: + return True + + async def __call__(self) -> None: + self.count += 1 + self.delete() + + Pipeline.MIN_SLEEP_SECONDS = 0.01 + pipeline = Pipeline(period=datetime.timedelta(seconds=Pipeline.MIN_SLEEP_SECONDS)) + observer = pipeline.register(ObserverToDeleteSelf()) + assert observer in pipeline.observers_iter() + + asyncio.new_event_loop().run_until_complete(pipeline.run()) + + assert observer.count == 1 + assert observer not in pipeline.observers_iter() diff --git a/tests/streaming/test_shutdown.py b/tests/streaming/test_shutdown.py new file mode 100644 index 00000000..297a8d46 --- /dev/null +++ b/tests/streaming/test_shutdown.py @@ -0,0 +1,131 @@ +import asyncio +import attr +import datetime +import os +import pytest +import signal +import time +from concurrent import futures +from typing import Optional + +from toloka.streaming import Pipeline +from toloka.streaming.storage import JSONLocalStorage +from toloka.util.async_utils import ComplexException + + +@pytest.fixture +def pid_file_path(tmp_path): + return tmp_path / 'to-kill-sigint.pid' + + +@pytest.fixture +def storage_directory(tmp_path): + dirname = tmp_path / 'storage_directory' + dirname.mkdir() + return dirname + + +OBSERVER_DURATION = 0.4 + + +@attr.s +class ObserverToInterrupt: + name: str = attr.ib() # Has no impact on key here. + duration: float = attr.ib(default=OBSERVER_DURATION) + count: int = attr.ib(default=0) + max_count: int = attr.ib(default=2) + injection: Optional['ObserverToInterrupt'] = attr.ib(default=None, init=False) + _should_resume: bool = attr.ib(default=True, init=False) + + async def __call__(self): + self.count += 1 + await asyncio.sleep(self.duration) + if self.count >= self.max_count: + self._should_resume = False + + async def should_resume(self): + return self._should_resume + + def _get_unique_key(self): + return f'some-uniq-key-for-{type(self).__name__}' + + def inject(self, other: 'ObserverToInterrupt') -> None: + self.injection = other + + +class ObserverThatFails(ObserverToInterrupt): + async def __call__(self): + await super().__call__() + raise ValueError('error-from-ObserverThatFails') + + +def _create_pipeline(dirname: str, observer_name: str): + Pipeline.MIN_SLEEP_SECONDS = 0 + pipeline = Pipeline(storage=JSONLocalStorage(dirname=dirname), period=datetime.timedelta(seconds=OBSERVER_DURATION)) + observer = pipeline.register(ObserverToInterrupt(observer_name)) + fail_observer = pipeline.register(ObserverThatFails(observer_name)) + return pipeline, observer, fail_observer + + +def _run_pipeline(pid_file_path: str, dirname: str): + pipeline, _, _ = _create_pipeline(dirname, 'observer-before-ctrl-c') + pid = os.getpid() + with open(pid_file_path, 'w') as file: + file.write(str(pid)) + loop = asyncio.new_event_loop() + loop.run_until_complete(pipeline.run()) + + +def _throw_sigint(pid_file_path: str, interrupt_after: float): + time.sleep(interrupt_after) + with open(pid_file_path) as file: + pid = int(file.read()) + os.kill(pid, signal.SIGINT) + + +def test_gracefully_shutdown(pid_file_path, storage_directory): + with futures.ProcessPoolExecutor() as executor: + done, _ = futures.wait([executor.submit(_run_pipeline, pid_file_path, storage_directory), + executor.submit(_throw_sigint, pid_file_path, OBSERVER_DURATION / 2)]) + for task in done: + error = task.exception() + if error and not isinstance(error, futures.BrokenExecutor): + raise error + + pipeline, observer, fail_observer = _create_pipeline(storage_directory, 'observer-after-ctrl-c') + with pytest.raises(ComplexException): + asyncio.new_event_loop().run_until_complete(pipeline.run()) + assert observer.injection.name == 'observer-before-ctrl-c' + assert observer.injection.count == 1 + assert fail_observer.injection is None # Only successful workers are saved. + + +LONG_WAIT_SECONDS = 10 +SHORT_OBSERVER_DURATION = 0.1 + + +def _run_long_sleeping_pipeline(pid_file_path: str): + Pipeline.MIN_SLEEP_SECONDS = LONG_WAIT_SECONDS + pipeline = Pipeline(period=datetime.timedelta(seconds=LONG_WAIT_SECONDS)) + pipeline.register(ObserverToInterrupt('short-observer', duration=SHORT_OBSERVER_DURATION)) + + pid = os.getpid() + with open(pid_file_path, 'w') as file: + file.write(str(pid)) + loop = asyncio.new_event_loop() + loop.run_until_complete(pipeline.run()) + + +def test_interrupt_sleeping(pid_file_path): + start_time = time.time() + + with futures.ProcessPoolExecutor() as executor: + done, _ = futures.wait([executor.submit(_run_long_sleeping_pipeline, pid_file_path), + executor.submit(_throw_sigint, pid_file_path, SHORT_OBSERVER_DURATION * 1.5)]) + for task in done: + error = task.exception() + if error and not isinstance(error, KeyboardInterrupt): + raise error + + elapsed = time.time() - start_time + assert elapsed < LONG_WAIT_SECONDS, elapsed diff --git a/tests/template_builder/test_completeness.py b/tests/template_builder/test_completeness.py index b90f4bb2..5c217555 100644 --- a/tests/template_builder/test_completeness.py +++ b/tests/template_builder/test_completeness.py @@ -30,6 +30,7 @@ 'view.web-phone-next', 'view.with-label', 'field.button-checkbox', + 'field.tumbler', } diff --git a/tests/test_assignment.py b/tests/test_assignment.py index 549c9385..35306288 100644 --- a/tests/test_assignment.py +++ b/tests/test_assignment.py @@ -1,4 +1,4 @@ -from datetime import datetime +from datetime import datetime, timezone from operator import itemgetter from urllib.parse import urlparse, parse_qs from decimal import Decimal @@ -78,8 +78,8 @@ def find_assignments(request, context): status=client.assignment.Assignment.ACCEPTED, pool_id='21', user_id='user-i1d', - created_gte=datetime(2015, 12, 1), - created_lt=datetime(2016, 6, 1), + created_gte=datetime(2015, 12, 1, tzinfo=timezone.utc), + created_lt=datetime(2016, 6, 1, tzinfo=timezone.utc), ) sort = client.search_requests.AssignmentSortItems(['-submitted']) result = toloka_client.find_assignments(request, sort=sort) @@ -90,8 +90,8 @@ def find_assignments(request, context): status=client.assignment.Assignment.ACCEPTED, pool_id='21', user_id='user-i1d', - created_gte=datetime(2015, 12, 1), - created_lt=datetime(2016, 6, 1), + created_gte=datetime(2015, 12, 1, tzinfo=timezone.utc), + created_lt=datetime(2016, 6, 1, tzinfo=timezone.utc), sort=['-submitted'] ) assert raw_result == client.unstructure(result) @@ -130,8 +130,8 @@ def get_assignments(request, context): status=client.assignment.Assignment.ACCEPTED, pool_id='21', user_id='user-i1d', - created_gte=datetime(2015, 12, 1), - created_lt=datetime(2016, 6, 1), + created_gte=datetime(2015, 12, 1, tzinfo=timezone.utc), + created_lt=datetime(2016, 6, 1, tzinfo=timezone.utc), ) result = toloka_client.get_assignments(request) assert assignments == client.unstructure(list(result)) @@ -141,8 +141,8 @@ def get_assignments(request, context): status=client.assignment.Assignment.ACCEPTED, pool_id='21', user_id='user-i1d', - created_gte=datetime(2015, 12, 1), - created_lt=datetime(2016, 6, 1), + created_gte=datetime(2015, 12, 1, tzinfo=timezone.utc), + created_lt=datetime(2016, 6, 1, tzinfo=timezone.utc), ) assert assignments == client.unstructure(list(result)) diff --git a/tests/test_attachment.py b/tests/test_attachment.py index 7e6ad5c2..f42f566f 100644 --- a/tests/test_attachment.py +++ b/tests/test_attachment.py @@ -62,7 +62,7 @@ def attachments(request, context): owner_company_id='company-1', name='ExampleAttachment.txt', user_id='user-1', - created_gt=datetime.datetime(2000, 1, 1, 12, 57, 1), + created_gt=datetime.datetime(2000, 1, 1, 12, 57, 1, tzinfo=datetime.timezone.utc), ) sort = client.search_requests.AttachmentSortItems(['id']) result = toloka_client.find_attachments(request, sort=sort, limit=50) @@ -75,7 +75,7 @@ def attachments(request, context): owner_company_id='company-1', name='ExampleAttachment.txt', user_id='user-1', - created_gt=datetime.datetime(2000, 1, 1, 12, 57, 1), + created_gt=datetime.datetime(2000, 1, 1, 12, 57, 1, tzinfo=datetime.timezone.utc), sort=['id'], limit=50 ) @@ -118,7 +118,7 @@ def get_attachments(request, context): owner_company_id='company-1', name='ExampleAttachment.txt', user_id='user-1', - created_gt=datetime.datetime(2000, 1, 1, 12, 57, 1), + created_gt=datetime.datetime(2000, 1, 1, 12, 57, 1, tzinfo=datetime.timezone.utc), ) result = toloka_client.get_attachments(request) assert attachments == client.unstructure(list(result)) @@ -130,7 +130,7 @@ def get_attachments(request, context): owner_company_id='company-1', name='ExampleAttachment.txt', user_id='user-1', - created_gt=datetime.datetime(2000, 1, 1, 12, 57, 1), + created_gt=datetime.datetime(2000, 1, 1, 12, 57, 1, tzinfo=datetime.timezone.utc), ) assert attachments == client.unstructure(list(result)) diff --git a/tests/test_filter.py b/tests/test_filter.py index 571dd78f..8d808174 100644 --- a/tests/test_filter.py +++ b/tests/test_filter.py @@ -1,3 +1,5 @@ +import pickle +import copy import pytest from toloka.client.filter import Languages, FilterAnd, Skill @@ -22,3 +24,17 @@ def test_language_multiple(): def test_verified_language_multiple(): assert Languages.in_(['EN', 'RU'], verified=True) == FilterAnd([Languages.in_(['EN', 'RU']), Skill('26366').eq(100), Skill('26296').eq(100)]) + + +@pytest.mark.parametrize( + 'obj', [Languages.in_(['EN', 'RU'], verified=True), Languages.in_(['EN', 'RU'])] +) +def test_language_pickleable(obj): + assert obj == pickle.loads(pickle.dumps(obj)) + + +@pytest.mark.parametrize( + 'obj', [Languages.in_(['EN', 'RU'], verified=True), Languages.in_(['EN', 'RU'])] +) +def test_language_deepcopyable(obj): + assert obj == copy.deepcopy(obj) diff --git a/tests/test_message_thread.py b/tests/test_message_thread.py index 12c1c9a7..4eae7e0d 100644 --- a/tests/test_message_thread.py +++ b/tests/test_message_thread.py @@ -82,8 +82,8 @@ def message_threads(request, context): request = client.search_requests.MessageThreadSearchRequest( folder=client.message_thread.Folder.OUTBOX, folder_ne=client.message_thread.Folder.IMPORTANT, - created_gte=datetime.datetime(2015, 12, 1), - created_lt=datetime.datetime(2016, 6, 1), + created_gte=datetime.datetime(2015, 12, 1, tzinfo=datetime.timezone.utc), + created_lt=datetime.datetime(2016, 6, 1, tzinfo=datetime.timezone.utc), ) sort = client.search_requests.MessageThreadSortItems(['-created']) result = toloka_client.find_message_threads(request, sort=sort) @@ -93,8 +93,8 @@ def message_threads(request, context): result = toloka_client.find_message_threads( folder=client.message_thread.Folder.OUTBOX, folder_ne=client.message_thread.Folder.IMPORTANT, - created_gte=datetime.datetime(2015, 12, 1), - created_lt=datetime.datetime(2016, 6, 1), + created_gte=datetime.datetime(2015, 12, 1, tzinfo=datetime.timezone.utc), + created_lt=datetime.datetime(2016, 6, 1, tzinfo=datetime.timezone.utc), sort=['-created'], ) assert raw_result == client.unstructure(result) @@ -132,8 +132,8 @@ def get_message_threads(request, context): request = client.search_requests.MessageThreadSearchRequest( folder=client.message_thread.Folder.OUTBOX, folder_ne=client.message_thread.Folder.IMPORTANT, - created_gte=datetime.datetime(2015, 12, 1), - created_lt=datetime.datetime(2016, 6, 1), + created_gte=datetime.datetime(2015, 12, 1, tzinfo=datetime.timezone.utc), + created_lt=datetime.datetime(2016, 6, 1, tzinfo=datetime.timezone.utc), ) result = toloka_client.get_message_threads(request) assert threads == client.unstructure(list(result)) @@ -142,8 +142,8 @@ def get_message_threads(request, context): result = toloka_client.get_message_threads( folder=client.message_thread.Folder.OUTBOX, folder_ne=client.message_thread.Folder.IMPORTANT, - created_gte=datetime.datetime(2015, 12, 1), - created_lt=datetime.datetime(2016, 6, 1), + created_gte=datetime.datetime(2015, 12, 1, tzinfo=datetime.timezone.utc), + created_lt=datetime.datetime(2016, 6, 1, tzinfo=datetime.timezone.utc), ) assert threads == client.unstructure(list(result)) diff --git a/tests/test_project.py b/tests/test_project.py index bd60613d..d821f2a6 100644 --- a/tests/test_project.py +++ b/tests/test_project.py @@ -1,4 +1,4 @@ -from datetime import datetime +import datetime from operator import itemgetter from textwrap import dedent from urllib.parse import urlparse, parse_qs @@ -108,7 +108,7 @@ def find_projects(request, context): request = client.search_requests.ProjectSearchRequest( status=client.Project.ProjectStatus.ACTIVE, id_gt='123', - created_lt=datetime(2015, 12, 9, 12, 10, 0), + created_lt=datetime.datetime(2015, 12, 9, 12, 10, 0, tzinfo=datetime.timezone.utc), ) sort = client.search_requests.ProjectSortItems(['-public_name', 'id']) result = toloka_client.find_projects(request, sort=sort, limit=50) @@ -118,7 +118,7 @@ def find_projects(request, context): result = toloka_client.find_projects( status=client.Project.ProjectStatus.ACTIVE, id_gt='123', - created_lt=datetime(2015, 12, 9, 12, 10, 0), + created_lt=datetime.datetime(2015, 12, 9, 12, 10, 0, tzinfo=datetime.timezone.utc), limit=50, sort=['-public_name', 'id'] ) @@ -155,7 +155,7 @@ def get_projects(request, context): request = client.search_requests.ProjectSearchRequest( status=client.Project.ProjectStatus.ACTIVE, id_gt='123', - created_lt=datetime(2015, 12, 9, 12, 10, 0), + created_lt=datetime.datetime(2015, 12, 9, 12, 10, 0, tzinfo=datetime.timezone.utc), ) result = toloka_client.get_projects(request) assert expected_projects == client.unstructure(list(result)) @@ -164,7 +164,7 @@ def get_projects(request, context): result = toloka_client.get_projects( status=client.Project.ProjectStatus.ACTIVE, id_gt='123', - created_lt=datetime(2015, 12, 9, 12, 10, 0), + created_lt=datetime.datetime(2015, 12, 9, 12, 10, 0, tzinfo=datetime.timezone.utc), ) assert expected_projects == client.unstructure(list(result)) @@ -516,7 +516,7 @@ def update_project(request, context): max_active_assignments_count=5, id='10', status=client.project.Project.ProjectStatus.ACTIVE, - created=datetime.strptime('2015-12-09 12:10:00', '%Y-%m-%d %H:%M:%S'), + created=datetime.datetime(2015, 12, 9, 12, 10, 0, tzinfo=datetime.timezone.utc), ) result = toloka_client.update_project('10', update_to_project) @@ -675,23 +675,22 @@ def get_content(request, context): content=get_content, headers={'Authorization': 'OAuth abc'}, status_code=200) - result = toloka_client.get_assignments_df(pool_id=123, - parameters=client.assignment.GetAssignmentsTsvParameters( - start_time_from=datetime(2020, 1, 1), - exclude_banned=True, - status=[s for s in - client.assignment.GetAssignmentsTsvParameters.Status] - )) + result = toloka_client.get_assignments_df( + pool_id='123', + parameters=client.assignment.GetAssignmentsTsvParameters( + start_time_from=datetime.datetime(2020, 1, 1, tzinfo=datetime.timezone.utc), + exclude_banned=True, + status=[s for s in client.assignment.GetAssignmentsTsvParameters.Status] + ) + ) assert result.equals(expected_df) assert requests_mock.last_request.qs == expected_params - result = toloka_client.get_assignments_df(pool_id=123, - start_time_from=datetime(2020, 1, 1), - exclude_banned=True, - status=[s for s in - client.assignment.GetAssignmentsTsvParameters.Status] - ) + result = toloka_client.get_assignments_df( + pool_id='123', start_time_from=datetime.datetime(2020, 1, 1, tzinfo=datetime.timezone.utc), + exclude_banned=True, status=[s for s in client.assignment.GetAssignmentsTsvParameters.Status] + ) assert result.equals(expected_df) assert requests_mock.last_request.qs == expected_params diff --git a/tests/test_serialization.py b/tests/test_serialization.py new file mode 100644 index 00000000..effd1bd3 --- /dev/null +++ b/tests/test_serialization.py @@ -0,0 +1,30 @@ +import datetime + +import pytest +from toloka.client._converter import unstructure, structure + + +@pytest.mark.parametrize( + 'to_unstructure, result', + [ + (datetime.datetime(2022, 1, 1, tzinfo=datetime.timezone.utc), '2022-01-01T00:00:00'), + (datetime.datetime(2022, 1, 1, tzinfo=None), '2022-01-01T00:00:00'), + (datetime.datetime(2022, 1, 1, tzinfo=datetime.timezone(datetime.timedelta(hours=-3))), '2022-01-01T03:00:00'), + ] +) +def test_time_format_unstructure(to_unstructure, result): + assert unstructure(to_unstructure) == result + + +@pytest.mark.parametrize( + 'to_structure, result', + [ + ('2022-01-01T00:00:00', datetime.datetime(2022, 1, 1, tzinfo=datetime.timezone.utc)), + ('2022-01-01T00:00:00+00:00', datetime.datetime(2022, 1, 1, tzinfo=datetime.timezone.utc)), + ('2022-01-01T03:00:00', datetime.datetime(2022, 1, 1, tzinfo=datetime.timezone(datetime.timedelta(hours=-3)))), + (datetime.datetime(2022, 1, 1, tzinfo=None), datetime.datetime(2022, 1, 1, tzinfo=datetime.timezone.utc)), + (datetime.datetime(2022, 1, 1, tzinfo=datetime.timezone.utc), datetime.datetime(2022, 1, 1, tzinfo=datetime.timezone.utc)), + ] +) +def test_time_format_structure(to_structure, result): + assert structure(to_structure, datetime.datetime) == result diff --git a/tests/test_task.py b/tests/test_task.py index 9d648e5b..43d6e979 100644 --- a/tests/test_task.py +++ b/tests/test_task.py @@ -478,7 +478,7 @@ def tasks(request, context): # Request object syntax request = client.search_requests.TaskSearchRequest( pool_id=21, - created_gt=datetime.datetime(2001, 1, 1, 12, 0, 0), + created_gt=datetime.datetime(2001, 1, 1, 12, 0, 0, tzinfo=datetime.timezone.utc), overlap_gte=42, ) sort = client.search_requests.TaskSortItems(['id', '-created']) @@ -488,7 +488,7 @@ def tasks(request, context): # Expanded syntax result = toloka_client.find_tasks( pool_id=21, - created_gt=datetime.datetime(2001, 1, 1, 12, 0, 0), + created_gt=datetime.datetime(2001, 1, 1, 12, 0, 0, tzinfo=datetime.timezone.utc), overlap_gte=42, sort=['id', '-created'], limit=20, @@ -525,7 +525,7 @@ def get_tasks(request, context): # Request object syntax request = client.search_requests.TaskSearchRequest( pool_id=21, - created_gt=datetime.datetime(2001, 1, 1, 12, 0, 0), + created_gt=datetime.datetime(2001, 1, 1, 12, 0, 0, tzinfo=datetime.timezone.utc), overlap_gte=42, ) result = toloka_client.get_tasks(request) @@ -534,7 +534,7 @@ def get_tasks(request, context): # Expanded syntax result = toloka_client.get_tasks( pool_id=21, - created_gt=datetime.datetime(2001, 1, 1, 12, 0, 0), + created_gt=datetime.datetime(2001, 1, 1, 12, 0, 0, tzinfo=datetime.timezone.utc), overlap_gte=42, ) assert tasks == client.unstructure(list(result)) diff --git a/tests/test_task_suite.py b/tests/test_task_suite.py index 2cd3e986..2ad0b6e7 100644 --- a/tests/test_task_suite.py +++ b/tests/test_task_suite.py @@ -404,7 +404,7 @@ def task_suites(request, context): # Request object syntax request = client.search_requests.TaskSuiteSearchRequest( pool_id=21, - created_lte=datetime.datetime(2020, 2, 1), + created_lte=datetime.datetime(2020, 2, 1, tzinfo=datetime.timezone.utc), overlap_gte=42, ) sort = client.search_requests.TaskSuiteSortItems(['-created']) @@ -414,7 +414,7 @@ def task_suites(request, context): # Expanded syntax result = toloka_client.find_task_suites( pool_id=21, - created_lte=datetime.datetime(2020, 2, 1), + created_lte=datetime.datetime(2020, 2, 1, tzinfo=datetime.timezone.utc), overlap_gte=42, sort=['-created'], limit=100, @@ -452,7 +452,7 @@ def get_task_suites(request, context): # Request object syntax request = client.search_requests.TaskSuiteSearchRequest( pool_id=21, - created_lte=datetime.datetime(2020, 2, 1), + created_lte=datetime.datetime(2020, 2, 1, tzinfo=datetime.timezone.utc), overlap_gte=42, ) result = toloka_client.get_task_suites(request) @@ -461,7 +461,7 @@ def get_task_suites(request, context): # Expanded syntax result = toloka_client.get_task_suites( pool_id=21, - created_lte=datetime.datetime(2020, 2, 1), + created_lte=datetime.datetime(2020, 2, 1, tzinfo=datetime.timezone.utc), overlap_gte=42, ) assert task_suites == client.unstructure(list(result)) diff --git a/tests/test_training.py b/tests/test_training.py index 99f23e44..c68efc21 100644 --- a/tests/test_training.py +++ b/tests/test_training.py @@ -82,7 +82,7 @@ def trainings(request, context): request = client.search_requests.TrainingSearchRequest( project_id='10', id_gt='20', - last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0), + last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0, tzinfo=datetime.timezone.utc), ) sort = client.search_requests.TrainingSortItems(['created', '-id']) result = toloka_client.find_trainings(request, sort=sort) @@ -92,7 +92,7 @@ def trainings(request, context): result = toloka_client.find_trainings( project_id='10', id_gt='20', - last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0), + last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0, tzinfo=datetime.timezone.utc), sort=['created', '-id'], ) assert raw_result == client.unstructure(result) @@ -128,7 +128,7 @@ def get_trainings(request, context): request = client.search_requests.TrainingSearchRequest( project_id='10', id_gt='20', - last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0), + last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0, tzinfo=datetime.timezone.utc), ) result = toloka_client.get_trainings(request) assert expected_trainings == client.unstructure(list(result)) @@ -137,7 +137,7 @@ def get_trainings(request, context): result = toloka_client.get_trainings( project_id='10', id_gt='20', - last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0), + last_started_lt=datetime.datetime(2016, 3, 23, 12, 59, 0, tzinfo=datetime.timezone.utc), ) assert expected_trainings == client.unstructure(list(result)) diff --git a/tests/test_user_bonus.py b/tests/test_user_bonus.py index 354d92d8..6f8aa5bc 100644 --- a/tests/test_user_bonus.py +++ b/tests/test_user_bonus.py @@ -242,7 +242,7 @@ def user_bonuses(request, context): # Request object syntax request = client.search_requests.UserBonusSearchRequest( user_id='user-1', - created_gte=datetime.datetime(2012, 1, 1, 12, 0, 0) + created_gte=datetime.datetime(2012, 1, 1, 12, 0, 0, tzinfo=datetime.timezone.utc) ) sort = client.search_requests.UserBonusSortItems(['created', '-id']) result = toloka_client.find_user_bonuses(request, sort=sort, limit=20) @@ -251,7 +251,7 @@ def user_bonuses(request, context): # Expanded syntax result = toloka_client.find_user_bonuses( user_id='user-1', - created_gte=datetime.datetime(2012, 1, 1, 12, 0, 0), + created_gte=datetime.datetime(2012, 1, 1, 12, 0, 0, tzinfo=datetime.timezone.utc), sort=['created', '-id'], limit=20, ) @@ -286,7 +286,7 @@ def get_user_bonuses(request, context): # Request object syntax request = client.search_requests.UserBonusSearchRequest( user_id='user-1', - created_gte=datetime.datetime(2012, 1, 1, 12, 0, 0) + created_gte=datetime.datetime(2012, 1, 1, 12, 0, 0, tzinfo=datetime.timezone.utc) ) result = toloka_client.get_user_bonuses(request) assert user_bonuses == client.unstructure(list(result)) @@ -294,7 +294,7 @@ def get_user_bonuses(request, context): # Expanded syntax result = toloka_client.get_user_bonuses( user_id='user-1', - created_gte=datetime.datetime(2012, 1, 1, 12, 0, 0), + created_gte=datetime.datetime(2012, 1, 1, 12, 0, 0, tzinfo=datetime.timezone.utc), ) assert user_bonuses == client.unstructure(list(result)) diff --git a/tests/test_user_restriction.py b/tests/test_user_restriction.py index cf960b97..cb8d8ef7 100644 --- a/tests/test_user_restriction.py +++ b/tests/test_user_restriction.py @@ -52,7 +52,7 @@ def user_restrictions(request, context): request = client.search_requests.UserRestrictionSearchRequest( scope=client.user_restriction.UserRestriction.PROJECT, id_gt='123', - created_lte=datetime.datetime(2017, 12, 9, 12, 10, 0), + created_lte=datetime.datetime(2017, 12, 9, 12, 10, 0, tzinfo=datetime.timezone.utc), ) sort = client.search_requests.UserRestrictionSortItems(['-created', 'id']) result = toloka_client.find_user_restrictions(request, sort=sort, limit=50) @@ -62,7 +62,7 @@ def user_restrictions(request, context): result = toloka_client.find_user_restrictions( scope=client.user_restriction.UserRestriction.PROJECT, id_gt='123', - created_lte=datetime.datetime(2017, 12, 9, 12, 10, 0), + created_lte=datetime.datetime(2017, 12, 9, 12, 10, 0, tzinfo=datetime.timezone.utc), sort=['-created', 'id'], limit=50, ) @@ -114,7 +114,7 @@ def get_user_restrictions(request, context): request = client.search_requests.UserRestrictionSearchRequest( scope=client.user_restriction.UserRestriction.PROJECT, id_gt='123', - created_lte=datetime.datetime(2017, 12, 9, 12, 10, 0), + created_lte=datetime.datetime(2017, 12, 9, 12, 10, 0, tzinfo=datetime.timezone.utc), ) result = toloka_client.get_user_restrictions(request) assert restrictions == client.unstructure(list(result)) @@ -123,7 +123,7 @@ def get_user_restrictions(request, context): result = toloka_client.get_user_restrictions( scope=client.user_restriction.UserRestriction.PROJECT, id_gt='123', - created_lte=datetime.datetime(2017, 12, 9, 12, 10, 0), + created_lte=datetime.datetime(2017, 12, 9, 12, 10, 0, tzinfo=datetime.timezone.utc), ) assert restrictions == client.unstructure(list(result)) diff --git a/tests/test_user_skill.py b/tests/test_user_skill.py index d678d2d6..24f01f56 100644 --- a/tests/test_user_skill.py +++ b/tests/test_user_skill.py @@ -64,8 +64,8 @@ def user_skills(request, context): # Request object syntax request = client.search_requests.UserSkillSearchRequest( skill_id='skill-i1d', - created_gt=datetime.datetime(2016, 3, 25), - modified_lt=datetime.datetime(2017, 3, 25), + created_gt=datetime.datetime(2016, 3, 25, tzinfo=datetime.timezone.utc), + modified_lt=datetime.datetime(2017, 3, 25, tzinfo=datetime.timezone.utc), ) sort = client.search_requests.UserSkillSortItems(['id']) result = toloka_client.find_user_skills(request, sort=sort, limit=100) @@ -74,8 +74,8 @@ def user_skills(request, context): # Expanded syntax result = toloka_client.find_user_skills( skill_id='skill-i1d', - created_gt=datetime.datetime(2016, 3, 25), - modified_lt=datetime.datetime(2017, 3, 25), + created_gt=datetime.datetime(2016, 3, 25, tzinfo=datetime.timezone.utc), + modified_lt=datetime.datetime(2017, 3, 25, tzinfo=datetime.timezone.utc), sort=['id'], limit=100, ) @@ -111,8 +111,8 @@ def get_user_skills(request, context): # Request object syntax request = client.search_requests.UserSkillSearchRequest( skill_id='skill-i1d', - created_gt=datetime.datetime(2016, 3, 25), - modified_lt=datetime.datetime(2017, 3, 25), + created_gt=datetime.datetime(2016, 3, 25, tzinfo=datetime.timezone.utc), + modified_lt=datetime.datetime(2017, 3, 25, tzinfo=datetime.timezone.utc), ) result = toloka_client.get_user_skills(request) assert user_skills == client.unstructure(list(result)) @@ -120,8 +120,8 @@ def get_user_skills(request, context): # Expanded syntax result = toloka_client.get_user_skills( skill_id='skill-i1d', - created_gt=datetime.datetime(2016, 3, 25), - modified_lt=datetime.datetime(2017, 3, 25), + created_gt=datetime.datetime(2016, 3, 25, tzinfo=datetime.timezone.utc), + modified_lt=datetime.datetime(2017, 3, 25, tzinfo=datetime.timezone.utc), ) assert user_skills == client.unstructure(list(result))