Создать пул
Важно
Домен toloka.yandex.com
работает в режиме deprecated. Рекомендуем переключиться на домен toloka.dev
для запросов API.
Создает пул.
Созданному пулу автоматически присваивается идентификатор.
Ограничение
Вы можете отправить не более 20 таких запросов в минуту и не более 100 в день.
Примечание
О создании обучающего пула читайте в разделе Создать обучение.
Запрос
POST https://toloka.dev/api/v1/pools
Authorization: OAuth <OAuth token>
Content-Type: application/JSON
POST https://sandbox.toloka.dev/api/v1/pools
Authorization: OAuth <OAuth token>
Content-Type: application/JSON
Заголовки
Заголовок | Описание |
---|---|
Authorization | Токен для авторизации аккаунта. В качестве префикса добавьте OAuth. |
Content-Type | Указывает формат данных в передаваемом теле запроса. |
Тело запроса
{
"project_id": "1",
"private_name": "My first pool",
"private_comment": "This is my first pool",
"public_description": "Pool's description ",
"may_contain_adult_content": false,
"will_expire": "2020-09-01T13:00",
"reward_per_assignment": 0.02,
"dynamic_pricing_config": {
"type": "SKILL",
"skill_id": "1289",
"intervals": [
{
"from": 0,
"to": 60,
"reward_per_assignment": 0.03
},
{
"from": 61,
"to": 100,
"reward_per_assignment": 0.04
}
]
},
"assignment_max_duration_seconds": 300,
"auto_accept_solutions": true,
"auto_accept_period_day": 7,
"auto_close_after_complete_delay_seconds": 60,
"assignments_issuing_config": {
"issue_task_suites_in_creation_order": false
},
"filter": {<settings for filtering users>},
"quality_control": {
"training_requirement": {
"training_pool_id": "21",
"training_passing_skill_value": 70
},
"captcha_frequency": "LOW",
"configs": {<quality control rule settings>},
"checkpoints_config": {
"real_settings": {
"target_overlap": 5,
"task_distribution_function": {
"scope": "PROJECT",
"distribution": "UNIFORM",
"window_days": 7,
"intervals": [
{
"from": 1,
"to": 100,
"frequency": 5
},
{
"from": 101,
"to": 1000,
"frequency": 25
}
]
}
},
"golden_settings": {
"target_overlap": 5,
"task_distribution_function": {
"scope": "PROJECT",
"distribution": "UNIFORM",
"window_days": 7,
"intervals": [
{
"from": 1,
"to": 100,
"frequency": 5
},
{
"from": 101,
"to": 1000,
"frequency": 25
}
]
}
},
"training_settings": {
"target_overlap": 5,
"task_distribution_function": {
"scope": "PROJECT",
"distribution": "UNIFORM",
"window_days": 7,
"intervals": [
{
"from": 1,
"to": 100,
"frequency": 5
},
{
"from": 101,
"to": 1000,
"frequency": 25
}
]
}
}
}
},
"speed_quality_balance": {
"type": "TOP_PERCENTAGE_BY_QUALITY",
"percent": 80
},
"dynamic_overlap_config": {
"type": "BASIC",
"max_overlap": 5,
"min_confidence": 0.9,
"answer_weight_skill_id": "1289",
"fields": [
{
"name": "result"
}
]
},
"defaults" : {
"default_overlap_for_new_task_suites" : 3,
"default_overlap_for_new_tasks": 3
},
"mixer_config": {
"real_tasks_count": 6,
"golden_tasks_count": 1,
"training_tasks_count": 1,
"min_real_tasks_count": 2,
"min_golden_tasks_count": 0,
"min_training_tasks_count": 0,
"force_last_assignment": true,
"force_last_assignment_delay_seconds": 10,
"mix_tasks_in_creation_order": true,
"shuffle_tasks_in_task_suite": false,
"golden_task_distribution_function": {
"scope": "PROJECT",
"distribution": "UNIFORM",
"window_days": 7 ,
"intervals": [
{
"from": 1,
"to": 25,
"frequency": 5
},
{
"from": 26,
"to": 1000,
"frequency": 25
}
]
},
"training_task_distribution_function": {
"scope": "PROJECT",
"distribution": "UNIFORM",
"window_days": 7,
"intervals": [
{
"from": 1,
"to": 25,
"frequency": 5
},
{
"from": 26,
"to": 1000,
"frequency": 25
}
]
}
},
"priority": 10
}
Параметр |
Описание |
project_id |
string | обязательный Идентификатор проекта, для которого создан пул. |
private_name |
string | обязательный Название пула (доступно только заказчику). |
may_contain_adult_content |
boolean | обязательный Присутствие контента для взрослых в заданиях. |
will_expire |
string | обязательный Дата и время по UTC, когда пул нужно закрыть (даже если не все страницы заданий выполнены). Формат даты ISO 8601: |
reward_per_assignment |
float | обязательный Плата за страницу заданий в долларах США. Для центов используйте точку («.») в качестве разделителя. Минимальная плата составляет 0,005 $. В пулы с нулевой ценой можно загружать только обучающие и контрольные задания. |
defaults |
object | обязательный Настройки, которые применяются по умолчанию при загрузке новых страниц заданий в пул. |
defaults.default_overlap_ for_new_task_suites |
integer | обязательный Перекрытие для страниц заданий, которые загружаются в пул (используется, если при загрузке указан параметр |
defaults.default_overlap_ for_new_tasks |
integer Перекрытие для заданий, которые загружаются в пул (используется, если при загрузке указан параметр |
assignment_max_duration_ seconds |
integer | обязательный Время на выполнение страницы заданий в секундах. Невыполненные задания перераспределяются другим исполнителям. Рекомендуется выделять на страницу заданий не менее 60 секунд (с учетом времени на загрузку страницы, отправку ответов). |
dynamic_pricing_config.type |
string | обязательный при условии Обязателен, если используется динамическое ценообразование. Тип параметра для расчета динамического ценообразования. Значение |
dynamic_pricing_config. skill_id |
string | обязательный при условии Обязателен, если используется динамическое ценообразование. Идентификатор навыка, по уровню которого рассчитывается плата за задание. |
dynamic_pricing_config. intervals[] |
array of objects | обязательный при условии Обязателен, если используется динамическое ценообразование. Интервалы уровней навыка. Не должны пересекаться. Исполнитель с уровнем навыка, не входящим ни в один интервал, получит базовую цену за страницу заданий. |
dynamic_pricing_config. intervals[].from |
integer | обязательный при условии Обязателен, если используется динамическое ценообразование. Нижняя граница интервала. Может принимать значения от 0 до 100. По умолчанию |
dynamic_pricing_config. intervals[].to |
integer | обязательный при условии Обязателен, если используется динамическое ценообразование. Верхняя граница интервала. Может принимать значения от 0 до 100. По умолчанию |
dynamic_pricing_config. intervals[].reward_per_ assignment |
float | обязательный при условии Обязателен, если используется динамическое ценообразование. Цена за страницу заданий для исполнителя с указанным уровнем навыка. |
quality_control. checkpoints_config. real_settings. target_overlap |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Перекрытие в заданиях с выборочной проверкой. |
quality_control. checkpoints_config. real_settings. task_distribution_function |
object | обязательный при условии Обязателен, если используется выборочная проверка. Распределение заданий с выборочной проверкой. Подробнее о том, как выдаются проверочные задания, читайте в Руководстве заказчика. |
quality_control. checkpoints_config. real_settings. task_distribution_function. scope |
string | обязательный при условии Обязателен, если используется выборочная проверка. Подсчет заданий, выполненных исполнителем:
|
quality_control. checkpoints_config. real_settings. task_distribution_function. distribution |
string | обязательный при условии Обязателен, если используется выборочная проверка. Распределение заданий с выборочной проверкой внутри интервала. У параметра одно возможное значение — |
quality_control. checkpoints_config. real_settings. task_distribution_function. window_days |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Период, за который нужно подсчитывать выполненные задания (количество дней). |
quality_control. checkpoints_config. real_settings. task_distribution_function. intervals[] |
array of objects | обязательный при условии Обязателен, если используется выборочная проверка. Границы интервалов и частота выдачи заданий с выборочной проверкой. |
quality_control. checkpoints_config. real_settings. task_distribution_function. intervals[].from |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Начало интервала (номер задания, выполненного исполнителем в проекте или пуле). |
quality_control. checkpoints_config. real_settings. task_distribution_function. intervals[].to |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Конец интервала (номер задания, выполненного исполнителем в проекте или пуле). |
quality_control. checkpoints_config. real_settings. task_distribution_function. intervals[].frequency |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Частота выдачи заданий с выборочной проверкой в интервале. Первое задание в интервале проверочное. Например, при значении |
quality_control. checkpoints_config. golden_settings. target_overlap |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Перекрытие в контрольных заданиях с выборочной проверкой. |
quality_control. checkpoints_config. golden_settings. task_distribution_function |
object | обязательный при условии Обязателен, если используется выборочная проверка. Распределение контрольных заданий с выборочной проверкой. |
quality_control. checkpoints_config. golden_settings. task_distribution_function. scope |
string | обязательный при условии Обязателен, если используется выборочная проверка. Подсчет заданий, выполненных исполнителем:
|
quality_control. checkpoints_config. golden_settings. task_distribution_function. distribution |
string | обязательный при условии Обязателен, если используется выборочная проверка. Распределение контрольных заданий с выборочной проверкой внутри интервала. У параметра одно возможное значение — |
quality_control. checkpoints_config. golden_settings. task_distribution_function. window_days |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Период, за который нужно подсчитывать выполненные задания (количество дней). |
quality_control. checkpoints_config. golden_settings. task_distribution_function. intervals[] |
array of objects | обязательный при условии Обязателен, если используется выборочная проверка. Границы интервалов и частота выдачи контрольных заданий с выборочной проверкой. |
quality_control. checkpoints_config. golden_settings. task_distribution_function. intervals[].from |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Начало интервала (номер задания, выполненного исполнителем в проекте или пуле). |
quality_control. checkpoints_config. golden_settings. task_distribution_function. intervals[].to |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Конец интервала (номер задания, выполненного исполнителем в проекте или пуле). |
quality_control. checkpoints_config. golden_settings. task_distribution_function. intervals[].frequency |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Частота выдачи контрольных заданий с выборочной проверкой в интервале. Первое задание в интервале проверочное. Например, при значении |
quality_control. checkpoints_config. training_settings. target_overlap |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Перекрытие в обучающих заданиях с выборочной проверкой. |
quality_control. checkpoints_config. training_settings. task_distribution_function |
object | обязательный при условии Обязателен, если используется выборочная проверка. Распределение обучающих заданий с выборочной проверкой. |
quality_control. checkpoints_config. training_settings. task_distribution_function. scope |
string | обязательный при условии Обязателен, если используется выборочная проверка. Подсчет заданий, выполненных исполнителем:
|
quality_control. checkpoints_config. training_settings. task_distribution_function. distribution |
string | обязательный при условии Обязателен, если используется выборочная проверка. Распределение обучающих заданий с выборочной проверкой внутри интервала. У параметра одно возможное значение — |
quality_control. checkpoints_config. training_settings. task_distribution_function. window_days |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Период, за который нужно подсчитывать выполненные задания (количество дней). |
quality_control. checkpoints_config. training_settings. task_distribution_function. intervals[] |
array of objects | обязательный при условии Обязателен, если используется выборочная проверка. Границы интервалов и частота выдачи обучающих заданий с выборочной проверкой. |
quality_control. checkpoints_config. training_settings. task_distribution_function. intervals[].from |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Начало интервала (номер задания, выполненного исполнителем в проекте или пуле). |
quality_control. checkpoints_config. training_settings. task_distribution_function. intervals[].to |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Конец интервала (номер задания, выполненного исполнителем в проекте или пуле). |
quality_control. checkpoints_config. training_settings. task_distribution_function. intervals[].frequency |
integer | обязательный при условии Обязателен, если используется выборочная проверка. Частота выдачи обучающих заданий с выборочной проверкой в интервале. Первое задание в интервале проверочное. Например, при значении |
dynamic_overlap_config.type |
string | обязательный при условии Обязателен, если используется динамическое перекрытие. Алгоритм динамического перекрытия.
Необходимо указать |
dynamic_overlap_config. max_overlap |
integer | обязательный при условии Обязателен, если используется динамическое перекрытие. Максимальное перекрытие. Должно превышать значения в |
dynamic_overlap_config. min_confidence |
float | обязательный при условии Обязателен, если используется динамическое перекрытие. Минимальная достоверность агрегированного ответа. Значения от 0 до 1. |
dynamic_overlap_config. answer_weight_skill_id |
string | обязательный при условии Обязателен, если используется динамическое перекрытие. Навык, который определяет вес ответа исполнителя. Для получения наилучших результатов используйте навык, значение которого вычисляется как доля правильных ответов на контрольные заданий. |
dynamic_overlap_config. fields[] |
array of objects | обязательный при условии Обязателен, если используется динамическое перекрытие. Поля выходных данных, ответы на которые будут агрегированы. Для получения наилучших результатов каждое из этих полей должно иметь ограниченное количество вариантов ответа. Не указывайте несколько полей, если их значения зависят друг от друга. |
dynamic_overlap_config. fields.name |
string | обязательный при условии Обязателен, если используется динамическое перекрытие. Имя поля выходных данных. |
mixer_config |
object | обязательный при условии Обязателен, если используется «умное смешивание». Параметры для автоматического создания страниц заданий («умное смешивание»). Подробнее о формировании страниц заданий см. в документе Руководство заказчика. |
mixer_config. real_tasks_count |
integer | обязательный при условии Обязателен, если используется «умное смешивание». Количество основных заданий на странице. Максимальное количество заданий на странице, если используется |
mixer_config. golden_tasks_count |
integer | обязательный при условии Обязателен, если используется «умное смешивание». Количество контрольных заданий на странице. |
mixer_config. training_tasks_count |
integer | обязательный при условии Обязателен, если используется «умное смешивание». Количество обучающих заданий на странице. |
mixer_config.golden_task_ distribution_function.scope |
string | обязательный при условии Обязателен, если используется выдача контрольных заданий с неравномерной частотой. Подсчет заданий, выполненных исполнителем:
|
mixer_config.golden_task_ distribution_function. distribution |
string | обязательный при условии Обязателен, если используется выдача контрольных заданий с неравномерной частотой. Распределение контрольных заданий внутри интервала. У параметра одно возможное значение — |
mixer_config.golden_task_ distribution_function. window_days |
integer | обязательный при условии Обязателен, если используется выдача контрольных заданий с неравномерной частотой. Период, за который нужно подсчитывать выполненные задания (количество дней). |
mixer_config.golden_task_ distribution_function. intervals[] |
array of objects | обязательный при условии Обязателен, если используется выдача контрольных заданий с неравномерной частотой. Границы интервалов и количество контрольных заданий в интервале. |
mixer_config.golden_task_ distribution_function. intervals[].from |
integer | обязательный при условии Обязателен, если используется выдача контрольных заданий с неравномерной частотой. Начало интервала (номер задания, выполненного исполнителем в проекте или пуле). |
mixer_config.golden_task_ distribution_function. intervals[].to |
integer | обязательный при условии Обязателен, если используется выдача контрольных заданий с неравномерной частотой. Конец интервала (номер задания, выполненного исполнителем в проекте или пуле). |
mixer_config.golden_task_ distribution_function. intervals[].frequency |
integer | обязательный при условии Обязателен, если используется выдача контрольных заданий с неравномерной частотой. Частота выдачи контрольных заданий в интервале. Первое задание в интервале контрольное. Например, при значении |
mixer_config.training_task_ distribution_function.scope |
string | обязательный при условии Обязателен, если используется выдача обучающих заданий с неравномерной частотой. Подсчет заданий, выполненных исполнителем:
|
mixer_config.training_task_ distribution_function. distribution |
string | обязательный при условии Обязателен, если используется выдача обучающих заданий с неравномерной частотой. Распределение обучающих заданий внутри интервала. У параметра одно возможное значение — |
mixer_config.training_task_ distribution_function. window_days |
integer | обязательный при условии Обязателен, если используется выдача обучающих заданий с неравномерной частотой. Период, за который нужно подсчитывать выполненные задания (количество дней). |
mixer_config.training_task_ distribution_function. intervals[] |
array of objects | обязательный при условии Обязателен, если используется выдача обучающих заданий с неравномерной частотой. Границы интервалов и количество контрольных заданий в интервале. |
mixer_config.training_task_ distribution_function. intervals[].from |
integer | обязательный при условии Обязателен, если используется выдача обучающих заданий с неравномерной частотой Начало интервала (номер задания, выполненного исполнителем в проекте или пуле). Да, если используется выдача обучающих заданий с неравномерной частотой |
mixer_config.training_task_ distribution_function. intervals[].to |
integer | обязательный при условии Обязателен, если используется выдача обучающих заданий с неравномерной частотой. Конец интервала (номер задания, выполненного исполнителем в проекте или пуле). |
mixer_config.training_task_ distribution_function. intervals[].frequency |
integer | обязательный при условии Обязателен, если используется выдача обучающих заданий с неравномерной частотой. Частота выдачи обучающих заданий в интервале. Первое задание в интервале обучающее. Например, при значении |
private_comment |
string Комментарий к пулу (доступен только заказчику). |
public_description |
string Описание для исполнителей. Если заполнено, то текст будет отображаться вместо |
dynamic_pricing_config |
object Настройки динамического ценообразования. |
auto_accept_solutions |
boolean Необходимость проверки заданий вручную:
По умолчанию значение |
auto_accept_period_day |
integer Время (количество дней) проверки задания заказчиком. Если заказчик не примет или не отклонит задание за данный срок, то решение будет принято автоматически. Может принимать значение от 1 до 21. |
auto_close_after_complete_ delay_seconds |
integer Время ожидания (в секундах) перед автоматическим закрытием пула, после того как все задания выполнены. Минимум — 0, максимум — 259 200 секунд (трое суток). По умолчанию значение 0. Используйте, если:
|
assignments_issuing_config |
object Настройки выдачи заданий в пуле. |
assignments_issuing_config. issue_task_suites_in_ creation_order |
boolean Для пулов, которые не используют «умное смешивание» . Выдача страниц заданий в порядке, в котором они были загружены. Например, для пула с перекрытием 5 сначала будет выдана первая страница заданий пяти исполнителям, затем вторая и так далее. Параметр можно использовать, если в проекте |
priority |
integer Приоритет пула среди других пулов проекта с такой же стоимостью заданий и набором фильтров. Сначала исполнителям выдаются задания с большим приоритетом. Возможные значения: от По умолчанию значение |
filter |
object Настройки фильтров для отбора исполнителей. |
quality_control |
object Настройки блоков контроля качества и идентификатор пула с обучающими заданиями. |
quality_control. training_requirement |
object Параметры обучающего пула, который привязан к пулу с основными заданиями. |
quality_control. training_requirement. training_pool_id |
string Идентификатор обучающего пула, который привязан к пулу с основными заданиями. |
quality_control. training_requirement. training_passing_skill_value |
integer Доля правильных ответов в обучающих заданиях (от 0 до 100), необходимая для допуска к основным заданиям. Для подсчета используются первые ответы исполнителя в заданиях. |
quality_control. captcha_frequency |
string Частота показа капчи:
По умолчанию капча не показывается. |
quality_control.configs |
object |
quality_control. checkpoints_config |
object Выборочная проверка заданий. Если вы хотите, чтобы проверка происходила методом мнение большинства, укажите Вы можете сокращать частоту проверок со временем. Пример настроек: в первых 100 заданиях, выполненных исполнителем в пуле, выдавать каждое пятое задание с перекрытием «5», чтобы сверить ответы. В последующих заданиях выдавать каждое 25 задание с перекрытием «5». |
quality_control. checkpoints_config. real_settings |
object Выборочная проверка обычных заданий. Чтобы выборочная проверка работала, не забудьте настроить показ заданий в mixer_config. |
quality_control. checkpoints_config. golden_settings |
object Выборочная проверка контрольных заданий. Чтобы выборочная проверка работала, не забудьте настроить показ этого типа заданий в mixer_config. |
quality_control. checkpoints_config. training_settings |
object Выборочная проверка обучающих заданий. Чтобы выборочная проверка работала, не забудьте настроить показ этого типа заданий в mixer_config. |
speed_quality_balance |
object |
speed_quality_balance. type |
string Тип соотношения. Может принимать значения:
|
speed_quality_balance. percent |
integer Процент исполнителей с лучшим качеством выполнения заданий. Поле появляется, если указан тип соотношения |
speed_quality_balance. count |
integer Количество активных исполнителей, которым доступно задание. Поле появляется, если указан тип соотношения |
dynamic_overlap_config |
object Настройка динамического перекрытия (incremental relabeling, IRL). Позволяет изменять перекрытие в зависимости от того, насколько хорошо исполнители справляются с заданием. Установите интервал закрытия ( Когда все задания в пуле будут выполнены, агрегируйте ответы. |
mixer_config. min_real_tasks_count |
float Минимальное количество основных заданий на странице (если не набирается число, указанное в |
mixer_config. min_golden_tasks_count |
integer Минимальное количество контрольных заданий на странице (если не набирается число, указанное в |
mixer_config. min_training_tasks_count |
integer Минимальное количество обучающих заданий на странице (если не набирается число, указанное в |
mixer_config. force_last_assignment |
boolean Настройка для последней страницы заданий в пуле, если невыполненных основных заданий осталось меньше минимума (
По умолчанию значение Параметр распространяется только на основные задания. Количество контрольных и обучающих заданий на последней странице должно быть полным ( |
mixer_config.force_last_ assignment_ delay_seconds |
integer Время ожидания (в секундах) с момента добавления задания или увеличения перекрытия до выдачи последней страницы заданий в пуле. Минимум — 0, максимум — 86 400 секунд (одни сутки). Параметр можно использовать, если в пуле |
mixer_config.mix_tasks_ in_creation_ order |
boolean Порядок, в котором задания включаются в страницы:
По умолчанию значение |
mixer_config. shuffle_tasks_in_task_suite |
boolean Порядок заданий внутри страницы заданий:
По умолчанию значение |
mixer_config.golden_task_ distribution_function |
object Выдача контрольных заданий с неравномерной частотой. Позволяет изменять частоту проверки по мере выполнения заданий исполнителем. Если заполнено, то в Граница интервала — номер задания в пуле. Если на странице заданий несколько интервалов, то к странице будет применена настройка первого интервала. Пример:На первой странице заданий (интервал от 1 до 25) каждое пятое задание будет контрольным, на последующих страницах — каждое 25-е задание. |
mixer_config.training_task_ distribution_function |
object Выдача обучающих заданий с неравномерной частотой. Позволяет менять частоту обучающих заданий по мере выполнения заданий исполнителем. Если заполнено, то в Пример:На первой странице заданий (интервал от 1 до 25) каждое пятое задание будет обучающим, на последующих страницах — каждое 25-е задание. |
Ответ
Содержит сведения о созданном пуле. Помимо параметров, которые задаются при создании пула, включает параметры, которые присваиваются пулу автоматически:
Параметр |
Описание |
id |
string Идентификатор пула. |
status |
string Статус пула:
|
last_close_reason |
string Причина, по которой пул был закрыт в последний раз:
|
created |
string Дата и время создания пула по UTC в формате ISO 8601: |
last_started |
string Дата и время последнего запуска пула по UTC в формате ISO 8601: |
last_stopped |
string Дата и время последней остановки пула по UTC в формате ISO 8601: |
type |
string Устаревший параметр. Тип пула. Всегда имеет значение |