root

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

const prompt = field("prompt", { type: "string" });
const context = field("context", { type: "string" });
const answer = field("answer", { type: "string" });

const boundary = root({
  started: [prompt, optional(context)],
  completed: [answer],
  itemLimit: 100,
});

console.log(boundary.started, boundary.completed);

{
  "started": { "node": "root", "handle": "started", "direction": "output" },
  "completed": { "node": "root", "handle": "completed", "direction": "input" }
}

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

const prompt = field("prompt", { type: "string" });
const context = field("context", { type: "string" });
const answer = field("answer", { type: "string" });

const boundary = root({
  started: [prompt, optional(context)],
  completed: [answer],
  itemLimit: 100,
});

console.log(boundary.started, boundary.completed);

{
  "started": { "node": "root", "handle": "started", "direction": "output" },
  "completed": { "node": "root", "handle": "completed", "direction": "input" }
}

import type { AuthoredRootNode, AuthoringIdOptions, RootAuthoringSettings } from "@toloka-platform/sdk";

declare function root(
  settings: RootAuthoringSettings,
  options?: AuthoringIdOptions,
): AuthoredRootNode;

Parameters

RootAuthoringSettings

required

The pipeline boundary. Unlike work-node constructors, root has no name argument.

Show Boundary settings

readonly (Field | { field: Field; optional?: boolean })[]

required

Fields entering the pipeline. A bare field is required; use optional(field) for an optional binding.

readonly (Field | { field: Field; optional?: boolean })[]

required

Fields at the End boundary, with the same binding syntax.

number

Optional cap on items selected for a run. See Start and End nodes for selection rules and limits.

AuthoringIdOptions

default:"{}"

Optional identity override.

Show Options

string

default:"root"

Graph node ID.

Returns

AuthoredRootNode

Add this node to the pipeline’s nodes array.

Show Node properties

string

The graph node ID.

'root'

The node type.

object

Compiled Start and End bindings, without a dataset ID or item filter.

OutputPort

Connect this to the first node’s input.

InputPort

Connect the last node’s output to this.

The exported root function also has root.started and root.completed ports targeting the default ID "root". When overriding the ID, use the returned node’s ports.

Throws

Throws a local error when settings is not an object. Pass root({ started, completed }), without a name argument.

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

const prompt = field("prompt", { type: "string" });
const context = field("context", { type: "string" });
const answer = field("answer", { type: "string" });

const boundary = root({
  started: [prompt, optional(context)],
  completed: [answer],
  itemLimit: 100,
});

console.log(boundary.started, boundary.completed);

The returned ports’ data properties:

{
  "started": { "node": "root", "handle": "started", "direction": "output" },
  "completed": { "node": "root", "handle": "completed", "direction": "input" }
}

Reference

TypeScript SDK

CLI

HTTP API

Parameters

Returns

Throws