Создание спецификации

Заполнение входных данных

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

{
  "question": "Do you like dogs?"
}

{
  "verdict": true
}

{
  "age": 42
}

{
    ...
    "registration_аddress": {
        "country": "Russia",
        "city": "Moscow",
        "address": "Tverskaya str, 3-53"
    }
}

{
  "images": [
    "https://cdn.stocksnap.io/img-thumbs/960w/surfer-wave_3DBOYBPB3X.jpg",
    "https://cdn.stocksnap.io/img-thumbs/960w/fisherman-silhouette_UADULRRHEK.jpg",
    "https://cdn.stocksnap.io/img-thumbs/960w/old-photo_GEQ27OWZVV.jpg"
  ]
}

Заполнение выходных данных

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

Примеры:

{
  "type": "field.radio-group",
  "options": [
    {
      "label": "Да",
      "value": true
    },
    {
      "label": "Нет",
      "value": false
    }
  ],
  "data": {
    "type": "data.output",
    "path": "verdict"
  }
}

{
  "type": "field.radio-group",
  "options": [
    {
      "label": "Да",
      "value": "true"
    },
    {
      "label": "Нет",
      "value": "false"
    }
  ],
  "data": {
    "type": "data.output",
    "path": "verdict"
  }
}

{
  "type": "field.radio-group",
  "options": [
    {
      "label": "Да",
      "value": 1
    },
    {
      "label": "Нет",
      "value": 0
    }
  ],
  "data": {
    "type": "data.output",
    "path": "verdict"
  }
}

{
  "type": "field.radio-group",
  "options": [
    {
      "label": "Да",
      "value": true
    },
    {
      "label": "Нет",
      "value": false
    }
  ],
  "data": {
    "type": "data.output",
    "path": "results.verdict"
  }
}

{
  "type": "field.radio-group",
  "options": [
    {
      "label": "Да",
      "value": 1
    },
    {
      "label": "Нет",
      "value": 0
    }
  ],
  "data": {
    "type": "data.output",
    "path": "verdicts.0"
  }
}

Как редактировать спецификацию

Вы можете изменить спецификацию в настройках проекта Яндекс Толоки двумя способами: в обычном режиме или в режиме JSON. Режим JSON дает больше возможностей: вы можете делать скрытыми входные данные и использовать регулярные выражения для валидации выходных данных.

Пояснения к настройке полей

Параметр	Параметр в JSON	Описание
Название	id	Идентификатор поля. Допустимы латинские буквы, цифры, дефис и нижнее подчеркивание.
Тип	type	Тип данных: строка — string; ссылка — url; логический — boolean; число — number; дробное число — float; файл — file; географические координаты — coordinates; объект JSON — json. Для массивов в режиме JSON к типу добавляется префикс array_. Например: array_file.
Обязательное поле	required	Обязательность объекта при загрузке заданий для входных данных. Обязательность ответа исполнителя для выходных данных. По умолчанию поле необязательное — false.
Скрытое поле	hidden	Позволяет скрыть данные от исполнителя. Если этого не сделать, исполнители могут получить значение поля программно. Параметр можно настроить в режиме JSON. Например, вы можете скрыть идентификатор assigment_id, который вам понадобится при выполнении отложенной приемки в отдельном проекте. По умолчанию поле открытое — false. Внимание. Скрытые поля недоступны в интерфейсе задания, даже через JS или код шаблона в конструкторе.
Массив	array_<тип>	Массив объектов одного типа. Используется, например, для загрузки нескольких фотографий исполнителем. В режиме JSON массив — это отдельный тип данных. Например: "type": "array_file".
Мин. элементов	min_size	Минимальное число элементов в массиве.
Макс. элементов	max_size	Максимальное число элементов в массиве.
Допустимые значения	allowed_values	Допустимые значения для строк, дробных и целых чисел, логического типа данных.
Мин. длина	min_length	Минимальная длина строки.
Макс. длина	max_length	Максимальная длина строки
Мин. значение	min_value	Минимальное значений для дробных и целых чисел.
Макс. значение	max_value	Максимальное значений для дробных и целых чисел.
Текущее положение	current_location	Сохранение текущих координат исполнителя (true/false). Только для типа данных coordinates. Используется в заданиях для мобильного приложения. По умолчанию false.
Шаблон	pattern	Регулярное выражение, которому должна соответствовать строка. Параметр можно настроить в режиме JSON.

Параметр	Параметр в JSON	Описание
Название	id	Идентификатор поля. Допустимы латинские буквы, цифры, дефис и нижнее подчеркивание.
Тип	type	Тип данных: строка — string; ссылка — url; логический — boolean; число — number; дробное число — float; файл — file; географические координаты — coordinates; объект JSON — json. Для массивов в режиме JSON к типу добавляется префикс array_. Например: array_file.
Обязательное поле	required	Обязательность объекта при загрузке заданий для входных данных. Обязательность ответа исполнителя для выходных данных. По умолчанию поле необязательное — false.
Скрытое поле	hidden	Позволяет скрыть данные от исполнителя. Если этого не сделать, исполнители могут получить значение поля программно. Параметр можно настроить в режиме JSON. Например, вы можете скрыть идентификатор assigment_id, который вам понадобится при выполнении отложенной приемки в отдельном проекте. По умолчанию поле открытое — false. Внимание. Скрытые поля недоступны в интерфейсе задания, даже через JS или код шаблона в конструкторе.
Массив	array_<тип>	Массив объектов одного типа. Используется, например, для загрузки нескольких фотографий исполнителем. В режиме JSON массив — это отдельный тип данных. Например: "type": "array_file".
Мин. элементов	min_size	Минимальное число элементов в массиве.
Макс. элементов	max_size	Максимальное число элементов в массиве.
Допустимые значения	allowed_values	Допустимые значения для строк, дробных и целых чисел, логического типа данных.
Мин. длина	min_length	Минимальная длина строки.
Макс. длина	max_length	Максимальная длина строки
Мин. значение	min_value	Минимальное значений для дробных и целых чисел.
Макс. значение	max_value	Максимальное значений для дробных и целых чисел.
Текущее положение	current_location	Сохранение текущих координат исполнителя (true/false). Только для типа данных coordinates. Используется в заданиях для мобильного приложения. По умолчанию false.
Шаблон	pattern	Регулярное выражение, которому должна соответствовать строка. Параметр можно настроить в режиме JSON.

Рекомендации