Input and output data

  1. How to edit the specification
  2. Recommendations

In the Specifications field, you set parameters for input and output data. These settings will apply to all tasks in the project.

In the specification, add fields for the data used in the task or for the data you need in the results. Reference these fields when you configure the interface.

Note. Don't repeat the input data in the output data. You will receive all data, including the input, in the results.

How to edit the specification

There are two ways to edit the specification: regular mode or JSON mode. JSON mode gives you more options — you can hide input data and use regular expressions to validate output data.

To add a field in the regular mode, click Add field.

To edit an existing field, hover over the field and click .

Explanations for configuring fields

Parameter

Parameter in JSON

Description

Name

id

Field ID. Only Latin letters, numbers, hyphens and underscores are allowed.

Type

type

Data type:

  • string

  • url

  • boolean

  • number

  • float

  • file
  • coordinates

  • json

For arrays, add the array_ prefix to the field type in JSON mode. For example: array_file.

Required

required

Whether the field must be filled when uploading the tasks for the input data.

Whether the performer's response is required in the output data.

By default, fields are optional — false.

Hidden

hidden

Allows you to hide data from the performer. If this is not done, performers can get the field value programmatically. You can configure this parameter in JSON mode.

For example, you can hide the assigment_id identifier you will need when reviewing assignments in a separate project.

By default, the field is visible — false.

Array array_<type> Array of objects of the same type. Used, for example, for multiple photos uploaded by a performer.

In JSON mode, there is a separate data type for the array. For example: "type": "array_file".

Min size

min_size Minimum number of items in the array.
Max size max_size Maximum number of items in the array.

Allowed values

allowed_values

Allowed values for string, integer, float and boolean data types.

Min length

min_length

Minimum length of the string.

Max length

max_length Maximum length of the string.

Min value

min_value Minimum values for float and integer numbers.

Max value

max_value Maximum values for float and integer numbers.
Current location

current_location

Saving the performer&apos;s current coordinates (true/false). Only for the coordinates data type. Used in tasks for the mobile app.

The default value is false.

Pattern pattern

Regular expression that the string must match. You can configure this parameter in JSON mode.

Recommendations

  • If you edit a required field, the changes apply only to new task pools. For example, if you need to fix an error in a project, clone the pool or create a new one. Existing task pools will continue using the previous version of the project.

  • In the output, use value validation and don't forget to mark the field as required if the performer has to fill it in.
  • Make the field hidden if you don't want performers to access it. This is possible even if you don't display this field in the interface. To do this, add the "hidden": true parameter in JSON mode.

    Let's say you pass product data (like articles or batch numbers) that performers don't need in order to complete the task. Or you are moderating comments and you need the authors' personal data in the results for further data processing, but the performers shouldn't have access to personal data.