@naturali/sdk 0.79.0 → 0.80.1
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.cjs +123 -0
- package/dist/index.d.cts +2519 -1016
- package/dist/index.d.mts +2519 -1016
- package/dist/index.mjs +123 -1
- package/package.json +2 -2
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
|
|
@@ -3963,24 +5056,6 @@ type ValidateOrchestrationRequest = {
|
|
|
3963
5056
|
[key: string]: unknown;
|
|
3964
5057
|
} | null;
|
|
3965
5058
|
};
|
|
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 = {
|
|
3977
|
-
/**
|
|
3978
|
-
* True when there are no blocking errors.
|
|
3979
|
-
*/
|
|
3980
|
-
valid: boolean;
|
|
3981
|
-
errors: Array<ValidationError>;
|
|
3982
|
-
warnings: Array<ValidationError>;
|
|
3983
|
-
};
|
|
3984
5059
|
type Project = {
|
|
3985
5060
|
/**
|
|
3986
5061
|
* Public project ID (proj_ prefix).
|
|
@@ -6638,6 +7713,20 @@ type ListAiProvidersResponses = {
|
|
|
6638
7713
|
name?: string;
|
|
6639
7714
|
provider?: 'openai' | 'anthropic' | 'google' | 'xai' | 'groq' | 'ollama' | 'azure' | 'bedrock' | 'vertex' | 'gateway' | 'custom';
|
|
6640
7715
|
default_model?: string;
|
|
7716
|
+
/**
|
|
7717
|
+
* Secret ID containing API credentials, or null when the record links none.
|
|
7718
|
+
*/
|
|
7719
|
+
secret_id?: string | null;
|
|
7720
|
+
/**
|
|
7721
|
+
* Custom base URL for the provider. Absent when the record sets none.
|
|
7722
|
+
*/
|
|
7723
|
+
base_url?: string;
|
|
7724
|
+
/**
|
|
7725
|
+
* Additional provider-specific configuration. Absent when the record sets none.
|
|
7726
|
+
*/
|
|
7727
|
+
config?: {
|
|
7728
|
+
[key: string]: unknown;
|
|
7729
|
+
};
|
|
6641
7730
|
project_id?: string;
|
|
6642
7731
|
created_at?: Date;
|
|
6643
7732
|
updated_at?: Date;
|
|
@@ -9235,25 +10324,261 @@ type CreateDocumentResponses = {
|
|
|
9235
10324
|
*/
|
|
9236
10325
|
201: DocumentRecord;
|
|
9237
10326
|
};
|
|
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
|
-
};
|
|
10327
|
+
type CreateDocumentResponse = CreateDocumentResponses[keyof CreateDocumentResponses];
|
|
10328
|
+
type IngestDocumentData = {
|
|
10329
|
+
body: {
|
|
10330
|
+
/**
|
|
10331
|
+
* ID of the uploaded file. Must be one of application/pdf, text/plain, text/markdown.
|
|
10332
|
+
*/
|
|
10333
|
+
file_id: string;
|
|
10334
|
+
/**
|
|
10335
|
+
* Path prefix under which to store the document (e.g. /docs/). The filename is appended automatically.
|
|
10336
|
+
*/
|
|
10337
|
+
path_prefix?: string;
|
|
10338
|
+
/**
|
|
10339
|
+
* Key-value tags to attach to the document.
|
|
10340
|
+
*/
|
|
10341
|
+
tags?: {
|
|
10342
|
+
[key: string]: string;
|
|
10343
|
+
};
|
|
10344
|
+
/**
|
|
10345
|
+
* 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.
|
|
10346
|
+
*/
|
|
10347
|
+
chunk_strategy?: 'page' | 'whole' | 'size';
|
|
10348
|
+
/**
|
|
10349
|
+
* Window size in characters when `chunk_strategy=size`. Defaults to 1000.
|
|
10350
|
+
*/
|
|
10351
|
+
chunk_size?: number;
|
|
10352
|
+
/**
|
|
10353
|
+
* Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
|
|
10354
|
+
*/
|
|
10355
|
+
chunk_overlap?: number;
|
|
10356
|
+
};
|
|
10357
|
+
path: {
|
|
10358
|
+
/**
|
|
10359
|
+
* Project public ID (proj_ prefix).
|
|
10360
|
+
*/
|
|
10361
|
+
project_id: string;
|
|
10362
|
+
};
|
|
10363
|
+
query?: {
|
|
10364
|
+
/**
|
|
10365
|
+
* 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`.
|
|
10366
|
+
*/
|
|
10367
|
+
wait?: boolean;
|
|
10368
|
+
};
|
|
10369
|
+
url: '/v1/projects/{project_id}/documents/ingest';
|
|
10370
|
+
};
|
|
10371
|
+
type IngestDocumentErrors = {
|
|
10372
|
+
/**
|
|
10373
|
+
* Invalid request, file not found, or unsupported content type
|
|
10374
|
+
*/
|
|
10375
|
+
400: ErrorResponse;
|
|
10376
|
+
/**
|
|
10377
|
+
* Unauthorized
|
|
10378
|
+
*/
|
|
10379
|
+
401: ErrorResponse;
|
|
10380
|
+
/**
|
|
10381
|
+
* Forbidden
|
|
10382
|
+
*/
|
|
10383
|
+
403: ErrorResponse;
|
|
10384
|
+
/**
|
|
10385
|
+
* 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.
|
|
10386
|
+
*/
|
|
10387
|
+
409: ErrorResponse;
|
|
10388
|
+
/**
|
|
10389
|
+
* The file is too large to ingest synchronously (`?wait=true`). Retry in background mode and poll the document status.
|
|
10390
|
+
*/
|
|
10391
|
+
413: ErrorResponse;
|
|
10392
|
+
};
|
|
10393
|
+
type IngestDocumentError = IngestDocumentErrors[keyof IngestDocumentErrors];
|
|
10394
|
+
type IngestDocumentResponses = {
|
|
10395
|
+
/**
|
|
10396
|
+
* Ingestion completed synchronously (only when `?wait=true`). The document is fully indexed and ready for search.
|
|
10397
|
+
*/
|
|
10398
|
+
201: IngestedDocumentRecord;
|
|
10399
|
+
/**
|
|
10400
|
+
* 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`.
|
|
10401
|
+
*/
|
|
10402
|
+
202: IngestedDocumentRecord;
|
|
10403
|
+
};
|
|
10404
|
+
type IngestDocumentResponse = IngestDocumentResponses[keyof IngestDocumentResponses];
|
|
10405
|
+
type DeleteDocumentData = {
|
|
10406
|
+
body?: never;
|
|
10407
|
+
path: {
|
|
10408
|
+
/**
|
|
10409
|
+
* Project public ID (proj_ prefix).
|
|
10410
|
+
*/
|
|
10411
|
+
project_id: string;
|
|
10412
|
+
/**
|
|
10413
|
+
* Document ID
|
|
10414
|
+
*/
|
|
10415
|
+
document_id: string;
|
|
10416
|
+
};
|
|
10417
|
+
query?: never;
|
|
10418
|
+
url: '/v1/projects/{project_id}/documents/{document_id}';
|
|
10419
|
+
};
|
|
10420
|
+
type DeleteDocumentErrors = {
|
|
10421
|
+
/**
|
|
10422
|
+
* Unauthorized
|
|
10423
|
+
*/
|
|
10424
|
+
401: ErrorResponse;
|
|
10425
|
+
/**
|
|
10426
|
+
* Forbidden
|
|
10427
|
+
*/
|
|
10428
|
+
403: ErrorResponse;
|
|
10429
|
+
/**
|
|
10430
|
+
* Document not found
|
|
10431
|
+
*/
|
|
10432
|
+
404: ErrorResponse;
|
|
10433
|
+
};
|
|
10434
|
+
type DeleteDocumentError = DeleteDocumentErrors[keyof DeleteDocumentErrors];
|
|
10435
|
+
type DeleteDocumentResponses = {
|
|
10436
|
+
/**
|
|
10437
|
+
* Document deleted
|
|
10438
|
+
*/
|
|
10439
|
+
204: void;
|
|
10440
|
+
};
|
|
10441
|
+
type DeleteDocumentResponse = DeleteDocumentResponses[keyof DeleteDocumentResponses];
|
|
10442
|
+
type GetDocumentData = {
|
|
10443
|
+
body?: never;
|
|
10444
|
+
path: {
|
|
10445
|
+
/**
|
|
10446
|
+
* Project public ID (proj_ prefix).
|
|
10447
|
+
*/
|
|
10448
|
+
project_id: string;
|
|
10449
|
+
/**
|
|
10450
|
+
* Document ID
|
|
10451
|
+
*/
|
|
10452
|
+
document_id: string;
|
|
10453
|
+
};
|
|
10454
|
+
query?: never;
|
|
10455
|
+
url: '/v1/projects/{project_id}/documents/{document_id}';
|
|
10456
|
+
};
|
|
10457
|
+
type GetDocumentErrors = {
|
|
10458
|
+
/**
|
|
10459
|
+
* Unauthorized
|
|
10460
|
+
*/
|
|
10461
|
+
401: ErrorResponse;
|
|
10462
|
+
/**
|
|
10463
|
+
* Forbidden
|
|
10464
|
+
*/
|
|
10465
|
+
403: ErrorResponse;
|
|
10466
|
+
/**
|
|
10467
|
+
* Document not found
|
|
10468
|
+
*/
|
|
10469
|
+
404: ErrorResponse;
|
|
10470
|
+
};
|
|
10471
|
+
type GetDocumentError = GetDocumentErrors[keyof GetDocumentErrors];
|
|
10472
|
+
type GetDocumentResponses = {
|
|
10473
|
+
/**
|
|
10474
|
+
* Document found
|
|
10475
|
+
*/
|
|
10476
|
+
200: DocumentRecord;
|
|
10477
|
+
};
|
|
10478
|
+
type GetDocumentResponse = GetDocumentResponses[keyof GetDocumentResponses];
|
|
10479
|
+
type UpdateDocumentData = {
|
|
10480
|
+
body: {
|
|
10481
|
+
/**
|
|
10482
|
+
* New text content
|
|
10483
|
+
*/
|
|
10484
|
+
content?: string;
|
|
10485
|
+
/**
|
|
10486
|
+
* New title
|
|
10487
|
+
*/
|
|
10488
|
+
title?: string;
|
|
10489
|
+
/**
|
|
10490
|
+
* Logical path within the project (e.g. /reports/q1.txt). Pass null to clear.
|
|
10491
|
+
*/
|
|
10492
|
+
path?: string | null;
|
|
10493
|
+
/**
|
|
10494
|
+
* 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.
|
|
10495
|
+
*/
|
|
10496
|
+
metadata?: {
|
|
10497
|
+
[key: string]: unknown;
|
|
10498
|
+
};
|
|
10499
|
+
/**
|
|
10500
|
+
* Key-value tags
|
|
10501
|
+
*/
|
|
10502
|
+
tags?: {
|
|
10503
|
+
[key: string]: string;
|
|
10504
|
+
};
|
|
10505
|
+
};
|
|
10506
|
+
path: {
|
|
10507
|
+
/**
|
|
10508
|
+
* Project public ID (proj_ prefix).
|
|
10509
|
+
*/
|
|
10510
|
+
project_id: string;
|
|
10511
|
+
/**
|
|
10512
|
+
* Document ID
|
|
10513
|
+
*/
|
|
10514
|
+
document_id: string;
|
|
10515
|
+
};
|
|
10516
|
+
query?: never;
|
|
10517
|
+
url: '/v1/projects/{project_id}/documents/{document_id}';
|
|
10518
|
+
};
|
|
10519
|
+
type UpdateDocumentErrors = {
|
|
10520
|
+
/**
|
|
10521
|
+
* Unauthorized
|
|
10522
|
+
*/
|
|
10523
|
+
401: ErrorResponse;
|
|
10524
|
+
/**
|
|
10525
|
+
* Forbidden
|
|
10526
|
+
*/
|
|
10527
|
+
403: ErrorResponse;
|
|
10528
|
+
/**
|
|
10529
|
+
* Document not found
|
|
10530
|
+
*/
|
|
10531
|
+
404: ErrorResponse;
|
|
10532
|
+
};
|
|
10533
|
+
type UpdateDocumentError = UpdateDocumentErrors[keyof UpdateDocumentErrors];
|
|
10534
|
+
type UpdateDocumentResponses = {
|
|
10535
|
+
/**
|
|
10536
|
+
* Document updated
|
|
10537
|
+
*/
|
|
10538
|
+
200: DocumentRecord;
|
|
10539
|
+
};
|
|
10540
|
+
type UpdateDocumentResponse = UpdateDocumentResponses[keyof UpdateDocumentResponses];
|
|
10541
|
+
type GetDocumentStatusData = {
|
|
10542
|
+
body?: never;
|
|
10543
|
+
path: {
|
|
10544
|
+
/**
|
|
10545
|
+
* Project public ID (proj_ prefix).
|
|
10546
|
+
*/
|
|
10547
|
+
project_id: string;
|
|
10548
|
+
/**
|
|
10549
|
+
* Document ID
|
|
10550
|
+
*/
|
|
10551
|
+
document_id: string;
|
|
10552
|
+
};
|
|
10553
|
+
query?: never;
|
|
10554
|
+
url: '/v1/projects/{project_id}/documents/{document_id}/status';
|
|
10555
|
+
};
|
|
10556
|
+
type GetDocumentStatusErrors = {
|
|
10557
|
+
/**
|
|
10558
|
+
* Unauthorized
|
|
10559
|
+
*/
|
|
10560
|
+
401: ErrorResponse;
|
|
10561
|
+
/**
|
|
10562
|
+
* Forbidden
|
|
10563
|
+
*/
|
|
10564
|
+
403: ErrorResponse;
|
|
10565
|
+
/**
|
|
10566
|
+
* Document not found
|
|
10567
|
+
*/
|
|
10568
|
+
404: ErrorResponse;
|
|
10569
|
+
};
|
|
10570
|
+
type GetDocumentStatusError = GetDocumentStatusErrors[keyof GetDocumentStatusErrors];
|
|
10571
|
+
type GetDocumentStatusResponses = {
|
|
10572
|
+
/**
|
|
10573
|
+
* Document ingestion status
|
|
10574
|
+
*/
|
|
10575
|
+
200: DocumentStatusRecord;
|
|
10576
|
+
};
|
|
10577
|
+
type GetDocumentStatusResponse = GetDocumentStatusResponses[keyof GetDocumentStatusResponses];
|
|
10578
|
+
type ReingestDocumentData = {
|
|
10579
|
+
body?: {
|
|
9255
10580
|
/**
|
|
9256
|
-
* How to split the source into chunks.
|
|
10581
|
+
* How to split the source into chunks. Defaults to `page`.
|
|
9257
10582
|
*/
|
|
9258
10583
|
chunk_strategy?: 'page' | 'whole' | 'size';
|
|
9259
10584
|
/**
|
|
@@ -9270,6 +10595,10 @@ type IngestDocumentData = {
|
|
|
9270
10595
|
* Project public ID (proj_ prefix).
|
|
9271
10596
|
*/
|
|
9272
10597
|
project_id: string;
|
|
10598
|
+
/**
|
|
10599
|
+
* Document ID
|
|
10600
|
+
*/
|
|
10601
|
+
document_id: string;
|
|
9273
10602
|
};
|
|
9274
10603
|
query?: {
|
|
9275
10604
|
/**
|
|
@@ -9277,13 +10606,9 @@ type IngestDocumentData = {
|
|
|
9277
10606
|
*/
|
|
9278
10607
|
wait?: boolean;
|
|
9279
10608
|
};
|
|
9280
|
-
url: '/v1/projects/{project_id}/documents/ingest';
|
|
10609
|
+
url: '/v1/projects/{project_id}/documents/{document_id}/ingest';
|
|
9281
10610
|
};
|
|
9282
|
-
type
|
|
9283
|
-
/**
|
|
9284
|
-
* Invalid request, file not found, or unsupported content type
|
|
9285
|
-
*/
|
|
9286
|
-
400: ErrorResponse;
|
|
10611
|
+
type ReingestDocumentErrors = {
|
|
9287
10612
|
/**
|
|
9288
10613
|
* Unauthorized
|
|
9289
10614
|
*/
|
|
@@ -9293,27 +10618,27 @@ type IngestDocumentErrors = {
|
|
|
9293
10618
|
*/
|
|
9294
10619
|
403: ErrorResponse;
|
|
9295
10620
|
/**
|
|
9296
|
-
*
|
|
10621
|
+
* Document not found
|
|
9297
10622
|
*/
|
|
9298
|
-
|
|
10623
|
+
404: ErrorResponse;
|
|
9299
10624
|
/**
|
|
9300
|
-
* The file is too large to ingest synchronously (`?wait=true`). Retry in background mode
|
|
10625
|
+
* The file is too large to re-ingest synchronously (`?wait=true`). Retry in background mode.
|
|
9301
10626
|
*/
|
|
9302
10627
|
413: ErrorResponse;
|
|
9303
10628
|
};
|
|
9304
|
-
type
|
|
9305
|
-
type
|
|
10629
|
+
type ReingestDocumentError = ReingestDocumentErrors[keyof ReingestDocumentErrors];
|
|
10630
|
+
type ReingestDocumentResponses = {
|
|
9306
10631
|
/**
|
|
9307
|
-
*
|
|
10632
|
+
* Re-ingestion completed synchronously (only when `?wait=true`).
|
|
9308
10633
|
*/
|
|
9309
10634
|
201: IngestedDocumentRecord;
|
|
9310
10635
|
/**
|
|
9311
|
-
*
|
|
10636
|
+
* 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
10637
|
*/
|
|
9313
10638
|
202: IngestedDocumentRecord;
|
|
9314
10639
|
};
|
|
9315
|
-
type
|
|
9316
|
-
type
|
|
10640
|
+
type ReingestDocumentResponse = ReingestDocumentResponses[keyof ReingestDocumentResponses];
|
|
10641
|
+
type GetDocumentTagsData = {
|
|
9317
10642
|
body?: never;
|
|
9318
10643
|
path: {
|
|
9319
10644
|
/**
|
|
@@ -9326,9 +10651,9 @@ type DeleteDocumentData = {
|
|
|
9326
10651
|
document_id: string;
|
|
9327
10652
|
};
|
|
9328
10653
|
query?: never;
|
|
9329
|
-
url: '/v1/projects/{project_id}/documents/{document_id}';
|
|
10654
|
+
url: '/v1/projects/{project_id}/documents/{document_id}/tags';
|
|
9330
10655
|
};
|
|
9331
|
-
type
|
|
10656
|
+
type GetDocumentTagsErrors = {
|
|
9332
10657
|
/**
|
|
9333
10658
|
* Unauthorized
|
|
9334
10659
|
*/
|
|
@@ -9342,16 +10667,20 @@ type DeleteDocumentErrors = {
|
|
|
9342
10667
|
*/
|
|
9343
10668
|
404: ErrorResponse;
|
|
9344
10669
|
};
|
|
9345
|
-
type
|
|
9346
|
-
type
|
|
10670
|
+
type GetDocumentTagsError = GetDocumentTagsErrors[keyof GetDocumentTagsErrors];
|
|
10671
|
+
type GetDocumentTagsResponses = {
|
|
9347
10672
|
/**
|
|
9348
|
-
* Document
|
|
10673
|
+
* Document tags
|
|
9349
10674
|
*/
|
|
9350
|
-
|
|
10675
|
+
200: {
|
|
10676
|
+
[key: string]: string;
|
|
10677
|
+
};
|
|
9351
10678
|
};
|
|
9352
|
-
type
|
|
9353
|
-
type
|
|
9354
|
-
body
|
|
10679
|
+
type GetDocumentTagsResponse = GetDocumentTagsResponses[keyof GetDocumentTagsResponses];
|
|
10680
|
+
type MergeDocumentTagsData = {
|
|
10681
|
+
body: {
|
|
10682
|
+
[key: string]: string;
|
|
10683
|
+
};
|
|
9355
10684
|
path: {
|
|
9356
10685
|
/**
|
|
9357
10686
|
* Project public ID (proj_ prefix).
|
|
@@ -9363,9 +10692,9 @@ type GetDocumentData = {
|
|
|
9363
10692
|
document_id: string;
|
|
9364
10693
|
};
|
|
9365
10694
|
query?: never;
|
|
9366
|
-
url: '/v1/projects/{project_id}/documents/{document_id}';
|
|
10695
|
+
url: '/v1/projects/{project_id}/documents/{document_id}/tags';
|
|
9367
10696
|
};
|
|
9368
|
-
type
|
|
10697
|
+
type MergeDocumentTagsErrors = {
|
|
9369
10698
|
/**
|
|
9370
10699
|
* Unauthorized
|
|
9371
10700
|
*/
|
|
@@ -9379,77 +10708,231 @@ type GetDocumentErrors = {
|
|
|
9379
10708
|
*/
|
|
9380
10709
|
404: ErrorResponse;
|
|
9381
10710
|
};
|
|
9382
|
-
type
|
|
9383
|
-
type
|
|
10711
|
+
type MergeDocumentTagsError = MergeDocumentTagsErrors[keyof MergeDocumentTagsErrors];
|
|
10712
|
+
type MergeDocumentTagsResponses = {
|
|
9384
10713
|
/**
|
|
9385
|
-
*
|
|
10714
|
+
* Tags merged
|
|
9386
10715
|
*/
|
|
9387
|
-
200:
|
|
10716
|
+
200: {
|
|
10717
|
+
[key: string]: string;
|
|
10718
|
+
};
|
|
9388
10719
|
};
|
|
9389
|
-
type
|
|
9390
|
-
type
|
|
10720
|
+
type MergeDocumentTagsResponse = MergeDocumentTagsResponses[keyof MergeDocumentTagsResponses];
|
|
10721
|
+
type ReplaceDocumentTagsData = {
|
|
9391
10722
|
body: {
|
|
10723
|
+
[key: string]: string;
|
|
10724
|
+
};
|
|
10725
|
+
path: {
|
|
9392
10726
|
/**
|
|
9393
|
-
*
|
|
10727
|
+
* Project public ID (proj_ prefix).
|
|
9394
10728
|
*/
|
|
9395
|
-
|
|
10729
|
+
project_id: string;
|
|
9396
10730
|
/**
|
|
9397
|
-
*
|
|
10731
|
+
* Document ID
|
|
9398
10732
|
*/
|
|
9399
|
-
|
|
10733
|
+
document_id: string;
|
|
10734
|
+
};
|
|
10735
|
+
query?: never;
|
|
10736
|
+
url: '/v1/projects/{project_id}/documents/{document_id}/tags';
|
|
10737
|
+
};
|
|
10738
|
+
type ReplaceDocumentTagsErrors = {
|
|
10739
|
+
/**
|
|
10740
|
+
* Unauthorized
|
|
10741
|
+
*/
|
|
10742
|
+
401: ErrorResponse;
|
|
10743
|
+
/**
|
|
10744
|
+
* Forbidden
|
|
10745
|
+
*/
|
|
10746
|
+
403: ErrorResponse;
|
|
10747
|
+
/**
|
|
10748
|
+
* Document not found
|
|
10749
|
+
*/
|
|
10750
|
+
404: ErrorResponse;
|
|
10751
|
+
};
|
|
10752
|
+
type ReplaceDocumentTagsError = ReplaceDocumentTagsErrors[keyof ReplaceDocumentTagsErrors];
|
|
10753
|
+
type ReplaceDocumentTagsResponses = {
|
|
10754
|
+
/**
|
|
10755
|
+
* Tags replaced
|
|
10756
|
+
*/
|
|
10757
|
+
200: {
|
|
10758
|
+
[key: string]: string;
|
|
10759
|
+
};
|
|
10760
|
+
};
|
|
10761
|
+
type ReplaceDocumentTagsResponse = ReplaceDocumentTagsResponses[keyof ReplaceDocumentTagsResponses];
|
|
10762
|
+
type CreateEmbeddingsData = {
|
|
10763
|
+
body: {
|
|
9400
10764
|
/**
|
|
9401
|
-
*
|
|
10765
|
+
* Single text to embed.
|
|
9402
10766
|
*/
|
|
9403
|
-
|
|
10767
|
+
input?: string;
|
|
9404
10768
|
/**
|
|
9405
|
-
*
|
|
10769
|
+
* Batch of texts to embed.
|
|
9406
10770
|
*/
|
|
9407
|
-
|
|
9408
|
-
|
|
9409
|
-
|
|
10771
|
+
inputs?: Array<string>;
|
|
10772
|
+
};
|
|
10773
|
+
path: {
|
|
9410
10774
|
/**
|
|
9411
|
-
*
|
|
10775
|
+
* Project public ID (proj_ prefix).
|
|
9412
10776
|
*/
|
|
9413
|
-
|
|
9414
|
-
|
|
9415
|
-
|
|
10777
|
+
project_id: string;
|
|
10778
|
+
};
|
|
10779
|
+
query?: never;
|
|
10780
|
+
url: '/v1/projects/{project_id}/embeddings';
|
|
10781
|
+
};
|
|
10782
|
+
type CreateEmbeddingsErrors = {
|
|
10783
|
+
/**
|
|
10784
|
+
* Invalid request body
|
|
10785
|
+
*/
|
|
10786
|
+
400: ErrorResponse;
|
|
10787
|
+
/**
|
|
10788
|
+
* Unauthorized
|
|
10789
|
+
*/
|
|
10790
|
+
401: ErrorResponse;
|
|
10791
|
+
/**
|
|
10792
|
+
* Embedding service not configured
|
|
10793
|
+
*/
|
|
10794
|
+
503: ErrorResponse;
|
|
10795
|
+
};
|
|
10796
|
+
type CreateEmbeddingsError = CreateEmbeddingsErrors[keyof CreateEmbeddingsErrors];
|
|
10797
|
+
type CreateEmbeddingsResponses = {
|
|
10798
|
+
/**
|
|
10799
|
+
* Embeddings generated successfully
|
|
10800
|
+
*/
|
|
10801
|
+
200: EmbeddingsResponse;
|
|
10802
|
+
};
|
|
10803
|
+
type CreateEmbeddingsResponse = CreateEmbeddingsResponses[keyof CreateEmbeddingsResponses];
|
|
10804
|
+
type ListDatasetsData = {
|
|
10805
|
+
body?: never;
|
|
10806
|
+
path: {
|
|
10807
|
+
/**
|
|
10808
|
+
* Project public ID (proj_ prefix).
|
|
10809
|
+
*/
|
|
10810
|
+
project_id: string;
|
|
10811
|
+
};
|
|
10812
|
+
query?: {
|
|
10813
|
+
/**
|
|
10814
|
+
* Maximum number of results to return
|
|
10815
|
+
*/
|
|
10816
|
+
limit?: number;
|
|
10817
|
+
/**
|
|
10818
|
+
* Number of results to skip
|
|
10819
|
+
*/
|
|
10820
|
+
offset?: number;
|
|
10821
|
+
};
|
|
10822
|
+
url: '/v1/projects/{project_id}/datasets';
|
|
10823
|
+
};
|
|
10824
|
+
type ListDatasetsErrors = {
|
|
10825
|
+
/**
|
|
10826
|
+
* Unauthorized
|
|
10827
|
+
*/
|
|
10828
|
+
401: unknown;
|
|
10829
|
+
/**
|
|
10830
|
+
* Forbidden
|
|
10831
|
+
*/
|
|
10832
|
+
403: unknown;
|
|
10833
|
+
/**
|
|
10834
|
+
* Internal server error
|
|
10835
|
+
*/
|
|
10836
|
+
500: unknown;
|
|
10837
|
+
};
|
|
10838
|
+
type ListDatasetsResponses = {
|
|
10839
|
+
/**
|
|
10840
|
+
* List of datasets
|
|
10841
|
+
*/
|
|
10842
|
+
200: {
|
|
10843
|
+
data: Array<Dataset>;
|
|
10844
|
+
total: number;
|
|
10845
|
+
limit: number;
|
|
10846
|
+
offset: number;
|
|
10847
|
+
};
|
|
10848
|
+
};
|
|
10849
|
+
type ListDatasetsResponse = ListDatasetsResponses[keyof ListDatasetsResponses];
|
|
10850
|
+
type CreateDatasetData = {
|
|
10851
|
+
body: {
|
|
10852
|
+
/**
|
|
10853
|
+
* Unique name within the project
|
|
10854
|
+
*/
|
|
10855
|
+
name: string;
|
|
10856
|
+
/**
|
|
10857
|
+
* What this suite covers
|
|
10858
|
+
*/
|
|
10859
|
+
description?: string | null;
|
|
10860
|
+
};
|
|
10861
|
+
path: {
|
|
10862
|
+
/**
|
|
10863
|
+
* Project public ID (proj_ prefix).
|
|
10864
|
+
*/
|
|
10865
|
+
project_id: string;
|
|
9416
10866
|
};
|
|
10867
|
+
query?: never;
|
|
10868
|
+
url: '/v1/projects/{project_id}/datasets';
|
|
10869
|
+
};
|
|
10870
|
+
type CreateDatasetErrors = {
|
|
10871
|
+
/**
|
|
10872
|
+
* Bad request (missing or invalid name)
|
|
10873
|
+
*/
|
|
10874
|
+
400: unknown;
|
|
10875
|
+
/**
|
|
10876
|
+
* Unauthorized
|
|
10877
|
+
*/
|
|
10878
|
+
401: unknown;
|
|
10879
|
+
/**
|
|
10880
|
+
* Forbidden
|
|
10881
|
+
*/
|
|
10882
|
+
403: unknown;
|
|
10883
|
+
/**
|
|
10884
|
+
* A dataset with that name already exists in the project
|
|
10885
|
+
*/
|
|
10886
|
+
409: unknown;
|
|
10887
|
+
/**
|
|
10888
|
+
* Internal server error
|
|
10889
|
+
*/
|
|
10890
|
+
500: unknown;
|
|
10891
|
+
};
|
|
10892
|
+
type CreateDatasetResponses = {
|
|
10893
|
+
/**
|
|
10894
|
+
* Dataset created successfully
|
|
10895
|
+
*/
|
|
10896
|
+
201: Dataset;
|
|
10897
|
+
};
|
|
10898
|
+
type CreateDatasetResponse = CreateDatasetResponses[keyof CreateDatasetResponses];
|
|
10899
|
+
type DeleteDatasetData = {
|
|
10900
|
+
body?: never;
|
|
9417
10901
|
path: {
|
|
9418
10902
|
/**
|
|
9419
10903
|
* Project public ID (proj_ prefix).
|
|
9420
10904
|
*/
|
|
9421
10905
|
project_id: string;
|
|
9422
10906
|
/**
|
|
9423
|
-
*
|
|
10907
|
+
* Dataset ID
|
|
9424
10908
|
*/
|
|
9425
|
-
|
|
10909
|
+
dataset_id: string;
|
|
9426
10910
|
};
|
|
9427
10911
|
query?: never;
|
|
9428
|
-
url: '/v1/projects/{project_id}/
|
|
10912
|
+
url: '/v1/projects/{project_id}/datasets/{dataset_id}';
|
|
9429
10913
|
};
|
|
9430
|
-
type
|
|
10914
|
+
type DeleteDatasetErrors = {
|
|
9431
10915
|
/**
|
|
9432
10916
|
* Unauthorized
|
|
9433
10917
|
*/
|
|
9434
|
-
401:
|
|
10918
|
+
401: unknown;
|
|
9435
10919
|
/**
|
|
9436
10920
|
* Forbidden
|
|
9437
10921
|
*/
|
|
9438
|
-
403:
|
|
10922
|
+
403: unknown;
|
|
9439
10923
|
/**
|
|
9440
|
-
*
|
|
10924
|
+
* Dataset not found
|
|
9441
10925
|
*/
|
|
9442
|
-
404:
|
|
10926
|
+
404: unknown;
|
|
9443
10927
|
};
|
|
9444
|
-
type
|
|
9445
|
-
type UpdateDocumentResponses = {
|
|
10928
|
+
type DeleteDatasetResponses = {
|
|
9446
10929
|
/**
|
|
9447
|
-
*
|
|
10930
|
+
* Dataset deleted successfully
|
|
9448
10931
|
*/
|
|
9449
|
-
|
|
10932
|
+
204: void;
|
|
9450
10933
|
};
|
|
9451
|
-
type
|
|
9452
|
-
type
|
|
10934
|
+
type DeleteDatasetResponse = DeleteDatasetResponses[keyof DeleteDatasetResponses];
|
|
10935
|
+
type GetDatasetData = {
|
|
9453
10936
|
body?: never;
|
|
9454
10937
|
path: {
|
|
9455
10938
|
/**
|
|
@@ -9457,140 +10940,199 @@ type GetDocumentStatusData = {
|
|
|
9457
10940
|
*/
|
|
9458
10941
|
project_id: string;
|
|
9459
10942
|
/**
|
|
9460
|
-
*
|
|
10943
|
+
* Dataset ID
|
|
9461
10944
|
*/
|
|
9462
|
-
|
|
10945
|
+
dataset_id: string;
|
|
9463
10946
|
};
|
|
9464
10947
|
query?: never;
|
|
9465
|
-
url: '/v1/projects/{project_id}/
|
|
10948
|
+
url: '/v1/projects/{project_id}/datasets/{dataset_id}';
|
|
9466
10949
|
};
|
|
9467
|
-
type
|
|
10950
|
+
type GetDatasetErrors = {
|
|
9468
10951
|
/**
|
|
9469
10952
|
* Unauthorized
|
|
9470
10953
|
*/
|
|
9471
|
-
401:
|
|
10954
|
+
401: unknown;
|
|
9472
10955
|
/**
|
|
9473
10956
|
* Forbidden
|
|
9474
10957
|
*/
|
|
9475
|
-
403:
|
|
10958
|
+
403: unknown;
|
|
9476
10959
|
/**
|
|
9477
|
-
*
|
|
10960
|
+
* Dataset not found
|
|
9478
10961
|
*/
|
|
9479
|
-
404:
|
|
10962
|
+
404: unknown;
|
|
9480
10963
|
};
|
|
9481
|
-
type
|
|
9482
|
-
type GetDocumentStatusResponses = {
|
|
10964
|
+
type GetDatasetResponses = {
|
|
9483
10965
|
/**
|
|
9484
|
-
*
|
|
10966
|
+
* Dataset details
|
|
9485
10967
|
*/
|
|
9486
|
-
200:
|
|
10968
|
+
200: Dataset;
|
|
9487
10969
|
};
|
|
9488
|
-
type
|
|
9489
|
-
type
|
|
9490
|
-
body
|
|
9491
|
-
|
|
9492
|
-
|
|
9493
|
-
|
|
9494
|
-
|
|
10970
|
+
type GetDatasetResponse = GetDatasetResponses[keyof GetDatasetResponses];
|
|
10971
|
+
type UpdateDatasetData = {
|
|
10972
|
+
body: {
|
|
10973
|
+
name?: string;
|
|
10974
|
+
description?: string | null;
|
|
10975
|
+
};
|
|
10976
|
+
path: {
|
|
9495
10977
|
/**
|
|
9496
|
-
*
|
|
10978
|
+
* Project public ID (proj_ prefix).
|
|
9497
10979
|
*/
|
|
9498
|
-
|
|
10980
|
+
project_id: string;
|
|
9499
10981
|
/**
|
|
9500
|
-
*
|
|
10982
|
+
* Dataset ID
|
|
9501
10983
|
*/
|
|
9502
|
-
|
|
10984
|
+
dataset_id: string;
|
|
9503
10985
|
};
|
|
10986
|
+
query?: never;
|
|
10987
|
+
url: '/v1/projects/{project_id}/datasets/{dataset_id}';
|
|
10988
|
+
};
|
|
10989
|
+
type UpdateDatasetErrors = {
|
|
10990
|
+
/**
|
|
10991
|
+
* Bad request
|
|
10992
|
+
*/
|
|
10993
|
+
400: unknown;
|
|
10994
|
+
/**
|
|
10995
|
+
* Unauthorized
|
|
10996
|
+
*/
|
|
10997
|
+
401: unknown;
|
|
10998
|
+
/**
|
|
10999
|
+
* Forbidden
|
|
11000
|
+
*/
|
|
11001
|
+
403: unknown;
|
|
11002
|
+
/**
|
|
11003
|
+
* Dataset not found
|
|
11004
|
+
*/
|
|
11005
|
+
404: unknown;
|
|
11006
|
+
/**
|
|
11007
|
+
* A dataset with that name already exists in the project
|
|
11008
|
+
*/
|
|
11009
|
+
409: unknown;
|
|
11010
|
+
};
|
|
11011
|
+
type UpdateDatasetResponses = {
|
|
11012
|
+
/**
|
|
11013
|
+
* Dataset updated successfully
|
|
11014
|
+
*/
|
|
11015
|
+
200: Dataset;
|
|
11016
|
+
};
|
|
11017
|
+
type UpdateDatasetResponse = UpdateDatasetResponses[keyof UpdateDatasetResponses];
|
|
11018
|
+
type ListDatasetItemsData = {
|
|
11019
|
+
body?: never;
|
|
9504
11020
|
path: {
|
|
9505
11021
|
/**
|
|
9506
11022
|
* Project public ID (proj_ prefix).
|
|
9507
11023
|
*/
|
|
9508
11024
|
project_id: string;
|
|
9509
11025
|
/**
|
|
9510
|
-
*
|
|
11026
|
+
* Dataset ID
|
|
9511
11027
|
*/
|
|
9512
|
-
|
|
11028
|
+
dataset_id: string;
|
|
9513
11029
|
};
|
|
9514
11030
|
query?: {
|
|
9515
11031
|
/**
|
|
9516
|
-
*
|
|
11032
|
+
* Maximum number of results to return
|
|
9517
11033
|
*/
|
|
9518
|
-
|
|
11034
|
+
limit?: number;
|
|
11035
|
+
/**
|
|
11036
|
+
* Number of results to skip
|
|
11037
|
+
*/
|
|
11038
|
+
offset?: number;
|
|
9519
11039
|
};
|
|
9520
|
-
url: '/v1/projects/{project_id}/
|
|
11040
|
+
url: '/v1/projects/{project_id}/datasets/{dataset_id}/items';
|
|
9521
11041
|
};
|
|
9522
|
-
type
|
|
11042
|
+
type ListDatasetItemsErrors = {
|
|
9523
11043
|
/**
|
|
9524
11044
|
* Unauthorized
|
|
9525
11045
|
*/
|
|
9526
|
-
401:
|
|
11046
|
+
401: unknown;
|
|
9527
11047
|
/**
|
|
9528
11048
|
* Forbidden
|
|
9529
11049
|
*/
|
|
9530
|
-
403:
|
|
9531
|
-
/**
|
|
9532
|
-
* Document not found
|
|
9533
|
-
*/
|
|
9534
|
-
404: ErrorResponse;
|
|
11050
|
+
403: unknown;
|
|
9535
11051
|
/**
|
|
9536
|
-
*
|
|
11052
|
+
* Dataset not found
|
|
9537
11053
|
*/
|
|
9538
|
-
|
|
11054
|
+
404: unknown;
|
|
9539
11055
|
};
|
|
9540
|
-
type
|
|
9541
|
-
type ReingestDocumentResponses = {
|
|
9542
|
-
/**
|
|
9543
|
-
* Re-ingestion completed synchronously (only when `?wait=true`).
|
|
9544
|
-
*/
|
|
9545
|
-
201: IngestedDocumentRecord;
|
|
11056
|
+
type ListDatasetItemsResponses = {
|
|
9546
11057
|
/**
|
|
9547
|
-
*
|
|
11058
|
+
* List of dataset items
|
|
9548
11059
|
*/
|
|
9549
|
-
|
|
11060
|
+
200: {
|
|
11061
|
+
data: Array<DatasetItem>;
|
|
11062
|
+
total: number;
|
|
11063
|
+
limit: number;
|
|
11064
|
+
offset: number;
|
|
11065
|
+
};
|
|
9550
11066
|
};
|
|
9551
|
-
type
|
|
9552
|
-
type
|
|
9553
|
-
body
|
|
11067
|
+
type ListDatasetItemsResponse = ListDatasetItemsResponses[keyof ListDatasetItemsResponses];
|
|
11068
|
+
type CreateDatasetItemData = {
|
|
11069
|
+
body: {
|
|
11070
|
+
input: DatasetItemInput;
|
|
11071
|
+
/**
|
|
11072
|
+
* Reference answer for exact_match / embedding_similarity / llm_judge scorers
|
|
11073
|
+
*/
|
|
11074
|
+
expected_output?: string | null;
|
|
11075
|
+
/**
|
|
11076
|
+
* Free-form tags, opaque to the platform
|
|
11077
|
+
*/
|
|
11078
|
+
metadata?: {
|
|
11079
|
+
[key: string]: unknown;
|
|
11080
|
+
} | null;
|
|
11081
|
+
};
|
|
9554
11082
|
path: {
|
|
9555
11083
|
/**
|
|
9556
11084
|
* Project public ID (proj_ prefix).
|
|
9557
11085
|
*/
|
|
9558
11086
|
project_id: string;
|
|
9559
11087
|
/**
|
|
9560
|
-
*
|
|
11088
|
+
* Dataset ID
|
|
9561
11089
|
*/
|
|
9562
|
-
|
|
11090
|
+
dataset_id: string;
|
|
9563
11091
|
};
|
|
9564
11092
|
query?: never;
|
|
9565
|
-
url: '/v1/projects/{project_id}/
|
|
11093
|
+
url: '/v1/projects/{project_id}/datasets/{dataset_id}/items';
|
|
9566
11094
|
};
|
|
9567
|
-
type
|
|
11095
|
+
type CreateDatasetItemErrors = {
|
|
11096
|
+
/**
|
|
11097
|
+
* Bad request (input is not message-shaped)
|
|
11098
|
+
*/
|
|
11099
|
+
400: unknown;
|
|
9568
11100
|
/**
|
|
9569
11101
|
* Unauthorized
|
|
9570
11102
|
*/
|
|
9571
|
-
401:
|
|
11103
|
+
401: unknown;
|
|
9572
11104
|
/**
|
|
9573
11105
|
* Forbidden
|
|
9574
11106
|
*/
|
|
9575
|
-
403:
|
|
11107
|
+
403: unknown;
|
|
9576
11108
|
/**
|
|
9577
|
-
*
|
|
11109
|
+
* Dataset not found
|
|
9578
11110
|
*/
|
|
9579
|
-
404:
|
|
11111
|
+
404: unknown;
|
|
9580
11112
|
};
|
|
9581
|
-
type
|
|
9582
|
-
type GetDocumentTagsResponses = {
|
|
11113
|
+
type CreateDatasetItemResponses = {
|
|
9583
11114
|
/**
|
|
9584
|
-
*
|
|
11115
|
+
* Dataset item created successfully
|
|
9585
11116
|
*/
|
|
9586
|
-
|
|
9587
|
-
[key: string]: string;
|
|
9588
|
-
};
|
|
11117
|
+
201: DatasetItem;
|
|
9589
11118
|
};
|
|
9590
|
-
type
|
|
9591
|
-
type
|
|
11119
|
+
type CreateDatasetItemResponse = CreateDatasetItemResponses[keyof CreateDatasetItemResponses];
|
|
11120
|
+
type CreateDatasetItemFromGenerationData = {
|
|
9592
11121
|
body: {
|
|
9593
|
-
|
|
11122
|
+
/**
|
|
11123
|
+
* The completed generation to promote. Must belong to the same project as the dataset.
|
|
11124
|
+
*/
|
|
11125
|
+
generation_id: string;
|
|
11126
|
+
/**
|
|
11127
|
+
* Reference answer. Omit to use the generation's own answer; pass `null` to store the item with no reference answer.
|
|
11128
|
+
*/
|
|
11129
|
+
expected_output?: string | null;
|
|
11130
|
+
/**
|
|
11131
|
+
* Free-form tags, opaque to the platform
|
|
11132
|
+
*/
|
|
11133
|
+
metadata?: {
|
|
11134
|
+
[key: string]: unknown;
|
|
11135
|
+
} | null;
|
|
9594
11136
|
};
|
|
9595
11137
|
path: {
|
|
9596
11138
|
/**
|
|
@@ -9598,121 +11140,133 @@ type MergeDocumentTagsData = {
|
|
|
9598
11140
|
*/
|
|
9599
11141
|
project_id: string;
|
|
9600
11142
|
/**
|
|
9601
|
-
*
|
|
11143
|
+
* Dataset ID
|
|
9602
11144
|
*/
|
|
9603
|
-
|
|
11145
|
+
dataset_id: string;
|
|
9604
11146
|
};
|
|
9605
11147
|
query?: never;
|
|
9606
|
-
url: '/v1/projects/{project_id}/
|
|
11148
|
+
url: '/v1/projects/{project_id}/datasets/{dataset_id}/items/from-generation';
|
|
9607
11149
|
};
|
|
9608
|
-
type
|
|
11150
|
+
type CreateDatasetItemFromGenerationErrors = {
|
|
11151
|
+
/**
|
|
11152
|
+
* Bad request (generation_id missing, or the generation belongs to a different project than the dataset)
|
|
11153
|
+
*/
|
|
11154
|
+
400: unknown;
|
|
9609
11155
|
/**
|
|
9610
11156
|
* Unauthorized
|
|
9611
11157
|
*/
|
|
9612
|
-
401:
|
|
11158
|
+
401: unknown;
|
|
9613
11159
|
/**
|
|
9614
11160
|
* Forbidden
|
|
9615
11161
|
*/
|
|
9616
|
-
403:
|
|
11162
|
+
403: unknown;
|
|
9617
11163
|
/**
|
|
9618
|
-
*
|
|
11164
|
+
* Dataset or generation not found
|
|
9619
11165
|
*/
|
|
9620
|
-
404:
|
|
11166
|
+
404: unknown;
|
|
11167
|
+
/**
|
|
11168
|
+
* The generation has not completed, or its content was never stored or has been purged
|
|
11169
|
+
*/
|
|
11170
|
+
409: unknown;
|
|
9621
11171
|
};
|
|
9622
|
-
type
|
|
9623
|
-
type MergeDocumentTagsResponses = {
|
|
11172
|
+
type CreateDatasetItemFromGenerationResponses = {
|
|
9624
11173
|
/**
|
|
9625
|
-
*
|
|
11174
|
+
* Dataset item created from the generation
|
|
9626
11175
|
*/
|
|
9627
|
-
|
|
9628
|
-
[key: string]: string;
|
|
9629
|
-
};
|
|
11176
|
+
201: DatasetItem;
|
|
9630
11177
|
};
|
|
9631
|
-
type
|
|
9632
|
-
type
|
|
9633
|
-
body
|
|
9634
|
-
[key: string]: string;
|
|
9635
|
-
};
|
|
11178
|
+
type CreateDatasetItemFromGenerationResponse = CreateDatasetItemFromGenerationResponses[keyof CreateDatasetItemFromGenerationResponses];
|
|
11179
|
+
type DeleteDatasetItemData = {
|
|
11180
|
+
body?: never;
|
|
9636
11181
|
path: {
|
|
9637
11182
|
/**
|
|
9638
11183
|
* Project public ID (proj_ prefix).
|
|
9639
11184
|
*/
|
|
9640
11185
|
project_id: string;
|
|
9641
11186
|
/**
|
|
9642
|
-
*
|
|
11187
|
+
* Dataset ID
|
|
9643
11188
|
*/
|
|
9644
|
-
|
|
11189
|
+
dataset_id: string;
|
|
11190
|
+
/**
|
|
11191
|
+
* Dataset item ID
|
|
11192
|
+
*/
|
|
11193
|
+
item_id: string;
|
|
9645
11194
|
};
|
|
9646
11195
|
query?: never;
|
|
9647
|
-
url: '/v1/projects/{project_id}/
|
|
11196
|
+
url: '/v1/projects/{project_id}/datasets/{dataset_id}/items/{item_id}';
|
|
9648
11197
|
};
|
|
9649
|
-
type
|
|
11198
|
+
type DeleteDatasetItemErrors = {
|
|
9650
11199
|
/**
|
|
9651
11200
|
* Unauthorized
|
|
9652
11201
|
*/
|
|
9653
|
-
401:
|
|
11202
|
+
401: unknown;
|
|
9654
11203
|
/**
|
|
9655
11204
|
* Forbidden
|
|
9656
11205
|
*/
|
|
9657
|
-
403:
|
|
11206
|
+
403: unknown;
|
|
9658
11207
|
/**
|
|
9659
|
-
*
|
|
11208
|
+
* Dataset or item not found
|
|
9660
11209
|
*/
|
|
9661
|
-
404:
|
|
11210
|
+
404: unknown;
|
|
9662
11211
|
};
|
|
9663
|
-
type
|
|
9664
|
-
type ReplaceDocumentTagsResponses = {
|
|
11212
|
+
type DeleteDatasetItemResponses = {
|
|
9665
11213
|
/**
|
|
9666
|
-
*
|
|
11214
|
+
* Dataset item deleted successfully
|
|
9667
11215
|
*/
|
|
9668
|
-
|
|
9669
|
-
[key: string]: string;
|
|
9670
|
-
};
|
|
11216
|
+
204: void;
|
|
9671
11217
|
};
|
|
9672
|
-
type
|
|
9673
|
-
type
|
|
11218
|
+
type DeleteDatasetItemResponse = DeleteDatasetItemResponses[keyof DeleteDatasetItemResponses];
|
|
11219
|
+
type UpdateDatasetItemData = {
|
|
9674
11220
|
body: {
|
|
9675
|
-
|
|
9676
|
-
|
|
9677
|
-
|
|
9678
|
-
|
|
9679
|
-
|
|
9680
|
-
* Batch of texts to embed.
|
|
9681
|
-
*/
|
|
9682
|
-
inputs?: Array<string>;
|
|
11221
|
+
input?: DatasetItemInput;
|
|
11222
|
+
expected_output?: string | null;
|
|
11223
|
+
metadata?: {
|
|
11224
|
+
[key: string]: unknown;
|
|
11225
|
+
} | null;
|
|
9683
11226
|
};
|
|
9684
11227
|
path: {
|
|
9685
11228
|
/**
|
|
9686
11229
|
* Project public ID (proj_ prefix).
|
|
9687
11230
|
*/
|
|
9688
11231
|
project_id: string;
|
|
11232
|
+
/**
|
|
11233
|
+
* Dataset ID
|
|
11234
|
+
*/
|
|
11235
|
+
dataset_id: string;
|
|
11236
|
+
/**
|
|
11237
|
+
* Dataset item ID
|
|
11238
|
+
*/
|
|
11239
|
+
item_id: string;
|
|
9689
11240
|
};
|
|
9690
11241
|
query?: never;
|
|
9691
|
-
url: '/v1/projects/{project_id}/
|
|
11242
|
+
url: '/v1/projects/{project_id}/datasets/{dataset_id}/items/{item_id}';
|
|
9692
11243
|
};
|
|
9693
|
-
type
|
|
11244
|
+
type UpdateDatasetItemErrors = {
|
|
9694
11245
|
/**
|
|
9695
|
-
*
|
|
11246
|
+
* Bad request
|
|
9696
11247
|
*/
|
|
9697
|
-
400:
|
|
11248
|
+
400: unknown;
|
|
9698
11249
|
/**
|
|
9699
11250
|
* Unauthorized
|
|
9700
11251
|
*/
|
|
9701
|
-
401:
|
|
11252
|
+
401: unknown;
|
|
9702
11253
|
/**
|
|
9703
|
-
*
|
|
11254
|
+
* Forbidden
|
|
9704
11255
|
*/
|
|
9705
|
-
|
|
11256
|
+
403: unknown;
|
|
11257
|
+
/**
|
|
11258
|
+
* Dataset or item not found
|
|
11259
|
+
*/
|
|
11260
|
+
404: unknown;
|
|
9706
11261
|
};
|
|
9707
|
-
type
|
|
9708
|
-
type CreateEmbeddingsResponses = {
|
|
11262
|
+
type UpdateDatasetItemResponses = {
|
|
9709
11263
|
/**
|
|
9710
|
-
*
|
|
11264
|
+
* Dataset item updated successfully
|
|
9711
11265
|
*/
|
|
9712
|
-
200:
|
|
11266
|
+
200: DatasetItem;
|
|
9713
11267
|
};
|
|
9714
|
-
type
|
|
9715
|
-
type
|
|
11268
|
+
type UpdateDatasetItemResponse = UpdateDatasetItemResponses[keyof UpdateDatasetItemResponses];
|
|
11269
|
+
type ListEvalsData = {
|
|
9716
11270
|
body?: never;
|
|
9717
11271
|
path: {
|
|
9718
11272
|
/**
|
|
@@ -9730,9 +11284,9 @@ type ListDatasetsData = {
|
|
|
9730
11284
|
*/
|
|
9731
11285
|
offset?: number;
|
|
9732
11286
|
};
|
|
9733
|
-
url: '/v1/projects/{project_id}/
|
|
11287
|
+
url: '/v1/projects/{project_id}/evals';
|
|
9734
11288
|
};
|
|
9735
|
-
type
|
|
11289
|
+
type ListEvalsErrors = {
|
|
9736
11290
|
/**
|
|
9737
11291
|
* Unauthorized
|
|
9738
11292
|
*/
|
|
@@ -9746,28 +11300,37 @@ type ListDatasetsErrors = {
|
|
|
9746
11300
|
*/
|
|
9747
11301
|
500: unknown;
|
|
9748
11302
|
};
|
|
9749
|
-
type
|
|
11303
|
+
type ListEvalsResponses = {
|
|
9750
11304
|
/**
|
|
9751
|
-
* List of
|
|
11305
|
+
* List of evals
|
|
9752
11306
|
*/
|
|
9753
11307
|
200: {
|
|
9754
|
-
data: Array<
|
|
11308
|
+
data: Array<Eval>;
|
|
9755
11309
|
total: number;
|
|
9756
11310
|
limit: number;
|
|
9757
11311
|
offset: number;
|
|
9758
11312
|
};
|
|
9759
11313
|
};
|
|
9760
|
-
type
|
|
9761
|
-
type
|
|
11314
|
+
type ListEvalsResponse = ListEvalsResponses[keyof ListEvalsResponses];
|
|
11315
|
+
type CreateEvalData = {
|
|
9762
11316
|
body: {
|
|
9763
11317
|
/**
|
|
9764
11318
|
* Unique name within the project
|
|
9765
11319
|
*/
|
|
9766
11320
|
name: string;
|
|
9767
11321
|
/**
|
|
9768
|
-
*
|
|
11322
|
+
* The agent under test
|
|
9769
11323
|
*/
|
|
9770
|
-
|
|
11324
|
+
agent_id: string;
|
|
11325
|
+
/**
|
|
11326
|
+
* The dataset to run it against
|
|
11327
|
+
*/
|
|
11328
|
+
dataset_id: string;
|
|
11329
|
+
scorers: Scorers;
|
|
11330
|
+
/**
|
|
11331
|
+
* 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.
|
|
11332
|
+
*/
|
|
11333
|
+
pass_threshold?: number | null;
|
|
9771
11334
|
};
|
|
9772
11335
|
path: {
|
|
9773
11336
|
/**
|
|
@@ -9776,11 +11339,11 @@ type CreateDatasetData = {
|
|
|
9776
11339
|
project_id: string;
|
|
9777
11340
|
};
|
|
9778
11341
|
query?: never;
|
|
9779
|
-
url: '/v1/projects/{project_id}/
|
|
11342
|
+
url: '/v1/projects/{project_id}/evals';
|
|
9780
11343
|
};
|
|
9781
|
-
type
|
|
11344
|
+
type CreateEvalErrors = {
|
|
9782
11345
|
/**
|
|
9783
|
-
* Bad request (
|
|
11346
|
+
* Bad request (unknown scorer type, cross-project reference, invalid threshold)
|
|
9784
11347
|
*/
|
|
9785
11348
|
400: unknown;
|
|
9786
11349
|
/**
|
|
@@ -9792,7 +11355,7 @@ type CreateDatasetErrors = {
|
|
|
9792
11355
|
*/
|
|
9793
11356
|
403: unknown;
|
|
9794
11357
|
/**
|
|
9795
|
-
*
|
|
11358
|
+
* An eval with that name already exists in the project
|
|
9796
11359
|
*/
|
|
9797
11360
|
409: unknown;
|
|
9798
11361
|
/**
|
|
@@ -9800,14 +11363,14 @@ type CreateDatasetErrors = {
|
|
|
9800
11363
|
*/
|
|
9801
11364
|
500: unknown;
|
|
9802
11365
|
};
|
|
9803
|
-
type
|
|
11366
|
+
type CreateEvalResponses = {
|
|
9804
11367
|
/**
|
|
9805
|
-
*
|
|
11368
|
+
* Eval created successfully
|
|
9806
11369
|
*/
|
|
9807
|
-
201:
|
|
11370
|
+
201: Eval;
|
|
9808
11371
|
};
|
|
9809
|
-
type
|
|
9810
|
-
type
|
|
11372
|
+
type CreateEvalResponse = CreateEvalResponses[keyof CreateEvalResponses];
|
|
11373
|
+
type DeleteEvalData = {
|
|
9811
11374
|
body?: never;
|
|
9812
11375
|
path: {
|
|
9813
11376
|
/**
|
|
@@ -9815,14 +11378,14 @@ type DeleteDatasetData = {
|
|
|
9815
11378
|
*/
|
|
9816
11379
|
project_id: string;
|
|
9817
11380
|
/**
|
|
9818
|
-
*
|
|
11381
|
+
* Eval ID
|
|
9819
11382
|
*/
|
|
9820
|
-
|
|
11383
|
+
eval_id: string;
|
|
9821
11384
|
};
|
|
9822
11385
|
query?: never;
|
|
9823
|
-
url: '/v1/projects/{project_id}/
|
|
11386
|
+
url: '/v1/projects/{project_id}/evals/{eval_id}';
|
|
9824
11387
|
};
|
|
9825
|
-
type
|
|
11388
|
+
type DeleteEvalErrors = {
|
|
9826
11389
|
/**
|
|
9827
11390
|
* Unauthorized
|
|
9828
11391
|
*/
|
|
@@ -9832,18 +11395,18 @@ type DeleteDatasetErrors = {
|
|
|
9832
11395
|
*/
|
|
9833
11396
|
403: unknown;
|
|
9834
11397
|
/**
|
|
9835
|
-
*
|
|
11398
|
+
* Eval not found
|
|
9836
11399
|
*/
|
|
9837
11400
|
404: unknown;
|
|
9838
11401
|
};
|
|
9839
|
-
type
|
|
11402
|
+
type DeleteEvalResponses = {
|
|
9840
11403
|
/**
|
|
9841
|
-
*
|
|
11404
|
+
* Eval deleted successfully
|
|
9842
11405
|
*/
|
|
9843
11406
|
204: void;
|
|
9844
11407
|
};
|
|
9845
|
-
type
|
|
9846
|
-
type
|
|
11408
|
+
type DeleteEvalResponse = DeleteEvalResponses[keyof DeleteEvalResponses];
|
|
11409
|
+
type GetEvalData = {
|
|
9847
11410
|
body?: never;
|
|
9848
11411
|
path: {
|
|
9849
11412
|
/**
|
|
@@ -9851,14 +11414,14 @@ type GetDatasetData = {
|
|
|
9851
11414
|
*/
|
|
9852
11415
|
project_id: string;
|
|
9853
11416
|
/**
|
|
9854
|
-
*
|
|
11417
|
+
* Eval ID
|
|
9855
11418
|
*/
|
|
9856
|
-
|
|
11419
|
+
eval_id: string;
|
|
9857
11420
|
};
|
|
9858
11421
|
query?: never;
|
|
9859
|
-
url: '/v1/projects/{project_id}/
|
|
11422
|
+
url: '/v1/projects/{project_id}/evals/{eval_id}';
|
|
9860
11423
|
};
|
|
9861
|
-
type
|
|
11424
|
+
type GetEvalErrors = {
|
|
9862
11425
|
/**
|
|
9863
11426
|
* Unauthorized
|
|
9864
11427
|
*/
|
|
@@ -9868,21 +11431,24 @@ type GetDatasetErrors = {
|
|
|
9868
11431
|
*/
|
|
9869
11432
|
403: unknown;
|
|
9870
11433
|
/**
|
|
9871
|
-
*
|
|
11434
|
+
* Eval not found
|
|
9872
11435
|
*/
|
|
9873
11436
|
404: unknown;
|
|
9874
11437
|
};
|
|
9875
|
-
type
|
|
11438
|
+
type GetEvalResponses = {
|
|
9876
11439
|
/**
|
|
9877
|
-
*
|
|
11440
|
+
* Eval details
|
|
9878
11441
|
*/
|
|
9879
|
-
200:
|
|
11442
|
+
200: Eval;
|
|
9880
11443
|
};
|
|
9881
|
-
type
|
|
9882
|
-
type
|
|
11444
|
+
type GetEvalResponse = GetEvalResponses[keyof GetEvalResponses];
|
|
11445
|
+
type UpdateEvalData = {
|
|
9883
11446
|
body: {
|
|
9884
11447
|
name?: string;
|
|
9885
|
-
|
|
11448
|
+
agent_id?: string;
|
|
11449
|
+
dataset_id?: string;
|
|
11450
|
+
scorers?: Scorers;
|
|
11451
|
+
pass_threshold?: number | null;
|
|
9886
11452
|
};
|
|
9887
11453
|
path: {
|
|
9888
11454
|
/**
|
|
@@ -9890,14 +11456,14 @@ type UpdateDatasetData = {
|
|
|
9890
11456
|
*/
|
|
9891
11457
|
project_id: string;
|
|
9892
11458
|
/**
|
|
9893
|
-
*
|
|
11459
|
+
* Eval ID
|
|
9894
11460
|
*/
|
|
9895
|
-
|
|
11461
|
+
eval_id: string;
|
|
9896
11462
|
};
|
|
9897
11463
|
query?: never;
|
|
9898
|
-
url: '/v1/projects/{project_id}/
|
|
11464
|
+
url: '/v1/projects/{project_id}/evals/{eval_id}';
|
|
9899
11465
|
};
|
|
9900
|
-
type
|
|
11466
|
+
type UpdateEvalErrors = {
|
|
9901
11467
|
/**
|
|
9902
11468
|
* Bad request
|
|
9903
11469
|
*/
|
|
@@ -9911,103 +11477,46 @@ type UpdateDatasetErrors = {
|
|
|
9911
11477
|
*/
|
|
9912
11478
|
403: unknown;
|
|
9913
11479
|
/**
|
|
9914
|
-
*
|
|
11480
|
+
* Eval not found
|
|
9915
11481
|
*/
|
|
9916
11482
|
404: unknown;
|
|
9917
11483
|
/**
|
|
9918
|
-
*
|
|
11484
|
+
* An eval with that name already exists in the project
|
|
9919
11485
|
*/
|
|
9920
11486
|
409: unknown;
|
|
9921
11487
|
};
|
|
9922
|
-
type
|
|
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 = {
|
|
11488
|
+
type UpdateEvalResponses = {
|
|
9968
11489
|
/**
|
|
9969
|
-
*
|
|
9970
|
-
*/
|
|
9971
|
-
200:
|
|
9972
|
-
data: Array<DatasetItem>;
|
|
9973
|
-
total: number;
|
|
9974
|
-
limit: number;
|
|
9975
|
-
offset: number;
|
|
9976
|
-
};
|
|
11490
|
+
* Eval updated successfully
|
|
11491
|
+
*/
|
|
11492
|
+
200: Eval;
|
|
9977
11493
|
};
|
|
9978
|
-
type
|
|
9979
|
-
type
|
|
9980
|
-
body
|
|
9981
|
-
|
|
11494
|
+
type UpdateEvalResponse = UpdateEvalResponses[keyof UpdateEvalResponses];
|
|
11495
|
+
type ListEvalRunsData = {
|
|
11496
|
+
body?: never;
|
|
11497
|
+
path: {
|
|
9982
11498
|
/**
|
|
9983
|
-
*
|
|
11499
|
+
* Project public ID (proj_ prefix).
|
|
9984
11500
|
*/
|
|
9985
|
-
|
|
11501
|
+
project_id: string;
|
|
9986
11502
|
/**
|
|
9987
|
-
*
|
|
11503
|
+
* Eval ID
|
|
9988
11504
|
*/
|
|
9989
|
-
|
|
9990
|
-
[key: string]: unknown;
|
|
9991
|
-
} | null;
|
|
11505
|
+
eval_id: string;
|
|
9992
11506
|
};
|
|
9993
|
-
|
|
11507
|
+
query?: {
|
|
9994
11508
|
/**
|
|
9995
|
-
*
|
|
11509
|
+
* Maximum number of results to return
|
|
9996
11510
|
*/
|
|
9997
|
-
|
|
11511
|
+
limit?: number;
|
|
9998
11512
|
/**
|
|
9999
|
-
*
|
|
11513
|
+
* Number of results to skip
|
|
10000
11514
|
*/
|
|
10001
|
-
|
|
11515
|
+
offset?: number;
|
|
10002
11516
|
};
|
|
10003
|
-
|
|
10004
|
-
url: '/v1/projects/{project_id}/datasets/{dataset_id}/items';
|
|
11517
|
+
url: '/v1/projects/{project_id}/evals/{eval_id}/runs';
|
|
10005
11518
|
};
|
|
10006
|
-
type
|
|
10007
|
-
/**
|
|
10008
|
-
* Bad request (input is not message-shaped)
|
|
10009
|
-
*/
|
|
10010
|
-
400: unknown;
|
|
11519
|
+
type ListEvalRunsErrors = {
|
|
10011
11520
|
/**
|
|
10012
11521
|
* Unauthorized
|
|
10013
11522
|
*/
|
|
@@ -10017,33 +11526,44 @@ type CreateDatasetItemErrors = {
|
|
|
10017
11526
|
*/
|
|
10018
11527
|
403: unknown;
|
|
10019
11528
|
/**
|
|
10020
|
-
*
|
|
11529
|
+
* Eval not found
|
|
10021
11530
|
*/
|
|
10022
11531
|
404: unknown;
|
|
10023
11532
|
};
|
|
10024
|
-
type
|
|
11533
|
+
type ListEvalRunsResponses = {
|
|
10025
11534
|
/**
|
|
10026
|
-
*
|
|
11535
|
+
* List of eval runs
|
|
10027
11536
|
*/
|
|
10028
|
-
|
|
11537
|
+
200: {
|
|
11538
|
+
data: Array<EvalRun>;
|
|
11539
|
+
total: number;
|
|
11540
|
+
limit: number;
|
|
11541
|
+
offset: number;
|
|
11542
|
+
};
|
|
10029
11543
|
};
|
|
10030
|
-
type
|
|
10031
|
-
type
|
|
11544
|
+
type ListEvalRunsResponse = ListEvalRunsResponses[keyof ListEvalRunsResponses];
|
|
11545
|
+
type StartEvalRunData = {
|
|
10032
11546
|
body: {
|
|
10033
11547
|
/**
|
|
10034
|
-
*
|
|
11548
|
+
* 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
11549
|
*/
|
|
10036
|
-
|
|
11550
|
+
wait?: boolean;
|
|
10037
11551
|
/**
|
|
10038
|
-
*
|
|
11552
|
+
* 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
11553
|
*/
|
|
10040
|
-
|
|
11554
|
+
agent_version?: number | null;
|
|
10041
11555
|
/**
|
|
10042
|
-
*
|
|
11556
|
+
* 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.
|
|
11557
|
+
*/
|
|
11558
|
+
baseline_run_id?: string | null;
|
|
11559
|
+
/**
|
|
11560
|
+
* 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.
|
|
11561
|
+
*
|
|
11562
|
+
* 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
11563
|
*/
|
|
10044
11564
|
metadata?: {
|
|
10045
11565
|
[key: string]: unknown;
|
|
10046
|
-
}
|
|
11566
|
+
};
|
|
10047
11567
|
};
|
|
10048
11568
|
path: {
|
|
10049
11569
|
/**
|
|
@@ -10051,16 +11571,16 @@ type CreateDatasetItemFromGenerationData = {
|
|
|
10051
11571
|
*/
|
|
10052
11572
|
project_id: string;
|
|
10053
11573
|
/**
|
|
10054
|
-
*
|
|
11574
|
+
* Eval ID
|
|
10055
11575
|
*/
|
|
10056
|
-
|
|
11576
|
+
eval_id: string;
|
|
10057
11577
|
};
|
|
10058
11578
|
query?: never;
|
|
10059
|
-
url: '/v1/projects/{project_id}/
|
|
11579
|
+
url: '/v1/projects/{project_id}/evals/{eval_id}/runs';
|
|
10060
11580
|
};
|
|
10061
|
-
type
|
|
11581
|
+
type StartEvalRunErrors = {
|
|
10062
11582
|
/**
|
|
10063
|
-
* Bad request (
|
|
11583
|
+
* 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
11584
|
*/
|
|
10065
11585
|
400: unknown;
|
|
10066
11586
|
/**
|
|
@@ -10072,22 +11592,22 @@ type CreateDatasetItemFromGenerationErrors = {
|
|
|
10072
11592
|
*/
|
|
10073
11593
|
403: unknown;
|
|
10074
11594
|
/**
|
|
10075
|
-
*
|
|
11595
|
+
* Eval not found
|
|
10076
11596
|
*/
|
|
10077
11597
|
404: unknown;
|
|
10078
11598
|
/**
|
|
10079
|
-
*
|
|
11599
|
+
* Internal server error
|
|
10080
11600
|
*/
|
|
10081
|
-
|
|
11601
|
+
500: unknown;
|
|
10082
11602
|
};
|
|
10083
|
-
type
|
|
11603
|
+
type StartEvalRunResponses = {
|
|
10084
11604
|
/**
|
|
10085
|
-
*
|
|
11605
|
+
* Eval run finished (`wait: true`) or queued (`wait: false`)
|
|
10086
11606
|
*/
|
|
10087
|
-
201:
|
|
11607
|
+
201: EvalRun;
|
|
10088
11608
|
};
|
|
10089
|
-
type
|
|
10090
|
-
type
|
|
11609
|
+
type StartEvalRunResponse = StartEvalRunResponses[keyof StartEvalRunResponses];
|
|
11610
|
+
type GetEvalRunData = {
|
|
10091
11611
|
body?: never;
|
|
10092
11612
|
path: {
|
|
10093
11613
|
/**
|
|
@@ -10095,18 +11615,18 @@ type DeleteDatasetItemData = {
|
|
|
10095
11615
|
*/
|
|
10096
11616
|
project_id: string;
|
|
10097
11617
|
/**
|
|
10098
|
-
*
|
|
11618
|
+
* Eval ID
|
|
10099
11619
|
*/
|
|
10100
|
-
|
|
11620
|
+
eval_id: string;
|
|
10101
11621
|
/**
|
|
10102
|
-
*
|
|
11622
|
+
* Eval run ID
|
|
10103
11623
|
*/
|
|
10104
|
-
|
|
11624
|
+
eval_run_id: string;
|
|
10105
11625
|
};
|
|
10106
11626
|
query?: never;
|
|
10107
|
-
url: '/v1/projects/{project_id}/
|
|
11627
|
+
url: '/v1/projects/{project_id}/evals/{eval_id}/runs/{eval_run_id}';
|
|
10108
11628
|
};
|
|
10109
|
-
type
|
|
11629
|
+
type GetEvalRunErrors = {
|
|
10110
11630
|
/**
|
|
10111
11631
|
* Unauthorized
|
|
10112
11632
|
*/
|
|
@@ -10116,47 +11636,46 @@ type DeleteDatasetItemErrors = {
|
|
|
10116
11636
|
*/
|
|
10117
11637
|
403: unknown;
|
|
10118
11638
|
/**
|
|
10119
|
-
*
|
|
11639
|
+
* Eval or run not found
|
|
10120
11640
|
*/
|
|
10121
11641
|
404: unknown;
|
|
10122
11642
|
};
|
|
10123
|
-
type
|
|
11643
|
+
type GetEvalRunResponses = {
|
|
10124
11644
|
/**
|
|
10125
|
-
*
|
|
11645
|
+
* Eval run details
|
|
10126
11646
|
*/
|
|
10127
|
-
|
|
11647
|
+
200: EvalRun;
|
|
10128
11648
|
};
|
|
10129
|
-
type
|
|
10130
|
-
type
|
|
10131
|
-
body
|
|
10132
|
-
input?: DatasetItemInput;
|
|
10133
|
-
expected_output?: string | null;
|
|
10134
|
-
metadata?: {
|
|
10135
|
-
[key: string]: unknown;
|
|
10136
|
-
} | null;
|
|
10137
|
-
};
|
|
11649
|
+
type GetEvalRunResponse = GetEvalRunResponses[keyof GetEvalRunResponses];
|
|
11650
|
+
type ListEvalResultsData = {
|
|
11651
|
+
body?: never;
|
|
10138
11652
|
path: {
|
|
10139
11653
|
/**
|
|
10140
11654
|
* Project public ID (proj_ prefix).
|
|
10141
11655
|
*/
|
|
10142
11656
|
project_id: string;
|
|
10143
11657
|
/**
|
|
10144
|
-
*
|
|
11658
|
+
* Eval ID
|
|
10145
11659
|
*/
|
|
10146
|
-
|
|
11660
|
+
eval_id: string;
|
|
10147
11661
|
/**
|
|
10148
|
-
*
|
|
11662
|
+
* Eval run ID
|
|
10149
11663
|
*/
|
|
10150
|
-
|
|
11664
|
+
eval_run_id: string;
|
|
10151
11665
|
};
|
|
10152
|
-
query?:
|
|
10153
|
-
|
|
11666
|
+
query?: {
|
|
11667
|
+
/**
|
|
11668
|
+
* Maximum number of results to return
|
|
11669
|
+
*/
|
|
11670
|
+
limit?: number;
|
|
11671
|
+
/**
|
|
11672
|
+
* Number of results to skip
|
|
11673
|
+
*/
|
|
11674
|
+
offset?: number;
|
|
11675
|
+
};
|
|
11676
|
+
url: '/v1/projects/{project_id}/evals/{eval_id}/runs/{eval_run_id}/results';
|
|
10154
11677
|
};
|
|
10155
|
-
type
|
|
10156
|
-
/**
|
|
10157
|
-
* Bad request
|
|
10158
|
-
*/
|
|
10159
|
-
400: unknown;
|
|
11678
|
+
type ListEvalResultsErrors = {
|
|
10160
11679
|
/**
|
|
10161
11680
|
* Unauthorized
|
|
10162
11681
|
*/
|
|
@@ -10166,38 +11685,46 @@ type UpdateDatasetItemErrors = {
|
|
|
10166
11685
|
*/
|
|
10167
11686
|
403: unknown;
|
|
10168
11687
|
/**
|
|
10169
|
-
*
|
|
11688
|
+
* Eval or run not found
|
|
10170
11689
|
*/
|
|
10171
11690
|
404: unknown;
|
|
10172
11691
|
};
|
|
10173
|
-
type
|
|
11692
|
+
type ListEvalResultsResponses = {
|
|
10174
11693
|
/**
|
|
10175
|
-
*
|
|
11694
|
+
* List of eval results
|
|
10176
11695
|
*/
|
|
10177
|
-
200:
|
|
11696
|
+
200: {
|
|
11697
|
+
data: Array<EvalResult>;
|
|
11698
|
+
total: number;
|
|
11699
|
+
limit: number;
|
|
11700
|
+
offset: number;
|
|
11701
|
+
};
|
|
10178
11702
|
};
|
|
10179
|
-
type
|
|
10180
|
-
type
|
|
11703
|
+
type ListEvalResultsResponse = ListEvalResultsResponses[keyof ListEvalResultsResponses];
|
|
11704
|
+
type CancelEvalRunData = {
|
|
10181
11705
|
body?: never;
|
|
10182
11706
|
path: {
|
|
10183
11707
|
/**
|
|
10184
11708
|
* Project public ID (proj_ prefix).
|
|
10185
11709
|
*/
|
|
10186
11710
|
project_id: string;
|
|
10187
|
-
};
|
|
10188
|
-
query?: {
|
|
10189
11711
|
/**
|
|
10190
|
-
*
|
|
11712
|
+
* Eval ID
|
|
10191
11713
|
*/
|
|
10192
|
-
|
|
11714
|
+
eval_id: string;
|
|
10193
11715
|
/**
|
|
10194
|
-
*
|
|
11716
|
+
* Eval run ID
|
|
10195
11717
|
*/
|
|
10196
|
-
|
|
11718
|
+
eval_run_id: string;
|
|
10197
11719
|
};
|
|
10198
|
-
|
|
11720
|
+
query?: never;
|
|
11721
|
+
url: '/v1/projects/{project_id}/evals/{eval_id}/runs/{eval_run_id}/cancel';
|
|
10199
11722
|
};
|
|
10200
|
-
type
|
|
11723
|
+
type CancelEvalRunErrors = {
|
|
11724
|
+
/**
|
|
11725
|
+
* The run has already finished
|
|
11726
|
+
*/
|
|
11727
|
+
400: unknown;
|
|
10201
11728
|
/**
|
|
10202
11729
|
* Unauthorized
|
|
10203
11730
|
*/
|
|
@@ -10206,57 +11733,55 @@ type ListEvalsErrors = {
|
|
|
10206
11733
|
* Forbidden
|
|
10207
11734
|
*/
|
|
10208
11735
|
403: unknown;
|
|
11736
|
+
/**
|
|
11737
|
+
* Eval or run not found
|
|
11738
|
+
*/
|
|
11739
|
+
404: unknown;
|
|
10209
11740
|
/**
|
|
10210
11741
|
* Internal server error
|
|
10211
11742
|
*/
|
|
10212
11743
|
500: unknown;
|
|
10213
11744
|
};
|
|
10214
|
-
type
|
|
11745
|
+
type CancelEvalRunResponses = {
|
|
10215
11746
|
/**
|
|
10216
|
-
*
|
|
11747
|
+
* Eval run canceled
|
|
10217
11748
|
*/
|
|
10218
|
-
200:
|
|
10219
|
-
data: Array<Eval>;
|
|
10220
|
-
total: number;
|
|
10221
|
-
limit: number;
|
|
10222
|
-
offset: number;
|
|
10223
|
-
};
|
|
11749
|
+
200: EvalRun;
|
|
10224
11750
|
};
|
|
10225
|
-
type
|
|
10226
|
-
type
|
|
10227
|
-
body
|
|
11751
|
+
type CancelEvalRunResponse = CancelEvalRunResponses[keyof CancelEvalRunResponses];
|
|
11752
|
+
type ListExceptionsData = {
|
|
11753
|
+
body?: never;
|
|
11754
|
+
path: {
|
|
10228
11755
|
/**
|
|
10229
|
-
*
|
|
11756
|
+
* Project public ID (proj_ prefix).
|
|
10230
11757
|
*/
|
|
10231
|
-
|
|
11758
|
+
project_id: string;
|
|
11759
|
+
};
|
|
11760
|
+
query?: {
|
|
10232
11761
|
/**
|
|
10233
|
-
*
|
|
11762
|
+
* Filter by triage status
|
|
10234
11763
|
*/
|
|
10235
|
-
|
|
11764
|
+
status?: 'open' | 'acknowledged' | 'resolved';
|
|
10236
11765
|
/**
|
|
10237
|
-
*
|
|
11766
|
+
* Filter by severity
|
|
10238
11767
|
*/
|
|
10239
|
-
|
|
10240
|
-
scorers: Scorers;
|
|
11768
|
+
severity?: 'info' | 'warning' | 'critical';
|
|
10241
11769
|
/**
|
|
10242
|
-
*
|
|
11770
|
+
* Filter by how the exception was filed
|
|
10243
11771
|
*/
|
|
10244
|
-
|
|
10245
|
-
};
|
|
10246
|
-
path: {
|
|
11772
|
+
kind?: 'run_failed' | 'guardrail_tripwire' | 'approval_expired' | 'quota_unpriced' | 'event_trigger_loop' | 'manual';
|
|
10247
11773
|
/**
|
|
10248
|
-
*
|
|
11774
|
+
* Maximum number of results to return
|
|
10249
11775
|
*/
|
|
10250
|
-
|
|
11776
|
+
limit?: number;
|
|
11777
|
+
/**
|
|
11778
|
+
* Number of results to skip
|
|
11779
|
+
*/
|
|
11780
|
+
offset?: number;
|
|
10251
11781
|
};
|
|
10252
|
-
|
|
10253
|
-
|
|
10254
|
-
|
|
10255
|
-
type CreateEvalErrors = {
|
|
10256
|
-
/**
|
|
10257
|
-
* Bad request (unknown scorer type, cross-project reference, invalid threshold)
|
|
10258
|
-
*/
|
|
10259
|
-
400: unknown;
|
|
11782
|
+
url: '/v1/projects/{project_id}/exceptions';
|
|
11783
|
+
};
|
|
11784
|
+
type ListExceptionsErrors = {
|
|
10260
11785
|
/**
|
|
10261
11786
|
* Unauthorized
|
|
10262
11787
|
*/
|
|
@@ -10265,23 +11790,24 @@ type CreateEvalErrors = {
|
|
|
10265
11790
|
* Forbidden
|
|
10266
11791
|
*/
|
|
10267
11792
|
403: unknown;
|
|
10268
|
-
/**
|
|
10269
|
-
* An eval with that name already exists in the project
|
|
10270
|
-
*/
|
|
10271
|
-
409: unknown;
|
|
10272
11793
|
/**
|
|
10273
11794
|
* Internal server error
|
|
10274
11795
|
*/
|
|
10275
11796
|
500: unknown;
|
|
10276
11797
|
};
|
|
10277
|
-
type
|
|
11798
|
+
type ListExceptionsResponses = {
|
|
10278
11799
|
/**
|
|
10279
|
-
*
|
|
11800
|
+
* List of exception items
|
|
10280
11801
|
*/
|
|
10281
|
-
|
|
11802
|
+
200: {
|
|
11803
|
+
data: Array<ExceptionItem>;
|
|
11804
|
+
total: number;
|
|
11805
|
+
limit: number;
|
|
11806
|
+
offset: number;
|
|
11807
|
+
};
|
|
10282
11808
|
};
|
|
10283
|
-
type
|
|
10284
|
-
type
|
|
11809
|
+
type ListExceptionsResponse = ListExceptionsResponses[keyof ListExceptionsResponses];
|
|
11810
|
+
type GetExceptionData = {
|
|
10285
11811
|
body?: never;
|
|
10286
11812
|
path: {
|
|
10287
11813
|
/**
|
|
@@ -10289,14 +11815,14 @@ type DeleteEvalData = {
|
|
|
10289
11815
|
*/
|
|
10290
11816
|
project_id: string;
|
|
10291
11817
|
/**
|
|
10292
|
-
*
|
|
11818
|
+
* Exception item ID
|
|
10293
11819
|
*/
|
|
10294
|
-
|
|
11820
|
+
exception_id: string;
|
|
10295
11821
|
};
|
|
10296
11822
|
query?: never;
|
|
10297
|
-
url: '/v1/projects/{project_id}/
|
|
11823
|
+
url: '/v1/projects/{project_id}/exceptions/{exception_id}';
|
|
10298
11824
|
};
|
|
10299
|
-
type
|
|
11825
|
+
type GetExceptionErrors = {
|
|
10300
11826
|
/**
|
|
10301
11827
|
* Unauthorized
|
|
10302
11828
|
*/
|
|
@@ -10306,18 +11832,18 @@ type DeleteEvalErrors = {
|
|
|
10306
11832
|
*/
|
|
10307
11833
|
403: unknown;
|
|
10308
11834
|
/**
|
|
10309
|
-
*
|
|
11835
|
+
* Exception item not found
|
|
10310
11836
|
*/
|
|
10311
11837
|
404: unknown;
|
|
10312
11838
|
};
|
|
10313
|
-
type
|
|
11839
|
+
type GetExceptionResponses = {
|
|
10314
11840
|
/**
|
|
10315
|
-
*
|
|
11841
|
+
* Exception item
|
|
10316
11842
|
*/
|
|
10317
|
-
|
|
11843
|
+
200: ExceptionItem;
|
|
10318
11844
|
};
|
|
10319
|
-
type
|
|
10320
|
-
type
|
|
11845
|
+
type GetExceptionResponse = GetExceptionResponses[keyof GetExceptionResponses];
|
|
11846
|
+
type AcknowledgeExceptionData = {
|
|
10321
11847
|
body?: never;
|
|
10322
11848
|
path: {
|
|
10323
11849
|
/**
|
|
@@ -10325,14 +11851,14 @@ type GetEvalData = {
|
|
|
10325
11851
|
*/
|
|
10326
11852
|
project_id: string;
|
|
10327
11853
|
/**
|
|
10328
|
-
*
|
|
11854
|
+
* Exception item ID
|
|
10329
11855
|
*/
|
|
10330
|
-
|
|
11856
|
+
exception_id: string;
|
|
10331
11857
|
};
|
|
10332
11858
|
query?: never;
|
|
10333
|
-
url: '/v1/projects/{project_id}/
|
|
11859
|
+
url: '/v1/projects/{project_id}/exceptions/{exception_id}/acknowledge';
|
|
10334
11860
|
};
|
|
10335
|
-
type
|
|
11861
|
+
type AcknowledgeExceptionErrors = {
|
|
10336
11862
|
/**
|
|
10337
11863
|
* Unauthorized
|
|
10338
11864
|
*/
|
|
@@ -10342,24 +11868,27 @@ type GetEvalErrors = {
|
|
|
10342
11868
|
*/
|
|
10343
11869
|
403: unknown;
|
|
10344
11870
|
/**
|
|
10345
|
-
*
|
|
11871
|
+
* Exception item not found
|
|
10346
11872
|
*/
|
|
10347
11873
|
404: unknown;
|
|
11874
|
+
/**
|
|
11875
|
+
* Item already resolved
|
|
11876
|
+
*/
|
|
11877
|
+
409: unknown;
|
|
10348
11878
|
};
|
|
10349
|
-
type
|
|
11879
|
+
type AcknowledgeExceptionResponses = {
|
|
10350
11880
|
/**
|
|
10351
|
-
*
|
|
11881
|
+
* Exception item acknowledged
|
|
10352
11882
|
*/
|
|
10353
|
-
200:
|
|
11883
|
+
200: ExceptionItem;
|
|
10354
11884
|
};
|
|
10355
|
-
type
|
|
10356
|
-
type
|
|
10357
|
-
body
|
|
10358
|
-
|
|
10359
|
-
|
|
10360
|
-
|
|
10361
|
-
|
|
10362
|
-
pass_threshold?: number | null;
|
|
11885
|
+
type AcknowledgeExceptionResponse = AcknowledgeExceptionResponses[keyof AcknowledgeExceptionResponses];
|
|
11886
|
+
type ResolveExceptionData = {
|
|
11887
|
+
body?: {
|
|
11888
|
+
/**
|
|
11889
|
+
* Optional resolution note
|
|
11890
|
+
*/
|
|
11891
|
+
note?: string;
|
|
10363
11892
|
};
|
|
10364
11893
|
path: {
|
|
10365
11894
|
/**
|
|
@@ -10367,18 +11896,14 @@ type UpdateEvalData = {
|
|
|
10367
11896
|
*/
|
|
10368
11897
|
project_id: string;
|
|
10369
11898
|
/**
|
|
10370
|
-
*
|
|
11899
|
+
* Exception item ID
|
|
10371
11900
|
*/
|
|
10372
|
-
|
|
11901
|
+
exception_id: string;
|
|
10373
11902
|
};
|
|
10374
11903
|
query?: never;
|
|
10375
|
-
url: '/v1/projects/{project_id}/
|
|
11904
|
+
url: '/v1/projects/{project_id}/exceptions/{exception_id}/resolve';
|
|
10376
11905
|
};
|
|
10377
|
-
type
|
|
10378
|
-
/**
|
|
10379
|
-
* Bad request
|
|
10380
|
-
*/
|
|
10381
|
-
400: unknown;
|
|
11906
|
+
type ResolveExceptionErrors = {
|
|
10382
11907
|
/**
|
|
10383
11908
|
* Unauthorized
|
|
10384
11909
|
*/
|
|
@@ -10388,32 +11913,28 @@ type UpdateEvalErrors = {
|
|
|
10388
11913
|
*/
|
|
10389
11914
|
403: unknown;
|
|
10390
11915
|
/**
|
|
10391
|
-
*
|
|
11916
|
+
* Exception item not found
|
|
10392
11917
|
*/
|
|
10393
11918
|
404: unknown;
|
|
10394
11919
|
/**
|
|
10395
|
-
*
|
|
11920
|
+
* Item already resolved
|
|
10396
11921
|
*/
|
|
10397
11922
|
409: unknown;
|
|
10398
11923
|
};
|
|
10399
|
-
type
|
|
11924
|
+
type ResolveExceptionResponses = {
|
|
10400
11925
|
/**
|
|
10401
|
-
*
|
|
11926
|
+
* Exception item resolved
|
|
10402
11927
|
*/
|
|
10403
|
-
200:
|
|
11928
|
+
200: ExceptionItem;
|
|
10404
11929
|
};
|
|
10405
|
-
type
|
|
10406
|
-
type
|
|
11930
|
+
type ResolveExceptionResponse = ResolveExceptionResponses[keyof ResolveExceptionResponses];
|
|
11931
|
+
type ListFilesData = {
|
|
10407
11932
|
body?: never;
|
|
10408
11933
|
path: {
|
|
10409
11934
|
/**
|
|
10410
11935
|
* Project public ID (proj_ prefix).
|
|
10411
11936
|
*/
|
|
10412
11937
|
project_id: string;
|
|
10413
|
-
/**
|
|
10414
|
-
* Eval ID
|
|
10415
|
-
*/
|
|
10416
|
-
eval_id: string;
|
|
10417
11938
|
};
|
|
10418
11939
|
query?: {
|
|
10419
11940
|
/**
|
|
@@ -10425,300 +11946,196 @@ type ListEvalRunsData = {
|
|
|
10425
11946
|
*/
|
|
10426
11947
|
offset?: number;
|
|
10427
11948
|
};
|
|
10428
|
-
url: '/v1/projects/{project_id}/
|
|
11949
|
+
url: '/v1/projects/{project_id}/files';
|
|
10429
11950
|
};
|
|
10430
|
-
type
|
|
10431
|
-
/**
|
|
10432
|
-
* Unauthorized
|
|
10433
|
-
*/
|
|
10434
|
-
401: unknown;
|
|
10435
|
-
/**
|
|
10436
|
-
* Forbidden
|
|
10437
|
-
*/
|
|
10438
|
-
403: unknown;
|
|
11951
|
+
type ListFilesErrors = {
|
|
10439
11952
|
/**
|
|
10440
|
-
*
|
|
11953
|
+
* Internal server error
|
|
10441
11954
|
*/
|
|
10442
|
-
|
|
11955
|
+
500: ErrorResponse;
|
|
10443
11956
|
};
|
|
10444
|
-
type
|
|
11957
|
+
type ListFilesError = ListFilesErrors[keyof ListFilesErrors];
|
|
11958
|
+
type ListFilesResponses = {
|
|
10445
11959
|
/**
|
|
10446
|
-
* List of
|
|
11960
|
+
* List of files returned successfully
|
|
10447
11961
|
*/
|
|
10448
11962
|
200: {
|
|
10449
|
-
data
|
|
10450
|
-
total
|
|
10451
|
-
limit
|
|
10452
|
-
offset
|
|
11963
|
+
data?: Array<FileRecord>;
|
|
11964
|
+
total?: number;
|
|
11965
|
+
limit?: number;
|
|
11966
|
+
offset?: number;
|
|
10453
11967
|
};
|
|
10454
11968
|
};
|
|
10455
|
-
type
|
|
10456
|
-
type
|
|
11969
|
+
type ListFilesResponse = ListFilesResponses[keyof ListFilesResponses];
|
|
11970
|
+
type CreateFileData = {
|
|
10457
11971
|
body: {
|
|
10458
11972
|
/**
|
|
10459
|
-
*
|
|
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.
|
|
11973
|
+
* Directory within the project (e.g. /images). Optional; defaults to / (root). Combined with filename to form the file's key (path).
|
|
10464
11974
|
*/
|
|
10465
|
-
|
|
11975
|
+
prefix?: string;
|
|
10466
11976
|
/**
|
|
10467
|
-
*
|
|
11977
|
+
* Original / download name and the key's leaf segment (e.g. logo.png).
|
|
10468
11978
|
*/
|
|
10469
|
-
|
|
11979
|
+
filename?: string;
|
|
10470
11980
|
/**
|
|
10471
|
-
*
|
|
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.
|
|
11981
|
+
* MIME type of the file
|
|
10474
11982
|
*/
|
|
10475
|
-
|
|
10476
|
-
[key: string]: unknown;
|
|
10477
|
-
};
|
|
10478
|
-
};
|
|
10479
|
-
path: {
|
|
11983
|
+
content_type?: string;
|
|
10480
11984
|
/**
|
|
10481
|
-
*
|
|
11985
|
+
* File size in bytes
|
|
10482
11986
|
*/
|
|
10483
|
-
|
|
11987
|
+
size?: number | null;
|
|
10484
11988
|
/**
|
|
10485
|
-
*
|
|
11989
|
+
* JSON string with additional metadata
|
|
10486
11990
|
*/
|
|
10487
|
-
|
|
11991
|
+
metadata?: string;
|
|
10488
11992
|
};
|
|
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
11993
|
path: {
|
|
10524
11994
|
/**
|
|
10525
11995
|
* Project public ID (proj_ prefix).
|
|
10526
11996
|
*/
|
|
10527
11997
|
project_id: string;
|
|
10528
|
-
/**
|
|
10529
|
-
* Eval ID
|
|
10530
|
-
*/
|
|
10531
|
-
eval_id: string;
|
|
10532
|
-
/**
|
|
10533
|
-
* Eval run ID
|
|
10534
|
-
*/
|
|
10535
|
-
eval_run_id: string;
|
|
10536
11998
|
};
|
|
10537
11999
|
query?: never;
|
|
10538
|
-
url: '/v1/projects/{project_id}/
|
|
12000
|
+
url: '/v1/projects/{project_id}/files';
|
|
10539
12001
|
};
|
|
10540
|
-
type
|
|
10541
|
-
/**
|
|
10542
|
-
* Unauthorized
|
|
10543
|
-
*/
|
|
10544
|
-
401: unknown;
|
|
10545
|
-
/**
|
|
10546
|
-
* Forbidden
|
|
10547
|
-
*/
|
|
10548
|
-
403: unknown;
|
|
12002
|
+
type CreateFileErrors = {
|
|
10549
12003
|
/**
|
|
10550
|
-
*
|
|
12004
|
+
* Internal server error
|
|
10551
12005
|
*/
|
|
10552
|
-
|
|
12006
|
+
500: ErrorResponse;
|
|
10553
12007
|
};
|
|
10554
|
-
type
|
|
12008
|
+
type CreateFileError = CreateFileErrors[keyof CreateFileErrors];
|
|
12009
|
+
type CreateFileResponses = {
|
|
10555
12010
|
/**
|
|
10556
|
-
*
|
|
12011
|
+
* File created successfully
|
|
10557
12012
|
*/
|
|
10558
|
-
|
|
12013
|
+
201: FileRecord;
|
|
10559
12014
|
};
|
|
10560
|
-
type
|
|
10561
|
-
type
|
|
10562
|
-
body
|
|
10563
|
-
path: {
|
|
12015
|
+
type CreateFileResponse = CreateFileResponses[keyof CreateFileResponses];
|
|
12016
|
+
type UploadFileData = {
|
|
12017
|
+
body: {
|
|
10564
12018
|
/**
|
|
10565
|
-
*
|
|
12019
|
+
* File content
|
|
10566
12020
|
*/
|
|
10567
|
-
|
|
12021
|
+
file: Blob | File;
|
|
10568
12022
|
/**
|
|
10569
|
-
*
|
|
12023
|
+
* 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
12024
|
*/
|
|
10571
|
-
|
|
12025
|
+
project_id?: string;
|
|
10572
12026
|
/**
|
|
10573
|
-
*
|
|
12027
|
+
* Directory within the project (e.g. /images). Optional; defaults to / (root).
|
|
10574
12028
|
*/
|
|
10575
|
-
|
|
10576
|
-
|
|
10577
|
-
|
|
12029
|
+
prefix?: string;
|
|
12030
|
+
/**
|
|
12031
|
+
* Original / download name. Optional; defaults to the uploaded file's name.
|
|
12032
|
+
*/
|
|
12033
|
+
filename?: string;
|
|
10578
12034
|
/**
|
|
10579
|
-
*
|
|
12035
|
+
* Additional metadata as a JSON string
|
|
10580
12036
|
*/
|
|
10581
|
-
|
|
12037
|
+
metadata?: string;
|
|
12038
|
+
};
|
|
12039
|
+
path: {
|
|
10582
12040
|
/**
|
|
10583
|
-
*
|
|
12041
|
+
* Project public ID (proj_ prefix).
|
|
10584
12042
|
*/
|
|
10585
|
-
|
|
12043
|
+
project_id: string;
|
|
10586
12044
|
};
|
|
10587
|
-
|
|
12045
|
+
query?: never;
|
|
12046
|
+
url: '/v1/projects/{project_id}/files/upload';
|
|
10588
12047
|
};
|
|
10589
|
-
type
|
|
12048
|
+
type UploadFileErrors = {
|
|
10590
12049
|
/**
|
|
10591
|
-
*
|
|
12050
|
+
* Missing file or invalid project
|
|
10592
12051
|
*/
|
|
10593
|
-
|
|
12052
|
+
400: ErrorResponse;
|
|
10594
12053
|
/**
|
|
10595
|
-
*
|
|
12054
|
+
* Missing or invalid credentials.
|
|
10596
12055
|
*/
|
|
10597
|
-
|
|
12056
|
+
401: ErrorResponse;
|
|
10598
12057
|
/**
|
|
10599
|
-
*
|
|
12058
|
+
* The caller's role in the project does not carry this action, or the credential is scoped to a different project.
|
|
12059
|
+
*
|
|
10600
12060
|
*/
|
|
10601
|
-
|
|
12061
|
+
403: ErrorResponse;
|
|
10602
12062
|
};
|
|
10603
|
-
type
|
|
12063
|
+
type UploadFileError = UploadFileErrors[keyof UploadFileErrors];
|
|
12064
|
+
type UploadFileResponses = {
|
|
10604
12065
|
/**
|
|
10605
|
-
*
|
|
12066
|
+
* File uploaded successfully
|
|
10606
12067
|
*/
|
|
10607
|
-
|
|
10608
|
-
data: Array<EvalResult>;
|
|
10609
|
-
total: number;
|
|
10610
|
-
limit: number;
|
|
10611
|
-
offset: number;
|
|
10612
|
-
};
|
|
12068
|
+
201: FileRecord;
|
|
10613
12069
|
};
|
|
10614
|
-
type
|
|
10615
|
-
type
|
|
10616
|
-
body
|
|
12070
|
+
type UploadFileResponse = UploadFileResponses[keyof UploadFileResponses];
|
|
12071
|
+
type UploadFileBase64Data = {
|
|
12072
|
+
body: UploadFileBase64Request;
|
|
10617
12073
|
path: {
|
|
10618
12074
|
/**
|
|
10619
12075
|
* Project public ID (proj_ prefix).
|
|
10620
12076
|
*/
|
|
10621
12077
|
project_id: string;
|
|
10622
|
-
/**
|
|
10623
|
-
* Eval ID
|
|
10624
|
-
*/
|
|
10625
|
-
eval_id: string;
|
|
10626
|
-
/**
|
|
10627
|
-
* Eval run ID
|
|
10628
|
-
*/
|
|
10629
|
-
eval_run_id: string;
|
|
10630
12078
|
};
|
|
10631
12079
|
query?: never;
|
|
10632
|
-
url: '/v1/projects/{project_id}/
|
|
12080
|
+
url: '/v1/projects/{project_id}/files/upload/base64';
|
|
10633
12081
|
};
|
|
10634
|
-
type
|
|
10635
|
-
/**
|
|
10636
|
-
* The run has already finished
|
|
10637
|
-
*/
|
|
10638
|
-
400: unknown;
|
|
10639
|
-
/**
|
|
10640
|
-
* Unauthorized
|
|
10641
|
-
*/
|
|
10642
|
-
401: unknown;
|
|
12082
|
+
type UploadFileBase64Errors = {
|
|
10643
12083
|
/**
|
|
10644
|
-
*
|
|
12084
|
+
* Missing content or invalid project
|
|
10645
12085
|
*/
|
|
10646
|
-
|
|
12086
|
+
400: ErrorResponse;
|
|
10647
12087
|
/**
|
|
10648
|
-
*
|
|
12088
|
+
* Missing or invalid credentials.
|
|
10649
12089
|
*/
|
|
10650
|
-
|
|
12090
|
+
401: ErrorResponse;
|
|
10651
12091
|
/**
|
|
10652
|
-
*
|
|
12092
|
+
* The caller's role in the project does not carry this action, or the credential is scoped to a different project.
|
|
12093
|
+
*
|
|
10653
12094
|
*/
|
|
10654
|
-
|
|
12095
|
+
403: ErrorResponse;
|
|
10655
12096
|
};
|
|
10656
|
-
type
|
|
12097
|
+
type UploadFileBase64Error = UploadFileBase64Errors[keyof UploadFileBase64Errors];
|
|
12098
|
+
type UploadFileBase64Responses = {
|
|
10657
12099
|
/**
|
|
10658
|
-
*
|
|
12100
|
+
* File uploaded successfully
|
|
10659
12101
|
*/
|
|
10660
|
-
|
|
12102
|
+
201: FileRecord;
|
|
10661
12103
|
};
|
|
10662
|
-
type
|
|
10663
|
-
type
|
|
12104
|
+
type UploadFileBase64Response = UploadFileBase64Responses[keyof UploadFileBase64Responses];
|
|
12105
|
+
type DeleteFileData = {
|
|
10664
12106
|
body?: never;
|
|
10665
12107
|
path: {
|
|
10666
12108
|
/**
|
|
10667
12109
|
* Project public ID (proj_ prefix).
|
|
10668
12110
|
*/
|
|
10669
12111
|
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
12112
|
/**
|
|
10689
|
-
*
|
|
12113
|
+
* ID of the file to delete
|
|
10690
12114
|
*/
|
|
10691
|
-
|
|
12115
|
+
file_id: string;
|
|
10692
12116
|
};
|
|
10693
|
-
|
|
12117
|
+
query?: never;
|
|
12118
|
+
url: '/v1/projects/{project_id}/files/{file_id}';
|
|
10694
12119
|
};
|
|
10695
|
-
type
|
|
10696
|
-
/**
|
|
10697
|
-
* Unauthorized
|
|
10698
|
-
*/
|
|
10699
|
-
401: unknown;
|
|
12120
|
+
type DeleteFileErrors = {
|
|
10700
12121
|
/**
|
|
10701
|
-
*
|
|
12122
|
+
* File not found
|
|
10702
12123
|
*/
|
|
10703
|
-
|
|
12124
|
+
404: ErrorResponse;
|
|
10704
12125
|
/**
|
|
10705
12126
|
* Internal server error
|
|
10706
12127
|
*/
|
|
10707
|
-
500:
|
|
12128
|
+
500: ErrorResponse;
|
|
10708
12129
|
};
|
|
10709
|
-
type
|
|
12130
|
+
type DeleteFileError = DeleteFileErrors[keyof DeleteFileErrors];
|
|
12131
|
+
type DeleteFileResponses = {
|
|
10710
12132
|
/**
|
|
10711
|
-
*
|
|
12133
|
+
* File deleted successfully
|
|
10712
12134
|
*/
|
|
10713
|
-
|
|
10714
|
-
data: Array<ExceptionItem>;
|
|
10715
|
-
total: number;
|
|
10716
|
-
limit: number;
|
|
10717
|
-
offset: number;
|
|
10718
|
-
};
|
|
12135
|
+
204: void;
|
|
10719
12136
|
};
|
|
10720
|
-
type
|
|
10721
|
-
type
|
|
12137
|
+
type DeleteFileResponse = DeleteFileResponses[keyof DeleteFileResponses];
|
|
12138
|
+
type GetFileData = {
|
|
10722
12139
|
body?: never;
|
|
10723
12140
|
path: {
|
|
10724
12141
|
/**
|
|
@@ -10726,35 +12143,32 @@ type GetExceptionData = {
|
|
|
10726
12143
|
*/
|
|
10727
12144
|
project_id: string;
|
|
10728
12145
|
/**
|
|
10729
|
-
*
|
|
12146
|
+
* File ID
|
|
10730
12147
|
*/
|
|
10731
|
-
|
|
12148
|
+
file_id: string;
|
|
10732
12149
|
};
|
|
10733
12150
|
query?: never;
|
|
10734
|
-
url: '/v1/projects/{project_id}/
|
|
12151
|
+
url: '/v1/projects/{project_id}/files/{file_id}';
|
|
10735
12152
|
};
|
|
10736
|
-
type
|
|
10737
|
-
/**
|
|
10738
|
-
* Unauthorized
|
|
10739
|
-
*/
|
|
10740
|
-
401: unknown;
|
|
12153
|
+
type GetFileErrors = {
|
|
10741
12154
|
/**
|
|
10742
|
-
*
|
|
12155
|
+
* File not found
|
|
10743
12156
|
*/
|
|
10744
|
-
|
|
12157
|
+
404: ErrorResponse;
|
|
10745
12158
|
/**
|
|
10746
|
-
*
|
|
12159
|
+
* Internal server error
|
|
10747
12160
|
*/
|
|
10748
|
-
|
|
12161
|
+
500: ErrorResponse;
|
|
10749
12162
|
};
|
|
10750
|
-
type
|
|
12163
|
+
type GetFileError = GetFileErrors[keyof GetFileErrors];
|
|
12164
|
+
type GetFileResponses = {
|
|
10751
12165
|
/**
|
|
10752
|
-
*
|
|
12166
|
+
* File found
|
|
10753
12167
|
*/
|
|
10754
|
-
200:
|
|
12168
|
+
200: FileRecord;
|
|
10755
12169
|
};
|
|
10756
|
-
type
|
|
10757
|
-
type
|
|
12170
|
+
type GetFileResponse = GetFileResponses[keyof GetFileResponses];
|
|
12171
|
+
type DownloadFileData = {
|
|
10758
12172
|
body?: never;
|
|
10759
12173
|
path: {
|
|
10760
12174
|
/**
|
|
@@ -10762,44 +12176,50 @@ type AcknowledgeExceptionData = {
|
|
|
10762
12176
|
*/
|
|
10763
12177
|
project_id: string;
|
|
10764
12178
|
/**
|
|
10765
|
-
*
|
|
12179
|
+
* File ID
|
|
10766
12180
|
*/
|
|
10767
|
-
|
|
12181
|
+
file_id: string;
|
|
10768
12182
|
};
|
|
10769
12183
|
query?: never;
|
|
10770
|
-
url: '/v1/projects/{project_id}/
|
|
12184
|
+
url: '/v1/projects/{project_id}/files/{file_id}/download';
|
|
10771
12185
|
};
|
|
10772
|
-
type
|
|
10773
|
-
/**
|
|
10774
|
-
* Unauthorized
|
|
10775
|
-
*/
|
|
10776
|
-
401: unknown;
|
|
12186
|
+
type DownloadFileErrors = {
|
|
10777
12187
|
/**
|
|
10778
|
-
*
|
|
12188
|
+
* Missing or invalid credentials.
|
|
10779
12189
|
*/
|
|
10780
|
-
|
|
12190
|
+
401: ErrorResponse;
|
|
10781
12191
|
/**
|
|
10782
|
-
*
|
|
12192
|
+
* The caller's role in the project does not carry this action, or the credential is scoped to a different project.
|
|
12193
|
+
*
|
|
10783
12194
|
*/
|
|
10784
|
-
|
|
12195
|
+
403: ErrorResponse;
|
|
10785
12196
|
/**
|
|
10786
|
-
*
|
|
12197
|
+
* File not found
|
|
10787
12198
|
*/
|
|
10788
|
-
|
|
12199
|
+
404: ErrorResponse;
|
|
10789
12200
|
};
|
|
10790
|
-
type
|
|
12201
|
+
type DownloadFileError = DownloadFileErrors[keyof DownloadFileErrors];
|
|
12202
|
+
type DownloadFileResponses = {
|
|
10791
12203
|
/**
|
|
10792
|
-
*
|
|
12204
|
+
* File content
|
|
10793
12205
|
*/
|
|
10794
|
-
200:
|
|
12206
|
+
200: Blob | File;
|
|
10795
12207
|
};
|
|
10796
|
-
type
|
|
10797
|
-
type
|
|
10798
|
-
body
|
|
12208
|
+
type DownloadFileResponse = DownloadFileResponses[keyof DownloadFileResponses];
|
|
12209
|
+
type UpdateFileMetadataData = {
|
|
12210
|
+
body: {
|
|
10799
12211
|
/**
|
|
10800
|
-
*
|
|
12212
|
+
* New metadata as a JSON string
|
|
10801
12213
|
*/
|
|
10802
|
-
|
|
12214
|
+
metadata?: string;
|
|
12215
|
+
/**
|
|
12216
|
+
* New directory — moves the file. The resulting path (prefix + filename) must be unique within the project.
|
|
12217
|
+
*/
|
|
12218
|
+
prefix?: string;
|
|
12219
|
+
/**
|
|
12220
|
+
* New filename — renames the key's leaf and the download name.
|
|
12221
|
+
*/
|
|
12222
|
+
filename?: string;
|
|
10803
12223
|
};
|
|
10804
12224
|
path: {
|
|
10805
12225
|
/**
|
|
@@ -10807,85 +12227,82 @@ type ResolveExceptionData = {
|
|
|
10807
12227
|
*/
|
|
10808
12228
|
project_id: string;
|
|
10809
12229
|
/**
|
|
10810
|
-
*
|
|
12230
|
+
* File ID
|
|
10811
12231
|
*/
|
|
10812
|
-
|
|
12232
|
+
file_id: string;
|
|
10813
12233
|
};
|
|
10814
12234
|
query?: never;
|
|
10815
|
-
url: '/v1/projects/{project_id}/
|
|
12235
|
+
url: '/v1/projects/{project_id}/files/{file_id}/metadata';
|
|
10816
12236
|
};
|
|
10817
|
-
type
|
|
12237
|
+
type UpdateFileMetadataErrors = {
|
|
10818
12238
|
/**
|
|
10819
|
-
*
|
|
12239
|
+
* Missing or invalid credentials.
|
|
10820
12240
|
*/
|
|
10821
|
-
401:
|
|
12241
|
+
401: ErrorResponse;
|
|
10822
12242
|
/**
|
|
10823
|
-
*
|
|
12243
|
+
* The caller's role in the project does not carry this action, or the credential is scoped to a different project.
|
|
12244
|
+
*
|
|
10824
12245
|
*/
|
|
10825
|
-
403:
|
|
12246
|
+
403: ErrorResponse;
|
|
10826
12247
|
/**
|
|
10827
|
-
*
|
|
12248
|
+
* File not found
|
|
10828
12249
|
*/
|
|
10829
|
-
404:
|
|
12250
|
+
404: ErrorResponse;
|
|
10830
12251
|
/**
|
|
10831
|
-
*
|
|
12252
|
+
* A file already exists at the target path in this project
|
|
10832
12253
|
*/
|
|
10833
|
-
409:
|
|
12254
|
+
409: ErrorResponse;
|
|
10834
12255
|
};
|
|
10835
|
-
type
|
|
12256
|
+
type UpdateFileMetadataError = UpdateFileMetadataErrors[keyof UpdateFileMetadataErrors];
|
|
12257
|
+
type UpdateFileMetadataResponses = {
|
|
10836
12258
|
/**
|
|
10837
|
-
*
|
|
12259
|
+
* Metadata updated successfully
|
|
10838
12260
|
*/
|
|
10839
|
-
200:
|
|
12261
|
+
200: FileRecord;
|
|
10840
12262
|
};
|
|
10841
|
-
type
|
|
10842
|
-
type
|
|
12263
|
+
type UpdateFileMetadataResponse = UpdateFileMetadataResponses[keyof UpdateFileMetadataResponses];
|
|
12264
|
+
type DownloadFileBase64Data = {
|
|
10843
12265
|
body?: never;
|
|
10844
12266
|
path: {
|
|
10845
12267
|
/**
|
|
10846
12268
|
* Project public ID (proj_ prefix).
|
|
10847
12269
|
*/
|
|
10848
12270
|
project_id: string;
|
|
10849
|
-
};
|
|
10850
|
-
query?: {
|
|
10851
|
-
/**
|
|
10852
|
-
* Maximum number of results to return
|
|
10853
|
-
*/
|
|
10854
|
-
limit?: number;
|
|
10855
12271
|
/**
|
|
10856
|
-
*
|
|
12272
|
+
* File ID
|
|
10857
12273
|
*/
|
|
10858
|
-
|
|
12274
|
+
file_id: string;
|
|
10859
12275
|
};
|
|
10860
|
-
|
|
12276
|
+
query?: never;
|
|
12277
|
+
url: '/v1/projects/{project_id}/files/{file_id}/download/base64';
|
|
10861
12278
|
};
|
|
10862
|
-
type
|
|
12279
|
+
type DownloadFileBase64Errors = {
|
|
10863
12280
|
/**
|
|
10864
|
-
*
|
|
12281
|
+
* Missing or invalid credentials.
|
|
10865
12282
|
*/
|
|
10866
|
-
|
|
12283
|
+
401: ErrorResponse;
|
|
12284
|
+
/**
|
|
12285
|
+
* The caller's role in the project does not carry this action, or the credential is scoped to a different project.
|
|
12286
|
+
*
|
|
12287
|
+
*/
|
|
12288
|
+
403: ErrorResponse;
|
|
12289
|
+
/**
|
|
12290
|
+
* File not found
|
|
12291
|
+
*/
|
|
12292
|
+
404: ErrorResponse;
|
|
10867
12293
|
};
|
|
10868
|
-
type
|
|
10869
|
-
type
|
|
12294
|
+
type DownloadFileBase64Error = DownloadFileBase64Errors[keyof DownloadFileBase64Errors];
|
|
12295
|
+
type DownloadFileBase64Responses = {
|
|
10870
12296
|
/**
|
|
10871
|
-
*
|
|
12297
|
+
* File content as base64
|
|
10872
12298
|
*/
|
|
10873
12299
|
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
12300
|
/**
|
|
10884
|
-
*
|
|
12301
|
+
* Base64-encoded file content
|
|
10885
12302
|
*/
|
|
10886
|
-
|
|
12303
|
+
content?: string;
|
|
10887
12304
|
/**
|
|
10888
|
-
* Original
|
|
12305
|
+
* Original filename
|
|
10889
12306
|
*/
|
|
10890
12307
|
filename?: string;
|
|
10891
12308
|
/**
|
|
@@ -10896,71 +12313,67 @@ type CreateFileData = {
|
|
|
10896
12313
|
* File size in bytes
|
|
10897
12314
|
*/
|
|
10898
12315
|
size?: number | null;
|
|
10899
|
-
/**
|
|
10900
|
-
* JSON string with additional metadata
|
|
10901
|
-
*/
|
|
10902
|
-
metadata?: string;
|
|
10903
12316
|
};
|
|
12317
|
+
};
|
|
12318
|
+
type DownloadFileBase64Response = DownloadFileBase64Responses[keyof DownloadFileBase64Responses];
|
|
12319
|
+
type GetFileTagsData = {
|
|
12320
|
+
body?: never;
|
|
10904
12321
|
path: {
|
|
10905
12322
|
/**
|
|
10906
12323
|
* Project public ID (proj_ prefix).
|
|
10907
12324
|
*/
|
|
10908
12325
|
project_id: string;
|
|
12326
|
+
/**
|
|
12327
|
+
* File ID
|
|
12328
|
+
*/
|
|
12329
|
+
file_id: string;
|
|
10909
12330
|
};
|
|
10910
12331
|
query?: never;
|
|
10911
|
-
url: '/v1/projects/{project_id}/files';
|
|
12332
|
+
url: '/v1/projects/{project_id}/files/{file_id}/tags';
|
|
10912
12333
|
};
|
|
10913
|
-
type
|
|
12334
|
+
type GetFileTagsErrors = {
|
|
10914
12335
|
/**
|
|
10915
|
-
*
|
|
12336
|
+
* Missing or invalid credentials.
|
|
10916
12337
|
*/
|
|
10917
|
-
|
|
12338
|
+
401: ErrorResponse;
|
|
12339
|
+
/**
|
|
12340
|
+
* The caller's role in the project does not carry this action, or the credential is scoped to a different project.
|
|
12341
|
+
*
|
|
12342
|
+
*/
|
|
12343
|
+
403: ErrorResponse;
|
|
12344
|
+
/**
|
|
12345
|
+
* File not found
|
|
12346
|
+
*/
|
|
12347
|
+
404: ErrorResponse;
|
|
10918
12348
|
};
|
|
10919
|
-
type
|
|
10920
|
-
type
|
|
12349
|
+
type GetFileTagsError = GetFileTagsErrors[keyof GetFileTagsErrors];
|
|
12350
|
+
type GetFileTagsResponses = {
|
|
10921
12351
|
/**
|
|
10922
|
-
* File
|
|
12352
|
+
* File tags
|
|
10923
12353
|
*/
|
|
10924
|
-
|
|
12354
|
+
200: {
|
|
12355
|
+
[key: string]: string;
|
|
12356
|
+
};
|
|
10925
12357
|
};
|
|
10926
|
-
type
|
|
10927
|
-
type
|
|
12358
|
+
type GetFileTagsResponse = GetFileTagsResponses[keyof GetFileTagsResponses];
|
|
12359
|
+
type MergeFileTagsData = {
|
|
10928
12360
|
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;
|
|
12361
|
+
[key: string]: string;
|
|
10949
12362
|
};
|
|
10950
12363
|
path: {
|
|
10951
12364
|
/**
|
|
10952
12365
|
* Project public ID (proj_ prefix).
|
|
10953
12366
|
*/
|
|
10954
12367
|
project_id: string;
|
|
12368
|
+
/**
|
|
12369
|
+
* File ID
|
|
12370
|
+
*/
|
|
12371
|
+
file_id: string;
|
|
10955
12372
|
};
|
|
10956
12373
|
query?: never;
|
|
10957
|
-
url: '/v1/projects/{project_id}/files/
|
|
12374
|
+
url: '/v1/projects/{project_id}/files/{file_id}/tags';
|
|
10958
12375
|
};
|
|
10959
|
-
type
|
|
10960
|
-
/**
|
|
10961
|
-
* Missing file or invalid project
|
|
10962
|
-
*/
|
|
10963
|
-
400: ErrorResponse;
|
|
12376
|
+
type MergeFileTagsErrors = {
|
|
10964
12377
|
/**
|
|
10965
12378
|
* Missing or invalid credentials.
|
|
10966
12379
|
*/
|
|
@@ -10970,31 +12383,39 @@ type UploadFileErrors = {
|
|
|
10970
12383
|
*
|
|
10971
12384
|
*/
|
|
10972
12385
|
403: ErrorResponse;
|
|
12386
|
+
/**
|
|
12387
|
+
* File not found
|
|
12388
|
+
*/
|
|
12389
|
+
404: ErrorResponse;
|
|
10973
12390
|
};
|
|
10974
|
-
type
|
|
10975
|
-
type
|
|
12391
|
+
type MergeFileTagsError = MergeFileTagsErrors[keyof MergeFileTagsErrors];
|
|
12392
|
+
type MergeFileTagsResponses = {
|
|
10976
12393
|
/**
|
|
10977
|
-
*
|
|
12394
|
+
* Tags merged
|
|
10978
12395
|
*/
|
|
10979
|
-
|
|
12396
|
+
200: {
|
|
12397
|
+
[key: string]: string;
|
|
12398
|
+
};
|
|
10980
12399
|
};
|
|
10981
|
-
type
|
|
10982
|
-
type
|
|
10983
|
-
body:
|
|
12400
|
+
type MergeFileTagsResponse = MergeFileTagsResponses[keyof MergeFileTagsResponses];
|
|
12401
|
+
type ReplaceFileTagsData = {
|
|
12402
|
+
body: {
|
|
12403
|
+
[key: string]: string;
|
|
12404
|
+
};
|
|
10984
12405
|
path: {
|
|
10985
12406
|
/**
|
|
10986
12407
|
* Project public ID (proj_ prefix).
|
|
10987
12408
|
*/
|
|
10988
12409
|
project_id: string;
|
|
12410
|
+
/**
|
|
12411
|
+
* File ID
|
|
12412
|
+
*/
|
|
12413
|
+
file_id: string;
|
|
10989
12414
|
};
|
|
10990
12415
|
query?: never;
|
|
10991
|
-
url: '/v1/projects/{project_id}/files/
|
|
12416
|
+
url: '/v1/projects/{project_id}/files/{file_id}/tags';
|
|
10992
12417
|
};
|
|
10993
|
-
type
|
|
10994
|
-
/**
|
|
10995
|
-
* Missing content or invalid project
|
|
10996
|
-
*/
|
|
10997
|
-
400: ErrorResponse;
|
|
12418
|
+
type ReplaceFileTagsErrors = {
|
|
10998
12419
|
/**
|
|
10999
12420
|
* Missing or invalid credentials.
|
|
11000
12421
|
*/
|
|
@@ -11004,353 +12425,370 @@ type UploadFileBase64Errors = {
|
|
|
11004
12425
|
*
|
|
11005
12426
|
*/
|
|
11006
12427
|
403: ErrorResponse;
|
|
12428
|
+
/**
|
|
12429
|
+
* File not found
|
|
12430
|
+
*/
|
|
12431
|
+
404: ErrorResponse;
|
|
11007
12432
|
};
|
|
11008
|
-
type
|
|
11009
|
-
type
|
|
12433
|
+
type ReplaceFileTagsError = ReplaceFileTagsErrors[keyof ReplaceFileTagsErrors];
|
|
12434
|
+
type ReplaceFileTagsResponses = {
|
|
11010
12435
|
/**
|
|
11011
|
-
*
|
|
12436
|
+
* Tags replaced
|
|
11012
12437
|
*/
|
|
11013
|
-
|
|
12438
|
+
200: {
|
|
12439
|
+
[key: string]: string;
|
|
12440
|
+
};
|
|
11014
12441
|
};
|
|
11015
|
-
type
|
|
11016
|
-
type
|
|
11017
|
-
body
|
|
12442
|
+
type ReplaceFileTagsResponse = ReplaceFileTagsResponses[keyof ReplaceFileTagsResponses];
|
|
12443
|
+
type ValidateFormationData = {
|
|
12444
|
+
body: {
|
|
12445
|
+
template?: FormationTemplateInput;
|
|
12446
|
+
/**
|
|
12447
|
+
* 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.
|
|
12448
|
+
*
|
|
12449
|
+
*/
|
|
12450
|
+
parameters?: {
|
|
12451
|
+
[key: string]: string;
|
|
12452
|
+
} | null;
|
|
12453
|
+
};
|
|
11018
12454
|
path: {
|
|
11019
12455
|
/**
|
|
11020
12456
|
* Project public ID (proj_ prefix).
|
|
11021
12457
|
*/
|
|
11022
12458
|
project_id: string;
|
|
11023
|
-
/**
|
|
11024
|
-
* ID of the file to delete
|
|
11025
|
-
*/
|
|
11026
|
-
file_id: string;
|
|
11027
12459
|
};
|
|
11028
12460
|
query?: never;
|
|
11029
|
-
url: '/v1/projects/{project_id}/
|
|
12461
|
+
url: '/v1/projects/{project_id}/formations/validate';
|
|
11030
12462
|
};
|
|
11031
|
-
type
|
|
11032
|
-
/**
|
|
11033
|
-
* File not found
|
|
11034
|
-
*/
|
|
11035
|
-
404: ErrorResponse;
|
|
12463
|
+
type ValidateFormationErrors = {
|
|
11036
12464
|
/**
|
|
11037
|
-
*
|
|
12465
|
+
* Unauthorized
|
|
11038
12466
|
*/
|
|
11039
|
-
|
|
12467
|
+
401: unknown;
|
|
11040
12468
|
};
|
|
11041
|
-
type
|
|
11042
|
-
type DeleteFileResponses = {
|
|
12469
|
+
type ValidateFormationResponses = {
|
|
11043
12470
|
/**
|
|
11044
|
-
*
|
|
12471
|
+
* Validation result
|
|
11045
12472
|
*/
|
|
11046
|
-
|
|
12473
|
+
200: ValidationResult;
|
|
11047
12474
|
};
|
|
11048
|
-
type
|
|
11049
|
-
type
|
|
11050
|
-
body
|
|
12475
|
+
type ValidateFormationResponse = ValidateFormationResponses[keyof ValidateFormationResponses];
|
|
12476
|
+
type PlanFormationData = {
|
|
12477
|
+
body: {
|
|
12478
|
+
/**
|
|
12479
|
+
* Existing formation ID to compare against. Omit for new formation planning.
|
|
12480
|
+
*/
|
|
12481
|
+
formation_id?: string;
|
|
12482
|
+
template: FormationTemplateInput;
|
|
12483
|
+
/**
|
|
12484
|
+
* 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.
|
|
12485
|
+
*
|
|
12486
|
+
*/
|
|
12487
|
+
parameters?: {
|
|
12488
|
+
[key: string]: string;
|
|
12489
|
+
} | null;
|
|
12490
|
+
};
|
|
11051
12491
|
path: {
|
|
11052
12492
|
/**
|
|
11053
12493
|
* Project public ID (proj_ prefix).
|
|
11054
12494
|
*/
|
|
11055
12495
|
project_id: string;
|
|
11056
|
-
/**
|
|
11057
|
-
* File ID
|
|
11058
|
-
*/
|
|
11059
|
-
file_id: string;
|
|
11060
12496
|
};
|
|
11061
12497
|
query?: never;
|
|
11062
|
-
url: '/v1/projects/{project_id}/
|
|
12498
|
+
url: '/v1/projects/{project_id}/formations/plan';
|
|
11063
12499
|
};
|
|
11064
|
-
type
|
|
12500
|
+
type PlanFormationErrors = {
|
|
11065
12501
|
/**
|
|
11066
|
-
*
|
|
12502
|
+
* Bad Request
|
|
11067
12503
|
*/
|
|
11068
|
-
|
|
12504
|
+
400: unknown;
|
|
11069
12505
|
/**
|
|
11070
|
-
*
|
|
12506
|
+
* Unauthorized
|
|
11071
12507
|
*/
|
|
11072
|
-
|
|
12508
|
+
401: unknown;
|
|
12509
|
+
/**
|
|
12510
|
+
* Forbidden
|
|
12511
|
+
*/
|
|
12512
|
+
403: unknown;
|
|
11073
12513
|
};
|
|
11074
|
-
type
|
|
11075
|
-
type GetFileResponses = {
|
|
12514
|
+
type PlanFormationResponses = {
|
|
11076
12515
|
/**
|
|
11077
|
-
*
|
|
12516
|
+
* Plan result
|
|
11078
12517
|
*/
|
|
11079
|
-
200:
|
|
12518
|
+
200: PlanResult;
|
|
11080
12519
|
};
|
|
11081
|
-
type
|
|
11082
|
-
type
|
|
12520
|
+
type PlanFormationResponse = PlanFormationResponses[keyof PlanFormationResponses];
|
|
12521
|
+
type ListFormationsData = {
|
|
11083
12522
|
body?: never;
|
|
11084
12523
|
path: {
|
|
11085
12524
|
/**
|
|
11086
12525
|
* Project public ID (proj_ prefix).
|
|
11087
12526
|
*/
|
|
11088
12527
|
project_id: string;
|
|
12528
|
+
};
|
|
12529
|
+
query?: {
|
|
11089
12530
|
/**
|
|
11090
|
-
*
|
|
12531
|
+
* Maximum number of results to return
|
|
11091
12532
|
*/
|
|
11092
|
-
|
|
12533
|
+
limit?: number;
|
|
12534
|
+
/**
|
|
12535
|
+
* Number of results to skip
|
|
12536
|
+
*/
|
|
12537
|
+
offset?: number;
|
|
11093
12538
|
};
|
|
11094
|
-
|
|
11095
|
-
url: '/v1/projects/{project_id}/files/{file_id}/download';
|
|
12539
|
+
url: '/v1/projects/{project_id}/formations';
|
|
11096
12540
|
};
|
|
11097
|
-
type
|
|
11098
|
-
/**
|
|
11099
|
-
* Missing or invalid credentials.
|
|
11100
|
-
*/
|
|
11101
|
-
401: ErrorResponse;
|
|
12541
|
+
type ListFormationsErrors = {
|
|
11102
12542
|
/**
|
|
11103
|
-
*
|
|
11104
|
-
*
|
|
12543
|
+
* Unauthorized
|
|
11105
12544
|
*/
|
|
11106
|
-
|
|
12545
|
+
401: unknown;
|
|
11107
12546
|
/**
|
|
11108
|
-
*
|
|
12547
|
+
* Forbidden
|
|
11109
12548
|
*/
|
|
11110
|
-
|
|
12549
|
+
403: unknown;
|
|
11111
12550
|
};
|
|
11112
|
-
type
|
|
11113
|
-
type DownloadFileResponses = {
|
|
12551
|
+
type ListFormationsResponses = {
|
|
11114
12552
|
/**
|
|
11115
|
-
*
|
|
12553
|
+
* List of formations
|
|
11116
12554
|
*/
|
|
11117
|
-
200:
|
|
12555
|
+
200: {
|
|
12556
|
+
data: Array<Formation>;
|
|
12557
|
+
total: number;
|
|
12558
|
+
limit: number;
|
|
12559
|
+
offset: number;
|
|
12560
|
+
};
|
|
11118
12561
|
};
|
|
11119
|
-
type
|
|
11120
|
-
type
|
|
12562
|
+
type ListFormationsResponse = ListFormationsResponses[keyof ListFormationsResponses];
|
|
12563
|
+
type CreateFormationData = {
|
|
11121
12564
|
body: {
|
|
11122
12565
|
/**
|
|
11123
|
-
*
|
|
12566
|
+
* Human-readable name for the formation stack
|
|
11124
12567
|
*/
|
|
11125
|
-
|
|
12568
|
+
name: string;
|
|
12569
|
+
template: FormationTemplateInput;
|
|
11126
12570
|
/**
|
|
11127
|
-
*
|
|
12571
|
+
* 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.
|
|
12572
|
+
*
|
|
11128
12573
|
*/
|
|
11129
|
-
|
|
12574
|
+
parameters?: {
|
|
12575
|
+
[key: string]: string;
|
|
12576
|
+
} | null;
|
|
11130
12577
|
/**
|
|
11131
|
-
*
|
|
12578
|
+
* 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`.
|
|
12579
|
+
*
|
|
11132
12580
|
*/
|
|
11133
|
-
|
|
12581
|
+
metadata?: {
|
|
12582
|
+
[key: string]: unknown;
|
|
12583
|
+
} | null;
|
|
11134
12584
|
};
|
|
11135
12585
|
path: {
|
|
11136
12586
|
/**
|
|
11137
12587
|
* Project public ID (proj_ prefix).
|
|
11138
12588
|
*/
|
|
11139
12589
|
project_id: string;
|
|
11140
|
-
/**
|
|
11141
|
-
* File ID
|
|
11142
|
-
*/
|
|
11143
|
-
file_id: string;
|
|
11144
12590
|
};
|
|
11145
12591
|
query?: never;
|
|
11146
|
-
url: '/v1/projects/{project_id}/
|
|
12592
|
+
url: '/v1/projects/{project_id}/formations';
|
|
11147
12593
|
};
|
|
11148
|
-
type
|
|
12594
|
+
type CreateFormationErrors = {
|
|
11149
12595
|
/**
|
|
11150
|
-
*
|
|
12596
|
+
* Bad Request
|
|
11151
12597
|
*/
|
|
11152
|
-
|
|
12598
|
+
400: unknown;
|
|
11153
12599
|
/**
|
|
11154
|
-
*
|
|
11155
|
-
*
|
|
12600
|
+
* Unauthorized
|
|
11156
12601
|
*/
|
|
11157
|
-
|
|
12602
|
+
401: unknown;
|
|
11158
12603
|
/**
|
|
11159
|
-
*
|
|
12604
|
+
* Forbidden
|
|
11160
12605
|
*/
|
|
11161
|
-
|
|
12606
|
+
403: unknown;
|
|
11162
12607
|
/**
|
|
11163
|
-
*
|
|
12608
|
+
* Formation with this name already exists
|
|
11164
12609
|
*/
|
|
11165
|
-
409:
|
|
12610
|
+
409: unknown;
|
|
11166
12611
|
};
|
|
11167
|
-
type
|
|
11168
|
-
type UpdateFileMetadataResponses = {
|
|
12612
|
+
type CreateFormationResponses = {
|
|
11169
12613
|
/**
|
|
11170
|
-
*
|
|
12614
|
+
* Formation created
|
|
11171
12615
|
*/
|
|
11172
|
-
|
|
12616
|
+
201: Formation;
|
|
11173
12617
|
};
|
|
11174
|
-
type
|
|
11175
|
-
type
|
|
12618
|
+
type CreateFormationResponse = CreateFormationResponses[keyof CreateFormationResponses];
|
|
12619
|
+
type DeleteFormationData = {
|
|
11176
12620
|
body?: never;
|
|
11177
12621
|
path: {
|
|
11178
12622
|
/**
|
|
11179
12623
|
* Project public ID (proj_ prefix).
|
|
11180
12624
|
*/
|
|
11181
12625
|
project_id: string;
|
|
11182
|
-
|
|
11183
|
-
* File ID
|
|
11184
|
-
*/
|
|
11185
|
-
file_id: string;
|
|
12626
|
+
formation_id: string;
|
|
11186
12627
|
};
|
|
11187
12628
|
query?: never;
|
|
11188
|
-
url: '/v1/projects/{project_id}/
|
|
12629
|
+
url: '/v1/projects/{project_id}/formations/{formation_id}';
|
|
11189
12630
|
};
|
|
11190
|
-
type
|
|
12631
|
+
type DeleteFormationErrors = {
|
|
11191
12632
|
/**
|
|
11192
|
-
*
|
|
12633
|
+
* Unauthorized
|
|
11193
12634
|
*/
|
|
11194
|
-
401:
|
|
12635
|
+
401: unknown;
|
|
11195
12636
|
/**
|
|
11196
|
-
*
|
|
11197
|
-
*
|
|
12637
|
+
* Forbidden
|
|
11198
12638
|
*/
|
|
11199
|
-
403:
|
|
12639
|
+
403: unknown;
|
|
11200
12640
|
/**
|
|
11201
|
-
*
|
|
12641
|
+
* Not Found
|
|
11202
12642
|
*/
|
|
11203
|
-
404:
|
|
12643
|
+
404: unknown;
|
|
12644
|
+
/**
|
|
12645
|
+
* 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`).
|
|
12646
|
+
*
|
|
12647
|
+
*/
|
|
12648
|
+
409: unknown;
|
|
11204
12649
|
};
|
|
11205
|
-
type
|
|
11206
|
-
type DownloadFileBase64Responses = {
|
|
12650
|
+
type DeleteFormationResponses = {
|
|
11207
12651
|
/**
|
|
11208
|
-
*
|
|
12652
|
+
* Deleted
|
|
11209
12653
|
*/
|
|
11210
12654
|
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;
|
|
12655
|
+
success: boolean;
|
|
11227
12656
|
};
|
|
11228
12657
|
};
|
|
11229
|
-
type
|
|
11230
|
-
type
|
|
12658
|
+
type DeleteFormationResponse = DeleteFormationResponses[keyof DeleteFormationResponses];
|
|
12659
|
+
type GetFormationData = {
|
|
11231
12660
|
body?: never;
|
|
11232
12661
|
path: {
|
|
11233
12662
|
/**
|
|
11234
12663
|
* Project public ID (proj_ prefix).
|
|
11235
12664
|
*/
|
|
11236
12665
|
project_id: string;
|
|
11237
|
-
|
|
11238
|
-
* File ID
|
|
11239
|
-
*/
|
|
11240
|
-
file_id: string;
|
|
12666
|
+
formation_id: string;
|
|
11241
12667
|
};
|
|
11242
12668
|
query?: never;
|
|
11243
|
-
url: '/v1/projects/{project_id}/
|
|
12669
|
+
url: '/v1/projects/{project_id}/formations/{formation_id}';
|
|
11244
12670
|
};
|
|
11245
|
-
type
|
|
12671
|
+
type GetFormationErrors = {
|
|
11246
12672
|
/**
|
|
11247
|
-
*
|
|
12673
|
+
* Unauthorized
|
|
11248
12674
|
*/
|
|
11249
|
-
401:
|
|
12675
|
+
401: unknown;
|
|
11250
12676
|
/**
|
|
11251
|
-
*
|
|
11252
|
-
*
|
|
12677
|
+
* Forbidden
|
|
11253
12678
|
*/
|
|
11254
|
-
403:
|
|
12679
|
+
403: unknown;
|
|
11255
12680
|
/**
|
|
11256
|
-
*
|
|
12681
|
+
* Not Found
|
|
11257
12682
|
*/
|
|
11258
|
-
404:
|
|
12683
|
+
404: unknown;
|
|
11259
12684
|
};
|
|
11260
|
-
type
|
|
11261
|
-
type GetFileTagsResponses = {
|
|
12685
|
+
type GetFormationResponses = {
|
|
11262
12686
|
/**
|
|
11263
|
-
*
|
|
12687
|
+
* Formation details
|
|
11264
12688
|
*/
|
|
11265
|
-
200:
|
|
11266
|
-
[key: string]: string;
|
|
11267
|
-
};
|
|
12689
|
+
200: Formation;
|
|
11268
12690
|
};
|
|
11269
|
-
type
|
|
11270
|
-
type
|
|
11271
|
-
body
|
|
11272
|
-
|
|
12691
|
+
type GetFormationResponse = GetFormationResponses[keyof GetFormationResponses];
|
|
12692
|
+
type UpdateFormationData = {
|
|
12693
|
+
body?: {
|
|
12694
|
+
template?: FormationTemplateInput;
|
|
12695
|
+
/**
|
|
12696
|
+
* 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.
|
|
12697
|
+
*
|
|
12698
|
+
*/
|
|
12699
|
+
parameters?: {
|
|
12700
|
+
[key: string]: string;
|
|
12701
|
+
} | null;
|
|
12702
|
+
/**
|
|
12703
|
+
* 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`.
|
|
12704
|
+
*
|
|
12705
|
+
*/
|
|
12706
|
+
metadata?: {
|
|
12707
|
+
[key: string]: unknown;
|
|
12708
|
+
} | null;
|
|
11273
12709
|
};
|
|
11274
12710
|
path: {
|
|
11275
12711
|
/**
|
|
11276
12712
|
* Project public ID (proj_ prefix).
|
|
11277
12713
|
*/
|
|
11278
12714
|
project_id: string;
|
|
11279
|
-
|
|
11280
|
-
* File ID
|
|
11281
|
-
*/
|
|
11282
|
-
file_id: string;
|
|
12715
|
+
formation_id: string;
|
|
11283
12716
|
};
|
|
11284
12717
|
query?: never;
|
|
11285
|
-
url: '/v1/projects/{project_id}/
|
|
12718
|
+
url: '/v1/projects/{project_id}/formations/{formation_id}';
|
|
11286
12719
|
};
|
|
11287
|
-
type
|
|
12720
|
+
type UpdateFormationErrors = {
|
|
11288
12721
|
/**
|
|
11289
|
-
*
|
|
12722
|
+
* Bad Request
|
|
11290
12723
|
*/
|
|
11291
|
-
|
|
12724
|
+
400: unknown;
|
|
11292
12725
|
/**
|
|
11293
|
-
*
|
|
11294
|
-
*
|
|
12726
|
+
* Unauthorized
|
|
11295
12727
|
*/
|
|
11296
|
-
|
|
12728
|
+
401: unknown;
|
|
11297
12729
|
/**
|
|
11298
|
-
*
|
|
12730
|
+
* Forbidden
|
|
11299
12731
|
*/
|
|
11300
|
-
|
|
12732
|
+
403: unknown;
|
|
12733
|
+
/**
|
|
12734
|
+
* Not Found
|
|
12735
|
+
*/
|
|
12736
|
+
404: unknown;
|
|
11301
12737
|
};
|
|
11302
|
-
type
|
|
11303
|
-
type MergeFileTagsResponses = {
|
|
12738
|
+
type UpdateFormationResponses = {
|
|
11304
12739
|
/**
|
|
11305
|
-
*
|
|
12740
|
+
* Updated formation
|
|
11306
12741
|
*/
|
|
11307
|
-
200:
|
|
11308
|
-
[key: string]: string;
|
|
11309
|
-
};
|
|
12742
|
+
200: Formation;
|
|
11310
12743
|
};
|
|
11311
|
-
type
|
|
11312
|
-
type
|
|
11313
|
-
body
|
|
11314
|
-
[key: string]: string;
|
|
11315
|
-
};
|
|
12744
|
+
type UpdateFormationResponse = UpdateFormationResponses[keyof UpdateFormationResponses];
|
|
12745
|
+
type ListFormationEventsData = {
|
|
12746
|
+
body?: never;
|
|
11316
12747
|
path: {
|
|
11317
12748
|
/**
|
|
11318
12749
|
* Project public ID (proj_ prefix).
|
|
11319
12750
|
*/
|
|
11320
12751
|
project_id: string;
|
|
12752
|
+
formation_id: string;
|
|
12753
|
+
};
|
|
12754
|
+
query?: {
|
|
11321
12755
|
/**
|
|
11322
|
-
*
|
|
12756
|
+
* Maximum number of results to return
|
|
11323
12757
|
*/
|
|
11324
|
-
|
|
12758
|
+
limit?: number;
|
|
12759
|
+
/**
|
|
12760
|
+
* Number of results to skip
|
|
12761
|
+
*/
|
|
12762
|
+
offset?: number;
|
|
11325
12763
|
};
|
|
11326
|
-
|
|
11327
|
-
url: '/v1/projects/{project_id}/files/{file_id}/tags';
|
|
12764
|
+
url: '/v1/projects/{project_id}/formations/{formation_id}/events';
|
|
11328
12765
|
};
|
|
11329
|
-
type
|
|
12766
|
+
type ListFormationEventsErrors = {
|
|
11330
12767
|
/**
|
|
11331
|
-
*
|
|
12768
|
+
* Unauthorized
|
|
11332
12769
|
*/
|
|
11333
|
-
401:
|
|
12770
|
+
401: unknown;
|
|
11334
12771
|
/**
|
|
11335
|
-
*
|
|
11336
|
-
*
|
|
12772
|
+
* Forbidden
|
|
11337
12773
|
*/
|
|
11338
|
-
403:
|
|
12774
|
+
403: unknown;
|
|
11339
12775
|
/**
|
|
11340
|
-
*
|
|
12776
|
+
* Not Found
|
|
11341
12777
|
*/
|
|
11342
|
-
404:
|
|
12778
|
+
404: unknown;
|
|
11343
12779
|
};
|
|
11344
|
-
type
|
|
11345
|
-
type ReplaceFileTagsResponses = {
|
|
12780
|
+
type ListFormationEventsResponses = {
|
|
11346
12781
|
/**
|
|
11347
|
-
*
|
|
12782
|
+
* List of operations
|
|
11348
12783
|
*/
|
|
11349
12784
|
200: {
|
|
11350
|
-
|
|
12785
|
+
data: Array<FormationOperation>;
|
|
12786
|
+
total: number;
|
|
12787
|
+
limit: number;
|
|
12788
|
+
offset: number;
|
|
11351
12789
|
};
|
|
11352
12790
|
};
|
|
11353
|
-
type
|
|
12791
|
+
type ListFormationEventsResponse = ListFormationEventsResponses[keyof ListFormationEventsResponses];
|
|
11354
12792
|
type ListGenerationsData = {
|
|
11355
12793
|
body?: never;
|
|
11356
12794
|
path: {
|
|
@@ -17725,6 +19163,70 @@ declare class Files {
|
|
|
17725
19163
|
*/
|
|
17726
19164
|
static replaceFileTags<ThrowOnError extends boolean = false>(options: Options<ReplaceFileTagsData, ThrowOnError>): RequestResult<ReplaceFileTagsResponses, ReplaceFileTagsErrors, ThrowOnError>;
|
|
17727
19165
|
}
|
|
19166
|
+
declare class Formations {
|
|
19167
|
+
/**
|
|
19168
|
+
* Validate a formation template
|
|
19169
|
+
*
|
|
19170
|
+
* 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.
|
|
19171
|
+
*
|
|
19172
|
+
*/
|
|
19173
|
+
static validateFormation<ThrowOnError extends boolean = false>(options: Options<ValidateFormationData, ThrowOnError>): RequestResult<ValidateFormationResponses, ValidateFormationErrors, ThrowOnError>;
|
|
19174
|
+
/**
|
|
19175
|
+
* Plan a formation deployment
|
|
19176
|
+
*
|
|
19177
|
+
* Computes a diff between the desired template and the current stack state without making any changes. Returns the list of planned actions.
|
|
19178
|
+
*
|
|
19179
|
+
*/
|
|
19180
|
+
static planFormation<ThrowOnError extends boolean = false>(options: Options<PlanFormationData, ThrowOnError>): RequestResult<PlanFormationResponses, PlanFormationErrors, ThrowOnError>;
|
|
19181
|
+
/**
|
|
19182
|
+
* List formations
|
|
19183
|
+
*
|
|
19184
|
+
* Returns all formation stacks for a project
|
|
19185
|
+
*/
|
|
19186
|
+
static listFormations<ThrowOnError extends boolean = false>(options: Options<ListFormationsData, ThrowOnError>): RequestResult<ListFormationsResponses, ListFormationsErrors, ThrowOnError>;
|
|
19187
|
+
/**
|
|
19188
|
+
* Create a new formation
|
|
19189
|
+
*
|
|
19190
|
+
* Validates the template, creates the formation record, then provisions all declared resources in dependency order.
|
|
19191
|
+
*
|
|
19192
|
+
* 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.
|
|
19193
|
+
*
|
|
19194
|
+
*/
|
|
19195
|
+
static createFormation<ThrowOnError extends boolean = false>(options: Options<CreateFormationData, ThrowOnError>): RequestResult<CreateFormationResponses, CreateFormationErrors, ThrowOnError>;
|
|
19196
|
+
/**
|
|
19197
|
+
* Delete an formation
|
|
19198
|
+
*
|
|
19199
|
+
* Deletes the formation stack and all its managed resources in reverse dependency order.
|
|
19200
|
+
*
|
|
19201
|
+
* 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.
|
|
19202
|
+
*
|
|
19203
|
+
* 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.
|
|
19204
|
+
*
|
|
19205
|
+
*/
|
|
19206
|
+
static deleteFormation<ThrowOnError extends boolean = false>(options: Options<DeleteFormationData, ThrowOnError>): RequestResult<DeleteFormationResponses, DeleteFormationErrors, ThrowOnError>;
|
|
19207
|
+
/**
|
|
19208
|
+
* Get a specific formation
|
|
19209
|
+
*
|
|
19210
|
+
* Returns the formation stack including its current resources.
|
|
19211
|
+
*/
|
|
19212
|
+
static getFormation<ThrowOnError extends boolean = false>(options: Options<GetFormationData, ThrowOnError>): RequestResult<GetFormationResponses, GetFormationErrors, ThrowOnError>;
|
|
19213
|
+
/**
|
|
19214
|
+
* Update an formation
|
|
19215
|
+
*
|
|
19216
|
+
* Applies a new template to the formation. Resources are created, updated, or deleted to reconcile the current state with the desired state.
|
|
19217
|
+
*
|
|
19218
|
+
* 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.
|
|
19219
|
+
*
|
|
19220
|
+
*/
|
|
19221
|
+
static updateFormation<ThrowOnError extends boolean = false>(options: Options<UpdateFormationData, ThrowOnError>): RequestResult<UpdateFormationResponses, UpdateFormationErrors, ThrowOnError>;
|
|
19222
|
+
/**
|
|
19223
|
+
* List formation operation events
|
|
19224
|
+
*
|
|
19225
|
+
* Returns all operations (create, update, delete) with their event logs for the formation, ordered chronologically.
|
|
19226
|
+
*
|
|
19227
|
+
*/
|
|
19228
|
+
static listFormationEvents<ThrowOnError extends boolean = false>(options: Options<ListFormationEventsData, ThrowOnError>): RequestResult<ListFormationEventsResponses, ListFormationEventsErrors, ThrowOnError>;
|
|
19229
|
+
}
|
|
17728
19230
|
declare class Generations {
|
|
17729
19231
|
/**
|
|
17730
19232
|
* List generations
|
|
@@ -18688,6 +20190,7 @@ declare class NaturaliClient {
|
|
|
18688
20190
|
readonly evaluations: typeof Evaluations;
|
|
18689
20191
|
readonly exceptions: typeof Exceptions;
|
|
18690
20192
|
readonly files: typeof Files;
|
|
20193
|
+
readonly formations: typeof Formations;
|
|
18691
20194
|
readonly generations: typeof Generations;
|
|
18692
20195
|
readonly guardrails: typeof Guardrails;
|
|
18693
20196
|
readonly ingestionRules: typeof IngestionRules;
|
|
@@ -18713,4 +20216,4 @@ declare class NaturaliClient {
|
|
|
18713
20216
|
constructor({ token, headers }?: NaturaliClientOptions);
|
|
18714
20217
|
}
|
|
18715
20218
|
//#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 };
|
|
20219
|
+
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 };
|