@naturali/sdk 0.79.0 → 0.80.0

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 CHANGED
@@ -2562,6 +2562,1099 @@ type FileRecord = {
2562
2562
  */
2563
2563
  updated_at?: Date;
2564
2564
  };
2565
+ /**
2566
+ * A formation template supplied as either a JSON object or a YAML/JSON string. When a string is provided the server parses it with a YAML parser (JSON is valid YAML) before processing.
2567
+ *
2568
+ */
2569
+ type FormationTemplateInput = FormationTemplate | string;
2570
+ type FormationTemplate = {
2571
+ /**
2572
+ * Declared parameters for this template. Each parameter may have a default value and an optional description. Parameters without a default must be supplied in the `parameters` field of the deploy request.
2573
+ *
2574
+ */
2575
+ parameters?: {
2576
+ [key: string]: ParameterDeclaration;
2577
+ } | null;
2578
+ /**
2579
+ * Map of logical resource IDs to resource declarations
2580
+ */
2581
+ resources: {
2582
+ [key: string]: ResourceDeclaration;
2583
+ };
2584
+ /**
2585
+ * Map of output names to values. Values may use `{ "ref": "logicalId" }` to reference physical IDs of created resources, or `{ "param": "ParamName" }` and `{ "sub": "text ${ParamName}" }` to embed parameter values.
2586
+ *
2587
+ */
2588
+ outputs?: {
2589
+ [key: string]: unknown;
2590
+ } | null;
2591
+ /**
2592
+ * Arbitrary metadata attached to the template. Supports the same substitution as `outputs`: `{ "ref": "logicalId" }` resolves to a created resource's physical ID, and `{ "param": "ParamName" }` / `{ "sub": "text ${ParamName}" }` embed parameter values. The raw expressions are preserved here; the resolved values from the last deploy are exposed on the formation's `resolved_metadata` field.
2593
+ *
2594
+ */
2595
+ metadata?: {
2596
+ [key: string]: unknown;
2597
+ } | null;
2598
+ };
2599
+ type ParameterDeclaration = {
2600
+ /**
2601
+ * Parameter type (currently only 'string' is supported)
2602
+ */
2603
+ type?: string;
2604
+ /**
2605
+ * Default value used when the parameter is not supplied at deploy time
2606
+ */
2607
+ default?: string | null;
2608
+ /**
2609
+ * Human-readable description of what this parameter represents
2610
+ */
2611
+ description?: string | null;
2612
+ /**
2613
+ * When true, the parameter value should be treated as sensitive and not echoed in logs or UI. Analogous to NoEcho in CloudFormation.
2614
+ *
2615
+ */
2616
+ no_echo?: boolean | null;
2617
+ /**
2618
+ * When true, omitting this parameter on update reuses its previously stored value instead of failing the required-parameter check — analogous to CloudFormation's UsePreviousValue, declared in the template. An explicitly supplied value still overrides. Has no effect on create (there is no previous value yet). The value is reused only where the underlying resource retains it (e.g. a secret's encrypted value); otherwise the last-applied value is used.
2619
+ *
2620
+ */
2621
+ use_previous_value?: boolean | null;
2622
+ };
2623
+ /**
2624
+ * Creates an AI agent backed by a provider. The agent handles requests, runs tools, and can be attached to actors. Exactly one of `ai_provider_id` or `model_route_id` must be declared. Switching an existing agent between the two declares the new field together with an explicit `null` for the old one.
2625
+ */
2626
+ type AgentResourceProperties = {
2627
+ /**
2628
+ * Public ID of the AI provider to pin. Mutually exclusive with `model_route_id`.
2629
+ */
2630
+ ai_provider_id?: string | null;
2631
+ /**
2632
+ * Public ID of a model route in the same project — the agent's completion model is resolved through the route's ordered targets with failover. Mutually exclusive with `ai_provider_id` and `model`.
2633
+ */
2634
+ model_route_id?: string | null;
2635
+ /**
2636
+ * Agent display name
2637
+ */
2638
+ name?: string | null;
2639
+ /**
2640
+ * System instructions for the agent
2641
+ */
2642
+ instructions?: string | null;
2643
+ /**
2644
+ * Model identifier (overrides provider default)
2645
+ */
2646
+ model?: string | null;
2647
+ /**
2648
+ * Tools to attach, one binding object per tool: `{ tool_id }`. Tool-call gating is owned by guardrails (attached via `guardrail_ids` on the project, agent, or tool), not by the binding. Inline `tool` entries are not supported in templates; declare a tool resource and reference it via `tool_id` (a `{ "ref": … }` to a tool resource in the same template resolves at deploy time).
2649
+ */
2650
+ tool_bindings?: Array<{
2651
+ [key: string]: unknown;
2652
+ }> | null;
2653
+ /**
2654
+ * Maximum number of agentic steps per generation
2655
+ */
2656
+ max_steps?: number | null;
2657
+ /**
2658
+ * Controls how the model selects tools. Accepts a string (`"auto"`, `"required"`) or an object (`{ "type": "tool", "tool_name": "my_tool" }`).
2659
+ */
2660
+ tool_choice?: unknown;
2661
+ /**
2662
+ * Conditions that stop multi-step generation early. The loop stops when any condition is met.
2663
+ */
2664
+ stop_conditions?: Array<{
2665
+ /**
2666
+ * Condition type — currently `hasToolCall`
2667
+ */
2668
+ type?: string;
2669
+ /**
2670
+ * Tool name to match when type is `hasToolCall`
2671
+ */
2672
+ tool_name?: string | null;
2673
+ }> | null;
2674
+ /**
2675
+ * Subset of the bound tools that are active
2676
+ */
2677
+ active_tool_ids?: Array<string> | null;
2678
+ /**
2679
+ * Guardrails attached at the agent scope.
2680
+ */
2681
+ guardrail_ids?: Array<string> | null;
2682
+ /**
2683
+ * Per-step overrides applied during multi-step generation. Steps not covered by a rule use the agent defaults.
2684
+ */
2685
+ step_rules?: Array<{
2686
+ /**
2687
+ * 1-indexed step number this rule applies to
2688
+ */
2689
+ step?: number;
2690
+ /**
2691
+ * Tool choice override for this step, e.g. `auto`, `required`, or `{ type: tool, tool_name: search }`
2692
+ */
2693
+ tool_choice?: {
2694
+ [key: string]: unknown;
2695
+ } | null;
2696
+ /**
2697
+ * Tool IDs active on this step
2698
+ */
2699
+ active_tool_ids?: Array<string> | null;
2700
+ }> | null;
2701
+ /**
2702
+ * Restricts which runtime actions the agent may invoke. Evaluated as the intersection with the caller's own policy.
2703
+ */
2704
+ boundary_policy?: {
2705
+ /**
2706
+ * List of IAM policy statements
2707
+ */
2708
+ statement?: Array<{
2709
+ /**
2710
+ * Effect — `Allow` or `Deny`
2711
+ */
2712
+ effect?: string;
2713
+ /**
2714
+ * IAM action strings, e.g. `memories:*` or `agents:DeleteAgent`
2715
+ */
2716
+ action?: Array<string>;
2717
+ /**
2718
+ * Resource SRN patterns (optional; omit to match all resources)
2719
+ */
2720
+ resource?: Array<string> | null;
2721
+ }>;
2722
+ } | null;
2723
+ /**
2724
+ * Sampling temperature
2725
+ */
2726
+ temperature?: number | null;
2727
+ /**
2728
+ * Maximum number of recent messages to include in the context window sent to the model. When null, all messages are included.
2729
+ */
2730
+ max_context_messages?: number | null;
2731
+ /**
2732
+ * When true, only one open session per actor_id is allowed for this agent.
2733
+ */
2734
+ single_session_per_actor?: boolean | null;
2735
+ /**
2736
+ * Agent-scope zero-retention setting (`full` or `none`). `null` inherits the project's setting. `full` is refused when the project's own mode is `none`.
2737
+ */
2738
+ trace_content_mode?: string | null;
2739
+ /**
2740
+ * Knowledge retrieval configuration. When set, relevant documents and memory entries are injected into every generation.
2741
+ */
2742
+ knowledge_config?: {
2743
+ /**
2744
+ * Public IDs of memories to retrieve from
2745
+ */
2746
+ memory_ids?: Array<string>;
2747
+ /**
2748
+ * Retrieve from all memories matching these tags
2749
+ */
2750
+ memory_tags?: Array<string>;
2751
+ /**
2752
+ * Public IDs of documents to retrieve from
2753
+ */
2754
+ document_ids?: Array<string>;
2755
+ /**
2756
+ * Retrieve from all documents matching these path prefixes
2757
+ */
2758
+ document_paths?: Array<string>;
2759
+ /**
2760
+ * Minimum similarity score (0–1) for retrieved chunks
2761
+ */
2762
+ min_score?: number;
2763
+ /**
2764
+ * Maximum number of chunks to inject
2765
+ */
2766
+ limit?: number;
2767
+ /**
2768
+ * Public ID of the memory the agent can write to. When set, a `write_memory` tool is automatically available to the agent.
2769
+ */
2770
+ write_memory_id?: string | null;
2771
+ /**
2772
+ * Automatic fact extraction from completed generation turns (requires write_memory_id). Pass `true` to enable with defaults, or an object to customize the provider, model, and prompt used for the extraction completion.
2773
+ */
2774
+ extraction?: boolean | {
2775
+ /**
2776
+ * Defaults to true when the object form is used. Set false to keep the configuration but disable extraction.
2777
+ */
2778
+ enabled?: boolean;
2779
+ /**
2780
+ * AI provider override for extraction calls. Must belong to the agent's project. Its default_model becomes the model fallback.
2781
+ */
2782
+ ai_provider_id?: string;
2783
+ /**
2784
+ * Model override for extraction calls.
2785
+ */
2786
+ model?: string;
2787
+ /**
2788
+ * Replaces the default task instructions. The JSON response contract and the conversation transcript are always appended by the server.
2789
+ */
2790
+ prompt?: string;
2791
+ };
2792
+ } | null;
2793
+ /**
2794
+ * JSON Schema describing the structured object the model must return. Non-streaming generations are constrained to this schema; the parsed value is returned as `output.object`.
2795
+ */
2796
+ output_schema?: {
2797
+ [key: string]: unknown;
2798
+ } | null;
2799
+ };
2800
+ /**
2801
+ * Creates a stateful conversation actor that wraps an agent or chat session and optionally links to a memory store.
2802
+ */
2803
+ type ActorResourceProperties = {
2804
+ /**
2805
+ * Actor display name
2806
+ */
2807
+ name: string;
2808
+ /**
2809
+ * External identifier for idempotent actor creation
2810
+ */
2811
+ external_id?: string | null;
2812
+ /**
2813
+ * Persona-specific instructions
2814
+ */
2815
+ instructions?: string | null;
2816
+ /**
2817
+ * Linked agent ID (mutually exclusive with chat_id)
2818
+ */
2819
+ agent_id?: string | null;
2820
+ /**
2821
+ * Linked chat ID (mutually exclusive with agent_id)
2822
+ */
2823
+ chat_id?: string | null;
2824
+ };
2825
+ /**
2826
+ * Configures an LLM provider connection (API key, model, endpoint) that agents use to generate responses.
2827
+ */
2828
+ type AiProviderResourceProperties = {
2829
+ /**
2830
+ * Provider display name
2831
+ */
2832
+ name: string;
2833
+ /**
2834
+ * Provider type (e.g. openai, anthropic)
2835
+ */
2836
+ provider: string;
2837
+ /**
2838
+ * Default model identifier (e.g. gpt-4o, claude-3-7-sonnet)
2839
+ */
2840
+ default_model: string;
2841
+ /**
2842
+ * Public ID of the secret containing the API key
2843
+ */
2844
+ secret_id?: string | null;
2845
+ /**
2846
+ * Custom base URL for the provider API (self-hosted or proxy)
2847
+ */
2848
+ base_url?: string | null;
2849
+ /**
2850
+ * Provider-specific extra configuration
2851
+ */
2852
+ config?: {
2853
+ [key: string]: unknown;
2854
+ } | null;
2855
+ };
2856
+ /**
2857
+ * Defines a tool (HTTP endpoint, MCP server, the runtime action, or pipeline) that agents can invoke during a generation.
2858
+ */
2859
+ type ToolResourceProperties = {
2860
+ /**
2861
+ * Tool display name
2862
+ */
2863
+ name: string;
2864
+ /**
2865
+ * Tool type hint (e.g. http, mcp, builtin, pipeline)
2866
+ */
2867
+ type?: string | null;
2868
+ /**
2869
+ * Tool description shown to the model
2870
+ */
2871
+ description?: string | null;
2872
+ /**
2873
+ * JSON Schema describing the tool's input parameters (free-form, user-defined)
2874
+ */
2875
+ parameters?: {
2876
+ [key: string]: unknown;
2877
+ } | null;
2878
+ /**
2879
+ * HTTP execution configuration. Required for `http` tools.
2880
+ */
2881
+ execute?: {
2882
+ /**
2883
+ * Endpoint URL. Supports `{param}` placeholders resolved from tool arguments.
2884
+ */
2885
+ url?: string;
2886
+ /**
2887
+ * HTTP method (default: `POST`)
2888
+ */
2889
+ method?: string | null;
2890
+ /**
2891
+ * Static headers included in every request
2892
+ */
2893
+ headers?: {
2894
+ [key: string]: unknown;
2895
+ } | null;
2896
+ /**
2897
+ * Request body encoding for `POST`/`PUT`/`PATCH`: `json` (default) or `multipart`. Incompatible with `auth.type: aws_sigv4`.
2898
+ */
2899
+ body_mode?: string | null;
2900
+ /**
2901
+ * Computed request credential. `type` is `aws_sigv4` (with `region`, `service`, `access_key_id`, `secret_access_key` and optional `session_token`) or `gcp_service_account` (with `credentials` and `scopes`). Credential fields accept `{{secret:...}}` references.
2902
+ */
2903
+ auth?: {
2904
+ [key: string]: unknown;
2905
+ } | null;
2906
+ } | null;
2907
+ /**
2908
+ * MCP server connection configuration. Required for `mcp` tools.
2909
+ */
2910
+ mcp?: {
2911
+ /**
2912
+ * MCP server URL
2913
+ */
2914
+ url?: string;
2915
+ /**
2916
+ * Headers included in every MCP request
2917
+ */
2918
+ headers?: {
2919
+ [key: string]: unknown;
2920
+ } | null;
2921
+ } | null;
2922
+ /**
2923
+ * Allowlist of actions the tool exposes. For `mcp` tools: an optional allowlist of MCP tool names to scope the server surface (`null` exposes every tool).
2924
+ */
2925
+ actions?: Array<string> | null;
2926
+ /**
2927
+ * 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.
2928
+ */
2929
+ denied_actions?: Array<string> | null;
2930
+ /**
2931
+ * Optional allowlist of `tool_context` keys forwarded to this tool as prefixed context headers. `null` or omitted forwards every key; `[]` forwards none. The server-pinned identity keys (`sessionId`, `actorId`, `actorExternalId`) are always forwarded, and a key consumed by a `{{context:<key>}}` token in this tool's own headers is substituted regardless of this list.
2932
+ */
2933
+ context_keys?: Array<string> | null;
2934
+ /**
2935
+ * Pre-filled parameter values injected at execution time
2936
+ */
2937
+ preset_parameters?: {
2938
+ [key: string]: unknown;
2939
+ } | null;
2940
+ /**
2941
+ * 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.
2942
+ */
2943
+ pipeline?: {
2944
+ [key: string]: unknown;
2945
+ } | null;
2946
+ /**
2947
+ * Universal JSON Logic mapping applied to the tool's raw result, for every tool type. Evaluated over `{ output: <raw result> }`, e.g. `{ "var": "output.text" }`. For `pipeline` tools this runs after the pipeline's own `output` mapping.
2948
+ */
2949
+ output_mapping?: {
2950
+ [key: string]: unknown;
2951
+ } | null;
2952
+ /**
2953
+ * Guardrails attached at the tool scope.
2954
+ */
2955
+ guardrail_ids?: Array<string> | null;
2956
+ };
2957
+ /**
2958
+ * Declares an evaluation dataset — the named fixture suite an eval runs an agent against. Its test cases are declared separately as `dataset_item` resources, so an item curated through the API is never collateral of a formation apply. Deleting the dataset deletes its items and the evals bound to it.
2959
+ */
2960
+ type DatasetResourceProperties = {
2961
+ /**
2962
+ * Dataset name, unique within the project
2963
+ */
2964
+ name: string;
2965
+ /**
2966
+ * Optional description
2967
+ */
2968
+ description?: string | null;
2969
+ };
2970
+ /**
2971
+ * One test case in a dataset: the messages sent to the agent under test and, optionally, the reference answer scorers compare against. Editing or removing an item never rewrites a run that already scored it — each result froze its own copy.
2972
+ */
2973
+ type DatasetItemResourceProperties = {
2974
+ /**
2975
+ * Public ID of the parent dataset (or ref expression)
2976
+ */
2977
+ dataset_id: string;
2978
+ /**
2979
+ * The messages sent to the agent, as `{role, content}` objects
2980
+ */
2981
+ input: Array<{
2982
+ [key: string]: unknown;
2983
+ }>;
2984
+ /**
2985
+ * Reference answer for exact_match / contains / embedding_similarity / llm_judge scorers
2986
+ */
2987
+ expected_output?: string | null;
2988
+ /**
2989
+ * Free-form tags on the case, e.g. `{"topic": "billing"}`
2990
+ */
2991
+ metadata?: {
2992
+ [key: string]: unknown;
2993
+ } | null;
2994
+ };
2995
+ /**
2996
+ * Binds an agent under test to a dataset and the scorers its outputs are judged by. `pass_threshold` is the pass rate a run must reach for its `passed` verdict — the gate an agent-version promotion consumes.
2997
+ */
2998
+ type EvalResourceProperties = {
2999
+ /**
3000
+ * Eval name, unique within the project
3001
+ */
3002
+ name: string;
3003
+ /**
3004
+ * Public ID of the agent under test (or ref expression)
3005
+ */
3006
+ agent_id: string;
3007
+ /**
3008
+ * Public ID of the dataset to run against (or ref expression)
3009
+ */
3010
+ dataset_id: string;
3011
+ /**
3012
+ * Scorer configs — `exact_match`, `contains`, `json_logic`, `output_schema`, `embedding_similarity`, `llm_judge`, or `tool`. Same shape as the evals REST contract.
3013
+ */
3014
+ scorers: Array<{
3015
+ [key: string]: unknown;
3016
+ }>;
3017
+ /**
3018
+ * 0–1. A run passes when its pass rate over non-errored items reaches this. Omit for a run that reports scores without a verdict.
3019
+ */
3020
+ pass_threshold?: number | null;
3021
+ };
3022
+ /**
3023
+ * Stores a text document in a project, optionally indexing it for knowledge retrieval.
3024
+ */
3025
+ type DocumentResourceProperties = {
3026
+ /**
3027
+ * Document text content
3028
+ */
3029
+ content: string;
3030
+ /**
3031
+ * Virtual path for organising the document
3032
+ */
3033
+ path?: string | null;
3034
+ /**
3035
+ * Original filename
3036
+ */
3037
+ filename?: string | null;
3038
+ /**
3039
+ * Document title
3040
+ */
3041
+ title?: string | null;
3042
+ /**
3043
+ * Arbitrary metadata key-value pairs
3044
+ */
3045
+ metadata?: {
3046
+ [key: string]: unknown;
3047
+ } | null;
3048
+ /**
3049
+ * Tag key-value pairs for filtering
3050
+ */
3051
+ tags?: {
3052
+ [key: string]: unknown;
3053
+ } | null;
3054
+ /**
3055
+ * How to split the content into embeddable chunks, matching `POST /documents`. `whole` (default) stores the content as a single chunk; `size` splits into fixed-size character windows with overlap. `page` is equivalent to `whole` for plain text.
3056
+ */
3057
+ chunk_strategy?: 'page' | 'whole' | 'size';
3058
+ /**
3059
+ * Window size in characters when `chunk_strategy=size`. Defaults to 1000.
3060
+ */
3061
+ chunk_size?: number;
3062
+ /**
3063
+ * Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
3064
+ */
3065
+ chunk_overlap?: number;
3066
+ };
3067
+ /**
3068
+ * Creates a named memory store that actors can read from and write to across conversations.
3069
+ */
3070
+ type MemoryResourceProperties = {
3071
+ /**
3072
+ * Memory display name
3073
+ */
3074
+ name: string;
3075
+ /**
3076
+ * What this memory stores
3077
+ */
3078
+ description?: string | null;
3079
+ /**
3080
+ * Tag strings for filtering
3081
+ */
3082
+ tags?: Array<string> | null;
3083
+ };
3084
+ /**
3085
+ * Adds a single text entry to a memory store.
3086
+ */
3087
+ type MemoryEntryResourceProperties = {
3088
+ /**
3089
+ * Public ID of the parent memory (or ref expression)
3090
+ */
3091
+ memory_id: string;
3092
+ /**
3093
+ * Text content of the memory entry
3094
+ */
3095
+ content: string;
3096
+ /**
3097
+ * How this entry was created (defaults to manual)
3098
+ */
3099
+ source_type?: 'manual' | 'agent' | 'extraction' | 'orchestration';
3100
+ /**
3101
+ * Per-entry tag strings for entry-granularity filtering
3102
+ */
3103
+ tags?: Array<string> | null;
3104
+ /**
3105
+ * Arbitrary structured metadata attached to the entry
3106
+ */
3107
+ metadata?: {
3108
+ [key: string]: unknown;
3109
+ } | null;
3110
+ };
3111
+ /**
3112
+ * Declares a model route within the formation's project: a named, ordered list of provider+model failover targets with retry and circuit-breaker configuration. Consumers reference it through their own `model_route_id`, or inherit it as the project's `default_model_route_id`.
3113
+ */
3114
+ type ModelRouteResourceProperties = {
3115
+ /**
3116
+ * Route name, unique within the project
3117
+ */
3118
+ name: string;
3119
+ /**
3120
+ * Ordered failover targets, tried in array order. Each entry is `{ ai_provider_id, model, timeout_seconds?, max_retries? }`; every provider must belong to this project, and the total attempt budget (sum of `1 + max_retries`) is capped at 10.
3121
+ */
3122
+ targets: Array<{
3123
+ [key: string]: unknown;
3124
+ }>;
3125
+ /**
3126
+ * Which failure classes fail over: any of `provider_error`, `timeout`, `rate_limited`. Defaults to all three. Deterministic rejections (400-class, auth, content policy) never fail over.
3127
+ */
3128
+ retry_on?: Array<string>;
3129
+ /**
3130
+ * Consecutive retryable failures before a target is skipped (default 3)
3131
+ */
3132
+ failure_threshold?: number | null;
3133
+ /**
3134
+ * How long a tripped target is skipped before being probed again (default 60)
3135
+ */
3136
+ cooldown_seconds?: number | null;
3137
+ };
3138
+ /**
3139
+ * Binds a starter (manual, webhook, schedule, or event) to an executable target (orchestration, agent, tool, or eval). Firings run under the project owner's confined run-as identity.
3140
+ */
3141
+ type TriggerResourceProperties = {
3142
+ /**
3143
+ * Trigger display name (unique within the project)
3144
+ */
3145
+ name: string;
3146
+ /**
3147
+ * Optional description
3148
+ */
3149
+ description?: string | null;
3150
+ /**
3151
+ * Starter type. Immutable after creation
3152
+ */
3153
+ type: 'manual' | 'webhook' | 'schedule' | 'event';
3154
+ /**
3155
+ * The kind of resource this trigger activates
3156
+ */
3157
+ target_type: 'orchestration' | 'agent' | 'tool' | 'eval';
3158
+ /**
3159
+ * Public ID of the target resource. Use { "ref": "LogicalId" } to reference an orchestration, agent, tool, or eval defined in the template.
3160
+ */
3161
+ target_id: string;
3162
+ /**
3163
+ * Tool targets only — the action for mcp tools
3164
+ */
3165
+ action?: string | null;
3166
+ /**
3167
+ * Static input shallow-merged under each firing's runtime input
3168
+ */
3169
+ input?: {
3170
+ [key: string]: unknown;
3171
+ } | null;
3172
+ /**
3173
+ * 5-field cron expression (UTC). Required when type is schedule
3174
+ */
3175
+ cron?: string | null;
3176
+ /**
3177
+ * Internal-event subscription pattern (`*`, `prefix.*`, or an exact event name). Required when type is event, rejected otherwise
3178
+ */
3179
+ event_pattern?: string | null;
3180
+ /**
3181
+ * Whether the trigger fires (default true)
3182
+ */
3183
+ active?: boolean;
3184
+ /**
3185
+ * Optional boundary policy that further confines the run-as identity
3186
+ */
3187
+ policy_id?: string | null;
3188
+ };
3189
+ /**
3190
+ * Creates a conversation within the formation's project.
3191
+ */
3192
+ type ConversationResourceProperties = {
3193
+ /**
3194
+ * Human-readable label for the conversation
3195
+ */
3196
+ name?: string | null;
3197
+ /**
3198
+ * Initial status of the conversation (open or closed)
3199
+ */
3200
+ status?: string;
3201
+ /**
3202
+ * Public ID of an actor to associate with this conversation
3203
+ */
3204
+ actor_id?: string | null;
3205
+ };
3206
+ /**
3207
+ * Registers a file record within the formation's project.
3208
+ */
3209
+ type FileResourceProperties = {
3210
+ /**
3211
+ * Directory within the project. Optional; defaults to / (root). Combined with filename to form the file's key (path).
3212
+ */
3213
+ prefix?: string | null;
3214
+ /**
3215
+ * Original / download name and the key's leaf segment.
3216
+ */
3217
+ filename?: string | null;
3218
+ /**
3219
+ * MIME type of the file
3220
+ */
3221
+ content_type?: string | null;
3222
+ /**
3223
+ * File size in bytes
3224
+ */
3225
+ size?: number | null;
3226
+ /**
3227
+ * JSON string with additional metadata
3228
+ */
3229
+ metadata?: string | null;
3230
+ };
3231
+ /**
3232
+ * Creates an encrypted secret within the formation's project.
3233
+ */
3234
+ type SecretResourceProperties = {
3235
+ /**
3236
+ * Human-readable label for the secret
3237
+ */
3238
+ name: string;
3239
+ /**
3240
+ * The secret value to encrypt and store
3241
+ */
3242
+ value: string;
3243
+ };
3244
+ /**
3245
+ * Creates a session attached to an agent within the formation's project.
3246
+ */
3247
+ type SessionResourceProperties = {
3248
+ /**
3249
+ * Public ID of the agent that owns this session
3250
+ */
3251
+ agent_id: string;
3252
+ /**
3253
+ * Human-readable label for the session
3254
+ */
3255
+ name?: string | null;
3256
+ /**
3257
+ * Public ID of an actor to associate with this session
3258
+ */
3259
+ actor_id?: string | null;
3260
+ /**
3261
+ * Whether to automatically generate a response when messages are sent
3262
+ */
3263
+ auto_generate?: boolean;
3264
+ /**
3265
+ * Number of seconds of inactivity after which the session expires. 0 means never expires.
3266
+ */
3267
+ inactivity_ttl_seconds?: number;
3268
+ /**
3269
+ * Optional context object passed to tool calls
3270
+ */
3271
+ tool_context?: {
3272
+ [key: string]: unknown;
3273
+ } | null;
3274
+ };
3275
+ /**
3276
+ * Routes a file content_type to a converter (tool or agent) so ingestion can turn non-native files (images, audio, scanned PDFs) into Documents. See the Ingestion Rules module docs for the matching and converter-invocation model.
3277
+ */
3278
+ type IngestionRuleResourceProperties = {
3279
+ /**
3280
+ * MIME type glob matched against a file's content_type (e.g. image*, audio/mpeg, application/pdf)
3281
+ */
3282
+ content_type_glob: string;
3283
+ /**
3284
+ * Converter tool ID (mutually exclusive with agent_id)
3285
+ */
3286
+ tool_id?: string | null;
3287
+ /**
3288
+ * Converter agent ID (mutually exclusive with tool_id)
3289
+ */
3290
+ agent_id?: string | null;
3291
+ /**
3292
+ * Operation id, required for mcp tool converters
3293
+ */
3294
+ action?: string | null;
3295
+ /**
3296
+ * Merged into the tool input before invocation (tool converters only)
3297
+ */
3298
+ preset_parameters?: {
3299
+ [key: string]: unknown;
3300
+ } | null;
3301
+ /**
3302
+ * For native types (PDF/text): `first` (default) converts only when native extraction yields no text; `skip` always converts.
3303
+ */
3304
+ native_extraction?: string | null;
3305
+ /**
3306
+ * How the file reaches a tool converter — base64 (default) or download_url
3307
+ */
3308
+ file_delivery?: string | null;
3309
+ /**
3310
+ * Default chunk strategy (page/whole/size), overridable per ingest request
3311
+ */
3312
+ chunk_strategy?: string | null;
3313
+ /**
3314
+ * Default window size in characters for the size strategy
3315
+ */
3316
+ chunk_size?: number | null;
3317
+ /**
3318
+ * Default overlap in characters for the size strategy
3319
+ */
3320
+ chunk_overlap?: number | null;
3321
+ /**
3322
+ * Arbitrary JSON metadata
3323
+ */
3324
+ metadata?: {
3325
+ [key: string]: unknown;
3326
+ } | null;
3327
+ };
3328
+ /**
3329
+ * Creates a DAG orchestration that wires agents, tools, and knowledge lookups into a repeatable pipeline within the formation's project. Node resource references (`agent_id`, `tool_id`, `memory_id`, `orchestration_id`) accept `{ "ref": "LogicalId" }` expressions to point at other resources declared in the same template — the basis for deploying an agent "squad" (a team of agents plus the flow that coordinates them) as a single stack.
3330
+ */
3331
+ type OrchestrationResourceProperties = {
3332
+ /**
3333
+ * Human-readable name for the orchestration
3334
+ */
3335
+ name: string;
3336
+ /**
3337
+ * Optional description of what the orchestration does
3338
+ */
3339
+ description?: string | null;
3340
+ /**
3341
+ * Ordered list of node definitions. A node's resource references (`agent_id`, `tool_id`, `memory_id`, `orchestration_id`) may use `{ "ref": "LogicalId" }` to bind to other resources in the template.
3342
+ */
3343
+ nodes: Array<{
3344
+ [key: string]: unknown;
3345
+ }>;
3346
+ /**
3347
+ * Directed connections between nodes
3348
+ */
3349
+ edges: Array<{
3350
+ [key: string]: unknown;
3351
+ }>;
3352
+ /**
3353
+ * Optional JSON Schema describing the run state
3354
+ */
3355
+ state_schema?: {
3356
+ [key: string]: unknown;
3357
+ } | null;
3358
+ /**
3359
+ * Optional JSON Schema describing the run input
3360
+ */
3361
+ input_schema?: {
3362
+ [key: string]: unknown;
3363
+ } | null;
3364
+ };
3365
+ /**
3366
+ * Creates a workflow — a state-machine definition (named states, allowed transitions, guards, and per-state automation) that tasks live in. State and transition dispatch references (`agent_id`, `orchestration_id`, `tool_id` inside an `on_enter` block) accept `{ "ref": "LogicalId" }` expressions to point at agents, orchestrations or tools declared in the same template, so a workflow plus the agents and tools that service its states can deploy as one stack. Mirrors the workflows REST contract (`states`, `transitions`, `payload_schema`).
3367
+ */
3368
+ type WorkflowResourceProperties = {
3369
+ /**
3370
+ * Human-readable name for the workflow, unique within the project
3371
+ */
3372
+ name: string;
3373
+ /**
3374
+ * Optional description of what the workflow models
3375
+ */
3376
+ description?: string | null;
3377
+ /**
3378
+ * Named states. Exactly one must be `initial: true`; any number may be `terminal: true`. A `kind: human` state parks the task until a transition fires; an `on_enter` block dispatches one agent generation or orchestration run on entry.
3379
+ */
3380
+ states: Array<{
3381
+ [key: string]: unknown;
3382
+ }>;
3383
+ /**
3384
+ * Named, directional moves between states. Each has `from` (source states) and `to` (one target), an optional JSON Logic `guard`, and an optional `requires_approval` gate.
3385
+ */
3386
+ transitions: Array<{
3387
+ [key: string]: unknown;
3388
+ }>;
3389
+ /**
3390
+ * Optional JSON Schema describing a task's payload
3391
+ */
3392
+ payload_schema?: {
3393
+ [key: string]: unknown;
3394
+ } | null;
3395
+ };
3396
+ /**
3397
+ * Creates a quota — a project-scoped cap that blocks (`enforce`) or reports (`monitor`) when a windowed aggregate is exceeded. `requests` quotas are enforced by the request middleware; `tokens`/`cost_usd` quotas at the pre-generation check. Mirrors the quotas REST contract; `scope`, `metric`, and `window` are immutable after creation (only `limit` and `mode` update).
3398
+ */
3399
+ type QuotaResourceProperties = {
3400
+ /**
3401
+ * The scope the quota applies to
3402
+ */
3403
+ scope: 'project' | 'api_key' | 'agent' | 'actor';
3404
+ /**
3405
+ * Public id of the api key / agent / actor the quota applies to. For `api_key` and `agent` scope, NULL means all entities of that scope type in the project. For `actor` scope, NULL means one budget *per* actor rather than a pooled total across all actors.
3406
+ */
3407
+ scope_ref?: string | null;
3408
+ /**
3409
+ * The metric being capped
3410
+ */
3411
+ metric: 'requests' | 'tokens' | 'cost_usd';
3412
+ /**
3413
+ * The window over which the metric is aggregated
3414
+ */
3415
+ window: 'rolling_1m' | 'rolling_1h' | 'rolling_24h' | 'calendar_month';
3416
+ /**
3417
+ * The cap. Positive integer for requests/tokens; fractional allowed for cost_usd.
3418
+ */
3419
+ limit: number;
3420
+ /**
3421
+ * enforce blocks with 429; monitor fires the webhook only
3422
+ */
3423
+ mode?: 'enforce' | 'monitor';
3424
+ };
3425
+ /**
3426
+ * Creates a guardrail — an action-class document (`class`/`guard`) that gates tool-call autonomy. Attach it to a tool or agent via that resource's `guardrail_ids` (a `{ "ref": … }` to this resource in the same template resolves to its physical id at deploy time). Mirrors the guardrails REST contract; `class`/`default_class`/`guard`/`escalate` are flattened here from the REST API's single `document` object.
3427
+ */
3428
+ type GuardrailResourceProperties = {
3429
+ /**
3430
+ * Human-readable name
3431
+ */
3432
+ name: string;
3433
+ /**
3434
+ * Optional description
3435
+ */
3436
+ description?: string | null;
3437
+ /**
3438
+ * A class literal (`A` / `B` / `C` / `D`) or a JSON Logic expression returning one. An invalid result resolves to `default_class`.
3439
+ */
3440
+ class: 'A' | 'B' | 'C' | 'D' | {
3441
+ [key: string]: unknown;
3442
+ };
3443
+ /**
3444
+ * Applied when the `class` expression returns anything other than a valid class. Defaults to `C` (fail-closed).
3445
+ */
3446
+ default_class?: 'A' | 'B' | 'C' | 'D';
3447
+ /**
3448
+ * A single JSON Logic expression; when the call classifies as `B` it executes only if this evaluates truthy.
3449
+ */
3450
+ guard?: {
3451
+ [key: string]: unknown;
3452
+ } | null;
3453
+ /**
3454
+ * When true, a passing guard still files an approval item.
3455
+ */
3456
+ escalate?: boolean | null;
3457
+ /**
3458
+ * Optional tool the platform calls at evaluation time to fetch fresh guardrail context.
3459
+ */
3460
+ context_tool_id?: string | null;
3461
+ /**
3462
+ * How tool-fetched context combines with the caller-supplied context.
3463
+ */
3464
+ context_mode?: 'merge' | 'replace' | null;
3465
+ };
3466
+ type ResourceDeclaration = {
3467
+ /**
3468
+ * Resource type. The types this API accepts are `ai_provider`, `tool`, `agent`, `actor`, `conversation`, `dataset`, `dataset_item`, `document`, `file`, `guardrail`, `ingestion_rule`, `memory`, `memory_entry`, `model_route`, `eval`, `orchestration`, `quota`, `secret`, `session`, `trigger` and `workflow` — plus `channel`, which naturali registers itself and handles through its own lifecycle, taking the same property names the channels API takes (its credential properties are write-only, so a tenant credential never lands in the resource ledger). A template naming any other type is refused with `400 unsupported_resource_type` before it reaches the runtime — including the runtime's own `api_key`, `chat`, `policy`, `project_price` and `webhook` types, which this API does not expose.
3469
+ *
3470
+ * This is deliberately not an enum: a deployment operator can register additional resource types backed by their own handler, and those are declared here exactly like a built-in one. The set a given deployment accepts is authoritative in the server, which rejects an unregistered type with `VALIDATION_FAILED` and lists what it does support.
3471
+ *
3472
+ */
3473
+ type: string;
3474
+ /**
3475
+ * Resource properties, as authored in the template and echoed back verbatim. The allowed fields, required fields, and field types for each resource `type` are defined by the corresponding `<Type>ResourceProperties` schema in this document (e.g. `model_route` → `ModelRouteResourceProperties`), which the server enforces at validate/deploy time. The declaration itself is free-form here because property values may be substitution expressions rather than final values: `{ "ref": "logicalId" }` references another resource's physical ID, `{ "param": "ParamName" }` substitutes a parameter value, and `{ "sub": "text ${ParamName}" }` interpolates parameters into a string.
3476
+ *
3477
+ */
3478
+ properties: {
3479
+ [key: string]: unknown;
3480
+ };
3481
+ /**
3482
+ * Explicit dependency list. In addition to implicit `ref` dependencies.
3483
+ */
3484
+ depends_on?: Array<string> | null;
3485
+ /**
3486
+ * Controls what happens to the physical resource when it is removed from the stack. `delete` (default) deletes the physical resource. `retain` keeps the physical resource alive and only removes the formation record. Omit it to get `delete`; an explicit `null` is rejected.
3487
+ *
3488
+ */
3489
+ deletion_policy?: 'delete' | 'retain';
3490
+ metadata?: {
3491
+ [key: string]: unknown;
3492
+ } | null;
3493
+ };
3494
+ type FormationResource = {
3495
+ /**
3496
+ * Public ID of the resource record
3497
+ */
3498
+ id?: string;
3499
+ /**
3500
+ * Logical identifier from the template
3501
+ */
3502
+ logical_id?: string;
3503
+ /**
3504
+ * Resource type (e.g. agent, memory)
3505
+ */
3506
+ resource_type?: string;
3507
+ /**
3508
+ * Public ID of the physical the runtime resource
3509
+ */
3510
+ physical_resource_id?: string | null;
3511
+ /**
3512
+ * Current resource status
3513
+ */
3514
+ status?: 'pending' | 'created' | 'updated' | 'deleted' | 'failed';
3515
+ };
3516
+ type Formation = {
3517
+ /**
3518
+ * Public ID of the formation
3519
+ */
3520
+ id?: string;
3521
+ /**
3522
+ * Project public ID
3523
+ */
3524
+ project_id?: string;
3525
+ /**
3526
+ * Human-readable formation name
3527
+ */
3528
+ name?: string;
3529
+ template?: FormationTemplate;
3530
+ /**
3531
+ * Resolved output values after stack deployment
3532
+ */
3533
+ outputs?: {
3534
+ [key: string]: string;
3535
+ } | null;
3536
+ /**
3537
+ * Formation status
3538
+ */
3539
+ status?: 'creating' | 'active' | 'updating' | 'failed' | 'deleting' | 'deleted' | 'delete_failed';
3540
+ /**
3541
+ * Static annotations stored on the formation record (supplied at create/update). Not a substitution site — `sub`/`param`/`ref` expressions are rejected. Use the template's top-level `metadata` block for deploy-time substitution (see `resolved_metadata`).
3542
+ *
3543
+ */
3544
+ metadata?: {
3545
+ [key: string]: unknown;
3546
+ } | null;
3547
+ /**
3548
+ * The template's top-level `metadata` block after parameter (`sub`/`param`) and resource (`ref`) substitution at the last deploy. Null when the template declares no metadata.
3549
+ *
3550
+ */
3551
+ resolved_metadata?: {
3552
+ [key: string]: unknown;
3553
+ } | null;
3554
+ /**
3555
+ * Parameter values applied at the last deploy, for auditability. `no_echo` parameters are masked (`***`). Null when the template declares no parameters.
3556
+ *
3557
+ */
3558
+ resolved_parameters?: {
3559
+ [key: string]: string;
3560
+ } | null;
3561
+ /**
3562
+ * Why the formation is `failed` or `delete_failed`, in the same `{ code, message, meta }` shape as an error response. Null in every other status, and cleared by the next successful deploy. This is the reason a `2xx` deploy response can report `status: "failed"` without a second call to `list-formation-events`.
3563
+ *
3564
+ */
3565
+ error?: FormationError | null;
3566
+ /**
3567
+ * Resources managed by this formation (present on get/create/update)
3568
+ */
3569
+ resources?: Array<FormationResource>;
3570
+ created_at?: Date;
3571
+ updated_at?: Date;
3572
+ };
3573
+ type ValidationError = {
3574
+ /**
3575
+ * JSON path to the field with the error
3576
+ */
3577
+ path?: string;
3578
+ /**
3579
+ * Error description
3580
+ */
3581
+ message?: string;
3582
+ };
3583
+ type ValidationResult = {
3584
+ valid?: boolean;
3585
+ errors?: Array<ValidationError>;
3586
+ warnings?: Array<ValidationError>;
3587
+ };
3588
+ type PlanChange = {
3589
+ logical_id?: string;
3590
+ resource_type?: string;
3591
+ action?: 'create' | 'update' | 'delete' | 'no-op';
3592
+ /**
3593
+ * The existing resource's physical ID. Present for update / no-op / delete actions, absent for create.
3594
+ */
3595
+ physical_resource_id?: string;
3596
+ /**
3597
+ * Resolved desired-state properties (post parameter/ref substitution) and, when available, the current live or last-applied properties they were compared against. Omitted when neither side could be computed (e.g. an unregistered resource type).
3598
+ */
3599
+ diff?: {
3600
+ desired?: {
3601
+ [key: string]: unknown;
3602
+ };
3603
+ current?: {
3604
+ [key: string]: unknown;
3605
+ } | null;
3606
+ };
3607
+ };
3608
+ type PlanResult = {
3609
+ changes?: Array<PlanChange>;
3610
+ };
3611
+ /**
3612
+ * Why a deploy or teardown failed, in the one error shape the API has. Carried on the formation itself and on the operation that failed.
3613
+ */
3614
+ type FormationError = {
3615
+ /**
3616
+ * The failing operation's error code (`VALIDATION_FAILED`, `RESOURCE_NOT_FOUND`, `FORMATION_DELETE_FAILED`, …), or `UNKNOWN` when the underlying failure carried no code.
3617
+ */
3618
+ code: string;
3619
+ /**
3620
+ * The failure, as reported by the resource that raised it.
3621
+ */
3622
+ message: string;
3623
+ /**
3624
+ * Context for the failure. A failed apply names the resource that broke it (`logical_id`, `resource_type`); a failed teardown lists every blocker under `failures`.
3625
+ */
3626
+ meta?: {
3627
+ [key: string]: unknown;
3628
+ };
3629
+ };
3630
+ type FormationEvent = {
3631
+ timestamp?: Date;
3632
+ logical_id?: string;
3633
+ resource_type?: string;
3634
+ /**
3635
+ * What the deploy did to the resource: `create`, `update`, `delete`, `no-op`, `rollback` (a resource created earlier in this deploy that was walked back after a later failure), or `rollback-skipped` (a `deletion_policy: retain` resource left standing by that unwind).
3636
+ */
3637
+ action?: string;
3638
+ status?: 'succeeded' | 'failed';
3639
+ physical_resource_id?: string | null;
3640
+ error?: string | null;
3641
+ };
3642
+ type FormationOperation = {
3643
+ /**
3644
+ * Public ID of the operation
3645
+ */
3646
+ id?: string;
3647
+ operation_type?: 'validate' | 'plan' | 'create' | 'update' | 'delete';
3648
+ status?: 'pending' | 'running' | 'succeeded' | 'failed';
3649
+ events?: Array<FormationEvent> | null;
3650
+ plan?: PlanResult | null;
3651
+ /**
3652
+ * Why this operation failed. Null for a succeeded or running operation. The same bag the formation itself carries while that failure is its current state.
3653
+ */
3654
+ error?: FormationError | null;
3655
+ created_at?: Date;
3656
+ updated_at?: Date;
3657
+ };
2565
3658
  type Generation = {
2566
3659
  /**
2567
3660
  * Public ID of the generation
@@ -3954,32 +5047,14 @@ type StartRunRequest = {
3954
5047
  wait?: boolean;
3955
5048
  };
3956
5049
  type ValidateOrchestrationRequest = {
3957
- nodes?: Array<OrchestrationNode>;
3958
- edges?: Array<OrchestrationEdge>;
3959
- /**
3960
- * Optional JSON Schema for run inputs; its top-level properties seed state.
3961
- */
3962
- input_schema?: {
3963
- [key: string]: unknown;
3964
- } | null;
3965
- };
3966
- type ValidationError = {
3967
- /**
3968
- * Location of the issue (e.g. nodes[1].input_mapping.val).
3969
- */
3970
- path?: string;
3971
- /**
3972
- * Human-readable description of the issue.
3973
- */
3974
- message?: string;
3975
- };
3976
- type ValidationResult = {
5050
+ nodes?: Array<OrchestrationNode>;
5051
+ edges?: Array<OrchestrationEdge>;
3977
5052
  /**
3978
- * True when there are no blocking errors.
5053
+ * Optional JSON Schema for run inputs; its top-level properties seed state.
3979
5054
  */
3980
- valid: boolean;
3981
- errors: Array<ValidationError>;
3982
- warnings: Array<ValidationError>;
5055
+ input_schema?: {
5056
+ [key: string]: unknown;
5057
+ } | null;
3983
5058
  };
3984
5059
  type Project = {
3985
5060
  /**
@@ -9235,25 +10310,261 @@ type CreateDocumentResponses = {
9235
10310
  */
9236
10311
  201: DocumentRecord;
9237
10312
  };
9238
- type CreateDocumentResponse = CreateDocumentResponses[keyof CreateDocumentResponses];
9239
- type IngestDocumentData = {
9240
- body: {
9241
- /**
9242
- * ID of the uploaded file. Must be one of application/pdf, text/plain, text/markdown.
9243
- */
9244
- file_id: string;
9245
- /**
9246
- * Path prefix under which to store the document (e.g. /docs/). The filename is appended automatically.
9247
- */
9248
- path_prefix?: string;
9249
- /**
9250
- * Key-value tags to attach to the document.
9251
- */
9252
- tags?: {
9253
- [key: string]: string;
9254
- };
10313
+ type CreateDocumentResponse = CreateDocumentResponses[keyof CreateDocumentResponses];
10314
+ type IngestDocumentData = {
10315
+ body: {
10316
+ /**
10317
+ * ID of the uploaded file. Must be one of application/pdf, text/plain, text/markdown.
10318
+ */
10319
+ file_id: string;
10320
+ /**
10321
+ * Path prefix under which to store the document (e.g. /docs/). The filename is appended automatically.
10322
+ */
10323
+ path_prefix?: string;
10324
+ /**
10325
+ * Key-value tags to attach to the document.
10326
+ */
10327
+ tags?: {
10328
+ [key: string]: string;
10329
+ };
10330
+ /**
10331
+ * How to split the source into chunks. `page` (default) creates one chunk per non-empty page (PDF); for non-paged sources it yields a single chunk. `whole` joins everything into one chunk. `size` splits into fixed-size character windows with overlap.
10332
+ */
10333
+ chunk_strategy?: 'page' | 'whole' | 'size';
10334
+ /**
10335
+ * Window size in characters when `chunk_strategy=size`. Defaults to 1000.
10336
+ */
10337
+ chunk_size?: number;
10338
+ /**
10339
+ * Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
10340
+ */
10341
+ chunk_overlap?: number;
10342
+ };
10343
+ path: {
10344
+ /**
10345
+ * Project public ID (proj_ prefix).
10346
+ */
10347
+ project_id: string;
10348
+ };
10349
+ query?: {
10350
+ /**
10351
+ * When omitted or `false` (default), processing runs in the background and `202 Accepted` is returned immediately with `status=pending`. Pass `true` to block until processing completes and receive `201 Created` with `status=ready`.
10352
+ */
10353
+ wait?: boolean;
10354
+ };
10355
+ url: '/v1/projects/{project_id}/documents/ingest';
10356
+ };
10357
+ type IngestDocumentErrors = {
10358
+ /**
10359
+ * Invalid request, file not found, or unsupported content type
10360
+ */
10361
+ 400: ErrorResponse;
10362
+ /**
10363
+ * Unauthorized
10364
+ */
10365
+ 401: ErrorResponse;
10366
+ /**
10367
+ * Forbidden
10368
+ */
10369
+ 403: ErrorResponse;
10370
+ /**
10371
+ * The file already backs a Document (a file can only be ingested once). Use `POST /documents/{document_id}/ingest` to re-process the existing document, or upload a new copy of the file to ingest it separately.
10372
+ */
10373
+ 409: ErrorResponse;
10374
+ /**
10375
+ * The file is too large to ingest synchronously (`?wait=true`). Retry in background mode and poll the document status.
10376
+ */
10377
+ 413: ErrorResponse;
10378
+ };
10379
+ type IngestDocumentError = IngestDocumentErrors[keyof IngestDocumentErrors];
10380
+ type IngestDocumentResponses = {
10381
+ /**
10382
+ * Ingestion completed synchronously (only when `?wait=true`). The document is fully indexed and ready for search.
10383
+ */
10384
+ 201: IngestedDocumentRecord;
10385
+ /**
10386
+ * Ingestion accepted. The document record has been created with `status=pending` and processing runs in the background. Poll `GET /v1/projects/{project_id}/documents/{document_id}` until `status` is `ready` or `failed`.
10387
+ */
10388
+ 202: IngestedDocumentRecord;
10389
+ };
10390
+ type IngestDocumentResponse = IngestDocumentResponses[keyof IngestDocumentResponses];
10391
+ type DeleteDocumentData = {
10392
+ body?: never;
10393
+ path: {
10394
+ /**
10395
+ * Project public ID (proj_ prefix).
10396
+ */
10397
+ project_id: string;
10398
+ /**
10399
+ * Document ID
10400
+ */
10401
+ document_id: string;
10402
+ };
10403
+ query?: never;
10404
+ url: '/v1/projects/{project_id}/documents/{document_id}';
10405
+ };
10406
+ type DeleteDocumentErrors = {
10407
+ /**
10408
+ * Unauthorized
10409
+ */
10410
+ 401: ErrorResponse;
10411
+ /**
10412
+ * Forbidden
10413
+ */
10414
+ 403: ErrorResponse;
10415
+ /**
10416
+ * Document not found
10417
+ */
10418
+ 404: ErrorResponse;
10419
+ };
10420
+ type DeleteDocumentError = DeleteDocumentErrors[keyof DeleteDocumentErrors];
10421
+ type DeleteDocumentResponses = {
10422
+ /**
10423
+ * Document deleted
10424
+ */
10425
+ 204: void;
10426
+ };
10427
+ type DeleteDocumentResponse = DeleteDocumentResponses[keyof DeleteDocumentResponses];
10428
+ type GetDocumentData = {
10429
+ body?: never;
10430
+ path: {
10431
+ /**
10432
+ * Project public ID (proj_ prefix).
10433
+ */
10434
+ project_id: string;
10435
+ /**
10436
+ * Document ID
10437
+ */
10438
+ document_id: string;
10439
+ };
10440
+ query?: never;
10441
+ url: '/v1/projects/{project_id}/documents/{document_id}';
10442
+ };
10443
+ type GetDocumentErrors = {
10444
+ /**
10445
+ * Unauthorized
10446
+ */
10447
+ 401: ErrorResponse;
10448
+ /**
10449
+ * Forbidden
10450
+ */
10451
+ 403: ErrorResponse;
10452
+ /**
10453
+ * Document not found
10454
+ */
10455
+ 404: ErrorResponse;
10456
+ };
10457
+ type GetDocumentError = GetDocumentErrors[keyof GetDocumentErrors];
10458
+ type GetDocumentResponses = {
10459
+ /**
10460
+ * Document found
10461
+ */
10462
+ 200: DocumentRecord;
10463
+ };
10464
+ type GetDocumentResponse = GetDocumentResponses[keyof GetDocumentResponses];
10465
+ type UpdateDocumentData = {
10466
+ body: {
10467
+ /**
10468
+ * New text content
10469
+ */
10470
+ content?: string;
10471
+ /**
10472
+ * New title
10473
+ */
10474
+ title?: string;
10475
+ /**
10476
+ * Logical path within the project (e.g. /reports/q1.txt). Pass null to clear.
10477
+ */
10478
+ path?: string | null;
10479
+ /**
10480
+ * Arbitrary metadata object. Unlike other body fields, keys are stored and returned verbatim in the casing supplied — they are not converted between snake_case and camelCase.
10481
+ */
10482
+ metadata?: {
10483
+ [key: string]: unknown;
10484
+ };
10485
+ /**
10486
+ * Key-value tags
10487
+ */
10488
+ tags?: {
10489
+ [key: string]: string;
10490
+ };
10491
+ };
10492
+ path: {
10493
+ /**
10494
+ * Project public ID (proj_ prefix).
10495
+ */
10496
+ project_id: string;
10497
+ /**
10498
+ * Document ID
10499
+ */
10500
+ document_id: string;
10501
+ };
10502
+ query?: never;
10503
+ url: '/v1/projects/{project_id}/documents/{document_id}';
10504
+ };
10505
+ type UpdateDocumentErrors = {
10506
+ /**
10507
+ * Unauthorized
10508
+ */
10509
+ 401: ErrorResponse;
10510
+ /**
10511
+ * Forbidden
10512
+ */
10513
+ 403: ErrorResponse;
10514
+ /**
10515
+ * Document not found
10516
+ */
10517
+ 404: ErrorResponse;
10518
+ };
10519
+ type UpdateDocumentError = UpdateDocumentErrors[keyof UpdateDocumentErrors];
10520
+ type UpdateDocumentResponses = {
10521
+ /**
10522
+ * Document updated
10523
+ */
10524
+ 200: DocumentRecord;
10525
+ };
10526
+ type UpdateDocumentResponse = UpdateDocumentResponses[keyof UpdateDocumentResponses];
10527
+ type GetDocumentStatusData = {
10528
+ body?: never;
10529
+ path: {
10530
+ /**
10531
+ * Project public ID (proj_ prefix).
10532
+ */
10533
+ project_id: string;
10534
+ /**
10535
+ * Document ID
10536
+ */
10537
+ document_id: string;
10538
+ };
10539
+ query?: never;
10540
+ url: '/v1/projects/{project_id}/documents/{document_id}/status';
10541
+ };
10542
+ type GetDocumentStatusErrors = {
10543
+ /**
10544
+ * Unauthorized
10545
+ */
10546
+ 401: ErrorResponse;
10547
+ /**
10548
+ * Forbidden
10549
+ */
10550
+ 403: ErrorResponse;
10551
+ /**
10552
+ * Document not found
10553
+ */
10554
+ 404: ErrorResponse;
10555
+ };
10556
+ type GetDocumentStatusError = GetDocumentStatusErrors[keyof GetDocumentStatusErrors];
10557
+ type GetDocumentStatusResponses = {
10558
+ /**
10559
+ * Document ingestion status
10560
+ */
10561
+ 200: DocumentStatusRecord;
10562
+ };
10563
+ type GetDocumentStatusResponse = GetDocumentStatusResponses[keyof GetDocumentStatusResponses];
10564
+ type ReingestDocumentData = {
10565
+ body?: {
9255
10566
  /**
9256
- * How to split the source into chunks. `page` (default) creates one chunk per non-empty page (PDF); for non-paged sources it yields a single chunk. `whole` joins everything into one chunk. `size` splits into fixed-size character windows with overlap.
10567
+ * How to split the source into chunks. Defaults to `page`.
9257
10568
  */
9258
10569
  chunk_strategy?: 'page' | 'whole' | 'size';
9259
10570
  /**
@@ -9270,6 +10581,10 @@ type IngestDocumentData = {
9270
10581
  * Project public ID (proj_ prefix).
9271
10582
  */
9272
10583
  project_id: string;
10584
+ /**
10585
+ * Document ID
10586
+ */
10587
+ document_id: string;
9273
10588
  };
9274
10589
  query?: {
9275
10590
  /**
@@ -9277,13 +10592,9 @@ type IngestDocumentData = {
9277
10592
  */
9278
10593
  wait?: boolean;
9279
10594
  };
9280
- url: '/v1/projects/{project_id}/documents/ingest';
10595
+ url: '/v1/projects/{project_id}/documents/{document_id}/ingest';
9281
10596
  };
9282
- type IngestDocumentErrors = {
9283
- /**
9284
- * Invalid request, file not found, or unsupported content type
9285
- */
9286
- 400: ErrorResponse;
10597
+ type ReingestDocumentErrors = {
9287
10598
  /**
9288
10599
  * Unauthorized
9289
10600
  */
@@ -9293,27 +10604,27 @@ type IngestDocumentErrors = {
9293
10604
  */
9294
10605
  403: ErrorResponse;
9295
10606
  /**
9296
- * The file already backs a Document (a file can only be ingested once). Use `POST /documents/{document_id}/ingest` to re-process the existing document, or upload a new copy of the file to ingest it separately.
10607
+ * Document not found
9297
10608
  */
9298
- 409: ErrorResponse;
10609
+ 404: ErrorResponse;
9299
10610
  /**
9300
- * The file is too large to ingest synchronously (`?wait=true`). Retry in background mode and poll the document status.
10611
+ * The file is too large to re-ingest synchronously (`?wait=true`). Retry in background mode.
9301
10612
  */
9302
10613
  413: ErrorResponse;
9303
10614
  };
9304
- type IngestDocumentError = IngestDocumentErrors[keyof IngestDocumentErrors];
9305
- type IngestDocumentResponses = {
10615
+ type ReingestDocumentError = ReingestDocumentErrors[keyof ReingestDocumentErrors];
10616
+ type ReingestDocumentResponses = {
9306
10617
  /**
9307
- * Ingestion completed synchronously (only when `?wait=true`). The document is fully indexed and ready for search.
10618
+ * Re-ingestion completed synchronously (only when `?wait=true`).
9308
10619
  */
9309
10620
  201: IngestedDocumentRecord;
9310
10621
  /**
9311
- * Ingestion accepted. The document record has been created with `status=pending` and processing runs in the background. Poll `GET /v1/projects/{project_id}/documents/{document_id}` until `status` is `ready` or `failed`.
10622
+ * Re-ingestion accepted. The document was reset to `status=pending` and processing runs in the background. Poll `GET /v1/projects/{project_id}/documents/{document_id}/status`.
9312
10623
  */
9313
10624
  202: IngestedDocumentRecord;
9314
10625
  };
9315
- type IngestDocumentResponse = IngestDocumentResponses[keyof IngestDocumentResponses];
9316
- type DeleteDocumentData = {
10626
+ type ReingestDocumentResponse = ReingestDocumentResponses[keyof ReingestDocumentResponses];
10627
+ type GetDocumentTagsData = {
9317
10628
  body?: never;
9318
10629
  path: {
9319
10630
  /**
@@ -9326,9 +10637,9 @@ type DeleteDocumentData = {
9326
10637
  document_id: string;
9327
10638
  };
9328
10639
  query?: never;
9329
- url: '/v1/projects/{project_id}/documents/{document_id}';
10640
+ url: '/v1/projects/{project_id}/documents/{document_id}/tags';
9330
10641
  };
9331
- type DeleteDocumentErrors = {
10642
+ type GetDocumentTagsErrors = {
9332
10643
  /**
9333
10644
  * Unauthorized
9334
10645
  */
@@ -9342,16 +10653,20 @@ type DeleteDocumentErrors = {
9342
10653
  */
9343
10654
  404: ErrorResponse;
9344
10655
  };
9345
- type DeleteDocumentError = DeleteDocumentErrors[keyof DeleteDocumentErrors];
9346
- type DeleteDocumentResponses = {
10656
+ type GetDocumentTagsError = GetDocumentTagsErrors[keyof GetDocumentTagsErrors];
10657
+ type GetDocumentTagsResponses = {
9347
10658
  /**
9348
- * Document deleted
10659
+ * Document tags
9349
10660
  */
9350
- 204: void;
10661
+ 200: {
10662
+ [key: string]: string;
10663
+ };
9351
10664
  };
9352
- type DeleteDocumentResponse = DeleteDocumentResponses[keyof DeleteDocumentResponses];
9353
- type GetDocumentData = {
9354
- body?: never;
10665
+ type GetDocumentTagsResponse = GetDocumentTagsResponses[keyof GetDocumentTagsResponses];
10666
+ type MergeDocumentTagsData = {
10667
+ body: {
10668
+ [key: string]: string;
10669
+ };
9355
10670
  path: {
9356
10671
  /**
9357
10672
  * Project public ID (proj_ prefix).
@@ -9363,9 +10678,9 @@ type GetDocumentData = {
9363
10678
  document_id: string;
9364
10679
  };
9365
10680
  query?: never;
9366
- url: '/v1/projects/{project_id}/documents/{document_id}';
10681
+ url: '/v1/projects/{project_id}/documents/{document_id}/tags';
9367
10682
  };
9368
- type GetDocumentErrors = {
10683
+ type MergeDocumentTagsErrors = {
9369
10684
  /**
9370
10685
  * Unauthorized
9371
10686
  */
@@ -9379,77 +10694,231 @@ type GetDocumentErrors = {
9379
10694
  */
9380
10695
  404: ErrorResponse;
9381
10696
  };
9382
- type GetDocumentError = GetDocumentErrors[keyof GetDocumentErrors];
9383
- type GetDocumentResponses = {
10697
+ type MergeDocumentTagsError = MergeDocumentTagsErrors[keyof MergeDocumentTagsErrors];
10698
+ type MergeDocumentTagsResponses = {
9384
10699
  /**
9385
- * Document found
10700
+ * Tags merged
9386
10701
  */
9387
- 200: DocumentRecord;
10702
+ 200: {
10703
+ [key: string]: string;
10704
+ };
9388
10705
  };
9389
- type GetDocumentResponse = GetDocumentResponses[keyof GetDocumentResponses];
9390
- type UpdateDocumentData = {
10706
+ type MergeDocumentTagsResponse = MergeDocumentTagsResponses[keyof MergeDocumentTagsResponses];
10707
+ type ReplaceDocumentTagsData = {
9391
10708
  body: {
10709
+ [key: string]: string;
10710
+ };
10711
+ path: {
9392
10712
  /**
9393
- * New text content
10713
+ * Project public ID (proj_ prefix).
9394
10714
  */
9395
- content?: string;
10715
+ project_id: string;
9396
10716
  /**
9397
- * New title
10717
+ * Document ID
9398
10718
  */
9399
- title?: string;
10719
+ document_id: string;
10720
+ };
10721
+ query?: never;
10722
+ url: '/v1/projects/{project_id}/documents/{document_id}/tags';
10723
+ };
10724
+ type ReplaceDocumentTagsErrors = {
10725
+ /**
10726
+ * Unauthorized
10727
+ */
10728
+ 401: ErrorResponse;
10729
+ /**
10730
+ * Forbidden
10731
+ */
10732
+ 403: ErrorResponse;
10733
+ /**
10734
+ * Document not found
10735
+ */
10736
+ 404: ErrorResponse;
10737
+ };
10738
+ type ReplaceDocumentTagsError = ReplaceDocumentTagsErrors[keyof ReplaceDocumentTagsErrors];
10739
+ type ReplaceDocumentTagsResponses = {
10740
+ /**
10741
+ * Tags replaced
10742
+ */
10743
+ 200: {
10744
+ [key: string]: string;
10745
+ };
10746
+ };
10747
+ type ReplaceDocumentTagsResponse = ReplaceDocumentTagsResponses[keyof ReplaceDocumentTagsResponses];
10748
+ type CreateEmbeddingsData = {
10749
+ body: {
9400
10750
  /**
9401
- * Logical path within the project (e.g. /reports/q1.txt). Pass null to clear.
10751
+ * Single text to embed.
9402
10752
  */
9403
- path?: string | null;
10753
+ input?: string;
9404
10754
  /**
9405
- * Arbitrary metadata object. Unlike other body fields, keys are stored and returned verbatim in the casing supplied — they are not converted between snake_case and camelCase.
10755
+ * Batch of texts to embed.
9406
10756
  */
9407
- metadata?: {
9408
- [key: string]: unknown;
9409
- };
10757
+ inputs?: Array<string>;
10758
+ };
10759
+ path: {
9410
10760
  /**
9411
- * Key-value tags
10761
+ * Project public ID (proj_ prefix).
9412
10762
  */
9413
- tags?: {
9414
- [key: string]: string;
9415
- };
10763
+ project_id: string;
10764
+ };
10765
+ query?: never;
10766
+ url: '/v1/projects/{project_id}/embeddings';
10767
+ };
10768
+ type CreateEmbeddingsErrors = {
10769
+ /**
10770
+ * Invalid request body
10771
+ */
10772
+ 400: ErrorResponse;
10773
+ /**
10774
+ * Unauthorized
10775
+ */
10776
+ 401: ErrorResponse;
10777
+ /**
10778
+ * Embedding service not configured
10779
+ */
10780
+ 503: ErrorResponse;
10781
+ };
10782
+ type CreateEmbeddingsError = CreateEmbeddingsErrors[keyof CreateEmbeddingsErrors];
10783
+ type CreateEmbeddingsResponses = {
10784
+ /**
10785
+ * Embeddings generated successfully
10786
+ */
10787
+ 200: EmbeddingsResponse;
10788
+ };
10789
+ type CreateEmbeddingsResponse = CreateEmbeddingsResponses[keyof CreateEmbeddingsResponses];
10790
+ type ListDatasetsData = {
10791
+ body?: never;
10792
+ path: {
10793
+ /**
10794
+ * Project public ID (proj_ prefix).
10795
+ */
10796
+ project_id: string;
10797
+ };
10798
+ query?: {
10799
+ /**
10800
+ * Maximum number of results to return
10801
+ */
10802
+ limit?: number;
10803
+ /**
10804
+ * Number of results to skip
10805
+ */
10806
+ offset?: number;
10807
+ };
10808
+ url: '/v1/projects/{project_id}/datasets';
10809
+ };
10810
+ type ListDatasetsErrors = {
10811
+ /**
10812
+ * Unauthorized
10813
+ */
10814
+ 401: unknown;
10815
+ /**
10816
+ * Forbidden
10817
+ */
10818
+ 403: unknown;
10819
+ /**
10820
+ * Internal server error
10821
+ */
10822
+ 500: unknown;
10823
+ };
10824
+ type ListDatasetsResponses = {
10825
+ /**
10826
+ * List of datasets
10827
+ */
10828
+ 200: {
10829
+ data: Array<Dataset>;
10830
+ total: number;
10831
+ limit: number;
10832
+ offset: number;
10833
+ };
10834
+ };
10835
+ type ListDatasetsResponse = ListDatasetsResponses[keyof ListDatasetsResponses];
10836
+ type CreateDatasetData = {
10837
+ body: {
10838
+ /**
10839
+ * Unique name within the project
10840
+ */
10841
+ name: string;
10842
+ /**
10843
+ * What this suite covers
10844
+ */
10845
+ description?: string | null;
10846
+ };
10847
+ path: {
10848
+ /**
10849
+ * Project public ID (proj_ prefix).
10850
+ */
10851
+ project_id: string;
9416
10852
  };
10853
+ query?: never;
10854
+ url: '/v1/projects/{project_id}/datasets';
10855
+ };
10856
+ type CreateDatasetErrors = {
10857
+ /**
10858
+ * Bad request (missing or invalid name)
10859
+ */
10860
+ 400: unknown;
10861
+ /**
10862
+ * Unauthorized
10863
+ */
10864
+ 401: unknown;
10865
+ /**
10866
+ * Forbidden
10867
+ */
10868
+ 403: unknown;
10869
+ /**
10870
+ * A dataset with that name already exists in the project
10871
+ */
10872
+ 409: unknown;
10873
+ /**
10874
+ * Internal server error
10875
+ */
10876
+ 500: unknown;
10877
+ };
10878
+ type CreateDatasetResponses = {
10879
+ /**
10880
+ * Dataset created successfully
10881
+ */
10882
+ 201: Dataset;
10883
+ };
10884
+ type CreateDatasetResponse = CreateDatasetResponses[keyof CreateDatasetResponses];
10885
+ type DeleteDatasetData = {
10886
+ body?: never;
9417
10887
  path: {
9418
10888
  /**
9419
10889
  * Project public ID (proj_ prefix).
9420
10890
  */
9421
10891
  project_id: string;
9422
10892
  /**
9423
- * Document ID
10893
+ * Dataset ID
9424
10894
  */
9425
- document_id: string;
10895
+ dataset_id: string;
9426
10896
  };
9427
10897
  query?: never;
9428
- url: '/v1/projects/{project_id}/documents/{document_id}';
10898
+ url: '/v1/projects/{project_id}/datasets/{dataset_id}';
9429
10899
  };
9430
- type UpdateDocumentErrors = {
10900
+ type DeleteDatasetErrors = {
9431
10901
  /**
9432
10902
  * Unauthorized
9433
10903
  */
9434
- 401: ErrorResponse;
10904
+ 401: unknown;
9435
10905
  /**
9436
10906
  * Forbidden
9437
10907
  */
9438
- 403: ErrorResponse;
10908
+ 403: unknown;
9439
10909
  /**
9440
- * Document not found
10910
+ * Dataset not found
9441
10911
  */
9442
- 404: ErrorResponse;
10912
+ 404: unknown;
9443
10913
  };
9444
- type UpdateDocumentError = UpdateDocumentErrors[keyof UpdateDocumentErrors];
9445
- type UpdateDocumentResponses = {
10914
+ type DeleteDatasetResponses = {
9446
10915
  /**
9447
- * Document updated
10916
+ * Dataset deleted successfully
9448
10917
  */
9449
- 200: DocumentRecord;
10918
+ 204: void;
9450
10919
  };
9451
- type UpdateDocumentResponse = UpdateDocumentResponses[keyof UpdateDocumentResponses];
9452
- type GetDocumentStatusData = {
10920
+ type DeleteDatasetResponse = DeleteDatasetResponses[keyof DeleteDatasetResponses];
10921
+ type GetDatasetData = {
9453
10922
  body?: never;
9454
10923
  path: {
9455
10924
  /**
@@ -9457,140 +10926,199 @@ type GetDocumentStatusData = {
9457
10926
  */
9458
10927
  project_id: string;
9459
10928
  /**
9460
- * Document ID
10929
+ * Dataset ID
9461
10930
  */
9462
- document_id: string;
10931
+ dataset_id: string;
9463
10932
  };
9464
10933
  query?: never;
9465
- url: '/v1/projects/{project_id}/documents/{document_id}/status';
10934
+ url: '/v1/projects/{project_id}/datasets/{dataset_id}';
9466
10935
  };
9467
- type GetDocumentStatusErrors = {
10936
+ type GetDatasetErrors = {
9468
10937
  /**
9469
10938
  * Unauthorized
9470
10939
  */
9471
- 401: ErrorResponse;
10940
+ 401: unknown;
9472
10941
  /**
9473
10942
  * Forbidden
9474
10943
  */
9475
- 403: ErrorResponse;
10944
+ 403: unknown;
9476
10945
  /**
9477
- * Document not found
10946
+ * Dataset not found
9478
10947
  */
9479
- 404: ErrorResponse;
10948
+ 404: unknown;
9480
10949
  };
9481
- type GetDocumentStatusError = GetDocumentStatusErrors[keyof GetDocumentStatusErrors];
9482
- type GetDocumentStatusResponses = {
10950
+ type GetDatasetResponses = {
9483
10951
  /**
9484
- * Document ingestion status
10952
+ * Dataset details
9485
10953
  */
9486
- 200: DocumentStatusRecord;
10954
+ 200: Dataset;
9487
10955
  };
9488
- type GetDocumentStatusResponse = GetDocumentStatusResponses[keyof GetDocumentStatusResponses];
9489
- type ReingestDocumentData = {
9490
- body?: {
9491
- /**
9492
- * How to split the source into chunks. Defaults to `page`.
9493
- */
9494
- chunk_strategy?: 'page' | 'whole' | 'size';
10956
+ type GetDatasetResponse = GetDatasetResponses[keyof GetDatasetResponses];
10957
+ type UpdateDatasetData = {
10958
+ body: {
10959
+ name?: string;
10960
+ description?: string | null;
10961
+ };
10962
+ path: {
9495
10963
  /**
9496
- * Window size in characters when `chunk_strategy=size`. Defaults to 1000.
10964
+ * Project public ID (proj_ prefix).
9497
10965
  */
9498
- chunk_size?: number;
10966
+ project_id: string;
9499
10967
  /**
9500
- * Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
10968
+ * Dataset ID
9501
10969
  */
9502
- chunk_overlap?: number;
10970
+ dataset_id: string;
9503
10971
  };
10972
+ query?: never;
10973
+ url: '/v1/projects/{project_id}/datasets/{dataset_id}';
10974
+ };
10975
+ type UpdateDatasetErrors = {
10976
+ /**
10977
+ * Bad request
10978
+ */
10979
+ 400: unknown;
10980
+ /**
10981
+ * Unauthorized
10982
+ */
10983
+ 401: unknown;
10984
+ /**
10985
+ * Forbidden
10986
+ */
10987
+ 403: unknown;
10988
+ /**
10989
+ * Dataset not found
10990
+ */
10991
+ 404: unknown;
10992
+ /**
10993
+ * A dataset with that name already exists in the project
10994
+ */
10995
+ 409: unknown;
10996
+ };
10997
+ type UpdateDatasetResponses = {
10998
+ /**
10999
+ * Dataset updated successfully
11000
+ */
11001
+ 200: Dataset;
11002
+ };
11003
+ type UpdateDatasetResponse = UpdateDatasetResponses[keyof UpdateDatasetResponses];
11004
+ type ListDatasetItemsData = {
11005
+ body?: never;
9504
11006
  path: {
9505
11007
  /**
9506
11008
  * Project public ID (proj_ prefix).
9507
11009
  */
9508
11010
  project_id: string;
9509
11011
  /**
9510
- * Document ID
11012
+ * Dataset ID
9511
11013
  */
9512
- document_id: string;
11014
+ dataset_id: string;
9513
11015
  };
9514
11016
  query?: {
9515
11017
  /**
9516
- * When omitted or `false` (default), processing runs in the background and `202 Accepted` is returned immediately with `status=pending`. Pass `true` to block until processing completes and receive `201 Created` with `status=ready`.
11018
+ * Maximum number of results to return
9517
11019
  */
9518
- wait?: boolean;
11020
+ limit?: number;
11021
+ /**
11022
+ * Number of results to skip
11023
+ */
11024
+ offset?: number;
9519
11025
  };
9520
- url: '/v1/projects/{project_id}/documents/{document_id}/ingest';
11026
+ url: '/v1/projects/{project_id}/datasets/{dataset_id}/items';
9521
11027
  };
9522
- type ReingestDocumentErrors = {
11028
+ type ListDatasetItemsErrors = {
9523
11029
  /**
9524
11030
  * Unauthorized
9525
11031
  */
9526
- 401: ErrorResponse;
11032
+ 401: unknown;
9527
11033
  /**
9528
11034
  * Forbidden
9529
11035
  */
9530
- 403: ErrorResponse;
9531
- /**
9532
- * Document not found
9533
- */
9534
- 404: ErrorResponse;
11036
+ 403: unknown;
9535
11037
  /**
9536
- * The file is too large to re-ingest synchronously (`?wait=true`). Retry in background mode.
11038
+ * Dataset not found
9537
11039
  */
9538
- 413: ErrorResponse;
11040
+ 404: unknown;
9539
11041
  };
9540
- type ReingestDocumentError = ReingestDocumentErrors[keyof ReingestDocumentErrors];
9541
- type ReingestDocumentResponses = {
9542
- /**
9543
- * Re-ingestion completed synchronously (only when `?wait=true`).
9544
- */
9545
- 201: IngestedDocumentRecord;
11042
+ type ListDatasetItemsResponses = {
9546
11043
  /**
9547
- * Re-ingestion accepted. The document was reset to `status=pending` and processing runs in the background. Poll `GET /v1/projects/{project_id}/documents/{document_id}/status`.
11044
+ * List of dataset items
9548
11045
  */
9549
- 202: IngestedDocumentRecord;
11046
+ 200: {
11047
+ data: Array<DatasetItem>;
11048
+ total: number;
11049
+ limit: number;
11050
+ offset: number;
11051
+ };
9550
11052
  };
9551
- type ReingestDocumentResponse = ReingestDocumentResponses[keyof ReingestDocumentResponses];
9552
- type GetDocumentTagsData = {
9553
- body?: never;
11053
+ type ListDatasetItemsResponse = ListDatasetItemsResponses[keyof ListDatasetItemsResponses];
11054
+ type CreateDatasetItemData = {
11055
+ body: {
11056
+ input: DatasetItemInput;
11057
+ /**
11058
+ * Reference answer for exact_match / embedding_similarity / llm_judge scorers
11059
+ */
11060
+ expected_output?: string | null;
11061
+ /**
11062
+ * Free-form tags, opaque to the platform
11063
+ */
11064
+ metadata?: {
11065
+ [key: string]: unknown;
11066
+ } | null;
11067
+ };
9554
11068
  path: {
9555
11069
  /**
9556
11070
  * Project public ID (proj_ prefix).
9557
11071
  */
9558
11072
  project_id: string;
9559
11073
  /**
9560
- * Document ID
11074
+ * Dataset ID
9561
11075
  */
9562
- document_id: string;
11076
+ dataset_id: string;
9563
11077
  };
9564
11078
  query?: never;
9565
- url: '/v1/projects/{project_id}/documents/{document_id}/tags';
11079
+ url: '/v1/projects/{project_id}/datasets/{dataset_id}/items';
9566
11080
  };
9567
- type GetDocumentTagsErrors = {
11081
+ type CreateDatasetItemErrors = {
11082
+ /**
11083
+ * Bad request (input is not message-shaped)
11084
+ */
11085
+ 400: unknown;
9568
11086
  /**
9569
11087
  * Unauthorized
9570
11088
  */
9571
- 401: ErrorResponse;
11089
+ 401: unknown;
9572
11090
  /**
9573
11091
  * Forbidden
9574
11092
  */
9575
- 403: ErrorResponse;
11093
+ 403: unknown;
9576
11094
  /**
9577
- * Document not found
11095
+ * Dataset not found
9578
11096
  */
9579
- 404: ErrorResponse;
11097
+ 404: unknown;
9580
11098
  };
9581
- type GetDocumentTagsError = GetDocumentTagsErrors[keyof GetDocumentTagsErrors];
9582
- type GetDocumentTagsResponses = {
11099
+ type CreateDatasetItemResponses = {
9583
11100
  /**
9584
- * Document tags
11101
+ * Dataset item created successfully
9585
11102
  */
9586
- 200: {
9587
- [key: string]: string;
9588
- };
11103
+ 201: DatasetItem;
9589
11104
  };
9590
- type GetDocumentTagsResponse = GetDocumentTagsResponses[keyof GetDocumentTagsResponses];
9591
- type MergeDocumentTagsData = {
11105
+ type CreateDatasetItemResponse = CreateDatasetItemResponses[keyof CreateDatasetItemResponses];
11106
+ type CreateDatasetItemFromGenerationData = {
9592
11107
  body: {
9593
- [key: string]: string;
11108
+ /**
11109
+ * The completed generation to promote. Must belong to the same project as the dataset.
11110
+ */
11111
+ generation_id: string;
11112
+ /**
11113
+ * Reference answer. Omit to use the generation's own answer; pass `null` to store the item with no reference answer.
11114
+ */
11115
+ expected_output?: string | null;
11116
+ /**
11117
+ * Free-form tags, opaque to the platform
11118
+ */
11119
+ metadata?: {
11120
+ [key: string]: unknown;
11121
+ } | null;
9594
11122
  };
9595
11123
  path: {
9596
11124
  /**
@@ -9598,121 +11126,133 @@ type MergeDocumentTagsData = {
9598
11126
  */
9599
11127
  project_id: string;
9600
11128
  /**
9601
- * Document ID
11129
+ * Dataset ID
9602
11130
  */
9603
- document_id: string;
11131
+ dataset_id: string;
9604
11132
  };
9605
11133
  query?: never;
9606
- url: '/v1/projects/{project_id}/documents/{document_id}/tags';
11134
+ url: '/v1/projects/{project_id}/datasets/{dataset_id}/items/from-generation';
9607
11135
  };
9608
- type MergeDocumentTagsErrors = {
11136
+ type CreateDatasetItemFromGenerationErrors = {
11137
+ /**
11138
+ * Bad request (generation_id missing, or the generation belongs to a different project than the dataset)
11139
+ */
11140
+ 400: unknown;
9609
11141
  /**
9610
11142
  * Unauthorized
9611
11143
  */
9612
- 401: ErrorResponse;
11144
+ 401: unknown;
9613
11145
  /**
9614
11146
  * Forbidden
9615
11147
  */
9616
- 403: ErrorResponse;
11148
+ 403: unknown;
9617
11149
  /**
9618
- * Document not found
11150
+ * Dataset or generation not found
9619
11151
  */
9620
- 404: ErrorResponse;
11152
+ 404: unknown;
11153
+ /**
11154
+ * The generation has not completed, or its content was never stored or has been purged
11155
+ */
11156
+ 409: unknown;
9621
11157
  };
9622
- type MergeDocumentTagsError = MergeDocumentTagsErrors[keyof MergeDocumentTagsErrors];
9623
- type MergeDocumentTagsResponses = {
11158
+ type CreateDatasetItemFromGenerationResponses = {
9624
11159
  /**
9625
- * Tags merged
11160
+ * Dataset item created from the generation
9626
11161
  */
9627
- 200: {
9628
- [key: string]: string;
9629
- };
11162
+ 201: DatasetItem;
9630
11163
  };
9631
- type MergeDocumentTagsResponse = MergeDocumentTagsResponses[keyof MergeDocumentTagsResponses];
9632
- type ReplaceDocumentTagsData = {
9633
- body: {
9634
- [key: string]: string;
9635
- };
11164
+ type CreateDatasetItemFromGenerationResponse = CreateDatasetItemFromGenerationResponses[keyof CreateDatasetItemFromGenerationResponses];
11165
+ type DeleteDatasetItemData = {
11166
+ body?: never;
9636
11167
  path: {
9637
11168
  /**
9638
11169
  * Project public ID (proj_ prefix).
9639
11170
  */
9640
11171
  project_id: string;
9641
11172
  /**
9642
- * Document ID
11173
+ * Dataset ID
9643
11174
  */
9644
- document_id: string;
11175
+ dataset_id: string;
11176
+ /**
11177
+ * Dataset item ID
11178
+ */
11179
+ item_id: string;
9645
11180
  };
9646
11181
  query?: never;
9647
- url: '/v1/projects/{project_id}/documents/{document_id}/tags';
11182
+ url: '/v1/projects/{project_id}/datasets/{dataset_id}/items/{item_id}';
9648
11183
  };
9649
- type ReplaceDocumentTagsErrors = {
11184
+ type DeleteDatasetItemErrors = {
9650
11185
  /**
9651
11186
  * Unauthorized
9652
11187
  */
9653
- 401: ErrorResponse;
11188
+ 401: unknown;
9654
11189
  /**
9655
11190
  * Forbidden
9656
11191
  */
9657
- 403: ErrorResponse;
11192
+ 403: unknown;
9658
11193
  /**
9659
- * Document not found
11194
+ * Dataset or item not found
9660
11195
  */
9661
- 404: ErrorResponse;
11196
+ 404: unknown;
9662
11197
  };
9663
- type ReplaceDocumentTagsError = ReplaceDocumentTagsErrors[keyof ReplaceDocumentTagsErrors];
9664
- type ReplaceDocumentTagsResponses = {
11198
+ type DeleteDatasetItemResponses = {
9665
11199
  /**
9666
- * Tags replaced
11200
+ * Dataset item deleted successfully
9667
11201
  */
9668
- 200: {
9669
- [key: string]: string;
9670
- };
11202
+ 204: void;
9671
11203
  };
9672
- type ReplaceDocumentTagsResponse = ReplaceDocumentTagsResponses[keyof ReplaceDocumentTagsResponses];
9673
- type CreateEmbeddingsData = {
11204
+ type DeleteDatasetItemResponse = DeleteDatasetItemResponses[keyof DeleteDatasetItemResponses];
11205
+ type UpdateDatasetItemData = {
9674
11206
  body: {
9675
- /**
9676
- * Single text to embed.
9677
- */
9678
- input?: string;
9679
- /**
9680
- * Batch of texts to embed.
9681
- */
9682
- inputs?: Array<string>;
11207
+ input?: DatasetItemInput;
11208
+ expected_output?: string | null;
11209
+ metadata?: {
11210
+ [key: string]: unknown;
11211
+ } | null;
9683
11212
  };
9684
11213
  path: {
9685
11214
  /**
9686
11215
  * Project public ID (proj_ prefix).
9687
11216
  */
9688
11217
  project_id: string;
11218
+ /**
11219
+ * Dataset ID
11220
+ */
11221
+ dataset_id: string;
11222
+ /**
11223
+ * Dataset item ID
11224
+ */
11225
+ item_id: string;
9689
11226
  };
9690
11227
  query?: never;
9691
- url: '/v1/projects/{project_id}/embeddings';
11228
+ url: '/v1/projects/{project_id}/datasets/{dataset_id}/items/{item_id}';
9692
11229
  };
9693
- type CreateEmbeddingsErrors = {
11230
+ type UpdateDatasetItemErrors = {
9694
11231
  /**
9695
- * Invalid request body
11232
+ * Bad request
9696
11233
  */
9697
- 400: ErrorResponse;
11234
+ 400: unknown;
9698
11235
  /**
9699
11236
  * Unauthorized
9700
11237
  */
9701
- 401: ErrorResponse;
11238
+ 401: unknown;
9702
11239
  /**
9703
- * Embedding service not configured
11240
+ * Forbidden
9704
11241
  */
9705
- 503: ErrorResponse;
11242
+ 403: unknown;
11243
+ /**
11244
+ * Dataset or item not found
11245
+ */
11246
+ 404: unknown;
9706
11247
  };
9707
- type CreateEmbeddingsError = CreateEmbeddingsErrors[keyof CreateEmbeddingsErrors];
9708
- type CreateEmbeddingsResponses = {
11248
+ type UpdateDatasetItemResponses = {
9709
11249
  /**
9710
- * Embeddings generated successfully
11250
+ * Dataset item updated successfully
9711
11251
  */
9712
- 200: EmbeddingsResponse;
11252
+ 200: DatasetItem;
9713
11253
  };
9714
- type CreateEmbeddingsResponse = CreateEmbeddingsResponses[keyof CreateEmbeddingsResponses];
9715
- type ListDatasetsData = {
11254
+ type UpdateDatasetItemResponse = UpdateDatasetItemResponses[keyof UpdateDatasetItemResponses];
11255
+ type ListEvalsData = {
9716
11256
  body?: never;
9717
11257
  path: {
9718
11258
  /**
@@ -9730,9 +11270,9 @@ type ListDatasetsData = {
9730
11270
  */
9731
11271
  offset?: number;
9732
11272
  };
9733
- url: '/v1/projects/{project_id}/datasets';
11273
+ url: '/v1/projects/{project_id}/evals';
9734
11274
  };
9735
- type ListDatasetsErrors = {
11275
+ type ListEvalsErrors = {
9736
11276
  /**
9737
11277
  * Unauthorized
9738
11278
  */
@@ -9746,28 +11286,37 @@ type ListDatasetsErrors = {
9746
11286
  */
9747
11287
  500: unknown;
9748
11288
  };
9749
- type ListDatasetsResponses = {
11289
+ type ListEvalsResponses = {
9750
11290
  /**
9751
- * List of datasets
11291
+ * List of evals
9752
11292
  */
9753
11293
  200: {
9754
- data: Array<Dataset>;
11294
+ data: Array<Eval>;
9755
11295
  total: number;
9756
11296
  limit: number;
9757
11297
  offset: number;
9758
11298
  };
9759
11299
  };
9760
- type ListDatasetsResponse = ListDatasetsResponses[keyof ListDatasetsResponses];
9761
- type CreateDatasetData = {
11300
+ type ListEvalsResponse = ListEvalsResponses[keyof ListEvalsResponses];
11301
+ type CreateEvalData = {
9762
11302
  body: {
9763
11303
  /**
9764
11304
  * Unique name within the project
9765
11305
  */
9766
11306
  name: string;
9767
11307
  /**
9768
- * What this suite covers
11308
+ * The agent under test
9769
11309
  */
9770
- description?: string | null;
11310
+ agent_id: string;
11311
+ /**
11312
+ * The dataset to run it against
11313
+ */
11314
+ dataset_id: string;
11315
+ scorers: Scorers;
11316
+ /**
11317
+ * 0–1. The run passes iff its pass rate — passed items over non-errored items — is at least this. Null reports scores without gating on them.
11318
+ */
11319
+ pass_threshold?: number | null;
9771
11320
  };
9772
11321
  path: {
9773
11322
  /**
@@ -9776,11 +11325,11 @@ type CreateDatasetData = {
9776
11325
  project_id: string;
9777
11326
  };
9778
11327
  query?: never;
9779
- url: '/v1/projects/{project_id}/datasets';
11328
+ url: '/v1/projects/{project_id}/evals';
9780
11329
  };
9781
- type CreateDatasetErrors = {
11330
+ type CreateEvalErrors = {
9782
11331
  /**
9783
- * Bad request (missing or invalid name)
11332
+ * Bad request (unknown scorer type, cross-project reference, invalid threshold)
9784
11333
  */
9785
11334
  400: unknown;
9786
11335
  /**
@@ -9792,7 +11341,7 @@ type CreateDatasetErrors = {
9792
11341
  */
9793
11342
  403: unknown;
9794
11343
  /**
9795
- * A dataset with that name already exists in the project
11344
+ * An eval with that name already exists in the project
9796
11345
  */
9797
11346
  409: unknown;
9798
11347
  /**
@@ -9800,14 +11349,14 @@ type CreateDatasetErrors = {
9800
11349
  */
9801
11350
  500: unknown;
9802
11351
  };
9803
- type CreateDatasetResponses = {
11352
+ type CreateEvalResponses = {
9804
11353
  /**
9805
- * Dataset created successfully
11354
+ * Eval created successfully
9806
11355
  */
9807
- 201: Dataset;
11356
+ 201: Eval;
9808
11357
  };
9809
- type CreateDatasetResponse = CreateDatasetResponses[keyof CreateDatasetResponses];
9810
- type DeleteDatasetData = {
11358
+ type CreateEvalResponse = CreateEvalResponses[keyof CreateEvalResponses];
11359
+ type DeleteEvalData = {
9811
11360
  body?: never;
9812
11361
  path: {
9813
11362
  /**
@@ -9815,14 +11364,14 @@ type DeleteDatasetData = {
9815
11364
  */
9816
11365
  project_id: string;
9817
11366
  /**
9818
- * Dataset ID
11367
+ * Eval ID
9819
11368
  */
9820
- dataset_id: string;
11369
+ eval_id: string;
9821
11370
  };
9822
11371
  query?: never;
9823
- url: '/v1/projects/{project_id}/datasets/{dataset_id}';
11372
+ url: '/v1/projects/{project_id}/evals/{eval_id}';
9824
11373
  };
9825
- type DeleteDatasetErrors = {
11374
+ type DeleteEvalErrors = {
9826
11375
  /**
9827
11376
  * Unauthorized
9828
11377
  */
@@ -9832,18 +11381,18 @@ type DeleteDatasetErrors = {
9832
11381
  */
9833
11382
  403: unknown;
9834
11383
  /**
9835
- * Dataset not found
11384
+ * Eval not found
9836
11385
  */
9837
11386
  404: unknown;
9838
11387
  };
9839
- type DeleteDatasetResponses = {
11388
+ type DeleteEvalResponses = {
9840
11389
  /**
9841
- * Dataset deleted successfully
11390
+ * Eval deleted successfully
9842
11391
  */
9843
11392
  204: void;
9844
11393
  };
9845
- type DeleteDatasetResponse = DeleteDatasetResponses[keyof DeleteDatasetResponses];
9846
- type GetDatasetData = {
11394
+ type DeleteEvalResponse = DeleteEvalResponses[keyof DeleteEvalResponses];
11395
+ type GetEvalData = {
9847
11396
  body?: never;
9848
11397
  path: {
9849
11398
  /**
@@ -9851,14 +11400,14 @@ type GetDatasetData = {
9851
11400
  */
9852
11401
  project_id: string;
9853
11402
  /**
9854
- * Dataset ID
11403
+ * Eval ID
9855
11404
  */
9856
- dataset_id: string;
11405
+ eval_id: string;
9857
11406
  };
9858
11407
  query?: never;
9859
- url: '/v1/projects/{project_id}/datasets/{dataset_id}';
11408
+ url: '/v1/projects/{project_id}/evals/{eval_id}';
9860
11409
  };
9861
- type GetDatasetErrors = {
11410
+ type GetEvalErrors = {
9862
11411
  /**
9863
11412
  * Unauthorized
9864
11413
  */
@@ -9868,21 +11417,24 @@ type GetDatasetErrors = {
9868
11417
  */
9869
11418
  403: unknown;
9870
11419
  /**
9871
- * Dataset not found
11420
+ * Eval not found
9872
11421
  */
9873
11422
  404: unknown;
9874
11423
  };
9875
- type GetDatasetResponses = {
11424
+ type GetEvalResponses = {
9876
11425
  /**
9877
- * Dataset details
11426
+ * Eval details
9878
11427
  */
9879
- 200: Dataset;
11428
+ 200: Eval;
9880
11429
  };
9881
- type GetDatasetResponse = GetDatasetResponses[keyof GetDatasetResponses];
9882
- type UpdateDatasetData = {
11430
+ type GetEvalResponse = GetEvalResponses[keyof GetEvalResponses];
11431
+ type UpdateEvalData = {
9883
11432
  body: {
9884
11433
  name?: string;
9885
- description?: string | null;
11434
+ agent_id?: string;
11435
+ dataset_id?: string;
11436
+ scorers?: Scorers;
11437
+ pass_threshold?: number | null;
9886
11438
  };
9887
11439
  path: {
9888
11440
  /**
@@ -9890,14 +11442,14 @@ type UpdateDatasetData = {
9890
11442
  */
9891
11443
  project_id: string;
9892
11444
  /**
9893
- * Dataset ID
11445
+ * Eval ID
9894
11446
  */
9895
- dataset_id: string;
11447
+ eval_id: string;
9896
11448
  };
9897
11449
  query?: never;
9898
- url: '/v1/projects/{project_id}/datasets/{dataset_id}';
11450
+ url: '/v1/projects/{project_id}/evals/{eval_id}';
9899
11451
  };
9900
- type UpdateDatasetErrors = {
11452
+ type UpdateEvalErrors = {
9901
11453
  /**
9902
11454
  * Bad request
9903
11455
  */
@@ -9911,103 +11463,46 @@ type UpdateDatasetErrors = {
9911
11463
  */
9912
11464
  403: unknown;
9913
11465
  /**
9914
- * Dataset not found
11466
+ * Eval not found
9915
11467
  */
9916
11468
  404: unknown;
9917
11469
  /**
9918
- * A dataset with that name already exists in the project
11470
+ * An eval with that name already exists in the project
9919
11471
  */
9920
11472
  409: unknown;
9921
11473
  };
9922
- type UpdateDatasetResponses = {
9923
- /**
9924
- * Dataset updated successfully
9925
- */
9926
- 200: Dataset;
9927
- };
9928
- type UpdateDatasetResponse = UpdateDatasetResponses[keyof UpdateDatasetResponses];
9929
- type ListDatasetItemsData = {
9930
- body?: never;
9931
- path: {
9932
- /**
9933
- * Project public ID (proj_ prefix).
9934
- */
9935
- project_id: string;
9936
- /**
9937
- * Dataset ID
9938
- */
9939
- dataset_id: string;
9940
- };
9941
- query?: {
9942
- /**
9943
- * Maximum number of results to return
9944
- */
9945
- limit?: number;
9946
- /**
9947
- * Number of results to skip
9948
- */
9949
- offset?: number;
9950
- };
9951
- url: '/v1/projects/{project_id}/datasets/{dataset_id}/items';
9952
- };
9953
- type ListDatasetItemsErrors = {
9954
- /**
9955
- * Unauthorized
9956
- */
9957
- 401: unknown;
9958
- /**
9959
- * Forbidden
9960
- */
9961
- 403: unknown;
9962
- /**
9963
- * Dataset not found
9964
- */
9965
- 404: unknown;
9966
- };
9967
- type ListDatasetItemsResponses = {
11474
+ type UpdateEvalResponses = {
9968
11475
  /**
9969
- * List of dataset items
9970
- */
9971
- 200: {
9972
- data: Array<DatasetItem>;
9973
- total: number;
9974
- limit: number;
9975
- offset: number;
9976
- };
11476
+ * Eval updated successfully
11477
+ */
11478
+ 200: Eval;
9977
11479
  };
9978
- type ListDatasetItemsResponse = ListDatasetItemsResponses[keyof ListDatasetItemsResponses];
9979
- type CreateDatasetItemData = {
9980
- body: {
9981
- input: DatasetItemInput;
11480
+ type UpdateEvalResponse = UpdateEvalResponses[keyof UpdateEvalResponses];
11481
+ type ListEvalRunsData = {
11482
+ body?: never;
11483
+ path: {
9982
11484
  /**
9983
- * Reference answer for exact_match / embedding_similarity / llm_judge scorers
11485
+ * Project public ID (proj_ prefix).
9984
11486
  */
9985
- expected_output?: string | null;
11487
+ project_id: string;
9986
11488
  /**
9987
- * Free-form tags, opaque to the platform
11489
+ * Eval ID
9988
11490
  */
9989
- metadata?: {
9990
- [key: string]: unknown;
9991
- } | null;
11491
+ eval_id: string;
9992
11492
  };
9993
- path: {
11493
+ query?: {
9994
11494
  /**
9995
- * Project public ID (proj_ prefix).
11495
+ * Maximum number of results to return
9996
11496
  */
9997
- project_id: string;
11497
+ limit?: number;
9998
11498
  /**
9999
- * Dataset ID
11499
+ * Number of results to skip
10000
11500
  */
10001
- dataset_id: string;
11501
+ offset?: number;
10002
11502
  };
10003
- query?: never;
10004
- url: '/v1/projects/{project_id}/datasets/{dataset_id}/items';
11503
+ url: '/v1/projects/{project_id}/evals/{eval_id}/runs';
10005
11504
  };
10006
- type CreateDatasetItemErrors = {
10007
- /**
10008
- * Bad request (input is not message-shaped)
10009
- */
10010
- 400: unknown;
11505
+ type ListEvalRunsErrors = {
10011
11506
  /**
10012
11507
  * Unauthorized
10013
11508
  */
@@ -10017,33 +11512,44 @@ type CreateDatasetItemErrors = {
10017
11512
  */
10018
11513
  403: unknown;
10019
11514
  /**
10020
- * Dataset not found
11515
+ * Eval not found
10021
11516
  */
10022
11517
  404: unknown;
10023
11518
  };
10024
- type CreateDatasetItemResponses = {
11519
+ type ListEvalRunsResponses = {
10025
11520
  /**
10026
- * Dataset item created successfully
11521
+ * List of eval runs
10027
11522
  */
10028
- 201: DatasetItem;
11523
+ 200: {
11524
+ data: Array<EvalRun>;
11525
+ total: number;
11526
+ limit: number;
11527
+ offset: number;
11528
+ };
10029
11529
  };
10030
- type CreateDatasetItemResponse = CreateDatasetItemResponses[keyof CreateDatasetItemResponses];
10031
- type CreateDatasetItemFromGenerationData = {
11530
+ type ListEvalRunsResponse = ListEvalRunsResponses[keyof ListEvalRunsResponses];
11531
+ type StartEvalRunData = {
10032
11532
  body: {
10033
11533
  /**
10034
- * The completed generation to promote. Must belong to the same project as the dataset.
11534
+ * True runs the eval synchronously (25-item cap) and returns a terminal run with its scores. False the default enqueues the items and returns a `queued` run immediately.
10035
11535
  */
10036
- generation_id: string;
11536
+ wait?: boolean;
10037
11537
  /**
10038
- * Reference answer. Omit to use the generation's own answer; pass `null` to store the item with no reference answer.
11538
+ * An archived agent version to evaluate. Defaults to the active release's stable version, or the live draft version when no release is in effect.
10039
11539
  */
10040
- expected_output?: string | null;
11540
+ agent_version?: number | null;
10041
11541
  /**
10042
- * Free-form tags, opaque to the platform
11542
+ * A terminal run of the same eval to compare against. The finished run's `aggregate_scores.baseline` reports per-scorer deltas over the item intersection. A run of a different eval is rejected with 400.
11543
+ */
11544
+ baseline_run_id?: string | null;
11545
+ /**
11546
+ * Caller-supplied key/value metadata attached to the run record for attribution — what this measurement was of (the commit or release candidate being scored, the CI job that asked for it). Round-trips verbatim on every read of the run, the list included.
11547
+ *
11548
+ * The bag is caller-owned and no key is reserved: everything the platform decides about a run (`status`, `agent_version`, `baseline_run_id`, `aggregate_scores`, `passed`, the counts) is a field of its own and cannot be written from here. Nothing in the scoring path reads it. A non-object is rejected with `400 VALIDATION_FAILED` and no run is created.
10043
11549
  */
10044
11550
  metadata?: {
10045
11551
  [key: string]: unknown;
10046
- } | null;
11552
+ };
10047
11553
  };
10048
11554
  path: {
10049
11555
  /**
@@ -10051,16 +11557,16 @@ type CreateDatasetItemFromGenerationData = {
10051
11557
  */
10052
11558
  project_id: string;
10053
11559
  /**
10054
- * Dataset ID
11560
+ * Eval ID
10055
11561
  */
10056
- dataset_id: string;
11562
+ eval_id: string;
10057
11563
  };
10058
11564
  query?: never;
10059
- url: '/v1/projects/{project_id}/datasets/{dataset_id}/items/from-generation';
11565
+ url: '/v1/projects/{project_id}/evals/{eval_id}/runs';
10060
11566
  };
10061
- type CreateDatasetItemFromGenerationErrors = {
11567
+ type StartEvalRunErrors = {
10062
11568
  /**
10063
- * Bad request (generation_id missing, or the generation belongs to a different project than the dataset)
11569
+ * Bad request (non-boolean wait, dataset empty or over the synchronous cap, unknown agent_version, invalid baseline, scorers no longer valid against the agent)
10064
11570
  */
10065
11571
  400: unknown;
10066
11572
  /**
@@ -10072,22 +11578,22 @@ type CreateDatasetItemFromGenerationErrors = {
10072
11578
  */
10073
11579
  403: unknown;
10074
11580
  /**
10075
- * Dataset or generation not found
11581
+ * Eval not found
10076
11582
  */
10077
11583
  404: unknown;
10078
11584
  /**
10079
- * The generation has not completed, or its content was never stored or has been purged
11585
+ * Internal server error
10080
11586
  */
10081
- 409: unknown;
11587
+ 500: unknown;
10082
11588
  };
10083
- type CreateDatasetItemFromGenerationResponses = {
11589
+ type StartEvalRunResponses = {
10084
11590
  /**
10085
- * Dataset item created from the generation
11591
+ * Eval run finished (`wait: true`) or queued (`wait: false`)
10086
11592
  */
10087
- 201: DatasetItem;
11593
+ 201: EvalRun;
10088
11594
  };
10089
- type CreateDatasetItemFromGenerationResponse = CreateDatasetItemFromGenerationResponses[keyof CreateDatasetItemFromGenerationResponses];
10090
- type DeleteDatasetItemData = {
11595
+ type StartEvalRunResponse = StartEvalRunResponses[keyof StartEvalRunResponses];
11596
+ type GetEvalRunData = {
10091
11597
  body?: never;
10092
11598
  path: {
10093
11599
  /**
@@ -10095,18 +11601,18 @@ type DeleteDatasetItemData = {
10095
11601
  */
10096
11602
  project_id: string;
10097
11603
  /**
10098
- * Dataset ID
11604
+ * Eval ID
10099
11605
  */
10100
- dataset_id: string;
11606
+ eval_id: string;
10101
11607
  /**
10102
- * Dataset item ID
11608
+ * Eval run ID
10103
11609
  */
10104
- item_id: string;
11610
+ eval_run_id: string;
10105
11611
  };
10106
11612
  query?: never;
10107
- url: '/v1/projects/{project_id}/datasets/{dataset_id}/items/{item_id}';
11613
+ url: '/v1/projects/{project_id}/evals/{eval_id}/runs/{eval_run_id}';
10108
11614
  };
10109
- type DeleteDatasetItemErrors = {
11615
+ type GetEvalRunErrors = {
10110
11616
  /**
10111
11617
  * Unauthorized
10112
11618
  */
@@ -10116,47 +11622,46 @@ type DeleteDatasetItemErrors = {
10116
11622
  */
10117
11623
  403: unknown;
10118
11624
  /**
10119
- * Dataset or item not found
11625
+ * Eval or run not found
10120
11626
  */
10121
11627
  404: unknown;
10122
11628
  };
10123
- type DeleteDatasetItemResponses = {
11629
+ type GetEvalRunResponses = {
10124
11630
  /**
10125
- * Dataset item deleted successfully
11631
+ * Eval run details
10126
11632
  */
10127
- 204: void;
11633
+ 200: EvalRun;
10128
11634
  };
10129
- type DeleteDatasetItemResponse = DeleteDatasetItemResponses[keyof DeleteDatasetItemResponses];
10130
- type UpdateDatasetItemData = {
10131
- body: {
10132
- input?: DatasetItemInput;
10133
- expected_output?: string | null;
10134
- metadata?: {
10135
- [key: string]: unknown;
10136
- } | null;
10137
- };
11635
+ type GetEvalRunResponse = GetEvalRunResponses[keyof GetEvalRunResponses];
11636
+ type ListEvalResultsData = {
11637
+ body?: never;
10138
11638
  path: {
10139
11639
  /**
10140
11640
  * Project public ID (proj_ prefix).
10141
11641
  */
10142
11642
  project_id: string;
10143
11643
  /**
10144
- * Dataset ID
11644
+ * Eval ID
10145
11645
  */
10146
- dataset_id: string;
11646
+ eval_id: string;
10147
11647
  /**
10148
- * Dataset item ID
11648
+ * Eval run ID
10149
11649
  */
10150
- item_id: string;
11650
+ eval_run_id: string;
10151
11651
  };
10152
- query?: never;
10153
- url: '/v1/projects/{project_id}/datasets/{dataset_id}/items/{item_id}';
11652
+ query?: {
11653
+ /**
11654
+ * Maximum number of results to return
11655
+ */
11656
+ limit?: number;
11657
+ /**
11658
+ * Number of results to skip
11659
+ */
11660
+ offset?: number;
11661
+ };
11662
+ url: '/v1/projects/{project_id}/evals/{eval_id}/runs/{eval_run_id}/results';
10154
11663
  };
10155
- type UpdateDatasetItemErrors = {
10156
- /**
10157
- * Bad request
10158
- */
10159
- 400: unknown;
11664
+ type ListEvalResultsErrors = {
10160
11665
  /**
10161
11666
  * Unauthorized
10162
11667
  */
@@ -10166,38 +11671,46 @@ type UpdateDatasetItemErrors = {
10166
11671
  */
10167
11672
  403: unknown;
10168
11673
  /**
10169
- * Dataset or item not found
11674
+ * Eval or run not found
10170
11675
  */
10171
11676
  404: unknown;
10172
11677
  };
10173
- type UpdateDatasetItemResponses = {
11678
+ type ListEvalResultsResponses = {
10174
11679
  /**
10175
- * Dataset item updated successfully
11680
+ * List of eval results
10176
11681
  */
10177
- 200: DatasetItem;
11682
+ 200: {
11683
+ data: Array<EvalResult>;
11684
+ total: number;
11685
+ limit: number;
11686
+ offset: number;
11687
+ };
10178
11688
  };
10179
- type UpdateDatasetItemResponse = UpdateDatasetItemResponses[keyof UpdateDatasetItemResponses];
10180
- type ListEvalsData = {
11689
+ type ListEvalResultsResponse = ListEvalResultsResponses[keyof ListEvalResultsResponses];
11690
+ type CancelEvalRunData = {
10181
11691
  body?: never;
10182
11692
  path: {
10183
11693
  /**
10184
11694
  * Project public ID (proj_ prefix).
10185
11695
  */
10186
11696
  project_id: string;
10187
- };
10188
- query?: {
10189
11697
  /**
10190
- * Maximum number of results to return
11698
+ * Eval ID
10191
11699
  */
10192
- limit?: number;
11700
+ eval_id: string;
10193
11701
  /**
10194
- * Number of results to skip
11702
+ * Eval run ID
10195
11703
  */
10196
- offset?: number;
11704
+ eval_run_id: string;
10197
11705
  };
10198
- url: '/v1/projects/{project_id}/evals';
11706
+ query?: never;
11707
+ url: '/v1/projects/{project_id}/evals/{eval_id}/runs/{eval_run_id}/cancel';
10199
11708
  };
10200
- type ListEvalsErrors = {
11709
+ type CancelEvalRunErrors = {
11710
+ /**
11711
+ * The run has already finished
11712
+ */
11713
+ 400: unknown;
10201
11714
  /**
10202
11715
  * Unauthorized
10203
11716
  */
@@ -10206,57 +11719,55 @@ type ListEvalsErrors = {
10206
11719
  * Forbidden
10207
11720
  */
10208
11721
  403: unknown;
11722
+ /**
11723
+ * Eval or run not found
11724
+ */
11725
+ 404: unknown;
10209
11726
  /**
10210
11727
  * Internal server error
10211
11728
  */
10212
11729
  500: unknown;
10213
11730
  };
10214
- type ListEvalsResponses = {
11731
+ type CancelEvalRunResponses = {
10215
11732
  /**
10216
- * List of evals
11733
+ * Eval run canceled
10217
11734
  */
10218
- 200: {
10219
- data: Array<Eval>;
10220
- total: number;
10221
- limit: number;
10222
- offset: number;
10223
- };
11735
+ 200: EvalRun;
10224
11736
  };
10225
- type ListEvalsResponse = ListEvalsResponses[keyof ListEvalsResponses];
10226
- type CreateEvalData = {
10227
- body: {
11737
+ type CancelEvalRunResponse = CancelEvalRunResponses[keyof CancelEvalRunResponses];
11738
+ type ListExceptionsData = {
11739
+ body?: never;
11740
+ path: {
10228
11741
  /**
10229
- * Unique name within the project
11742
+ * Project public ID (proj_ prefix).
10230
11743
  */
10231
- name: string;
11744
+ project_id: string;
11745
+ };
11746
+ query?: {
10232
11747
  /**
10233
- * The agent under test
11748
+ * Filter by triage status
10234
11749
  */
10235
- agent_id: string;
11750
+ status?: 'open' | 'acknowledged' | 'resolved';
10236
11751
  /**
10237
- * The dataset to run it against
11752
+ * Filter by severity
10238
11753
  */
10239
- dataset_id: string;
10240
- scorers: Scorers;
11754
+ severity?: 'info' | 'warning' | 'critical';
10241
11755
  /**
10242
- * 0–1. The run passes iff its pass rate — passed items over non-errored items — is at least this. Null reports scores without gating on them.
11756
+ * Filter by how the exception was filed
10243
11757
  */
10244
- pass_threshold?: number | null;
10245
- };
10246
- path: {
11758
+ kind?: 'run_failed' | 'guardrail_tripwire' | 'approval_expired' | 'quota_unpriced' | 'event_trigger_loop' | 'manual';
10247
11759
  /**
10248
- * Project public ID (proj_ prefix).
11760
+ * Maximum number of results to return
10249
11761
  */
10250
- project_id: string;
11762
+ limit?: number;
11763
+ /**
11764
+ * Number of results to skip
11765
+ */
11766
+ offset?: number;
10251
11767
  };
10252
- query?: never;
10253
- url: '/v1/projects/{project_id}/evals';
10254
- };
10255
- type CreateEvalErrors = {
10256
- /**
10257
- * Bad request (unknown scorer type, cross-project reference, invalid threshold)
10258
- */
10259
- 400: unknown;
11768
+ url: '/v1/projects/{project_id}/exceptions';
11769
+ };
11770
+ type ListExceptionsErrors = {
10260
11771
  /**
10261
11772
  * Unauthorized
10262
11773
  */
@@ -10265,23 +11776,24 @@ type CreateEvalErrors = {
10265
11776
  * Forbidden
10266
11777
  */
10267
11778
  403: unknown;
10268
- /**
10269
- * An eval with that name already exists in the project
10270
- */
10271
- 409: unknown;
10272
11779
  /**
10273
11780
  * Internal server error
10274
11781
  */
10275
11782
  500: unknown;
10276
11783
  };
10277
- type CreateEvalResponses = {
11784
+ type ListExceptionsResponses = {
10278
11785
  /**
10279
- * Eval created successfully
11786
+ * List of exception items
10280
11787
  */
10281
- 201: Eval;
11788
+ 200: {
11789
+ data: Array<ExceptionItem>;
11790
+ total: number;
11791
+ limit: number;
11792
+ offset: number;
11793
+ };
10282
11794
  };
10283
- type CreateEvalResponse = CreateEvalResponses[keyof CreateEvalResponses];
10284
- type DeleteEvalData = {
11795
+ type ListExceptionsResponse = ListExceptionsResponses[keyof ListExceptionsResponses];
11796
+ type GetExceptionData = {
10285
11797
  body?: never;
10286
11798
  path: {
10287
11799
  /**
@@ -10289,14 +11801,14 @@ type DeleteEvalData = {
10289
11801
  */
10290
11802
  project_id: string;
10291
11803
  /**
10292
- * Eval ID
11804
+ * Exception item ID
10293
11805
  */
10294
- eval_id: string;
11806
+ exception_id: string;
10295
11807
  };
10296
11808
  query?: never;
10297
- url: '/v1/projects/{project_id}/evals/{eval_id}';
11809
+ url: '/v1/projects/{project_id}/exceptions/{exception_id}';
10298
11810
  };
10299
- type DeleteEvalErrors = {
11811
+ type GetExceptionErrors = {
10300
11812
  /**
10301
11813
  * Unauthorized
10302
11814
  */
@@ -10306,18 +11818,18 @@ type DeleteEvalErrors = {
10306
11818
  */
10307
11819
  403: unknown;
10308
11820
  /**
10309
- * Eval not found
11821
+ * Exception item not found
10310
11822
  */
10311
11823
  404: unknown;
10312
11824
  };
10313
- type DeleteEvalResponses = {
11825
+ type GetExceptionResponses = {
10314
11826
  /**
10315
- * Eval deleted successfully
11827
+ * Exception item
10316
11828
  */
10317
- 204: void;
11829
+ 200: ExceptionItem;
10318
11830
  };
10319
- type DeleteEvalResponse = DeleteEvalResponses[keyof DeleteEvalResponses];
10320
- type GetEvalData = {
11831
+ type GetExceptionResponse = GetExceptionResponses[keyof GetExceptionResponses];
11832
+ type AcknowledgeExceptionData = {
10321
11833
  body?: never;
10322
11834
  path: {
10323
11835
  /**
@@ -10325,14 +11837,14 @@ type GetEvalData = {
10325
11837
  */
10326
11838
  project_id: string;
10327
11839
  /**
10328
- * Eval ID
11840
+ * Exception item ID
10329
11841
  */
10330
- eval_id: string;
11842
+ exception_id: string;
10331
11843
  };
10332
11844
  query?: never;
10333
- url: '/v1/projects/{project_id}/evals/{eval_id}';
11845
+ url: '/v1/projects/{project_id}/exceptions/{exception_id}/acknowledge';
10334
11846
  };
10335
- type GetEvalErrors = {
11847
+ type AcknowledgeExceptionErrors = {
10336
11848
  /**
10337
11849
  * Unauthorized
10338
11850
  */
@@ -10342,24 +11854,27 @@ type GetEvalErrors = {
10342
11854
  */
10343
11855
  403: unknown;
10344
11856
  /**
10345
- * Eval not found
11857
+ * Exception item not found
10346
11858
  */
10347
11859
  404: unknown;
11860
+ /**
11861
+ * Item already resolved
11862
+ */
11863
+ 409: unknown;
10348
11864
  };
10349
- type GetEvalResponses = {
11865
+ type AcknowledgeExceptionResponses = {
10350
11866
  /**
10351
- * Eval details
11867
+ * Exception item acknowledged
10352
11868
  */
10353
- 200: Eval;
11869
+ 200: ExceptionItem;
10354
11870
  };
10355
- type GetEvalResponse = GetEvalResponses[keyof GetEvalResponses];
10356
- type UpdateEvalData = {
10357
- body: {
10358
- name?: string;
10359
- agent_id?: string;
10360
- dataset_id?: string;
10361
- scorers?: Scorers;
10362
- pass_threshold?: number | null;
11871
+ type AcknowledgeExceptionResponse = AcknowledgeExceptionResponses[keyof AcknowledgeExceptionResponses];
11872
+ type ResolveExceptionData = {
11873
+ body?: {
11874
+ /**
11875
+ * Optional resolution note
11876
+ */
11877
+ note?: string;
10363
11878
  };
10364
11879
  path: {
10365
11880
  /**
@@ -10367,18 +11882,14 @@ type UpdateEvalData = {
10367
11882
  */
10368
11883
  project_id: string;
10369
11884
  /**
10370
- * Eval ID
11885
+ * Exception item ID
10371
11886
  */
10372
- eval_id: string;
11887
+ exception_id: string;
10373
11888
  };
10374
11889
  query?: never;
10375
- url: '/v1/projects/{project_id}/evals/{eval_id}';
11890
+ url: '/v1/projects/{project_id}/exceptions/{exception_id}/resolve';
10376
11891
  };
10377
- type UpdateEvalErrors = {
10378
- /**
10379
- * Bad request
10380
- */
10381
- 400: unknown;
11892
+ type ResolveExceptionErrors = {
10382
11893
  /**
10383
11894
  * Unauthorized
10384
11895
  */
@@ -10388,32 +11899,28 @@ type UpdateEvalErrors = {
10388
11899
  */
10389
11900
  403: unknown;
10390
11901
  /**
10391
- * Eval not found
11902
+ * Exception item not found
10392
11903
  */
10393
11904
  404: unknown;
10394
11905
  /**
10395
- * An eval with that name already exists in the project
11906
+ * Item already resolved
10396
11907
  */
10397
11908
  409: unknown;
10398
11909
  };
10399
- type UpdateEvalResponses = {
11910
+ type ResolveExceptionResponses = {
10400
11911
  /**
10401
- * Eval updated successfully
11912
+ * Exception item resolved
10402
11913
  */
10403
- 200: Eval;
11914
+ 200: ExceptionItem;
10404
11915
  };
10405
- type UpdateEvalResponse = UpdateEvalResponses[keyof UpdateEvalResponses];
10406
- type ListEvalRunsData = {
11916
+ type ResolveExceptionResponse = ResolveExceptionResponses[keyof ResolveExceptionResponses];
11917
+ type ListFilesData = {
10407
11918
  body?: never;
10408
11919
  path: {
10409
11920
  /**
10410
11921
  * Project public ID (proj_ prefix).
10411
11922
  */
10412
11923
  project_id: string;
10413
- /**
10414
- * Eval ID
10415
- */
10416
- eval_id: string;
10417
11924
  };
10418
11925
  query?: {
10419
11926
  /**
@@ -10425,300 +11932,196 @@ type ListEvalRunsData = {
10425
11932
  */
10426
11933
  offset?: number;
10427
11934
  };
10428
- url: '/v1/projects/{project_id}/evals/{eval_id}/runs';
11935
+ url: '/v1/projects/{project_id}/files';
10429
11936
  };
10430
- type ListEvalRunsErrors = {
10431
- /**
10432
- * Unauthorized
10433
- */
10434
- 401: unknown;
10435
- /**
10436
- * Forbidden
10437
- */
10438
- 403: unknown;
11937
+ type ListFilesErrors = {
10439
11938
  /**
10440
- * Eval not found
11939
+ * Internal server error
10441
11940
  */
10442
- 404: unknown;
11941
+ 500: ErrorResponse;
10443
11942
  };
10444
- type ListEvalRunsResponses = {
11943
+ type ListFilesError = ListFilesErrors[keyof ListFilesErrors];
11944
+ type ListFilesResponses = {
10445
11945
  /**
10446
- * List of eval runs
11946
+ * List of files returned successfully
10447
11947
  */
10448
11948
  200: {
10449
- data: Array<EvalRun>;
10450
- total: number;
10451
- limit: number;
10452
- offset: number;
11949
+ data?: Array<FileRecord>;
11950
+ total?: number;
11951
+ limit?: number;
11952
+ offset?: number;
10453
11953
  };
10454
11954
  };
10455
- type ListEvalRunsResponse = ListEvalRunsResponses[keyof ListEvalRunsResponses];
10456
- type StartEvalRunData = {
11955
+ type ListFilesResponse = ListFilesResponses[keyof ListFilesResponses];
11956
+ type CreateFileData = {
10457
11957
  body: {
10458
11958
  /**
10459
- * True runs the eval synchronously (25-item cap) and returns a terminal run with its scores. False the default enqueues the items and returns a `queued` run immediately.
10460
- */
10461
- wait?: boolean;
10462
- /**
10463
- * An archived agent version to evaluate. Defaults to the active release's stable version, or the live draft version when no release is in effect.
11959
+ * Directory within the project (e.g. /images). Optional; defaults to / (root). Combined with filename to form the file's key (path).
10464
11960
  */
10465
- agent_version?: number | null;
11961
+ prefix?: string;
10466
11962
  /**
10467
- * A terminal run of the same eval to compare against. The finished run's `aggregate_scores.baseline` reports per-scorer deltas over the item intersection. A run of a different eval is rejected with 400.
11963
+ * Original / download name and the key's leaf segment (e.g. logo.png).
10468
11964
  */
10469
- baseline_run_id?: string | null;
11965
+ filename?: string;
10470
11966
  /**
10471
- * Caller-supplied key/value metadata attached to the run record for attribution — what this measurement was of (the commit or release candidate being scored, the CI job that asked for it). Round-trips verbatim on every read of the run, the list included.
10472
- *
10473
- * The bag is caller-owned and no key is reserved: everything the platform decides about a run (`status`, `agent_version`, `baseline_run_id`, `aggregate_scores`, `passed`, the counts) is a field of its own and cannot be written from here. Nothing in the scoring path reads it. A non-object is rejected with `400 VALIDATION_FAILED` and no run is created.
11967
+ * MIME type of the file
10474
11968
  */
10475
- metadata?: {
10476
- [key: string]: unknown;
10477
- };
10478
- };
10479
- path: {
11969
+ content_type?: string;
10480
11970
  /**
10481
- * Project public ID (proj_ prefix).
11971
+ * File size in bytes
10482
11972
  */
10483
- project_id: string;
11973
+ size?: number | null;
10484
11974
  /**
10485
- * Eval ID
11975
+ * JSON string with additional metadata
10486
11976
  */
10487
- eval_id: string;
11977
+ metadata?: string;
10488
11978
  };
10489
- query?: never;
10490
- url: '/v1/projects/{project_id}/evals/{eval_id}/runs';
10491
- };
10492
- type StartEvalRunErrors = {
10493
- /**
10494
- * Bad request (non-boolean wait, dataset empty or over the synchronous cap, unknown agent_version, invalid baseline, scorers no longer valid against the agent)
10495
- */
10496
- 400: unknown;
10497
- /**
10498
- * Unauthorized
10499
- */
10500
- 401: unknown;
10501
- /**
10502
- * Forbidden
10503
- */
10504
- 403: unknown;
10505
- /**
10506
- * Eval not found
10507
- */
10508
- 404: unknown;
10509
- /**
10510
- * Internal server error
10511
- */
10512
- 500: unknown;
10513
- };
10514
- type StartEvalRunResponses = {
10515
- /**
10516
- * Eval run finished (`wait: true`) or queued (`wait: false`)
10517
- */
10518
- 201: EvalRun;
10519
- };
10520
- type StartEvalRunResponse = StartEvalRunResponses[keyof StartEvalRunResponses];
10521
- type GetEvalRunData = {
10522
- body?: never;
10523
11979
  path: {
10524
11980
  /**
10525
11981
  * Project public ID (proj_ prefix).
10526
11982
  */
10527
11983
  project_id: string;
10528
- /**
10529
- * Eval ID
10530
- */
10531
- eval_id: string;
10532
- /**
10533
- * Eval run ID
10534
- */
10535
- eval_run_id: string;
10536
11984
  };
10537
11985
  query?: never;
10538
- url: '/v1/projects/{project_id}/evals/{eval_id}/runs/{eval_run_id}';
11986
+ url: '/v1/projects/{project_id}/files';
10539
11987
  };
10540
- type GetEvalRunErrors = {
10541
- /**
10542
- * Unauthorized
10543
- */
10544
- 401: unknown;
10545
- /**
10546
- * Forbidden
10547
- */
10548
- 403: unknown;
11988
+ type CreateFileErrors = {
10549
11989
  /**
10550
- * Eval or run not found
11990
+ * Internal server error
10551
11991
  */
10552
- 404: unknown;
11992
+ 500: ErrorResponse;
10553
11993
  };
10554
- type GetEvalRunResponses = {
11994
+ type CreateFileError = CreateFileErrors[keyof CreateFileErrors];
11995
+ type CreateFileResponses = {
10555
11996
  /**
10556
- * Eval run details
11997
+ * File created successfully
10557
11998
  */
10558
- 200: EvalRun;
11999
+ 201: FileRecord;
10559
12000
  };
10560
- type GetEvalRunResponse = GetEvalRunResponses[keyof GetEvalRunResponses];
10561
- type ListEvalResultsData = {
10562
- body?: never;
10563
- path: {
12001
+ type CreateFileResponse = CreateFileResponses[keyof CreateFileResponses];
12002
+ type UploadFileData = {
12003
+ body: {
10564
12004
  /**
10565
- * Project public ID (proj_ prefix).
12005
+ * File content
10566
12006
  */
10567
- project_id: string;
12007
+ file: Blob | File;
10568
12008
  /**
10569
- * Eval ID
12009
+ * Project ID to associate the file with. Optional when authenticating with a project-scoped API key, which defaults to the key's project; required otherwise.
10570
12010
  */
10571
- eval_id: string;
12011
+ project_id?: string;
10572
12012
  /**
10573
- * Eval run ID
12013
+ * Directory within the project (e.g. /images). Optional; defaults to / (root).
10574
12014
  */
10575
- eval_run_id: string;
10576
- };
10577
- query?: {
12015
+ prefix?: string;
12016
+ /**
12017
+ * Original / download name. Optional; defaults to the uploaded file's name.
12018
+ */
12019
+ filename?: string;
10578
12020
  /**
10579
- * Maximum number of results to return
12021
+ * Additional metadata as a JSON string
10580
12022
  */
10581
- limit?: number;
12023
+ metadata?: string;
12024
+ };
12025
+ path: {
10582
12026
  /**
10583
- * Number of results to skip
12027
+ * Project public ID (proj_ prefix).
10584
12028
  */
10585
- offset?: number;
12029
+ project_id: string;
10586
12030
  };
10587
- url: '/v1/projects/{project_id}/evals/{eval_id}/runs/{eval_run_id}/results';
12031
+ query?: never;
12032
+ url: '/v1/projects/{project_id}/files/upload';
10588
12033
  };
10589
- type ListEvalResultsErrors = {
12034
+ type UploadFileErrors = {
10590
12035
  /**
10591
- * Unauthorized
12036
+ * Missing file or invalid project
10592
12037
  */
10593
- 401: unknown;
12038
+ 400: ErrorResponse;
10594
12039
  /**
10595
- * Forbidden
12040
+ * Missing or invalid credentials.
10596
12041
  */
10597
- 403: unknown;
12042
+ 401: ErrorResponse;
10598
12043
  /**
10599
- * Eval or run not found
12044
+ * The caller's role in the project does not carry this action, or the credential is scoped to a different project.
12045
+ *
10600
12046
  */
10601
- 404: unknown;
12047
+ 403: ErrorResponse;
10602
12048
  };
10603
- type ListEvalResultsResponses = {
12049
+ type UploadFileError = UploadFileErrors[keyof UploadFileErrors];
12050
+ type UploadFileResponses = {
10604
12051
  /**
10605
- * List of eval results
12052
+ * File uploaded successfully
10606
12053
  */
10607
- 200: {
10608
- data: Array<EvalResult>;
10609
- total: number;
10610
- limit: number;
10611
- offset: number;
10612
- };
12054
+ 201: FileRecord;
10613
12055
  };
10614
- type ListEvalResultsResponse = ListEvalResultsResponses[keyof ListEvalResultsResponses];
10615
- type CancelEvalRunData = {
10616
- body?: never;
12056
+ type UploadFileResponse = UploadFileResponses[keyof UploadFileResponses];
12057
+ type UploadFileBase64Data = {
12058
+ body: UploadFileBase64Request;
10617
12059
  path: {
10618
12060
  /**
10619
12061
  * Project public ID (proj_ prefix).
10620
12062
  */
10621
12063
  project_id: string;
10622
- /**
10623
- * Eval ID
10624
- */
10625
- eval_id: string;
10626
- /**
10627
- * Eval run ID
10628
- */
10629
- eval_run_id: string;
10630
12064
  };
10631
12065
  query?: never;
10632
- url: '/v1/projects/{project_id}/evals/{eval_id}/runs/{eval_run_id}/cancel';
12066
+ url: '/v1/projects/{project_id}/files/upload/base64';
10633
12067
  };
10634
- type CancelEvalRunErrors = {
10635
- /**
10636
- * The run has already finished
10637
- */
10638
- 400: unknown;
10639
- /**
10640
- * Unauthorized
10641
- */
10642
- 401: unknown;
12068
+ type UploadFileBase64Errors = {
10643
12069
  /**
10644
- * Forbidden
12070
+ * Missing content or invalid project
10645
12071
  */
10646
- 403: unknown;
12072
+ 400: ErrorResponse;
10647
12073
  /**
10648
- * Eval or run not found
12074
+ * Missing or invalid credentials.
10649
12075
  */
10650
- 404: unknown;
12076
+ 401: ErrorResponse;
10651
12077
  /**
10652
- * Internal server error
12078
+ * The caller's role in the project does not carry this action, or the credential is scoped to a different project.
12079
+ *
10653
12080
  */
10654
- 500: unknown;
12081
+ 403: ErrorResponse;
10655
12082
  };
10656
- type CancelEvalRunResponses = {
12083
+ type UploadFileBase64Error = UploadFileBase64Errors[keyof UploadFileBase64Errors];
12084
+ type UploadFileBase64Responses = {
10657
12085
  /**
10658
- * Eval run canceled
12086
+ * File uploaded successfully
10659
12087
  */
10660
- 200: EvalRun;
12088
+ 201: FileRecord;
10661
12089
  };
10662
- type CancelEvalRunResponse = CancelEvalRunResponses[keyof CancelEvalRunResponses];
10663
- type ListExceptionsData = {
12090
+ type UploadFileBase64Response = UploadFileBase64Responses[keyof UploadFileBase64Responses];
12091
+ type DeleteFileData = {
10664
12092
  body?: never;
10665
12093
  path: {
10666
12094
  /**
10667
12095
  * Project public ID (proj_ prefix).
10668
12096
  */
10669
12097
  project_id: string;
10670
- };
10671
- query?: {
10672
- /**
10673
- * Filter by triage status
10674
- */
10675
- status?: 'open' | 'acknowledged' | 'resolved';
10676
- /**
10677
- * Filter by severity
10678
- */
10679
- severity?: 'info' | 'warning' | 'critical';
10680
- /**
10681
- * Filter by how the exception was filed
10682
- */
10683
- kind?: 'run_failed' | 'guardrail_tripwire' | 'approval_expired' | 'quota_unpriced' | 'event_trigger_loop' | 'manual';
10684
- /**
10685
- * Maximum number of results to return
10686
- */
10687
- limit?: number;
10688
12098
  /**
10689
- * Number of results to skip
12099
+ * ID of the file to delete
10690
12100
  */
10691
- offset?: number;
12101
+ file_id: string;
10692
12102
  };
10693
- url: '/v1/projects/{project_id}/exceptions';
12103
+ query?: never;
12104
+ url: '/v1/projects/{project_id}/files/{file_id}';
10694
12105
  };
10695
- type ListExceptionsErrors = {
10696
- /**
10697
- * Unauthorized
10698
- */
10699
- 401: unknown;
12106
+ type DeleteFileErrors = {
10700
12107
  /**
10701
- * Forbidden
12108
+ * File not found
10702
12109
  */
10703
- 403: unknown;
12110
+ 404: ErrorResponse;
10704
12111
  /**
10705
12112
  * Internal server error
10706
12113
  */
10707
- 500: unknown;
12114
+ 500: ErrorResponse;
10708
12115
  };
10709
- type ListExceptionsResponses = {
12116
+ type DeleteFileError = DeleteFileErrors[keyof DeleteFileErrors];
12117
+ type DeleteFileResponses = {
10710
12118
  /**
10711
- * List of exception items
12119
+ * File deleted successfully
10712
12120
  */
10713
- 200: {
10714
- data: Array<ExceptionItem>;
10715
- total: number;
10716
- limit: number;
10717
- offset: number;
10718
- };
12121
+ 204: void;
10719
12122
  };
10720
- type ListExceptionsResponse = ListExceptionsResponses[keyof ListExceptionsResponses];
10721
- type GetExceptionData = {
12123
+ type DeleteFileResponse = DeleteFileResponses[keyof DeleteFileResponses];
12124
+ type GetFileData = {
10722
12125
  body?: never;
10723
12126
  path: {
10724
12127
  /**
@@ -10726,35 +12129,32 @@ type GetExceptionData = {
10726
12129
  */
10727
12130
  project_id: string;
10728
12131
  /**
10729
- * Exception item ID
12132
+ * File ID
10730
12133
  */
10731
- exception_id: string;
12134
+ file_id: string;
10732
12135
  };
10733
12136
  query?: never;
10734
- url: '/v1/projects/{project_id}/exceptions/{exception_id}';
12137
+ url: '/v1/projects/{project_id}/files/{file_id}';
10735
12138
  };
10736
- type GetExceptionErrors = {
10737
- /**
10738
- * Unauthorized
10739
- */
10740
- 401: unknown;
12139
+ type GetFileErrors = {
10741
12140
  /**
10742
- * Forbidden
12141
+ * File not found
10743
12142
  */
10744
- 403: unknown;
12143
+ 404: ErrorResponse;
10745
12144
  /**
10746
- * Exception item not found
12145
+ * Internal server error
10747
12146
  */
10748
- 404: unknown;
12147
+ 500: ErrorResponse;
10749
12148
  };
10750
- type GetExceptionResponses = {
12149
+ type GetFileError = GetFileErrors[keyof GetFileErrors];
12150
+ type GetFileResponses = {
10751
12151
  /**
10752
- * Exception item
12152
+ * File found
10753
12153
  */
10754
- 200: ExceptionItem;
12154
+ 200: FileRecord;
10755
12155
  };
10756
- type GetExceptionResponse = GetExceptionResponses[keyof GetExceptionResponses];
10757
- type AcknowledgeExceptionData = {
12156
+ type GetFileResponse = GetFileResponses[keyof GetFileResponses];
12157
+ type DownloadFileData = {
10758
12158
  body?: never;
10759
12159
  path: {
10760
12160
  /**
@@ -10762,44 +12162,50 @@ type AcknowledgeExceptionData = {
10762
12162
  */
10763
12163
  project_id: string;
10764
12164
  /**
10765
- * Exception item ID
12165
+ * File ID
10766
12166
  */
10767
- exception_id: string;
12167
+ file_id: string;
10768
12168
  };
10769
12169
  query?: never;
10770
- url: '/v1/projects/{project_id}/exceptions/{exception_id}/acknowledge';
12170
+ url: '/v1/projects/{project_id}/files/{file_id}/download';
10771
12171
  };
10772
- type AcknowledgeExceptionErrors = {
10773
- /**
10774
- * Unauthorized
10775
- */
10776
- 401: unknown;
12172
+ type DownloadFileErrors = {
10777
12173
  /**
10778
- * Forbidden
12174
+ * Missing or invalid credentials.
10779
12175
  */
10780
- 403: unknown;
12176
+ 401: ErrorResponse;
10781
12177
  /**
10782
- * Exception item not found
12178
+ * The caller's role in the project does not carry this action, or the credential is scoped to a different project.
12179
+ *
10783
12180
  */
10784
- 404: unknown;
12181
+ 403: ErrorResponse;
10785
12182
  /**
10786
- * Item already resolved
12183
+ * File not found
10787
12184
  */
10788
- 409: unknown;
12185
+ 404: ErrorResponse;
10789
12186
  };
10790
- type AcknowledgeExceptionResponses = {
12187
+ type DownloadFileError = DownloadFileErrors[keyof DownloadFileErrors];
12188
+ type DownloadFileResponses = {
10791
12189
  /**
10792
- * Exception item acknowledged
12190
+ * File content
10793
12191
  */
10794
- 200: ExceptionItem;
12192
+ 200: Blob | File;
10795
12193
  };
10796
- type AcknowledgeExceptionResponse = AcknowledgeExceptionResponses[keyof AcknowledgeExceptionResponses];
10797
- type ResolveExceptionData = {
10798
- body?: {
12194
+ type DownloadFileResponse = DownloadFileResponses[keyof DownloadFileResponses];
12195
+ type UpdateFileMetadataData = {
12196
+ body: {
10799
12197
  /**
10800
- * Optional resolution note
12198
+ * New metadata as a JSON string
10801
12199
  */
10802
- note?: string;
12200
+ metadata?: string;
12201
+ /**
12202
+ * New directory — moves the file. The resulting path (prefix + filename) must be unique within the project.
12203
+ */
12204
+ prefix?: string;
12205
+ /**
12206
+ * New filename — renames the key's leaf and the download name.
12207
+ */
12208
+ filename?: string;
10803
12209
  };
10804
12210
  path: {
10805
12211
  /**
@@ -10807,85 +12213,82 @@ type ResolveExceptionData = {
10807
12213
  */
10808
12214
  project_id: string;
10809
12215
  /**
10810
- * Exception item ID
12216
+ * File ID
10811
12217
  */
10812
- exception_id: string;
12218
+ file_id: string;
10813
12219
  };
10814
12220
  query?: never;
10815
- url: '/v1/projects/{project_id}/exceptions/{exception_id}/resolve';
12221
+ url: '/v1/projects/{project_id}/files/{file_id}/metadata';
10816
12222
  };
10817
- type ResolveExceptionErrors = {
12223
+ type UpdateFileMetadataErrors = {
10818
12224
  /**
10819
- * Unauthorized
12225
+ * Missing or invalid credentials.
10820
12226
  */
10821
- 401: unknown;
12227
+ 401: ErrorResponse;
10822
12228
  /**
10823
- * Forbidden
12229
+ * The caller's role in the project does not carry this action, or the credential is scoped to a different project.
12230
+ *
10824
12231
  */
10825
- 403: unknown;
12232
+ 403: ErrorResponse;
10826
12233
  /**
10827
- * Exception item not found
12234
+ * File not found
10828
12235
  */
10829
- 404: unknown;
12236
+ 404: ErrorResponse;
10830
12237
  /**
10831
- * Item already resolved
12238
+ * A file already exists at the target path in this project
10832
12239
  */
10833
- 409: unknown;
12240
+ 409: ErrorResponse;
10834
12241
  };
10835
- type ResolveExceptionResponses = {
12242
+ type UpdateFileMetadataError = UpdateFileMetadataErrors[keyof UpdateFileMetadataErrors];
12243
+ type UpdateFileMetadataResponses = {
10836
12244
  /**
10837
- * Exception item resolved
12245
+ * Metadata updated successfully
10838
12246
  */
10839
- 200: ExceptionItem;
12247
+ 200: FileRecord;
10840
12248
  };
10841
- type ResolveExceptionResponse = ResolveExceptionResponses[keyof ResolveExceptionResponses];
10842
- type ListFilesData = {
12249
+ type UpdateFileMetadataResponse = UpdateFileMetadataResponses[keyof UpdateFileMetadataResponses];
12250
+ type DownloadFileBase64Data = {
10843
12251
  body?: never;
10844
12252
  path: {
10845
12253
  /**
10846
12254
  * Project public ID (proj_ prefix).
10847
12255
  */
10848
12256
  project_id: string;
10849
- };
10850
- query?: {
10851
- /**
10852
- * Maximum number of results to return
10853
- */
10854
- limit?: number;
10855
12257
  /**
10856
- * Number of results to skip
12258
+ * File ID
10857
12259
  */
10858
- offset?: number;
12260
+ file_id: string;
10859
12261
  };
10860
- url: '/v1/projects/{project_id}/files';
12262
+ query?: never;
12263
+ url: '/v1/projects/{project_id}/files/{file_id}/download/base64';
10861
12264
  };
10862
- type ListFilesErrors = {
12265
+ type DownloadFileBase64Errors = {
10863
12266
  /**
10864
- * Internal server error
12267
+ * Missing or invalid credentials.
10865
12268
  */
10866
- 500: ErrorResponse;
12269
+ 401: ErrorResponse;
12270
+ /**
12271
+ * The caller's role in the project does not carry this action, or the credential is scoped to a different project.
12272
+ *
12273
+ */
12274
+ 403: ErrorResponse;
12275
+ /**
12276
+ * File not found
12277
+ */
12278
+ 404: ErrorResponse;
10867
12279
  };
10868
- type ListFilesError = ListFilesErrors[keyof ListFilesErrors];
10869
- type ListFilesResponses = {
12280
+ type DownloadFileBase64Error = DownloadFileBase64Errors[keyof DownloadFileBase64Errors];
12281
+ type DownloadFileBase64Responses = {
10870
12282
  /**
10871
- * List of files returned successfully
12283
+ * File content as base64
10872
12284
  */
10873
12285
  200: {
10874
- data?: Array<FileRecord>;
10875
- total?: number;
10876
- limit?: number;
10877
- offset?: number;
10878
- };
10879
- };
10880
- type ListFilesResponse = ListFilesResponses[keyof ListFilesResponses];
10881
- type CreateFileData = {
10882
- body: {
10883
12286
  /**
10884
- * Directory within the project (e.g. /images). Optional; defaults to / (root). Combined with filename to form the file's key (path).
12287
+ * Base64-encoded file content
10885
12288
  */
10886
- prefix?: string;
12289
+ content?: string;
10887
12290
  /**
10888
- * Original / download name and the key's leaf segment (e.g. logo.png).
12291
+ * Original filename
10889
12292
  */
10890
12293
  filename?: string;
10891
12294
  /**
@@ -10896,71 +12299,67 @@ type CreateFileData = {
10896
12299
  * File size in bytes
10897
12300
  */
10898
12301
  size?: number | null;
10899
- /**
10900
- * JSON string with additional metadata
10901
- */
10902
- metadata?: string;
10903
12302
  };
12303
+ };
12304
+ type DownloadFileBase64Response = DownloadFileBase64Responses[keyof DownloadFileBase64Responses];
12305
+ type GetFileTagsData = {
12306
+ body?: never;
10904
12307
  path: {
10905
12308
  /**
10906
12309
  * Project public ID (proj_ prefix).
10907
12310
  */
10908
12311
  project_id: string;
12312
+ /**
12313
+ * File ID
12314
+ */
12315
+ file_id: string;
10909
12316
  };
10910
12317
  query?: never;
10911
- url: '/v1/projects/{project_id}/files';
12318
+ url: '/v1/projects/{project_id}/files/{file_id}/tags';
10912
12319
  };
10913
- type CreateFileErrors = {
12320
+ type GetFileTagsErrors = {
10914
12321
  /**
10915
- * Internal server error
12322
+ * Missing or invalid credentials.
10916
12323
  */
10917
- 500: ErrorResponse;
12324
+ 401: ErrorResponse;
12325
+ /**
12326
+ * The caller's role in the project does not carry this action, or the credential is scoped to a different project.
12327
+ *
12328
+ */
12329
+ 403: ErrorResponse;
12330
+ /**
12331
+ * File not found
12332
+ */
12333
+ 404: ErrorResponse;
10918
12334
  };
10919
- type CreateFileError = CreateFileErrors[keyof CreateFileErrors];
10920
- type CreateFileResponses = {
12335
+ type GetFileTagsError = GetFileTagsErrors[keyof GetFileTagsErrors];
12336
+ type GetFileTagsResponses = {
10921
12337
  /**
10922
- * File created successfully
12338
+ * File tags
10923
12339
  */
10924
- 201: FileRecord;
12340
+ 200: {
12341
+ [key: string]: string;
12342
+ };
10925
12343
  };
10926
- type CreateFileResponse = CreateFileResponses[keyof CreateFileResponses];
10927
- type UploadFileData = {
12344
+ type GetFileTagsResponse = GetFileTagsResponses[keyof GetFileTagsResponses];
12345
+ type MergeFileTagsData = {
10928
12346
  body: {
10929
- /**
10930
- * File content
10931
- */
10932
- file: Blob | File;
10933
- /**
10934
- * Project ID to associate the file with. Optional when authenticating with a project-scoped API key, which defaults to the key's project; required otherwise.
10935
- */
10936
- project_id?: string;
10937
- /**
10938
- * Directory within the project (e.g. /images). Optional; defaults to / (root).
10939
- */
10940
- prefix?: string;
10941
- /**
10942
- * Original / download name. Optional; defaults to the uploaded file's name.
10943
- */
10944
- filename?: string;
10945
- /**
10946
- * Additional metadata as a JSON string
10947
- */
10948
- metadata?: string;
12347
+ [key: string]: string;
10949
12348
  };
10950
12349
  path: {
10951
12350
  /**
10952
12351
  * Project public ID (proj_ prefix).
10953
12352
  */
10954
12353
  project_id: string;
12354
+ /**
12355
+ * File ID
12356
+ */
12357
+ file_id: string;
10955
12358
  };
10956
12359
  query?: never;
10957
- url: '/v1/projects/{project_id}/files/upload';
12360
+ url: '/v1/projects/{project_id}/files/{file_id}/tags';
10958
12361
  };
10959
- type UploadFileErrors = {
10960
- /**
10961
- * Missing file or invalid project
10962
- */
10963
- 400: ErrorResponse;
12362
+ type MergeFileTagsErrors = {
10964
12363
  /**
10965
12364
  * Missing or invalid credentials.
10966
12365
  */
@@ -10970,31 +12369,39 @@ type UploadFileErrors = {
10970
12369
  *
10971
12370
  */
10972
12371
  403: ErrorResponse;
12372
+ /**
12373
+ * File not found
12374
+ */
12375
+ 404: ErrorResponse;
10973
12376
  };
10974
- type UploadFileError = UploadFileErrors[keyof UploadFileErrors];
10975
- type UploadFileResponses = {
12377
+ type MergeFileTagsError = MergeFileTagsErrors[keyof MergeFileTagsErrors];
12378
+ type MergeFileTagsResponses = {
10976
12379
  /**
10977
- * File uploaded successfully
12380
+ * Tags merged
10978
12381
  */
10979
- 201: FileRecord;
12382
+ 200: {
12383
+ [key: string]: string;
12384
+ };
10980
12385
  };
10981
- type UploadFileResponse = UploadFileResponses[keyof UploadFileResponses];
10982
- type UploadFileBase64Data = {
10983
- body: UploadFileBase64Request;
12386
+ type MergeFileTagsResponse = MergeFileTagsResponses[keyof MergeFileTagsResponses];
12387
+ type ReplaceFileTagsData = {
12388
+ body: {
12389
+ [key: string]: string;
12390
+ };
10984
12391
  path: {
10985
12392
  /**
10986
12393
  * Project public ID (proj_ prefix).
10987
12394
  */
10988
12395
  project_id: string;
12396
+ /**
12397
+ * File ID
12398
+ */
12399
+ file_id: string;
10989
12400
  };
10990
12401
  query?: never;
10991
- url: '/v1/projects/{project_id}/files/upload/base64';
12402
+ url: '/v1/projects/{project_id}/files/{file_id}/tags';
10992
12403
  };
10993
- type UploadFileBase64Errors = {
10994
- /**
10995
- * Missing content or invalid project
10996
- */
10997
- 400: ErrorResponse;
12404
+ type ReplaceFileTagsErrors = {
10998
12405
  /**
10999
12406
  * Missing or invalid credentials.
11000
12407
  */
@@ -11004,353 +12411,370 @@ type UploadFileBase64Errors = {
11004
12411
  *
11005
12412
  */
11006
12413
  403: ErrorResponse;
12414
+ /**
12415
+ * File not found
12416
+ */
12417
+ 404: ErrorResponse;
11007
12418
  };
11008
- type UploadFileBase64Error = UploadFileBase64Errors[keyof UploadFileBase64Errors];
11009
- type UploadFileBase64Responses = {
12419
+ type ReplaceFileTagsError = ReplaceFileTagsErrors[keyof ReplaceFileTagsErrors];
12420
+ type ReplaceFileTagsResponses = {
11010
12421
  /**
11011
- * File uploaded successfully
12422
+ * Tags replaced
11012
12423
  */
11013
- 201: FileRecord;
12424
+ 200: {
12425
+ [key: string]: string;
12426
+ };
11014
12427
  };
11015
- type UploadFileBase64Response = UploadFileBase64Responses[keyof UploadFileBase64Responses];
11016
- type DeleteFileData = {
11017
- body?: never;
12428
+ type ReplaceFileTagsResponse = ReplaceFileTagsResponses[keyof ReplaceFileTagsResponses];
12429
+ type ValidateFormationData = {
12430
+ body: {
12431
+ template?: FormationTemplateInput;
12432
+ /**
12433
+ * Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in `template.parameters`. When provided, the validation result also reports required parameters that are still missing after applying these values.
12434
+ *
12435
+ */
12436
+ parameters?: {
12437
+ [key: string]: string;
12438
+ } | null;
12439
+ };
11018
12440
  path: {
11019
12441
  /**
11020
12442
  * Project public ID (proj_ prefix).
11021
12443
  */
11022
12444
  project_id: string;
11023
- /**
11024
- * ID of the file to delete
11025
- */
11026
- file_id: string;
11027
12445
  };
11028
12446
  query?: never;
11029
- url: '/v1/projects/{project_id}/files/{file_id}';
12447
+ url: '/v1/projects/{project_id}/formations/validate';
11030
12448
  };
11031
- type DeleteFileErrors = {
11032
- /**
11033
- * File not found
11034
- */
11035
- 404: ErrorResponse;
12449
+ type ValidateFormationErrors = {
11036
12450
  /**
11037
- * Internal server error
12451
+ * Unauthorized
11038
12452
  */
11039
- 500: ErrorResponse;
12453
+ 401: unknown;
11040
12454
  };
11041
- type DeleteFileError = DeleteFileErrors[keyof DeleteFileErrors];
11042
- type DeleteFileResponses = {
12455
+ type ValidateFormationResponses = {
11043
12456
  /**
11044
- * File deleted successfully
12457
+ * Validation result
11045
12458
  */
11046
- 204: void;
12459
+ 200: ValidationResult;
11047
12460
  };
11048
- type DeleteFileResponse = DeleteFileResponses[keyof DeleteFileResponses];
11049
- type GetFileData = {
11050
- body?: never;
12461
+ type ValidateFormationResponse = ValidateFormationResponses[keyof ValidateFormationResponses];
12462
+ type PlanFormationData = {
12463
+ body: {
12464
+ /**
12465
+ * Existing formation ID to compare against. Omit for new formation planning.
12466
+ */
12467
+ formation_id?: string;
12468
+ template: FormationTemplateInput;
12469
+ /**
12470
+ * Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in `template.parameters`. A parameter declared with `use_previous_value: true` may be omitted to reuse its stored value.
12471
+ *
12472
+ */
12473
+ parameters?: {
12474
+ [key: string]: string;
12475
+ } | null;
12476
+ };
11051
12477
  path: {
11052
12478
  /**
11053
12479
  * Project public ID (proj_ prefix).
11054
12480
  */
11055
12481
  project_id: string;
11056
- /**
11057
- * File ID
11058
- */
11059
- file_id: string;
11060
12482
  };
11061
12483
  query?: never;
11062
- url: '/v1/projects/{project_id}/files/{file_id}';
12484
+ url: '/v1/projects/{project_id}/formations/plan';
11063
12485
  };
11064
- type GetFileErrors = {
12486
+ type PlanFormationErrors = {
11065
12487
  /**
11066
- * File not found
12488
+ * Bad Request
11067
12489
  */
11068
- 404: ErrorResponse;
12490
+ 400: unknown;
11069
12491
  /**
11070
- * Internal server error
12492
+ * Unauthorized
11071
12493
  */
11072
- 500: ErrorResponse;
12494
+ 401: unknown;
12495
+ /**
12496
+ * Forbidden
12497
+ */
12498
+ 403: unknown;
11073
12499
  };
11074
- type GetFileError = GetFileErrors[keyof GetFileErrors];
11075
- type GetFileResponses = {
12500
+ type PlanFormationResponses = {
11076
12501
  /**
11077
- * File found
12502
+ * Plan result
11078
12503
  */
11079
- 200: FileRecord;
12504
+ 200: PlanResult;
11080
12505
  };
11081
- type GetFileResponse = GetFileResponses[keyof GetFileResponses];
11082
- type DownloadFileData = {
12506
+ type PlanFormationResponse = PlanFormationResponses[keyof PlanFormationResponses];
12507
+ type ListFormationsData = {
11083
12508
  body?: never;
11084
12509
  path: {
11085
12510
  /**
11086
12511
  * Project public ID (proj_ prefix).
11087
12512
  */
11088
12513
  project_id: string;
12514
+ };
12515
+ query?: {
11089
12516
  /**
11090
- * File ID
12517
+ * Maximum number of results to return
11091
12518
  */
11092
- file_id: string;
12519
+ limit?: number;
12520
+ /**
12521
+ * Number of results to skip
12522
+ */
12523
+ offset?: number;
11093
12524
  };
11094
- query?: never;
11095
- url: '/v1/projects/{project_id}/files/{file_id}/download';
12525
+ url: '/v1/projects/{project_id}/formations';
11096
12526
  };
11097
- type DownloadFileErrors = {
11098
- /**
11099
- * Missing or invalid credentials.
11100
- */
11101
- 401: ErrorResponse;
12527
+ type ListFormationsErrors = {
11102
12528
  /**
11103
- * The caller's role in the project does not carry this action, or the credential is scoped to a different project.
11104
- *
12529
+ * Unauthorized
11105
12530
  */
11106
- 403: ErrorResponse;
12531
+ 401: unknown;
11107
12532
  /**
11108
- * File not found
12533
+ * Forbidden
11109
12534
  */
11110
- 404: ErrorResponse;
12535
+ 403: unknown;
11111
12536
  };
11112
- type DownloadFileError = DownloadFileErrors[keyof DownloadFileErrors];
11113
- type DownloadFileResponses = {
12537
+ type ListFormationsResponses = {
11114
12538
  /**
11115
- * File content
12539
+ * List of formations
11116
12540
  */
11117
- 200: Blob | File;
12541
+ 200: {
12542
+ data: Array<Formation>;
12543
+ total: number;
12544
+ limit: number;
12545
+ offset: number;
12546
+ };
11118
12547
  };
11119
- type DownloadFileResponse = DownloadFileResponses[keyof DownloadFileResponses];
11120
- type UpdateFileMetadataData = {
12548
+ type ListFormationsResponse = ListFormationsResponses[keyof ListFormationsResponses];
12549
+ type CreateFormationData = {
11121
12550
  body: {
11122
12551
  /**
11123
- * New metadata as a JSON string
12552
+ * Human-readable name for the formation stack
11124
12553
  */
11125
- metadata?: string;
12554
+ name: string;
12555
+ template: FormationTemplateInput;
11126
12556
  /**
11127
- * New directory moves the file. The resulting path (prefix + filename) must be unique within the project.
12557
+ * Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in `template.parameters`. Required parameters (those without a default) must be provided here.
12558
+ *
11128
12559
  */
11129
- prefix?: string;
12560
+ parameters?: {
12561
+ [key: string]: string;
12562
+ } | null;
11130
12563
  /**
11131
- * New filename renames the key's leaf and the download name.
12564
+ * Static annotations stored on the formation record. This field is NOT a substitution site: `sub`/`param`/`ref` expressions are rejected with 400 (`FORMATION_INVALID_METADATA`). For deploy-time substitution use the template's top-level `metadata` block, which is resolved into `resolved_metadata`.
12565
+ *
11132
12566
  */
11133
- filename?: string;
12567
+ metadata?: {
12568
+ [key: string]: unknown;
12569
+ } | null;
11134
12570
  };
11135
12571
  path: {
11136
12572
  /**
11137
12573
  * Project public ID (proj_ prefix).
11138
12574
  */
11139
12575
  project_id: string;
11140
- /**
11141
- * File ID
11142
- */
11143
- file_id: string;
11144
12576
  };
11145
12577
  query?: never;
11146
- url: '/v1/projects/{project_id}/files/{file_id}/metadata';
12578
+ url: '/v1/projects/{project_id}/formations';
11147
12579
  };
11148
- type UpdateFileMetadataErrors = {
12580
+ type CreateFormationErrors = {
11149
12581
  /**
11150
- * Missing or invalid credentials.
12582
+ * Bad Request
11151
12583
  */
11152
- 401: ErrorResponse;
12584
+ 400: unknown;
11153
12585
  /**
11154
- * The caller's role in the project does not carry this action, or the credential is scoped to a different project.
11155
- *
12586
+ * Unauthorized
11156
12587
  */
11157
- 403: ErrorResponse;
12588
+ 401: unknown;
11158
12589
  /**
11159
- * File not found
12590
+ * Forbidden
11160
12591
  */
11161
- 404: ErrorResponse;
12592
+ 403: unknown;
11162
12593
  /**
11163
- * A file already exists at the target path in this project
12594
+ * Formation with this name already exists
11164
12595
  */
11165
- 409: ErrorResponse;
12596
+ 409: unknown;
11166
12597
  };
11167
- type UpdateFileMetadataError = UpdateFileMetadataErrors[keyof UpdateFileMetadataErrors];
11168
- type UpdateFileMetadataResponses = {
12598
+ type CreateFormationResponses = {
11169
12599
  /**
11170
- * Metadata updated successfully
12600
+ * Formation created
11171
12601
  */
11172
- 200: FileRecord;
12602
+ 201: Formation;
11173
12603
  };
11174
- type UpdateFileMetadataResponse = UpdateFileMetadataResponses[keyof UpdateFileMetadataResponses];
11175
- type DownloadFileBase64Data = {
12604
+ type CreateFormationResponse = CreateFormationResponses[keyof CreateFormationResponses];
12605
+ type DeleteFormationData = {
11176
12606
  body?: never;
11177
12607
  path: {
11178
12608
  /**
11179
12609
  * Project public ID (proj_ prefix).
11180
12610
  */
11181
12611
  project_id: string;
11182
- /**
11183
- * File ID
11184
- */
11185
- file_id: string;
12612
+ formation_id: string;
11186
12613
  };
11187
12614
  query?: never;
11188
- url: '/v1/projects/{project_id}/files/{file_id}/download/base64';
12615
+ url: '/v1/projects/{project_id}/formations/{formation_id}';
11189
12616
  };
11190
- type DownloadFileBase64Errors = {
12617
+ type DeleteFormationErrors = {
11191
12618
  /**
11192
- * Missing or invalid credentials.
12619
+ * Unauthorized
11193
12620
  */
11194
- 401: ErrorResponse;
12621
+ 401: unknown;
11195
12622
  /**
11196
- * The caller's role in the project does not carry this action, or the credential is scoped to a different project.
11197
- *
12623
+ * Forbidden
11198
12624
  */
11199
- 403: ErrorResponse;
12625
+ 403: unknown;
11200
12626
  /**
11201
- * File not found
12627
+ * Not Found
11202
12628
  */
11203
- 404: ErrorResponse;
12629
+ 404: unknown;
12630
+ /**
12631
+ * One or more resources could not be deleted (`FORMATION_DELETE_FAILED`). `error.meta.failures` lists each one as `{ logical_id, resource_type, error }`. The `message` says whether the pre-flight caught it (nothing deleted, formation still `active`) or it surfaced mid-teardown (formation left in `delete_failed`).
12632
+ *
12633
+ */
12634
+ 409: unknown;
11204
12635
  };
11205
- type DownloadFileBase64Error = DownloadFileBase64Errors[keyof DownloadFileBase64Errors];
11206
- type DownloadFileBase64Responses = {
12636
+ type DeleteFormationResponses = {
11207
12637
  /**
11208
- * File content as base64
12638
+ * Deleted
11209
12639
  */
11210
12640
  200: {
11211
- /**
11212
- * Base64-encoded file content
11213
- */
11214
- content?: string;
11215
- /**
11216
- * Original filename
11217
- */
11218
- filename?: string;
11219
- /**
11220
- * MIME type of the file
11221
- */
11222
- content_type?: string;
11223
- /**
11224
- * File size in bytes
11225
- */
11226
- size?: number | null;
12641
+ success: boolean;
11227
12642
  };
11228
12643
  };
11229
- type DownloadFileBase64Response = DownloadFileBase64Responses[keyof DownloadFileBase64Responses];
11230
- type GetFileTagsData = {
12644
+ type DeleteFormationResponse = DeleteFormationResponses[keyof DeleteFormationResponses];
12645
+ type GetFormationData = {
11231
12646
  body?: never;
11232
12647
  path: {
11233
12648
  /**
11234
12649
  * Project public ID (proj_ prefix).
11235
12650
  */
11236
12651
  project_id: string;
11237
- /**
11238
- * File ID
11239
- */
11240
- file_id: string;
12652
+ formation_id: string;
11241
12653
  };
11242
12654
  query?: never;
11243
- url: '/v1/projects/{project_id}/files/{file_id}/tags';
12655
+ url: '/v1/projects/{project_id}/formations/{formation_id}';
11244
12656
  };
11245
- type GetFileTagsErrors = {
12657
+ type GetFormationErrors = {
11246
12658
  /**
11247
- * Missing or invalid credentials.
12659
+ * Unauthorized
11248
12660
  */
11249
- 401: ErrorResponse;
12661
+ 401: unknown;
11250
12662
  /**
11251
- * The caller's role in the project does not carry this action, or the credential is scoped to a different project.
11252
- *
12663
+ * Forbidden
11253
12664
  */
11254
- 403: ErrorResponse;
12665
+ 403: unknown;
11255
12666
  /**
11256
- * File not found
12667
+ * Not Found
11257
12668
  */
11258
- 404: ErrorResponse;
12669
+ 404: unknown;
11259
12670
  };
11260
- type GetFileTagsError = GetFileTagsErrors[keyof GetFileTagsErrors];
11261
- type GetFileTagsResponses = {
12671
+ type GetFormationResponses = {
11262
12672
  /**
11263
- * File tags
12673
+ * Formation details
11264
12674
  */
11265
- 200: {
11266
- [key: string]: string;
11267
- };
12675
+ 200: Formation;
11268
12676
  };
11269
- type GetFileTagsResponse = GetFileTagsResponses[keyof GetFileTagsResponses];
11270
- type MergeFileTagsData = {
11271
- body: {
11272
- [key: string]: string;
12677
+ type GetFormationResponse = GetFormationResponses[keyof GetFormationResponses];
12678
+ type UpdateFormationData = {
12679
+ body?: {
12680
+ template?: FormationTemplateInput;
12681
+ /**
12682
+ * Runtime parameter values that override or supply template parameter defaults. Keys must match parameter names declared in `template.parameters`. Required parameters (those without a default) must be provided here, unless the parameter is declared with `use_previous_value: true`, in which case omitting it reuses the previously stored value.
12683
+ *
12684
+ */
12685
+ parameters?: {
12686
+ [key: string]: string;
12687
+ } | null;
12688
+ /**
12689
+ * Static annotations stored on the formation record. This field is NOT a substitution site: `sub`/`param`/`ref` expressions are rejected with 400 (`FORMATION_INVALID_METADATA`). For deploy-time substitution use the template's top-level `metadata` block, which is resolved into `resolved_metadata`.
12690
+ *
12691
+ */
12692
+ metadata?: {
12693
+ [key: string]: unknown;
12694
+ } | null;
11273
12695
  };
11274
12696
  path: {
11275
12697
  /**
11276
12698
  * Project public ID (proj_ prefix).
11277
12699
  */
11278
12700
  project_id: string;
11279
- /**
11280
- * File ID
11281
- */
11282
- file_id: string;
12701
+ formation_id: string;
11283
12702
  };
11284
12703
  query?: never;
11285
- url: '/v1/projects/{project_id}/files/{file_id}/tags';
12704
+ url: '/v1/projects/{project_id}/formations/{formation_id}';
11286
12705
  };
11287
- type MergeFileTagsErrors = {
12706
+ type UpdateFormationErrors = {
11288
12707
  /**
11289
- * Missing or invalid credentials.
12708
+ * Bad Request
11290
12709
  */
11291
- 401: ErrorResponse;
12710
+ 400: unknown;
11292
12711
  /**
11293
- * The caller's role in the project does not carry this action, or the credential is scoped to a different project.
11294
- *
12712
+ * Unauthorized
11295
12713
  */
11296
- 403: ErrorResponse;
12714
+ 401: unknown;
11297
12715
  /**
11298
- * File not found
12716
+ * Forbidden
11299
12717
  */
11300
- 404: ErrorResponse;
12718
+ 403: unknown;
12719
+ /**
12720
+ * Not Found
12721
+ */
12722
+ 404: unknown;
11301
12723
  };
11302
- type MergeFileTagsError = MergeFileTagsErrors[keyof MergeFileTagsErrors];
11303
- type MergeFileTagsResponses = {
12724
+ type UpdateFormationResponses = {
11304
12725
  /**
11305
- * Tags merged
12726
+ * Updated formation
11306
12727
  */
11307
- 200: {
11308
- [key: string]: string;
11309
- };
12728
+ 200: Formation;
11310
12729
  };
11311
- type MergeFileTagsResponse = MergeFileTagsResponses[keyof MergeFileTagsResponses];
11312
- type ReplaceFileTagsData = {
11313
- body: {
11314
- [key: string]: string;
11315
- };
12730
+ type UpdateFormationResponse = UpdateFormationResponses[keyof UpdateFormationResponses];
12731
+ type ListFormationEventsData = {
12732
+ body?: never;
11316
12733
  path: {
11317
12734
  /**
11318
12735
  * Project public ID (proj_ prefix).
11319
12736
  */
11320
12737
  project_id: string;
12738
+ formation_id: string;
12739
+ };
12740
+ query?: {
11321
12741
  /**
11322
- * File ID
12742
+ * Maximum number of results to return
11323
12743
  */
11324
- file_id: string;
12744
+ limit?: number;
12745
+ /**
12746
+ * Number of results to skip
12747
+ */
12748
+ offset?: number;
11325
12749
  };
11326
- query?: never;
11327
- url: '/v1/projects/{project_id}/files/{file_id}/tags';
12750
+ url: '/v1/projects/{project_id}/formations/{formation_id}/events';
11328
12751
  };
11329
- type ReplaceFileTagsErrors = {
12752
+ type ListFormationEventsErrors = {
11330
12753
  /**
11331
- * Missing or invalid credentials.
12754
+ * Unauthorized
11332
12755
  */
11333
- 401: ErrorResponse;
12756
+ 401: unknown;
11334
12757
  /**
11335
- * The caller's role in the project does not carry this action, or the credential is scoped to a different project.
11336
- *
12758
+ * Forbidden
11337
12759
  */
11338
- 403: ErrorResponse;
12760
+ 403: unknown;
11339
12761
  /**
11340
- * File not found
12762
+ * Not Found
11341
12763
  */
11342
- 404: ErrorResponse;
12764
+ 404: unknown;
11343
12765
  };
11344
- type ReplaceFileTagsError = ReplaceFileTagsErrors[keyof ReplaceFileTagsErrors];
11345
- type ReplaceFileTagsResponses = {
12766
+ type ListFormationEventsResponses = {
11346
12767
  /**
11347
- * Tags replaced
12768
+ * List of operations
11348
12769
  */
11349
12770
  200: {
11350
- [key: string]: string;
12771
+ data: Array<FormationOperation>;
12772
+ total: number;
12773
+ limit: number;
12774
+ offset: number;
11351
12775
  };
11352
12776
  };
11353
- type ReplaceFileTagsResponse = ReplaceFileTagsResponses[keyof ReplaceFileTagsResponses];
12777
+ type ListFormationEventsResponse = ListFormationEventsResponses[keyof ListFormationEventsResponses];
11354
12778
  type ListGenerationsData = {
11355
12779
  body?: never;
11356
12780
  path: {
@@ -17725,6 +19149,70 @@ declare class Files {
17725
19149
  */
17726
19150
  static replaceFileTags<ThrowOnError extends boolean = false>(options: Options<ReplaceFileTagsData, ThrowOnError>): RequestResult<ReplaceFileTagsResponses, ReplaceFileTagsErrors, ThrowOnError>;
17727
19151
  }
19152
+ declare class Formations {
19153
+ /**
19154
+ * Validate a formation template
19155
+ *
19156
+ * Validates a formation template without creating any resources. Returns a list of errors and warnings. Accepts the template as a JSON object or as a YAML/JSON string.
19157
+ *
19158
+ */
19159
+ static validateFormation<ThrowOnError extends boolean = false>(options: Options<ValidateFormationData, ThrowOnError>): RequestResult<ValidateFormationResponses, ValidateFormationErrors, ThrowOnError>;
19160
+ /**
19161
+ * Plan a formation deployment
19162
+ *
19163
+ * Computes a diff between the desired template and the current stack state without making any changes. Returns the list of planned actions.
19164
+ *
19165
+ */
19166
+ static planFormation<ThrowOnError extends boolean = false>(options: Options<PlanFormationData, ThrowOnError>): RequestResult<PlanFormationResponses, PlanFormationErrors, ThrowOnError>;
19167
+ /**
19168
+ * List formations
19169
+ *
19170
+ * Returns all formation stacks for a project
19171
+ */
19172
+ static listFormations<ThrowOnError extends boolean = false>(options: Options<ListFormationsData, ThrowOnError>): RequestResult<ListFormationsResponses, ListFormationsErrors, ThrowOnError>;
19173
+ /**
19174
+ * Create a new formation
19175
+ *
19176
+ * Validates the template, creates the formation record, then provisions all declared resources in dependency order.
19177
+ *
19178
+ * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `201` and `status: "failed"`, and `error` explains why (the resources created before the failure are rolled back). Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `builtin` CLI exits non-zero on that body so `create-formation && …` does not lie.
19179
+ *
19180
+ */
19181
+ static createFormation<ThrowOnError extends boolean = false>(options: Options<CreateFormationData, ThrowOnError>): RequestResult<CreateFormationResponses, CreateFormationErrors, ThrowOnError>;
19182
+ /**
19183
+ * Delete an formation
19184
+ *
19185
+ * Deletes the formation stack and all its managed resources in reverse dependency order.
19186
+ *
19187
+ * A resource the platform refuses to delete on its own — most often an agent that has generation or trace history — fails the teardown with `409 FORMATION_DELETE_FAILED`, naming every blocking resource in `error.meta.failures`. Resolve the blockers (for an agent, `DELETE /v1/projects/{project_id}/agents/{agent_id}?force=true` also removes its generations and traces, and `deletion_policy: retain` exempts it from teardown entirely) and delete the formation again.
19188
+ *
19189
+ * A refusal the platform can foresee is found by a pre-flight, before the first delete: nothing is removed, and the formation stays `active` and intact for the retry. An unforeseeable error surfaces mid-teardown instead, where resources deleted before the blocker stay deleted and the formation is left in `delete_failed`. The error message states which happened.
19190
+ *
19191
+ */
19192
+ static deleteFormation<ThrowOnError extends boolean = false>(options: Options<DeleteFormationData, ThrowOnError>): RequestResult<DeleteFormationResponses, DeleteFormationErrors, ThrowOnError>;
19193
+ /**
19194
+ * Get a specific formation
19195
+ *
19196
+ * Returns the formation stack including its current resources.
19197
+ */
19198
+ static getFormation<ThrowOnError extends boolean = false>(options: Options<GetFormationData, ThrowOnError>): RequestResult<GetFormationResponses, GetFormationErrors, ThrowOnError>;
19199
+ /**
19200
+ * Update an formation
19201
+ *
19202
+ * Applies a new template to the formation. Resources are created, updated, or deleted to reconcile the current state with the desired state.
19203
+ *
19204
+ * A **template-shape** error is refused with `400`. A **deploy** failure is not: the operation ran, so the formation is returned with `200` and `status: "failed"`, and `error` explains why. Read `status` — a `2xx` here means the deploy was attempted, not that it worked. The `builtin` CLI exits non-zero on that body so `update-formation && …` does not lie.
19205
+ *
19206
+ */
19207
+ static updateFormation<ThrowOnError extends boolean = false>(options: Options<UpdateFormationData, ThrowOnError>): RequestResult<UpdateFormationResponses, UpdateFormationErrors, ThrowOnError>;
19208
+ /**
19209
+ * List formation operation events
19210
+ *
19211
+ * Returns all operations (create, update, delete) with their event logs for the formation, ordered chronologically.
19212
+ *
19213
+ */
19214
+ static listFormationEvents<ThrowOnError extends boolean = false>(options: Options<ListFormationEventsData, ThrowOnError>): RequestResult<ListFormationEventsResponses, ListFormationEventsErrors, ThrowOnError>;
19215
+ }
17728
19216
  declare class Generations {
17729
19217
  /**
17730
19218
  * List generations
@@ -18688,6 +20176,7 @@ declare class NaturaliClient {
18688
20176
  readonly evaluations: typeof Evaluations;
18689
20177
  readonly exceptions: typeof Exceptions;
18690
20178
  readonly files: typeof Files;
20179
+ readonly formations: typeof Formations;
18691
20180
  readonly generations: typeof Generations;
18692
20181
  readonly guardrails: typeof Guardrails;
18693
20182
  readonly ingestionRules: typeof IngestionRules;
@@ -18713,4 +20202,4 @@ declare class NaturaliClient {
18713
20202
  constructor({ token, headers }?: NaturaliClientOptions);
18714
20203
  }
18715
20204
  //#endregion
18716
- export { type AbortAgentReleaseData, type AbortAgentReleaseError, type AbortAgentReleaseErrors, type AbortAgentReleaseResponse, type AbortAgentReleaseResponses, type AcceptedGenerationResponse, type AcknowledgeExceptionData, type AcknowledgeExceptionErrors, type AcknowledgeExceptionResponse, type AcknowledgeExceptionResponses, type Acknowledgement, Activity, type ActivityEntry, type ActorRecord, Actors, type AddConversationMessageData, type AddConversationMessageError, type AddConversationMessageErrors, type AddConversationMessageResponse, type AddConversationMessageResponses, type AddSessionMessageData, type AddSessionMessageError, type AddSessionMessageErrors, type AddSessionMessageRequest, type AddSessionMessageResponse, type AddSessionMessageResponse2, type AddSessionMessageResponses, type AddSessionMessageSaved, type Address, type AddressActionSet, type AddressList, type Agent, type AgentGenerationResponse, type AgentRelease, type AgentVersion, AgentVersions, Agents, type AggregateScores, AiProviders, type ApiKeyCreate, type ApiKeyCreated, type ApiKeyId, type ApiKeyList, type ApiKeyRecord, type ApiKeyUpdate, ApiKeys, type ApprovalId, type ApprovalItem, type ApprovalRecurrenceGroup, Approvals, type ApproveApprovalData, type ApproveApprovalErrors, type ApproveApprovalResponse, type ApproveApprovalResponses, Assistant, type AssistantChannel, type AssistantGrant, type AssistantGrantList, type AssistantLinkPreview, type AssistantLinkRedeem, type AssistantScope, type AuditEntry, AuditLog, Auth, type AuthSession, type BaselineComparison, type CallToolData, type CallToolError, type CallToolErrors, type CallToolRequest, type CallToolResponses, type CancelEvalRunData, type CancelEvalRunErrors, type CancelEvalRunResponse, type CancelEvalRunResponses, type CancelOrchestrationRunData, type CancelOrchestrationRunErrors, type CancelOrchestrationRunResponse, type CancelOrchestrationRunResponses, type Channel, type ChannelCreate, type ChannelDefaultAction, type ChannelDefaultActionInput, type ChannelId, type ChannelKind, type ChannelKindList, type ChannelList, type ChannelPredicate, type ChannelRoute, type ChannelRouteList, type ChannelRouteWrite, type ChannelSurface, type ChannelUpdate, Channels, type ClientOptions, type ContainsScorer, type Conversation, type ConversationId, type ConversationList, type ConversationMessage, type ConversationMessageList, type ConversationMessageRecord, type ConversationRecord, Conversations, type CreateActorData, type CreateActorError, type CreateActorErrors, type CreateActorResponse, type CreateActorResponses, type CreateAgentData, type CreateAgentError, type CreateAgentErrors, type CreateAgentGenerationData, type CreateAgentGenerationError, type CreateAgentGenerationErrors, type CreateAgentGenerationRequest, type CreateAgentGenerationResponse, type CreateAgentGenerationResponses, type CreateAgentRequest, type CreateAgentResponse, type CreateAgentResponses, type CreateAiProviderData, type CreateAiProviderErrors, type CreateAiProviderResponse, type CreateAiProviderResponses, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyErrors, type CreateApiKeyResponse, type CreateApiKeyResponses, type CreateChannelData, type CreateChannelError, type CreateChannelErrors, type CreateChannelResponse, type CreateChannelResponses, type CreateChannelRouteData, type CreateChannelRouteError, type CreateChannelRouteErrors, type CreateChannelRouteResponse, type CreateChannelRouteResponses, type CreateConversationData, type CreateConversationError, type CreateConversationErrors, type CreateConversationResponse, type CreateConversationResponses, type CreateDatasetData, type CreateDatasetErrors, type CreateDatasetItemData, type CreateDatasetItemErrors, type CreateDatasetItemFromGenerationData, type CreateDatasetItemFromGenerationErrors, type CreateDatasetItemFromGenerationResponse, type CreateDatasetItemFromGenerationResponses, type CreateDatasetItemResponse, type CreateDatasetItemResponses, type CreateDatasetResponse, type CreateDatasetResponses, type CreateDocumentData, type CreateDocumentError, type CreateDocumentErrors, type CreateDocumentResponse, type CreateDocumentResponses, type CreateEmbeddingsData, type CreateEmbeddingsError, type CreateEmbeddingsErrors, type CreateEmbeddingsResponse, type CreateEmbeddingsResponses, type CreateEvalData, type CreateEvalErrors, type CreateEvalResponse, type CreateEvalResponses, type CreateFileData, type CreateFileError, type CreateFileErrors, type CreateFileResponse, type CreateFileResponses, type CreateGuardrailData, type CreateGuardrailError, type CreateGuardrailErrors, type CreateGuardrailRequest, type CreateGuardrailResponse, type CreateGuardrailResponses, type CreateIngestionRuleData, type CreateIngestionRuleErrors, type CreateIngestionRuleResponse, type CreateIngestionRuleResponses, type CreateMemoryData, type CreateMemoryEntryData, type CreateMemoryEntryErrors, type CreateMemoryEntryResponse, type CreateMemoryEntryResponses, type CreateMemoryErrors, type CreateMemoryResponse, type CreateMemoryResponses, type CreateModelRouteData, type CreateModelRouteErrors, type CreateModelRouteResponse, type CreateModelRouteResponses, type CreateOrchestrationData, type CreateOrchestrationErrors, type CreateOrchestrationRequest, type CreateOrchestrationResponse, type CreateOrchestrationResponses, type CreateProjectData, type CreateProjectError, type CreateProjectErrors, type CreateProjectResponse, type CreateProjectResponses, type CreateQuotaData, type CreateQuotaErrors, type CreateQuotaResponse, type CreateQuotaResponses, type CreateSecretData, type CreateSecretErrors, type CreateSecretResponse, type CreateSecretResponses, type CreateSessionData, type CreateSessionError, type CreateSessionErrors, type CreateSessionRequest, type CreateSessionResponse, type CreateSessionResponses, type CreateTaskData, type CreateTaskErrors, type CreateTaskRequest, type CreateTaskResponse, type CreateTaskResponses, type CreateToolData, type CreateToolError, type CreateToolErrors, type CreateToolRequest, type CreateToolResponse, type CreateToolResponses, type CreateTriggerData, type CreateTriggerErrors, type CreateTriggerRequest, type CreateTriggerResponse, type CreateTriggerResponses, type CreateWebhookData, type CreateWebhookError, type CreateWebhookErrors, type CreateWebhookResponse, type CreateWebhookResponses, type CreateWorkflowData, type CreateWorkflowErrors, type CreateWorkflowRequest, type CreateWorkflowResponse, type CreateWorkflowResponses, type Cursor, type Dataset, type DatasetItem, type DatasetItemInput, type DeleteActorData, type DeleteActorError, type DeleteActorErrors, type DeleteActorResponse, type DeleteActorResponses, type DeleteAddressData, type DeleteAddressError, type DeleteAddressErrors, type DeleteAddressResponse, type DeleteAddressResponses, type DeleteAgentData, type DeleteAgentError, type DeleteAgentErrors, type DeleteAgentResponse, type DeleteAgentResponses, type DeleteAiProviderData, type DeleteAiProviderErrors, type DeleteAiProviderResponse, type DeleteAiProviderResponses, type DeleteApiKeyData, type DeleteApiKeyError, type DeleteApiKeyErrors, type DeleteApiKeyResponse, type DeleteApiKeyResponses, type DeleteChannelData, type DeleteChannelError, type DeleteChannelErrors, type DeleteChannelResponse, type DeleteChannelResponses, type DeleteChannelRouteData, type DeleteChannelRouteError, type DeleteChannelRouteErrors, type DeleteChannelRouteResponse, type DeleteChannelRouteResponses, type DeleteConversationData, type DeleteConversationError, type DeleteConversationErrors, type DeleteConversationResponse, type DeleteConversationResponses, type DeleteDatasetData, type DeleteDatasetErrors, type DeleteDatasetItemData, type DeleteDatasetItemErrors, type DeleteDatasetItemResponse, type DeleteDatasetItemResponses, type DeleteDatasetResponse, type DeleteDatasetResponses, type DeleteDocumentData, type DeleteDocumentError, type DeleteDocumentErrors, type DeleteDocumentResponse, type DeleteDocumentResponses, type DeleteEvalData, type DeleteEvalErrors, type DeleteEvalResponse, type DeleteEvalResponses, type DeleteFileData, type DeleteFileError, type DeleteFileErrors, type DeleteFileResponse, type DeleteFileResponses, type DeleteGuardrailData, type DeleteGuardrailError, type DeleteGuardrailErrors, type DeleteGuardrailResponse, type DeleteGuardrailResponses, type DeleteIngestionRuleData, type DeleteIngestionRuleErrors, type DeleteIngestionRuleResponse, type DeleteIngestionRuleResponses, type DeleteMemoryData, type DeleteMemoryEntryData, type DeleteMemoryEntryErrors, type DeleteMemoryEntryResponse, type DeleteMemoryEntryResponses, type DeleteMemoryErrors, type DeleteMemoryResponse, type DeleteMemoryResponses, type DeleteModelRouteData, type DeleteModelRouteErrors, type DeleteModelRouteResponse, type DeleteModelRouteResponses, type DeleteOrchestrationData, type DeleteOrchestrationErrors, type DeleteOrchestrationResponse, type DeleteOrchestrationResponses, type DeleteProjectData, type DeleteProjectError, type DeleteProjectErrors, type DeleteProjectResponse, type DeleteProjectResponses, type DeleteQuotaData, type DeleteQuotaErrors, type DeleteQuotaResponse, type DeleteQuotaResponses, type DeleteSecretData, type DeleteSecretErrors, type DeleteSecretResponses, type DeleteSessionData, type DeleteSessionError, type DeleteSessionErrors, type DeleteSessionResponse, type DeleteSessionResponses, type DeleteTaskData, type DeleteTaskErrors, type DeleteTaskResponse, type DeleteTaskResponses, type DeleteToolData, type DeleteToolError, type DeleteToolErrors, type DeleteToolResponse, type DeleteToolResponses, type DeleteTriggerData, type DeleteTriggerErrors, type DeleteTriggerResponse, type DeleteTriggerResponses, type DeleteWebhookData, type DeleteWebhookError, type DeleteWebhookErrors, type DeleteWebhookResponse, type DeleteWebhookResponses, type DeleteWorkflowData, type DeleteWorkflowErrors, type DeleteWorkflowResponse, type DeleteWorkflowResponses, type DeliveryId, type DiscordModes, type DocumentKnowledgeResult, type DocumentMessageContent, type DocumentRecord, type DocumentStatusRecord, Documents, type DownloadFileBase64Data, type DownloadFileBase64Error, type DownloadFileBase64Errors, type DownloadFileBase64Response, type DownloadFileBase64Responses, type DownloadFileData, type DownloadFileError, type DownloadFileErrors, type DownloadFileResponse, type DownloadFileResponses, type EmbeddingSimilarityScorer, Embeddings, type EmbeddingsResponse, type EnableManagedModelsData, type EnableManagedModelsError, type EnableManagedModelsErrors, type EnableManagedModelsResponse, type EnableManagedModelsResponses, type ErrorResponse, type Eval, type EvalResult, type EvalRun, type EvaluateGuardrailData, type EvaluateGuardrailError, type EvaluateGuardrailErrors, type EvaluateGuardrailResponse, type EvaluateGuardrailResponses, Evaluations, type Event, type EventSubscription, type EventType, type ExactMatchScorer, type ExceptionId, type ExceptionItem, Exceptions, type ExportAuditEntriesData, type ExportAuditEntriesErrors, type ExportAuditEntriesResponse, type ExportAuditEntriesResponses, type FileRecord, type FileRecordWritable, Files, type FireTriggerData, type FireTriggerErrors, type FireTriggerRequest, type FireTriggerResponse, type FireTriggerResponses, type Force, type ForkSessionData, type ForkSessionError, type ForkSessionErrors, type ForkSessionRequest, type ForkSessionResponse, type ForkSessionResponses, type GenerateConversationMessageCompleted, type GenerateConversationMessageData, type GenerateConversationMessageError, type GenerateConversationMessageErrors, type GenerateConversationMessageRequiresAction, type GenerateConversationMessageResponse, type GenerateConversationMessageResponse2, type GenerateConversationMessageResponses, type GenerateSessionRequest, type GenerateSessionResponse, type GenerateSessionResponseData, type GenerateSessionResponseError, type GenerateSessionResponseErrors, type GenerateSessionResponseResponse, type GenerateSessionResponseResponses, type Generation, type GenerationTranscript, Generations, type GetActorData, type GetActorError, type GetActorErrors, type GetActorResponse, type GetActorResponses, type GetActorTagsData, type GetActorTagsError, type GetActorTagsErrors, type GetActorTagsResponse, type GetActorTagsResponses, type GetAddressData, type GetAddressError, type GetAddressErrors, type GetAddressResponse, type GetAddressResponses, type GetAgentData, type GetAgentError, type GetAgentErrors, type GetAgentResponse, type GetAgentResponses, type GetAgentVersionData, type GetAgentVersionError, type GetAgentVersionErrors, type GetAgentVersionResponse, type GetAgentVersionResponses, type GetAiProviderData, type GetAiProviderErrors, type GetAiProviderPricesData, type GetAiProviderPricesErrors, type GetAiProviderPricesResponse, type GetAiProviderPricesResponses, type GetAiProviderResponse, type GetAiProviderResponses, type GetApiKeyData, type GetApiKeyError, type GetApiKeyErrors, type GetApiKeyResponse, type GetApiKeyResponses, type GetApprovalData, type GetApprovalErrors, type GetApprovalResponse, type GetApprovalResponses, type GetAuditEntryData, type GetAuditEntryErrors, type GetAuditEntryResponse, type GetAuditEntryResponses, type GetChannelConversationData, type GetChannelConversationError, type GetChannelConversationErrors, type GetChannelConversationResponse, type GetChannelConversationResponses, type GetChannelData, type GetChannelError, type GetChannelErrors, type GetChannelResponse, type GetChannelResponses, type GetChannelRouteData, type GetChannelRouteError, type GetChannelRouteErrors, type GetChannelRouteResponse, type GetChannelRouteResponses, type GetConversationData, type GetConversationError, type GetConversationErrors, type GetConversationResponse, type GetConversationResponses, type GetConversationTagsData, type GetConversationTagsError, type GetConversationTagsErrors, type GetConversationTagsResponse, type GetConversationTagsResponses, type GetCurrentUserData, type GetCurrentUserError, type GetCurrentUserErrors, type GetCurrentUserResponse, type GetCurrentUserResponses, type GetDatasetData, type GetDatasetErrors, type GetDatasetResponse, type GetDatasetResponses, type GetDocumentData, type GetDocumentError, type GetDocumentErrors, type GetDocumentResponse, type GetDocumentResponses, type GetDocumentStatusData, type GetDocumentStatusError, type GetDocumentStatusErrors, type GetDocumentStatusResponse, type GetDocumentStatusResponses, type GetDocumentTagsData, type GetDocumentTagsError, type GetDocumentTagsErrors, type GetDocumentTagsResponse, type GetDocumentTagsResponses, type GetEvalData, type GetEvalErrors, type GetEvalResponse, type GetEvalResponses, type GetEvalRunData, type GetEvalRunErrors, type GetEvalRunResponse, type GetEvalRunResponses, type GetExceptionData, type GetExceptionErrors, type GetExceptionResponse, type GetExceptionResponses, type GetFileData, type GetFileError, type GetFileErrors, type GetFileResponse, type GetFileResponses, type GetFileTagsData, type GetFileTagsError, type GetFileTagsErrors, type GetFileTagsResponse, type GetFileTagsResponses, type GetGenerationData, type GetGenerationError, type GetGenerationErrors, type GetGenerationResponse, type GetGenerationResponses, type GetGenerationTranscriptData, type GetGenerationTranscriptError, type GetGenerationTranscriptErrors, type GetGenerationTranscriptResponse, type GetGenerationTranscriptResponses, type GetGuardrailData, type GetGuardrailError, type GetGuardrailErrors, type GetGuardrailResponse, type GetGuardrailResponses, type GetGuardrailVersionData, type GetGuardrailVersionError, type GetGuardrailVersionErrors, type GetGuardrailVersionResponse, type GetGuardrailVersionResponses, type GetIngestionRuleData, type GetIngestionRuleErrors, type GetIngestionRuleResponse, type GetIngestionRuleResponses, type GetMemoryData, type GetMemoryEntryData, type GetMemoryEntryErrors, type GetMemoryEntryResponse, type GetMemoryEntryResponses, type GetMemoryErrors, type GetMemoryResponse, type GetMemoryResponses, type GetModelData, type GetModelError, type GetModelErrors, type GetModelResponse, type GetModelResponses, type GetModelRouteData, type GetModelRouteErrors, type GetModelRouteResponse, type GetModelRouteResponses, type GetOrchestrationData, type GetOrchestrationErrors, type GetOrchestrationResponse, type GetOrchestrationResponses, type GetOrchestrationRunData, type GetOrchestrationRunErrors, type GetOrchestrationRunResponse, type GetOrchestrationRunResponses, type GetOrchestrationVersionData, type GetOrchestrationVersionErrors, type GetOrchestrationVersionResponse, type GetOrchestrationVersionResponses, type GetProjectData, type GetProjectError, type GetProjectErrors, type GetProjectResponse, type GetProjectResponses, type GetProjectUsageData, type GetProjectUsageError, type GetProjectUsageErrors, type GetProjectUsageResponse, type GetProjectUsageResponses, type GetQueueStatsData, type GetQueueStatsErrors, type GetQueueStatsResponse, type GetQueueStatsResponses, type GetQuotaData, type GetQuotaErrors, type GetQuotaResponse, type GetQuotaResponses, type GetSecretData, type GetSecretErrors, type GetSecretResponse, type GetSecretResponses, type GetSessionData, type GetSessionError, type GetSessionErrors, type GetSessionResponse, type GetSessionResponses, type GetSessionTagsData, type GetSessionTagsError, type GetSessionTagsErrors, type GetSessionTagsResponse, type GetSessionTagsResponses, type GetTaskData, type GetTaskErrors, type GetTaskHistoryData, type GetTaskHistoryErrors, type GetTaskHistoryResponse, type GetTaskHistoryResponses, type GetTaskResponse, type GetTaskResponses, type GetToolData, type GetToolError, type GetToolErrors, type GetToolResponse, type GetToolResponses, type GetTraceData, type GetTraceError, type GetTraceErrors, type GetTraceResponse, type GetTraceResponses, type GetTraceTreeData, type GetTraceTreeError, type GetTraceTreeErrors, type GetTraceTreeResponse, type GetTraceTreeResponses, type GetTriggerData, type GetTriggerErrors, type GetTriggerFiringData, type GetTriggerFiringErrors, type GetTriggerFiringResponse, type GetTriggerFiringResponses, type GetTriggerResponse, type GetTriggerResponses, type GetTriggerSecretData, type GetTriggerSecretErrors, type GetTriggerSecretResponse, type GetTriggerSecretResponses, type GetWebhookData, type GetWebhookDeliveryData, type GetWebhookDeliveryError, type GetWebhookDeliveryErrors, type GetWebhookDeliveryResponse, type GetWebhookDeliveryResponses, type GetWebhookError, type GetWebhookErrors, type GetWebhookResponse, type GetWebhookResponses, type GetWorkflowData, type GetWorkflowErrors, type GetWorkflowResponse, type GetWorkflowResponses, type GetWorkflowVersionData, type GetWorkflowVersionErrors, type GetWorkflowVersionResponse, type GetWorkflowVersionResponses, type GrantId, type Guardrail, type GuardrailDocument, type GuardrailEvaluation, type GuardrailVersion, Guardrails, type HumanInputRequest, type IdempotencyKey, type Identifier, type IngestDocumentData, type IngestDocumentError, type IngestDocumentErrors, type IngestDocumentResponse, type IngestDocumentResponses, type IngestedDocumentRecord, type IngestionRule, IngestionRules, type JsonLogicScorer, Knowledge, type KnowledgeResult, type Limit, type LinkToken, type ListActivityData, type ListActivityErrors, type ListActivityResponse, type ListActivityResponses, type ListActorsData, type ListActorsError, type ListActorsErrors, type ListActorsResponse, type ListActorsResponses, type ListAddressConversationsData, type ListAddressConversationsError, type ListAddressConversationsErrors, type ListAddressConversationsResponse, type ListAddressConversationsResponses, type ListAddressesData, type ListAddressesError, type ListAddressesErrors, type ListAddressesResponse, type ListAddressesResponses, type ListAgentVersionsData, type ListAgentVersionsError, type ListAgentVersionsErrors, type ListAgentVersionsResponse, type ListAgentVersionsResponses, type ListAgentsData, type ListAgentsError, type ListAgentsErrors, type ListAgentsResponse, type ListAgentsResponses, type ListAiProviderModelsData, type ListAiProviderModelsErrors, type ListAiProviderModelsResponse, type ListAiProviderModelsResponses, type ListAiProvidersData, type ListAiProvidersErrors, type ListAiProvidersResponse, type ListAiProvidersResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListApprovalRecurrencesData, type ListApprovalRecurrencesErrors, type ListApprovalRecurrencesResponse, type ListApprovalRecurrencesResponses, type ListApprovalsData, type ListApprovalsErrors, type ListApprovalsResponse, type ListApprovalsResponses, type ListAssistantGrantsData, type ListAssistantGrantsError, type ListAssistantGrantsErrors, type ListAssistantGrantsResponse, type ListAssistantGrantsResponses, type ListAuditEntriesData, type ListAuditEntriesErrors, type ListAuditEntriesResponse, type ListAuditEntriesResponses, type ListChannelConversationMessagesData, type ListChannelConversationMessagesError, type ListChannelConversationMessagesErrors, type ListChannelConversationMessagesResponse, type ListChannelConversationMessagesResponses, type ListChannelConversationsData, type ListChannelConversationsError, type ListChannelConversationsErrors, type ListChannelConversationsResponse, type ListChannelConversationsResponses, type ListChannelKindsData, type ListChannelKindsError, type ListChannelKindsErrors, type ListChannelKindsResponse, type ListChannelKindsResponses, type ListChannelRoutesData, type ListChannelRoutesError, type ListChannelRoutesErrors, type ListChannelRoutesResponse, type ListChannelRoutesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListConversationMessagesData, type ListConversationMessagesError, type ListConversationMessagesErrors, type ListConversationMessagesResponse, type ListConversationMessagesResponses, type ListConversationsData, type ListConversationsError, type ListConversationsErrors, type ListConversationsResponse, type ListConversationsResponses, type ListDatasetItemsData, type ListDatasetItemsErrors, type ListDatasetItemsResponse, type ListDatasetItemsResponses, type ListDatasetsData, type ListDatasetsErrors, type ListDatasetsResponse, type ListDatasetsResponses, type ListDocumentsData, type ListDocumentsError, type ListDocumentsErrors, type ListDocumentsResponse, type ListDocumentsResponses, type ListEvalResultsData, type ListEvalResultsErrors, type ListEvalResultsResponse, type ListEvalResultsResponses, type ListEvalRunsData, type ListEvalRunsErrors, type ListEvalRunsResponse, type ListEvalRunsResponses, type ListEvalsData, type ListEvalsErrors, type ListEvalsResponse, type ListEvalsResponses, type ListExceptionsData, type ListExceptionsErrors, type ListExceptionsResponse, type ListExceptionsResponses, type ListFilesData, type ListFilesError, type ListFilesErrors, type ListFilesResponse, type ListFilesResponses, type ListGenerationsData, type ListGenerationsError, type ListGenerationsErrors, type ListGenerationsResponse, type ListGenerationsResponses, type ListGuardrailVersionsData, type ListGuardrailVersionsError, type ListGuardrailVersionsErrors, type ListGuardrailVersionsResponse, type ListGuardrailVersionsResponses, type ListGuardrailsData, type ListGuardrailsError, type ListGuardrailsErrors, type ListGuardrailsResponse, type ListGuardrailsResponses, type ListIngestionRulesData, type ListIngestionRulesErrors, type ListIngestionRulesResponse, type ListIngestionRulesResponses, type ListMemoriesData, type ListMemoriesErrors, type ListMemoriesResponse, type ListMemoriesResponses, type ListMemoryEntriesData, type ListMemoryEntriesErrors, type ListMemoryEntriesResponse, type ListMemoryEntriesResponses, type ListModelRoutesData, type ListModelRoutesErrors, type ListModelRoutesResponse, type ListModelRoutesResponses, type ListModelsData, type ListModelsError, type ListModelsErrors, type ListModelsResponse, type ListModelsResponses, type ListOrchestrationRunsData, type ListOrchestrationRunsErrors, type ListOrchestrationRunsResponse, type ListOrchestrationRunsResponses, type ListOrchestrationVersionsData, type ListOrchestrationVersionsErrors, type ListOrchestrationVersionsResponse, type ListOrchestrationVersionsResponses, type ListOrchestrationsData, type ListOrchestrationsErrors, type ListOrchestrationsResponse, type ListOrchestrationsResponses, type ListProjectChannelRoutesData, type ListProjectChannelRoutesError, type ListProjectChannelRoutesErrors, type ListProjectChannelRoutesResponse, type ListProjectChannelRoutesResponses, type ListProjectMembersData, type ListProjectMembersError, type ListProjectMembersErrors, type ListProjectMembersResponse, type ListProjectMembersResponses, type ListProjectsData, type ListProjectsError, type ListProjectsErrors, type ListProjectsResponse, type ListProjectsResponses, type ListQuotasData, type ListQuotasErrors, type ListQuotasResponse, type ListQuotasResponses, type ListSecretsData, type ListSecretsErrors, type ListSecretsResponse, type ListSecretsResponses, type ListSessionForksData, type ListSessionForksError, type ListSessionForksErrors, type ListSessionForksResponse, type ListSessionForksResponses, type ListSessionsData, type ListSessionsError, type ListSessionsErrors, type ListSessionsResponse, type ListSessionsResponses, type ListTasksData, type ListTasksErrors, type ListTasksResponse, type ListTasksResponses, type ListToolsData, type ListToolsError, type ListToolsErrors, type ListToolsResponse, type ListToolsResponses, type ListTracesData, type ListTracesError, type ListTracesErrors, type ListTracesResponse, type ListTracesResponses, type ListTriggerFiringsData, type ListTriggerFiringsErrors, type ListTriggerFiringsResponse, type ListTriggerFiringsResponses, type ListTriggersData, type ListTriggersErrors, type ListTriggersResponse, type ListTriggersResponses, type ListWebhookDeliveriesData, type ListWebhookDeliveriesError, type ListWebhookDeliveriesErrors, type ListWebhookDeliveriesResponse, type ListWebhookDeliveriesResponses, type ListWebhooksData, type ListWebhooksError, type ListWebhooksErrors, type ListWebhooksResponse, type ListWebhooksResponses, type ListWorkflowVersionsData, type ListWorkflowVersionsErrors, type ListWorkflowVersionsResponse, type ListWorkflowVersionsResponses, type ListWorkflowsData, type ListWorkflowsErrors, type ListWorkflowsResponse, type ListWorkflowsResponses, type LlmJudgeScorer, type LogoutData, type LogoutError, type LogoutErrors, type LogoutRequest, type LogoutResponse, type LogoutResponses, type ManagedProvider, Memories, type Memory, MemoryEntries, type MemoryEntry, type MemoryEntryWriteResult, type MemoryKnowledgeResult, type MergeActorTagsData, type MergeActorTagsError, type MergeActorTagsErrors, type MergeActorTagsResponse, type MergeActorTagsResponses, type MergeConversationTagsData, type MergeConversationTagsError, type MergeConversationTagsErrors, type MergeConversationTagsResponse, type MergeConversationTagsResponses, type MergeDocumentTagsData, type MergeDocumentTagsError, type MergeDocumentTagsErrors, type MergeDocumentTagsResponse, type MergeDocumentTagsResponses, type MergeFileTagsData, type MergeFileTagsError, type MergeFileTagsErrors, type MergeFileTagsResponse, type MergeFileTagsResponses, type MergeSessionTagsData, type MergeSessionTagsError, type MergeSessionTagsErrors, type MergeSessionTagsResponse, type MergeSessionTagsResponses, type MessagesLimit, type Model, type ModelId, type ModelList, type ModelRoute, type ModelRouteTarget, ModelRoutes, Models, NaturaliClient, type NaturaliClientOptions, type NodeExecution, type Offset, type OpenChannelConversationData, type OpenChannelConversationError, type OpenChannelConversationErrors, type OpenChannelConversationResponse, type OpenChannelConversationResponses, type Options, type Orchestration, type OrchestrationEdge, type OrchestrationId, type OrchestrationNode, type OrchestrationRun, type OrchestrationRunId, type OrchestrationVersion, Orchestrations, type OutputSchemaScorer, type PatchAgentData, type PatchAgentError, type PatchAgentErrors, type PatchAgentResponse, type PatchAgentResponses, type PreviewAssistantLinkData, type PreviewAssistantLinkError, type PreviewAssistantLinkErrors, type PreviewAssistantLinkResponse, type PreviewAssistantLinkResponses, type Project, type ProjectCreate, type ProjectId, type ProjectList, type ProjectMember, type ProjectMemberList, type ProjectRole, type ProjectUpdate, type ProjectUsage, Projects, type PromoteAgentReleaseData, type PromoteAgentReleaseError, type PromoteAgentReleaseErrors, type PromoteAgentReleaseResponse, type PromoteAgentReleaseResponses, type ProviderModelsResponse, type ProviderPrice, type ProviderPricesResponse, type PurgeGenerationContentData, type PurgeGenerationContentError, type PurgeGenerationContentErrors, type PurgeGenerationContentResponse, type PurgeGenerationContentResponses, type PurgeTraceContentData, type PurgeTraceContentError, type PurgeTraceContentErrors, type PurgeTraceContentResponse, type PurgeTraceContentResponses, type QueueStats, type Quota, Quotas, type RedeemAssistantLinkData, type RedeemAssistantLinkError, type RedeemAssistantLinkErrors, type RedeemAssistantLinkResponse, type RedeemAssistantLinkResponses, type RedeliverWebhookDeliveryData, type RedeliverWebhookDeliveryError, type RedeliverWebhookDeliveryErrors, type RedeliverWebhookDeliveryResponse, type RedeliverWebhookDeliveryResponses, type RefreshRequest, type RefreshSessionData, type RefreshSessionError, type RefreshSessionErrors, type RefreshSessionResponse, type RefreshSessionResponses, type ReingestDocumentData, type ReingestDocumentError, type ReingestDocumentErrors, type ReingestDocumentResponse, type ReingestDocumentResponses, type RejectApprovalData, type RejectApprovalErrors, type RejectApprovalResponse, type RejectApprovalResponses, type RemoveConversationMessageData, type RemoveConversationMessageError, type RemoveConversationMessageErrors, type RemoveConversationMessageResponse, type RemoveConversationMessageResponses, type ReplaceActorTagsData, type ReplaceActorTagsError, type ReplaceActorTagsErrors, type ReplaceActorTagsResponse, type ReplaceActorTagsResponses, type ReplaceConversationTagsData, type ReplaceConversationTagsError, type ReplaceConversationTagsErrors, type ReplaceConversationTagsResponse, type ReplaceConversationTagsResponses, type ReplaceDocumentTagsData, type ReplaceDocumentTagsError, type ReplaceDocumentTagsErrors, type ReplaceDocumentTagsResponse, type ReplaceDocumentTagsResponses, type ReplaceFileTagsData, type ReplaceFileTagsError, type ReplaceFileTagsErrors, type ReplaceFileTagsResponse, type ReplaceFileTagsResponses, type ReplaceSessionTagsData, type ReplaceSessionTagsError, type ReplaceSessionTagsErrors, type ReplaceSessionTagsResponse, type ReplaceSessionTagsResponses, type RequestSignInCodeData, type RequestSignInCodeError, type RequestSignInCodeErrors, type RequestSignInCodeResponse, type RequestSignInCodeResponses, type RequiredAction, type ResolveExceptionData, type ResolveExceptionErrors, type ResolveExceptionResponse, type ResolveExceptionResponses, type RestoreAgentVersionData, type RestoreAgentVersionError, type RestoreAgentVersionErrors, type RestoreAgentVersionRequest, type RestoreAgentVersionResponse, type RestoreAgentVersionResponses, type RestoreGuardrailVersionData, type RestoreGuardrailVersionError, type RestoreGuardrailVersionErrors, type RestoreGuardrailVersionRequest, type RestoreGuardrailVersionResponse, type RestoreGuardrailVersionResponses, type RestoreOrchestrationVersionData, type RestoreOrchestrationVersionErrors, type RestoreOrchestrationVersionRequest, type RestoreOrchestrationVersionResponse, type RestoreOrchestrationVersionResponses, type RestoreWorkflowVersionData, type RestoreWorkflowVersionErrors, type RestoreWorkflowVersionRequest, type RestoreWorkflowVersionResponse, type RestoreWorkflowVersionResponses, type ResumeOrchestrationRunData, type ResumeOrchestrationRunErrors, type ResumeOrchestrationRunResponse, type ResumeOrchestrationRunResponses, type RevokeAssistantGrantData, type RevokeAssistantGrantError, type RevokeAssistantGrantErrors, type RevokeAssistantGrantResponse, type RevokeAssistantGrantResponses, type RotateApiKeyData, type RotateApiKeyError, type RotateApiKeyErrors, type RotateApiKeyResponse, type RotateApiKeyResponses, type RotateTriggerSecretData, type RotateTriggerSecretErrors, type RotateTriggerSecretResponse, type RotateTriggerSecretResponses, type RotateWebhookSecretData, type RotateWebhookSecretError, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RouteId, type RunUsageTotals, type ScorerResult, type Scorers, type SearchKnowledgeData, type SearchKnowledgeError, type SearchKnowledgeErrors, type SearchKnowledgeResponse, type SearchKnowledgeResponses, Secrets, type SendSessionMessageResponse, type SessionId, type SessionRecord, Sessions, type SetAddressActionData, type SetAddressActionError, type SetAddressActionErrors, type SetAddressActionResponse, type SetAddressActionResponses, type SetAgentReleaseData, type SetAgentReleaseError, type SetAgentReleaseErrors, type SetAgentReleaseRequest, type SetAgentReleaseResponse, type SetAgentReleaseResponses, type SignInCodeRequest, type SignInCodeVerify, type StartEvalRunData, type StartEvalRunErrors, type StartEvalRunResponse, type StartEvalRunResponses, type StartOrchestrationRunData, type StartOrchestrationRunErrors, type StartOrchestrationRunResponse, type StartOrchestrationRunResponses, type StartRunRequest, type SubmitAgentToolOutputsData, type SubmitAgentToolOutputsError, type SubmitAgentToolOutputsErrors, type SubmitAgentToolOutputsResponse, type SubmitAgentToolOutputsResponses, type SubmitHumanInputData, type SubmitHumanInputErrors, type SubmitHumanInputResponse, type SubmitHumanInputResponses, type SubmitSessionToolOutputsData, type SubmitSessionToolOutputsError, type SubmitSessionToolOutputsErrors, type SubmitSessionToolOutputsRequest, type SubmitSessionToolOutputsResponse, type SubmitSessionToolOutputsResponses, type SubmitToolOutputsRequest, type Task, type TaskTransition, Tasks, type Tool, type ToolBinding, type ToolOutputMessageContent, type ToolScorer, Tools, type Trace, type TraceTreeNode, Traces, type TranscriptStep, type TranscriptToolCall, type TranscriptToolResult, type TranscriptUsage, type TransitionTaskData, type TransitionTaskErrors, type TransitionTaskRequest, type TransitionTaskResponse, type TransitionTaskResponses, type Trigger, type TriggerFiring, type TriggerFiringListResponse, type TriggerSecretResponse, type TriggerWithSecret, Triggers, type UpdateActorData, type UpdateActorError, type UpdateActorErrors, type UpdateActorResponse, type UpdateActorResponses, type UpdateAgentData, type UpdateAgentError, type UpdateAgentErrors, type UpdateAgentRequest, type UpdateAgentResponse, type UpdateAgentResponses, type UpdateAiProviderData, type UpdateAiProviderErrors, type UpdateAiProviderPricesData, type UpdateAiProviderPricesErrors, type UpdateAiProviderPricesResponse, type UpdateAiProviderPricesResponses, type UpdateAiProviderResponses, type UpdateApiKeyData, type UpdateApiKeyError, type UpdateApiKeyErrors, type UpdateApiKeyResponse, type UpdateApiKeyResponses, type UpdateChannelData, type UpdateChannelError, type UpdateChannelErrors, type UpdateChannelResponse, type UpdateChannelResponses, type UpdateChannelRouteData, type UpdateChannelRouteError, type UpdateChannelRouteErrors, type UpdateChannelRouteResponse, type UpdateChannelRouteResponses, type UpdateConversationData, type UpdateConversationError, type UpdateConversationErrors, type UpdateConversationResponse, type UpdateConversationResponses, type UpdateCurrentUserData, type UpdateCurrentUserError, type UpdateCurrentUserErrors, type UpdateCurrentUserResponse, type UpdateCurrentUserResponses, type UpdateDatasetData, type UpdateDatasetErrors, type UpdateDatasetItemData, type UpdateDatasetItemErrors, type UpdateDatasetItemResponse, type UpdateDatasetItemResponses, type UpdateDatasetResponse, type UpdateDatasetResponses, type UpdateDocumentData, type UpdateDocumentError, type UpdateDocumentErrors, type UpdateDocumentResponse, type UpdateDocumentResponses, type UpdateEvalData, type UpdateEvalErrors, type UpdateEvalResponse, type UpdateEvalResponses, type UpdateFileMetadataData, type UpdateFileMetadataError, type UpdateFileMetadataErrors, type UpdateFileMetadataResponse, type UpdateFileMetadataResponses, type UpdateGenerationData, type UpdateGenerationError, type UpdateGenerationErrors, type UpdateGenerationRequest, type UpdateGenerationResponse, type UpdateGenerationResponses, type UpdateGuardrailData, type UpdateGuardrailError, type UpdateGuardrailErrors, type UpdateGuardrailRequest, type UpdateGuardrailResponse, type UpdateGuardrailResponses, type UpdateIngestionRuleData, type UpdateIngestionRuleErrors, type UpdateIngestionRuleResponse, type UpdateIngestionRuleResponses, type UpdateMemoryData, type UpdateMemoryEntryData, type UpdateMemoryEntryErrors, type UpdateMemoryEntryResponse, type UpdateMemoryEntryResponses, type UpdateMemoryErrors, type UpdateMemoryResponse, type UpdateMemoryResponses, type UpdateModelRouteData, type UpdateModelRouteErrors, type UpdateModelRouteResponse, type UpdateModelRouteResponses, type UpdateOrchestrationData, type UpdateOrchestrationErrors, type UpdateOrchestrationRequest, type UpdateOrchestrationResponse, type UpdateOrchestrationResponses, type UpdateProjectData, type UpdateProjectError, type UpdateProjectErrors, type UpdateProjectResponse, type UpdateProjectResponses, type UpdateQuotaData, type UpdateQuotaErrors, type UpdateQuotaResponse, type UpdateQuotaResponses, type UpdateSecretData, type UpdateSecretErrors, type UpdateSecretResponses, type UpdateSessionData, type UpdateSessionError, type UpdateSessionErrors, type UpdateSessionRequest, type UpdateSessionResponse, type UpdateSessionResponses, type UpdateTaskData, type UpdateTaskErrors, type UpdateTaskRequest, type UpdateTaskResponse, type UpdateTaskResponses, type UpdateToolData, type UpdateToolError, type UpdateToolErrors, type UpdateToolRequest, type UpdateToolResponse, type UpdateToolResponses, type UpdateTriggerData, type UpdateTriggerErrors, type UpdateTriggerRequest, type UpdateTriggerResponse, type UpdateTriggerResponses, type UpdateWebhookData, type UpdateWebhookError, type UpdateWebhookErrors, type UpdateWebhookResponse, type UpdateWebhookResponses, type UpdateWorkflowData, type UpdateWorkflowErrors, type UpdateWorkflowRequest, type UpdateWorkflowResponse, type UpdateWorkflowResponses, type UploadFileBase64Data, type UploadFileBase64Error, type UploadFileBase64Errors, type UploadFileBase64Request, type UploadFileBase64Response, type UploadFileBase64Responses, type UploadFileData, type UploadFileError, type UploadFileErrors, type UploadFileResponse, type UploadFileResponses, type UpsertProviderPricesRequest, type UsageComponent, type UsageComponents, type UsageGroup, type UsageTokens, type User, type UserUpdate, Users, type ValidateOrchestrationData, type ValidateOrchestrationErrors, type ValidateOrchestrationRequest, type ValidateOrchestrationResponse, type ValidateOrchestrationResponses, type ValidationError, type ValidationResult, type VerifySignInCodeData, type VerifySignInCodeError, type VerifySignInCodeErrors, type VerifySignInCodeResponse, type VerifySignInCodeResponses, type Webhook, type WebhookCreate, type WebhookDelivery, type WebhookDeliveryList, type WebhookId, type WebhookList, type WebhookUpdate, type WebhookWithSecret, Webhooks, type Workflow, type WorkflowState, type WorkflowTransition, type WorkflowVersion, Workflows, createClient, createConfig };
20205
+ export { type AbortAgentReleaseData, type AbortAgentReleaseError, type AbortAgentReleaseErrors, type AbortAgentReleaseResponse, type AbortAgentReleaseResponses, type AcceptedGenerationResponse, type AcknowledgeExceptionData, type AcknowledgeExceptionErrors, type AcknowledgeExceptionResponse, type AcknowledgeExceptionResponses, type Acknowledgement, Activity, type ActivityEntry, type ActorRecord, type ActorResourceProperties, Actors, type AddConversationMessageData, type AddConversationMessageError, type AddConversationMessageErrors, type AddConversationMessageResponse, type AddConversationMessageResponses, type AddSessionMessageData, type AddSessionMessageError, type AddSessionMessageErrors, type AddSessionMessageRequest, type AddSessionMessageResponse, type AddSessionMessageResponse2, type AddSessionMessageResponses, type AddSessionMessageSaved, type Address, type AddressActionSet, type AddressList, type Agent, type AgentGenerationResponse, type AgentRelease, type AgentResourceProperties, type AgentVersion, AgentVersions, Agents, type AggregateScores, type AiProviderResourceProperties, AiProviders, type ApiKeyCreate, type ApiKeyCreated, type ApiKeyId, type ApiKeyList, type ApiKeyRecord, type ApiKeyUpdate, ApiKeys, type ApprovalId, type ApprovalItem, type ApprovalRecurrenceGroup, Approvals, type ApproveApprovalData, type ApproveApprovalErrors, type ApproveApprovalResponse, type ApproveApprovalResponses, Assistant, type AssistantChannel, type AssistantGrant, type AssistantGrantList, type AssistantLinkPreview, type AssistantLinkRedeem, type AssistantScope, type AuditEntry, AuditLog, Auth, type AuthSession, type BaselineComparison, type CallToolData, type CallToolError, type CallToolErrors, type CallToolRequest, type CallToolResponses, type CancelEvalRunData, type CancelEvalRunErrors, type CancelEvalRunResponse, type CancelEvalRunResponses, type CancelOrchestrationRunData, type CancelOrchestrationRunErrors, type CancelOrchestrationRunResponse, type CancelOrchestrationRunResponses, type Channel, type ChannelCreate, type ChannelDefaultAction, type ChannelDefaultActionInput, type ChannelId, type ChannelKind, type ChannelKindList, type ChannelList, type ChannelPredicate, type ChannelRoute, type ChannelRouteList, type ChannelRouteWrite, type ChannelSurface, type ChannelUpdate, Channels, type ClientOptions, type ContainsScorer, type Conversation, type ConversationId, type ConversationList, type ConversationMessage, type ConversationMessageList, type ConversationMessageRecord, type ConversationRecord, type ConversationResourceProperties, Conversations, type CreateActorData, type CreateActorError, type CreateActorErrors, type CreateActorResponse, type CreateActorResponses, type CreateAgentData, type CreateAgentError, type CreateAgentErrors, type CreateAgentGenerationData, type CreateAgentGenerationError, type CreateAgentGenerationErrors, type CreateAgentGenerationRequest, type CreateAgentGenerationResponse, type CreateAgentGenerationResponses, type CreateAgentRequest, type CreateAgentResponse, type CreateAgentResponses, type CreateAiProviderData, type CreateAiProviderErrors, type CreateAiProviderResponse, type CreateAiProviderResponses, type CreateApiKeyData, type CreateApiKeyError, type CreateApiKeyErrors, type CreateApiKeyResponse, type CreateApiKeyResponses, type CreateChannelData, type CreateChannelError, type CreateChannelErrors, type CreateChannelResponse, type CreateChannelResponses, type CreateChannelRouteData, type CreateChannelRouteError, type CreateChannelRouteErrors, type CreateChannelRouteResponse, type CreateChannelRouteResponses, type CreateConversationData, type CreateConversationError, type CreateConversationErrors, type CreateConversationResponse, type CreateConversationResponses, type CreateDatasetData, type CreateDatasetErrors, type CreateDatasetItemData, type CreateDatasetItemErrors, type CreateDatasetItemFromGenerationData, type CreateDatasetItemFromGenerationErrors, type CreateDatasetItemFromGenerationResponse, type CreateDatasetItemFromGenerationResponses, type CreateDatasetItemResponse, type CreateDatasetItemResponses, type CreateDatasetResponse, type CreateDatasetResponses, type CreateDocumentData, type CreateDocumentError, type CreateDocumentErrors, type CreateDocumentResponse, type CreateDocumentResponses, type CreateEmbeddingsData, type CreateEmbeddingsError, type CreateEmbeddingsErrors, type CreateEmbeddingsResponse, type CreateEmbeddingsResponses, type CreateEvalData, type CreateEvalErrors, type CreateEvalResponse, type CreateEvalResponses, type CreateFileData, type CreateFileError, type CreateFileErrors, type CreateFileResponse, type CreateFileResponses, type CreateFormationData, type CreateFormationErrors, type CreateFormationResponse, type CreateFormationResponses, type CreateGuardrailData, type CreateGuardrailError, type CreateGuardrailErrors, type CreateGuardrailRequest, type CreateGuardrailResponse, type CreateGuardrailResponses, type CreateIngestionRuleData, type CreateIngestionRuleErrors, type CreateIngestionRuleResponse, type CreateIngestionRuleResponses, type CreateMemoryData, type CreateMemoryEntryData, type CreateMemoryEntryErrors, type CreateMemoryEntryResponse, type CreateMemoryEntryResponses, type CreateMemoryErrors, type CreateMemoryResponse, type CreateMemoryResponses, type CreateModelRouteData, type CreateModelRouteErrors, type CreateModelRouteResponse, type CreateModelRouteResponses, type CreateOrchestrationData, type CreateOrchestrationErrors, type CreateOrchestrationRequest, type CreateOrchestrationResponse, type CreateOrchestrationResponses, type CreateProjectData, type CreateProjectError, type CreateProjectErrors, type CreateProjectResponse, type CreateProjectResponses, type CreateQuotaData, type CreateQuotaErrors, type CreateQuotaResponse, type CreateQuotaResponses, type CreateSecretData, type CreateSecretErrors, type CreateSecretResponse, type CreateSecretResponses, type CreateSessionData, type CreateSessionError, type CreateSessionErrors, type CreateSessionRequest, type CreateSessionResponse, type CreateSessionResponses, type CreateTaskData, type CreateTaskErrors, type CreateTaskRequest, type CreateTaskResponse, type CreateTaskResponses, type CreateToolData, type CreateToolError, type CreateToolErrors, type CreateToolRequest, type CreateToolResponse, type CreateToolResponses, type CreateTriggerData, type CreateTriggerErrors, type CreateTriggerRequest, type CreateTriggerResponse, type CreateTriggerResponses, type CreateWebhookData, type CreateWebhookError, type CreateWebhookErrors, type CreateWebhookResponse, type CreateWebhookResponses, type CreateWorkflowData, type CreateWorkflowErrors, type CreateWorkflowRequest, type CreateWorkflowResponse, type CreateWorkflowResponses, type Cursor, type Dataset, type DatasetItem, type DatasetItemInput, type DatasetItemResourceProperties, type DatasetResourceProperties, type DeleteActorData, type DeleteActorError, type DeleteActorErrors, type DeleteActorResponse, type DeleteActorResponses, type DeleteAddressData, type DeleteAddressError, type DeleteAddressErrors, type DeleteAddressResponse, type DeleteAddressResponses, type DeleteAgentData, type DeleteAgentError, type DeleteAgentErrors, type DeleteAgentResponse, type DeleteAgentResponses, type DeleteAiProviderData, type DeleteAiProviderErrors, type DeleteAiProviderResponse, type DeleteAiProviderResponses, type DeleteApiKeyData, type DeleteApiKeyError, type DeleteApiKeyErrors, type DeleteApiKeyResponse, type DeleteApiKeyResponses, type DeleteChannelData, type DeleteChannelError, type DeleteChannelErrors, type DeleteChannelResponse, type DeleteChannelResponses, type DeleteChannelRouteData, type DeleteChannelRouteError, type DeleteChannelRouteErrors, type DeleteChannelRouteResponse, type DeleteChannelRouteResponses, type DeleteConversationData, type DeleteConversationError, type DeleteConversationErrors, type DeleteConversationResponse, type DeleteConversationResponses, type DeleteDatasetData, type DeleteDatasetErrors, type DeleteDatasetItemData, type DeleteDatasetItemErrors, type DeleteDatasetItemResponse, type DeleteDatasetItemResponses, type DeleteDatasetResponse, type DeleteDatasetResponses, type DeleteDocumentData, type DeleteDocumentError, type DeleteDocumentErrors, type DeleteDocumentResponse, type DeleteDocumentResponses, type DeleteEvalData, type DeleteEvalErrors, type DeleteEvalResponse, type DeleteEvalResponses, type DeleteFileData, type DeleteFileError, type DeleteFileErrors, type DeleteFileResponse, type DeleteFileResponses, type DeleteFormationData, type DeleteFormationErrors, type DeleteFormationResponse, type DeleteFormationResponses, type DeleteGuardrailData, type DeleteGuardrailError, type DeleteGuardrailErrors, type DeleteGuardrailResponse, type DeleteGuardrailResponses, type DeleteIngestionRuleData, type DeleteIngestionRuleErrors, type DeleteIngestionRuleResponse, type DeleteIngestionRuleResponses, type DeleteMemoryData, type DeleteMemoryEntryData, type DeleteMemoryEntryErrors, type DeleteMemoryEntryResponse, type DeleteMemoryEntryResponses, type DeleteMemoryErrors, type DeleteMemoryResponse, type DeleteMemoryResponses, type DeleteModelRouteData, type DeleteModelRouteErrors, type DeleteModelRouteResponse, type DeleteModelRouteResponses, type DeleteOrchestrationData, type DeleteOrchestrationErrors, type DeleteOrchestrationResponse, type DeleteOrchestrationResponses, type DeleteProjectData, type DeleteProjectError, type DeleteProjectErrors, type DeleteProjectResponse, type DeleteProjectResponses, type DeleteQuotaData, type DeleteQuotaErrors, type DeleteQuotaResponse, type DeleteQuotaResponses, type DeleteSecretData, type DeleteSecretErrors, type DeleteSecretResponses, type DeleteSessionData, type DeleteSessionError, type DeleteSessionErrors, type DeleteSessionResponse, type DeleteSessionResponses, type DeleteTaskData, type DeleteTaskErrors, type DeleteTaskResponse, type DeleteTaskResponses, type DeleteToolData, type DeleteToolError, type DeleteToolErrors, type DeleteToolResponse, type DeleteToolResponses, type DeleteTriggerData, type DeleteTriggerErrors, type DeleteTriggerResponse, type DeleteTriggerResponses, type DeleteWebhookData, type DeleteWebhookError, type DeleteWebhookErrors, type DeleteWebhookResponse, type DeleteWebhookResponses, type DeleteWorkflowData, type DeleteWorkflowErrors, type DeleteWorkflowResponse, type DeleteWorkflowResponses, type DeliveryId, type DiscordModes, type DocumentKnowledgeResult, type DocumentMessageContent, type DocumentRecord, type DocumentResourceProperties, type DocumentStatusRecord, Documents, type DownloadFileBase64Data, type DownloadFileBase64Error, type DownloadFileBase64Errors, type DownloadFileBase64Response, type DownloadFileBase64Responses, type DownloadFileData, type DownloadFileError, type DownloadFileErrors, type DownloadFileResponse, type DownloadFileResponses, type EmbeddingSimilarityScorer, Embeddings, type EmbeddingsResponse, type EnableManagedModelsData, type EnableManagedModelsError, type EnableManagedModelsErrors, type EnableManagedModelsResponse, type EnableManagedModelsResponses, type ErrorResponse, type Eval, type EvalResourceProperties, type EvalResult, type EvalRun, type EvaluateGuardrailData, type EvaluateGuardrailError, type EvaluateGuardrailErrors, type EvaluateGuardrailResponse, type EvaluateGuardrailResponses, Evaluations, type Event, type EventSubscription, type EventType, type ExactMatchScorer, type ExceptionId, type ExceptionItem, Exceptions, type ExportAuditEntriesData, type ExportAuditEntriesErrors, type ExportAuditEntriesResponse, type ExportAuditEntriesResponses, type FileRecord, type FileRecordWritable, type FileResourceProperties, Files, type FireTriggerData, type FireTriggerErrors, type FireTriggerRequest, type FireTriggerResponse, type FireTriggerResponses, type Force, type ForkSessionData, type ForkSessionError, type ForkSessionErrors, type ForkSessionRequest, type ForkSessionResponse, type ForkSessionResponses, type Formation, type FormationError, type FormationEvent, type FormationOperation, type FormationResource, type FormationTemplate, type FormationTemplateInput, Formations, type GenerateConversationMessageCompleted, type GenerateConversationMessageData, type GenerateConversationMessageError, type GenerateConversationMessageErrors, type GenerateConversationMessageRequiresAction, type GenerateConversationMessageResponse, type GenerateConversationMessageResponse2, type GenerateConversationMessageResponses, type GenerateSessionRequest, type GenerateSessionResponse, type GenerateSessionResponseData, type GenerateSessionResponseError, type GenerateSessionResponseErrors, type GenerateSessionResponseResponse, type GenerateSessionResponseResponses, type Generation, type GenerationTranscript, Generations, type GetActorData, type GetActorError, type GetActorErrors, type GetActorResponse, type GetActorResponses, type GetActorTagsData, type GetActorTagsError, type GetActorTagsErrors, type GetActorTagsResponse, type GetActorTagsResponses, type GetAddressData, type GetAddressError, type GetAddressErrors, type GetAddressResponse, type GetAddressResponses, type GetAgentData, type GetAgentError, type GetAgentErrors, type GetAgentResponse, type GetAgentResponses, type GetAgentVersionData, type GetAgentVersionError, type GetAgentVersionErrors, type GetAgentVersionResponse, type GetAgentVersionResponses, type GetAiProviderData, type GetAiProviderErrors, type GetAiProviderPricesData, type GetAiProviderPricesErrors, type GetAiProviderPricesResponse, type GetAiProviderPricesResponses, type GetAiProviderResponse, type GetAiProviderResponses, type GetApiKeyData, type GetApiKeyError, type GetApiKeyErrors, type GetApiKeyResponse, type GetApiKeyResponses, type GetApprovalData, type GetApprovalErrors, type GetApprovalResponse, type GetApprovalResponses, type GetAuditEntryData, type GetAuditEntryErrors, type GetAuditEntryResponse, type GetAuditEntryResponses, type GetChannelConversationData, type GetChannelConversationError, type GetChannelConversationErrors, type GetChannelConversationResponse, type GetChannelConversationResponses, type GetChannelData, type GetChannelError, type GetChannelErrors, type GetChannelResponse, type GetChannelResponses, type GetChannelRouteData, type GetChannelRouteError, type GetChannelRouteErrors, type GetChannelRouteResponse, type GetChannelRouteResponses, type GetConversationData, type GetConversationError, type GetConversationErrors, type GetConversationResponse, type GetConversationResponses, type GetConversationTagsData, type GetConversationTagsError, type GetConversationTagsErrors, type GetConversationTagsResponse, type GetConversationTagsResponses, type GetCurrentUserData, type GetCurrentUserError, type GetCurrentUserErrors, type GetCurrentUserResponse, type GetCurrentUserResponses, type GetDatasetData, type GetDatasetErrors, type GetDatasetResponse, type GetDatasetResponses, type GetDocumentData, type GetDocumentError, type GetDocumentErrors, type GetDocumentResponse, type GetDocumentResponses, type GetDocumentStatusData, type GetDocumentStatusError, type GetDocumentStatusErrors, type GetDocumentStatusResponse, type GetDocumentStatusResponses, type GetDocumentTagsData, type GetDocumentTagsError, type GetDocumentTagsErrors, type GetDocumentTagsResponse, type GetDocumentTagsResponses, type GetEvalData, type GetEvalErrors, type GetEvalResponse, type GetEvalResponses, type GetEvalRunData, type GetEvalRunErrors, type GetEvalRunResponse, type GetEvalRunResponses, type GetExceptionData, type GetExceptionErrors, type GetExceptionResponse, type GetExceptionResponses, type GetFileData, type GetFileError, type GetFileErrors, type GetFileResponse, type GetFileResponses, type GetFileTagsData, type GetFileTagsError, type GetFileTagsErrors, type GetFileTagsResponse, type GetFileTagsResponses, type GetFormationData, type GetFormationErrors, type GetFormationResponse, type GetFormationResponses, type GetGenerationData, type GetGenerationError, type GetGenerationErrors, type GetGenerationResponse, type GetGenerationResponses, type GetGenerationTranscriptData, type GetGenerationTranscriptError, type GetGenerationTranscriptErrors, type GetGenerationTranscriptResponse, type GetGenerationTranscriptResponses, type GetGuardrailData, type GetGuardrailError, type GetGuardrailErrors, type GetGuardrailResponse, type GetGuardrailResponses, type GetGuardrailVersionData, type GetGuardrailVersionError, type GetGuardrailVersionErrors, type GetGuardrailVersionResponse, type GetGuardrailVersionResponses, type GetIngestionRuleData, type GetIngestionRuleErrors, type GetIngestionRuleResponse, type GetIngestionRuleResponses, type GetMemoryData, type GetMemoryEntryData, type GetMemoryEntryErrors, type GetMemoryEntryResponse, type GetMemoryEntryResponses, type GetMemoryErrors, type GetMemoryResponse, type GetMemoryResponses, type GetModelData, type GetModelError, type GetModelErrors, type GetModelResponse, type GetModelResponses, type GetModelRouteData, type GetModelRouteErrors, type GetModelRouteResponse, type GetModelRouteResponses, type GetOrchestrationData, type GetOrchestrationErrors, type GetOrchestrationResponse, type GetOrchestrationResponses, type GetOrchestrationRunData, type GetOrchestrationRunErrors, type GetOrchestrationRunResponse, type GetOrchestrationRunResponses, type GetOrchestrationVersionData, type GetOrchestrationVersionErrors, type GetOrchestrationVersionResponse, type GetOrchestrationVersionResponses, type GetProjectData, type GetProjectError, type GetProjectErrors, type GetProjectResponse, type GetProjectResponses, type GetProjectUsageData, type GetProjectUsageError, type GetProjectUsageErrors, type GetProjectUsageResponse, type GetProjectUsageResponses, type GetQueueStatsData, type GetQueueStatsErrors, type GetQueueStatsResponse, type GetQueueStatsResponses, type GetQuotaData, type GetQuotaErrors, type GetQuotaResponse, type GetQuotaResponses, type GetSecretData, type GetSecretErrors, type GetSecretResponse, type GetSecretResponses, type GetSessionData, type GetSessionError, type GetSessionErrors, type GetSessionResponse, type GetSessionResponses, type GetSessionTagsData, type GetSessionTagsError, type GetSessionTagsErrors, type GetSessionTagsResponse, type GetSessionTagsResponses, type GetTaskData, type GetTaskErrors, type GetTaskHistoryData, type GetTaskHistoryErrors, type GetTaskHistoryResponse, type GetTaskHistoryResponses, type GetTaskResponse, type GetTaskResponses, type GetToolData, type GetToolError, type GetToolErrors, type GetToolResponse, type GetToolResponses, type GetTraceData, type GetTraceError, type GetTraceErrors, type GetTraceResponse, type GetTraceResponses, type GetTraceTreeData, type GetTraceTreeError, type GetTraceTreeErrors, type GetTraceTreeResponse, type GetTraceTreeResponses, type GetTriggerData, type GetTriggerErrors, type GetTriggerFiringData, type GetTriggerFiringErrors, type GetTriggerFiringResponse, type GetTriggerFiringResponses, type GetTriggerResponse, type GetTriggerResponses, type GetTriggerSecretData, type GetTriggerSecretErrors, type GetTriggerSecretResponse, type GetTriggerSecretResponses, type GetWebhookData, type GetWebhookDeliveryData, type GetWebhookDeliveryError, type GetWebhookDeliveryErrors, type GetWebhookDeliveryResponse, type GetWebhookDeliveryResponses, type GetWebhookError, type GetWebhookErrors, type GetWebhookResponse, type GetWebhookResponses, type GetWorkflowData, type GetWorkflowErrors, type GetWorkflowResponse, type GetWorkflowResponses, type GetWorkflowVersionData, type GetWorkflowVersionErrors, type GetWorkflowVersionResponse, type GetWorkflowVersionResponses, type GrantId, type Guardrail, type GuardrailDocument, type GuardrailEvaluation, type GuardrailResourceProperties, type GuardrailVersion, Guardrails, type HumanInputRequest, type IdempotencyKey, type Identifier, type IngestDocumentData, type IngestDocumentError, type IngestDocumentErrors, type IngestDocumentResponse, type IngestDocumentResponses, type IngestedDocumentRecord, type IngestionRule, type IngestionRuleResourceProperties, IngestionRules, type JsonLogicScorer, Knowledge, type KnowledgeResult, type Limit, type LinkToken, type ListActivityData, type ListActivityErrors, type ListActivityResponse, type ListActivityResponses, type ListActorsData, type ListActorsError, type ListActorsErrors, type ListActorsResponse, type ListActorsResponses, type ListAddressConversationsData, type ListAddressConversationsError, type ListAddressConversationsErrors, type ListAddressConversationsResponse, type ListAddressConversationsResponses, type ListAddressesData, type ListAddressesError, type ListAddressesErrors, type ListAddressesResponse, type ListAddressesResponses, type ListAgentVersionsData, type ListAgentVersionsError, type ListAgentVersionsErrors, type ListAgentVersionsResponse, type ListAgentVersionsResponses, type ListAgentsData, type ListAgentsError, type ListAgentsErrors, type ListAgentsResponse, type ListAgentsResponses, type ListAiProviderModelsData, type ListAiProviderModelsErrors, type ListAiProviderModelsResponse, type ListAiProviderModelsResponses, type ListAiProvidersData, type ListAiProvidersErrors, type ListAiProvidersResponse, type ListAiProvidersResponses, type ListApiKeysData, type ListApiKeysError, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListApprovalRecurrencesData, type ListApprovalRecurrencesErrors, type ListApprovalRecurrencesResponse, type ListApprovalRecurrencesResponses, type ListApprovalsData, type ListApprovalsErrors, type ListApprovalsResponse, type ListApprovalsResponses, type ListAssistantGrantsData, type ListAssistantGrantsError, type ListAssistantGrantsErrors, type ListAssistantGrantsResponse, type ListAssistantGrantsResponses, type ListAuditEntriesData, type ListAuditEntriesErrors, type ListAuditEntriesResponse, type ListAuditEntriesResponses, type ListChannelConversationMessagesData, type ListChannelConversationMessagesError, type ListChannelConversationMessagesErrors, type ListChannelConversationMessagesResponse, type ListChannelConversationMessagesResponses, type ListChannelConversationsData, type ListChannelConversationsError, type ListChannelConversationsErrors, type ListChannelConversationsResponse, type ListChannelConversationsResponses, type ListChannelKindsData, type ListChannelKindsError, type ListChannelKindsErrors, type ListChannelKindsResponse, type ListChannelKindsResponses, type ListChannelRoutesData, type ListChannelRoutesError, type ListChannelRoutesErrors, type ListChannelRoutesResponse, type ListChannelRoutesResponses, type ListChannelsData, type ListChannelsError, type ListChannelsErrors, type ListChannelsResponse, type ListChannelsResponses, type ListConversationMessagesData, type ListConversationMessagesError, type ListConversationMessagesErrors, type ListConversationMessagesResponse, type ListConversationMessagesResponses, type ListConversationsData, type ListConversationsError, type ListConversationsErrors, type ListConversationsResponse, type ListConversationsResponses, type ListDatasetItemsData, type ListDatasetItemsErrors, type ListDatasetItemsResponse, type ListDatasetItemsResponses, type ListDatasetsData, type ListDatasetsErrors, type ListDatasetsResponse, type ListDatasetsResponses, type ListDocumentsData, type ListDocumentsError, type ListDocumentsErrors, type ListDocumentsResponse, type ListDocumentsResponses, type ListEvalResultsData, type ListEvalResultsErrors, type ListEvalResultsResponse, type ListEvalResultsResponses, type ListEvalRunsData, type ListEvalRunsErrors, type ListEvalRunsResponse, type ListEvalRunsResponses, type ListEvalsData, type ListEvalsErrors, type ListEvalsResponse, type ListEvalsResponses, type ListExceptionsData, type ListExceptionsErrors, type ListExceptionsResponse, type ListExceptionsResponses, type ListFilesData, type ListFilesError, type ListFilesErrors, type ListFilesResponse, type ListFilesResponses, type ListFormationEventsData, type ListFormationEventsErrors, type ListFormationEventsResponse, type ListFormationEventsResponses, type ListFormationsData, type ListFormationsErrors, type ListFormationsResponse, type ListFormationsResponses, type ListGenerationsData, type ListGenerationsError, type ListGenerationsErrors, type ListGenerationsResponse, type ListGenerationsResponses, type ListGuardrailVersionsData, type ListGuardrailVersionsError, type ListGuardrailVersionsErrors, type ListGuardrailVersionsResponse, type ListGuardrailVersionsResponses, type ListGuardrailsData, type ListGuardrailsError, type ListGuardrailsErrors, type ListGuardrailsResponse, type ListGuardrailsResponses, type ListIngestionRulesData, type ListIngestionRulesErrors, type ListIngestionRulesResponse, type ListIngestionRulesResponses, type ListMemoriesData, type ListMemoriesErrors, type ListMemoriesResponse, type ListMemoriesResponses, type ListMemoryEntriesData, type ListMemoryEntriesErrors, type ListMemoryEntriesResponse, type ListMemoryEntriesResponses, type ListModelRoutesData, type ListModelRoutesErrors, type ListModelRoutesResponse, type ListModelRoutesResponses, type ListModelsData, type ListModelsError, type ListModelsErrors, type ListModelsResponse, type ListModelsResponses, type ListOrchestrationRunsData, type ListOrchestrationRunsErrors, type ListOrchestrationRunsResponse, type ListOrchestrationRunsResponses, type ListOrchestrationVersionsData, type ListOrchestrationVersionsErrors, type ListOrchestrationVersionsResponse, type ListOrchestrationVersionsResponses, type ListOrchestrationsData, type ListOrchestrationsErrors, type ListOrchestrationsResponse, type ListOrchestrationsResponses, type ListProjectChannelRoutesData, type ListProjectChannelRoutesError, type ListProjectChannelRoutesErrors, type ListProjectChannelRoutesResponse, type ListProjectChannelRoutesResponses, type ListProjectMembersData, type ListProjectMembersError, type ListProjectMembersErrors, type ListProjectMembersResponse, type ListProjectMembersResponses, type ListProjectsData, type ListProjectsError, type ListProjectsErrors, type ListProjectsResponse, type ListProjectsResponses, type ListQuotasData, type ListQuotasErrors, type ListQuotasResponse, type ListQuotasResponses, type ListSecretsData, type ListSecretsErrors, type ListSecretsResponse, type ListSecretsResponses, type ListSessionForksData, type ListSessionForksError, type ListSessionForksErrors, type ListSessionForksResponse, type ListSessionForksResponses, type ListSessionsData, type ListSessionsError, type ListSessionsErrors, type ListSessionsResponse, type ListSessionsResponses, type ListTasksData, type ListTasksErrors, type ListTasksResponse, type ListTasksResponses, type ListToolsData, type ListToolsError, type ListToolsErrors, type ListToolsResponse, type ListToolsResponses, type ListTracesData, type ListTracesError, type ListTracesErrors, type ListTracesResponse, type ListTracesResponses, type ListTriggerFiringsData, type ListTriggerFiringsErrors, type ListTriggerFiringsResponse, type ListTriggerFiringsResponses, type ListTriggersData, type ListTriggersErrors, type ListTriggersResponse, type ListTriggersResponses, type ListWebhookDeliveriesData, type ListWebhookDeliveriesError, type ListWebhookDeliveriesErrors, type ListWebhookDeliveriesResponse, type ListWebhookDeliveriesResponses, type ListWebhooksData, type ListWebhooksError, type ListWebhooksErrors, type ListWebhooksResponse, type ListWebhooksResponses, type ListWorkflowVersionsData, type ListWorkflowVersionsErrors, type ListWorkflowVersionsResponse, type ListWorkflowVersionsResponses, type ListWorkflowsData, type ListWorkflowsErrors, type ListWorkflowsResponse, type ListWorkflowsResponses, type LlmJudgeScorer, type LogoutData, type LogoutError, type LogoutErrors, type LogoutRequest, type LogoutResponse, type LogoutResponses, type ManagedProvider, Memories, type Memory, MemoryEntries, type MemoryEntry, type MemoryEntryResourceProperties, type MemoryEntryWriteResult, type MemoryKnowledgeResult, type MemoryResourceProperties, type MergeActorTagsData, type MergeActorTagsError, type MergeActorTagsErrors, type MergeActorTagsResponse, type MergeActorTagsResponses, type MergeConversationTagsData, type MergeConversationTagsError, type MergeConversationTagsErrors, type MergeConversationTagsResponse, type MergeConversationTagsResponses, type MergeDocumentTagsData, type MergeDocumentTagsError, type MergeDocumentTagsErrors, type MergeDocumentTagsResponse, type MergeDocumentTagsResponses, type MergeFileTagsData, type MergeFileTagsError, type MergeFileTagsErrors, type MergeFileTagsResponse, type MergeFileTagsResponses, type MergeSessionTagsData, type MergeSessionTagsError, type MergeSessionTagsErrors, type MergeSessionTagsResponse, type MergeSessionTagsResponses, type MessagesLimit, type Model, type ModelId, type ModelList, type ModelRoute, type ModelRouteResourceProperties, type ModelRouteTarget, ModelRoutes, Models, NaturaliClient, type NaturaliClientOptions, type NodeExecution, type Offset, type OpenChannelConversationData, type OpenChannelConversationError, type OpenChannelConversationErrors, type OpenChannelConversationResponse, type OpenChannelConversationResponses, type Options, type Orchestration, type OrchestrationEdge, type OrchestrationId, type OrchestrationNode, type OrchestrationResourceProperties, type OrchestrationRun, type OrchestrationRunId, type OrchestrationVersion, Orchestrations, type OutputSchemaScorer, type ParameterDeclaration, type PatchAgentData, type PatchAgentError, type PatchAgentErrors, type PatchAgentResponse, type PatchAgentResponses, type PlanChange, type PlanFormationData, type PlanFormationErrors, type PlanFormationResponse, type PlanFormationResponses, type PlanResult, type PreviewAssistantLinkData, type PreviewAssistantLinkError, type PreviewAssistantLinkErrors, type PreviewAssistantLinkResponse, type PreviewAssistantLinkResponses, type Project, type ProjectCreate, type ProjectId, type ProjectList, type ProjectMember, type ProjectMemberList, type ProjectRole, type ProjectUpdate, type ProjectUsage, Projects, type PromoteAgentReleaseData, type PromoteAgentReleaseError, type PromoteAgentReleaseErrors, type PromoteAgentReleaseResponse, type PromoteAgentReleaseResponses, type ProviderModelsResponse, type ProviderPrice, type ProviderPricesResponse, type PurgeGenerationContentData, type PurgeGenerationContentError, type PurgeGenerationContentErrors, type PurgeGenerationContentResponse, type PurgeGenerationContentResponses, type PurgeTraceContentData, type PurgeTraceContentError, type PurgeTraceContentErrors, type PurgeTraceContentResponse, type PurgeTraceContentResponses, type QueueStats, type Quota, type QuotaResourceProperties, Quotas, type RedeemAssistantLinkData, type RedeemAssistantLinkError, type RedeemAssistantLinkErrors, type RedeemAssistantLinkResponse, type RedeemAssistantLinkResponses, type RedeliverWebhookDeliveryData, type RedeliverWebhookDeliveryError, type RedeliverWebhookDeliveryErrors, type RedeliverWebhookDeliveryResponse, type RedeliverWebhookDeliveryResponses, type RefreshRequest, type RefreshSessionData, type RefreshSessionError, type RefreshSessionErrors, type RefreshSessionResponse, type RefreshSessionResponses, type ReingestDocumentData, type ReingestDocumentError, type ReingestDocumentErrors, type ReingestDocumentResponse, type ReingestDocumentResponses, type RejectApprovalData, type RejectApprovalErrors, type RejectApprovalResponse, type RejectApprovalResponses, type RemoveConversationMessageData, type RemoveConversationMessageError, type RemoveConversationMessageErrors, type RemoveConversationMessageResponse, type RemoveConversationMessageResponses, type ReplaceActorTagsData, type ReplaceActorTagsError, type ReplaceActorTagsErrors, type ReplaceActorTagsResponse, type ReplaceActorTagsResponses, type ReplaceConversationTagsData, type ReplaceConversationTagsError, type ReplaceConversationTagsErrors, type ReplaceConversationTagsResponse, type ReplaceConversationTagsResponses, type ReplaceDocumentTagsData, type ReplaceDocumentTagsError, type ReplaceDocumentTagsErrors, type ReplaceDocumentTagsResponse, type ReplaceDocumentTagsResponses, type ReplaceFileTagsData, type ReplaceFileTagsError, type ReplaceFileTagsErrors, type ReplaceFileTagsResponse, type ReplaceFileTagsResponses, type ReplaceSessionTagsData, type ReplaceSessionTagsError, type ReplaceSessionTagsErrors, type ReplaceSessionTagsResponse, type ReplaceSessionTagsResponses, type RequestSignInCodeData, type RequestSignInCodeError, type RequestSignInCodeErrors, type RequestSignInCodeResponse, type RequestSignInCodeResponses, type RequiredAction, type ResolveExceptionData, type ResolveExceptionErrors, type ResolveExceptionResponse, type ResolveExceptionResponses, type ResourceDeclaration, type RestoreAgentVersionData, type RestoreAgentVersionError, type RestoreAgentVersionErrors, type RestoreAgentVersionRequest, type RestoreAgentVersionResponse, type RestoreAgentVersionResponses, type RestoreGuardrailVersionData, type RestoreGuardrailVersionError, type RestoreGuardrailVersionErrors, type RestoreGuardrailVersionRequest, type RestoreGuardrailVersionResponse, type RestoreGuardrailVersionResponses, type RestoreOrchestrationVersionData, type RestoreOrchestrationVersionErrors, type RestoreOrchestrationVersionRequest, type RestoreOrchestrationVersionResponse, type RestoreOrchestrationVersionResponses, type RestoreWorkflowVersionData, type RestoreWorkflowVersionErrors, type RestoreWorkflowVersionRequest, type RestoreWorkflowVersionResponse, type RestoreWorkflowVersionResponses, type ResumeOrchestrationRunData, type ResumeOrchestrationRunErrors, type ResumeOrchestrationRunResponse, type ResumeOrchestrationRunResponses, type RevokeAssistantGrantData, type RevokeAssistantGrantError, type RevokeAssistantGrantErrors, type RevokeAssistantGrantResponse, type RevokeAssistantGrantResponses, type RotateApiKeyData, type RotateApiKeyError, type RotateApiKeyErrors, type RotateApiKeyResponse, type RotateApiKeyResponses, type RotateTriggerSecretData, type RotateTriggerSecretErrors, type RotateTriggerSecretResponse, type RotateTriggerSecretResponses, type RotateWebhookSecretData, type RotateWebhookSecretError, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RouteId, type RunUsageTotals, type ScorerResult, type Scorers, type SearchKnowledgeData, type SearchKnowledgeError, type SearchKnowledgeErrors, type SearchKnowledgeResponse, type SearchKnowledgeResponses, type SecretResourceProperties, Secrets, type SendSessionMessageResponse, type SessionId, type SessionRecord, type SessionResourceProperties, Sessions, type SetAddressActionData, type SetAddressActionError, type SetAddressActionErrors, type SetAddressActionResponse, type SetAddressActionResponses, type SetAgentReleaseData, type SetAgentReleaseError, type SetAgentReleaseErrors, type SetAgentReleaseRequest, type SetAgentReleaseResponse, type SetAgentReleaseResponses, type SignInCodeRequest, type SignInCodeVerify, type StartEvalRunData, type StartEvalRunErrors, type StartEvalRunResponse, type StartEvalRunResponses, type StartOrchestrationRunData, type StartOrchestrationRunErrors, type StartOrchestrationRunResponse, type StartOrchestrationRunResponses, type StartRunRequest, type SubmitAgentToolOutputsData, type SubmitAgentToolOutputsError, type SubmitAgentToolOutputsErrors, type SubmitAgentToolOutputsResponse, type SubmitAgentToolOutputsResponses, type SubmitHumanInputData, type SubmitHumanInputErrors, type SubmitHumanInputResponse, type SubmitHumanInputResponses, type SubmitSessionToolOutputsData, type SubmitSessionToolOutputsError, type SubmitSessionToolOutputsErrors, type SubmitSessionToolOutputsRequest, type SubmitSessionToolOutputsResponse, type SubmitSessionToolOutputsResponses, type SubmitToolOutputsRequest, type Task, type TaskTransition, Tasks, type Tool, type ToolBinding, type ToolOutputMessageContent, type ToolResourceProperties, type ToolScorer, Tools, type Trace, type TraceTreeNode, Traces, type TranscriptStep, type TranscriptToolCall, type TranscriptToolResult, type TranscriptUsage, type TransitionTaskData, type TransitionTaskErrors, type TransitionTaskRequest, type TransitionTaskResponse, type TransitionTaskResponses, type Trigger, type TriggerFiring, type TriggerFiringListResponse, type TriggerResourceProperties, type TriggerSecretResponse, type TriggerWithSecret, Triggers, type UpdateActorData, type UpdateActorError, type UpdateActorErrors, type UpdateActorResponse, type UpdateActorResponses, type UpdateAgentData, type UpdateAgentError, type UpdateAgentErrors, type UpdateAgentRequest, type UpdateAgentResponse, type UpdateAgentResponses, type UpdateAiProviderData, type UpdateAiProviderErrors, type UpdateAiProviderPricesData, type UpdateAiProviderPricesErrors, type UpdateAiProviderPricesResponse, type UpdateAiProviderPricesResponses, type UpdateAiProviderResponses, type UpdateApiKeyData, type UpdateApiKeyError, type UpdateApiKeyErrors, type UpdateApiKeyResponse, type UpdateApiKeyResponses, type UpdateChannelData, type UpdateChannelError, type UpdateChannelErrors, type UpdateChannelResponse, type UpdateChannelResponses, type UpdateChannelRouteData, type UpdateChannelRouteError, type UpdateChannelRouteErrors, type UpdateChannelRouteResponse, type UpdateChannelRouteResponses, type UpdateConversationData, type UpdateConversationError, type UpdateConversationErrors, type UpdateConversationResponse, type UpdateConversationResponses, type UpdateCurrentUserData, type UpdateCurrentUserError, type UpdateCurrentUserErrors, type UpdateCurrentUserResponse, type UpdateCurrentUserResponses, type UpdateDatasetData, type UpdateDatasetErrors, type UpdateDatasetItemData, type UpdateDatasetItemErrors, type UpdateDatasetItemResponse, type UpdateDatasetItemResponses, type UpdateDatasetResponse, type UpdateDatasetResponses, type UpdateDocumentData, type UpdateDocumentError, type UpdateDocumentErrors, type UpdateDocumentResponse, type UpdateDocumentResponses, type UpdateEvalData, type UpdateEvalErrors, type UpdateEvalResponse, type UpdateEvalResponses, type UpdateFileMetadataData, type UpdateFileMetadataError, type UpdateFileMetadataErrors, type UpdateFileMetadataResponse, type UpdateFileMetadataResponses, type UpdateFormationData, type UpdateFormationErrors, type UpdateFormationResponse, type UpdateFormationResponses, type UpdateGenerationData, type UpdateGenerationError, type UpdateGenerationErrors, type UpdateGenerationRequest, type UpdateGenerationResponse, type UpdateGenerationResponses, type UpdateGuardrailData, type UpdateGuardrailError, type UpdateGuardrailErrors, type UpdateGuardrailRequest, type UpdateGuardrailResponse, type UpdateGuardrailResponses, type UpdateIngestionRuleData, type UpdateIngestionRuleErrors, type UpdateIngestionRuleResponse, type UpdateIngestionRuleResponses, type UpdateMemoryData, type UpdateMemoryEntryData, type UpdateMemoryEntryErrors, type UpdateMemoryEntryResponse, type UpdateMemoryEntryResponses, type UpdateMemoryErrors, type UpdateMemoryResponse, type UpdateMemoryResponses, type UpdateModelRouteData, type UpdateModelRouteErrors, type UpdateModelRouteResponse, type UpdateModelRouteResponses, type UpdateOrchestrationData, type UpdateOrchestrationErrors, type UpdateOrchestrationRequest, type UpdateOrchestrationResponse, type UpdateOrchestrationResponses, type UpdateProjectData, type UpdateProjectError, type UpdateProjectErrors, type UpdateProjectResponse, type UpdateProjectResponses, type UpdateQuotaData, type UpdateQuotaErrors, type UpdateQuotaResponse, type UpdateQuotaResponses, type UpdateSecretData, type UpdateSecretErrors, type UpdateSecretResponses, type UpdateSessionData, type UpdateSessionError, type UpdateSessionErrors, type UpdateSessionRequest, type UpdateSessionResponse, type UpdateSessionResponses, type UpdateTaskData, type UpdateTaskErrors, type UpdateTaskRequest, type UpdateTaskResponse, type UpdateTaskResponses, type UpdateToolData, type UpdateToolError, type UpdateToolErrors, type UpdateToolRequest, type UpdateToolResponse, type UpdateToolResponses, type UpdateTriggerData, type UpdateTriggerErrors, type UpdateTriggerRequest, type UpdateTriggerResponse, type UpdateTriggerResponses, type UpdateWebhookData, type UpdateWebhookError, type UpdateWebhookErrors, type UpdateWebhookResponse, type UpdateWebhookResponses, type UpdateWorkflowData, type UpdateWorkflowErrors, type UpdateWorkflowRequest, type UpdateWorkflowResponse, type UpdateWorkflowResponses, type UploadFileBase64Data, type UploadFileBase64Error, type UploadFileBase64Errors, type UploadFileBase64Request, type UploadFileBase64Response, type UploadFileBase64Responses, type UploadFileData, type UploadFileError, type UploadFileErrors, type UploadFileResponse, type UploadFileResponses, type UpsertProviderPricesRequest, type UsageComponent, type UsageComponents, type UsageGroup, type UsageTokens, type User, type UserUpdate, Users, type ValidateFormationData, type ValidateFormationErrors, type ValidateFormationResponse, type ValidateFormationResponses, type ValidateOrchestrationData, type ValidateOrchestrationErrors, type ValidateOrchestrationRequest, type ValidateOrchestrationResponse, type ValidateOrchestrationResponses, type ValidationError, type ValidationResult, type VerifySignInCodeData, type VerifySignInCodeError, type VerifySignInCodeErrors, type VerifySignInCodeResponse, type VerifySignInCodeResponses, type Webhook, type WebhookCreate, type WebhookDelivery, type WebhookDeliveryList, type WebhookId, type WebhookList, type WebhookUpdate, type WebhookWithSecret, Webhooks, type Workflow, type WorkflowResourceProperties, type WorkflowState, type WorkflowTransition, type WorkflowVersion, Workflows, createClient, createConfig };