@soat/sdk 0.55.0 → 0.56.0

package/dist/index.d.cts

@@ -482,7 +482,15 @@ type Agent = {
      * Key-value pairs a result's own `tags` must all contain (exact match). Scopes documents and memories alike.
      */
     tags?: TagBag;
+    /**
+     * Minimum raw cosine similarity (0–1) a vector candidate must reach to be ranked, the floor the search endpoint spells `min_similarity`. No default: omitted means no floor at all, and every one of the `limit` nearest chunks is injected however weak it is.
+     *
+     */
     min_score?: number;
+    /**
+     * Maximum number of results to inject. Omitted, 10 are injected.
+     *
+     */
     limit?: number;
     /**
      * Public ID of the memory store the agent can write to during generation. When set, a write_memory tool is automatically available to the agent.
@@ -678,7 +686,15 @@ type CreateAgentRequest = {
      * Key-value pairs a result's own `tags` must all contain (exact match). Scopes documents and memories alike.
      */
     tags?: TagBag;
+    /**
+     * Minimum raw cosine similarity (0–1) a vector candidate must reach to be ranked, the floor the search endpoint spells `min_similarity`. No default: omitted means no floor at all, and every one of the `limit` nearest chunks is injected however weak it is.
+     *
+     */
     min_score?: number;
+    /**
+     * Maximum number of results to inject. Omitted, 10 are injected.
+     *
+     */
     limit?: number;
     /**
      * Public ID of the memory store the agent can write to during generation. When set, a write_memory tool is automatically available to the agent.
@@ -768,7 +784,15 @@ type UpdateAgentRequest = {
      * Key-value pairs a result's own `tags` must all contain (exact match). Scopes documents and memories alike.
      */
     tags?: TagBag;
+    /**
+     * Minimum raw cosine similarity (0–1) a vector candidate must reach to be ranked, the floor the search endpoint spells `min_similarity`. No default: omitted means no floor at all, and every one of the `limit` nearest chunks is injected however weak it is.
+     *
+     */
     min_score?: number;
+    /**
+     * Maximum number of results to inject. Omitted, 10 are injected.
+     *
+     */
     limit?: number;
     /**
      * Public ID of the memory store the agent can write to during generation. When set, a write_memory tool is automatically available to the agent.
@@ -869,7 +893,15 @@ type CreateAgentGenerationRequest = {
      * Key-value pairs a result's own `tags` must all contain (exact match). Scopes documents and memories alike.
      */
     tags?: TagBag;
+    /**
+     * Minimum raw cosine similarity (0–1) a vector candidate must reach to be ranked, the floor the search endpoint spells `min_similarity`. No default: omitted means no floor at all, and every one of the `limit` nearest chunks is injected however weak it is.
+     *
+     */
     min_score?: number;
+    /**
+     * Maximum number of results to inject. Omitted, 10 are injected.
+     *
+     */
     limit?: number;
   } | null;
 };
@@ -4705,14 +4737,15 @@ type OrchestrationNode = {
     [key: string]: unknown;
   };
   /**
-   * Maps state write paths to values. Each key is a `state.<path>` destination (the `state.` prefix is optional); each value is JSON Logic (https://jsonlogic.com) evaluated against `{ "output": <node artifact>, "state": <run state> }` — e.g. `{ "summary": {"var": "output.content"} }` writes the artifact's `content` field to `state.summary`. The same evaluator as input_mapping/transform/condition; only the context differs.
+   * Maps state write paths to values. Each key is a `state.<path>` destination (the `state.` prefix is optional); each value is JSON Logic (https://jsonlogic.com) evaluated against `{ "output": <node artifact>, "state": <run state> }` — e.g. `{ "summary": {"var": "output.content"} }` writes the artifact's `content` field to `state.summary`. The same evaluator as input_mapping/transform/condition; only the context differs. An `agent` node's artifact always carries both `content` (the text response) and `object` (the parsed value when a schema applied, `null` otherwise), so `output.content` reads the same whether or not the node declares an `output_schema`.
    *
    */
   state_mapping?: {
     [key: string]: unknown;
   };
   /**
-   * For agent nodes — JSON Schema for structured output parsing.
+   * For agent nodes — JSON Schema the model's answer is parsed into, reaching the artifact as `object`. Declaring it here is only needed for an agent that carries no `output_schema` of its own: the agent's schema already produces the artifact's `object` wherever that agent generates.
+   *
    */
   output_schema?: {
     [key: string]: unknown;
@@ -5081,6 +5114,11 @@ type NodeExecution = {
    *
    */
   attempt: number;
+  /**
+   * How many times this attempt was dispatched, including the first. A worker that stops mid-node leaves its task to be redelivered, and the redelivery re-runs the node under this same record — so a count above 1 is work the run issued, and was billed for, more than once.
+   *
+   */
+  dispatches: number;
   /**
    * Node execution status. `running` marks an execution record whose node is still in flight. Open set — new statuses may be added in minor releases; clients must tolerate unknown values.
    */

package/dist/index.d.mts

@@ -482,7 +482,15 @@ type Agent = {
      * Key-value pairs a result's own `tags` must all contain (exact match). Scopes documents and memories alike.
      */
     tags?: TagBag;
+    /**
+     * Minimum raw cosine similarity (0–1) a vector candidate must reach to be ranked, the floor the search endpoint spells `min_similarity`. No default: omitted means no floor at all, and every one of the `limit` nearest chunks is injected however weak it is.
+     *
+     */
     min_score?: number;
+    /**
+     * Maximum number of results to inject. Omitted, 10 are injected.
+     *
+     */
     limit?: number;
     /**
      * Public ID of the memory store the agent can write to during generation. When set, a write_memory tool is automatically available to the agent.
@@ -678,7 +686,15 @@ type CreateAgentRequest = {
      * Key-value pairs a result's own `tags` must all contain (exact match). Scopes documents and memories alike.
      */
     tags?: TagBag;
+    /**
+     * Minimum raw cosine similarity (0–1) a vector candidate must reach to be ranked, the floor the search endpoint spells `min_similarity`. No default: omitted means no floor at all, and every one of the `limit` nearest chunks is injected however weak it is.
+     *
+     */
     min_score?: number;
+    /**
+     * Maximum number of results to inject. Omitted, 10 are injected.
+     *
+     */
     limit?: number;
     /**
      * Public ID of the memory store the agent can write to during generation. When set, a write_memory tool is automatically available to the agent.
@@ -768,7 +784,15 @@ type UpdateAgentRequest = {
      * Key-value pairs a result's own `tags` must all contain (exact match). Scopes documents and memories alike.
      */
     tags?: TagBag;
+    /**
+     * Minimum raw cosine similarity (0–1) a vector candidate must reach to be ranked, the floor the search endpoint spells `min_similarity`. No default: omitted means no floor at all, and every one of the `limit` nearest chunks is injected however weak it is.
+     *
+     */
     min_score?: number;
+    /**
+     * Maximum number of results to inject. Omitted, 10 are injected.
+     *
+     */
     limit?: number;
     /**
      * Public ID of the memory store the agent can write to during generation. When set, a write_memory tool is automatically available to the agent.
@@ -869,7 +893,15 @@ type CreateAgentGenerationRequest = {
      * Key-value pairs a result's own `tags` must all contain (exact match). Scopes documents and memories alike.
      */
     tags?: TagBag;
+    /**
+     * Minimum raw cosine similarity (0–1) a vector candidate must reach to be ranked, the floor the search endpoint spells `min_similarity`. No default: omitted means no floor at all, and every one of the `limit` nearest chunks is injected however weak it is.
+     *
+     */
     min_score?: number;
+    /**
+     * Maximum number of results to inject. Omitted, 10 are injected.
+     *
+     */
     limit?: number;
   } | null;
 };
@@ -4705,14 +4737,15 @@ type OrchestrationNode = {
     [key: string]: unknown;
   };
   /**
-   * Maps state write paths to values. Each key is a `state.<path>` destination (the `state.` prefix is optional); each value is JSON Logic (https://jsonlogic.com) evaluated against `{ "output": <node artifact>, "state": <run state> }` — e.g. `{ "summary": {"var": "output.content"} }` writes the artifact's `content` field to `state.summary`. The same evaluator as input_mapping/transform/condition; only the context differs.
+   * Maps state write paths to values. Each key is a `state.<path>` destination (the `state.` prefix is optional); each value is JSON Logic (https://jsonlogic.com) evaluated against `{ "output": <node artifact>, "state": <run state> }` — e.g. `{ "summary": {"var": "output.content"} }` writes the artifact's `content` field to `state.summary`. The same evaluator as input_mapping/transform/condition; only the context differs. An `agent` node's artifact always carries both `content` (the text response) and `object` (the parsed value when a schema applied, `null` otherwise), so `output.content` reads the same whether or not the node declares an `output_schema`.
    *
    */
   state_mapping?: {
     [key: string]: unknown;
   };
   /**
-   * For agent nodes — JSON Schema for structured output parsing.
+   * For agent nodes — JSON Schema the model's answer is parsed into, reaching the artifact as `object`. Declaring it here is only needed for an agent that carries no `output_schema` of its own: the agent's schema already produces the artifact's `object` wherever that agent generates.
+   *
    */
   output_schema?: {
     [key: string]: unknown;
@@ -5081,6 +5114,11 @@ type NodeExecution = {
    *
    */
   attempt: number;
+  /**
+   * How many times this attempt was dispatched, including the first. A worker that stops mid-node leaves its task to be redelivered, and the redelivery re-runs the node under this same record — so a count above 1 is work the run issued, and was billed for, more than once.
+   *
+   */
+  dispatches: number;
   /**
    * Node execution status. `running` marks an execution record whose node is still in flight. Open set — new statuses may be added in minor releases; clients must tolerate unknown values.
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soat/sdk",
-  "version": "0.55.0",
+  "version": "0.56.0",
   "description": "TypeScript SDK for SOAT — open-source infrastructure for production-ready AI agents.",
   "keywords": [
     "ai-agents",