field

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

const text = field("text", { type: "string" });
const note = field("note", { type: "string" }, { id: "note" });

const boundary = root({
  started: [text, optional(note)],
  completed: [text],
});

console.log(note.name, boundary.id);

{
  "id": "note",
  "name": "note",
  "jsonSchema": { "type": "string" }
}

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

const text = field("text", { type: "string" });
const note = field("note", { type: "string" }, { id: "note" });

const boundary = root({
  started: [text, optional(note)],
  completed: [text],
});

console.log(note.name, boundary.id);

{
  "id": "note",
  "name": "note",
  "jsonSchema": { "type": "string" }
}

import type { AuthoringIdOptions, Field, JsonSchema, OptionalFieldBinding } from "@toloka-platform/sdk";

declare function field<const Name extends string>(
  name: Name,
  jsonSchema: JsonSchema,
  options?: AuthoringIdOptions,
): Field<Name>;

declare function optional(referencedField: Field): OptionalFieldBinding;

Parameters

string

required

The field name. Its literal type is retained in Field<Name>.

JsonSchema

required

The JSON Schema for field values. For example, { type: "string" } or { type: "array", items: { type: "string" } }.

AuthoringIdOptions

default:"{}"

Optional identity override.

Show Options

string

Explicit graph field ID. Otherwise the ID is derived deterministically from the name.

Returns

Field<Name>

A field definition. Reuse this object in node settings and definePipeline({ fields }).

Show Field properties

string

The graph field ID.

Name

The supplied name.

JsonSchema

The supplied schema.

field() constructs a definition; it does not create a dataset field or validate the schema against the platform. Use pipeline reconciliation to create it on the platform.

Optional bindings

optional(referencedField) takes one required Field and returns { field: referencedField, optional: true }. It changes the binding’s optionality without changing the field’s schema. Use it in a root’s started or completed list, or a Code or Match node’s field bindings. For required Code and Match bindings, use { field, optional: false }. Root lists also accept a bare field as a required binding. Generation and Quorum entities use an optional property on the entity object.

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

const text = field("text", { type: "string" });
const note = field("note", { type: "string" }, { id: "note" });

const boundary = root({
  started: [text, optional(note)],
  completed: [text],
});

console.log(note.name, boundary.id);

The note field’s data properties:

{
  "id": "note",
  "name": "note",
  "jsonSchema": { "type": "string" }
}

Reference

TypeScript SDK

CLI

HTTP API

Parameters

Returns

Optional bindings