@soat/sdk 0.13.3 → 0.13.4

package/dist/index.cjs

@@ -2358,7 +2358,7 @@ var Tools = class {
 	/**
 	* Call a tool
 	*
-	* Directly invokes a tool and returns its output. Supported for `http`, `soat`, and `mcp` tools. `client` tools cannot be invoked server-side and will return 422.
+	* Directly invokes a tool and returns its output. Supported for `http`, `soat`, `mcp`, and `pipeline` tools. `client` tools cannot be invoked server-side and will return 422. A `pipeline` tool runs its declared steps in order and returns the mapped `output` (or the last step's output); `action` is ignored and `input` is the pipeline input.
 	* For `soat` and `mcp` tools the `action` field is required and identifies which action (SOAT) or tool name (MCP) to invoke. For `http` tools `action` is ignored.
 	* `preset_parameters` stored on the tool are merged with the caller-supplied `input` before execution; preset keys take lower precedence.
 	*

package/dist/index.d.cts

@@ -1696,7 +1696,7 @@ type AiProviderResourceProperties = {
   } | null;
 };
 /**
- * Defines a tool (HTTP endpoint, MCP server, or SOAT action) that agents can invoke during a generation.
+ * Defines a tool (HTTP endpoint, MCP server, SOAT action, or pipeline) that agents can invoke during a generation.
  */
 type ToolResourceProperties = {
   /**
@@ -1704,7 +1704,7 @@ type ToolResourceProperties = {
    */
   name: string;
   /**
-   * Tool type hint (e.g. http, mcp, soat)
+   * Tool type hint (e.g. http, mcp, soat, pipeline)
    */
   type?: string | null;
   /**
@@ -1761,6 +1761,12 @@ type ToolResourceProperties = {
   preset_parameters?: {
     [key: string]: unknown;
   } | null;
+  /**
+   * Pipeline definition for `pipeline` tools: an ordered `steps` array, each invoking another tool by `tool_id` (optional `action`) with an `input` built from earlier results via JSON Logic over `{ input, steps }`, plus an optional `output` mapping. Step `input` keys and `var` paths use camelCase (the runtime form). Free-form, user-defined.
+   */
+  pipeline?: {
+    [key: string]: unknown;
+  } | null;
 };
 /**
  * Stores a text document in a project, optionally indexing it for knowledge retrieval.
@@ -1825,9 +1831,9 @@ type MemoryEntryResourceProperties = {
    */
   content: string;
   /**
-   * Origin label (e.g. manual, document, import)
+   * How this entry was created (defaults to manual)
    */
-  source?: string | null;
+  source_type?: 'manual' | 'agent' | 'extraction';
 };
 /**
  * Registers an HTTPS endpoint to receive SOAT platform event notifications.
@@ -2141,7 +2147,7 @@ type Generation = {
    */
   trace_id?: string;
   /**
-   * Public ID of the generation that triggered this one via a sub-agent call. Null for top-level generations.
+   * Public ID of the generation that triggered this one. Set for debate perspective/synthesis child generations and sub-agent invocations alike. Null for top-level generations.
    *
    */
   initiator_generation_id?: string | null;
@@ -2246,7 +2252,7 @@ type DocumentKnowledgeResult = {
   /**
    * Semantic similarity score (0–1). Only present when `query` was provided.
    */
-  score?: number;
+  similarity_score?: number;
   /**
    * Creation timestamp
    */
@@ -2280,7 +2286,7 @@ type MemoryKnowledgeResult = {
   /**
    * Semantic similarity score (0–1). Only present when `query` was provided.
    */
-  score?: number;
+  similarity_score?: number;
   /**
    * Creation timestamp
    */
@@ -2306,7 +2312,7 @@ type MemoryEntry = {
   id?: string;
   memory_id?: string;
   content?: string;
-  source?: 'manual' | 'agent' | 'extraction';
+  source_type?: 'manual' | 'agent' | 'extraction';
   created_at?: Date;
   updated_at?: Date;
 };
@@ -2327,17 +2333,17 @@ type OrchestrationNode = {
   /**
    * Node execution type.
    */
-  type: 'agent' | 'tool' | 'transform' | 'knowledge' | 'memory_write' | 'condition' | 'human' | 'loop' | 'delay' | 'webhook' | 'sub_orchestration';
+  type: 'agent' | 'tool' | 'transform' | 'knowledge' | 'memory_write' | 'condition' | 'human' | 'loop' | 'poll' | 'delay' | 'webhook' | 'sub_orchestration';
   /**
    * For agent nodes — public ID of the agent to invoke.
    */
   agent_id?: string;
   /**
-   * For tool nodes — public ID of the tool to call.
+   * For tool and poll nodes — public ID of the tool to call.
    */
   tool_id?: string;
   /**
-   * For tool nodes — specific operation/action on MCP/SOAT tools.
+   * For tool and poll nodes — specific operation/action on MCP/SOAT tools.
    */
   operation_id?: string;
   /**
@@ -2346,6 +2352,13 @@ type OrchestrationNode = {
   expression?: {
     [key: string]: unknown;
   };
+  /**
+   * For poll nodes — JSON Logic stop condition, evaluated each attempt against the run state augmented with `response` (the latest tool result) and `attempt` (1-based count); a truthy result stops polling.
+   *
+   */
+  exit_condition?: {
+    [key: string]: unknown;
+  };
   /**
    * For human nodes — prompt shown to the human reviewer.
    */
@@ -2385,16 +2398,23 @@ type OrchestrationNode = {
    * For loop nodes — variable name injected into state for each item.
    */
   item_variable?: string;
-  /**
-   * For loop nodes — sub-graph definition to run per item.
-   */
-  sub_graph?: string;
   /**
    * For loop nodes — number of items to process in parallel.
    */
   parallelism?: number;
   /**
-   * For delay nodes — ISO 8601 duration (e.g. PT5S).
+   * For poll nodes — wait between attempts. Accepts a friendly suffix form (`5s`, `30s`, `5m`, `2h`, `500ms`) or ISO 8601 (e.g. PT5S).
+   *
+   */
+  interval?: string;
+  /**
+   * For poll nodes — when max_iterations is reached without the exit condition becoming true, fail the run (true) instead of completing with condition_met=false (default false).
+   *
+   */
+  fail_on_timeout?: boolean;
+  /**
+   * For delay nodes — how long to wait. Accepts a friendly suffix form (`5s`, `30s`, `5m`, `2h`, `500ms`) or ISO 8601 (e.g. PT5S).
+   *
    */
   duration?: string;
   /**
@@ -2406,11 +2426,13 @@ type OrchestrationNode = {
    */
   webhook_url?: string;
   /**
-   * For sub_orchestration nodes — public ID of the child orchestration.
+   * Public ID of the orchestration this node runs — the child orchestration for sub_orchestration nodes, and the orchestration run once per item for loop nodes.
+   *
    */
   orchestration_id?: string;
   /**
-   * Maximum iterations before the node is aborted.
+   * Maximum iterations before the node is aborted. For poll nodes this is the maximum number of attempts (default 10, ceiling 1000).
+   *
    */
   max_iterations?: number;
 };
@@ -2913,7 +2935,7 @@ type Tool = {
   /**
    * Tool type
    */
-  type?: 'http' | 'client' | 'mcp' | 'soat';
+  type?: 'http' | 'client' | 'mcp' | 'soat' | 'pipeline';
   /**
    * What the tool does (sent to the model)
    */
@@ -2947,6 +2969,12 @@ type Tool = {
   preset_parameters?: {
     [key: string]: unknown;
   } | null;
+  /**
+   * Pipeline definition for `pipeline` tools: an ordered `steps` array, each step invoking another tool by `tool_id` (optional `action`) and building its `input` from earlier results via JSON Logic evaluated over `{ input, steps }`. An optional `output` maps the final result.
+   */
+  pipeline?: {
+    [key: string]: unknown;
+  } | null;
   created_at?: Date;
   updated_at?: Date;
 };
@@ -2962,7 +2990,7 @@ type CreateToolRequest = {
   /**
    * Tool type (default http)
    */
-  type?: 'http' | 'client' | 'mcp' | 'soat';
+  type?: 'http' | 'client' | 'mcp' | 'soat' | 'pipeline';
   /**
    * What the tool does
    */
@@ -2996,10 +3024,16 @@ type CreateToolRequest = {
   preset_parameters?: {
     [key: string]: unknown;
   };
+  /**
+   * Pipeline definition for `pipeline` tools. See the `pipeline` field on the Tool schema for the full structure.
+   */
+  pipeline?: {
+    [key: string]: unknown;
+  };
 };
 type UpdateToolRequest = {
   name?: string;
-  type?: 'http' | 'client' | 'mcp' | 'soat';
+  type?: 'http' | 'client' | 'mcp' | 'soat' | 'pipeline';
   description?: string | null;
   parameters?: {
     [key: string]: unknown;
@@ -3021,6 +3055,12 @@ type UpdateToolRequest = {
   preset_parameters?: {
     [key: string]: unknown;
   } | null;
+  /**
+   * Pipeline definition for `pipeline` tools. See the `pipeline` field on the Tool schema for the full structure.
+   */
+  pipeline?: {
+    [key: string]: unknown;
+  } | null;
 };
 type CallToolRequest = {
   /**
@@ -3106,6 +3146,11 @@ type TraceTreeNode = {
    * Child traces triggered by sub-agent calls from this trace
    */
   children?: Array<TraceTreeNode>;
+  /**
+   * Generations that belong to this trace node. Only present when `include=generations` is requested. Includes top-level generations and debate child generations (perspective turns and synthesis steps) linked via `initiator_generation_id`.
+   *
+   */
+  generations?: Array<Generation>;
 };
 type UserRecord = {
   /**
@@ -6007,6 +6052,11 @@ type ListGenerationsData = {
      * Filter by trace public ID
      */
     trace_id?: string;
+    /**
+     * Filter by the public ID of the parent generation. Returns all generations triggered by that generation — debate perspective turns, synthesis steps, and sub-agent invocations. Null-initiated (top-level) generations are not returned.
+     *
+     */
+    initiator_generation_id?: string;
     /**
      * Filter by lifecycle status
      */
@@ -6381,7 +6431,7 @@ type CreateMemoryEntryData = {
     /**
      * How this entry was created
      */
-    source?: 'manual' | 'agent' | 'extraction';
+    source_type?: 'manual' | 'agent' | 'extraction';
     /**
      * Cosine similarity score at or above which the incoming content is considered a duplicate and skipped (default 0.95)
      */
@@ -8088,7 +8138,13 @@ type GetTraceTreeData = {
      */
     trace_id: string;
   };
-  query?: never;
+  query?: {
+    /**
+     * Comma-separated list of related resources to embed on each node. Supported value: `generations` — attaches all generations that belong to each trace node (including debate perspective/synthesis children linked via `initiator_generation_id`).
+     *
+     */
+    include?: string;
+  };
   url: '/api/v1/traces/{trace_id}/tree';
 };
 type GetTraceTreeErrors = {
@@ -9453,7 +9509,7 @@ declare class Tools {
   /**
    * Call a tool
    *
-   * Directly invokes a tool and returns its output. Supported for `http`, `soat`, and `mcp` tools. `client` tools cannot be invoked server-side and will return 422.
+   * Directly invokes a tool and returns its output. Supported for `http`, `soat`, `mcp`, and `pipeline` tools. `client` tools cannot be invoked server-side and will return 422. A `pipeline` tool runs its declared steps in order and returns the mapped `output` (or the last step's output); `action` is ignored and `input` is the pipeline input.
    * For `soat` and `mcp` tools the `action` field is required and identifies which action (SOAT) or tool name (MCP) to invoke. For `http` tools `action` is ignored.
    * `preset_parameters` stored on the tool are merged with the caller-supplied `input` before execution; preset keys take lower precedence.
    *

package/dist/index.d.mts

@@ -1696,7 +1696,7 @@ type AiProviderResourceProperties = {
   } | null;
 };
 /**
- * Defines a tool (HTTP endpoint, MCP server, or SOAT action) that agents can invoke during a generation.
+ * Defines a tool (HTTP endpoint, MCP server, SOAT action, or pipeline) that agents can invoke during a generation.
  */
 type ToolResourceProperties = {
   /**
@@ -1704,7 +1704,7 @@ type ToolResourceProperties = {
    */
   name: string;
   /**
-   * Tool type hint (e.g. http, mcp, soat)
+   * Tool type hint (e.g. http, mcp, soat, pipeline)
    */
   type?: string | null;
   /**
@@ -1761,6 +1761,12 @@ type ToolResourceProperties = {
   preset_parameters?: {
     [key: string]: unknown;
   } | null;
+  /**
+   * Pipeline definition for `pipeline` tools: an ordered `steps` array, each invoking another tool by `tool_id` (optional `action`) with an `input` built from earlier results via JSON Logic over `{ input, steps }`, plus an optional `output` mapping. Step `input` keys and `var` paths use camelCase (the runtime form). Free-form, user-defined.
+   */
+  pipeline?: {
+    [key: string]: unknown;
+  } | null;
 };
 /**
  * Stores a text document in a project, optionally indexing it for knowledge retrieval.
@@ -1825,9 +1831,9 @@ type MemoryEntryResourceProperties = {
    */
   content: string;
   /**
-   * Origin label (e.g. manual, document, import)
+   * How this entry was created (defaults to manual)
    */
-  source?: string | null;
+  source_type?: 'manual' | 'agent' | 'extraction';
 };
 /**
  * Registers an HTTPS endpoint to receive SOAT platform event notifications.
@@ -2141,7 +2147,7 @@ type Generation = {
    */
   trace_id?: string;
   /**
-   * Public ID of the generation that triggered this one via a sub-agent call. Null for top-level generations.
+   * Public ID of the generation that triggered this one. Set for debate perspective/synthesis child generations and sub-agent invocations alike. Null for top-level generations.
    *
    */
   initiator_generation_id?: string | null;
@@ -2246,7 +2252,7 @@ type DocumentKnowledgeResult = {
   /**
    * Semantic similarity score (0–1). Only present when `query` was provided.
    */
-  score?: number;
+  similarity_score?: number;
   /**
    * Creation timestamp
    */
@@ -2280,7 +2286,7 @@ type MemoryKnowledgeResult = {
   /**
    * Semantic similarity score (0–1). Only present when `query` was provided.
    */
-  score?: number;
+  similarity_score?: number;
   /**
    * Creation timestamp
    */
@@ -2306,7 +2312,7 @@ type MemoryEntry = {
   id?: string;
   memory_id?: string;
   content?: string;
-  source?: 'manual' | 'agent' | 'extraction';
+  source_type?: 'manual' | 'agent' | 'extraction';
   created_at?: Date;
   updated_at?: Date;
 };
@@ -2327,17 +2333,17 @@ type OrchestrationNode = {
   /**
    * Node execution type.
    */
-  type: 'agent' | 'tool' | 'transform' | 'knowledge' | 'memory_write' | 'condition' | 'human' | 'loop' | 'delay' | 'webhook' | 'sub_orchestration';
+  type: 'agent' | 'tool' | 'transform' | 'knowledge' | 'memory_write' | 'condition' | 'human' | 'loop' | 'poll' | 'delay' | 'webhook' | 'sub_orchestration';
   /**
    * For agent nodes — public ID of the agent to invoke.
    */
   agent_id?: string;
   /**
-   * For tool nodes — public ID of the tool to call.
+   * For tool and poll nodes — public ID of the tool to call.
    */
   tool_id?: string;
   /**
-   * For tool nodes — specific operation/action on MCP/SOAT tools.
+   * For tool and poll nodes — specific operation/action on MCP/SOAT tools.
    */
   operation_id?: string;
   /**
@@ -2346,6 +2352,13 @@ type OrchestrationNode = {
   expression?: {
     [key: string]: unknown;
   };
+  /**
+   * For poll nodes — JSON Logic stop condition, evaluated each attempt against the run state augmented with `response` (the latest tool result) and `attempt` (1-based count); a truthy result stops polling.
+   *
+   */
+  exit_condition?: {
+    [key: string]: unknown;
+  };
   /**
    * For human nodes — prompt shown to the human reviewer.
    */
@@ -2385,16 +2398,23 @@ type OrchestrationNode = {
    * For loop nodes — variable name injected into state for each item.
    */
   item_variable?: string;
-  /**
-   * For loop nodes — sub-graph definition to run per item.
-   */
-  sub_graph?: string;
   /**
    * For loop nodes — number of items to process in parallel.
    */
   parallelism?: number;
   /**
-   * For delay nodes — ISO 8601 duration (e.g. PT5S).
+   * For poll nodes — wait between attempts. Accepts a friendly suffix form (`5s`, `30s`, `5m`, `2h`, `500ms`) or ISO 8601 (e.g. PT5S).
+   *
+   */
+  interval?: string;
+  /**
+   * For poll nodes — when max_iterations is reached without the exit condition becoming true, fail the run (true) instead of completing with condition_met=false (default false).
+   *
+   */
+  fail_on_timeout?: boolean;
+  /**
+   * For delay nodes — how long to wait. Accepts a friendly suffix form (`5s`, `30s`, `5m`, `2h`, `500ms`) or ISO 8601 (e.g. PT5S).
+   *
    */
   duration?: string;
   /**
@@ -2406,11 +2426,13 @@ type OrchestrationNode = {
    */
   webhook_url?: string;
   /**
-   * For sub_orchestration nodes — public ID of the child orchestration.
+   * Public ID of the orchestration this node runs — the child orchestration for sub_orchestration nodes, and the orchestration run once per item for loop nodes.
+   *
    */
   orchestration_id?: string;
   /**
-   * Maximum iterations before the node is aborted.
+   * Maximum iterations before the node is aborted. For poll nodes this is the maximum number of attempts (default 10, ceiling 1000).
+   *
    */
   max_iterations?: number;
 };
@@ -2913,7 +2935,7 @@ type Tool = {
   /**
    * Tool type
    */
-  type?: 'http' | 'client' | 'mcp' | 'soat';
+  type?: 'http' | 'client' | 'mcp' | 'soat' | 'pipeline';
   /**
    * What the tool does (sent to the model)
    */
@@ -2947,6 +2969,12 @@ type Tool = {
   preset_parameters?: {
     [key: string]: unknown;
   } | null;
+  /**
+   * Pipeline definition for `pipeline` tools: an ordered `steps` array, each step invoking another tool by `tool_id` (optional `action`) and building its `input` from earlier results via JSON Logic evaluated over `{ input, steps }`. An optional `output` maps the final result.
+   */
+  pipeline?: {
+    [key: string]: unknown;
+  } | null;
   created_at?: Date;
   updated_at?: Date;
 };
@@ -2962,7 +2990,7 @@ type CreateToolRequest = {
   /**
    * Tool type (default http)
    */
-  type?: 'http' | 'client' | 'mcp' | 'soat';
+  type?: 'http' | 'client' | 'mcp' | 'soat' | 'pipeline';
   /**
    * What the tool does
    */
@@ -2996,10 +3024,16 @@ type CreateToolRequest = {
   preset_parameters?: {
     [key: string]: unknown;
   };
+  /**
+   * Pipeline definition for `pipeline` tools. See the `pipeline` field on the Tool schema for the full structure.
+   */
+  pipeline?: {
+    [key: string]: unknown;
+  };
 };
 type UpdateToolRequest = {
   name?: string;
-  type?: 'http' | 'client' | 'mcp' | 'soat';
+  type?: 'http' | 'client' | 'mcp' | 'soat' | 'pipeline';
   description?: string | null;
   parameters?: {
     [key: string]: unknown;
@@ -3021,6 +3055,12 @@ type UpdateToolRequest = {
   preset_parameters?: {
     [key: string]: unknown;
   } | null;
+  /**
+   * Pipeline definition for `pipeline` tools. See the `pipeline` field on the Tool schema for the full structure.
+   */
+  pipeline?: {
+    [key: string]: unknown;
+  } | null;
 };
 type CallToolRequest = {
   /**
@@ -3106,6 +3146,11 @@ type TraceTreeNode = {
    * Child traces triggered by sub-agent calls from this trace
    */
   children?: Array<TraceTreeNode>;
+  /**
+   * Generations that belong to this trace node. Only present when `include=generations` is requested. Includes top-level generations and debate child generations (perspective turns and synthesis steps) linked via `initiator_generation_id`.
+   *
+   */
+  generations?: Array<Generation>;
 };
 type UserRecord = {
   /**
@@ -6007,6 +6052,11 @@ type ListGenerationsData = {
      * Filter by trace public ID
      */
     trace_id?: string;
+    /**
+     * Filter by the public ID of the parent generation. Returns all generations triggered by that generation — debate perspective turns, synthesis steps, and sub-agent invocations. Null-initiated (top-level) generations are not returned.
+     *
+     */
+    initiator_generation_id?: string;
     /**
      * Filter by lifecycle status
      */
@@ -6381,7 +6431,7 @@ type CreateMemoryEntryData = {
     /**
      * How this entry was created
      */
-    source?: 'manual' | 'agent' | 'extraction';
+    source_type?: 'manual' | 'agent' | 'extraction';
     /**
      * Cosine similarity score at or above which the incoming content is considered a duplicate and skipped (default 0.95)
      */
@@ -8088,7 +8138,13 @@ type GetTraceTreeData = {
      */
     trace_id: string;
   };
-  query?: never;
+  query?: {
+    /**
+     * Comma-separated list of related resources to embed on each node. Supported value: `generations` — attaches all generations that belong to each trace node (including debate perspective/synthesis children linked via `initiator_generation_id`).
+     *
+     */
+    include?: string;
+  };
   url: '/api/v1/traces/{trace_id}/tree';
 };
 type GetTraceTreeErrors = {
@@ -9453,7 +9509,7 @@ declare class Tools {
   /**
    * Call a tool
    *
-   * Directly invokes a tool and returns its output. Supported for `http`, `soat`, and `mcp` tools. `client` tools cannot be invoked server-side and will return 422.
+   * Directly invokes a tool and returns its output. Supported for `http`, `soat`, `mcp`, and `pipeline` tools. `client` tools cannot be invoked server-side and will return 422. A `pipeline` tool runs its declared steps in order and returns the mapped `output` (or the last step's output); `action` is ignored and `input` is the pipeline input.
    * For `soat` and `mcp` tools the `action` field is required and identifies which action (SOAT) or tool name (MCP) to invoke. For `http` tools `action` is ignored.
    * `preset_parameters` stored on the tool are merged with the caller-supplied `input` before execution; preset keys take lower precedence.
    *

package/dist/index.mjs

@@ -2357,7 +2357,7 @@ var Tools = class {
 	/**
 	* Call a tool
 	*
-	* Directly invokes a tool and returns its output. Supported for `http`, `soat`, and `mcp` tools. `client` tools cannot be invoked server-side and will return 422.
+	* Directly invokes a tool and returns its output. Supported for `http`, `soat`, `mcp`, and `pipeline` tools. `client` tools cannot be invoked server-side and will return 422. A `pipeline` tool runs its declared steps in order and returns the mapped `output` (or the last step's output); `action` is ignored and `input` is the pipeline input.
 	* For `soat` and `mcp` tools the `action` field is required and identifies which action (SOAT) or tool name (MCP) to invoke. For `http` tools `action` is ignored.
 	* `preset_parameters` stored on the tool are merged with the caller-supplied `input` before execution; preset keys take lower precedence.
 	*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soat/sdk",
-  "version": "0.13.3",
+  "version": "0.13.4",
   "description": "TypeScript SDK for the SOAT API",
   "type": "module",
   "main": "dist/index.mjs",