Возможности API

  1. На уровне проекта
  2. На уровне пула
  3. На уровне страницы заданий
  4. На уровне задания
  5. Агрегация ответов на одно задание
  6. Отслеживание операций

У Яндекс.Толоки есть ряд возможностей, которыми можно воспользоваться через API, но нельзя через интерфейс. В этом документе кратко описаны ключи, использующиеся на разных этапах работы в Толоке.

На уровне проекта

Ключ

Значение

Когда использовать

assignments_automerge_enabled
Разрешить слияние идентичных заданий в проекте. Настройка пригодится, если есть вероятность, что одно и то же задание (с полностью идентичными входными данными ) будет загружено в разные пулы. В таком случае можно сэкономить средства за счет слияния.
max_active_assignments_count
Количество страниц, которые пользователь может одновременно выполнять. Эта настройка пригодится в полевых заданиях. С ней исполнители могут резервировать задания, по умолчанию до 30 заданий. Например, чтобы зарезервировать все доступные задания возле себя. Вы можете ограничить количество заданий, которое сможет зарезервировать один исполнитель.

Ключ

Значение

Когда использовать

assignments_automerge_enabled
Разрешить слияние идентичных заданий в проекте. Настройка пригодится, если есть вероятность, что одно и то же задание (с полностью идентичными входными данными ) будет загружено в разные пулы. В таком случае можно сэкономить средства за счет слияния.
max_active_assignments_count
Количество страниц, которые пользователь может одновременно выполнять. Эта настройка пригодится в полевых заданиях. С ней исполнители могут резервировать задания, по умолчанию до 30 заданий. Например, чтобы зарезервировать все доступные задания возле себя. Вы можете ограничить количество заданий, которое сможет зарезервировать один исполнитель.

Подробнее о возможностях API на уровне проекта.

На уровне пула

Ключ

Значение

Когда использовать

mixer_config.golden_task_distribution_function

Выдача контрольных заданий с неравномерной частотой. Позволяет изменять частоту проверки по мере выполнения заданий пользователем.

Эту настройку можно использовать, чтобы снижать частоту выдачи контрольных заданий по мере того, как пользователь выполняет задания и становится более опытным. В таком случае пользователю можно доверять, и уменьшение количества контрольных заданий будет экономить ресурсы.

mixer_config.training_task_distribution_function

Выдача обучающих заданий с неравномерной частотой. Позволяет менять частоту обучающих заданий по мере выполнения заданий пользователем.

Эту настройку можно использовать, чтобы снижать частоту выдачи обучающих заданий по мере того, как пользователь выполняет задания и становится более опытным. В таком случае пользователю можно доверять, и уменьшение количества обучающих заданий будет экономить ресурсы.

Ключ

Значение

Когда использовать

mixer_config.golden_task_distribution_function

Выдача контрольных заданий с неравномерной частотой. Позволяет изменять частоту проверки по мере выполнения заданий пользователем.

Эту настройку можно использовать, чтобы снижать частоту выдачи контрольных заданий по мере того, как пользователь выполняет задания и становится более опытным. В таком случае пользователю можно доверять, и уменьшение количества контрольных заданий будет экономить ресурсы.

mixer_config.training_task_distribution_function

Выдача обучающих заданий с неравномерной частотой. Позволяет менять частоту обучающих заданий по мере выполнения заданий пользователем.

Эту настройку можно использовать, чтобы снижать частоту выдачи обучающих заданий по мере того, как пользователь выполняет задания и становится более опытным. В таком случае пользователю можно доверять, и уменьшение количества обучающих заданий будет экономить ресурсы.

Подробнее о возможностях API на уровне пула.

На уровне страницы заданий

Ключ

Значение

Когда использовать

issuing_order_override

Приоритет страницы заданий среди других страниц в пуле. Определяет порядок выдачи страниц исполнителям. Чем больше значение параметра, тем выше приоритет.

Используется, чтобы показывать страницы заданий с большим приоритетом раньше других.

reserved_for[]

Идентификаторы пользователей, которым будет доступна страница.

Используется для выбора пользователей, которым будет доступна данная страница.

unavailable_for[]

Идентификаторы пользователей, для которых страница должна быть недоступна.

Используется для выбора пользователей, которым будет недоступна данная страница.

Ключ

Значение

Когда использовать

issuing_order_override

Приоритет страницы заданий среди других страниц в пуле. Определяет порядок выдачи страниц исполнителям. Чем больше значение параметра, тем выше приоритет.

Используется, чтобы показывать страницы заданий с большим приоритетом раньше других.

reserved_for[]

Идентификаторы пользователей, которым будет доступна страница.

Используется для выбора пользователей, которым будет доступна данная страница.

unavailable_for[]

Идентификаторы пользователей, для которых страница должна быть недоступна.

Используется для выбора пользователей, которым будет недоступна данная страница.

Подробнее о возможностях API на уровне страниц заданий.

На уровне задания

Ключ

Значение

Когда использовать

baseline_solutions[]

Предварительные ответы. Эти данные имитируют ответы исполнителей при расчете уверенности в ответе. Они используются в динамическом перекрытии и в агрегации результатов по навыку.

Эта настройка понадобится, если имеются предварительные ответы, которые верны с определенной вероятностью. Тогда при использовании данной возможности в зависимости от ответа исполнителя перекрытие будет разным (при совпадении ответа исполнителя и предварительного ответа перекрытие повышаться не будет).

reserved_for[]

Идентификаторы пользователей, которым задание будет доступно.

Используется для выбора пользователей, которым будет доступно данное задание.

unavailable_for[]

Идентификаторы пользователей, для которых задание должно быть недоступно.

Используется для выбора пользователей, которым будет недоступно данное задание.

Ключ

Значение

Когда использовать

baseline_solutions[]

Предварительные ответы. Эти данные имитируют ответы исполнителей при расчете уверенности в ответе. Они используются в динамическом перекрытии и в агрегации результатов по навыку.

Эта настройка понадобится, если имеются предварительные ответы, которые верны с определенной вероятностью. Тогда при использовании данной возможности в зависимости от ответа исполнителя перекрытие будет разным (при совпадении ответа исполнителя и предварительного ответа перекрытие повышаться не будет).

reserved_for[]

Идентификаторы пользователей, которым задание будет доступно.

Используется для выбора пользователей, которым будет доступно данное задание.

unavailable_for[]

Идентификаторы пользователей, для которых задание должно быть недоступно.

Используется для выбора пользователей, которым будет недоступно данное задание.

Подробнее о возможностях API на уровне задания.

Агрегация ответов на одно задание

Агрегация ответов — это процесс обработки ответов на задание, в результате которого выдается итоговый ответ и степень его достоверности.

Чтобы запустить агрегацию ответов на одно задание, отправьте POST-запрос к ресурсу /api/v1/aggregated-solutions/aggregate-by-task.

Подробнее об агрегации ответов.

Отслеживание операций

В результате некоторых запросов к API (открытие и закрытие пула, загрузка страниц заданий и т.д.) создается операция, выполняемая в фоновом режиме. Сведения о такой операции (например, статус и время создания) передаются в формате JSON.

Отслеживать выполнение таких операций можно с помощью API.

Подробнее об отслеживании операций.