Соглашение об использовании платформы разметки данных TagMe
====================
Настоящий документ представляет собой оферту Банка, адресованную Пользователям, на заключение договора на условиях настоящего документа (далее - «Соглашение») в соответствии со статьей 428 Гражданского кодекса Российской Федерации. Действующая редакция документа доступна по адресу: <https://tagme.sberdevices.ru/docs/agreement>.

1\. Термины и определения

1.1\. Аутентификация – процедура проверки данных Пользователя. Аутентификация работника Банка с использованием сервиса SberTeam ID происходит путем двухфакторной процедуры проверки данных работника Банка, обратившегося для доступа к Sber Team ID с целью использовать функционал Sber Team ID на Платформе.

1.2\. Банк/Владелец Платформы — Публичное акционерное общество «Сбербанк России» (ОГРН 1027700132195; иные реквизиты размещены по адресу: <http://www.sberbank.ru/ru/about/today/requisites>), осуществляющее управление и/или администрирование Платформы, обладающее всеми необходимыми правами на Платформу.

1.3\. Внешний Разметчик – пользователь Платформы, дееспособное физическое лицо, осуществляющее выполнение Заданий в Проекте Заказчика, на основании Договора с Внешним Разметчиком, заключаемого с Компанией.

1.4\. Внутренний Разметчик – пользователь Платформы, дееспособное физическое лицо, являющийся работником Банка и осуществляющий выполнение Задания в интересах Банка.

1.5\. Договор с Внешним Разметчиком – договор, регулирующий взаимоотношения между Компанией и Внешним Разметчиком по поводу оказания Внешним Разметчиком услуг по выполнению Заданий, включая вопросы оплаты и приемки оказанных Внешним Разметчиком услуг.

1.6\. Задание – задание Заказчика на сбор и(или) разметку данных (аудио-, видео- или текстовых файлов, таблиц (xlsx, csv, tsv), приложений (json) или изображений), выполняемое Пользователями в соответствии с условиями, изложенными в таком Задании, и иными положениями соответствующего договора на оказание услуг, заключенного между сторонами.

1.7\. Заказчик – Банк или третье лицо (также именуемое «Компания»), которые действуют в лице своих представителей (Представитель Заказчика), создавшее на Платформе Проект и размещающее Задания для Разметчиков. Заказчики – третьи лица используют Платформу на основании отдельного договора, заключенного между Банком и таким третьим лицом, на основании которого Банк предоставляет возможность Компании создавать свой Личный кабинет. После создания Личного кабинета Заказчик может создавать Проект, Задание и добавлять своих Представителей и Разметчиков. Заказчик использует функциональность Платформы в соответствии с Руководством по использованию Платформы, размещенным по адресу: <https://tagme.sberdevices.ru/docs/customer/index.html>.

1.8\. Личный кабинет — страница на Платформе с перечнем сведений о Пользователе (в том числе идентификационных сведений), с использованием которого осуществляется использование функциональности Платформы. Личный кабинет Заказчика может использоваться Представителями Заказчика для создания Проектов, добавления своих Разметчиков и назначения Задания Разметчикам. Личный кабинет Разметчика может использоваться для выполнения Задания.

1.9\. Компания – юридическое лицо, являющееся партнером Банка, которое заключило договор с Банком на использование Платформы, и организующее привлечение и/или привлекающее Внешних Разметчиков от своего имени для выполнения Проектов по Договору с Внешним Разметчиком.

1.10\. Материалы — любые элементы, файлы и/или информация (в том числе любые результаты интеллектуальной деятельности), загружаемые на Платформу Разметчиком и/или Представителем Заказчика, включая материалы, необходимые для выполнения Задания.

1.11\. Платформа – программа для ЭВМ «Платформа Tagme», правообладателем которой является Банк (Реестровая запись №15168 от 14.10.2022), позволяющая Пользователю и Заказчику использовать её функциональные возможности, связанные со сбором, разметкой и валидацией данных.

1.12\. Пользователь – Разметчик и Представитель Заказчика при совместном упоминании.

1.13\. Представитель Заказчика – пользователь Платформы, дееспособное физическое лицо, надлежащим образом уполномоченное Заказчиком на совершение юридически значимых действий от имени и в интересах такого Заказчика, в том числе, на создание Проектов, размещение Заданий, добавление в Проекты Разметчиков для выполнения Заданий.

1.14\. Проект – раздел Платформы, предназначенный для создания Задания, размещения Материалов, необходимых для выполнения Задания, добавления Разметчиков для выполнения Задания и управления ими, а также для размещения Разметчиками Результатов и их проверки.

1.15\. Разметчик – пользователь Платформы, дееспособное физическое лицо, выполняющее Задания по сбору и(или) разметке данных в качестве Внутреннего Разметчика или Внешнего Разметчика с использованием функциональных возможностей Платформы. Разметчик использует функциональность Платформы в соответствии с Руководством по использованию Платформы, размещенным по адресу: <https://tagme.sberdevices.ru/docs/marker/index.html>.

1.16\. Результаты – все результаты, включая, но не ограничиваясь, результаты интеллектуальной деятельности и результаты тестирования, которые были получены и/или созданы Разметчиком в рамках выполнения Задания.

1.17\. Сбер ID – сервис Банка по Аутентификации физического лица на информационных ресурсах Банка и партнеров Банка и иному использованию персональных данных физического лица в соответствии с договором о предоставлении услуги «Удобный доступ» .

1.18\. Сбер TeamID – сервис Банка по Аутентификации, позволяющий Внутреннему Разметчику и Представителю Заказчика получить доступ на Платформу с использованием логина и пароля от внутренней системы управления доступом к информационным ресурсам Банка (СУДИР) в соответствии с Пользовательским соглашением Sber Team ID (<https://teamid.sber.ru>).

1.19\. Учетная запись – совокупность данных, содержащих сформированный Платформой идентификатор, необходимых для Аутентификации и предоставления доступа к Платформе. Любые термины и определения, использующиеся в Соглашении и не упомянутые в настоящем разделе, будут толковаться системно, в связи с другими терминами, а также в соответствии со смыслом, вытекающим из текста Соглашения. В случае если содержание термина или понятия не представляется возможным определить из текста Соглашения, то дефиниция соответствующего термина или понятия определяется в соответствии с действующим законодательством Российской Федерации либо исходя из сложившейся релевантной практики.

2\. Предмет Соглашения

2.1\. Соглашение регулирует отношения между Банком и Пользователем, возникающие в связи с использованием функциональности Платформы, и определяет права и обязанности сторон.

2.2\. Соглашение не регулирует отношения между Пользователем и Заказчиком, а также между Банком и Заказчиком – третьим лицом. Все вопросы, связанные с отношениями Разметчика и Заказчика, и нерегулируемые Соглашением, регулируется отдельными соглашениями между Разметчиком и Заказчиком. Банк не является стороной соглашений, заключаемых между Разметчиками и Компаниями.

2.3\. Банк предоставляет Пользователю возможность использования функциональности Платформы, а Пользователь обязуется использовать функциональность Платформы исключительно на условиях Соглашения. Банк не взимают плату с Пользователей за использование функциональных возможностей Платформы.

2.4\. Доступ к Платформе осуществляются удаленно через сеть «Интернет».

3\. Общие положения

3.1\. Пользователь считается в полном объеме и безоговорочно присоединившимся к настоящему Соглашению (пункт 1 статьи 428 Гражданского кодекса Российской Федерации) путем совершения конклюдентных действий, а именно регистрации Личного кабинета в соответствии с пп. 4.1.3 Соглашения или первой Аутентификации в соответствии с пп. 4.1.1, 4.1.2 Соглашения.

3.2\. Банк вправе время от времени вносить изменения в условия Соглашения. Пользователь обязуется знакомиться с условиями Соглашения при каждой Аутентификации. Выполняя Аутентификацию, Пользователь соглашается с условиями Соглашения в редакции, действующей на дату Аутентификации. В случае несогласия Пользователя с условиями Соглашения, он обязан прекратить использование Платформы и удалить свой Личный кабинет, если он был зарегистрирован. Удаление Личного кабинета может быть произведено Пользователем самостоятельно при наличии функциональной возможности Платформы или посредством направления запроса об удалении Личного кабинета на адрес электронной почты: [tagme\_help@sberbank.ru](mailto:tagme%5Fhelp@sberbank.ru). Продолжая Использование Платформы, Пользователь подтверждает свое согласие с изменениями Соглашения.

3.3\. Пользователь настоящим уведомлен, понимает и соглашается с тем, что Банк может собирать статистические данные об использовании Платформы.

3.4\. Платформа не предназначена для загрузки и работы с Материалами, содержащими информацию ограниченного доступа, включая персональные данные, сведения, составляющие государственную, банковскую, коммерческую и иную охраняемую законом тайну.

4\. Предоставление доступа к Платформе

4.1\. Пользователю предоставляется доступ к Платформе одним из следующих способов:

4.1.1\. путем Аутентификации Разметчика на Платформе с использованием Сбер ID;

4.1.2\. путем регистрации Личного кабинета на Платформе.

4.2\. Регистрация Личного кабинета производится путем заполнения регистрационной формы на Платформе, где Пользователь указывает адрес электронной почты (логин) и пароль, на который Банк направляет ссылку для подтверждения адреса электронной почты (действительности логина). Первичная Аутентификация на Платформе осуществляется через переход по полученной по электронной почте ссылке для подтверждения, дальнейшая Аутентификация производится путем введения логина и пароля.

4.3\. После Аутентификации Разметчик получает доступ к функциональности Платформы, позволяющей выполнять Задания, тестовые задания, созданные для обучения Разметчиков, и загружать на Платформу Материалы, если это необходимо для выполнения Задания, а также Результаты.

4.4\. После Аутентификации Представитель Заказчика получает доступ к функциональности Платформы, позволяющей создавать Проекты и управлять ими, в том числе размещать Задания, добавлять/назначать Разметчиков на Задание, загружать на Платформу Материалы и выгружать Результаты.

4.5\. Пользователь самостоятельно осуществляет контроль за безопасностью, сохранностью информации, размещаемой и хранимой им на Платформе.

4.6\. Пользователь не в праве предоставлять доступ к Платформе с использованием своих Учетных данных третьим лицам.

4.7\. В рамках взаимодействия Заказчика в лице своих Представителей с Разметчиками в процессе использования Платформы, Банк выступает исключительно как лицо, организовавшее техническую возможность такого взаимодействия, за исключением случаев, когда Банк сам является Заказчиком.

4.8\. Факт заключения Соглашения Пользователем является основанием обработки его персональных данных Банком, которые необходимы для заключения и исполнения Соглашения в составе: фамилия, имя, отчество; адрес электронной почты/ адрес корпоративной электронной почты, место работы (для Внутренних Разметчиков); статистика о пользовательской сессии (сведения о действиях Пользователя на Платформе и связанная с действиями информация (в том числе о дате/времени, когда совершались действия, об ID используемого устройства, ID (идентификаторе/уникальном коде, присваиваемом субъекту), IP-адресе, типе используемого устройства, типе операционной системы устройства, используемого Пользователем).

4.9\. Обработка Банком персональных данных Пользователей будет осуществляться с целью исполнения прав и обязательств, предусмотренных Соглашением, а именно:

4.9.1\. предоставление доступа к Платформе;

4.9.2\. проведение аналитики данных с целью определения необходимости развития Платформы;

4.9.3\. информирование Пользователей посредством отправки в электронном виде с использованием функциональных возможностей Платформы и/или на адрес электронной почты Пользователя системных, сервисных (функциональных) оповещений, а также информационных сообщений, связанных с использованием Платформы.

4.10\. Обработка персональных данных будет осуществляться в соответствии с Политикой обработки персональных данных в ПАО Сбербанк, опубликованной по адресу: <https://www.sberbank.ru/privacy/policy>.

4.11\. Банк вправе осуществлять обработку персональных данных с использованием средств автоматизации, в том числе в информационно-телекоммуникационных сетях, включая:

(i) сбор, запись, систематизацию, накопление, хранение, уточнение (обновление, изменение) извлечение, использование, блокирование, удаление, уничтожение и уничтожение части персональных данных;

(ii) передачу (предоставление, доступ), если необходимость в ней возникнет в будущем в ходе исполнения Соглашения и (или) в силу требований применимого законодательства.

4.12\. Банк обязуется при обработке персональных данных:

(i) обеспечивать обработку персональных данных с соблюдением всех применимых требований законодательства Российской Федерации в области защиты персональных данных, в том числе с соблюдением принципов, требований, обязательств оператора персональных данных, установленных Федеральным законом от 27.07.2006 № 152-ФЗ «О персональных данных»;

(ii) в случае если Банк в целях исполнения своих законных обязательств должен передать персональные данные третьим лицам, в том числе органам государственной власти, осуществлять указанные действия с соблюдением требований законодательства, и уведомлять Пользователя о наименовании получателя и цели передачи персональных данных, в случае если передача необходима для исполнения прав и обязанностей Банка в рамках Соглашения.

4.13\. Обработка персональных данных будет осуществляться в течение срока действия Соглашения. По достижении цели обработки или в случае утраты необходимости в её достижении, обрабатываемые персональные данные подлежат уничтожению, если иное не предусмотрено законом. Банк обязуется принимать все возможные меры для обеспечения уничтожения персональных данных.

5\. Права и обязанности Сторон

5.1\. Банк вправе:

5.1.1\. Определять структуру, внешний вид и наполнение Платформы, и в любое время вносить изменения в функциональность Платформы, оформление и содержание Платформы.

5.1.2\. Без какого-либо уведомления и/или объяснения причин - ограничить или запретить (временно или постоянно) доступность Платформы любому Пользователю, в том числе удалить Личный кабинет Пользователя, в том числе в случае нарушения условий Соглашения и/или применимого права Российской Федерации.

5.1.3\. Проводить плановые и внеплановые профилактические работы на Платформе, для чего временно приостанавливать работу Платформы. Банк по своему усмотрению может уведомлять Пользователей о времени проведения данных работ и/или об их длительности путем размещения соответствующего уведомления на Платформе.

5.1.4\. Блокировать и удалять Учетную запись Пользователя по своему усмотрению, в том числе в случае совершения Пользователем действий, нарушающих законодательство Российской Федерации или положения Соглашения.

5.1.5\. Удалить или заблокировать без предупреждения Материалы, которые нарушают и/или могут нарушать законодательство Российской Федерации, положения Соглашения.

5.2\. Банк обязуется принимать необходимые организационные и технические меры для поддержания работоспособности Платформы.

5.3\. Пользователь обязуется:

5.3.1\. Использовать Платформу исключительно на условиях и в соответствии с настоящим Соглашением.

5.3.2\. Хранить в тайне и не раскрывать третьим лицам информацию об учетных данных, с помощью которых осуществляется доступ к Платформе. В случае, если такая информация по тем или иным причинам станет известна третьим лицам, немедленно изменить свои учетные данные.

5.3.3\. Не использовать устройства и другие программно-аппаратные средства, позволяющие нарушить функционирование Платформы.

5.3.4\. Незамедлительно информировать Банк обо всех ставших ему известных случаях противоправного использования Платформы третьими лицами.

5.4\. Пользователю запрещается:

5.4.1\. в любой форме и любым способом (если иное прямо не разрешено условиями Соглашения):

(i) копировать, изменять (модифицировать), создавать производные произведения, дополнять, распространять (в том числе посредством предоставления права использования), продавать, доводить до всеобщего сведения, публиковать и совершать иные действия, которые прямо не указаны в Соглашении, как допустимые, в отношении исходного/объектного кода Платформы;

(ii) пытаться обойти технические меры защиты Платформы и/или пытаться получить исходный/объектный кода Платформы;

(iii) совершать любые действия, затрудняющие / блокирующие / ухудшающие функционирование Платформы;

5.4.2\. осуществлять действия, направленные на дестабилизацию функционирования Платформы, осуществлять попытки несанкционированного доступа к Платформе и Личным кабинетам иных лиц, а также осуществлять любые иные аналогичные действия;

5.4.3\. способствовать действиям, направленным на нарушение ограничений и запретов, налагаемых Соглашением;

5.4.4\. создавать «inlining or embedded links» (встроенные ссылки), позволяющие отображать определенную информацию и/или иные объекты интеллектуальной собственности на любом другом сайте (в том числе, на собственном сайте Заказчика) посредством embed, а также фреймы (frames), являющиеся специальным окном веб-браузера для представления внешнего сайта;

5.4.5\. создавать любые гиперссылки (включая, «inlining or embedded links») на страницы Платформы, функционал и/или функциональные возможности Платформы, доступные Пользователю только после Аутентификации.

6\. Заверения и гарантии

6.1\. Пользователь дает Банку заверения об обстоятельствах по смыслу ст. 431.2 ГК РФ, относительно следующего:

6.1.1\. Пользователь, размещая на Платформе Материалы, заверяет, что права на Материалы, размещаемые Разметчиком, принадлежат Разметчику или право их использования предоставлено ему правообладателями, или согласия правообладателя не требуется в силу закона;

6.1.2\. Пользователь заверяет, что размещаемые на Платформе Материалы не содержат:

(i) компьютерные вирусы, трояны, самоликвидирующиеся механизмы, механизмы защиты от копирования и другие подобные машинные команды, которые могут деактивировать, уничтожить или изменить иным образом данные Банка, программное или аппаратное обеспечение Платформы;

(ii) сведения, являющиеся персональными данными;

(iii) информацию, признаваемую запрещенной / распространение которой запрещено на территории Российской Федерации.

7\. Ответственность Сторон

7.1\. Функциональность Платформы, информация, размещенная на Платформе, предоставляются на условиях «как есть» (as is). Банк не предоставляет никаких гарантий в отношении соответствия Платформы конкретным целям и ожиданиям Пользователя, а также не предоставляет никаких иных гарантий, прямо не указанных в Соглашении.

7.2\. Банк не несет ответственности за юридическое оформление Договора с Внешним Разметчиком. Банк не выступает в роли агента или иного представителя Компании, и не принимает на себя какие-либо права и обязательства, связанные с заключением / исполнение / сопровождением Договора с Внешним Разметчиком, а также не несет ответственности за соблюдение / исполнение такого договора.

7.3\. Банк не несет ответственности за любые убытки, проистекающие из данного Соглашения и/или из использования Платформы, или невозможности использования Платформы, даже если Банку было известно или должно было быть известно о возможности таких убытков или Пользователь был предупрежден о возможности таких убытков.

7.4\. Пользователь самостоятельно несет юридическую ответственность за противоправные действия, осуществляемые с использованием Платформы, а также в связи с размещением Материалов на Платформе, в том числе за соответствие содержания размещаемых Материалов требованиям применимого законодательства, включая ответственность перед третьими лицами.

7.5\. В случае предъявления Банку требований, претензий, исков со стороны третьих лиц или уполномоченных на это органов государственной власти о нарушении Банком прав третьего лица (лиц) или требований действующего законодательства, которое было допущено Банком в результате нарушения Пользователем своих заверений, гарантий или обязательств, Пользователь обязуется самостоятельно и за свой счет урегулировать все претензии таких третьих лиц.

8\. Заключительные положения

8.1\. Банк может размещать на Платформе или направлять Пользователю в электронном виде через Личный кабинет и/или на адрес электронной почты Пользователя, указанный в Учетной записи, системные, сервисные (функциональные) оповещения, а также информационные сообщения, связанные с использованием Платформы.

8.2\. Стороны согласились считать получаемые уведомления и сообщения в электронном виде, указанные в п. 8.1\. Соглашения, от имени Банка с адресов электронной почты с доменом sberbank.ru, а также с использованием функциональных возможностей Платформы, юридически значимыми сообщениями по смыслу ст. 165.1 ГК РФ.

8.3\. К настоящему Соглашению подлежит применению право Российской Федерации.

8.4\. Все споры, разногласия и претензии, которые могут возникнуть в связи с исполнением, расторжением или признанием недействительным Соглашения, Стороны будут стремиться решить путем переговоров с соблюдением обязательного претензионного порядка. При невозможности решить возникшие споры в досудебном порядке, они будут разрешаться в судебном порядке в соответствии с законодательством Российской Федерации по месту нахождения Банка.

Документация TagMe
====================
TagMe — предназначена для ручной разметки и проверки данных. Полученную информацию можно использовать для обучения моделей искусственного интеллекта.

### [ Руководство заказчика](/docs/customer/index.html) 

 Инструкции по настройке и управлению задачами по разметке данных

### [ Руководство разметчика](/docs/marker/index.html) 

 Описание порядка работы на платформе разметки данных

### [ Для разработчика](/docs/dev/index.html) 

 Инструменты автоматизации взаимодействия с платформой

## [](#%5Fюридические%5Fдокументы)Юридические документы

* [Соглашение об использовании платформы разметки данных](agreement.html)
* [Согласие на обработку персональных данных](user%5Fconsent.html)

Согласие на обработку персональных данных пользователя платформы TagMe
====================
Я, пользователь платформы TagMe, доступ к которой предоставляется посредством сайта по адресу <https://tagme.sberdevices.ru/> (и по поддоменам) (далее – Платформа), действуя свободно, своей волей и в своем интересе, даю свое согласие на обработку моих персональных данных Публичному акционерному обществу «Сбербанк России» (адрес: Российская Федерация, 117312, г. Москва, ул. Вавилова, д. 19, далее – Оператор) на следующих условиях (далее – Согласие):

1. Перечень обрабатываемых персональных данных: фамилия, имя, отчество; адрес электронной почты / адрес корпоративной электронной почты, место работы / сведения о связи / назначении заданий; сведения об использовании Платформы: перечень заданий, время выполнения заданий, результаты выполнения задания, стоимость выполненных заданий; данные о пользовательской сессии: сведения о действиях на Платформе и связанная с действиями информация (в том числе о дате/времени, когда совершались действия, об ID используемого устройства, ID пользователя (идентификаторе/уникальном коде, присваиваемом субъекту), IP-адресе, типе используемого устройства, типе операционной системы устройства, используемого Пользователем; а также иные сведения, самостоятельно указанные мной при использовании Платформы.
2. Цели обработки персональных данных: обеспечение возможности использования функционала Платформы в соответствии с условиями пользовательского соглашения об использовании Платформы на инфраструктуре ООО «Облачные технологии» (адрес: 117312, Москва, ул. Вавилова, д. 23, стр. 1, комн. № 1.207, ОГРН: 5167746080057, ИНН 7736279160, далее – Обработчик).
3. Действия, совершаемые с персональными данными с использованием средств вычислительной техники и без использования таких средств: сбор, получение, запись, систематизация, накопление, хранение, уточнение (обновление, изменение), извлечение, использование, обезличивание, блокирование, удаление, уничтожение, а также передача (предоставление, доступ) с поручением или без поручения обработки Обработчику.
4. Срок обработки на основании Согласия: Согласие действует с момента его предоставления в течение 5 лет, либо до момента отзыва Согласия или прекращения действия пользовательского соглашения об использовании Платформы, в зависимости от того, что наступит ранее.
5. Порядок отзыва Согласия: Согласие может быть отозвано мной или моим представителем полностью или в соответствующей части в любой момент путем направления Оператору письменного заявления, содержащего в явном виде отзыв Согласия и сведения, позволяющие подтвердить мое участие в отношениях с Оператором (в случае направления заявления представителем к заявлению также должны быть приложены документы, подтверждающие полномочия такого представителя), любым из следующих способов:  
   * на бумажном носителе по почтовому адресу Оператора: 117312 г. Москва, ул. Вавилова, д. 19; или  
   * в электронном виде на почту [tagme\_help@sberbank.ru](mailto:tagme%5Fhelp@sberbank.ru).
6. Настоящее Согласие дано с учетом Федерального закона от 27.07.2006 № 152-ФЗ «О персональных данных», с содержанием которого я ознакомлен.
7. Я понимаю, что, если я приму решение не предоставлять Согласие, цель обработки, описанная в нем, может быть не достигнута. Я понимаю, что последующий отзыв мной Согласия также повлечет за собой аналогичные последствия.

Отложенная приемка
====================
По умолчанию результаты разметки принимаются автоматически — у всех размеченных объектов статус меняется на `ACCEPTED`.

Но вы можете настроить ручную валидацию результатов разметки и самостоятельно принимать решение о приемке или отклонении каждого результата в интерфейсе или через SDK.

Для этого в настройках задачи включите отложенную приемку и установите:

* Автоматическое принятие ответов — в течение скольких дней после получения ответа его нужно проверить. Если вы не успели принять или отклонить ответ в этот срок, то ответ принимается автоматически.
* Порог качества для контрольных заданий — минимальный показатель [качества](quality-consistency.html), при котором ответ на контрольное задание не отклоняется автоматически.

Если вы случайно отклонили результат, вы можете изменить решение и принять его. Принятые результаты нельзя отклонить.

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

Также вы можете изменить показатель [качества](quality-consistency.html) ответа разметчика в контрольных заданиях. Это повлияет на показатели:

1. В результатах разметки, которые скачиваются в виде файла.
2. Уровня навыка разметчика, если в задаче установлен навык на выход. Обновление навыков происходит асинхронно — в течение 10 минут после приемки.

В статистике не отображаются изменения показателя качества, сделанные вручную.

Пользователи
====================
## [](#%5Fприглашаем%5Fновых%5Fпользователей)Приглашаем новых пользователей

Чтобы отправить приглашение новому пользователю:

1. Перейдите в раздел **Пользователи** на вкладку **Ссылки-приглашения**.
2. Нажмите **Создать**.
3. В открывшемся окне настройте пригласительную ссылку:  
   * введите название;  
   * укажите срок действия ссылки, если нужно;  
   * укажите максимальное количество заявок, если нужно;  
   * чтобы автоматически принимать заявки по ссылке, включите переключатель;  
   * чтобы автоматически принимать заявки с почтами определенного домена, включите переключатель и укажите домен;  
   * чтобы сразу добавлять пользователей в определенную группу, включите переключатель и выберите группу из выпадающего списка.
4. Нажмите **Создать**. Новая ссылка отобразится в списке.
5. Чтобы скопировать ссылку, нажмите на кнопку копирования слева от названия ссылки.
6. Отправьте ссылку сотрудникам, которых вы хотите пригласить, и они смогут отправить заявки на присоединение к организации.

Чтобы принять заявку на присоединение к организации:

1. Перейдите в раздел **Пользователи** на вкладку **Заявки** и отметьте, кого вы хотите принять.
2. Нажмите **Принять**.
3. В открывшемся окне выберите из списка группы, в которые нужно добавить новых разметчиков.
4. Нажмите **Добавить**.

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

| |  Один разметчик может состоять в нескольких группах одновременно. Его персональная статистика учитывается в статистике каждой группы. |
| --------------------------------------------------------------------------------------------------------------------------------------- |

Чтобы отключить ссылку, нажмите на кнопку меню в строке данной ссылки и выберите **Отключить**.

## [](#%5Fдобавляем%5Fпользователей%5Fв%5Fорганизацию)Добавляем пользователей в организацию

Если пользователи уже зарегистрированы на платформе TagMe, Администратор может добавить их в организацию по ID или электронной почте. Для этого нужно:

1. Перейти в раздел **Пользователи** на вкладку **Участники**.
2. Нажать **Добавить пользователей**.
3. Ввести идентификатор или почту пользователя.
4. Выбрать роль пользователя.
5. Нажать **Добавить**.

## [](#%5Fредактируем%5Fроли)Редактируем роли

В системе есть следующие роли:

* Разметчик.
* Заказчик.
* Администратор организации.

Новым пользователям автоматически назначается роль **Разметчик**.

Если у вас роль **Администратор**, вы можете редактировать роли пользователей. Для этого:

1. Перейдите в раздел **Пользователи** на вкладку **Участники**.
2. Нажмите кнопку меню в строке нужного пользователя.
3. Выберите **Редактировать роли**.
4. Отметьте те роли, которые должны быть у пользователя.
5. Нажмите **Сохранить**.

## [](#%5Fназначаем%5Fразметчика%5Fна%5Fпроект)Назначаем разметчика на проект

Чтобы назначить разметчиков, которые будут работать с проектом, перейдите в проект на вкладку **Разметчики** и выберите одну или несколько групп из списка.

## [](#%5Fсоздаем%5Fи%5Fредактируем%5Fгруппы)Создаем и редактируем группы

Чтобы создать новую группу:

1. Перейдите в раздел **Группы разметчиков**.
2. Нажмите **Создать группу**.
3. В открывшемся окне введите название группы и нажмите **Добавить**. Новая группа появится в списке.

Чтобы добавить разметчиков:

1. Нажмите **Добавить пользователей**.
2. В открывшемся окне введите электронные адреса сотрудников, которых вы хотите добавить в группу.
3. Нажмите **Добавить**.

Чтобы перемещать и копировать разметчиков между группами:

1. Перейдите в группу.
2. Нажмите кнопку меню в строке нужного разметчика.
3. Выберите требуемое действие: **Переместить в другую группу** или **Скопировать в другую группу**.
4. В открывшемся окне нажмите **Выбрать** в строке нужной группы.

Чтобы удалить участника из группы, перейдите в группу, нажмите кнопку меню в строке нужного разметчика и выберите **Удалить**.

## [](#%5Fудаляем%5Fпользователя)Удаляем пользователя

Если у вас роль **Администратор**, вы можете удалить пользователя из организации. Для этого:

1. Перейдите в раздел **Пользователи** на вкладку **Участники**.
2. Нажмите кнопку меню в строке нужного пользователя.
3. Выберите **Удалить из организации**.
4. Нажмите **Удалить**.

AI-ассистент для создания интерфейса
====================
AI-ассистент — это встроенный инструмент, который помогает создавать и редактировать интерфейс заданий с помощью текстовых описаний на естественном языке. Вместо ручной верстки вы описываете, какой интерфейс вам нужен, и ассистент генерирует готовый код.

| |  Если вам нужна ручная верстка интерфейса, воспользуйтесь разделом [Верстка интерфейса](creating-interface.html). |
| ------------------------------------------------------------------------------------------------------------------- |

## [](#%5Fначало%5Fработы)Начало работы

Чтобы открыть AI-ассистент, перейдите в проект на вкладку **Интерфейс**. Панель чата расположена справа от редактора кода.

![ai agent overview](_images/ai-agent-overview.webp) 

Вы можете начать работу двумя способами:

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

## [](#%5Fкак%5Fсоставлять%5Fзапросы)Как составлять запросы

Качество сгенерированного интерфейса напрямую зависит от того, насколько подробно вы опишете задачу. Ниже приведены рекомендации по составлению запросов.

### [](#%5Fчто%5Fуказать%5Fв%5Fзапросе)Что указать в запросе

Хороший запрос содержит следующую информацию:

* **Тип задачи** — классификация, сегментация, сравнение, генерация текста, оценка качества и т. д.
* **Тип входных данных** — текст, изображение, аудио, видео, диалог.
* **Структура ответа** — какие категории, варианты ответов или элементы должен выбирать разметчик.
* **Дополнительные условия** — обязательность полей, количество вариантов, наличие поля для комментария.

### [](#%5Fпримеры%5Fзапросов)Примеры запросов

Хороший запрос

Создай интерфейс для классификации текста. Разметчик получает текст отзыва
и должен определить его тональность: положительный, отрицательный или нейтральный.
Добавь обязательное поле для комментария, если выбран вариант «нейтральный».

Слишком краткий запрос

Сделай форму для разметки.

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

### [](#%5Fзапросы%5Fна%5Fредактирование)Запросы на редактирование

Ассистент видит текущий код вашего интерфейса. Вы можете попросить его внести точечные изменения в уже существующий интерфейс:

* «Добавь поле для комментария после блока с вариантами ответа»
* «Измени количество вариантов ответа на 5»
* «Добавь валидацию: комментарий обязателен, если выбран вариант "Другое"»

## [](#%5Fуточняющие%5Fвопросы)Уточняющие вопросы

Если информации в вашем запросе недостаточно для генерации качественного интерфейса, ассистент задаст уточняющие вопросы. Вопросы могут касаться:

* **Типа задачи** — если из запроса неясно, какой тип разметки требуется.
* **Входных данных** — если не указан тип данных, с которыми будет работать разметчик.
* **Структуры ответа** — если нужны детали: категории, сущности, критерии оценки.

![ai agent questions](_images/ai-agent-questions.webp) 

### [](#%5Fформат%5Fвопросов)Формат вопросов

Вопросы отображаются в виде карточек с вариантами ответа. Вы можете:

* Выбрать один или несколько предложенных вариантов (зависит от типа вопроса).
* Ввести свой вариант в текстовом поле, если ни один из предложенных не подходит.

Если вопросов несколько, они отображаются последовательно — переключайтесь между ними с помощью кнопок **Назад** и **Далее**. После ответа на все вопросы нажмите **Отправить**.

## [](#%5Fгенерация%5Fи%5Fпросмотр%5Fизменений)Генерация и просмотр изменений

После обработки вашего запроса ассистент сгенерирует код и предложит его к применению. Изменения отображаются слева от чата в виде блоков кода с подсветкой синтаксиса.

![ai agent diff](_images/ai-agent-diff.webp) 

Ассистент может изменить один или несколько блоков интерфейса:

* HTML — разметка задания
* CSS — стили
* JavaScript — логика и валидация
* Example data — пример данных для предпросмотра
* Config — конфигурация
* Specification — спецификация для расчёта качества

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

## [](#%5Fпринятие%5Fи%5Fотклонение%5Fизменений)Принятие и отклонение изменений

После генерации кода вам необходимо принять или отклонить предложенные изменения.

![ai agent accept reject](_images/ai-agent-accept-reject.webp) 

### [](#%5Fдоступные%5Fдействия)Доступные действия

| Действие                     | Описание                                                                                                                   |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| **Принять изменение**        | Применяет сгенерированный код к соответствующему блоку интерфейса.                                                         |
| **Отклонить изменение**      | Отменяет предложенное изменение — текущий код блока останется без изменений.                                               |
| **Принять всё**              | Применяет все предложенные изменения одновременно.                                                                         |
| **Отклонить всё**            | Отменяет все предложенные изменения.                                                                                       |
| **Отклонить с комментарием** | Отменяет изменения и передаёт ассистенту обратную связь. Ассистент учтёт ваш комментарий и предложит исправленный вариант. |

| |  Пока вы не приняли или не отклонили все предложенные изменения, отправка новых сообщений в чат недоступна. |
| ------------------------------------------------------------------------------------------------------------- |

### [](#%5Fобратная%5Fсвязь%5Fпри%5Fотклонении)Обратная связь при отклонении

Если сгенерированный код не соответствует ожиданиям, отклоните изменения с комментарием. Опишите, что именно нужно исправить, например:

* «Варианты ответа должны располагаться горизонтально, а не вертикально»
* «Не хватает поля для комментария»
* «Изображение должно быть слева, а не сверху»

Ассистент получит вашу обратную связь и предложит исправленный вариант кода.

## [](#%5Fредактирование%5Fсуществующего%5Fинтерфейса)Редактирование существующего интерфейса

Ассистент автоматически видит текущий код всех блоков вашего интерфейса (HTML, CSS, JavaScript, Example data, Config, Specification). Благодаря этому вы можете:

* Просить внести точечные правки в уже готовый интерфейс.
* Описывать изменения относительно текущего состояния: «измени цвет кнопки», «добавь ещё один вариант ответа», «убери поле с комментарием».
* Дорабатывать интерфейс итеративно, отправляя последовательные запросы.

| |  Если вы вручную изменили код в редакторе, ассистент увидит обновлённый код при следующем запросе. |
| ---------------------------------------------------------------------------------------------------- |

## [](#%5Fсохранение%5Fи%5Fпредпросмотр)Сохранение и предпросмотр

После принятия изменений код отображается в редакторе, но ещё не сохранён на сервере.

Чтобы сохранить изменения и посмотреть результат:

1. Нажмите **Сохранить**, чтобы сохранить интерфейс.
2. Нажмите **Предпросмотр интерфейса**, чтобы проверить, как выглядит форма.

## [](#%5Fистория%5Fверсий%5Fинтерфейса)История версий интерфейса

Каждое сохранение интерфейса создаёт новую версию. Вы можете просмотреть историю версий и вернуться к любой предыдущей.

![ai agent history](_images/ai-agent-history.webp) 

### [](#%5Fпросмотр%5Fистории)Просмотр истории

Чтобы открыть историю версий, нажмите на селектор версий в верхней части страницы интерфейса. Список содержит:

* Автора изменения.
* Дату и время сохранения.

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

## [](#%5Fистория%5Fчата)История чата

История чата с ассистентом сохраняется автоматически и привязана к вашему проекту. При повторном открытии страницы интерфейса вы увидите предыдущие сообщения.

### [](#%5Fуправление%5Fисторией%5Fчата)Управление историей чата

* **Очистить историю** — удаляет все сообщения чата. Действие необратимо.
* **Скачать историю** — сохраняет переписку в файл `chat-history.json` на ваш компьютер.

| |  Очистка истории чата не влияет на сохранённые версии интерфейса. Код, который вы приняли и сохранили, останется в истории версий. |
| ------------------------------------------------------------------------------------------------------------------------------------ |

## [](#%5Fрекомендации%5Fпо%5Fработе%5Fс%5Fассистентом)Рекомендации по работе с ассистентом

* **Будьте конкретны** — указывайте тип задачи, входные данные и ожидаемую структуру ответа.
* **Используйте обратную связь** — если результат не подходит, отклоняйте с комментарием, а не переписывайте запрос с нуля.
* **Сохраняйте промежуточные результаты** — если вас устраивает текущий вариант, сохраните его перед дальнейшими изменениями.

Релиз 3.10.0
====================
В этом обновлении:

* **Эллипс** — новый инструмент для сегментации изображений (ellipse).
* **Автофокусировка на поле поиска**. Чтобы в задачах сегментации в поле поиска по классам автоматически проставлялся курсор, используйте параметр `searchAutoFocus`.
* **Автооткрытие аннотаций при сегментации изображений**. Чтобы настроить автоматическое отображение аннотации после выделения фрагмента на изображении, используйте параметр `annotationAutoOpen`.
* **Поворот изображения в результатах разметки**. Чтобы в результатах разметки отображалась информация о том, что разметчики поворачивали изображение, используйте атрибут `withRotationResult` в компоненте `tm-previewer`.
* **Настройка штриховки и заливки в инструментах сегментации изображений**. Работает в инструментах: многоугольник (polygon), прямоугольник (bbox) и эллипс (ellipse). Настраивается с помощью объекта `fill`.
* **Возможность сгенерировать несколько изображений в одной задаче**. В шаблоне **Создание изображений** вы можете создать несколько блоков генерации, и в каждом указать минимальное и максимальное количество изображений, которые сможет добавить разметчик.
* **Группировка фрагментов**. В шаблонах сегментации вы можете настроить возможность для разметчиков группировать фрагменты. Используйте для этого параметр `groupsEnabled`.
* **Изменение класса фрагмента**. В шаблонах сегментации вы можете настроить возможность для разметчиков изменять класс выделенного фрагмента. Используйте для этого параметр `entityChangeIcon`.
* **Настройка отображения кнопок «Загрузить видео» и «Использовать камеру»**. В шаблоне **Генерация видео** вы можете добавлять или удалять кнопки с помощью параметров `uploadButton` и `cameraButton`.

Релиз 3.11.0
====================
В этом обновлении:

* **Избранные проекты**. Нажмите на иконку закладки в списке проектов и этот проект будет отображаться выше остальных.
* **Пригласительные ссылки**. При создании пригласительной ссылки можно настроить возможность автоматически принимать пользователей.
* **Тестовые данные** для шаблонов можно указать в блоке **Example data**. Там же можно скачать пример заполнения файла в формате JSON, TSV или CSV.

Релиз 3.25.0
====================
В этом обновлении:

Релиз 3.8.6
====================
В этом обновлении:

* **Настройка горячих клавиш для классов**. В шаблонах сегментации добавлена возможность настраивать горячие клавиши для выбора класса.

Релиз 3.9.0
====================
В этом обновлении:

* **Отложенная приемка результатов**. Добавлена возможность проверять задания вручную. Для этого включите в настройках задачи отложенную приемку.
* **Загрузка навыков разметчиков таблицей**. Перейдите в раздел **Навыки** и загрузите таблицу со списком разметчиков и присваиваемых им навыков.
* **Точная настройка фильтрации разметчиков по навыку**. В настройках задачи вы можете указать диапазон желаемого уровня навыка с помощью символов `≤` или `≥`.
* **Расчет качества и согласованности** по алгоритмам IOU и levenshtein.

Релиз 4.0.0
====================
## [](#%5Fограничение%5Fизменения%5Fтипа%5Fзаданий)Ограничение изменения типа заданий

После первого запуска задания запрещено менять его тип, но разрешено менять мету (правильный ответ, подсказка, предразметка) в статусах «Ожидает запуска», «Остановлена», «Завершена». Перейдите в проект, задачу, «Задания», откройте их и через три точки выберите «Открыть атрибуты». После запуска изменить тип задания невозможно ни через UI, ни через SDK.

## [](#%5Fназначение%5Fразметчика%5Fдо%5Fзапуска%5Fзадачи)Назначение разметчика до запуска задачи

Можно заранее назначать исполнителя на новые основные задания. Перейдите в проект, задачу, «Задания», откройте их и через три точки выберите «Назначить разметчика». Если задание назначено разметчику, перекрытие менять нельзя.

## [](#%5Fотображение%5Fназвания%5Fфайла%5Fв%5Fответах%5Fразметчика)Отображение названия файла в ответах разметчика

Во вкладке «Ответы разметчиков» теперь отображается название файла и доступна фильтрация по нему.

## [](#%5Fвыгрузка%5Fзаданий%5Fв%5Fформате%5Fjson)Выгрузка заданий в формате JSON

Доступна выгрузка списка заданий в JSON. Перейдите в проект/задачу, во вкладке «Задания» нажмите на иконку выгрузки.

## [](#%5Fмассовое%5Fвыделение%5Fреплик%5Fгорячими%5Fклавишами%5Fв%5Fсегментации%5Fдиалогов)Массовое выделение реплик горячими клавишами в сегментации диалогов

В шаблоне сегментации можно выделять несколько реплик горячими клавишами: Shift + реплика – добавление, Ctrl + реплика – диапазон.

## [](#%5Fновый%5Fкомпонент%5Ftm%5Fchat)Новый компонент tm-chat

Доступен компонент tm-chat для проектов. Примеры и инструкции можно найти в Storybook.

## [](#%5Fдвухстрочные%5Fзаголовки%5Fв%5Fсайдбаре)Двухстрочные заголовки в сайдбаре

Названия разделов в сайдбаре теперь отображаются в два ряда.

Релиз 4.1.0
====================
## [](#%5Fархивация%5Fи%5Fразархивация%5Fшаблонов)Архивация и разархивация шаблонов

Архивировация шаблонов в статусе «Не опубликован» и разархивировация их обратно. Архивированные шаблоны скрываются из маркетплейса и не могут быть опубликованы, но сохраняют права доступа.

## [](#%5Fувеличенный%5Fмаксимальный%5Fразмер%5Fинструкции)Увеличенный максимальный размер инструкции

Ограничение увеличено с 25 МБ до 500 МБ, можно добавлять до \~100 картинок. В проектах после релиза инструкция сохраняется как URL в датасете, в старых проектах – после первого редактирования. SDK автоматически конвертирует текст инструкции в URL.

## [](#%5Fновое%5Fмодальное%5Fокно%5Fпри%5Fпереходе%5Fмежду%5Fвкладками)Новое модальное окно при переходе между вкладками

При переходе между вкладками теперь появляется «Сохранить изменения перед переходом?». Теперь нет необходимости возвращаться в инструкцию или другие вкладки для сохранения.

## [](#%5Fудаление%5Fзаданий%5Fв%5Fостановленной%5Fзадаче)Удаление заданий в остановленной задаче

Удаление заданий, кроме случаев, когда они участвовали в запуске, имели кастомное перекрытие или были назначены разметчику. Теперь невозможно удалить задания, которые когда-либо были назначены разметчику.

## [](#%5Fулучшенная%5Fчитаемость%5Fкомментариев)Улучшенная читаемость комментариев

Комментарии во вкладке «Ответы разметчиков» и в просмотре задания отображаются шире, длинные сворачиваются, текст можно копировать.

## [](#%5Fссылка%5Fна%5Fitem%5Fв%5Fassignment)Ссылка на item в assignment

В ответах разметчиков появилась ссылка на item, ведущая к просмотру item без разметки (доступно и для архивных задач).

Релиз 4.10.0
====================
## [](#%5Fфильтрация%5Fпользователей%5Fпо%5Fпочте%5Fв%5Fответах%5Fисполнителей)Фильтрация пользователей по почте в "Ответах исполнителей"

Вернулась возможность фильтрации пользователей в разделе "Ответы исполнителей". Заказчик и исполнитель с признаком "Валидатор" могут отфильтровать пользователей по e-mail, если пользователь состоит в текущей организации, или по ID, если исполнитель находится в публичной группе.

## [](#%5Fсегментация%5Fсеквенции)Сегментация секвенции

В шаблоне "Сегментация изображений по кадрам" появились новые флаги — включение трекинга и дублирования конфигурации.

## [](#%5Fмассовый%5Fввод%5Fпользователей%5Fв%5Fполе%5Fввода)Массовый ввод пользователей в поле ввода

Теперь в поле выбора пользователей можно ввести сразу несколько значений: e-mail или ID через разделитель. Пользователи будут выбраны автоматически.

Релиз 4.11.0
====================
## [](#%5Fгенерация%5Fинтерфейса%5Fразметчика%5Fчерез%5Fчат%5Fс%5Fllm)Генерация интерфейса разметчика через чат с LLM

В разделе «Интерфейс» проекта появился встроенный чат с LLM. Заказчик может создать или отредактировать интерфейс разметки, введя промпт с использованием готовых пресетов или собственного описания. Система сгенерирует интерфейс или внесет изменения в готовый код по описанию от пользователя.

## [](#%5Fстатистика%5Fпо%5Fпроекту%5Fс%5Fучетом%5Fбонусов)Статистика по проекту с учетом бонусов

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

## [](#%5Fограничение%5Fсуммы%5Fштрафа%5Fи%5Fизменение%5Fформата%5Fбонуса)Ограничение суммы штрафа и изменение формата бонуса

Сумма штрафа теперь ограничена доходом исполнителя по задаче, а не проекту — при превышении система выдаст ошибку. Изменено поле bonus\_at: вместо даты и времени указывается только дата.

## [](#%5Fинструмент%5Fполилиния%5Fв%5Fсегментации%5Fпо%5Fкадрам)Инструмент «Полилиния» в сегментации по кадрам

В шаблон разметки «Сегментация изображений по кадрам» добавлен новый инструмент «Полилиния». Для полилинии доступны действия через контекстное меню: включение трекинга объекта и дублирование на несколько кадров вперед. В конфигурации доступны опции:

* max — ограничение количества точек
* strokeWidth — фиксированная толщина линии
* maxStrokeWidth — максимально допустимая толщина

## [](#%5Fнастройка%5Fстолбцов%5Fв%5Fответах%5Fисполнителей)Настройка столбцов в «Ответах исполнителей»

В разделе «Ответы разметчиков» появилась возможность настройки. Заказчик может управлять отображением полей и порядком столбцов таблицы.

Релиз 4.2.0
====================
## [](#%5Fпубликация%5Fassignment%5Fпо%5Fссылке)Публикация assignment по ссылке

Формирование публичной ссылки на размеченное задание, чтобы разметчик видел свой результат и комментарии заказчика. Для этого через SDK в MarkupReview установите `is_review_public=true`, затем сформируйте ссылку `tagme.sberdevices.ru/marker/review/assignment/{id}`

## [](#%5Fуправление%5Fобновлениями%5Fмежду%5Fшаблоном%5Fи%5Fпроектом)Управление обновлениями между шаблоном и проектом

Можно управлять автообновлениями шаблона разметки (инструкция, интерфейс, config) для проектов, созданных на его основе. Способ 1 – в маркетплейсе нажмите «Использовать» на шаблоне и настройте автообновления в модальном окне. Способ 2 – в проекте на вкладках «Инструкция»/«Интерфейс»/«Настройка» переключите автообновление.

## [](#%5Fвыдача%5Fзаданий%5Fпо%5Fпорядку)Выдача заданий по порядку

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

## [](#%5Fиспользование%5Fаттачментов%5Fмежду%5Fпроектами)Использование аттачментов между проектами

Переиспользование заданий с вложенными файлами, вставленными разметчиком, в других задачах/проектах. В задаче на вкладке «Настройки» включите тоггл в блоке «Использование результатов» и выберите организации для шаринга.

## [](#%5Fai%5Fпомощник%5Fв%5Fинструкции)AI-помощник в инструкции

Автоматическое исправление логических ошибок в тексте инструкции через AI. Для этого выделите текст, нажмите «AI», просмотрите и примените изменения в модальном окне.

## [](#%5Fудаление%5Fкомментария%5Fи%5Fкачества%5Fу%5Fassignments)Удаление комментария и качества у assignments

Можно удалять комментарий и качество ответа разметчика через UI и SDK. В проекте во вкладке «Ответы разметчиков» нажмите три точки и выберите нужную опцию.»

Релиз 4.3.0
====================
## [](#%5Fфильтрация%5Fучастников%5Fпо%5Fролям)Фильтрация участников по ролям

В списке участников организации появилась фильтрация по ролям: «Заказчик», «Администратор организации», «Менеджер».

## [](#%5Fпросмотр%5Fвыполненного%5Fзадания%5Fбез%5Fкомментария%5Fотображение%5Fстатуса)Просмотр выполненного задания без комментария + отображение статуса

Разметчик может видеть своё выполненное задание, комментарий заказчика (если есть) и статус ответа («Ожидает проверки», «Принят», «Отклонён»), даже если комментарий отсутствует. Через SDK в MarkupReview установите `is_review_public=true`, затем сформируйте ссылку формата `tagme.sberdevices.ru/marker/review/assignment/{id}`.

## [](#%5Fпризнак%5Fпубличности%5Fв%5Fвыгрузке%5Fрезультатов)Признак публичности в выгрузке результатов

В выгрузке результатов разметки добавлен столбец `is_review_public` – доступно ли разметчику просматривать своё задание.

## [](#%5Fавтоподсказки%5Fдля%5Ftm%5Fкомпонентов)Автоподсказки для tm-компонентов

При вводе кода интерфейса платформа подсказывает названия tm-компонентов и их атрибуты.

## [](#%5Fновый%5Ftm%5Fкомпонент%5Fс%5Fgigachat%5Fcloud%5Fonly)Новый tm-компонент с GigaChat (CLOUD-ONLY)

Можно подключить кнопку GigaChat в интерфейсе задания, подробная настройка описана в Storybook.

Релиз 4.4.0
====================
## [](#%5Fобязательные%5Fатрибуты%5Fв%5Fstorybook%5Fулучшенные%5Fподсказки)Обязательные атрибуты в Storybook + улучшенные подсказки

В Storybook добавлены обязательные атрибуты компонентов, а интерактивная подсказка в интерфейсе автоматически выводит обязательные/рекомендуемые атрибуты и варианты заполнения.

## [](#%5Fкомпонент%5Ftm%5Fchip%5Ftm%5Fchips)Компонент tm-chip / tm-chips

Позволяет добавлять интерактивные кнопки-чипсы в интерфейс заданий. Подробная настройка описана в Storybook.

## [](#%5Fкомпонент%5Ftm%5Fdialog)Компонент tm-dialog

Поддерживает диалоги с любым порядком реплик, вложенными компонентами (чекбоксы, радиокнопки, чипсы, комментарии), центрированием реплик и разной структурой внутри одной роли. В маркетплейсе в шаблоне «Диалоги с LLM» описана вся документация.

## [](#%5Ftm%5Fdialog%5Fподдержка%5Fфайлов%5Fаудио%5Fи%5Fвидео)tm-dialog: поддержка файлов, аудио и видео

В реплики можно добавлять аудио/файлы, управлять громкостью и скоростью, просматривать и скачивать файлы. Аудио совмещается с чекбоксами, мультивыбором, чипсами.

## [](#%5Fкомпонент%5Fсетки%5Ftm%5Fgrid%5Fи%5Fего%5Fсоставляющая%5Ftm%5Fgrid%5Fitem)Компонент сетки tm-grid и его составляющая tm-grid-item

Позволяет размещать элементы интерфейса в колонках, управлять шириной и расположением, добавлять адаптацию под устройства. Подробная настройка описана в Storybook.

## [](#%5Fскроллинг%5Fстраниц%5Fв%5Fсегментации%5Fpdf)Скроллинг страниц в сегментации PDF

В сегментации PDF добавлена прокрутка страниц.

## [](#%5Fназначение%5Fразметчиков%5Fв%5Fразных%5Fтипах%5Fзадач%5Fмассовое%5Fназначение)Назначение разметчиков в разных типах задач + массовое назначение

Теперь можно назначать исполнителей в обучении/экзамене, на контрольные/обучающие задания в основных/реабилитационных задачах; доступно массовое назначение.

## [](#%5Fплановое%5Fколичество%5Fразметчиков)Плановое количество разметчиков

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

## [](#%5Fкаталог%5Fшаблонов%5Fв%5Fмаркетплейсе)Каталог шаблонов в Маркетплейсе

Все шаблоны разметки теперь доступны в общем каталоге Маркетплейса. Можно выбрать шаблон при создании проекта или применить его после создания.

## [](#%5Fкорректировка%5Fперекрытия%5Fдо%5Fзапуска%5Fзадачи%5Fпри%5Fназначении%5Fисполнителей)Корректировка перекрытия до запуска задачи при назначении исполнителей

До запуска задачи заказчик сможет назначать разметчиков, а потом менять перекрытие по задаче. По заданию будет проставляться перекрытие равное максимальному значению между назначенными и перекрытием задачи. Применимо кроме случаев если по в явном виде изменено перекрытие по заданию или в момент назначение исполнителя выбрано "Увеличить перекрытие".

## [](#%5Fgigachat%5Fбот%5Fразметчик)GigaChat-бот-разметчик

Во всех инстансах доступен GigaChat-бот для разметки классификации/генерации. Запросите подключение бота в организацию в [tagme\_help@sberbank.ru](mailto:tagme%5Fhelp@sberbank.ru), добавьте инструкцию и интерфейс, включите бота в группу разметчиков и запустите задачу.

Релиз 4.5.0
====================
## [](#%5Fсохранение%5Fсозданных%5Fконтрольныхобучающих%5Fзаданий%5Fв%5Fразные%5Fзадачи)Сохранение созданных контрольных/обучающих заданий в разные задачи

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

## [](#%5Fредактор%5Fинструкции%5Fв%5Fmarkdown)Редактор инструкции в Markdown

Инструкцию можно писать в формате Markdown и переключаться между MD и HTML. Для бота MD читается лучше, у разметчиков остается без изменений.

## [](#%5Ftm%5Fdialog%5Fподдержка%5Fmarkdown%5Fи%5Fфункций)tm-dialog: поддержка Markdown и функций

В диалоги можно загружать текст в MD и использовать функции. Подробная настройка описана в Storybook.

## [](#%5Fкомпонент%5Ftm%5Fview%5Fдинамическое%5Fотображение)Компонент tm-view, динамическое отображение

Позволяет показывать дополнительные поля по условиям (name, value, or/and, равно/не равно). Подробная настройка описана в Storybook.

## [](#%5Ftm%5Fbutton%5Fgiga%5Fработа%5Fс%5Fфайлами%5Fcloud%5Fonly)tm-button-giga: работа с файлами (CLOUD-ONLY)

Можно загружать файлы для бота и он сможет их читать и выполнять задание. Основная настройка по `tm-button-giga`, добавляя атрибут `attachments`. Подробная настройка описана в Storybook.

## [](#%5Fвалидация%5Ftm%5Fкомпонентов)Валидация tm-компонентов

В HTML можно задавать условия валидации для tm-input, tm-textarea, tm-radio, tm-checkbox, tm-select, а также для аудио (`required-listened`, `min-listened-percent`) и видео (`required-watched`, `min-watched-percent`). Сначала работает валидация из HTML, затем из JS. Подробная настройка описана в Storybook.

## [](#%5Fjson%5Fрежим%5Fработы%5Fбота%5Fcloud%5Fonly)JSON-режим работы бота (CLOUD-ONLY)

Бот может выводить ответы в формате JSON.

## [](#%5Fновый%5Fраздел%5Fмои%5Fответы)Новый раздел «Мои ответы»

Разметчик видит комментарии заказчика к выполненным заданиям, комментарий становится виден автоматически при его добавлении/изменении/отклонении.

Релиз 4.6.0
====================
## [](#%5Fавтоматическое%5Fформирование%5Fоглавления)Автоматическое формирование оглавления

Инструкция автоматически собирает оглавление на основе заголовков H1–H3\. В проектах, созданных до релиза, оглавление сформируется автоматически, если заголовки уже были расставлены.

## [](#%5Fверсионирование%5Fинструкции%5Fчасть%5F1)Версионирование инструкции (часть 1)

Доступны версии инструкции в проекте и шаблоне: видно, когда была изменена, можно просматривать разные версии. При включённом автообновлении версии из шаблона помечаются как «Автообновление».

## [](#%5Fотдельный%5Fблок%5Fspecification%5Fновая%5Fлогика%5Fавтообновления)Отдельный блок Specification + новая логика автообновления

Блок Specification выделен в интерфейсе отдельно и управляется своими настройками автообновления. Его можно менять даже при запущенных задачах. В старых проектах автообновление Specification будет отключено по умолчанию.

## [](#%5Ftm%5Fimg%5Fcollector%5Fи%5Ftm%5Fvideo%5Fgeneration%5Fв%5Fstorybook)tm-img-collector и tm-video-generation в Storybook

Добавление компонентов в справочник.

## [](#%5Fинформация%5Fо%5Fперекрытии%5Fназначенных%5Fзаданиях%5Fи%5Fочереди)Информация о перекрытии, назначенных заданиях и очереди

На вкладке «Задания» появились поля «Перекрытие», «Назначенные», «В очереди», а также возможность изменить перекрытие у основного задания через модальное окно. В архивированных задачах данные фиксируются на момент архивации, при разархивации пересчитываются при необходимости.

## [](#%5Fуведомление%5Fпо%5Fонтологии)Уведомление по онтологии

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

Релиз 4.7.0
====================
## [](#%5Fпубликация%5Fassignments)Публикация assignments

Доступ для заказчика по ссылке. Заказчик теперь может открыть ту же ссылку, что и разметчик, его автоматически перенаправит в «Ответы разметчиков» на конкретный assignment. Доступ работает автоматически по ссылке вида `/marker/review/assignment/{id}`

## [](#%5Fверсионирование%5Fинструкции%5Fчасть%5F2)Версионирование инструкции (часть 2)

Заказчик видит тултип версии инструкции в «Ответы разметчиков», по которой разметчик выполнял задание, и наличие обновлений после выполнения. Разметчик в разделе «Мои ответы» может открыть инструкцию, увидеть дату версии и подсветку изменений.

## [](#%5Fверсионирование%5Fинтерфейса)Версионирование интерфейса

Вкладка «Интерфейс» теперь показывает историю изменений, можно откатываться к предыдущим версиям. На странице ответа разметчика и в разделе «Ответы разметчиков» отображается версия интерфейса, с которой разметчик начал выполнение.

## [](#%5Fшаблон%5Fдиалог%5Fс%5Fllm%5Fи%5Fчатом%5Ftm%5Fdialog%5Fendpoint)Шаблон «Диалог с LLM и чатом»: tm-dialog-endpoint

Позволяет создавать диалоги между пользователем и AI-пользователем: управлять началом диалога со стороны разметчика (вводить текст, записывать/вставлять аудио, добавлять документы), редактировать сообщения, запускать ответ AI и выбирать лучший вариант. Подробная настройка описана в Storybook.

Релиз 4.8.0
====================
## [](#%5Fначисление%5Fбонусов%5Fи%5Fштрафов%5Fразметчикам)Начисление бонусов и штрафов разметчикам

Назначение бонусов и штрафов разметчикам в рамках проекта и просмотр статистики начислений.

Чтобы попробовать пройти онбординг по этой функции, перейдите в раздел «Ответы разметчиков».[ Активировать тур ](/) 

## [](#%5Fпубличные%5Fгруппы%5Fразметчиков%5Fмежду%5Fорганизациями)Публичные группы разметчиков между организациями

Создание группы разметчиков и возможность поделиться ею с другими организациями, подключение осуществляется на уровне проекта. У групп и на проектах появляется иконка «Публичная», состав группы скрыт, виден только ID разметчиков.

Чтобы попробовать пройти онбординг по этой функции, перейдите в раздел «Группы разметчиков».[ Активировать тур ](/) 

## [](#%5Fпроверки%5Fумр%5Fпо%5Fвыполненным%5Fзаданиям)Проверки УМР по выполненным заданиям

Запуск проверки качества разметки по результатам задач через SDK. Для этого используются методы `validate_task_results` и `get_task_results_validation_info`. Доступны расчёты Криппендорфа, Спирмена, Дэвида-Скина, тест Стьюдента и доверительного интервала, статзначимость отличия метрик критерием Уилкоксона. Метрики считаются на целом сете и по отдельным тематикам.

## [](#%5Fонбординг%5Fдля%5Fзаказчика)Онбординг для заказчика

Доступен онбординг по новым фичам прямо на платформе. В сайдбар добавлен раздел «Что нового», в документации – запуск онбордингов.

Релиз 4.9.0
====================
## [](#%5Fсоздание%5Fгруппы%5Fисполнителей%5Fс%5Fпризнаком%5Fвалидатор)Создание группы исполнителей с признаком "Валидатор"

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

## [](#%5Fнастройка%5Fвыгрузки%5Fрезультатов)Настройка выгрузки результатов

При выгрузке результатов по задаче теперь можно настроить добавление статуса результатов в выгрузке (ACCEPTED, REJECTED, EXPIRED, SKIPPED, SUBMITTED), периода выгрузки выполнения заданий, типа задания, исполнителей и согласованности.

## [](#%5Fдата%5Fи%5Fдлительность%5Fразметки)Дата и длительность разметки

На странице review теперь можно увидеть дату и длительность выполнения задания.

## [](#%5Fувеличение%5Fколичества%5Fзнаков%5Fв%5Fкомментарий)Увеличение количества знаков в комментарий

Комментарии к ответам исполнителям теперь могут быть длиннее (до 2000 символов).

## [](#%5Fизменение%5Fокна%5Fнавыка)Изменение окна навыка

Минимальное значение окна навыка снижено до 1.

## [](#%5Fдобавление%5Fполя%5Fзаданий%5Fс%5Fкачеством)Добавление поля заданий с качеством

При выгрузке статистики по задачам и исполнителям добавлено поле "Кол-во заданий с качеством".

## [](#%5Fвкладка%5Fобзор%5Fи%5Fстатистика)Вкладка "Обзор" и "Статистика"

Доработаны вкладки "Обзор" и "Статистика" для учета бонуса по задачам.

История обновлений TagMe
====================
**Релизы 2026 года:**

* [Релиз 4.11.0](changelog-4-11-0.html)
* [Релиз 4.10.0](changelog-4-10-0.html)
* [Релиз 4.9.0](changelog-4-9-0.html)

**Релизы 2025 года:**

* [Релиз 4.8.0](changelog-4-8-0.html)
* [Релиз 4.7.0](changelog-4-7-0.html)
* [Релиз 4.6.0](changelog-4-6-0.html)
* [Релиз 4.5.0](changelog-4-5-0.html)
* [Релиз 4.4.0](changelog-4-4-0.html)
* [Релиз 4.3.0](changelog-4-3-0.html)
* [Релиз 4.2.0](changelog-4-2-0.html)
* [Релиз 4.1.0](changelog-4-1-0.html)
* [Релиз 4.0.0](changelog-4-0-0.html)
* [Релиз 3.25.0](changelog-3-25-0.html)

**Релизы 2024 года:**

* [Релиз 3.11.0](changelog-3-11-0.html)
* [Релиз 3.10.0](changelog-3-10-0.html)
* [Релиз 3.9.0](changelog-3-9-0.html)
* [Релиз 3.8.6](changelog-3-8-6.html)

Шаблонизатор Handlebars
====================
Мы поддерживаем генерацию компонентов с использования шаблонизатора Handlebars. Основной кейс использования таких компонентов — это миграция шаблонов из Толоки. Рекомендуется использовать [TM-компоненты](../dev/storybook/storybook.html).

Пример:

```html
<tm-block>
  <h1> Видео </h1>
  {{media type="video" src=video }}

  <h1> Аудио </h1>
   {{media type="audio" src=audio }}

  <h1> Диалоги </h1>
  {{custom type="dialog" messages=dialogJson.messages}}


    <tm-title>
      Выберите эмоциональный контекст сообщения:
    </tm-title>
    {{field type="radio" name="emotion" value="1" label="Нейтральный" hotkey="1"}}
    {{field type="radio" name="emotion" value="2" label="Агрессивный" hotkey="2"}}
    {{field type="radio" name="emotion" value="3" label="Веселый" hotkey="3"}}

    <tm-title>
      Добавьте описание
    </tm-title>
    {{field type="input" name="text" hotkey="0" width="90%"}}

    <tm-title>
      Есть ли в записи иностранные слова/имена/названия?:
    </tm-title>
    <div>{{field type="checkbox" name="has_english" label="Да" value="1" hotkey="8"}}</div>
    <div>{{field type="checkbox" name="has_english" label="Нет" value="0" hotkey="9"}}</div>
</tm-block>
```

Контрольные и обучающие задания
====================
С помощью контрольных и обучающих заданий вы можете контролировать [качество работы разметчиков](quality-consistency.html) прямо в процессе выполнения задачи. Такие задания будут выдаваться разметчику случайным образом.

Контрольное задание — задание с автоматической проверкой ответа. Разметчик не узнает, что задание было контрольным, но если он сделает ошибку, это понизит его [уровень навыка](skills.html).

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

## [](#%5Fсоздаем%5Fконтрольные%5Fи%5Fобучающие%5Fзадания)Создаем контрольные и обучающие задания

После того, как вы загрузили [основное задание](uploading-data.html), вы можете превратить его в контрольное или обучающее двумя способами:

1. В интерфейсе заданий:  
   * Нажмите **Подготовить контрольные и обучающие** на вкладке **Задания** или в списке заданий.  
   * В открывшемся задании укажите правильные ответы, а также добавьте подсказку, если задание обучающее.  
   * Нажмите **Сохранить**. Если в задаче несколько заданий, вы можете перемещаться между ними с помощью стрелок в верхней части страницы.
2. В редакторе атрибутов:  
   * Перейдите в список заданий на вкладке **Задания**.  
   * Нажмите кнопку меню в строке нужного задания и выберите **Открыть атрибуты**.  
   * В открывшемся окне добавьте правильные ответы — JSON с типом `control`, а также подсказку, если задание обучающее, — JSON с типом `explanation`.

Верстка интерфейса
====================
Вы можете самостоятельно создать интерфейс формы заданий, используя [tm-компоненты](../dev/storybook/storybook.html) платформы, или воспользоваться [готовыми шаблонами](templates.html).

| |  Также вы можете использовать код интерфейсов из Толоки. Для этого измените имя класса — замените TolokaHandlebarsTask на HandlebarsTask. |
| ------------------------------------------------------------------------------------------------------------------------------------------- |

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

Для верстки с нуля и используйте следующие поля:

* **[HTML](interface-html.html)** – блок для верстки описания заданий. В блок можно добавлять код не только в формате HTML, но и на языке для создания шаблонов Handlebars.
* **[CSS](interface-css.html)** – блок для задания уникальных стилей верстки. Не обязательно заполнять.
* **[JavaScript](interface-api.html)** – блок для настройки валидации и редактирования входных и выходных данных с использованием встроенного API.
* **[Config](interface-config.html)** – блок для указания ссылок на внешние библиотеки, а также списка классов и онтологии в задачах сегментации. Чтобы задать справочник отдельно для конкретной задачи, можно использовать [SDK](../sdk/examples.html#%5Fсоздание%5Fи%5Fзапуск%5Fзадачи%5Fс%5Fсобственными%5Fклассами).
* **[Specification](interface-specification.html)** — блок для задания правил расчета [качества и согласованности](quality-consistency.html) в заданиях.
* **[Example data](interface-example-data.html)** – блок для данных, которые будут отображаться при предпросмотре.

После того как вы заполнили поля или выбрали шаблон, нажмите **Предпросмотр** и проверьте, как выглядит созданная форма. Чтобы сохранить выбранный интерфейс, нажмите **Сохранить изменения**.

| |  Верхняя панель формы имеет фиксированный вид, вы не можете его изменить. С помощью верхней панели разметчик может просмотреть инструкцию, отправить или пропустить задание и вернуться к проекту. |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

DataMapping для загруженных файлов
====================
Поле `dataMapping` в блоке [Config](interface-config.html) позволяет указать переменную, по которой будет доступна ссылка на загруженные объекты разметки: аудио-, видео-, текстовые файлы или изображения. Подробнее о загрузке файлов — в разделе [Загрузка файлов](uploading-data.html).

## [](#%5Fпараметры%5Fdatamapping)Параметры dataMapping

| Параметр | Обязательность | Тип    | Описание                                                                                                                         |
| -------- | -------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------- |
| fileUrl  | Нет            | string | Используется для переопределения поля со ссылкой на файл. Значение по умолчанию — filename                                       |
| fileData | Нет            | string | Используется для переопределения поля с распаршенными данными из файла, например, HTML или TXT. Значение по умолчанию — fileData |

## [](#%5Fпримеры%5Fdatamapping)Примеры dataMapping

Использование dataMapping в конфиге

```json
{
    "dataMapping": {
        "fileData": "data-variable",
        "fileUrl": "data-url"
    }
}
```

Использование dataMapping в шаблоне

```html
<tm-text>{{{data-variable}}}</tm-text>
```

## [](#%5Fjson%5Fфайлы)JSON-файлы

Все поля JSON-файлов можно использовать в редакторе интерфейса в блоке [HTML](interface-html.html).

Пример:

file1.json

```json
{
    "data-text": "Мама мыла раму",
    "data-description": "Описание"
}
```

HTML

```html
<tm-block title="Прочитайте текст">
    <tm-text>
        {{{data-text}}}
        {{{data-description}}}
    </tm-text>
    ...
```

## [](#%5Fтекстовые%5Fфайлы)Текстовые файлы

Вы можете загружать в задание текстовые файлы — TXT и HTML, поддерживаемые в интерфейсе. Например, дополнительно к предыдущему файлу (назовем его **file1.json**) можно загрузить текстовый файл **file2.txt**.

Чтобы использовать данные из текстового файла в нужной переменной, опишите их в блоке **Config** с помощью поля [dataMapping](#). Укажите в поле `fileData` имя переменной, по которому будут доступны данные из файла.

CONFIG

```json
{
    "input_data_category": "text",
    "dataMapping": {
        "fileData": "data-text"
    }
}
```

## [](#%5Fдругие%5Fформаты%5Fфайлов)Другие форматы файлов

По умолчанию ссылка на файл форматов JPG, MP4, MP3 и т. д. будет доступна через переменную `filename`. Вы можете переопределить переменную с помощью поля `fileUrl` в объекте [dataMapping](#) в блоке **Config** на вкладке **Интерфейс**.

CONFIG

```json
{
    "dataMapping": {
        "fileUrl": "data-url"
    }
}
```

HTML

```html
<tm-forms-video src="{{{data-url}}}"></m-forms-video>
```

Датасеты
====================
Вы можете загружать файлы на портал TagMe в виде датасетов и затем использовать их в задачах и инструкциях.

## [](#%5Fограничения)Ограничения

Максимальный размер загружаемого файла: 500 Мб. Количество файлов не ограничено.

Нельзя загружать файлы следующих форматов: apk, app, bat, bin, cgi, cmd, com, cpp, js, jse, exe, gadget, gtp, hta, jar, msi, msu, paf, paf.exe, pif, ps1, pwz, scr, thm, vb, vbe, vbs, wsf.

## [](#%5Fзагрузка%5Fдатасетов)Загрузка датасетов

Чтобы загрузить файлы:

1. Перейдите в раздел **Датасеты**.
2. Нажмите **Создать датасет**.
3. Введите название датасета.
4. Нажмите **Создать**. Вам откроется созданный датасет.
5. Загрузите файлы с компьютера в датасет: нажмите **Выберите** или перетащите файлы из папки.

## [](#%5Fиспользование%5Fфайлов%5Fиз%5Fдатасетов)Использование файлов из датасетов

Чтобы использовать файлы датасета в задании:

1. Откройте датасет.
2. Нажмите **Скачать**.
3. Выберите формат таблицы со ссылками: XLSX или CSV.
4. Загрузите таблицу в задание. Подробнее о загрузке читайте в разделе [Задания для разметки](uploading-data.html).

Вы также можете использовать ссылки на отдельные файлы:

1. Откройте датасет.
2. Нажмите кнопку меню в строке выбранного файла.
3. Выберите **Скопировать ссылку**.
4. Добавьте скопированную ссылку в инструкцию или в таблицу для загрузки заданий.

Результаты разметки
====================
## [](#%5Fпосмотреть%5Fрезультаты)Посмотреть результаты

После запуска задачи вы можете следить за результатами разметки на вкладке **Ответы разметчиков**. Здесь отображается подробная информация о заданиях:

* Задание — название и идентификатор объекта.
* Статус — состояние ответа разметчика: "ожидает проверки", "принят", "отклонён", "назначен/на доработке".
* Тип — типа задания: контрольное или основное.
* Разметчик — электронный адрес разметчика.
* Время ответа — дата и время завершения разметки задания этим разметчиком.
* Длительность разметки — время, потраченное разметчиком на разметку этого задания.
* Согласованность — согласованность ответов разметчиков. Подробнее о расчете — в разделе [Качество и согласованность](quality-consistency.html)
* Качество — качество разметки. Указывается только для контрольных заданий. Подробнее о расчете — в разделе [Качество и согласованность](quality-consistency.html)
* Комментарий — комментарий заказчика при принятии или отклонении заданий, направляются разметчику как обратная связь по заданию в "Мои ответы".

Чтобы посмотреть ответ разметчика, нажмите на строку выбранного задания — вам откроется интерфейс задания с ответами разметчика. Если это контрольное задание, вы также можете посмотреть правильный ответ. Для этого в верхней части экрана отметьте радиокнопку **Правильный ответ**.

| |  Вкладка **Ответы разметчиков** не отображается для задач со статусом **В архиве**. О статусах задач читайте в разделе [Жизненный цикл задачи](task-flow.html). |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |

## [](#%5Fскачать%5Fрезультаты)Скачать результаты

Чтобы скачать результаты разметки, перейдите в задачу, нажмите **Результаты** и выберите формат файла: **JSON**, **JSON - старый формат**, **XLSX**, **TSV** или **CSV**.

В файле будут все размеченные на момент выгрузки данные, даже если они не достигли заданного показатели перекрытия.

| |  Скачать результаты в форматах **JSON**, **XLSX**, **TSV** и **CSV**, можно только для тех задач, которые создали после 1 января 2023 года. |
| --------------------------------------------------------------------------------------------------------------------------------------------- |

**Поля файла выгрузки JSON:**

| **Поле**                 | **Описание**                                                                                                                                                                                                        |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| task\_id                 | Идентификатор задачи                                                                                                                                                                                                |
| task\_type               | Тип задачи                                                                                                                                                                                                          |
| file\_name               | Название размечаемого файла                                                                                                                                                                                         |
| organization\_id         | Идентификатор подразделения-заказчика разметки                                                                                                                                                                      |
| person\_id               | Идентификатор автора задания на разметку                                                                                                                                                                            |
| item\_id                 | Идентификатор задания                                                                                                                                                                                               |
| item\_type               | Тип задания                                                                                                                                                                                                         |
| assignment\_id           | Идентификатор объекта разметки                                                                                                                                                                                      |
| status                   | Статус разметки объекта (SUBMITTED — объект размечен и ожидает проверки, REJECTED — результат разметки отклонен, ACCEPTED - результат разметки принят, EXPIRED - разметка просрочена, SKIPPED - разметка пропущена) |
| marker\_id               | Идентификатор разметчика                                                                                                                                                                                            |
| start\_date              | Дата и время начала разметки                                                                                                                                                                                        |
| end\_date                | Дата и время завершения разметки                                                                                                                                                                                    |
| control\_passed          | Результат проверки контрольного задания (true — верный ответ, false — неверный ответ). Заполняется только для контрольного задания                                                                                  |
| pool\_ids                | Список идентификаторов групп разметки                                                                                                                                                                               |
| price                    | Стоимость задания                                                                                                                                                                                                   |
| consistency              | Рассчитанный процент согласованности ответов. Бинарное сравнение ответов разметчиков                                                                                                                                |
| quality                  | Качество разметки                                                                                                                                                                                                   |
| submitted\_at            | Дата и время отправки задания                                                                                                                                                                                       |
| skipped\_at              | Дата и время, когда было пропущено задание                                                                                                                                                                          |
| expired\_at              | Дата и время, когда задание истекло                                                                                                                                                                                 |
| accepted\_at             | Дата и время, когда задание было принято                                                                                                                                                                            |
| rejected\_at             | Дата и время, когда задание было отклонено                                                                                                                                                                          |
| started\_at              | Дата и время, когда разметчик начал разметку                                                                                                                                                                        |
| reviewer\_id             | Идентификатор пользователя, который оставил комментарий                                                                                                                                                             |
| reviewer\_comment        | Текст комментария                                                                                                                                                                                                   |
| is\_review\_public       | Виден (True) или не виден (False) комментарий разметчику                                                                                                                                                            |
| original\_assignment\_id | Идентификатор ответов исполнителей, которые были направлены на доработку, исправлены заказчиком или переназначены на другого исполнителя                                                                            |
| OUTPUT:<data field>      | Описание меток в соответствии с заданием при выгрузке в форматах XSLX, CSV и TSV                                                                                                                                    |
| GOLDEN:<data field>      | Правильные ответы на контрольные задания при выгрузке в форматах XSLX, CSV и TSV                                                                                                                                    |

Частые вопросы
====================
## [](#%5Fзадача%5Fотображается%5Fнекорректно)Задача отображается некорректно

Проверьте, что вы работаете в одном из поддерживаемых браузеров:

* Google Chrome,
* Safari,
* Mozilla Firefox,
* Yandex Browser.

## [](#%5Fразметчик%5Fне%5Fвидит%5Fзадачу)Разметчик не видит задачу

Проверьте, что:

1. Разметчик есть в группе, которая назначена на проект. Если нет — [добавьте](adding-marker.html).
2. Убедитесь, что [уровень навыка](skills.html) разметчика выше, чем уровень фильтрации по навыку, указанный в [настройках](settings.html) задачи.

## [](#%5Fне%5Fмогу%5Fдобавить%5Fразметчика%5Fв%5Fгруппу)Не могу добавить разметчика в группу

Чтобы добавить разметчиков в группу, сначала [пригласите](adding-marker.html) их в компанию, а затем подтвердите их прием на вкладке **Заявки** в разделе **Участники**.

## [](#%5Fкакие%5Fзадания%5Fучитываются%5Fв%5Fнавыке%5Fразметчика)Какие задания учитываются в навыке разметчика?

Если вы включили в задаче контроль качества, то в навыке разметчика будут учитываться [контрольные и обучающие](control-task.html) задания.

## [](#%5Fчем%5Fобучающие%5Fзадания%5Fотличаются%5Fот%5Fконтрольных)Чем обучающие задания отличаются от контрольных?

Отличие только одно — при ошибке в обучающем задании разметчику отобразится подсказка, а при ошибке в контрольном — нет.

## [](#%5Fможет%5Fли%5Fразметчик%5Fисправить%5Fответ%5Fв%5Fобучающем%5Fзадании)Может ли разметчик исправить ответ в обучающем задании?

Нет. Если разметчик сделал ошибку в обучающем задании, ему отобразится подсказка и он перейдет к следующему заданию.

## [](#%5Fкак%5Fрассчитывается%5Fнавык%5Fесли%5Fв%5Fзадании%5Fнесколько%5Fвопросов)Как рассчитывается навык, если в задании несколько вопросов?

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

## [](#%5Fможно%5Fли%5Fзагрузить%5Fдополнительные%5Fданные%5Fв%5Fзапущенную%5Fили%5Fзавершенную%5Fзадачу)Можно ли загрузить дополнительные данные в запущенную или завершенную задачу?

Да. Если задача завершена, то вы можете загрузить новые данные, после этого статус задачи автоматически изменится на «Остановлена». Если задача в статусе «Идёт разметка», то сначала остановите ее, а затем загружайте новые данные.

## [](#%5Fпочему%5Fразметчики%5Fне%5Fполучают%5Fконтрольные%5Fили%5Fобучающие%5Fзадания)Почему разметчики не получают контрольные или обучающие задания?

Проверьте, что в проекте:

1. Контрольная или обучающая задача запущена.
2. В [настройках](settings.html) основной задачи включен переключатель **Выдача контрольных и обучающих заданий**.

## [](#%5Fесли%5Fя%5Fостановлю%5Fзадачу%5Fто%5Fработающие%5Fс%5Fней%5Fразметчики%5Fсразу%5Fперейдут%5Fк%5Fследующей%5Fзадаче)Если я остановлю задачу, то работающие с ней разметчики сразу перейдут к следующей задаче?

Да, если это основная задача. Разметчики закончат выполнять задание, которое уже начали, но им не отобразятся другие задания остановленной задачи.

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

## [](#%5Fчто%5Fбудет%5Fесли%5Fзапустить%5Fзадачу%5Fc%5Fболее%5Fвысоким%5Fприоритетом%5Fчем%5Fта%5Fкоторая%5Fуже%5Fразмечается)Что будет, если запустить задачу c более высоким приоритетом, чем та, которая уже размечается?

Разметчики автоматически переключатся на более приоритетную задачу.

Руководство заказчика
====================
### [ Быстрый старт](/docs/customer/quick-start.html) 

 Создаем и запускаем новую задачу на разметку данных

### [ Разработка интерфейса](/docs/customer/creating-interface.html) 

 Советы по верстке, шаблоны и примеры

### [ Подготовка инструкций](/docs/customer/manual.html) 

 Как подготовить инструкцию для получения качественных результатов

### [ Подготовка заданий](/docs/customer/uploading-data.html) 

 Как загрузить данные для разметки и дополнительные атрибуты

### [ Запуск и остановка задач](/docs/customer/start.html) 

 Как подготовить и запустить задачи разметки

### [ Управление качеством](/docs/customer/training-examination.html) 

 Обучаение разметчиков, навыки и настройки задачи

### [ Управление организацией](/docs/customer/adding-marker.html) 

 Назначение разметчиков, настройки проекта

### [ Результаты разметки](/docs/customer/downloading-data.html) 

 Как скачать и интерпретировать результаты разметки

### [ Статистика](/docs/customer/statistics.html) 

 Полная информация о проектах и ходе разметки

### [ Частые вопросы](/docs/customer/faq.html) 

 Если возникли проблемы

### [ История обновлений](/docs/customer/changelog.html) 

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

Блок JavaScript
====================
Блок для настройки шаблона с использованием встроенного API для валидации и редактирования входных и выходных данных. Для этого предусмотрен базовый класс `Task`. Чтобы добавить дополнительную логику, его можно переопределить:

```javascript
exports.Task = class Task extends exports.Task {
    // Здесь будут ваши методы для переопределения валидации и т. п.
}
```

## [](#%5Fосновные%5Fпараметры)Основные параметры

* **onRender()** — вызывается после каждой отрисовки формы. Это поле необходимо переопределить.
* **getDOMElement()** — возвращает корневой родительский HTML элемент.
* **getTemplateData()** — возвращает объект со свойствами, использующийся в HTML шаблоне.
* **saveMarkupToStorage()** — сохраняет текущий результат разметки в localStorage.
* **validate(result)** — вызывается перед отправкой результатов формы. Возвращается `true`, если данные формы заполнены правильно, иначе — `false` или объект с сообщением об ошибке. `result` представляет собой объект с ключом `output_values`, в котором находятся результаты формы. Это поле необходимо переопределить.
* **transform(result)** — вызывается после валидации результатов и позволяет преобразовать их.

Пример result

```javascript
{
    output_values: {
        field1: "содержимое первого поля",
        field2: "содержимое второго поля"
    }
}
```

## [](#%5Fвалидация%5Fрезультатов)Валидация результатов

Для валидации результатов необходимо в классе `Task` определить метод `validate`.

Пример валидации единственного поля text

```javascript
validate(result) {
    const text = result['text']
    if (!text) {
        return "Пожалуйста, заполните текстовое поле"
    }
    return true
}
```

## [](#%5Fпреобразование%5Fрезультатов)Преобразование результатов

Для преобразования результатов перед отправкой необходимо в классе `Task` определить метод `transform`.

Пример добавления поля text из исходного задания

```javascript
transform(result) {
    const templateData = this.getTemplateData()

    return Object.assign(result, { taskText: templateData.text })
}
```

## [](#%5Fобертка%5Fдля%5Fсвоих%5Fскриптов)Обертка для своих скриптов

Если вам нужно запустить что-то сложное или воспользоваться API для получения и отправки результатов напрямую в обход формы:

```javascript
exports.Task = class MyTask {
    constructor({ el, task, setResult }) {
        // el - корневой HTML-элемент задания
        // task - объект с описанием задания, содержит ссылку на файл задания: {"filename": "https://..."}
        // setResult - функция для отправки результата
    }

    submit() {
        // метод submit вызывается при нажатии на кнопку отправки результата
    }
}
```

При использовании этого примера HTML и CSS поля из формы игнорируются и не используются.

Интерфейс из бандла
====================
Иногда возникает необходимость использовать разрабатываемые вне платформы интерфейсы разметки. Такие интерфесы могу быть созданы с использованием любых технологий.

Бандл — это html-файл, внутри которого находится содержимое файлов css и js.

## [](#%5Fподготовка%5Fбандла)Подготовка бандла

Для сборки html-файла со всеми ресурсами вы можете использовать любой удобный способ или воспользоваться [скриптом](%5Fattachments/prepareBuild.js):

1. Для использования скрипта вам потребуется node.js.
2. Разместите скрипт в той же директории, что и папка **build**.
3. Запустите в консоли команду `node prepareBuild.js`.

После успешного выполнения скрипта в той же директории, где находится скрипт, будет сгенерирован файл index.html со всеми ресурсами внутри.

| |  Скрипт работает только для файлов, которые указаны в тегах <script> и <link> в вашем html-файле. По умолчанию путь до директории с билдом — ./build. Вы можете изменить его, задав новый путь в качестве аргумента node prepareBuild.js ./new\_path\_to\_build. |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

## [](#%5Fзагрузка%5Fбандла)Загрузка бандла

Чтобы загрузить бандл, нажмите на кнопку **Загрузить Bundle**:

![upload bundle](_images/upload-bundle.png) 

Перед вами появится модальное окно, в котором вы можете:

* загрузить новый html-файл. В этом случае произойдет обновление всех полей интерфейса
* обновить существующий html-файл. В таком случае обновления полей интерфейса не произойдет. Обновится лишь содержимое по ссылке указанной в поле `bundleSrc` в секции `CONFIG`

![upload bundle modal](_images/upload-bundle-modal.png) 

| |  Все бандлы загружаются в датасет с именем interface\_bundles. Если такого датасета не существует, то он будет создан автоматически |
| ------------------------------------------------------------------------------------------------------------------------------------- |

## [](#%5Fиспользования%5Fapi%5Fв%5Fбандлах)Использования API в бандлах

Для удобства отладки бандлов можно задавать примеры данных в блоке [Example data](interface-example-data.html). При запуске задачи ожидается, что аналогичные примеры входных данных будут поданы на вход вашего шаблона разметки.

Example data

```javascript
{
    "context": [...]
}
```

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

Config

```javascript
{
    "entities": [...]
}
```

Для общения основного приложения TagMe со сторонним приложением используется внутренний API, который будет доступен через `window.parent.tmAPI`. API используется для получения данных задачи, валидации и отправке результат разметки и показа ошибок.

### [](#%5Fсвойства)Свойства

* `task` — содержит данные задания: из реальных данных с платформы или из [Example data](interface-example-data.html).

| **Параметр** | **Обязательность** | **Описание**                                                                                   |
| ------------ | ------------------ | ---------------------------------------------------------------------------------------------- |
| data         | Да                 | Данные для задания. Уникальное для каждого задания                                             |
| config       | Да                 | Конфигурация интерфейса проекта. Заполняется в поле CONFIG                                     |
| meta         | Да                 | Дополнительная информация о задании                                                            |
| token        | Нет                | Токен задания. Используется для запросов к стораджу. Имеет значение только на экране разметки. |
| premarkup    | Да                 | Предразметка задания. Уникальное для каждого задания                                           |

* `task.meta`

| **Параметр**    | **Обязательность** | **Описание**                                                                                       |
| --------------- | ------------------ | -------------------------------------------------------------------------------------------------- |
| userId          | Да                 | id пользователя                                                                                    |
| taskId          | Нет                | id задачи                                                                                          |
| stage           | Да                 | Экран разметки. Возможные значения "preview", "preview\_task", "prepare\_task", "result", "markup" |
| isControlAnswer | Нет                | На экране "result" показывает контрольное это задание или нет.                                     |

### [](#%5Fметоды)Методы

* `onSubmit` \- функция, которая вызывается перед отправкой результата для получения данных из бандла. Ожидает объект в качестве возвращаемого значения.
* `onValidate` \- функция, которая вызывается перед отправкой результата. Проверяет валидность результирующих данных. Ожидаемые занчения: `true` если данные валидные, `string` если данные не валидные и есть текст ошибки валидации, `false` если данные не валидные (будет показана дефолтная ошибка валидации)
* `saveMarkupToStorage` \- функция, сохраняющая текущий результат разметки в localStorage. Сохраненный результат будет использоваться в качестве предразметки.

Пример

```javascript
    window.parent.tmAPI.onValidate =  () => {
        if (typeof values !== 'object') return "Не верный формат данных"

        if (Object.values(values).some((value) => value === undefined)) {
            return "Вы оценили не все параметры!"
        }

        return true
    }

    window.parent.tmAPI.onSubmit = () => {
        return result_from_bundle
    }
```

* `setError(error)` — устанавливает ошибку, в качестве параметра принимает объект, содержащий 3 поля:  
   * **message** — заголовок ошибки;  
   * **description** — описание ошибки;  
   * **details** — дополнительные данные об ошибке.  
   * **stack** — stack trace ошибки.

Пример

```javascript
    window.parent.tmAPI.setError({
            message: 'При формировании задания произошла ошибка',
            description:
                'Мы пометим, что это задание привело к ошибке, и проигнорируем его в результатах.\n Пожалуйста, перейдите к следующему заданию',
            stack: error.stack,
            details: {
                name: error.name,
                message: error.message,
                componentStack: error.componentStack
            }
        })
```

![bundle error](_images/bundle-error.png) 

Пример результата разметки при ошибке

```json
{
  "result": {
    "error": {
      "message": "При формировании задания произошла ошибка",
      "description": "Мы пометим, что это задание привело к ошибке, и проигнорируем его в результатах.\n Пожалуйста, перейдите к следующему заданию",
      "details": {
        "name": "Error",
        "message": "Synthetic error",
        "componentStack": "\n    at Bi (about:srcdoc:62:57436)\n    at Md (about:srcdoc:62:58715)\n    at div\n    at Od (about:srcdoc:62:57519)"
      },
      "stack": "Error: Synthetic error\n    at about:srcdoc:62:57457\n    at al (about:srcdoc:62:24194)\n    at Jn (about:srcdoc:62:42084)\n    at wd (about:srcdoc:62:40937)\n    at Sn (about:srcdoc:62:39999)\n    at Fi (about:srcdoc:62:36680)\n    at vn (about:srcdoc:60:3267)\n    at about:srcdoc:62:34080"
    }
  },
  "status": "error"
}
```

| |  Все не перехваченные ошибки внутри приложения перехватываются на уровне iframe. |
| ---------------------------------------------------------------------------------- |

Блок Config
====================
В блоке **Config** вы можете добавить ссылки на внешние библиотеки, а также настроить классы и онтологию в задачах сегментации.

Подробнее о верстке задач сегментации читайте в разделе [Интерфейс сегментации](interface-segmentation.html).

**Основные параметры:**

| Параметр              | Обязательность | Тип        | Описание                                                                                                                        |
| --------------------- | -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------- |
| type                  | Нет            | string     | Тип шаблона. Служебное поле                                                                                                     |
| input\_data\_category | Нет            | string     | Тип входных данных шаблона. Служебное поле                                                                                      |
| title                 | Нет            | string     | Заголовок шаблона                                                                                                               |
| shortDescription      | Нет            | string     | Краткое описание шаблона                                                                                                        |
| dataMapping           | Нет            | object     | Позволяет переопределить поля, используемые в шаблоне. Подробнее — в разделе [DataMapping загруженных файлов](datamapping.html) |
| libraries             | Нет            | string\[\] | Массив с адресами JS-библиотек                                                                                                  |
| submitOnEnter         | Нет            | boolean    | Включение/отключение отправки задания по клавише enter. По умолчанию true.                                                      |
| markupAutosave        | Нет            | boolean    | Включение/отключение автосохранения разметки. Интервал сохранения 1 минута. По умолчанию true.                                  |

Блок CSS
====================
Блок для задания уникальных стилей верстки.

С помощью стилей можно, например, управлять шириной боковых панелей в [шаблонах сегментации](interface-segmentation.html):

```css
/* Установка ширины панели с классами */

.form-entities {
    min-width: 350px;
}

.form-annotation {
    min-width: 350px;
}
```

Блок Example data
====================
В этот блоке вы можете указать тестовые данные для задания, которые будут отображаться при предпросмотре шаблона. Например:

```JSON
{
  "text": "Привет! Как дела?"
}
```

Название поля (например, text) должно соответствовать названию переменной в блоке HTML:

```HTML
<tm-text>
        {{{text}}}
</tm-text>
```

Вы также можете скачать файл с тестовыми данными в формате JSON, TSV или CSV и использовать его как пример для [создания задания](uploading-data.html).

Настройка шаблонов генерации
====================
![generation](_images/generation.png) 

Шаблоны настраиваются в проекте на вкладке **Интерфейс**. Общие параметры настройки интерфейса описаны в разделе [Блок Config](interface-config.html).

Специфические настройки для шаблонов генерации можно сделать в блоке [HTML](interface-html.html).

## [](#%5Fсоздание%5Fизображений)Создание изображений

Чтобы настроить шаблон создания изображений, используйте компонент `tm-img-collector` с атрибутами:

| **Параметр** | **Обязательность** | **Описание**                                                                  |
| ------------ | ------------------ | ----------------------------------------------------------------------------- |
| name         | Да                 | Ключ в результатах разметки                                                   |
| minCount     | Нет                | Минимальное количество изображений, которые разметчик может загрузить в блок  |
| maxCount     | Нет                | Максимальное количество изображений, которые разметчик может загрузить в блок |

Вы можете добавить несколько блоков создания изображений.

## [](#%5Fзапись%5Fречи)Запись речи

Чтобы настроить шаблон записи речи, используйте компонент [tm-title](content-in-interface.html#%5Ftitle) и `tm-recorder` с атрибутами:

| **Параметр** | **Обязательность** | **Описание**                                                                                                                                                                                                                                   |
| ------------ | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name         | Нет                | Ключ в результатах разметки                                                                                                                                                                                                                    |
| hotkeys      | Нет                | Горячие клавиши. Укажите четыре буквенные клавиши, которые будут вызывать следующие действия: — открытие окна загрузки файла; — начало и остановка записи; — начало или остановка проигрывания записанного аудио; — удаление записанного аудио |

**Пример:**

```html
<tm-recorder name="speech" hotkeys="ursd"></tm-recorder>
```

## [](#%5Fгенерация%5Fвидео)Генерация видео

Чтобы настроить шаблон генерации видео, используйте компонент `tm-video-generation` и его атрибуты:

| **Параметр** | **Обязательность** | **Описание**                                                                                                                                                                                                                                                                                     |
| ------------ | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| src          | Нет                | Ссылка на пример видео для разметчиков                                                                                                                                                                                                                                                           |
| text         | Нет                | Текстовое описание задания для разметчиков                                                                                                                                                                                                                                                       |
| uploadButton | Нет                | Возможность добавить кнопку загрузки файла                                                                                                                                                                                                                                                       |
| cameraButton | Нет                | Возможность добавить кнопку записи видео                                                                                                                                                                                                                                                         |
| idealWidth   | Нет                | Возможность установить разрешение видео для записи. Разрешение по умолчанию: 1280 x 720                                                                                                                                                                                                          |
| facingMode   | Нет                | Возможность установить приоритетную камеру для записи. Возможные значения: \- user — камера направлена на пользователя; \- environment — камера направлена от пользователя; \- left — камера направлена на пользователя и чуть левее; \- right — камера направлена на пользователя и чуть правее |

Вы также можете добавить в компонент `tm-video-generation` прочие [компоненты для отображения контента](content-in-interface.html). Они отобразятся над блоком генерации.

Пример:

```html
<tm-video-generation src="{{video}}" text="Посмотрите пример:" uploadButton="true" cameraButton="true" idealWidth="640" facingMode="user">
    <tm-title>Заполните поле</tm-title>
    <tm-input name="text" hotkey="0" placeholder="Пример заполнения"></tm-input>
</tm-video-generation>
```

## [](#%5Fгенерация%5Fтекста)Генерация текста

Чтобы настроить шаблон генерации текста, используйте [компоненты для отображения контента](content-in-interface.html).

## [](#%5Fзагрузка%5Fфайлов)Загрузка файлов

Чтобы настроить шаблон загрузки файлов, используйте компонент `tm-file-collector` и его атрибуты:

| **Параметр**   | **Обязательность** | **Описание**                                                                         |
| -------------- | ------------------ | ------------------------------------------------------------------------------------ |
| name           | Да                 | Системное имя блока. Результаты в выгрузке будут находиться в объекте с этим именем. |
| minCount       | Нет                | Минимальное количество файлов.                                                       |
| maxCount       | Нет                | Максимальное количество файлов.                                                      |
| minFileSize    | Нет                | Минимальный размер каждого файла по отдельности.                                     |
| maxFileSize    | Нет                | Максимальный размер каждого файла по отдельности.                                    |
| minFileSizeSum | Нет                | Минимальный размер всех файлов.                                                      |
| maxFileSizeSum | Нет                | Максимальный размер всех файлов.                                                     |
| allowedFormats | Нет                | Расширения файлов допустимые для выбора в компоненте.                                |
| maxFileSizeSum | Нет                | Максимальный размер всех файлов.                                                     |
| multilineFile  | Нет                | Написание имени файла в несколько строк.                                             |

Настройка горячих клавиш
====================
Горячие клавиши позволяют разметчикам ускорить работу. Некоторые горячие клавиши встроены в интерфейс по умолчанию и их нельзя изменить, например, Space для запуска или остановки воспроизведения аудио.

Функции, для которых можно настроить горячие клавиши:

* Выбор варианта ответа — параметр `hotkey` в блоке [HTML](interface-html.html).
* Выбор класса в шаблонах сегментации — параметр `hotKey` в блоке [Config](interface-config.html).

Блок HTML
====================
Блок для верстки описания заданий.

В этом блоке вы можете:

1. Верстать задания в формате HTML.
2. Использовать для верстки заданий TM-компоненты TagMe. Подробнее — в разделе [TM-компоненты](../dev/storybook/storybook.html).
3. Настроить отображение данных с помощью библиотеки Handlebars. Документацию по Handlebars можно найти на официальном сайте: <https://handlebarsjs.com>.

Подключение JS-библиотек
====================
Чтобы подключить JS-библиотеку, перейдите в проект на вкладку **Интерфейс** и укажите адрес библиотеки в блоке [Config](interface-config.html) в атрибуте `libraries`. Вы можете подключить несколько библиотек. В случае проблем с доступом в консоли браузера отобразится причина ошибки.

Пример интерфейса для вывода случайного идентификатора (UUID) с подключением внешней библиотеки uuid.js:

Заполнение блока Config для подключения библиотеки

```json
{ "libraries": [ "https://cdnjs.cloudflare.com/ajax/libs/uuid/8.3.2/uuid.min.js" ]}
```

Заполнение блока HTML для отображения сгенерированного UUID

```html
<div id="uuid"></div>
```

Заполнение блока JavaScript для генерации UUID

```js
exports.Task = class Task extends exports.Task {
  render() {
    super.render()
    document.querySelector('#uuid').innerHTML = `<b>${uuid.v1()}</b>`
  }
}
```

undefined
====================
## [](#%5Fсегментация%5Fтаблиц)Сегментация таблиц

![table seg example](_images/table-seg-example.png) 

### [](#%5Fинструменты%5Fвыделения)Инструменты выделения

В шаблоне **Сегментация таблиц** вы можете использовать следующие параметры для настройки классов:

| **Параметр** | **Обязательность** | **Тип** | **Описание**    |
| ------------ | ------------------ | ------- | --------------- |
| name         | Да                 | string  | Название класса |
| color        | Да                 | string  | Цвет класса     |

Пример:

```json
{
  "entities": [
    {
      "name": "First table",
      "color": "green"
    },
    {
      "name": "Second table",
      "color": "blue"
    }
  ]
}
```

| |  Вы также можете загрузить отдельные классы для каждой задачи, используя SDK. Пример смотрите в разделе [Примеры запросов](../sdk/examples.html). |
| --------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fнастройка%5Fтегов)Настройка тегов

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

Параметры для настройки тегов:

| **Параметр** | **Обязательность** | **Тип** | **Описание**    |
| ------------ | ------------------ | ------- | --------------- |
| name         | Да                 | string  | Название класса |
| color        | Нет                | string  | Цвет класса     |

Пример:

```json
{
  "tags": [
    {
      "name": "Common",
      "color": "yellow"
    },
    {
      "name": "Special",
      "color": "purple"
    }
  ]
}
```

### [](#%5Fгорячие%5Fклавишы)Горячие клавишы

* `1`, `2` …​ `n` \- выбор класса
* `backspase` \- удаление таблицы
* `esc` \- снятие выделения таблицы/ячейки
* `r` \- выбор инструмента создания строк (при выбранной таблице)
* `с` \- выбор инструмента создания столбцов (при выбранной таблице)
* `m` \- объединение/разъединение ячеек (при выбранной таблице)
* `space + перемещение мыши с зажатой левой клавишей` \- перемещение изображения по канвасу
* `ctrl + c`, `ctrl + v` \- копирование/вставка таблицы
* `ctrl + z`, `ctrl + y` \- отмена/возврат действия

Настройка шаблонов сегментации
====================
![segmentation](_images/segmentation.png) 

## [](#%5Fпараметры%5Fсегментации)Параметры сегментации

Шаблоны настраиваются в проекте на вкладке **Интерфейс**. Общие параметры настройки интерфейса описаны в разделе [Блок Config](interface-config.html). Также в блоке **Config** есть специфические параметры для шаблонов сегментации:

| Параметр              | Обязательность | Тип     | Описание                                                                                                                                |
| --------------------- | -------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| groupsEnabled         | Нет            | boolean | Возможность разметчикам группировать фрагменты. Значение по умолчанию — false                                                           |
| rotationEnabled       | Нет            | boolean | Возможность поворота изображения во время разметки. Доступно для сегментации изображений и PDF. Значение по умолчанию — false           |
| expandWord            | Нет            | boolean | Если true, то выделяется все слово. Доступно для сегментации текста. Значение по умолчанию — false                                      |
| expandWordRegExp      | Нет            | string  | Регулярное выражение для определения границы слова. Доступно для сегментации текста. Значение по умолчанию — "\[^\\\\s.,\]              |
| entities              | Да             | object  | Классы для сегментации                                                                                                                  |
| onthologyStructure    | Нет            | object  | Структура онтологии                                                                                                                     |
| customEntitiesEnabled | Нет            | boolean | Возможность разметчикам добавлять новые классы. Доступно для сегментации текста и изображений. Значение по умолчанию — false            |
| stepSize              | Нет            | number  | Размер шага перемотки для сегментаций видео и аудио. Значение по умолчанию для сегментации аудио — 0.01, для сегментации видео — 0.0333 |
| searchAutoFocus       | Нет            | boolean | Возможность автофокусировки на поле поиска классов при загрузке задания                                                                 |
| annotationAutoOpen    | Нет            | boolean | Возможность автоматического отображения аннотаций при выделении фрагмента или выборе класса                                             |
| entityChangeIcon      | Нет            | boolean | Возможность разметчикам изменить класс фрагмента на другой с таким же инструемнтом                                                      |

## [](#%5Fнастройка%5Fклассов)Настройка классов

Классы настраиваются в объекте `entities`:

| **Параметр** | **Обязательность** | **Тип** | **Описание**                                                                                                                                                                                                     |
| ------------ | ------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id           | Да                 | string  | Идентификатор класса                                                                                                                                                                                             |
| name         | Да                 | string  | Название класса                                                                                                                                                                                                  |
| tooltip      | Нет                | string  | Подсказка к классу. Можно использовать HTML-разметку для оформления текста                                                                                                                                       |
| color        | Нет                | string  | Цвет класса                                                                                                                                                                                                      |
| type         | Да                 | string  | Тип инструмента выделения фрагментов. Используется для сегментации изображений, аудио и видео                                                                                                                    |
| hotKey       | Нет                | string  | Горячая клавиша для класса. Можно использовать цифры и буквы                                                                                                                                                     |
| maxAmount    | Нет                | number  | Максимальное количество фрагментов данного класса. Используется во вложенных классах.                                                                                                                            |
| options      | Нет                | object  | Объект, в котором можно указать дополнительные настройки. Используется в сегментации изображений для настройки инструмента **Прямоугольник**. Подробнее — в пункте [Поворот фрагмента](#%5Fповорот%5Fфрагмента). |
| fields       | Нет                | array   | Массив для настройки аннотации класса                                                                                                                                                                            |

```json
{
    "id": "entity-1",
    "name": "Первый класс",
    "tooltip": "Подсказка к классу",
    "type": "polygon",
    "hotKey": "1"
}
```

## [](#%5Fрезультат%5Fразметки)Результат разметки

| **Параметр** | **Обязательность** | **Тип** | **Описание**                                                                                     |
| ------------ | ------------------ | ------- | ------------------------------------------------------------------------------------------------ |
| marks        | Да                 | array   | Массив размеченных фрагментов                                                                    |
| meta         | Нет                | object  | Метаинформация об объектах разметки. Например в сегментации изображений imageWidth и imageHeight |

## [](#%5Fаннотация)Аннотация

Аннотация — это раздел, в котором разметчик может внести дополнительную информацию о фрагменте или ответить на вопросы о нем.

Чтобы аннотация автоматически отображалась разметчикам, используйте параметр `annotationAutoOpen` в блоке [Config](interface-config.html).

Аннотация для каждого класса настраивается в объекте `fields`.

![example annotation](_images/example-annotation.png) 

| **Параметр** | **Обязательность** | **Тип** | **Описание**                                                                                                                                                                                                         |
| ------------ | ------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| type         | Да                 | string  | Тип элемента. Возможные значения: — input — поле для ввода однострочного текста; — textarea — поле для ввода многострочного текста; — checkbox — чекбокс; — radio — радиокнопка; — select — поле с выбором значения; |
| name         | Да                 | string  | Ключ элемента, должен быть уникальным в рамках класса. Отображается в результатах разметки                                                                                                                           |
| title        | Нет                | string  | Заголовок элемента                                                                                                                                                                                                   |
| placeholder  | Нет                | string  | Подсказка в полях для ввода текста                                                                                                                                                                                   |
| options      | Нет                | array   | Массив с вариантами ответов для типов radio, checkbox и select. Содержит параметры: — title — отображается разметчикам; — value — отображается в результатах разметки                                                |

```json
"entities": [
    {
      "id": "entity-1",
      "name": "1. Первый класс",
      "tooltip": "Подсказка к классу",
      "hotKey": "1",
      "entities": [
        {
          "id": "entity-12",
          "name": "Подкласс",
          "tooltip": "Подсказка к классу",
          "color": "red",
          "hotKey": "A"
        }
      ],
      "fields": [
        {
          "type": "input",
          "name": "input",
          "title": "Название объекта",
          "placeholder": "Объект"
        },
        {
          "type": "textarea",
          "name": "textarea",
          "title": "Описание",
          "placeholder": "Одно или два предложения об объекте"
        },
        {
          "type": "checkbox",
          "name": "checkbox",
          "title": "Объект правильный",
          "options": [
            {
              "title": "Да",
              "value": "yes"
            },
            {
              "title": "Нет",
              "value": "no"
            }
          ]
        },
        {
          "type": "radio",
          "name": "radio",
          "title": "Объект правильный",
          "options": [
            {
              "title": "Да",
              "value": "yes"
            },
            {
              "title": "Нет",
              "value": "no"
            }
          ]
        },
        {
          "type": "select",
          "name": "select",
          "title": "Цвет объекта",
          "options": [
            {
              "title": "Красный",
              "value": "red"
            },
            {
              "title": "Желтый",
              "value": "yellow"
            },
            {
              "title": "Зеленый",
              "value": "green"
            }
          ]
        }
      ]
    }
]
```

## [](#%5Fподсказки)Подсказки

Чтобы разметчики не запутались в классах сегментации, добавьте всплывающие подсказки в параметре `tooltip` в блоке [Config](interface-config.html).

При верстке подсказки вы можете использовать основные инструменты оформления текста:

* `\n` — перенос на новую строку.
* `\t` — табуляция.
* `<b>` — жирный текст.
* `<i>` — курсив.
* `<u>` — подчеркнутый текст.

Вы также можете настроить ширину окна всплывающей подсказки в блоке **CSS**. Например:

Ширина окна подсказки

```json
.tooltip-container {
    max-width: 500px;
    width: 500px;
}
```

## [](#%5Fгруппировка%5Fфрагментов)Группировка фрагментов

Если нужно, чтобы разметчики дополнительно группировали фрагменты размеченных объектов, добавьте в блоке [Config](interface-config.html) параметр `"groupsEnabled": true`.

Функция доступна в следующих шаблонах:

* Сегментация текста.
* Сегментация изображений.
* Шаблоны раздела **Диалоги**.
* Шаблоны раздела **Дополнительные**.

## [](#%5Fрежим%5Fread%5Fonly)Режим Read only

Шаблоны сегментации `аудио`, `видео`, `изображений` поддерживают режим "read only". В этом режиме будут отключены любые действия, направленные на редактирование результатов разметки или создание новых элементов. Интерактивность и вся функциональность, нужная для просмотра и валидации разметки, сохранится.

| |  Панель онтологии в режиме "read only" продолжает быть доступной для редактирования. |
| -------------------------------------------------------------------------------------- |

Для включения режима "read only" необходимо в теге нужного компонента указать атрибут `readOnly="true"`.

```html
Пример. Блок HTML
----
<tm-forms-audio src="{{audio}}" readOnly="true"></tm-forms-audio>
----
```

## [](#%5Fсегментация%5Fтекста)Сегментация текста

### [](#%5Fонтология)Онтология

Онтология — это вкладка в задачах сегментации текста, где разметчики могут указать дополнительную информацию о тексте.

Например, если объект разметки — юридический документ, то для него можно указать тип документа, реквизиты заказчика и исполнителя и т. д. Также можно добавить в онтологию выделенный фрагмент текста, например, дату или сумму договора.

Онтология настраивается в блоке [Config](interface-config.html) в параметре `onthologyStructure`. Здесь вы можете добавлять элементы онтологии и настраивать их формат с помощью параметра `type`. Возможные значения параметра:

* `node` — раздел;
* `dynamicNode` — раздел с возможностью удаления. Для `dynamicNode` можно задать количество дублирующих разделов с помощью атрибутов `min` и `max`;
* `textField` — поле для ввода однострочного текста;
* `textArea` — поле для ввода многострочного текста;
* `checkbox` — чекбокс;
* `radio` — радиокнопка;
* `select` — поле с выбором значения;
* `fragment` — добавление фрагмента текста с классом.

**Параметры:**

| **Параметр**     | **Обязательность**               | **Тип**    | **Описание**                                                                                                                                                                                                 |
| ---------------- | -------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| name             | Да                               | string     | Заголовок раздела или элемента                                                                                                                                                                               |
| type             | Да                               | string     | Тип элемента. Возможные значения см. выше                                                                                                                                                                    |
| fields           | Нет                              | array      | Массив с вложенными элементами. Используется в элементах: node, dynamicNode                                                                                                                                  |
| required         | Нет                              | boolean    | Признак обязательности элемента                                                                                                                                                                              |
| availableClasses | Нет                              | string\[\] | Доступные для выбора id классов. При отсутствии этой опции разрешается выбирать любой. Используется в элементах: fragment                                                                                    |
| min              | Да — для dynamicNode             | number     | Минимальное количество фрагментов, которые пользователь может выделить в тексте. Если значение 0 — элемент необязательный, если больше нуля — обязательный. Используется в элементах: fragment и dynamicNode |
| max              | Да — для dynamicNode             | number     | Максимальное количество фрагментов, которые пользователь может выделить в тексте. Используется в элементах: fragment и dynamicNode                                                                           |
| values           | Да — для checkbox, radio, select | array      | Массив с вариантами ответа. Содержит параметры: \* key — ключ варианта; \* value — название варианта. Используется в элементах: checkbox, radio, select                                                      |

**Пример:**

```json
"onthologyStructure": {
        "name": "Реквизиты документа",
        "type": "node",
        "fields": [
            {
                "name": "Общие реквизиты",
                "type": "node",
                "fields": [
                    {
                        "name": "Номер и дата",
                        "type": "textField",
                        "required": false
                    },
                    {
                        "name": "Тип документа",
                        "type": "select",
                        "values": [
                            {
                                "key": "1",
                                "value": "Договор"
                            },
                            {
                                "key": "2",
                                "value": "Соглашение"
                            },
                            {
                                "key": "3",
                                "value": "Уведомление"
                            }
                        ]
                    }
                ]
            },
            {
                "name": "Заказчик",
                "type": "dynamicNode",
                "min": 1,
                "max": 7,
                "fields": [
                    {
                        "name": "Название организации",
                        "type": "textField",
                        "required": true
                    },
                    {
                        "name": "Реквизиты организации",
                        "type": "fragment",
                        "availableClasses": ["entity-1", "entity-2"]
                        "min": 0,
                        "max": 7
                    }
                ]
            },
            {
                "name": "Исполнитель",
                "type": "dynamicNode",
                "min": 1,
                "max": 7,
                "fields": [
                    {
                        "name": "Название организации",
                        "type": "textField",
                        "required": true
                    },
                    {
                        "name": "Реквизиты организации",
                        "type": "fragment",
                        "min": 1,
                        "max": 7
                    }
                ]
            }
        ]
    }
```

### [](#%5Fвложенность%5Fклассов)Вложенность классов

Вы можете настроить связь между классами типа «родитель-ребенок». Например, разметчик должен выделить в тексте фрагмент с классом «Адрес», и только после этого ему станут доступны дочерние классы «Город» и «Улица».

Чтобы вложить один класс в другой, добавьте в родительский класс массив `entities`. Например:

```json
"entities": [
    {
      "id": "entity-1",
      "name": "1. Первый класс",
      "tooltip": "Подсказка к классу",
      "hotKey": "1",
      "entities": [
        {
          "id": "entity-12",
          "name": "Подкласс",
          "tooltip": "Подсказка к классу",
          "color": "red",
          "hotKey": "A"
        }
      ]
    }
]
```

## [](#%5Fсегментация%5Fизображений)Сегментация изображений

| |  Вы также можете загрузить отдельные классы для каждой задачи, используя SDK. Пример смотрите в разделе [Примеры запросов](../sdk/examples.html). |
| --------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fинструменты%5Fвыделения)Инструменты выделения

Если вы выбрали шаблон **Сегментация изображений**, настройте в каждом классе инструмент выделения фрагментов. Для этого укажите название инструмента в параметре `type` в блоке [Config](interface-config.html):

* polygon — многоугольник.
* bbox — прямоугольник.
* ellipse — эллипс.
* polyline — полилиния.
* brush — кисть.
* smart\_brush - умная кисть
* keypoint — ключевые точки.

### [](#%5Fповорот%5Fизображения)Поворот изображения

Что бы включить возможность поворота изображения во время разметки, укажите параметр `"rotationEnabled": true` в `CONFIG` секции настройки интерфейса.

Поворот изображения осуществляется на 90, 180 и 270 градусов. Угол поворота не влияет на результат разметки и применяется только к отображению в интерфейсе.

Результат поворота попадает в результат разметки. На расчет качества и согласованности это не влияет. Если нужно учитывать угол поворота при расчете качества, добавьте это поле в секцию `SPECIFICATION` в настройках интерфейса.

Пример ответа разметчика:

```json
{
  "marks": [],
  "rotation": 90,
  "imageMeta": {
    "width": 654,
    "height": 846
  }
}
```

### [](#%5Fповорот%5Fфрагмента)Поворот фрагмента

Чтобы настроить возможность поворота выделенного фрагмента для инструмента **Прямоугольник**, укажите в нужном классе параметр `"rotated": true` в объекте `options`. Например:

```html
{
  "id": "entity-2",
  "name": "Второй класс",
  "color": "green",
  "type": "bbox",
  "options": {"rotated": true}
},
```

### [](#%5Fштриховка%5Fи%5Fзаливка%5Fфрагментов)Штриховка и заливка фрагментов

Чтобы сделать фрагменты более заметными на изображении, настройте штриховку и заливку. Для этого добавьте в класс объект `fill` с параметрами:

* `stripesSize` — толщина линий штриховки.
* `backgroundEnabled` — признак того, требуется ли заливка фрагмента.

**Пример:**

```json
"fill": {
    "stripesSize": 4,
    "backgroundEnabled": true
},
```

Функция доступна для инструментов:

* многоугольник (polygon),
* прямоугольник (bbox),
* эллипс (ellipse).

### [](#%5Fограничение%5Fколичества%5Fkeypoint)Ограничение количества keypoint

У инструмента keypoint есть возможность ограничить количество точек, которые сможет проставить разметчик в одном классе Для этого в конфигурации класса необходимо добавить аттрибут "max":

**Пример:**

```json
{
    "id": "keypoint-entity-id",
    "name": "Углы треугольника",
    "max": 3,
    "color": "red",
    "type": "keypoint"
}
```

### [](#%5Fнастройка%5Fтолщины%5Fлинии%5Fполилинии)Настройка толщины линии полилинии

Инструмент **полилиния** (polyline) позволяет размечать линейные объекты на изображении путем последовательного указания точек.

В интерфейсе разметки доступен слайдер для изменения толщины линии в диапазоне от 1 до 20 пикселей (значения по умолчанию).

**Базовый пример настройки класса:**

```json
{
    "id": "entity-polyline",
    "name": "Полилиния",
    "tooltip": "Подсказка к классу",
    "type": "polyline",
    "color": "red",
    "hotKey": "2"
}
```

#### [](#%5Fрасширенные%5Fнастройки%5Fполилинии)Расширенные настройки полилинии

Для более точной настройки инструмента polyline доступны дополнительные параметры:

| Параметр       | Тип    | Описание                                                                                                                                                                                                     |
| -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| strokeWidth    | number | Фиксированная толщина линии в пикселях. При указании этого параметра слайдер толщины будет заблокирован и недоступен для изменения разметчиком. Используйте для стандартизации толщины линий в проекте.      |
| maxStrokeWidth | number | Максимальное значение толщины линии в пикселях. Слайдер будет ограничен диапазоном от 1 до указанного значения. По умолчанию максимум равен 20.                                                              |
| max            | number | Максимальное количество точек, которые может добавить разметчик в одну полилинию. При достижении лимита линия автоматически завершается. Счетчик точек отображается в интерфейсе рядом со слайдером толщины. |

**Пример с фиксированной толщиной:**

```json
{
    "id": "entity-polyline-fixed",
    "name": "Дорожная разметка",
    "type": "polyline",
    "color": "yellow",
    "strokeWidth": 3,
    "hotKey": "1"
}
```

| |  При указании strokeWidth разметчик не сможет изменить толщину линии — слайдер будет отображаться в заблокированном состоянии с установленным значением. |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- |

**Пример с ограничением максимальной толщины:**

```json
{
    "id": "entity-polyline-limited",
    "name": "Тонкие линии",
    "type": "polyline",
    "color": "blue",
    "maxStrokeWidth": 5,
    "hotKey": "2"
}
```

**Пример с ограничением количества точек:**

```json
{
    "id": "entity-polyline-segment",
    "name": "Отрезок",
    "type": "polyline",
    "color": "green",
    "max": 2,
    "hotKey": "3"
}
```

| |  При достижении максимального количества точек (max) линия автоматически завершается, и разметчик может начать размечать новый объект. Счетчик отображает текущее количество точек и максимальное значение (например, "3/5"). |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

**Пример с комбинацией параметров:**

```json
{
    "id": "entity-polyline-full",
    "name": "Граница участка",
    "type": "polyline",
    "color": "red",
    "strokeWidth": 4,
    "max": 10,
    "hotKey": "4"
}
```

**Структура метки в результате разметки:**

```json
{
    "type": "polyline",
    "position": {
        "points": [
            {"x": 100, "y": 150},
            {"x": 200, "y": 250},
            {"x": 300, "y": 200}
        ]
    },
    "strokeWidth": 5,
    "entityId": "entity-polyline"
}
```

## [](#%5Fсегментация%5Fпоследовательности)Сегментация последовательности

Шаблон предназначен для разметки последовательностей изображений (видеокадров) с помощью инструментов сегментации (bbox, ellipse) с поддержкой функции трекинга объектов и возможностью добавления аннотаций.

Интерфейс состоит из трёх основных блоков: - Центральная часть – рабочая область с изображением для разметки и навигация по кадрам. - Левая панель – список классов для разметки. - Правая панель – список размеченных объектов и аннотации (если включены в конфиге).

Логика работы: 1.Пользователь выбирает класс для разметки 2\. Пользователь выделяет объект выбранным инструментом. 3\. (Опционально) включает трекинг для отслеживания объекта на последовательности кадров. 4\. (Опционально) добавляет ключевые кадры для коррекции положения объекта. 5\. (Опционально) управляет видимостью объекта на разных кадрах. 6\. (Опционально) заполнение аннотации.

### [](#%5Fфункция%5Fтрекинга%5Fобъектов)Функция трекинга объектов

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

Основные возможности: - Включение трекинга – автоматически создает метку на всех кадрах последовательности с одинаковым trackingId. - Ключевые кадры – опорные точки для автоматического расчета положения объекта на промежуточных кадрах. - Управление видимостью – возможность скрыть/показать объект на текущем и последующих кадрах. - Автоматическая интерполяция – система рассчитывает плавное движение объекта между ключевыми кадрами.

### [](#%5Fнастройка%5Fкласса)Настройка класса

Классы настраиваются в объекте entities в секции Config

**Пример:**

```json
{
    "id": "entity-1",
    "name": "Первый класс",
    "tooltip": "Подсказка к классу",
    "type": "polygon",
    "hotKey": "1",
    "fields": [ { "type": "input", "name": "annotaion", "title": "Название объекта", "placeholder": "Объект" }]
}
```

### [](#%5Fструктура%5Fрезультата%5Fразметки)Структура результата разметки

Результат разметки представляет собой JSON-объект с массивом кадров (pages). Каждый кадр содержит массив меток (marks) с информацией о размеченных объектах.

Поля трекинга в метках: - trackingId – уникальный идентификатор отслеживаемого объекта. Все метки с одинаковым trackingId представляют один объект на разных кадрах. - isKeyFrame – флаг ключевого кадра (true/false). Ключевые кадры задают опорные точки для автоматической интерполяции.

| |  Скрытые фрагменты не включаются в результат разметки – если объект скрыт на кадре, соответствующая метка отсутствует в массиве marks этого кадра. При загрузке результата в качестве предразметки скрытые фрагменты трекинга автоматически восстанавливаются системой. |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fполезные%5Fполя%5Fконфигурации)Полезные поля конфигурации

* `submitOnEnter` (опциональный, по умолчанию true) - определяет, отправляется ли разметка при нажатии Enter.
* `markupAutosave` (опциональный, по умолчанию true) - автоматически сохраняет разметку раз в 1 минуту.
* `rotationEnabled` (опциональный, по умолчанию false) - включает возможность поворачивать изображение во время разметки.
* `groupsEnabled` (опциональный, по умолчанию false) - включает возможность группировать размеченные объекты.
* `customEntitiesEnabled` (опциональный, по умолчанию false) - включает возможность добавление собственных классов во время разметки.

Блок Specification
====================
В блоке могут храниться параметры для расчета [качества и согласованности](quality-consistency.html).

| |  Перед запуском задачи проверьте, что названия полей вопросов совпадают с названиями в блоке [Config](interface-config.html). |
| ------------------------------------------------------------------------------------------------------------------------------- |

## [](#%5Fпараметры)Параметры

| **Параметр**    | **Обязательность** | **Тип** | **Описание**                                                                                                                                                                                                        |
| --------------- | ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| input\_schema   | Нет                | object  | Служебное поле                                                                                                                                                                                                      |
| output\_schema  | Нет                | object  | Служебное поле                                                                                                                                                                                                      |
| quality\_config | Нет                | object  | Параметры для расчета качества и согласованности. Здесь вы можете задать вес и выбрать алгоритм расчета для каждого вопроса в задании. Подробнее — в разделе [Качество и согласованность](quality-consistency.html) |

## [](#%5Fпример)Пример

```html
{
   "quality_config": {
      "fields": {
         "type_speaker": {
            "type": "binary",
            "weight": 10
         },
         "has_animals": {
            "type": "binary",
            "weight": 12
         }
      }
   }
}
```

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

## [](#%5Fкак%5Fдобавить%5Fв%5Fпроект%5Fинструкцию)Как добавить в проект инструкцию

Перейдите в проект и на вкладке **Инструкция** подробно опишите, как нужно выполнять задания:

* порядок действий разметчика,
* какие ответы считаются правильными, а какие — нет,
* примеры правильной разметки,
* сложные случаи, в которых разметчик может запутаться.

Наглядная информация поможет разметчикам разобраться быстрее. Мы рекомендуем прикреплять к инструкции изображения с примерами. Для этого нажмите кнопку загрузки картинок на панели инструментов и добавьте ссылку на изображение. Изображение может находиться на стороннем ресурсе или на платформе TagMe в разделе [Датасеты](datasets.html).

Чтобы отформатировать текст, используйте панель инструментов. На панели инструментов также можно найти AI-помощника по инструкции, который поможет улучшить текст.

| |  Если вы копируете текст из файла в инструкцию — проверьте, сохранилась ли верстка. |
| ------------------------------------------------------------------------------------- |

В инструкции автоматически создается оглавление на основе заголовков H1-H3\. Чтобы посмотреть, как инструкция отобразится разметчикам, нажмите на кнопку Предпросмотра.

Когда инструкция будет готова, нажмите **Сохранить изменения**.

## [](#%5Fсостав%5Fинструкции)Состав инструкции

### [](#%5Fцель%5Fпроекта)Цель проекта

Кратко опишите, в чем цель проекта.

**Пример 1:** Составить текстовые описания к изображениям. Результаты будут использоваться, чтобы обучить модель искусственного интеллекта генерировать изображения.

**Пример 2:** Оценить качество диалога модели искусственного интеллекта (Ассистента) с пользователем.

### [](#%5Fтипы%5Fзаданий%5Fв%5Fпроекте)Типы заданий в проекте

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

**Пример 1:** Проект состоит из обучения, экзамена и основных заданий. Обучение и экзамен не оплачиваются.

**Пример 2:** Сначала пройдите обучение, чтобы набрать нужный уровень навыка — 70\. Затем выполните экзаменационные задания. После этого можете приступать к основным заданиям. Если в процессе выполнения заданий ваш уровень навыка упадет ниже 70, то вы перейдете в реабилитационную задачу.

### [](#%5Fкак%5Fвыполнять%5Fзадания)Как выполнять задания

Подробно опишите логику выполнения заданий.

**Пример 1:**

Ваш текст должен детально описывать изображение.

* Если изображен человек или персонаж, то напишите, кто это, опишите место, одежду, окружение.
* Если изображена достопримечательность, то опишите стиль, цвета, яркие детали.
* Для русской культуры можно добавить в описание, что это именно что-то советское или русское. Например, если это Винни-Пух, то укажите, что это советский Винни-Пух.

Что важно в описании:

* Большее внимание уделяем главному предмету или субъекту.
* Главные детали пишем в начале (кто или что изображено).
* Указывать, что за изображение, если оно нестандартное (картина, картина маслом, картина карандашом, черно-белое фото, памятник, бюст и т. д.).
* Разнообразие запросов — запросы по шаблону не приветствуются. Можно менять местами порядок описания деталей, делать сложные предложения, использовать синонимы.
* Описывать «человеческим» языком.
* Орфография и пунктуация.

**Пример 2:**

Интерфейс задания выглядит следующим образом: cлева диалог между Пользователем и Ассистентом, справа – критерии для оценки ответов Ассистента.

![Интерфейс задания](_images/manual-example.png) 

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

Варианты ответов:

* **Непригодный** — в ответе нарушена логичность, ответ не по теме, противоречивый и т. п.
* **Могло быть и лучше** — в ответе соблюдена логичность, но ответ неполный.
* **Пригодный** — ответ логичный (ясный и непротиворечивый) и полный (достаточно информации по запросу).

### [](#%5Fпримеры%5Fправильной%5Fразметки)Примеры правильной разметки

Приведите как можно больше примеров заданий с правильными ответами. Добавьте комментарии, что делает именно этот ответ правильным.

**Пример 1:**

![Пример задания](_images/manual-example-2.png) 

Хорошее описание: «Рисунок из детской книжки – мальчик играет с собакой возле дома».

Плохое описание: «Мальчик и собака».

**Пример 2:**

Диалог:

«П: Напиши короткую сказку про курочку

А: Жили-были дед и баба. И была у них курочка Ряба. Снесла курочка яичко, да не простое – а золотое. Дед бил – не разбил. Баба била – не разбила. А мышка бежала, хвостиком махнула, яичко упало и разбилось. Дед плачет, баба плачет, а курочка кудахчет: Не плачь, дед, не плачь, баба: снесу вам новое яичко не золотое, а простое».

Ответ: Пригодный.

Комментарий: Ответ ясный, понятный и полностью предоставляет необходимую информацию.

Маркетплейс. Шаблоны разметки
====================
Здесь собраны шаблоны разметки, созданные вашими коллегами. Они помогут вам быстрее и эффективнее работать над проектами разметки.

## [](#%5Fчто%5Fтакое%5Fшаблоны%5Fразметки)Что такое шаблоны разметки?

Шаблоны разметки — это готовые к использованию конфигурации интерфейсов и инструкций, которые разработаны специально для того, чтобы упростить процесс разметки данных. Каждый шаблон создан с учётом специфики определённых типов проектов и областей применения.

## [](#%5Fкак%5Fнайти%5Fнужный%5Fшаблон)Как найти нужный шаблон?

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

## [](#%5Fдетальная%5Fинформация%5Fо%5Fкаждом%5Fшаблоне)Детальная информация о каждом шаблоне

Кликнув на карточку шаблона, вы попадёте на страницу с детальной информацией. Там вы найдёте:

* **Название и краткое описание**: Узнайте, для каких целей предназначен данный шаблон и какие задачи он решает.
* **Категория**: Определитесь с областью применения шаблона, будь то разметка изображений, текста или аудио.
* **Скриншоты интерфейса**: Посмотрите, как выглядит шаблон в действии, прежде чем принять решение.
* **Документация**: Ознакомьтесь с полным руководством по использованию шаблона и настройками интерфейса.
* **Инструкция для разметчиков**: Получите чёткую инструкцию по выполнению задач с использованием данного шаблона.
* **Контактные данные разработчика**: Свяжитесь с автором шаблона для получения дополнительной информации или поддержки.

| |  На странице шаблона указаны контактные данные разработчика, по которым можно связаться для решения вопросов или сообщить о проблеме. |
| --------------------------------------------------------------------------------------------------------------------------------------- |

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

Чтобы создать проект на основе шаблона, нажмите кнопку «Использовать» на карточке или на странице шаблона. В открывшемся окне заполните нужные поля и нажмите «Добавить». В новый проект будут перенесены инструкция и интерфейс из шаблона. Обновления в самом шаблоне не затронут ваш проект, за исключением случаев, когда используется бандл.

| |  Если шаблон использует бандл, изменения в нём могут повлиять на проекты, созданные на его основе. |
| ---------------------------------------------------------------------------------------------------- |

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

## [](#%5Fсоздание%5Fи%5Fуправление%5Fшаблонами%5Fразметки)Создание и управление шаблонами разметки

Вы готовы создать и управлять своими собственными шаблонами? Отлично! Давайте разберёмся, как это делается.

### [](#%5Fсоздание%5Fнового%5Fшаблона)Создание нового шаблона

Чтобы создать новый шаблон, выполните следующие шаги:

1. Перейдите на страницу маркетплейса или в раздел «Управление шаблонами разметки».
2. Нажмите кнопку «Создать шаблон».
3. В появившемся окне заполните нужные поля и нажмите «Создать».

### [](#%5Fнастройка%5Fсуществующих%5Fшаблонов)Настройка существующих шаблонов

Для управления и настройки уже созданных шаблонов выполните следующее:

1. В левой панели выберите пункт «Управление», затем «Шаблоны разметки».
2. В открывшейся таблице выберите нужный шаблон для редактирования.

### [](#%5Fосновные%5Fразделы%5Fнастройки%5Fшаблона)Основные разделы настройки шаблона

#### [](#%5Fинструкция)Инструкция

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

#### [](#%5Fинтерфейс)Интерфейс

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

#### [](#%5Fдокументация)Документация

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

#### [](#%5Fпроекты)Проекты

На данной вкладке представлен список всех проектов, созданных на базе этого шаблона.

#### [](#%5Fнастройки)Настройки

Здесь вы можете изменять различные аспекты вашего шаблона:

* **Имя и описание**: Обновляйте название и описание шаблона для лучшей идентификации.
* **Контакты и категории**: Добавьте контактные данные и отнесите шаблон к соответствующей категории для удобства поиска.
* **Загрузка изображений и превью**: Загружайте визуальные материалы, чтобы пользователи могли лучше представить, как будет выглядеть ваш шаблон в деле.

### [](#%5Fпубликация%5Fшаблона)Публикация шаблона

Готовы к тому, чтобы ваш шаблон увидел свет? Следуйте этим простым шагам, чтобы опубликовать его на маркетплейсе:

1. Заполнение обязательных полей:  
   * Инструкция  
   * Интерфейс  
   * Документация  
   * Контакты  
   * Категории
2. Публикация:

Когда все обязательные поля заполнены, нажмите кнопку "Опубликовать" в правом верхнем углу экрана. Теперь ваш шаблон появится на странице маркетплейса и станет доступен для использования другими пользователями.

### [](#%5Fснятие%5Fшаблона%5Fс%5Fпубликации)Снятие шаблона с публикации

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

1. Откройте страницу управления шаблоном.
2. Нажмите кнопку "Снять с публикации".

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

## [](#%5Fавтообновление%5Fи%5Fручное%5Fобновление%5Fпроектов%5Fиз%5Fшаблона%5Fразметки)Автообновление и ручное обновление проектов из шаблона разметки.

При создании проекта из шаблона разметки у вас есть возможность включить автообновления для трёх ключевых разделов вашего проекта: Config, Интерфейс и Инструкция. Эта функция позволит вам автоматически применять любые изменения, внесённые в исходный шаблон разметки.

### [](#%5Fавтообновление)Автообновление

**Автообновление** — это удобная возможность автоматически получать последние изменения из шаблона разметки, когда они вносятся разработчиком. Особенно полезна эта функция, если вы предпочитаете не заниматься ручной настройкой проекта и готовы доверять обновлению разработчика шаблона.

| |  Если автообновление включено, изменения будут применены к вашему проекту даже тогда, когда уже запущены какие-то задачи. |
| --------------------------------------------------------------------------------------------------------------------------- |

**Частичное автообновление**: Вы можете гибко управлять автообновлением каждого раздела. Например, если вы хотите внести собственные правки в инструкцию, её автообновление можно отключить, оставив активным обновление для остальных частей проекта (Интерфейс, Config и Specification).

Управление автообновлением доступно через вкладки «Настройки», «Интерфейс» и «Инструкция».

**Автообновление Интерфейса**

Для автообновления интерфейса доступны три раздела которые обновляются независимо друг от друга:

* HTML, CSS, JavaScript, Example data
* Config
* Specification

**Прекращение автообновлений**: Если разработчик шаблона снимает его с публикации или ограничивает доступ, автообновление для всех проектов, созданных на основе этого шаблона, будет отключено.

### [](#%5Fручное%5Fобновление)Ручное обновление

Если вы не хотите использовать автообновление, но всё же желаете периодически обновлять ваш проект до актуальной версии шаблона, вы можете сделать это вручную. Для этого достаточно нажать кнопку «Загрузить обновление». Если вас устроили загруженные обновления, нажмите кнопку ""Сохранить" для применения изменений.

**Отмена обновлений**: Если новые изменения окажутся неподходящими или неудобными, вы сможете их отменить перед сохранением, воспользовавшись кнопкой «Не сохранять» внизу страницы.

## [](#%5Fбандлы%5Fособенности%5Fработы)Бандлы. Особенности работы.

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

Шаблоны с использованием бандлов отличаются от стандартных. Так как они используют постоянную ссылку на бандл, любые изменения, внесённые в бандл, автоматически применяются как к самому шаблону, так и ко всем проектам, основанным на нём.

| |  Даже если вы снимете такой шаблон с публикации, изменения в бандле всё равно повлияют на существующие проекты. |
| ----------------------------------------------------------------------------------------------------------------- |

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

Управление проектом
====================
## [](#%5Fпорядок%5Fвыполнения%5Fзадач)Порядок выполнения задач

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

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

### [](#%5Fпо%5Fпорядку%5Fсоздания)По порядку создания

Если в проекте созданы задачи А, B, а затем — C, то при запуске задач В и С разметчики будут получать задания из задачи B, а после их разметки — из задачи С.

Если в процессе разметки будет запущена задача А — то, новые разметчики начнут с задачи А. Все, кто работал с задачей С, продолжат работать и к задаче A уже не вернутся.

### [](#%5Fпо%5Fприоритету)По приоритету

Если вам не подходит порядок создания задач, вы можете назначить для каждой задачи приоритет. Подробнее читайте в разделе [Настройки задачи](settings.html).

## [](#%5Fстатистика%5Fпроекта)Статистика проекта

Чтобы посмотреть статистику проекта, откройте проект и перейдите на вкладку **Статистика**. Здесь представлена общая статистика по проекту, а также статистика выполнения задач. Чтобы выбрать, статистику какой задачи отображать, нажмите **Выбрать задачу**. Вы можете настроить отображение статистики задачи по группам разметчиков и по временным периодам.

О том, как скачать статистику, читайте в разделе [Работа со статистикой](statistics.html).

## [](#%5Fудаление%5Fпроекта)Удаление проекта

Если вы не планируете использовать проект, вы можете переместить его в архив. Для этого:

1. Перейдите в раздел **Проекты**.
2. Нажмите на кнопку меню в правой части строки проекта, который вы хотите отправить в архив.
3. Нажмите **Архивировать**.

Чтобы вернуть проект из архива:

1. Перейдите в раздел **Проекты**.
2. На вкладке **Архив** нажмите на кнопку меню в правой части строки проекта, который вы хотите разархивировать.
3. Нажмите **Разархивировать**.

Качество и согласованность
====================
Качество разметки — показатель качества ответов в [обучающих и контрольных заданиях](control-task.html), а также в заданиях с [отложенной приемкой](acceptance.html).

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

Качество и согласованность результатов разметки можно посмотреть в задаче на вкладке **Обзор**, а также в выгрузке статистики и результатов разметки. Возможные значения — числа от 0 до 1.

Для каждого вопроса в задании вы можете настроить вес и алгоритм расчета.

## [](#%5Fвес)Вес

Вес вопроса — это уровень влияния вопроса на итоговое качество или согласованность задания. Возможные значения — любые целые числа.

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

## [](#%5Fалгоритмы%5Fрасчета)Алгоритмы расчета

Вы можете выбрать один из трех алгоритмов расчета качества и согласованности:

* **binary** — алгоритм для вопросов, где требуется полное совпадение ответов. Если ответ разметчика в точности совпадает с контрольным ответом или ответом другого разметчика, то показатель 1\. Если ответы хоть в чем-то различаются — 0\. Подходит для всех типов заданий.
* **levenshtein** — алгоритм для вопросов с текстовыми ответами. При расчете используется вычисление редакционного расстояния, без учета регистра. Подробнее — по [ссылке](https://ru.wikipedia.org/wiki/%D0%A0%D0%B0%D1%81%D1%81%D1%82%D0%BE%D1%8F%D0%BD%D0%B8%D0%B5%5F%D0%9B%D0%B5%D0%B2%D0%B5%D0%BD%D1%88%D1%82%D0%B5%D0%B9%D0%BD%D0%B0). При использовании этого алгоритма в заданиях не с текстовыми ответами, например, сегментация изображений, показатель будет равен 0.
* **iou** — алгоритм для заданий сегментации изображений, видео и аудио. При использовании этого алгоритма в других заданиях, показатель будет равен 0.
* **oneOf** — алгоритм для контрольных заданий с несколькими допустимыми ответами. Контрольный ответ задаётся массивом вариантов; ответ разметчика считается верным (показатель 1), если он точно совпадает с любым элементом этого массива. В основных заданиях (согласованность) работает как **binary**.

## [](#%5Fкак%5Fнастроить%5Fпараметры)Как настроить параметры

Вы можете настроить расчет качества и согласованности в проекте на вкладке **Интерфейс**. Для этого добавьте в [блок Specification](creating-interface.html#%5Fблок%5Fspecification) параметр `quality_config`, а в него — параметр `fields` с вопросами, по которым нужно делать расчет. Убедитесь, что названия полей вопросов совпадают с названиями в блоке [Config](interface-config.html). Для каждого вопроса вы можете задать вес и выбрать алгоритм расчета. Например:

Пример quality\_config

```json
"quality_config": {
  "fields": {
    "type_speaker": {
      "type": "levenshtein",
      "weight": 1
    },
    "number": {
      "type": "binary",
      "weight": 2
    }
  }
}
```

## [](#%5Fалгоритм%5Foneof)Алгоритм oneOf

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

### [](#%5Fкак%5Fсравнивается%5Fответ)Как сравнивается ответ

1. Сначала эталон и ответ разметчика сравниваются целиком по правилам **binary**. Если совпало - 1.
2. Если нет и задание контрольное, а эталон - массив, каждый его элемент по очереди сравнивается с ответом разметчика по правилам **binary**. При первом совпадении - 1.
3. Если ни один элемент не подошёл - 0.

В **основных** заданиях (расчёт согласованности) массив вариантов не раскрывается - алгоритм ведёт себя как **binary** и сравнивает ответы разметчиков целиком.

### [](#%5Fнюансы)Нюансы

* Сравнение строгое и регистрозависимое: `"green"` ≠ `"Green"`.
* Числа нормализуются между `int` и `float` (`2` совпадёт с `2.0`), но строки и числа - разные типы: `"2"` ≠ `2`. Булевы значения не равны числам: `true` ≠ `1`.
* Элементом массива может быть объект или массив - сравнение идёт целиком, частичных совпадений нет (`{"a": 1}`, `{"c": 3}`) не совпадёт с (`{"a": 1, "b": 2}`, `{"d": 4}`).
* Если эталон - не массив, алгоритм работает как **binary**.
* Пустой массив эталона (`[]`) всегда даёт 0 - допустимых вариантов нет.

### [](#%5Fпример%5Fрасчёта%5Fкачества)Пример расчёта качества

**Задание:** «Выберите категорию товара».

**Контрольный ответ:** `["electronics", "books", "clothes"]`

| **Разметчик** | **Ответ разметчика** | **Качество ответа разметчика** |
| ------------- | -------------------- | ------------------------------ |
| Разметчик 1   | «books»              | 1                              |
| Разметчик 2   | «electronics»        | 1                              |
| Разметчик 3   | «food»               | 0                              |

### [](#%5Fкак%5Fзадать%5Fв%5Fконфигурации)Как задать в конфигурации

У алгоритма нет дополнительных параметров, кроме `weight`:

```json
"quality_config": {
  "fields": {
    "category": {
      "type": "oneOf",
      "weight": 2
    }
  }
}
```

Контрольный ответ для такого поля в задании указывается массивом допустимых вариантов:

```json
{
  "category": ["electronics", "books", "clothes"]
}
```

## [](#%5Fалгоритм%5Flevenshtein)Алгоритм levenshtein

Используется для текстов размером до 5000 символов. При превышении этого ограничения используется **binary**.

### [](#%5Fпример%5Fрасчета%5Fсогласованности)Пример расчета согласованности

**Задание:** «Напишите, что вы слышите на аудио».

**Ответы разметчиков:**

* Разметчик 1: «Наполеон сеял рожь».
* Разметчик 2: «На поле он сеял рожь».
* Разметчик 3: «На поле он посеял рожь».

**Расчет согласованности:**

* Согласованность ответов разметчиков 1 и 2: 0,89.
* Согласованность ответов разметчиков 1 и 3: 0,78.
* Согласованность ответов разметчика 2 и 3: 0,9.

**Средняя согласованность по заданию:** 0,86.

### [](#%5Fпример%5Fрасчета%5Fкачества)Пример расчета качества

**Задание:** «Напишите, что вы слышите на аудио».

**Контрольный ответ:** «На поле он сеял рожь».

| **Разметчик** | **Ответ разметчика**     | **Качество ответа разметчика** |
| ------------- | ------------------------ | ------------------------------ |
| Разметчик 1   | «Наполеон сеял рожь»     | 0,9                            |
| Разметчик 2   | «На поле он сеял рожь»   | 1                              |
| Разметчик 3   | «На поле он посеял рожь» | 0,9                            |

**Среднее качество по заданию:** 0,93.

## [](#%5Fалгоритм%5Fiou)Алгоритм IOU

IOU (intersection over union) — метрика, оценивающая схожесть объектов. Рассчитывается путем деления размера пересечения объектов на их суммарный размер.

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

Если при сегментации использовалось несколько инструментов, то сначала рассчитывается IOU для каждого инструмента, а затем вычисляется среднее арифметическое значение. Все размеченные объекты считаются равноправными, независимо от уровня их группировки.

### [](#%5Fсегментация%5Fизображений)Сегментация изображений

#### [](#%5Fкисть%5Fbrush%5Fи%5Fsmart%5Fbrush)Кисть (brush и smart\_brush)

Если в классе есть несколько объектов типа «кисть», то перед началом расчета IOU они объединяются в один объект. В результате в каждом из сравниваемых ответов будет по одному объекту этого класса.

Чтобы сравнить пару объектов, мы делим количество пикселей, которые выделены в обоих объектах, на общее количество пикселей, которые выделены хотя бы в одном объекте.

#### [](#%5Fполигон%5Fpolygon)Полигон (polygon)

IOU рассчитывается аналогично кисти.

#### [](#%5Fэллипс%5Fellipse)Эллипс (ellipse)

IOU рассчитывается аналогично кисти.

| |  При расчете также учитываются пиксели, которые находятся за правой и нижней границами изображения. |
| ----------------------------------------------------------------------------------------------------- |

#### [](#%5Fпрямоугольник%5Fbbox)Прямоугольник (bbox)

Чтобы сравнить пару объектов, мы делим площадь пересечения объектов на общую выделенную площадь.

Для расчета IOU группы объектов типа «прямоугольник»:

1. Проверяем, совпадает ли количество объектов в двух ответах. Если не совпадает, то общий IOU задания равен 0.
2. Каждому прямоугольнику из одного ответа ищем пару в другом ответе. Для этого проверяем соответствие центра прямоугольника в одном ответе прямоугольнику в другом ответе. Если хотя бы одна пара не сложилась, то общий IOU задания равен 0.
3. Рассчитываем IOU для каждой пары — математически вычисляем площадь их пересечения и объединения.
4. Итоговое IOU по этому классу — среднее арифметическое значение всех пар.

#### [](#%5Fключевые%5Fточки%5Fkeypoint)Ключевые точки (keypoint)

IOU пары точек считаем по формуле:

```none
IOU = 1 - расстояние между точками / длина диагонали
```

Для расчета IOU группы объектов типа «ключевые точки»:

1. Проверяем, совпадает ли количество объектов в двух ответах. Если не совпадает, то общий IOU задания равен 0.
2. Рассчитываем IOU для каждой пары.
3. Итоговое IOU по этому классу — среднее арифметическое значение всех пар.

### [](#%5Fсегментация%5Fаудио%5Fи%5Fвидео)Сегментация аудио и видео

#### [](#%5Fсегмент%5Fsegment)Сегмент (segment)

Для каждого сегмента рассчитывается площадь — длина сегмента умножается на фиксированный показатель высоты.

Далее IOU рассчитывается аналогично инструменту «прямоугольник» из сегментации изображений.

#### [](#%5Fфрейм%5Fframe)Фрейм (frame)

Для каждого фрейма рассчитываются координаты — к времени фрейма (X) добавляется фиксированный показатель (Y).

Далее IOU рассчитывается аналогично инструменту «ключевые точки» из сегментации изображений.

Быстрый старт
====================
## [](#%5Fрегистрация)Регистрация

Чтобы зарегистрироваться на платформе в качестве заказчика, отправьте [заявку](https://developers.sber.ru/portal/products/tagme#form).

## [](#%5Fзаводим%5Fпроект)Заводим проект

Чтобы создать проект:

1. Авторизуйтесь в [Личном кабинете](https://tagme.sberdevices.ru) с учетной записью заказчика и перейдите в нужную организацию.
2. Перейдите в раздел **Проекты** в левом меню.
3. Нажмите кнопку **Добавить проект**.
4. Введите название проекта и нажмите **Добавить**.

Проект отобразится в списке.

## [](#%5Fверстаем%5Fинтерфейс)Верстаем интерфейс

Вы можете создать интерфейс формы заданий, воспользовавшись готовыми шаблонами.

1. Перейдите в проект на вкладку **Интерфейс**.
2. Нажмите **Маркетплейс**.
3. Выберите подходящий шаблон и нажмите **Использовать**.
4. Чтобы посмотреть, как будет выглядеть интерфейс, нажмите **Предпросмотр**.
5. Чтобы сохранить выбранный интерфейс, нажмите **Сохранить изменения**.

Вы также можете сверстать интерфейс самостоятельно, перенести код из Толоки или скопировать из другого проекта. Подробнее читайте в разделе [Верстка интерфейса](creating-interface.html).

## [](#%5Fсоздаем%5Fинструкцию)Создаем инструкцию

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

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

Подробнее читайте в разделе [Подготовка инструкции](manual.html).

## [](#%5Fназначаем%5Fразметчика%5Fна%5Fпроект)Назначаем разметчика на проект

Чтобы назначить разметчиков, которые будут работать с проектом, перейдите в проект на вкладку **Разметчики**, выберите одну или несколько групп из списка и включите переключатели.

О том, как пригласить новых разметчиков или создать группу, читайте в разделе [Разметчики](adding-marker.html).

## [](#%5Fсоздаем%5Fзадачу)Создаем задачу

Чтобы добавить задачу:

1. Перейдите в нужный проект на вкладку **Задачи**.
2. Нажмите **Добавить задачу**.
3. В открывшемся окне введите название и описание задачи. Описание будет отображаться всем разметчикам.
4. Нажмите **Добавить задачу**.

Задача отобразится в проекте на вкладке **Задачи**.

| |  Задачи выдаются разметчику в следующем порядке: обучение, экзамен, основная, реабилитация. Чтобы изменить порядок выдачи, перейдите в настройки задачи и заполните поле **Приоритет задачи от 0 до 100** или настройте фильтр по навыкам. |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

## [](#%5Fзагружаем%5Fзадания)Загружаем задания

Вы можете загрузить в задачу аудио-, видео- или текстовые файлы, приложения (json, ogg, csv) или изображения, которые требуется разметить. Для этого перейдите в задачу на вкладку **Задания** и нажмите **Загрузить**.

| |  Общий объем загруженных файлов в задаче должен быть не больше 500 Мб. |
| ------------------------------------------------------------------------ |

Подробнее о загрузке читайте в разделе [Задания для разметки](uploading-data.html).

## [](#%5Fнастраиваем%5Fзадачу)Настраиваем задачу

На вкладке **Настройки** вы можете указать дополнительную информацию и регламентировать выполнение задачи.

Подробнее читайте в разделе [Настройки задачи](settings.html).

## [](#%5Fзапускаем%5Fзадачу)Запускаем задачу

Чтобы разметчики увидели задачу и смогли приступить к ее выполнению, нажмите кнопку запуска задачи в проекте или кнопку **Запустить разметку** в задаче.

Вам отобразится список настроек задачи. Если задача корректно наполнена данными, активируется кнопка **Запустить**. Нажмите ее и задача начнет обрабатываться, а затем перейдет в статус **Идёт разметка**.

Подробнее читайте в разделе [Запуск задачи](start.html).

Регистрация
====================


Реабилитационные задачи
====================
Чтобы не удалять разметчика с проекта сразу после понижения [уровня навыка](skills.html) и дать ему второй шанс, добавьте в проект реабилитационную задачу. Разметчик переходит на реабилитационную задачу, если в результате разметки задачи качество навыка опустилось ниже показателя, который вы указали в [настройках](settings.html). В реабилитационных задачах встроена автоматическая проверка. Когда разметчик повысит [качество разметки](quality-consistency.html) до должного уровня, он сможет вернуться на основные задачи проекта.

| |  Статистика реабилитационных задач не учитывается в общей статистике проекта, отображаемой у разметчиков. |
| ----------------------------------------------------------------------------------------------------------- |

Вы можете создать реабилитационную задачу так же, как [основную задачу](quick-start.html#%5Fсоздаем%5Fзадачу). Для этого на вкладке **Задачи** в проекте откройте выпадающий список рядом с кнопкой **Добавить задачу** и выберите нужный тип.

Реабилитационная задача должна содержать основные задания, а также обучающие и контрольные. О том, как создавать такие задания, читайте в разделе [Контрольные и обучающие задания](control-task.html).

Прежде чем запустить реабилитационную задачу, укажите в [настройках](settings.html) навык, в рамках которого будут учитываться результаты заданий.

Настройки задачи
====================
Вы можете регламентировать выполнение задачи разметчиками на вкладке **Настройки**.

## [](#%5Fотображение%5Fи%5Fдоступность)Отображение и доступность

* **Название задачи** — не отображается разметчикам.
* **Описание задачи** — отображается разметчикам.
* **Приоритет задачи от 0 до 100** — настройте порядок отображения задач разметчикам. Задачи с высоким приоритетом отображаются раньше. Значение по умолчанию — 0.

## [](#%5Fнастройка%5Fзаданий)Настройка заданий

* **Перекрытие** — укажите, сколько разметчиков должны разметить каждое задание. По умолчанию — 1.
* **Время на разметку одного задания** — установите лимит времени на выполнение одного задания. По умолчанию — 900 секунд.
* **Кнопка «Пропустить»** — настройте возможность для разметчика пропускать задание, если он сомневается в ответе.
* **Стоимость задания** — укажите стоимость задания в условных единицах, используя систему расчета оплаты разметки, принятую в вашей компании.
* **Лимит количества заданий на одного разметчика в день** — по умолчанию разметчику выдается неограниченное число заданий в день. Включите опцию, чтобы установить лимит по количеству заданий для одного разметчика в день.
* **Выдача заданий по порядку** — по умолчанию задания выдаются в случайном порядке. Включите опцию, чтобы задания выдавались в порядке их загрузки на платформу.

## [](#%5Fконтроль%5Fкачества)Контроль качества

* **Фильтрация разметчиков по навыку** — добавьте фильтр с навыками, без которых разметчик не сможет приступить к задаче. Для этого нажмите **Добавить фильтр**. Далее выберите один или несколько навыков, а также укажите требуемый уровень, например, «Генерация видео ≤ 80» или «Блюда экзамен ≥ 14». Подробнее о навыках читайте в разделе [Навыки](skills.html).
* **Выдача контрольных и обучающих заданий** — включите переключатель, чтобы разметчику иногда попадались [контрольные и обучающие задания](control-task.html), которые влияют на уровень навыка.
* **Вероятность выдачи** – укажите, с какой вероятностью разметчику попадется контрольное или обучающее задание вместо основного.
* **Навык, на который влияет качество ответов** — выберите или создайте навык, значение которого будет меняться по результатам контрольных и обучающих заданий.
* **Отложенная приемка** — включите переключатель, чтобы настроить [ручную приемку](acceptance.html) результатов разметки.
* **Автоматическое принятие ответов** — укажите, в течение скольких дней после отправки ответа нужно его проверить.
* **Порог качества для контрольных заданий** — укажите минимальный показатель [качества](quality-consistency.html), при котором ответ на контрольное задание не отклоняется автоматически.

## [](#%5Fдополнительно)Дополнительно

* **Дедлайн** — выберите дату, до которой вы планируете завершить разметку.
* **Бюджет** — укажите количество условных единиц, которые вы планируете потратить на выполнение задачи.
* **Качество разметки** — укажите, какой процент правильных ответов на контрольные и обучающие задания вы планируете получить. Формат — число от 0 до 1\. Подробнее о расчете качества — в разделе [Качество и согласованность](quality-consistency.html).
* **Согласованность ответов** — укажите, какую согласованность ответов разметчиков вы планируете получить. Формат — число от 0 до 1.
* **Плановое количество разметчиков** — укажите необходимое плановое количество разметчиков.
* **Payload** — позволяет использовать свой справочник тематик для разных групп заданий. Если в payload указаны классы, то они заменят те, что заданы в блоке с классами entities в настройках проекта.

Навыки
====================
Навык разметчика — это тип разметки, с которым разметчик уже успешно работал.

Навык присваивается разметчику, когда он успешно выполняет [контрольные и обучающие задания](control-task.html). Уровень навыка — это процент правильных ответов среди последних контрольных и обучающих задач с этим навыком, которые выполнял разметчик.

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

Полный список навыков и разметчиков, которые ими обладают, вы можете посмотреть в разделе **Навыки** в левом меню.

## [](#%5Fсоздаем%5Fнавык)Создаем навык

Чтобы создать новый навык:

1. Перейдите в раздел **Навыки** на вкладку **Список навыков**.
2. Нажмите **Создать навык**.
3. В открывшемся окне укажите название навыка и количество заданий, влияющих на значение навыка и выберите тип отображения.
4. Нажмите **Подтвердить**.

## [](#%5Fназначаем%5Fнавык%5Fразметчикам)Назначаем навык разметчикам

Если вам нужно присвоить разметчикам навык, загрузите файл со списком разметчиков. Для этого:

1. Перейдите в раздел **Навыки** на вкладку **Пользователи и навыки**.
2. Нажмите **Загрузить навыки таблицей**.
3. Выберите на компьютере файл формата xlsx, tsv или csv. В файле должны быть следующие столбцы:  
   * `person` — электронный адрес разметчика;  
   * `skill` — uid или название навыка;  
   * `value` — уровень навыка.

## [](#%5Fвыбираем%5Fлучших%5Fразметчиков)Выбираем лучших разметчиков

Чтобы улучшить качество разметки, вы можете в [настройках задачи](settings.html) указать, какой уровень навыка должен быть у разметчиков, которые будут работать с задачей.

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

## [](#%5Fнастраиваем%5Fконтрольные%5Fи%5Fобучающие%5Fзадания)Настраиваем контрольные и обучающие задания

Если в задачу включены [контрольные или обучающие задания](control-task.html), то результаты будут влиять на уровень навыка разметчика.

Укажите, какой навык разметчика должен меняться в процессе выполнения задачи:

1. Перейдите в [настройки задачи](settings.html).
2. Включите выдачу контрольных и обучающих заданий в разделе **Навыки и качество разметки**.
3. Укажите вероятность выдачи контрольного или обучающего задания.
4. Выберите навык в поле **Навык, на который влияет качество ответов** или создайте новый с помощью кнопки **Создать навык**.

Запуск задачи
====================
Чтобы разметчики увидели задачу и смогли приступить к ее выполнению, вам нужно запустить задачу. Для этого:

1. Нажмите кнопку запуска задачи в проекте или кнопку **Запустить** в задаче. Вам отобразится список настроек задачи.
2. Если в задаче есть незаполненные разделы, они будут выделены красным. Вам нужно корректно настроить задачу.
3. Если задача корректно наполнена данными, активируется кнопка **Запустить**. Нажмите ее и задача начнет обрабатываться. Время обработки зависит от объема данных в задаче.
4. Когда задача обработана, ее статус изменяется на **Идёт разметка** и отображается индикатор выполнения задачи. Индикатор показывает, сколько заданий в задаче уже размечены.

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

Даже если разметка еще не закончена, вы можете посмотреть промежуточные результаты. Подробнее — в разделе [Результаты разметки](downloading-data.html).

О статусах задач читайте в разделе [Жизненный цикл задачи](task-flow.html).

Статистика
====================
## [](#%5Fстатистика%5Fзадачи)Статистика задачи

Чтобы посмотреть статистику по задаче, перейдите в задачу на вкладки **Обзор** и **Статистика**.

Здесь вы найдете информацию о статусе задачи, количестве размеченных объектов, качестве и согласованности, среднем времени разметки одного объекта, сроки и бюджет, разметчики – активные, скольким доступна задача, сколько всего выполняли задачу, среднее количество заданий, а также графики разметки по дням или часам.

## [](#%5Fстатистика%5Fпроекта)Статистика проекта

Статистика по проекту находится в проекте на вкладке **Статистика**.

Здесь указан статус проекта, количество задач, размеченных объектов, групп разметчиков на проекте, а также общее число разметчиков в этих группах.

## [](#%5Fобщая%5Fстатистика)Общая статистика

В разделе **Статистика** в левом меню представлена общая статистика компании, а также статистика работы разметчиков. Здесь представлена следующая информация:

* общее количество проектов;
* количество проектов с активными задачами;
* количество размеченных объектов;
* количество активных задач;
* количество выполненных задач;
* количество объектов, откправленных на исполнение;
* количество групп разметчиков;
* общее количество разметчиков.

## [](#%5Fкак%5Fскачать%5Fстатистику)Как скачать статистику

Чтобы скачать статистику, нажмите **Скачать статистику** в верхней части страницы, и в открывшемся окне настройте период и выберите тип статистики — по задачам или по разметчикам. Затем нажмите **Скачать в csv** или **Скачать в xlsx**.

## [](#%5Fкак%5Fоткрыть%5Fcsv%5Fфайл)Как открыть CSV-файл

Чтобы открыть CSV-файл, вы можете использовать Microsoft Excel 2016-2019:

1. Откройте Microsoft Excel, перейдите на вкладку **Данные**, нажмите **Внешние данные** и выберите пункт **Из текста**.
2. Через файловый менеджер найдите нужный файл и откройте его. В Excel откроется окно «Мастер текстов (импорт)».
3. Пройдите три шага, чтобы настроить импорт, как показано на рисунках:  
![4](_images/excel/4.png)  
![5](_images/excel/5.png)  
![6](_images/excel/6.png)
4. В открывшемся окне поместите получившиеся данные на существующий лист или создайте новый.  
![7](_images/excel/7.png)

Теперь данные готовы для работы.

Остановка задачи
====================
Чтобы остановить разметку задачи, нажмите кнопку остановки задачи в проекте или кнопку **Остановить разметку** в задаче. Задача перейдет в статус **Остановлена**. О статусах задач читайте в разделе [Жизненный цикл задачи](task-flow.html).

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

Если вы остановили основную задачу, работающие с ней разметчики завершат разметку текущего задания, а затем перейдут к другим задачам.

Жизненный цикл задачи
====================
Когда вы создаете задачу, ей присваивается статус **Ожидает запуска**.

Запустите задачу и разметчики начнут работать с ней, а статус поменяется на **Идёт разметка**.

Если задача не размечается никем в течение 30 дней, то она переходит в статус **Остановлена**. Вы также можете остановить задачу вручную, если ее нужно изменить, а затем запустить снова.

Когда задачу разметило достаточное количество разметчиков, она переходит в статус **Завершена**. Если нужно, вы можете загрузить в нее новые данные или запустить снова.

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

![Жизненный цикл задачи](_images/task-flow.png) 

Шаблоны
====================
Чтобы выбрать шаблон верстки, определите, в чем заключается задание для разметчика:

* Описать объект. На форме размещается объект и поле для ввода текста. Подходят шаблоны: **Транскрибация аудиозаписей**, **Транскрибация видеозаписей**, **Транскрибация изображений Captcha**, **Генерация текста**.
* Классифицировать объект. На форме размещается объект и радиокнопки для ответов. Подходят шаблоны классификации.
* Сравнить объекты. На форме размещается два объекта и радиокнопки для ответов. Подходят шаблоны: **Сравнение текста**, **Сравнение изображений**, **Сравнение аудио**, **Сравнение видео**. Чтобы приложить к заданию несколько объектов, расположите их во внешнем хранилище. Подробнее читайте в разделе [Загрузка двух объектов для сравнения](uploading-data.html#%5Fзагрузка%5Fдвух%5Fобъектов%5Fдля%5Fсравнения).
* Сегментировать объект — найти и выделить заданную информацию. В центре формы располагается объект разметки, слева — список классов информации, которые нужно выделить, справа — список выделенных фрагментов и, при необходимости, вопросы к каждому фрагменту. Подходят [шаблоны сегментации](interface-segmentation.html).
* Сгенерировать контент. На форме размещается блок для загрузки медиа или поле для ввода текста. Подходят [шаблоны генерации](interface-generation.html).

## [](#%5Fтекст)Текст

Вы загружаете текст без форматирования (TXT) или в HTML-разметке (HTML).

* **Классификация текста (TXT)** — разметчик отвечает на вопросы о содержании текста.
* **Классификация текста с динамической формой (TXT)** — разметчик отвечает на вопросы о содержании. Форма меняется в зависимости от ответов разметчика.
* **Классификация текста (HTML)** — разметчик отвечает на вопросы о содержании текста. Текст может быть оформлен с помощью стилей в блоке **CSS**.
* **Классификация текста со стилями (HTML)** — разметчик отвечает на вопросы о содержании текста. Текст может быть оформлен с помощью стилей в блоке **CSS**.
* **Классификация текста для обучения QnA** — разметчик проверяет результаты выдачи поисковиков и отвечает на вопросы.
* **Сегментация текста (HTML)** — разметчик выделяет фрагменты текста, отвечает на вопросы по ним и заполняет онтологию.
* **Сегментация текста со стилями (HTML)** — разметчик выделяет фрагменты текста и отвечает на вопросы. Шаблон можно использовать как пример оформления с помощью CSS-стилей.
* **Сегментация текста HTML с классификацией** — разметчик выделяет фрагменты текста и отвечает на вопросы по ним и на общие вопросы о тексте.
* **Генерация текста** — разметчик создает описание для изображения или видео, перефразирует видео или генерирует иной текстовый контент.
* **Сравнение текста** — разметчик отвечает на вопросы о двух блоках текста.

![text](_images/text.png) 

## [](#%5Fизображения)Изображения

* **Сравнение изображений** — разметчик выбирает варианты ответов на вопрос, например, «Какое из изображений цветное?». Входные данные — JSON-файл с изображением в формате Base-64.
* **Транскрибация изображений Captcha** — разметчик вводит в поле символы с картинки.
* **Классификация изображений** — разметчик отвечает на вопросы, например, «Сколько человек на изображении?» или «Есть ли на изображении животные?».
* **Гамма-коррекция изображения** — разметчик настраивает комфортную гамму на изображении.
* **Сегментация изображений** — разметчик выделяет предметы на изображении и отвечает на вопросы.
* **Создание изображений** — разметчик загружает изображение или делает снимок с помощью веб-камеры. Можно добавить несколько блоков генерации на страницу.
* **Сегментация изображений с классификацией** — разметчик выделяет предметы на изображении и отвечает на вопросы с дополнительной разметкой.

![segmentation](_images/segmentation.png) 

## [](#%5Fдиалоги)Диалоги

* **Классификация диалогов (JSON)** — разметчик отвечает на вопросы о диалоге.
* **Сегментация диалогов (JSON)** — разметчик выделяет реплики и отвечает на вопросы.
* **Сегментация диалогов (CSV)** — разметчик выделяет реплики и отвечает на вопросы.
* **Классификация диалогов с сегментацией (CSV)** — разметчик выделяет реплики и отвечает на вопросы об этих репликах и о диалоге в целом.
* **Классификация диалогов с сегментацией (JSON)** — разметчик выделяет реплики и отвечает на вопросы об этих репликах и о диалоге в целом.

![dialogue](_images/dialogue.png) 

## [](#%5Fаудио)Аудио

* **Сравнение аудио** — разметчик отвечает на вопросы о двух аудиозаписях.
* **Транскрибация аудиозаписей** — разметчик вводит текст из аудио в поле ответа.
* **Классификация аудиозаписей** — разметчик отвечает на вопросы, например, «Сколько человек говорит на записи?» или «Есть ли на записи посторонние звуки?».
* **Запись речи** — разметчик загружает аудиофайл или записывает речь с помощью микрофона.
* **Сегментация аудио** — разметчик выделяет фрагменты аудио на таймлайне.

![audio](_images/audio.png) 

## [](#%5Fвидео)Видео

Вы загружаете видео формата MP4.

* **Сравнение видео** — разметчик отвечает на вопросы о двух видеозаписях.
* **Транскрибация видеозаписей** — разметчик записывает услышанное и увиденное на видео в поле ответа.
* **Классификация видеозаписей** — разметчик отвечает на вопросы, например, «Сколько человек на видео?» или «Есть ли на видео автомобили?».
* **Сегментация видеозаписей** — разметчик выделяет фрагменты видео на таймлайне.
* **Генерация видео** — разметчик записывает видео.

![video](_images/video.png) 

## [](#%5Fдокументы)Документы

Вы загружаете документ формата PDF.

* **Сегментация PDF-файла** — разметчик выделяет страницы документа и отвечает на вопросы.

![pdf](_images/pdf.png) 

## [](#%5Fдополнительные)Дополнительные

Вы загружаете материал любого формата и атрибутивные материалы к нему.

* **Классификация составного объекта с формой**.
* **Классификация текста на основе справочника в csv**.

Обучение и экзамен
====================
Чтобы убедиться, что разметчики поняли инструкцию, добавьте в проект обучающую и экзаменационную задачи. В таких задачах встроена автоматическая проверка, и результат ответов разметчика влияет на [уровень навыка](skills.html).

Если в проекте включены обучение или экзамен, то разметчики сначала будут выполнять их. Затем, если уровень приобретенного навыка будет достаточным, разметчики смогут приступить к основным задачам проекта.

## [](#%5Fсоздаем%5Fобучение%5Fи%5Fэкзамен)Создаем обучение и экзамен

Вы можете создать обучающую или экзаменационную задачу так же, как [основную задачу](quick-start.html#%5Fсоздаем%5Fзадачу). Для этого на вкладке **Задачи** в проекте откройте выпадающий список рядом с кнопкой **Добавить задачу** и выберите нужный тип.

В обучающей задаче все задания должны быть обучающими, а в экзаменационной — контрольными. О том, как создавать такие задания, читайте в разделе [Контрольные и обучающие задания](control-task.html).

Прежде чем запустить обучающую или экзаменационную задачу, укажите в [настройках](settings.html) навык, в рамках которого будут учитываться результаты заданий.

## [](#%5Fнастраиваем%5Fобучение%5Fи%5Fэкзамен)Настраиваем обучение и экзамен

Вы можете регламентировать выполнение задачи разметчиками на вкладке **Настройки**.

### [](#%5Fотображение%5Fи%5Fдоступность)Отображение и доступность

* **Название задачи** — не отображается разметчикам.
* **Описание задачи** — отображается разметчикам.

### [](#%5Fнастройка%5Fзаданий)Настройка заданий

* **Количество заданий на одного разметчика** — включите переключатель, чтобы указать, сколько заданий нужно выполнить разметчику, чтобы задача завершилась.
* **Время на разметку одного задания** — установите лимит времени на выполнение одного задания. По умолчанию — 900 секунд.
* **Стоимость задания** — укажите стоимость задания в условных единицах, используя систему расчета оплаты разметки, принятую в вашей компании.
* **Лимит количества заданий на одного разметчика в день** — по умолчанию разметчику выдается неограниченное число заданий в день. Включите опцию, чтобы установить лимит по количеству заданий для одного разметчика в день.
* **Выдача заданий по порядку** — по умолчанию задания выдаются в случайном порядке. Включите опцию, чтобы задания выдавались в порядке их загрузки на платформу.

### [](#%5Fконтроль%5Fкачества)Контроль качества

* **Фильтрация разметчиков по навыку** — выберите навык, без которого разметчик не сможет приступить к задаче, а также укажите требуемый уровень навыка. Подробнее читайте в разделе [Навыки](skills.html).
* **Навык, на который влияет качество ответов** — выберите или создайте навык, значение которого будет меняться по результатам контрольных и обучающих заданий.
* **Порог качества для обучающих заданий** — разметчику будет показана подсказка в случае значения качества ответа по заданию ниже заданного порога.

### [](#%5Fдополнительно)Дополнительно

* **Бюджет** — укажите количество условных единиц, которые вы планируете потратить на выполнение задачи.
* **Качество разметки** — укажите, какой процент правильных ответов на контрольные и обучающие задания вы планируете получить. Формат — число от 0 до 1\. Подробнее о расчете качества — в разделе [Качество и согласованность](quality-consistency.html).
* **Плановое количество разметчиков** — укажите необходимое плановое количество исполнителей.
* **Payload** — позволяет использовать свой справочник тематик для разных групп заданий. Если в payload указаны классы, то они заменят те, что заданы в блоке с классами entities в настройках проекта.

Атрибуты
====================
В задачу можно добавить атрибутивные данные, которые будут использоваться при разметке:

* Предразметка — предварительно установленные метки.
* Правильные ответы для автоматической проверки.
* Дополнительные свойства объектов для использования в интерфейсе разметки, например, известная маска ввода.

Вы можете добавить атрибутивные данные в задачу несколькими способами:

1. Загрузить в виде JSON-файла вместе с заданиями. Подробнее читайте в разделе [Задания для разметки](uploading-data.html).
2. Добавить вручную для каждого задания. Для этого:  
   * Нажмите **Открыть список заданий** на вкладке **Задания**.  
   * Нажмите кнопку меню в строке выбранного задания.  
   * Выберите **Открыть атрибуты**. Вам откроется редактор атрибутов.  
   * Добавьте атрибуты в блок **JSON** с указанием назначения:  
         * control — объект размером не более 500 Кб (валидный JSON).  
         * premarkup — объект (валидный JSON).  
         * explanation — строка.  
         [source,json]  
         ----  
         {  
             "explanation": "подсказка",  
             "control": {},  
             "premarkup": {}  
         }  
   * Нажмите **Сохранить**.

Загрузка файлов
====================
В задаче на вкладке **Задания** вы можете загрузить аудио-, видео- или текстовые файлы, таблицы (xlsx, csv, tsv), приложения (json и ogg) или изображения, которые требуется разметить. Для этого нажмите **Загрузить данные** или **Загрузить ещё**, если в задаче уже есть задания.

## [](#%5Fограничения)Ограничения

Максимальный размер загружаемого файла: 500 Мб. Количество файлов не ограничено.

Нельзя загружать файлы следующих форматов: apk, app, bat, bin, cgi, cmd, com, cpp, js, jse, exe, gadget, gtp, hta, jar, msi, msu, paf, paf.exe, pif, ps1, pwz, scr, thm, vb, vbe, vbs, wsf.

## [](#%5Fизображения%5Fаудио%5Fи%5Fвидео)Изображения, аудио и видео

Когда вы загружаете изображения, аудио или видео, то по умолчанию ссылки на эти файлы будут доступны в настройках интерфейса по переменной `filename`.

Если вы хотите переопределить переменную, то используйте объект [dataMapping](datamapping.html) в поле **Config** на вкладке **Интерфейс**.

## [](#%5Fтекстовые%5Fфайлы)Текстовые файлы

Когда вы загружаете текстовый файл, то данные из файла автоматически доступны в настройках интерфейса по переменной `fileData`.

Если вы хотите переопределить переменную, то используйте объект [dataMapping](datamapping.html) в поле **Config** на вкладке **Интерфейс**.

## [](#%5Fjson%5Fфайлы)JSON-файлы

Пример JSON-файла вы можете посмотреть и скачать на вкладке **Интерфейс** в блоке [Example data](interface-example-data.html).

## [](#%5Fтаблицы)Таблицы

Вы можете загрузить данные в табличном формате — xlsx, csv или tsv. Для этого используйте раздел [Датасеты](datasets.html) или создайте таблицу самостоятельно.

* Размер файла — до 50 Мб.
* Количество строк в файле — до 50 тысяч.
* Каждая строка соответствует одному заданию.
* Пустые строки игнорируются.
* Данные таблицы сохраняются в системе в виде JSON. Невалидный JSON, текст и числа сохраняются в виде строки.
* Таблица не загрузится, если в ней нет столбца **INPUT** или другого аналогичного.

Пример таблицы вы можете скачать на вкладке **Интерфейс** в блоке [Example data](interface-example-data.html).

Заголовки столбцов:

* **INPUT:<input data field>** — данные для разметки. Данные могут быть в виде текста, URL или JSON. Если в таблице нет столбца с таким заголовком, то в качестве данных для разметки сохранятся данные из других столбцов, исключая столбцы, приведенные ниже.
* **FILENAME** — название задания, отображается в задаче и в результатах разметки. Могут быть не уникальные значения. Если данных нет, название генерируется в виде: _\[название файла\] + \[номер строки\]_. Если столбец заполнен не для всех строк, отображается ошибка разбора файла.
* **GOLDEN:<output data field>** — правильные ответы на контрольные задания. Столбец нужен только в контрольных и обучающих заданиях.
* **HINT:<output data field>** — подсказка к обучающему заданию. В таблице может быть несколько столбцов **HINT**, их содержимое объединяется в общий текст и отображается над заданием.
* **PREMARKUP:<output data field>** — данные предразметки.

Данные из столбца **INPUT** (или другого аналогичного) сохраняются в системе в формате JSON:

* Eсли вы указали данные в виде текста, числа или URL, то они сохранятся в виде строки, например:  
```JSON  
{  
    "text": "25000"  
}  
```
* Eсли вы указали данные в формате валидного JSON, то они сохранятся в формате JSON внутри объекта:  
```JSON  
{  
    "data": {  
        "date": "29.05",  
        "text": "Привет",  
        "claim": "wrgw"  
    }  
}  
```
* Если вы используете кавычки, в JSON они автоматически экранируются:  
```JSON  
{  
    "text": "ОАО \"Ромашка\""  
}  
```

Данные из остальных столбцов сохраняются в системе в виде файла атрибутов. Например:

|== | **GOLDEN:result1** |**GOLDEN:text** |**HINT:text** |**PREMARKUP:result2**| Правильный ответ | 1 | Подсказка | 0 |==

```JSON
{
    "control": {
        "result1": "Правильный ответ",
        "text": "1"
    },
    "explanation": "Подсказка",
    "premarkup": {
        "result2": "0"
    }
}
```

## [](#%5Fзагрузка%5Fдвух%5Fфайлов%5Fдля%5Fсравнения)Загрузка двух файлов для сравнения

Чтобы добавить в задание несколько файлов для сравнения, загрузите файлы на платформу TagMe в раздел [Датасеты](datasets.html) или используйте внешнее хранилище с доступом по HTTP-протоколу.

Затем загрузите в задачу файл со ссылками, например:

```javascript
{
  "image1": "/docs/templates/data/image1.png",
  "image2": "/docs/templates/data/image2.png"
}
```

## [](#%5Fpdf%5Fфайлы)PDF-файлы

Чтобы загрузить PDF-файлы для шаблона **Сегментация PDF-файла**, используйте [SDK](../sdk/cli.html).

## [](#%5Fфайлы%5Fс%5Fпредразметкой)Файлы с предразметкой

Вы можете загрузить в задачу предварительно установленные метки — предразметку.

Предразметка загружается вместе с объектом разметки в JSON-файле или настраивается в редакторе атрибутов задания. Подробнее читайте в разделе [Атрибуты](uploading-attributes.html).

Пример JSON файла с предразметкой

```JSON
{
    "messages": [
        {
           ...
        },
        ...
        {
            ...
        }
    ],
    "marks": [
        {
            "id": "mark-1",
            "messageId": "message-2",
            "entityId": "entity-1"
        },
        {
            "id": "mark-2",
            "messageId": "message-2",
            "entityId": "entity-2"
        }
    ]
}
```

Структура меток должна соответствовать структуре, которая будет отправляться разметчиками в созданном задании.

Например, использовать шаблон для сегментации изображений. В JS-блоке внести следующие изменения, связанные с обработкой загруженного файла.

JS

```javascript
const prepareTask = async (task, templateData) => {
    const {marks} = templateData
    const premarkupMarks = Array.isArray(marks) ? marks : [];

    return {
        ...task,
        marks: premarkupMarks,
        validateResult(result) {
            if (result.marks.length == 0) {
                return 'Разметьте изображение';
            }
            return true;
        },

        transformResult(result) {
            return result;
        }
    };
};

exports.Task = class Task extends exports.Task {
    render() {
        prepareTask(this.task, this.getTemplateData())
            .then((preparedTask) => {
                this.validate = preparedTask.validateResult;
                this.transform = preparedTask.transformResult;
                super.render();
                this.setPreparedTask(preparedTask);
            });
    }
};
```

EXAMPLE

```json
{
    "filename": "https://tagme.sberdevices.ru/docs/customer/_attachments/premarkup-plus-base64.json"
}
```

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

Если вы сомневаетесь в ответе, нажмите **Инструкция** в верхней части формы.

Когда вы ответили на все вопросы, нажмите **Отправить** в верхней части формы и вы перейдете к следующему заданию.

Выполняем задания
====================
| |  Перед началом работы на платформе пройдите [обучение](https://tagme.sberdevices.ru/course/index.html). Оно займет около часа, познакомит вас с TagMe и даст понять, как работать с основными типами заданий. |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

Чтобы приступить к работе, авторизуйтесь на [платформе](https://tagme.sberdevices.ru). В разделе **Проекты** вам отобразится список доступных проектов разметки. В некоторых проектах можно сразу приступать к разметке, а в других нужно сначала [пройти обучение и экзамен](training-examination.html).

Нажмите **Начать** в строке выбранного проекта. Вам откроется инструкция. Внимательно прочитайте ее и, когда будете готовы начать выполнять задания, нажмите **Приступить к разметке**.

Внимательно прочитайте инструкцию и ознакомьтесь с объектом. Объекты бывают нескольких видов:

* аудиозапись;
* видеозапись;
* изображение;
* текст;
* диалог — текст, оформленный в виде диалога нескольких персонажей.

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

Теперь можно приступать к выполнению задания. Задания могут быть нескольких видов:

* [Ответить на вопросы](answering.html). Вас могут попросить выбрать правильный вариант ответа, ввести капчу или транскрибировать аудиозапись.
* [Классифицировать объект](classification.html). Например, определить, к какому классу относится аудиозапись звонка в колл-центр — «вопрос» или «претензия».
* [Создать объект](creation.html). Например, начитать текст в микрофон или загрузить фото.
* [Сегментировать объект](segmentation-overview.html). Например, найти и выделить в тексте имена собственные, присвоить каждому класс («имя человека», «кличка животного» или «название города»), а затем ответить на вопросы по каждому имени собственному.

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

## [](#%5Fрежим%5Fтолько%5Fдля%5Fчтения)Режим только для чтения

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

Релиз 4.0.0
====================
## [](#%5Fкнопка%5Fотправить)Кнопка "Отправить"

При нажатии на Enter на Numpad задание будет отправляться, как выполненное.

Релиз 4.1.0
====================
## [](#%5Fповорот%5Fизображений%5Fв%5Fразметке%5Fс%5Fсегментацией)Поворот изображений в разметке с сегментацией

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

Релиз 4.10.0
====================
## [](#%5Fсмена%5Fвендора%5Fпо%5Fссылке%5Fприглашению)Смена вендора по ссылке-приглашению

Теперь при переходе по ссылке-приглашению, добавление в новую организацию прозойдет только в 00:00 по МСК следующего дня, до этого времени вы будете находиться в изначальной. Если вы ранее не были закреплены за вендором — переход осуществляется сразу.

## [](#%5Fулучшении%5Fсегментации%5Fсеквенции%5Fизображений)Улучшении сегментации секвенции изображений

В шаблоне "Сегментация изображений по кадрам" стало ещё удобнее работать с последовательностями. Был добавлен трекинг для инструмента ключевой точки. Также теперь поддерживается сохранение выделенного фрагмента при переходе по кадрам (только для трекинг-фрагментов).

Добавлены горячие клавиши: \* `T` — включить трекинг \* `O` — скрыть / показать фрагмент \* `Ctrl + B` \+ `Enter` — дублировать фрагмент и применить дублирование

Релиз 4.11.0
====================
## [](#%5Fсамостоятельное%5Fисправление%5Fответов%5Fвалидатором)Самостоятельное исправление ответов валидатором

В разделе «Валидация» при просмотре ответов исполнителей у валидаторов появилось действие «Исправить самостоятельно».

## [](#%5Fинструмент%5Fполилиния%5Fв%5Fсегментации%5Fпо%5Fкадрам)Инструмент «Полилиния» в сегментации по кадрам

В шаблон разметки «Сегментация изображений по кадрам» добавлен новый инструмент «Полилиния».

Для полилинии доступны действия через контекстное меню: включение трекинга объекта и дублирование на несколько кадров вперед.

## [](#%5Fнастройка%5Fстолбцов%5Fв%5Fответах%5Fисполнителей)Настройка столбцов в «Ответах исполнителей»

В разделе «Ответы разметчиков» появилась кнопка настройки. Валидатор может управлять отображением и порядком столбцов таблицы.

Релиз 4.2.0
====================
## [](#%5Fразметка%5Fзаданий%5Fпо%5Fпорядку)Разметка заданий по порядку

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

Релиз 4.3.0
====================
## [](#%5Fповорот%5Fи%5Fмасштабирование)Поворот и масштабирование

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

## [](#%5Fскорость%5Fвоспроизведения%5Fаудио)Скорость воспроизведения аудио

Во время прослушивания теперь можно поставить скорость воспроизведения 0.75x.

Релиз 4.4.0
====================
## [](#%5Fвкладка%5Fмои%5Fответы)Вкладка «Мои ответы»

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

Релиз 4.5.0
====================
## [](#%5Fавтоисключение%5Fиз%5Fгрупп%5Fпри%5Fсмене%5Fвендора)Автоисключение из групп при смене вендора

При принятии приглашения от организации с другим вендором, он автоматически меняется, происходит исключение из всех групп в других организациях.

Релиз 4.6.0
====================
## [](#%5Fоглавление%5Fинструкции)Оглавление инструкции

У инструкции теперь есть оглавление, есть возможность перемещаться по ней, нажимая на нужные разделы.

Релиз 4.7.0
====================
## [](#%5Fоповещения%5Fпри%5Fобновлении%5Fинструкции)Оповещения при обновлении инструкции

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

Релиз 4.8.0
====================
## [](#%5Fполучение%5Fбонуса%5Fили%5Fштрафа)Получение бонуса или штрафа

Теперь заказчик может назначать бонусы и штрафы при разметке заданий. В статистике будет отображаться информация о них через соответствующие иконки.

## [](#%5Fконтакты%5Fзаказчиков)Контакты заказчиков

Теперь из вкладки «Мои ответы» есть возможность перейти в контакты заказчика, чтобы связаться с ним.

Релиз 4.9.0
====================
## [](#%5Fроль%5Fвалидатора)Роль валидатора

Теперь есть возможность работать в роли валидатора с ограниченными правами: просмотр ответов, принятие/отклонение ответов, оставление комментариев, проставление качества, отправка ответов на доработку, исправление ответа разметчика и просмотр статуса ответов. Раздел "Валидация" в сайдбаре показывает доступные проекты и задачи.

## [](#%5Fувеличение%5Fколичества%5Fзнаков%5Fв%5Fкомментарий%5Fдля%5Fроли%5Fвалидатора)Увеличение количества знаков в комментарий – для роли валидатора

Комментарии к ответам исполнителям теперь могут быть длиннее (до 2000 символов).

## [](#%5Fсегментация%5Fсеквенции%5Fизображений)Сегментация секвенции изображений

При работе с сегментацией изображений теперь можно: переключать кадры, дублировать объекты, делать объекты ключевыми, добавлять аннотации, скрывать объекты и запускать перелистывание страниц. Кнопки в шаблоне:

* `<<` – возврат в начало
* `>>` – возврат в конец
* `<` – переключение назад на однин кадр
* `>` – переключение вперед на один кадр
* `иконка Звёздочка` – пометить объект ключевым
* `иконка Фрейм` – скрытие/отображение объекта в кадре

История обновлений TagMe
====================
**Релизы 2026 года:**

* [Релиз 4.11.0](changelog-4-11-0.html)
* [Релиз 4.10.0](changelog-4-10-0.html)
* [Релиз 4.9.0](changelog-4-9-0.html)

**Релизы 2025 года:**

* [Релиз 4.8.0](changelog-4-8-0.html)
* [Релиз 4.7.0](changelog-4-7-0.html)
* [Релиз 4.6.0](changelog-4-6-0.html)
* [Релиз 4.5.0](changelog-4-5-0.html)
* [Релиз 4.4.0](changelog-4-4-0.html)
* [Релиз 4.3.0](changelog-4-3-0.html)
* [Релиз 4.2.0](changelog-4-2-0.html)
* [Релиз 4.1.0](changelog-4-1-0.html)
* [Релиз 4.0.0](changelog-4-0-0.html)

Классифицируем объекты
====================
В заданиях по классификации экран разделен на три части:

* По центру — объекты разметки: текст, диалог или изображение.
* Слева — перечень классов, которые можно присвоить каждому объекту.
* Справа — список объектов с присвоенными классами.

Если в строчке объекта в правой части формы появилась иконка ![icon annotation](_images/icon-annotation.png), нажмите на нее и ответьте на вопросы. Чтобы вернуться к списку объектов, нажмите на крестик или Esc на клавиатуре. Вам отобразится список всех объектов.

| |  Перед отправкой задачи проверьте, что вы ответили на вопросы по всем объектам. Вы можете переключаться между объектами с помощью стрелок или с помощью Tab на клавиатуре. |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

Если вы ошибочно присвоили класс объекту, удалите его. Для этого нажмите на мусорную корзину в строчке объекта в правой части формы ![icon trash](_images/icon-trash.png).

Чтобы ускорить работу, используйте [горячие клавиши](hotkeys.html).

Создаем объекты
====================
В таких заданиях вам могут предложить создать контент:

* записать голос в микрофон или загрузить аудиозапись;
* сфотографироваться или загрузить фото;
* написать небольшой текст, например, описать товар.

Если вы не уверены, что нужно сделать, нажмите **Инструкция** в верхней части формы.

Частые вопросы
====================
Мы публикуем важные обновления и информацию о новых проектах в [Telegram-канал](https://t.me/+KBKq4qEIvGgwZThi).

![QR-код Telegram-канала](_images/tg-channel-qr.png) 

## [](#%5Fтехнические%5Fвопросы)Технические вопросы

### [](#%5Fне%5Fпомню%5Fлогин%5Fи%5Fпароль%5Ftagme)Не помню логин и пароль TagMe

Воспользуйтесь кнопкой **Войти с помощью ABC Elementary**.

Если вы не помните логин и пароль от ABC Elementary, то нажмите **Забыли пароль?**.

### [](#%5Fвозникла%5Fтехническая%5Fпроблема)Возникла техническая проблема

Воспользуйтесь кнопкой **Помощь** или напишите нам на [почту](mailto:<!--#echo var="nginx%5Fssi%5Femail"-->?subject=tagme) .

### [](#%5Fна%5Fкаком%5Fустройстве%5Fможно%5Fработать)На каком устройстве можно работать?

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

### [](#%5Fнужны%5Fнаушники)Нужны наушники?

Нет. Но вы можете их использовать для улучшения качества звука при выполнении заданий, содержащих аудио.

## [](#%5Fвопросы%5Fо%5Fсамозанятости)Вопросы о самозанятости

### [](#%5Fчто%5Fзначит%5Fбыть%5Fсамозанятым)Что значит быть самозанятым?

Это значит, что доходы с подработки необходимо регистрировать в налоговой службе. Деньги, заработанные таким образом, называются «профессиональным доходом» — с него самозанятые уплачивают государству 6 % (если доход получен от организации).

### [](#%5Fзачем%5Fоформлять%5Fсамозанятость)Зачем оформлять самозанятость?

Чтобы официально получать доход. Без статуса самозанятого вы не сможете вывести заработанные деньги с платформы.

### [](#%5Fкак%5Fстать%5Fсамозанятым)Как стать самозанятым?

Оформить самозанятость можно, например, на сайте [Свое дело](https://www.sberbank.com/ru/svoedelo/start#freeservices) от Сбербанка.

### [](#%5Fесли%5Fя%5Fофициально%5Fтрудоустроен%5Fмогу%5Fя%5Fстать%5Fсамозанятым)Если я официально трудоустроен, могу я стать самозанятым?

Да, вы можете совмещать основную работу с самозанятостью, например, работать в компании и подрабатывать удаленно на платформе. При этом работодатель будет оплачивать за вас НДФЛ 13% с дохода от работы по трудовому договору, а вы сами будете дополнительно оплачивать налог от самозанятости при подработке на платформе.

### [](#%5Fесли%5Fя%5Fип%5Fмогу%5Fя%5Fстать%5Fсамозанятым)Если я ИП, могу я стать самозанятым?

Да, но может потребоваться изменить режим налогообложения. Уточните подробности в налоговой службе вашего региона.

### [](#%5Fкакие%5Fограничения%5Fпо%5Fдоходу)Какие ограничения по доходу?

Налог на самозанятость можно платить, только пока сумма дохода за год не превысит 2,4 млн. руб. Если ваш доход становится больше этой суммы, вы не можете быть самозанятым.

### [](#%5Fкак%5Fрассчитать%5Fналог)Как рассчитать налог?

Самостоятельно ничего считать не нужно. Применение налогового вычета, контроль над ограничением по сумме дохода и другие особенности расчета полностью автоматизированы.

### [](#%5Fчто%5Fобязан%5Fделать%5Fсамозанятый)Что обязан делать самозанятый?

* При каждом получении денег — формировать и передавать чек в ООО ПКО «АБК». Как в магазине при покупке любого товара вам обязаны выдать кассовый чек, так и вы после получения оплаты должны отправить чек организации. Формирование чеков — ваша личная ответственность.
* Ежемесячно — платить налог в приложении, где вы оформляли самозанятость.

### [](#%5Fкак%5Fформировать%5Fчеки%5Fесли%5Fвы%5Fстали%5Fсамозанятым%5Fчерез%5Fсвое%5Fдело%5Fот%5Fсбербанка)Как формировать чеки, если вы стали самозанятым через Свое дело от Сбербанка?

Формировать чеки нужно вручную при поступлении оплаты онлайн или наличными от ваших клиентов. Для этого:

1. Перейдите в сервис **Свое дело**.
2. Нажмите **Создать чек**.

Это нужно делать, даже если вы получили деньги на привязанную к сервису карту.

### [](#%5Fнужно%5Fли%5Fмне%5Fотправлять%5Fчеки%5Fв%5Fооо%5Fпко%5Fабк)Нужно ли мне отправлять чеки в ООО ПКО «АБК»?

Да, при каждом получении денег — необходимо формировать и передавать чек в ООО ПКО «АБК». На платформе АВС Elementary чеки прикрепляются непосредственно в личном кабинете.

* Если вы оформили самозанятость через сервис «Свое дело», получаете выплаты на карту Сбера и у вас подключены "Авточеки" — ссылка на чек подтянется автоматически в личном кабинете, статус станет «Принят». Дополнительно ничего делать не нужно.
* Если вы оформили самозанятость через любой другой сервис — автоматическая отправка чеков недоступна. В этом случае вы формируете чек вручную в приложении «Мой налог» и прикрепляете его в личном кабинете ABC Elementary.  
   * Как только выплата пройдет (статус выплаты изменится с «Запрос сформирован» на «Выплачено»), статус чека будет «Отсутствует».

**Чтобы добавить чек:**

1. Нажмите на «плюсик» рядом с выплатой, вставьте ссылку из приложения «Мой налог». Система проверит: соответствует ли ссылка формату «Моего налога», актуален ли ИНН указанной компании.
2. После добавления ссылки статус изменится на «Проверяется» — на стороне ABC Elementary дополнительно сверят сумму и ИНН. Если что-то не совпадает — вам напишут на почту и попросят обновить данные по чеку.

Исправить ссылку можно в любое время — просто нажмите на значок «карандаш».

Важно! Если у вас есть выплата со статусом «Выплачено» (зеленая галочка), но нет чека (статус «Отсутствует») — новый запрос на выплату создать будет нельзя, пока чек не будет добавлен и подтвержден. При возникновении вопросов по выплатам, чекам - необходимо обращаться в поддержку: [elementary@activebc.ru](mailto:elementary@activebc.ru)

### [](#%5Fкак%5Fсформировать%5Fчек)Как сформировать чек?

Что нужно сделать, чтобы правильно заполнить поля и получить корректную ссылку на чек.

1. Перейти в приложение Мой Налог, выбрать «Новая продажа»;
2. Заполнить поля  
   * Дата продажи: дата зачисления выплаты на карту;  
   * Наименование товара услуги: разметка данных;  
   * Стоимость: сумма зачисления с копейками;  
   * Выбрать пункт «Юридическому лицу или ИП»;  
   * ИНН юридического лица: 7736659589;  
   * Наименование организации: ООО ПКО «АБК»;
3. Нажать кнопку «Выдать чек»;
4. В появившемся окне в нижнем правом углу нажать «Отправить»;
5. В появившемся окне нажать «Ссылку на чек»;
6. В появившемся окне скопировать ссылку на чек (в строке со ссылкой в правой части строки нажать на иконку копирования);

Ссылка скопировалась в буфер памяти устройства, ее можно использовать для копирования и вставки в личном кабинете ABC

### [](#%5Fа%5Fесли%5Fя%5Fне%5Fотправлю%5Fчек)А если я не отправлю чек?

За неотправку чека предусмотрен штраф в размере 100 % суммы, на которую не был сформирован чек.

### [](#%5Fмогут%5Fли%5Fиностранцы%5Fне%5Fграждане%5Fрф%5Fполучать%5Fдоход%5Fсамозанятым%5Fна%5Fплатформе)Могут ли иностранцы (не граждане РФ) получать доход самозанятым на платформе?

Пока такой возможности нет. Работать на платформе могут только граждане РФ.

### [](#%5Fгде%5Fузнать%5Fподробнее%5Fпро%5Fсамозанятость)Где узнать подробнее про самозанятость?

На сайте [ФНС России](https://npd.nalog.ru/).

## [](#%5Fвопросы%5Fо%5Fвыплатах)Вопросы о выплатах

### [](#%5Fсколько%5Fя%5Fзаработаю)Сколько я заработаю?

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

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

### [](#%5Fкто%5Fи%5Fкак%5Fустанавливает%5Fстоимость%5Fзаданий)Кто и как устанавливает стоимость заданий?

В каждом задании есть объекты для разметки. Один объект — это одно изображение, или одна аудиозапись, или один фрагмент текста. Стоимость задания — это сумма стоимостей всех его объектов.

Стоимость объекта устанавливает заказчик. Платформа TagMe является посредником между заказчиком (владельцем заданий) и исполнителем (разметчиком).

### [](#%5Fв%5Fкакой%5Fвалюте%5Fуказана%5Fстоимость)В какой валюте указана стоимость?

Стоимость заданий указана в рублях, у.е. — это обозначение условных единиц.

### [](#%5Fстоимость%5Fзадания%5Fможет%5Fизмениться)Стоимость задания может измениться?

Да. Так как стоимость объекта устанавливает заказчик, он может при последующей загрузке объектов увеличить или уменьшить стоимость.

### [](#%5Fобучение%5Fи%5Fэкзамен%5Fтоже%5Fоплачиваются)Обучение и экзамен тоже оплачиваются?

Нет. Обычно задания, которые выполняются на обучении и экзамене, не оплачиваются, т. к. они нужны для того, чтобы вы лучше поняли инструкцию и не допускали ошибок при выполнении задания.

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

### [](#%5Fсколько%5Fвсего%5Fя%5Fзаработала)Сколько всего я заработал(а)?

Чтобы узнать, сколько вы заработали на платформе TagMe, умножьте количество размеченных объектов на стоимость одного объекта.

Количество размеченных объектов вы можете посмотреть на вкладке **Статистика** в разделе **Статистика по проектам**.

Стоимость одного объекта указана на вкладке **Проекты** в строке каждого проекта.

| |  Планируется доработка платформы, в результате которой на вкладке **Статистика** будет отображаться сумма, заработанная на всех проектах за все время вашей работы на платформе. |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fпочему%5Fне%5Fначислилась%5Fплата%5Fза%5Fзадание)Почему не начислилась плата за задание?

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

Такие задания учитываются в статистике в блоке **Задания на проверке**. Как только заказчик примет ваши задания, они переместятся в блок **Принятые задания** и за них начислится плата.

### [](#%5Fкак%5Fвывести%5Fзаработанные%5Fденьги)Как вывести заработанные деньги?

Чтобы вывести заработанные деньги:

1. Авторизуйтесь в [личном кабинете ABC Elementary](https://app.elementary.center/?login).
2. В меню **Баланс** нажмите **Вывод денег**.
3. Заполните паспортные данные для формирования акта выполненных работ.
4. Нажмите **Вывести**.

Деньги поступят на ваш счет в течение 5 банковских дней.

### [](#%5Fкогда%5Fможно%5Fвыводить%5Fденьги)Когда можно выводить деньги?

Вы можете выводить заработанные деньги в [личном кабинете ABC Elementary](https://app.elementary.center/?login) два раза в месяц:

* 15 числа каждого месяца,
* в последний день каждого месяца.

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

### [](#%5Fсколько%5Fденег%5Fможно%5Fвывести)Сколько денег можно вывести?

Сумма, доступная для вывода, отображается в разделе **Баланс** в [личном кабинете ABC Elementary](https://app.elementary.center/?login).

Личный кабинет обновляется два раза в месяц: за несколько дней до даты вывода. График смотрите в [Телеграм-канале](https://t.me/+KBKq4qEIvGgwZThi).

### [](#%5Fкуда%5Fобращаться%5Fпо%5Fтехническим%5Fпроблемам%5Fс%5Fвыводом%5Fденег)Куда обращаться по техническим проблемам с выводом денег?

Кнопка **Вывод денег** в [личном кабинете ABC Elementary](https://app.elementary.center/?login) активна два раза в месяц.

При возникновении технических сложностей обратитесь в [службу поддержки ABC Elementary](https://app.elementary.center/feedback#top).

### [](#%5Fкак%5Fподать%5Fапелляцию%5Fпо%5Fвыплате)Как подать апелляцию по выплате?

По вопросам начисления вознаграждения обращайтесь к нашему партнеру — [ABC Elementary](https://app.elementary.center/feedback#top).

## [](#%5Fвопросы%5Fо%5Fзаданиях)Вопросы о заданиях

### [](#%5Fкакие%5Fзадания%5Fя%5Fмогу%5Fвыполнять)Какие задания я могу выполнять?

Любые задания, которые отображаются на вкладке **Проекты**.

### [](#%5Fкакие%5Fбывают%5Fзадания)Какие бывают задания?

На платформе TagMe представлены такие задания, как прослушать аудиозапись и перевести ее в текст, посмотреть на картинку и выделить на ней объекты, прочитать текст и отнести к определенному классу и так далее.

### [](#%5Fнет%5Fновых%5Fзаданий)Нет новых заданий

Все доступные задания размещаются на вкладке **Проекты**.

Задания добавляются в TagMe по мере возникновения у заказчика потребности на разметку данных. Задания могут появиться в любой момент.

### [](#%5Fкак%5Fузнать%5Fо%5Fновых%5Fзаданиях)Как узнать о новых заданиях?

Следите за новостями в [Telegram-канале](https://t.me/+KBKq4qEIvGgwZThi) и читайте информационную рассылку от нашего партнера — ABC Elementary.

![QR-код Telegram-канала](_images/tg-channel-qr.png) 

### [](#%5Fна%5Fвкладке%5Fпроекты%5Fпропадают%5Fзадания)На вкладке Проекты пропадают задания

Над заданиями работают несколько разметчиков. Если все объекты размечены, то задание пропадает с вкладки **Проекты**.

### [](#%5Fможно%5Fвзять%5Fдругое%5Fзадание)Можно взять другое задание?

Да. Выбирайте любое доступное задание на вкладке **Проект**.

### [](#%5Fгде%5Fнайти%5Fинструкцию)Где найти инструкцию?

Инструкция отображается, когда вы приступаете к выполнению задания.

Если нужно посмотреть инструкцию в ходе выполнения задания, то нажмите **Инструкция** в правом верхнем углу экрана.

### [](#%5Fобучение%5Fи%5Fэкзамен%5Fесть%5Fдля%5Fвсех%5Fзаданий)Обучение и экзамен есть для всех заданий?

Нет. Обучение и экзамен добавляются по желанию заказчика.

### [](#%5Fсколько%5Fзаданий%5Fв%5Fэкзамене)Сколько заданий в экзамене?

Количество заданий в экзамене и время выполнения определяет заказчик. Обычно в экзамене от 10 до 30 заданий.

### [](#%5Fв%5Fобучении%5Fи%5Fэкзамене%5Fмне%5Fукажут%5Fна%5Fошибки)В обучении и экзамене мне укажут на ошибки?

Если вы дали неверный ответ на обучении, вам отобразится комментарий с правильным ответом. На экзамене такого функционала не предусмотрено.

### [](#%5Fгде%5Fпосмотреть%5Fсвои%5Fошибки%5Fпо%5Fзаданиям)Где посмотреть свои ошибки по заданиям?

В боковом меню, во вкладке "Мои ответы", если заказчик отклонил/принял задания и оставил комментарий.

### [](#%5Fкакой%5Fграфик%5Fработы)Какой график работы?

Вы самостоятельно выбираете график работы.

### [](#%5Fсколько%5Fзаданий%5Fнадо%5Fразмечать%5Fв%5Fдень)Сколько заданий надо размечать в день?

Вы можете размечать любое количество заданий.

### [](#%5Fгде%5Fя%5Fмогу%5Fузнать%5Fколичество%5Fвыполненных%5Fзаданий)Где я могу узнать количество выполненных заданий?

На вкладке **Статистика** представлена информация по выполненным заданиям и среднему времени выполнения заданий.

Горячие клавиши
====================
Чтобы ускорить работу, используйте горячие клавиши.

| Горячие клавиши                  | Действие                                                                       |
| -------------------------------- | ------------------------------------------------------------------------------ |
| Tab                              | Переход к следующему вопросу или к следующему выделенному фрагменту            |
| Space                            | Выбор варианта ответа                                                          |
| ESC                              | Завершение создания или редактирования фрагмента                               |
| Z                                | Создание нового фрагмента с последним использованным классом                   |
| Del или Backspace                | Удаление выбранного фрагмента                                                  |
| Shift                            | В задачах сегментации изображений создается окружность с единым радиусом       |
| Alt или Option                   | В задачах сегментации изображений создается эллипс с фиксированным центром     |
| Shift \+ Alt или Shift \+ Option | В задачах сегментации изображений создается окружность с фиксированным центром |

| Горячие клавиши в шаблонах сегментации изображений по кадрам | Действие                                                          |
| ------------------------------------------------------------ | ----------------------------------------------------------------- |
| D                                                            | Переключение назад между объектами последовательности             |
| F                                                            | Переключение вперед между объектами последовательности            |
| C                                                            | Переключение назад на 2 кадра между объектами последовательности  |
| V                                                            | Переключение вперед на 2 кадра между объектами последовательности |
| Z                                                            | Выбор последнего класса между объектами последовательности        |
| T                                                            | Включение трекинга                                                |
| O                                                            | Скрыть или показать фрагмент                                      |
| Ctrl \+ B и Enter                                            | Дублирование фрагмента и применение дублирования                  |

Руководство разметчика
====================
### [ Регистрация](/docs/marker/registration.html) 

 Как зарегистрироваться на платформе и начать работу

### [ Разметка задач](/docs/marker/cases.html) 

 Какие бывают задания и как их выполнять

### [ Статистика работы](/docs/marker/statistic.html) 

 Узнайте, как вы работаете

Получаем оплату
====================
## [](#%5Fкогда%5Fвыводить%5Fденьги)Когда выводить деньги

Вы можете выводить заработанные деньги в [личном кабинете ABC Elementary](https://app.elementary.center/?login) два раза в месяц:

* 15 числа каждого месяца,
* в последний день каждого месяца.

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

Сумма, доступная для вывода, отображается в разделе **Баланс**.

Личный кабинет обновляется два раза в месяц: за несколько дней до даты вывода. График смотрите в [Телеграм-канале](https://t.me/+KBKq4qEIvGgwZThi).

## [](#%5Fкак%5Fвыводить%5Fденьги)Как выводить деньги

Чтобы вывести заработанные деньги:

1. Авторизуйтесь в [личном кабинете ABC Elementary](https://app.elementary.center/?login).
2. В меню **Баланс** нажмите **Вывод денег**.
3. Заполните паспортные данные для формирования акта выполненных работ.
4. Нажмите **Вывести**.

Деньги поступят на ваш счет в течение 5 банковских дней.

При возникновении технических сложностей обратитесь в [службу поддержки ABC Elementary](https://app.elementary.center/feedback#top).

## [](#%5Fкак%5Fзаплатить%5Fналоги)Как заплатить налоги

В течение одного дня с момента получения денег вы должны сформировать чек на сайте «Мой налог» и направить его на электронную почту [elementary@activebc.ru](mailto:elementary@activebc.ru).

Если вы оформляли самозанятость в сервисе Сбера [«Свое дело»](https://www.sberbank.com/ru/svoedelo/start#freeservices), разрешите автоматическую отправку чеков — и вы можете не делать это вручную.

| |  За неотправку чека предусмотрен штраф в размере 100 % суммы, на которую не был сформирован чек. |
| -------------------------------------------------------------------------------------------------- |

Быстрый старт
====================
## [](#%5Fтри%5Fпростых%5Fшага)Три простых шага

 Шаг 1\. Оформите самозанятость

 Тогда вы сможете получать деньги за разметку. Оформить самозанятость можно, например, в сервисе Сбера [«Свое дело»](https://www.sberbank.ru/ru/svoedelo#freeservices).

 Шаг 2\. Зарегистрируйтесь в [ABC Elementary](https://app.elementary.center/?rg=TAGME) 

 Здесь вы сможете выводить заработанные деньги два раза в месяц.

 Шаг 3\. Выполняйте задания в [TagMe](https://tagme.sberdevices.ru) 

 Нажмите **«Войти с помощью ABC Elementary»**, авторизуйтесь и выполняйте задания по разметке данных.

| |  Перед началом работы на платформе пройдите [обучение](https://tagme.sberdevices.ru/course/index.html). Оно займет около часа, познакомит вас с TagMe и даст понять, как работать с основными типами заданий. |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

## [](#%5Fбудем%5Fна%5Fсвязи)Будем на связи

Мы публикуем важные обновления и информацию о новых проектах в [Telegram-канал](https://t.me/+KBKq4qEIvGgwZThi).

![QR-код Telegram-канала](_images/tg-channel-qr.png) 

Сегментируем аудио
====================
## [](#%5Fпорядок%5Fработы)Порядок работы

Сначала изучите список классов, которые нужно найти в аудиозаписи, и убедитесь, что вам понятно, что нужно искать. Затем прослушайте запись. Вы можете управлять скоростью воспроизведения с помощью кнопок + и –.

Когда вы встретите в аудио фрагмент, который соответствует одному из требуемых классов:

1. Нажмите на класс в левой части формы. Рядом с классом появится галочка.
2. Выделите фрагмент на таймлайне (подробнее об инструментах выделения читайте ниже). В результате выделенный фрагмент подсветится цветом этого класса и запись о фрагменте появится в правой части формы.
3. Если в строчке фрагмента в правой части формы появилась иконка ![icon annotation](_images/icon-annotation.png), то нажмите на нее. Вам откроется список вопросов о фрагменте.
4. Ответьте на вопросы о фрагменте.
5. Чтобы вернуться к списку фрагментов, нажмите на крестик или Esc на клавиатуре. Вам отобразится список всех фрагментов.

| |  Перед отправкой задачи проверьте, что вы ответили на вопросы обо всех фрагментах. Вы можете переключаться между фрагментами с помощью стрелок или с помощью Tab на клавиатуре. |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

Чтобы ускорить работу, вы можете использовать [горячие клавиши](hotkeys.html).

![interface audio](_images/interface-audio.png) 

## [](#%5Fудаляем%5Fфрагмент)Удаляем фрагмент

Если вы ошибочно выделили фрагмент, удалите его. Для этого нажмите на мусорную корзину в строчке фрагмента в правой части формы ![icon trash](_images/icon-trash.png).

## [](#%5Fизменяем%5Fкласс%5Fфрагмента)Изменяем класс фрагмента

В некоторых заданиях вы можете изменить класс выделенного фрагмента. Для этого:

1. Наведите курсор на фрагмент в списке.
2. Нажмите иконку ![icon change class](_images/icon-change-class.png).
3. Выберите класс из вариантов с таким же инструментом.

## [](#%5Fгруппируем%5Fфрагменты)Группируем фрагменты

В некоторых заданиях вы можете группировать выделенные фрагменты. Для этого:

1. Нажмите **Объединить в группу**.
2. Введите название группы.
3. Нажмите **Добавить**.

Группа появится в списке фрагментов.

Чтобы все фрагменты, которые вы размечаете, автоматически добавлялись в группу, наведите на нее курсор и нажмите ![icon group](_images/icon-group.png).

Также вы можете переместить в группу уже размеченные фрагменты. Для этого есть два способа:

1. Перетащите фрагмент из списка в группу, зажав левую кнопку мыши.
2. Наведите курсор на фрагмент в списке, нажмите три точки справа, выберите в выпадающем списке **Добавить в группу** и выберите группу.

## [](#%5Fинструменты%5Fвыделения)Инструменты выделения

Условные обозначения рядом с названием класса помогут вам определить, какой инструмент у вас есть, чтобы выделить фрагменты этого класса.

Возможные инструменты:

1. Фрейм ![tool frame](_images/tool-frame.png) — метка определенного момента аудио.
2. Сегмент ![tool segment](_images/tool-segment.png) — отрезок аудио, у которого есть начало и конец.

Сегментируем диалог
====================
## [](#%5Fпорядок%5Fработы)Порядок работы

Сначала изучите список классов, которые нужно найти в диалоге, и убедитесь, что вам понятно, что нужно искать. Затем начните читать диалог.

Когда вы встречаете реплику, которая соответствует одному из требуемых классов:

1. Нажмите на нее.
2. Нажмите на соответствующий класс в левой части формы. В результате у реплики появится стикер с классом, а запись о реплике появится в правой части формы.
3. Если в строчке реплики в правой части формы появилась иконка ![icon annotation](_images/icon-annotation.png), то нажмите на нее. Вам откроется список вопросов о реплике.
4. Ответьте на вопросы о реплике.
5. Чтобы вернуться к списку реплик, нажмите на крестик или Esc на клавиатуре. Вам отобразится список всех реплик.

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

Если реплика соответствует нескольким классам, вы можете выделить ее повторно и назначить еще один класс.

Чтобы ускорить работу, вы можете использовать [горячие клавиши](hotkeys.html).

![interface dialog](_images/interface-dialog.png) 

## [](#%5Fудаляем%5Fфрагмент)Удаляем фрагмент

Если вы ошибочно выделили фрагмент, удалите его. Для этого нажмите на мусорную корзину в строчке фрагмента в правой части формы ![icon trash](_images/icon-trash.png).

## [](#%5Fгруппируем%5Fфрагменты)Группируем фрагменты

В некоторых заданиях вы можете группировать выделенные фрагменты. Для этого:

1. Нажмите **Объединить в группу**.
2. Введите название группы.
3. Нажмите **Добавить**.

Группа появится в списке фрагментов.

Чтобы все фрагменты, которые вы размечаете, автоматически добавлялись в группу, наведите на нее курсор и нажмите ![icon group](_images/icon-group.png).

Также вы можете переместить в группу уже размеченные фрагменты. Для этого есть два способа:

1. Перетащите фрагмент из списка в группу, зажав левую кнопку мыши.
2. Наведите курсор на фрагмент в списке, нажмите три точки справа, выберите в выпадающем списке **Добавить в группу** и выберите группу.

## [](#%5Fизменяем%5Fкласс%5Fфрагмента)Изменяем класс фрагмента

В некоторых заданиях вы можете изменить класс выделенного фрагмента. Для этого:

1. Наведите курсор на фрагмент в списке.
2. Нажмите иконку ![icon change class](_images/icon-change-class.png).
3. Выберите класс из вариантов с таким же инструментом.

Сегментируем изображение
====================
## [](#%5Fпорядок%5Fработы)Порядок работы

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

| |  Вы можете менять масштаб изображения колесиком мыши. |
| ------------------------------------------------------- |

Когда вы найдете на изображении фрагмент, который соответствует одному из требуемых классов:

1. Нажмите на класс в левой части формы.
2. Выделите фрагмент, следуя подсказкам на экране (подробнее об инструментах выделения читайте ниже). В результате выделенный фрагмент подсветится цветом этого класса и запись о фрагменте появится в правой части формы.
3. Если в строчке фрагмента в правой части формы появилась иконка ![icon annotation](_images/icon-annotation.png), то нажмите на нее. Вам откроется аннотация — список вопросов о фрагменте.
4. Ответьте на вопросы о фрагменте.
5. Чтобы вернуться к списку фрагментов, нажмите на крестик или Esc на клавиатуре. Вам отобразится список всех фрагментов.

| |  Перед отправкой задачи проверьте, что вы ответили на вопросы обо всех фрагментах. Вы можете переключаться между фрагментами с помощью стрелок или с помощью Tab на клавиатуре. |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

Чтобы ускорить работу, вы можете использовать [горячие клавиши](hotkeys.html).

![interface image](_images/interface-image.png) 

## [](#%5Fудаляем%5Fфрагмент)Удаляем фрагмент

Если вы ошибочно выделили фрагмент, удалите его. Для этого нажмите на мусорную корзину в строчке фрагмента в правой части формы ![icon trash](_images/icon-trash.png).

## [](#%5Fгруппируем%5Fфрагменты)Группируем фрагменты

В некоторых заданиях вы можете группировать выделенные фрагменты. Для этого:

1. Нажмите **Объединить в группу**.
2. Введите название группы.
3. Нажмите **Добавить**.

Группа появится в списке фрагментов.

Чтобы все фрагменты, которые вы размечаете, автоматически добавлялись в группу, наведите на нее курсор и нажмите ![icon group](_images/icon-group.png).

Также вы можете переместить в группу уже размеченные фрагменты. Для этого есть два способа:

1. Перетащите фрагмент из списка в группу, зажав левую кнопку мыши.
2. Наведите курсор на фрагмент в списке, нажмите три точки справа, выберите в выпадающем списке **Добавить в группу** и выберите группу.

## [](#%5Fскрываем%5Fфрагменты)Скрываем фрагменты

Вы можете скрыть фрагмент с изображения с помощью иконки ![icon view](_images/icon-view.png). Она расположена над списком фрагментов.

Чтобы скрыть определенный фрагмент, наведите на него курсор — появится иконка скрытия фрагмента.

## [](#%5Fизменяем%5Fкласс%5Fфрагмента)Изменяем класс фрагмента

В некоторых заданиях вы можете изменить класс выделенного фрагмента. Для этого:

1. Наведите курсор на фрагмент в списке.
2. Нажмите иконку ![icon change class](_images/icon-change-class.png).
3. Выберите класс из вариантов с таким же инструментом.

## [](#%5Fинструменты%5Fвыделения)Инструменты выделения

Условные обозначения рядом с названием класса помогут вам определить, какой инструмент у вас есть, чтобы выделить фрагменты этого класса.

Возможные инструменты:

1. Многоугольник ![tool polygon](_images/tool-polygon.png).
2. Прямоугольник ![tool box](_images/tool-box.png).
3. Эллипс ![tool ellipse](_images/tool-ellipse.png)
4. Кисть ![tool brush](_images/tool-brush.png).
5. Умная кисть ![tool smart brush](_images/tool-smart-brush.png).
6. Ключевые точки ![tool key points](_images/tool-key-points.png).

### [](#%5Fмногоугольник)Многоугольник

С помощью многоугольника вы можете нарисовать фигуру с тремя и более углами.

Для этого последовательно ставьте точки по контуру фрагмента, который вы хотите выделить. Точки будут автоматически соединяться линиями.

Чтобы поставить новую точку, нажмите левую кнопку мыши. Чтобы удалить последнюю поставленную точку, нажмите правую кнопку мыши. Когда вы закончили выделять фрагмент, нажмите Esc на клавиатуре.

Чтобы отредактировать фрагмент, нажмите на него на изображении или в списке в правой части формы. Теперь вы можете:

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

### [](#%5Fпрямоугольник)Прямоугольник

С помощью прямоугольника вы можете нарисовать фигуру с четырьмя углами.

Для этого выберите, где на изображении будет располагаться один из углов фрагмента, нажмите там левой кнопкой мыши и, удерживая ее, ведите до противоположного угла фрагмента.

Чтобы отредактировать фрагмент, нажмите на него на изображении или в списке в правой части формы. Теперь вы можете:

* передвигать фрагмент целиком;
* передвигать точки контура, меняя размер фрагмента.

### [](#%5Fэллипс)Эллипс

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

Чтобы отредактировать фрагмент, нажмите на него на изображении или в списке в правой части формы. Теперь вы можете:

* передвигать фрагмент целиком;
* передвигать точки контура, меняя размер фрагмента.

При работе с эллипсом, вы можете использовать горячие клавиши:

| Горячие клавиши                  | Действие                                     |
| -------------------------------- | -------------------------------------------- |
| Shift                            | Создается окружность с единым радиусом       |
| Alt или Option                   | Создается эллипс с фиксированным центром     |
| Shift \+ Alt или Shift \+ Option | Создается окружность с фиксированным центром |

### [](#%5Fкисть)Кисть

Кисть позволяет закрасить на изображении фрагмент любой формы. Чтобы нарисовать линию, зажмите левую кнопку мыши, чтобы стереть — правую кнопку мыши.

Чтобы изменить толщину линии, измените масштаб изображения колесиком мыши.

Когда вы закончили выделять фрагмент, нажмите Esc на клавиатуре.

Чтобы отредактировать фрагмент, нажмите на него на изображении или в списке в правой части формы. Теперь вы можете:

* передвигать фрагмент целиком;
* дорисовывать линии левой кнопкой мыши;
* стирать нарисованное правой кнопкой мыши.

### [](#%5Fключевые%5Fточки)Ключевые точки

С помощью ключевых точек вы можете обозначить фрагмент изображения.

Точки можно ставить в произвольном порядке.

Чтобы поставить новую точку, нажмите левую кнопку мыши. Чтобы удалить поставленную точку, нажмите правую кнопку мыши. Когда вы закончили выделять фрагмент, нажмите Esc на клавиатуре.

Чтобы отредактировать фрагмент, нажмите на него на изображении или в списке в правой части формы. Теперь вы можете:

* передвигать точки;
* добавлять новые точки левой кнопкой мыши;
* удалять точки, нажимая на них правой кнопкой мыши.

Сегментируем объекты
====================
Форма состоит из трех частей:

* По центру — объект разметки: текст, диалог или изображение.
* Слева — перечень классов, фрагменты с которыми нужно найти и выделить на объекте, а также кнопка для добавления нового класса.
* Справа — список выделенных фрагментов.

Найдите фрагменты объекта, которые соответствуют нужным классам.

Также в некоторых заданиях нужно дополнительно ответить на вопросы или сгруппировать размеченные фрагменты.

| |  Если вы удаляете группу фрагментов, то удаляются и все фрагменты, которые были в ней. |
| ---------------------------------------------------------------------------------------- |

![segmentation overview](_images/segmentation-overview.png) 

Сегментируем последовательности
====================
## [](#%5Fпорядок%5Fработы)Порядок работы

**Сегментация изображений по кадрам** — это процесс разметки объектов на каждом отдельном кадре последовательности. В отличие от работы с одиночными изображениями, здесь вы работаете с серией связанных кадров, где объекты перемещаются и изменяются с течением времени.

Сначала изучите список классов объектов, которые нужно отследить в последовательности кадров, и убедитесь, что вам понятно, что нужно искать. Затем начните просматривать последовательность.

## [](#%5Fтрекинг%5Fобъектов)Трекинг объектов

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

Когда вы находите объект на кадре, который соответствует одному из требуемых классов:

1. Нажмите на класс в левой части формы.
2. Выделите объект на изображении одним из доступных инструментов разметки.
3. Нажмите на объект и перейдите к его настройкам в правом меню.
4. Нажмите "Включить трекинг".

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

### [](#%5Fчто%5Fпроисходит%5Fпри%5Fвключении%5Fтрекинга)Что происходит при включении трекинга

* **На текущем кадре:** метка остается видимой
* **На последующих кадрах:** создаются видимые копии метки
* **На предыдущих кадрах:** создаются скрытые копии метки
* **Текущий кадр и первый кадр** автоматически становятся ключевыми кадрами

### [](#%5Fудаляем%5Fотслеживаемый%5Fобъект)Удаляем отслеживаемый объект

| |  При удалении фрагмента с включенным трекингом, фрагменты будут удалены со всех кадров последовательности. |
| ------------------------------------------------------------------------------------------------------------ |

Для удаления отслеживаемого объекта: 1\. Выберите объект в списке справа 2\. Нажмите "Удалить"

Чтобы ускорить работу, вы можете использовать [горячие клавиши](hotkeys.html).

## [](#%5Fключевые%5Fкадры)Ключевые кадры

**Ключевой кадр** — это кадр, на котором вы вручную задали точное положение объекта. Система использует ключевые кадра как опорные точки для автоматического расчета положения на промежуточных кадрах.

Как добавить ключевой кадр:

1. Выберите объект, который вы хотите сделать ключевым
2. Нажмите на объект и перейдите к его настройкам в правом меню
3. Нажмите "Сделать ключевым объектом"
4. Перейдите на кадр, где размеры или положение объекта изменились значительно
5. Измените размеры или положение объекта

Система автоматически пересчитывает движение между соседними ключевыми кадрами.

### [](#%5Fкак%5Fубрать%5Fключевой%5Fкадр)Как убрать ключевой кадр:

1. Перейдите на ключевой кадр
2. Выберите метку
3. Нажмите "Ключевой кадр" (кнопка переключения)

### [](#%5Fчто%5Fпроисходит%5Fпри%5Fудалении%5Fключевого%5Fкадра)Что происходит при удалении ключевого кадра:

* Система пересчитывает движение между соседними ключевыми кадрами
* Если ключевых кадров больше нет — позиция копируется с предыдущего ключевого кадра

| |  Первый кадр всегда является ключевым и не может быть удален. Удаление ключевого кадра влияет на всю последующую интерполяцию. |
| -------------------------------------------------------------------------------------------------------------------------------- |

## [](#%5Fвидимость%5Fотслеживаемых%5Fобъектов)Видимость отслеживаемых объектов

**Управление видимостью** — это функция, которая позволяет временно скрывать и показывать отслеживаемые объекты на определенных кадрах видеопоследовательностях. Эта функция имитирует реальное поведение объектов, которые могут временно исчезать из поля зрения камеры.

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

### [](#%5Fскрытие%5Fобъекта)Скрытие объекта

Скрывайте объект на том кадре, где он **начинает исчезать** или **полностью перестает быть видимым**.

1. Перейдите на кадр, где объект начинает исчезать
2. Выберите отслеживаемую метку
3. Нажмите "Спрятать/показать"

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

### [](#%5Fпоказ%5Fобъекта)Показ объекта

Показывайте объект на том кадре, где он **начинает появляться** или **становится снова видимым**.

1. Перейдите на кадр, где объект появляется снова
2. Выберите отслеживаемый объект
3. В правом меню нажмите "Показать"
4. Скорректируйте положение метки

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

Сегментируем текст
====================
## [](#%5Fпорядок%5Fработы)Порядок работы

Сначала изучите список классов, которые нужно найти в тексте, и убедитесь, что вам понятно, что нужно искать. Затем начните читать текст. Когда вы встретите фрагмент, который соответствует одному из требуемых классов:

1. Выделите его, зажав левую кнопку мыши.
2. Нажмите на соответствующий класс в левой части формы. В результате выделенный фрагмент подсветится цветом этого класса и запись о фрагменте появится в правой части формы.

Если фрагмент соответствует нескольким классам, вы можете выделить его повторно и назначить еще один класс.

Чтобы ускорить работу, используйте [горячие клавиши](hotkeys.html).

![interface text](_images/interface-text.png) 

## [](#%5Fудаляем%5Fфрагмент)Удаляем фрагмент

Если вы ошибочно выделили фрагмент, удалите его. Для этого нажмите на мусорную корзину в строчке фрагмента в правой части формы ![icon trash](_images/icon-trash.png).

## [](#%5Fскрываем%5Fфрагменты)Скрываем фрагменты

Вы можете скрыть фрагмент из текста с помощью иконки ![icon view](_images/icon-view.png). Она расположена над списком фрагментов.

Чтобы скрыть определенный фрагмент, наведите на него курсор — появится иконка скрытия фрагмента.

## [](#%5Fгруппируем%5Fфрагменты)Группируем фрагменты

В некоторых заданиях вы можете группировать выделенные фрагменты. Для этого:

1. Нажмите **Объединить в группу**.
2. Введите название группы.
3. Нажмите **Добавить**.

Группа появится в списке фрагментов.

Чтобы все фрагменты, которые вы размечаете, автоматически добавлялись в группу, наведите на нее курсор и нажмите ![icon group](_images/icon-group.png).

Также вы можете переместить в группу уже размеченные фрагменты. Для этого есть два способа:

1. Перетащите фрагмент из списка в группу, зажав левую кнопку мыши.
2. Наведите курсор на фрагмент в списке, нажмите три точки справа, выберите в выпадающем списке **Добавить в группу** и выберите группу.

## [](#%5Fизменяем%5Fкласс%5Fфрагмента)Изменяем класс фрагмента

В некоторых заданиях вы можете изменить класс выделенного фрагмента. Для этого:

1. Наведите курсор на фрагмент в списке.
2. Нажмите иконку ![icon change class](_images/icon-change-class.png).
3. Выберите класс из вариантов с таким же инструментом.

## [](#%5Fописываем%5Fфрагменты)Описываем фрагменты

Если в строчке фрагмента в правой части формы появилась иконка ![icon annotation](_images/icon-annotation.png), нажмите на нее — вам откроется список вопросов, на которые нужно ответить.

Чтобы вернуться к списку фрагментов, нажмите на крестик или Esc на клавиатуре. Вам отобразится список всех фрагментов.

| |  Перед отправкой задачи проверьте, что вы ответили на вопросы обо всех фрагментах. Вы можете переключаться между фрагментами с помощью стрелок или с помощью Tab на клавиатуре. |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

## [](#%5Fзаполняем%5Fонтологию)Заполняем онтологию

В некоторых заданиях нужно заполнить онтологию — ответить на вопросы о тексте. В этом случае в правой части экрана рядом со списком выделенных фрагментов появляется вкладка **Онтология**.

Красные метки означают, что в онтологии есть незаполненные обязательные поля.

![Онтология](_images/onthology.png) 

Сегментируем видео
====================
## [](#%5Fпорядок%5Fработы)Порядок работы

Сначала изучите список классов, которые нужно найти в видеозаписи, и убедитесь, что вам понятно, что нужно искать. Затем просмотрите запись. Вы можете управлять скоростью воспроизведения с помощью кнопок + и –.

Когда вы встретите фрагмент, который соответствует одному из требуемых классов:

1. Нажмите на класс в левой части формы. Рядом с классом появится галочка.
2. Выделите фрагмент на таймлайне (подробнее об инструментах выделения читайте ниже). В результате выделенный фрагмент подсветится цветом этого класса и запись о фрагменте появится в правой части формы.
3. Если в строчке фрагмента в правой части формы появилась иконка ![icon annotation](_images/icon-annotation.png), то нажмите на нее. Вам откроется список вопросов о фрагменте.
4. Ответьте на вопросы о фрагменте.
5. Чтобы вернуться к списку фрагментов, нажмите на крестик или Esc на клавиатуре. Вам отобразится список всех фрагментов.

| |  Перед отправкой задачи проверьте, что вы ответили на вопросы обо всех фрагментах. Вы можете переключаться между фрагментами с помощью стрелок или с помощью Tab на клавиатуре. |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

Чтобы ускорить работу, вы можете использовать [горячие клавиши](hotkeys.html).

![interface video](_images/interface-video.png) 

## [](#%5Fудаляем%5Fфрагмент)Удаляем фрагмент

Если вы ошибочно выделили фрагмент, удалите его. Для этого нажмите на мусорную корзину в строчке фрагмента в правой части формы ![icon trash](_images/icon-trash.png).

## [](#%5Fизменяем%5Fкласс%5Fфрагмента)Изменяем класс фрагмента

В некоторых заданиях вы можете изменить класс выделенного фрагмента. Для этого:

1. Наведите курсор на фрагмент в списке.
2. Нажмите иконку ![icon change class](_images/icon-change-class.png).
3. Выберите класс из вариантов с таким же инструментом.

## [](#%5Fгруппируем%5Fфрагменты)Группируем фрагменты

В некоторых заданиях вы можете группировать выделенные фрагменты. Для этого:

1. Нажмите **Объединить в группу**.
2. Введите название группы.
3. Нажмите **Добавить**.

Группа появится в списке фрагментов.

Чтобы все фрагменты, которые вы размечаете, автоматически добавлялись в группу, наведите на нее курсор и нажмите ![icon group](_images/icon-group.png).

Также вы можете переместить в группу уже размеченные фрагменты. Для этого есть два способа:

1. Перетащите фрагмент из списка в группу, зажав левую кнопку мыши.
2. Наведите курсор на фрагмент в списке, нажмите три точки справа, выберите в выпадающем списке **Добавить в группу** и выберите группу.

## [](#%5Fинструменты%5Fвыделения)Инструменты выделения

Условные обозначения рядом с названием класса помогут вам определить, какой инструмент у вас есть, чтобы выделить фрагменты этого класса.

Возможные инструменты:

1. Фрейм ![tool frame](_images/tool-frame.png) — метка определенного момента видео.
2. Сегмент ![tool segment](_images/tool-segment.png) — отрезок видео, у которого есть начало и конец.

Начинаем работу
====================
## [](#%5Fзаходим%5Fв%5Ftagme)Заходим в TagMe

Чтобы приступить к выполнению заданий после регистрации, авторизуйтесь на платформе TagMe:

![Форма авторизации](_images/tagme-login.png) 

1. Перейдите на [платформу TagMe](https://tagme.sberdevices.ru/).
2. Нажмите **Войти с помощью ABC Elementary**.
3. Введите логин и пароль, указанные при [регистрации](registration.html#%5Fрегистрируемся%5Fв%5Fabc%5Felementary) в ABC Elementary.
4. Нажмите **Войти**.

## [](#%5Fприступаем%5Fк%5Fработе)Приступаем к работе

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

## [](#%5Fполучаем%5Fзаработок)Получаем заработок

Вы можете выводить заработанные деньги в [личном кабинете ABC Elementary](https://app.elementary.center/?login) два раза в месяц:

* 15 числа каждого месяца,
* в последний день каждого месяца.

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

Сумма, доступная для вывода, отображается в разделе **Баланс**.

Чтобы вывести заработанные деньги:

1. Авторизуйтесь в [личном кабинете ABC Elementary](https://app.elementary.center/?login).
2. В меню **Баланс** нажмите **Вывод денег**.
3. Заполните паспортные данные для формирования акта выполненных работ.
4. Нажмите **Вывести**.

## [](#%5Fгде%5Fзадать%5Fвопросы)Где задать вопросы

Подпишитесь на [Telegram-канал](https://t.me/+KBKq4qEIvGgwZThi), где мы публикуем важные обновления и информацию о новых проектах.

![QR-код Telegram-канала](_images/tg-channel-qr.png) 

Если у вас возникнут вопросы, читайте [документацию](https://tagme.sberdevices.ru/docs/marker/index.html) и пользуйтесь полем поиска.

Статистика
====================
Чтобы посмотреть статистику результатов вашей работы, перейдите на вкладку **Статистика** в боковом меню.

Здесь вы увидите:

* общее количество размеченных заданий и затраченное время;
* общий заработок и подробный график о нём;
* количество заданий на проверке;
* название и уровень навыков.

Вы можете посмотреть статистику в разрезе проектов за выбранный период.

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

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

![instruction example](_images/instruction-example.png) 

Рисунок 1\. Пример инструкции

После ознакомления производится переход к форме, которую создал заказчик под задание.

![task example](_images/task-example.png) 

Рисунок 2\. Пример интерфейса разметки

Интерфейс разметчика всегда имеет типовой заголовок со следующим набором элементов:

* **Закрыть** \- по нажатию ![close](_images/icons/close.png) происходит выход из задания, без сохранения текущих изменений и отправки результатов. Задание будет возвращено в общий набор для повторной выдачи;
* Название проекта и идентификатор размечаемого объекта. Идентификатор может использоваться в коммуникации с заказчиков в случае проблем с конкретным объектом задания.
* Количество размеченных объектов за сегодня, шт.
* Время, оставшееся для разметки текущего объекта, мин. Устанавливается заказчиком на задаче.
* **Инструкция** \- позволяет открыть инструкцию к заданию в отдельной вкладке;
* **Пропустить** \- пропускает задание, переходит к следующему. Доступность кнопки в задании настраивает заказчик.
* **Отправить** \- отправляет результат разметки и переходит к следующему заданию.

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

Шаблоны разметки
====================
TagMe предоставляет возможность автоматически конфигурировать интерфейс под каждое задание индивидуально. Однако для наиболее частых сценариев предоставляются шаблонные интерфейсы заданий.

Проходим обучение и экзамен
====================
Чтобы убедиться, что вы поняли инструкцию, в некоторых проектах есть обучение и экзамен. Об этом написано в карточке проекта. Также в карточке можно посмотреть стоимость обучения и экзамена — для этого нажмите **Больше информации**.

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

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

Для разработчика
====================
### [ HTML-Компоненты](/docs/dev/storybook/storybook.html) 

 Описание библиотеки HTML-компоненты TagMe

### [ REST API](/docs/dev/api/rest-api.html) 

 Описание предоставляемых интерфейсов в формате OpenAPI

### [ TagMe SDK](/docs/sdk/index.html) 

 Инструкции и справочные материалы по использованию SDK на языке Python

При возникновении вопросов по взаимодейтсвию с платформой следует обращаться в [службу технической поддержки](mailto:<!--#echo var="nginx%5Fssi%5Femail"-->?subject=sdk) .

undefined
====================


undefined
====================


undefined
====================


CLI Скрипты
====================
Скрипты устанавливаются вместе с pip пакетом и их можно вызывать из командной строки, как обычные bash-комманды.

## [](#%5Fвыгрузка%5Fдатасета%5Fиз%5Fзадачи)Выгрузка датасета из задачи

Скачать исходные данные для разметки по идентификатору задачи в указанную папку.

```bash
download-task-data -t <task id> -d <destination dir>
```

## [](#%5Fвыгрузка%5Fрезультатов%5Fзадачи)Выгрузка результатов задачи

Скачать результаты разметки по идентификатору задачи в указанный путь.

```bash
download-task-results -t <task id> -d <result file>
```

Также вы можете скачать результаты в виде таблицы:

```bash
download_table -t <task id> -d <file name>
```

## [](#%5Fвыгрузка%5Fстатистики)Выгрузка статистики

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

```bash
get_quality_stats -O <item|task> -f <json|csv>
```

## [](#%5Fзагрузка%5Fданных%5Fв%5Fзадачу)Загрузка данных в задачу

Загрузить данные для разметки в задачу.

```bash
upload-task-data -t <task id> -d <dir>
```

Если нужно загрузить задания в виде PDF-файлов, используйте скрипт:

```bash
upload_pdf -d <destination dir> -t <task id>
```

Для использования необходимо указать параметры подключения к внешнему хранилищу в секции **cloud** [config-файла](%5Fattachments/crowd.cfg). В интерфейсе платформы загруженные PDF-файлы файлы отображаются в виде JSON.

## [](#%5Fзагрузка%5Fнавыков)Загрузка навыков

Загрузить в организацию навыки из таблицы.

```bash
import_skills -p <tsv file>
```

## [](#%5Fрасширение%5Fотчета)Расширение отчета

Сделать расширенный отчет по результатам разметки (ФИО автора задания, ФИО разметчиков, название задачи).

```bash
extend-task-results -e <result file> -d <extended results> -o <organisation name>
```

## [](#%5Fсегментация%5Fизображений%5Fэкспорт%5Fвалидация)Сегментация изображений: экспорт → валидация

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

```bash
image-segmentation-e2v -e <export file> -d <destination file> --base64 <flag> -o <organization name> -c <config path>
```

## [](#%5Fсегментация%5Fизображений%5Fyolo%5Fвалидация)Сегментация изображений: yolo → валидация

Сформировать данные для задачи на валидацию из исходного изображнения и файла с предразметкой в YOLO.

```bash
image-segmentation-y2b -f <src dir> -d <destination dir>
```

## [](#%5Fклонирование%5Fпроекта)Клонирование проекта

Склонировать проект с задачами и перенести туда еще не размеченные задания.

```bash
clone_project -t <task id> -d <destination dir>
```

Возвращает ссылку на новый проект.

## [](#%5Fсинхронизация%5Fзадач)Синхронизация задач

Запустить синхронизацию для задач с настройками пайплайна.

```bash
pipeline_sync [-p <project_id>] [-t <task_id>] [--dry-run] [--limit <n>] [-o <organization>]
```

Параметры конфига пайплайна в PAYLOAD задачи или секции CONFIG проекта:

| **Параметр**                  | **Описание**                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| source\_task                  | uid задачи, результаты разметки которой будут использованы для конфига в PAYLOAD задачи                                                                                                                                                                                                                                                                                                                                            |
| source\_project               | uid проекта, результаты разметки задач в котором будут использованы для конфига в секции CONFIG проекта                                                                                                                                                                                                                                                                                                                            |
| fields                        | Список пар полей в исходном и целевом задании, в соответствии с которым будут скопированы данные. Возможные значения: \* file — бинарный файл; \* file.audio — поле **audio** входного JSON-файла. Могут быть использованы любые поля входного JSON; \* result.text — поле **text** в результатах разметки. Могут быть использованы любые поля в результатах разметки; \* premarkup.marks — объект **marks** в данных предразметки |
| result\_aggregation           | Правило агрегации результатов разметки. Возможные значения: \* aggregate – результаты нескольких разметчиков будут скопированы в одно задание и представлены списком; \* separate – на каждый ответ разных разметчиков по одному заданию будет создано отдельное задание                                                                                                                                                           |
| consistency\_filter           | Условие отбора результатов на основе согласованности. Возможные значения: \* all\_unique – все уникальные результаты разметки будут скопированы в задачу на валидацию; \* unsure – только результаты разметки по заданиям, в которых согласованность ниже установленного порога будут скопированы                                                                                                                                  |
| consistency\_share\_threshold | Доля одинаковых ответов, чтобы считать результат согласованным. Например, 0.5 — половина ответов разметчиков должна совпадать чтобы считать, что задание не требует валидации. Если перекрытие в задаче 3 и нужно отправлять на валидацию только в том случае, если нет хотя бы двух одинаковых ответов, — подойдет значение 0.6 (⇐2/3)                                                                                            |
| ignore\_fields                | Список полей исходных заданий, которые нужно исключить из расчета консистентности и целевых заданий                                                                                                                                                                                                                                                                                                                                |
| executor                      | По умолчанию None. Обработчик задач запускается пользователем SDK через cli команды. \* True — использовать автоматический обработчик задач. Пользователь [tagme\_pipelines@sberbank.ru](mailto:tagme%5Fpipelines@sberbank.ru) должен быть добавлен в организацию как заказчик                                                                                                                                                     |
| auto\_create\_task            | Создавать задачи автоматически при связи на уровне проектов                                                                                                                                                                                                                                                                                                                                                                        |
| auto\_start\_task             | Запускать задачу после дозагрузки файлов                                                                                                                                                                                                                                                                                                                                                                                           |

Пример секции CONFIG пайплайна в PAYLOAD задачи

```json
{
  "pipeline": {
      "source_task": "fcc1f83e-4441-4bd6-90be-6ed50b6056ee",
      "source_project": "fcc1f83e-4441-4bd6-90be-6ed50b6056ee",
      "fields": [
        ["file", "file"],
        ["result.marks", "premarkup.marks"]
      ],
      "result_aggregation": "aggregate",
      "consistency_filter": "unsure",
      "consistency_share_threshold": 0.6,
      "ignore_fields": ["result.marks.id"],
        "executor": "example",
        "auto_create_task": true,
        "auto_start_task": false
  }
}
```

undefined
====================


Примеры запросов
====================
## [](#%5Fсоздание%5Fпроекта)Создание проекта

```python
from crowd_sdk.tagme import TagmeClient, types

async def create_project() -> types.ProjectResponse:
    client = TagmeClient.from_config()
    # список организаций доступных пользователю
    available_organization_ids = await client.get_organizations_ids()
    return await client.create_project(
        types.CreateProjectRequest(
            organization_id=available_organization_ids[0],
            name='Новый проект',
            description='Описание нового проекта',
        )
    )
```

## [](#%5Fсоздание%5Fи%5Fзапуск%5Fзадачи)Создание и запуск задачи

```python
import asyncio
from pathlib import Path

from crowd_sdk.tagme import TagmeClient, types


async def create_and_start_task(test_data_path: Path):
    """
    Метод создаёт и запускает задачу для разметки
    """

    client = TagmeClient.from_config()

    available_organization_ids = await client.get_organizations_ids()
    organization_id = available_organization_ids[0]

    pool = await client.create_pool(
        types.CreatePoolRequest(
            name='test_name',
            markers=['test_marker@sber.ru'],
            organization_id=organization_id,
        )
    )
    project = await client.create_project(
        types.CreateProjectRequest(
            name='project_name',
            organization_id=organization_id,
            description='desc',
        )
    )
    method = await client.create_method(
        types.CreateMethodRequest(
            name='test method',
            organization_id=organization_id,
            forms=types.MethodForms(
                css='test css',
                html='test html',
                js='test js',
                data='test data',
            ),
            marker_brief='test task instruction',
        )
    )
    workflow = await client.get_default_project_workflow(project.uid)

    test_task_name = 'test_task'
    await client.create_task(
        types.CreateTaskRequest(
            name=test_task_name,
            organization_id=organization_id,
            workflow_id=workflow.uid,
            method_id=method.uid,
            description='description',
            overlap=1,
        )
    )

    tasks = await client.get_tasks(types.GetTasksRequest(workflow_id=workflow.uid))
    for _task in tasks:
        if _task.name == test_task_name:
            new_task = _task
            break
    else:  # pylint: disable=useless-else-on-loop
        raise ValueError('Task wasn\'t created')

    await client.add_users_to_project(types.AddUsersToProjectRequest(project_id=project.uid, pool_id=pool.uid))

    await client.upload_folder_to_task(
        bucket_id=new_task.storage_id,
        task_id=new_task.uid,
        folder=test_data_path,
    )
    await client.start_task(new_task.uid)

    for _ in range(5):
        await asyncio.sleep(5)
        new_task = await client.get_task(new_task.uid)
        if new_task.state is types.TaskState.RUNNING:
            break
    else:  # pylint: disable=W0120
        raise ValueError(f'Incorrent task state {new_task.state}, expected {types.TaskState.RUNNING}')
```

## [](#%5Fсоздание%5Fи%5Fзапуск%5Fзадачи%5Fс%5Fсобственными%5Fклассами)Создание и запуск задачи с собственными классами

```python
import asyncio
import json
from pathlib import Path
from typing import Optional, Tuple

from crowd_sdk.tagme import ProjectConfig, TagmeClientAdvanced


async def create_test_pool(
    tagme_client: TagmeClientAdvanced, pool_name: str, organization_id: Optional[str] = None
) -> str:
    pool = await tagme_client.client.create_pool(name=pool_name, markers=[], organization_id=organization_id)
    current_user = await tagme_client.client.get_self_person()
    await tagme_client.client.add_markers(emails=[current_user.email], pools=[pool.uid])

    return pool.uid


async def prerequisites(organization_id: str) -> Tuple[TagmeClientAdvanced, str]:
    client = TagmeClientAdvanced()
    config = ProjectConfig.load(Path(__file__).parent / 'example_data' / 'project' / 'project.yaml')
    new_pool = await create_test_pool(client, 'Test pool', organization_id)
    config.pools = [new_pool]

    # Create project using text segmentation template
    project_id = await client.create_project_by_config(config, organization_id=organization_id)

    # Create task, upload data and add pool
    task = await client.create_and_start_task(config, project_id, start_task=False)
    assert task.uid

    return client, task.uid


async def main(organization_id: str) -> None:
    # prerequisites for this example: ready for markup task
    client, task_id = await prerequisites(organization_id)

    # Update entities only for the created task
    entities_file = Path(__file__).parent / 'example_data' / 'new_entities.json'
    with open(entities_file) as f:
        new_entities = json.load(f)

    await client.set_task_payload(task_id, {'entities': new_entities})

    # Run task
    await client.start_task(task_id)


if __name__ == '__main__':
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main('064d1d79-8c71-4068-b4e5-39850c90eaa1'))
```

## [](#%5Fотключение%5Fконтрольного%5Fзадания)Отключение контрольного задания

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

1. Остановите разметку задачи.
2. Отключите задание, чтобы оно больше не показывалось разметчикам.
3. Запустите разметку задачи снова.

```python
import asyncio

from crowd_sdk.tagme import TagmeClient


async def main(task_id: str, file_uid: str) -> None:
    tagme_client = TagmeClient()
    task = await tagme_client.get_task(task_id=task_id)
    file = await tagme_client.get_file(task_id, file_uid)
    flag = False

    assert file.metadata[0] and len(file.metadata) == 1  # making sure that this file is a control task
    if task.state.value == 'RUNNING':
        await tagme_client.stop_task(task.uid)  # stops the task if it was active
        flag = True

    assert file.enabled is True  # the file is issued to markers
    await tagme_client.disable_control_task(task.uid, file_uid)  # disable this file
    file = await tagme_client.get_file(task_id, file_uid)  # update file info
    assert file.enabled is False  # the file is not issued to markers

    if flag:
        await tagme_client.start_task(task.uid)  # starts a stopped task if it was active


if __name__ == '__main__':
    loop = asyncio.get_event_loop()
    loop.run_until_complete(
        main(
            task_id='xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
            file_uid='yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy',
        )
    )
```

## [](#%5Fскачивание%5Fрезультатов)Скачивание результатов

```python
import json
from pathlib import Path
from crowd_sdk.tagme import TagmeClientAdvanced
client = TagmeClientAdvanced()

path = Path(__file__).parent / 'test_data' / 'task_results.json'  # куда сохранить результаты'
task_id = 'b9a1c93c-1a0e-44d1-8b14-bfb0abd3104d'
task_results = await client.get_task_results(task_id)
with open(path, 'w') as f:
    json.dump([result.to_dict() for result in task_results], f, ensure_ascii=False, indent=2)
```

## [](#%5Fвыгрузка%5Fстатистики)Выгрузка статистики

```python
from typing import List
from crowd_sdk.tagme import TagmeClientAdvanced, types

tagme_client = TagmeClientAdvanced('~/.crowd.cfg')
task_id = '2ba17b92-257c-6ff6-8e16-73a11382ab09'
project_id = '2ba17b92-257c-6ff6-8e16-73a11382ab09'
task: types.TaskData = await tagme_client.get_task(task_id=task_id)
task_statistics, marker_statistics = await tagme_client.export_project_stats(
    project_id=project_id,
    from_date=(2022, 4, 1),
    to_date=(2022, 4, 18),
)
task_result: List[types.TaskResult] = await tagme_client.get_task_results(task_id=task_id)
```

undefined
====================
## [](#начинаем-пользоваться)**Начинаем пользоваться**

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

Далее, начнем с его помощью выполнять различные действия на платформе

### [](#инициализируем-клиент)Инициализируем клиент

In\[ \]:

```python
from crowd_sdk.tagme import TagmeClientAdvanced

client = TagmeClientAdvanced("crowd.cfg")
```

### [](#создаем-свой-проект-используя-sdk)Создаем свой проект, используя SDK

Для этого воспользуемся методом `create_project`

In\[ \]:

```python
from IPython.display import Markdown as md

project = await client.create_project(
    name="Имя вашего проекта",
    description="Описание вашего проекта",
    inner_comment="Внутренний комментарий для заказчика",
)

project_link = await client.gen_project_url(project.uid, project.organization_id)
md(f'**[cсылка на ваш проект]({project_link})**')
```

Out\[ \]:

**[cсылка на ваш проект](https://tagme.sberdevices.ru/company/d9d24126-e268-4a7e-bb83-8ee9123e0ef7/project/34b229eb-10be-4393-9feb-2173339ce2b7)**

### [](#добавляем-инструкцию-и-интерфейс)Добавляем инструкцию и интерфейс

У каждого проекта на TagMe есть методика. Она состоит из нескольких частей:

* marker\_brief - инструкция для разметчиков, сверстанная в HTML
* forms - части интерфейса и различные настройки проекта

Форма проекта, в свою очередь, состоит из следующих полей:

* html, css, js - интерфейс заданий проекта
* config, specifications - различные настройки проекта в формате JSON
* example - пример данных задания для показа в предпросмотре интерфейса

In\[ \]:

```python
# Добавим руками
marker_brief = """
Инструкция в формате HTML
"""

html = """
Интерфейс проекта (часть с HTML)
"""

css = """
Интерфейс проекта (часть с CSS)
"""

js = """
Интерфейс проекта (часть с JS)
"""


# Или просто скачаем готовые примеры
import aiohttp

async def download_text(url: str) -> str:
    async with aiohttp.ClientSession() as session:
      resp = await session.get(url)
      return await resp.text()

marker_brief  = await download_text("https://obs.ru-moscow-1.hc.sbercloud.ru/d-tagme-public/public/crowd_sdk/example_data/example_brief.html")
html          = await download_text("https://obs.ru-moscow-1.hc.sbercloud.ru/d-tagme-public/public/crowd_sdk/example_data/example_html.html")
css           = await download_text("https://obs.ru-moscow-1.hc.sbercloud.ru/d-tagme-public/public/crowd_sdk/example_data/example_css.css")
js            = await download_text("https://obs.ru-moscow-1.hc.sbercloud.ru/d-tagme-public/public/crowd_sdk/example_data/example_js.js")


# Или скопируем из другого проекта
# old_project = await client.get_project("id проекта")
# await client.load_project_method(old_project)
# old_method = old_project.method

# marker_brief = old_method.marker_brief
# html = old_method.forms.html
# css = old_method.forms.css
# js = old_method.forms.js

# Раскомментируйте чтобы посмотреть инструкцию прямо в ноутбуке
# from IPython.display import HTML
# HTML(marker_brief)
```

In\[ \]:

```python
from crowd_sdk.tagme.types import MethodData, MethodForms

forms = MethodForms(
    html=html,
    css=css,
    js=js,
    example={"text": "текст"}
)

method = MethodData(
    uid=project.method_id,
    name="Название методики",
    forms=forms,
    marker_brief=marker_brief,
)

await client.update_method(method=method)
md(f'**[ссылка на интерфейс проекта]({project_link}/forms)**')
```

Out\[ \]:

**[ссылка на интерфейс проекта](https://tagme.sberdevices.ru/company/d9d24126-e268-4a7e-bb83-8ee9123e0ef7/project/34b229eb-10be-4393-9feb-2173339ce2b7/forms)**

## [](#добавляем-задачу-в-проект)Добавляем задачу в проект

In\[ \]:

```python
from crowd_sdk.tagme.types import TaskDataRequest, TaskType

create_task_request = TaskDataRequest(
    project_id=project.uid,
    organization_id=project.organization_id,
    name="Имя вашей задачи",
    overlap=2,
    type=TaskType.PROD, # or TaskType.STUDY | TaskType.EXAM
    description="Описание задачи",
)

task = await client.create_task(create_task_request)

task_link = await client.gen_task_url(task.project_id, task.uid, task.organization_id)
md(f'**[ссылка на вашу задачу]({task_link})**')
```

Out\[ \]:

**[ссылка на вашу задачу](https://tagme.sberdevices.ru/company/d9d24126-e268-4a7e-bb83-8ee9123e0ef7/project/34b229eb-10be-4393-9feb-2173339ce2b7/task/92f16cf4-79f8-44b5-918e-428186fa3e93/overview)**

## [](#загружаем-задания-в-задачу)Загружаем задания в задачу

В SDK существуют различные способы загрузить данные в задачу. Рассмотрим их:

1. Таблицей - в каждой строке содержатся данные для конкретного задания, так что можно загрузить сразу много заданий. Столбцы со значениями входных полей называются `INPUT:название поля`. Например,`INPUT:text`. Для контрольных заданий столбец с ожидаемым результатом задания помечается как `GOLDEN:название поля`. Например,`GOLDEN:result`. Для добавления подсказок к заданию можно добавить столбец вида `HINT:название поля`. Метод клиента для загрузки таблицы с данными называется upload\_table и он обрабатывает форматы xls(x) и csv. Кроме того, есть метод `upload_tsv_data`, который позволяет загружать задания в формате tsv.
2. Файлами - можно загрузить отдельные файлы, в которых лежат задания, подходящие под ваш интерфейс. Для этого существуют такие методы, как`upload_files`, `upload_folder`, `upload_folder_to_task`,`upload_folders_to_task`, `upload_folders_to_task_and_start`. По названиям методов можно понять, что они делают. Отличие `upload_folder`и `upload_folder_to_task` заключается в том, что в первый передается объект типа `TaskData`, а во второй - id задачи, так что скорее всего вам пригодится второй из них.
3. Загрузка PDF - для этого есть метод `upload_folder_pdf`. Этот метод перед загрузкой преобразует pdf-файлы в png-изображения. Такие данные можно будет использовать для шаблона \`\`Сегментация PDF''.
4. Загрузка списка заданий в формате JSON - для этого есть метод`upload_json_data`. Он принимает список объектов в формате JSON. Для каждого задания можно добавить предразметку, правильный ответ и подсказки.

Подробнее о форматах смотрите по**[ссылке](https://tagme.sberdevices.ru/docs/customer/uploading-data.html)**.

### [](#скачиваем-данные)Скачиваем данные

In\[ \]:

```python
import pandas as pd

session = aiohttp.ClientSession()
data = await (await session.get("https://obs.ru-moscow-1.hc.sbercloud.ru/d-tagme-public/public/crowd_sdk/example_data/example_data.xlsx")).content.read()
await session.close()

data_df = pd.read_excel(data)
data_df.head(5)
```

Out\[ \]:

<ipython-input-10-597d07fd1ad6>:7: FutureWarning: Passing bytes to 'read\_excel' is deprecated and will be removed in a future version. To read from a byte string, wrap it in a `BytesIO` object. data\_df = pd.read\_excel(data)

| INPUT:text | GOLDEN:music          |        |
| ---------- | --------------------- | ------ |
| 0          | седьмой б             | artist |
| 1          | сбер поставь niletto  | artist |
| 2          | включи песню звери    | NaN    |
| 3          | включи песню симбочка | NaN    |
| 4          | владимир дормидонтов  | NaN    |

### [](#загружаем-в-задачу)Загружаем в задачу

In\[ \]:

```python
with open("data.xlsx", "wb") as f:
    f.write(data)

await client.upload_table(task.uid, "data.xlsx")
```

## [](#добавляем-разметчиков-в-проект)Добавляем разметчиков в проект

### [](#создаем-группу-разметчиков-и-добавляем-в-нее-себя)Создаем группу разметчиков и добавляем в нее себя

In\[ \]:

```python
self_person = await client.get_self_person()
markers = [self_person.uid]
pool = await client.create_pool(
    markers=markers,
    name="Имя вашей группы разметчиков",
)
```

### [](#добавляем-группу-разметчиков-в-проект)Добавляем группу разметчиков в проект

### [](#добавляем-еще-разметчиков)Добавляем еще разметчиков

Если прямо сейчас вы присутствуете на офлайн-обучении в СберУниверситете, вам доступна группа разметчиков, которую мы добавили специально для обучения. Давайте добавим и ее.

In\[ \]:

```python
await client.add_users_to_project(project_id=project.uid, pool_id=pool.uid)
```

### [](#добавляем-группу-разметчиков-в-наш-проект)Добавляем группу разметчиков в наш проект

In\[ \]:

```python
# await client.add_users_to_project(project.uid, pool.uid)
```

## [](#запускаем-задачу)Запускаем задачу

In\[ \]:

```python
await client.start_task(task.uid)
print("Task started")
```

Out\[ \]:

Task started

## [](#ожидаем-завершение-разметки-задачи)Ожидаем завершение разметки задачи

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

## [](#получаем-результаты-разметки)Получаем результаты разметки

### [](#получаем-сырые-результаты)Получаем сырые результаты

Чтобы получить результаты разметки, используя SDK, у клиента есть такие методы, как `get_task_assignments` и `get_task_assignments_df`. Первый из них возвращает список объектов типа `Assignment`, а второй, как можно догадаться, возвращает DataFrame, который содержит в себе таблицу с результатами.

Чаще всего, при работе внутри блокнотов удобнее пользоваться DataFrame-ами, так что давайте и сейчас им воспользуемся.

In\[ \]:

```python
df = await client.get_task_assignments_df(task.uid)
df.head(5)
```

Out\[ \]:

| OUTPUT:Comment | OUTPUT:correct | accepted\_at               | assignment\_id                       | enabled | end\_date                  | file\_name    | item\_id                             | item\_type | marker\_id                           | organization\_id                     | person\_id                           | start\_date                | status   | submitted\_at              | task\_id                             |
| -------------- | -------------- | -------------------------- | ------------------------------------ | ------- | -------------------------- | ------------- | ------------------------------------ | ---------- | ------------------------------------ | ------------------------------------ | ------------------------------------ | -------------------------- | -------- | -------------------------- | ------------------------------------ |
| 0              | 1              | 2024-07-30 17:46:55.350004 | 04f9dbd8-a86f-4bf2-8739-7edb232ab6b1 | True    | 2024-07-30 17:46:55.350004 | data\_11.json | 890b6c51-dc96-4f32-9378-1ec83eaef14c | data       | f17e770b-5344-49b7-8bb4-f7d44c539e66 | d9d24126-e268-4a7e-bb83-8ee9123e0ef7 | f17e770b-5344-49b7-8bb4-f7d44c539e66 | 2024-07-30 17:43:18.566430 | ACCEPTED | 2024-07-30 17:46:55.350004 | 92f16cf4-79f8-44b5-918e-428186fa3e93 |
| 1              | 2              | 2024-07-30 17:46:56.319992 | 42e34a34-15d7-4c0f-a46c-553135d164a7 | True    | 2024-07-30 17:46:56.319992 | data\_19.json | c1a5ba10-f1d7-4cf6-9118-9d0eb88aa7f5 | data       | f17e770b-5344-49b7-8bb4-f7d44c539e66 | d9d24126-e268-4a7e-bb83-8ee9123e0ef7 | f17e770b-5344-49b7-8bb4-f7d44c539e66 | 2024-07-30 17:46:55.403594 | ACCEPTED | 2024-07-30 17:46:56.319992 | 92f16cf4-79f8-44b5-918e-428186fa3e93 |
| 2              | 3              | 2024-07-30 17:46:57.163482 | 8c9b91c2-e3b5-4431-8418-00cbe9fe0787 | True    | 2024-07-30 17:46:57.163482 | data\_21.json | b8136362-bac2-4b72-903c-5c743bf6911c | data       | f17e770b-5344-49b7-8bb4-f7d44c539e66 | d9d24126-e268-4a7e-bb83-8ee9123e0ef7 | f17e770b-5344-49b7-8bb4-f7d44c539e66 | 2024-07-30 17:46:56.367860 | ACCEPTED | 2024-07-30 17:46:57.163482 | 92f16cf4-79f8-44b5-918e-428186fa3e93 |
| 3              | 4              | 2024-07-30 17:46:58.452109 | 4f14d70a-f6aa-4dca-9440-56c6f582e24e | True    | 2024-07-30 17:46:58.452109 | data\_5.json  | ab225d84-45e3-425e-89dd-a9cb6b519cc1 | data       | f17e770b-5344-49b7-8bb4-f7d44c539e66 | d9d24126-e268-4a7e-bb83-8ee9123e0ef7 | f17e770b-5344-49b7-8bb4-f7d44c539e66 | 2024-07-30 17:46:57.207142 | ACCEPTED | 2024-07-30 17:46:58.452109 | 92f16cf4-79f8-44b5-918e-428186fa3e93 |
| 4              | 1              | 2024-07-30 17:46:59.630209 | 91327f8a-379a-4576-96ee-5439613e8ae0 | True    | 2024-07-30 17:46:59.630209 | data\_20.json | fde0f063-efb3-403a-94a3-b8abf48bcb2d | data       | f17e770b-5344-49b7-8bb4-f7d44c539e66 | d9d24126-e268-4a7e-bb83-8ee9123e0ef7 | f17e770b-5344-49b7-8bb4-f7d44c539e66 | 2024-07-30 17:46:58.493102 | ACCEPTED | 2024-07-30 17:46:59.630209 | 92f16cf4-79f8-44b5-918e-428186fa3e93 |

Для сравнения посмотрим, как выглядит один ответ разметчика при использовании `get_task_assignments` (для удобства конвертируем в json)

In\[ \]:

```python
from crowd_sdk.core.utils.common import dataclass_to_dict

assignments = await client.get_task_assignments(task_id=task.uid)
first_assignment = assignments[0]
dataclass_to_dict(first_assignment)
```

Out\[ \]:

{'file\_name': 'data\_11.json', 'item\_id': '890b6c51-dc96-4f32-9378-1ec83eaef14c', 'marker\_id': 'f17e770b-5344-49b7-8bb4-f7d44c539e66', 'organization\_id': 'd9d24126-e268-4a7e-bb83-8ee9123e0ef7', 'person\_id': 'f17e770b-5344-49b7-8bb4-f7d44c539e66', 'price': 0.0, 'result': {'Comment': '', 'correct': 1}, 'status': 'ACCEPTED', 'task\_id': '92f16cf4-79f8-44b5-918e-428186fa3e93', 'start\_date': '2024-07-30T17:43:18.566430+03:00', 'end\_date': '2024-07-30T17:46:55.350004+03:00', 'submitted\_at': '2024-07-30T17:46:55.350004+03:00', 'accepted\_at': '2024-07-30T17:46:55.350004+03:00', 'item\_type': 'data', 'assignment\_id': '04f9dbd8-a86f-4bf2-8739-7edb232ab6b1', 'enabled': True}

Что в таблице, что в объектах, которые возвращаются из`get_task_assignments`, содержится различная информация об ответах разметчиков.

Главное различие, которое можно заметить, заключается в том, что при выгрузке таблицей, поле result разбивается на ключи словаря, и они становятся разными столбцами с названием `OUTPUT:название поля`.

TagMe SDK
====================
### [ Установка](/docs/sdk/installation.html) 

### [ Быстрый старт](/docs/sdk/intro.ipynb.html) 

### [ Примеры](/docs/sdk/examples.html) 

### [ CLI Скрипты](/docs/sdk/cli.html) 

### [ TagMe SDK Reference](/docs/sdk/rst/attachments.html) 

Установка
====================
SDK для Python совместим с версиями Python 3.6 и выше.

Чтобы установить SDK:

* скачайте релизную сборку SDK в виде [wheel пакета](/docs/sber%5Ftagme%5Fcrowd%5Fsdk-4.11.0rc2-py3-none-any.whl);
* выполните команду:

Пример команды

```bash
pip install <Путь до wheel-пакета>
```

* сконфигурируйте SDK для подключения к платформе разметки через [config-файл](%5Fattachments/crowd.cfg), указав в нем учетные данные пользователя в секции **tagme**. Для [загрузки PDF](cli.html#%5Fзагрузка%5Fданных%5Fв%5Fзадачу) заполните секцию **cloud**.

По умолчанию SDK ищет файл по пути: **\~/.crowd.cfg**

```text
tagme:
 url: https://tagme.sberdevices.ru
 auth_url: https://tagme.sberdevices.ru
 user: <user login>
 password: <user password>
cloud:
 main:
  endpoint: <s3 endpoint>
  key: <s3 key>
  secret: <s3 secret>
```

Быстрый старт
====================
[Скачать notebook](%5Fattachments/guide.ipynb)

[Открыть в **Google Colab**](https://colab.research.google.com/drive/19Isj2rtlh%5F7rLlJII%5FXCimpI8Sve6a1h)

## [](#начинаем-пользоваться)**Начинаем пользоваться**

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

Далее, начнем с его помощью выполнять различные действия на платформе

### [](#инициализируем-клиент)Инициализируем клиент

In\[ \]:

```python
from crowd_sdk.tagme import TagmeClientAdvanced

client = TagmeClientAdvanced("crowd.cfg")
```

### [](#создаем-свой-проект-используя-sdk)Создаем свой проект, используя SDK

Для этого воспользуемся методом `create_project`

In\[ \]:

```python
from IPython.display import Markdown as md

project = await client.create_project(
    name="Имя вашего проекта",
    description="Описание вашего проекта",
    inner_comment="Внутренний комментарий для заказчика",
)

project_link = await client.gen_project_url(project.uid, project.organization_id)
md(f'**[cсылка на ваш проект]({project_link})**')
```

Out\[ \]:

**[cсылка на ваш проект](https://tagme.sberdevices.ru/company/d9d24126-e268-4a7e-bb83-8ee9123e0ef7/project/34b229eb-10be-4393-9feb-2173339ce2b7)**

### [](#добавляем-инструкцию-и-интерфейс)Добавляем инструкцию и интерфейс

У каждого проекта на TagMe есть методика. Она состоит из нескольких частей:

* marker\_brief - инструкция для разметчиков, сверстанная в HTML
* forms - части интерфейса и различные настройки проекта

Форма проекта, в свою очередь, состоит из следующих полей:

* html, css, js - интерфейс заданий проекта
* config, specifications - различные настройки проекта в формате JSON
* example - пример данных задания для показа в предпросмотре интерфейса

In\[ \]:

```python
# Добавим руками
marker_brief = """
Инструкция в формате HTML
"""

html = """
Интерфейс проекта (часть с HTML)
"""

css = """
Интерфейс проекта (часть с CSS)
"""

js = """
Интерфейс проекта (часть с JS)
"""


# Или просто скачаем готовые примеры
import aiohttp

async def download_text(url: str) -> str:
    async with aiohttp.ClientSession() as session:
      resp = await session.get(url)
      return await resp.text()

marker_brief  = await download_text("https://obs.ru-moscow-1.hc.sbercloud.ru/d-tagme-public/public/crowd_sdk/example_data/example_brief.html")
html          = await download_text("https://obs.ru-moscow-1.hc.sbercloud.ru/d-tagme-public/public/crowd_sdk/example_data/example_html.html")
css           = await download_text("https://obs.ru-moscow-1.hc.sbercloud.ru/d-tagme-public/public/crowd_sdk/example_data/example_css.css")
js            = await download_text("https://obs.ru-moscow-1.hc.sbercloud.ru/d-tagme-public/public/crowd_sdk/example_data/example_js.js")


# Или скопируем из другого проекта
# old_project = await client.get_project("id проекта")
# await client.load_project_method(old_project)
# old_method = old_project.method

# marker_brief = old_method.marker_brief
# html = old_method.forms.html
# css = old_method.forms.css
# js = old_method.forms.js

# Раскомментируйте чтобы посмотреть инструкцию прямо в ноутбуке
# from IPython.display import HTML
# HTML(marker_brief)
```

In\[ \]:

```python
from crowd_sdk.tagme.types import MethodData, MethodForms

forms = MethodForms(
    html=html,
    css=css,
    js=js,
    example={"text": "текст"}
)

method = MethodData(
    uid=project.method_id,
    name="Название методики",
    forms=forms,
    marker_brief=marker_brief,
)

await client.update_method(method=method)
md(f'**[ссылка на интерфейс проекта]({project_link}/forms)**')
```

Out\[ \]:

**[ссылка на интерфейс проекта](https://tagme.sberdevices.ru/company/d9d24126-e268-4a7e-bb83-8ee9123e0ef7/project/34b229eb-10be-4393-9feb-2173339ce2b7/forms)**

## [](#добавляем-задачу-в-проект)Добавляем задачу в проект

In\[ \]:

```python
from crowd_sdk.tagme.types import TaskDataRequest, TaskType

create_task_request = TaskDataRequest(
    project_id=project.uid,
    organization_id=project.organization_id,
    name="Имя вашей задачи",
    overlap=2,
    type=TaskType.PROD, # or TaskType.STUDY | TaskType.EXAM
    description="Описание задачи",
)

task = await client.create_task(create_task_request)

task_link = await client.gen_task_url(task.project_id, task.uid, task.organization_id)
md(f'**[ссылка на вашу задачу]({task_link})**')
```

Out\[ \]:

**[ссылка на вашу задачу](https://tagme.sberdevices.ru/company/d9d24126-e268-4a7e-bb83-8ee9123e0ef7/project/34b229eb-10be-4393-9feb-2173339ce2b7/task/92f16cf4-79f8-44b5-918e-428186fa3e93/overview)**

## [](#загружаем-задания-в-задачу)Загружаем задания в задачу

В SDK существуют различные способы загрузить данные в задачу. Рассмотрим их:

1. Таблицей - в каждой строке содержатся данные для конкретного задания, так что можно загрузить сразу много заданий. Столбцы со значениями входных полей называются `INPUT:название поля`. Например,`INPUT:text`. Для контрольных заданий столбец с ожидаемым результатом задания помечается как `GOLDEN:название поля`. Например,`GOLDEN:result`. Для добавления подсказок к заданию можно добавить столбец вида `HINT:название поля`. Метод клиента для загрузки таблицы с данными называется upload\_table и он обрабатывает форматы xls(x) и csv. Кроме того, есть метод `upload_tsv_data`, который позволяет загружать задания в формате tsv.
2. Файлами - можно загрузить отдельные файлы, в которых лежат задания, подходящие под ваш интерфейс. Для этого существуют такие методы, как`upload_files`, `upload_folder`, `upload_folder_to_task`,`upload_folders_to_task`, `upload_folders_to_task_and_start`. По названиям методов можно понять, что они делают. Отличие `upload_folder`и `upload_folder_to_task` заключается в том, что в первый передается объект типа `TaskData`, а во второй - id задачи, так что скорее всего вам пригодится второй из них.
3. Загрузка PDF - для этого есть метод `upload_folder_pdf`. Этот метод перед загрузкой преобразует pdf-файлы в png-изображения. Такие данные можно будет использовать для шаблона \`\`Сегментация PDF''.
4. Загрузка списка заданий в формате JSON - для этого есть метод`upload_json_data`. Он принимает список объектов в формате JSON. Для каждого задания можно добавить предразметку, правильный ответ и подсказки.

Подробнее о форматах смотрите по**[ссылке](https://tagme.sberdevices.ru/docs/customer/uploading-data.html)**.

### [](#скачиваем-данные)Скачиваем данные

In\[ \]:

```python
import pandas as pd

session = aiohttp.ClientSession()
data = await (await session.get("https://obs.ru-moscow-1.hc.sbercloud.ru/d-tagme-public/public/crowd_sdk/example_data/example_data.xlsx")).content.read()
await session.close()

data_df = pd.read_excel(data)
data_df.head(5)
```

Out\[ \]:

<ipython-input-10-597d07fd1ad6>:7: FutureWarning: Passing bytes to 'read\_excel' is deprecated and will be removed in a future version. To read from a byte string, wrap it in a `BytesIO` object. data\_df = pd.read\_excel(data)

| INPUT:text | GOLDEN:music          |        |
| ---------- | --------------------- | ------ |
| 0          | седьмой б             | artist |
| 1          | сбер поставь niletto  | artist |
| 2          | включи песню звери    | NaN    |
| 3          | включи песню симбочка | NaN    |
| 4          | владимир дормидонтов  | NaN    |

### [](#загружаем-в-задачу)Загружаем в задачу

In\[ \]:

```python
with open("data.xlsx", "wb") as f:
    f.write(data)

await client.upload_table(task.uid, "data.xlsx")
```

## [](#добавляем-разметчиков-в-проект)Добавляем разметчиков в проект

### [](#создаем-группу-разметчиков-и-добавляем-в-нее-себя)Создаем группу разметчиков и добавляем в нее себя

In\[ \]:

```python
self_person = await client.get_self_person()
markers = [self_person.uid]
pool = await client.create_pool(
    markers=markers,
    name="Имя вашей группы разметчиков",
)
```

### [](#добавляем-группу-разметчиков-в-проект)Добавляем группу разметчиков в проект

### [](#добавляем-еще-разметчиков)Добавляем еще разметчиков

Если прямо сейчас вы присутствуете на офлайн-обучении в СберУниверситете, вам доступна группа разметчиков, которую мы добавили специально для обучения. Давайте добавим и ее.

In\[ \]:

```python
await client.add_users_to_project(project_id=project.uid, pool_id=pool.uid)
```

### [](#добавляем-группу-разметчиков-в-наш-проект)Добавляем группу разметчиков в наш проект

In\[ \]:

```python
# await client.add_users_to_project(project.uid, pool.uid)
```

## [](#запускаем-задачу)Запускаем задачу

In\[ \]:

```python
await client.start_task(task.uid)
print("Task started")
```

Out\[ \]:

Task started

## [](#ожидаем-завершение-разметки-задачи)Ожидаем завершение разметки задачи

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

## [](#получаем-результаты-разметки)Получаем результаты разметки

### [](#получаем-сырые-результаты)Получаем сырые результаты

Чтобы получить результаты разметки, используя SDK, у клиента есть такие методы, как `get_task_assignments` и `get_task_assignments_df`. Первый из них возвращает список объектов типа `Assignment`, а второй, как можно догадаться, возвращает DataFrame, который содержит в себе таблицу с результатами.

Чаще всего, при работе внутри блокнотов удобнее пользоваться DataFrame-ами, так что давайте и сейчас им воспользуемся.

In\[ \]:

```python
df = await client.get_task_assignments_df(task.uid)
df.head(5)
```

Out\[ \]:

| OUTPUT:Comment | OUTPUT:correct | accepted\_at               | assignment\_id                       | enabled | end\_date                  | file\_name    | item\_id                             | item\_type | marker\_id                           | organization\_id                     | person\_id                           | start\_date                | status   | submitted\_at              | task\_id                             |
| -------------- | -------------- | -------------------------- | ------------------------------------ | ------- | -------------------------- | ------------- | ------------------------------------ | ---------- | ------------------------------------ | ------------------------------------ | ------------------------------------ | -------------------------- | -------- | -------------------------- | ------------------------------------ |
| 0              | 1              | 2024-07-30 17:46:55.350004 | 04f9dbd8-a86f-4bf2-8739-7edb232ab6b1 | True    | 2024-07-30 17:46:55.350004 | data\_11.json | 890b6c51-dc96-4f32-9378-1ec83eaef14c | data       | f17e770b-5344-49b7-8bb4-f7d44c539e66 | d9d24126-e268-4a7e-bb83-8ee9123e0ef7 | f17e770b-5344-49b7-8bb4-f7d44c539e66 | 2024-07-30 17:43:18.566430 | ACCEPTED | 2024-07-30 17:46:55.350004 | 92f16cf4-79f8-44b5-918e-428186fa3e93 |
| 1              | 2              | 2024-07-30 17:46:56.319992 | 42e34a34-15d7-4c0f-a46c-553135d164a7 | True    | 2024-07-30 17:46:56.319992 | data\_19.json | c1a5ba10-f1d7-4cf6-9118-9d0eb88aa7f5 | data       | f17e770b-5344-49b7-8bb4-f7d44c539e66 | d9d24126-e268-4a7e-bb83-8ee9123e0ef7 | f17e770b-5344-49b7-8bb4-f7d44c539e66 | 2024-07-30 17:46:55.403594 | ACCEPTED | 2024-07-30 17:46:56.319992 | 92f16cf4-79f8-44b5-918e-428186fa3e93 |
| 2              | 3              | 2024-07-30 17:46:57.163482 | 8c9b91c2-e3b5-4431-8418-00cbe9fe0787 | True    | 2024-07-30 17:46:57.163482 | data\_21.json | b8136362-bac2-4b72-903c-5c743bf6911c | data       | f17e770b-5344-49b7-8bb4-f7d44c539e66 | d9d24126-e268-4a7e-bb83-8ee9123e0ef7 | f17e770b-5344-49b7-8bb4-f7d44c539e66 | 2024-07-30 17:46:56.367860 | ACCEPTED | 2024-07-30 17:46:57.163482 | 92f16cf4-79f8-44b5-918e-428186fa3e93 |
| 3              | 4              | 2024-07-30 17:46:58.452109 | 4f14d70a-f6aa-4dca-9440-56c6f582e24e | True    | 2024-07-30 17:46:58.452109 | data\_5.json  | ab225d84-45e3-425e-89dd-a9cb6b519cc1 | data       | f17e770b-5344-49b7-8bb4-f7d44c539e66 | d9d24126-e268-4a7e-bb83-8ee9123e0ef7 | f17e770b-5344-49b7-8bb4-f7d44c539e66 | 2024-07-30 17:46:57.207142 | ACCEPTED | 2024-07-30 17:46:58.452109 | 92f16cf4-79f8-44b5-918e-428186fa3e93 |
| 4              | 1              | 2024-07-30 17:46:59.630209 | 91327f8a-379a-4576-96ee-5439613e8ae0 | True    | 2024-07-30 17:46:59.630209 | data\_20.json | fde0f063-efb3-403a-94a3-b8abf48bcb2d | data       | f17e770b-5344-49b7-8bb4-f7d44c539e66 | d9d24126-e268-4a7e-bb83-8ee9123e0ef7 | f17e770b-5344-49b7-8bb4-f7d44c539e66 | 2024-07-30 17:46:58.493102 | ACCEPTED | 2024-07-30 17:46:59.630209 | 92f16cf4-79f8-44b5-918e-428186fa3e93 |

Для сравнения посмотрим, как выглядит один ответ разметчика при использовании `get_task_assignments` (для удобства конвертируем в json)

In\[ \]:

```python
from crowd_sdk.core.utils.common import dataclass_to_dict

assignments = await client.get_task_assignments(task_id=task.uid)
first_assignment = assignments[0]
dataclass_to_dict(first_assignment)
```

Out\[ \]:

{'file\_name': 'data\_11.json', 'item\_id': '890b6c51-dc96-4f32-9378-1ec83eaef14c', 'marker\_id': 'f17e770b-5344-49b7-8bb4-f7d44c539e66', 'organization\_id': 'd9d24126-e268-4a7e-bb83-8ee9123e0ef7', 'person\_id': 'f17e770b-5344-49b7-8bb4-f7d44c539e66', 'price': 0.0, 'result': {'Comment': '', 'correct': 1}, 'status': 'ACCEPTED', 'task\_id': '92f16cf4-79f8-44b5-918e-428186fa3e93', 'start\_date': '2024-07-30T17:43:18.566430+03:00', 'end\_date': '2024-07-30T17:46:55.350004+03:00', 'submitted\_at': '2024-07-30T17:46:55.350004+03:00', 'accepted\_at': '2024-07-30T17:46:55.350004+03:00', 'item\_type': 'data', 'assignment\_id': '04f9dbd8-a86f-4bf2-8739-7edb232ab6b1', 'enabled': True}

Что в таблице, что в объектах, которые возвращаются из`get_task_assignments`, содержится различная информация об ответах разметчиков.

Главное различие, которое можно заметить, заключается в том, что при выгрузке таблицей, поле result разбивается на ключи словаря, и они становятся разными столбцами с названием `OUTPUT:название поля`.

SDK для Python
====================
SDK для Python — это набор средств разработки для взаимодействия сервисов, разработанных на Python, с платформой разметки данных TagMe.

В состав входит набор классов для выполнения основной функцинальности, связанной с платформой, а также набор [cli скриптов](cli.html), которые решают конкретные задачи.

С помощью SDK вы сможете:

* Управлять организацией:  
   * создавать группы разметчиков и измененять их состав;  
   * получать статистику.
* Управлять проектами разметки:  
   * получать список проектов;  
   * создавать проекты;  
   * получать списки задач в проектах;  
   * создавать задачи;  
   * назначать группы разметчиков;  
   * изменять статус задач;  
   * выгружать результаты;  
   * загружать данные для разметки;  
   * выгружать результаты разметки.

Подключение к клиенту
====================
## [](#%5Fclaude%5Fdesktop%5Fcursor)Claude Desktop / Cursor

Добавь в конфиг MCP (`~/.cursor/mcp.json`, `~/claude_desktop_config.json` или настройки других ИИ клиентов):

### [](#%5Fтолько%5Fстатистика)Только статистика

```json
{
  "mcpServers": {
    "crowd-sdk": {
      "command": "tagme",
      "args": ["mcp"],
    }
  }
}
```

### [](#%5Fстатистика%5Fhuman%5Fmcp)Статистика + Human MCP

```json
{
  "mcpServers": {
    "crowd-sdk": {
      "command": "tagme",
      "args": ["mcp", "--enable-human-mcp"],
    }
  }
}
```

### [](#%5Fdataset%5Fbuilder%5Fhuman%5Fmcp%5Fопционально)Dataset Builder (+ Human MCP опционально)

```json
{
  "mcpServers": {
    "crowd-sdk-dataset": {
      "command": "tagme",
      "args": ["mcp", "dataset"],
    }
  }
}
```

### [](#%5Fоба%5Fсервера%5Fодновременно)Оба сервера одновременно

```json
{
  "mcpServers": {
    "crowd-sdk": {
      "command": "tagme",
      "args": ["mcp", "--enable-human-mcp"]
    },
    "crowd-sdk-dataset": {
      "command": "tagme",
      "args": ["mcp", "dataset"]
    }
  }
}
```

## [](#%5Fhttp%5Fтранспорт)HTTP транспорт

Для интеграции с внешними сервисами используй HTTP транспорт:

```bash
tagme mcp --transport streamable-http --host 0.0.0.0 --port 8000
```

## [](#%5Fсторонние%5Fмодули)Сторонние модули

Любой Python-пакет, экспортирующий `register_mcp_tools(mcp)`, можно подключить к серверу через `--extra-modules`:

```json
{
  "mcpServers": {
    "crowd-sdk": {
      "command": "tagme",
      "args": ["mcp", "--extra-modules", "myapp.doc_search"],
    }
  }
}
```

Dataset builder: e2e генерация датасета
====================
[Скачать notebook](%5Fattachments/dataset%5Fbuilder%5Fdemo.ipynb)

Флаги и переменные окружения
====================
## [](#%5Fфлаги%5Fкомандной%5Fстроки)Флаги командной строки

| Флаг                | По умолчанию | Описание                                                                                     |
| ------------------- | ------------ | -------------------------------------------------------------------------------------------- |
| \--enable-human-mcp | выключено    | Включить [Human MCP](modules/human-mcp.html) инструменты                                     |
| \--base-toolset     | full         | Набор statistic инструментов: full или minimal (только health\_check \+ get\_platform\_info) |
| \--extra-modules    | —            | Дополнительные Python-модули через запятую или двоеточие                                     |
| \--transport        | stdio        | Транспорт: stdio или streamable-http                                                         |
| \--host             | 127.0.0.1    | Хост для HTTP транспорта                                                                     |
| \--port             | 8000         | Порт для HTTP транспорта                                                                     |

## [](#%5Fпеременные%5Fокружения)Переменные окружения

### [](#%5Fавторизация%5Ftagme)Авторизация Tagme

| Переменная         | Описание                                           |
| ------------------ | -------------------------------------------------- |
| CROWD\_MCP\_CONFIG | Путь к конфиг-файлу YAML с параметрами подключения |
| TAGME\_STAND       | URL платформы Tagme                                |
| TAGME\_USERNAME    | Логин пользователя                                 |
| TAGME\_PASSWORD    | Пароль пользователя                                |

### [](#%5Fmcp%5Fсервер)MCP сервер

| Переменная                      | Описание                                  |
| ------------------------------- | ----------------------------------------- |
| CROWD\_SDK\_MCP\_HUMAN\_TOOLS=1 | Аналог \--enable-human-mcp                |
| CROWD\_SDK\_MCP\_BASE\_TOOLSET  | Аналог \--base-toolset (full или minimal) |
| CROWD\_SDK\_MCP\_EXTRA\_MODULES | Аналог \--extra-modules                   |

### [](#%5Fdataset%5Fbuilder)Dataset Builder

| Переменная                       | Описание                                        |
| -------------------------------- | ----------------------------------------------- |
| CROWD\_MCP\_GENERATION\_BACKEND  | LLM-бэкенд: tagme (по умолчанию), litellm, http |
| CROWD\_MCP\_GENERATION\_MODEL    | Предпочитаемая модель (одна с weight 1.0)       |
| CROWD\_MCP\_GENERATION\_PROVIDER | Предпочитаемый провайдер                        |
| CROWD\_MCP\_TAGME\_LLM\_URL      | URL LLM-прокси для бэкенда tagme                |
| SEARCH\_API\_URL                 | URL Search API для agentic режима               |
| SEARCH\_API\_TOKEN               | Токен аутентификации Search API                 |
| SEARCH\_API\_AUTH\_HEADER        | Заголовок авторизации Search API                |

Human MCP: создание задач
====================
[Скачать notebook](%5Fattachments/human%5Fmcp%5Fdemo.ipynb)

MCP Сервер Crowd SDK
====================
MCP сервер предоставляет инструменты платформы Tagme LLM-агентам через [Model Context Protocol](https://modelcontextprotocol.io/). Подключается к Claude Desktop, Cursor и любому другому MCP-совместимому клиенту.

## [](#%5Fмодули)Модули

| Модуль                                          | Назначение                                                           | Включение                    |
| ----------------------------------------------- | -------------------------------------------------------------------- | ---------------------------- |
| [Statistic](modules/statistic.html)             | Статистика, анализ результатов, анализ инструкций, обнаружение фрода | Включён по умолчанию         |
| [Human MCP](modules/human-mcp.html)             | Создание задач на экспертов, управление жизненным циклом проектов    | \--enable-human-mcp          |
| [Dataset Builder](modules/dataset-builder.html) | Генерация LLM-датасетов локально без Tagme API                       | Субкоманда tagme mcp dataset |

## [](#%5Fбыстрый%5Fстарт)Быстрый старт

1. Установите пакет:  
```bash  
pip install sber-tagme-crowd-sdk[mcp]  
```
2. Задайте параметры подключения (если конфиг файл для SDK не создан):  
```bash  
export TAGME_STAND=https://tagme.example.com  
export TAGME_USERNAME=you@example.com  
export TAGME_PASSWORD=secret  
```
3. Запустите сервер:  
```bash  
tagme mcp  
```

Подробнее — [Установка и аутентификация](installation.html), [Подключение к клиенту](connection.html).

## [](#%5Fdemo%5Fноутбуки)Demo ноутбуки

| Ноутбук                                               | Описание                                | Скачать                                                    |
| ----------------------------------------------------- | --------------------------------------- | ---------------------------------------------------------- |
| [Statistic Demo](statistic%5Fdemo.html)               | Инструменты статистики и анализа        | [📥 .ipynb](%5Fattachments/statistic%5Fdemo.ipynb)         |
| [Human MCP Demo](human%5Fmcp%5Fdemo.html)             | Human MCP: создание задач               | [📥 .ipynb](%5Fattachments/human%5Fmcp%5Fdemo.ipynb)       |
| [Dataset Builder Demo](dataset%5Fbuilder%5Fdemo.html) | Dataset builder: e2e генерация датасета | [📥 .ipynb](%5Fattachments/dataset%5Fbuilder%5Fdemo.ipynb) |

Установка и аутентификация
====================
## [](#%5Fустановка)Установка

Базовая установка включает MCP сервер, модуль Statistic и Human MCP:

```bash
pip install sber-tagme-crowd-sdk[mcp]
```

Для модуля fastmcp требуется python 3.10+

## [](#%5Fаутентификация)Аутентификация

По умолчанию используется аутентификация для SDK. Дополнительных действий НЕ требуется.

Если инструмент используется не локально, то подключение к платформе Tagme задаётся через конфиг-файл или переменные окружения.

### [](#%5Fвариант%5F1%5Fконфиг%5Fфайл)Вариант 1 — конфиг-файл

```bash
export CROWD_MCP_CONFIG=/path/to/tagme.yaml
```

Содержимое `tagme.yaml`:

```yaml
stand: https://tagme.example.com
user: you@example.com
password: secret
```

### [](#%5Fвариант%5F2%5Fпеременные%5Fокружения)Вариант 2 — переменные окружения

```bash
export TAGME_STAND=https://tagme.example.com
export TAGME_USERNAME=you@example.com
export TAGME_PASSWORD=secret
```

| |  Для модуля [Dataset Builder](modules/dataset-builder.html) подключение к Tagme нужно только для использования бэкенда Tagme для LLM и Поиска. |
| ------------------------------------------------------------------------------------------------------------------------------------------------ |

Инструменты статистики и анализа
====================
[Скачать notebook](%5Fattachments/statistic%5Fdemo.ipynb)

undefined
====================
## [](#%5Fattachments)Attachments

### [](#%5Fdownload%5Fattachment)download\_attachment

TagmeClientAdvanced.download\_attachment(attachment\_url: str, dir\_path: str, organization\_id: str | None = None, ) → str

Download attachment by url and save to file.

| Parameters | \* **attachment\_url** – attachment url to download. \* **dir\_path** – path to directory to save attachment. |
| ---------- | ------------------------------------------------------------------------------------------------------------- |
| Returns    | path to saved attachment.                                                                                     |

### [](#%5Fdownload%5Fattachments)download\_attachments

TagmeClientAdvanced.download\_attachments(task\_id: str, dir\_path: str, organization\_id: str | None = None, ) → List\[str\]

Download all attachments from task.

| Parameters | \* **task\_id** – task id to download attachments from. \* **dir\_path** – path to directory to save attachments. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of paths to saved attachments.                                                                                                                                                             |

undefined
====================
## [](#%5Fclient)Client

### [](#%5Fclose)close

TagmeClientAdvanced.close() → None

Close client http connection. Always do it before finishing to work with client or use ‘async with’ construction.

undefined
====================
## [](#%5Fdatasets)Datasets

### [](#%5Fcreate%5Fdataset)create\_dataset

TagmeClientAdvanced.create\_dataset(name: str, access: str = 'organization', data\_classification\_level: str | None = None, data\_source: str | None = None, organization\_id: str | None = None, acl: List\[str\] | None = None, dataset\_type: str | None = 'DATASET', ) → [Dataset](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Dataset)

Create new dataset.

| Parameters | \* **name** – name of new dataset. \* **data\_classification\_level** – data classification level (‘K2’, ‘K3’). \* **data\_source** – data source. \* **organization\_id** – optional organization identifier. Defaults to None. \* **access** – access level. \* **acl** – access control list. \* **dataset\_type** – dataset type |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | Information about created dataset.                                                                                                                                                                                                                                                                                                   |

### [](#%5Fdownload%5Fdataset%5Fdata)download\_dataset\_data

TagmeClientAdvanced.download\_dataset\_data(dataset\_id: str, destination\_dir: str | Path, organization\_id: str | None = None, ) → int

Download files from dataset.

| Parameters | \* **dataset\_id** – id of dataset to download files from. \* **destination\_dir** – path to directory where files will be downloaded. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | number of files downloaded successfully.                                                                                                                                                                             |

### [](#%5Fdownload%5Fdataset%5Ffile)download\_dataset\_file

TagmeClientAdvanced.download\_dataset\_file(file\_id: str, organization\_id: str | None = None, with\_headers: bool = False, ) → bytes | Any

Download dataset file.

| Parameters | \* **file\_id** – id of file to download. \* **organization\_id** – optional organization identifier. Defaults to None. \* **with\_headers** – if True, return tuple with bytes and headers. Defaults to False. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | bytes of file if with\_headers is False, tuple with bytes and headers otherwise.                                                                                                                                |

### [](#%5Fget%5Fdataset)get\_dataset

TagmeClientAdvanced.get\_dataset(dataset\_id: str, organization\_id: str | None = None, ) → [Dataset](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Dataset)

Get information about dataset.

| Parameters | \* **dataset\_id** – dataset id to get information about. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | information about dataset.                                                                                                              |

### [](#%5Fget%5Fdataset%5Ffile)get\_dataset\_file

TagmeClientAdvanced.get\_dataset\_file(file\_id: str, organization\_id: str | None = None, ) → [DatasetFile](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-DatasetFile)

Get dataset file by file\_id (its id, name, url).

| Parameters | \* **file\_id** – dataset file id to get. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------- |
| Returns    | file from dataset.                                                                                                      |

### [](#%5Fget%5Fdataset%5Ffiles)get\_dataset\_files

TagmeClientAdvanced.get\_dataset\_files(dataset\_id: str, organization\_id: str | None = None, with\_authors: bool | None = None, ) → List\[[DatasetFile](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-DatasetFile)\]

Get files from dataset (their id, name, url).

| Parameters | \* **dataset\_id** – dataset id to get files from. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of files from dataset.                                                                                                      |

### [](#%5Fget%5Fdatasets)get\_datasets

TagmeClientAdvanced.get\_datasets(page: int | None = None, size: int | None = None, query: str | None = None, organization\_id: str | None = None, with\_authors: bool | None = None, ) → List\[[Dataset](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Dataset)\]

Get organization’s datasets.

| Parameters | \* **page** – page number for pagination. Defaults to None. \* **size** – page size for pagination. Defaults to None. \* **query** – text query for filtering datasets. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of information about datasets.                                                                                                                                                                                                                   |

### [](#%5Fget%5Forg%5Flora%5Fdataset)get\_org\_lora\_dataset

TagmeClientAdvanced.get\_org\_lora\_dataset(organization\_id: str | None = None, ) → [Dataset](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Dataset)

Get organization lora dataset.

| Parameters | **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------- |
| Returns    | information about organization lora dataset.                               |

### [](#%5Fremove%5Fdataset)remove\_dataset

TagmeClientAdvanced.remove\_dataset(dataset\_id: str, organization\_id: str | None = None, ) → None

Delete dataset.

| Parameters | \* **dataset\_id** – id of dataset to remove. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Freplace%5Fdataset%5Ffile)replace\_dataset\_file

TagmeClientAdvanced.replace\_dataset\_file(dataset\_id: str, file\_id: str, filepath: str | Path, organization\_id: str | None = None, ) → [UploadFilesResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult)

Replace file under existing uid and link.

| Parameters | \* **dataset\_id** – id of dataset to upload file to. \* **file\_id** – id of file to replace. \* **filepath** – path to new file. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | object which contains information about uploaded file and errors.                                                                                                                                                |

### [](#%5Fupdate%5Fdataset)update\_dataset

TagmeClientAdvanced.update\_dataset(dataset\_id: str, name: str, access: str = 'organization', data\_classification\_level: str | None = None, data\_source: str | None = None, organization\_id: str | None = None, acl: List\[str\] | None = None, ) → [Dataset](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Dataset)

Update dataset information.

| Parameters | \* **dataset\_id** – dataset id to update. \* **name** – name of new dataset. \* **data\_classification\_level** – data classification level (‘K2’, ‘K3’). \* **data\_source** – data source. \* **organization\_id** – optional organization identifier. Defaults to None. \* **access** – access level. \* **acl** – access control list. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | information about updated dataset.                                                                                                                                                                                                                                                                                                          |

### [](#%5Fupload%5Fdataset%5Ffiles)upload\_dataset\_files

TagmeClientAdvanced.upload\_dataset\_files(dataset\_id: str, filepaths: Sequence\[str | Path\], batch\_size: int = 16, organization\_id: str | None = None, tqdm\_on: str | bool = False, ) → [UploadFilesResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult)

Upload selected files to dataset.

| Parameters | \* **dataset\_id** – id of dataset to upload files to. \* **filepaths** – list of paths to files to upload. \* **batch\_size** – size of batch used during uploading. Defaults to 16. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | object which contains information about uploaded files and errors.                                                                                                                                                                                                  |

### [](#%5Fupload%5Ffolder%5Fto%5Fdataset)upload\_folder\_to\_dataset

TagmeClientAdvanced.upload\_folder\_to\_dataset(dataset\_id: str, folder: str | Path, exclude\_ext\_filter: Set\[str\] | None = None, organization\_id: str | None = None, ) → [UploadFilesResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult)

Upload files from folder to dataset.

| Parameters | \* **dataset\_id** – id of dataset to upload files to. \* **folder** – path to folder with files to upload. \* **exclude\_ext\_filter** – set of file extensions to exclude. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | object which contains information about uploaded files and errors.                                                                                                                                                                                         |

undefined
====================
## [](#%5Femployees)Employees

### [](#%5Fadd%5Femployee%5Fto%5Forganization)add\_employee\_to\_organization

TagmeClientAdvanced.add\_employee\_to\_organization(person\_id: str, roles: List\[str\] = None, organization\_id: str | None = None, ) → [Employee](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Employee)

Add new employee to organization.

| Parameters  | \* **person\_id** – person id to add to organization. \* **roles** – roles to add to person (CUSTOMER, ORGANIZATION\_ADMIN). If set to None or \[\], person will be added as marker. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns     | employee information.                                                                                                                                                                                                                                              |
| Return type | [Employee](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Employee)                                                                                                                                                                                            |

### [](#%5Fget%5Femployee)get\_employee

TagmeClientAdvanced.get\_employee(user\_id: str, organization\_id: str | None = None, ) → [Employee](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Employee)

Get information about organization’s employee.

| Parameters  | \* **user\_id** – user id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ----------- | -------------------------------------------------------------------------------------------------------- |
| Returns     | employee information.                                                                                    |
| Return type | [Employee](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Employee)                                  |

### [](#%5Fget%5Femployee%5Finfo)get\_employee\_info

TagmeClientAdvanced.get\_employee\_info(employee\_id: str, with\_pools: bool | None = None, with\_info: bool | None = None, organization\_id: str | None = None, ) → [Employee](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Employee)

Get full information about employee.

| Parameters | \* **employee\_id** – employee id. \* **with\_pools** – If set to True, load employee’s pools. Defaults to None. \* **with\_info** – if set to true, load personal info. Defaults to None. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | full information about employee.                                                                                                                                                                                                                                         |

### [](#%5Fget%5Femployees)get\_employees

TagmeClientAdvanced.get\_employees(query: str | None = None, person\_ids: List\[str\] | None = None, with\_pools: bool | None = None, with\_info: bool | None = None, organization\_id: str | None = None, page: int | None = None, size: int | None = None, active: bool | None = None, roles: List\[str\] | None = None, ) → List\[[Employee](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Employee)\]

Get information about employees.

| Parameters | \* **query** – search query. Defaults to None. \* **person\_ids** – person ids. Defaults to None. \* **with\_pools** – If set to True, load employee’s pools. Defaults to None. \* **with\_info** – If set to True, load personal info. Defaults to None. \* **organization\_id** – optional organization identifier. Defaults to None. \* **page** – page number for pagination. Defaults to None. \* **size** – page size for pagination. Defaults to None. \* **active** – If set to True, get only active employees. Defaults to None. \* **roles** – filter by roles (CUSTOMER or ORGANIZATION\_ADMIN). Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | list of employees.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

### [](#%5Fget%5Fmarker%5Finfo)get\_marker\_info

TagmeClientAdvanced.get\_marker\_info(marker\_id: str, with\_pools: bool, with\_info: bool, organization\_id: str | None = None, ) → [Employee](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Employee)

Get full information about organization employee.

| Parameters | \* **marker\_id** – marker id. \* **with\_pools** – if set, return information about marker pools. \* **with\_info** – if set, return person info about marker. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | full information about marker.                                                                                                                                                                                                                |

### [](#%5Fget%5Fuser%5Fconfig)get\_user\_config

TagmeClientAdvanced.get\_user\_config(user\_id: str, organization\_id: str | None = None, ) → Dict\[str, Any\]

Get employee config.

| Parameters | \* **user\_id** – user id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |
| Returns    | employee config.                                                                                         |

### [](#%5Fget%5Fuser%5Finfo)get\_user\_info

TagmeClientAdvanced.get\_user\_info(user\_id: str, organization\_id: str | None = None, ) → [Employee](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Employee)

Get information about employee.

| Parameters | \* **user\_id** – user id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |
| Returns    | information about employee.                                                                              |

### [](#%5Fget%5Fuser%5Fprofile)get\_user\_profile

TagmeClientAdvanced.get\_user\_profile(user\_id: str, organization\_id: str | None = None, ) → Dict\[str, Any\]

Get user profile.

| Parameters | \* **user\_id** – user id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |
| Returns    | user profile.                                                                                            |

### [](#%5Fget%5Fuser%5Freport)get\_user\_report

TagmeClientAdvanced.get\_user\_report(user\_id: str, organization\_id: str | None = None, ) → Dict\[str, Any\]

Get user report

| Parameters | \* **user\_id** – user id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |
| Returns    | user report.                                                                                             |

### [](#%5Fget%5Fuser%5Froles)get\_user\_roles

TagmeClientAdvanced.get\_user\_roles(user\_id: str, organization\_id: str, ) → List\[str\] | None

Get user roles.

| Parameters | \* **user\_id** – user id. \* **organization\_id** – organization identifier. |
| ---------- | ----------------------------------------------------------------------------- |
| Returns    | list user roles or None. None or empty list stands for marker role.           |

### [](#%5Fset%5Fuser%5Fconfig)set\_user\_config

TagmeClientAdvanced.set\_user\_config(user\_id: str, config: Dict\[str, Any\], organization\_id: str | None = None, ) → None

Set employee config.

| Parameters | \* **user\_id** – user id. \* **config** – employee config. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fset%5Fuser%5Fprofile)set\_user\_profile

TagmeClientAdvanced.set\_user\_profile(user\_id: str, profile: Dict\[str, Any\], organization\_id: str | None = None, ) → None

Set user profile.

| Parameters | \* **user\_id** – user id. \* **profile** – user profile. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fset%5Fuser%5Freport)set\_user\_report

TagmeClientAdvanced.set\_user\_report(user\_id: str, report: Dict\[str, Any\], organization\_id: str | None = None, ) → None

Set user report.

| Parameters | \* **user\_id** – user id. \* **report** – user report. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fset%5Fuser%5Froles)set\_user\_roles

TagmeClientAdvanced.set\_user\_roles(user\_id: str, roles: List\[str\] | None, organization\_id: str | None = None, ) → None

Set user roles.

| Parameters | \* **user\_id** – user id. \* **roles** – list of user roles. Available roles are: ‘CUSTOMER’, ‘ORGANIZATION\_ADMIN’, pass empty list to set marker role. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fupdate%5Fuser%5Fconfig)update\_user\_config

TagmeClientAdvanced.update\_user\_config(user\_id: str, config: Dict\[str, Any\], organization\_id: str | None = None, ) → None

Update employee config.

| Parameters | \* **user\_id** – user id. \* **config** – employee config. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fupdate%5Fuser%5Fprofile)update\_user\_profile

TagmeClientAdvanced.update\_user\_profile(user\_id: str, profile: Dict\[str, Any\], organization\_id: str | None = None, ) → None

Update user profile.

| Parameters | \* **user\_id** – user id. \* **profile** – user profile. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fupdate%5Fuser%5Freport)update\_user\_report

TagmeClientAdvanced.update\_user\_report(user\_id: str, report: Dict\[str, Any\], organization\_id: str | None = None, ) → None

Update user report.

Parameters

\* `**user_id**` – user id.

\* `**report**` ( `**Dict**` `**[**` `**str**` , \* `*Any` `**]**`) – user report. 

\* `**organization_id**` – optional organization identifier. Defaults to None.

undefined
====================
## [](#%5Ffiles)Files

### [](#%5Fclone%5Ftask%5Ffiles)clone\_task\_files

TagmeClientAdvanced.clone\_task\_files(src\_task\_id: str, dst\_task\_id: str, ignore\_files\_ids: Set\[str\], organization\_id: str | None = None, dst\_organization\_id: str | None = None, tqdm\_on: bool | str = False, ) → int

Clone task files from one task to another.

| Parameters | \* **src\_task\_id** – task id to clone files from. \* **dst\_task\_id** – task id to clone files to. \* **ignore\_files\_ids** – files ids to ignore while cloning. \* **organization\_id** – optional organization identifier. Defaults to None. \* **dst\_organization\_id** – optional organization id of destination task. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | number of files cloned successfully.                                                                                                                                                                                                                                                                                                              |

### [](#%5Fdelete%5Ffile)delete\_file

TagmeClientAdvanced.delete\_file(file\_id: str, organization\_id: str | None = None, ) → None

Delete file.

| Parameters | \* **file\_id** – id of file to delete. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fdelete%5Fitems%5Ffrom%5Ftask)delete\_items\_from\_task

TagmeClientAdvanced.delete\_items\_from\_task(task\_id: str, organization\_id: str | None = None, ) → [DeleteAllFilesrResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-DeleteAllFilesrResult)

Delete all files from tasks. (warning) May not work. Hope it will be fixed soon.

| Parameters | \* **task\_id** – task id to delete files from. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fdelete%5Fsome%5Fitems%5Ffrom%5Ftask)delete\_some\_items\_from\_task

TagmeClientAdvanced.delete\_some\_items\_from\_task(task\_id: str, files: List\[str\], organization\_id: str | None = None, ) → [DeleteSomeFilesResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-DeleteSomeFilesResult)

Delete selected task files from task.

| Parameters | \* **task\_id** – task\_id to delete files from. \* **files** – file ids to delete from task. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fdisable%5Fcontrol%5Ftask)disable\_control\_task

TagmeClientAdvanced.disable\_control\_task(task\_id: str, file\_uid: str, organization\_id: str | None = None, ) → None

Disable control task.

| Parameters | \* **task\_id** – task id. \* **file\_uid** – control task file uid to disable. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fdownload%5Ffile)download\_file

TagmeClientAdvanced.download\_file(task\_id: str, file\_id: str, organization\_id: str | None = None, ) → bytes

Download file by id.

| Parameters | \* **task\_id** – task id to download file from. \* **file\_id** – file id to download. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | file content.                                                                                                                                                         |

### [](#%5Fdownload%5Ftask%5Fdata)download\_task\_data

TagmeClientAdvanced.download\_task\_data(task\_id: str, destination\_dir: str | Path, organization\_id: str | None = None, ) → int

Download all files from task.

| Parameters | \* **task\_id** – task id to download files from. \* **destination\_dir** – path to directory to download files to. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | number of files downloaded successfully.                                                                                                                                                          |

### [](#%5Fget%5Ffile)get\_file

TagmeClientAdvanced.get\_file(task\_id: str, file\_uid: str, organization\_id: str | None = None, ) → [TaskFile](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskFile)

Get information about task file.

| Parameters | \* **task\_id** – task id. \* **file\_uid** – file uid to get information about. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | information about task file.                                                                                                                                   |

### [](#%5Fget%5Fmeta%5Fdata)get\_meta\_data

TagmeClientAdvanced.get\_meta\_data(task\_id: str, file\_uid: str, types: List\[[MetaType](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MetaType)\] | None = None, organization\_id: str | None = None, ) → [MetaData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MetaData)

Get controls, premarkup and explanation for task file.

| Parameters | \* **task\_id** – id of task to get meta data for file from. \* **file\_uid** – id of file to get meta data from. \* **types** – types of metadata ([MetaType](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MetaType)). Defaults to None. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | object which contains controls, premarkup and explanation.                                                                                                                                                                                                                                                                    |

### [](#%5Fget%5Ftask%5Ffiles)get\_task\_files

TagmeClientAdvanced.get\_task\_files(task\_id: str, query: str | None = None, types: List\[[FileType](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-FileType) | str\] | None = None, page: int | None = None, size: int | None = None, enabled: bool | None = True, organization\_id: str | None = None, ) → List\[[TaskFile](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskFile)\]

Get information about files in task.

| Parameters | \* **task\_id** – id of task. \* **query** – optional search query for file names. \* **types** – file types to get (CONTROL, STUDY, DATA) \* **page** – page number for pagination. \* **size** – number of items per page for pagination. \* **enabled** – optional flag to get only enabled files. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of task file objects.                                                                                                                                                                                                                                                                                                                                                          |

### [](#%5Fget%5Ftask%5Ffiles%5Fmeta)get\_task\_files\_meta

TagmeClientAdvanced.get\_task\_files\_meta(task\_id: str, organization\_id: str | None = None, ) → List\[[FileMetaData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-FileMetaData)\]

Get metadata for all files in task.

| Parameters | \* **task\_id** – task id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |
| Returns    | list of task files metadata.                                                                             |

### [](#%5Fremove%5Fcontrol)remove\_control

TagmeClientAdvanced.remove\_control(task: [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData), file\_id: str, force\_unassign: bool | None = False, ) → None

Remove control item from task.

| Parameters | \* **task** – task to remove control from. \* **file\_id** – id of control file to remove. \* **force\_unassign** – forcibly unassign all assignments |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Freplace%5Ffile)replace\_file

TagmeClientAdvanced.replace\_file(task\_id: str, file\_id: str, filepath: str | Path, organization\_id: str | None = None, ) → [UploadFilesResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult)

Replace file in task.

| Parameters | \* **task\_id** – task id to upload file to. \* **file\_id** – id of file to replace. \* **filepath** – path to new file. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | object which contains uploaded files and errors.                                                                                                                                                        |

### [](#%5Fupdate%5Fmeta%5Fdata)update\_meta\_data

TagmeClientAdvanced.update\_meta\_data(task\_id: str, data: List\[Dict\] | List\[[UpdateMetaDataRequest](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UpdateMetaDataRequest)\], organization\_id: str | None = None, ) → dict

Update information about controls, premarkup and explanation.

| Parameters | \* **task\_id** – task id to update meta data. \* **data** – data to update meta data. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | dict                                                                                                                                                                 |

### [](#%5Fupload%5Ffiles)upload\_files

TagmeClientAdvanced.upload\_files(task\_id: str, filepaths: Sequence\[str | Path\], batch\_size: int = 16, organization\_id: str | None = None, tqdm\_on: bool | str = False, preserve\_order: bool = False, wait\_until\_sdct\_done: bool = True, ) → [UploadFilesResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult)

Upload files to task.

| Parameters | \* **task\_id** – task id to upload files to. \* **filepaths** – paths to files to upload to task. \* **batch\_size** – number of files downloading at once. Defaults to 16. \* **organization\_id** – optional organization identifier. Defaults to None. \* **tqdm\_on** – if True, tqdm will be used to show progress of uploading. \* **preserve\_order** – if True, files will be uploaded in order. Defaults to False. \* **wait\_until\_sdct\_done** – if True, will wait until sdct done. Defaults to True. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | object which contains uploaded files and errors.                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |

### [](#%5Fupload%5Ffolder)upload\_folder

TagmeClientAdvanced.upload\_folder(task: [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData), folder: str | Path, organization\_id: str | None = None, tqdm\_on: bool | str = False, ) → [UploadFilesResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult)

Upload all files from folder to task.

| Parameters | \* **task** – task to upload files to. \* **folder** – folder with files to upload to task. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | uploaded files and errors.                                                                                                                                                |

### [](#%5Fupload%5Ffolder%5Fto%5Ftask)upload\_folder\_to\_task

TagmeClientAdvanced.upload\_folder\_to\_task(task\_id: str, folder: str | Path, exclude\_ext\_filter: Set\[str\] | None = None, organization\_id: str | None = None, tqdm\_on: bool | str = False, ) → [UploadFilesResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult)

Upload all files from folder to task.

| Parameters | \* **task\_id** – task id to upload files to. \* **folder** – path to folder to upload files from. \* **exclude\_ext\_filter** – file extensions to exclude. Defaults to None. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | object which contains uploaded files and errors.                                                                                                                                                                                                             |

### [](#%5Fupload%5Ffolders%5Fto%5Ftask)upload\_folders\_to\_task

TagmeClientAdvanced.upload\_folders\_to\_task(upload\_data: List\[Tuple\[str, str | Path\]\], exclude\_ext\_filter: Set\[str\] | None = None, start: bool = False, organization\_id: str | None = None, tqdm\_on: bool | str = False, ) → Dict\[str, None | bool | [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)\]

Upload many folders to many tasks.

Parameters

\* `**upload_data**` – pairs of task id and folder to upload.

\* `**exclude_ext_filter**` – file extensions to exclude. Defaults

\* `**start**` – start tasks after uploading. Defaults to False.

\* `**organization_id**` – optional organization identifier. Defaults to None.

Returns

object which contains uploaded files and errors.

\* key: - task\_id

\* value: None - if the folder for the task is empty 

 TaskData - if the task was started

 True - if the task didn’t need to be started 

 False - if the task was not started due to the problems with task constraints or an exception.

### [](#%5Fupload%5Ffolders%5Fto%5Ftask%5Fand%5Fstart)upload\_folders\_to\_task\_and\_start

TagmeClientAdvanced.upload\_folders\_to\_task\_and\_start(upload\_data: List\[Tuple\[str, str | Path\]\], exclude\_ext\_filter: Set\[str\] | None = None, organization\_id: str | None = None, tqdm\_on: bool | str = False, ) → Dict\[str, None | bool | [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)\]

Upload many folders to many tasks and start them.

Parameters

\* `**upload_data**` – pairs of task id and folder to upload.

\* `**exclude_ext_filter**` – file extensions to exclude. Defaults to None.

\* `**organization_id**` – optional organization identifier. Defaults to None.

Returns

object which contains uploaded files and errors.

\* key: - task\_id

\* value: None - if the folder for the task is empty 

 TaskData - if the task was started

 True - if the task didn’t need to be started 

 False - if the task was not started due to the problems with task constraints or an exception.

### [](#%5Fupload%5Fjson%5Fdata)upload\_json\_data

TagmeClientAdvanced.upload\_json\_data(task\_id: str, json\_data: Iterable\[dict\], base\_path: str | Path | None = None, organization\_id: str | None = None, tqdm\_on: bool | str = False, ) → None

Upload data in json format to task. Each json object can contain fields:

* ‘file\_path’: name of destination file (ends with .json).
* ‘file\_id’: name of destination file
* ‘task’: dict which contains input data for task. Can also contain field ‘id’ for name of destination file.
* ‘upload\_file’: file with input data for task.
* ‘premarkup’: premarkup for task.
* ‘control’: control for task.
* ‘hint’: explanation for task.

| Parameters | \* **task\_id** – id of task to upload data to. \* **json\_data** – data to upload. \* **base\_path** – path to folder with json files. Defaults to None. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fupload%5Fmethodics%5Ffile)upload\_methodics\_file

TagmeClientAdvanced.upload\_methodics\_file(method\_id: str, filepath: str | Path, file\_type: [MethodFileType](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MethodFileType), organization\_id: str | None = None, ) → [UploadFilesResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult)

Upload methodics file for method.

| Parameters | \* **method\_id** – id of method to upload file to. \* **filepath** – path to file to upload. \* **file\_type** – type of file to upload. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | uid and url of file.                                                                                                                                                                                                    |

### [](#%5Fupload%5Ftable)upload\_table

TagmeClientAdvanced.upload\_table(task\_id: str, file: Path, delimeter: str | None = None, quotechar: str | None = None, escapechar: str | None = None, organization\_id: str | None = None, ) → None

Upload task data table. See more information at <https://tagme.sberdevices.ru/docs/customer/uploading-data.html>

| Parameters | \* **task\_id** – task id to upload table to. \* **file** – path to table to upload (.csv,.tsv,.xlsx). \* **delimeter** – table delimiter. \* **quotechar** – table quotechar. \* **escapechar** – table escapechar. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fupload%5Ftsv%5Fdata)upload\_tsv\_data

TagmeClientAdvanced.upload\_tsv\_data(task\_id: str, filepath: str | Path, organization\_id: str | None = None, ) → None

Upload TSV data in toloka-format, INPUT:<input-fields> GOLDEN:<meta-fields> Read the doc: <https://tagme.sberdevices.ru/docs/customer/uploading-data.html>

| Parameters | \* **task\_id** – id of task to upload data to. \* **filepath** – path to TSV file. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |

undefined
====================
## [](#%5Finvites)Invites

### [](#%5Faccept%5Finvite)accept\_invite

TagmeClientAdvanced.accept\_invite(invite\_id: str, pools: List\[str\], organization\_id: str | None = None, ) → None

Approve request to join organization.

| Parameters | \* **invite\_id** – invite id to approve. \* **pools** – list of pools to add user to. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fapply%5Fpartner%5Finvite)apply\_partner\_invite

TagmeClientAdvanced.apply\_partner\_invite(invite\_name: str, partner\_id: str, utm\_referral: str | None = None, ) → None

Apply partner invite.

| Parameters | \* **invite\_name** – invite name. \* **partner\_id** – partner id. \* **utm\_referral** – utm referral. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fcancel%5Fvendor%5Fchange%5Frequest)cancel\_vendor\_change\_request

TagmeClientAdvanced.cancel\_vendor\_change\_request() → None

Cancel active vendor change request for current user.

| Returns | None. |
| ------- | ----- |

### [](#%5Fcreate%5Finvite)create\_invite

TagmeClientAdvanced.create\_invite(data: [InviteRequest](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InviteRequest), ) → [InviteData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InviteData)

Create new invite to organization.

| Parameters | **data** – invite request data. |
| ---------- | ------------------------------- |
| Returns    | created invite data.            |

### [](#%5Fcreate%5Finvite%5Frequest)create\_invite\_request

TagmeClientAdvanced.create\_invite\_request(invite\_id: str, organization\_id: str | None = None, ) → [InviteApplication](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InviteApplication)

Create request to join organization.

| Parameters | \* **invite\_id** – invite id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------ |
| Returns    | invite request data.                                                                                         |

### [](#%5Fdelete%5Finvite)delete\_invite

TagmeClientAdvanced.delete\_invite(uid: str, organization\_id: str | None = None, ) → [InviteData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InviteData)

Delete invite.

| Parameters | \* **uid** – invite id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------- |
| Returns    | full information about deleted invite.                                                                |

### [](#%5Fget%5Factive%5Fvendor%5Fchange%5Frequest)get\_active\_vendor\_change\_request

TagmeClientAdvanced.get\_active\_vendor\_change\_request() → [VendorChangeRecord](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-VendorChangeRecord) | None

Get active vendor change request for current user.

| Returns | Active vendor change request record or None if not found. |
| ------- | --------------------------------------------------------- |

### [](#%5Fget%5Finvite)get\_invite

TagmeClientAdvanced.get\_invite(uid: str, organization\_id: str | None = None, ) → [InviteData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InviteData)

Get invite by its id.

| Parameters | \* **uid** – invite id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------- |
| Returns    | full information about invite.                                                                        |

### [](#%5Fget%5Finvites)get\_invites

TagmeClientAdvanced.get\_invites(active: bool = True, page: int | None = None, size: int | None = None, organization\_id: str | None = None, ) → List\[[InviteData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InviteData)\]

Get invites.

| Parameters | \* **active** – get only active invites. Defaults to True. \* **page** – page number for pagination. Defaults to None. \* **size** – page size for pagination. Defaults to None. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of invites.                                                                                                                                                                                                                                               |

### [](#%5Fget%5Finvites%5Fpending)get\_invites\_pending

TagmeClientAdvanced.get\_invites\_pending(organization\_id: str | None = None, invite\_name: str | None = None, state: str = 'NEW', ) → List\[[InviteApplication](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InviteApplication)\]

Get all the requests to join organization.

| Parameters | \* **organization\_id** – optional organization identifier. Defaults to None. \* **invite\_name** – filter by invite name. Defaults to None. \* **state** – filter by state. Defaults to ‘NEW’. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | all the requests to join organization.                                                                                                                                                          |

### [](#%5Fput%5Finvite)put\_invite

TagmeClientAdvanced.put\_invite(data: [InviteData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InviteData), ) → [InviteData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InviteData)

Add new invite to organization.

| Parameters | **data** – invite data to create it.   |
| ---------- | -------------------------------------- |
| Returns    | full information about created invite. |

undefined
====================
## [](#%5Fmarkers)Markers

### [](#%5Fget%5Fmarkup%5Ftask)get\_markup\_task

TagmeClientAdvanced.get\_markup\_task(task\_id: str, ) → [MarkupTask](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupTask)

Get current assignment to markup in task.

| Parameters | **task\_id** – task id. |
| ---------- | ----------------------- |
| Returns    | markup task.            |

### [](#%5Fget%5Ftasks%5Ffor%5Fmarkup)get\_tasks\_for\_markup

TagmeClientAdvanced.get\_tasks\_for\_markup(page: int | None = None, size: int | None = None, query: str | None = None, ) → List\[[TaskflowTaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskflowTaskData)\]

Get all task available for markup.

| Parameters | \* **page** – optional page number for pagination. Defaults to None. \* **size** – optional page size for pagination. Defaults to None. \* **query** – optional search query. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of tasks for markup.                                                                                                                                                                       |

### [](#%5Fskip%5Fmarkup%5Ftask)skip\_markup\_task

TagmeClientAdvanced.skip\_markup\_task(task\_id: str, assignment\_id: str, ) → None

Skip markup task,

| Parameters | \* **task\_id** – task id to skip. \* **assignment\_id** – assignment id to skip. |
| ---------- | --------------------------------------------------------------------------------- |

### [](#%5Fsubmit%5Fmarkup%5Ftask)submit\_markup\_task

TagmeClientAdvanced.submit\_markup\_task(task\_id: str, assignment\_id: str, markup\_result: Dict\[str, Any\], ) → None

Submit markup task.

| Parameters | \* **task\_id** – task id to submit. \* **assignment\_id** – assignment id to submit. \* **markup\_result** – result of markup. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------- |

undefined
====================
## [](#%5Forganization)Organization

### [](#%5Fget%5Fcurrent%5Forganization%5Fid)get\_current\_organization\_id

TagmeClientAdvanced.get\_current\_organization\_id() → str

Get organization id which is currently used by client.

| Returns | current organization id. |
| ------- | ------------------------ |

### [](#%5Fget%5Ffull%5Forganization)get\_full\_organization

TagmeClientAdvanced.get\_full\_organization(organization\_id: str, with\_employees: bool | None = None, ) → [FullOrganization](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-FullOrganization)

Get information about organization by id.

| Parameters | \* **organization\_id** – organization identifier. \* **with\_employees** – include information about employees. |
| ---------- | ---------------------------------------------------------------------------------------------------------------- |
| Returns    | information about organization.                                                                                  |

### [](#%5Fget%5Ffull%5Forganizations)get\_full\_organizations

TagmeClientAdvanced.get\_full\_organizations(query: str | None = None, page: int | None = None, size: int | None = None, org\_ids: List\[str\] | None = None, ignore\_org: bool | None = None, ) → List\[[FullOrganization](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-FullOrganization)\]

Get information about organizations.

| Parameters | \* **query** – search query to filter organizations. \* **page** – page number for pagination. Defaults to None. \* **size** – page size for pagination. Defaults to None. \* **org\_ids** – list of organization IDs to filter organizations. Defaults to None. \* **ignore\_org** – whether to ignore organizations. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of organizations.                                                                                                                                                                                                                                                                                                                   |

### [](#%5Fget%5Forganization)get\_organization

TagmeClientAdvanced.get\_organization(org\_key: str | None = None, ) → [Organization](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Organization)

Get organization by id or name. If organization\_id is None, get current organization.

| Parameters | **org\_key** – id or name of organization.  |
| ---------- | ------------------------------------------- |
| Returns    | organization found or current organization. |

### [](#%5Fget%5Forganizations)get\_organizations

TagmeClientAdvanced.get\_organizations() → List\[[Organization](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Organization)\]

Get available organizations.

| Returns | list of organizations. |
| ------- | ---------------------- |

### [](#%5Fset%5Forganization)set\_organization

TagmeClientAdvanced.set\_organization(org\_key: str | None, ) → None

Set current organization which is used by client.

| Parameters | **org\_key** – organization id or name. If set to None, sets first organization which was found. |
| ---------- | ------------------------------------------------------------------------------------------------ |

### [](#%5Fupdate%5Forganization)update\_organization

TagmeClientAdvanced.update\_organization(organization\_id: str, name: str | None = None, config: [OrganizationConfig](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-OrganizationConfig) | None = None, contacts: str | None = None, ) → [FullOrganization](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-FullOrganization)

Update organization info.

| Parameters | \* **organization\_id** – organization identifier. \* **name** – new organization name. \* **config** – new organization config. \* **contacts** – new organization contacts. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | new organization info.                                                                                                                                                        |

undefined
====================
## [](#%5Fother)Other

### [](#%5Fget%5Fbad%5Fcontrol%5Fitems)get\_bad\_control\_items

TagmeClientAdvanced.get\_bad\_control\_items(task: [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData), rate\_threshold: float = 0.5, count\_threshold: int | None = None, organization\_id: str | None = None, ) → List\[Dict\[str, Any\]\]

Get control items with low good answers ratio.

| Parameters | \* **task** – task to get bad control items from. \* **rate\_threshold** – lowest accepted rate of good answers. Defaults to 0.5. \* **count\_threshold** – lowest accepted number of of good answers. Defaults to None. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | rows which contain bad control tasks info.                                                                                                                                                                                                                                                             |

undefined
====================
## [](#%5Fpersons)Persons

### [](#%5Fget%5Fperson)get\_person

TagmeClientAdvanced.get\_person(person\_id: str | None = None, organization\_id: str | None = None, email: str | None = None, with\_organizations: bool | None = None, ) → [Person](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Person)

Get person by id or email.

| Parameters | \* **person\_id** – person id. Cannot be passed together with email. Defaults to None. \* **organization\_id** – optional organization identifier. Defaults to None. \* **email** – person email. Cannot be passed together with person\_id. Defaults to None. \* **with\_organizations** – include info about organizations. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | information about user.                                                                                                                                                                                                                                                                                                                         |

### [](#%5Fget%5Fpersons)get\_persons

TagmeClientAdvanced.get\_persons(page: int | None = None, size: int | None = None, query: str | None = None, emails: List\[str\] | None = None, with\_organizations: bool | None = None, organization\_id: str | None = None, person\_ids: List\[str\] | None = None, only\_active: bool | None = None, ) → List\[[Person](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Person)\]

Get users list.

| Parameters | \* **page** – page number for pagination. Defaults to None. \* **size** – page size for pagination. Defaults to None. \* **query** – search query. Defaults to None. \* **emails** – list of emails to search. Defaults to None. \* **with\_organizations** – include info about organizations. Defaults to None. \* **organization\_id** – optional organization identifier. Defaults to None. \* **person\_ids** – list of person ids to search. Defaults to None. \* **only\_active** – whether to include only active users. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of users.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

### [](#%5Fget%5Fself%5Fperson)get\_self\_person

TagmeClientAdvanced.get\_self\_person(with\_organizations: bool = False, ) → [Person](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Person)

Get information about your user.

| Parameters | **with\_organizations** – include available organizations. Defaults to False. |
| ---------- | ----------------------------------------------------------------------------- |
| Returns    | your user information.                                                        |

undefined
====================
## [](#%5Fplugins)Plugins

### [](#%5Fadd%5Fplugin)add\_plugin

TagmeClientAdvanced.add\_plugin(user\_id: str, plugin: [Plugin](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Plugin), organization\_id: str | None = None, ) → None

Add new plugin to user. If it has same route as another plugin, it would be replaced.

| Parameters | \* **user\_id** – user id. \* **plugin** – plugin data. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fcheck%5Fplugin%5Ftemplate)check\_plugin\_template

TagmeClientAdvanced.check\_plugin\_template(plugin\_template\_id: str, organization\_id: str | None = None, ) → [CheckPluginTemplateResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckPluginTemplateResult)

Check if plugin template is ready for publishing.

| Parameters | \* **plugin\_template\_id** – plugin template id to check. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- |

Results

object with check status.

### [](#%5Fcreate%5Forganization%5Fplugin)create\_organization\_plugin

TagmeClientAdvanced.create\_organization\_plugin(plugin\_template\_id: str, roles: List\[Literal\['MARKER', 'CUSTOMER', 'ORGANIZATION\_ADMIN'\]\], route: str, enabled: bool = True, organization\_id: str | None = None, ) → [PluginAssignment](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PluginAssignment)

Install plugin template for organization.

| Parameters | \* **plugin\_template\_id** – plugin template id to install. \* **roles** – roles which will see plugin. \* **route** – route for plugin. \* **enabled** – enable/disable plugin. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | info about installed plugin.                                                                                                                                                                                                                                    |

### [](#%5Fcreate%5Fplugin%5Ftemplate)create\_plugin\_template

TagmeClientAdvanced.create\_plugin\_template(name: str, description: str | None = None, documentation: str | None = None, contacts: str | None = None, access: Literal\['public', 'organization', 'private'\] = 'private', title: str | None = None, config: dict | None = None, acl: List\[str\] | None = None, scope: Literal\['SIDEBAR'\] = 'SIDEBAR', roles: List\[Literal\['MARKER', 'CUSTOMER', 'ORGANIZATION\_ADMIN'\]\] | None = None, organization\_id: str | None = None, ) → [PluginTemplate](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PluginTemplate)

Create plugin template.

| Parameters | \* **name** – plugin name. \* **description** – plugin description. \* **documentation** – plugin documentation. \* **contacts** – plugin owner’s contacts. \* **access** – access. \* **title** – title to show in sidebar. \* **config** – plugin configuration. \* **acl** – organizations to share template with (if access is organization). \* **scope** – scope of plugin (now only SIDEBAR). \* **roles** – available roles. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | created plugin template.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

### [](#%5Fdelete%5Forganization%5Fplugin)delete\_organization\_plugin

TagmeClientAdvanced.delete\_organization\_plugin(plugin\_assignment\_id: str, organization\_id: str | None = None, ) → None

Uninstall plugin from organization.

| Parameters | \* **plugin\_assignment\_id** – plugin assignment id to delete. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fdelete%5Fplugin%5Ftemplate)delete\_plugin\_template

TagmeClientAdvanced.delete\_plugin\_template(plugin\_template\_id: str, organization\_id: str | None = None, ) → None

Delete plugin template.

| Parameters | \* **plugin\_template\_id** – plugin template id to delete \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fget%5Fmy%5Fplugins)get\_my\_plugins

TagmeClientAdvanced.get\_my\_plugins(scope: Literal\['MARKER\_SIDEBAR', 'ORGANIZATION\_SIDEBAR'\] = 'MARKER\_SIDEBAR', disable\_cache: bool = False, organization\_id: str | None = None, ) → List\[[UserPlugin](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UserPlugin)\]

Get current user plugins.

| Parameters | **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------- |
| Returns    | short info about plugins available for current user.                       |

### [](#%5Fget%5Forganization%5Fplugins)get\_organization\_plugins

TagmeClientAdvanced.get\_organization\_plugins(page: int | None = None, size: int | None = None, query: str | None = None, organization\_id: str | None = None, ) → List\[[InstalledPlugin](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InstalledPlugin)\]

Get plugins installed for current organization.

| Parameters | \* **page** – page number for pagination. \* **size** – number of items per page for pagination. \* **query** – optional search query for plugin names. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | plugins installed for current organization.                                                                                                                                                                                           |

### [](#%5Fget%5Fplugin%5Ftemplate)get\_plugin\_template

TagmeClientAdvanced.get\_plugin\_template(plugin\_template\_id: str, organization\_id: str | None = None, ) → [PluginTemplate](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PluginTemplate)

Get plugin template.

| Parameters | \* **plugin\_template\_id** – plugin template id to get \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | plugin template info.                                                                                                                 |

### [](#%5Fget%5Fplugin%5Ftemplate%5Finstallations)get\_plugin\_template\_installations

TagmeClientAdvanced.get\_plugin\_template\_installations(plugin\_template\_id: str, organization\_id: str | None = None, ) → List\[[PluginInstallation](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PluginInstallation)\]

Get organizations where plugin is installed.

| Parameters | \* **plugin\_template\_id** – plugin template id to get installations. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | organizations info where plugin is installed.                                                                                                        |

### [](#%5Fget%5Fplugin%5Ftemplates)get\_plugin\_templates

TagmeClientAdvanced.get\_plugin\_templates(page: int | None = None, size: int | None = None, query: str | None = None, organization\_id: str | None = None, ) → List\[[PluginTemplate](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PluginTemplate)\]

Get plugin templates created by current organization’s users.

| Parameters | \* **page** – page number for pagination. \* **size** – number of items per page for pagination. \* **query** – optional search query for file names. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of plugin templates.                                                                                                                                                                                                           |

### [](#%5Fget%5Fpublished%5Fplugin%5Ftemplates)get\_published\_plugin\_templates

TagmeClientAdvanced.get\_published\_plugin\_templates(page: int | None = None, size: int | None = None, query: str | None = None, organization\_id: str | None = None, ) → List\[[PluginTemplate](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PluginTemplate)\]

Get plugin templates available to install for current organization.

| Parameters | \* **page** – page number for pagination. \* **size** – number of items per page for pagination. \* **query** – optional search query for file names. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of plugin templates.                                                                                                                                                                                                           |

### [](#%5Fpublish%5Fplugin%5Ftemplate)publish\_plugin\_template

TagmeClientAdvanced.publish\_plugin\_template(plugin\_template\_id: str, organization\_id: str | None = None, ) → None

Publish plugin template.

| Parameters | \* **plugin\_template\_id** – plugin template id to publish. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |

### [](#%5Fremove%5Fplugin)remove\_plugin

TagmeClientAdvanced.remove\_plugin(user\_id: str, route: str, plugin\_type: [PluginTypes](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PluginTypes), organization\_id: str | None = None, ) → None

Remove plugin from user by its route.

| Parameters | \* **user\_id** – user id. \* **route** – route of plugin to remove. \* **plugin\_type** – plugin type (CUSTOMER or MARKER). \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Funpublish%5Fplugin%5Ftemplate)unpublish\_plugin\_template

TagmeClientAdvanced.unpublish\_plugin\_template(plugin\_template\_id: str, organization\_id: str | None = None, ) → None

Unpublish plugin template.

| Parameters | \* **plugin\_template\_id** – plugin template id to unpublish. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fupdate%5Forganization%5Fplugin)update\_organization\_plugin

TagmeClientAdvanced.update\_organization\_plugin(plugin\_assignment\_id: str, enabled: bool | None = False, roles: List\[Literal\['MARKER', 'CUSTOMER', 'ORGANIZATION\_ADMIN'\]\] | None = None, route: str | None = None, organization\_id: str | None = None, ) → [PluginAssignment](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PluginAssignment)

Update installed plugin.

| Parameters | \* **plugin\_assignment\_id** – plugin assignment id to update. \* **enabled** – enable/disable plugin. \* **roles** – roles which will see plugin. \* **route** – route for plugin. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | info about installed plugin.                                                                                                                                                                                                                                       |

### [](#%5Fupdate%5Fplugin%5Ftemplate)update\_plugin\_template

TagmeClientAdvanced.update\_plugin\_template(plugin\_template\_id: str, name: str | None = None, description: str | None = None, documentation: str | None = None, contacts: str | None = None, access: Literal\['public', 'organization', 'private'\] | None = None, title: str | None = None, config: dict | None = None, acl: List\[str\] | None = None, scope: Literal\['SIDEBAR'\] | None = None, roles: List\[Literal\['MARKER', 'CUSTOMER', 'ORGANIZATION\_ADMIN'\]\] | None = None, organization\_id: str | None = None, ) → [PluginTemplate](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PluginTemplate)

Update plugin template.

| Parameters | \* **plugin\_template\_id** – plugin template id to update \* **name** – plugin name \* **description** – plugin description \* **documentation** – plugin documentation \* **contacts** – plugin owner’s contacts \* **access** – access \* **title** – title to show in sidebar \* **config** – plugin configuration \* **acl** – organizations to share template with (if access is organization) \* **scope** – scope of plugin (now only SIDEBAR) \* **roles** – available roles \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | updated plugin template.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

### [](#%5Fupload%5Fplugin%5Ftemplate%5Ffile)upload\_plugin\_template\_file

TagmeClientAdvanced.upload\_plugin\_template\_file(plugin\_template\_id: str, file\_type: Literal\['icon', 'preview', 'bundle'\], file\_path: str, organization\_id: str | None = None, ) → [PluginTemplateFileResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PluginTemplateFileResult)

Upload file to plugin template.

| Parameters | \* **plugin\_template\_id** – plugin template id to upload file to. \* **file\_type** – type of file to upload. \* **file\_path** – path to file to upload. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | info about uploaded file.                                                                                                                                                                                                                 |

undefined
====================
## [](#%5Fpools)Pools

### [](#%5Fadd%5Fmarker)add\_marker

TagmeClientAdvanced.add\_marker(marker\_email: str, pools: List\[str\], organization\_id: str | None = None, ) → [ErrorMarkersResponse](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ErrorMarkersResponse)

Add marker to pools.

| Parameters | \* **marker\_email** – marker email. \* **pools** – pools to add marker to. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | object with errors while adding marker to pools.                                                                                                          |

### [](#%5Fadd%5Fmarkers)add\_markers

TagmeClientAdvanced.add\_markers(emails: List\[str\], pools: List\[str\], organization\_id: str | None = None, ) → [ErrorMarkersResponse](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ErrorMarkersResponse)

Add markers to pools.

| Parameters | \* **emails** – emails of markers. \* **pools** – pools to add markers to. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | object with errors while adding markers to pools.                                                                                                        |

### [](#%5Fadd%5Fpools)add\_pools

TagmeClientAdvanced.add\_pools(project\_id: str, pools: Sequence\[str\], organization\_id: str | None = None, ) → None

Add pools of users to project.

| Parameters | \* **project\_id** – project id to add pools to \* **pools** – pools ids to add to project \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

### [](#%5Fattach%5Fuser%5Fto%5Fpool)attach\_user\_to\_pool

TagmeClientAdvanced.attach\_user\_to\_pool(pool\_id: str, user\_id: str, organization\_id: str | None = None, ) → bool

Add user to pool.

| Parameters | \* **pool\_id** – pool id to add user to. \* **user\_id** – user id to add to pool. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | True if user was successfully added to pool, False otherwise.                                                                                                     |

### [](#%5Fclone%5Fpool)clone\_pool

TagmeClientAdvanced.clone\_pool(pool\_id: str, organization\_id: str | None = None, dst\_organization\_id: str | None = None, ) → [Pool](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Pool)

Clone pool with members.

| Parameters | \* **pool\_id** – pool id to clone. \* **organization\_id** – optional organization identifier. Defaults to None. \* **dst\_organization\_id** – optional organization id to clone pool to. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | created pool.                                                                                                                                                                                                 |

### [](#%5Fcreate%5Fpool)create\_pool

TagmeClientAdvanced.create\_pool(markers: List\[str\], name: str, organization\_id: str | None = None, access: Literal\['public', 'organization', 'private'\] | None = None, acl: List\[str\] | None = None, group\_type: Literal\['MARKERS', 'VALIDATORS'\] | None = None, ) → [Pool](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Pool)

Create new pool. Access levels:

* public: pool can be added to project in any organization.
* organization: pool can be added only to project in the same organization or organization in acl.
* private (or None): pool can be added only to project in the same organization.

| Parameters | \* **markers** – list of users ids to add to new pool. \* **name** – new pool name. \* **organization\_id** – optional organization identifier. Defaults to None. \* **access** – pool access level. Defaults to None. \* **acl** – list of allowed organizations ids for ‘organization’ access. Defaults to None. \* **group\_type** – type of pool (MARKERS or VALIDATORS). Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | information about newly created pool.                                                                                                                                                                                                                                                                                                                                                           |

### [](#%5Fdelete%5Fpool)delete\_pool

TagmeClientAdvanced.delete\_pool(pool\_id: str, organization\_id: str | None = None, ) → None

Delete pool.

| Parameters | \* **pool\_id** – pool id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |

### [](#%5Fdetach%5Fmarkers)detach\_markers

TagmeClientAdvanced.detach\_markers(pool\_id: str, uids: List\[str\], organization\_id: str | None = None, ) → [ErrorMarkersResponse](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ErrorMarkersResponse)

Remove users from pool.

| Parameters | \* **pool\_id** – pool id to remove users from. \* **uids** – list of users ids to remove from pool. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | object which contains information about errors while removing users from pool.                                                                                                     |

### [](#%5Fdetach%5Fuser%5Ffrom%5Fpool)detach\_user\_from\_pool

TagmeClientAdvanced.detach\_user\_from\_pool(pool\_id: str, user\_id: str, organization\_id: str | None = None, ) → bool

Remove user from pool.

| Parameters | \* **pool\_id** – pool id to remove user from. \* **user\_id** – user id to remove from pool. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | True if user was successfully removed from pool, False otherwise.                                                                                                           |

### [](#%5Fget%5Forganization%5Fpools)get\_organization\_pools

TagmeClientAdvanced.get\_organization\_pools(organization\_id: str | None = None, page: int | None = None, size: int | None = None, query: str | None = None, with\_shared\_pools: bool | None = None, ) → List\[[Pool](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Pool)\]

Get pool in selected organization.

| Parameters | \* **organization\_id** – optional organization identifier. Defaults to None. \* **page** – page number for pagination. Defaults to None. \* **size** – page size for pagination. Defaults to None. \* **query** – query to search by name or uid. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of pools.                                                                                                                                                                                                                                                       |

### [](#%5Fget%5Fpool)get\_pool

TagmeClientAdvanced.get\_pool(pool\_id: str, with\_markers: bool | None = None, organization\_id: str | None = None, ) → [Pool](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Pool)

Get information about pool by id.

| Parameters | \* **pool\_id** – pool id. \* **with\_markers** – if True, return list of users in pool. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | information about pool.                                                                                                                                                |

### [](#%5Fget%5Fpools)get\_pools

TagmeClientAdvanced.get\_pools(project\_id: str, organization\_id: str | None = None, ) → List\[str\]

Get pools added to project.

| Parameters | \* **project\_id** – project id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------- |
| Returns    | list of pools.                                                                                                 |

### [](#%5Fmove%5Fmarkers)move\_markers

TagmeClientAdvanced.move\_markers(pool\_id: str, target\_pool: str, uids: List\[str\], organization\_id: str | None = None, ) → [ErrorMarkersResponse](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ErrorMarkersResponse)

Move users from one pool to another.

| Parameters | \* **pool\_id** – pool id to move users from. \* **target\_pool** – pool id to move users to. \* **uids** – list of users ids to move from pool to target pool. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

Returns; object which contains information about errors while moving users from pool to target pool.

### [](#%5Fset%5Fmarker%5Fpriority)set\_marker\_priority

TagmeClientAdvanced.set\_marker\_priority(marker\_id: str, pool\_id: str, priority: int, organization\_id: str | None = None, ) → None

Set priority of marker in pool.

| Parameters | \* **marker\_id** – marker id to set priority. \* **pool\_id** – pool id to set priority. \* **priority** – priority to set. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fupdate%5Fpool)update\_pool

TagmeClientAdvanced.update\_pool(pool\_id: str, name: str, organization\_id: str | None = None, access: Literal\['public', 'organization', 'private'\] | None = None, acl: List\[str\] | None = None, ) → [Pool](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Pool)

Update pool name. Access levels:

* public: pool can be added to project in any organization.
* organization: pool can be added only to project in the same organization or organization in acl.
* private (or None): pool can be added only to project in the same organization.

| Parameters | \* **pool\_id** – pool id. \* **name** – new pool name. \* **organization\_id** – optional organization identifier. Defaults to None. \* **access** – pool access level. Defaults to None. \* **acl** – list of allowed organizations ids for ‘organization’ access. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | information about updated pool.                                                                                                                                                                                                                                                        |

undefined
====================
## [](#%5Fprojects)Projects

### [](#%5Fadd%5Fusers%5Fto%5Fproject)add\_users\_to\_project

TagmeClientAdvanced.add\_users\_to\_project(project\_id: str, pool\_id: str, organization\_id: str | None = None, ) → None

Add pool of users to project.

| Parameters | \* **project\_id** – project id to add pool to. \* **pool\_id** – pool id to add to project. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Farchive%5Fproject)archive\_project

TagmeClientAdvanced.archive\_project(project\_name: str, organization\_id: str | None = None, ) → None

(deprecated) Archive all projects with given name. Use ‘archive\_project\_by\_name’ instead.

| Parameters | \* **project\_name** – name of projects to archive. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Farchive%5Fproject%5Fby%5Fname)archive\_project\_by\_name

TagmeClientAdvanced.archive\_project\_by\_name(project\_name: str, organization\_id: str | None = None, raise\_when\_not\_found: bool = True, ) → None

Archive all projects with given name.

| Parameters | \* **project\_name** – name of projects to archive. \* **organization\_id** – optional organization identifier. Defaults to None. \* **raise\_when\_not\_found** – raise exception if no project with given name found. Defaults to True. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Farchive%5Fprojects)archive\_projects

TagmeClientAdvanced.archive\_projects(uids: List\[str\], organization\_id: str | None = None, ) → dict | None

Archive projects.

| Parameters | \* **uids** – list of project ids to archive. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------- |
| Returns    | empty dict.                                                                                                                 |

### [](#%5Fclone%5Fproject)clone\_project

TagmeClientAdvanced.clone\_project(project\_id: str, organization\_id: str | None = None, dst\_organization\_id: str | None = None, name\_suffix: str | None = None, clone\_task\_payloads: bool = False, ) → Tuple\[List\[Tuple\[[TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData), [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)\]\], [Project](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Project)\]

Clone project with all its tasks and users.

| Parameters | \* **project\_id** – project id to clone. \* **organization\_id** – optional organization identifier. Defaults to None. \* **dst\_organization\_id** – optional organization identifier to clone project to. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | list of pairs of old tasks and new tasks, new project.                                                                                                                                                                         |

### [](#%5Fclone%5Fproject%5Fwith%5Fdata)clone\_project\_with\_data

TagmeClientAdvanced.clone\_project\_with\_data(project\_id: str, organization\_id: str | None = None, dst\_organization\_id: str | None = None, clone\_all\_files: bool = False, clone\_task\_payloads: bool = False, ) → str

Clone project with all its tasks, pools and datasets.

| Parameters | \* **project\_id** – project id to clone. \* **organization\_id** – optional organization identifier. Defaults to None. \* **dst\_organization\_id** – optional organization id of destination project. Defaults to None. \* **clone\_all\_files** – clone files which are already marked. Defaults to False. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | id of cloned project.                                                                                                                                                                                                                                                                                         |

### [](#%5Fcreate%5Fcross%5Fproject%5Fvalidation%5Fpipeline)create\_cross\_project\_validation\_pipeline

TagmeClientAdvanced.create\_cross\_project\_validation\_pipeline(config: PipelineInitialConfig, organization\_id: str | None = None, ) → None

Create validation pipeline between two different projects.

| Parameters | \* **config** – Configuration for the validation pipeline. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fcreate%5Fproject)create\_project

TagmeClientAdvanced.create\_project(name: str, description: str | None = None, organization\_id: str | None = None, inner\_comment: str | None = None, template\_id: str | None = None, is\_brief\_autoupdate: bool | None = None, is\_forms\_autoupdate: bool | None = None, is\_config\_autoupdate: bool | None = None, is\_specification\_autoupdate: bool | None = None, ) → [Project](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Project)

Create new project.

| Parameters | \* **name** – name of new project. \* **description** – project’s description. \* **organization\_id** – optional organization identifier. Defaults to None. \* **inner\_comment** – inner comment for customers. Defaults to None. \* **template\_id** – template id for project. Defaults to None. \* **is\_brief\_autoupdate** – whether to enable brief autoupdate. Defaults to None. \* **is\_forms\_autoupdate** – whether to enable forms autoupdate. Defaults to None. \* **is\_config\_autoupdate** – whether to enable config autoupdate. Defaults to None. \* **is\_specification\_autoupdate** – whether to enable specification autoupdate. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | created project.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

### [](#%5Fcreate%5Fproject%5Fbookmark)create\_project\_bookmark

TagmeClientAdvanced.create\_project\_bookmark(project\_id: str, organization\_id: str | None = None, ) → None

Add project to bookmarks.

| Parameters | \* **project\_id** – project id to add bookmark. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------ |

### [](#%5Fcreate%5Fproject%5Fby%5Fconfig)create\_project\_by\_config

TagmeClientAdvanced.create\_project\_by\_config(config: ProjectConfig, organization\_id: str | None = None, ) → str

Create new project.

| Parameters | \* **config** – full project data. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------- |
| Returns    | created project id.                                                                                              |

### [](#%5Fcreate%5Fsingle%5Fproject%5Fvalidation%5Fpipeline)create\_single\_project\_validation\_pipeline

TagmeClientAdvanced.create\_single\_project\_validation\_pipeline(config: PipelineInitialConfig, organization\_id: str | None = None, ) → None

Create validation pipeline within a single project. The source and destination project IDs in the config must be the same.

| Parameters | \* **config** – Configuration for the validation pipeline. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fcreate%5Fvalidation%5Fpipeline)create\_validation\_pipeline

TagmeClientAdvanced.create\_validation\_pipeline(config: PipelineInitialConfig, organization\_id: str | None = None, ) → None

Create validation pipeline. This method acts as a dispatcher, calling either create\_cross\_project\_validation\_pipeline or create\_single\_project\_validation\_pipeline based on the provided config.

| Parameters | \* **config** – Configuration for the validation pipeline. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fdelete%5Fproject%5Fbookmark)delete\_project\_bookmark

TagmeClientAdvanced.delete\_project\_bookmark(project\_id: str, organization\_id: str | None = None, ) → None

Remove project from bookmarks.

| Parameters | \* **project\_id** – project id to remove bookmark. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fdelete%5Fusers%5Ffrom%5Fproject)delete\_users\_from\_project

TagmeClientAdvanced.delete\_users\_from\_project(project\_id: str, pool\_id: str, organization\_id: str | None = None, ) → None

Delete pool of users from project.

| Parameters | \* **project\_id** – project id to delete pool from. \* **pool\_id** – pool id to delete from project. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

### [](#%5Fdownload%5Fbrief%5Fversion%5Ffile)download\_brief\_version\_file

TagmeClientAdvanced.download\_brief\_version\_file(method\_id: str, version: str | int = 'latest', date\_time: datetime | None = None, ) → str

Download certait brief version by its number or date.

| Parameters | \* **method\_id** – uid of method, brief belongs to \* **version** – number of brief version or ‘latest’ \* **date\_time** – datetime when version was used |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | file of certain brief version                                                                                                                               |

### [](#%5Fdownload%5Finterface%5Fversion)download\_interface\_version

TagmeClientAdvanced.download\_interface\_version(method\_id: str, version: str | int = 'latest', date\_time: datetime | None = None, task\_id: str | None = None, ) → [InterfaceVersionInfo](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InterfaceVersionInfo)

Download certait interface version by its number or date.

| Parameters | \* **method\_id** – uid of method, interface belongs to \* **version** – number of interface version or ‘latest’ \* **date\_time** – datetime when version was used \* **task\_id** – id of task to get entities from |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | data of certain interface version                                                                                                                                                                                     |

### [](#%5Fget%5Fbrief%5Fread%5Fstatus)get\_brief\_read\_status

TagmeClientAdvanced.get\_brief\_read\_status(method\_id: str, organization\_id: str | None = None, ) → [BriefReadStatusData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-BriefReadStatusData)

Get methodic brief read status by id.

| Parameters | \* **method\_id** – method id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------ |
| Returns    | information about methodic brief read status.                                                                |

### [](#%5Fget%5Fbrief%5Fversion%5Finfo)get\_brief\_version\_info

TagmeClientAdvanced.get\_brief\_version\_info(method\_id: str, version: str | int = 'latest', date\_time: datetime | None = None, with\_person\_info: bool = False, ) → Tuple\[[BriefVersionInfo](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-BriefVersionInfo), dict\]

Get certait brief version by its number or date.

| Parameters | \* **method\_id** – uid of method, brief belongs to \* **version** – number of brief version or ‘latest’ \* **date\_time** – datetime when version was used \* **with\_person\_info** – return personal information of version’s author |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | information about brief version with response headers                                                                                                                                                                                   |

### [](#%5Fget%5Finterface%5Fversion%5Finfo)get\_interface\_version\_info

TagmeClientAdvanced.get\_interface\_version\_info(method\_id: str, version: str | int = 'latest', date\_time: datetime | None = None, with\_person\_info: bool | None = None, ) → [InterfaceVersionInfo](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InterfaceVersionInfo)

Get certait interface version by its number or date.

| Parameters | \* **method\_id** – uid of method, interface belongs to \* **version** – number of interface version or ‘latest’ \* **date\_time** – datetime when version was used \* **with\_person\_info** – return personal information of version’s author |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | information about interface version                                                                                                                                                                                                             |

### [](#%5Fget%5Fmethod)get\_method

TagmeClientAdvanced.get\_method(method\_id: str, task\_id: str | None = None, organization\_id: str | None = None, download\_brief: bool = False, ) → [MethodData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MethodData)

Get methodic by id. It contains brief, interface, specification and config.

If methodic is a url, brief will be downloaded and is\_brief\_as\_url will be set to False.

| Parameters | \* **method\_id** – method id. \* **task\_id** – task id. \* **organization\_id** – optional organization identifier. Defaults to None. \* **download\_brief** – download brief if it is a url. Defaults to False. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | information about methodic.                                                                                                                                                                                        |

### [](#%5Fget%5Fmethod%5Fbrief)get\_method\_brief

TagmeClientAdvanced.get\_method\_brief(method\_id: str, ) → Tuple\[str, dict\]

Get brief with headers by method id.

| Parameters | **method\_id** – uid of method, brief belongs to     |
| ---------- | ---------------------------------------------------- |
| Returns    | tuple with brief content or url and response headers |

### [](#%5Fget%5Fproject)get\_project

TagmeClientAdvanced.get\_project(project\_id: str, with\_tasks\_count: bool = False, organization\_id: str | None = None, ) → [Project](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Project)

Get project by id.

| Parameters | \* **project\_id** – project id. \* **with\_tasks\_count** – if set, return project with tasks count. Defaults to False. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | project data.                                                                                                                                                                                          |

### [](#%5Fget%5Fproject%5Fcontacts)get\_project\_contacts

TagmeClientAdvanced.get\_project\_contacts(project\_id: str, organization\_id: str | None = None, ) → [Contacts](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Contacts)

Get project or organization contacts.

| Parameters | \* **project\_id** – project id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------- |

### [](#%5Fget%5Fproject%5Fids%5Fby%5Fstatus)get\_project\_ids\_by\_status

TagmeClientAdvanced.get\_project\_ids\_by\_status(is\_archived: bool, organization\_id: str | None = None, ) → Set\[str\]

Get all archived or unarchived project ids.

| Parameters | \* **is\_archived** – status (archived or unarchived). \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | ids of projects with matched status.                                                                                                 |

### [](#%5Fget%5Fproject%5Fnames%5Fby%5Fstatus)get\_project\_names\_by\_status

TagmeClientAdvanced.get\_project\_names\_by\_status(is\_archived: bool, organization\_id: str | None = None, ) → Set\[str\]

Get all archived or unarchived projects.

| Parameters | \* **is\_archived** – status (archived or unarchived). \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | names of projects with matched status.                                                                                               |

### [](#%5Fget%5Fproject%5Fresults)get\_project\_results

TagmeClientAdvanced.get\_project\_results(project\_name: str, task\_name: str, is\_archived: bool | None = None, organization\_id: str | None = None, ) → List\[[TaskResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskResult)\]

Get results for task matched by name.

| Parameters | \* **project\_name** – name of project to get results from. \* **task\_name** – name of project’s task to get results from. \* **is\_archived** – search in archived projects. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | list of task results.                                                                                                                                                                            |

### [](#%5Fget%5Fproject%5Ftask)get\_project\_task

TagmeClientAdvanced.get\_project\_task(project\_id: str, ignore\_tasks: Tuple\[str, …​\] = ('Обучение', 'Экзамен'), organization\_id: str | None = None, ) → [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)

(deprecated) Get first task for project. Use ‘get\_project\_tasks’ instead.

| Parameters | \* **project\_id** – project id to get task from. \* **ignore\_tasks** – names of tasks to ignore. Defaults to (‘Обучение’, ‘Экзамен’). \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | found task.                                                                                                                                                                                                           |

### [](#%5Fget%5Fproject%5Ftasks)get\_project\_tasks

TagmeClientAdvanced.get\_project\_tasks(project\_id: str, ignore\_tasks: Tuple\[str, …​\] = ('Обучение', 'Экзамен'), organization\_id: str | None = None, ) → List\[[TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)\]

Get tasks for project.

| Parameters | \* **project\_id** – project id to get tasks from. \* **ignore\_tasks** – names of tasks to ignore. Defaults to (‘Обучение’, ‘Экзамен’). \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | found tasks.                                                                                                                                                                                                           |

### [](#%5Fget%5Fproject%5Fwith%5Fleast%5Fmarkup%5Ftime)get\_project\_with\_least\_markup\_time

TagmeClientAdvanced.get\_project\_with\_least\_markup\_time(projects: List\[[Project](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Project)\], from\_date: Tuple\[int, int, int\] | str = None, to\_date: Tuple\[int, int, int\] | str = None, ) → [Project](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Project)

Get project with the least markup time. If params ‘from\_date’ and ‘to\_date’ are not specified, the last 30 days are used to count marking speed.

| Parameters  | \* **projects** – list of projects to compare \* **from\_date** – start date for calculating the marking speed. Defaults to None \* **to\_date** – end date for calculating the marking speed. Defaults to None |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns     | the project with the least remaining markup time                                                                                                                                                                |
| Return type | [Project](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Project)                                                                                                                                           |

### [](#%5Fget%5Fprojects)get\_projects

TagmeClientAdvanced.get\_projects(with\_tasks\_count: bool = False, archived: bool | None = False, with\_pipeline: bool | None = False, organization\_id: str | None = None, query: str | None = None, page: int | None = None, size: int | None = None, is\_bookmarked: bool | None = None, is\_pipelined: bool | None = None, update\_date\_from: str | None = None, ) → List\[[Project](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Project)\]

Get organization projects.

| Parameters | \* **with\_tasks\_count** – return task count for project. Defaults to False. \* **archived** – return archived projects. Defaults to False. \* **organization\_id** – optional organization identifier. Defaults to None. \* **with\_pipeline** – return projects with pipeline config. Defaults to False. \* **query** – text query to search by name. Defaults to None. \* **page** – number of page for pagination. Defaults to None. \* **is\_bookmarked** – return only bookmarked projects. Defaults to None. \* **is\_pipelined** – return only pipelined projects. Defaults to None. \* **update\_date\_from** – return projects whose settings changed on or after that day |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of projects matched.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

### [](#%5Fget%5Fprojects%5Fadvanced)get\_projects\_advanced

TagmeClientAdvanced.get\_projects\_advanced(project\_ids: Collection\[str\] | None = None, organization\_id: str | None = None, with\_method: bool = False, with\_pipeline: bool | None = False, archived: bool | None = None, is\_pipelined: bool | None = None, tqdm\_on: bool | str = False, max\_concurrency: int = 10, ) → List\[[Project](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Project)\]

Get organization projects.

| Parameters | \* **project\_ids** – optional project identifiers. If not set, all projects are returned. \* **organization\_id** – optional organization identifier. Defaults to None. \* **with\_method** – if set to True, methods for projects are loaded. \* **with\_pipeline** – return projects with pipeline config. Defaults to False. \* **archived** – if set to True or False, only archived or not archived projects are returned. \* **is\_pipelined** – return only pipelined projects. Defaults to None. \* **tqdm\_on** – if set to True or some string progress bar is shown. Defaults to False. \* **max\_concurrency** – controls the asyncio.Semaphore value for limiting concurrent operations. Defaults to 10. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of projects.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

### [](#%5Fget%5Fprojects%5Fadvanced%5Fwith%5Ferrors)get\_projects\_advanced\_with\_errors

TagmeClientAdvanced.get\_projects\_advanced\_with\_errors(project\_ids: Collection\[str\] | None = None, organization\_id: str | None = None, with\_method: bool = False, with\_pipeline: bool | None = False, archived: bool | None = None, is\_pipelined: bool | None = None, tqdm\_on: bool | str = False, errors: Dict\[str, List\[str\]\] | DefaultDict\[str, List\[str\]\] | None = None, max\_concurrency: int = 10, ) → Tuple\[List\[[Project](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Project)\], Dict\[str, List\[str\]\] | DefaultDict\[str, List\[str\]\]\]

Get organization projects.

| Parameters | \* **project\_ids** – optional project identifiers. If not set, all projects are returned. \* **organization\_id** – optional organization identifier. Defaults to None. \* **with\_method** – if set to True, methods for projects are loaded. \* **with\_pipeline** – return projects with pipeline config. Defaults to False. \* **archived** – if set to True or False, only archived or not archived projects are returned. \* **is\_pipelined** – return only pipelined projects. Defaults to None. \* **tqdm\_on** – if set to True or some string progress bar is shown. Defaults to False. \* **errors** – optional mapping project\_id and list of errors. \* **max\_concurrency** – controls the asyncio.Semaphore value for limiting concurrent operations. Defaults to 10. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of projects and occured errors with mapping.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |

### [](#%5Fget%5Fprojects%5Fby%5Fname)get\_projects\_by\_name

TagmeClientAdvanced.get\_projects\_by\_name(project\_name: str, archived: bool = False, organization\_id: str | None = None, with\_tasks\_count: bool = False, ) → List\[[Project](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Project)\]

Get projects by text query.

| Parameters | \* **project\_name** – project name \* **archived** – return archived projects. Defaults to False. \* **organization\_id** – optional organization identifier. Defaults to None. \* **with\_tasks\_count** – return task count for project. Defaults to False. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of projects matched.                                                                                                                                                                                                                                      |

### [](#%5Fget%5Ftaskflow%5Fprojects)get\_taskflow\_projects

TagmeClientAdvanced.get\_taskflow\_projects(page: int | None = None, size: int | None = None, query: str | None = None, only\_favourite: bool | None = None, project\_id: str | None = None, ) → [ProjectTaskPaginated](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ProjectTaskPaginated)

Retrieves project-tasks available to the marker from the taskflow service.

| Parameters | \* **page** – pagination page. Defaults to None. \* **size** – pagination max size of requesting page. Defaults to None. \* **query** – look up project-tasks by query. Defaults to None. \* **only\_favourite** – return only pinned projects. Defaults to None. \* **project\_id** – return only specified project. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of project-tasks matched.                                                                                                                                                                                                                                                                                                          |

### [](#%5Flist%5Fmethod%5Fbrief%5Fversions)list\_method\_brief\_versions

TagmeClientAdvanced.list\_method\_brief\_versions(method\_id: str, ) → List\[[BriefVersionInfo](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-BriefVersionInfo)\]

Get all brief versions.

| Parameters | **method\_id** – uid of method, brief belongs to |
| ---------- | ------------------------------------------------ |
| Returns    | information about method’s brief versions        |

### [](#%5Flist%5Fmethod%5Finterface%5Fversions)list\_method\_interface\_versions

TagmeClientAdvanced.list\_method\_interface\_versions(method\_id: str, ) → List\[[InterfaceVersionInfo](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-InterfaceVersionInfo)\]

Get all interface versions.

| Parameters | **method\_id** – uid of method, interface belongs to |
| ---------- | ---------------------------------------------------- |
| Returns    | information about method’s interface versions        |

### [](#%5Fload%5Fproject%5Fmethod)load\_project\_method

TagmeClientAdvanced.load\_project\_method(project: [Project](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Project), download\_brief: bool = False, ) → None

Load project methodic (it contains brief and interface).

| Parameters | \* **project** – project to load method for. \* **download\_brief** – download brief if it is a url. Sets is\_brief\_as\_url to False for compatibility. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Frestore%5Fprojects)restore\_projects

TagmeClientAdvanced.restore\_projects(uids: List\[str\], organization\_id: str | None = None, ) → dict | None

Restore projects from archive.

| Parameters | \* **uids** – list of project ids to unarchive. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------- |
| Returns    | empty dict.                                                                                                                   |

### [](#%5Fset%5Fbrief%5Fread%5Fstatus)set\_brief\_read\_status

TagmeClientAdvanced.set\_brief\_read\_status(method\_id: str, read\_token: str, organization\_id: str | None = None, ) → None

Set methodic brief read status by id.

| Parameters | \* **method\_id** – method id. \* **read\_token** – token from headers get\_brief method \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | Nothing.                                                                                                                                                               |

### [](#%5Fupdate%5Fmethod)update\_method

TagmeClientAdvanced.update\_method(method: [MethodData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MethodData) | [MethodDataRequest](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MethodDataRequest) | dict, organization\_id: str | None = None, ) → [MethodData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MethodData)

Update project methodic.

| Parameters | \* **method** – new method data. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------- |
| Returns    | information about updated methodic.                                                                            |

### [](#%5Fupdate%5Fmethod%5Fbrief)update\_method\_brief

TagmeClientAdvanced.update\_method\_brief(method\_id: str, file\_path: str, file\_name: str, ) → None

Update brief file of method.

| Parameters | \* **method\_id** – uid of method, brief belongs to \* **file\_path** – path, where file is stored \* **file\_name** – name of file |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | None                                                                                                                                |

### [](#%5Fupdate%5Fproject)update\_project

TagmeClientAdvanced.update\_project(project\_id: str, name: str | None = None, organization\_id: str | None = None, description: str | None = None, inner\_comment: str | None = None, pipeline: SyncSettings | dict | None = None, is\_pipeline\_enabled: bool | None = None, is\_brief\_autoupdate: bool | None = None, is\_forms\_autoupdate: bool | None = None, is\_config\_autoupdate: bool | None = None, is\_specification\_autoupdate: bool | None = None, pipeline\_errors: str | None = None, ) → [Project](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Project)

Update project info.

| Parameters | \* **project\_id** – id of project to update. \* **name** – new name of project. \* **organization\_id** – optional organization identifier. Defaults to None. \* **description** – new description of project. Defaults to None. \* **inner\_comment** – new inner comment for customers. Defaults to None. \* **pipeline** – new pipeline settings. Defaults to None. \* **is\_pipeline\_enabled** – whether to enable pipeline. Defaults to None. \* **is\_brief\_autoupdate** – whether to enable brief autoupdate. Defaults to None. \* **is\_forms\_autoupdate** – whether to enable forms autoupdate. Defaults to None. \* **is\_config\_autoupdate** – whether to enable config autoupdate. Defaults to None. \* **is\_specification\_autoupdate** – whether to enable specification autoupdate. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | updated project.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

### [](#%5Fupdate%5Fproject%5Ferrors)update\_project\_errors

TagmeClientAdvanced.update\_project\_errors(project\_id: str, organization\_id: str, need\_to\_stop\_pipeline: bool = True, pipeline\_errors: str | None = None, ) → None

Update markup project’s pipeline\_errors field

| Parameters | \* **project\_id** – Id of project, that is updated. \* **pipeline\_errors** – value of error or None. |
| ---------- | ------------------------------------------------------------------------------------------------------ |

undefined
====================
## [](#%5Fresults)Results

### [](#%5Fdelete%5Fassignments%5Fcomments)delete\_assignments\_comments

TagmeClientAdvanced.delete\_assignments\_comments(assignment\_ids: List\[str\], organization\_id: str, ) → [MarkupReviewResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupReviewResult)

Delete comments on multiple reviews of markup tasks.

| Parameters | \* **assignment\_ids** – assignment ids where quality will be deleted \* **organization\_id** – organization identifier. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------ |
| Returns    | object which contains information about markup review errors.                                                            |

### [](#%5Fdelete%5Fassignments%5Fquality)delete\_assignments\_quality

TagmeClientAdvanced.delete\_assignments\_quality(assignment\_ids: List\[str\], organization\_id: str, ) → [MarkupReviewResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupReviewResult)

Delete quality on multiple reviews of markup tasks.

| Parameters | \* **assignment\_ids** – assignment ids where quality will be deleted \* **organization\_id** – organization identifier. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------ |
| Returns    | object which contains information about markup review errors.                                                            |

### [](#%5Fdownload%5Ftable%5Fresults)download\_table\_results

TagmeClientAdvanced.download\_table\_results(task\_id: str, date\_from: str | None = None, date\_to: str | None = None, file\_format: [ExportFormat](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ExportFormat) \= ExportFormat.CSV, organization\_id: str | None = None, make\_file: bool = True, ) → List | None

Get table with markup results and save to file.

| Parameters | \* **task\_id** – task id to get results from. \* **date\_from** – minimal date of results to get. Defaults to None. \* **date\_to** – maximal date of results to get. Defaults to None. \* **file\_format** – file format to save results (‘csv’, ‘json’, ‘xlsx’, ‘tsv’). Defaults to ‘csv’. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fdownload%5Ftask%5Fresults)download\_task\_results

TagmeClientAdvanced.download\_task\_results(task\_id: str, destination: str | Path, organization\_id: str | None = None, ) → None

Get task assignments’ results and save to file.

| Parameters | \* **task\_id** – task id to download results from. \* **destination** – path to file to save results to. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fget%5Fassignment%5Fresult%5Fby%5Fmarker)get\_assignment\_result\_by\_marker

TagmeClientAdvanced.get\_assignment\_result\_by\_marker(assignment\_id: str, ) → [AssignmentResultByMarker](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-AssignmentResultByMarker)

Get assignment result for marker.

| Parameters | **assignment\_id** – assignment id to retrieve results for             |
| ---------- | ---------------------------------------------------------------------- |
| Returns    | Object containing information about assignment including markup result |

### [](#%5Fget%5Fmarkup%5Fresult)get\_markup\_result

TagmeClientAdvanced.get\_markup\_result(assignment\_id: str, organization\_id: str, ) → [MarkupResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupResult) | None

Get result of assignment markup.

| Parameters | \* **assignment\_id** – id of markup task. \* **organization\_id** – organization identifier. |
| ---------- | --------------------------------------------------------------------------------------------- |
| Returns    | object which contains information about markup task result.                                   |

### [](#%5Fget%5Fmarkup%5Fresult%5Findex)get\_markup\_result\_index

TagmeClientAdvanced.get\_markup\_result\_index(assignment\_id: str, organization\_id: str, ) → [AssignmentIndex](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-AssignmentIndex) | None

Get indexing of assignment markup.

| Parameters | \* **assignment\_id** – id of markup task. \* **organization\_id** – organization identifier. |
| ---------- | --------------------------------------------------------------------------------------------- |
| Returns    | object which contains information about previous and next markup task results.                |

### [](#%5Fget%5Fmarkup%5Fresults)get\_markup\_results

TagmeClientAdvanced.get\_markup\_results(task\_id: str, organization\_id: str, marker\_ids: List\[str\] | None = None, file\_name: str | None = None, file\_ids: List\[str\] | None = None, statuses: List\[str\] | None = None, file\_types: List\[[FileType](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-FileType)\] | None = None, submitted\_ats: List\[date\] | None = None, assignment\_ids: List\[str\] | None = None, page: int | None = None, size: int | None = None, sort\_field: [MarkupResultSortField](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupResultSortField) | None = None, sort\_order: [SortOrder](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-SortOrder) | None = None, ) → [MarkupResults](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupResults)

Get results of markup.

| Parameters | \* **task\_id** – id of markup task. \* **organization\_id** – organization identifier. \* **marker\_ids** – optional list of marker ids. \* **file\_name** – filter by file name. \* **file\_ids** – filter by file ids. \* **statuses** – filter by assignment status. \* **file\_types** – filter by file type. \* **submitted\_ats** – filter by submission date. \* **assignment\_ids** – filter by assignment id. \* **page** – optional page number for pagination. \* **size** – optional page size for pagination. \* **sort\_field** – field to sort results by. \* **sort\_order** – sort order (‘asc’, ‘desc’). |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | markup results.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |

### [](#%5Fget%5Ftask%5Fassignments)get\_task\_assignments

TagmeClientAdvanced.get\_task\_assignments(task\_id: str, date\_from: str | None = None, date\_to: str | None = None, updated\_date\_from: str | None = None, updated\_date\_to: str | None = None, with\_input\_data: bool = False, join\_markers: bool = False, control\_only: bool = False, organization\_id: str | None = None, msk\_time: bool = True, tqdm\_on: bool = False, with\_assignment\_link: bool = False, marker\_ids: str | None = None, item\_types: List\[Literal\['data', 'control', 'study'\]\] | None = None, statuses: List\[Literal\['ACCEPTED', 'REJECTED', 'EXPIRED', 'SKIPPED', 'SUBMITTED'\]\] | None = None, consistency: float | None = None, consistency\_filter: Literal\['lte', 'gte', 'gt', 'lt', 'eq'\] | None = None, ) → List\[[Assignment](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Assignment)\]

Get list of task assignments.

| Parameters | \* **task\_id** – task id to get assignments for. \* **date\_from** – minimal date of assignment completion. Defaults to None. \* **date\_to** – maximal date of assignment completion. Defaults to None. \* **with\_input\_data** – add input fields to result. Defaults to False. \* **join\_markers** – add markers’ emails to result. Defaults to False. \* **control\_only** – return only control tasks. Defaults to False. \* **organization\_id** – optional organization identifier. Defaults to None. \* **msk\_time** – use MSK time for date\_from and date\_to filter. Defaults to True. \* **tqdm\_on** – show progress bar while downloading results. Defaults to False. \* **updated\_date\_from** – begin date of updating asignment to filter by. Defaults to None. \* **updated\_date\_to** – end date of updating asignment to filter by. Defaults to None. \* **item\_types** – list of file types to filter by. Defaults to None. \* **statuses** – list of statuses to filter by. Defaults to None. \* **marker\_ids** – List of marker\_ids to filter by. Defaults to None. \* **consistency** – consistency trashhold. Defaults to None. \* **consistency\_filter** – ccomparison operators for consistency filtering. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of assignments for task.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

### [](#%5Fget%5Ftask%5Fassignments%5Fdf)get\_task\_assignments\_df

TagmeClientAdvanced.get\_task\_assignments\_df(task\_id: str, date\_from: str | None = None, date\_to: str | None = None, updated\_date\_from: str | None = None, updated\_date\_to: str | None = None, marker\_ids: str | None = None, item\_types: List\[Literal\['data', 'control', 'study'\]\] | None = None, statuses: List\[Literal\['ACCEPTED', 'REJECTED', 'EXPIRED', 'SKIPPED', 'SUBMITTED'\]\] | None = None, consistency: float | None = None, consistency\_filter: Literal\['lte', 'gte', 'gt', 'lt', 'eq'\] | None = None, with\_input\_data: bool = False, organization\_id: str | None = None, msk\_time: bool = True, with\_assignment\_link: bool = False, ) → Any

Get pandas.DataFrame which contains task assignments.

| Parameters | \* **task\_id** – task id to get assignments for. \* **date\_from** – minimal date of assignment completion. Defaults to None. \* **date\_to** – maximal date of assignment completion. Defaults to None. \* **with\_input\_data** – add input fields to result. Defaults to False. \* **organization\_id** – optional organization identifier. Defaults to None. \* **msk\_time** – use MSK time for date\_from and date\_to filter. Defaults to True. \* **updated\_date\_from** – begin date of updating asignment to filter by. Defaults to None. \* **updated\_date\_to** – end date of updating asignment to filter by. Defaults to None. \* **item\_types** – list of file types to filter by. Defaults to None. \* **statuses** – list of statuses to filter by. Defaults to None. \* **marker\_ids** – List of marker\_ids to filter by. Defaults to None. \* **consistency** – consistency trashhold. Defaults to None. \* **consistency\_filter** – ccomparison operators for consistency filtering. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | pandas.DataFrame with task assignments.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

### [](#%5Fget%5Ftask%5Fresults)get\_task\_results

TagmeClientAdvanced.get\_task\_results(task\_id: str, organization\_id: str | None = None, ) → List\[[TaskResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskResult)\]

(deprecated) Get markup result for task. Use ‘get\_task\_assignments’ instead.

| Parameters | \* **task\_id** – task id to get results for. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of task assignments’ results.                                                                                          |

### [](#%5Fget%5Ftask%5Fresults%5Fflat)get\_task\_results\_flat

TagmeClientAdvanced.get\_task\_results\_flat(task\_id: str, join\_markers: bool = False, organization\_id: str | None = None, ) → List\[[Assignment](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Assignment)\]

(deprecated) Get markup result for task in new format. Use ‘get\_task\_assignments’ instead.

| Parameters | \* **task\_id** – task\_id to get results for. \* **join\_markers** – add markers’ emails to result. Defaults to False \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of task assignments’ results.                                                                                                                                                                   |

### [](#%5Fget%5Ftask%5Fsrc%5Fflat)get\_task\_src\_flat

TagmeClientAdvanced.get\_task\_src\_flat(task\_id: str, organization\_id: str | None = None, ) → List\[Dict\[str, Any\]\]

Get rows of task data. Contains file data:

* hints (HINT:<field name>)
* premarkup (GOLDEN:<field name>)
* premarkup (PREMARKUP:<field name>)
* input data (INPUT:<field name>)

| Parameters | \* **task\_id** – task id to get data from. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of rows with task data.                                                                                              |

### [](#%5Fget%5Ftask%5Fstatistics)get\_task\_statistics

TagmeClientAdvanced.get\_task\_statistics(task\_id: str, organization\_id: str, ) → [TaskStatistics](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskStatistics) | None

Get markup stats for task.

| Parameters | \* **task\_id** – id of task. \* **organization\_id** – organization identifier. |
| ---------- | -------------------------------------------------------------------------------- |
| Returns    | object which contains information task markup stats.                             |

### [](#%5Freview%5Fmarkup)review\_markup

TagmeClientAdvanced.review\_markup(review: [MarkupReview](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupReview), organization\_id: str, ) → None

Leave review on markup task.

| Parameters | \* **review** – status (ACCEPTED, REJECTED), comment and quality to set to assignment. \* **organization\_id** – organization identifier. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Freview%5Fmultiple%5Fmarkups)review\_multiple\_markups

TagmeClientAdvanced.review\_multiple\_markups(reviews: List\[[MarkupReview](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupReview)\] | List\[dict\], organization\_id: str, ) → [MarkupReviewResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupReviewResult)

Leave reviews on multiple markup tasks.

| Parameters | \* **reviews** – status (ACCEPTED, REJECTED), comment and quality to set to assignment. \* **organization\_id** – organization identifier. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |

undefined
====================
## [](#%5Fskills)Skills

### [](#%5Fcreate%5Fskill)create\_skill

TagmeClientAdvanced.create\_skill(name: str, organization\_id: str | None = None, is\_public: bool = False, ) → [Skill](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Skill)

Create new skill with given name.

| Parameters | \* **name** – skill name. \* **organization\_id** – optional organization identifier. Defaults to None. \* **is\_public** – is skill public. Defaults to False. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | created skill.                                                                                                                                                  |

### [](#%5Fdisable%5Fskill)disable\_skill

TagmeClientAdvanced.disable\_skill(skill\_id: str, organization\_id: str | None = None, ) → None

Disable skill.

| Parameters | \* **skill\_id** – skill id to disable. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fenable%5Fskill)enable\_skill

TagmeClientAdvanced.enable\_skill(skill\_id: str, organization\_id: str | None = None, ) → None

Enable skill.

| Parameters | \* **skill\_id** – skill id to enable. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fget%5Fmarkers%5Fskills%5Flist)get\_markers\_skills\_list

TagmeClientAdvanced.get\_markers\_skills\_list(query: str | None = None, size: int | None = None, page: int | None = None, organization\_id: str | None = None, with\_info: bool | None = None, ) → List\[[MarkerSkill](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkerSkill)\]

Get list of markers’ skills and their values.

| Parameters | \* **query** – search query for skill name. Defaults to None. \* **size** – size of page for pagination. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------- |
| Returns    | markers with their skills and skills’ values.                                                                              |

### [](#%5Fget%5Fpublic%5Fskills%5Flist)get\_public\_skills\_list

TagmeClientAdvanced.get\_public\_skills\_list(query: str | None = None, size: int | None = None, page: int | None = None, ) → List\[[PublicSkill](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PublicSkill)\]

Get list of markers’ skills and their values.

| Parameters | \* **query** – search query for skill name. Defaults to None. \* **size** – size of page for pagination. Defaults to None. \* **page** – page number for pagination. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | markers with their skills and skills’ values.                                                                                                                                          |

### [](#%5Fget%5Fskill)get\_skill

TagmeClientAdvanced.get\_skill(skill\_id: str, organization\_id: str | None = None, ) → [Skill](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Skill)

Get information about skill by skill id.

| Parameters | \* **skill\_id** – skill id to get information about. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | information about skill.                                                                                                            |

### [](#%5Fget%5Fskills%5Flist)get\_skills\_list

TagmeClientAdvanced.get\_skills\_list(query: str | None = None, with\_markers\_count: bool | None = None, organization\_id: str | None = None, size: int | None = None, page: int | None = None, ) → List\[[Skill](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Skill)\]

Get all available skills.

| Parameters | \* **query** – search query for skill name. \* **with\_markers\_count** – include markers count which has this skill in response. \* **organization\_id** – optional organization id. Defaults to None. \* **size** – page size for pagination. Defaults to None. \* **page** – page number for pagination. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of skills.                                                                                                                                                                                                                                                                                                               |

### [](#%5Frename%5Fskill)rename\_skill

TagmeClientAdvanced.rename\_skill(skill\_name: str, target\_name: str, organization\_id: str | None = None, ) → [Skill](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Skill)

Find skill by name and rename it. Only first found skill will be updated.

| Parameters | \* **skill\_name** – skill name to search by. \* **target\_name** – new skill name. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | information about updated skill.                                                                                                                                  |

### [](#%5Fset%5Fmarker%5Fskill)set\_marker\_skill

TagmeClientAdvanced.set\_marker\_skill(marker\_id: str, skill\_id: str, value: int, organization\_id: str | None = None, ) → [SetMarkerSkillResponse](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-SetMarkerSkillResponse)

Add skill and its value to marker.

| Parameters | \* **marker\_id** – marker id to add skill to. \* **skill\_id** – skill id to add to marker. \* **value** – skill value from 0 to 100. \* **organization\_id** – organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | object which contains person\_id, skill\_id and skill value.                                                                                                                                                |

### [](#%5Fset%5Fmarkers%5Fskills)set\_markers\_skills

TagmeClientAdvanced.set\_markers\_skills(table\_path: Path | str, organization\_id: str | None = None, ) → [SetMarkersSkillsResponse](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-SetMarkersSkillsResponse)

Add skills to markers from table with columns ‘person’, ‘skill’, ‘value’.

| Parameters | **table\_path** – path to table with markers skill data to import.      |
| ---------- | ----------------------------------------------------------------------- |
| Returns    | object which contains information about successfull updates and errors. |

### [](#%5Fset%5Fmarkers%5Fskills%5Fjson)set\_markers\_skills\_json

TagmeClientAdvanced.set\_markers\_skills\_json(json\_data: List\[Dict\[str, Any\]\], organization\_id: str | None = None, ) → [SetMarkersSkillsResponse](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-SetMarkersSkillsResponse)

Add skills to markers via list with objects inside.

| Parameters | **json\_data** – list of dicts with fields ‘person’, ‘skill’, ‘value’.  |
| ---------- | ----------------------------------------------------------------------- |
| Returns    | object which contains information about successfull updates and errors. |

### [](#%5Fupdate%5Fskill)update\_skill

TagmeClientAdvanced.update\_skill(skill\_id: str, name: str, window\_size: int = 10, is\_public: bool = False, organization\_id: str | None = None, ) → [Skill](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Skill)

Update information about skill.

| Parameters | \* **skill\_id** – skill id to update. \* **name** – new skill name. \* **window\_size** – new skill window size. \* **is\_public** – is skill public. Defaults to False. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | information about updated skill.                                                                                                                                                                                                                        |

undefined
====================
## [](#%5Fstatistics)Statistics

### [](#%5Fexport%5Forg%5Fstats)export\_org\_stats

TagmeClientAdvanced.export\_org\_stats(from\_date: Tuple\[int, int, int\] | str, to\_date: Tuple\[int, int, int\] | str, types: List\[[ExportTypes](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ExportTypes) | str\] = None, file\_format: [ExportFormat](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ExportFormat) \= ExportFormat.CSV, organization\_id: str | None = None, hourly: bool | None = None, ) → Tuple\[List\[[TasksStatistic](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TasksStatistic)\], List\[[MarkersStatistic](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkersStatistic)\]\]

Export organization statistics to file.

| Parameters | \* **from\_date** – start of statistics period. \* **to\_date** – end of statistics period. \* **types** – types of data to export (MARKERS or TASKS). \* **file\_format** – file format to export. Defaults to CSV. \* **organization\_id** – optional organization identifier. Defaults to None. \* **hourly** – if True, export hourly statistics. By default, exports daily statistics. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of organization statistics items.                                                                                                                                                                                                                                                                                                                                                      |

### [](#%5Fexport%5Fproject%5Fstats)export\_project\_stats

TagmeClientAdvanced.export\_project\_stats(project\_id: str, from\_date: Tuple\[int, int, int\] | str, to\_date: Tuple\[int, int, int\] | str, types: List\[[ExportTypes](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ExportTypes) | str\] = None, file\_format: [ExportFormat](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ExportFormat) \= ExportFormat.CSV, organization\_id: str | None = None, ) → Tuple\[List\[[TasksStatistic](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TasksStatistic)\], List\[[MarkersStatistic](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkersStatistic)\]\]

Export project statistics to file.

| Parameters | \* **project\_id** – id of project to export. \* **from\_date** – start of statistics period. \* **to\_date** – end of statistics period. \* **types** – types of data to export (MARKERS or TASKS). \* **file\_format** – file format to export. Defaults to CSV. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | list of project statistics items.                                                                                                                                                                                                                                                                                                                |

### [](#%5Fget%5Flist%5Ftasks%5Fstatistics)get\_list\_tasks\_statistics

TagmeClientAdvanced.get\_list\_tasks\_statistics(task\_ids: List\[str\], update\_date\_from: str | None = None, organization\_id: str | None = None, ) → List\[[TaskStatisticsItem](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskStatisticsItem)\]

Get statistics for selected tasks.

| Parameters | \* **task\_ids** – task ids to get statistics for. \* **update\_date\_from** – filter by update date, return tasks whose statistics changed on or after that day \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | task statistics.                                                                                                                                                                                                                               |

### [](#%5Fget%5Fmarker%5Fproject%5Fstats)get\_marker\_project\_stats

TagmeClientAdvanced.get\_marker\_project\_stats(project\_id: str, from\_date: Tuple\[int, int, int\] | str, to\_date: Tuple\[int, int, int\] | str, types: Iterable\[str\] = ('markers',), stats\_format: str = 'csv', organization\_id: str | None = None, ) → AsyncGenerator\[Tuple\[str, TextIOWrapper\], None\]

Get statistics for marker in project.

| Parameters | \* **project\_id** – project id. \* **from\_date** – minimal date of statistics collection. \* **to\_date** – maximal date of statistics collection. \* **types** – type of statistics (‘markers’, ‘tasks’). \* **stats\_format** – format of statistics (‘csv’ or ‘xlsx’). Defaults to ‘csv’. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | marker statistics.                                                                                                                                                                                                                                                                                                                                                           |

### [](#%5Fget%5Fmarker%5Fstats)get\_marker\_stats

TagmeClientAdvanced.get\_marker\_stats(date\_from: str, date\_to: str, types: Iterable\[str\] = ('markers',), stats\_format: str = 'csv', organization\_id: str | None = None, ) → AsyncGenerator\[Tuple\[str, TextIOWrapper\], None\]

Get statistics for marker in organization.

| Parameters | \* **date\_from** – minimal date of statistics collection. \* **date\_to** – maximal date of statistics collection. \* **types** – type of statistics (‘markers’, ‘tasks’). \* **stats\_format** – format of statistics (‘csv’ or ‘xlsx’). Defaults to ‘csv’. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | marker statistics.                                                                                                                                                                                                                                                                                                                          |

### [](#%5Fget%5Fmarkup%5Fmarker%5Fstatistics)get\_markup\_marker\_statistics

TagmeClientAdvanced.get\_markup\_marker\_statistics(page: int | None = None, size: int | None = None, query: str | None = None, start\_date: date | None = None, end\_date: date | None = None, sort\_field: [MarkupMarkerStatisticsSortField](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupMarkerStatisticsSortField) | None = None, sort\_order: [SortOrder](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-SortOrder) | None = None, ) → [MarkupMarkerStatistics](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupMarkerStatistics)

Get marker statistics.

| Parameters | \* **page** – optional page number for pagination. \* **size** – optional page size for pagination. \* **query** – filter by project name. \* **start\_date** – filter by statistics start date. \* **end\_date** – filter by statistics end date. \* **sort\_field** – field to sort results by. \* **sort\_order** – sort order (‘asc’, ‘desc’). |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | marker statistics.                                                                                                                                                                                                                                                                                                                                 |

### [](#%5Fget%5Forganization%5Fstats)get\_organization\_stats

TagmeClientAdvanced.get\_organization\_stats(organization\_id: str | None = None, ) → [OrganizationStatistic](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-OrganizationStatistic)

Get organization statistics.

| Parameters | **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------- |
| Returns    | organization statistics.                                                   |

### [](#%5Fget%5Fproject%5Fstats)get\_project\_stats

TagmeClientAdvanced.get\_project\_stats(project\_id: str, organization\_id: str | None = None, ) → [ProjectStatistic](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ProjectStatistic)

Get project statistics.

| Parameters | \* **project\_id** – project id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------- |
| Returns    | project statistics.                                                                                            |

### [](#%5Fget%5Fquality%5Fstats)get\_quality\_stats

TagmeClientAdvanced.get\_quality\_stats(organization\_id: str, output: StatsOutputType, task\_ids: Tuple\[str\] | None = None, project\_ids: Tuple\[str\] | None = None, ) → List\[TaskQuality | List\[ItemQuality\]\]

Get quality statistics for tasks.

| Parameters | \* **organization\_id** – organization identifier. \* **output** – type of statistics returned (TASK or ITEM). \* **task\_ids** – optional task identifiers. Defaults to None. \* **project\_ids** – optional project identifiers. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of quality statistics items. If output is TASK, returns list of TaskQuality. If output is ITEM, returns list of ItemQuality.                                                                                                                    |

### [](#%5Fget%5Ftask%5Fitem%5Fstatistics)get\_task\_item\_statistics

TagmeClientAdvanced.get\_task\_item\_statistics(organization\_id: str, task\_id: str, item\_id: str, ) → [TaskTabItemStats](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskTabItemStats)

Returns task item statistics by taskID

### [](#%5Fget%5Ftask%5Fitems%5Fstatistics)get\_task\_items\_statistics

TagmeClientAdvanced.get\_task\_items\_statistics(task\_id: str, organization\_id: str, page: int | None = None, size: int | None = None, item\_ids: List\[str\] | None = None, ) → List\[[TaskTabItemStats](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskTabItemStats)\]

Returns task items statistics by taskID

### [](#%5Fget%5Ftask%5Fstats)get\_task\_stats

TagmeClientAdvanced.get\_task\_stats(task\_id: str, organization\_id: str | None = None, ) → [TaskStats](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskStats)

Get statistics for task.

| Parameters | \* **task\_id** – task id to get statistics for. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | task statistics.                                                                                                               |

### [](#%5Fget%5Ftask%5Fstats%5Fadvanced)get\_task\_stats\_advanced

TagmeClientAdvanced.get\_task\_stats\_advanced(task\_id: str, organization\_id: str | None = None, ) → [TaskStatsAdvanced](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskStatsAdvanced)

Get estimation date and number of assignments in progress for task.

| Parameters | \* **task\_id** – task id to get statistics for. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | task statistics.                                                                                                               |

### [](#%5Fget%5Fvalidate%5Ftime%5Fstatistics)get\_validate\_time\_statistics

TagmeClientAdvanced.get\_validate\_time\_statistics(organization\_id: str, task\_id: str | None = None, page: int | None = None, size: int | None = None, ) → [ValidateTimeStatistics](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ValidateTimeStatistics)

Get validator time statistics.

| Parameters | \* **organization\_id** – organization identifier. \* **task\_id** – id of markup task. \* **page** – optional page number for pagination. \* **size** – optional page size for pagination. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | validate time statistics.                                                                                                                                                                   |

undefined
====================
## [](#%5Ftasks)Tasks

### [](#%5Farchive%5Ftask)archive\_task

TagmeClientAdvanced.archive\_task(task\_id: str, organization\_id: str | None = None, ) → None

Archive task.

| Parameters | \* **task\_id** – task id. \* **organization\_id** – optional organization identifier. |
| ---------- | -------------------------------------------------------------------------------------- |

### [](#%5Fassign%5Fassignment)assign\_assignment

TagmeClientAdvanced.assign\_assignment(task\_id: str, item\_id: str, marker\_id: str, expired\_after: datetime, original\_assignment\_id: str | None = None, price: float | None = None, is\_increase\_overlap: bool | None = None, is\_release\_to\_pool\_on\_expire: bool | None = None, organization\_id: str | None = None, ) → None

Assign an assignment in item

| Parameters | \* **task\_id** – id of task. \* **item\_id** – id of item. \* **marker\_id** – id of marker. \* **expired\_after** – time of expiring of assignment. \* **original\_assignment\_id** – id of assignment for premarkup. \* **price** – price, if None, will be taken from task price. \* **is\_increase\_overlap** – if True, new assignment will be created. \* **is\_release\_to\_pool\_on\_expire** – if True, new assignment won’t be created after expiring this one. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | None.                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

### [](#%5Fassign%5Fassignments)assign\_assignments

TagmeClientAdvanced.assign\_assignments(assignments: List\[[AssignAssignmentRequest](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-AssignAssignmentRequest)\], organization\_id: str | None = None, ) → None

(deprecated) Assign multiple assignment. Use ‘assign\_multiple\_assignments’ instead.

| Parameters | \* **assignments** – rules on how to assign assignment. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fassign%5Fmultiple%5Fassignments)assign\_multiple\_assignments

TagmeClientAdvanced.assign\_multiple\_assignments(items: List\[[AssignMultipleAssignmentRequest](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-AssignMultipleAssignmentRequest)\], organization\_id: str | None = None, ) → [AssignAssignmentsResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-AssignAssignmentsResult)

Assign multiple assignment

| Parameters | \* **items** – rules on how to assign assignment. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fcheck%5Ftask)check\_task

TagmeClientAdvanced.check\_task(task\_id: str, organization\_id: str | None = None, ) → [CheckTaskResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckTaskResult)

Check task settings before start.

| Parameters | \* **task\_id** – task id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |
| Returns    | current task settings.                                                                                   |

### [](#%5Fcomplete%5Ftask)complete\_task

TagmeClientAdvanced.complete\_task(task\_id: str, organization\_id: str | None = None, ) → [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)

Complete task.

| Parameters | \* **task\_id** – task id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |
| Returns    | task data.                                                                                               |

### [](#%5Fcreate%5Fand%5Fstart%5Ftask)create\_and\_start\_task

TagmeClientAdvanced.create\_and\_start\_task(config: ProjectConfig, project\_id: str, task\_name: str | None = None, start\_task: bool = True, organization\_id: str | None = None, ) → [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)

(deprecated) Create task inside project and start it. Use separate methods instead.

| Parameters | \* **config** – data to create task. \* **project\_id** – project id to add task. \* **task\_name** – name of task to create. Defaults to None. \* **start\_task** – start task after its creation. Defaults to True. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | created task.                                                                                                                                                                                                                                                                                       |

### [](#%5Fcreate%5Fproject%5Fand%5Ftask)create\_project\_and\_task

TagmeClientAdvanced.create\_project\_and\_task(config: ProjectConfig, start\_task: bool = True, organization\_id: str | None = None, ) → Tuple\[str, [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)\]

(deprecated) Create project and task for it. Use ‘create\_task’ and ‘create\_project’ or ‘create\_project\_by\_config’ instead.

| Parameters | \* **config** – full project data. \* **start\_task** – start task after its creation. Defaults to True. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | project\_id and created task.                                                                                                                                                          |

### [](#%5Fcreate%5Ftask)create\_task

TagmeClientAdvanced.create\_task(task: [TaskDataRequest](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskDataRequest) | [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData) | dict, organization\_id: str | None = None, ) → [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)

Create new task.

| Parameters | \* **task** – new task’s data. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------ |
| Returns    | created task.                                                                                                |

### [](#%5Fcreate%5Ftask%5Fin%5Fproject)create\_task\_in\_project

TagmeClientAdvanced.create\_task\_in\_project(config: ProjectConfig, project\_id: str, task\_name: str | None = None, organization\_id: str | None = None, ) → [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)

(deprecated) Create task inside project. Use ‘create\_task’ instead.

| Parameters | \* **config** – data to create task. \* **project\_id** – project id to add task to. \* **task\_name** – name of task to create. Defaults to None. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | created task.                                                                                                                                                                                                                    |

### [](#%5Fdelete%5Ftask%5Fpayload)delete\_task\_payload

TagmeClientAdvanced.delete\_task\_payload(task\_id: str, organization\_id: str | None = None, ) → None

Delete payload from task.

| Parameters | \* **task\_id** – task id to delete payload for. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------ |

### [](#%5Fduplicate%5Ftask)duplicate\_task

TagmeClientAdvanced.duplicate\_task(original\_task: [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData) | dict, task: dict = None, organization\_id: str | None = None, ) → [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)

Create duplicate of task.

| Parameters | \* **original\_task** – original task. \* **task** – new task data, different from the original task data. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | created task.                                                                                                                                                                            |

### [](#%5Fget%5Fproject%5Fpublic%5Fassignments)get\_project\_public\_assignments

TagmeClientAdvanced.get\_project\_public\_assignments(project\_id: str, organization\_id: str | None = None, page: int | None = None, size: int | None = None, ) → [GetProjectPublicAssignmentsResponse](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-GetProjectPublicAssignmentsResponse)

Get project public assignments.

| Parameters | \* **project\_id** – project id \* **organization\_id** – optional organization identifier. Defaults to None. \* **page** – optional page number. Defaults to None. \* **size** – optional page size. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | public assignments for project.                                                                                                                                                                                         |

### [](#%5Fget%5Fprojects%5Fwith%5Fpublic%5Fassignments)get\_projects\_with\_public\_assignments

TagmeClientAdvanced.get\_projects\_with\_public\_assignments(organization\_id: str | None = None, query: str | None = None, page: int | None = None, size: int | None = None, ) → List\[[ProjectsWithPublicAssignment](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-ProjectsWithPublicAssignment)\]

Get projects with public assignments.

| Parameters | \* **organization\_id** – optional organization identifier. Defaults to None. \* **query** – optional search query. Defaults to None. \* **page** – optional page number. Defaults to None. \* **size** – optional page size. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | projects with public assignments.                                                                                                                                                                                                               |

### [](#%5Fget%5Ftask)get\_task

TagmeClientAdvanced.get\_task(task\_id: str, organization\_id: str | None = None, with\_files\_count: bool = False, ) → [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)

Get task by id.

| Parameters | \* **task\_id** – id of task to get. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------ |
| Returns    | task data.                                                                                                         |

### [](#%5Fget%5Ftask%5Ffiles%5Fcount)get\_task\_files\_count

TagmeClientAdvanced.get\_task\_files\_count(task\_id: str, types: List\[str\] | None = None, organization\_id: str | None = None, ) → [TaskFilesCount](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskFilesCount)

Get count of files in task by types.

| Parameters | \* **task\_id** – id of task. \* **types** – file types to include (all, control, study, data) \* **organizaton\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | files count for requested types.                                                                                                                                            |

### [](#%5Fget%5Ftask%5Fhierarchy)get\_task\_hierarchy

TagmeClientAdvanced.get\_task\_hierarchy(task\_id: str, ) → [TaskHierarchy](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskHierarchy)

Get project id and organization id for task.

| Parameters | **task\_id** – id of task.                                      |
| ---------- | --------------------------------------------------------------- |
| Returns    | Object which contains project\_id and organization\_id of task. |

### [](#%5Fget%5Ftask%5Finfo)get\_task\_info

TagmeClientAdvanced.get\_task\_info(task\_id: str, organization\_id: str | None = None, ) → Dict

Get information about task bucket in cloud.

| Parameters | \* **task\_id** – task id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |
| Returns    | bucket information.                                                                                      |

### [](#%5Fget%5Ftask%5Finformation)get\_task\_information

TagmeClientAdvanced.get\_task\_information(task\_id: str, organization\_id: str | None = None, ) → [TaskInfo](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskInfo)

Get information about task.

| Parameters | \* **task\_id** – task id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |
| Returns    | task information.                                                                                        |

### [](#%5Fget%5Ftask%5Fpayload)get\_task\_payload

TagmeClientAdvanced.get\_task\_payload(task\_id: str, organization\_id: str | None = None, ) → dict

Get task payload.

| Parameters | \* **task\_id** – task id to get payload for. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------- |
| Returns    | task payload.                                                                                                               |

### [](#%5Fget%5Ftasks)get\_tasks

TagmeClientAdvanced.get\_tasks(project\_id: str | None = None, price\_min: float | None = None, price\_max: float | None = None, priority\_min: int | None = None, priority\_max: int | None = None, query: str | None = None, page: int | None = None, size: int | None = None, organization\_id: str | None = None, update\_date\_from: str | None = None, states: List\[[TaskState](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskState)\] | None = None, task\_ids: List\[str\] | None = None, ) → List\[[TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)\]

Get tasks matching by filter.

| Parameters | \* **project\_id** – optional project identifier. \* **price\_max** – optional maximum price for task. \* **price\_min** – optional minimum price for task. \* **priority\_min** – optional minimum priority for task. \* **priority\_max** – optional maximum priority for task. \* **query** – optional search query for task names. \* **page** – page number for pagination. \* **size** – number of items per page for pagination. \* **organization\_id** – optional organization identifier. Defaults to None. \* **update\_date\_from** – optional update date for tasks. \* **states** – optional task states. \* **task\_ids** – optional task identifiers. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of tasks.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |

### [](#%5Fget%5Ftasks%5Fadvanced)get\_tasks\_advanced

TagmeClientAdvanced.get\_tasks\_advanced(task\_ids: Sequence\[str\] | None = None, project\_ids: Sequence\[str\] | None = None, organization\_id: str | None = None, with\_empty: bool = True, with\_payload: bool = False, with\_project\_pipeline: bool | dict = False, archived: bool | None = None, tqdm\_on: bool = False, max\_concurrency: int = 10, ) → List\[[TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)\]

Get tasks matching by filter.

| Parameters | \* **task\_ids** – optional task identifiers. If not set, all tasks are returned. \* **project\_ids** – optional project identifiers. If not set, tasks from all the projects are returned. \* **organization\_id** – optional organization identifier. Defaults to None. \* **with\_empty** – if set to True, tasks with no files are returned. Defaults to True. \* **with\_payload** – if set to True, tasks payload is added. Defaults to False. \* **with\_project\_config** – add project config to tasks payload. Defaults to False. \* **archived** – if set to True or False, only archived or not archived tasks are returned. Defaults to None. \* **tqdm\_on** – if set to True or some string progress bar is shown. Defaults to False. \* **max\_concurrency** – controls the asyncio.Semaphore value for limiting concurrent operations. Defaults to 10. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of tasks.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |

### [](#%5Fget%5Ftasks%5Fadvanced%5Fwith%5Ferrors)get\_tasks\_advanced\_with\_errors

TagmeClientAdvanced.get\_tasks\_advanced\_with\_errors(task\_ids: Sequence\[str\] | None = None, project\_ids: Sequence\[str\] | None = None, organization\_id: str | None = None, with\_empty: bool = True, with\_payload: bool = False, with\_project\_pipeline: bool | dict = False, archived: bool | None = None, project\_errors: Dict\[str, List\[str\]\] | DefaultDict\[str, List\[str\]\] | None = None, task\_errors: Dict\[str, str\] | None = None, tqdm\_on: bool = False, max\_concurrency: int = 10, ) → [AdvancedTaskDataWithErrors](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-AdvancedTaskDataWithErrors)

Get tasks matching by filter.

| Parameters | \* **task\_ids** – optional task identifiers. If not set, all tasks are returned. \* **project\_ids** – optional project identifiers. If not set, tasks from all the projects are returned. \* **organization\_id** – optional organization identifier. Defaults to None. \* **with\_empty** – if set to True, tasks with no files are returned. Defaults to True. \* **with\_payload** – if set to True, tasks payload is added. Defaults to False. \* **with\_project\_config** – add project config to tasks payload. Defaults to False. \* **archived** – if set to True or False, only archived or not archived tasks are returned. Defaults to None. \* **project\_errors** – optional mapping project\_ids and list of errors. \* **task\_errors** – optional mapping task\_ids and its errors. \* **tqdm\_on** – if set to True or some string progress bar is shown. Defaults to False. \* **max\_concurrency** – controls the asyncio.Semaphore value for limiting concurrent operations. Defaults to 10. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | list of tasks and occured errors with mapping.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

### [](#%5Fincrease%5Fitem%5Foverlap)increase\_item\_overlap

TagmeClientAdvanced.increase\_item\_overlap(task\_id: str, item\_id: str, organization\_id: str | None = None, ) → [Item](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Item)

Increase overlap of an item

| Parameters | \* **task\_id** – id of task. \* **item\_id** – id of item. |
| ---------- | ----------------------------------------------------------- |
| Returns    | Item info.                                                  |

### [](#%5Fload%5Ftask%5Fpayload)load\_task\_payload

TagmeClientAdvanced.load\_task\_payload(task: [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData), ) → None

Add payload to task (to ‘payload’ field).

| Parameters | **task** – task to load payload for. |
| ---------- | ------------------------------------ |

### [](#%5Fpoll%5Ffor%5Ftask%5Fstate)poll\_for\_task\_state

TagmeClientAdvanced.poll\_for\_task\_state(task\_id: str, state: [TaskState](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskState), retry\_amount: int = 15, wait\_seconds: float = 3, organization\_id: str | None = None, ) → [TaskState](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskState)

Wait while task has needed state.

| Parameters | \* **task\_id** – task id. \* **state** – task state needed. \* **retry\_amount** – amount of retries for polling. Defaults to 15. \* **wait\_seconds** – amount of seconds for polling. Defaults to 3. \* **organization\_id** – optional organization id. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | task state after finish of polling.                                                                                                                                                                                                                                           |

### [](#%5Fput%5Fitem%5Foverlap)put\_item\_overlap

TagmeClientAdvanced.put\_item\_overlap(task\_id: str, item\_id: str, overlap: int, organization\_id: str | None = None, ) → [Item](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Item)

Change overlap of an item

| Parameters | \* **task\_id** – id of task. \* **item\_id** – id of item. \* **overlap** – target overlap value |
| ---------- | ------------------------------------------------------------------------------------------------- |
| Returns    | Item info.                                                                                        |

### [](#%5Fremove%5Ftask)remove\_task

TagmeClientAdvanced.remove\_task(task\_id: str, organization\_id: str | None = None, ) → None

Remove task

| Parameters | \* **task\_id** – task id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |

### [](#%5Fset%5Ftask%5Fpayload)set\_task\_payload

TagmeClientAdvanced.set\_task\_payload(task\_id: str, payload: dict, organization\_id: str | None = None, ) → dict

Set task payload.

| Parameters | \* **task\_id** – task id to set payload for. \* **payload** – payload to set. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | new task payload.                                                                                                                                            |

### [](#%5Fstart%5Ftask)start\_task

TagmeClientAdvanced.start\_task(task\_id: str, organization\_id: str | None = None, retry\_amount: int = 15, wait\_seconds: float = 3, ) → [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)

Start task.

| Parameters | \* **task\_id** – task id. \* **organization\_id** – optional organization identifier. Defaults to None. \* **retry\_amount** – (deprecated) number of retries of starting task. Defaults to 15. \* **wait\_seconds** – (deprecated) seconds to wait between retries. Defaults to 3. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | task data.                                                                                                                                                                                                                                                                           |

### [](#%5Fstop%5Ftask)stop\_task

TagmeClientAdvanced.stop\_task(task\_id: str, organization\_id: str | None = None, ) → [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)

Stop task and wait for it to stop.

| Parameters | \* **task\_id** – task id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |
| Returns    | task data.                                                                                               |

### [](#%5Funarchive%5Ftask)unarchive\_task

TagmeClientAdvanced.unarchive\_task(task\_id: str, organization\_id: str | None = None, ) → None

Unarchive task.

| Parameters | \* **task\_id** – task id. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | -------------------------------------------------------------------------------------------------------- |

### [](#%5Funassign%5Fassignment)unassign\_assignment

TagmeClientAdvanced.unassign\_assignment(task\_id: str, assignment\_id: str, is\_keep\_price: bool | None = None, is\_decrease\_overlap: bool | None = None, organization\_id: str | None = None, ) → None

Unassign previously assigned assignment

| Parameters | \* **task\_id** – id of task. \* **assignment\_id** – id of assignment. \* **is\_keep\_price** – if True, price will be saved as a price of an unassigned assignment. \* **is\_decrease\_overlap** – if True, item overlap will decrement. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | None.                                                                                                                                                                                                                                      |

### [](#%5Fupdate%5Ftask)update\_task

TagmeClientAdvanced.update\_task(task: [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData) | dict, organization\_id: str | None = None, ) → [TaskData](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)

Update task.

| Parameters | \* **task** – new task’s data. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------ |
| Returns    | updated task.                                                                                                |

### [](#%5Fupload%5Ffolder%5Fpdf)upload\_folder\_pdf

TagmeClientAdvanced.upload\_folder\_pdf(task\_id: str, folder: str | Path, cloud\_client: Any | None = None, exclude\_ext\_filter: Set\[str\] | None = None, organization\_id: str | None = None, tqdm\_on: bool | str = False, ) → [UploadFilesResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult)

Upload folder with pdf-files. Transforms pdf-files into png images before uploading.

| Parameters | \* **task\_id** – task id to upload files to. \* **folder** – folder with pdf files. \* **cloud\_client** – cloud client used to upload files. \* **exclude\_ext\_filter** – skip files of given extension. Defaults to None. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | uploaded files and errors.                                                                                                                                                                                                                                                                                  |

undefined
====================
## [](#%5Ftemplates)Templates

### [](#%5Fadd%5Fimages%5Fto%5Ftemplate)add\_images\_to\_template

TagmeClientAdvanced.add\_images\_to\_template(template\_id: str, files\_paths: List\[str\], organization\_id: str | None = None, ) → [UploadFilesResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult)

Add images to a template.

| Parameters  | \* **template\_id** ( **str**) – The ID of the template to add images to. \* **files\_paths** ( **List** **\[** **str** **\]**) – The list containing the images to add. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns     | The result of adding the images to the template.                                                                                                                                                                                                       |
| Return type | [UploadFilesResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult)                                                                                                                                                              |

### [](#%5Fapply%5Ftemplate%5Fto%5Fproject)apply\_template\_to\_project

TagmeClientAdvanced.apply\_template\_to\_project(template\_id: str, project\_id: str, organization\_id: str | None = None, autoupdate\_params: dict | None = None, ) → None

Apply a template to a project.

| Parameters | \* **template\_id** ( **str**) – The ID of the template to apply. \* **project\_id** ( **str**) – The ID of the project to apply the template to. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Farchive%5Ftemplate)archive\_template

TagmeClientAdvanced.archive\_template(template\_id: str, organization\_id: str | None = None, ) → None

Archive a template.

| Parameters | \* **template\_id** ( **str**) – The ID of the template to archive. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fcheck%5Ftemplate)check\_template

TagmeClientAdvanced.check\_template(template\_id: str, organization\_id: str | None = None, ) → [CheckTemplateResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckTemplateResult)

Check a template.

| Parameters  | \* **template\_id** ( **str**) – The ID of the template to check. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns     | The result of the check.                                                                                                                        |
| Return type | [CheckTemplateResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckTemplateResult)                                                   |

### [](#%5Fcreate%5Ftemplate)create\_template

TagmeClientAdvanced.create\_template(name: str, description: str | None = None, documentation: str | None = None, contacts: str | None = None, categories: List\[str\] | None = None, from\_method\_id: str | None = None, organization\_id: str | None = None, access: str | None = None, acl: List\[str\] | None = None, ) → [Template](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Template)

Create a new template.

| Parameters  | \* **name** ( **str**) – The name of the template. \* **description** ( **Optional** **\[** **str** **\]**) – The description of the template. \* **documentation** ( **Optional** **\[** **str** **\]**) – The documentation of the template. \* **contacts** ( **Optional** **\[** **str** **\]**) – The contacts of the template. \* **categories** ( **Optional** **\[** **List** **\[** **str** **\]** **\]**) – The categories of the template. \* **from\_method\_id** ( **Optional** **\[** **str** **\]**) – The ID of the method to create the template from. \* **organization\_id** – optional organization identifier. Defaults to None. \* **access** – (Optional\[str\]): The access level of the template. \* **acl** – (Optional\[List\[str\]\]): The ACL of the template. |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns     | The created template.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Return type | [Template](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Template)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

### [](#%5Fdelete%5Ftemplate%5Fpreview)delete\_template\_preview

TagmeClientAdvanced.delete\_template\_preview(template\_id: str, organization\_id: str | None = None, ) → None

Delete the preview for a template.

| Parameters | \* **template\_id** ( **str**) – The ID of the template to delete the preview for. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fget%5Fpublished%5Ftemplates%5Flist)get\_published\_templates\_list

TagmeClientAdvanced.get\_published\_templates\_list(query: str | None = None, categories: List\[str\] | None = None, size: int | None = None, page: int | None = None, organization\_id: str | None = None, ) → List\[[Template](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Template)\]

Get a list of published templates.

| Parameters  | \* **query** ( **Optional** **\[** **str** **\]**) – The query to search for. \* **categories** ( **Optional** **\[** **List** **\[** **str** **\]** **\]**) – The categories to filter by. \* **size** ( **Optional** **\[** **int** **\]**) – Page size for pagination. Defaults to None. \* **page** ( **Optional** **\[** **int** **\]**) – The page number to return. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns     | A list of templates.                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Return type | List\[[Template](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Template)\]                                                                                                                                                                                                                                                                                                                                                                          |

### [](#%5Fget%5Ftemplate)get\_template

TagmeClientAdvanced.get\_template(template\_id: str, organization\_id: str | None = None, ) → [Template](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Template)

Get a template by ID.

| Parameters  | \* **template\_id** ( **str**) – The ID of the template to get. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns     | The template with the specified ID.                                                                                                           |
| Return type | [Template](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Template)                                                                       |

### [](#%5Fget%5Ftemplate%5Fimages%5Flist)get\_template\_images\_list

TagmeClientAdvanced.get\_template\_images\_list(template\_id: str, organization\_id: str | None = None, ) → [SimpleImagesListResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-SimpleImagesListResult)

Get a list of images for a template.

| Parameters  | \* **template\_id** ( **str**) – The ID of the template to get images for. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns     | A list of images for the template.                                                                                                                       |
| Return type | [SimpleImagesListResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-SimpleImagesListResult)                                                      |

### [](#%5Fget%5Ftemplates%5Flist)get\_templates\_list

TagmeClientAdvanced.get\_templates\_list(query: str | None = None, categories: List\[str\] | None = None, archived: bool | None = None, size: int | None = None, page: int | None = None, organization\_id: str | None = None, ) → List\[[Template](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Template)\]

Get a list of templates.

| Parameters  | \* **query** ( **Optional** **\[** **str** **\]**) – The query to search for. \* **categories** ( **Optional** **\[** **List** **\[** **str** **\]** **\]**) – The categories to filter by. \* **archived** ( **Optional** **\[** **bool** **\]**) – Flag to return only archived/unarchived. \* **size** ( **Optional** **\[** **int** **\]**) – Page size for pagination. Defaults to None. \* **page** ( **Optional** **\[** **int** **\]**) – The page number to return. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns     | A list of templates.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Return type | List\[[Template](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Template)\]                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

### [](#%5Fpublish%5Ftemplate)publish\_template

TagmeClientAdvanced.publish\_template(template\_id: str, organization\_id: str | None = None, ) → None

Publish a template.

| Parameters | \* **template\_id** ( **str**) – The ID of the template to publish. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Funarchive%5Ftemplate)unarchive\_template

TagmeClientAdvanced.unarchive\_template(template\_id: str, organization\_id: str | None = None, ) → None

Unarchive a template.

| Parameters | \* **template\_id** ( **str**) – The ID of the template to unarchive. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Funpublish%5Ftemplate)unpublish\_template

TagmeClientAdvanced.unpublish\_template(template\_id: str, organization\_id: str | None = None, ) → None

Unpublish a template.

| Parameters | \* **template\_id** ( **str**) – The ID of the template to unpublish. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Fupdate%5Ftemplate)update\_template

TagmeClientAdvanced.update\_template(template\_id: str, name: str, description: str | None = None, documentation: str | None = None, contacts: str | None = None, categories: List\[str\] | None = None, organization\_id: str | None = None, access: str | None = None, acl: List\[str\] | None = None, ) → [Template](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Template)

Update a template.

| Parameters  | \* **template\_id** ( **str**) – The ID of the template to update. \* **name** ( **str**) – The new name of the template. \* **description** ( **Optional** **\[** **str** **\]**) – The new description of the template. \* **documentation** ( **Optional** **\[** **str** **\]**) – The new documentation of the template. \* **contacts** ( **Optional** **\[** **str** **\]**) – The new contacts of the template. \* **categories** ( **Optional** **\[** **List** **\[** **str** **\]** **\]**) – The new categories of the template. \* **organization\_id** – optional organization identifier. Defaults to None. \* **access** – (Optional\[str\]): The access level of the template. \* **acl** – (Optional\[List\[str\]\]): The ACL of the template. |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns     | The updated template.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Return type | [Template](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-Template)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |

### [](#%5Fupload%5Ftemplate%5Fpreview)upload\_template\_preview

TagmeClientAdvanced.upload\_template\_preview(template\_id: str, files\_paths: List\[str\], organization\_id: str | None = None, ) → [PreviewFileResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PreviewFileResult)

Upload a preview for a template.

| Parameters  | \* **template\_id** ( **str**) – The ID of the template to upload the preview for. \* **files\_paths** ( **List** **\[** **str** **\]**) – The list containing the preview to upload. \* **organization\_id** – optional organization identifier. Defaults to None. |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns     | The result of uploading the preview.                                                                                                                                                                                                                                |
| Return type | [PreviewFileResult](types.html#crowd%5Fsdk-tagme-http%5Fclient-datacls-PreviewFileResult)                                                                                                                                                                           |

undefined
====================
## [](#%5Ftypes)Types

### [](#%5Factiveassignment)ActiveAssignment

class crowd\_sdk.tagme.http\_client.datacls.ActiveAssignment(assignment\_id: str, task\_id: str, task\_name: str, project\_id: str, project\_name: str, organization\_id: str, item\_type: str, assignment\_started: datetime.datetime, price: float, )

assignment\_id: str

assignment\_started: datetime

item\_type: str

organization\_id: str

price: float

project\_id: str

project\_name: str

task\_id: str

task\_name: str

### [](#%5Faddbonusesresponse)AddBonusesResponse

class crowd\_sdk.tagme.http\_client.datacls.AddBonusesResponse(failed\_marker\_ids: Dict\[str, str\] = <factory>, )

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-AddBonusesResponse-failed%5Fmarker%5Fids)AdvancedTaskDataWithErrors

class crowd\_sdk.tagme.http\_client.datacls.AdvancedTaskDataWithErrors(tasks: List\[[crowd\_sdk.tagme.http\_client.datacls.TaskData](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData)\], project\_errors: Dict\[str, List\[str\]\] | DefaultDict\[str, List\[str\]\], task\_errors: Dict\[str, str\], )

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-AdvancedTaskDataWithErrors-tasks)AssignAssignmentRequest

class crowd\_sdk.tagme.http\_client.datacls.AssignAssignmentRequest(task\_id: str, item\_id: str, marker\_id: str, expired\_after: datetime.datetime, original\_assignment\_id: str | NoneType = None, price: float | NoneType = None, is\_increase\_overlap: bool | NoneType = None, is\_release\_to\_pool\_on\_expire: bool | NoneType = None, )

expired\_after: datetime

is\_increase\_overlap: bool | None = None

is\_release\_to\_pool\_on\_expire: bool | None = None

item\_id: str

marker\_id: str

original\_assignment\_id: str | None = None

price: float | None = None

task\_id: str

### [](#%5Fassignassignmentserror)AssignAssignmentsError

class crowd\_sdk.tagme.http\_client.datacls.AssignAssignmentsError(task\_id: str, marker\_id: str, message: str, )

marker\_id: str

message: str

task\_id: str

### [](#%5Fassignassignmentsresult)AssignAssignmentsResult

class crowd\_sdk.tagme.http\_client.datacls.AssignAssignmentsResult(failed\_assign\_requests: List\[[crowd\_sdk.tagme.http\_client.datacls.AssignAssignmentsError](#crowd%5Fsdk-tagme-http%5Fclient-datacls-AssignAssignmentsError)\] | NoneType, )

failed\_assign\_requests: List\[[AssignAssignmentsError](#crowd%5Fsdk-tagme-http%5Fclient-datacls-AssignAssignmentsError)\] | None

### [](#%5Fassignmultipleassignmentrequest)AssignMultipleAssignmentRequest

class crowd\_sdk.tagme.http\_client.datacls.AssignMultipleAssignmentRequest(task\_id: str, item\_id: str, markers: List\[[crowd\_sdk.tagme.http\_client.datacls.MarkerAssignment](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkerAssignment)\], expired\_after: datetime.datetime | str, price: float | NoneType = None, is\_increase\_overlap: bool | NoneType = None, is\_release\_to\_pool\_on\_expire: bool | NoneType = None, )

expired\_after: datetime | str

is\_increase\_overlap: bool | None = None

is\_release\_to\_pool\_on\_expire: bool | None = None

item\_id: str

price: float | None = None

task\_id: str

### [](#%5Fassignment)Assignment

class crowd\_sdk.tagme.http\_client.datacls.Assignment(file\_name: str, item\_id: str, marker\_id: str, organization\_id: str, person\_id: str, price: float | NoneType, result: dict | NoneType, status: Literal\['ACCEPTED', 'ASSIGNED', 'SKIPPED', 'EXPIRED', 'SUBMITTED', 'REJECTED'\], task\_id: str, start\_date: datetime.datetime | NoneType = None, end\_date: datetime.datetime | NoneType = None, submitted\_at: datetime.datetime | NoneType = None, expired\_at: datetime.datetime | NoneType = None, skipped\_at: datetime.datetime | NoneType = None, accepted\_at: datetime.datetime | NoneType = None, rejected\_at: datetime.datetime | NoneType = None, updated\_date: datetime.datetime | NoneType = None, item\_type: str | NoneType = None, control: dict | NoneType = None, control\_passed: bool | float | int | NoneType = None, consistency: float | NoneType = None, quality: float | NoneType = None, assignment\_id: str | NoneType = None, time\_spent: float | NoneType = None, email: str | NoneType = None, input\_data: dict | NoneType = None, enabled: bool | NoneType = True, assignment\_link: str | NoneType = None, reviewer\_comment: str | NoneType = None, is\_review\_public: bool | NoneType = None, )

accepted\_at: datetime | None = None

assignment\_id: str | None = None

assignment\_link: str | None = None

consistency: float | None = None

control: dict | None = None

control\_passed: bool | float | int | None = None

email: str | None = None

enabled: bool | None = True

end\_date: datetime | None = None

expired\_at: datetime | None = None

file\_name: str

### [](#%5Ffrom%5Fassignment%5Fdata)from\_assignment\_data

static from\_assignment\_data(user\_id: str, item\_data: [TaskResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskResult), assignment\_data: dict, status: Literal\['ACCEPTED', 'ASSIGNED', 'SKIPPED', 'EXPIRED', 'SUBMITTED', 'REJECTED'\], ) → [Assignment](#crowd%5Fsdk-tagme-http%5Fclient-datacls-Assignment)

### [](#%5Fget%5Fquality)get\_quality

get\_quality() → float | None

### [](#%5Fget%5Fsafe%5Fresult%5Ffield)get\_safe\_result\_field

get\_safe\_result\_field(key: str, ) → Any

input\_data: dict | None = None

is\_review\_public: bool | None = None

item\_id: str

item\_type: str | None = None

marker\_id: str

organization\_id: str

person\_id: str

price: float | None

quality: float | None = None

rejected\_at: datetime | None = None

result: dict | None

reviewer\_comment: str | None = None

skipped\_at: datetime | None = None

start\_date: datetime | None = None

submitted\_at: datetime | None = None

task\_id: str

time\_spent: float | None = None

### [](#%5Fto%5Fresult%5Fdata)to\_result\_data

to\_result\_data() → Dict\[str, Any\]

### [](#%5Fto%5Fskip%5Fdata)to\_skip\_data

to\_skip\_data() → Dict\[str, Any\]

updated\_date: datetime | None = None

### [](#%5Fassignmentindex)AssignmentIndex

class crowd\_sdk.tagme.http\_client.datacls.AssignmentIndex(prev\_assignment\_id: str | NoneType = None, next\_assignment\_id: str | NoneType = None, )

next\_assignment\_id: str | None = None

prev\_assignment\_id: str | None = None

### [](#%5Fassignmentresultbymarker)AssignmentResultByMarker

class crowd\_sdk.tagme.http\_client.datacls.AssignmentResultByMarker(id: str, task\_id: str, project\_name: str, brief\_url: str, file\_url: str, form\_url: str, result: Dict\[str, Any\], reviewer\_comment: str | NoneType, status: str, method\_id: str | NoneType = None, started\_at: datetime.datetime | NoneType = None, submitted\_at: datetime.datetime | NoneType = None, )

brief\_url: str

file\_url: str

form\_url: str

id: str

method\_id: str | None = None

project\_name: str

reviewer\_comment: str | None

started\_at: datetime | None = None

status: str

submitted\_at: datetime | None = None

task\_id: str

### [](#%5Favailableprojecttask)AvailableProjectTask

class crowd\_sdk.tagme.http\_client.datacls.AvailableProjectTask(task\_id: str, task\_name: str, project\_id: str, project\_name: str, organization\_id: str, pool\_ids: List\[str\], )

organization\_id: str

project\_id: str

project\_name: str

task\_id: str

task\_name: str

### [](#%5Favailableprojecttaskresponse)AvailableProjectTaskResponse

class crowd\_sdk.tagme.http\_client.datacls.AvailableProjectTaskResponse(has\_next: bool, items: List\[[crowd\_sdk.tagme.http\_client.datacls.AvailableProjectTask](#crowd%5Fsdk-tagme-http%5Fclient-datacls-AvailableProjectTask)\], )

has\_next: bool

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-AvailableProjectTaskResponse-items)BriefReadStatusData

class crowd\_sdk.tagme.http\_client.datacls.BriefReadStatusData(read\_at: str, is\_new\_version: bool, )

is\_new\_version: bool

read\_at: str

### [](#%5Fbriefversioninfo)BriefVersionInfo

class crowd\_sdk.tagme.http\_client.datacls.BriefVersionInfo(method\_id: str, created\_at: datetime.datetime, file\_id: str | NoneType = None, dataset\_id: str | NoneType = None, version: int | NoneType = None, person: dict | NoneType = None, person\_id: str | NoneType = None, is\_autoupdate: bool = False, )

created\_at: datetime

dataset\_id: str | None = None

file\_id: str | None = None

is\_autoupdate: bool = False

method\_id: str

person: dict | None = None

person\_id: str | None = None

version: int | None = None

### [](#%5Fcheckplugintemplateresult)CheckPluginTemplateResult

class crowd\_sdk.tagme.http\_client.datacls.CheckPluginTemplateResult(bundle: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, status: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, documentation: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, description: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, contacts: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, title: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, )

bundle: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

contacts: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

description: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

documentation: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

status: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

title: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

### [](#%5Fcheckresult)CheckResult

class crowd\_sdk.tagme.http\_client.datacls.CheckResult(status: [crowd\_sdk.tagme.http\_client.datacls.CheckStatus](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckStatus), message: str | NoneType = None, )

message: str | None = None

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult-status)CheckStatus

class crowd\_sdk.tagme.http\_client.datacls.CheckStatus(value, )

An enumeration.

ERROR \= 'ERROR'

OK \= 'OK'

WARNING \= 'WARNING'

### [](#%5Fchecktaskresult)CheckTaskResult

class crowd\_sdk.tagme.http\_client.datacls.CheckTaskResult(brief: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, form: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, markers: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, price: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, data\_count: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, filter: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, control\_count: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, out\_skill: [crowd\_sdk.tagme.http\_client.datacls.SkillCheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-SkillCheckResult) | NoneType = None, data\_classification\_level: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, data\_source: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, control\_fraction: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, )

brief: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

control\_count: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

control\_fraction: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

data\_classification\_level: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

data\_count: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

data\_source: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

filter: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

form: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

markers: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

out\_skill: [SkillCheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-SkillCheckResult) | None = None

price: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

### [](#%5Fchecktemplateresult)CheckTemplateResult

class crowd\_sdk.tagme.http\_client.datacls.CheckTemplateResult(brief: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, form: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, documentation: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, categories: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, contacts: [crowd\_sdk.tagme.http\_client.datacls.CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | NoneType = None, )

brief: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

categories: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

contacts: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

documentation: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

form: [CheckResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckResult) | None = None

### [](#%5Fcontacts)Contacts

class crowd\_sdk.tagme.http\_client.datacls.Contacts(contacts: str | NoneType, )

contacts: str | None

### [](#%5Fcreateorganizationconfiguration)CreateOrganizationConfiguration

class crowd\_sdk.tagme.http\_client.datacls.CreateOrganizationConfiguration(mms\_business\_task\_id: str, mms\_model\_version\_id: str, )

mms\_business\_task\_id: str

mms\_model\_version\_id: str

### [](#%5Fdataset)Dataset

class crowd\_sdk.tagme.http\_client.datacls.Dataset(id: str, access: str, owner\_id: str, created\_date: datetime.datetime, files\_count: int, name: str, data\_classification\_level: str | NoneType = None, data\_source: str | NoneType = None, acl: List\[str\] | NoneType = None, attachments\_access: str | NoneType = None, attachments\_acl: List\[str\] | NoneType = None, author: dict | NoneType = None, )

access: str

acl: List\[str\] | None = None

attachments\_access: str | None = None

attachments\_acl: List\[str\] | None = None

author: dict | None = None

created\_date: datetime

data\_classification\_level: str | None = None

data\_source: str | None = None

files\_count: int

id: str

name: str

owner\_id: str

### [](#%5Fdatasetfile)DatasetFile

class crowd\_sdk.tagme.http\_client.datacls.DatasetFile(url: str, name: str, id: str, dataset\_id: str | NoneType = None, author: dict | NoneType = None, )

author: dict | None = None

dataset\_id: str | None = None

id: str

name: str

url: str

### [](#%5Fdatasetrequest)DatasetRequest

class crowd\_sdk.tagme.http\_client.datacls.DatasetRequest(name: str, data\_classification\_level: str | NoneType = None, data\_source: str | NoneType = None, )

data\_classification\_level: str | None = None

data\_source: str | None = None

name: str

### [](#%5Fdatasettype)DatasetType

class crowd\_sdk.tagme.http\_client.datacls.DatasetType(value, )

An enumeration.

BUCKET \= 'BUCKET'

BUNDLE \= 'BUNDLE'

DATASET \= 'DATASET'

LORA\_LEARNING \= 'LORA\_LEARNING'

METHODICS \= 'METHODICS'

TEMPLATE \= 'TEMPLATE'

### [](#%5Fdeleteallfilesrresult)DeleteAllFilesrResult

class crowd\_sdk.tagme.http\_client.datacls.DeleteAllFilesrResult(count: int, message: str, status: str, )

count: int

message: str

status: str

### [](#%5Fdeletesomefilesresult)DeleteSomeFilesResult

class crowd\_sdk.tagme.http\_client.datacls.DeleteSomeFilesResult(errors: List\[dict\], deleted\_files: List\[str\], message: str, )

message: str

### [](#%5Femployee)Employee

class crowd\_sdk.tagme.http\_client.datacls.Employee(person\_id: str, organization\_id: str, uid: str, employ\_date: Union\[datetime.datetime, NoneType\], active: bool, roles: Union\[List\[str\], NoneType\] = None, profile: Dict\[str, Any\] = <factory>, report: Dict\[str, Any\] = <factory>, config: Dict\[str, Any\] = <factory>, person: Union\[crowd\_sdk.tagme.http\_client.datacls.Person, NoneType\] = None, pools: Union\[List\[crowd\_sdk.tagme.http\_client.datacls.EmployeePool\], NoneType\] = None, )

active: bool

employ\_date: datetime | None

organization\_id: str

person: [Person](#crowd%5Fsdk-tagme-http%5Fclient-datacls-Person) | None = None

person\_id: str

pools: List\[[EmployeePool](#crowd%5Fsdk-tagme-http%5Fclient-datacls-EmployeePool)\] | None = None

roles: List\[str\] | None = None

uid: str

### [](#%5Femployeepool)EmployeePool

class crowd\_sdk.tagme.http\_client.datacls.EmployeePool(name: str, uid: str, )

name: str

uid: str

### [](#%5Ferrormarkersresponse)ErrorMarkersResponse

class crowd\_sdk.tagme.http\_client.datacls.ErrorMarkersResponse(status: int, errors: List\[[crowd\_sdk.tagme.http\_client.datacls.MarkersError](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkersError)\], )

status: int

### [](#%5Fexampledata)ExampleData

class crowd\_sdk.tagme.http\_client.datacls.ExampleData(filename: str | Dict | NoneType = '', explanation: str | NoneType = None, control: Dict\[str, Any\] | NoneType = None, premarkup: Dict\[str, Any\] | NoneType = None, )

control: Dict\[str, Any\] | None = None

explanation: str | None = None

filename: str | Dict | None = ''

premarkup: Dict\[str, Any\] | None = None

### [](#%5Fexportformat)ExportFormat

class crowd\_sdk.tagme.http\_client.datacls.ExportFormat(value, )

An enumeration.

CSV \= 'csv'

JSON \= 'json'

TSV \= 'tsv'

XLS \= 'xls'

### [](#%5Fexporttypes)ExportTypes

class crowd\_sdk.tagme.http\_client.datacls.ExportTypes(value, )

An enumeration.

MARKERS \= 'MARKERS'

TASKS \= 'TASKS'

### [](#%5Ffile)File

class crowd\_sdk.tagme.http\_client.datacls.File(filename: str, uid: str, )

filename: str

uid: str

### [](#%5Ffileerror)FileError

class crowd\_sdk.tagme.http\_client.datacls.FileError(filename: str, status: int, error: str, )

error: str

filename: str

status: int

### [](#%5Ffilemetadata)FileMetaData

class crowd\_sdk.tagme.http\_client.datacls.FileMetaData(file\_id: str, filehash: str | NoneType = None, premarkup: dict | NoneType = None, control: dict | NoneType = None, explanation: Any | NoneType = None, )

control: dict | None = None

explanation: Any | None = None

file\_id: str

filehash: str | None = None

premarkup: dict | None = None

### [](#%5Ffiletype)FileType

class crowd\_sdk.tagme.http\_client.datacls.FileType(value, )

An enumeration.

CONTROL \= 'CONTROL'

DATA \= 'DATA'

STUDY \= 'STUDY'

### [](#%5Ffullorganization)FullOrganization

class crowd\_sdk.tagme.http\_client.datacls.FullOrganization(uid: str, name: str, creation\_date: datetime.datetime | NoneType = None, config: [crowd\_sdk.tagme.http\_client.datacls.OrganizationConfig](#crowd%5Fsdk-tagme-http%5Fclient-datacls-OrganizationConfig) | NoneType = None, active\_employees\_cnt: int | NoneType = None, all\_employees\_cnt: int | NoneType = None, employees: List\[[crowd\_sdk.tagme.http\_client.datacls.OrganizationEmployee](#crowd%5Fsdk-tagme-http%5Fclient-datacls-OrganizationEmployee)\] | NoneType = None, is\_demo: bool | NoneType = None, contacts: str | NoneType = None, )

active\_employees\_cnt: int | None = None

all\_employees\_cnt: int | None = None

config: [OrganizationConfig](#crowd%5Fsdk-tagme-http%5Fclient-datacls-OrganizationConfig) | None = None

contacts: str | None = None

creation\_date: datetime | None = None

employees: List\[[OrganizationEmployee](#crowd%5Fsdk-tagme-http%5Fclient-datacls-OrganizationEmployee)\] | None = None

is\_demo: bool | None = None

name: str

uid: str

### [](#%5Fgetprojectpublicassignmentsresponse)GetProjectPublicAssignmentsResponse

class crowd\_sdk.tagme.http\_client.datacls.GetProjectPublicAssignmentsResponse(project\_id: str, project\_name: str, assignments: List\[[crowd\_sdk.tagme.http\_client.datacls.PublicAssignmentItem](#crowd%5Fsdk-tagme-http%5Fclient-datacls-PublicAssignmentItem)\], )

project\_id: str

project\_name: str

### [](#%5Fhourlytaskconsistencystatistics)HourlyTaskConsistencyStatistics

class crowd\_sdk.tagme.http\_client.datacls.HourlyTaskConsistencyStatistics(datetime: datetime.datetime, period\_started\_at: datetime.datetime, task\_id: str, item\_consistency\_sum: float, item\_consistency\_count: int, )

datetime: datetime

item\_consistency\_count: int

item\_consistency\_sum: float

period\_started\_at: datetime

task\_id: str

### [](#%5Fhourlytaskmarkerstatistics)HourlyTaskMarkerStatistics

class crowd\_sdk.tagme.http\_client.datacls.HourlyTaskMarkerStatistics(datetime: datetime.datetime, period\_started\_at: datetime.datetime, task\_id: str, marker\_id: str, expired\_count: int, skipped\_count: int, accepted\_count: int, rejected\_count: int, submitted\_count: int, markup\_duration\_sec: float, consistency\_sum: float, consistency\_count: int, quality\_sum: float, quality\_count: int, payed\_money\_sum: float, payed\_money\_count: int, frozen\_money\_sum: float, rejected\_money\_sum: float, )

accepted\_count: int

consistency\_count: int

consistency\_sum: float

datetime: datetime

expired\_count: int

frozen\_money\_sum: float

marker\_id: str

markup\_duration\_sec: float

payed\_money\_count: int

payed\_money\_sum: float

period\_started\_at: datetime

quality\_count: int

quality\_sum: float

rejected\_count: int

rejected\_money\_sum: float

skipped\_count: int

submitted\_count: int

task\_id: str

### [](#%5Fimageresult)ImageResult

class crowd\_sdk.tagme.http\_client.datacls.ImageResult(uid: str, file\_name: str, file\_size\_bytes: int, )

file\_name: str

file\_size\_bytes: int

uid: str

### [](#%5Finstalledplugin)InstalledPlugin

class crowd\_sdk.tagme.http\_client.datacls.InstalledPlugin(plugin\_template\_id: str, plugin\_assignment\_id: str, template\_roles: List\[Literal\['MARKER', 'CUSTOMER', 'ORGANIZATION\_ADMIN'\]\], roles: List\[Literal\['MARKER', 'CUSTOMER', 'ORGANIZATION\_ADMIN'\]\], enabled: bool, route: str, name: str, template\_organization\_id: str, scope: Literal\['SIDEBAR'\], created\_at: datetime.datetime, description: str, )

created\_at: datetime

description: str

enabled: bool

name: str

plugin\_assignment\_id: str

plugin\_template\_id: str

route: str

template\_organization\_id: str

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-InstalledPlugin-template%5Froles)InterfaceVersionInfo

class crowd\_sdk.tagme.http\_client.datacls.InterfaceVersionInfo(method\_id: str, version: int, created\_at: datetime.datetime, person\_id: str | NoneType = None, is\_autoupdate: bool | NoneType = False, updated\_keys: List\[str\] | NoneType = None, person: dict | NoneType = None, config\_content: dict | NoneType = None, config\_base\_version: int | NoneType = None, specification\_content: dict | NoneType = None, specification\_base\_version: int | NoneType = None, html\_content: str | NoneType = None, html\_base\_version: int | NoneType = None, css\_content: str | NoneType = None, css\_base\_version: int | NoneType = None, js\_content: str | NoneType = None, js\_base\_version: int | NoneType = None, example\_content: dict | NoneType = None, example\_base\_version: int | NoneType = None, )

config\_base\_version: int | None = None

config\_content: dict | None = None

created\_at: datetime

css\_base\_version: int | None = None

css\_content: str | None = None

example\_base\_version: int | None = None

example\_content: dict | None = None

html\_base\_version: int | None = None

html\_content: str | None = None

is\_autoupdate: bool | None = False

js\_base\_version: int | None = None

js\_content: str | None = None

method\_id: str

person: dict | None = None

person\_id: str | None = None

specification\_base\_version: int | None = None

specification\_content: dict | None = None

updated\_keys: List\[str\] | None = None

version: int

### [](#%5Finviteapplication)InviteApplication

class crowd\_sdk.tagme.http\_client.datacls.InviteApplication(state: str, invite\_id: str, created\_date: datetime.datetime, person\_id: str, uid: str, invite\_name: str | NoneType, person: [crowd\_sdk.tagme.http\_client.datacls.InvitePerson](#crowd%5Fsdk-tagme-http%5Fclient-datacls-InvitePerson) | NoneType, )

created\_date: datetime

invite\_id: str

invite\_name: str | None

person: [InvitePerson](#crowd%5Fsdk-tagme-http%5Fclient-datacls-InvitePerson) | None

person\_id: str

state: str

uid: str

### [](#%5Finvitedata)InviteData

class crowd\_sdk.tagme.http\_client.datacls.InviteData(state: str, current\_new\_requests\_count: int, acceptance\_strategy: str, organization\_id: str, expired\_date: datetime.datetime | NoneType, uid: str, current\_requests\_count: int, invite\_name: str, max\_requests\_count: int | NoneType, created\_date: datetime.datetime, author\_id: str, pools\_to\_assign: List\[str\] | NoneType, auto\_accept\_emails: str | NoneType, )

acceptance\_strategy: str

author\_id: str

auto\_accept\_emails: str | None

created\_date: datetime

current\_new\_requests\_count: int

current\_requests\_count: int

expired\_date: datetime | None

invite\_name: str

max\_requests\_count: int | None

organization\_id: str

pools\_to\_assign: List\[str\] | None

state: str

uid: str

### [](#%5Finviteperson)InvitePerson

class crowd\_sdk.tagme.http\_client.datacls.InvitePerson(email: str, first\_name: str, last\_name: str, middle\_name: str | NoneType, phone\_number: str | NoneType, source\_platform: str | NoneType, )

email: str

first\_name: str

last\_name: str

middle\_name: str | None

phone\_number: str | None

source\_platform: str | None

### [](#%5Finviterequest)InviteRequest

class crowd\_sdk.tagme.http\_client.datacls.InviteRequest(acceptance\_strategy: str, organization\_id: str, invite\_name: str, state: str | NoneType = None, max\_requests\_count: int | NoneType = None, expired\_date: datetime.datetime | NoneType = None, pools\_to\_assign: List\[str\] | NoneType = None, auto\_accept\_emails: str | NoneType = None, )

acceptance\_strategy: str

auto\_accept\_emails: str | None = None

expired\_date: datetime | None = None

invite\_name: str

max\_requests\_count: int | None = None

organization\_id: str

pools\_to\_assign: List\[str\] | None = None

state: str | None = None

### [](#%5Fitem)Item

class crowd\_sdk.tagme.http\_client.datacls.Item(stat: [crowd\_sdk.tagme.http\_client.datacls.ItemStat](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ItemStat), )

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-Item-stat)ItemStat

class crowd\_sdk.tagme.http\_client.datacls.ItemStat(task\_overlap: int, in\_progress: int, in\_review: int, rejected: int, accepted: int, overlap: int | NoneType = None, )

accepted: int

in\_progress: int

in\_review: int

overlap: int | None = None

rejected: int

task\_overlap: int

### [](#%5Fmarkeractiveassignmentresponse)MarkerActiveAssignmentResponse

class crowd\_sdk.tagme.http\_client.datacls.MarkerActiveAssignmentResponse(assignments: List\[[crowd\_sdk.tagme.http\_client.datacls.ActiveAssignment](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ActiveAssignment)\], )

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkerActiveAssignmentResponse-assignments)MarkerAssignment

class crowd\_sdk.tagme.http\_client.datacls.MarkerAssignment(marker\_id: str, original\_assignment\_id: str | NoneType = None, )

marker\_id: str

original\_assignment\_id: str | None = None

### [](#%5Fmarkerpool)MarkerPool

class crowd\_sdk.tagme.http\_client.datacls.MarkerPool(marker\_id: str, pool\_id: str, priority: int | NoneType = None, )

marker\_id: str

pool\_id: str

priority: int | None = None

### [](#%5Fmarkerskill)MarkerSkill

class crowd\_sdk.tagme.http\_client.datacls.MarkerSkill(uid: str, name: str, person\_id: str, organization\_id: str, value: int, created\_date: datetime.datetime | NoneType, person: [crowd\_sdk.tagme.http\_client.datacls.Person](#crowd%5Fsdk-tagme-http%5Fclient-datacls-Person) | NoneType, )

created\_date: datetime | None

name: str

organization\_id: str

person: [Person](#crowd%5Fsdk-tagme-http%5Fclient-datacls-Person) | None

person\_id: str

uid: str

value: int

### [](#%5Fmarkerskilldataerror)MarkerSkillDataError

class crowd\_sdk.tagme.http\_client.datacls.MarkerSkillDataError(code: str, message: str, value: Any | NoneType, row: int, )

code: str

message: str

row: int

value: Any | None

### [](#%5Fmarkerskillupdated)MarkerSkillUpdated

class crowd\_sdk.tagme.http\_client.datacls.MarkerSkillUpdated(person: str, skill: str, row: int, )

person: str

row: int

skill: str

### [](#%5Fmarkerstatinproject)MarkerStatInProject

class crowd\_sdk.tagme.http\_client.datacls.MarkerStatInProject(marker\_id: str, total\_money: float, marking\_duration\_secs: int, )

marker\_id: str

marking\_duration\_secs: int

total\_money: float

### [](#%5Fmarkerstats)MarkerStats

class crowd\_sdk.tagme.http\_client.datacls.MarkerStats(items: List\[[crowd\_sdk.tagme.http\_client.datacls.MarkerStatInProject](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkerStatInProject)\], )

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkerStats-items)MarkersError

class crowd\_sdk.tagme.http\_client.datacls.MarkersError(email\_list: List\[str\], error\_message: str, )

error\_message: str

### [](#%5Fmarkersstatistic)MarkersStatistic

class crowd\_sdk.tagme.http\_client.datacls.MarkersStatistic(date: str, organization: str, project: str, project\_id: str, task: str, task\_id: str, marker\_id: str, avg\_time: float, overall\_time: float, blocked\_price: float | NoneType = None, sum\_price: float | NoneType = None, fio: str | NoneType = None, email: str | NoneType = None, begin: datetime.datetime | NoneType = None, end: datetime.datetime | NoneType = None, marked: int = 0, skipped: int = 0, accepted: int = 0, rejected: int = 0, submitted: int = 0, expired: int = 0, avg\_quality: float | NoneType = None, avg\_consistency: float | NoneType = None, rejected\_price: float | NoneType = None, bonus\_plus\_penalty: float | NoneType = None, count\_quality: int | NoneType = None, )

accepted: int = 0

avg\_consistency: float | None = None

avg\_quality: float | None = None

avg\_time: float

begin: datetime | None = None

blocked\_price: float | None = None

bonus\_plus\_penalty: float | None = None

count\_quality: int | None = None

date: str

email: str | None = None

end: datetime | None = None

expired: int = 0

fio: str | None = None

marked: int = 0

marker\_id: str

organization: str

overall\_time: float

project: str

project\_id: str

rejected: int = 0

rejected\_price: float | None = None

skipped: int = 0

submitted: int = 0

sum\_price: float | None = None

task: str

task\_id: str

### [](#%5Fmarkupmarkerstatistic)MarkupMarkerStatistic

class crowd\_sdk.tagme.http\_client.datacls.MarkupMarkerStatistic(stat\_at: datetime.date, task\_type: [crowd\_sdk.tagme.http\_client.datacls.TaskType](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskType), marking\_duration: int, marked: int, accepted: int, accepted\_money: float, frozen: int, frozen\_money: float, project\_id: str, project\_name: str, skills: List\[[crowd\_sdk.tagme.http\_client.datacls.MarkupMarkerStatisticSkill](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupMarkerStatisticSkill)\], )

accepted: int

accepted\_money: float

frozen: int

frozen\_money: float

marked: int

marking\_duration: int

project\_id: str

project\_name: str

stat\_at: date

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupMarkerStatistic-task%5Ftype)MarkupMarkerStatisticSkill

class crowd\_sdk.tagme.http\_client.datacls.MarkupMarkerStatisticSkill(id: str, name: str, level: int, )

id: str

level: int

name: str

### [](#%5Fmarkupmarkerstatistics)MarkupMarkerStatistics

class crowd\_sdk.tagme.http\_client.datacls.MarkupMarkerStatistics(items: List\[[crowd\_sdk.tagme.http\_client.datacls.MarkupMarkerStatistic](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupMarkerStatistic)\], has\_next: bool, )

has\_next: bool

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupMarkerStatistics-items)MarkupMarkerStatisticsSortField

class crowd\_sdk.tagme.http\_client.datacls.MarkupMarkerStatisticsSortField(value, )

An enumeration.

STAT\_AT \= 'stat\_at'

### [](#%5Fmarkupresult)MarkupResult

class crowd\_sdk.tagme.http\_client.datacls.MarkupResult(id: str, project\_id: str, task\_id: str, marker\_id: str, items: List\[[crowd\_sdk.tagme.http\_client.datacls.MarkupResultItem](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupResultItem)\], status: str, start\_date: datetime.datetime, end\_date: datetime.datetime | NoneType, quality: float | NoneType, consistency: float | NoneType, result: dict | NoneType, submitted\_at: datetime.datetime | NoneType, accepted\_at: datetime.datetime | NoneType, skipped\_at: datetime.datetime | NoneType, expired\_at: datetime.datetime | NoneType, rejected\_at: datetime.datetime | NoneType, reviewer\_id: str | NoneType, reviewer\_comment: str | NoneType, original\_assignment\_id: str | NoneType, is\_review\_public: bool | NoneType, )

accepted\_at: datetime | None

consistency: float | None

end\_date: datetime | None

expired\_at: datetime | None

id: str

is\_review\_public: bool | None

marker\_id: str

original\_assignment\_id: str | None

project\_id: str

quality: float | None

rejected\_at: datetime | None

result: dict | None

reviewer\_comment: str | None

reviewer\_id: str | None

skipped\_at: datetime | None

start\_date: datetime

status: str

submitted\_at: datetime | None

task\_id: str

### [](#%5Fmarkupresultitem)MarkupResultItem

class crowd\_sdk.tagme.http\_client.datacls.MarkupResultItem(id: str, type: str, file\_name: str, control: Dict | NoneType, )

control: Dict | None

file\_name: str

id: str

type: str

### [](#%5Fmarkupresultsortfield)MarkupResultSortField

class crowd\_sdk.tagme.http\_client.datacls.MarkupResultSortField(value, )

An enumeration.

ACCEPTED \= 'accepted'

CONSISTENCY \= 'consistency'

EXPIRED \= 'expired'

ITEM\_ID \= 'item\_id'

ITEM\_TYPE \= 'item\_type'

MARKUP\_DURATION \= 'markup\_duration'

QUALITY \= 'quality'

REJECTED \= 'rejected'

SKIPPED \= 'skipped'

STATUS \= 'status'

SUBMITTED \= 'submitted'

### [](#%5Fmarkupresults)MarkupResults

class crowd\_sdk.tagme.http\_client.datacls.MarkupResults(items: List\[[crowd\_sdk.tagme.http\_client.datacls.MarkupResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupResult)\], has\_next: bool, )

has\_next: bool

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupResults-items)MarkupReview

class crowd\_sdk.tagme.http\_client.datacls.MarkupReview(assignment\_id: str, status: str | NoneType = None, comment: str | NoneType = None, is\_review\_public: bool | NoneType = None, quality: float | NoneType = None, is\_delete\_quality\_when\_empty: bool | NoneType = None, is\_delete\_comment\_when\_empty: bool | NoneType = None, )

assignment\_id: str

comment: str | None = None

is\_delete\_comment\_when\_empty: bool | None = None

is\_delete\_quality\_when\_empty: bool | None = None

is\_review\_public: bool | None = None

quality: float | None = None

status: str | None = None

### [](#%5Fmarkupreviewresult)MarkupReviewResult

class crowd\_sdk.tagme.http\_client.datacls.MarkupReviewResult(failed\_assignment\_ids: Dict\[str, str\] | NoneType, )

failed\_assignment\_ids: Dict\[str, str\] | None

### [](#%5Fmarkuptask)MarkupTask

class crowd\_sdk.tagme.http\_client.datacls.MarkupTask(id: str, project\_name: str, assignment\_timeout\_seconds: float, skippable: bool, brief\_url: str, file\_url: str, form\_url: str, premarkup\_url: str, price: float, item\_id: str, empty: bool = False, started\_at: datetime.datetime | NoneType = None, )

assignment\_timeout\_seconds: float

brief\_url: str

### [](#%5Fbuild%5Fempty%5Ftask)build\_empty\_task

static build\_empty\_task() → [MarkupTask](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkupTask)

empty: bool = False

file\_url: str

form\_url: str

id: str

item\_id: str

premarkup\_url: str

price: float

project\_name: str

skippable: bool

started\_at: datetime | None = None

### [](#%5Fmarkuptaskfile)MarkupTaskFile

class crowd\_sdk.tagme.http\_client.datacls.MarkupTaskFile(name: str, content\_type: str, content: aiohttp.streams.StreamReader, \_MarkupTaskFile\_\_bytes: bytes | NoneType = None, )

### [](#%5Fas%5Fdict)as\_dict

async as\_dict() → Any

content: StreamReader

content\_type: str

name: str

### [](#%5Fread)read

async read() → bytes

### [](#%5Fsave)save

async save(path: Path | str, ) → Path

### [](#%5Fmember)Member

class crowd\_sdk.tagme.http\_client.datacls.Member(uid: str, person: 'Person', priority: int | NoneType = None, )

priority: int | None = None

uid: str

### [](#%5Fmetadata)MetaData

class crowd\_sdk.tagme.http\_client.datacls.MetaData(control: dict | NoneType = None, premarkup: dict | NoneType = None, explanation: Any | NoneType = None, )

control: dict | None = None

explanation: Any | None = None

premarkup: dict | None = None

### [](#%5Fmetatype)MetaType

class crowd\_sdk.tagme.http\_client.datacls.MetaType(value, )

An enumeration.

CONTROL \= 'control'

EXPLANATION \= 'explanation'

PREMARKUP \= 'premarkup'

### [](#%5Fmethoddata)MethodData

class crowd\_sdk.tagme.http\_client.datacls.MethodData(uid: str, name: str | NoneType = None, forms: [crowd\_sdk.tagme.http\_client.datacls.MethodForms](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MethodForms) | NoneType = None, marker\_brief: str | NoneType = None, organization\_id: str | NoneType = None, person\_id: str | NoneType = None, modification\_date: str | NoneType = None, is\_brief\_as\_url: bool | NoneType = None, brief\_update\_date: str | NoneType = None, forms\_update\_date: str | NoneType = None, config\_update\_date: str | NoneType = None, )

brief\_update\_date: str | None = None

config\_update\_date: str | None = None

forms: [MethodForms](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MethodForms) | None = None

forms\_update\_date: str | None = None

is\_brief\_as\_url: bool | None = None

marker\_brief: str | None = None

modification\_date: str | None = None

name: str | None = None

organization\_id: str | None = None

person\_id: str | None = None

uid: str

### [](#%5Fmethoddatarequest)MethodDataRequest

class crowd\_sdk.tagme.http\_client.datacls.MethodDataRequest(uid: str, name: str | NoneType = None, forms: [crowd\_sdk.tagme.http\_client.datacls.MethodFormsRequest](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MethodFormsRequest) | NoneType = None, marker\_brief: str | NoneType = None, organization\_id: str | NoneType = None, person\_id: str | NoneType = None, modification\_date: str | NoneType = None, is\_brief\_as\_url: bool | NoneType = None, brief\_update\_date: str | NoneType = None, forms\_update\_date: str | NoneType = None, config\_update\_date: str | NoneType = None, )

brief\_update\_date: str | None = None

config\_update\_date: str | None = None

forms: [MethodFormsRequest](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MethodFormsRequest) | None = None

forms\_update\_date: str | None = None

is\_brief\_as\_url: bool | None = None

marker\_brief: str | None = None

modification\_date: str | None = None

name: str | None = None

organization\_id: str | None = None

person\_id: str | None = None

uid: str

### [](#%5Fmethodfiletype)MethodFileType

class crowd\_sdk.tagme.http\_client.datacls.MethodFileType(value, )

An enumeration.

BRIEF \= 'brief'

### [](#%5Fmethodforms)MethodForms

class crowd\_sdk.tagme.http\_client.datacls.MethodForms(example: dict = <factory>, config: dict = <factory>, specification: dict = <factory>, html: Union\[str, NoneType\] = '', css: Union\[str, NoneType\] = '', js: Union\[str, NoneType\] = '', )

config: dict

css: str | None = ''

example: dict

html: str | None = ''

js: str | None = ''

specification: dict

### [](#%5Fmethodformsrequest)MethodFormsRequest

class crowd\_sdk.tagme.http\_client.datacls.MethodFormsRequest(example: dict | NoneType = None, config: dict | NoneType = None, specification: dict | NoneType = None, html: str | NoneType = None, css: str | NoneType = None, js: str | NoneType = None, )

config: dict | None = None

css: str | None = None

example: dict | None = None

html: str | None = None

js: str | None = None

specification: dict | None = None

### [](#%5Fmodel)Model

class crowd\_sdk.tagme.http\_client.datacls.Model(uid: str, created\_at: datetime.datetime, name: str, description: str, project\_id: str, dataset\_id: str, author\_id: str, organization\_id: str, train\_id: str | NoneType = None, test\_id: str | NoneType = None, )

author\_id: str

created\_at: datetime

dataset\_id: str

description: str

name: str

organization\_id: str

project\_id: str

test\_id: str | None = None

train\_id: str | None = None

uid: str

### [](#%5Fmodelcreaterequest)ModelCreateRequest

class crowd\_sdk.tagme.http\_client.datacls.ModelCreateRequest(name: str, description: str, project\_id: str, dataset\_id: str, train\_id: str | NoneType = None, test\_id: str | NoneType = None, )

dataset\_id: str

description: str

name: str

project\_id: str

test\_id: str | None = None

train\_id: str | None = None

### [](#%5Forganization)Organization

class crowd\_sdk.tagme.http\_client.datacls.Organization(uid: str, name: str, employ\_date: Union\[datetime.datetime, NoneType\], employee\_id: str, roles: List\[str\] = <factory>, profile: Dict\[str, Any\] = <factory>, report: Dict\[str, Any\] = <factory>, config: Dict\[str, Any\] = <factory>, )

employ\_date: datetime | None

employee\_id: str

name: str

uid: str

### [](#%5Forganizationconfig)OrganizationConfig

class crowd\_sdk.tagme.http\_client.datacls.OrganizationConfig(help\_center\_url: str | NoneType, marker\_faq\_url: str | NoneType, price\_instruction\_lnk: str | NoneType, )

help\_center\_url: str | None

marker\_faq\_url: str | None

price\_instruction\_lnk: str | None

### [](#%5Forganizationconfiguration)OrganizationConfiguration

class crowd\_sdk.tagme.http\_client.datacls.OrganizationConfiguration(mms\_business\_task\_id: str, mms\_model\_version\_id: str, business\_task\_name: str | NoneType = None, model\_name: str | NoneType = None, model\_version\_confidentional\_category: str | NoneType = None, organization\_id: str | NoneType = None, )

business\_task\_name: str | None = None

mms\_business\_task\_id: str

mms\_model\_version\_id: str

model\_name: str | None = None

model\_version\_confidentional\_category: str | None = None

organization\_id: str | None = None

### [](#%5Forganizationemployee)OrganizationEmployee

class crowd\_sdk.tagme.http\_client.datacls.OrganizationEmployee(first\_name: str, last\_name: str, uid: str, )

first\_name: str

last\_name: str

uid: str

### [](#%5Forganizationstatistic)OrganizationStatistic

class crowd\_sdk.tagme.http\_client.datacls.OrganizationStatistic(projects\_count: int | NoneType = None, projects\_with\_active\_tasks: int | NoneType = None, opened\_tasks: int | NoneType = None, done\_tasks: int | NoneType = None, marked\_count: int | NoneType = None, unmarked\_count: int | NoneType = None, pools\_count: int | NoneType = None, markers\_pools\_count: int | NoneType = None, validators\_pools\_count: int | NoneType = None, markers\_count: int | NoneType = None, validators\_count: int | NoneType = None, )

done\_tasks: int | None = None

marked\_count: int | None = None

markers\_count: int | None = None

markers\_pools\_count: int | None = None

opened\_tasks: int | None = None

pools\_count: int | None = None

projects\_count: int | None = None

projects\_with\_active\_tasks: int | None = None

unmarked\_count: int | None = None

validators\_count: int | None = None

validators\_pools\_count: int | None = None

### [](#%5Foverlapsource)OverlapSource

class crowd\_sdk.tagme.http\_client.datacls.OverlapSource(value, )

An enumeration.

FROM\_TASK \= 'FROM\_TASK'

USER\_DEFINED \= 'USER\_DEFINED'

### [](#%5Fperson)Person

class crowd\_sdk.tagme.http\_client.datacls.Person(email: str, first\_name: str, last\_name: str, uid: str, middle\_name: str | NoneType = None, organizations: List\[[crowd\_sdk.tagme.http\_client.datacls.Organization](#crowd%5Fsdk-tagme-http%5Fclient-datacls-Organization)\] | NoneType = None, phone\_number: str | NoneType = None, source\_platform: str | NoneType = None, partner\_id: str | NoneType = None, utm\_referral: str | NoneType = None, )

email: str

first\_name: str

### [](#%5Fget%5Fconfig)get\_config

get\_config(organization: str, ) → Dict\[str, Any\] | None

### [](#%5Fget%5Ffio)get\_fio

get\_fio() → str

### [](#%5Fget%5Forganization)get\_organization

get\_organization(organization: str, ) → [Organization](#crowd%5Fsdk-tagme-http%5Fclient-datacls-Organization) | None

### [](#%5Fget%5Fprofile)get\_profile

get\_profile(organization: str, ) → Dict\[str, Any\] | None

### [](#%5Fget%5Freport)get\_report

get\_report(organization: str, ) → Dict\[str, Any\] | None

### [](#%5Fget%5Froles)get\_roles

get\_roles(organization: str, ) → List\[str\] | None

last\_name: str

middle\_name: str | None = None

organizations: List\[[Organization](#crowd%5Fsdk-tagme-http%5Fclient-datacls-Organization)\] | None = None

partner\_id: str | None = None

phone\_number: str | None = None

source\_platform: str | None = None

uid: str

utm\_referral: str | None = None

### [](#%5Fplugin)Plugin

class crowd\_sdk.tagme.http\_client.datacls.Plugin(type: [crowd\_sdk.tagme.http\_client.datacls.PluginTypes](#crowd%5Fsdk-tagme-http%5Fclient-datacls-PluginTypes), route: str, icon: str, title: str, bundle: str, data: dict | NoneType, )

bundle: str

data: dict | None

icon: str

route: str

title: str

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-Plugin-type)PluginAssignment

class crowd\_sdk.tagme.http\_client.datacls.PluginAssignment(uid: str, plugin\_template\_id: str, organization\_id: str, roles: List\[Literal\['MARKER', 'CUSTOMER', 'ORGANIZATION\_ADMIN'\]\], enabled: bool, route: str, icon\_file\_id: str, created\_at: datetime.datetime, )

created\_at: datetime

enabled: bool

icon\_file\_id: str

organization\_id: str

plugin\_template\_id: str

route: str

uid: str

### [](#%5Fplugininstallation)PluginInstallation

class crowd\_sdk.tagme.http\_client.datacls.PluginInstallation(plugin\_assignment\_id: str, organization\_id: str, organization\_name: str, roles: List\[Literal\['MARKER', 'CUSTOMER', 'ORGANIZATION\_ADMIN'\]\], )

organization\_id: str

organization\_name: str

plugin\_assignment\_id: str

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-PluginInstallation-roles)PluginTemplate

class crowd\_sdk.tagme.http\_client.datacls.PluginTemplate(uid: str, name: str, person\_id: str, organization\_id: str, access: Literal\['public', 'organization', 'private'\], acl: List\[str\] | NoneType, status: Literal\['DRAFT', 'PUBLISHED', 'ARCHIVED'\], scope: Literal\['SIDEBAR'\], roles: List\[Literal\['MARKER', 'CUSTOMER', 'ORGANIZATION\_ADMIN'\]\], description: str | NoneType, contacts: str | NoneType, title: str | NoneType, icon\_file\_id: str, bundle\_file\_id: str, preview\_file\_id: str, installations\_count: int, created\_at: datetime.datetime, updated\_at: datetime.datetime, documentation: str | NoneType = None, config: dict | NoneType = None, )

acl: List\[str\] | None

bundle\_file\_id: str

config: dict | None = None

contacts: str | None

created\_at: datetime

description: str | None

documentation: str | None = None

icon\_file\_id: str

installations\_count: int

name: str

organization\_id: str

person\_id: str

preview\_file\_id: str

title: str | None

uid: str

updated\_at: datetime

### [](#%5Fplugintemplatefileresult)PluginTemplateFileResult

class crowd\_sdk.tagme.http\_client.datacls.PluginTemplateFileResult(template\_file\_id: str, )

template\_file\_id: str

### [](#%5Fplugintypes)PluginTypes

class crowd\_sdk.tagme.http\_client.datacls.PluginTypes(value, )

An enumeration.

CUSTOMER \= 'CUSTOMER'

MARKER \= 'MARKER'

### [](#%5Fpool)Pool

class crowd\_sdk.tagme.http\_client.datacls.Pool(name: str, uid: str, person\_id: str, person: Union\[ForwardRef('Person'), NoneType\] = None, members\_count: Union\[int, NoneType\] = 0, members: List\[crowd\_sdk.tagme.http\_client.datacls.Member\] = <factory>, organization\_id: Union\[str, NoneType\] = None, organization: Union\[crowd\_sdk.tagme.http\_client.datacls.PoolOrganization, NoneType\] = None, access: Union\[Literal\['public', 'organization', 'private'\], NoneType\] = None, acl: Union\[List\[str\], NoneType\] = None, group\_type: Literal\['MARKERS', 'VALIDATORS'\] = 'MARKERS', )

access: Literal\['public', 'organization', 'private'\] | None = None

acl: List\[str\] | None = None

group\_type: Literal\['MARKERS', 'VALIDATORS'\] = 'MARKERS'

members\_count: int | None = 0

name: str

organization: [PoolOrganization](#crowd%5Fsdk-tagme-http%5Fclient-datacls-PoolOrganization) | None = None

organization\_id: str | None = None

person: [Person](#crowd%5Fsdk-tagme-http%5Fclient-datacls-Person) | None = None

person\_id: str

uid: str

### [](#%5Fpoolorganization)PoolOrganization

class crowd\_sdk.tagme.http\_client.datacls.PoolOrganization(uid: str, name: str, )

name: str

uid: str

### [](#%5Fpreviewfileresult)PreviewFileResult

class crowd\_sdk.tagme.http\_client.datacls.PreviewFileResult(preview\_file\_id: str, )

preview\_file\_id: str

### [](#%5Fproject)Project

class crowd\_sdk.tagme.http\_client.datacls.Project(organization\_id: str, name: str, description: str, inner\_comment: str, pools: List\[str\], uid: str, method\_id: str, person\_id: str, created\_date: datetime.datetime | NoneType, update\_date: datetime.datetime | NoneType, running\_tasks\_count: int | NoneType, tasks\_count: int | NoneType, is\_archived: bool = False, method: Union\[ForwardRef('MethodData'), NoneType\] = None, is\_bookmarked: bool = False, pipeline: dict | NoneType = None, is\_pipeline\_enabled: bool | NoneType = False, template\_id: str | NoneType = None, is\_brief\_autoupdate: bool | NoneType = False, is\_forms\_autoupdate: bool | NoneType = False, is\_config\_autoupdate: bool | NoneType = False, is\_specification\_autoupdate: bool | NoneType = False, markers\_count\_plan: int | NoneType = None, pipeline\_errors: str | NoneType = None, contacts: str | NoneType = None, )

contacts: str | None = None

created\_date: datetime | None

description: str

inner\_comment: str

is\_archived: bool = False

is\_bookmarked: bool = False

is\_brief\_autoupdate: bool | None = False

is\_config\_autoupdate: bool | None = False

is\_forms\_autoupdate: bool | None = False

is\_pipeline\_enabled: bool | None = False

is\_specification\_autoupdate: bool | None = False

markers\_count\_plan: int | None = None

method: [MethodData](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MethodData) | None = None

method\_id: str

name: str

organization\_id: str

person\_id: str

pipeline: dict | None = None

pipeline\_errors: str | None = None

running\_tasks\_count: int | None

tasks\_count: int | None

template\_id: str | None = None

uid: str

update\_date: datetime | None

### [](#%5Fprojectstat)ProjectStat

class crowd\_sdk.tagme.http\_client.datacls.ProjectStat(avg\_income: float | NoneType, min\_price: float | NoneType, max\_price: float | NoneType, study\_price: float | NoneType, exam\_price: float | NoneType, )

avg\_income: float | None

exam\_price: float | None

max\_price: float | None

min\_price: float | None

study\_price: float | None

### [](#%5Fprojectstatistic)ProjectStatistic

class crowd\_sdk.tagme.http\_client.datacls.ProjectStatistic(project\_id: str, markers\_count: int | NoneType = None, validators\_count: int | NoneType = None, pools\_count: int | NoneType = None, markers\_pools\_count: int | NoneType = None, validators\_pools\_count: int | NoneType = None, objects\_count: int | NoneType = None, marked\_count: int | NoneType = None, status: str | NoneType = None, tasks\_count: int | NoneType = None, active\_marker\_count: int | NoneType = None, )

active\_marker\_count: int | None = None

marked\_count: int | None = None

markers\_count: int | None = None

markers\_pools\_count: int | None = None

objects\_count: int | None = None

pools\_count: int | None = None

project\_id: str

status: str | None = None

tasks\_count: int | None = None

validators\_count: int | None = None

validators\_pools\_count: int | None = None

### [](#%5Fprojectstatistics)ProjectStatistics

class crowd\_sdk.tagme.http\_client.datacls.ProjectStatistics(min\_price: float | NoneType = None, max\_price: float | NoneType = None, min\_study\_price: float | NoneType = None, max\_study\_price: float | NoneType = None, min\_exam\_price: float | NoneType = None, max\_exam\_price: float | NoneType = None, min\_retry\_price: float | NoneType = None, max\_retry\_price: float | NoneType = None, )

max\_exam\_price: float | None = None

max\_price: float | None = None

max\_retry\_price: float | None = None

max\_study\_price: float | None = None

min\_exam\_price: float | None = None

min\_price: float | None = None

min\_retry\_price: float | None = None

min\_study\_price: float | None = None

### [](#%5Fprojecttask)ProjectTask

class crowd\_sdk.tagme.http\_client.datacls.ProjectTask(id: str, status: [TaskStatus](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskStatus), description: str, form\_url: str, brief\_url: str, is\_favourite\_project: bool, project\_name: str, project\_id: str, price: float, type: [TaskType](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskType), project\_stat: [ProjectStatistics](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ProjectStatistics), is\_auto\_accept: bool, method\_id: str | None = None, started\_at: datetime | None = None, min\_expired\_after: datetime | None = None, priority: int | None = None, max\_income: float | None = None, avg\_time: float | None = None, project\_description: str | None = None, )

Project-task entity

avg\_time: float | None = None

brief\_url: str

description: str

form\_url: str

id: str

is\_auto\_accept: bool

is\_favourite\_project: bool

max\_income: float | None = None

method\_id: str | None = None

min\_expired\_after: datetime | None = None

price: float

priority: int | None = None

project\_description: str | None = None

project\_id: str

project\_name: str

started\_at: datetime | None = None

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ProjectTask-type)ProjectTaskPaginated

class crowd\_sdk.tagme.http\_client.datacls.ProjectTaskPaginated(items: List\[[crowd\_sdk.tagme.http\_client.datacls.ProjectTask](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ProjectTask)\], has\_next: bool, )

has\_next: bool

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ProjectTaskPaginated-items)ProjectsWithPublicAssignment

class crowd\_sdk.tagme.http\_client.datacls.ProjectsWithPublicAssignment(project\_id: str, project\_name: str, last\_updated\_at: datetime.datetime, )

last\_updated\_at: datetime

project\_id: str

project\_name: str

### [](#%5Fpublicassignmentitem)PublicAssignmentItem

class crowd\_sdk.tagme.http\_client.datacls.PublicAssignmentItem(id: str, task\_id: str, status: [crowd\_sdk.tagme.http\_client.datacls.ReviewStatus](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ReviewStatus), updated\_at: datetime.datetime, reviewer\_comment: str | NoneType = None, reviewer\_id: str | NoneType = None, )

id: str

reviewer\_comment: str | None = None

reviewer\_id: str | None = None

task\_id: str

updated\_at: datetime

### [](#%5Fpublicskill)PublicSkill

class crowd\_sdk.tagme.http\_client.datacls.PublicSkill(id: str, value: int, count: int, )

count: int

id: str

value: int

### [](#%5Freviewstatus)ReviewStatus

class crowd\_sdk.tagme.http\_client.datacls.ReviewStatus(value, )

An enumeration.

ACCEPTED \= 'ACCEPTED'

REJECTED \= 'REJECTED'

SUBMITTED \= 'SUBMITTED'

### [](#%5Fspinfo)SPInfo

class crowd\_sdk.tagme.http\_client.datacls.SPInfo(report\_url: str, checking\_files\_count: int, rejected\_files\_count: int, error\_files\_count: int, )

checking\_files\_count: int

error\_files\_count: int

rejected\_files\_count: int

report\_url: str

### [](#%5Fsetmarkerskillresponse)SetMarkerSkillResponse

class crowd\_sdk.tagme.http\_client.datacls.SetMarkerSkillResponse(value: int, person\_id: str, skill\_id: str, )

person\_id: str

skill\_id: str

value: int

### [](#%5Fsetmarkersskillsresponse)SetMarkersSkillsResponse

class crowd\_sdk.tagme.http\_client.datacls.SetMarkersSkillsResponse(data\_errors: List\[[crowd\_sdk.tagme.http\_client.datacls.MarkerSkillDataError](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkerSkillDataError)\] | NoneType, updated\_skills: List\[[crowd\_sdk.tagme.http\_client.datacls.MarkerSkillUpdated](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkerSkillUpdated)\], )

data\_errors: List\[[MarkerSkillDataError](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MarkerSkillDataError)\] | None

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-SetMarkersSkillsResponse-updated%5Fskills)SimpleImagesListResult

class crowd\_sdk.tagme.http\_client.datacls.SimpleImagesListResult(images: List\[[crowd\_sdk.tagme.http\_client.datacls.ImageResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ImageResult)\], )

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-SimpleImagesListResult-images)Skill

class crowd\_sdk.tagme.http\_client.datacls.Skill(uid: str, name: str, person\_id: str, window\_size: int | NoneType = 64, enabled: bool = True, organization\_id: str | NoneType = None, marker\_count: int | NoneType = None, created\_date: datetime.datetime | NoneType = None, is\_public: bool = False, )

created\_date: datetime | None = None

enabled: bool = True

is\_public: bool = False

marker\_count: int | None = None

name: str

organization\_id: str | None = None

person\_id: str

uid: str

window\_size: int | None = 64

### [](#%5Fskillcheckresult)SkillCheckResult

class crowd\_sdk.tagme.http\_client.datacls.SkillCheckResult(status: [crowd\_sdk.tagme.http\_client.datacls.CheckStatus](#crowd%5Fsdk-tagme-http%5Fclient-datacls-CheckStatus), message: str | NoneType = None, uid: str | NoneType = None, )

uid: str | None = None

### [](#%5Fsortorder)SortOrder

class crowd\_sdk.tagme.http\_client.datacls.SortOrder(value, )

An enumeration.

ASC \= 'asc'

DESC \= 'desc'

### [](#%5Ftaskbonus)TaskBonus

class crowd\_sdk.tagme.http\_client.datacls.TaskBonus(author\_id: str, bonus: float, bonus\_at: datetime.datetime, comment: str, id: str, marker\_id: str, task\_id: str, average\_quality: float | NoneType = None, marked\_count: int | NoneType = None, marking\_duration\_secs: float | NoneType = None, )

author\_id: str

average\_quality: float | None = None

bonus: float

bonus\_at: datetime

comment: str

id: str

marked\_count: int | None = None

marker\_id: str

marking\_duration\_secs: float | None = None

task\_id: str

### [](#%5Ftaskbonuses)TaskBonuses

class crowd\_sdk.tagme.http\_client.datacls.TaskBonuses(items: List\[[crowd\_sdk.tagme.http\_client.datacls.TaskBonus](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskBonus)\], has\_next: bool, )

has\_next: bool

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskBonuses-items)TaskBonusesSummary

class crowd\_sdk.tagme.http\_client.datacls.TaskBonusesSummary(bonus\_summary: float, penalty\_summary: float, )

bonus\_summary: float

penalty\_summary: float

### [](#%5Ftaskdata)TaskData

class crowd\_sdk.tagme.http\_client.datacls.TaskData(project\_id: str, organization\_id: Union\[str, NoneType\], name: str, uid: str, person\_id: str, estimated\_files\_count: Union\[int, NoneType\], storage\_id: Union\[str, NoneType\], item\_timeout\_seconds: Union\[int, NoneType\], use\_project\_method: Union\[bool, NoneType\], payload: Union\[dict, NoneType\], data\_classification\_level: Union\[str, NoneType\], data\_source: Union\[str, NoneType\], control\_count: Union\[int, NoneType\], control\_fraction: Union\[int, NoneType\], created\_date: Union\[datetime.datetime, NoneType\], update\_date: Union\[datetime.datetime, NoneType\], start\_date: Union\[datetime.datetime, NoneType\], finished\_date: Union\[datetime.datetime, NoneType\], out\_skill\_id: Union\[str, NoneType\], deadline: Union\[datetime.date, NoneType\], expected\_consistency: Union\[float, NoneType\], expected\_quality: Union\[float, NoneType\], expected\_sum: Union\[float, NoneType\], filter: Union\[dict, NoneType\], type: crowd\_sdk.tagme.http\_client.datacls.TaskType = <TaskType.PROD: 'PROD'>, state: crowd\_sdk.tagme.http\_client.datacls.TaskState = <TaskState.INITIAL: 'INITIAL'>, is\_active: bool = False, overlap: int = 1, skip\_strategy: crowd\_sdk.tagme.http\_client.datacls.TaskSkipStrategy = <TaskSkipStrategy.NON\_SKIPPABLE: 'NON\_SKIPPABLE'>, deleted: bool = False, description: Union\[str, NoneType\] = '', depersonalize: bool = False, price: float = 0, priority: int = 0, is\_auto\_accept: bool = True, auto\_accept\_period\_day: Union\[int, NoneType\] = None, auto\_accept\_threshold: Union\[float, NoneType\] = None, is\_straight\_order: bool = False, max\_items\_per\_day: Union\[int, NoneType\] = None, attachments\_access: Union\[str, NoneType\] = None, attachments\_acl: Union\[List\[str\], NoneType\] = None, markers\_count\_plan: Union\[int, NoneType\] = None, )

attachments\_access: str | None = None

attachments\_acl: List\[str\] | None = None

auto\_accept\_period\_day: int | None = None

auto\_accept\_threshold: float | None = None

control\_count: int | None

control\_fraction: int | None

created\_date: datetime | None

data\_classification\_level: str | None

data\_source: str | None

deadline: date | None

deleted: bool = False

depersonalize: bool = False

description: str | None = ''

estimated\_files\_count: int | None

expected\_consistency: float | None

expected\_quality: float | None

expected\_sum: float | None

filter: dict | None

finished\_date: datetime | None

### [](#%5Fgen%5Furl)gen\_url

gen\_url(base\_url: str, ) → str

is\_active: bool = False

is\_auto\_accept: bool = True

is\_straight\_order: bool = False

item\_timeout\_seconds: int | None

markers\_count\_plan: int | None = None

max\_items\_per\_day: int | None = None

name: str

organization\_id: str | None

out\_skill\_id: str | None

overlap: int = 1

payload: dict | None

person\_id: str

price: float = 0

priority: int = 0

project\_id: str

skip\_strategy: [TaskSkipStrategy](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskSkipStrategy) \= 'NON\_SKIPPABLE'

start\_date: datetime | None

state: [TaskState](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskState) \= 'INITIAL'

storage\_id: str | None

type: [TaskType](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskType) \= 'PROD'

uid: str

update\_date: datetime | None

use\_project\_method: bool | None

### [](#%5Ftaskdatarequest)TaskDataRequest

class crowd\_sdk.tagme.http\_client.datacls.TaskDataRequest(project\_id: str, organization\_id: str, name: str, overlap: int = 1, type: crowd\_sdk.tagme.http\_client.datacls.TaskType = <TaskType.PROD: 'PROD'>, skip\_strategy: crowd\_sdk.tagme.http\_client.datacls.TaskSkipStrategy = <TaskSkipStrategy.NON\_SKIPPABLE: 'NON\_SKIPPABLE'>, description: Union\[str, NoneType\] = '', price: Union\[float, NoneType\] = None, priority: Union\[int, NoneType\] = None, data\_classification\_level: Union\[str, NoneType\] = None, data\_source: Union\[str, NoneType\] = None, control\_count: Union\[int, NoneType\] = None, control\_fraction: Union\[int, NoneType\] = None, item\_timeout\_seconds: Union\[int, NoneType\] = None, out\_skill\_id: Union\[str, NoneType\] = None, depersonalize: Union\[bool, NoneType\] = None, deadline: Union\[datetime.date, NoneType\] = None, expected\_consistency: Union\[float, NoneType\] = None, expected\_quality: Union\[float, NoneType\] = None, expected\_sum: Union\[float, NoneType\] = None, filter: Union\[dict, NoneType\] = None, is\_auto\_accept: bool = True, auto\_accept\_period\_day: Union\[int, NoneType\] = None, auto\_accept\_threshold: Union\[float, NoneType\] = None, is\_straight\_order: bool = False, max\_items\_per\_day: Union\[int, NoneType\] = None, attachments\_access: Union\[str, NoneType\] = None, attachments\_acl: Union\[List\[str\], NoneType\] = None, markers\_count\_plan: Union\[int, NoneType\] = None, )

attachments\_access: str | None = None

attachments\_acl: List\[str\] | None = None

auto\_accept\_period\_day: int | None = None

auto\_accept\_threshold: float | None = None

control\_count: int | None = None

control\_fraction: int | None = None

data\_classification\_level: str | None = None

data\_source: str | None = None

deadline: date | None = None

depersonalize: bool | None = None

description: str | None = ''

expected\_consistency: float | None = None

expected\_quality: float | None = None

expected\_sum: float | None = None

filter: dict | None = None

### [](#%5Ffrom%5Ftask%5Fdata)from\_task\_data

classmethod from\_task\_data(task\_data: [TaskData](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskData), ignore\_fields: Set\[str\] | None = None, ) → [TaskDataRequest](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskDataRequest)

is\_auto\_accept: bool = True

is\_straight\_order: bool = False

item\_timeout\_seconds: int | None = None

markers\_count\_plan: int | None = None

max\_items\_per\_day: int | None = None

name: str

organization\_id: str

out\_skill\_id: str | None = None

overlap: int = 1

price: float | None = None

priority: int | None = None

project\_id: str

skip\_strategy: [TaskSkipStrategy](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskSkipStrategy) \= 'NON\_SKIPPABLE'

type: [TaskType](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskType) \= 'PROD'

### [](#%5Ftaskfile)TaskFile

class crowd\_sdk.tagme.http\_client.datacls.TaskFile(content\_type: str, name: str, size: int, metadata: List\[[crowd\_sdk.tagme.http\_client.datacls.MetaType](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MetaType)\], bucket: str, hashsum: str | NoneType, data: str | NoneType, uid: str, file\_type: [crowd\_sdk.tagme.http\_client.datacls.FileType](#crowd%5Fsdk-tagme-http%5Fclient-datacls-FileType), enabled: bool | NoneType, )

bucket: str

content\_type: str

data: str | None

enabled: bool | None

hashsum: str | None

name: str

size: int

uid: str

### [](#%5Ftaskfilescount)TaskFilesCount

class crowd\_sdk.tagme.http\_client.datacls.TaskFilesCount(all: int | NoneType = None, control: int | NoneType = None, study: int | NoneType = None, data: int | NoneType = None, )

all: int | None = None

control: int | None = None

data: int | None = None

study: int | None = None

### [](#%5Ftaskhierarchy)TaskHierarchy

class crowd\_sdk.tagme.http\_client.datacls.TaskHierarchy(project\_id: str, organization\_id: str, template\_id: str | NoneType, )

organization\_id: str

project\_id: str

template\_id: str | None

### [](#%5Ftaskinfo)TaskInfo

class crowd\_sdk.tagme.http\_client.datacls.TaskInfo(id: str, status: [TaskStatus](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskStatus), started\_at: datetime | None = None, )

Minified task entity

id: str

started\_at: datetime | None = None

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskInfo-status)TaskMarkup

class crowd\_sdk.tagme.http\_client.datacls.TaskMarkup(pools: List\[str\], pick\_date: datetime.datetime, submit\_date: datetime.datetime, result: Dict\[str, Any\], )

pick\_date: datetime

submit\_date: datetime

### [](#%5Ftaskresult)TaskResult

class crowd\_sdk.tagme.http\_client.datacls.TaskResult(uid: str, entity\_id: str, task\_id: str, organization\_id: str, person\_id: str, storage\_id: Union\[str, NoneType\], file\_name: str, entity\_type: Union\[str, NoneType\], price: Union\[float, NoneType\], skip: Dict\[str, Any\] = <factory>, result: Dict\[str, Dict\[str, Any\]\] = <factory>, consistency\_percentage: Union\[float, NoneType\] = None, consistent\_result: Union\[bool, NoneType\] = None, consistent\_skip: Union\[bool, NoneType\] = None, )

### [](#%5Fappend%5Fassignment)append\_assignment

append\_assignment(assignment: [Assignment](#crowd%5Fsdk-tagme-http%5Fclient-datacls-Assignment), ) → None

consistency\_percentage: float | None = None

consistent\_result: bool | None = None

consistent\_skip: bool | None = None

entity\_id: str

entity\_type: str | None

file\_name: str

### [](#%5Ffrom%5Fassignments)from\_assignments

classmethod from\_assignments(item\_id: str, assignments: List\[[Assignment](#crowd%5Fsdk-tagme-http%5Fclient-datacls-Assignment)\], ) → [TaskResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskResult)

organization\_id: str

person\_id: str

price: float | None

storage\_id: str | None

task\_id: str

### [](#%5Fto%5Fdict)to\_dict

to\_dict() → dict

uid: str

### [](#%5Ftaskresultsvalidationinfo)TaskResultsValidationInfo

class crowd\_sdk.tagme.http\_client.datacls.TaskResultsValidationInfo(latest\_results: List\[[crowd\_sdk.tagme.http\_client.datacls.ValidationTaskResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ValidationTaskResult)\], latest\_statuses: List\[[crowd\_sdk.tagme.http\_client.datacls.ValidationTaskStatus](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ValidationTaskStatus)\], )

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskResultsValidationInfo-latest%5Fstatuses)TaskSkipStrategy

class crowd\_sdk.tagme.http\_client.datacls.TaskSkipStrategy(value, )

An enumeration.

COUNT\_AS\_MARKUP \= 'COUNT\_AS\_MARKUP'

IGNORE \= 'IGNORE'

NON\_SKIPPABLE \= 'NON\_SKIPPABLE'

### [](#%5Ftaskstate)TaskState

class crowd\_sdk.tagme.http\_client.datacls.TaskState(value, )

An enumeration.

ARCHIVE \= 'ARCHIVE'

DONE \= 'DONE'

INITIAL \= 'INITIAL'

RUNNING \= 'RUNNING'

STOPPED \= 'STOPPED'

### [](#%5Ftaskstatistics)TaskStatistics

class crowd\_sdk.tagme.http\_client.datacls.TaskStatistics(assigned: int, submitted: int, accepted: int, rejected: int, )

accepted: int

assigned: int

rejected: int

submitted: int

### [](#%5Ftaskstatisticsitem)TaskStatisticsItem

class crowd\_sdk.tagme.http\_client.datacls.TaskStatisticsItem(task\_id: str, objects\_count: int, marked\_count: int, total\_marked\_objects\_count: int, total\_skipped\_objects\_count: int, total\_expired\_objects\_count: int, total\_accepted\_objects\_count: int, total\_rejected\_objects\_count: int, total\_submitted\_objects\_count: int, total\_marked\_time: float, current\_overlap: float, total\_objects\_count: float, overlap\_marked\_stats: Dict\[str, Any\], updated\_date: datetime.datetime | NoneType, )

current\_overlap: float

marked\_count: int

objects\_count: int

task\_id: str

total\_accepted\_objects\_count: int

total\_expired\_objects\_count: int

total\_marked\_objects\_count: int

total\_marked\_time: float

total\_objects\_count: float

total\_rejected\_objects\_count: int

total\_skipped\_objects\_count: int

total\_submitted\_objects\_count: int

updated\_date: datetime | None

### [](#%5Ftaskstats)TaskStats

class crowd\_sdk.tagme.http\_client.datacls.TaskStats(task\_id: str, total\_marked\_time: float, objects\_count: int, marked\_count: int, total\_skipped\_objects\_count: int, total\_marked\_objects\_count: int, total\_accepted\_objects\_count: int, total\_rejected\_objects\_count: int, current\_overlap: int, total\_objects\_count: int, avg\_object\_count\_marker: float, status: [crowd\_sdk.tagme.http\_client.datacls.TaskState](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskState), one\_object\_avg\_time: float, active\_markers: int, total\_markers: int, finished\_marker: int | NoneType, pretending\_marker: int | NoneType, cost: float | NoneType, avg\_quality: float | NoneType, avg\_consistency: float | NoneType, avg\_hour\_profit: float | NoneType, )

active\_markers: int

avg\_consistency: float | None

avg\_hour\_profit: float | None

avg\_object\_count\_marker: float

avg\_quality: float | None

cost: float | None

current\_overlap: int

finished\_marker: int | None

marked\_count: int

objects\_count: int

one\_object\_avg\_time: float

pretending\_marker: int | None

task\_id: str

total\_accepted\_objects\_count: int

total\_marked\_objects\_count: int

total\_marked\_time: float

total\_markers: int

total\_objects\_count: int

total\_rejected\_objects\_count: int

total\_skipped\_objects\_count: int

### [](#%5Ftaskstatsadvanced)TaskStatsAdvanced

class crowd\_sdk.tagme.http\_client.datacls.TaskStatsAdvanced(estimation\_date: datetime.date | NoneType, in\_progress\_count: int, )

estimation\_date: date | None

in\_progress\_count: int

### [](#%5Ftaskstatus)TaskStatus

class crowd\_sdk.tagme.http\_client.datacls.TaskStatus(value, )

An enumeration.

ARCHIVE \= 'ARCHIVE'

RUN \= 'RUN'

STOP \= 'STOP'

### [](#%5Ftasktabitemstats)TaskTabItemStats

class crowd\_sdk.tagme.http\_client.datacls.TaskTabItemStats(item\_id: str, task\_overlap: int, overlap: int, in\_progress: int, in\_review: int, rejected: int, accepted: int, assigned: int, queue: int, overlap\_source: [crowd\_sdk.tagme.http\_client.datacls.OverlapSource](#crowd%5Fsdk-tagme-http%5Fclient-datacls-OverlapSource), )

accepted: int

assigned: int

in\_progress: int

in\_review: int

item\_id: str

overlap: int

queue: int

rejected: int

task\_overlap: int

### [](#%5Ftasktype)TaskType

class crowd\_sdk.tagme.http\_client.datacls.TaskType(value, )

An enumeration.

EXAM \= 'EXAM'

HONEYPOT \= 'HONEYPOT'

PROD \= 'PROD'

RETRY \= 'RETRY'

STUDY \= 'STUDY'

### [](#%5Ftaskunavailabilityreason)TaskUnavailabilityReason

class crowd\_sdk.tagme.http\_client.datacls.TaskUnavailabilityReason(reason\_code: [crowd\_sdk.tagme.http\_client.datacls.TaskUnavailabilityReasonCode](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskUnavailabilityReasonCode), reason\_description: str, )

reason\_description: str

### [](#%5Ftaskunavailabilityreasoncode)TaskUnavailabilityReasonCode

class crowd\_sdk.tagme.http\_client.datacls.TaskUnavailabilityReasonCode(value, )

An enumeration.

ALREADY\_MARKED \= 'ALREADY\_MARKED'

AVAILABLE \= 'AVAILABLE'

DAILY\_LIMIT\_REACHED \= 'DAILY\_LIMIT\_REACHED'

INACTIVE\_TASK \= 'INACTIVE\_TASK'

LOW\_POOL\_PRIORITY\_LEVEL \= 'LOW\_POOL\_PRIORITY\_LEVEL'

MORE\_IMPORTANT\_TASK\_AVAILABLE \= 'MORE\_IMPORTANT\_TASK\_AVAILABLE'

NOT\_IN\_POOL \= 'NOT\_IN\_POOL'

NO\_TASK \= 'NO\_TASK'

UNDEFINED \= 'UNDEFINED'

UNSUITABLE\_SKILL\_LEVEL \= 'UNSUITABLE\_SKILL\_LEVEL'

### [](#%5Ftaskflowtaskdata)TaskflowTaskData

class crowd\_sdk.tagme.http\_client.datacls.TaskflowTaskData(id: str, brief\_url: str, project\_name: str, description: str, project\_description: str | NoneType, form\_url: str, price: float, status: str, type: str, project\_stat: [crowd\_sdk.tagme.http\_client.datacls.ProjectStat](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ProjectStat), is\_auto\_accept: bool, )

brief\_url: str

description: str

form\_url: str

id: str

is\_auto\_accept: bool

price: float

project\_description: str | None

project\_name: str

status: str

type: str

### [](#%5Ftasksstatistic)TasksStatistic

class crowd\_sdk.tagme.http\_client.datacls.TasksStatistic(date: str, organization: str, project: str, project\_id: str, task: str, task\_id: str, overlap: int, avg\_time: float, overall\_time: float, count\_assignments: int = 0, count\_items: int = 0, completed\_items: int = 0, completed\_assignments: int = 0, accepted\_assignments: int = 0, rejected\_assignments: int = 0, submitted\_assignments: int = 0, skipped\_assignments: int = 0, expired\_assignments: int = 0, sum\_price: float | NoneType = None, blocked\_price: float | NoneType = None, avg\_consistency: float | NoneType = None, avg\_quality: float | NoneType = None, task\_type: str | NoneType = None, rejected\_price: float | NoneType = None, bonus\_plus\_penalty: float | NoneType = None, count\_quality: int | NoneType = None, )

accepted\_assignments: int = 0

avg\_consistency: float | None = None

avg\_quality: float | None = None

avg\_time: float

blocked\_price: float | None = None

bonus\_plus\_penalty: float | None = None

completed\_assignments: int = 0

completed\_items: int = 0

count\_assignments: int = 0

count\_items: int = 0

count\_quality: int | None = None

date: str

expired\_assignments: int = 0

organization: str

overall\_time: float

overlap: int

project: str

project\_id: str

rejected\_assignments: int = 0

rejected\_price: float | None = None

skipped\_assignments: int = 0

submitted\_assignments: int = 0

sum\_price: float | None = None

task: str

task\_id: str

task\_type: str | None = None

### [](#%5Ftemplate)Template

class crowd\_sdk.tagme.http\_client.datacls.Template(uid: str, name: str, person\_id: str, organization\_id: str, status: str, method\_id: str, preview\_file\_id: str | NoneType = '', description: str | NoneType = '', categories: List\[str\] | NoneType = None, gallery\_ids: List\[str\] | NoneType = None, created\_at: datetime.datetime | NoneType = None, updated\_at: datetime.datetime | NoneType = None, documentation: str | NoneType = '', dataset\_id: str | NoneType = None, contacts: str | NoneType = None, projects\_count: int | NoneType = 0, access: str | NoneType = None, acl: List\[str\] | NoneType = None, )

access: str | None = None

acl: List\[str\] | None = None

categories: List\[str\] | None = None

contacts: str | None = None

created\_at: datetime | None = None

dataset\_id: str | None = None

description: str | None = ''

documentation: str | None = ''

gallery\_ids: List\[str\] | None = None

method\_id: str

name: str

organization\_id: str

person\_id: str

preview\_file\_id: str | None = ''

projects\_count: int | None = 0

status: str

uid: str

updated\_at: datetime | None = None

### [](#%5Ftypecasting)TypeCasting

class crowd\_sdk.tagme.http\_client.datacls.TypeCasting

### [](#%5Fupdatemetadatarequest)UpdateMetaDataRequest

class crowd\_sdk.tagme.http\_client.datacls.UpdateMetaDataRequest(data: [crowd\_sdk.tagme.http\_client.datacls.MetaData](#crowd%5Fsdk-tagme-http%5Fclient-datacls-MetaData), fileId: str | NoneType = None, filename: str | NoneType = None, )

fileId: str | None = None

filename: str | None = None

### [](#%5Fuploadfilesresult)UploadFilesResult

class crowd\_sdk.tagme.http\_client.datacls.UploadFilesResult(created\_files: List\[crowd\_sdk.tagme.http\_client.datacls.File\] = <factory>, errors: List\[Union\[crowd\_sdk.tagme.http\_client.datacls.FileError, str\]\] = <factory>, )

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult-errors)extend

extend(other: [UploadFilesResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult), ) → None

### [](#%5Fmerge)merge

static merge(\*results: Any, ) → [UploadFilesResult](#crowd%5Fsdk-tagme-http%5Fclient-datacls-UploadFilesResult)

### [](#%5Fuserplugin)UserPlugin

class crowd\_sdk.tagme.http\_client.datacls.UserPlugin(title: str, route: str, icon\_file\_id: str, )

icon\_file\_id: str

route: str

title: str

### [](#%5Fvalidatetimestatistic)ValidateTimeStatistic

class crowd\_sdk.tagme.http\_client.datacls.ValidateTimeStatistic(created\_at: datetime.datetime, date: datetime.datetime, duration\_sec: int, task\_id: str, updated\_at: datetime.datetime, validator\_id: str, )

created\_at: datetime

date: datetime

duration\_sec: int

task\_id: str

updated\_at: datetime

validator\_id: str

### [](#%5Fvalidatetimestatistics)ValidateTimeStatistics

class crowd\_sdk.tagme.http\_client.datacls.ValidateTimeStatistics(items: List\[[crowd\_sdk.tagme.http\_client.datacls.ValidateTimeStatistic](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ValidateTimeStatistic)\], has\_next: bool, )

has\_next: bool

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ValidateTimeStatistics-items)ValidationPipelineResult

class crowd\_sdk.tagme.http\_client.datacls.ValidationPipelineResult(status: str, validators\_total: int, validators: List\[dict\], items\_total: int | NoneType = None, validated\_file\_id: str | NoneType = None, errors\_file\_id: str | NoneType = None, )

errors\_file\_id: str | None = None

items\_total: int | None = None

status: str

validated\_file\_id: str | None = None

validators\_total: int

### [](#%5Fvalidationrequestitem)ValidationRequestItem

class crowd\_sdk.tagme.http\_client.datacls.ValidationRequestItem(source: str, options: Dict\[str, Any\] = <factory>, )

source: str

### [](#%5Fvalidationtaskresult)ValidationTaskResult

class crowd\_sdk.tagme.http\_client.datacls.ValidationTaskResult(algorithm: str, params: dict, result\_file\_id: str, created\_at: datetime.datetime, errors\_file\_id: str | NoneType = None, mean\_result: float | NoneType = None, )

algorithm: str

created\_at: datetime

errors\_file\_id: str | None = None

mean\_result: float | None = None

params: dict

result\_file\_id: str

### [](#%5Fvalidationtaskstatus)ValidationTaskStatus

class crowd\_sdk.tagme.http\_client.datacls.ValidationTaskStatus(algorithm: str, status: str, updated\_at: datetime.datetime, message: str | NoneType = None, )

algorithm: str

message: str | None = None

status: str

updated\_at: datetime

### [](#%5Fvalidatordetail)ValidatorDetail

class crowd\_sdk.tagme.http\_client.datacls.ValidatorDetail(source: str, type: [crowd\_sdk.tagme.http\_client.datacls.ValidatorType](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ValidatorType), title: str, enabled: bool, stage: str, description: str, tags: List\[str\], options: dict, )

description: str

enabled: bool

options: dict

source: str

stage: str

title: str

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ValidatorDetail-type)ValidatorInfo

class crowd\_sdk.tagme.http\_client.datacls.ValidatorInfo(is\_validator: bool, )

is\_validator: bool

### [](#%5Fvalidatorproject)ValidatorProject

class crowd\_sdk.tagme.http\_client.datacls.ValidatorProject(project\_id: str, project\_name: str, project\_description: str, available\_task\_count: int, )

available\_task\_count: int

project\_description: str

project\_id: str

project\_name: str

### [](#%5Fvalidatortask)ValidatorTask

class crowd\_sdk.tagme.http\_client.datacls.ValidatorTask(task\_id: str, task\_status: [crowd\_sdk.tagme.http\_client.datacls.TaskStatus](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskStatus), task\_name: str, task\_type: [crowd\_sdk.tagme.http\_client.datacls.TaskType](#crowd%5Fsdk-tagme-http%5Fclient-datacls-TaskType), task\_description: str, num\_of\_submitted\_assignments: int, items\_completed: int, items\_total: int, priority: int, created\_at: datetime.datetime, author\_id: str | NoneType = None, auto\_accept\_threshold: float | NoneType = None, method\_id: str | NoneType = None, )

author\_id: str | None = None

auto\_accept\_threshold: float | None = None

created\_at: datetime

items\_completed: int

items\_total: int

method\_id: str | None = None

num\_of\_submitted\_assignments: int

priority: int

task\_description: str

task\_id: str

task\_name: str

### [](#crowd%5Fsdk-tagme-http%5Fclient-datacls-ValidatorTask-task%5Ftype)ValidatorType

class crowd\_sdk.tagme.http\_client.datacls.ValidatorType(value, )

An enumeration.

artifact \= 'artifact'

base \= 'base'

dataset\_backend \= 'dataset/backend'

dataset\_frontend \= 'dataset/frontend'

### [](#%5Fvendorchangerecord)VendorChangeRecord

class crowd\_sdk.tagme.http\_client.datacls.VendorChangeRecord(person\_id: str, created\_at: datetime.datetime, source\_platform: str | NoneType = None, partner\_id: str | NoneType = None, utm\_referral: str | NoneType = None, active\_from: datetime.datetime | NoneType = None, prev\_source\_platform: str | NoneType = None, prev\_partner\_id: str | NoneType = None, prev\_utm\_referral: str | NoneType = None, error: str | NoneType = None, )

active\_from: datetime | None = None

created\_at: datetime

error: str | None = None

partner\_id: str | None = None

person\_id: str

prev\_partner\_id: str | None = None

prev\_source\_platform: str | None = None

prev\_utm\_referral: str | None = None

source\_platform: str | None = None

utm\_referral: str | None = None

### [](#%5Fverifyloraconfiguration)VerifyLoraConfiguration

class crowd\_sdk.tagme.http\_client.datacls.VerifyLoraConfiguration(allowed: bool, business\_task\_name: str | NoneType, model\_version\_confidentional\_category: str | NoneType, )

allowed: bool

business\_task\_name: str | None

model\_version\_confidentional\_category: str | None

### [](#%5Ffmt%5Fdate)fmt\_date

crowd\_sdk.tagme.http\_client.datacls.fmt\_date(d: datetime | None, ) → str | None

undefined
====================
## [](#%5Furls)Urls

### [](#%5Fgen%5Fassignment%5Furl)gen\_assignment\_url

TagmeClientAdvanced.gen\_assignment\_url(assignment\_id: str, organization\_id: str | None = None, base\_url: str | None = None, ) → str

Generate assignment url

| Parameters | \* **task\_id** – task id. \* **assignment\_id** – assignment id. \* **organization\_id** – optional organization identifier. Defaults to None. \* **base\_url** – optional url prefix. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | link to assignment.                                                                                                                                                                     |

### [](#%5Fgen%5Ffile%5Furl)gen\_file\_url

TagmeClientAdvanced.gen\_file\_url(file\_id: str, base\_url: str | None = None, ) → str

Generate file url.

| Parameters | \* **file\_id** – file id. \* **base\_url** – optional url prefix. |
| ---------- | ------------------------------------------------------------------ |
| Returns    | link to file.                                                      |

### [](#%5Fgen%5Fproject%5Furl)gen\_project\_url

TagmeClientAdvanced.gen\_project\_url(project\_id: str, organization\_id: str | None = None, base\_url: str | None = None, ) → str

Generate project url.

| Parameters | \* **project\_id** – project id. \* **organization\_id** – optional organization identifier. Defaults to None. \* **base\_url** – optional url prefix. |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Returns    | link to project.                                                                                                                                       |

### [](#%5Fgen%5Ftask%5Furl)gen\_task\_url

TagmeClientAdvanced.gen\_task\_url(project\_id: str, task\_id: str, organization\_id: str | None = None, base\_url: str | None = None, ) → str

Generate task url.

| Parameters | \* **project\_id** – project id. \* **task\_id** – task id. \* **organization\_id** – optional organization identifier. Defaults to None. \* **base\_url** – optional url prefix. |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Returns    | link to task.                                                                                                                                                                     |

Модуль Dataset Builder
====================
Инструмент для генерации LLM-датасетов (SFT, DPO, Reward Modeling, Eval и др.) локально без Tagme API. Управляется через MCP-инструменты в Cursor или Claude Desktop.

## [](#%5Fконцепция)Концепция

Просто опиши в чате что нужно — инструмент сам создаст датасет, сгенерирует сэмплы и покажет статистику. Никакого написания скриптов вручную.

```none
"Создай датасет для fact-checking на русском, 500 сэмплов, разные домены"
        ↓
  Cursor Agent / Claude Desktop вызывает MCP-инструменты
        ↓
  datasets/fact_check/output/dataset.jsonl
```

## [](#%5Fподключение)Подключение

Модуль подключается отдельной субкомандой:

```bash
tagme mcp dataset
```

MCP-конфиг для Claude Desktop / Cursor:

```json
{
  "mcpServers": {
    "crowd-sdk-dataset": {
      "command": "tagme",
      "args": ["mcp", "dataset"]
    }
  }
}
```

## [](#%5Fфлоу%5Fработы)Флоу работы

### [](#%5Fстандартный%5Fфлоу)Стандартный флоу

```none
1. create_dataset
2. preview_dataset_setup → показать spec + config, дождаться OK пользователя
3. Редактирование spec.md / config.yaml (при необходимости)
4. generate_cases(n_cases=50)
5. generate_dataset(dry_run=True) → план, снова дождаться OK
6. generate_dataset(n_samples=...)
7. inspect_dataset
```

### [](#%5Fcompletion%5Fфлоу)Completion флоу

Если есть частичные данные (например, вопросы без ответов):

```python
# partial.jsonl:
# {"question": "Что такое фотосинтез?"}
# {"question": "Столица Австралии?"}

generate_dataset(name="my_dataset", inputs_file="partial.jsonl")
# LLM заполнит поля answer, options и др. по Output Schema
```

## [](#%5Fmcp%5Fинструменты)MCP-инструменты

### [](#%5Fcreate%5Fdataset)`create_dataset`

Создаёт структуру нового датасета из шаблона.

```python
create_dataset("my_dataset", "chat")
# Создаёт:
# datasets/my_dataset/spec.md     ← из шаблона spec_chat.md
# datasets/my_dataset/config.yaml ← из шаблона config_default.yaml
```

Поддерживаемые типы датасетов:

| Тип            | Назначение               | Ключевые поля                 |
| -------------- | ------------------------ | ----------------------------- |
| chat           | SFT / instruction tuning | messages: \[{role, content}\] |
| preference     | DPO обучение             | prompt, chosen, rejected      |
| scored         | Reward modeling          | prompt, response, score       |
| classification | Классификаторы           | text, label                   |
| rag            | RAG pipeline             | context\[\], question, answer |
| trajectory     | Tool-use / агенты        | task, trajectory\[\]          |
| eval           | Eval benchmarks          | question, answer, options\[\] |

### [](#%5Fpreview%5Fdataset%5Fsetup)`preview_dataset_setup`

Возвращает полный текст `spec.md`, `config.yaml` и `tools.yaml` для показа пользователю до генерации. Ответ включает `confirmation_prompt` и `await_user_confirmation: true`.

```python
preview_dataset_setup("my_dataset")
```

### [](#%5Fgenerate%5Fcases)`generate_cases`

Генерирует cases для разнообразия сэмплов. Читает `Case Dimensions` и `Case Schema` из `spec.md`.

```python
generate_cases("my_dataset", n_cases=50)
generate_cases("my_dataset", overwrite=True)  # перегенерировать
```

Генерирует батчами. Каждый батч знает о предыдущих `topic_area` — не повторяет темы. Возвращает: количество cases, покрытие по осям, первые 3 case.

### [](#%5Fgenerate%5Fdataset)`generate_dataset`

Генерирует сэмплы и записывает в `output/dataset.jsonl`.

```python
generate_dataset("my_dataset", n_samples=200)
generate_dataset("my_dataset", dry_run=True)                    # план без генерации
generate_dataset("my_dataset", inputs_file="partial.jsonl")     # completion режим
```

Режимы генерации:

| Режим      | Условие              | Описание                                       |
| ---------- | -------------------- | ---------------------------------------------- |
| real       | есть tools.yaml      | LLM реально вызывает инструменты (поиск и др.) |
| simulated  | нет tools.yaml       | LLM генерирует из обучающих данных             |
| completion | передан inputs\_file | LLM дополняет частичные сэмплы                 |

Кастомные модели:

```python
generate_dataset(
    name="my_dataset",
    models=[
        {"provider": "", "model": "", "weight": 1},
        {"provider": "", "model": "", "weight": 1},
    ],
)
```

Cases используются циклически: при 200 cases и `n_samples=2000` каждый case используется 10 раз (с разными аспектами темы через `sample_index_in_group`).

### [](#%5Finspect%5Fdataset)`inspect_dataset`

Возвращает статистику и примеры.

```python
inspect_dataset("my_dataset", n_examples=5)
```

Возвращает: общее кол-во сэмплов, статистику токенов, распределение по полям, режимы генерации,`generation_tokens` (prompt/completion из `generation_stats.json`) и N случайных примеров.

## [](#%5Fllm%5Fбэкенды%5Fгенерации)LLM-бэкенды генерации

### [](#%5Ftagme%5Fпо%5Fумолчанию)tagme (по умолчанию)

Внутренний LLM-прокси SberDevices. Авторизация из текущей MCP-сессии — отдельный API-ключ не нужен.

```yaml
generation:
  backend: tagme
  temperature: 0.8
  max_tokens: 1024

models:
  - provider: openai      # для tagme не уходит в API, только model
    model: z-ai/glm-5.1
    weight: 1.0
```

### [](#%5Flitellm)litellm

Мультипровайдерный роутинг через litellm. Поддерживает любые доступные вам llm

```bash
# Установка с litellm
pip install crowd-sdk[mcp] litellm
```

```yaml
generation:
  backend: litellm
  temperature: 0.8
  max_tokens: 1024

models:
  - provider:
    model:
    weight: 1.0
  - provider:
    model:
    weight: 0.5
```

### [](#%5Fhttp)http

Прямые HTTP-запросы к OpenAI-compatible API через aiohttp.

```yaml
generation:
  backend: http
  http:
    base_url: https://api.example.com/v1   # обязательно
    api_key: sk-...                        # опционально
  temperature: 0.8
  max_tokens: 1024
```

| |  При Tool calling через API с бэкенда без поддержки инструментов можно включить fallback: generation.tools\_fallback: true. |
| ----------------------------------------------------------------------------------------------------------------------------- |

## [](#%5Fspec%5Fmd%5Fописание%5Fдатасета)spec.md — описание датасета

Главный файл датасета. Задаёт схему вывода, оси разнообразия и инструкции для LLM.

```markdown
# Dataset Name

## Use Case
Для чего датасет и какой capability он развивает.

## Output Schema
JSON-схема одного сэмпла — LLM генерирует точно по ней.

## Case Dimensions
Оси разнообразия. Используются при generate_cases.

### Domains
- science/biology
- geography/europe

### Difficulty
- easy
- medium
- hard

## Case Schema
Описание полей case.

| Поле | Тип | Описание | Влияние на генерацию |
|------|-----|----------|----------------------|
| domain | str | Домен | Факты только из этого домена |
| difficulty | str | Сложность | Влияет на выбор формулировки |
| need_internet | bool | Нужен поиск | true → вызови search tool |

## Generation Instructions
Инструкции для LLM.
```

Поля case полностью определяются в `spec.md` — для chat-датасета можно добавить `persona`, для code-датасета — `language`. Код ничего про них не знает.

## [](#%5Fcases%5Fгарантированное%5Fразнообразие)Cases — гарантированное разнообразие

| topic\_area                                            | Плохо / Хорошо |
| ------------------------------------------------------ | -------------- |
| «масса Юпитера» ❌ / «планеты Солнечной системы» ✓      |                |
| «длина реки Нил» ❌ / «реки и озёра Африки» ✓           |                |
| «дата рождения Пушкина» ❌ / «русские поэты XIX века» ✓ |                |

Хорошая `topic_area` даёт 20–50 разных конкретных сэмплов.

## [](#%5Fформат%5Fвыходного%5Fjsonl)Формат выходного JSONL

Каждая строка — валидный JSON. Каждый сэмпл содержит служебное поле `_generation`:

```json
{
  "text": "Несмотря на то что...",
  "claims": [],
  "_generation": {
    "model": "gpt-4o-mini",
    "provider": "openai",
    "index": 42,
    "mode": "real",
    "case_id": 7,
    "tool_calls": [{"tool": "search_client", "query": "..."}]
  }
}
```

После каждого прогона сохраняется `output/generation_stats.json` с токенами, временем и ошибками.

## [](#%5Fправило%5Fдля%5Fcursor)Правило для Cursor

Для проектов с датасетами создайте `.cursor/rules/dataset-builder.mdc`:

```markdown
---
description: LLM-датасеты только через crowd-sdk MCP dataset builder
globs: datasets/**/*
alwaysApply: true
---

# Dataset Builder

Генерацию jsonl выполняй только MCP: create_dataset → preview_dataset_setup →
generate_cases → generate_dataset(dry_run=True) → после «запускай» generate_dataset → inspect_dataset.

Запрещено: Python/shell-скрипты для генерации сэмплов, прямые вызовы LLM API из кода.

После create_dataset или preview_dataset_setup покажи spec.md и config.yaml и жди «ок»
пользователя. generate_dataset без dry_run — только после явного «запускай».
```

## [](#%5Fdemo)Demo

Полный пример работы с кодом и детальным разбором инструментов представлен в интерактивной странице документации [Dataset Builder Demo](../dataset%5Fbuilder%5Fdemo.html).

Модуль Human MCP
====================
Инструменты для управления жизненным циклом проектов и задач разметки на платформе Tagme через LLM-агента.

| |  По умолчанию выключен. Включается флагом \--enable-human-mcp при запуске или переменной окружения CROWD\_SDK\_MCP\_HUMAN\_TOOLS=1. |
| ------------------------------------------------------------------------------------------------------------------------------------- |

## [](#%5Fфлоу%5Fработы)Флоу работы

### [](#%5Fсценарий%5F1%5Fпроект%5Fпо%5Fшаблону)Сценарий 1 — Проект по шаблону

```none
get_human_mcp_markup_options          ← посмотреть доступные шаблоны, пулы, существующие проекты
        ↓
configure_human_mcp_project (create)  ← создать проект из шаблона с инструкцией и slug
        ↓
create_markup_task_with_items         ← загрузить items и создать задачу
        ↓
list_project_tasks                    ← проверить список задач
        ↓
update_markup_task / stop_markup_task ← управлять параметрами или остановить задачу
```

### [](#%5Fсценарий%5F2%5Fпроект%5Fс%5Fгенерацией%5Fинтерфейса)Сценарий 2 — Проект с генерацией интерфейса

```none
generate_tagme_interface              ← сгенерировать интерфейс через tagme-x-genui (диалог)
        ↓
configure_human_mcp_project (create)  ← создать проект без шаблона
        ↓
apply_interface_to_project            ← применить сгенерированный интерфейс к проекту
        ↓
create_markup_task_with_items         ← загрузить items и создать задачу
```

### [](#%5Fинспекция%5Fсуществующих%5Fпроектов)Инспекция существующих проектов

```none
summarize_projects_for_human_mcp ← просмотреть существующие проекты (инструкция, slug, пулы)
```

## [](#%5Fинструменты)Инструменты

### [](#%5Fget%5Fhuman%5Fmcp%5Fmarkup%5Foptions)`get_human_mcp_markup_options`

Справочный каталог — возвращает доступные шаблоны, пулы и существующие human\_mcp проекты. Вызывай перед созданием проекта, чтобы найти нужные `template_id` и `pool_id`.

```python
{
    # "organization_id": "org123",          # авто-определяется, если не передан
    # "template_category_tags": ["text"],   # AND-фильтр по категориям шаблонов
    # "templates_catalog": "published",     # published | workspace
}
```

### [](#%5Fconfigure%5Fhuman%5Fmcp%5Fproject)`configure_human_mcp_project`

Создать проект из шаблона (`operation='create'`) или сменить шаблон на существующем проекте (`operation='apply_template'`).

```python
# Создать новый проект
{
    "operation": "create",
    "template_id": "tpl789",
    "name": "Мой проект разметки",
    "human_mcp_task_slug": "dialog_quality_v1",
    "instruction": "Оцените каждый диалог по критериям качества...",
    "pool_ids": ["pool001"],
}

# Сменить шаблон на существующем проекте
{
    "operation": "apply_template",
    "template_id": "tpl789",
    "project_id": "proj456",
}
```

### [](#%5Fgenerate%5Ftagme%5Finterface)`generate_tagme_interface`

Генерация интерфейса разметки через сервис tagme-x-genui. Многошаговый диалог: сервис может задать уточняющие вопросы перед генерацией.

```python
# Шаг 1 — старт генерации
{
    "prompt": "Интерфейс для бинарной классификации текстов: тональность (позитив/негатив)",
    "genui_url": "http://localhost:8000",
}
# → status="needs_input":  вернёт questions[] и generation_id
# → status="completed":    вернёт interface{html, js, css, config, specification, example}

# Шаг 2 — ответить на вопросы (если needs_input)
{
    "prompt": "...",
    "genui_url": "http://localhost:8000",
    "generation_id": "<id из шага 1>",
    "answers": [{"question_id": "q1", "value": "Да"}],
}
```

### [](#%5Fapply%5Finterface%5Fto%5Fproject)`apply_interface_to_project`

Записывает сгенерированный интерфейс (html/js/css/config/specification/example) в метод проекта. Передай `interface` из результата `generate_tagme_interface`.

```python
{
    "project_id": "proj456",
    "html": "<div>...</div>",
    "js": "...",
    "css": "...",
    "config": {...},
    "specification": {...},
    "example": {...},
}
```

### [](#%5Fcreate%5Fmarkup%5Ftask%5Fwith%5Fitems)`create_markup_task_with_items`

Создаёт задачу разметки внутри существующего проекта и загружает в неё items.

```python
{
    "project_id": "proj456",
    "task_name": "Батч диалогов 2024-03",
    "items": [
        {"task": {"text": "Привет, как дела?", "id": "d001"}},
        {"task": {"text": "Какая погода сегодня?", "id": "d002"}},
    ],
    "price": 10.0,
    "overlap": 1,
    "start_after_upload": False,  # True только по явной просьбе пользователя
    # "deadline": "2024-04-01",
}
```

| |  Каждый item должен иметь ключ "task". Внутренние поля должны соответствовать форме разметки целевого проекта. При необходимости разбей items на несколько вызовов (см. HUMAN\_MCP\_MAX\_UPLOAD\_ITEMS). |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

### [](#%5Flist%5Fproject%5Ftasks)`list_project_tasks`

Получает список всех задач проекта с их ID, названиями и статусами. Используй перед `update_markup_task` или `stop_markup_task` для получения `task_id`.

```python
{"project_id": "proj456"}
```

### [](#%5Fupdate%5Fmarkup%5Ftask)`update_markup_task`

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

```python
{
    "task_id": "task123",
    "price": 15.0,
    "overlap": 2,
    "deadline": "2026-07-01",
    # "name": "Новое название",
    # "description": "Новое описание",
}
```

### [](#%5Fstop%5Fmarkup%5Ftask)`stop_markup_task`

Останавливает активную задачу. Инструмент ожидает полной остановки перед возвратом.

```python
{"task_id": "task123"}
```

### [](#%5Fsummarize%5Fprojects%5Ffor%5Fhuman%5Fmcp)`summarize_projects_for_human_mcp`

Получает текст инструкции, slug, template\_id и pool\_ids для существующих human\_mcp проектов. Удобно для подбора подходящего проекта под новый тип задачи.

```python
{
    "project_ids": ["proj456", "proj789"],  # опционально — без параметра авто-обнаружение
}
```

## [](#%5Fидентификация%5Fпроекта%5Fslug)Идентификация проекта: slug

Каждый human\_mcp проект хранит slug в поле `inner_comment` в формате `human_mcp_task:<slug>`. Slug идентифицирует тип задачи разметки и используется для поиска проекта между сессиями.

## [](#%5Fподсказки%5Fразметчику%5Fhints%5Fyaml)Подсказки разметчику (hints YAML)

Передай путь через переменную окружения `CROWD_MCP_HUMAN_LABELING_HINTS` или параметр `hints_path`в `get_human_mcp_markup_options`. Это позволяет агенту выбирать шаблоны, задавать дефолты цены/перекрытия и понимать типы задач.

Шаблон файла: `examples/30.mcp/human_mcp_labeling_hints.example.yaml`.

## [](#%5Fdemo)Demo

Полный пример работы с кодом и детальным разбором инструментов представлен в интерактивной странице документации [Human MCP Demo](../human%5Fmcp%5Fdemo.html).

Модуль Statistic
====================
Инструменты для получения статистики платформы Tagme, анализа результатов разметки и обнаружения фрода. Включён по умолчанию — дополнительная установка или флаги не требуются.

## [](#%5Fинструменты)Инструменты

### [](#%5Fget%5Fproject%5Fstats)`get_project_stats`

Обзор проекта: статус, прогресс, количество задач, снапшот качества.

```python
{"project_id": "abc123"}
```

### [](#%5Fget%5Ftask%5Fstats)`get_task_stats`

Снапшот задачи: процент выполнения, оценка качества, распределение нагрузки, счётчики статусов.

```python
{"task_id": "task456"}
```

### [](#%5Fget%5Fannotation%5Fsummary)`get_annotation_summary`

Комбинированный дашборд: прогресс + качество + алерты + экспорт за период. Удобный агрегированный формат для LLM.

```python
{
    "project_id": "abc123",     # или task_id
    "start_date": "2024-01-01", # опционально
    "end_date": "2024-03-31",   # опционально
}
```

### [](#%5Fget%5Fmarker%5Fperformance%5Fstats)`get_marker_performance_stats`

Таблица производительности разметчиков: объём, оценка качества, согласованность, вознаграждение. Поддерживает сортировку и фильтрацию.

```python
{
    "task_id": "task456",       # или project_id
    "sort_by": "quality",       # quality | marked | reward | consistency
    "min_marked": 10,           # фильтр: минимум заданий
    "min_quality": 0.7,         # фильтр: минимальное качество
}
```

### [](#%5Fget%5Fproject%5Fquality%5Fstats)`get_project_quality_stats`

Сырой вывод quality API для одного или нескольких проектов/задач.

```python
{
    "project_ids": ["abc123"],
    "output": "task",           # task | item
}
```

### [](#%5Fanalyze%5Fproject%5Finstructions)`analyze_project_instructions`

Загружает инструкцию разметчика (`marker_brief`) для метода проекта. Возвращает структурный анализ: количество слов, заголовки, ссылки, списки, сводку по формам.

```python
{"project_id": "abc123"}
```

### [](#%5Fanalyze%5Ftask%5Fresults)`analyze_task_results`

Анализ на уровне заданий для задачи: распределение классов, степень согласия, ответы разметчиков, примеры результатов, сравнение с контролем.

```python
{
    "task_id": "task456",
    "analyses": ["class_distribution", "agreement_summary", "sample_results"],
}
```

Доступные блоки анализа:

| Блок                    | Описание                           |
| ----------------------- | ---------------------------------- |
| inspect                 | Общая инспекция задачи             |
| class\_distribution     | Распределение классов              |
| agreement\_summary      | Степень согласия разметчиков       |
| generation\_summary     | Сводка по генерации                |
| marker\_answer\_summary | Сводка по ответам разметчиков      |
| sample\_results         | Примеры результатов                |
| compare\_with\_control  | Сравнение с контрольными заданиями |

### [](#%5Fanalyze%5Ffraud%5Frisk)`analyze_fraud_risk`

Эвристический отчёт о рисках фрода для задачи: аномально быстрое время выполнения, низкое качество, дублирующиеся ответы, высокие доли отказов/пропусков/истечений.

```python
{
    "task_id": "task456",
    "quality_threshold": 0.6,
    "fast_time_sigma": 2.5,
}
```

### [](#%5Fanalyze%5Fproject%5Fresults)`analyze_project_results`

Агрегированный анализ по всем задачам проекта. Поддерживает режимы `rollup` (объединённый) и `per_task` (по каждой задаче).

```python
{
    "project_id": "abc123",
    "summary_mode": "rollup",   # rollup | per_task
}
```

## [](#%5Fdemo)Demo

Полный пример работы с кодом и детальным разбором инструментов представлен в интерактивной странице документации [Statistic Demo](../statistic%5Fdemo.html).