code

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

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

export const normalize = code("normalize", {
  about: { name: "normalize" },
  input: [{ field: text, optional: false }],
  output: [{ field: normalized, optional: false }],
  envVars: [
    { type: "static", name: "LOG_LEVEL", value: "info" },
    { type: "secret", name: "SERVICE_TOKEN", secretName: "service_token" },
  ],
  code: {
    code: 'async def main(inputs):\n    return {"normalized": inputs["text"].strip()}\n',
  },
});

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

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

export const normalize = code("normalize", {
  about: { name: "normalize" },
  input: [{ field: text, optional: false }],
  output: [{ field: normalized, optional: false }],
  envVars: [
    { type: "static", name: "LOG_LEVEL", value: "info" },
    { type: "secret", name: "SERVICE_TOKEN", secretName: "service_token" },
  ],
  code: {
    code: 'async def main(inputs):\n    return {"normalized": inputs["text"].strip()}\n',
  },
});

import type { AuthoredCodeNode, AuthoringIdOptions, CodeAuthoringSettings } from "@toloka-platform/sdk";

declare function code(
  name: string,
  settings: CodeAuthoringSettings,
  options?: AuthoringIdOptions,
): AuthoredCodeNode;

Parameters

string

required

Name used to derive the node ID. Also set settings.about.name; this constructor does not fill it for you.

CodeAuthoringSettings

required

Python source, field bindings, and node settings. See the Code node reference for runtime behavior, environment variables, and platform checks.

Show Authoring settings

CodeNodeSettings['about']

required

Node name and optional description.

readonly { field: Field; optional: boolean }[]

required

Fields read by the node. Reuse declared Field objects.

readonly { field: Field; optional: boolean }[]

required

Fields written by the node. optional(field) constructs an optional binding.

{ code: string }

required

Python source with an async main(inputs) function.

CodeNodeSettings['envVars']

Array of static values and project-secret references. Each entry has one of these shapes.

Show Static entry

'static'

required

Selects a literal value.

string

required

Environment variable name exposed to Python.

string

required

Environment variable value.

Show Secret reference

'secret'

required

Selects a project secret.

string

required

Environment variable name exposed to Python.

string

required

Name of the project secret to read.

CodeNodeSettings['checks']

Platform check definitions, separate from local tests.

Show Check settings

array

Saved Code checks.

Show Check fields

string

required

Check identifier.

string

required

Check display name.

string | Record<string, string>

required

JSON sample input as a string, or as an object with an input key containing that string.

AuthoringIdOptions

default:"{}"

Optional identity override.

Show Options

string

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

Returns

AuthoredCodeNode

Add the node to definePipeline({ nodes }) and connect its ports.

Show Node properties

string

Graph node ID.

'code'

Node type.

CodeNodeSettings

Settings with field objects compiled to graph references.

InputPort

Port for incoming connections.

OutputPort

Port for outgoing connections.

Construction does not execute Python. Use runCodeNode or test.code to exercise it locally.

The SERVICE_TOKEN environment variable references a project secret named service_token; create that secret before running the node on the platform.

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

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

export const normalize = code("normalize", {
  about: { name: "normalize" },
  input: [{ field: text, optional: false }],
  output: [{ field: normalized, optional: false }],
  envVars: [
    { type: "static", name: "LOG_LEVEL", value: "info" },
    { type: "secret", name: "SERVICE_TOKEN", secretName: "service_token" },
  ],
  code: {
    code: 'async def main(inputs):\n    return {"normalized": inputs["text"].strip()}\n',
  },
});

Reference

TypeScript SDK

CLI

HTTP API

Parameters

Returns

​Parameters

​Returns

Parameters

Returns