Creating specifications

Project settings in Toloka must include specifications for the input and output data. If you use Template Builder in the Toloka interface, the specification is created automatically by default.

Specification setting modes

You can configure the specification automatically or manually. You can change the way the specification is configured using the Define data specification manually option. This option is disabled by default.

Filling in input data

If automatic generation of specifications is enabled, the input data fields are created from the configuration code. Provide a detailed example to get a ready-to-use specification. If you have optional fields, include them also.

Examples:

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

Filling in output data

If automatic generation of specifications is enabled, the output data fields are created from the configuration code. It takes into account the components that use data.output as well as the values supported by it.

Examples:

{
"type": "field.radio-group",
"options": [
{
  "label": "Yes",
  "value": true
},
{
  "label": "No",
  "value": false
}
],
"data": {
"type": "data.output",
"path": "verdict"
}
}
Copy text

How to edit the specification

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

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 a Toloker has to fill it in.

• Hidden fields are intended only for requesters and are not available in the task interface. The values of hidden fields can't be used either in the JS code or in the template constructor.

  Let's say you pass product data (like articles or batch numbers) that Tolokers 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 Tolokers shouldn't have access to personal data.

  To create a hidden field, add it to the specification yourself and then add the "hidden": true parameter to this field in JSON mode. You should do this in Toloka when configuring your project. The hidden field remains when the specification is re-generated using the Template Builder.

What's next

• See examples of data read and write.
• Learn how to clear the entered data.

Last updated: August 2, 2023