definePipeline

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

const text = field("text", { type: "string" });
const boundary = root({ started: [text], completed: [text] });

export default definePipeline({
  dataset: "example-items",
  fields: [text],
  nodes: [boundary],
  connections: [connect(boundary.started, boundary.completed)],
});

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

const text = field("text", { type: "string" });
const boundary = root({ started: [text], completed: [text] });

export default definePipeline({
  dataset: "example-items",
  fields: [text],
  nodes: [boundary],
  connections: [connect(boundary.started, boundary.completed)],
});

import type { PipelineDefinition, PipelineDefinitionInput } from "@toloka-platform/sdk";

declare function definePipeline<const DatasetName extends string>(
  definition: PipelineDefinitionInput<DatasetName>,
): PipelineDefinition<DatasetName>;

Parameters

PipelineDefinitionInput

required

The authored pipeline.

Show Definition fields

string

Dataset name to bind during reconciliation. When omitted, toloka apply creates a new pipeline without creating or attaching a dataset. If the pipeline already has a dataset on the platform, omitting this property makes apply fail: it refuses to remove the binding. An empty string is rejected by definePipeline.

readonly Field[]

required

Every field object referenced by the nodes. Reuse the same objects returned by field().

readonly PipelineNode[]

required

Nodes built with root, code, generation, quorum, or match.

readonly Connection[]

required

Connections returned by connect().

Returns

PipelineDefinition<DatasetName>

A definition for source loading and local testing. Export it as the default value of a pipeline.ts file under pipelines/ for the CLI.

Show Definition properties

DatasetName | undefined

The supplied dataset name.

UnboundPipelineGraphV1

A version 1 graph with fields, nodes, and connections. The root has no dataset ID or item filter yet.

Throws

Throws a local error for an empty dataset name, duplicate field IDs, duplicate node IDs, a node that references an undeclared field object, or a connection whose source or target node is undeclared. Construction does not perform full graph validation. The CLI validates definitions while loading source; use validate() for the graph contract and local checks before applying.

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

const text = field("text", { type: "string" });
const boundary = root({ started: [text], completed: [text] });

export default definePipeline({
  dataset: "example-items",
  fields: [text],
  nodes: [boundary],
  connections: [connect(boundary.started, boundary.completed)],
});

Reference

TypeScript SDK

CLI

HTTP API

Parameters

Returns

Throws

​Parameters

​Returns

​Throws

Parameters

Returns

Throws