quorum

import { field, quorum } from "@toloka-platform/sdk";

const answers = field("answers", {
  type: "array",
  items: { type: "string" },
});

export const review = quorum("review", {
  about: { name: "review" },
  publicName: "Review an answer",
  entities: {
    input: [],
    output: [{ field: answers, entityType: "EXPLANATION" }],
  },
  qualityCriteria: [],
  instruction: "Write a brief assessment.",
  ui: {
    code: '<Field.Textarea path="answers" />',
    data: "{}",
    preprocess: "return {};",
    postprocess: "return {};",
    constants: "{}",
  },
  overlap: 3,
  onboarding: {
    enabled: false,
    steps: [],
    info: {
      estimatedTime: "",
      role: "",
      goal: "",
      successCriteria: "",
    },
  },
});

import { field, quorum } from "@toloka-platform/sdk";

const answers = field("answers", {
  type: "array",
  items: { type: "string" },
});

export const review = quorum("review", {
  about: { name: "review" },
  publicName: "Review an answer",
  entities: {
    input: [],
    output: [{ field: answers, entityType: "EXPLANATION" }],
  },
  qualityCriteria: [],
  instruction: "Write a brief assessment.",
  ui: {
    code: '<Field.Textarea path="answers" />',
    data: "{}",
    preprocess: "return {};",
    postprocess: "return {};",
    constants: "{}",
  },
  overlap: 3,
  onboarding: {
    enabled: false,
    steps: [],
    info: {
      estimatedTime: "",
      role: "",
      goal: "",
      successCriteria: "",
    },
  },
});

import type { AuthoredQuorumNode, AuthoringIdOptions, QuorumAuthoringSettings } from "@toloka-platform/sdk";

declare function quorum(
  name: string,
  settings: QuorumAuthoringSettings,
  options?: AuthoringIdOptions,
): AuthoredQuorumNode;

Parameters

string

required

Name used to derive the node ID. Also supply settings.about.name.

QuorumAuthoringSettings

required

Configure overlap, audience, labeling interface, onboarding, and quality using the Quorum node reference.

Show Authoring settings

QuorumNodeSettings['about']

required

Node name and optional description.

string

required

Display name for the work.

object

required

Required input and output arrays. Each entity uses the shared entity-binding shape, including supported entityType values, allowedLabels, dynamic, maxEntities, and defaults. Relations also use field objects. Quorum output field schemas must account for multiple annotations.

array

required

Each criterion’s targetEntity is a Field object.

string

required

Expert instructions.

QuorumNodeSettings['ui']

required

Labeling-interface source.

number

required

Annotation overlap; see Quorum behavior.

QuorumNodeSettings['onboarding']

required

Expert onboarding settings.

object

Uses field objects for graded entities’ targetEntity properties.

AuthoringIdOptions

default:"{}"

Optional identity override.

Show Options

string

Explicit graph node ID. Otherwise derived from the node type and name.

Unlike generation, this constructor requires explicit instructions, UI, quality criteria, and onboarding. Optional audience, quality assurance, offboarding, and check settings keep their node reference meanings.

Entity fields

Quorum output fields have an outer array for the collected annotations. A static string output uses { type: "array", items: { type: "string" } }. A dynamic string output needs nested arrays:

{
  "type": "array",
  "items": {
    "type": "array",
    "items": { "type": "string" }
  }
}

For dynamic bindings, set dynamic: true, an integer maxEntities from 1 to 50, and a jsonPath with exactly one [*] wildcard. For SINGLE_LABEL and MULTI_LABEL outputs, supply at least two allowedLabels entries with label and value strings. The binding example shows both forms; change the output field schemas to include Quorum’s outer array when using them here.

Returns

AuthoredQuorumNode

A Quorum node with compiled field references.

Show Node properties

string

Graph node ID.

'quorum'

Node type.

QuorumNodeSettings

Compiled node settings.

InputPort

Port for incoming connections.

OutputPort

Port for outgoing connections.

Use the check and apply workflow to validate the complete node before running it.

This local fixture shows the required constructor fields. Configure audience, pricing, quality, and onboarding for your labeling work before applying it.

import { field, quorum } from "@toloka-platform/sdk";

const answers = field("answers", {
  type: "array",
  items: { type: "string" },
});

export const review = quorum("review", {
  about: { name: "review" },
  publicName: "Review an answer",
  entities: {
    input: [],
    output: [{ field: answers, entityType: "EXPLANATION" }],
  },
  qualityCriteria: [],
  instruction: "Write a brief assessment.",
  ui: {
    code: '<Field.Textarea path="answers" />',
    data: "{}",
    preprocess: "return {};",
    postprocess: "return {};",
    constants: "{}",
  },
  overlap: 3,
  onboarding: {
    enabled: false,
    steps: [],
    info: {
      estimatedTime: "",
      role: "",
      goal: "",
      successCriteria: "",
    },
  },
});

Reference

TypeScript SDK

CLI

HTTP API

Parameters

Entity fields

Returns