@soat/sdk 0.14.10 → 0.14.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.cts +29 -4
- package/dist/index.d.mts +29 -4
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -681,6 +681,10 @@ type CreateAgentGenerationRequest = {
|
|
|
681
681
|
* Logical action label recorded on the generation's usage meter, so spend can be rolled up per action (e.g. an A/B/C/D operating action).
|
|
682
682
|
*/
|
|
683
683
|
action_id?: string;
|
|
684
|
+
/**
|
|
685
|
+
* Per-turn override of the agent's `knowledge_config.extraction` default. Omit to follow the agent's stored config. Set `false` to suppress automatic memory extraction for this turn (e.g. an operational or tool-listing turn that would only add noise to a curated memory). Set `true` to force extraction on for this turn even when the agent does not enable it by default, provided the agent has a `write_memory_id`. Has no effect on streaming or `requires_action` turns, which never extract.
|
|
686
|
+
*/
|
|
687
|
+
extract?: boolean;
|
|
684
688
|
/**
|
|
685
689
|
* Per-generation knowledge retrieval override. Array filters (memory_ids, memory_tags, document_ids, document_paths) are unioned with the agent's stored knowledge_config; scalar fields (min_score, limit) use the per-generation value when present.
|
|
686
690
|
*/
|
|
@@ -1138,6 +1142,10 @@ type DiscussionRecord = {
|
|
|
1138
1142
|
[key: string]: string;
|
|
1139
1143
|
};
|
|
1140
1144
|
participants?: Array<ParticipantRecord>;
|
|
1145
|
+
/**
|
|
1146
|
+
* Non-blocking warnings for participant/synthesis prompt `{token}` references outside the allowlist ({topic}, {transcript}, {steps.deliberation}, {steps.deliberation.last}). Unknown tokens are not rejected — they pass through unresolved — so this is informational only.
|
|
1147
|
+
*/
|
|
1148
|
+
template_warnings?: Array<string>;
|
|
1141
1149
|
created_at?: Date;
|
|
1142
1150
|
updated_at?: Date;
|
|
1143
1151
|
};
|
|
@@ -1705,6 +1713,10 @@ type ToolResourceProperties = {
|
|
|
1705
1713
|
* Allowlist of actions the tool exposes. For `soat` tools: SOAT platform action names. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool).
|
|
1706
1714
|
*/
|
|
1707
1715
|
actions?: Array<string> | null;
|
|
1716
|
+
/**
|
|
1717
|
+
* For `mcp` tools: an optional denylist of MCP tool names to hide. Applied after `actions` and taking precedence over it — the ergonomic way to scope a read+write MCP server read-only by denying just the write tools. `null` denies nothing.
|
|
1718
|
+
*/
|
|
1719
|
+
denied_actions?: Array<string> | null;
|
|
1708
1720
|
/**
|
|
1709
1721
|
* Pre-filled parameter values injected at execution time
|
|
1710
1722
|
*/
|
|
@@ -2558,10 +2570,11 @@ type OrchestrationNode = {
|
|
|
2558
2570
|
[key: string]: unknown;
|
|
2559
2571
|
};
|
|
2560
2572
|
/**
|
|
2561
|
-
* Maps node artifact
|
|
2573
|
+
* 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.
|
|
2574
|
+
*
|
|
2562
2575
|
*/
|
|
2563
|
-
|
|
2564
|
-
[key: string]:
|
|
2576
|
+
state_mapping?: {
|
|
2577
|
+
[key: string]: unknown;
|
|
2565
2578
|
};
|
|
2566
2579
|
/**
|
|
2567
2580
|
* For agent nodes — JSON Schema for structured output parsing.
|
|
@@ -3241,6 +3254,10 @@ type Tool = {
|
|
|
3241
3254
|
* Allowlist of actions to expose. For `soat` tools: SOAT platform action names (required). For `mcp` tools: an optional allowlist of MCP tool names — when set, only those tools are exposed to the model and callable via `/call`; when `null`, the entire MCP server surface is exposed. Ignored for other tool types.
|
|
3242
3255
|
*/
|
|
3243
3256
|
actions?: Array<string> | null;
|
|
3257
|
+
/**
|
|
3258
|
+
* For `mcp` tools: an optional denylist of MCP tool names to hide. Applied after `actions` and taking precedence over it — a name in both lists is denied. This is the ergonomic way to scope a read+write MCP server read-only: deny just the write tools instead of enumerating every read tool in `actions`. Names not listed are exposed. `null` (default) denies nothing. Ignored for other tool types.
|
|
3259
|
+
*/
|
|
3260
|
+
denied_actions?: Array<string> | null;
|
|
3244
3261
|
/**
|
|
3245
3262
|
* Fixed parameters merged into every soat tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
|
|
3246
3263
|
*/
|
|
@@ -3306,6 +3323,10 @@ type CreateToolRequest = {
|
|
|
3306
3323
|
* Allowlist of actions. For `soat` tools: SOAT platform action names (required). For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface — omit or set `null` to expose every tool the MCP server offers. Ignored for other tool types.
|
|
3307
3324
|
*/
|
|
3308
3325
|
actions?: Array<string>;
|
|
3326
|
+
/**
|
|
3327
|
+
* For `mcp` tools: an optional denylist of MCP tool names to hide. Applied after `actions` and taking precedence over it. Use it to scope a read+write MCP server read-only by denying just the write tools. Omit or set `null` to deny nothing. Ignored for other tool types.
|
|
3328
|
+
*/
|
|
3329
|
+
denied_actions?: Array<string>;
|
|
3309
3330
|
/**
|
|
3310
3331
|
* Fixed parameters merged into every soat tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
|
|
3311
3332
|
*/
|
|
@@ -3350,6 +3371,10 @@ type UpdateToolRequest = {
|
|
|
3350
3371
|
* Allowlist of actions. For `soat` tools: SOAT platform action names. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool). Ignored for other tool types.
|
|
3351
3372
|
*/
|
|
3352
3373
|
actions?: Array<string> | null;
|
|
3374
|
+
/**
|
|
3375
|
+
* For `mcp` tools: an optional denylist of MCP tool names to hide. Applied after `actions` and taking precedence over it. Use it to scope a read+write MCP server read-only by denying just the write tools. `null` denies nothing. Ignored for other tool types.
|
|
3376
|
+
*/
|
|
3377
|
+
denied_actions?: Array<string> | null;
|
|
3353
3378
|
/**
|
|
3354
3379
|
* Fixed parameters merged into every soat tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
|
|
3355
3380
|
*/
|
|
@@ -3375,7 +3400,7 @@ type UpdateToolRequest = {
|
|
|
3375
3400
|
};
|
|
3376
3401
|
type CallToolRequest = {
|
|
3377
3402
|
/**
|
|
3378
|
-
* For `soat` tools: the action name (must be in the tool's `actions` list). For `mcp` tools: the MCP tool name to invoke (must be in the tool's `actions` allowlist when one is set). Ignored for `http` tools.
|
|
3403
|
+
* For `soat` tools: the action name (must be in the tool's `actions` list). For `mcp` tools: the MCP tool name to invoke (must be in the tool's `actions` allowlist when one is set, and must not be in its `denied_actions` denylist). Ignored for `http` tools.
|
|
3379
3404
|
*
|
|
3380
3405
|
*/
|
|
3381
3406
|
action?: string;
|
package/dist/index.d.mts
CHANGED
|
@@ -681,6 +681,10 @@ type CreateAgentGenerationRequest = {
|
|
|
681
681
|
* Logical action label recorded on the generation's usage meter, so spend can be rolled up per action (e.g. an A/B/C/D operating action).
|
|
682
682
|
*/
|
|
683
683
|
action_id?: string;
|
|
684
|
+
/**
|
|
685
|
+
* Per-turn override of the agent's `knowledge_config.extraction` default. Omit to follow the agent's stored config. Set `false` to suppress automatic memory extraction for this turn (e.g. an operational or tool-listing turn that would only add noise to a curated memory). Set `true` to force extraction on for this turn even when the agent does not enable it by default, provided the agent has a `write_memory_id`. Has no effect on streaming or `requires_action` turns, which never extract.
|
|
686
|
+
*/
|
|
687
|
+
extract?: boolean;
|
|
684
688
|
/**
|
|
685
689
|
* Per-generation knowledge retrieval override. Array filters (memory_ids, memory_tags, document_ids, document_paths) are unioned with the agent's stored knowledge_config; scalar fields (min_score, limit) use the per-generation value when present.
|
|
686
690
|
*/
|
|
@@ -1138,6 +1142,10 @@ type DiscussionRecord = {
|
|
|
1138
1142
|
[key: string]: string;
|
|
1139
1143
|
};
|
|
1140
1144
|
participants?: Array<ParticipantRecord>;
|
|
1145
|
+
/**
|
|
1146
|
+
* Non-blocking warnings for participant/synthesis prompt `{token}` references outside the allowlist ({topic}, {transcript}, {steps.deliberation}, {steps.deliberation.last}). Unknown tokens are not rejected — they pass through unresolved — so this is informational only.
|
|
1147
|
+
*/
|
|
1148
|
+
template_warnings?: Array<string>;
|
|
1141
1149
|
created_at?: Date;
|
|
1142
1150
|
updated_at?: Date;
|
|
1143
1151
|
};
|
|
@@ -1705,6 +1713,10 @@ type ToolResourceProperties = {
|
|
|
1705
1713
|
* Allowlist of actions the tool exposes. For `soat` tools: SOAT platform action names. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool).
|
|
1706
1714
|
*/
|
|
1707
1715
|
actions?: Array<string> | null;
|
|
1716
|
+
/**
|
|
1717
|
+
* For `mcp` tools: an optional denylist of MCP tool names to hide. Applied after `actions` and taking precedence over it — the ergonomic way to scope a read+write MCP server read-only by denying just the write tools. `null` denies nothing.
|
|
1718
|
+
*/
|
|
1719
|
+
denied_actions?: Array<string> | null;
|
|
1708
1720
|
/**
|
|
1709
1721
|
* Pre-filled parameter values injected at execution time
|
|
1710
1722
|
*/
|
|
@@ -2558,10 +2570,11 @@ type OrchestrationNode = {
|
|
|
2558
2570
|
[key: string]: unknown;
|
|
2559
2571
|
};
|
|
2560
2572
|
/**
|
|
2561
|
-
* Maps node artifact
|
|
2573
|
+
* 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.
|
|
2574
|
+
*
|
|
2562
2575
|
*/
|
|
2563
|
-
|
|
2564
|
-
[key: string]:
|
|
2576
|
+
state_mapping?: {
|
|
2577
|
+
[key: string]: unknown;
|
|
2565
2578
|
};
|
|
2566
2579
|
/**
|
|
2567
2580
|
* For agent nodes — JSON Schema for structured output parsing.
|
|
@@ -3241,6 +3254,10 @@ type Tool = {
|
|
|
3241
3254
|
* Allowlist of actions to expose. For `soat` tools: SOAT platform action names (required). For `mcp` tools: an optional allowlist of MCP tool names — when set, only those tools are exposed to the model and callable via `/call`; when `null`, the entire MCP server surface is exposed. Ignored for other tool types.
|
|
3242
3255
|
*/
|
|
3243
3256
|
actions?: Array<string> | null;
|
|
3257
|
+
/**
|
|
3258
|
+
* For `mcp` tools: an optional denylist of MCP tool names to hide. Applied after `actions` and taking precedence over it — a name in both lists is denied. This is the ergonomic way to scope a read+write MCP server read-only: deny just the write tools instead of enumerating every read tool in `actions`. Names not listed are exposed. `null` (default) denies nothing. Ignored for other tool types.
|
|
3259
|
+
*/
|
|
3260
|
+
denied_actions?: Array<string> | null;
|
|
3244
3261
|
/**
|
|
3245
3262
|
* Fixed parameters merged into every soat tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
|
|
3246
3263
|
*/
|
|
@@ -3306,6 +3323,10 @@ type CreateToolRequest = {
|
|
|
3306
3323
|
* Allowlist of actions. For `soat` tools: SOAT platform action names (required). For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface — omit or set `null` to expose every tool the MCP server offers. Ignored for other tool types.
|
|
3307
3324
|
*/
|
|
3308
3325
|
actions?: Array<string>;
|
|
3326
|
+
/**
|
|
3327
|
+
* For `mcp` tools: an optional denylist of MCP tool names to hide. Applied after `actions` and taking precedence over it. Use it to scope a read+write MCP server read-only by denying just the write tools. Omit or set `null` to deny nothing. Ignored for other tool types.
|
|
3328
|
+
*/
|
|
3329
|
+
denied_actions?: Array<string>;
|
|
3309
3330
|
/**
|
|
3310
3331
|
* Fixed parameters merged into every soat tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
|
|
3311
3332
|
*/
|
|
@@ -3350,6 +3371,10 @@ type UpdateToolRequest = {
|
|
|
3350
3371
|
* Allowlist of actions. For `soat` tools: SOAT platform action names. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool). Ignored for other tool types.
|
|
3351
3372
|
*/
|
|
3352
3373
|
actions?: Array<string> | null;
|
|
3374
|
+
/**
|
|
3375
|
+
* For `mcp` tools: an optional denylist of MCP tool names to hide. Applied after `actions` and taking precedence over it. Use it to scope a read+write MCP server read-only by denying just the write tools. `null` denies nothing. Ignored for other tool types.
|
|
3376
|
+
*/
|
|
3377
|
+
denied_actions?: Array<string> | null;
|
|
3353
3378
|
/**
|
|
3354
3379
|
* Fixed parameters merged into every soat tool call. Keys matching fields in the action's input schema are removed from the schema shown to the model and injected automatically at execution time.
|
|
3355
3380
|
*/
|
|
@@ -3375,7 +3400,7 @@ type UpdateToolRequest = {
|
|
|
3375
3400
|
};
|
|
3376
3401
|
type CallToolRequest = {
|
|
3377
3402
|
/**
|
|
3378
|
-
* For `soat` tools: the action name (must be in the tool's `actions` list). For `mcp` tools: the MCP tool name to invoke (must be in the tool's `actions` allowlist when one is set). Ignored for `http` tools.
|
|
3403
|
+
* For `soat` tools: the action name (must be in the tool's `actions` list). For `mcp` tools: the MCP tool name to invoke (must be in the tool's `actions` allowlist when one is set, and must not be in its `denied_actions` denylist). Ignored for `http` tools.
|
|
3379
3404
|
*
|
|
3380
3405
|
*/
|
|
3381
3406
|
action?: string;
|