@soat/sdk 0.20.5 → 0.22.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 +304 -113
- package/dist/index.d.cts +1513 -694
- package/dist/index.d.mts +1513 -694
- package/dist/index.mjs +304 -113
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -403,7 +403,22 @@ type ActorRecord = {
|
|
|
403
403
|
updated_at?: Date;
|
|
404
404
|
};
|
|
405
405
|
type ErrorResponse = {
|
|
406
|
-
|
|
406
|
+
/**
|
|
407
|
+
* Structured error. Every error response uses this shape — 401, 403 and the 500 catch-all included — so `code` can be read without first checking the type of `error`.
|
|
408
|
+
*/
|
|
409
|
+
error: {
|
|
410
|
+
/**
|
|
411
|
+
* A key from the server's ERROR_CODES registry.
|
|
412
|
+
*/
|
|
413
|
+
code: string;
|
|
414
|
+
message: string;
|
|
415
|
+
/**
|
|
416
|
+
* Optional structured context for the error.
|
|
417
|
+
*/
|
|
418
|
+
meta?: {
|
|
419
|
+
[key: string]: unknown;
|
|
420
|
+
};
|
|
421
|
+
};
|
|
407
422
|
};
|
|
408
423
|
type Agent = {
|
|
409
424
|
/**
|
|
@@ -569,6 +584,10 @@ type AgentRelease = {
|
|
|
569
584
|
* Percentage of traffic assigned to `canary_version`
|
|
570
585
|
*/
|
|
571
586
|
canary_percent: number;
|
|
587
|
+
/**
|
|
588
|
+
* 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).
|
|
589
|
+
*/
|
|
590
|
+
promotion_gate?: string | null;
|
|
572
591
|
};
|
|
573
592
|
/**
|
|
574
593
|
* An immutable archive of an agent's configuration at one version.
|
|
@@ -598,6 +617,10 @@ type AgentVersion = {
|
|
|
598
617
|
* 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
618
|
*/
|
|
600
619
|
label?: string | null;
|
|
620
|
+
/**
|
|
621
|
+
* 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.
|
|
622
|
+
*/
|
|
623
|
+
eval_run_id?: string | null;
|
|
601
624
|
/**
|
|
602
625
|
* 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
626
|
*/
|
|
@@ -623,6 +646,10 @@ type SetAgentReleaseRequest = {
|
|
|
623
646
|
* Percentage of traffic to assign to `canary_version`
|
|
624
647
|
*/
|
|
625
648
|
canary_percent: number;
|
|
649
|
+
/**
|
|
650
|
+
* 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.
|
|
651
|
+
*/
|
|
652
|
+
promotion_gate?: string | null;
|
|
626
653
|
};
|
|
627
654
|
/**
|
|
628
655
|
* 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 +979,15 @@ type SubmitToolOutputsRequest = {
|
|
|
952
979
|
output: unknown;
|
|
953
980
|
}>;
|
|
954
981
|
};
|
|
982
|
+
/**
|
|
983
|
+
* 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}`.
|
|
984
|
+
*
|
|
985
|
+
*/
|
|
986
|
+
type AcceptedGenerationResponse = {
|
|
987
|
+
status: 'accepted';
|
|
988
|
+
generation_id: string;
|
|
989
|
+
trace_id: string;
|
|
990
|
+
};
|
|
955
991
|
/**
|
|
956
992
|
* 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
993
|
*
|
|
@@ -1562,104 +1598,6 @@ type GenerateConversationMessageResponse = ({
|
|
|
1562
1598
|
} & GenerateConversationMessageCompleted) | ({
|
|
1563
1599
|
status: 'requires_action';
|
|
1564
1600
|
} & GenerateConversationMessageRequiresAction);
|
|
1565
|
-
/**
|
|
1566
|
-
* Override for the final synthesis pass that weighs the deliberation into a single outcome.
|
|
1567
|
-
*/
|
|
1568
|
-
type SynthesisConfig = {
|
|
1569
|
-
ai_provider_id?: string;
|
|
1570
|
-
model?: string;
|
|
1571
|
-
/**
|
|
1572
|
-
* Synthesis prompt template. Supports {steps.deliberation} and {topic}.
|
|
1573
|
-
*/
|
|
1574
|
-
prompt?: string;
|
|
1575
|
-
/**
|
|
1576
|
-
* Provider-native reasoning effort for the synthesis completion.
|
|
1577
|
-
*/
|
|
1578
|
-
effort?: 'low' | 'medium' | 'high';
|
|
1579
|
-
} | null;
|
|
1580
|
-
/**
|
|
1581
|
-
* A participant in the deliberation.
|
|
1582
|
-
*/
|
|
1583
|
-
type ParticipantInput = {
|
|
1584
|
-
/**
|
|
1585
|
-
* Display label used for transcript attribution.
|
|
1586
|
-
*/
|
|
1587
|
-
name?: string | null;
|
|
1588
|
-
/**
|
|
1589
|
-
* Persona prompt for this participant.
|
|
1590
|
-
*/
|
|
1591
|
-
prompt?: string | null;
|
|
1592
|
-
/**
|
|
1593
|
-
* Turn order (defaults to array index).
|
|
1594
|
-
*/
|
|
1595
|
-
position?: number;
|
|
1596
|
-
/**
|
|
1597
|
-
* Durable actor identity to attribute this participant's turns to.
|
|
1598
|
-
*/
|
|
1599
|
-
actor_id?: string | null;
|
|
1600
|
-
ai_provider_id?: string | null;
|
|
1601
|
-
model?: string | null;
|
|
1602
|
-
temperature?: number | null;
|
|
1603
|
-
/**
|
|
1604
|
-
* Provider-native reasoning effort for this participant's turns.
|
|
1605
|
-
*/
|
|
1606
|
-
effort?: 'low' | 'medium' | 'high' | null;
|
|
1607
|
-
};
|
|
1608
|
-
type ParticipantRecord = {
|
|
1609
|
-
id?: string;
|
|
1610
|
-
name?: string | null;
|
|
1611
|
-
prompt?: string | null;
|
|
1612
|
-
position?: number;
|
|
1613
|
-
actor_id?: string | null;
|
|
1614
|
-
ai_provider_id?: string | null;
|
|
1615
|
-
model?: string | null;
|
|
1616
|
-
temperature?: number | null;
|
|
1617
|
-
effort?: string | null;
|
|
1618
|
-
};
|
|
1619
|
-
type DiscussionRecord = {
|
|
1620
|
-
id?: string;
|
|
1621
|
-
project_id?: string;
|
|
1622
|
-
name?: string;
|
|
1623
|
-
description?: string | null;
|
|
1624
|
-
max_rounds?: number;
|
|
1625
|
-
ai_provider_id?: string | null;
|
|
1626
|
-
model?: string | null;
|
|
1627
|
-
synthesis?: SynthesisConfig;
|
|
1628
|
-
tags?: {
|
|
1629
|
-
[key: string]: string;
|
|
1630
|
-
};
|
|
1631
|
-
participants?: Array<ParticipantRecord>;
|
|
1632
|
-
/**
|
|
1633
|
-
* 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.
|
|
1634
|
-
*/
|
|
1635
|
-
template_warnings?: Array<string>;
|
|
1636
|
-
created_at?: Date;
|
|
1637
|
-
updated_at?: Date;
|
|
1638
|
-
};
|
|
1639
|
-
type DiscussionRunRecord = {
|
|
1640
|
-
id?: string;
|
|
1641
|
-
discussion_id?: string;
|
|
1642
|
-
project_id?: string;
|
|
1643
|
-
topic?: string;
|
|
1644
|
-
status?: 'pending' | 'running' | 'completed' | 'failed';
|
|
1645
|
-
/**
|
|
1646
|
-
* The synthesized outcome text (the tool-result contract).
|
|
1647
|
-
*/
|
|
1648
|
-
outcome?: string | null;
|
|
1649
|
-
conversation_id?: string | null;
|
|
1650
|
-
outcome_document_id?: string | null;
|
|
1651
|
-
/**
|
|
1652
|
-
* Type of the principal that invoked the run. Read-only: derived from the authenticated caller, never accepted from a request body.
|
|
1653
|
-
*/
|
|
1654
|
-
started_by_principal_type?: 'user' | 'api_key' | null;
|
|
1655
|
-
/**
|
|
1656
|
-
* 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`.
|
|
1657
|
-
*/
|
|
1658
|
-
started_by_principal_id?: string | null;
|
|
1659
|
-
completed_at?: Date | null;
|
|
1660
|
-
created_at?: Date;
|
|
1661
|
-
updated_at?: Date;
|
|
1662
|
-
};
|
|
1663
1601
|
type DocumentRecord = {
|
|
1664
1602
|
/**
|
|
1665
1603
|
* Document ID
|
|
@@ -1757,6 +1695,218 @@ type EmbeddingsResponse = {
|
|
|
1757
1695
|
*/
|
|
1758
1696
|
embeddings?: Array<Array<number>>;
|
|
1759
1697
|
};
|
|
1698
|
+
/**
|
|
1699
|
+
* Messages replayed verbatim as the generation's input
|
|
1700
|
+
*/
|
|
1701
|
+
type DatasetItemInput = Array<{
|
|
1702
|
+
role: string;
|
|
1703
|
+
/**
|
|
1704
|
+
* Message content — a string, or AI SDK content parts
|
|
1705
|
+
*/
|
|
1706
|
+
content: unknown;
|
|
1707
|
+
}>;
|
|
1708
|
+
/**
|
|
1709
|
+
* 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.
|
|
1710
|
+
*
|
|
1711
|
+
* `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.
|
|
1712
|
+
*
|
|
1713
|
+
* `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.
|
|
1714
|
+
*/
|
|
1715
|
+
type Scorers = Array<ExactMatchScorer | ContainsScorer | JsonLogicScorer | OutputSchemaScorer | LlmJudgeScorer>;
|
|
1716
|
+
type ExactMatchScorer = {
|
|
1717
|
+
type: 'exact_match';
|
|
1718
|
+
};
|
|
1719
|
+
type ContainsScorer = {
|
|
1720
|
+
type: 'contains';
|
|
1721
|
+
value: string;
|
|
1722
|
+
case_sensitive?: boolean;
|
|
1723
|
+
};
|
|
1724
|
+
type JsonLogicScorer = {
|
|
1725
|
+
type: 'json_logic';
|
|
1726
|
+
/**
|
|
1727
|
+
* A JSON Logic expression; a truthy result scores 1
|
|
1728
|
+
*/
|
|
1729
|
+
expression: {
|
|
1730
|
+
[key: string]: unknown;
|
|
1731
|
+
};
|
|
1732
|
+
};
|
|
1733
|
+
type OutputSchemaScorer = {
|
|
1734
|
+
type: 'output_schema';
|
|
1735
|
+
/**
|
|
1736
|
+
* 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.
|
|
1737
|
+
*/
|
|
1738
|
+
schema?: {
|
|
1739
|
+
[key: string]: unknown;
|
|
1740
|
+
};
|
|
1741
|
+
};
|
|
1742
|
+
type LlmJudgeScorer = {
|
|
1743
|
+
type: 'llm_judge';
|
|
1744
|
+
/**
|
|
1745
|
+
* 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.
|
|
1746
|
+
*/
|
|
1747
|
+
prompt: string;
|
|
1748
|
+
/**
|
|
1749
|
+
* The item passes this scorer when the judge's score is greater than or equal to this value. Required.
|
|
1750
|
+
*/
|
|
1751
|
+
pass_threshold: number;
|
|
1752
|
+
/**
|
|
1753
|
+
* The AI provider that runs the judge; it must belong to the eval's project. Omit to use the project's default model route.
|
|
1754
|
+
*/
|
|
1755
|
+
ai_provider_id?: string | null;
|
|
1756
|
+
/**
|
|
1757
|
+
* Overrides the provider's default model. Pinned per scorer, because deltas between runs judged by different models are not comparable.
|
|
1758
|
+
*/
|
|
1759
|
+
model?: string | null;
|
|
1760
|
+
};
|
|
1761
|
+
type ScorerResult = {
|
|
1762
|
+
/**
|
|
1763
|
+
* The scorer type that produced this entry
|
|
1764
|
+
*/
|
|
1765
|
+
scorer?: string;
|
|
1766
|
+
score?: number;
|
|
1767
|
+
passed?: boolean;
|
|
1768
|
+
/**
|
|
1769
|
+
* The judge's stated rationale; present for `llm_judge` only
|
|
1770
|
+
*/
|
|
1771
|
+
reasoning?: string;
|
|
1772
|
+
};
|
|
1773
|
+
type Dataset = {
|
|
1774
|
+
id?: string;
|
|
1775
|
+
project_id?: string;
|
|
1776
|
+
name?: string;
|
|
1777
|
+
description?: string | null;
|
|
1778
|
+
created_at?: Date;
|
|
1779
|
+
updated_at?: Date;
|
|
1780
|
+
};
|
|
1781
|
+
type DatasetItem = {
|
|
1782
|
+
id?: string;
|
|
1783
|
+
dataset_id?: string;
|
|
1784
|
+
input?: DatasetItemInput;
|
|
1785
|
+
expected_output?: string | null;
|
|
1786
|
+
metadata?: {
|
|
1787
|
+
[key: string]: unknown;
|
|
1788
|
+
} | null;
|
|
1789
|
+
/**
|
|
1790
|
+
* The generation this item was curated from. A curated item is a deliberate fixture: erasing the source generation neither deletes nor mutates it.
|
|
1791
|
+
*/
|
|
1792
|
+
source_generation_id?: string | null;
|
|
1793
|
+
created_at?: Date;
|
|
1794
|
+
updated_at?: Date;
|
|
1795
|
+
};
|
|
1796
|
+
type Eval = {
|
|
1797
|
+
id?: string;
|
|
1798
|
+
project_id?: string;
|
|
1799
|
+
name?: string;
|
|
1800
|
+
agent_id?: string;
|
|
1801
|
+
dataset_id?: string;
|
|
1802
|
+
scorers?: Scorers;
|
|
1803
|
+
pass_threshold?: number | null;
|
|
1804
|
+
created_at?: Date;
|
|
1805
|
+
updated_at?: Date;
|
|
1806
|
+
};
|
|
1807
|
+
/**
|
|
1808
|
+
* Per-scorer rollup plus the run-level pass rate; null until the run is terminal
|
|
1809
|
+
*/
|
|
1810
|
+
type AggregateScores = {
|
|
1811
|
+
scorers?: {
|
|
1812
|
+
[key: string]: {
|
|
1813
|
+
mean?: number;
|
|
1814
|
+
pass_rate?: number;
|
|
1815
|
+
};
|
|
1816
|
+
};
|
|
1817
|
+
/**
|
|
1818
|
+
* Passed items over non-errored items; null when nothing was scorable
|
|
1819
|
+
*/
|
|
1820
|
+
pass_rate?: number | null;
|
|
1821
|
+
/**
|
|
1822
|
+
* Items that produced a score — errored items are excluded
|
|
1823
|
+
*/
|
|
1824
|
+
scored_item_count?: number;
|
|
1825
|
+
baseline?: BaselineComparison;
|
|
1826
|
+
} | null;
|
|
1827
|
+
/**
|
|
1828
|
+
* Comparison against the run named by `baseline_run_id`; absent when the run named none.
|
|
1829
|
+
*
|
|
1830
|
+
* 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.
|
|
1831
|
+
*/
|
|
1832
|
+
type BaselineComparison = {
|
|
1833
|
+
run_id?: string;
|
|
1834
|
+
/**
|
|
1835
|
+
* Items scorable in both runs — the basis of every delta
|
|
1836
|
+
*/
|
|
1837
|
+
compared_item_count?: number;
|
|
1838
|
+
/**
|
|
1839
|
+
* Scorable here but not in the baseline (added, or errored there)
|
|
1840
|
+
*/
|
|
1841
|
+
added_item_count?: number;
|
|
1842
|
+
/**
|
|
1843
|
+
* Scorable in the baseline but not here (removed, or errored here)
|
|
1844
|
+
*/
|
|
1845
|
+
removed_item_count?: number;
|
|
1846
|
+
/**
|
|
1847
|
+
* Run-level pass-rate delta over the intersection; null when the two runs share no comparable item
|
|
1848
|
+
*/
|
|
1849
|
+
pass_rate_delta?: number | null;
|
|
1850
|
+
/**
|
|
1851
|
+
* Per-scorer deltas, keyed by scorer type. A scorer only one of the two runs ran is omitted rather than compared against nothing.
|
|
1852
|
+
*/
|
|
1853
|
+
scorers?: {
|
|
1854
|
+
[key: string]: {
|
|
1855
|
+
mean_delta?: number;
|
|
1856
|
+
pass_rate_delta?: number;
|
|
1857
|
+
};
|
|
1858
|
+
};
|
|
1859
|
+
} | null;
|
|
1860
|
+
type EvalRun = {
|
|
1861
|
+
id?: string;
|
|
1862
|
+
eval_id?: string;
|
|
1863
|
+
/**
|
|
1864
|
+
* The one agent version every item in this run executed against
|
|
1865
|
+
*/
|
|
1866
|
+
agent_version?: number;
|
|
1867
|
+
status?: 'queued' | 'running' | 'completed' | 'failed' | 'canceled';
|
|
1868
|
+
baseline_run_id?: string | null;
|
|
1869
|
+
/**
|
|
1870
|
+
* 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.
|
|
1871
|
+
*/
|
|
1872
|
+
trigger_id?: string | null;
|
|
1873
|
+
aggregate_scores?: AggregateScores;
|
|
1874
|
+
/**
|
|
1875
|
+
* Null when the eval declares no pass_threshold, and until the run is terminal
|
|
1876
|
+
*/
|
|
1877
|
+
passed?: boolean | null;
|
|
1878
|
+
item_count?: number;
|
|
1879
|
+
completed_count?: number;
|
|
1880
|
+
errored_count?: number;
|
|
1881
|
+
started_at?: Date | null;
|
|
1882
|
+
finished_at?: Date | null;
|
|
1883
|
+
created_at?: Date;
|
|
1884
|
+
};
|
|
1885
|
+
type EvalResult = {
|
|
1886
|
+
id?: string;
|
|
1887
|
+
eval_run_id?: string;
|
|
1888
|
+
/**
|
|
1889
|
+
* Null once the dataset item has been deleted
|
|
1890
|
+
*/
|
|
1891
|
+
dataset_item_id?: string | null;
|
|
1892
|
+
input?: DatasetItemInput;
|
|
1893
|
+
expected_output?: string | null;
|
|
1894
|
+
generation_id?: string | null;
|
|
1895
|
+
/**
|
|
1896
|
+
* The agent's final output text. Cleared when the linked generation's content is purged; the scores and the frozen input survive.
|
|
1897
|
+
*/
|
|
1898
|
+
output?: string | null;
|
|
1899
|
+
scores?: Array<ScorerResult>;
|
|
1900
|
+
/**
|
|
1901
|
+
* AND over the per-scorer passed flags
|
|
1902
|
+
*/
|
|
1903
|
+
passed?: boolean;
|
|
1904
|
+
/**
|
|
1905
|
+
* 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.
|
|
1906
|
+
*/
|
|
1907
|
+
error?: string | null;
|
|
1908
|
+
created_at?: Date;
|
|
1909
|
+
};
|
|
1760
1910
|
type ExceptionItem = {
|
|
1761
1911
|
id?: string;
|
|
1762
1912
|
project_id?: string;
|
|
@@ -1914,15 +2064,21 @@ type FileRecord = {
|
|
|
1914
2064
|
/**
|
|
1915
2065
|
* MIME type of the file
|
|
1916
2066
|
*/
|
|
1917
|
-
|
|
2067
|
+
content_type?: string | null;
|
|
1918
2068
|
/**
|
|
1919
2069
|
* File size in bytes
|
|
1920
2070
|
*/
|
|
1921
|
-
size?: number;
|
|
2071
|
+
size?: number | null;
|
|
1922
2072
|
/**
|
|
1923
2073
|
* JSON string with additional metadata
|
|
1924
2074
|
*/
|
|
1925
|
-
metadata?: string;
|
|
2075
|
+
metadata?: string | null;
|
|
2076
|
+
/**
|
|
2077
|
+
* Key-value tags attached to the file.
|
|
2078
|
+
*/
|
|
2079
|
+
tags?: {
|
|
2080
|
+
[key: string]: string;
|
|
2081
|
+
};
|
|
1926
2082
|
/**
|
|
1927
2083
|
* Creation timestamp
|
|
1928
2084
|
*/
|
|
@@ -2338,6 +2494,71 @@ type ToolResourceProperties = {
|
|
|
2338
2494
|
*/
|
|
2339
2495
|
guardrail_ids?: Array<string> | null;
|
|
2340
2496
|
};
|
|
2497
|
+
/**
|
|
2498
|
+
* 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.
|
|
2499
|
+
*/
|
|
2500
|
+
type DatasetResourceProperties = {
|
|
2501
|
+
/**
|
|
2502
|
+
* Dataset name, unique within the project
|
|
2503
|
+
*/
|
|
2504
|
+
name: string;
|
|
2505
|
+
/**
|
|
2506
|
+
* Optional description
|
|
2507
|
+
*/
|
|
2508
|
+
description?: string | null;
|
|
2509
|
+
};
|
|
2510
|
+
/**
|
|
2511
|
+
* 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.
|
|
2512
|
+
*/
|
|
2513
|
+
type DatasetItemResourceProperties = {
|
|
2514
|
+
/**
|
|
2515
|
+
* Public ID of the parent dataset (or ref expression)
|
|
2516
|
+
*/
|
|
2517
|
+
dataset_id: string;
|
|
2518
|
+
/**
|
|
2519
|
+
* The messages sent to the agent, as `{role, content}` objects
|
|
2520
|
+
*/
|
|
2521
|
+
input: Array<{
|
|
2522
|
+
[key: string]: unknown;
|
|
2523
|
+
}>;
|
|
2524
|
+
/**
|
|
2525
|
+
* Reference answer for exact_match / contains / llm_judge scorers
|
|
2526
|
+
*/
|
|
2527
|
+
expected_output?: string | null;
|
|
2528
|
+
/**
|
|
2529
|
+
* Free-form tags on the case, e.g. `{"topic": "billing"}`
|
|
2530
|
+
*/
|
|
2531
|
+
metadata?: {
|
|
2532
|
+
[key: string]: unknown;
|
|
2533
|
+
} | null;
|
|
2534
|
+
};
|
|
2535
|
+
/**
|
|
2536
|
+
* 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.
|
|
2537
|
+
*/
|
|
2538
|
+
type EvalResourceProperties = {
|
|
2539
|
+
/**
|
|
2540
|
+
* Eval name, unique within the project
|
|
2541
|
+
*/
|
|
2542
|
+
name: string;
|
|
2543
|
+
/**
|
|
2544
|
+
* Public ID of the agent under test (or ref expression)
|
|
2545
|
+
*/
|
|
2546
|
+
agent_id: string;
|
|
2547
|
+
/**
|
|
2548
|
+
* Public ID of the dataset to run against (or ref expression)
|
|
2549
|
+
*/
|
|
2550
|
+
dataset_id: string;
|
|
2551
|
+
/**
|
|
2552
|
+
* Scorer configs — `exact_match`, `contains`, `json_logic`, `output_schema`, or `llm_judge`. Same shape as the evals REST contract.
|
|
2553
|
+
*/
|
|
2554
|
+
scorers: Array<{
|
|
2555
|
+
[key: string]: unknown;
|
|
2556
|
+
}>;
|
|
2557
|
+
/**
|
|
2558
|
+
* 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.
|
|
2559
|
+
*/
|
|
2560
|
+
pass_threshold?: number | null;
|
|
2561
|
+
};
|
|
2341
2562
|
/**
|
|
2342
2563
|
* Stores a text document in a project, optionally indexing it for knowledge retrieval.
|
|
2343
2564
|
*/
|
|
@@ -2476,7 +2697,7 @@ type WebhookResourceProperties = {
|
|
|
2476
2697
|
events: Array<string>;
|
|
2477
2698
|
};
|
|
2478
2699
|
/**
|
|
2479
|
-
* Binds a starter (manual, webhook, or schedule) to an executable target (orchestration, agent, or
|
|
2700
|
+
* 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.
|
|
2480
2701
|
*/
|
|
2481
2702
|
type TriggerResourceProperties = {
|
|
2482
2703
|
/**
|
|
@@ -2494,9 +2715,9 @@ type TriggerResourceProperties = {
|
|
|
2494
2715
|
/**
|
|
2495
2716
|
* The kind of resource this trigger activates
|
|
2496
2717
|
*/
|
|
2497
|
-
target_type: 'orchestration' | 'agent' | 'tool';
|
|
2718
|
+
target_type: 'orchestration' | 'agent' | 'tool' | 'eval';
|
|
2498
2719
|
/**
|
|
2499
|
-
* Public ID of the target resource. Use { "ref": "LogicalId" } to reference an orchestration, agent, or
|
|
2720
|
+
* Public ID of the target resource. Use { "ref": "LogicalId" } to reference an orchestration, agent, tool, or eval defined in the template.
|
|
2500
2721
|
*/
|
|
2501
2722
|
target_id: string;
|
|
2502
2723
|
/**
|
|
@@ -2574,45 +2795,11 @@ type ConversationResourceProperties = {
|
|
|
2574
2795
|
actor_id?: string | null;
|
|
2575
2796
|
};
|
|
2576
2797
|
/**
|
|
2577
|
-
*
|
|
2798
|
+
* Registers a file record within the formation's project.
|
|
2578
2799
|
*/
|
|
2579
|
-
type
|
|
2800
|
+
type FileResourceProperties = {
|
|
2580
2801
|
/**
|
|
2581
|
-
*
|
|
2582
|
-
*/
|
|
2583
|
-
name: string;
|
|
2584
|
-
description?: string | null;
|
|
2585
|
-
/**
|
|
2586
|
-
* 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.
|
|
2587
|
-
*/
|
|
2588
|
-
ai_provider_id?: string | null;
|
|
2589
|
-
/**
|
|
2590
|
-
* Default model (falls back to the provider's default_model)
|
|
2591
|
-
*/
|
|
2592
|
-
model?: string | null;
|
|
2593
|
-
/**
|
|
2594
|
-
* Rounds of deliberation (1–3, default 1)
|
|
2595
|
-
*/
|
|
2596
|
-
max_rounds?: number | null;
|
|
2597
|
-
/**
|
|
2598
|
-
* Override for the final synthesis pass
|
|
2599
|
-
*/
|
|
2600
|
-
synthesis?: {
|
|
2601
|
-
[key: string]: unknown;
|
|
2602
|
-
} | null;
|
|
2603
|
-
/**
|
|
2604
|
-
* The deliberation participants (max 5)
|
|
2605
|
-
*/
|
|
2606
|
-
participants?: Array<{
|
|
2607
|
-
[key: string]: unknown;
|
|
2608
|
-
}>;
|
|
2609
|
-
};
|
|
2610
|
-
/**
|
|
2611
|
-
* Registers a file record within the formation's project.
|
|
2612
|
-
*/
|
|
2613
|
-
type FileResourceProperties = {
|
|
2614
|
-
/**
|
|
2615
|
-
* Directory within the project. Optional; defaults to / (root). Combined with filename to form the file's key (path).
|
|
2802
|
+
* Directory within the project. Optional; defaults to / (root). Combined with filename to form the file's key (path).
|
|
2616
2803
|
*/
|
|
2617
2804
|
prefix?: string | null;
|
|
2618
2805
|
/**
|
|
@@ -2923,12 +3110,14 @@ type ResourceDeclaration = {
|
|
|
2923
3110
|
/**
|
|
2924
3111
|
* Resource type
|
|
2925
3112
|
*/
|
|
2926
|
-
type: 'ai_provider' | 'tool' | 'agent' | 'actor' | 'api_key' | 'chat' | 'conversation' | 'document' | 'file' | 'guardrail' | 'ingestion_rule' | 'memory' | 'memory_entry' | 'model_route' | '
|
|
3113
|
+
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';
|
|
2927
3114
|
/**
|
|
2928
|
-
* Resource properties.
|
|
3115
|
+
* Resource properties, as authored in the template and echoed back verbatim. The allowed fields, required fields, and field types for each resource `type` are defined by the corresponding `<Type>ResourceProperties` schema in this document (e.g. `model_route` → `ModelRouteResourceProperties`), which the server enforces at validate/deploy time. The declaration itself is free-form here because property values may be substitution expressions rather than final values: `{ "ref": "logicalId" }` references another resource's physical ID, `{ "param": "ParamName" }` substitutes a parameter value, and `{ "sub": "text ${ParamName}" }` interpolates parameters into a string.
|
|
2929
3116
|
*
|
|
2930
3117
|
*/
|
|
2931
|
-
properties:
|
|
3118
|
+
properties: {
|
|
3119
|
+
[key: string]: unknown;
|
|
3120
|
+
};
|
|
2932
3121
|
/**
|
|
2933
3122
|
* Explicit dependency list. In addition to implicit `ref` dependencies.
|
|
2934
3123
|
*/
|
|
@@ -3669,9 +3858,9 @@ type OrchestrationNode = {
|
|
|
3669
3858
|
*/
|
|
3670
3859
|
id: string;
|
|
3671
3860
|
/**
|
|
3672
|
-
* Node execution type.
|
|
3861
|
+
* Node execution type. Known types: agent, tool, transform, knowledge, memory_write, condition, human, approval, loop, poll, delay, webhook, emit_event, sub_orchestration. Open set — new types may be added in minor releases, and an unrecognized type is accepted at create time (the run fails when the node dispatches), so clients must tolerate unknown values.
|
|
3673
3862
|
*/
|
|
3674
|
-
type:
|
|
3863
|
+
type: string;
|
|
3675
3864
|
/**
|
|
3676
3865
|
* For agent nodes — public ID of the agent to invoke.
|
|
3677
3866
|
*/
|
|
@@ -3685,18 +3874,14 @@ type OrchestrationNode = {
|
|
|
3685
3874
|
*/
|
|
3686
3875
|
operation_id?: string;
|
|
3687
3876
|
/**
|
|
3688
|
-
* For transform/condition nodes — JSON Logic rule (https://jsonlogic.com) evaluated against the run state.
|
|
3877
|
+
* For transform/condition nodes — JSON Logic rule (https://jsonlogic.com) evaluated against the run state. A rule may be any JSON value (object, string, number, boolean, array), so no type is constrained.
|
|
3689
3878
|
*/
|
|
3690
|
-
expression?:
|
|
3691
|
-
[key: string]: unknown;
|
|
3692
|
-
};
|
|
3879
|
+
expression?: unknown;
|
|
3693
3880
|
/**
|
|
3694
3881
|
* For poll nodes — JSON Logic stop condition, evaluated each attempt against the run state augmented with `response` (the latest tool result) and `attempt` (1-based count); a truthy result stops polling.
|
|
3695
3882
|
*
|
|
3696
3883
|
*/
|
|
3697
|
-
exit_condition?:
|
|
3698
|
-
[key: string]: unknown;
|
|
3699
|
-
};
|
|
3884
|
+
exit_condition?: unknown;
|
|
3700
3885
|
/**
|
|
3701
3886
|
* For human nodes — prompt shown to the human reviewer.
|
|
3702
3887
|
*/
|
|
@@ -3726,23 +3911,17 @@ type OrchestrationNode = {
|
|
|
3726
3911
|
*/
|
|
3727
3912
|
instructions?: string;
|
|
3728
3913
|
/**
|
|
3729
|
-
* For approval nodes — JSON Logic resolved into the item's reasoning.
|
|
3914
|
+
* For approval nodes — JSON Logic (any JSON value) resolved into the item's reasoning.
|
|
3730
3915
|
*/
|
|
3731
|
-
reasoning?:
|
|
3732
|
-
[key: string]: unknown;
|
|
3733
|
-
};
|
|
3916
|
+
reasoning?: unknown;
|
|
3734
3917
|
/**
|
|
3735
|
-
* For approval nodes — JSON Logic resolved into the item's evidence.
|
|
3918
|
+
* For approval nodes — JSON Logic (any JSON value) resolved into the item's evidence.
|
|
3736
3919
|
*/
|
|
3737
|
-
evidence?:
|
|
3738
|
-
[key: string]: unknown;
|
|
3739
|
-
};
|
|
3920
|
+
evidence?: unknown;
|
|
3740
3921
|
/**
|
|
3741
|
-
* For approval nodes — JSON Logic resolved into the item's predicted impact.
|
|
3922
|
+
* For approval nodes — JSON Logic (any JSON value) resolved into the item's predicted impact.
|
|
3742
3923
|
*/
|
|
3743
|
-
predicted_impact?:
|
|
3744
|
-
[key: string]: unknown;
|
|
3745
|
-
};
|
|
3924
|
+
predicted_impact?: unknown;
|
|
3746
3925
|
/**
|
|
3747
3926
|
* Maps node input keys to values. Each value is JSON Logic (https://jsonlogic.com), the same evaluator used by transform and condition nodes. A single-key object is evaluated against the run state — `{"var": "key"}` reads `state.key`, `{"cat": [...]}` and `{">": [...]}` compute derived values. Any other value (string, number, boolean, array, multi-key object) is passed through as a literal.
|
|
3748
3927
|
*
|
|
@@ -4098,7 +4277,10 @@ type NodeExecution = {
|
|
|
4098
4277
|
*
|
|
4099
4278
|
*/
|
|
4100
4279
|
attempt: number;
|
|
4101
|
-
|
|
4280
|
+
/**
|
|
4281
|
+
* Node execution status. `running` marks an execution record whose node is still in flight. Open set — new statuses may be added in minor releases; clients must tolerate unknown values.
|
|
4282
|
+
*/
|
|
4283
|
+
status: 'running' | 'completed' | 'failed' | 'requires_action' | 'skipped';
|
|
4102
4284
|
/**
|
|
4103
4285
|
* Resolved input_mapping the node received.
|
|
4104
4286
|
*/
|
|
@@ -4126,15 +4308,29 @@ type NodeExecution = {
|
|
|
4126
4308
|
*/
|
|
4127
4309
|
type RequiredAction = {
|
|
4128
4310
|
/**
|
|
4129
|
-
* Discriminator identifying the kind of pause.
|
|
4311
|
+
* Discriminator identifying the kind of pause. Open enum — new pause kinds may be added in minor releases; clients must tolerate unknown values.
|
|
4130
4312
|
*/
|
|
4131
|
-
type: 'human_input' | 'webhook_receive';
|
|
4313
|
+
type: 'human_input' | 'webhook_receive' | 'approval';
|
|
4132
4314
|
node_id: string;
|
|
4133
4315
|
prompt: string;
|
|
4134
4316
|
context: {
|
|
4135
4317
|
[key: string]: unknown;
|
|
4136
4318
|
};
|
|
4137
4319
|
options?: Array<string> | null;
|
|
4320
|
+
/**
|
|
4321
|
+
* Present only for `approval` pauses — the frozen tool proposal the engine emits as an ApprovalItem when the run parks. Copied as a value; inner keys stay exactly as authored.
|
|
4322
|
+
*/
|
|
4323
|
+
approval_spec?: {
|
|
4324
|
+
[key: string]: unknown;
|
|
4325
|
+
};
|
|
4326
|
+
/**
|
|
4327
|
+
* Present once the approval item is emitted.
|
|
4328
|
+
*/
|
|
4329
|
+
approval_id?: string;
|
|
4330
|
+
/**
|
|
4331
|
+
* Present for `approval` pauses — when the item expires.
|
|
4332
|
+
*/
|
|
4333
|
+
expires_at?: Date;
|
|
4138
4334
|
};
|
|
4139
4335
|
type HumanInputRequest = {
|
|
4140
4336
|
/**
|
|
@@ -4204,8 +4400,8 @@ type PolicyRecord = {
|
|
|
4204
4400
|
* Public policy ID (pol_ prefix)
|
|
4205
4401
|
*/
|
|
4206
4402
|
id?: string;
|
|
4207
|
-
name?: string;
|
|
4208
|
-
description?: string;
|
|
4403
|
+
name?: string | null;
|
|
4404
|
+
description?: string | null;
|
|
4209
4405
|
document?: PolicyDocument;
|
|
4210
4406
|
created_at?: Date;
|
|
4211
4407
|
updated_at?: Date;
|
|
@@ -5020,9 +5216,9 @@ type Trigger = {
|
|
|
5020
5216
|
name?: string;
|
|
5021
5217
|
description?: string | null;
|
|
5022
5218
|
type?: 'manual' | 'webhook' | 'schedule';
|
|
5023
|
-
target_type?: 'orchestration' | 'agent' | 'tool';
|
|
5219
|
+
target_type?: 'orchestration' | 'agent' | 'tool' | 'eval';
|
|
5024
5220
|
/**
|
|
5025
|
-
* Public ID of the target resource (orchestration, agent, or
|
|
5221
|
+
* Public ID of the target resource (orchestration, agent, tool, or eval)
|
|
5026
5222
|
*/
|
|
5027
5223
|
target_id?: string;
|
|
5028
5224
|
/**
|
|
@@ -5030,7 +5226,7 @@ type Trigger = {
|
|
|
5030
5226
|
*/
|
|
5031
5227
|
action?: string | null;
|
|
5032
5228
|
/**
|
|
5033
|
-
* Static input, shallow-merged under fire-time input
|
|
5229
|
+
* 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.
|
|
5034
5230
|
*/
|
|
5035
5231
|
input?: {
|
|
5036
5232
|
[key: string]: unknown;
|
|
@@ -5065,7 +5261,7 @@ type CreateTriggerRequest = {
|
|
|
5065
5261
|
name: string;
|
|
5066
5262
|
description?: string;
|
|
5067
5263
|
type: 'manual' | 'webhook' | 'schedule';
|
|
5068
|
-
target_type: 'orchestration' | 'agent' | 'tool';
|
|
5264
|
+
target_type: 'orchestration' | 'agent' | 'tool' | 'eval';
|
|
5069
5265
|
target_id: string;
|
|
5070
5266
|
/**
|
|
5071
5267
|
* Tool targets only — the action for soat/mcp tools
|
|
@@ -5084,7 +5280,7 @@ type CreateTriggerRequest = {
|
|
|
5084
5280
|
type UpdateTriggerRequest = {
|
|
5085
5281
|
name?: string;
|
|
5086
5282
|
description?: string | null;
|
|
5087
|
-
target_type?: 'orchestration' | 'agent' | 'tool';
|
|
5283
|
+
target_type?: 'orchestration' | 'agent' | 'tool' | 'eval';
|
|
5088
5284
|
target_id?: string;
|
|
5089
5285
|
action?: string | null;
|
|
5090
5286
|
input?: {
|
|
@@ -5096,7 +5292,7 @@ type UpdateTriggerRequest = {
|
|
|
5096
5292
|
};
|
|
5097
5293
|
type FireTriggerRequest = {
|
|
5098
5294
|
/**
|
|
5099
|
-
* Fire-time input, shallow-merged over the trigger's static input
|
|
5295
|
+
* Fire-time input, shallow-merged over the trigger's static input. For `eval` targets it may carry `agent_version` and `baseline_run_id`.
|
|
5100
5296
|
*/
|
|
5101
5297
|
input?: {
|
|
5102
5298
|
[key: string]: unknown;
|
|
@@ -5719,15 +5915,21 @@ type FileRecordWritable = {
|
|
|
5719
5915
|
/**
|
|
5720
5916
|
* MIME type of the file
|
|
5721
5917
|
*/
|
|
5722
|
-
|
|
5918
|
+
content_type?: string | null;
|
|
5723
5919
|
/**
|
|
5724
5920
|
* File size in bytes
|
|
5725
5921
|
*/
|
|
5726
|
-
size?: number;
|
|
5922
|
+
size?: number | null;
|
|
5727
5923
|
/**
|
|
5728
5924
|
* JSON string with additional metadata
|
|
5729
5925
|
*/
|
|
5730
|
-
metadata?: string;
|
|
5926
|
+
metadata?: string | null;
|
|
5927
|
+
/**
|
|
5928
|
+
* Key-value tags attached to the file.
|
|
5929
|
+
*/
|
|
5930
|
+
tags?: {
|
|
5931
|
+
[key: string]: string;
|
|
5932
|
+
};
|
|
5731
5933
|
/**
|
|
5732
5934
|
* Creation timestamp
|
|
5733
5935
|
*/
|
|
@@ -6379,7 +6581,12 @@ type CreateAgentGenerationData = {
|
|
|
6379
6581
|
path: {
|
|
6380
6582
|
agent_id: string;
|
|
6381
6583
|
};
|
|
6382
|
-
query?:
|
|
6584
|
+
query?: {
|
|
6585
|
+
/**
|
|
6586
|
+
* 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.
|
|
6587
|
+
*/
|
|
6588
|
+
wait?: boolean;
|
|
6589
|
+
};
|
|
6383
6590
|
url: '/api/v1/agents/{agent_id}/generate';
|
|
6384
6591
|
};
|
|
6385
6592
|
type CreateAgentGenerationErrors = {
|
|
@@ -6408,9 +6615,13 @@ type CreateAgentGenerationErrors = {
|
|
|
6408
6615
|
type CreateAgentGenerationError = CreateAgentGenerationErrors[keyof CreateAgentGenerationErrors];
|
|
6409
6616
|
type CreateAgentGenerationResponses = {
|
|
6410
6617
|
/**
|
|
6411
|
-
* Generation result or SSE stream
|
|
6618
|
+
* Generation result or SSE stream (only when `?wait=true` or `stream: true`)
|
|
6412
6619
|
*/
|
|
6413
6620
|
200: AgentGenerationResponse;
|
|
6621
|
+
/**
|
|
6622
|
+
* Generation accepted and running in the background (default, when `wait` is omitted or `false`). Poll `GET /api/v1/generations/{generation_id}` for the result.
|
|
6623
|
+
*/
|
|
6624
|
+
202: AcceptedGenerationResponse;
|
|
6414
6625
|
};
|
|
6415
6626
|
type CreateAgentGenerationResponse = CreateAgentGenerationResponses[keyof CreateAgentGenerationResponses];
|
|
6416
6627
|
type SubmitAgentToolOutputsData = {
|
|
@@ -6623,7 +6834,7 @@ type PromoteAgentReleaseErrors = {
|
|
|
6623
6834
|
*/
|
|
6624
6835
|
404: ErrorResponse;
|
|
6625
6836
|
/**
|
|
6626
|
-
* Conflict — the agent has no active release
|
|
6837
|
+
* 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`)
|
|
6627
6838
|
*/
|
|
6628
6839
|
409: ErrorResponse;
|
|
6629
6840
|
};
|
|
@@ -6802,7 +7013,7 @@ type DeleteAiProviderData = {
|
|
|
6802
7013
|
};
|
|
6803
7014
|
query?: {
|
|
6804
7015
|
/**
|
|
6805
|
-
* When `true`, delete the provider's price overrides and unlink its usage
|
|
7016
|
+
* 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.
|
|
6806
7017
|
*
|
|
6807
7018
|
*/
|
|
6808
7019
|
force?: boolean;
|
|
@@ -6870,7 +7081,7 @@ type GetAiProviderResponses = {
|
|
|
6870
7081
|
provider?: string;
|
|
6871
7082
|
default_model?: string;
|
|
6872
7083
|
project_id?: string;
|
|
6873
|
-
secret_id?: string;
|
|
7084
|
+
secret_id?: string | null;
|
|
6874
7085
|
base_url?: string;
|
|
6875
7086
|
config?: {
|
|
6876
7087
|
[key: string]: unknown;
|
|
@@ -6888,7 +7099,7 @@ type UpdateAiProviderData = {
|
|
|
6888
7099
|
*/
|
|
6889
7100
|
provider?: 'openai' | 'anthropic' | 'google' | 'xai' | 'groq' | 'ollama' | 'azure' | 'bedrock' | 'vertex' | 'gateway' | 'custom';
|
|
6890
7101
|
default_model?: string;
|
|
6891
|
-
secret_id?: string;
|
|
7102
|
+
secret_id?: string | null;
|
|
6892
7103
|
base_url?: string;
|
|
6893
7104
|
config?: {
|
|
6894
7105
|
[key: string]: unknown;
|
|
@@ -8138,7 +8349,12 @@ type GenerateConversationMessageData = {
|
|
|
8138
8349
|
path: {
|
|
8139
8350
|
conversation_id: string;
|
|
8140
8351
|
};
|
|
8141
|
-
query?:
|
|
8352
|
+
query?: {
|
|
8353
|
+
/**
|
|
8354
|
+
* 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.
|
|
8355
|
+
*/
|
|
8356
|
+
wait?: boolean;
|
|
8357
|
+
};
|
|
8142
8358
|
url: '/api/v1/conversations/{conversation_id}/generate';
|
|
8143
8359
|
};
|
|
8144
8360
|
type GenerateConversationMessageErrors = {
|
|
@@ -8166,9 +8382,16 @@ type GenerateConversationMessageErrors = {
|
|
|
8166
8382
|
type GenerateConversationMessageError = GenerateConversationMessageErrors[keyof GenerateConversationMessageErrors];
|
|
8167
8383
|
type GenerateConversationMessageResponses = {
|
|
8168
8384
|
/**
|
|
8169
|
-
* Generation completed or requires action
|
|
8385
|
+
* Generation completed or requires action (only when `?wait=true`)
|
|
8170
8386
|
*/
|
|
8171
8387
|
200: GenerateConversationMessageResponse;
|
|
8388
|
+
/**
|
|
8389
|
+
* Generation accepted and running in the background (default, when `wait` is omitted or `false`). The reply is persisted as a ConversationMessage when it completes.
|
|
8390
|
+
*/
|
|
8391
|
+
202: {
|
|
8392
|
+
status: 'accepted';
|
|
8393
|
+
conversation_id: string;
|
|
8394
|
+
};
|
|
8172
8395
|
};
|
|
8173
8396
|
type GenerateConversationMessageResponse2 = GenerateConversationMessageResponses[keyof GenerateConversationMessageResponses];
|
|
8174
8397
|
type RemoveConversationMessageData = {
|
|
@@ -8317,7 +8540,7 @@ type ReplaceConversationTagsResponses = {
|
|
|
8317
8540
|
};
|
|
8318
8541
|
};
|
|
8319
8542
|
type ReplaceConversationTagsResponse = ReplaceConversationTagsResponses[keyof ReplaceConversationTagsResponses];
|
|
8320
|
-
type
|
|
8543
|
+
type ListDocumentsData = {
|
|
8321
8544
|
body?: never;
|
|
8322
8545
|
path?: never;
|
|
8323
8546
|
query?: {
|
|
@@ -8334,9 +8557,9 @@ type ListDiscussionsData = {
|
|
|
8334
8557
|
*/
|
|
8335
8558
|
offset?: number;
|
|
8336
8559
|
};
|
|
8337
|
-
url: '/api/v1/
|
|
8560
|
+
url: '/api/v1/documents';
|
|
8338
8561
|
};
|
|
8339
|
-
type
|
|
8562
|
+
type ListDocumentsErrors = {
|
|
8340
8563
|
/**
|
|
8341
8564
|
* Unauthorized
|
|
8342
8565
|
*/
|
|
@@ -8346,47 +8569,65 @@ type ListDiscussionsErrors = {
|
|
|
8346
8569
|
*/
|
|
8347
8570
|
403: ErrorResponse;
|
|
8348
8571
|
};
|
|
8349
|
-
type
|
|
8350
|
-
type
|
|
8572
|
+
type ListDocumentsError = ListDocumentsErrors[keyof ListDocumentsErrors];
|
|
8573
|
+
type ListDocumentsResponses = {
|
|
8351
8574
|
/**
|
|
8352
|
-
* List of
|
|
8575
|
+
* List of documents
|
|
8353
8576
|
*/
|
|
8354
8577
|
200: {
|
|
8355
|
-
data?: Array<
|
|
8578
|
+
data?: Array<DocumentRecord>;
|
|
8356
8579
|
total?: number;
|
|
8357
8580
|
limit?: number;
|
|
8358
8581
|
offset?: number;
|
|
8359
8582
|
};
|
|
8360
8583
|
};
|
|
8361
|
-
type
|
|
8362
|
-
type
|
|
8584
|
+
type ListDocumentsResponse = ListDocumentsResponses[keyof ListDocumentsResponses];
|
|
8585
|
+
type CreateDocumentData = {
|
|
8363
8586
|
body: {
|
|
8364
8587
|
/**
|
|
8365
|
-
* Project ID. Required for JWT auth; omit when using
|
|
8588
|
+
* Project ID. Required for JWT auth; omit when using an project key.
|
|
8366
8589
|
*/
|
|
8367
8590
|
project_id?: string;
|
|
8368
|
-
|
|
8369
|
-
description?: string | null;
|
|
8591
|
+
content: string;
|
|
8370
8592
|
/**
|
|
8371
|
-
*
|
|
8593
|
+
* Logical path within the project (e.g. /reports/q1.txt). Defaults to /filename if omitted.
|
|
8594
|
+
*/
|
|
8595
|
+
path?: string;
|
|
8596
|
+
filename?: string;
|
|
8597
|
+
/**
|
|
8598
|
+
* Document title
|
|
8599
|
+
*/
|
|
8600
|
+
title?: string;
|
|
8601
|
+
/**
|
|
8602
|
+
* 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.
|
|
8372
8603
|
*/
|
|
8373
|
-
|
|
8604
|
+
metadata?: {
|
|
8605
|
+
[key: string]: unknown;
|
|
8606
|
+
};
|
|
8374
8607
|
/**
|
|
8375
|
-
*
|
|
8608
|
+
* Key-value tags
|
|
8376
8609
|
*/
|
|
8377
|
-
model?: string | null;
|
|
8378
|
-
max_rounds?: number;
|
|
8379
|
-
synthesis?: SynthesisConfig;
|
|
8380
8610
|
tags?: {
|
|
8381
8611
|
[key: string]: string;
|
|
8382
8612
|
};
|
|
8383
|
-
|
|
8613
|
+
/**
|
|
8614
|
+
* 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.
|
|
8615
|
+
*/
|
|
8616
|
+
chunk_strategy?: 'page' | 'whole' | 'size';
|
|
8617
|
+
/**
|
|
8618
|
+
* Window size in characters when `chunk_strategy=size`. Defaults to 1000.
|
|
8619
|
+
*/
|
|
8620
|
+
chunk_size?: number;
|
|
8621
|
+
/**
|
|
8622
|
+
* Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
|
|
8623
|
+
*/
|
|
8624
|
+
chunk_overlap?: number;
|
|
8384
8625
|
};
|
|
8385
8626
|
path?: never;
|
|
8386
8627
|
query?: never;
|
|
8387
|
-
url: '/api/v1/
|
|
8628
|
+
url: '/api/v1/documents';
|
|
8388
8629
|
};
|
|
8389
|
-
type
|
|
8630
|
+
type CreateDocumentErrors = {
|
|
8390
8631
|
/**
|
|
8391
8632
|
* Invalid request body
|
|
8392
8633
|
*/
|
|
@@ -8400,26 +8641,61 @@ type CreateDiscussionErrors = {
|
|
|
8400
8641
|
*/
|
|
8401
8642
|
403: ErrorResponse;
|
|
8402
8643
|
};
|
|
8403
|
-
type
|
|
8404
|
-
type
|
|
8644
|
+
type CreateDocumentError = CreateDocumentErrors[keyof CreateDocumentErrors];
|
|
8645
|
+
type CreateDocumentResponses = {
|
|
8405
8646
|
/**
|
|
8406
|
-
*
|
|
8647
|
+
* Document created
|
|
8407
8648
|
*/
|
|
8408
|
-
201:
|
|
8649
|
+
201: DocumentRecord;
|
|
8409
8650
|
};
|
|
8410
|
-
type
|
|
8411
|
-
type
|
|
8412
|
-
body
|
|
8413
|
-
|
|
8651
|
+
type CreateDocumentResponse = CreateDocumentResponses[keyof CreateDocumentResponses];
|
|
8652
|
+
type IngestDocumentData = {
|
|
8653
|
+
body: {
|
|
8654
|
+
/**
|
|
8655
|
+
* ID of the uploaded file. Must be one of application/pdf, text/plain, text/markdown.
|
|
8656
|
+
*/
|
|
8657
|
+
file_id: string;
|
|
8658
|
+
/**
|
|
8659
|
+
* Project ID. Required for JWT auth; omit when using a project key.
|
|
8660
|
+
*/
|
|
8661
|
+
project_id?: string;
|
|
8662
|
+
/**
|
|
8663
|
+
* Path prefix under which to store the document (e.g. /docs/). The filename is appended automatically.
|
|
8664
|
+
*/
|
|
8665
|
+
path_prefix?: string;
|
|
8666
|
+
/**
|
|
8667
|
+
* Key-value tags to attach to the document.
|
|
8668
|
+
*/
|
|
8669
|
+
tags?: {
|
|
8670
|
+
[key: string]: string;
|
|
8671
|
+
};
|
|
8672
|
+
/**
|
|
8673
|
+
* 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.
|
|
8674
|
+
*/
|
|
8675
|
+
chunk_strategy?: 'page' | 'whole' | 'size';
|
|
8676
|
+
/**
|
|
8677
|
+
* Window size in characters when `chunk_strategy=size`. Defaults to 1000.
|
|
8678
|
+
*/
|
|
8679
|
+
chunk_size?: number;
|
|
8680
|
+
/**
|
|
8681
|
+
* Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
|
|
8682
|
+
*/
|
|
8683
|
+
chunk_overlap?: number;
|
|
8684
|
+
};
|
|
8685
|
+
path?: never;
|
|
8686
|
+
query?: {
|
|
8414
8687
|
/**
|
|
8415
|
-
*
|
|
8688
|
+
* 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`.
|
|
8416
8689
|
*/
|
|
8417
|
-
|
|
8690
|
+
wait?: boolean;
|
|
8418
8691
|
};
|
|
8419
|
-
|
|
8420
|
-
url: '/api/v1/discussions/runs/{run_id}';
|
|
8692
|
+
url: '/api/v1/documents/ingest';
|
|
8421
8693
|
};
|
|
8422
|
-
type
|
|
8694
|
+
type IngestDocumentErrors = {
|
|
8695
|
+
/**
|
|
8696
|
+
* Invalid request, file not found, or unsupported content type
|
|
8697
|
+
*/
|
|
8698
|
+
400: ErrorResponse;
|
|
8423
8699
|
/**
|
|
8424
8700
|
* Unauthorized
|
|
8425
8701
|
*/
|
|
@@ -8429,30 +8705,38 @@ type GetDiscussionRunErrors = {
|
|
|
8429
8705
|
*/
|
|
8430
8706
|
403: ErrorResponse;
|
|
8431
8707
|
/**
|
|
8432
|
-
*
|
|
8708
|
+
* 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.
|
|
8433
8709
|
*/
|
|
8434
|
-
|
|
8710
|
+
409: ErrorResponse;
|
|
8711
|
+
/**
|
|
8712
|
+
* The file is too large to ingest synchronously (`?wait=true`). Retry in background mode and poll the document status.
|
|
8713
|
+
*/
|
|
8714
|
+
413: ErrorResponse;
|
|
8435
8715
|
};
|
|
8436
|
-
type
|
|
8437
|
-
type
|
|
8716
|
+
type IngestDocumentError = IngestDocumentErrors[keyof IngestDocumentErrors];
|
|
8717
|
+
type IngestDocumentResponses = {
|
|
8718
|
+
/**
|
|
8719
|
+
* Ingestion completed synchronously (only when `?wait=true`). The document is fully indexed and ready for search.
|
|
8720
|
+
*/
|
|
8721
|
+
201: IngestedDocumentRecord;
|
|
8438
8722
|
/**
|
|
8439
|
-
*
|
|
8723
|
+
* 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`.
|
|
8440
8724
|
*/
|
|
8441
|
-
|
|
8725
|
+
202: IngestedDocumentRecord;
|
|
8442
8726
|
};
|
|
8443
|
-
type
|
|
8444
|
-
type
|
|
8727
|
+
type IngestDocumentResponse = IngestDocumentResponses[keyof IngestDocumentResponses];
|
|
8728
|
+
type DeleteDocumentData = {
|
|
8445
8729
|
body?: never;
|
|
8446
8730
|
path: {
|
|
8447
8731
|
/**
|
|
8448
|
-
*
|
|
8732
|
+
* Document ID
|
|
8449
8733
|
*/
|
|
8450
|
-
|
|
8734
|
+
document_id: string;
|
|
8451
8735
|
};
|
|
8452
8736
|
query?: never;
|
|
8453
|
-
url: '/api/v1/
|
|
8737
|
+
url: '/api/v1/documents/{document_id}';
|
|
8454
8738
|
};
|
|
8455
|
-
type
|
|
8739
|
+
type DeleteDocumentErrors = {
|
|
8456
8740
|
/**
|
|
8457
8741
|
* Unauthorized
|
|
8458
8742
|
*/
|
|
@@ -8462,30 +8746,30 @@ type DeleteDiscussionErrors = {
|
|
|
8462
8746
|
*/
|
|
8463
8747
|
403: ErrorResponse;
|
|
8464
8748
|
/**
|
|
8465
|
-
*
|
|
8749
|
+
* Document not found
|
|
8466
8750
|
*/
|
|
8467
8751
|
404: ErrorResponse;
|
|
8468
8752
|
};
|
|
8469
|
-
type
|
|
8470
|
-
type
|
|
8753
|
+
type DeleteDocumentError = DeleteDocumentErrors[keyof DeleteDocumentErrors];
|
|
8754
|
+
type DeleteDocumentResponses = {
|
|
8471
8755
|
/**
|
|
8472
|
-
*
|
|
8756
|
+
* Document deleted
|
|
8473
8757
|
*/
|
|
8474
8758
|
204: void;
|
|
8475
8759
|
};
|
|
8476
|
-
type
|
|
8477
|
-
type
|
|
8760
|
+
type DeleteDocumentResponse = DeleteDocumentResponses[keyof DeleteDocumentResponses];
|
|
8761
|
+
type GetDocumentData = {
|
|
8478
8762
|
body?: never;
|
|
8479
8763
|
path: {
|
|
8480
8764
|
/**
|
|
8481
|
-
*
|
|
8765
|
+
* Document ID
|
|
8482
8766
|
*/
|
|
8483
|
-
|
|
8767
|
+
document_id: string;
|
|
8484
8768
|
};
|
|
8485
8769
|
query?: never;
|
|
8486
|
-
url: '/api/v1/
|
|
8770
|
+
url: '/api/v1/documents/{document_id}';
|
|
8487
8771
|
};
|
|
8488
|
-
type
|
|
8772
|
+
type GetDocumentErrors = {
|
|
8489
8773
|
/**
|
|
8490
8774
|
* Unauthorized
|
|
8491
8775
|
*/
|
|
@@ -8495,48 +8779,55 @@ type GetDiscussionErrors = {
|
|
|
8495
8779
|
*/
|
|
8496
8780
|
403: ErrorResponse;
|
|
8497
8781
|
/**
|
|
8498
|
-
*
|
|
8782
|
+
* Document not found
|
|
8499
8783
|
*/
|
|
8500
8784
|
404: ErrorResponse;
|
|
8501
8785
|
};
|
|
8502
|
-
type
|
|
8503
|
-
type
|
|
8786
|
+
type GetDocumentError = GetDocumentErrors[keyof GetDocumentErrors];
|
|
8787
|
+
type GetDocumentResponses = {
|
|
8504
8788
|
/**
|
|
8505
|
-
*
|
|
8789
|
+
* Document found
|
|
8506
8790
|
*/
|
|
8507
|
-
200:
|
|
8791
|
+
200: DocumentRecord;
|
|
8508
8792
|
};
|
|
8509
|
-
type
|
|
8510
|
-
type
|
|
8793
|
+
type GetDocumentResponse = GetDocumentResponses[keyof GetDocumentResponses];
|
|
8794
|
+
type UpdateDocumentData = {
|
|
8511
8795
|
body: {
|
|
8512
|
-
name?: string;
|
|
8513
|
-
description?: string | null;
|
|
8514
8796
|
/**
|
|
8515
|
-
*
|
|
8797
|
+
* New text content
|
|
8798
|
+
*/
|
|
8799
|
+
content?: string;
|
|
8800
|
+
/**
|
|
8801
|
+
* New title
|
|
8802
|
+
*/
|
|
8803
|
+
title?: string;
|
|
8804
|
+
/**
|
|
8805
|
+
* Logical path within the project (e.g. /reports/q1.txt). Pass null to clear.
|
|
8806
|
+
*/
|
|
8807
|
+
path?: string | null;
|
|
8808
|
+
/**
|
|
8809
|
+
* 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.
|
|
8810
|
+
*/
|
|
8811
|
+
metadata?: {
|
|
8812
|
+
[key: string]: unknown;
|
|
8813
|
+
};
|
|
8814
|
+
/**
|
|
8815
|
+
* Key-value tags
|
|
8516
8816
|
*/
|
|
8517
|
-
ai_provider_id?: string | null;
|
|
8518
|
-
model?: string | null;
|
|
8519
|
-
max_rounds?: number;
|
|
8520
|
-
synthesis?: SynthesisConfig;
|
|
8521
8817
|
tags?: {
|
|
8522
8818
|
[key: string]: string;
|
|
8523
8819
|
};
|
|
8524
|
-
participants?: Array<ParticipantInput>;
|
|
8525
8820
|
};
|
|
8526
8821
|
path: {
|
|
8527
8822
|
/**
|
|
8528
|
-
*
|
|
8823
|
+
* Document ID
|
|
8529
8824
|
*/
|
|
8530
|
-
|
|
8825
|
+
document_id: string;
|
|
8531
8826
|
};
|
|
8532
8827
|
query?: never;
|
|
8533
|
-
url: '/api/v1/
|
|
8828
|
+
url: '/api/v1/documents/{document_id}';
|
|
8534
8829
|
};
|
|
8535
|
-
type
|
|
8536
|
-
/**
|
|
8537
|
-
* Invalid request body
|
|
8538
|
-
*/
|
|
8539
|
-
400: ErrorResponse;
|
|
8830
|
+
type UpdateDocumentErrors = {
|
|
8540
8831
|
/**
|
|
8541
8832
|
* Unauthorized
|
|
8542
8833
|
*/
|
|
@@ -8546,33 +8837,30 @@ type UpdateDiscussionErrors = {
|
|
|
8546
8837
|
*/
|
|
8547
8838
|
403: ErrorResponse;
|
|
8548
8839
|
/**
|
|
8549
|
-
*
|
|
8840
|
+
* Document not found
|
|
8550
8841
|
*/
|
|
8551
8842
|
404: ErrorResponse;
|
|
8552
8843
|
};
|
|
8553
|
-
type
|
|
8554
|
-
type
|
|
8844
|
+
type UpdateDocumentError = UpdateDocumentErrors[keyof UpdateDocumentErrors];
|
|
8845
|
+
type UpdateDocumentResponses = {
|
|
8555
8846
|
/**
|
|
8556
|
-
*
|
|
8847
|
+
* Document updated
|
|
8557
8848
|
*/
|
|
8558
|
-
200:
|
|
8849
|
+
200: DocumentRecord;
|
|
8559
8850
|
};
|
|
8560
|
-
type
|
|
8561
|
-
type
|
|
8851
|
+
type UpdateDocumentResponse = UpdateDocumentResponses[keyof UpdateDocumentResponses];
|
|
8852
|
+
type GetDocumentStatusData = {
|
|
8562
8853
|
body?: never;
|
|
8563
8854
|
path: {
|
|
8564
8855
|
/**
|
|
8565
|
-
*
|
|
8856
|
+
* Document ID
|
|
8566
8857
|
*/
|
|
8567
|
-
|
|
8568
|
-
};
|
|
8569
|
-
query?: {
|
|
8570
|
-
limit?: number;
|
|
8571
|
-
offset?: number;
|
|
8858
|
+
document_id: string;
|
|
8572
8859
|
};
|
|
8573
|
-
|
|
8860
|
+
query?: never;
|
|
8861
|
+
url: '/api/v1/documents/{document_id}/status';
|
|
8574
8862
|
};
|
|
8575
|
-
type
|
|
8863
|
+
type GetDocumentStatusErrors = {
|
|
8576
8864
|
/**
|
|
8577
8865
|
* Unauthorized
|
|
8578
8866
|
*/
|
|
@@ -8582,44 +8870,215 @@ type ListDiscussionRunsErrors = {
|
|
|
8582
8870
|
*/
|
|
8583
8871
|
403: ErrorResponse;
|
|
8584
8872
|
/**
|
|
8585
|
-
*
|
|
8873
|
+
* Document not found
|
|
8586
8874
|
*/
|
|
8587
8875
|
404: ErrorResponse;
|
|
8588
8876
|
};
|
|
8589
|
-
type
|
|
8590
|
-
type
|
|
8877
|
+
type GetDocumentStatusError = GetDocumentStatusErrors[keyof GetDocumentStatusErrors];
|
|
8878
|
+
type GetDocumentStatusResponses = {
|
|
8591
8879
|
/**
|
|
8592
|
-
*
|
|
8880
|
+
* Document ingestion status
|
|
8593
8881
|
*/
|
|
8594
|
-
200:
|
|
8595
|
-
|
|
8596
|
-
|
|
8597
|
-
|
|
8598
|
-
|
|
8882
|
+
200: DocumentStatusRecord;
|
|
8883
|
+
};
|
|
8884
|
+
type GetDocumentStatusResponse = GetDocumentStatusResponses[keyof GetDocumentStatusResponses];
|
|
8885
|
+
type ReingestDocumentData = {
|
|
8886
|
+
body?: {
|
|
8887
|
+
/**
|
|
8888
|
+
* How to split the source into chunks. Defaults to `page`.
|
|
8889
|
+
*/
|
|
8890
|
+
chunk_strategy?: 'page' | 'whole' | 'size';
|
|
8891
|
+
/**
|
|
8892
|
+
* Window size in characters when `chunk_strategy=size`. Defaults to 1000.
|
|
8893
|
+
*/
|
|
8894
|
+
chunk_size?: number;
|
|
8895
|
+
/**
|
|
8896
|
+
* Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
|
|
8897
|
+
*/
|
|
8898
|
+
chunk_overlap?: number;
|
|
8899
|
+
};
|
|
8900
|
+
path: {
|
|
8901
|
+
/**
|
|
8902
|
+
* Document ID
|
|
8903
|
+
*/
|
|
8904
|
+
document_id: string;
|
|
8905
|
+
};
|
|
8906
|
+
query?: {
|
|
8907
|
+
/**
|
|
8908
|
+
* 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`.
|
|
8909
|
+
*/
|
|
8910
|
+
wait?: boolean;
|
|
8599
8911
|
};
|
|
8912
|
+
url: '/api/v1/documents/{document_id}/ingest';
|
|
8913
|
+
};
|
|
8914
|
+
type ReingestDocumentErrors = {
|
|
8915
|
+
/**
|
|
8916
|
+
* Unauthorized
|
|
8917
|
+
*/
|
|
8918
|
+
401: ErrorResponse;
|
|
8919
|
+
/**
|
|
8920
|
+
* Forbidden
|
|
8921
|
+
*/
|
|
8922
|
+
403: ErrorResponse;
|
|
8923
|
+
/**
|
|
8924
|
+
* Document not found
|
|
8925
|
+
*/
|
|
8926
|
+
404: ErrorResponse;
|
|
8927
|
+
/**
|
|
8928
|
+
* The file is too large to re-ingest synchronously (`?wait=true`). Retry in background mode.
|
|
8929
|
+
*/
|
|
8930
|
+
413: ErrorResponse;
|
|
8600
8931
|
};
|
|
8601
|
-
type
|
|
8602
|
-
type
|
|
8932
|
+
type ReingestDocumentError = ReingestDocumentErrors[keyof ReingestDocumentErrors];
|
|
8933
|
+
type ReingestDocumentResponses = {
|
|
8934
|
+
/**
|
|
8935
|
+
* Re-ingestion completed synchronously (only when `?wait=true`).
|
|
8936
|
+
*/
|
|
8937
|
+
201: IngestedDocumentRecord;
|
|
8938
|
+
/**
|
|
8939
|
+
* Re-ingestion accepted. The document was reset to `status=pending` and processing runs in the background. Poll `GET /api/v1/documents/{document_id}/status`.
|
|
8940
|
+
*/
|
|
8941
|
+
202: IngestedDocumentRecord;
|
|
8942
|
+
};
|
|
8943
|
+
type ReingestDocumentResponse = ReingestDocumentResponses[keyof ReingestDocumentResponses];
|
|
8944
|
+
type CompleteIngestionCallbackData = {
|
|
8945
|
+
/**
|
|
8946
|
+
* The converter output contract, adapted for a JSON request body: a single page as `{ text }`, or `{ pages: [{ text, page_number }] }` for multiple pages.
|
|
8947
|
+
*/
|
|
8603
8948
|
body: {
|
|
8949
|
+
text: string;
|
|
8950
|
+
} | {
|
|
8951
|
+
pages: Array<{
|
|
8952
|
+
text?: string;
|
|
8953
|
+
page_number?: number;
|
|
8954
|
+
}>;
|
|
8955
|
+
};
|
|
8956
|
+
path: {
|
|
8957
|
+
/**
|
|
8958
|
+
* Document ID
|
|
8959
|
+
*/
|
|
8960
|
+
document_id: string;
|
|
8961
|
+
};
|
|
8962
|
+
query: {
|
|
8963
|
+
/**
|
|
8964
|
+
* Single-use signed token from the original `callback.token`
|
|
8965
|
+
*/
|
|
8966
|
+
token: string;
|
|
8967
|
+
};
|
|
8968
|
+
url: '/api/v1/documents/{document_id}/ingestion-callback';
|
|
8969
|
+
};
|
|
8970
|
+
type CompleteIngestionCallbackErrors = {
|
|
8971
|
+
/**
|
|
8972
|
+
* The token is missing, invalid, or does not match this document.
|
|
8973
|
+
*/
|
|
8974
|
+
401: ErrorResponse;
|
|
8975
|
+
/**
|
|
8976
|
+
* Document not found
|
|
8977
|
+
*/
|
|
8978
|
+
404: ErrorResponse;
|
|
8979
|
+
/**
|
|
8980
|
+
* The document is no longer awaiting this conversion attempt (already completed, timed out, or superseded by a re-ingest).
|
|
8981
|
+
*/
|
|
8982
|
+
409: ErrorResponse;
|
|
8983
|
+
/**
|
|
8984
|
+
* The output shape is unrecognized.
|
|
8985
|
+
*/
|
|
8986
|
+
422: ErrorResponse;
|
|
8987
|
+
};
|
|
8988
|
+
type CompleteIngestionCallbackError = CompleteIngestionCallbackErrors[keyof CompleteIngestionCallbackErrors];
|
|
8989
|
+
type CompleteIngestionCallbackResponses = {
|
|
8990
|
+
/**
|
|
8991
|
+
* Conversion completed — the document was chunked and marked `ready` (or `failed` with `FILE_PARSE_FAILED` if the output produced no text).
|
|
8992
|
+
*/
|
|
8993
|
+
204: void;
|
|
8994
|
+
};
|
|
8995
|
+
type CompleteIngestionCallbackResponse = CompleteIngestionCallbackResponses[keyof CompleteIngestionCallbackResponses];
|
|
8996
|
+
type GetDocumentTagsData = {
|
|
8997
|
+
body?: never;
|
|
8998
|
+
path: {
|
|
8604
8999
|
/**
|
|
8605
|
-
*
|
|
9000
|
+
* Document ID
|
|
8606
9001
|
*/
|
|
8607
|
-
|
|
9002
|
+
document_id: string;
|
|
9003
|
+
};
|
|
9004
|
+
query?: never;
|
|
9005
|
+
url: '/api/v1/documents/{document_id}/tags';
|
|
9006
|
+
};
|
|
9007
|
+
type GetDocumentTagsErrors = {
|
|
9008
|
+
/**
|
|
9009
|
+
* Unauthorized
|
|
9010
|
+
*/
|
|
9011
|
+
401: ErrorResponse;
|
|
9012
|
+
/**
|
|
9013
|
+
* Forbidden
|
|
9014
|
+
*/
|
|
9015
|
+
403: ErrorResponse;
|
|
9016
|
+
/**
|
|
9017
|
+
* Document not found
|
|
9018
|
+
*/
|
|
9019
|
+
404: ErrorResponse;
|
|
9020
|
+
};
|
|
9021
|
+
type GetDocumentTagsError = GetDocumentTagsErrors[keyof GetDocumentTagsErrors];
|
|
9022
|
+
type GetDocumentTagsResponses = {
|
|
9023
|
+
/**
|
|
9024
|
+
* Document tags
|
|
9025
|
+
*/
|
|
9026
|
+
200: {
|
|
9027
|
+
[key: string]: string;
|
|
9028
|
+
};
|
|
9029
|
+
};
|
|
9030
|
+
type GetDocumentTagsResponse = GetDocumentTagsResponses[keyof GetDocumentTagsResponses];
|
|
9031
|
+
type MergeDocumentTagsData = {
|
|
9032
|
+
body: {
|
|
9033
|
+
[key: string]: string;
|
|
8608
9034
|
};
|
|
8609
9035
|
path: {
|
|
8610
9036
|
/**
|
|
8611
|
-
*
|
|
9037
|
+
* Document ID
|
|
8612
9038
|
*/
|
|
8613
|
-
|
|
9039
|
+
document_id: string;
|
|
8614
9040
|
};
|
|
8615
9041
|
query?: never;
|
|
8616
|
-
url: '/api/v1/
|
|
9042
|
+
url: '/api/v1/documents/{document_id}/tags';
|
|
8617
9043
|
};
|
|
8618
|
-
type
|
|
9044
|
+
type MergeDocumentTagsErrors = {
|
|
8619
9045
|
/**
|
|
8620
|
-
*
|
|
9046
|
+
* Unauthorized
|
|
8621
9047
|
*/
|
|
8622
|
-
|
|
9048
|
+
401: ErrorResponse;
|
|
9049
|
+
/**
|
|
9050
|
+
* Forbidden
|
|
9051
|
+
*/
|
|
9052
|
+
403: ErrorResponse;
|
|
9053
|
+
/**
|
|
9054
|
+
* Document not found
|
|
9055
|
+
*/
|
|
9056
|
+
404: ErrorResponse;
|
|
9057
|
+
};
|
|
9058
|
+
type MergeDocumentTagsError = MergeDocumentTagsErrors[keyof MergeDocumentTagsErrors];
|
|
9059
|
+
type MergeDocumentTagsResponses = {
|
|
9060
|
+
/**
|
|
9061
|
+
* Tags merged
|
|
9062
|
+
*/
|
|
9063
|
+
200: {
|
|
9064
|
+
[key: string]: string;
|
|
9065
|
+
};
|
|
9066
|
+
};
|
|
9067
|
+
type MergeDocumentTagsResponse = MergeDocumentTagsResponses[keyof MergeDocumentTagsResponses];
|
|
9068
|
+
type ReplaceDocumentTagsData = {
|
|
9069
|
+
body: {
|
|
9070
|
+
[key: string]: string;
|
|
9071
|
+
};
|
|
9072
|
+
path: {
|
|
9073
|
+
/**
|
|
9074
|
+
* Document ID
|
|
9075
|
+
*/
|
|
9076
|
+
document_id: string;
|
|
9077
|
+
};
|
|
9078
|
+
query?: never;
|
|
9079
|
+
url: '/api/v1/documents/{document_id}/tags';
|
|
9080
|
+
};
|
|
9081
|
+
type ReplaceDocumentTagsErrors = {
|
|
8623
9082
|
/**
|
|
8624
9083
|
* Unauthorized
|
|
8625
9084
|
*/
|
|
@@ -8629,24 +9088,63 @@ type CreateDiscussionRunErrors = {
|
|
|
8629
9088
|
*/
|
|
8630
9089
|
403: ErrorResponse;
|
|
8631
9090
|
/**
|
|
8632
|
-
*
|
|
9091
|
+
* Document not found
|
|
8633
9092
|
*/
|
|
8634
9093
|
404: ErrorResponse;
|
|
8635
9094
|
};
|
|
8636
|
-
type
|
|
8637
|
-
type
|
|
9095
|
+
type ReplaceDocumentTagsError = ReplaceDocumentTagsErrors[keyof ReplaceDocumentTagsErrors];
|
|
9096
|
+
type ReplaceDocumentTagsResponses = {
|
|
8638
9097
|
/**
|
|
8639
|
-
*
|
|
9098
|
+
* Tags replaced
|
|
8640
9099
|
*/
|
|
8641
|
-
|
|
9100
|
+
200: {
|
|
9101
|
+
[key: string]: string;
|
|
9102
|
+
};
|
|
8642
9103
|
};
|
|
8643
|
-
type
|
|
8644
|
-
type
|
|
9104
|
+
type ReplaceDocumentTagsResponse = ReplaceDocumentTagsResponses[keyof ReplaceDocumentTagsResponses];
|
|
9105
|
+
type CreateEmbeddingsData = {
|
|
9106
|
+
body: {
|
|
9107
|
+
/**
|
|
9108
|
+
* Single text to embed.
|
|
9109
|
+
*/
|
|
9110
|
+
input?: string;
|
|
9111
|
+
/**
|
|
9112
|
+
* Batch of texts to embed.
|
|
9113
|
+
*/
|
|
9114
|
+
inputs?: Array<string>;
|
|
9115
|
+
};
|
|
9116
|
+
path?: never;
|
|
9117
|
+
query?: never;
|
|
9118
|
+
url: '/api/v1/embeddings';
|
|
9119
|
+
};
|
|
9120
|
+
type CreateEmbeddingsErrors = {
|
|
9121
|
+
/**
|
|
9122
|
+
* Invalid request body
|
|
9123
|
+
*/
|
|
9124
|
+
400: ErrorResponse;
|
|
9125
|
+
/**
|
|
9126
|
+
* Unauthorized
|
|
9127
|
+
*/
|
|
9128
|
+
401: ErrorResponse;
|
|
9129
|
+
/**
|
|
9130
|
+
* Embedding service not configured
|
|
9131
|
+
*/
|
|
9132
|
+
503: ErrorResponse;
|
|
9133
|
+
};
|
|
9134
|
+
type CreateEmbeddingsError = CreateEmbeddingsErrors[keyof CreateEmbeddingsErrors];
|
|
9135
|
+
type CreateEmbeddingsResponses = {
|
|
9136
|
+
/**
|
|
9137
|
+
* Embeddings generated successfully
|
|
9138
|
+
*/
|
|
9139
|
+
200: EmbeddingsResponse;
|
|
9140
|
+
};
|
|
9141
|
+
type CreateEmbeddingsResponse = CreateEmbeddingsResponses[keyof CreateEmbeddingsResponses];
|
|
9142
|
+
type ListDatasetsData = {
|
|
8645
9143
|
body?: never;
|
|
8646
9144
|
path?: never;
|
|
8647
9145
|
query?: {
|
|
8648
9146
|
/**
|
|
8649
|
-
* Project ID (
|
|
9147
|
+
* Project ID (required if not using project key auth)
|
|
8650
9148
|
*/
|
|
8651
9149
|
project_id?: string;
|
|
8652
9150
|
/**
|
|
@@ -8658,588 +9156,806 @@ type ListDocumentsData = {
|
|
|
8658
9156
|
*/
|
|
8659
9157
|
offset?: number;
|
|
8660
9158
|
};
|
|
8661
|
-
url: '/api/v1/
|
|
9159
|
+
url: '/api/v1/datasets';
|
|
8662
9160
|
};
|
|
8663
|
-
type
|
|
9161
|
+
type ListDatasetsErrors = {
|
|
8664
9162
|
/**
|
|
8665
9163
|
* Unauthorized
|
|
8666
9164
|
*/
|
|
8667
|
-
401:
|
|
9165
|
+
401: unknown;
|
|
8668
9166
|
/**
|
|
8669
9167
|
* Forbidden
|
|
8670
9168
|
*/
|
|
8671
|
-
403:
|
|
9169
|
+
403: unknown;
|
|
9170
|
+
/**
|
|
9171
|
+
* Internal server error
|
|
9172
|
+
*/
|
|
9173
|
+
500: unknown;
|
|
8672
9174
|
};
|
|
8673
|
-
type
|
|
8674
|
-
type ListDocumentsResponses = {
|
|
9175
|
+
type ListDatasetsResponses = {
|
|
8675
9176
|
/**
|
|
8676
|
-
* List of
|
|
9177
|
+
* List of datasets
|
|
8677
9178
|
*/
|
|
8678
9179
|
200: {
|
|
8679
|
-
data
|
|
8680
|
-
total
|
|
8681
|
-
limit
|
|
8682
|
-
offset
|
|
9180
|
+
data: Array<Dataset>;
|
|
9181
|
+
total: number;
|
|
9182
|
+
limit: number;
|
|
9183
|
+
offset: number;
|
|
8683
9184
|
};
|
|
8684
9185
|
};
|
|
8685
|
-
type
|
|
8686
|
-
type
|
|
9186
|
+
type ListDatasetsResponse = ListDatasetsResponses[keyof ListDatasetsResponses];
|
|
9187
|
+
type CreateDatasetData = {
|
|
8687
9188
|
body: {
|
|
8688
9189
|
/**
|
|
8689
|
-
* Project ID
|
|
9190
|
+
* Project ID (required if not using project key auth)
|
|
8690
9191
|
*/
|
|
8691
9192
|
project_id?: string;
|
|
8692
|
-
content: string;
|
|
8693
|
-
/**
|
|
8694
|
-
* Logical path within the project (e.g. /reports/q1.txt). Defaults to /filename if omitted.
|
|
8695
|
-
*/
|
|
8696
|
-
path?: string;
|
|
8697
|
-
filename?: string;
|
|
8698
|
-
/**
|
|
8699
|
-
* Document title
|
|
8700
|
-
*/
|
|
8701
|
-
title?: string;
|
|
8702
9193
|
/**
|
|
8703
|
-
*
|
|
9194
|
+
* Unique name within the project
|
|
8704
9195
|
*/
|
|
8705
|
-
|
|
8706
|
-
[key: string]: unknown;
|
|
8707
|
-
};
|
|
9196
|
+
name: string;
|
|
8708
9197
|
/**
|
|
8709
|
-
*
|
|
9198
|
+
* What this suite covers
|
|
8710
9199
|
*/
|
|
8711
|
-
|
|
8712
|
-
|
|
8713
|
-
|
|
9200
|
+
description?: string | null;
|
|
9201
|
+
};
|
|
9202
|
+
path?: never;
|
|
9203
|
+
query?: never;
|
|
9204
|
+
url: '/api/v1/datasets';
|
|
9205
|
+
};
|
|
9206
|
+
type CreateDatasetErrors = {
|
|
9207
|
+
/**
|
|
9208
|
+
* Bad request (missing or invalid name)
|
|
9209
|
+
*/
|
|
9210
|
+
400: unknown;
|
|
9211
|
+
/**
|
|
9212
|
+
* Unauthorized
|
|
9213
|
+
*/
|
|
9214
|
+
401: unknown;
|
|
9215
|
+
/**
|
|
9216
|
+
* Forbidden
|
|
9217
|
+
*/
|
|
9218
|
+
403: unknown;
|
|
9219
|
+
/**
|
|
9220
|
+
* A dataset with that name already exists in the project
|
|
9221
|
+
*/
|
|
9222
|
+
409: unknown;
|
|
9223
|
+
/**
|
|
9224
|
+
* Internal server error
|
|
9225
|
+
*/
|
|
9226
|
+
500: unknown;
|
|
9227
|
+
};
|
|
9228
|
+
type CreateDatasetResponses = {
|
|
9229
|
+
/**
|
|
9230
|
+
* Dataset created successfully
|
|
9231
|
+
*/
|
|
9232
|
+
201: Dataset;
|
|
9233
|
+
};
|
|
9234
|
+
type CreateDatasetResponse = CreateDatasetResponses[keyof CreateDatasetResponses];
|
|
9235
|
+
type DeleteDatasetData = {
|
|
9236
|
+
body?: never;
|
|
9237
|
+
path: {
|
|
8714
9238
|
/**
|
|
8715
|
-
*
|
|
9239
|
+
* Dataset ID
|
|
8716
9240
|
*/
|
|
8717
|
-
|
|
9241
|
+
dataset_id: string;
|
|
9242
|
+
};
|
|
9243
|
+
query?: never;
|
|
9244
|
+
url: '/api/v1/datasets/{dataset_id}';
|
|
9245
|
+
};
|
|
9246
|
+
type DeleteDatasetErrors = {
|
|
9247
|
+
/**
|
|
9248
|
+
* Unauthorized
|
|
9249
|
+
*/
|
|
9250
|
+
401: unknown;
|
|
9251
|
+
/**
|
|
9252
|
+
* Forbidden
|
|
9253
|
+
*/
|
|
9254
|
+
403: unknown;
|
|
9255
|
+
/**
|
|
9256
|
+
* Dataset not found
|
|
9257
|
+
*/
|
|
9258
|
+
404: unknown;
|
|
9259
|
+
};
|
|
9260
|
+
type DeleteDatasetResponses = {
|
|
9261
|
+
/**
|
|
9262
|
+
* Dataset deleted successfully
|
|
9263
|
+
*/
|
|
9264
|
+
204: void;
|
|
9265
|
+
};
|
|
9266
|
+
type DeleteDatasetResponse = DeleteDatasetResponses[keyof DeleteDatasetResponses];
|
|
9267
|
+
type GetDatasetData = {
|
|
9268
|
+
body?: never;
|
|
9269
|
+
path: {
|
|
8718
9270
|
/**
|
|
8719
|
-
*
|
|
9271
|
+
* Dataset ID
|
|
8720
9272
|
*/
|
|
8721
|
-
|
|
9273
|
+
dataset_id: string;
|
|
9274
|
+
};
|
|
9275
|
+
query?: never;
|
|
9276
|
+
url: '/api/v1/datasets/{dataset_id}';
|
|
9277
|
+
};
|
|
9278
|
+
type GetDatasetErrors = {
|
|
9279
|
+
/**
|
|
9280
|
+
* Unauthorized
|
|
9281
|
+
*/
|
|
9282
|
+
401: unknown;
|
|
9283
|
+
/**
|
|
9284
|
+
* Forbidden
|
|
9285
|
+
*/
|
|
9286
|
+
403: unknown;
|
|
9287
|
+
/**
|
|
9288
|
+
* Dataset not found
|
|
9289
|
+
*/
|
|
9290
|
+
404: unknown;
|
|
9291
|
+
};
|
|
9292
|
+
type GetDatasetResponses = {
|
|
9293
|
+
/**
|
|
9294
|
+
* Dataset details
|
|
9295
|
+
*/
|
|
9296
|
+
200: Dataset;
|
|
9297
|
+
};
|
|
9298
|
+
type GetDatasetResponse = GetDatasetResponses[keyof GetDatasetResponses];
|
|
9299
|
+
type UpdateDatasetData = {
|
|
9300
|
+
body: {
|
|
9301
|
+
name?: string;
|
|
9302
|
+
description?: string | null;
|
|
9303
|
+
};
|
|
9304
|
+
path: {
|
|
8722
9305
|
/**
|
|
8723
|
-
*
|
|
9306
|
+
* Dataset ID
|
|
8724
9307
|
*/
|
|
8725
|
-
|
|
9308
|
+
dataset_id: string;
|
|
8726
9309
|
};
|
|
8727
|
-
path?: never;
|
|
8728
9310
|
query?: never;
|
|
8729
|
-
url: '/api/v1/
|
|
9311
|
+
url: '/api/v1/datasets/{dataset_id}';
|
|
8730
9312
|
};
|
|
8731
|
-
type
|
|
9313
|
+
type UpdateDatasetErrors = {
|
|
8732
9314
|
/**
|
|
8733
|
-
*
|
|
9315
|
+
* Bad request
|
|
8734
9316
|
*/
|
|
8735
|
-
400:
|
|
9317
|
+
400: unknown;
|
|
8736
9318
|
/**
|
|
8737
9319
|
* Unauthorized
|
|
8738
9320
|
*/
|
|
8739
|
-
401:
|
|
9321
|
+
401: unknown;
|
|
8740
9322
|
/**
|
|
8741
9323
|
* Forbidden
|
|
8742
9324
|
*/
|
|
8743
|
-
403:
|
|
9325
|
+
403: unknown;
|
|
9326
|
+
/**
|
|
9327
|
+
* Dataset not found
|
|
9328
|
+
*/
|
|
9329
|
+
404: unknown;
|
|
9330
|
+
/**
|
|
9331
|
+
* A dataset with that name already exists in the project
|
|
9332
|
+
*/
|
|
9333
|
+
409: unknown;
|
|
8744
9334
|
};
|
|
8745
|
-
type
|
|
8746
|
-
type CreateDocumentResponses = {
|
|
9335
|
+
type UpdateDatasetResponses = {
|
|
8747
9336
|
/**
|
|
8748
|
-
*
|
|
9337
|
+
* Dataset updated successfully
|
|
8749
9338
|
*/
|
|
8750
|
-
|
|
9339
|
+
200: Dataset;
|
|
8751
9340
|
};
|
|
8752
|
-
type
|
|
8753
|
-
type
|
|
8754
|
-
body
|
|
8755
|
-
|
|
8756
|
-
* ID of the uploaded file. Must be one of application/pdf, text/plain, text/markdown.
|
|
8757
|
-
*/
|
|
8758
|
-
file_id: string;
|
|
8759
|
-
/**
|
|
8760
|
-
* Project ID. Required for JWT auth; omit when using a project key.
|
|
8761
|
-
*/
|
|
8762
|
-
project_id?: string;
|
|
9341
|
+
type UpdateDatasetResponse = UpdateDatasetResponses[keyof UpdateDatasetResponses];
|
|
9342
|
+
type ListDatasetItemsData = {
|
|
9343
|
+
body?: never;
|
|
9344
|
+
path: {
|
|
8763
9345
|
/**
|
|
8764
|
-
*
|
|
9346
|
+
* Dataset ID
|
|
8765
9347
|
*/
|
|
8766
|
-
|
|
9348
|
+
dataset_id: string;
|
|
9349
|
+
};
|
|
9350
|
+
query?: {
|
|
8767
9351
|
/**
|
|
8768
|
-
*
|
|
9352
|
+
* Maximum number of results to return
|
|
8769
9353
|
*/
|
|
8770
|
-
|
|
8771
|
-
[key: string]: string;
|
|
8772
|
-
};
|
|
9354
|
+
limit?: number;
|
|
8773
9355
|
/**
|
|
8774
|
-
*
|
|
9356
|
+
* Number of results to skip
|
|
8775
9357
|
*/
|
|
8776
|
-
|
|
9358
|
+
offset?: number;
|
|
9359
|
+
};
|
|
9360
|
+
url: '/api/v1/datasets/{dataset_id}/items';
|
|
9361
|
+
};
|
|
9362
|
+
type ListDatasetItemsErrors = {
|
|
9363
|
+
/**
|
|
9364
|
+
* Unauthorized
|
|
9365
|
+
*/
|
|
9366
|
+
401: unknown;
|
|
9367
|
+
/**
|
|
9368
|
+
* Forbidden
|
|
9369
|
+
*/
|
|
9370
|
+
403: unknown;
|
|
9371
|
+
/**
|
|
9372
|
+
* Dataset not found
|
|
9373
|
+
*/
|
|
9374
|
+
404: unknown;
|
|
9375
|
+
};
|
|
9376
|
+
type ListDatasetItemsResponses = {
|
|
9377
|
+
/**
|
|
9378
|
+
* List of dataset items
|
|
9379
|
+
*/
|
|
9380
|
+
200: {
|
|
9381
|
+
data: Array<DatasetItem>;
|
|
9382
|
+
total: number;
|
|
9383
|
+
limit: number;
|
|
9384
|
+
offset: number;
|
|
9385
|
+
};
|
|
9386
|
+
};
|
|
9387
|
+
type ListDatasetItemsResponse = ListDatasetItemsResponses[keyof ListDatasetItemsResponses];
|
|
9388
|
+
type CreateDatasetItemData = {
|
|
9389
|
+
body: {
|
|
9390
|
+
input: DatasetItemInput;
|
|
8777
9391
|
/**
|
|
8778
|
-
*
|
|
9392
|
+
* Reference answer for exact_match / llm_judge scorers
|
|
8779
9393
|
*/
|
|
8780
|
-
|
|
9394
|
+
expected_output?: string | null;
|
|
8781
9395
|
/**
|
|
8782
|
-
*
|
|
9396
|
+
* Free-form tags, opaque to the platform
|
|
8783
9397
|
*/
|
|
8784
|
-
|
|
9398
|
+
metadata?: {
|
|
9399
|
+
[key: string]: unknown;
|
|
9400
|
+
} | null;
|
|
8785
9401
|
};
|
|
8786
|
-
path
|
|
8787
|
-
query?: {
|
|
9402
|
+
path: {
|
|
8788
9403
|
/**
|
|
8789
|
-
*
|
|
9404
|
+
* Dataset ID
|
|
8790
9405
|
*/
|
|
8791
|
-
|
|
9406
|
+
dataset_id: string;
|
|
8792
9407
|
};
|
|
8793
|
-
|
|
9408
|
+
query?: never;
|
|
9409
|
+
url: '/api/v1/datasets/{dataset_id}/items';
|
|
8794
9410
|
};
|
|
8795
|
-
type
|
|
9411
|
+
type CreateDatasetItemErrors = {
|
|
8796
9412
|
/**
|
|
8797
|
-
*
|
|
9413
|
+
* Bad request (input is not message-shaped)
|
|
8798
9414
|
*/
|
|
8799
|
-
400:
|
|
9415
|
+
400: unknown;
|
|
8800
9416
|
/**
|
|
8801
9417
|
* Unauthorized
|
|
8802
9418
|
*/
|
|
8803
|
-
401:
|
|
9419
|
+
401: unknown;
|
|
8804
9420
|
/**
|
|
8805
9421
|
* Forbidden
|
|
8806
9422
|
*/
|
|
8807
|
-
403:
|
|
9423
|
+
403: unknown;
|
|
8808
9424
|
/**
|
|
8809
|
-
*
|
|
9425
|
+
* Dataset not found
|
|
8810
9426
|
*/
|
|
8811
|
-
|
|
9427
|
+
404: unknown;
|
|
9428
|
+
};
|
|
9429
|
+
type CreateDatasetItemResponses = {
|
|
8812
9430
|
/**
|
|
8813
|
-
*
|
|
9431
|
+
* Dataset item created successfully
|
|
8814
9432
|
*/
|
|
8815
|
-
|
|
9433
|
+
201: DatasetItem;
|
|
8816
9434
|
};
|
|
8817
|
-
type
|
|
8818
|
-
type
|
|
9435
|
+
type CreateDatasetItemResponse = CreateDatasetItemResponses[keyof CreateDatasetItemResponses];
|
|
9436
|
+
type DeleteDatasetItemData = {
|
|
9437
|
+
body?: never;
|
|
9438
|
+
path: {
|
|
9439
|
+
/**
|
|
9440
|
+
* Dataset ID
|
|
9441
|
+
*/
|
|
9442
|
+
dataset_id: string;
|
|
9443
|
+
/**
|
|
9444
|
+
* Dataset item ID
|
|
9445
|
+
*/
|
|
9446
|
+
item_id: string;
|
|
9447
|
+
};
|
|
9448
|
+
query?: never;
|
|
9449
|
+
url: '/api/v1/datasets/{dataset_id}/items/{item_id}';
|
|
9450
|
+
};
|
|
9451
|
+
type DeleteDatasetItemErrors = {
|
|
8819
9452
|
/**
|
|
8820
|
-
*
|
|
9453
|
+
* Unauthorized
|
|
8821
9454
|
*/
|
|
8822
|
-
|
|
9455
|
+
401: unknown;
|
|
8823
9456
|
/**
|
|
8824
|
-
*
|
|
9457
|
+
* Forbidden
|
|
8825
9458
|
*/
|
|
8826
|
-
|
|
9459
|
+
403: unknown;
|
|
9460
|
+
/**
|
|
9461
|
+
* Dataset or item not found
|
|
9462
|
+
*/
|
|
9463
|
+
404: unknown;
|
|
8827
9464
|
};
|
|
8828
|
-
type
|
|
8829
|
-
|
|
8830
|
-
|
|
9465
|
+
type DeleteDatasetItemResponses = {
|
|
9466
|
+
/**
|
|
9467
|
+
* Dataset item deleted successfully
|
|
9468
|
+
*/
|
|
9469
|
+
204: void;
|
|
9470
|
+
};
|
|
9471
|
+
type DeleteDatasetItemResponse = DeleteDatasetItemResponses[keyof DeleteDatasetItemResponses];
|
|
9472
|
+
type UpdateDatasetItemData = {
|
|
9473
|
+
body: {
|
|
9474
|
+
input?: DatasetItemInput;
|
|
9475
|
+
expected_output?: string | null;
|
|
9476
|
+
metadata?: {
|
|
9477
|
+
[key: string]: unknown;
|
|
9478
|
+
} | null;
|
|
9479
|
+
};
|
|
8831
9480
|
path: {
|
|
8832
9481
|
/**
|
|
8833
|
-
*
|
|
9482
|
+
* Dataset ID
|
|
8834
9483
|
*/
|
|
8835
|
-
|
|
9484
|
+
dataset_id: string;
|
|
9485
|
+
/**
|
|
9486
|
+
* Dataset item ID
|
|
9487
|
+
*/
|
|
9488
|
+
item_id: string;
|
|
8836
9489
|
};
|
|
8837
9490
|
query?: never;
|
|
8838
|
-
url: '/api/v1/
|
|
9491
|
+
url: '/api/v1/datasets/{dataset_id}/items/{item_id}';
|
|
8839
9492
|
};
|
|
8840
|
-
type
|
|
9493
|
+
type UpdateDatasetItemErrors = {
|
|
9494
|
+
/**
|
|
9495
|
+
* Bad request
|
|
9496
|
+
*/
|
|
9497
|
+
400: unknown;
|
|
8841
9498
|
/**
|
|
8842
9499
|
* Unauthorized
|
|
8843
9500
|
*/
|
|
8844
|
-
401:
|
|
9501
|
+
401: unknown;
|
|
8845
9502
|
/**
|
|
8846
9503
|
* Forbidden
|
|
8847
9504
|
*/
|
|
8848
|
-
403:
|
|
9505
|
+
403: unknown;
|
|
8849
9506
|
/**
|
|
8850
|
-
*
|
|
9507
|
+
* Dataset or item not found
|
|
8851
9508
|
*/
|
|
8852
|
-
404:
|
|
9509
|
+
404: unknown;
|
|
8853
9510
|
};
|
|
8854
|
-
type
|
|
8855
|
-
type DeleteDocumentResponses = {
|
|
9511
|
+
type UpdateDatasetItemResponses = {
|
|
8856
9512
|
/**
|
|
8857
|
-
*
|
|
9513
|
+
* Dataset item updated successfully
|
|
8858
9514
|
*/
|
|
8859
|
-
|
|
9515
|
+
200: DatasetItem;
|
|
8860
9516
|
};
|
|
8861
|
-
type
|
|
8862
|
-
type
|
|
9517
|
+
type UpdateDatasetItemResponse = UpdateDatasetItemResponses[keyof UpdateDatasetItemResponses];
|
|
9518
|
+
type ListEvalsData = {
|
|
8863
9519
|
body?: never;
|
|
8864
|
-
path
|
|
9520
|
+
path?: never;
|
|
9521
|
+
query?: {
|
|
8865
9522
|
/**
|
|
8866
|
-
*
|
|
9523
|
+
* Project ID (required if not using project key auth)
|
|
8867
9524
|
*/
|
|
8868
|
-
|
|
9525
|
+
project_id?: string;
|
|
9526
|
+
/**
|
|
9527
|
+
* Maximum number of results to return
|
|
9528
|
+
*/
|
|
9529
|
+
limit?: number;
|
|
9530
|
+
/**
|
|
9531
|
+
* Number of results to skip
|
|
9532
|
+
*/
|
|
9533
|
+
offset?: number;
|
|
8869
9534
|
};
|
|
8870
|
-
|
|
8871
|
-
url: '/api/v1/documents/{document_id}';
|
|
9535
|
+
url: '/api/v1/evals';
|
|
8872
9536
|
};
|
|
8873
|
-
type
|
|
9537
|
+
type ListEvalsErrors = {
|
|
8874
9538
|
/**
|
|
8875
9539
|
* Unauthorized
|
|
8876
9540
|
*/
|
|
8877
|
-
401:
|
|
9541
|
+
401: unknown;
|
|
8878
9542
|
/**
|
|
8879
9543
|
* Forbidden
|
|
8880
9544
|
*/
|
|
8881
|
-
403:
|
|
9545
|
+
403: unknown;
|
|
8882
9546
|
/**
|
|
8883
|
-
*
|
|
9547
|
+
* Internal server error
|
|
8884
9548
|
*/
|
|
8885
|
-
|
|
9549
|
+
500: unknown;
|
|
8886
9550
|
};
|
|
8887
|
-
type
|
|
8888
|
-
type GetDocumentResponses = {
|
|
9551
|
+
type ListEvalsResponses = {
|
|
8889
9552
|
/**
|
|
8890
|
-
*
|
|
9553
|
+
* List of evals
|
|
8891
9554
|
*/
|
|
8892
|
-
200:
|
|
9555
|
+
200: {
|
|
9556
|
+
data: Array<Eval>;
|
|
9557
|
+
total: number;
|
|
9558
|
+
limit: number;
|
|
9559
|
+
offset: number;
|
|
9560
|
+
};
|
|
8893
9561
|
};
|
|
8894
|
-
type
|
|
8895
|
-
type
|
|
9562
|
+
type ListEvalsResponse = ListEvalsResponses[keyof ListEvalsResponses];
|
|
9563
|
+
type CreateEvalData = {
|
|
8896
9564
|
body: {
|
|
8897
9565
|
/**
|
|
8898
|
-
*
|
|
9566
|
+
* Project ID (required if not using project key auth)
|
|
8899
9567
|
*/
|
|
8900
|
-
|
|
9568
|
+
project_id?: string;
|
|
8901
9569
|
/**
|
|
8902
|
-
*
|
|
9570
|
+
* Unique name within the project
|
|
8903
9571
|
*/
|
|
8904
|
-
|
|
9572
|
+
name: string;
|
|
8905
9573
|
/**
|
|
8906
|
-
*
|
|
9574
|
+
* The agent under test
|
|
8907
9575
|
*/
|
|
8908
|
-
|
|
9576
|
+
agent_id: string;
|
|
8909
9577
|
/**
|
|
8910
|
-
*
|
|
9578
|
+
* The dataset to run it against
|
|
8911
9579
|
*/
|
|
8912
|
-
|
|
8913
|
-
|
|
8914
|
-
};
|
|
9580
|
+
dataset_id: string;
|
|
9581
|
+
scorers: Scorers;
|
|
8915
9582
|
/**
|
|
8916
|
-
*
|
|
9583
|
+
* 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.
|
|
8917
9584
|
*/
|
|
8918
|
-
|
|
8919
|
-
[key: string]: string;
|
|
8920
|
-
};
|
|
9585
|
+
pass_threshold?: number | null;
|
|
8921
9586
|
};
|
|
9587
|
+
path?: never;
|
|
9588
|
+
query?: never;
|
|
9589
|
+
url: '/api/v1/evals';
|
|
9590
|
+
};
|
|
9591
|
+
type CreateEvalErrors = {
|
|
9592
|
+
/**
|
|
9593
|
+
* Bad request (unknown scorer type, cross-project reference, invalid threshold)
|
|
9594
|
+
*/
|
|
9595
|
+
400: unknown;
|
|
9596
|
+
/**
|
|
9597
|
+
* Unauthorized
|
|
9598
|
+
*/
|
|
9599
|
+
401: unknown;
|
|
9600
|
+
/**
|
|
9601
|
+
* Forbidden
|
|
9602
|
+
*/
|
|
9603
|
+
403: unknown;
|
|
9604
|
+
/**
|
|
9605
|
+
* An eval with that name already exists in the project
|
|
9606
|
+
*/
|
|
9607
|
+
409: unknown;
|
|
9608
|
+
/**
|
|
9609
|
+
* Internal server error
|
|
9610
|
+
*/
|
|
9611
|
+
500: unknown;
|
|
9612
|
+
};
|
|
9613
|
+
type CreateEvalResponses = {
|
|
9614
|
+
/**
|
|
9615
|
+
* Eval created successfully
|
|
9616
|
+
*/
|
|
9617
|
+
201: Eval;
|
|
9618
|
+
};
|
|
9619
|
+
type CreateEvalResponse = CreateEvalResponses[keyof CreateEvalResponses];
|
|
9620
|
+
type DeleteEvalData = {
|
|
9621
|
+
body?: never;
|
|
8922
9622
|
path: {
|
|
8923
9623
|
/**
|
|
8924
|
-
*
|
|
9624
|
+
* Eval ID
|
|
8925
9625
|
*/
|
|
8926
|
-
|
|
9626
|
+
eval_id: string;
|
|
8927
9627
|
};
|
|
8928
9628
|
query?: never;
|
|
8929
|
-
url: '/api/v1/
|
|
9629
|
+
url: '/api/v1/evals/{eval_id}';
|
|
8930
9630
|
};
|
|
8931
|
-
type
|
|
9631
|
+
type DeleteEvalErrors = {
|
|
8932
9632
|
/**
|
|
8933
9633
|
* Unauthorized
|
|
8934
9634
|
*/
|
|
8935
|
-
401:
|
|
9635
|
+
401: unknown;
|
|
8936
9636
|
/**
|
|
8937
9637
|
* Forbidden
|
|
8938
9638
|
*/
|
|
8939
|
-
403:
|
|
9639
|
+
403: unknown;
|
|
8940
9640
|
/**
|
|
8941
|
-
*
|
|
9641
|
+
* Eval not found
|
|
8942
9642
|
*/
|
|
8943
|
-
404:
|
|
9643
|
+
404: unknown;
|
|
8944
9644
|
};
|
|
8945
|
-
type
|
|
8946
|
-
type UpdateDocumentResponses = {
|
|
9645
|
+
type DeleteEvalResponses = {
|
|
8947
9646
|
/**
|
|
8948
|
-
*
|
|
9647
|
+
* Eval deleted successfully
|
|
8949
9648
|
*/
|
|
8950
|
-
|
|
9649
|
+
204: void;
|
|
8951
9650
|
};
|
|
8952
|
-
type
|
|
8953
|
-
type
|
|
9651
|
+
type DeleteEvalResponse = DeleteEvalResponses[keyof DeleteEvalResponses];
|
|
9652
|
+
type GetEvalData = {
|
|
8954
9653
|
body?: never;
|
|
8955
9654
|
path: {
|
|
8956
9655
|
/**
|
|
8957
|
-
*
|
|
9656
|
+
* Eval ID
|
|
8958
9657
|
*/
|
|
8959
|
-
|
|
9658
|
+
eval_id: string;
|
|
8960
9659
|
};
|
|
8961
9660
|
query?: never;
|
|
8962
|
-
url: '/api/v1/
|
|
9661
|
+
url: '/api/v1/evals/{eval_id}';
|
|
8963
9662
|
};
|
|
8964
|
-
type
|
|
9663
|
+
type GetEvalErrors = {
|
|
8965
9664
|
/**
|
|
8966
9665
|
* Unauthorized
|
|
8967
9666
|
*/
|
|
8968
|
-
401:
|
|
9667
|
+
401: unknown;
|
|
8969
9668
|
/**
|
|
8970
9669
|
* Forbidden
|
|
8971
9670
|
*/
|
|
8972
|
-
403:
|
|
9671
|
+
403: unknown;
|
|
8973
9672
|
/**
|
|
8974
|
-
*
|
|
9673
|
+
* Eval not found
|
|
8975
9674
|
*/
|
|
8976
|
-
404:
|
|
9675
|
+
404: unknown;
|
|
8977
9676
|
};
|
|
8978
|
-
type
|
|
8979
|
-
type GetDocumentStatusResponses = {
|
|
9677
|
+
type GetEvalResponses = {
|
|
8980
9678
|
/**
|
|
8981
|
-
*
|
|
9679
|
+
* Eval details
|
|
8982
9680
|
*/
|
|
8983
|
-
200:
|
|
9681
|
+
200: Eval;
|
|
8984
9682
|
};
|
|
8985
|
-
type
|
|
8986
|
-
type
|
|
8987
|
-
body
|
|
8988
|
-
|
|
8989
|
-
|
|
8990
|
-
|
|
8991
|
-
|
|
8992
|
-
|
|
8993
|
-
* Window size in characters when `chunk_strategy=size`. Defaults to 1000.
|
|
8994
|
-
*/
|
|
8995
|
-
chunk_size?: number;
|
|
8996
|
-
/**
|
|
8997
|
-
* Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
|
|
8998
|
-
*/
|
|
8999
|
-
chunk_overlap?: number;
|
|
9683
|
+
type GetEvalResponse = GetEvalResponses[keyof GetEvalResponses];
|
|
9684
|
+
type UpdateEvalData = {
|
|
9685
|
+
body: {
|
|
9686
|
+
name?: string;
|
|
9687
|
+
agent_id?: string;
|
|
9688
|
+
dataset_id?: string;
|
|
9689
|
+
scorers?: Scorers;
|
|
9690
|
+
pass_threshold?: number | null;
|
|
9000
9691
|
};
|
|
9001
9692
|
path: {
|
|
9002
9693
|
/**
|
|
9003
|
-
*
|
|
9004
|
-
*/
|
|
9005
|
-
document_id: string;
|
|
9006
|
-
};
|
|
9007
|
-
query?: {
|
|
9008
|
-
/**
|
|
9009
|
-
* 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`.
|
|
9694
|
+
* Eval ID
|
|
9010
9695
|
*/
|
|
9011
|
-
|
|
9696
|
+
eval_id: string;
|
|
9012
9697
|
};
|
|
9013
|
-
|
|
9698
|
+
query?: never;
|
|
9699
|
+
url: '/api/v1/evals/{eval_id}';
|
|
9014
9700
|
};
|
|
9015
|
-
type
|
|
9701
|
+
type UpdateEvalErrors = {
|
|
9702
|
+
/**
|
|
9703
|
+
* Bad request
|
|
9704
|
+
*/
|
|
9705
|
+
400: unknown;
|
|
9016
9706
|
/**
|
|
9017
9707
|
* Unauthorized
|
|
9018
9708
|
*/
|
|
9019
|
-
401:
|
|
9709
|
+
401: unknown;
|
|
9020
9710
|
/**
|
|
9021
9711
|
* Forbidden
|
|
9022
9712
|
*/
|
|
9023
|
-
403:
|
|
9713
|
+
403: unknown;
|
|
9024
9714
|
/**
|
|
9025
|
-
*
|
|
9715
|
+
* Eval not found
|
|
9026
9716
|
*/
|
|
9027
|
-
404:
|
|
9717
|
+
404: unknown;
|
|
9028
9718
|
/**
|
|
9029
|
-
*
|
|
9719
|
+
* An eval with that name already exists in the project
|
|
9030
9720
|
*/
|
|
9031
|
-
|
|
9721
|
+
409: unknown;
|
|
9032
9722
|
};
|
|
9033
|
-
type
|
|
9034
|
-
type ReingestDocumentResponses = {
|
|
9035
|
-
/**
|
|
9036
|
-
* Re-ingestion completed synchronously (only when `?async=false`).
|
|
9037
|
-
*/
|
|
9038
|
-
201: IngestedDocumentRecord;
|
|
9723
|
+
type UpdateEvalResponses = {
|
|
9039
9724
|
/**
|
|
9040
|
-
*
|
|
9725
|
+
* Eval updated successfully
|
|
9041
9726
|
*/
|
|
9042
|
-
|
|
9727
|
+
200: Eval;
|
|
9043
9728
|
};
|
|
9044
|
-
type
|
|
9045
|
-
type
|
|
9046
|
-
|
|
9047
|
-
* The converter output contract, adapted for a JSON request body: a single page as `{ text }`, or `{ pages: [{ text, page_number }] }` for multiple pages.
|
|
9048
|
-
*/
|
|
9049
|
-
body: {
|
|
9050
|
-
text: string;
|
|
9051
|
-
} | {
|
|
9052
|
-
pages: Array<{
|
|
9053
|
-
text?: string;
|
|
9054
|
-
page_number?: number;
|
|
9055
|
-
}>;
|
|
9056
|
-
};
|
|
9729
|
+
type UpdateEvalResponse = UpdateEvalResponses[keyof UpdateEvalResponses];
|
|
9730
|
+
type ListEvalRunsData = {
|
|
9731
|
+
body?: never;
|
|
9057
9732
|
path: {
|
|
9058
9733
|
/**
|
|
9059
|
-
*
|
|
9734
|
+
* Eval ID
|
|
9060
9735
|
*/
|
|
9061
|
-
|
|
9736
|
+
eval_id: string;
|
|
9062
9737
|
};
|
|
9063
|
-
query
|
|
9738
|
+
query?: {
|
|
9064
9739
|
/**
|
|
9065
|
-
*
|
|
9740
|
+
* Maximum number of results to return
|
|
9741
|
+
*/
|
|
9742
|
+
limit?: number;
|
|
9743
|
+
/**
|
|
9744
|
+
* Number of results to skip
|
|
9066
9745
|
*/
|
|
9067
|
-
|
|
9746
|
+
offset?: number;
|
|
9068
9747
|
};
|
|
9069
|
-
url: '/api/v1/
|
|
9748
|
+
url: '/api/v1/evals/{eval_id}/runs';
|
|
9070
9749
|
};
|
|
9071
|
-
type
|
|
9072
|
-
/**
|
|
9073
|
-
* The token is missing, invalid, or does not match this document.
|
|
9074
|
-
*/
|
|
9075
|
-
401: ErrorResponse;
|
|
9750
|
+
type ListEvalRunsErrors = {
|
|
9076
9751
|
/**
|
|
9077
|
-
*
|
|
9752
|
+
* Unauthorized
|
|
9078
9753
|
*/
|
|
9079
|
-
|
|
9754
|
+
401: unknown;
|
|
9080
9755
|
/**
|
|
9081
|
-
*
|
|
9756
|
+
* Forbidden
|
|
9082
9757
|
*/
|
|
9083
|
-
|
|
9758
|
+
403: unknown;
|
|
9084
9759
|
/**
|
|
9085
|
-
*
|
|
9760
|
+
* Eval not found
|
|
9086
9761
|
*/
|
|
9087
|
-
|
|
9762
|
+
404: unknown;
|
|
9088
9763
|
};
|
|
9089
|
-
type
|
|
9090
|
-
type CompleteIngestionCallbackResponses = {
|
|
9764
|
+
type ListEvalRunsResponses = {
|
|
9091
9765
|
/**
|
|
9092
|
-
*
|
|
9766
|
+
* List of eval runs
|
|
9093
9767
|
*/
|
|
9094
|
-
|
|
9768
|
+
200: {
|
|
9769
|
+
data: Array<EvalRun>;
|
|
9770
|
+
total: number;
|
|
9771
|
+
limit: number;
|
|
9772
|
+
offset: number;
|
|
9773
|
+
};
|
|
9095
9774
|
};
|
|
9096
|
-
type
|
|
9097
|
-
type
|
|
9098
|
-
body
|
|
9775
|
+
type ListEvalRunsResponse = ListEvalRunsResponses[keyof ListEvalRunsResponses];
|
|
9776
|
+
type StartEvalRunData = {
|
|
9777
|
+
body: {
|
|
9778
|
+
/**
|
|
9779
|
+
* 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.
|
|
9780
|
+
*/
|
|
9781
|
+
wait?: boolean;
|
|
9782
|
+
/**
|
|
9783
|
+
* 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.
|
|
9784
|
+
*/
|
|
9785
|
+
agent_version?: number | null;
|
|
9786
|
+
/**
|
|
9787
|
+
* 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.
|
|
9788
|
+
*/
|
|
9789
|
+
baseline_run_id?: string | null;
|
|
9790
|
+
};
|
|
9099
9791
|
path: {
|
|
9100
9792
|
/**
|
|
9101
|
-
*
|
|
9793
|
+
* Eval ID
|
|
9102
9794
|
*/
|
|
9103
|
-
|
|
9795
|
+
eval_id: string;
|
|
9104
9796
|
};
|
|
9105
9797
|
query?: never;
|
|
9106
|
-
url: '/api/v1/
|
|
9798
|
+
url: '/api/v1/evals/{eval_id}/runs';
|
|
9107
9799
|
};
|
|
9108
|
-
type
|
|
9800
|
+
type StartEvalRunErrors = {
|
|
9801
|
+
/**
|
|
9802
|
+
* Bad request (non-boolean wait, dataset empty or over the synchronous cap, unknown agent_version, invalid baseline, scorers no longer valid against the agent)
|
|
9803
|
+
*/
|
|
9804
|
+
400: unknown;
|
|
9109
9805
|
/**
|
|
9110
9806
|
* Unauthorized
|
|
9111
9807
|
*/
|
|
9112
|
-
401:
|
|
9808
|
+
401: unknown;
|
|
9113
9809
|
/**
|
|
9114
9810
|
* Forbidden
|
|
9115
9811
|
*/
|
|
9116
|
-
403:
|
|
9812
|
+
403: unknown;
|
|
9117
9813
|
/**
|
|
9118
|
-
*
|
|
9814
|
+
* Eval not found
|
|
9119
9815
|
*/
|
|
9120
|
-
404:
|
|
9816
|
+
404: unknown;
|
|
9817
|
+
/**
|
|
9818
|
+
* Internal server error
|
|
9819
|
+
*/
|
|
9820
|
+
500: unknown;
|
|
9121
9821
|
};
|
|
9122
|
-
type
|
|
9123
|
-
type GetDocumentTagsResponses = {
|
|
9822
|
+
type StartEvalRunResponses = {
|
|
9124
9823
|
/**
|
|
9125
|
-
*
|
|
9824
|
+
* Eval run finished (`wait: true`) or queued (`wait: false`)
|
|
9126
9825
|
*/
|
|
9127
|
-
|
|
9128
|
-
[key: string]: string;
|
|
9129
|
-
};
|
|
9826
|
+
201: EvalRun;
|
|
9130
9827
|
};
|
|
9131
|
-
type
|
|
9132
|
-
type
|
|
9133
|
-
body
|
|
9134
|
-
[key: string]: string;
|
|
9135
|
-
};
|
|
9828
|
+
type StartEvalRunResponse = StartEvalRunResponses[keyof StartEvalRunResponses];
|
|
9829
|
+
type GetEvalRunData = {
|
|
9830
|
+
body?: never;
|
|
9136
9831
|
path: {
|
|
9137
9832
|
/**
|
|
9138
|
-
*
|
|
9833
|
+
* Eval ID
|
|
9139
9834
|
*/
|
|
9140
|
-
|
|
9835
|
+
eval_id: string;
|
|
9836
|
+
/**
|
|
9837
|
+
* Eval run ID
|
|
9838
|
+
*/
|
|
9839
|
+
eval_run_id: string;
|
|
9141
9840
|
};
|
|
9142
9841
|
query?: never;
|
|
9143
|
-
url: '/api/v1/
|
|
9842
|
+
url: '/api/v1/evals/{eval_id}/runs/{eval_run_id}';
|
|
9144
9843
|
};
|
|
9145
|
-
type
|
|
9844
|
+
type GetEvalRunErrors = {
|
|
9146
9845
|
/**
|
|
9147
9846
|
* Unauthorized
|
|
9148
9847
|
*/
|
|
9149
|
-
401:
|
|
9848
|
+
401: unknown;
|
|
9150
9849
|
/**
|
|
9151
9850
|
* Forbidden
|
|
9152
9851
|
*/
|
|
9153
|
-
403:
|
|
9852
|
+
403: unknown;
|
|
9154
9853
|
/**
|
|
9155
|
-
*
|
|
9854
|
+
* Eval or run not found
|
|
9156
9855
|
*/
|
|
9157
|
-
404:
|
|
9856
|
+
404: unknown;
|
|
9158
9857
|
};
|
|
9159
|
-
type
|
|
9160
|
-
type MergeDocumentTagsResponses = {
|
|
9858
|
+
type GetEvalRunResponses = {
|
|
9161
9859
|
/**
|
|
9162
|
-
*
|
|
9860
|
+
* Eval run details
|
|
9163
9861
|
*/
|
|
9164
|
-
200:
|
|
9165
|
-
[key: string]: string;
|
|
9166
|
-
};
|
|
9862
|
+
200: EvalRun;
|
|
9167
9863
|
};
|
|
9168
|
-
type
|
|
9169
|
-
type
|
|
9170
|
-
body
|
|
9171
|
-
[key: string]: string;
|
|
9172
|
-
};
|
|
9864
|
+
type GetEvalRunResponse = GetEvalRunResponses[keyof GetEvalRunResponses];
|
|
9865
|
+
type ListEvalResultsData = {
|
|
9866
|
+
body?: never;
|
|
9173
9867
|
path: {
|
|
9174
9868
|
/**
|
|
9175
|
-
*
|
|
9869
|
+
* Eval ID
|
|
9176
9870
|
*/
|
|
9177
|
-
|
|
9871
|
+
eval_id: string;
|
|
9872
|
+
/**
|
|
9873
|
+
* Eval run ID
|
|
9874
|
+
*/
|
|
9875
|
+
eval_run_id: string;
|
|
9178
9876
|
};
|
|
9179
|
-
query?:
|
|
9180
|
-
|
|
9877
|
+
query?: {
|
|
9878
|
+
/**
|
|
9879
|
+
* Maximum number of results to return
|
|
9880
|
+
*/
|
|
9881
|
+
limit?: number;
|
|
9882
|
+
/**
|
|
9883
|
+
* Number of results to skip
|
|
9884
|
+
*/
|
|
9885
|
+
offset?: number;
|
|
9886
|
+
};
|
|
9887
|
+
url: '/api/v1/evals/{eval_id}/runs/{eval_run_id}/results';
|
|
9181
9888
|
};
|
|
9182
|
-
type
|
|
9889
|
+
type ListEvalResultsErrors = {
|
|
9183
9890
|
/**
|
|
9184
9891
|
* Unauthorized
|
|
9185
9892
|
*/
|
|
9186
|
-
401:
|
|
9893
|
+
401: unknown;
|
|
9187
9894
|
/**
|
|
9188
9895
|
* Forbidden
|
|
9189
9896
|
*/
|
|
9190
|
-
403:
|
|
9897
|
+
403: unknown;
|
|
9191
9898
|
/**
|
|
9192
|
-
*
|
|
9899
|
+
* Eval or run not found
|
|
9193
9900
|
*/
|
|
9194
|
-
404:
|
|
9901
|
+
404: unknown;
|
|
9195
9902
|
};
|
|
9196
|
-
type
|
|
9197
|
-
type ReplaceDocumentTagsResponses = {
|
|
9903
|
+
type ListEvalResultsResponses = {
|
|
9198
9904
|
/**
|
|
9199
|
-
*
|
|
9905
|
+
* List of eval results
|
|
9200
9906
|
*/
|
|
9201
9907
|
200: {
|
|
9202
|
-
|
|
9908
|
+
data: Array<EvalResult>;
|
|
9909
|
+
total: number;
|
|
9910
|
+
limit: number;
|
|
9911
|
+
offset: number;
|
|
9203
9912
|
};
|
|
9204
9913
|
};
|
|
9205
|
-
type
|
|
9206
|
-
type
|
|
9207
|
-
body
|
|
9914
|
+
type ListEvalResultsResponse = ListEvalResultsResponses[keyof ListEvalResultsResponses];
|
|
9915
|
+
type CancelEvalRunData = {
|
|
9916
|
+
body?: never;
|
|
9917
|
+
path: {
|
|
9208
9918
|
/**
|
|
9209
|
-
*
|
|
9919
|
+
* Eval ID
|
|
9210
9920
|
*/
|
|
9211
|
-
|
|
9921
|
+
eval_id: string;
|
|
9212
9922
|
/**
|
|
9213
|
-
*
|
|
9923
|
+
* Eval run ID
|
|
9214
9924
|
*/
|
|
9215
|
-
|
|
9925
|
+
eval_run_id: string;
|
|
9216
9926
|
};
|
|
9217
|
-
path?: never;
|
|
9218
9927
|
query?: never;
|
|
9219
|
-
url: '/api/v1/
|
|
9928
|
+
url: '/api/v1/evals/{eval_id}/runs/{eval_run_id}/cancel';
|
|
9220
9929
|
};
|
|
9221
|
-
type
|
|
9930
|
+
type CancelEvalRunErrors = {
|
|
9222
9931
|
/**
|
|
9223
|
-
*
|
|
9932
|
+
* The run has already finished
|
|
9224
9933
|
*/
|
|
9225
|
-
400:
|
|
9934
|
+
400: unknown;
|
|
9226
9935
|
/**
|
|
9227
9936
|
* Unauthorized
|
|
9228
9937
|
*/
|
|
9229
|
-
401:
|
|
9938
|
+
401: unknown;
|
|
9230
9939
|
/**
|
|
9231
|
-
*
|
|
9940
|
+
* Forbidden
|
|
9232
9941
|
*/
|
|
9233
|
-
|
|
9942
|
+
403: unknown;
|
|
9943
|
+
/**
|
|
9944
|
+
* Eval or run not found
|
|
9945
|
+
*/
|
|
9946
|
+
404: unknown;
|
|
9947
|
+
/**
|
|
9948
|
+
* Internal server error
|
|
9949
|
+
*/
|
|
9950
|
+
500: unknown;
|
|
9234
9951
|
};
|
|
9235
|
-
type
|
|
9236
|
-
type CreateEmbeddingsResponses = {
|
|
9952
|
+
type CancelEvalRunResponses = {
|
|
9237
9953
|
/**
|
|
9238
|
-
*
|
|
9954
|
+
* Eval run canceled
|
|
9239
9955
|
*/
|
|
9240
|
-
200:
|
|
9956
|
+
200: EvalRun;
|
|
9241
9957
|
};
|
|
9242
|
-
type
|
|
9958
|
+
type CancelEvalRunResponse = CancelEvalRunResponses[keyof CancelEvalRunResponses];
|
|
9243
9959
|
type ListExceptionsData = {
|
|
9244
9960
|
body?: never;
|
|
9245
9961
|
path?: never;
|
|
@@ -9465,7 +10181,7 @@ type CreateFileData = {
|
|
|
9465
10181
|
/**
|
|
9466
10182
|
* File size in bytes
|
|
9467
10183
|
*/
|
|
9468
|
-
size?: number;
|
|
10184
|
+
size?: number | null;
|
|
9469
10185
|
/**
|
|
9470
10186
|
* JSON string with additional metadata
|
|
9471
10187
|
*/
|
|
@@ -9818,7 +10534,7 @@ type DownloadFileBase64Responses = {
|
|
|
9818
10534
|
/**
|
|
9819
10535
|
* File size in bytes
|
|
9820
10536
|
*/
|
|
9821
|
-
size?: number;
|
|
10537
|
+
size?: number | null;
|
|
9822
10538
|
};
|
|
9823
10539
|
};
|
|
9824
10540
|
type DownloadFileBase64Response = DownloadFileBase64Responses[keyof DownloadFileBase64Responses];
|
|
@@ -13391,9 +14107,9 @@ type GenerateSessionResponseData = {
|
|
|
13391
14107
|
};
|
|
13392
14108
|
query?: {
|
|
13393
14109
|
/**
|
|
13394
|
-
* When
|
|
14110
|
+
* 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.
|
|
13395
14111
|
*/
|
|
13396
|
-
|
|
14112
|
+
wait?: boolean;
|
|
13397
14113
|
};
|
|
13398
14114
|
url: '/api/v1/sessions/{session_id}/generate';
|
|
13399
14115
|
};
|
|
@@ -13427,11 +14143,11 @@ type GenerateSessionResponseErrors = {
|
|
|
13427
14143
|
type GenerateSessionResponseError = GenerateSessionResponseErrors[keyof GenerateSessionResponseErrors];
|
|
13428
14144
|
type GenerateSessionResponseResponses = {
|
|
13429
14145
|
/**
|
|
13430
|
-
* Agent reply or requires_action
|
|
14146
|
+
* Agent reply or requires_action (only when `?wait=true`)
|
|
13431
14147
|
*/
|
|
13432
14148
|
200: GenerateSessionResponse;
|
|
13433
14149
|
/**
|
|
13434
|
-
* Generation accepted (
|
|
14150
|
+
* Generation accepted and running in the background (default, when `wait` is omitted or `false`)
|
|
13435
14151
|
*/
|
|
13436
14152
|
202: {
|
|
13437
14153
|
status?: 'accepted';
|
|
@@ -14009,13 +14725,10 @@ type CallToolErrors = {
|
|
|
14009
14725
|
type CallToolError = CallToolErrors[keyof CallToolErrors];
|
|
14010
14726
|
type CallToolResponses = {
|
|
14011
14727
|
/**
|
|
14012
|
-
* The raw output returned by the tool. `null` when the tool produced no output — a `soat` action answering `204 No Content`, for instance.
|
|
14728
|
+
* The raw output returned by the tool — any JSON value (object, array, string, number, boolean). `null` when the tool produced no output — a `soat` action answering `204 No Content`, for instance.
|
|
14013
14729
|
*/
|
|
14014
|
-
200:
|
|
14015
|
-
[key: string]: unknown;
|
|
14016
|
-
} | null;
|
|
14730
|
+
200: unknown;
|
|
14017
14731
|
};
|
|
14018
|
-
type CallToolResponse = CallToolResponses[keyof CallToolResponses];
|
|
14019
14732
|
type ListTracesData = {
|
|
14020
14733
|
body?: never;
|
|
14021
14734
|
path?: never;
|
|
@@ -14169,7 +14882,7 @@ type ListTriggersData = {
|
|
|
14169
14882
|
query?: {
|
|
14170
14883
|
project_id?: string;
|
|
14171
14884
|
type?: 'manual' | 'webhook' | 'schedule';
|
|
14172
|
-
target_type?: 'orchestration' | 'agent' | 'tool';
|
|
14885
|
+
target_type?: 'orchestration' | 'agent' | 'tool' | 'eval';
|
|
14173
14886
|
/**
|
|
14174
14887
|
* Maximum number of results to return
|
|
14175
14888
|
*/
|
|
@@ -15701,7 +16414,7 @@ declare class Agents {
|
|
|
15701
16414
|
/**
|
|
15702
16415
|
* Run an agent generation
|
|
15703
16416
|
*
|
|
15704
|
-
* Sends messages to the agent, resolves its tools, and runs the AI model loop.
|
|
16417
|
+
* 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.
|
|
15705
16418
|
*
|
|
15706
16419
|
*/
|
|
15707
16420
|
static createAgentGeneration<ThrowOnError extends boolean = false>(options: Options<CreateAgentGenerationData, ThrowOnError>): RequestResult<CreateAgentGenerationResponses, CreateAgentGenerationErrors, ThrowOnError>;
|
|
@@ -15753,6 +16466,8 @@ declare class AgentVersions {
|
|
|
15753
16466
|
*
|
|
15754
16467
|
* 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.
|
|
15755
16468
|
*
|
|
16469
|
+
* 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.
|
|
16470
|
+
*
|
|
15756
16471
|
*/
|
|
15757
16472
|
static promoteAgentRelease<ThrowOnError extends boolean = false>(options: Options<PromoteAgentReleaseData, ThrowOnError>): RequestResult<PromoteAgentReleaseResponses, PromoteAgentReleaseErrors, ThrowOnError>;
|
|
15758
16473
|
/**
|
|
@@ -15781,7 +16496,7 @@ declare class AiProviders {
|
|
|
15781
16496
|
*
|
|
15782
16497
|
* Deletes an AI provider configuration.
|
|
15783
16498
|
*
|
|
15784
|
-
* Live references — chats, agents,
|
|
16499
|
+
* 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.
|
|
15785
16500
|
*
|
|
15786
16501
|
*/
|
|
15787
16502
|
static deleteAiProvider<ThrowOnError extends boolean = false>(options: Options<DeleteAiProviderData, ThrowOnError>): RequestResult<DeleteAiProviderResponses, DeleteAiProviderErrors, ThrowOnError>;
|
|
@@ -15994,9 +16709,14 @@ declare class Conversations {
|
|
|
15994
16709
|
* Generate the next message in a conversation
|
|
15995
16710
|
*
|
|
15996
16711
|
* Generates the next message using the specified actor's linked agent or chat.
|
|
15997
|
-
*
|
|
15998
|
-
*
|
|
15999
|
-
*
|
|
16712
|
+
* Background by default: returns `202 Accepted` immediately and the reply
|
|
16713
|
+
* lands as a new ConversationMessage when it completes — poll
|
|
16714
|
+
* `GET /api/v1/conversations/{conversation_id}/messages` for it.
|
|
16715
|
+
* Pass `?wait=true` to block and receive the result inline. On
|
|
16716
|
+
* `completed`, the reply is persisted as a new ConversationMessage
|
|
16717
|
+
* authored by that actor. On `requires_action`, nothing is persisted; the
|
|
16718
|
+
* caller must submit tool outputs via the Agents module and re-invoke
|
|
16719
|
+
* generate — so a flow using client tools should pass `?wait=true`.
|
|
16000
16720
|
*
|
|
16001
16721
|
*/
|
|
16002
16722
|
static generateConversationMessage<ThrowOnError extends boolean = false>(options: Options<GenerateConversationMessageData, ThrowOnError>): RequestResult<GenerateConversationMessageResponses, GenerateConversationMessageErrors, ThrowOnError>;
|
|
@@ -16025,57 +16745,6 @@ declare class Conversations {
|
|
|
16025
16745
|
*/
|
|
16026
16746
|
static replaceConversationTags<ThrowOnError extends boolean = false>(options: Options<ReplaceConversationTagsData, ThrowOnError>): RequestResult<ReplaceConversationTagsResponses, ReplaceConversationTagsErrors, ThrowOnError>;
|
|
16027
16747
|
}
|
|
16028
|
-
declare class Discussions {
|
|
16029
|
-
/**
|
|
16030
|
-
* List discussions
|
|
16031
|
-
*
|
|
16032
|
-
* Returns all discussions the caller has access to. If project_id is provided, returns only discussions in that project.
|
|
16033
|
-
*/
|
|
16034
|
-
static listDiscussions<ThrowOnError extends boolean = false>(options?: Options<ListDiscussionsData, ThrowOnError>): RequestResult<ListDiscussionsResponses, ListDiscussionsErrors, ThrowOnError>;
|
|
16035
|
-
/**
|
|
16036
|
-
* Create a discussion
|
|
16037
|
-
*
|
|
16038
|
-
* Creates a new discussion config. project keys infer the project from the key's scope; JWT callers must supply project_id.
|
|
16039
|
-
*/
|
|
16040
|
-
static createDiscussion<ThrowOnError extends boolean = false>(options: Options<CreateDiscussionData, ThrowOnError>): RequestResult<CreateDiscussionResponses, CreateDiscussionErrors, ThrowOnError>;
|
|
16041
|
-
/**
|
|
16042
|
-
* Get a discussion run by ID
|
|
16043
|
-
*
|
|
16044
|
-
* Returns a single discussion run, including its outcome, transcript conversation, and outcome document.
|
|
16045
|
-
*/
|
|
16046
|
-
static getDiscussionRun<ThrowOnError extends boolean = false>(options: Options<GetDiscussionRunData, ThrowOnError>): RequestResult<GetDiscussionRunResponses, GetDiscussionRunErrors, ThrowOnError>;
|
|
16047
|
-
/**
|
|
16048
|
-
* Delete a discussion
|
|
16049
|
-
*
|
|
16050
|
-
* Deletes a discussion config and its participants.
|
|
16051
|
-
*/
|
|
16052
|
-
static deleteDiscussion<ThrowOnError extends boolean = false>(options: Options<DeleteDiscussionData, ThrowOnError>): RequestResult<DeleteDiscussionResponses, DeleteDiscussionErrors, ThrowOnError>;
|
|
16053
|
-
/**
|
|
16054
|
-
* Get a discussion by ID
|
|
16055
|
-
*
|
|
16056
|
-
* Returns a discussion config with its participants.
|
|
16057
|
-
*/
|
|
16058
|
-
static getDiscussion<ThrowOnError extends boolean = false>(options: Options<GetDiscussionData, ThrowOnError>): RequestResult<GetDiscussionResponses, GetDiscussionErrors, ThrowOnError>;
|
|
16059
|
-
/**
|
|
16060
|
-
* Update a discussion
|
|
16061
|
-
*
|
|
16062
|
-
* Updates a discussion. Providing participants replaces the full set (not merged).
|
|
16063
|
-
*/
|
|
16064
|
-
static updateDiscussion<ThrowOnError extends boolean = false>(options: Options<UpdateDiscussionData, ThrowOnError>): RequestResult<UpdateDiscussionResponses, UpdateDiscussionErrors, ThrowOnError>;
|
|
16065
|
-
/**
|
|
16066
|
-
* List a discussion's runs
|
|
16067
|
-
*
|
|
16068
|
-
* Returns the run history of a discussion, most recent first.
|
|
16069
|
-
*/
|
|
16070
|
-
static listDiscussionRuns<ThrowOnError extends boolean = false>(options: Options<ListDiscussionRunsData, ThrowOnError>): RequestResult<ListDiscussionRunsResponses, ListDiscussionRunsErrors, ThrowOnError>;
|
|
16071
|
-
/**
|
|
16072
|
-
* Invoke a discussion
|
|
16073
|
-
*
|
|
16074
|
-
* 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.
|
|
16075
|
-
*
|
|
16076
|
-
*/
|
|
16077
|
-
static createDiscussionRun<ThrowOnError extends boolean = false>(options: Options<CreateDiscussionRunData, ThrowOnError>): RequestResult<CreateDiscussionRunResponses, CreateDiscussionRunErrors, ThrowOnError>;
|
|
16078
|
-
}
|
|
16079
16748
|
declare class Documents {
|
|
16080
16749
|
/**
|
|
16081
16750
|
* List documents
|
|
@@ -16143,8 +16812,8 @@ declare class Documents {
|
|
|
16143
16812
|
* source file. Existing chunks are discarded and the document is reset to
|
|
16144
16813
|
* `status=pending` before re-processing. Use this to recover a document
|
|
16145
16814
|
* stuck in `processing`/`failed` or to re-chunk with a different strategy
|
|
16146
|
-
* without re-uploading the file.
|
|
16147
|
-
* `?
|
|
16815
|
+
* without re-uploading the file. Background by default (`202`); pass
|
|
16816
|
+
* `?wait=true` to run synchronously (`201`).
|
|
16148
16817
|
*
|
|
16149
16818
|
*/
|
|
16150
16819
|
static reingestDocument<ThrowOnError extends boolean = false>(options: Options<ReingestDocumentData, ThrowOnError>): RequestResult<ReingestDocumentResponses, ReingestDocumentErrors, ThrowOnError>;
|
|
@@ -16193,6 +16862,138 @@ declare class Embeddings {
|
|
|
16193
16862
|
*/
|
|
16194
16863
|
static createEmbeddings<ThrowOnError extends boolean = false>(options: Options<CreateEmbeddingsData, ThrowOnError>): RequestResult<CreateEmbeddingsResponses, CreateEmbeddingsErrors, ThrowOnError>;
|
|
16195
16864
|
}
|
|
16865
|
+
declare class Evaluations {
|
|
16866
|
+
/**
|
|
16867
|
+
* List datasets
|
|
16868
|
+
*
|
|
16869
|
+
* Returns the datasets defined in a project
|
|
16870
|
+
*/
|
|
16871
|
+
static listDatasets<ThrowOnError extends boolean = false>(options?: Options<ListDatasetsData, ThrowOnError>): RequestResult<ListDatasetsResponses, ListDatasetsErrors, ThrowOnError>;
|
|
16872
|
+
/**
|
|
16873
|
+
* Create a dataset
|
|
16874
|
+
*
|
|
16875
|
+
* Creates a project-scoped dataset — a named collection of test cases an eval runs an agent against. Names are unique per project.
|
|
16876
|
+
*
|
|
16877
|
+
* 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.
|
|
16878
|
+
*/
|
|
16879
|
+
static createDataset<ThrowOnError extends boolean = false>(options: Options<CreateDatasetData, ThrowOnError>): RequestResult<CreateDatasetResponses, CreateDatasetErrors, ThrowOnError>;
|
|
16880
|
+
/**
|
|
16881
|
+
* Delete a dataset
|
|
16882
|
+
*
|
|
16883
|
+
* 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.
|
|
16884
|
+
*/
|
|
16885
|
+
static deleteDataset<ThrowOnError extends boolean = false>(options: Options<DeleteDatasetData, ThrowOnError>): RequestResult<DeleteDatasetResponses, DeleteDatasetErrors, ThrowOnError>;
|
|
16886
|
+
/**
|
|
16887
|
+
* Get a dataset
|
|
16888
|
+
*
|
|
16889
|
+
* Returns a specific dataset
|
|
16890
|
+
*/
|
|
16891
|
+
static getDataset<ThrowOnError extends boolean = false>(options: Options<GetDatasetData, ThrowOnError>): RequestResult<GetDatasetResponses, GetDatasetErrors, ThrowOnError>;
|
|
16892
|
+
/**
|
|
16893
|
+
* Update a dataset
|
|
16894
|
+
*
|
|
16895
|
+
* Updates a dataset's name and/or description
|
|
16896
|
+
*/
|
|
16897
|
+
static updateDataset<ThrowOnError extends boolean = false>(options: Options<UpdateDatasetData, ThrowOnError>): RequestResult<UpdateDatasetResponses, UpdateDatasetErrors, ThrowOnError>;
|
|
16898
|
+
/**
|
|
16899
|
+
* List dataset items
|
|
16900
|
+
*
|
|
16901
|
+
* Returns the test cases in a dataset, oldest first
|
|
16902
|
+
*/
|
|
16903
|
+
static listDatasetItems<ThrowOnError extends boolean = false>(options: Options<ListDatasetItemsData, ThrowOnError>): RequestResult<ListDatasetItemsResponses, ListDatasetItemsErrors, ThrowOnError>;
|
|
16904
|
+
/**
|
|
16905
|
+
* Add a dataset item
|
|
16906
|
+
*
|
|
16907
|
+
* Adds one test case. `input` is replayed verbatim as the generation's messages, so it must be a non-empty array of `{ role, content }`.
|
|
16908
|
+
*/
|
|
16909
|
+
static createDatasetItem<ThrowOnError extends boolean = false>(options: Options<CreateDatasetItemData, ThrowOnError>): RequestResult<CreateDatasetItemResponses, CreateDatasetItemErrors, ThrowOnError>;
|
|
16910
|
+
/**
|
|
16911
|
+
* Delete a dataset item
|
|
16912
|
+
*
|
|
16913
|
+
* Deletes a test case. Results of runs that already scored it stay readable; their `dataset_item_id` becomes null.
|
|
16914
|
+
*/
|
|
16915
|
+
static deleteDatasetItem<ThrowOnError extends boolean = false>(options: Options<DeleteDatasetItemData, ThrowOnError>): RequestResult<DeleteDatasetItemResponses, DeleteDatasetItemErrors, ThrowOnError>;
|
|
16916
|
+
/**
|
|
16917
|
+
* Update a dataset item
|
|
16918
|
+
*
|
|
16919
|
+
* Updates a test case. Runs that already scored it are unaffected — each result carries its own frozen copy of the input and expected output.
|
|
16920
|
+
*/
|
|
16921
|
+
static updateDatasetItem<ThrowOnError extends boolean = false>(options: Options<UpdateDatasetItemData, ThrowOnError>): RequestResult<UpdateDatasetItemResponses, UpdateDatasetItemErrors, ThrowOnError>;
|
|
16922
|
+
/**
|
|
16923
|
+
* List evals
|
|
16924
|
+
*
|
|
16925
|
+
* Returns the evals defined in a project
|
|
16926
|
+
*/
|
|
16927
|
+
static listEvals<ThrowOnError extends boolean = false>(options?: Options<ListEvalsData, ThrowOnError>): RequestResult<ListEvalsResponses, ListEvalsErrors, ThrowOnError>;
|
|
16928
|
+
/**
|
|
16929
|
+
* Create an eval
|
|
16930
|
+
*
|
|
16931
|
+
* 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.
|
|
16932
|
+
*
|
|
16933
|
+
* 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.
|
|
16934
|
+
*/
|
|
16935
|
+
static createEval<ThrowOnError extends boolean = false>(options: Options<CreateEvalData, ThrowOnError>): RequestResult<CreateEvalResponses, CreateEvalErrors, ThrowOnError>;
|
|
16936
|
+
/**
|
|
16937
|
+
* Delete an eval
|
|
16938
|
+
*
|
|
16939
|
+
* Deletes an eval, its runs, and their results
|
|
16940
|
+
*/
|
|
16941
|
+
static deleteEval<ThrowOnError extends boolean = false>(options: Options<DeleteEvalData, ThrowOnError>): RequestResult<DeleteEvalResponses, DeleteEvalErrors, ThrowOnError>;
|
|
16942
|
+
/**
|
|
16943
|
+
* Get an eval
|
|
16944
|
+
*
|
|
16945
|
+
* Returns a specific eval
|
|
16946
|
+
*/
|
|
16947
|
+
static getEval<ThrowOnError extends boolean = false>(options: Options<GetEvalData, ThrowOnError>): RequestResult<GetEvalResponses, GetEvalErrors, ThrowOnError>;
|
|
16948
|
+
/**
|
|
16949
|
+
* Update an eval
|
|
16950
|
+
*
|
|
16951
|
+
* 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.
|
|
16952
|
+
*/
|
|
16953
|
+
static updateEval<ThrowOnError extends boolean = false>(options: Options<UpdateEvalData, ThrowOnError>): RequestResult<UpdateEvalResponses, UpdateEvalErrors, ThrowOnError>;
|
|
16954
|
+
/**
|
|
16955
|
+
* List eval runs
|
|
16956
|
+
*
|
|
16957
|
+
* Returns an eval's runs, newest first
|
|
16958
|
+
*/
|
|
16959
|
+
static listEvalRuns<ThrowOnError extends boolean = false>(options: Options<ListEvalRunsData, ThrowOnError>): RequestResult<ListEvalRunsResponses, ListEvalRunsErrors, ThrowOnError>;
|
|
16960
|
+
/**
|
|
16961
|
+
* Start an eval run
|
|
16962
|
+
*
|
|
16963
|
+
* Runs the eval against its dataset, creating one real agent generation per item and scoring the outputs.
|
|
16964
|
+
*
|
|
16965
|
+
* `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.
|
|
16966
|
+
*
|
|
16967
|
+
* `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.
|
|
16968
|
+
*
|
|
16969
|
+
* 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.
|
|
16970
|
+
*
|
|
16971
|
+
* 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.
|
|
16972
|
+
*/
|
|
16973
|
+
static startEvalRun<ThrowOnError extends boolean = false>(options: Options<StartEvalRunData, ThrowOnError>): RequestResult<StartEvalRunResponses, StartEvalRunErrors, ThrowOnError>;
|
|
16974
|
+
/**
|
|
16975
|
+
* Get an eval run
|
|
16976
|
+
*
|
|
16977
|
+
* Returns a run's status, counts, and aggregate scores
|
|
16978
|
+
*/
|
|
16979
|
+
static getEvalRun<ThrowOnError extends boolean = false>(options: Options<GetEvalRunData, ThrowOnError>): RequestResult<GetEvalRunResponses, GetEvalRunErrors, ThrowOnError>;
|
|
16980
|
+
/**
|
|
16981
|
+
* List eval run results
|
|
16982
|
+
*
|
|
16983
|
+
* Returns the per-item results of a run, oldest first
|
|
16984
|
+
*/
|
|
16985
|
+
static listEvalResults<ThrowOnError extends boolean = false>(options: Options<ListEvalResultsData, ThrowOnError>): RequestResult<ListEvalResultsResponses, ListEvalResultsErrors, ThrowOnError>;
|
|
16986
|
+
/**
|
|
16987
|
+
* Cancel an eval run
|
|
16988
|
+
*
|
|
16989
|
+
* Cancels a queued or running run: its outstanding item tasks are dropped so it stops consuming provider budget, and the run settles as `canceled`.
|
|
16990
|
+
*
|
|
16991
|
+
* 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.
|
|
16992
|
+
*
|
|
16993
|
+
* A run that has already finished is rejected with 400.
|
|
16994
|
+
*/
|
|
16995
|
+
static cancelEvalRun<ThrowOnError extends boolean = false>(options: Options<CancelEvalRunData, ThrowOnError>): RequestResult<CancelEvalRunResponses, CancelEvalRunErrors, ThrowOnError>;
|
|
16996
|
+
}
|
|
16196
16997
|
declare class Exceptions {
|
|
16197
16998
|
/**
|
|
16198
16999
|
* List exception items
|
|
@@ -16890,7 +17691,7 @@ declare class Sessions {
|
|
|
16890
17691
|
/**
|
|
16891
17692
|
* Trigger agent generation
|
|
16892
17693
|
*
|
|
16893
|
-
* Triggers the agent to generate a response based on the current conversation.
|
|
17694
|
+
* 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.
|
|
16894
17695
|
*
|
|
16895
17696
|
*/
|
|
16896
17697
|
static generateSessionResponse<ThrowOnError extends boolean = false>(options: Options<GenerateSessionResponseData, ThrowOnError>): RequestResult<GenerateSessionResponseResponses, GenerateSessionResponseErrors, ThrowOnError>;
|
|
@@ -17071,7 +17872,7 @@ declare class Triggers {
|
|
|
17071
17872
|
/**
|
|
17072
17873
|
* Fire a trigger
|
|
17073
17874
|
*
|
|
17074
|
-
* Fires a trigger synchronously and returns the terminal firing record.
|
|
17875
|
+
* 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.
|
|
17075
17876
|
*/
|
|
17076
17877
|
static fireTrigger<ThrowOnError extends boolean = false>(options: Options<FireTriggerData, ThrowOnError>): RequestResult<FireTriggerResponses, FireTriggerErrors, ThrowOnError>;
|
|
17077
17878
|
/**
|
|
@@ -17359,32 +18160,50 @@ interface SoatClientOptions {
|
|
|
17359
18160
|
* the corresponding static class from the generated SDK, so all method
|
|
17360
18161
|
* signatures, types, and return values are identical — the only difference
|
|
17361
18162
|
* is that you never need to supply `client` yourself.
|
|
18163
|
+
*
|
|
18164
|
+
* The list is exhaustive by construction: `NoUnregisteredResource` at the
|
|
18165
|
+
* bottom of this file fails `pnpm typecheck` when a spec adds a resource this
|
|
18166
|
+
* class does not expose.
|
|
17362
18167
|
*/
|
|
17363
18168
|
declare class SoatClient {
|
|
18169
|
+
readonly activity: typeof Activity;
|
|
17364
18170
|
readonly actors: typeof Actors;
|
|
17365
18171
|
readonly agents: typeof Agents;
|
|
18172
|
+
readonly agentVersions: typeof AgentVersions;
|
|
17366
18173
|
readonly aiProviders: typeof AiProviders;
|
|
17367
18174
|
readonly apiKeys: typeof ApiKeys;
|
|
18175
|
+
readonly approvals: typeof Approvals;
|
|
18176
|
+
readonly auditLog: typeof AuditLog;
|
|
17368
18177
|
readonly chats: typeof Chats;
|
|
17369
18178
|
readonly conversations: typeof Conversations;
|
|
17370
18179
|
readonly documents: typeof Documents;
|
|
18180
|
+
readonly embeddings: typeof Embeddings;
|
|
18181
|
+
readonly evaluations: typeof Evaluations;
|
|
18182
|
+
readonly exceptions: typeof Exceptions;
|
|
17371
18183
|
readonly files: typeof Files;
|
|
17372
18184
|
readonly formations: typeof Formations;
|
|
18185
|
+
readonly generations: typeof Generations;
|
|
18186
|
+
readonly guardrails: typeof Guardrails;
|
|
17373
18187
|
readonly ingestionRules: typeof IngestionRules;
|
|
17374
18188
|
readonly knowledge: typeof Knowledge;
|
|
17375
18189
|
readonly memories: typeof Memories;
|
|
17376
18190
|
readonly memoryEntries: typeof MemoryEntries;
|
|
18191
|
+
readonly modelRoutes: typeof ModelRoutes;
|
|
18192
|
+
readonly orchestrations: typeof Orchestrations;
|
|
17377
18193
|
readonly policies: typeof Policies;
|
|
17378
18194
|
readonly projects: typeof Projects;
|
|
18195
|
+
readonly quotas: typeof Quotas;
|
|
17379
18196
|
readonly secrets: typeof Secrets;
|
|
17380
18197
|
readonly sessions: typeof Sessions;
|
|
18198
|
+
readonly tasks: typeof Tasks;
|
|
17381
18199
|
readonly tools: typeof Tools;
|
|
17382
18200
|
readonly traces: typeof Traces;
|
|
17383
18201
|
readonly triggers: typeof Triggers;
|
|
17384
18202
|
readonly usage: typeof Usage;
|
|
17385
18203
|
readonly users: typeof Users;
|
|
17386
18204
|
readonly webhooks: typeof Webhooks;
|
|
18205
|
+
readonly workflows: typeof Workflows;
|
|
17387
18206
|
constructor({ baseUrl, token, headers }?: SoatClientOptions);
|
|
17388
18207
|
}
|
|
17389
18208
|
//#endregion
|
|
17390
|
-
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 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 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 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 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 };
|
|
18209
|
+
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 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 };
|