@soat/sdk 0.20.4 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +318 -113
- package/dist/index.d.cts +1529 -650
- package/dist/index.d.mts +1529 -650
- package/dist/index.mjs +318 -113
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -569,6 +569,10 @@ type AgentRelease = {
|
|
|
569
569
|
* Percentage of traffic assigned to `canary_version`
|
|
570
570
|
*/
|
|
571
571
|
canary_percent: number;
|
|
572
|
+
/**
|
|
573
|
+
* Eval that must have a passing run against `canary_version` before `promote` is allowed, or null for an ungated rollout. The gate constrains only how the rollout ends — traffic is split the same way either way. See [Eval-gated promotion](/docs/modules/agents#eval-gated-promotion).
|
|
574
|
+
*/
|
|
575
|
+
promotion_gate?: string | null;
|
|
572
576
|
};
|
|
573
577
|
/**
|
|
574
578
|
* An immutable archive of an agent's configuration at one version.
|
|
@@ -598,6 +602,10 @@ type AgentVersion = {
|
|
|
598
602
|
* Optional human tag, set with `version_label` on the write that created this version. Restore, promote and abort set one automatically (e.g. `restored from v1`).
|
|
599
603
|
*/
|
|
600
604
|
label?: string | null;
|
|
605
|
+
/**
|
|
606
|
+
* The eval run that cleared the release's `promotion_gate` when this version was promoted. Null for every version that did not go live through a gated promotion — which is most of them.
|
|
607
|
+
*/
|
|
608
|
+
eval_run_id?: string | null;
|
|
601
609
|
/**
|
|
602
610
|
* Public ID of the user whose action produced this version. A formation apply is attributed to the project's owning identity; null when no principal could be resolved.
|
|
603
611
|
*/
|
|
@@ -623,6 +631,10 @@ type SetAgentReleaseRequest = {
|
|
|
623
631
|
* Percentage of traffic to assign to `canary_version`
|
|
624
632
|
*/
|
|
625
633
|
canary_percent: number;
|
|
634
|
+
/**
|
|
635
|
+
* Eval to gate promotion on. It must belong to this project and evaluate this agent; anything else is a `400`. Omit it, or send null, for a rollout that can be promoted at will.
|
|
636
|
+
*/
|
|
637
|
+
promotion_gate?: string | null;
|
|
626
638
|
};
|
|
627
639
|
/**
|
|
628
640
|
* One agent↔tool attachment. Exactly one of `tool_id` (persisted tool reference) or `tool` (inline ephemeral definition) per entry. Tool-call gating is owned by [Guardrails](/docs/modules/guardrails), attached via `guardrail_ids` on the project, agent, or tool — not on the binding.
|
|
@@ -952,6 +964,15 @@ type SubmitToolOutputsRequest = {
|
|
|
952
964
|
output: unknown;
|
|
953
965
|
}>;
|
|
954
966
|
};
|
|
967
|
+
/**
|
|
968
|
+
* Handle for a generation running in the background. The generation record already exists when this is returned, so the id is immediately pollable via `GET /api/v1/generations/{generation_id}`.
|
|
969
|
+
*
|
|
970
|
+
*/
|
|
971
|
+
type AcceptedGenerationResponse = {
|
|
972
|
+
status: 'accepted';
|
|
973
|
+
generation_id: string;
|
|
974
|
+
trace_id: string;
|
|
975
|
+
};
|
|
955
976
|
/**
|
|
956
977
|
* Result of an agent generation. Mirrors the server's `GenerationResult`. When `status` is `completed` the model output is under `output`; when it is `requires_action` the pending client tool calls are under `required_action`.
|
|
957
978
|
*
|
|
@@ -1087,6 +1108,49 @@ type UpsertProviderPricesRequest = {
|
|
|
1087
1108
|
effective_from: Date;
|
|
1088
1109
|
}>;
|
|
1089
1110
|
};
|
|
1111
|
+
type ProviderModelsResponse = {
|
|
1112
|
+
/**
|
|
1113
|
+
* The provider slug the listing came from
|
|
1114
|
+
*/
|
|
1115
|
+
provider: string;
|
|
1116
|
+
models: Array<{
|
|
1117
|
+
/**
|
|
1118
|
+
* The provider-native model id, ready to use as `default_model` or an agent's `model`
|
|
1119
|
+
*
|
|
1120
|
+
*/
|
|
1121
|
+
id: string;
|
|
1122
|
+
/**
|
|
1123
|
+
* The provider's own human-readable name, when it reports one
|
|
1124
|
+
*/
|
|
1125
|
+
display_name?: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* Who makes the model, when the provider reports it
|
|
1128
|
+
*/
|
|
1129
|
+
vendor?: string;
|
|
1130
|
+
/**
|
|
1131
|
+
* Lowercased input modalities, when the provider reports them
|
|
1132
|
+
*/
|
|
1133
|
+
input_modalities?: Array<string>;
|
|
1134
|
+
/**
|
|
1135
|
+
* Lowercased output modalities, when the provider reports them
|
|
1136
|
+
*/
|
|
1137
|
+
output_modalities?: Array<string>;
|
|
1138
|
+
/**
|
|
1139
|
+
* Whether the model supports streaming responses
|
|
1140
|
+
*/
|
|
1141
|
+
streaming?: boolean;
|
|
1142
|
+
/**
|
|
1143
|
+
* `active`, `legacy` or `deprecated`, as the provider reports it. A model that is not `active` still serves today but should not be pinned by anything new.
|
|
1144
|
+
*
|
|
1145
|
+
*/
|
|
1146
|
+
lifecycle?: 'active' | 'legacy' | 'deprecated';
|
|
1147
|
+
/**
|
|
1148
|
+
* Lowercased inference types the model supports, when reported. A Bedrock model offering only `inference_profile` must be invoked through a cross-region profile id rather than the bare model id.
|
|
1149
|
+
*
|
|
1150
|
+
*/
|
|
1151
|
+
inference_types?: Array<string>;
|
|
1152
|
+
}>;
|
|
1153
|
+
};
|
|
1090
1154
|
type ApiKeyRecord = {
|
|
1091
1155
|
/**
|
|
1092
1156
|
* Public API key ID (key_ prefix)
|
|
@@ -1519,104 +1583,6 @@ type GenerateConversationMessageResponse = ({
|
|
|
1519
1583
|
} & GenerateConversationMessageCompleted) | ({
|
|
1520
1584
|
status: 'requires_action';
|
|
1521
1585
|
} & GenerateConversationMessageRequiresAction);
|
|
1522
|
-
/**
|
|
1523
|
-
* Override for the final synthesis pass that weighs the deliberation into a single outcome.
|
|
1524
|
-
*/
|
|
1525
|
-
type SynthesisConfig = {
|
|
1526
|
-
ai_provider_id?: string;
|
|
1527
|
-
model?: string;
|
|
1528
|
-
/**
|
|
1529
|
-
* Synthesis prompt template. Supports {steps.deliberation} and {topic}.
|
|
1530
|
-
*/
|
|
1531
|
-
prompt?: string;
|
|
1532
|
-
/**
|
|
1533
|
-
* Provider-native reasoning effort for the synthesis completion.
|
|
1534
|
-
*/
|
|
1535
|
-
effort?: 'low' | 'medium' | 'high';
|
|
1536
|
-
} | null;
|
|
1537
|
-
/**
|
|
1538
|
-
* A participant in the deliberation.
|
|
1539
|
-
*/
|
|
1540
|
-
type ParticipantInput = {
|
|
1541
|
-
/**
|
|
1542
|
-
* Display label used for transcript attribution.
|
|
1543
|
-
*/
|
|
1544
|
-
name?: string | null;
|
|
1545
|
-
/**
|
|
1546
|
-
* Persona prompt for this participant.
|
|
1547
|
-
*/
|
|
1548
|
-
prompt?: string | null;
|
|
1549
|
-
/**
|
|
1550
|
-
* Turn order (defaults to array index).
|
|
1551
|
-
*/
|
|
1552
|
-
position?: number;
|
|
1553
|
-
/**
|
|
1554
|
-
* Durable actor identity to attribute this participant's turns to.
|
|
1555
|
-
*/
|
|
1556
|
-
actor_id?: string | null;
|
|
1557
|
-
ai_provider_id?: string | null;
|
|
1558
|
-
model?: string | null;
|
|
1559
|
-
temperature?: number | null;
|
|
1560
|
-
/**
|
|
1561
|
-
* Provider-native reasoning effort for this participant's turns.
|
|
1562
|
-
*/
|
|
1563
|
-
effort?: 'low' | 'medium' | 'high' | null;
|
|
1564
|
-
};
|
|
1565
|
-
type ParticipantRecord = {
|
|
1566
|
-
id?: string;
|
|
1567
|
-
name?: string | null;
|
|
1568
|
-
prompt?: string | null;
|
|
1569
|
-
position?: number;
|
|
1570
|
-
actor_id?: string | null;
|
|
1571
|
-
ai_provider_id?: string | null;
|
|
1572
|
-
model?: string | null;
|
|
1573
|
-
temperature?: number | null;
|
|
1574
|
-
effort?: string | null;
|
|
1575
|
-
};
|
|
1576
|
-
type DiscussionRecord = {
|
|
1577
|
-
id?: string;
|
|
1578
|
-
project_id?: string;
|
|
1579
|
-
name?: string;
|
|
1580
|
-
description?: string | null;
|
|
1581
|
-
max_rounds?: number;
|
|
1582
|
-
ai_provider_id?: string | null;
|
|
1583
|
-
model?: string | null;
|
|
1584
|
-
synthesis?: SynthesisConfig;
|
|
1585
|
-
tags?: {
|
|
1586
|
-
[key: string]: string;
|
|
1587
|
-
};
|
|
1588
|
-
participants?: Array<ParticipantRecord>;
|
|
1589
|
-
/**
|
|
1590
|
-
* Non-blocking warnings for participant/synthesis prompt `{token}` references outside the allowlist ({topic}, {transcript}, {steps.deliberation}, {steps.deliberation.last}). Unknown tokens are not rejected — they pass through unresolved — so this is informational only.
|
|
1591
|
-
*/
|
|
1592
|
-
template_warnings?: Array<string>;
|
|
1593
|
-
created_at?: Date;
|
|
1594
|
-
updated_at?: Date;
|
|
1595
|
-
};
|
|
1596
|
-
type DiscussionRunRecord = {
|
|
1597
|
-
id?: string;
|
|
1598
|
-
discussion_id?: string;
|
|
1599
|
-
project_id?: string;
|
|
1600
|
-
topic?: string;
|
|
1601
|
-
status?: 'pending' | 'running' | 'completed' | 'failed';
|
|
1602
|
-
/**
|
|
1603
|
-
* The synthesized outcome text (the tool-result contract).
|
|
1604
|
-
*/
|
|
1605
|
-
outcome?: string | null;
|
|
1606
|
-
conversation_id?: string | null;
|
|
1607
|
-
outcome_document_id?: string | null;
|
|
1608
|
-
/**
|
|
1609
|
-
* Type of the principal that invoked the run. Read-only: derived from the authenticated caller, never accepted from a request body.
|
|
1610
|
-
*/
|
|
1611
|
-
started_by_principal_type?: 'user' | 'api_key' | null;
|
|
1612
|
-
/**
|
|
1613
|
-
* Public id of the principal that invoked the run — the API key's own id (`key_…`) when a key was used, otherwise the user's (`user_…`). Read-only, like `started_by_principal_type`.
|
|
1614
|
-
*/
|
|
1615
|
-
started_by_principal_id?: string | null;
|
|
1616
|
-
completed_at?: Date | null;
|
|
1617
|
-
created_at?: Date;
|
|
1618
|
-
updated_at?: Date;
|
|
1619
|
-
};
|
|
1620
1586
|
type DocumentRecord = {
|
|
1621
1587
|
/**
|
|
1622
1588
|
* Document ID
|
|
@@ -1714,6 +1680,218 @@ type EmbeddingsResponse = {
|
|
|
1714
1680
|
*/
|
|
1715
1681
|
embeddings?: Array<Array<number>>;
|
|
1716
1682
|
};
|
|
1683
|
+
/**
|
|
1684
|
+
* Messages replayed verbatim as the generation's input
|
|
1685
|
+
*/
|
|
1686
|
+
type DatasetItemInput = Array<{
|
|
1687
|
+
role: string;
|
|
1688
|
+
/**
|
|
1689
|
+
* Message content — a string, or AI SDK content parts
|
|
1690
|
+
*/
|
|
1691
|
+
content: unknown;
|
|
1692
|
+
}>;
|
|
1693
|
+
/**
|
|
1694
|
+
* Scorer configs, a discriminated union on `type`. Each type may appear at most once. Every scorer produces `{ score: 0–1, passed: boolean }`; binary scorers emit 0 or 1.
|
|
1695
|
+
*
|
|
1696
|
+
* `exact_match` compares the trimmed output text to `expected_output`. `contains` looks for `value` in the output text. `json_logic` evaluates `expression` over `{ input, output, object, expected, item.metadata }`, where `object` is the structured output (absent when the agent has no `output_schema`). `output_schema` validates the structured output against the scorer's own `schema`, falling back to the agent's; it requires the agent to carry an `output_schema`, because without one the platform emits no structured output and every item would score 0.
|
|
1697
|
+
*
|
|
1698
|
+
* `llm_judge` grades the output with a model completion, returning a continuous score plus its `reasoning`. Its `pass_threshold` is required: a continuous score says nothing about where "good enough" is, and a defaulted cutoff would silently decide the gate.
|
|
1699
|
+
*/
|
|
1700
|
+
type Scorers = Array<ExactMatchScorer | ContainsScorer | JsonLogicScorer | OutputSchemaScorer | LlmJudgeScorer>;
|
|
1701
|
+
type ExactMatchScorer = {
|
|
1702
|
+
type: 'exact_match';
|
|
1703
|
+
};
|
|
1704
|
+
type ContainsScorer = {
|
|
1705
|
+
type: 'contains';
|
|
1706
|
+
value: string;
|
|
1707
|
+
case_sensitive?: boolean;
|
|
1708
|
+
};
|
|
1709
|
+
type JsonLogicScorer = {
|
|
1710
|
+
type: 'json_logic';
|
|
1711
|
+
/**
|
|
1712
|
+
* A JSON Logic expression; a truthy result scores 1
|
|
1713
|
+
*/
|
|
1714
|
+
expression: {
|
|
1715
|
+
[key: string]: unknown;
|
|
1716
|
+
};
|
|
1717
|
+
};
|
|
1718
|
+
type OutputSchemaScorer = {
|
|
1719
|
+
type: 'output_schema';
|
|
1720
|
+
/**
|
|
1721
|
+
* JSON Schema the structured output is validated against. Frozen here so two runs stay comparable; falls back to the agent's `output_schema` when omitted.
|
|
1722
|
+
*/
|
|
1723
|
+
schema?: {
|
|
1724
|
+
[key: string]: unknown;
|
|
1725
|
+
};
|
|
1726
|
+
};
|
|
1727
|
+
type LlmJudgeScorer = {
|
|
1728
|
+
type: 'llm_judge';
|
|
1729
|
+
/**
|
|
1730
|
+
* The judge prompt. `{{input}}`, `{{output}}` and `{{expected}}` are replaced with the item's input messages, the agent's output text, and the item's `expected_output`. Slots are filled in one pass, so a slot value that itself contains `{{output}}` is not re-expanded. The judge must answer with a JSON object carrying a numeric `score` between 0 and 1 and an optional `reasoning` string; a reply that does not marks the **item** errored, never the run failed and never a score of 0.
|
|
1731
|
+
*/
|
|
1732
|
+
prompt: string;
|
|
1733
|
+
/**
|
|
1734
|
+
* The item passes this scorer when the judge's score is greater than or equal to this value. Required.
|
|
1735
|
+
*/
|
|
1736
|
+
pass_threshold: number;
|
|
1737
|
+
/**
|
|
1738
|
+
* The AI provider that runs the judge; it must belong to the eval's project. Omit to use the project's default model route.
|
|
1739
|
+
*/
|
|
1740
|
+
ai_provider_id?: string | null;
|
|
1741
|
+
/**
|
|
1742
|
+
* Overrides the provider's default model. Pinned per scorer, because deltas between runs judged by different models are not comparable.
|
|
1743
|
+
*/
|
|
1744
|
+
model?: string | null;
|
|
1745
|
+
};
|
|
1746
|
+
type ScorerResult = {
|
|
1747
|
+
/**
|
|
1748
|
+
* The scorer type that produced this entry
|
|
1749
|
+
*/
|
|
1750
|
+
scorer?: string;
|
|
1751
|
+
score?: number;
|
|
1752
|
+
passed?: boolean;
|
|
1753
|
+
/**
|
|
1754
|
+
* The judge's stated rationale; present for `llm_judge` only
|
|
1755
|
+
*/
|
|
1756
|
+
reasoning?: string;
|
|
1757
|
+
};
|
|
1758
|
+
type Dataset = {
|
|
1759
|
+
id?: string;
|
|
1760
|
+
project_id?: string;
|
|
1761
|
+
name?: string;
|
|
1762
|
+
description?: string | null;
|
|
1763
|
+
created_at?: Date;
|
|
1764
|
+
updated_at?: Date;
|
|
1765
|
+
};
|
|
1766
|
+
type DatasetItem = {
|
|
1767
|
+
id?: string;
|
|
1768
|
+
dataset_id?: string;
|
|
1769
|
+
input?: DatasetItemInput;
|
|
1770
|
+
expected_output?: string | null;
|
|
1771
|
+
metadata?: {
|
|
1772
|
+
[key: string]: unknown;
|
|
1773
|
+
} | null;
|
|
1774
|
+
/**
|
|
1775
|
+
* The generation this item was curated from. A curated item is a deliberate fixture: erasing the source generation neither deletes nor mutates it.
|
|
1776
|
+
*/
|
|
1777
|
+
source_generation_id?: string | null;
|
|
1778
|
+
created_at?: Date;
|
|
1779
|
+
updated_at?: Date;
|
|
1780
|
+
};
|
|
1781
|
+
type Eval = {
|
|
1782
|
+
id?: string;
|
|
1783
|
+
project_id?: string;
|
|
1784
|
+
name?: string;
|
|
1785
|
+
agent_id?: string;
|
|
1786
|
+
dataset_id?: string;
|
|
1787
|
+
scorers?: Scorers;
|
|
1788
|
+
pass_threshold?: number | null;
|
|
1789
|
+
created_at?: Date;
|
|
1790
|
+
updated_at?: Date;
|
|
1791
|
+
};
|
|
1792
|
+
/**
|
|
1793
|
+
* Per-scorer rollup plus the run-level pass rate; null until the run is terminal
|
|
1794
|
+
*/
|
|
1795
|
+
type AggregateScores = {
|
|
1796
|
+
scorers?: {
|
|
1797
|
+
[key: string]: {
|
|
1798
|
+
mean?: number;
|
|
1799
|
+
pass_rate?: number;
|
|
1800
|
+
};
|
|
1801
|
+
};
|
|
1802
|
+
/**
|
|
1803
|
+
* Passed items over non-errored items; null when nothing was scorable
|
|
1804
|
+
*/
|
|
1805
|
+
pass_rate?: number | null;
|
|
1806
|
+
/**
|
|
1807
|
+
* Items that produced a score — errored items are excluded
|
|
1808
|
+
*/
|
|
1809
|
+
scored_item_count?: number;
|
|
1810
|
+
baseline?: BaselineComparison;
|
|
1811
|
+
} | null;
|
|
1812
|
+
/**
|
|
1813
|
+
* Comparison against the run named by `baseline_run_id`; absent when the run named none.
|
|
1814
|
+
*
|
|
1815
|
+
* Every number here is computed over the **item intersection** — the dataset items present and scorable in both runs — because a delta only means something when both sides answered the same question. The compared/added/removed counts make any dataset drift visible instead of letting it read as agent regression. Positive deltas mean this run scored higher than the baseline.
|
|
1816
|
+
*/
|
|
1817
|
+
type BaselineComparison = {
|
|
1818
|
+
run_id?: string;
|
|
1819
|
+
/**
|
|
1820
|
+
* Items scorable in both runs — the basis of every delta
|
|
1821
|
+
*/
|
|
1822
|
+
compared_item_count?: number;
|
|
1823
|
+
/**
|
|
1824
|
+
* Scorable here but not in the baseline (added, or errored there)
|
|
1825
|
+
*/
|
|
1826
|
+
added_item_count?: number;
|
|
1827
|
+
/**
|
|
1828
|
+
* Scorable in the baseline but not here (removed, or errored here)
|
|
1829
|
+
*/
|
|
1830
|
+
removed_item_count?: number;
|
|
1831
|
+
/**
|
|
1832
|
+
* Run-level pass-rate delta over the intersection; null when the two runs share no comparable item
|
|
1833
|
+
*/
|
|
1834
|
+
pass_rate_delta?: number | null;
|
|
1835
|
+
/**
|
|
1836
|
+
* Per-scorer deltas, keyed by scorer type. A scorer only one of the two runs ran is omitted rather than compared against nothing.
|
|
1837
|
+
*/
|
|
1838
|
+
scorers?: {
|
|
1839
|
+
[key: string]: {
|
|
1840
|
+
mean_delta?: number;
|
|
1841
|
+
pass_rate_delta?: number;
|
|
1842
|
+
};
|
|
1843
|
+
};
|
|
1844
|
+
} | null;
|
|
1845
|
+
type EvalRun = {
|
|
1846
|
+
id?: string;
|
|
1847
|
+
eval_id?: string;
|
|
1848
|
+
/**
|
|
1849
|
+
* The one agent version every item in this run executed against
|
|
1850
|
+
*/
|
|
1851
|
+
agent_version?: number;
|
|
1852
|
+
status?: 'queued' | 'running' | 'completed' | 'failed' | 'canceled';
|
|
1853
|
+
baseline_run_id?: string | null;
|
|
1854
|
+
/**
|
|
1855
|
+
* The trigger that started this run — set when a schedule (or a manual trigger fire) started it, null for a run started through this API. Kept even if the trigger is later deleted.
|
|
1856
|
+
*/
|
|
1857
|
+
trigger_id?: string | null;
|
|
1858
|
+
aggregate_scores?: AggregateScores;
|
|
1859
|
+
/**
|
|
1860
|
+
* Null when the eval declares no pass_threshold, and until the run is terminal
|
|
1861
|
+
*/
|
|
1862
|
+
passed?: boolean | null;
|
|
1863
|
+
item_count?: number;
|
|
1864
|
+
completed_count?: number;
|
|
1865
|
+
errored_count?: number;
|
|
1866
|
+
started_at?: Date | null;
|
|
1867
|
+
finished_at?: Date | null;
|
|
1868
|
+
created_at?: Date;
|
|
1869
|
+
};
|
|
1870
|
+
type EvalResult = {
|
|
1871
|
+
id?: string;
|
|
1872
|
+
eval_run_id?: string;
|
|
1873
|
+
/**
|
|
1874
|
+
* Null once the dataset item has been deleted
|
|
1875
|
+
*/
|
|
1876
|
+
dataset_item_id?: string | null;
|
|
1877
|
+
input?: DatasetItemInput;
|
|
1878
|
+
expected_output?: string | null;
|
|
1879
|
+
generation_id?: string | null;
|
|
1880
|
+
/**
|
|
1881
|
+
* The agent's final output text. Cleared when the linked generation's content is purged; the scores and the frozen input survive.
|
|
1882
|
+
*/
|
|
1883
|
+
output?: string | null;
|
|
1884
|
+
scores?: Array<ScorerResult>;
|
|
1885
|
+
/**
|
|
1886
|
+
* AND over the per-scorer passed flags
|
|
1887
|
+
*/
|
|
1888
|
+
passed?: boolean;
|
|
1889
|
+
/**
|
|
1890
|
+
* Item-level failure reason. A generation that did not complete — a `requires_action` pause, a provider failure — is recorded here and excluded from the aggregates rather than scored 0.
|
|
1891
|
+
*/
|
|
1892
|
+
error?: string | null;
|
|
1893
|
+
created_at?: Date;
|
|
1894
|
+
};
|
|
1717
1895
|
type ExceptionItem = {
|
|
1718
1896
|
id?: string;
|
|
1719
1897
|
project_id?: string;
|
|
@@ -2295,6 +2473,71 @@ type ToolResourceProperties = {
|
|
|
2295
2473
|
*/
|
|
2296
2474
|
guardrail_ids?: Array<string> | null;
|
|
2297
2475
|
};
|
|
2476
|
+
/**
|
|
2477
|
+
* 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.
|
|
2478
|
+
*/
|
|
2479
|
+
type DatasetResourceProperties = {
|
|
2480
|
+
/**
|
|
2481
|
+
* Dataset name, unique within the project
|
|
2482
|
+
*/
|
|
2483
|
+
name: string;
|
|
2484
|
+
/**
|
|
2485
|
+
* Optional description
|
|
2486
|
+
*/
|
|
2487
|
+
description?: string | null;
|
|
2488
|
+
};
|
|
2489
|
+
/**
|
|
2490
|
+
* 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.
|
|
2491
|
+
*/
|
|
2492
|
+
type DatasetItemResourceProperties = {
|
|
2493
|
+
/**
|
|
2494
|
+
* Public ID of the parent dataset (or ref expression)
|
|
2495
|
+
*/
|
|
2496
|
+
dataset_id: string;
|
|
2497
|
+
/**
|
|
2498
|
+
* The messages sent to the agent, as `{role, content}` objects
|
|
2499
|
+
*/
|
|
2500
|
+
input: Array<{
|
|
2501
|
+
[key: string]: unknown;
|
|
2502
|
+
}>;
|
|
2503
|
+
/**
|
|
2504
|
+
* Reference answer for exact_match / contains / llm_judge scorers
|
|
2505
|
+
*/
|
|
2506
|
+
expected_output?: string | null;
|
|
2507
|
+
/**
|
|
2508
|
+
* Free-form tags on the case, e.g. `{"topic": "billing"}`
|
|
2509
|
+
*/
|
|
2510
|
+
metadata?: {
|
|
2511
|
+
[key: string]: unknown;
|
|
2512
|
+
} | null;
|
|
2513
|
+
};
|
|
2514
|
+
/**
|
|
2515
|
+
* 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.
|
|
2516
|
+
*/
|
|
2517
|
+
type EvalResourceProperties = {
|
|
2518
|
+
/**
|
|
2519
|
+
* Eval name, unique within the project
|
|
2520
|
+
*/
|
|
2521
|
+
name: string;
|
|
2522
|
+
/**
|
|
2523
|
+
* Public ID of the agent under test (or ref expression)
|
|
2524
|
+
*/
|
|
2525
|
+
agent_id: string;
|
|
2526
|
+
/**
|
|
2527
|
+
* Public ID of the dataset to run against (or ref expression)
|
|
2528
|
+
*/
|
|
2529
|
+
dataset_id: string;
|
|
2530
|
+
/**
|
|
2531
|
+
* Scorer configs — `exact_match`, `contains`, `json_logic`, `output_schema`, or `llm_judge`. Same shape as the evals REST contract.
|
|
2532
|
+
*/
|
|
2533
|
+
scorers: Array<{
|
|
2534
|
+
[key: string]: unknown;
|
|
2535
|
+
}>;
|
|
2536
|
+
/**
|
|
2537
|
+
* 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.
|
|
2538
|
+
*/
|
|
2539
|
+
pass_threshold?: number | null;
|
|
2540
|
+
};
|
|
2298
2541
|
/**
|
|
2299
2542
|
* Stores a text document in a project, optionally indexing it for knowledge retrieval.
|
|
2300
2543
|
*/
|
|
@@ -2433,7 +2676,7 @@ type WebhookResourceProperties = {
|
|
|
2433
2676
|
events: Array<string>;
|
|
2434
2677
|
};
|
|
2435
2678
|
/**
|
|
2436
|
-
* Binds a starter (manual, webhook, or schedule) to an executable target (orchestration, agent, or
|
|
2679
|
+
* Binds a starter (manual, webhook, or schedule) to an executable target (orchestration, agent, tool, or eval). Firings run under the project owner's confined run-as identity.
|
|
2437
2680
|
*/
|
|
2438
2681
|
type TriggerResourceProperties = {
|
|
2439
2682
|
/**
|
|
@@ -2451,9 +2694,9 @@ type TriggerResourceProperties = {
|
|
|
2451
2694
|
/**
|
|
2452
2695
|
* The kind of resource this trigger activates
|
|
2453
2696
|
*/
|
|
2454
|
-
target_type: 'orchestration' | 'agent' | 'tool';
|
|
2697
|
+
target_type: 'orchestration' | 'agent' | 'tool' | 'eval';
|
|
2455
2698
|
/**
|
|
2456
|
-
* Public ID of the target resource. Use { "ref": "LogicalId" } to reference an orchestration, agent, or
|
|
2699
|
+
* Public ID of the target resource. Use { "ref": "LogicalId" } to reference an orchestration, agent, tool, or eval defined in the template.
|
|
2457
2700
|
*/
|
|
2458
2701
|
target_id: string;
|
|
2459
2702
|
/**
|
|
@@ -2531,43 +2774,9 @@ type ConversationResourceProperties = {
|
|
|
2531
2774
|
actor_id?: string | null;
|
|
2532
2775
|
};
|
|
2533
2776
|
/**
|
|
2534
|
-
*
|
|
2777
|
+
* Registers a file record within the formation's project.
|
|
2535
2778
|
*/
|
|
2536
|
-
type
|
|
2537
|
-
/**
|
|
2538
|
-
* Display name of the discussion
|
|
2539
|
-
*/
|
|
2540
|
-
name: string;
|
|
2541
|
-
description?: string | null;
|
|
2542
|
-
/**
|
|
2543
|
-
* Default AI provider participants and synthesis fall back to. Omit (or declare `null`) to inherit the project's `default_model_route_id`, which requires the project to have one.
|
|
2544
|
-
*/
|
|
2545
|
-
ai_provider_id?: string | null;
|
|
2546
|
-
/**
|
|
2547
|
-
* Default model (falls back to the provider's default_model)
|
|
2548
|
-
*/
|
|
2549
|
-
model?: string | null;
|
|
2550
|
-
/**
|
|
2551
|
-
* Rounds of deliberation (1–3, default 1)
|
|
2552
|
-
*/
|
|
2553
|
-
max_rounds?: number | null;
|
|
2554
|
-
/**
|
|
2555
|
-
* Override for the final synthesis pass
|
|
2556
|
-
*/
|
|
2557
|
-
synthesis?: {
|
|
2558
|
-
[key: string]: unknown;
|
|
2559
|
-
} | null;
|
|
2560
|
-
/**
|
|
2561
|
-
* The deliberation participants (max 5)
|
|
2562
|
-
*/
|
|
2563
|
-
participants?: Array<{
|
|
2564
|
-
[key: string]: unknown;
|
|
2565
|
-
}>;
|
|
2566
|
-
};
|
|
2567
|
-
/**
|
|
2568
|
-
* Registers a file record within the formation's project.
|
|
2569
|
-
*/
|
|
2570
|
-
type FileResourceProperties = {
|
|
2779
|
+
type FileResourceProperties = {
|
|
2571
2780
|
/**
|
|
2572
2781
|
* Directory within the project. Optional; defaults to / (root). Combined with filename to form the file's key (path).
|
|
2573
2782
|
*/
|
|
@@ -2880,12 +3089,12 @@ type ResourceDeclaration = {
|
|
|
2880
3089
|
/**
|
|
2881
3090
|
* Resource type
|
|
2882
3091
|
*/
|
|
2883
|
-
type: 'ai_provider' | 'tool' | 'agent' | 'actor' | 'api_key' | 'chat' | 'conversation' | 'document' | 'file' | 'guardrail' | 'ingestion_rule' | 'memory' | 'memory_entry' | 'model_route' | '
|
|
3092
|
+
type: 'ai_provider' | 'tool' | 'agent' | 'actor' | 'api_key' | 'chat' | 'conversation' | 'dataset' | 'dataset_item' | 'document' | 'file' | 'guardrail' | 'ingestion_rule' | 'memory' | 'memory_entry' | 'model_route' | 'eval' | 'orchestration' | 'policy' | 'project_price' | 'quota' | 'secret' | 'session' | 'webhook' | 'trigger' | 'workflow';
|
|
2884
3093
|
/**
|
|
2885
3094
|
* Resource properties. Values may use `{ "ref": "logicalId" }` to reference physical IDs of other resources in the template, `{ "param": "ParamName" }` to substitute a parameter value, or `{ "sub": "text ${ParamName}" }` to interpolate parameter values into a string.
|
|
2886
3095
|
*
|
|
2887
3096
|
*/
|
|
2888
|
-
properties: AgentResourceProperties | ActorResourceProperties | AiProviderResourceProperties | ToolResourceProperties | ApiKeyResourceProperties | ChatResourceProperties |
|
|
3097
|
+
properties: AgentResourceProperties | ActorResourceProperties | AiProviderResourceProperties | ToolResourceProperties | ApiKeyResourceProperties | ChatResourceProperties | DatasetResourceProperties | DatasetItemResourceProperties | EvalResourceProperties | ConversationResourceProperties | DocumentResourceProperties | FileResourceProperties | GuardrailResourceProperties | IngestionRuleResourceProperties | MemoryResourceProperties | MemoryEntryResourceProperties | ModelRouteResourceProperties | OrchestrationResourceProperties | PolicyResourceProperties | ProjectPriceResourceProperties | QuotaResourceProperties | SecretResourceProperties | SessionResourceProperties | WebhookResourceProperties | TriggerResourceProperties | WorkflowResourceProperties;
|
|
2889
3098
|
/**
|
|
2890
3099
|
* Explicit dependency list. In addition to implicit `ref` dependencies.
|
|
2891
3100
|
*/
|
|
@@ -4977,9 +5186,9 @@ type Trigger = {
|
|
|
4977
5186
|
name?: string;
|
|
4978
5187
|
description?: string | null;
|
|
4979
5188
|
type?: 'manual' | 'webhook' | 'schedule';
|
|
4980
|
-
target_type?: 'orchestration' | 'agent' | 'tool';
|
|
5189
|
+
target_type?: 'orchestration' | 'agent' | 'tool' | 'eval';
|
|
4981
5190
|
/**
|
|
4982
|
-
* Public ID of the target resource (orchestration, agent, or
|
|
5191
|
+
* Public ID of the target resource (orchestration, agent, tool, or eval)
|
|
4983
5192
|
*/
|
|
4984
5193
|
target_id?: string;
|
|
4985
5194
|
/**
|
|
@@ -4987,7 +5196,7 @@ type Trigger = {
|
|
|
4987
5196
|
*/
|
|
4988
5197
|
action?: string | null;
|
|
4989
5198
|
/**
|
|
4990
|
-
* Static input, shallow-merged under fire-time input
|
|
5199
|
+
* Static input, shallow-merged under fire-time input. For `eval` targets the effective input may carry `agent_version` and `baseline_run_id`, which are passed to the queued run.
|
|
4991
5200
|
*/
|
|
4992
5201
|
input?: {
|
|
4993
5202
|
[key: string]: unknown;
|
|
@@ -5022,7 +5231,7 @@ type CreateTriggerRequest = {
|
|
|
5022
5231
|
name: string;
|
|
5023
5232
|
description?: string;
|
|
5024
5233
|
type: 'manual' | 'webhook' | 'schedule';
|
|
5025
|
-
target_type: 'orchestration' | 'agent' | 'tool';
|
|
5234
|
+
target_type: 'orchestration' | 'agent' | 'tool' | 'eval';
|
|
5026
5235
|
target_id: string;
|
|
5027
5236
|
/**
|
|
5028
5237
|
* Tool targets only — the action for soat/mcp tools
|
|
@@ -5041,7 +5250,7 @@ type CreateTriggerRequest = {
|
|
|
5041
5250
|
type UpdateTriggerRequest = {
|
|
5042
5251
|
name?: string;
|
|
5043
5252
|
description?: string | null;
|
|
5044
|
-
target_type?: 'orchestration' | 'agent' | 'tool';
|
|
5253
|
+
target_type?: 'orchestration' | 'agent' | 'tool' | 'eval';
|
|
5045
5254
|
target_id?: string;
|
|
5046
5255
|
action?: string | null;
|
|
5047
5256
|
input?: {
|
|
@@ -5053,7 +5262,7 @@ type UpdateTriggerRequest = {
|
|
|
5053
5262
|
};
|
|
5054
5263
|
type FireTriggerRequest = {
|
|
5055
5264
|
/**
|
|
5056
|
-
* Fire-time input, shallow-merged over the trigger's static input
|
|
5265
|
+
* Fire-time input, shallow-merged over the trigger's static input. For `eval` targets it may carry `agent_version` and `baseline_run_id`.
|
|
5057
5266
|
*/
|
|
5058
5267
|
input?: {
|
|
5059
5268
|
[key: string]: unknown;
|
|
@@ -6336,7 +6545,12 @@ type CreateAgentGenerationData = {
|
|
|
6336
6545
|
path: {
|
|
6337
6546
|
agent_id: string;
|
|
6338
6547
|
};
|
|
6339
|
-
query?:
|
|
6548
|
+
query?: {
|
|
6549
|
+
/**
|
|
6550
|
+
* When omitted or `false` (default), the generation runs in the background and `202 Accepted` is returned immediately with a `generation_id` to poll. Pass `true` to block until the generation settles and receive the result. Mutually exclusive with `stream: true`. A `soat` tool call always waits.
|
|
6551
|
+
*/
|
|
6552
|
+
wait?: boolean;
|
|
6553
|
+
};
|
|
6340
6554
|
url: '/api/v1/agents/{agent_id}/generate';
|
|
6341
6555
|
};
|
|
6342
6556
|
type CreateAgentGenerationErrors = {
|
|
@@ -6365,9 +6579,13 @@ type CreateAgentGenerationErrors = {
|
|
|
6365
6579
|
type CreateAgentGenerationError = CreateAgentGenerationErrors[keyof CreateAgentGenerationErrors];
|
|
6366
6580
|
type CreateAgentGenerationResponses = {
|
|
6367
6581
|
/**
|
|
6368
|
-
* Generation result or SSE stream
|
|
6582
|
+
* Generation result or SSE stream (only when `?wait=true` or `stream: true`)
|
|
6369
6583
|
*/
|
|
6370
6584
|
200: AgentGenerationResponse;
|
|
6585
|
+
/**
|
|
6586
|
+
* Generation accepted and running in the background (default, when `wait` is omitted or `false`). Poll `GET /api/v1/generations/{generation_id}` for the result.
|
|
6587
|
+
*/
|
|
6588
|
+
202: AcceptedGenerationResponse;
|
|
6371
6589
|
};
|
|
6372
6590
|
type CreateAgentGenerationResponse = CreateAgentGenerationResponses[keyof CreateAgentGenerationResponses];
|
|
6373
6591
|
type SubmitAgentToolOutputsData = {
|
|
@@ -6580,7 +6798,7 @@ type PromoteAgentReleaseErrors = {
|
|
|
6580
6798
|
*/
|
|
6581
6799
|
404: ErrorResponse;
|
|
6582
6800
|
/**
|
|
6583
|
-
* Conflict — the agent has no active release
|
|
6801
|
+
* Conflict — the agent has no active release (`NO_ACTIVE_RELEASE`), or its `promotion_gate` has no passing eval run against the canary version (`PROMOTION_GATE_UNMET`)
|
|
6584
6802
|
*/
|
|
6585
6803
|
409: ErrorResponse;
|
|
6586
6804
|
};
|
|
@@ -6759,7 +6977,7 @@ type DeleteAiProviderData = {
|
|
|
6759
6977
|
};
|
|
6760
6978
|
query?: {
|
|
6761
6979
|
/**
|
|
6762
|
-
* When `true`, delete the provider's price overrides and unlink its usage
|
|
6980
|
+
* When `true`, delete the provider's price overrides and unlink its usage history so a provider with only soft dependents can be removed. Has no effect on live references (chats, agents, model routes), which always block deletion.
|
|
6763
6981
|
*
|
|
6764
6982
|
*/
|
|
6765
6983
|
force?: boolean;
|
|
@@ -6884,6 +7102,47 @@ type UpdateAiProviderResponses = {
|
|
|
6884
7102
|
*/
|
|
6885
7103
|
200: unknown;
|
|
6886
7104
|
};
|
|
7105
|
+
type ListAiProviderModelsData = {
|
|
7106
|
+
body?: never;
|
|
7107
|
+
path: {
|
|
7108
|
+
/**
|
|
7109
|
+
* AI Provider ID
|
|
7110
|
+
*/
|
|
7111
|
+
ai_provider_id: string;
|
|
7112
|
+
};
|
|
7113
|
+
query?: never;
|
|
7114
|
+
url: '/api/v1/ai-providers/{ai_provider_id}/models';
|
|
7115
|
+
};
|
|
7116
|
+
type ListAiProviderModelsErrors = {
|
|
7117
|
+
/**
|
|
7118
|
+
* The provider type cannot enumerate models, or the record is missing configuration the listing needs (a Vertex project, a Bedrock region, a linked API key).
|
|
7119
|
+
*
|
|
7120
|
+
*/
|
|
7121
|
+
400: unknown;
|
|
7122
|
+
/**
|
|
7123
|
+
* Unauthorized
|
|
7124
|
+
*/
|
|
7125
|
+
401: unknown;
|
|
7126
|
+
/**
|
|
7127
|
+
* Forbidden
|
|
7128
|
+
*/
|
|
7129
|
+
403: unknown;
|
|
7130
|
+
/**
|
|
7131
|
+
* AI provider not found
|
|
7132
|
+
*/
|
|
7133
|
+
404: unknown;
|
|
7134
|
+
/**
|
|
7135
|
+
* The provider rejected the listing request
|
|
7136
|
+
*/
|
|
7137
|
+
502: unknown;
|
|
7138
|
+
};
|
|
7139
|
+
type ListAiProviderModelsResponses = {
|
|
7140
|
+
/**
|
|
7141
|
+
* The models this provider can run
|
|
7142
|
+
*/
|
|
7143
|
+
200: ProviderModelsResponse;
|
|
7144
|
+
};
|
|
7145
|
+
type ListAiProviderModelsResponse = ListAiProviderModelsResponses[keyof ListAiProviderModelsResponses];
|
|
6887
7146
|
type GetAiProviderPricesData = {
|
|
6888
7147
|
body?: never;
|
|
6889
7148
|
path: {
|
|
@@ -8054,7 +8313,12 @@ type GenerateConversationMessageData = {
|
|
|
8054
8313
|
path: {
|
|
8055
8314
|
conversation_id: string;
|
|
8056
8315
|
};
|
|
8057
|
-
query?:
|
|
8316
|
+
query?: {
|
|
8317
|
+
/**
|
|
8318
|
+
* When omitted or `false` (default), the generation runs in the background and `202 Accepted` is returned immediately. Pass `true` to block until the generation settles and receive the result. A `soat` tool call always waits.
|
|
8319
|
+
*/
|
|
8320
|
+
wait?: boolean;
|
|
8321
|
+
};
|
|
8058
8322
|
url: '/api/v1/conversations/{conversation_id}/generate';
|
|
8059
8323
|
};
|
|
8060
8324
|
type GenerateConversationMessageErrors = {
|
|
@@ -8082,9 +8346,16 @@ type GenerateConversationMessageErrors = {
|
|
|
8082
8346
|
type GenerateConversationMessageError = GenerateConversationMessageErrors[keyof GenerateConversationMessageErrors];
|
|
8083
8347
|
type GenerateConversationMessageResponses = {
|
|
8084
8348
|
/**
|
|
8085
|
-
* Generation completed or requires action
|
|
8349
|
+
* Generation completed or requires action (only when `?wait=true`)
|
|
8086
8350
|
*/
|
|
8087
8351
|
200: GenerateConversationMessageResponse;
|
|
8352
|
+
/**
|
|
8353
|
+
* Generation accepted and running in the background (default, when `wait` is omitted or `false`). The reply is persisted as a ConversationMessage when it completes.
|
|
8354
|
+
*/
|
|
8355
|
+
202: {
|
|
8356
|
+
status: 'accepted';
|
|
8357
|
+
conversation_id: string;
|
|
8358
|
+
};
|
|
8088
8359
|
};
|
|
8089
8360
|
type GenerateConversationMessageResponse2 = GenerateConversationMessageResponses[keyof GenerateConversationMessageResponses];
|
|
8090
8361
|
type RemoveConversationMessageData = {
|
|
@@ -8233,7 +8504,7 @@ type ReplaceConversationTagsResponses = {
|
|
|
8233
8504
|
};
|
|
8234
8505
|
};
|
|
8235
8506
|
type ReplaceConversationTagsResponse = ReplaceConversationTagsResponses[keyof ReplaceConversationTagsResponses];
|
|
8236
|
-
type
|
|
8507
|
+
type ListDocumentsData = {
|
|
8237
8508
|
body?: never;
|
|
8238
8509
|
path?: never;
|
|
8239
8510
|
query?: {
|
|
@@ -8250,9 +8521,9 @@ type ListDiscussionsData = {
|
|
|
8250
8521
|
*/
|
|
8251
8522
|
offset?: number;
|
|
8252
8523
|
};
|
|
8253
|
-
url: '/api/v1/
|
|
8524
|
+
url: '/api/v1/documents';
|
|
8254
8525
|
};
|
|
8255
|
-
type
|
|
8526
|
+
type ListDocumentsErrors = {
|
|
8256
8527
|
/**
|
|
8257
8528
|
* Unauthorized
|
|
8258
8529
|
*/
|
|
@@ -8262,47 +8533,65 @@ type ListDiscussionsErrors = {
|
|
|
8262
8533
|
*/
|
|
8263
8534
|
403: ErrorResponse;
|
|
8264
8535
|
};
|
|
8265
|
-
type
|
|
8266
|
-
type
|
|
8536
|
+
type ListDocumentsError = ListDocumentsErrors[keyof ListDocumentsErrors];
|
|
8537
|
+
type ListDocumentsResponses = {
|
|
8267
8538
|
/**
|
|
8268
|
-
* List of
|
|
8539
|
+
* List of documents
|
|
8269
8540
|
*/
|
|
8270
8541
|
200: {
|
|
8271
|
-
data?: Array<
|
|
8542
|
+
data?: Array<DocumentRecord>;
|
|
8272
8543
|
total?: number;
|
|
8273
8544
|
limit?: number;
|
|
8274
8545
|
offset?: number;
|
|
8275
8546
|
};
|
|
8276
8547
|
};
|
|
8277
|
-
type
|
|
8278
|
-
type
|
|
8548
|
+
type ListDocumentsResponse = ListDocumentsResponses[keyof ListDocumentsResponses];
|
|
8549
|
+
type CreateDocumentData = {
|
|
8279
8550
|
body: {
|
|
8280
8551
|
/**
|
|
8281
|
-
* Project ID. Required for JWT auth; omit when using
|
|
8552
|
+
* Project ID. Required for JWT auth; omit when using an project key.
|
|
8282
8553
|
*/
|
|
8283
8554
|
project_id?: string;
|
|
8284
|
-
|
|
8285
|
-
|
|
8555
|
+
content: string;
|
|
8556
|
+
/**
|
|
8557
|
+
* Logical path within the project (e.g. /reports/q1.txt). Defaults to /filename if omitted.
|
|
8558
|
+
*/
|
|
8559
|
+
path?: string;
|
|
8560
|
+
filename?: string;
|
|
8561
|
+
/**
|
|
8562
|
+
* Document title
|
|
8563
|
+
*/
|
|
8564
|
+
title?: string;
|
|
8286
8565
|
/**
|
|
8287
|
-
*
|
|
8566
|
+
* 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.
|
|
8288
8567
|
*/
|
|
8289
|
-
|
|
8568
|
+
metadata?: {
|
|
8569
|
+
[key: string]: unknown;
|
|
8570
|
+
};
|
|
8290
8571
|
/**
|
|
8291
|
-
*
|
|
8572
|
+
* Key-value tags
|
|
8292
8573
|
*/
|
|
8293
|
-
model?: string | null;
|
|
8294
|
-
max_rounds?: number;
|
|
8295
|
-
synthesis?: SynthesisConfig;
|
|
8296
8574
|
tags?: {
|
|
8297
8575
|
[key: string]: string;
|
|
8298
8576
|
};
|
|
8299
|
-
|
|
8577
|
+
/**
|
|
8578
|
+
* How to split the content into embeddable chunks. `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.
|
|
8579
|
+
*/
|
|
8580
|
+
chunk_strategy?: 'page' | 'whole' | 'size';
|
|
8581
|
+
/**
|
|
8582
|
+
* Window size in characters when `chunk_strategy=size`. Defaults to 1000.
|
|
8583
|
+
*/
|
|
8584
|
+
chunk_size?: number;
|
|
8585
|
+
/**
|
|
8586
|
+
* Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
|
|
8587
|
+
*/
|
|
8588
|
+
chunk_overlap?: number;
|
|
8300
8589
|
};
|
|
8301
8590
|
path?: never;
|
|
8302
8591
|
query?: never;
|
|
8303
|
-
url: '/api/v1/
|
|
8592
|
+
url: '/api/v1/documents';
|
|
8304
8593
|
};
|
|
8305
|
-
type
|
|
8594
|
+
type CreateDocumentErrors = {
|
|
8306
8595
|
/**
|
|
8307
8596
|
* Invalid request body
|
|
8308
8597
|
*/
|
|
@@ -8316,26 +8605,61 @@ type CreateDiscussionErrors = {
|
|
|
8316
8605
|
*/
|
|
8317
8606
|
403: ErrorResponse;
|
|
8318
8607
|
};
|
|
8319
|
-
type
|
|
8320
|
-
type
|
|
8608
|
+
type CreateDocumentError = CreateDocumentErrors[keyof CreateDocumentErrors];
|
|
8609
|
+
type CreateDocumentResponses = {
|
|
8321
8610
|
/**
|
|
8322
|
-
*
|
|
8611
|
+
* Document created
|
|
8323
8612
|
*/
|
|
8324
|
-
201:
|
|
8613
|
+
201: DocumentRecord;
|
|
8325
8614
|
};
|
|
8326
|
-
type
|
|
8327
|
-
type
|
|
8328
|
-
body
|
|
8329
|
-
|
|
8615
|
+
type CreateDocumentResponse = CreateDocumentResponses[keyof CreateDocumentResponses];
|
|
8616
|
+
type IngestDocumentData = {
|
|
8617
|
+
body: {
|
|
8618
|
+
/**
|
|
8619
|
+
* ID of the uploaded file. Must be one of application/pdf, text/plain, text/markdown.
|
|
8620
|
+
*/
|
|
8621
|
+
file_id: string;
|
|
8622
|
+
/**
|
|
8623
|
+
* Project ID. Required for JWT auth; omit when using a project key.
|
|
8624
|
+
*/
|
|
8625
|
+
project_id?: string;
|
|
8626
|
+
/**
|
|
8627
|
+
* Path prefix under which to store the document (e.g. /docs/). The filename is appended automatically.
|
|
8628
|
+
*/
|
|
8629
|
+
path_prefix?: string;
|
|
8630
|
+
/**
|
|
8631
|
+
* Key-value tags to attach to the document.
|
|
8632
|
+
*/
|
|
8633
|
+
tags?: {
|
|
8634
|
+
[key: string]: string;
|
|
8635
|
+
};
|
|
8636
|
+
/**
|
|
8637
|
+
* 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.
|
|
8638
|
+
*/
|
|
8639
|
+
chunk_strategy?: 'page' | 'whole' | 'size';
|
|
8640
|
+
/**
|
|
8641
|
+
* Window size in characters when `chunk_strategy=size`. Defaults to 1000.
|
|
8642
|
+
*/
|
|
8643
|
+
chunk_size?: number;
|
|
8644
|
+
/**
|
|
8645
|
+
* Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
|
|
8646
|
+
*/
|
|
8647
|
+
chunk_overlap?: number;
|
|
8648
|
+
};
|
|
8649
|
+
path?: never;
|
|
8650
|
+
query?: {
|
|
8330
8651
|
/**
|
|
8331
|
-
*
|
|
8652
|
+
* 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`.
|
|
8332
8653
|
*/
|
|
8333
|
-
|
|
8654
|
+
wait?: boolean;
|
|
8334
8655
|
};
|
|
8335
|
-
|
|
8336
|
-
url: '/api/v1/discussions/runs/{run_id}';
|
|
8656
|
+
url: '/api/v1/documents/ingest';
|
|
8337
8657
|
};
|
|
8338
|
-
type
|
|
8658
|
+
type IngestDocumentErrors = {
|
|
8659
|
+
/**
|
|
8660
|
+
* Invalid request, file not found, or unsupported content type
|
|
8661
|
+
*/
|
|
8662
|
+
400: ErrorResponse;
|
|
8339
8663
|
/**
|
|
8340
8664
|
* Unauthorized
|
|
8341
8665
|
*/
|
|
@@ -8345,30 +8669,38 @@ type GetDiscussionRunErrors = {
|
|
|
8345
8669
|
*/
|
|
8346
8670
|
403: ErrorResponse;
|
|
8347
8671
|
/**
|
|
8348
|
-
*
|
|
8672
|
+
* 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.
|
|
8349
8673
|
*/
|
|
8350
|
-
|
|
8674
|
+
409: ErrorResponse;
|
|
8675
|
+
/**
|
|
8676
|
+
* The file is too large to ingest synchronously (`?wait=true`). Retry in background mode and poll the document status.
|
|
8677
|
+
*/
|
|
8678
|
+
413: ErrorResponse;
|
|
8351
8679
|
};
|
|
8352
|
-
type
|
|
8353
|
-
type
|
|
8680
|
+
type IngestDocumentError = IngestDocumentErrors[keyof IngestDocumentErrors];
|
|
8681
|
+
type IngestDocumentResponses = {
|
|
8682
|
+
/**
|
|
8683
|
+
* Ingestion completed synchronously (only when `?wait=true`). The document is fully indexed and ready for search.
|
|
8684
|
+
*/
|
|
8685
|
+
201: IngestedDocumentRecord;
|
|
8354
8686
|
/**
|
|
8355
|
-
*
|
|
8687
|
+
* Ingestion accepted. The document record has been created with `status=pending` and processing runs in the background. Poll `GET /api/v1/documents/{document_id}` until `status` is `ready` or `failed`.
|
|
8356
8688
|
*/
|
|
8357
|
-
|
|
8689
|
+
202: IngestedDocumentRecord;
|
|
8358
8690
|
};
|
|
8359
|
-
type
|
|
8360
|
-
type
|
|
8691
|
+
type IngestDocumentResponse = IngestDocumentResponses[keyof IngestDocumentResponses];
|
|
8692
|
+
type DeleteDocumentData = {
|
|
8361
8693
|
body?: never;
|
|
8362
8694
|
path: {
|
|
8363
8695
|
/**
|
|
8364
|
-
*
|
|
8696
|
+
* Document ID
|
|
8365
8697
|
*/
|
|
8366
|
-
|
|
8698
|
+
document_id: string;
|
|
8367
8699
|
};
|
|
8368
8700
|
query?: never;
|
|
8369
|
-
url: '/api/v1/
|
|
8701
|
+
url: '/api/v1/documents/{document_id}';
|
|
8370
8702
|
};
|
|
8371
|
-
type
|
|
8703
|
+
type DeleteDocumentErrors = {
|
|
8372
8704
|
/**
|
|
8373
8705
|
* Unauthorized
|
|
8374
8706
|
*/
|
|
@@ -8378,30 +8710,30 @@ type DeleteDiscussionErrors = {
|
|
|
8378
8710
|
*/
|
|
8379
8711
|
403: ErrorResponse;
|
|
8380
8712
|
/**
|
|
8381
|
-
*
|
|
8713
|
+
* Document not found
|
|
8382
8714
|
*/
|
|
8383
8715
|
404: ErrorResponse;
|
|
8384
8716
|
};
|
|
8385
|
-
type
|
|
8386
|
-
type
|
|
8717
|
+
type DeleteDocumentError = DeleteDocumentErrors[keyof DeleteDocumentErrors];
|
|
8718
|
+
type DeleteDocumentResponses = {
|
|
8387
8719
|
/**
|
|
8388
|
-
*
|
|
8720
|
+
* Document deleted
|
|
8389
8721
|
*/
|
|
8390
8722
|
204: void;
|
|
8391
8723
|
};
|
|
8392
|
-
type
|
|
8393
|
-
type
|
|
8724
|
+
type DeleteDocumentResponse = DeleteDocumentResponses[keyof DeleteDocumentResponses];
|
|
8725
|
+
type GetDocumentData = {
|
|
8394
8726
|
body?: never;
|
|
8395
8727
|
path: {
|
|
8396
8728
|
/**
|
|
8397
|
-
*
|
|
8729
|
+
* Document ID
|
|
8398
8730
|
*/
|
|
8399
|
-
|
|
8731
|
+
document_id: string;
|
|
8400
8732
|
};
|
|
8401
8733
|
query?: never;
|
|
8402
|
-
url: '/api/v1/
|
|
8734
|
+
url: '/api/v1/documents/{document_id}';
|
|
8403
8735
|
};
|
|
8404
|
-
type
|
|
8736
|
+
type GetDocumentErrors = {
|
|
8405
8737
|
/**
|
|
8406
8738
|
* Unauthorized
|
|
8407
8739
|
*/
|
|
@@ -8411,48 +8743,55 @@ type GetDiscussionErrors = {
|
|
|
8411
8743
|
*/
|
|
8412
8744
|
403: ErrorResponse;
|
|
8413
8745
|
/**
|
|
8414
|
-
*
|
|
8746
|
+
* Document not found
|
|
8415
8747
|
*/
|
|
8416
8748
|
404: ErrorResponse;
|
|
8417
8749
|
};
|
|
8418
|
-
type
|
|
8419
|
-
type
|
|
8750
|
+
type GetDocumentError = GetDocumentErrors[keyof GetDocumentErrors];
|
|
8751
|
+
type GetDocumentResponses = {
|
|
8420
8752
|
/**
|
|
8421
|
-
*
|
|
8753
|
+
* Document found
|
|
8422
8754
|
*/
|
|
8423
|
-
200:
|
|
8755
|
+
200: DocumentRecord;
|
|
8424
8756
|
};
|
|
8425
|
-
type
|
|
8426
|
-
type
|
|
8757
|
+
type GetDocumentResponse = GetDocumentResponses[keyof GetDocumentResponses];
|
|
8758
|
+
type UpdateDocumentData = {
|
|
8427
8759
|
body: {
|
|
8428
|
-
name?: string;
|
|
8429
|
-
description?: string | null;
|
|
8430
8760
|
/**
|
|
8431
|
-
*
|
|
8761
|
+
* New text content
|
|
8762
|
+
*/
|
|
8763
|
+
content?: string;
|
|
8764
|
+
/**
|
|
8765
|
+
* New title
|
|
8766
|
+
*/
|
|
8767
|
+
title?: string;
|
|
8768
|
+
/**
|
|
8769
|
+
* Logical path within the project (e.g. /reports/q1.txt). Pass null to clear.
|
|
8770
|
+
*/
|
|
8771
|
+
path?: string | null;
|
|
8772
|
+
/**
|
|
8773
|
+
* 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.
|
|
8774
|
+
*/
|
|
8775
|
+
metadata?: {
|
|
8776
|
+
[key: string]: unknown;
|
|
8777
|
+
};
|
|
8778
|
+
/**
|
|
8779
|
+
* Key-value tags
|
|
8432
8780
|
*/
|
|
8433
|
-
ai_provider_id?: string | null;
|
|
8434
|
-
model?: string | null;
|
|
8435
|
-
max_rounds?: number;
|
|
8436
|
-
synthesis?: SynthesisConfig;
|
|
8437
8781
|
tags?: {
|
|
8438
8782
|
[key: string]: string;
|
|
8439
8783
|
};
|
|
8440
|
-
participants?: Array<ParticipantInput>;
|
|
8441
8784
|
};
|
|
8442
8785
|
path: {
|
|
8443
8786
|
/**
|
|
8444
|
-
*
|
|
8787
|
+
* Document ID
|
|
8445
8788
|
*/
|
|
8446
|
-
|
|
8789
|
+
document_id: string;
|
|
8447
8790
|
};
|
|
8448
8791
|
query?: never;
|
|
8449
|
-
url: '/api/v1/
|
|
8792
|
+
url: '/api/v1/documents/{document_id}';
|
|
8450
8793
|
};
|
|
8451
|
-
type
|
|
8452
|
-
/**
|
|
8453
|
-
* Invalid request body
|
|
8454
|
-
*/
|
|
8455
|
-
400: ErrorResponse;
|
|
8794
|
+
type UpdateDocumentErrors = {
|
|
8456
8795
|
/**
|
|
8457
8796
|
* Unauthorized
|
|
8458
8797
|
*/
|
|
@@ -8462,33 +8801,30 @@ type UpdateDiscussionErrors = {
|
|
|
8462
8801
|
*/
|
|
8463
8802
|
403: ErrorResponse;
|
|
8464
8803
|
/**
|
|
8465
|
-
*
|
|
8804
|
+
* Document not found
|
|
8466
8805
|
*/
|
|
8467
8806
|
404: ErrorResponse;
|
|
8468
8807
|
};
|
|
8469
|
-
type
|
|
8470
|
-
type
|
|
8808
|
+
type UpdateDocumentError = UpdateDocumentErrors[keyof UpdateDocumentErrors];
|
|
8809
|
+
type UpdateDocumentResponses = {
|
|
8471
8810
|
/**
|
|
8472
|
-
*
|
|
8811
|
+
* Document updated
|
|
8473
8812
|
*/
|
|
8474
|
-
200:
|
|
8813
|
+
200: DocumentRecord;
|
|
8475
8814
|
};
|
|
8476
|
-
type
|
|
8477
|
-
type
|
|
8815
|
+
type UpdateDocumentResponse = UpdateDocumentResponses[keyof UpdateDocumentResponses];
|
|
8816
|
+
type GetDocumentStatusData = {
|
|
8478
8817
|
body?: never;
|
|
8479
8818
|
path: {
|
|
8480
8819
|
/**
|
|
8481
|
-
*
|
|
8820
|
+
* Document ID
|
|
8482
8821
|
*/
|
|
8483
|
-
|
|
8484
|
-
};
|
|
8485
|
-
query?: {
|
|
8486
|
-
limit?: number;
|
|
8487
|
-
offset?: number;
|
|
8822
|
+
document_id: string;
|
|
8488
8823
|
};
|
|
8489
|
-
|
|
8824
|
+
query?: never;
|
|
8825
|
+
url: '/api/v1/documents/{document_id}/status';
|
|
8490
8826
|
};
|
|
8491
|
-
type
|
|
8827
|
+
type GetDocumentStatusErrors = {
|
|
8492
8828
|
/**
|
|
8493
8829
|
* Unauthorized
|
|
8494
8830
|
*/
|
|
@@ -8498,44 +8834,215 @@ type ListDiscussionRunsErrors = {
|
|
|
8498
8834
|
*/
|
|
8499
8835
|
403: ErrorResponse;
|
|
8500
8836
|
/**
|
|
8501
|
-
*
|
|
8837
|
+
* Document not found
|
|
8502
8838
|
*/
|
|
8503
8839
|
404: ErrorResponse;
|
|
8504
8840
|
};
|
|
8505
|
-
type
|
|
8506
|
-
type
|
|
8841
|
+
type GetDocumentStatusError = GetDocumentStatusErrors[keyof GetDocumentStatusErrors];
|
|
8842
|
+
type GetDocumentStatusResponses = {
|
|
8507
8843
|
/**
|
|
8508
|
-
*
|
|
8844
|
+
* Document ingestion status
|
|
8509
8845
|
*/
|
|
8510
|
-
200:
|
|
8511
|
-
|
|
8512
|
-
|
|
8513
|
-
|
|
8514
|
-
|
|
8846
|
+
200: DocumentStatusRecord;
|
|
8847
|
+
};
|
|
8848
|
+
type GetDocumentStatusResponse = GetDocumentStatusResponses[keyof GetDocumentStatusResponses];
|
|
8849
|
+
type ReingestDocumentData = {
|
|
8850
|
+
body?: {
|
|
8851
|
+
/**
|
|
8852
|
+
* How to split the source into chunks. Defaults to `page`.
|
|
8853
|
+
*/
|
|
8854
|
+
chunk_strategy?: 'page' | 'whole' | 'size';
|
|
8855
|
+
/**
|
|
8856
|
+
* Window size in characters when `chunk_strategy=size`. Defaults to 1000.
|
|
8857
|
+
*/
|
|
8858
|
+
chunk_size?: number;
|
|
8859
|
+
/**
|
|
8860
|
+
* Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
|
|
8861
|
+
*/
|
|
8862
|
+
chunk_overlap?: number;
|
|
8863
|
+
};
|
|
8864
|
+
path: {
|
|
8865
|
+
/**
|
|
8866
|
+
* Document ID
|
|
8867
|
+
*/
|
|
8868
|
+
document_id: string;
|
|
8515
8869
|
};
|
|
8870
|
+
query?: {
|
|
8871
|
+
/**
|
|
8872
|
+
* 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`.
|
|
8873
|
+
*/
|
|
8874
|
+
wait?: boolean;
|
|
8875
|
+
};
|
|
8876
|
+
url: '/api/v1/documents/{document_id}/ingest';
|
|
8877
|
+
};
|
|
8878
|
+
type ReingestDocumentErrors = {
|
|
8879
|
+
/**
|
|
8880
|
+
* Unauthorized
|
|
8881
|
+
*/
|
|
8882
|
+
401: ErrorResponse;
|
|
8883
|
+
/**
|
|
8884
|
+
* Forbidden
|
|
8885
|
+
*/
|
|
8886
|
+
403: ErrorResponse;
|
|
8887
|
+
/**
|
|
8888
|
+
* Document not found
|
|
8889
|
+
*/
|
|
8890
|
+
404: ErrorResponse;
|
|
8891
|
+
/**
|
|
8892
|
+
* The file is too large to re-ingest synchronously (`?wait=true`). Retry in background mode.
|
|
8893
|
+
*/
|
|
8894
|
+
413: ErrorResponse;
|
|
8895
|
+
};
|
|
8896
|
+
type ReingestDocumentError = ReingestDocumentErrors[keyof ReingestDocumentErrors];
|
|
8897
|
+
type ReingestDocumentResponses = {
|
|
8898
|
+
/**
|
|
8899
|
+
* Re-ingestion completed synchronously (only when `?wait=true`).
|
|
8900
|
+
*/
|
|
8901
|
+
201: IngestedDocumentRecord;
|
|
8902
|
+
/**
|
|
8903
|
+
* Re-ingestion accepted. The document was reset to `status=pending` and processing runs in the background. Poll `GET /api/v1/documents/{document_id}/status`.
|
|
8904
|
+
*/
|
|
8905
|
+
202: IngestedDocumentRecord;
|
|
8516
8906
|
};
|
|
8517
|
-
type
|
|
8518
|
-
type
|
|
8907
|
+
type ReingestDocumentResponse = ReingestDocumentResponses[keyof ReingestDocumentResponses];
|
|
8908
|
+
type CompleteIngestionCallbackData = {
|
|
8909
|
+
/**
|
|
8910
|
+
* The converter output contract, adapted for a JSON request body: a single page as `{ text }`, or `{ pages: [{ text, page_number }] }` for multiple pages.
|
|
8911
|
+
*/
|
|
8519
8912
|
body: {
|
|
8913
|
+
text: string;
|
|
8914
|
+
} | {
|
|
8915
|
+
pages: Array<{
|
|
8916
|
+
text?: string;
|
|
8917
|
+
page_number?: number;
|
|
8918
|
+
}>;
|
|
8919
|
+
};
|
|
8920
|
+
path: {
|
|
8921
|
+
/**
|
|
8922
|
+
* Document ID
|
|
8923
|
+
*/
|
|
8924
|
+
document_id: string;
|
|
8925
|
+
};
|
|
8926
|
+
query: {
|
|
8927
|
+
/**
|
|
8928
|
+
* Single-use signed token from the original `callback.token`
|
|
8929
|
+
*/
|
|
8930
|
+
token: string;
|
|
8931
|
+
};
|
|
8932
|
+
url: '/api/v1/documents/{document_id}/ingestion-callback';
|
|
8933
|
+
};
|
|
8934
|
+
type CompleteIngestionCallbackErrors = {
|
|
8935
|
+
/**
|
|
8936
|
+
* The token is missing, invalid, or does not match this document.
|
|
8937
|
+
*/
|
|
8938
|
+
401: ErrorResponse;
|
|
8939
|
+
/**
|
|
8940
|
+
* Document not found
|
|
8941
|
+
*/
|
|
8942
|
+
404: ErrorResponse;
|
|
8943
|
+
/**
|
|
8944
|
+
* The document is no longer awaiting this conversion attempt (already completed, timed out, or superseded by a re-ingest).
|
|
8945
|
+
*/
|
|
8946
|
+
409: ErrorResponse;
|
|
8947
|
+
/**
|
|
8948
|
+
* The output shape is unrecognized.
|
|
8949
|
+
*/
|
|
8950
|
+
422: ErrorResponse;
|
|
8951
|
+
};
|
|
8952
|
+
type CompleteIngestionCallbackError = CompleteIngestionCallbackErrors[keyof CompleteIngestionCallbackErrors];
|
|
8953
|
+
type CompleteIngestionCallbackResponses = {
|
|
8954
|
+
/**
|
|
8955
|
+
* Conversion completed — the document was chunked and marked `ready` (or `failed` with `FILE_PARSE_FAILED` if the output produced no text).
|
|
8956
|
+
*/
|
|
8957
|
+
204: void;
|
|
8958
|
+
};
|
|
8959
|
+
type CompleteIngestionCallbackResponse = CompleteIngestionCallbackResponses[keyof CompleteIngestionCallbackResponses];
|
|
8960
|
+
type GetDocumentTagsData = {
|
|
8961
|
+
body?: never;
|
|
8962
|
+
path: {
|
|
8520
8963
|
/**
|
|
8521
|
-
*
|
|
8964
|
+
* Document ID
|
|
8522
8965
|
*/
|
|
8523
|
-
|
|
8966
|
+
document_id: string;
|
|
8967
|
+
};
|
|
8968
|
+
query?: never;
|
|
8969
|
+
url: '/api/v1/documents/{document_id}/tags';
|
|
8970
|
+
};
|
|
8971
|
+
type GetDocumentTagsErrors = {
|
|
8972
|
+
/**
|
|
8973
|
+
* Unauthorized
|
|
8974
|
+
*/
|
|
8975
|
+
401: ErrorResponse;
|
|
8976
|
+
/**
|
|
8977
|
+
* Forbidden
|
|
8978
|
+
*/
|
|
8979
|
+
403: ErrorResponse;
|
|
8980
|
+
/**
|
|
8981
|
+
* Document not found
|
|
8982
|
+
*/
|
|
8983
|
+
404: ErrorResponse;
|
|
8984
|
+
};
|
|
8985
|
+
type GetDocumentTagsError = GetDocumentTagsErrors[keyof GetDocumentTagsErrors];
|
|
8986
|
+
type GetDocumentTagsResponses = {
|
|
8987
|
+
/**
|
|
8988
|
+
* Document tags
|
|
8989
|
+
*/
|
|
8990
|
+
200: {
|
|
8991
|
+
[key: string]: string;
|
|
8992
|
+
};
|
|
8993
|
+
};
|
|
8994
|
+
type GetDocumentTagsResponse = GetDocumentTagsResponses[keyof GetDocumentTagsResponses];
|
|
8995
|
+
type MergeDocumentTagsData = {
|
|
8996
|
+
body: {
|
|
8997
|
+
[key: string]: string;
|
|
8524
8998
|
};
|
|
8525
8999
|
path: {
|
|
8526
9000
|
/**
|
|
8527
|
-
*
|
|
9001
|
+
* Document ID
|
|
8528
9002
|
*/
|
|
8529
|
-
|
|
9003
|
+
document_id: string;
|
|
8530
9004
|
};
|
|
8531
9005
|
query?: never;
|
|
8532
|
-
url: '/api/v1/
|
|
9006
|
+
url: '/api/v1/documents/{document_id}/tags';
|
|
8533
9007
|
};
|
|
8534
|
-
type
|
|
9008
|
+
type MergeDocumentTagsErrors = {
|
|
8535
9009
|
/**
|
|
8536
|
-
*
|
|
9010
|
+
* Unauthorized
|
|
8537
9011
|
*/
|
|
8538
|
-
|
|
9012
|
+
401: ErrorResponse;
|
|
9013
|
+
/**
|
|
9014
|
+
* Forbidden
|
|
9015
|
+
*/
|
|
9016
|
+
403: ErrorResponse;
|
|
9017
|
+
/**
|
|
9018
|
+
* Document not found
|
|
9019
|
+
*/
|
|
9020
|
+
404: ErrorResponse;
|
|
9021
|
+
};
|
|
9022
|
+
type MergeDocumentTagsError = MergeDocumentTagsErrors[keyof MergeDocumentTagsErrors];
|
|
9023
|
+
type MergeDocumentTagsResponses = {
|
|
9024
|
+
/**
|
|
9025
|
+
* Tags merged
|
|
9026
|
+
*/
|
|
9027
|
+
200: {
|
|
9028
|
+
[key: string]: string;
|
|
9029
|
+
};
|
|
9030
|
+
};
|
|
9031
|
+
type MergeDocumentTagsResponse = MergeDocumentTagsResponses[keyof MergeDocumentTagsResponses];
|
|
9032
|
+
type ReplaceDocumentTagsData = {
|
|
9033
|
+
body: {
|
|
9034
|
+
[key: string]: string;
|
|
9035
|
+
};
|
|
9036
|
+
path: {
|
|
9037
|
+
/**
|
|
9038
|
+
* Document ID
|
|
9039
|
+
*/
|
|
9040
|
+
document_id: string;
|
|
9041
|
+
};
|
|
9042
|
+
query?: never;
|
|
9043
|
+
url: '/api/v1/documents/{document_id}/tags';
|
|
9044
|
+
};
|
|
9045
|
+
type ReplaceDocumentTagsErrors = {
|
|
8539
9046
|
/**
|
|
8540
9047
|
* Unauthorized
|
|
8541
9048
|
*/
|
|
@@ -8545,24 +9052,63 @@ type CreateDiscussionRunErrors = {
|
|
|
8545
9052
|
*/
|
|
8546
9053
|
403: ErrorResponse;
|
|
8547
9054
|
/**
|
|
8548
|
-
*
|
|
9055
|
+
* Document not found
|
|
8549
9056
|
*/
|
|
8550
9057
|
404: ErrorResponse;
|
|
8551
9058
|
};
|
|
8552
|
-
type
|
|
8553
|
-
type
|
|
9059
|
+
type ReplaceDocumentTagsError = ReplaceDocumentTagsErrors[keyof ReplaceDocumentTagsErrors];
|
|
9060
|
+
type ReplaceDocumentTagsResponses = {
|
|
8554
9061
|
/**
|
|
8555
|
-
*
|
|
9062
|
+
* Tags replaced
|
|
8556
9063
|
*/
|
|
8557
|
-
|
|
9064
|
+
200: {
|
|
9065
|
+
[key: string]: string;
|
|
9066
|
+
};
|
|
8558
9067
|
};
|
|
8559
|
-
type
|
|
8560
|
-
type
|
|
9068
|
+
type ReplaceDocumentTagsResponse = ReplaceDocumentTagsResponses[keyof ReplaceDocumentTagsResponses];
|
|
9069
|
+
type CreateEmbeddingsData = {
|
|
9070
|
+
body: {
|
|
9071
|
+
/**
|
|
9072
|
+
* Single text to embed.
|
|
9073
|
+
*/
|
|
9074
|
+
input?: string;
|
|
9075
|
+
/**
|
|
9076
|
+
* Batch of texts to embed.
|
|
9077
|
+
*/
|
|
9078
|
+
inputs?: Array<string>;
|
|
9079
|
+
};
|
|
9080
|
+
path?: never;
|
|
9081
|
+
query?: never;
|
|
9082
|
+
url: '/api/v1/embeddings';
|
|
9083
|
+
};
|
|
9084
|
+
type CreateEmbeddingsErrors = {
|
|
9085
|
+
/**
|
|
9086
|
+
* Invalid request body
|
|
9087
|
+
*/
|
|
9088
|
+
400: ErrorResponse;
|
|
9089
|
+
/**
|
|
9090
|
+
* Unauthorized
|
|
9091
|
+
*/
|
|
9092
|
+
401: ErrorResponse;
|
|
9093
|
+
/**
|
|
9094
|
+
* Embedding service not configured
|
|
9095
|
+
*/
|
|
9096
|
+
503: ErrorResponse;
|
|
9097
|
+
};
|
|
9098
|
+
type CreateEmbeddingsError = CreateEmbeddingsErrors[keyof CreateEmbeddingsErrors];
|
|
9099
|
+
type CreateEmbeddingsResponses = {
|
|
9100
|
+
/**
|
|
9101
|
+
* Embeddings generated successfully
|
|
9102
|
+
*/
|
|
9103
|
+
200: EmbeddingsResponse;
|
|
9104
|
+
};
|
|
9105
|
+
type CreateEmbeddingsResponse = CreateEmbeddingsResponses[keyof CreateEmbeddingsResponses];
|
|
9106
|
+
type ListDatasetsData = {
|
|
8561
9107
|
body?: never;
|
|
8562
9108
|
path?: never;
|
|
8563
9109
|
query?: {
|
|
8564
9110
|
/**
|
|
8565
|
-
* Project ID (
|
|
9111
|
+
* Project ID (required if not using project key auth)
|
|
8566
9112
|
*/
|
|
8567
9113
|
project_id?: string;
|
|
8568
9114
|
/**
|
|
@@ -8574,588 +9120,806 @@ type ListDocumentsData = {
|
|
|
8574
9120
|
*/
|
|
8575
9121
|
offset?: number;
|
|
8576
9122
|
};
|
|
8577
|
-
url: '/api/v1/
|
|
9123
|
+
url: '/api/v1/datasets';
|
|
8578
9124
|
};
|
|
8579
|
-
type
|
|
9125
|
+
type ListDatasetsErrors = {
|
|
8580
9126
|
/**
|
|
8581
9127
|
* Unauthorized
|
|
8582
9128
|
*/
|
|
8583
|
-
401:
|
|
9129
|
+
401: unknown;
|
|
8584
9130
|
/**
|
|
8585
9131
|
* Forbidden
|
|
8586
9132
|
*/
|
|
8587
|
-
403:
|
|
9133
|
+
403: unknown;
|
|
9134
|
+
/**
|
|
9135
|
+
* Internal server error
|
|
9136
|
+
*/
|
|
9137
|
+
500: unknown;
|
|
8588
9138
|
};
|
|
8589
|
-
type
|
|
8590
|
-
type ListDocumentsResponses = {
|
|
9139
|
+
type ListDatasetsResponses = {
|
|
8591
9140
|
/**
|
|
8592
|
-
* List of
|
|
9141
|
+
* List of datasets
|
|
8593
9142
|
*/
|
|
8594
9143
|
200: {
|
|
8595
|
-
data
|
|
8596
|
-
total
|
|
8597
|
-
limit
|
|
8598
|
-
offset
|
|
9144
|
+
data: Array<Dataset>;
|
|
9145
|
+
total: number;
|
|
9146
|
+
limit: number;
|
|
9147
|
+
offset: number;
|
|
8599
9148
|
};
|
|
8600
9149
|
};
|
|
8601
|
-
type
|
|
8602
|
-
type
|
|
9150
|
+
type ListDatasetsResponse = ListDatasetsResponses[keyof ListDatasetsResponses];
|
|
9151
|
+
type CreateDatasetData = {
|
|
8603
9152
|
body: {
|
|
8604
9153
|
/**
|
|
8605
|
-
* Project ID
|
|
9154
|
+
* Project ID (required if not using project key auth)
|
|
8606
9155
|
*/
|
|
8607
9156
|
project_id?: string;
|
|
8608
|
-
content: string;
|
|
8609
9157
|
/**
|
|
8610
|
-
*
|
|
9158
|
+
* Unique name within the project
|
|
8611
9159
|
*/
|
|
8612
|
-
|
|
8613
|
-
filename?: string;
|
|
8614
|
-
/**
|
|
8615
|
-
* Document title
|
|
8616
|
-
*/
|
|
8617
|
-
title?: string;
|
|
9160
|
+
name: string;
|
|
8618
9161
|
/**
|
|
8619
|
-
*
|
|
9162
|
+
* What this suite covers
|
|
8620
9163
|
*/
|
|
8621
|
-
|
|
8622
|
-
|
|
8623
|
-
|
|
9164
|
+
description?: string | null;
|
|
9165
|
+
};
|
|
9166
|
+
path?: never;
|
|
9167
|
+
query?: never;
|
|
9168
|
+
url: '/api/v1/datasets';
|
|
9169
|
+
};
|
|
9170
|
+
type CreateDatasetErrors = {
|
|
9171
|
+
/**
|
|
9172
|
+
* Bad request (missing or invalid name)
|
|
9173
|
+
*/
|
|
9174
|
+
400: unknown;
|
|
9175
|
+
/**
|
|
9176
|
+
* Unauthorized
|
|
9177
|
+
*/
|
|
9178
|
+
401: unknown;
|
|
9179
|
+
/**
|
|
9180
|
+
* Forbidden
|
|
9181
|
+
*/
|
|
9182
|
+
403: unknown;
|
|
9183
|
+
/**
|
|
9184
|
+
* A dataset with that name already exists in the project
|
|
9185
|
+
*/
|
|
9186
|
+
409: unknown;
|
|
9187
|
+
/**
|
|
9188
|
+
* Internal server error
|
|
9189
|
+
*/
|
|
9190
|
+
500: unknown;
|
|
9191
|
+
};
|
|
9192
|
+
type CreateDatasetResponses = {
|
|
9193
|
+
/**
|
|
9194
|
+
* Dataset created successfully
|
|
9195
|
+
*/
|
|
9196
|
+
201: Dataset;
|
|
9197
|
+
};
|
|
9198
|
+
type CreateDatasetResponse = CreateDatasetResponses[keyof CreateDatasetResponses];
|
|
9199
|
+
type DeleteDatasetData = {
|
|
9200
|
+
body?: never;
|
|
9201
|
+
path: {
|
|
8624
9202
|
/**
|
|
8625
|
-
*
|
|
9203
|
+
* Dataset ID
|
|
8626
9204
|
*/
|
|
8627
|
-
|
|
8628
|
-
|
|
8629
|
-
|
|
9205
|
+
dataset_id: string;
|
|
9206
|
+
};
|
|
9207
|
+
query?: never;
|
|
9208
|
+
url: '/api/v1/datasets/{dataset_id}';
|
|
9209
|
+
};
|
|
9210
|
+
type DeleteDatasetErrors = {
|
|
9211
|
+
/**
|
|
9212
|
+
* Unauthorized
|
|
9213
|
+
*/
|
|
9214
|
+
401: unknown;
|
|
9215
|
+
/**
|
|
9216
|
+
* Forbidden
|
|
9217
|
+
*/
|
|
9218
|
+
403: unknown;
|
|
9219
|
+
/**
|
|
9220
|
+
* Dataset not found
|
|
9221
|
+
*/
|
|
9222
|
+
404: unknown;
|
|
9223
|
+
};
|
|
9224
|
+
type DeleteDatasetResponses = {
|
|
9225
|
+
/**
|
|
9226
|
+
* Dataset deleted successfully
|
|
9227
|
+
*/
|
|
9228
|
+
204: void;
|
|
9229
|
+
};
|
|
9230
|
+
type DeleteDatasetResponse = DeleteDatasetResponses[keyof DeleteDatasetResponses];
|
|
9231
|
+
type GetDatasetData = {
|
|
9232
|
+
body?: never;
|
|
9233
|
+
path: {
|
|
8630
9234
|
/**
|
|
8631
|
-
*
|
|
9235
|
+
* Dataset ID
|
|
8632
9236
|
*/
|
|
8633
|
-
|
|
8634
|
-
|
|
8635
|
-
|
|
8636
|
-
|
|
8637
|
-
|
|
9237
|
+
dataset_id: string;
|
|
9238
|
+
};
|
|
9239
|
+
query?: never;
|
|
9240
|
+
url: '/api/v1/datasets/{dataset_id}';
|
|
9241
|
+
};
|
|
9242
|
+
type GetDatasetErrors = {
|
|
9243
|
+
/**
|
|
9244
|
+
* Unauthorized
|
|
9245
|
+
*/
|
|
9246
|
+
401: unknown;
|
|
9247
|
+
/**
|
|
9248
|
+
* Forbidden
|
|
9249
|
+
*/
|
|
9250
|
+
403: unknown;
|
|
9251
|
+
/**
|
|
9252
|
+
* Dataset not found
|
|
9253
|
+
*/
|
|
9254
|
+
404: unknown;
|
|
9255
|
+
};
|
|
9256
|
+
type GetDatasetResponses = {
|
|
9257
|
+
/**
|
|
9258
|
+
* Dataset details
|
|
9259
|
+
*/
|
|
9260
|
+
200: Dataset;
|
|
9261
|
+
};
|
|
9262
|
+
type GetDatasetResponse = GetDatasetResponses[keyof GetDatasetResponses];
|
|
9263
|
+
type UpdateDatasetData = {
|
|
9264
|
+
body: {
|
|
9265
|
+
name?: string;
|
|
9266
|
+
description?: string | null;
|
|
9267
|
+
};
|
|
9268
|
+
path: {
|
|
8638
9269
|
/**
|
|
8639
|
-
*
|
|
9270
|
+
* Dataset ID
|
|
8640
9271
|
*/
|
|
8641
|
-
|
|
9272
|
+
dataset_id: string;
|
|
8642
9273
|
};
|
|
8643
|
-
path?: never;
|
|
8644
9274
|
query?: never;
|
|
8645
|
-
url: '/api/v1/
|
|
9275
|
+
url: '/api/v1/datasets/{dataset_id}';
|
|
8646
9276
|
};
|
|
8647
|
-
type
|
|
9277
|
+
type UpdateDatasetErrors = {
|
|
8648
9278
|
/**
|
|
8649
|
-
*
|
|
9279
|
+
* Bad request
|
|
8650
9280
|
*/
|
|
8651
|
-
400:
|
|
9281
|
+
400: unknown;
|
|
8652
9282
|
/**
|
|
8653
9283
|
* Unauthorized
|
|
8654
9284
|
*/
|
|
8655
|
-
401:
|
|
9285
|
+
401: unknown;
|
|
8656
9286
|
/**
|
|
8657
9287
|
* Forbidden
|
|
8658
9288
|
*/
|
|
8659
|
-
403:
|
|
9289
|
+
403: unknown;
|
|
9290
|
+
/**
|
|
9291
|
+
* Dataset not found
|
|
9292
|
+
*/
|
|
9293
|
+
404: unknown;
|
|
9294
|
+
/**
|
|
9295
|
+
* A dataset with that name already exists in the project
|
|
9296
|
+
*/
|
|
9297
|
+
409: unknown;
|
|
8660
9298
|
};
|
|
8661
|
-
type
|
|
8662
|
-
type CreateDocumentResponses = {
|
|
9299
|
+
type UpdateDatasetResponses = {
|
|
8663
9300
|
/**
|
|
8664
|
-
*
|
|
9301
|
+
* Dataset updated successfully
|
|
8665
9302
|
*/
|
|
8666
|
-
|
|
9303
|
+
200: Dataset;
|
|
8667
9304
|
};
|
|
8668
|
-
type
|
|
8669
|
-
type
|
|
8670
|
-
body
|
|
8671
|
-
|
|
8672
|
-
* ID of the uploaded file. Must be one of application/pdf, text/plain, text/markdown.
|
|
8673
|
-
*/
|
|
8674
|
-
file_id: string;
|
|
8675
|
-
/**
|
|
8676
|
-
* Project ID. Required for JWT auth; omit when using a project key.
|
|
8677
|
-
*/
|
|
8678
|
-
project_id?: string;
|
|
9305
|
+
type UpdateDatasetResponse = UpdateDatasetResponses[keyof UpdateDatasetResponses];
|
|
9306
|
+
type ListDatasetItemsData = {
|
|
9307
|
+
body?: never;
|
|
9308
|
+
path: {
|
|
8679
9309
|
/**
|
|
8680
|
-
*
|
|
9310
|
+
* Dataset ID
|
|
8681
9311
|
*/
|
|
8682
|
-
|
|
9312
|
+
dataset_id: string;
|
|
9313
|
+
};
|
|
9314
|
+
query?: {
|
|
8683
9315
|
/**
|
|
8684
|
-
*
|
|
9316
|
+
* Maximum number of results to return
|
|
8685
9317
|
*/
|
|
8686
|
-
|
|
8687
|
-
[key: string]: string;
|
|
8688
|
-
};
|
|
9318
|
+
limit?: number;
|
|
8689
9319
|
/**
|
|
8690
|
-
*
|
|
9320
|
+
* Number of results to skip
|
|
8691
9321
|
*/
|
|
8692
|
-
|
|
9322
|
+
offset?: number;
|
|
9323
|
+
};
|
|
9324
|
+
url: '/api/v1/datasets/{dataset_id}/items';
|
|
9325
|
+
};
|
|
9326
|
+
type ListDatasetItemsErrors = {
|
|
9327
|
+
/**
|
|
9328
|
+
* Unauthorized
|
|
9329
|
+
*/
|
|
9330
|
+
401: unknown;
|
|
9331
|
+
/**
|
|
9332
|
+
* Forbidden
|
|
9333
|
+
*/
|
|
9334
|
+
403: unknown;
|
|
9335
|
+
/**
|
|
9336
|
+
* Dataset not found
|
|
9337
|
+
*/
|
|
9338
|
+
404: unknown;
|
|
9339
|
+
};
|
|
9340
|
+
type ListDatasetItemsResponses = {
|
|
9341
|
+
/**
|
|
9342
|
+
* List of dataset items
|
|
9343
|
+
*/
|
|
9344
|
+
200: {
|
|
9345
|
+
data: Array<DatasetItem>;
|
|
9346
|
+
total: number;
|
|
9347
|
+
limit: number;
|
|
9348
|
+
offset: number;
|
|
9349
|
+
};
|
|
9350
|
+
};
|
|
9351
|
+
type ListDatasetItemsResponse = ListDatasetItemsResponses[keyof ListDatasetItemsResponses];
|
|
9352
|
+
type CreateDatasetItemData = {
|
|
9353
|
+
body: {
|
|
9354
|
+
input: DatasetItemInput;
|
|
8693
9355
|
/**
|
|
8694
|
-
*
|
|
9356
|
+
* Reference answer for exact_match / llm_judge scorers
|
|
8695
9357
|
*/
|
|
8696
|
-
|
|
9358
|
+
expected_output?: string | null;
|
|
8697
9359
|
/**
|
|
8698
|
-
*
|
|
9360
|
+
* Free-form tags, opaque to the platform
|
|
8699
9361
|
*/
|
|
8700
|
-
|
|
9362
|
+
metadata?: {
|
|
9363
|
+
[key: string]: unknown;
|
|
9364
|
+
} | null;
|
|
8701
9365
|
};
|
|
8702
|
-
path
|
|
8703
|
-
query?: {
|
|
9366
|
+
path: {
|
|
8704
9367
|
/**
|
|
8705
|
-
*
|
|
9368
|
+
* Dataset ID
|
|
8706
9369
|
*/
|
|
8707
|
-
|
|
9370
|
+
dataset_id: string;
|
|
8708
9371
|
};
|
|
8709
|
-
|
|
9372
|
+
query?: never;
|
|
9373
|
+
url: '/api/v1/datasets/{dataset_id}/items';
|
|
8710
9374
|
};
|
|
8711
|
-
type
|
|
9375
|
+
type CreateDatasetItemErrors = {
|
|
8712
9376
|
/**
|
|
8713
|
-
*
|
|
9377
|
+
* Bad request (input is not message-shaped)
|
|
8714
9378
|
*/
|
|
8715
|
-
400:
|
|
9379
|
+
400: unknown;
|
|
8716
9380
|
/**
|
|
8717
9381
|
* Unauthorized
|
|
8718
9382
|
*/
|
|
8719
|
-
401:
|
|
9383
|
+
401: unknown;
|
|
8720
9384
|
/**
|
|
8721
9385
|
* Forbidden
|
|
8722
9386
|
*/
|
|
8723
|
-
403:
|
|
9387
|
+
403: unknown;
|
|
8724
9388
|
/**
|
|
8725
|
-
*
|
|
9389
|
+
* Dataset not found
|
|
8726
9390
|
*/
|
|
8727
|
-
|
|
9391
|
+
404: unknown;
|
|
9392
|
+
};
|
|
9393
|
+
type CreateDatasetItemResponses = {
|
|
8728
9394
|
/**
|
|
8729
|
-
*
|
|
9395
|
+
* Dataset item created successfully
|
|
8730
9396
|
*/
|
|
8731
|
-
|
|
9397
|
+
201: DatasetItem;
|
|
8732
9398
|
};
|
|
8733
|
-
type
|
|
8734
|
-
type
|
|
9399
|
+
type CreateDatasetItemResponse = CreateDatasetItemResponses[keyof CreateDatasetItemResponses];
|
|
9400
|
+
type DeleteDatasetItemData = {
|
|
9401
|
+
body?: never;
|
|
9402
|
+
path: {
|
|
9403
|
+
/**
|
|
9404
|
+
* Dataset ID
|
|
9405
|
+
*/
|
|
9406
|
+
dataset_id: string;
|
|
9407
|
+
/**
|
|
9408
|
+
* Dataset item ID
|
|
9409
|
+
*/
|
|
9410
|
+
item_id: string;
|
|
9411
|
+
};
|
|
9412
|
+
query?: never;
|
|
9413
|
+
url: '/api/v1/datasets/{dataset_id}/items/{item_id}';
|
|
9414
|
+
};
|
|
9415
|
+
type DeleteDatasetItemErrors = {
|
|
8735
9416
|
/**
|
|
8736
|
-
*
|
|
9417
|
+
* Unauthorized
|
|
8737
9418
|
*/
|
|
8738
|
-
|
|
9419
|
+
401: unknown;
|
|
8739
9420
|
/**
|
|
8740
|
-
*
|
|
9421
|
+
* Forbidden
|
|
8741
9422
|
*/
|
|
8742
|
-
|
|
9423
|
+
403: unknown;
|
|
9424
|
+
/**
|
|
9425
|
+
* Dataset or item not found
|
|
9426
|
+
*/
|
|
9427
|
+
404: unknown;
|
|
8743
9428
|
};
|
|
8744
|
-
type
|
|
8745
|
-
|
|
8746
|
-
|
|
9429
|
+
type DeleteDatasetItemResponses = {
|
|
9430
|
+
/**
|
|
9431
|
+
* Dataset item deleted successfully
|
|
9432
|
+
*/
|
|
9433
|
+
204: void;
|
|
9434
|
+
};
|
|
9435
|
+
type DeleteDatasetItemResponse = DeleteDatasetItemResponses[keyof DeleteDatasetItemResponses];
|
|
9436
|
+
type UpdateDatasetItemData = {
|
|
9437
|
+
body: {
|
|
9438
|
+
input?: DatasetItemInput;
|
|
9439
|
+
expected_output?: string | null;
|
|
9440
|
+
metadata?: {
|
|
9441
|
+
[key: string]: unknown;
|
|
9442
|
+
} | null;
|
|
9443
|
+
};
|
|
8747
9444
|
path: {
|
|
8748
9445
|
/**
|
|
8749
|
-
*
|
|
9446
|
+
* Dataset ID
|
|
8750
9447
|
*/
|
|
8751
|
-
|
|
9448
|
+
dataset_id: string;
|
|
9449
|
+
/**
|
|
9450
|
+
* Dataset item ID
|
|
9451
|
+
*/
|
|
9452
|
+
item_id: string;
|
|
8752
9453
|
};
|
|
8753
9454
|
query?: never;
|
|
8754
|
-
url: '/api/v1/
|
|
9455
|
+
url: '/api/v1/datasets/{dataset_id}/items/{item_id}';
|
|
8755
9456
|
};
|
|
8756
|
-
type
|
|
9457
|
+
type UpdateDatasetItemErrors = {
|
|
9458
|
+
/**
|
|
9459
|
+
* Bad request
|
|
9460
|
+
*/
|
|
9461
|
+
400: unknown;
|
|
8757
9462
|
/**
|
|
8758
9463
|
* Unauthorized
|
|
8759
9464
|
*/
|
|
8760
|
-
401:
|
|
9465
|
+
401: unknown;
|
|
8761
9466
|
/**
|
|
8762
9467
|
* Forbidden
|
|
8763
9468
|
*/
|
|
8764
|
-
403:
|
|
9469
|
+
403: unknown;
|
|
8765
9470
|
/**
|
|
8766
|
-
*
|
|
9471
|
+
* Dataset or item not found
|
|
8767
9472
|
*/
|
|
8768
|
-
404:
|
|
9473
|
+
404: unknown;
|
|
8769
9474
|
};
|
|
8770
|
-
type
|
|
8771
|
-
type DeleteDocumentResponses = {
|
|
9475
|
+
type UpdateDatasetItemResponses = {
|
|
8772
9476
|
/**
|
|
8773
|
-
*
|
|
9477
|
+
* Dataset item updated successfully
|
|
8774
9478
|
*/
|
|
8775
|
-
|
|
9479
|
+
200: DatasetItem;
|
|
8776
9480
|
};
|
|
8777
|
-
type
|
|
8778
|
-
type
|
|
9481
|
+
type UpdateDatasetItemResponse = UpdateDatasetItemResponses[keyof UpdateDatasetItemResponses];
|
|
9482
|
+
type ListEvalsData = {
|
|
8779
9483
|
body?: never;
|
|
8780
|
-
path
|
|
9484
|
+
path?: never;
|
|
9485
|
+
query?: {
|
|
8781
9486
|
/**
|
|
8782
|
-
*
|
|
9487
|
+
* Project ID (required if not using project key auth)
|
|
8783
9488
|
*/
|
|
8784
|
-
|
|
9489
|
+
project_id?: string;
|
|
9490
|
+
/**
|
|
9491
|
+
* Maximum number of results to return
|
|
9492
|
+
*/
|
|
9493
|
+
limit?: number;
|
|
9494
|
+
/**
|
|
9495
|
+
* Number of results to skip
|
|
9496
|
+
*/
|
|
9497
|
+
offset?: number;
|
|
8785
9498
|
};
|
|
8786
|
-
|
|
8787
|
-
url: '/api/v1/documents/{document_id}';
|
|
9499
|
+
url: '/api/v1/evals';
|
|
8788
9500
|
};
|
|
8789
|
-
type
|
|
9501
|
+
type ListEvalsErrors = {
|
|
8790
9502
|
/**
|
|
8791
9503
|
* Unauthorized
|
|
8792
9504
|
*/
|
|
8793
|
-
401:
|
|
9505
|
+
401: unknown;
|
|
8794
9506
|
/**
|
|
8795
9507
|
* Forbidden
|
|
8796
9508
|
*/
|
|
8797
|
-
403:
|
|
9509
|
+
403: unknown;
|
|
8798
9510
|
/**
|
|
8799
|
-
*
|
|
9511
|
+
* Internal server error
|
|
8800
9512
|
*/
|
|
8801
|
-
|
|
9513
|
+
500: unknown;
|
|
8802
9514
|
};
|
|
8803
|
-
type
|
|
8804
|
-
type GetDocumentResponses = {
|
|
9515
|
+
type ListEvalsResponses = {
|
|
8805
9516
|
/**
|
|
8806
|
-
*
|
|
9517
|
+
* List of evals
|
|
8807
9518
|
*/
|
|
8808
|
-
200:
|
|
9519
|
+
200: {
|
|
9520
|
+
data: Array<Eval>;
|
|
9521
|
+
total: number;
|
|
9522
|
+
limit: number;
|
|
9523
|
+
offset: number;
|
|
9524
|
+
};
|
|
8809
9525
|
};
|
|
8810
|
-
type
|
|
8811
|
-
type
|
|
9526
|
+
type ListEvalsResponse = ListEvalsResponses[keyof ListEvalsResponses];
|
|
9527
|
+
type CreateEvalData = {
|
|
8812
9528
|
body: {
|
|
8813
9529
|
/**
|
|
8814
|
-
*
|
|
9530
|
+
* Project ID (required if not using project key auth)
|
|
8815
9531
|
*/
|
|
8816
|
-
|
|
9532
|
+
project_id?: string;
|
|
8817
9533
|
/**
|
|
8818
|
-
*
|
|
9534
|
+
* Unique name within the project
|
|
8819
9535
|
*/
|
|
8820
|
-
|
|
9536
|
+
name: string;
|
|
8821
9537
|
/**
|
|
8822
|
-
*
|
|
9538
|
+
* The agent under test
|
|
8823
9539
|
*/
|
|
8824
|
-
|
|
9540
|
+
agent_id: string;
|
|
8825
9541
|
/**
|
|
8826
|
-
*
|
|
9542
|
+
* The dataset to run it against
|
|
8827
9543
|
*/
|
|
8828
|
-
|
|
8829
|
-
|
|
8830
|
-
};
|
|
9544
|
+
dataset_id: string;
|
|
9545
|
+
scorers: Scorers;
|
|
8831
9546
|
/**
|
|
8832
|
-
*
|
|
9547
|
+
* 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.
|
|
8833
9548
|
*/
|
|
8834
|
-
|
|
8835
|
-
[key: string]: string;
|
|
8836
|
-
};
|
|
9549
|
+
pass_threshold?: number | null;
|
|
8837
9550
|
};
|
|
9551
|
+
path?: never;
|
|
9552
|
+
query?: never;
|
|
9553
|
+
url: '/api/v1/evals';
|
|
9554
|
+
};
|
|
9555
|
+
type CreateEvalErrors = {
|
|
9556
|
+
/**
|
|
9557
|
+
* Bad request (unknown scorer type, cross-project reference, invalid threshold)
|
|
9558
|
+
*/
|
|
9559
|
+
400: unknown;
|
|
9560
|
+
/**
|
|
9561
|
+
* Unauthorized
|
|
9562
|
+
*/
|
|
9563
|
+
401: unknown;
|
|
9564
|
+
/**
|
|
9565
|
+
* Forbidden
|
|
9566
|
+
*/
|
|
9567
|
+
403: unknown;
|
|
9568
|
+
/**
|
|
9569
|
+
* An eval with that name already exists in the project
|
|
9570
|
+
*/
|
|
9571
|
+
409: unknown;
|
|
9572
|
+
/**
|
|
9573
|
+
* Internal server error
|
|
9574
|
+
*/
|
|
9575
|
+
500: unknown;
|
|
9576
|
+
};
|
|
9577
|
+
type CreateEvalResponses = {
|
|
9578
|
+
/**
|
|
9579
|
+
* Eval created successfully
|
|
9580
|
+
*/
|
|
9581
|
+
201: Eval;
|
|
9582
|
+
};
|
|
9583
|
+
type CreateEvalResponse = CreateEvalResponses[keyof CreateEvalResponses];
|
|
9584
|
+
type DeleteEvalData = {
|
|
9585
|
+
body?: never;
|
|
8838
9586
|
path: {
|
|
8839
9587
|
/**
|
|
8840
|
-
*
|
|
9588
|
+
* Eval ID
|
|
8841
9589
|
*/
|
|
8842
|
-
|
|
9590
|
+
eval_id: string;
|
|
8843
9591
|
};
|
|
8844
9592
|
query?: never;
|
|
8845
|
-
url: '/api/v1/
|
|
9593
|
+
url: '/api/v1/evals/{eval_id}';
|
|
8846
9594
|
};
|
|
8847
|
-
type
|
|
9595
|
+
type DeleteEvalErrors = {
|
|
8848
9596
|
/**
|
|
8849
9597
|
* Unauthorized
|
|
8850
9598
|
*/
|
|
8851
|
-
401:
|
|
9599
|
+
401: unknown;
|
|
8852
9600
|
/**
|
|
8853
9601
|
* Forbidden
|
|
8854
9602
|
*/
|
|
8855
|
-
403:
|
|
9603
|
+
403: unknown;
|
|
8856
9604
|
/**
|
|
8857
|
-
*
|
|
9605
|
+
* Eval not found
|
|
8858
9606
|
*/
|
|
8859
|
-
404:
|
|
9607
|
+
404: unknown;
|
|
8860
9608
|
};
|
|
8861
|
-
type
|
|
8862
|
-
type UpdateDocumentResponses = {
|
|
9609
|
+
type DeleteEvalResponses = {
|
|
8863
9610
|
/**
|
|
8864
|
-
*
|
|
9611
|
+
* Eval deleted successfully
|
|
8865
9612
|
*/
|
|
8866
|
-
|
|
9613
|
+
204: void;
|
|
8867
9614
|
};
|
|
8868
|
-
type
|
|
8869
|
-
type
|
|
9615
|
+
type DeleteEvalResponse = DeleteEvalResponses[keyof DeleteEvalResponses];
|
|
9616
|
+
type GetEvalData = {
|
|
8870
9617
|
body?: never;
|
|
8871
9618
|
path: {
|
|
8872
9619
|
/**
|
|
8873
|
-
*
|
|
9620
|
+
* Eval ID
|
|
8874
9621
|
*/
|
|
8875
|
-
|
|
9622
|
+
eval_id: string;
|
|
8876
9623
|
};
|
|
8877
9624
|
query?: never;
|
|
8878
|
-
url: '/api/v1/
|
|
9625
|
+
url: '/api/v1/evals/{eval_id}';
|
|
8879
9626
|
};
|
|
8880
|
-
type
|
|
9627
|
+
type GetEvalErrors = {
|
|
8881
9628
|
/**
|
|
8882
9629
|
* Unauthorized
|
|
8883
9630
|
*/
|
|
8884
|
-
401:
|
|
9631
|
+
401: unknown;
|
|
8885
9632
|
/**
|
|
8886
9633
|
* Forbidden
|
|
8887
9634
|
*/
|
|
8888
|
-
403:
|
|
9635
|
+
403: unknown;
|
|
8889
9636
|
/**
|
|
8890
|
-
*
|
|
9637
|
+
* Eval not found
|
|
8891
9638
|
*/
|
|
8892
|
-
404:
|
|
9639
|
+
404: unknown;
|
|
8893
9640
|
};
|
|
8894
|
-
type
|
|
8895
|
-
type GetDocumentStatusResponses = {
|
|
9641
|
+
type GetEvalResponses = {
|
|
8896
9642
|
/**
|
|
8897
|
-
*
|
|
9643
|
+
* Eval details
|
|
8898
9644
|
*/
|
|
8899
|
-
200:
|
|
9645
|
+
200: Eval;
|
|
8900
9646
|
};
|
|
8901
|
-
type
|
|
8902
|
-
type
|
|
8903
|
-
body
|
|
8904
|
-
|
|
8905
|
-
|
|
8906
|
-
|
|
8907
|
-
|
|
8908
|
-
|
|
8909
|
-
* Window size in characters when `chunk_strategy=size`. Defaults to 1000.
|
|
8910
|
-
*/
|
|
8911
|
-
chunk_size?: number;
|
|
8912
|
-
/**
|
|
8913
|
-
* Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
|
|
8914
|
-
*/
|
|
8915
|
-
chunk_overlap?: number;
|
|
9647
|
+
type GetEvalResponse = GetEvalResponses[keyof GetEvalResponses];
|
|
9648
|
+
type UpdateEvalData = {
|
|
9649
|
+
body: {
|
|
9650
|
+
name?: string;
|
|
9651
|
+
agent_id?: string;
|
|
9652
|
+
dataset_id?: string;
|
|
9653
|
+
scorers?: Scorers;
|
|
9654
|
+
pass_threshold?: number | null;
|
|
8916
9655
|
};
|
|
8917
9656
|
path: {
|
|
8918
9657
|
/**
|
|
8919
|
-
*
|
|
8920
|
-
*/
|
|
8921
|
-
document_id: string;
|
|
8922
|
-
};
|
|
8923
|
-
query?: {
|
|
8924
|
-
/**
|
|
8925
|
-
* When omitted or `true` (default), processing runs in the background and `202 Accepted` is returned immediately with `status=pending`. Pass `false` to run synchronously and receive `201 Created` with `status=ready`.
|
|
9658
|
+
* Eval ID
|
|
8926
9659
|
*/
|
|
8927
|
-
|
|
9660
|
+
eval_id: string;
|
|
8928
9661
|
};
|
|
8929
|
-
|
|
9662
|
+
query?: never;
|
|
9663
|
+
url: '/api/v1/evals/{eval_id}';
|
|
8930
9664
|
};
|
|
8931
|
-
type
|
|
9665
|
+
type UpdateEvalErrors = {
|
|
9666
|
+
/**
|
|
9667
|
+
* Bad request
|
|
9668
|
+
*/
|
|
9669
|
+
400: unknown;
|
|
8932
9670
|
/**
|
|
8933
9671
|
* Unauthorized
|
|
8934
9672
|
*/
|
|
8935
|
-
401:
|
|
9673
|
+
401: unknown;
|
|
8936
9674
|
/**
|
|
8937
9675
|
* Forbidden
|
|
8938
9676
|
*/
|
|
8939
|
-
403:
|
|
9677
|
+
403: unknown;
|
|
8940
9678
|
/**
|
|
8941
|
-
*
|
|
9679
|
+
* Eval not found
|
|
8942
9680
|
*/
|
|
8943
|
-
404:
|
|
9681
|
+
404: unknown;
|
|
8944
9682
|
/**
|
|
8945
|
-
*
|
|
9683
|
+
* An eval with that name already exists in the project
|
|
8946
9684
|
*/
|
|
8947
|
-
|
|
9685
|
+
409: unknown;
|
|
8948
9686
|
};
|
|
8949
|
-
type
|
|
8950
|
-
type ReingestDocumentResponses = {
|
|
8951
|
-
/**
|
|
8952
|
-
* Re-ingestion completed synchronously (only when `?async=false`).
|
|
8953
|
-
*/
|
|
8954
|
-
201: IngestedDocumentRecord;
|
|
9687
|
+
type UpdateEvalResponses = {
|
|
8955
9688
|
/**
|
|
8956
|
-
*
|
|
9689
|
+
* Eval updated successfully
|
|
8957
9690
|
*/
|
|
8958
|
-
|
|
9691
|
+
200: Eval;
|
|
8959
9692
|
};
|
|
8960
|
-
type
|
|
8961
|
-
type
|
|
8962
|
-
|
|
8963
|
-
* The converter output contract, adapted for a JSON request body: a single page as `{ text }`, or `{ pages: [{ text, page_number }] }` for multiple pages.
|
|
8964
|
-
*/
|
|
8965
|
-
body: {
|
|
8966
|
-
text: string;
|
|
8967
|
-
} | {
|
|
8968
|
-
pages: Array<{
|
|
8969
|
-
text?: string;
|
|
8970
|
-
page_number?: number;
|
|
8971
|
-
}>;
|
|
8972
|
-
};
|
|
9693
|
+
type UpdateEvalResponse = UpdateEvalResponses[keyof UpdateEvalResponses];
|
|
9694
|
+
type ListEvalRunsData = {
|
|
9695
|
+
body?: never;
|
|
8973
9696
|
path: {
|
|
8974
9697
|
/**
|
|
8975
|
-
*
|
|
9698
|
+
* Eval ID
|
|
8976
9699
|
*/
|
|
8977
|
-
|
|
9700
|
+
eval_id: string;
|
|
8978
9701
|
};
|
|
8979
|
-
query
|
|
9702
|
+
query?: {
|
|
8980
9703
|
/**
|
|
8981
|
-
*
|
|
9704
|
+
* Maximum number of results to return
|
|
9705
|
+
*/
|
|
9706
|
+
limit?: number;
|
|
9707
|
+
/**
|
|
9708
|
+
* Number of results to skip
|
|
8982
9709
|
*/
|
|
8983
|
-
|
|
9710
|
+
offset?: number;
|
|
8984
9711
|
};
|
|
8985
|
-
url: '/api/v1/
|
|
9712
|
+
url: '/api/v1/evals/{eval_id}/runs';
|
|
8986
9713
|
};
|
|
8987
|
-
type
|
|
8988
|
-
/**
|
|
8989
|
-
* The token is missing, invalid, or does not match this document.
|
|
8990
|
-
*/
|
|
8991
|
-
401: ErrorResponse;
|
|
9714
|
+
type ListEvalRunsErrors = {
|
|
8992
9715
|
/**
|
|
8993
|
-
*
|
|
9716
|
+
* Unauthorized
|
|
8994
9717
|
*/
|
|
8995
|
-
|
|
9718
|
+
401: unknown;
|
|
8996
9719
|
/**
|
|
8997
|
-
*
|
|
9720
|
+
* Forbidden
|
|
8998
9721
|
*/
|
|
8999
|
-
|
|
9722
|
+
403: unknown;
|
|
9000
9723
|
/**
|
|
9001
|
-
*
|
|
9724
|
+
* Eval not found
|
|
9002
9725
|
*/
|
|
9003
|
-
|
|
9726
|
+
404: unknown;
|
|
9004
9727
|
};
|
|
9005
|
-
type
|
|
9006
|
-
type CompleteIngestionCallbackResponses = {
|
|
9728
|
+
type ListEvalRunsResponses = {
|
|
9007
9729
|
/**
|
|
9008
|
-
*
|
|
9730
|
+
* List of eval runs
|
|
9009
9731
|
*/
|
|
9010
|
-
|
|
9732
|
+
200: {
|
|
9733
|
+
data: Array<EvalRun>;
|
|
9734
|
+
total: number;
|
|
9735
|
+
limit: number;
|
|
9736
|
+
offset: number;
|
|
9737
|
+
};
|
|
9011
9738
|
};
|
|
9012
|
-
type
|
|
9013
|
-
type
|
|
9014
|
-
body
|
|
9739
|
+
type ListEvalRunsResponse = ListEvalRunsResponses[keyof ListEvalRunsResponses];
|
|
9740
|
+
type StartEvalRunData = {
|
|
9741
|
+
body: {
|
|
9742
|
+
/**
|
|
9743
|
+
* 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.
|
|
9744
|
+
*/
|
|
9745
|
+
wait?: boolean;
|
|
9746
|
+
/**
|
|
9747
|
+
* 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.
|
|
9748
|
+
*/
|
|
9749
|
+
agent_version?: number | null;
|
|
9750
|
+
/**
|
|
9751
|
+
* 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.
|
|
9752
|
+
*/
|
|
9753
|
+
baseline_run_id?: string | null;
|
|
9754
|
+
};
|
|
9015
9755
|
path: {
|
|
9016
9756
|
/**
|
|
9017
|
-
*
|
|
9757
|
+
* Eval ID
|
|
9018
9758
|
*/
|
|
9019
|
-
|
|
9759
|
+
eval_id: string;
|
|
9020
9760
|
};
|
|
9021
9761
|
query?: never;
|
|
9022
|
-
url: '/api/v1/
|
|
9762
|
+
url: '/api/v1/evals/{eval_id}/runs';
|
|
9023
9763
|
};
|
|
9024
|
-
type
|
|
9764
|
+
type StartEvalRunErrors = {
|
|
9765
|
+
/**
|
|
9766
|
+
* Bad request (non-boolean wait, dataset empty or over the synchronous cap, unknown agent_version, invalid baseline, scorers no longer valid against the agent)
|
|
9767
|
+
*/
|
|
9768
|
+
400: unknown;
|
|
9025
9769
|
/**
|
|
9026
9770
|
* Unauthorized
|
|
9027
9771
|
*/
|
|
9028
|
-
401:
|
|
9772
|
+
401: unknown;
|
|
9029
9773
|
/**
|
|
9030
9774
|
* Forbidden
|
|
9031
9775
|
*/
|
|
9032
|
-
403:
|
|
9776
|
+
403: unknown;
|
|
9033
9777
|
/**
|
|
9034
|
-
*
|
|
9778
|
+
* Eval not found
|
|
9035
9779
|
*/
|
|
9036
|
-
404:
|
|
9780
|
+
404: unknown;
|
|
9781
|
+
/**
|
|
9782
|
+
* Internal server error
|
|
9783
|
+
*/
|
|
9784
|
+
500: unknown;
|
|
9037
9785
|
};
|
|
9038
|
-
type
|
|
9039
|
-
type GetDocumentTagsResponses = {
|
|
9786
|
+
type StartEvalRunResponses = {
|
|
9040
9787
|
/**
|
|
9041
|
-
*
|
|
9788
|
+
* Eval run finished (`wait: true`) or queued (`wait: false`)
|
|
9042
9789
|
*/
|
|
9043
|
-
|
|
9044
|
-
[key: string]: string;
|
|
9045
|
-
};
|
|
9790
|
+
201: EvalRun;
|
|
9046
9791
|
};
|
|
9047
|
-
type
|
|
9048
|
-
type
|
|
9049
|
-
body
|
|
9050
|
-
[key: string]: string;
|
|
9051
|
-
};
|
|
9792
|
+
type StartEvalRunResponse = StartEvalRunResponses[keyof StartEvalRunResponses];
|
|
9793
|
+
type GetEvalRunData = {
|
|
9794
|
+
body?: never;
|
|
9052
9795
|
path: {
|
|
9053
9796
|
/**
|
|
9054
|
-
*
|
|
9797
|
+
* Eval ID
|
|
9055
9798
|
*/
|
|
9056
|
-
|
|
9799
|
+
eval_id: string;
|
|
9800
|
+
/**
|
|
9801
|
+
* Eval run ID
|
|
9802
|
+
*/
|
|
9803
|
+
eval_run_id: string;
|
|
9057
9804
|
};
|
|
9058
9805
|
query?: never;
|
|
9059
|
-
url: '/api/v1/
|
|
9806
|
+
url: '/api/v1/evals/{eval_id}/runs/{eval_run_id}';
|
|
9060
9807
|
};
|
|
9061
|
-
type
|
|
9808
|
+
type GetEvalRunErrors = {
|
|
9062
9809
|
/**
|
|
9063
9810
|
* Unauthorized
|
|
9064
9811
|
*/
|
|
9065
|
-
401:
|
|
9812
|
+
401: unknown;
|
|
9066
9813
|
/**
|
|
9067
9814
|
* Forbidden
|
|
9068
9815
|
*/
|
|
9069
|
-
403:
|
|
9816
|
+
403: unknown;
|
|
9070
9817
|
/**
|
|
9071
|
-
*
|
|
9818
|
+
* Eval or run not found
|
|
9072
9819
|
*/
|
|
9073
|
-
404:
|
|
9820
|
+
404: unknown;
|
|
9074
9821
|
};
|
|
9075
|
-
type
|
|
9076
|
-
type MergeDocumentTagsResponses = {
|
|
9822
|
+
type GetEvalRunResponses = {
|
|
9077
9823
|
/**
|
|
9078
|
-
*
|
|
9824
|
+
* Eval run details
|
|
9079
9825
|
*/
|
|
9080
|
-
200:
|
|
9081
|
-
[key: string]: string;
|
|
9082
|
-
};
|
|
9826
|
+
200: EvalRun;
|
|
9083
9827
|
};
|
|
9084
|
-
type
|
|
9085
|
-
type
|
|
9086
|
-
body
|
|
9087
|
-
[key: string]: string;
|
|
9088
|
-
};
|
|
9828
|
+
type GetEvalRunResponse = GetEvalRunResponses[keyof GetEvalRunResponses];
|
|
9829
|
+
type ListEvalResultsData = {
|
|
9830
|
+
body?: never;
|
|
9089
9831
|
path: {
|
|
9090
9832
|
/**
|
|
9091
|
-
*
|
|
9833
|
+
* Eval ID
|
|
9092
9834
|
*/
|
|
9093
|
-
|
|
9835
|
+
eval_id: string;
|
|
9836
|
+
/**
|
|
9837
|
+
* Eval run ID
|
|
9838
|
+
*/
|
|
9839
|
+
eval_run_id: string;
|
|
9094
9840
|
};
|
|
9095
|
-
query?:
|
|
9096
|
-
|
|
9841
|
+
query?: {
|
|
9842
|
+
/**
|
|
9843
|
+
* Maximum number of results to return
|
|
9844
|
+
*/
|
|
9845
|
+
limit?: number;
|
|
9846
|
+
/**
|
|
9847
|
+
* Number of results to skip
|
|
9848
|
+
*/
|
|
9849
|
+
offset?: number;
|
|
9850
|
+
};
|
|
9851
|
+
url: '/api/v1/evals/{eval_id}/runs/{eval_run_id}/results';
|
|
9097
9852
|
};
|
|
9098
|
-
type
|
|
9853
|
+
type ListEvalResultsErrors = {
|
|
9099
9854
|
/**
|
|
9100
9855
|
* Unauthorized
|
|
9101
9856
|
*/
|
|
9102
|
-
401:
|
|
9857
|
+
401: unknown;
|
|
9103
9858
|
/**
|
|
9104
9859
|
* Forbidden
|
|
9105
9860
|
*/
|
|
9106
|
-
403:
|
|
9861
|
+
403: unknown;
|
|
9107
9862
|
/**
|
|
9108
|
-
*
|
|
9863
|
+
* Eval or run not found
|
|
9109
9864
|
*/
|
|
9110
|
-
404:
|
|
9865
|
+
404: unknown;
|
|
9111
9866
|
};
|
|
9112
|
-
type
|
|
9113
|
-
type ReplaceDocumentTagsResponses = {
|
|
9867
|
+
type ListEvalResultsResponses = {
|
|
9114
9868
|
/**
|
|
9115
|
-
*
|
|
9869
|
+
* List of eval results
|
|
9116
9870
|
*/
|
|
9117
9871
|
200: {
|
|
9118
|
-
|
|
9872
|
+
data: Array<EvalResult>;
|
|
9873
|
+
total: number;
|
|
9874
|
+
limit: number;
|
|
9875
|
+
offset: number;
|
|
9119
9876
|
};
|
|
9120
9877
|
};
|
|
9121
|
-
type
|
|
9122
|
-
type
|
|
9123
|
-
body
|
|
9878
|
+
type ListEvalResultsResponse = ListEvalResultsResponses[keyof ListEvalResultsResponses];
|
|
9879
|
+
type CancelEvalRunData = {
|
|
9880
|
+
body?: never;
|
|
9881
|
+
path: {
|
|
9124
9882
|
/**
|
|
9125
|
-
*
|
|
9883
|
+
* Eval ID
|
|
9126
9884
|
*/
|
|
9127
|
-
|
|
9885
|
+
eval_id: string;
|
|
9128
9886
|
/**
|
|
9129
|
-
*
|
|
9887
|
+
* Eval run ID
|
|
9130
9888
|
*/
|
|
9131
|
-
|
|
9889
|
+
eval_run_id: string;
|
|
9132
9890
|
};
|
|
9133
|
-
path?: never;
|
|
9134
9891
|
query?: never;
|
|
9135
|
-
url: '/api/v1/
|
|
9892
|
+
url: '/api/v1/evals/{eval_id}/runs/{eval_run_id}/cancel';
|
|
9136
9893
|
};
|
|
9137
|
-
type
|
|
9894
|
+
type CancelEvalRunErrors = {
|
|
9138
9895
|
/**
|
|
9139
|
-
*
|
|
9896
|
+
* The run has already finished
|
|
9140
9897
|
*/
|
|
9141
|
-
400:
|
|
9898
|
+
400: unknown;
|
|
9142
9899
|
/**
|
|
9143
9900
|
* Unauthorized
|
|
9144
9901
|
*/
|
|
9145
|
-
401:
|
|
9902
|
+
401: unknown;
|
|
9146
9903
|
/**
|
|
9147
|
-
*
|
|
9904
|
+
* Forbidden
|
|
9148
9905
|
*/
|
|
9149
|
-
|
|
9906
|
+
403: unknown;
|
|
9907
|
+
/**
|
|
9908
|
+
* Eval or run not found
|
|
9909
|
+
*/
|
|
9910
|
+
404: unknown;
|
|
9911
|
+
/**
|
|
9912
|
+
* Internal server error
|
|
9913
|
+
*/
|
|
9914
|
+
500: unknown;
|
|
9150
9915
|
};
|
|
9151
|
-
type
|
|
9152
|
-
type CreateEmbeddingsResponses = {
|
|
9916
|
+
type CancelEvalRunResponses = {
|
|
9153
9917
|
/**
|
|
9154
|
-
*
|
|
9918
|
+
* Eval run canceled
|
|
9155
9919
|
*/
|
|
9156
|
-
200:
|
|
9920
|
+
200: EvalRun;
|
|
9157
9921
|
};
|
|
9158
|
-
type
|
|
9922
|
+
type CancelEvalRunResponse = CancelEvalRunResponses[keyof CancelEvalRunResponses];
|
|
9159
9923
|
type ListExceptionsData = {
|
|
9160
9924
|
body?: never;
|
|
9161
9925
|
path?: never;
|
|
@@ -13307,9 +14071,9 @@ type GenerateSessionResponseData = {
|
|
|
13307
14071
|
};
|
|
13308
14072
|
query?: {
|
|
13309
14073
|
/**
|
|
13310
|
-
* When
|
|
14074
|
+
* When omitted or `false` (default), generation runs in the background and `202 Accepted` is returned immediately. Pass `true` to block until the generation settles and receive the result.
|
|
13311
14075
|
*/
|
|
13312
|
-
|
|
14076
|
+
wait?: boolean;
|
|
13313
14077
|
};
|
|
13314
14078
|
url: '/api/v1/sessions/{session_id}/generate';
|
|
13315
14079
|
};
|
|
@@ -13343,11 +14107,11 @@ type GenerateSessionResponseErrors = {
|
|
|
13343
14107
|
type GenerateSessionResponseError = GenerateSessionResponseErrors[keyof GenerateSessionResponseErrors];
|
|
13344
14108
|
type GenerateSessionResponseResponses = {
|
|
13345
14109
|
/**
|
|
13346
|
-
* Agent reply or requires_action
|
|
14110
|
+
* Agent reply or requires_action (only when `?wait=true`)
|
|
13347
14111
|
*/
|
|
13348
14112
|
200: GenerateSessionResponse;
|
|
13349
14113
|
/**
|
|
13350
|
-
* Generation accepted (
|
|
14114
|
+
* Generation accepted and running in the background (default, when `wait` is omitted or `false`)
|
|
13351
14115
|
*/
|
|
13352
14116
|
202: {
|
|
13353
14117
|
status?: 'accepted';
|
|
@@ -14085,7 +14849,7 @@ type ListTriggersData = {
|
|
|
14085
14849
|
query?: {
|
|
14086
14850
|
project_id?: string;
|
|
14087
14851
|
type?: 'manual' | 'webhook' | 'schedule';
|
|
14088
|
-
target_type?: 'orchestration' | 'agent' | 'tool';
|
|
14852
|
+
target_type?: 'orchestration' | 'agent' | 'tool' | 'eval';
|
|
14089
14853
|
/**
|
|
14090
14854
|
* Maximum number of results to return
|
|
14091
14855
|
*/
|
|
@@ -15617,7 +16381,7 @@ declare class Agents {
|
|
|
15617
16381
|
/**
|
|
15618
16382
|
* Run an agent generation
|
|
15619
16383
|
*
|
|
15620
|
-
* Sends messages to the agent, resolves its tools, and runs the AI model loop.
|
|
16384
|
+
* Sends messages to the agent, resolves its tools, and runs the AI model loop. Background by default: returns `202 Accepted` with a `generation_id` to poll via `GET /api/v1/generations/{generation_id}`. Pass `?wait=true` to block and receive the result inline, where client tools pause the generation and return `requires_action`. Streaming (`stream: true`) implies waiting.
|
|
15621
16385
|
*
|
|
15622
16386
|
*/
|
|
15623
16387
|
static createAgentGeneration<ThrowOnError extends boolean = false>(options: Options<CreateAgentGenerationData, ThrowOnError>): RequestResult<CreateAgentGenerationResponses, CreateAgentGenerationErrors, ThrowOnError>;
|
|
@@ -15669,6 +16433,8 @@ declare class AgentVersions {
|
|
|
15669
16433
|
*
|
|
15670
16434
|
* Makes the canary version's config the agent's live config and clears the release. The canary is pinned by version, so an edit that landed mid-rollout is not promoted in its place — it stays an unreleased draft in the version history.
|
|
15671
16435
|
*
|
|
16436
|
+
* When the release carries a `promotion_gate`, the eval it names must have a run that finished `completed` with `passed: true` **and** was pinned to the canary version (`agent_version`); otherwise the call is a `409` and the rollout is left running untouched. The run that cleared the gate is recorded as `eval_run_id` on the version that goes live.
|
|
16437
|
+
*
|
|
15672
16438
|
*/
|
|
15673
16439
|
static promoteAgentRelease<ThrowOnError extends boolean = false>(options: Options<PromoteAgentReleaseData, ThrowOnError>): RequestResult<PromoteAgentReleaseResponses, PromoteAgentReleaseErrors, ThrowOnError>;
|
|
15674
16440
|
/**
|
|
@@ -15697,7 +16463,7 @@ declare class AiProviders {
|
|
|
15697
16463
|
*
|
|
15698
16464
|
* Deletes an AI provider configuration.
|
|
15699
16465
|
*
|
|
15700
|
-
* Live references — chats, agents,
|
|
16466
|
+
* Live references — chats, agents, and model routes whose targets name this provider — always block deletion with `409 AI_PROVIDER_HAS_DEPENDENTS`; `force` does not override them, so delete or repoint those resources first. Soft dependents — price overrides and usage/generation records — also block with `409` unless `force=true`, which deletes the provider's price overrides and unlinks (nulls) its usage history, preserving those rows. The `409` body's `error.meta` reports the counts, a sample of offending IDs, and a `forcible` flag that is `true` when a `force=true` retry would succeed.
|
|
15701
16467
|
*
|
|
15702
16468
|
*/
|
|
15703
16469
|
static deleteAiProvider<ThrowOnError extends boolean = false>(options: Options<DeleteAiProviderData, ThrowOnError>): RequestResult<DeleteAiProviderResponses, DeleteAiProviderErrors, ThrowOnError>;
|
|
@@ -15713,6 +16479,15 @@ declare class AiProviders {
|
|
|
15713
16479
|
* Updates an AI provider configuration
|
|
15714
16480
|
*/
|
|
15715
16481
|
static updateAiProvider<ThrowOnError extends boolean = false>(options: Options<UpdateAiProviderData, ThrowOnError>): RequestResult<UpdateAiProviderResponses, UpdateAiProviderErrors, ThrowOnError>;
|
|
16482
|
+
/**
|
|
16483
|
+
* List the models this provider can run
|
|
16484
|
+
*
|
|
16485
|
+
* Asks the provider which models it can run, using this provider record's own credentials and configuration, and returns provider-native model ids — the same strings `default_model` and an agent's `model` carry.
|
|
16486
|
+
* Which models are reachable is a property of the credential, not of the provider type: a Vertex provider sees only the publisher models its Google Cloud project and location serve, and a Bedrock provider only the foundation models enabled in its region. Reading the list is how a caller avoids pinning a model that fails at generation time.
|
|
16487
|
+
* Not every provider type can answer. `azure` lists deployments an operator named rather than models, and `ollama` lists whatever was pulled onto that host, so both return `400 MODEL_LISTING_UNSUPPORTED`.
|
|
16488
|
+
*
|
|
16489
|
+
*/
|
|
16490
|
+
static listAiProviderModels<ThrowOnError extends boolean = false>(options: Options<ListAiProviderModelsData, ThrowOnError>): RequestResult<ListAiProviderModelsResponses, ListAiProviderModelsErrors, ThrowOnError>;
|
|
15716
16491
|
/**
|
|
15717
16492
|
* List per-provider price overrides
|
|
15718
16493
|
*
|
|
@@ -15901,9 +16676,14 @@ declare class Conversations {
|
|
|
15901
16676
|
* Generate the next message in a conversation
|
|
15902
16677
|
*
|
|
15903
16678
|
* Generates the next message using the specified actor's linked agent or chat.
|
|
15904
|
-
*
|
|
15905
|
-
*
|
|
15906
|
-
*
|
|
16679
|
+
* Background by default: returns `202 Accepted` immediately and the reply
|
|
16680
|
+
* lands as a new ConversationMessage when it completes — poll
|
|
16681
|
+
* `GET /api/v1/conversations/{conversation_id}/messages` for it.
|
|
16682
|
+
* Pass `?wait=true` to block and receive the result inline. On
|
|
16683
|
+
* `completed`, the reply is persisted as a new ConversationMessage
|
|
16684
|
+
* authored by that actor. On `requires_action`, nothing is persisted; the
|
|
16685
|
+
* caller must submit tool outputs via the Agents module and re-invoke
|
|
16686
|
+
* generate — so a flow using client tools should pass `?wait=true`.
|
|
15907
16687
|
*
|
|
15908
16688
|
*/
|
|
15909
16689
|
static generateConversationMessage<ThrowOnError extends boolean = false>(options: Options<GenerateConversationMessageData, ThrowOnError>): RequestResult<GenerateConversationMessageResponses, GenerateConversationMessageErrors, ThrowOnError>;
|
|
@@ -15932,57 +16712,6 @@ declare class Conversations {
|
|
|
15932
16712
|
*/
|
|
15933
16713
|
static replaceConversationTags<ThrowOnError extends boolean = false>(options: Options<ReplaceConversationTagsData, ThrowOnError>): RequestResult<ReplaceConversationTagsResponses, ReplaceConversationTagsErrors, ThrowOnError>;
|
|
15934
16714
|
}
|
|
15935
|
-
declare class Discussions {
|
|
15936
|
-
/**
|
|
15937
|
-
* List discussions
|
|
15938
|
-
*
|
|
15939
|
-
* Returns all discussions the caller has access to. If project_id is provided, returns only discussions in that project.
|
|
15940
|
-
*/
|
|
15941
|
-
static listDiscussions<ThrowOnError extends boolean = false>(options?: Options<ListDiscussionsData, ThrowOnError>): RequestResult<ListDiscussionsResponses, ListDiscussionsErrors, ThrowOnError>;
|
|
15942
|
-
/**
|
|
15943
|
-
* Create a discussion
|
|
15944
|
-
*
|
|
15945
|
-
* Creates a new discussion config. project keys infer the project from the key's scope; JWT callers must supply project_id.
|
|
15946
|
-
*/
|
|
15947
|
-
static createDiscussion<ThrowOnError extends boolean = false>(options: Options<CreateDiscussionData, ThrowOnError>): RequestResult<CreateDiscussionResponses, CreateDiscussionErrors, ThrowOnError>;
|
|
15948
|
-
/**
|
|
15949
|
-
* Get a discussion run by ID
|
|
15950
|
-
*
|
|
15951
|
-
* Returns a single discussion run, including its outcome, transcript conversation, and outcome document.
|
|
15952
|
-
*/
|
|
15953
|
-
static getDiscussionRun<ThrowOnError extends boolean = false>(options: Options<GetDiscussionRunData, ThrowOnError>): RequestResult<GetDiscussionRunResponses, GetDiscussionRunErrors, ThrowOnError>;
|
|
15954
|
-
/**
|
|
15955
|
-
* Delete a discussion
|
|
15956
|
-
*
|
|
15957
|
-
* Deletes a discussion config and its participants.
|
|
15958
|
-
*/
|
|
15959
|
-
static deleteDiscussion<ThrowOnError extends boolean = false>(options: Options<DeleteDiscussionData, ThrowOnError>): RequestResult<DeleteDiscussionResponses, DeleteDiscussionErrors, ThrowOnError>;
|
|
15960
|
-
/**
|
|
15961
|
-
* Get a discussion by ID
|
|
15962
|
-
*
|
|
15963
|
-
* Returns a discussion config with its participants.
|
|
15964
|
-
*/
|
|
15965
|
-
static getDiscussion<ThrowOnError extends boolean = false>(options: Options<GetDiscussionData, ThrowOnError>): RequestResult<GetDiscussionResponses, GetDiscussionErrors, ThrowOnError>;
|
|
15966
|
-
/**
|
|
15967
|
-
* Update a discussion
|
|
15968
|
-
*
|
|
15969
|
-
* Updates a discussion. Providing participants replaces the full set (not merged).
|
|
15970
|
-
*/
|
|
15971
|
-
static updateDiscussion<ThrowOnError extends boolean = false>(options: Options<UpdateDiscussionData, ThrowOnError>): RequestResult<UpdateDiscussionResponses, UpdateDiscussionErrors, ThrowOnError>;
|
|
15972
|
-
/**
|
|
15973
|
-
* List a discussion's runs
|
|
15974
|
-
*
|
|
15975
|
-
* Returns the run history of a discussion, most recent first.
|
|
15976
|
-
*/
|
|
15977
|
-
static listDiscussionRuns<ThrowOnError extends boolean = false>(options: Options<ListDiscussionRunsData, ThrowOnError>): RequestResult<ListDiscussionRunsResponses, ListDiscussionRunsErrors, ThrowOnError>;
|
|
15978
|
-
/**
|
|
15979
|
-
* Invoke a discussion
|
|
15980
|
-
*
|
|
15981
|
-
* Runs the discussion synchronously over the given topic and returns the completed run, whose outcome inlines the synthesized text. The run's transcript is persisted as a conversation and the outcome as a document.
|
|
15982
|
-
*
|
|
15983
|
-
*/
|
|
15984
|
-
static createDiscussionRun<ThrowOnError extends boolean = false>(options: Options<CreateDiscussionRunData, ThrowOnError>): RequestResult<CreateDiscussionRunResponses, CreateDiscussionRunErrors, ThrowOnError>;
|
|
15985
|
-
}
|
|
15986
16715
|
declare class Documents {
|
|
15987
16716
|
/**
|
|
15988
16717
|
* List documents
|
|
@@ -16050,8 +16779,8 @@ declare class Documents {
|
|
|
16050
16779
|
* source file. Existing chunks are discarded and the document is reset to
|
|
16051
16780
|
* `status=pending` before re-processing. Use this to recover a document
|
|
16052
16781
|
* stuck in `processing`/`failed` or to re-chunk with a different strategy
|
|
16053
|
-
* without re-uploading the file.
|
|
16054
|
-
* `?
|
|
16782
|
+
* without re-uploading the file. Background by default (`202`); pass
|
|
16783
|
+
* `?wait=true` to run synchronously (`201`).
|
|
16055
16784
|
*
|
|
16056
16785
|
*/
|
|
16057
16786
|
static reingestDocument<ThrowOnError extends boolean = false>(options: Options<ReingestDocumentData, ThrowOnError>): RequestResult<ReingestDocumentResponses, ReingestDocumentErrors, ThrowOnError>;
|
|
@@ -16100,6 +16829,138 @@ declare class Embeddings {
|
|
|
16100
16829
|
*/
|
|
16101
16830
|
static createEmbeddings<ThrowOnError extends boolean = false>(options: Options<CreateEmbeddingsData, ThrowOnError>): RequestResult<CreateEmbeddingsResponses, CreateEmbeddingsErrors, ThrowOnError>;
|
|
16102
16831
|
}
|
|
16832
|
+
declare class Evaluations {
|
|
16833
|
+
/**
|
|
16834
|
+
* List datasets
|
|
16835
|
+
*
|
|
16836
|
+
* Returns the datasets defined in a project
|
|
16837
|
+
*/
|
|
16838
|
+
static listDatasets<ThrowOnError extends boolean = false>(options?: Options<ListDatasetsData, ThrowOnError>): RequestResult<ListDatasetsResponses, ListDatasetsErrors, ThrowOnError>;
|
|
16839
|
+
/**
|
|
16840
|
+
* Create a dataset
|
|
16841
|
+
*
|
|
16842
|
+
* Creates a project-scoped dataset — a named collection of test cases an eval runs an agent against. Names are unique per project.
|
|
16843
|
+
*
|
|
16844
|
+
* Datasets are operator-owned **fixtures**. The platform's content purge never deletes or mutates a dataset item, so erasing a generation cannot silently stop a test suite from being runnable.
|
|
16845
|
+
*/
|
|
16846
|
+
static createDataset<ThrowOnError extends boolean = false>(options: Options<CreateDatasetData, ThrowOnError>): RequestResult<CreateDatasetResponses, CreateDatasetErrors, ThrowOnError>;
|
|
16847
|
+
/**
|
|
16848
|
+
* Delete a dataset
|
|
16849
|
+
*
|
|
16850
|
+
* Deletes a dataset, its items, and every eval bound to it. Results of runs that already scored those items keep their frozen copies of the input and expected output.
|
|
16851
|
+
*/
|
|
16852
|
+
static deleteDataset<ThrowOnError extends boolean = false>(options: Options<DeleteDatasetData, ThrowOnError>): RequestResult<DeleteDatasetResponses, DeleteDatasetErrors, ThrowOnError>;
|
|
16853
|
+
/**
|
|
16854
|
+
* Get a dataset
|
|
16855
|
+
*
|
|
16856
|
+
* Returns a specific dataset
|
|
16857
|
+
*/
|
|
16858
|
+
static getDataset<ThrowOnError extends boolean = false>(options: Options<GetDatasetData, ThrowOnError>): RequestResult<GetDatasetResponses, GetDatasetErrors, ThrowOnError>;
|
|
16859
|
+
/**
|
|
16860
|
+
* Update a dataset
|
|
16861
|
+
*
|
|
16862
|
+
* Updates a dataset's name and/or description
|
|
16863
|
+
*/
|
|
16864
|
+
static updateDataset<ThrowOnError extends boolean = false>(options: Options<UpdateDatasetData, ThrowOnError>): RequestResult<UpdateDatasetResponses, UpdateDatasetErrors, ThrowOnError>;
|
|
16865
|
+
/**
|
|
16866
|
+
* List dataset items
|
|
16867
|
+
*
|
|
16868
|
+
* Returns the test cases in a dataset, oldest first
|
|
16869
|
+
*/
|
|
16870
|
+
static listDatasetItems<ThrowOnError extends boolean = false>(options: Options<ListDatasetItemsData, ThrowOnError>): RequestResult<ListDatasetItemsResponses, ListDatasetItemsErrors, ThrowOnError>;
|
|
16871
|
+
/**
|
|
16872
|
+
* Add a dataset item
|
|
16873
|
+
*
|
|
16874
|
+
* Adds one test case. `input` is replayed verbatim as the generation's messages, so it must be a non-empty array of `{ role, content }`.
|
|
16875
|
+
*/
|
|
16876
|
+
static createDatasetItem<ThrowOnError extends boolean = false>(options: Options<CreateDatasetItemData, ThrowOnError>): RequestResult<CreateDatasetItemResponses, CreateDatasetItemErrors, ThrowOnError>;
|
|
16877
|
+
/**
|
|
16878
|
+
* Delete a dataset item
|
|
16879
|
+
*
|
|
16880
|
+
* Deletes a test case. Results of runs that already scored it stay readable; their `dataset_item_id` becomes null.
|
|
16881
|
+
*/
|
|
16882
|
+
static deleteDatasetItem<ThrowOnError extends boolean = false>(options: Options<DeleteDatasetItemData, ThrowOnError>): RequestResult<DeleteDatasetItemResponses, DeleteDatasetItemErrors, ThrowOnError>;
|
|
16883
|
+
/**
|
|
16884
|
+
* Update a dataset item
|
|
16885
|
+
*
|
|
16886
|
+
* Updates a test case. Runs that already scored it are unaffected — each result carries its own frozen copy of the input and expected output.
|
|
16887
|
+
*/
|
|
16888
|
+
static updateDatasetItem<ThrowOnError extends boolean = false>(options: Options<UpdateDatasetItemData, ThrowOnError>): RequestResult<UpdateDatasetItemResponses, UpdateDatasetItemErrors, ThrowOnError>;
|
|
16889
|
+
/**
|
|
16890
|
+
* List evals
|
|
16891
|
+
*
|
|
16892
|
+
* Returns the evals defined in a project
|
|
16893
|
+
*/
|
|
16894
|
+
static listEvals<ThrowOnError extends boolean = false>(options?: Options<ListEvalsData, ThrowOnError>): RequestResult<ListEvalsResponses, ListEvalsErrors, ThrowOnError>;
|
|
16895
|
+
/**
|
|
16896
|
+
* Create an eval
|
|
16897
|
+
*
|
|
16898
|
+
* Binds an agent under test to a dataset and a list of scorers. The agent and the dataset must belong to the same project as the eval; a cross-project reference is rejected with 400.
|
|
16899
|
+
*
|
|
16900
|
+
* Scorer config is frozen here rather than read from the agent at run time, so two runs of the same eval are always judged by the same criteria and their comparison measures the agent instead of the config drifting underneath it. Each scorer `type` may appear at most once.
|
|
16901
|
+
*/
|
|
16902
|
+
static createEval<ThrowOnError extends boolean = false>(options: Options<CreateEvalData, ThrowOnError>): RequestResult<CreateEvalResponses, CreateEvalErrors, ThrowOnError>;
|
|
16903
|
+
/**
|
|
16904
|
+
* Delete an eval
|
|
16905
|
+
*
|
|
16906
|
+
* Deletes an eval, its runs, and their results
|
|
16907
|
+
*/
|
|
16908
|
+
static deleteEval<ThrowOnError extends boolean = false>(options: Options<DeleteEvalData, ThrowOnError>): RequestResult<DeleteEvalResponses, DeleteEvalErrors, ThrowOnError>;
|
|
16909
|
+
/**
|
|
16910
|
+
* Get an eval
|
|
16911
|
+
*
|
|
16912
|
+
* Returns a specific eval
|
|
16913
|
+
*/
|
|
16914
|
+
static getEval<ThrowOnError extends boolean = false>(options: Options<GetEvalData, ThrowOnError>): RequestResult<GetEvalResponses, GetEvalErrors, ThrowOnError>;
|
|
16915
|
+
/**
|
|
16916
|
+
* Update an eval
|
|
16917
|
+
*
|
|
16918
|
+
* Updates an eval. Changing `agent_id` re-validates the scorers against the new agent, since an `output_schema` scorer that was legal against the old one may not be.
|
|
16919
|
+
*/
|
|
16920
|
+
static updateEval<ThrowOnError extends boolean = false>(options: Options<UpdateEvalData, ThrowOnError>): RequestResult<UpdateEvalResponses, UpdateEvalErrors, ThrowOnError>;
|
|
16921
|
+
/**
|
|
16922
|
+
* List eval runs
|
|
16923
|
+
*
|
|
16924
|
+
* Returns an eval's runs, newest first
|
|
16925
|
+
*/
|
|
16926
|
+
static listEvalRuns<ThrowOnError extends boolean = false>(options: Options<ListEvalRunsData, ThrowOnError>): RequestResult<ListEvalRunsResponses, ListEvalRunsErrors, ThrowOnError>;
|
|
16927
|
+
/**
|
|
16928
|
+
* Start an eval run
|
|
16929
|
+
*
|
|
16930
|
+
* Runs the eval against its dataset, creating one real agent generation per item and scoring the outputs.
|
|
16931
|
+
*
|
|
16932
|
+
* `wait: true` executes the run synchronously and returns it terminal, with its scores. The dataset is capped at 25 items for a synchronous run; a larger one is rejected with 400 rather than partially scored.
|
|
16933
|
+
*
|
|
16934
|
+
* `wait: false` (the default) enqueues one task per item and returns immediately with `status: "queued"`. A worker executes the items and the run settles itself; poll `GET /evals/{eval_id}/runs/{eval_run_id}` for the terminal status, or subscribe to the `eval_run.completed` webhook. There is no item cap on a queued run.
|
|
16935
|
+
*
|
|
16936
|
+
* The whole run is pinned to **one** agent version, stamped on `agent_version`: pass one explicitly to evaluate a canary before promoting it, or omit it to use the active release's stable version (or the live draft when no release is in effect). Without the pin, release assignment would bucket each item independently and blend two configs into a single score.
|
|
16937
|
+
*
|
|
16938
|
+
* With `baseline_run_id`, the finished run's `aggregate_scores.baseline` carries per-scorer deltas against that run, computed over the items present and scorable in **both** runs, with the divergence counted. A delta over a shifted dataset is therefore never presented as a clean comparison.
|
|
16939
|
+
*/
|
|
16940
|
+
static startEvalRun<ThrowOnError extends boolean = false>(options: Options<StartEvalRunData, ThrowOnError>): RequestResult<StartEvalRunResponses, StartEvalRunErrors, ThrowOnError>;
|
|
16941
|
+
/**
|
|
16942
|
+
* Get an eval run
|
|
16943
|
+
*
|
|
16944
|
+
* Returns a run's status, counts, and aggregate scores
|
|
16945
|
+
*/
|
|
16946
|
+
static getEvalRun<ThrowOnError extends boolean = false>(options: Options<GetEvalRunData, ThrowOnError>): RequestResult<GetEvalRunResponses, GetEvalRunErrors, ThrowOnError>;
|
|
16947
|
+
/**
|
|
16948
|
+
* List eval run results
|
|
16949
|
+
*
|
|
16950
|
+
* Returns the per-item results of a run, oldest first
|
|
16951
|
+
*/
|
|
16952
|
+
static listEvalResults<ThrowOnError extends boolean = false>(options: Options<ListEvalResultsData, ThrowOnError>): RequestResult<ListEvalResultsResponses, ListEvalResultsErrors, ThrowOnError>;
|
|
16953
|
+
/**
|
|
16954
|
+
* Cancel an eval run
|
|
16955
|
+
*
|
|
16956
|
+
* Cancels a queued or running run: its outstanding item tasks are dropped so it stops consuming provider budget, and the run settles as `canceled`.
|
|
16957
|
+
*
|
|
16958
|
+
* Results already written are kept — they are real measurements of generations that were really paid for — and `completed_count` / `errored_count` report what ran. `aggregate_scores` is deliberately left null: a partial roll-up in the same field a completed run uses would read as a whole-dataset verdict.
|
|
16959
|
+
*
|
|
16960
|
+
* A run that has already finished is rejected with 400.
|
|
16961
|
+
*/
|
|
16962
|
+
static cancelEvalRun<ThrowOnError extends boolean = false>(options: Options<CancelEvalRunData, ThrowOnError>): RequestResult<CancelEvalRunResponses, CancelEvalRunErrors, ThrowOnError>;
|
|
16963
|
+
}
|
|
16103
16964
|
declare class Exceptions {
|
|
16104
16965
|
/**
|
|
16105
16966
|
* List exception items
|
|
@@ -16797,7 +17658,7 @@ declare class Sessions {
|
|
|
16797
17658
|
/**
|
|
16798
17659
|
* Trigger agent generation
|
|
16799
17660
|
*
|
|
16800
|
-
* Triggers the agent to generate a response based on the current conversation.
|
|
17661
|
+
* Triggers the agent to generate a response based on the current conversation. Background by default: returns `202 Accepted` immediately while the generation runs. Pass ?wait=true to block and receive the assistant reply (or a requires_action status if the agent needs client tool outputs) in the response.
|
|
16801
17662
|
*
|
|
16802
17663
|
*/
|
|
16803
17664
|
static generateSessionResponse<ThrowOnError extends boolean = false>(options: Options<GenerateSessionResponseData, ThrowOnError>): RequestResult<GenerateSessionResponseResponses, GenerateSessionResponseErrors, ThrowOnError>;
|
|
@@ -16978,7 +17839,7 @@ declare class Triggers {
|
|
|
16978
17839
|
/**
|
|
16979
17840
|
* Fire a trigger
|
|
16980
17841
|
*
|
|
16981
|
-
* Fires a trigger synchronously and returns the terminal firing record.
|
|
17842
|
+
* Fires a trigger synchronously and returns the terminal firing record. The firing itself always settles here; an `eval` target's run is queued rather than executed inline, so the record names a `queued` run to poll.
|
|
16982
17843
|
*/
|
|
16983
17844
|
static fireTrigger<ThrowOnError extends boolean = false>(options: Options<FireTriggerData, ThrowOnError>): RequestResult<FireTriggerResponses, FireTriggerErrors, ThrowOnError>;
|
|
16984
17845
|
/**
|
|
@@ -17266,32 +18127,50 @@ interface SoatClientOptions {
|
|
|
17266
18127
|
* the corresponding static class from the generated SDK, so all method
|
|
17267
18128
|
* signatures, types, and return values are identical — the only difference
|
|
17268
18129
|
* is that you never need to supply `client` yourself.
|
|
18130
|
+
*
|
|
18131
|
+
* The list is exhaustive by construction: `NoUnregisteredResource` at the
|
|
18132
|
+
* bottom of this file fails `pnpm typecheck` when a spec adds a resource this
|
|
18133
|
+
* class does not expose.
|
|
17269
18134
|
*/
|
|
17270
18135
|
declare class SoatClient {
|
|
18136
|
+
readonly activity: typeof Activity;
|
|
17271
18137
|
readonly actors: typeof Actors;
|
|
17272
18138
|
readonly agents: typeof Agents;
|
|
18139
|
+
readonly agentVersions: typeof AgentVersions;
|
|
17273
18140
|
readonly aiProviders: typeof AiProviders;
|
|
17274
18141
|
readonly apiKeys: typeof ApiKeys;
|
|
18142
|
+
readonly approvals: typeof Approvals;
|
|
18143
|
+
readonly auditLog: typeof AuditLog;
|
|
17275
18144
|
readonly chats: typeof Chats;
|
|
17276
18145
|
readonly conversations: typeof Conversations;
|
|
17277
18146
|
readonly documents: typeof Documents;
|
|
18147
|
+
readonly embeddings: typeof Embeddings;
|
|
18148
|
+
readonly evaluations: typeof Evaluations;
|
|
18149
|
+
readonly exceptions: typeof Exceptions;
|
|
17278
18150
|
readonly files: typeof Files;
|
|
17279
18151
|
readonly formations: typeof Formations;
|
|
18152
|
+
readonly generations: typeof Generations;
|
|
18153
|
+
readonly guardrails: typeof Guardrails;
|
|
17280
18154
|
readonly ingestionRules: typeof IngestionRules;
|
|
17281
18155
|
readonly knowledge: typeof Knowledge;
|
|
17282
18156
|
readonly memories: typeof Memories;
|
|
17283
18157
|
readonly memoryEntries: typeof MemoryEntries;
|
|
18158
|
+
readonly modelRoutes: typeof ModelRoutes;
|
|
18159
|
+
readonly orchestrations: typeof Orchestrations;
|
|
17284
18160
|
readonly policies: typeof Policies;
|
|
17285
18161
|
readonly projects: typeof Projects;
|
|
18162
|
+
readonly quotas: typeof Quotas;
|
|
17286
18163
|
readonly secrets: typeof Secrets;
|
|
17287
18164
|
readonly sessions: typeof Sessions;
|
|
18165
|
+
readonly tasks: typeof Tasks;
|
|
17288
18166
|
readonly tools: typeof Tools;
|
|
17289
18167
|
readonly traces: typeof Traces;
|
|
17290
18168
|
readonly triggers: typeof Triggers;
|
|
17291
18169
|
readonly usage: typeof Usage;
|
|
17292
18170
|
readonly users: typeof Users;
|
|
17293
18171
|
readonly webhooks: typeof Webhooks;
|
|
18172
|
+
readonly workflows: typeof Workflows;
|
|
17294
18173
|
constructor({ baseUrl, token, headers }?: SoatClientOptions);
|
|
17295
18174
|
}
|
|
17296
18175
|
//#endregion
|
|
17297
|
-
export { type AbortAgentReleaseData, type AbortAgentReleaseError, type AbortAgentReleaseErrors, type AbortAgentReleaseResponse, type AbortAgentReleaseResponses, type AcknowledgeExceptionData, type AcknowledgeExceptionErrors, type AcknowledgeExceptionResponse, type AcknowledgeExceptionResponses, 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 Agent, type AgentGenerationResponse, type AgentRelease, type AgentResourceProperties, type AgentVersion, AgentVersions, Agents, type AiProviderResourceProperties, AiProviders, type ApiKeyCreated, type ApiKeyRecord, type ApiKeyResourceProperties, ApiKeys, type ApprovalId, type ApprovalItem, type ApprovalRecurrenceGroup, Approvals, type ApproveApprovalData, type ApproveApprovalErrors, type ApproveApprovalResponse, type ApproveApprovalResponses, type AttachUserPoliciesData, type AttachUserPoliciesError, type AttachUserPoliciesErrors, type AttachUserPoliciesResponse, type AttachUserPoliciesResponses, type AuditEntry, AuditLog, type BootstrapUserData, type BootstrapUserError, type BootstrapUserErrors, type BootstrapUserResponse, type BootstrapUserResponses, type CallToolData, type CallToolError, type CallToolErrors, type CallToolRequest, type CallToolResponse, type CallToolResponses, type CancelOrchestrationRunData, type CancelOrchestrationRunErrors, type CancelOrchestrationRunResponse, type CancelOrchestrationRunResponses, type Chat, type ChatCompletionChoice, type ChatCompletionForChatRequest, type ChatCompletionRequest, type ChatCompletionResponse, type ChatCompletionResponseMessage, type ChatMessage, type ChatMessageInput, type ChatResourceProperties, Chats, type ClientOptions, type CompleteIngestionCallbackData, type CompleteIngestionCallbackError, type CompleteIngestionCallbackErrors, type CompleteIngestionCallbackResponse, type CompleteIngestionCallbackResponses, 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 CreateChatCompletionData, type CreateChatCompletionError, type CreateChatCompletionErrors, type CreateChatCompletionForChatData, type CreateChatCompletionForChatError, type CreateChatCompletionForChatErrors, type CreateChatCompletionForChatResponse, type CreateChatCompletionForChatResponses, type CreateChatCompletionResponse, type CreateChatCompletionResponses, type CreateChatData, type CreateChatError, type CreateChatErrors, type CreateChatRequest, type CreateChatResponse, type CreateChatResponses, type CreateConversationData, type CreateConversationError, type CreateConversationErrors, type CreateConversationResponse, type CreateConversationResponses, type CreateDiscussionData, type CreateDiscussionError, type CreateDiscussionErrors, type CreateDiscussionResponse, type CreateDiscussionResponses, type CreateDiscussionRunData, type CreateDiscussionRunError, type CreateDiscussionRunErrors, type CreateDiscussionRunResponse, type CreateDiscussionRunResponses, type CreateDocumentData, type CreateDocumentError, type CreateDocumentErrors, type CreateDocumentResponse, type CreateDocumentResponses, type CreateEmbeddingsData, type CreateEmbeddingsError, type CreateEmbeddingsErrors, type CreateEmbeddingsResponse, type CreateEmbeddingsResponses, 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 CreatePolicyData, type CreatePolicyError, type CreatePolicyErrors, type CreatePolicyResponse, type CreatePolicyResponses, type CreatePresignedUrlData, type CreatePresignedUrlError, type CreatePresignedUrlErrors, type CreatePresignedUrlResponse, type CreatePresignedUrlResponses, type CreateProjectData, 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 CreateUsageThresholdData, type CreateUsageThresholdError, type CreateUsageThresholdErrors, type CreateUsageThresholdRequest, type CreateUsageThresholdResponse, type CreateUsageThresholdResponses, type CreateUserData, type CreateUserError, type CreateUserErrors, type CreateUserResponse, type CreateUserResponses, type CreateWebhookData, type CreateWebhookErrors, type CreateWebhookRequest, type CreateWebhookResponse, type CreateWebhookResponses, type CreateWorkflowData, type CreateWorkflowErrors, type CreateWorkflowRequest, type CreateWorkflowResponse, type CreateWorkflowResponses, type DeleteActorData, type DeleteActorError, type DeleteActorErrors, type DeleteActorResponse, type DeleteActorResponses, type DeleteAgentData, type DeleteAgentError, type DeleteAgentErrors, type DeleteAgentResponse, type DeleteAgentResponses, type DeleteAiProviderData, type DeleteAiProviderErrors, type DeleteAiProviderResponse, type DeleteAiProviderResponses, type DeleteApiKeyData, type DeleteApiKeyErrors, type DeleteApiKeyResponse, type DeleteApiKeyResponses, type DeleteChatData, type DeleteChatError, type DeleteChatErrors, type DeleteChatResponse, type DeleteChatResponses, type DeleteConversationData, type DeleteConversationError, type DeleteConversationErrors, type DeleteConversationResponse, type DeleteConversationResponses, type DeleteDiscussionData, type DeleteDiscussionError, type DeleteDiscussionErrors, type DeleteDiscussionResponse, type DeleteDiscussionResponses, type DeleteDocumentData, type DeleteDocumentError, type DeleteDocumentErrors, type DeleteDocumentResponse, type DeleteDocumentResponses, 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 DeletePolicyData, type DeletePolicyErrors, type DeletePolicyResponse, type DeletePolicyResponses, 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 DeleteUsageThresholdData, type DeleteUsageThresholdError, type DeleteUsageThresholdErrors, type DeleteUsageThresholdResponse, type DeleteUsageThresholdResponses, type DeleteUserData, type DeleteUserError, type DeleteUserErrors, type DeleteUserResponse, type DeleteUserResponses, type DeleteWebhookData, type DeleteWebhookErrors, type DeleteWebhookResponse, type DeleteWebhookResponses, type DeleteWorkflowData, type DeleteWorkflowErrors, type DeleteWorkflowResponse, type DeleteWorkflowResponses, type Delivery, type DeliveryListResponse, type DiscussionRecord, type DiscussionResourceProperties, type DiscussionRunRecord, Discussions, 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, Embeddings, type EmbeddingsResponse, type ErrorResponse, type EvaluateGuardrailData, type EvaluateGuardrailError, type EvaluateGuardrailErrors, type EvaluateGuardrailResponse, type EvaluateGuardrailResponses, 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 Formation, 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, Generations, type GetActorData, type GetActorError, type GetActorErrors, type GetActorResponse, type GetActorResponses, type GetActorTagsData, type GetActorTagsError, type GetActorTagsErrors, type GetActorTagsResponse, type GetActorTagsResponses, 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 GetApiKeyErrors, type GetApiKeyResponse, type GetApiKeyResponses, type GetApprovalData, type GetApprovalErrors, type GetApprovalResponse, type GetApprovalResponses, type GetAuditEntryData, type GetAuditEntryErrors, type GetAuditEntryResponse, type GetAuditEntryResponses, type GetChatData, type GetChatError, type GetChatErrors, type GetChatResponse, type GetChatResponses, 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 GetDiscussionData, type GetDiscussionError, type GetDiscussionErrors, type GetDiscussionResponse, type GetDiscussionResponses, type GetDiscussionRunData, type GetDiscussionRunError, type GetDiscussionRunErrors, type GetDiscussionRunResponse, type GetDiscussionRunResponses, 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 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 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 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 GetPolicyData, type GetPolicyErrors, type GetPolicyResponse, type GetPolicyResponses, type GetPriceBookData, type GetPriceBookError, type GetPriceBookErrors, type GetPriceBookResponse, type GetPriceBookResponses, type GetProjectData, type GetProjectErrors, type GetProjectPricesData, type GetProjectPricesErrors, type GetProjectPricesResponse, type GetProjectPricesResponses, type GetProjectResponse, type GetProjectResponses, 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 GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageReceiptData, type GetUsageReceiptError, type GetUsageReceiptErrors, type GetUsageReceiptResponse, type GetUsageReceiptResponses, type GetUsageResponse, type GetUsageResponses, type GetUserData, type GetUserError, type GetUserErrors, type GetUserResponse, type GetUserResponses, type GetWebhookData, type GetWebhookDeliveryData, type GetWebhookDeliveryErrors, type GetWebhookDeliveryResponse, type GetWebhookDeliveryResponses, type GetWebhookErrors, type GetWebhookResponse, type GetWebhookResponses, type GetWebhookSecretData, type GetWebhookSecretErrors, type GetWebhookSecretResponse, type GetWebhookSecretResponses, type GetWorkflowData, type GetWorkflowErrors, type GetWorkflowResponse, type GetWorkflowResponses, type GetWorkflowVersionData, type GetWorkflowVersionErrors, type GetWorkflowVersionResponse, type GetWorkflowVersionResponses, type Guardrail, type GuardrailDocument, type GuardrailEvaluation, type GuardrailResourceProperties, type GuardrailVersion, Guardrails, type HumanInputRequest, type IngestDocumentData, type IngestDocumentError, type IngestDocumentErrors, type IngestDocumentResponse, type IngestDocumentResponses, type IngestedDocumentRecord, type IngestionRule, type IngestionRuleResourceProperties, IngestionRules, Knowledge, type KnowledgeResult, type ListActivityData, type ListActivityErrors, type ListActivityResponse, type ListActivityResponses, type ListActorsData, type ListActorsError, type ListActorsErrors, type ListActorsResponse, type ListActorsResponses, type ListAgentVersionsData, type ListAgentVersionsError, type ListAgentVersionsErrors, type ListAgentVersionsResponse, type ListAgentVersionsResponses, type ListAgentsData, type ListAgentsError, type ListAgentsErrors, type ListAgentsResponse, type ListAgentsResponses, type ListAiProvidersData, type ListAiProvidersErrors, type ListAiProvidersResponse, type ListAiProvidersResponses, type ListApiKeysData, type ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListApprovalRecurrencesData, type ListApprovalRecurrencesErrors, type ListApprovalRecurrencesResponse, type ListApprovalRecurrencesResponses, type ListApprovalsData, type ListApprovalsErrors, type ListApprovalsResponse, type ListApprovalsResponses, type ListAuditEntriesData, type ListAuditEntriesErrors, type ListAuditEntriesResponse, type ListAuditEntriesResponses, type ListChatsData, type ListChatsError, type ListChatsErrors, type ListChatsResponse, type ListChatsResponses, type ListConversationMessagesData, type ListConversationMessagesError, type ListConversationMessagesErrors, type ListConversationMessagesResponse, type ListConversationMessagesResponses, type ListConversationsData, type ListConversationsError, type ListConversationsErrors, type ListConversationsResponse, type ListConversationsResponses, type ListDiscussionRunsData, type ListDiscussionRunsError, type ListDiscussionRunsErrors, type ListDiscussionRunsResponse, type ListDiscussionRunsResponses, type ListDiscussionsData, type ListDiscussionsError, type ListDiscussionsErrors, type ListDiscussionsResponse, type ListDiscussionsResponses, type ListDocumentsData, type ListDocumentsError, type ListDocumentsErrors, type ListDocumentsResponse, type ListDocumentsResponses, 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 ListOrchestrationRunsData, type ListOrchestrationRunsErrors, type ListOrchestrationRunsResponse, type ListOrchestrationRunsResponses, type ListOrchestrationVersionsData, type ListOrchestrationVersionsErrors, type ListOrchestrationVersionsResponse, type ListOrchestrationVersionsResponses, type ListOrchestrationsData, type ListOrchestrationsErrors, type ListOrchestrationsResponse, type ListOrchestrationsResponses, type ListPoliciesData, type ListPoliciesErrors, type ListPoliciesResponse, type ListPoliciesResponses, type ListProjectsData, type ListProjectsErrors, type ListProjectsResponse, type ListProjectsResponses, type ListQuotasData, type ListQuotasErrors, type ListQuotasResponse, type ListQuotasResponses, type ListSecretsData, type ListSecretsErrors, type ListSecretsResponse, type ListSecretsResponses, 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 ListUsageMetersData, type ListUsageMetersError, type ListUsageMetersErrors, type ListUsageMetersResponse, type ListUsageMetersResponses, type ListUsageThresholdsData, type ListUsageThresholdsError, type ListUsageThresholdsErrors, type ListUsageThresholdsResponse, type ListUsageThresholdsResponses, type ListUsersData, type ListUsersError, type ListUsersErrors, type ListUsersResponse, type ListUsersResponses, type ListWebhookDeliveriesData, type ListWebhookDeliveriesErrors, type ListWebhookDeliveriesResponse, type ListWebhookDeliveriesResponses, type ListWebhooksData, type ListWebhooksErrors, type ListWebhooksResponse, type ListWebhooksResponses, type ListWorkflowVersionsData, type ListWorkflowVersionsErrors, type ListWorkflowVersionsResponse, type ListWorkflowVersionsResponses, type ListWorkflowsData, type ListWorkflowsErrors, type ListWorkflowsResponse, type ListWorkflowsResponses, type LoginResponse, type LoginUserData, type LoginUserError, type LoginUserErrors, type LoginUserResponse, type LoginUserResponses, 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 ModelRoute, type ModelRouteResourceProperties, type ModelRouteTarget, ModelRoutes, type NodeExecution, type Options, type Orchestration, type OrchestrationEdge, type OrchestrationId, type OrchestrationNode, type OrchestrationResourceProperties, type OrchestrationRun, type OrchestrationRunId, type OrchestrationVersion, Orchestrations, type ParameterDeclaration, type ParticipantInput, type ParticipantRecord, type PatchAgentData, type PatchAgentError, type PatchAgentErrors, type PatchAgentResponse, type PatchAgentResponses, type PlanChange, type PlanFormationData, type PlanFormationErrors, type PlanFormationResponse, type PlanFormationResponses, type PlanResult, Policies, type PolicyDocument, type PolicyRecord, type PolicyResourceProperties, type PolicyStatement, type PresignedUrlRequest, type PresignedUrlResponse, type Price, type PriceBookResponse, type ProjectPrice, type ProjectPriceResourceProperties, type ProjectPricesResponse, type ProjectRecord, Projects, type PromoteAgentReleaseData, type PromoteAgentReleaseError, type PromoteAgentReleaseErrors, type PromoteAgentReleaseResponse, type PromoteAgentReleaseResponses, 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 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 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 RotateTriggerSecretData, type RotateTriggerSecretErrors, type RotateTriggerSecretResponse, type RotateTriggerSecretResponses, type RotateWebhookSecretData, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, type RunUsageTotals, type SearchKnowledgeData, type SearchKnowledgeError, type SearchKnowledgeErrors, type SearchKnowledgeResponse, type SearchKnowledgeResponses, type SecretResourceProperties, Secrets, type SendSessionMessageResponse, type SessionId, type SessionRecord, type SessionResourceProperties, Sessions, type SetAgentReleaseData, type SetAgentReleaseError, type SetAgentReleaseErrors, type SetAgentReleaseRequest, type SetAgentReleaseResponse, type SetAgentReleaseResponses, SoatClient, type SoatClientOptions, 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 SynthesisConfig, type Task, type TaskTransition, Tasks, type Tool, type ToolBinding, type ToolOutputMessageContent, type ToolResourceProperties, Tools, type Trace, type TraceTreeNode, Traces, 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 UpdateConversationData, type UpdateConversationError, type UpdateConversationErrors, type UpdateConversationResponse, type UpdateConversationResponses, type UpdateDiscussionData, type UpdateDiscussionError, type UpdateDiscussionErrors, type UpdateDiscussionResponse, type UpdateDiscussionResponses, type UpdateDocumentData, type UpdateDocumentError, type UpdateDocumentErrors, type UpdateDocumentResponse, type UpdateDocumentResponses, 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 UpdatePolicyData, type UpdatePolicyError, type UpdatePolicyErrors, type UpdatePolicyResponse, type UpdatePolicyResponses, type UpdateProjectData, type UpdateProjectErrors, type UpdateProjectPricesData, type UpdateProjectPricesErrors, type UpdateProjectPricesResponse, type UpdateProjectPricesResponses, 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 UpdateWebhookErrors, type UpdateWebhookRequest, 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 UploadFileWithTokenData, type UploadFileWithTokenError, type UploadFileWithTokenErrors, type UploadFileWithTokenRequest, type UploadFileWithTokenResponse, type UploadFileWithTokenResponses, type UpsertPriceBookData, type UpsertPriceBookError, type UpsertPriceBookErrors, type UpsertPriceBookResponse, type UpsertPriceBookResponses, type UpsertPricesRequest, type UpsertProjectPricesRequest, type UpsertProviderPricesRequest, Usage, type UsageAggregate, type UsageAggregateComponent, type UsageAggregateTotals, type UsageComponent, type UsageEvent, type UsageReceipt, type UsageThreshold, type UserRecord, Users, type ValidateFormationData, type ValidateFormationErrors, type ValidateFormationResponse, type ValidateFormationResponses, type ValidateOrchestrationData, type ValidateOrchestrationErrors, type ValidateOrchestrationRequest, type ValidateOrchestrationResponse, type ValidateOrchestrationResponses, type ValidationError, type ValidationResult, type Webhook, type WebhookResourceProperties, type WebhookSecretResponse, type WebhookWithSecret, Webhooks, type Workflow, type WorkflowResourceProperties, type WorkflowState, type WorkflowTransition, type WorkflowVersion, Workflows, createClient, createConfig };
|
|
18176
|
+
export { type AbortAgentReleaseData, type AbortAgentReleaseError, type AbortAgentReleaseErrors, type AbortAgentReleaseResponse, type AbortAgentReleaseResponses, type AcceptedGenerationResponse, type AcknowledgeExceptionData, type AcknowledgeExceptionErrors, type AcknowledgeExceptionResponse, type AcknowledgeExceptionResponses, 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 Agent, type AgentGenerationResponse, type AgentRelease, type AgentResourceProperties, type AgentVersion, AgentVersions, Agents, type AggregateScores, type AiProviderResourceProperties, AiProviders, type ApiKeyCreated, type ApiKeyRecord, type ApiKeyResourceProperties, ApiKeys, type ApprovalId, type ApprovalItem, type ApprovalRecurrenceGroup, Approvals, type ApproveApprovalData, type ApproveApprovalErrors, type ApproveApprovalResponse, type ApproveApprovalResponses, type AttachUserPoliciesData, type AttachUserPoliciesError, type AttachUserPoliciesErrors, type AttachUserPoliciesResponse, type AttachUserPoliciesResponses, type AuditEntry, AuditLog, type BaselineComparison, type BootstrapUserData, type BootstrapUserError, type BootstrapUserErrors, type BootstrapUserResponse, type BootstrapUserResponses, type CallToolData, type CallToolError, type CallToolErrors, type CallToolRequest, type CallToolResponse, type CallToolResponses, type CancelEvalRunData, type CancelEvalRunErrors, type CancelEvalRunResponse, type CancelEvalRunResponses, type CancelOrchestrationRunData, type CancelOrchestrationRunErrors, type CancelOrchestrationRunResponse, type CancelOrchestrationRunResponses, type Chat, type ChatCompletionChoice, type ChatCompletionForChatRequest, type ChatCompletionRequest, type ChatCompletionResponse, type ChatCompletionResponseMessage, type ChatMessage, type ChatMessageInput, type ChatResourceProperties, Chats, type ClientOptions, type CompleteIngestionCallbackData, type CompleteIngestionCallbackError, type CompleteIngestionCallbackErrors, type CompleteIngestionCallbackResponse, type CompleteIngestionCallbackResponses, type ContainsScorer, 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 CreateChatCompletionData, type CreateChatCompletionError, type CreateChatCompletionErrors, type CreateChatCompletionForChatData, type CreateChatCompletionForChatError, type CreateChatCompletionForChatErrors, type CreateChatCompletionForChatResponse, type CreateChatCompletionForChatResponses, type CreateChatCompletionResponse, type CreateChatCompletionResponses, type CreateChatData, type CreateChatError, type CreateChatErrors, type CreateChatRequest, type CreateChatResponse, type CreateChatResponses, type CreateConversationData, type CreateConversationError, type CreateConversationErrors, type CreateConversationResponse, type CreateConversationResponses, type CreateDatasetData, type CreateDatasetErrors, type CreateDatasetItemData, type CreateDatasetItemErrors, 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 CreatePolicyData, type CreatePolicyError, type CreatePolicyErrors, type CreatePolicyResponse, type CreatePolicyResponses, type CreatePresignedUrlData, type CreatePresignedUrlError, type CreatePresignedUrlErrors, type CreatePresignedUrlResponse, type CreatePresignedUrlResponses, type CreateProjectData, 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 CreateUsageThresholdData, type CreateUsageThresholdError, type CreateUsageThresholdErrors, type CreateUsageThresholdRequest, type CreateUsageThresholdResponse, type CreateUsageThresholdResponses, type CreateUserData, type CreateUserError, type CreateUserErrors, type CreateUserResponse, type CreateUserResponses, type CreateWebhookData, type CreateWebhookErrors, type CreateWebhookRequest, type CreateWebhookResponse, type CreateWebhookResponses, type CreateWorkflowData, type CreateWorkflowErrors, type CreateWorkflowRequest, type CreateWorkflowResponse, type CreateWorkflowResponses, type Dataset, type DatasetItem, type DatasetItemInput, type DatasetItemResourceProperties, type DatasetResourceProperties, type DeleteActorData, type DeleteActorError, type DeleteActorErrors, type DeleteActorResponse, type DeleteActorResponses, type DeleteAgentData, type DeleteAgentError, type DeleteAgentErrors, type DeleteAgentResponse, type DeleteAgentResponses, type DeleteAiProviderData, type DeleteAiProviderErrors, type DeleteAiProviderResponse, type DeleteAiProviderResponses, type DeleteApiKeyData, type DeleteApiKeyErrors, type DeleteApiKeyResponse, type DeleteApiKeyResponses, type DeleteChatData, type DeleteChatError, type DeleteChatErrors, type DeleteChatResponse, type DeleteChatResponses, 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 DeletePolicyData, type DeletePolicyErrors, type DeletePolicyResponse, type DeletePolicyResponses, 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 DeleteUsageThresholdData, type DeleteUsageThresholdError, type DeleteUsageThresholdErrors, type DeleteUsageThresholdResponse, type DeleteUsageThresholdResponses, type DeleteUserData, type DeleteUserError, type DeleteUserErrors, type DeleteUserResponse, type DeleteUserResponses, type DeleteWebhookData, type DeleteWebhookErrors, type DeleteWebhookResponse, type DeleteWebhookResponses, type DeleteWorkflowData, type DeleteWorkflowErrors, type DeleteWorkflowResponse, type DeleteWorkflowResponses, type Delivery, type DeliveryListResponse, 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, Embeddings, type EmbeddingsResponse, type ErrorResponse, type Eval, type EvalResourceProperties, type EvalResult, type EvalRun, type EvaluateGuardrailData, type EvaluateGuardrailError, type EvaluateGuardrailErrors, type EvaluateGuardrailResponse, type EvaluateGuardrailResponses, Evaluations, 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 Formation, 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, Generations, type GetActorData, type GetActorError, type GetActorErrors, type GetActorResponse, type GetActorResponses, type GetActorTagsData, type GetActorTagsError, type GetActorTagsErrors, type GetActorTagsResponse, type GetActorTagsResponses, 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 GetApiKeyErrors, type GetApiKeyResponse, type GetApiKeyResponses, type GetApprovalData, type GetApprovalErrors, type GetApprovalResponse, type GetApprovalResponses, type GetAuditEntryData, type GetAuditEntryErrors, type GetAuditEntryResponse, type GetAuditEntryResponses, type GetChatData, type GetChatError, type GetChatErrors, type GetChatResponse, type GetChatResponses, 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 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 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 GetPolicyData, type GetPolicyErrors, type GetPolicyResponse, type GetPolicyResponses, type GetPriceBookData, type GetPriceBookError, type GetPriceBookErrors, type GetPriceBookResponse, type GetPriceBookResponses, type GetProjectData, type GetProjectErrors, type GetProjectPricesData, type GetProjectPricesErrors, type GetProjectPricesResponse, type GetProjectPricesResponses, type GetProjectResponse, type GetProjectResponses, 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 GetUsageData, type GetUsageError, type GetUsageErrors, type GetUsageReceiptData, type GetUsageReceiptError, type GetUsageReceiptErrors, type GetUsageReceiptResponse, type GetUsageReceiptResponses, type GetUsageResponse, type GetUsageResponses, type GetUserData, type GetUserError, type GetUserErrors, type GetUserResponse, type GetUserResponses, type GetWebhookData, type GetWebhookDeliveryData, type GetWebhookDeliveryErrors, type GetWebhookDeliveryResponse, type GetWebhookDeliveryResponses, type GetWebhookErrors, type GetWebhookResponse, type GetWebhookResponses, type GetWebhookSecretData, type GetWebhookSecretErrors, type GetWebhookSecretResponse, type GetWebhookSecretResponses, type GetWorkflowData, type GetWorkflowErrors, type GetWorkflowResponse, type GetWorkflowResponses, type GetWorkflowVersionData, type GetWorkflowVersionErrors, type GetWorkflowVersionResponse, type GetWorkflowVersionResponses, type Guardrail, type GuardrailDocument, type GuardrailEvaluation, type GuardrailResourceProperties, type GuardrailVersion, Guardrails, type HumanInputRequest, type IngestDocumentData, type IngestDocumentError, type IngestDocumentErrors, type IngestDocumentResponse, type IngestDocumentResponses, type IngestedDocumentRecord, type IngestionRule, type IngestionRuleResourceProperties, IngestionRules, type JsonLogicScorer, Knowledge, type KnowledgeResult, type ListActivityData, type ListActivityErrors, type ListActivityResponse, type ListActivityResponses, type ListActorsData, type ListActorsError, type ListActorsErrors, type ListActorsResponse, type ListActorsResponses, 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 ListApiKeysErrors, type ListApiKeysResponse, type ListApiKeysResponses, type ListApprovalRecurrencesData, type ListApprovalRecurrencesErrors, type ListApprovalRecurrencesResponse, type ListApprovalRecurrencesResponses, type ListApprovalsData, type ListApprovalsErrors, type ListApprovalsResponse, type ListApprovalsResponses, type ListAuditEntriesData, type ListAuditEntriesErrors, type ListAuditEntriesResponse, type ListAuditEntriesResponses, type ListChatsData, type ListChatsError, type ListChatsErrors, type ListChatsResponse, type ListChatsResponses, 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 ListOrchestrationRunsData, type ListOrchestrationRunsErrors, type ListOrchestrationRunsResponse, type ListOrchestrationRunsResponses, type ListOrchestrationVersionsData, type ListOrchestrationVersionsErrors, type ListOrchestrationVersionsResponse, type ListOrchestrationVersionsResponses, type ListOrchestrationsData, type ListOrchestrationsErrors, type ListOrchestrationsResponse, type ListOrchestrationsResponses, type ListPoliciesData, type ListPoliciesErrors, type ListPoliciesResponse, type ListPoliciesResponses, type ListProjectsData, type ListProjectsErrors, type ListProjectsResponse, type ListProjectsResponses, type ListQuotasData, type ListQuotasErrors, type ListQuotasResponse, type ListQuotasResponses, type ListSecretsData, type ListSecretsErrors, type ListSecretsResponse, type ListSecretsResponses, 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 ListUsageMetersData, type ListUsageMetersError, type ListUsageMetersErrors, type ListUsageMetersResponse, type ListUsageMetersResponses, type ListUsageThresholdsData, type ListUsageThresholdsError, type ListUsageThresholdsErrors, type ListUsageThresholdsResponse, type ListUsageThresholdsResponses, type ListUsersData, type ListUsersError, type ListUsersErrors, type ListUsersResponse, type ListUsersResponses, type ListWebhookDeliveriesData, type ListWebhookDeliveriesErrors, type ListWebhookDeliveriesResponse, type ListWebhookDeliveriesResponses, type ListWebhooksData, 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 LoginResponse, type LoginUserData, type LoginUserError, type LoginUserErrors, type LoginUserResponse, type LoginUserResponses, 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 ModelRoute, type ModelRouteResourceProperties, type ModelRouteTarget, ModelRoutes, type NodeExecution, 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, Policies, type PolicyDocument, type PolicyRecord, type PolicyResourceProperties, type PolicyStatement, type PresignedUrlRequest, type PresignedUrlResponse, type Price, type PriceBookResponse, type ProjectPrice, type ProjectPriceResourceProperties, type ProjectPricesResponse, type ProjectRecord, 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 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 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 RotateTriggerSecretData, type RotateTriggerSecretErrors, type RotateTriggerSecretResponse, type RotateTriggerSecretResponses, type RotateWebhookSecretData, type RotateWebhookSecretErrors, type RotateWebhookSecretResponse, type RotateWebhookSecretResponses, 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 SetAgentReleaseData, type SetAgentReleaseError, type SetAgentReleaseErrors, type SetAgentReleaseRequest, type SetAgentReleaseResponse, type SetAgentReleaseResponses, SoatClient, type SoatClientOptions, 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, Tools, type Trace, type TraceTreeNode, Traces, 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 UpdateConversationData, type UpdateConversationError, type UpdateConversationErrors, type UpdateConversationResponse, type UpdateConversationResponses, 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 UpdatePolicyData, type UpdatePolicyError, type UpdatePolicyErrors, type UpdatePolicyResponse, type UpdatePolicyResponses, type UpdateProjectData, type UpdateProjectErrors, type UpdateProjectPricesData, type UpdateProjectPricesErrors, type UpdateProjectPricesResponse, type UpdateProjectPricesResponses, 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 UpdateWebhookErrors, type UpdateWebhookRequest, 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 UploadFileWithTokenData, type UploadFileWithTokenError, type UploadFileWithTokenErrors, type UploadFileWithTokenRequest, type UploadFileWithTokenResponse, type UploadFileWithTokenResponses, type UpsertPriceBookData, type UpsertPriceBookError, type UpsertPriceBookErrors, type UpsertPriceBookResponse, type UpsertPriceBookResponses, type UpsertPricesRequest, type UpsertProjectPricesRequest, type UpsertProviderPricesRequest, Usage, type UsageAggregate, type UsageAggregateComponent, type UsageAggregateTotals, type UsageComponent, type UsageEvent, type UsageReceipt, type UsageThreshold, type UserRecord, Users, type ValidateFormationData, type ValidateFormationErrors, type ValidateFormationResponse, type ValidateFormationResponses, type ValidateOrchestrationData, type ValidateOrchestrationErrors, type ValidateOrchestrationRequest, type ValidateOrchestrationResponse, type ValidateOrchestrationResponses, type ValidationError, type ValidationResult, type Webhook, type WebhookResourceProperties, type WebhookSecretResponse, type WebhookWithSecret, Webhooks, type Workflow, type WorkflowResourceProperties, type WorkflowState, type WorkflowTransition, type WorkflowVersion, Workflows, createClient, createConfig };
|