@zhivex-ai/core 1.18.0 → 1.20.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/README.md +4 -0
- package/dist/agent/approvals.d.ts +7 -0
- package/dist/agent/approvals.d.ts.map +1 -0
- package/dist/agent/approvals.js +97 -0
- package/dist/agent/approvals.js.map +1 -0
- package/dist/agent/cancellation.d.ts +4 -0
- package/dist/agent/cancellation.d.ts.map +1 -0
- package/dist/agent/cancellation.js +69 -0
- package/dist/agent/cancellation.js.map +1 -0
- package/dist/agent/common.d.ts +20 -0
- package/dist/agent/common.d.ts.map +1 -0
- package/dist/agent/common.js +150 -0
- package/dist/agent/common.js.map +1 -0
- package/dist/agent/compaction.d.ts +6 -0
- package/dist/agent/compaction.d.ts.map +1 -0
- package/dist/agent/compaction.js +156 -0
- package/dist/agent/compaction.js.map +1 -0
- package/dist/agent/context.d.ts +58 -0
- package/dist/agent/context.d.ts.map +1 -0
- package/dist/agent/context.js +267 -0
- package/dist/agent/context.js.map +1 -0
- package/dist/agent/definition.d.ts +4 -0
- package/dist/agent/definition.d.ts.map +1 -0
- package/dist/agent/definition.js +35 -0
- package/dist/agent/definition.js.map +1 -0
- package/dist/agent/execution.d.ts +14 -0
- package/dist/agent/execution.d.ts.map +1 -0
- package/dist/agent/execution.js +1062 -0
- package/dist/agent/execution.js.map +1 -0
- package/dist/agent/groups.d.ts +3 -0
- package/dist/agent/groups.d.ts.map +1 -0
- package/dist/agent/groups.js +130 -0
- package/dist/agent/groups.js.map +1 -0
- package/dist/agent/guardrails.d.ts +4 -0
- package/dist/agent/guardrails.d.ts.map +1 -0
- package/dist/agent/guardrails.js +29 -0
- package/dist/agent/guardrails.js.map +1 -0
- package/dist/agent/instance.d.ts +42 -0
- package/dist/agent/instance.d.ts.map +1 -0
- package/dist/agent/instance.js +82 -0
- package/dist/agent/instance.js.map +1 -0
- package/dist/agent/lifecycle.d.ts +31 -0
- package/dist/agent/lifecycle.d.ts.map +1 -0
- package/dist/agent/lifecycle.js +184 -0
- package/dist/agent/lifecycle.js.map +1 -0
- package/dist/agent/state.d.ts +6 -0
- package/dist/agent/state.d.ts.map +1 -0
- package/dist/agent/state.js +119 -0
- package/dist/agent/state.js.map +1 -0
- package/dist/agent/telemetry.d.ts +12 -0
- package/dist/agent/telemetry.d.ts.map +1 -0
- package/dist/agent/telemetry.js +176 -0
- package/dist/agent/telemetry.js.map +1 -0
- package/dist/agent/tool-execution.d.ts +6 -0
- package/dist/agent/tool-execution.d.ts.map +1 -0
- package/dist/agent/tool-execution.js +176 -0
- package/dist/agent/tool-execution.js.map +1 -0
- package/dist/agent-run-view.d.ts +9 -0
- package/dist/agent-run-view.d.ts.map +1 -0
- package/dist/agent-run-view.js +42 -0
- package/dist/agent-run-view.js.map +1 -0
- package/dist/agent-store/file.d.ts +11 -0
- package/dist/agent-store/file.d.ts.map +1 -0
- package/dist/agent-store/file.js +534 -0
- package/dist/agent-store/file.js.map +1 -0
- package/dist/agent-store/memory.d.ts +9 -0
- package/dist/agent-store/memory.d.ts.map +1 -0
- package/dist/agent-store/memory.js +198 -0
- package/dist/agent-store/memory.js.map +1 -0
- package/dist/agent-store/postgres.d.ts +4 -0
- package/dist/agent-store/postgres.d.ts.map +1 -0
- package/dist/agent-store/postgres.js +374 -0
- package/dist/agent-store/postgres.js.map +1 -0
- package/dist/agent-store/shared.d.ts +19 -0
- package/dist/agent-store/shared.d.ts.map +1 -0
- package/dist/agent-store/shared.js +137 -0
- package/dist/agent-store/shared.js.map +1 -0
- package/dist/agent-store/sqlite.d.ts +4 -0
- package/dist/agent-store/sqlite.d.ts.map +1 -0
- package/dist/agent-store/sqlite.js +362 -0
- package/dist/agent-store/sqlite.js.map +1 -0
- package/dist/agent-store.d.ts +5 -21
- package/dist/agent-store.d.ts.map +1 -1
- package/dist/agent-store.js +5 -1588
- package/dist/agent-store.js.map +1 -1
- package/dist/agent.d.ts +6 -57
- package/dist/agent.d.ts.map +1 -1
- package/dist/agent.js +6 -2631
- package/dist/agent.js.map +1 -1
- package/dist/agents-entry.d.ts +19 -0
- package/dist/agents-entry.d.ts.map +1 -0
- package/dist/agents-entry.js +14 -0
- package/dist/agents-entry.js.map +1 -0
- package/dist/api-stability.d.ts.map +1 -1
- package/dist/api-stability.js +1 -0
- package/dist/api-stability.js.map +1 -1
- package/dist/artifact/file.d.ts +6 -0
- package/dist/artifact/file.d.ts.map +1 -0
- package/dist/artifact/file.js +380 -0
- package/dist/artifact/file.js.map +1 -0
- package/dist/artifact/memory.d.ts +3 -0
- package/dist/artifact/memory.d.ts.map +1 -0
- package/dist/artifact/memory.js +80 -0
- package/dist/artifact/memory.js.map +1 -0
- package/dist/artifact/postgres.d.ts +3 -0
- package/dist/artifact/postgres.d.ts.map +1 -0
- package/dist/artifact/postgres.js +283 -0
- package/dist/artifact/postgres.js.map +1 -0
- package/dist/artifact/shared.d.ts +208 -0
- package/dist/artifact/shared.d.ts.map +1 -0
- package/dist/artifact/shared.js +523 -0
- package/dist/artifact/shared.js.map +1 -0
- package/dist/artifact/sqlite.d.ts +3 -0
- package/dist/artifact/sqlite.d.ts.map +1 -0
- package/dist/artifact/sqlite.js +283 -0
- package/dist/artifact/sqlite.js.map +1 -0
- package/dist/artifact.d.ts +6 -186
- package/dist/artifact.d.ts.map +1 -1
- package/dist/artifact.js +6 -1536
- package/dist/artifact.js.map +1 -1
- package/dist/catalog-contracts.d.ts +52 -0
- package/dist/catalog-contracts.d.ts.map +1 -0
- package/dist/catalog-contracts.js +250 -0
- package/dist/catalog-contracts.js.map +1 -0
- package/dist/catalog.d.ts +3 -52
- package/dist/catalog.d.ts.map +1 -1
- package/dist/catalog.js +3 -249
- package/dist/catalog.js.map +1 -1
- package/dist/generate-cache-file.d.ts +11 -0
- package/dist/generate-cache-file.d.ts.map +1 -0
- package/dist/generate-cache-file.js +124 -0
- package/dist/generate-cache-file.js.map +1 -0
- package/dist/generate-text.d.ts +2 -5
- package/dist/generate-text.d.ts.map +1 -1
- package/dist/generate-text.js +6 -18
- package/dist/generate-text.js.map +1 -1
- package/dist/generation-entry.d.ts +6 -0
- package/dist/generation-entry.d.ts.map +1 -0
- package/dist/generation-entry.js +6 -0
- package/dist/generation-entry.js.map +1 -0
- package/dist/image-input.d.ts +4 -0
- package/dist/image-input.d.ts.map +1 -0
- package/dist/image-input.js +26 -0
- package/dist/image-input.js.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/middleware-runtime.d.ts +35 -0
- package/dist/middleware-runtime.d.ts.map +1 -0
- package/dist/middleware-runtime.js +532 -0
- package/dist/middleware-runtime.js.map +1 -0
- package/dist/middleware.d.ts +3 -43
- package/dist/middleware.d.ts.map +1 -1
- package/dist/middleware.js +3 -653
- package/dist/middleware.js.map +1 -1
- package/dist/normalize-messages.d.ts +3 -0
- package/dist/normalize-messages.d.ts.map +1 -0
- package/dist/normalize-messages.js +16 -0
- package/dist/normalize-messages.js.map +1 -0
- package/dist/provider-entry.d.ts +18 -0
- package/dist/provider-entry.d.ts.map +1 -0
- package/dist/provider-entry.js +14 -0
- package/dist/provider-entry.js.map +1 -0
- package/dist/realtime.d.ts +2 -0
- package/dist/realtime.d.ts.map +1 -1
- package/dist/realtime.js +6 -0
- package/dist/realtime.js.map +1 -1
- package/dist/store-key.d.ts +3 -0
- package/dist/store-key.d.ts.map +1 -0
- package/dist/store-key.js +5 -0
- package/dist/store-key.js.map +1 -0
- package/dist/store-security.d.ts +1 -2
- package/dist/store-security.d.ts.map +1 -1
- package/dist/store-security.js +2 -4
- package/dist/store-security.js.map +1 -1
- package/dist/types/agent-state.d.ts +236 -0
- package/dist/types/agent-state.d.ts.map +1 -0
- package/dist/types/agent-state.js +2 -0
- package/dist/types/agent-state.js.map +1 -0
- package/dist/types/agents.d.ts +429 -0
- package/dist/types/agents.d.ts.map +1 -0
- package/dist/types/agents.js +2 -0
- package/dist/types/agents.js.map +1 -0
- package/dist/types/common.d.ts +179 -0
- package/dist/types/common.d.ts.map +1 -0
- package/dist/types/common.js +2 -0
- package/dist/types/common.js.map +1 -0
- package/dist/types/generation.d.ts +109 -0
- package/dist/types/generation.d.ts.map +1 -0
- package/dist/types/generation.js +2 -0
- package/dist/types/generation.js.map +1 -0
- package/dist/types/media-data.d.ts +65 -0
- package/dist/types/media-data.d.ts.map +1 -0
- package/dist/types/media-data.js +2 -0
- package/dist/types/media-data.js.map +1 -0
- package/dist/types/media.d.ts +141 -0
- package/dist/types/media.d.ts.map +1 -0
- package/dist/types/media.js +2 -0
- package/dist/types/media.js.map +1 -0
- package/dist/types/messages.d.ts +84 -0
- package/dist/types/messages.d.ts.map +1 -0
- package/dist/types/messages.js +2 -0
- package/dist/types/messages.js.map +1 -0
- package/dist/types/middleware.d.ts +130 -0
- package/dist/types/middleware.d.ts.map +1 -0
- package/dist/types/middleware.js +2 -0
- package/dist/types/middleware.js.map +1 -0
- package/dist/types/model-tools.d.ts +409 -0
- package/dist/types/model-tools.d.ts.map +1 -0
- package/dist/types/model-tools.js +2 -0
- package/dist/types/model-tools.js.map +1 -0
- package/dist/types/persistence.d.ts +168 -0
- package/dist/types/persistence.d.ts.map +1 -0
- package/dist/types/persistence.js +2 -0
- package/dist/types/persistence.js.map +1 -0
- package/dist/types/provider-resources.d.ts +336 -0
- package/dist/types/provider-resources.d.ts.map +1 -0
- package/dist/types/provider-resources.js +2 -0
- package/dist/types/provider-resources.js.map +1 -0
- package/dist/types/provider.d.ts +23 -0
- package/dist/types/provider.d.ts.map +1 -0
- package/dist/types/provider.js +2 -0
- package/dist/types/provider.js.map +1 -0
- package/dist/types/resource-options.d.ts +88 -0
- package/dist/types/resource-options.d.ts.map +1 -0
- package/dist/types/resource-options.js +2 -0
- package/dist/types/resource-options.js.map +1 -0
- package/dist/types/stream.d.ts +70 -0
- package/dist/types/stream.d.ts.map +1 -0
- package/dist/types/stream.js +2 -0
- package/dist/types/stream.js.map +1 -0
- package/dist/types/ui.d.ts +110 -0
- package/dist/types/ui.d.ts.map +1 -0
- package/dist/types/ui.js +2 -0
- package/dist/types/ui.js.map +1 -0
- package/dist/types.d.ts +16 -2480
- package/dist/types.d.ts.map +1 -1
- package/dist/ui.d.ts.map +1 -1
- package/dist/ui.js +2 -0
- package/dist/ui.js.map +1 -1
- package/dist/workflow-state-service/file.d.ts +5 -0
- package/dist/workflow-state-service/file.d.ts.map +1 -0
- package/dist/workflow-state-service/file.js +142 -0
- package/dist/workflow-state-service/file.js.map +1 -0
- package/dist/workflow-state-service/memory.d.ts +3 -0
- package/dist/workflow-state-service/memory.d.ts.map +1 -0
- package/dist/workflow-state-service/memory.js +27 -0
- package/dist/workflow-state-service/memory.js.map +1 -0
- package/dist/workflow-state-service/postgres.d.ts +4 -0
- package/dist/workflow-state-service/postgres.d.ts.map +1 -0
- package/dist/workflow-state-service/postgres.js +179 -0
- package/dist/workflow-state-service/postgres.js.map +1 -0
- package/dist/workflow-state-service/shared.d.ts +43 -0
- package/dist/workflow-state-service/shared.d.ts.map +1 -0
- package/dist/workflow-state-service/shared.js +107 -0
- package/dist/workflow-state-service/shared.js.map +1 -0
- package/dist/workflow-state-service/sqlite.d.ts +4 -0
- package/dist/workflow-state-service/sqlite.d.ts.map +1 -0
- package/dist/workflow-state-service/sqlite.js +183 -0
- package/dist/workflow-state-service/sqlite.js.map +1 -0
- package/dist/workflow-state-service.d.ts +6 -33
- package/dist/workflow-state-service.d.ts.map +1 -1
- package/dist/workflow-state-service.js +6 -626
- package/dist/workflow-state-service.js.map +1 -1
- package/package.json +17 -1
package/dist/types.d.ts
CHANGED
|
@@ -1,2481 +1,17 @@
|
|
|
1
|
-
|
|
2
|
-
export type
|
|
3
|
-
export type
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
export type
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
export type
|
|
10
|
-
export type
|
|
11
|
-
export type
|
|
12
|
-
export
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
reasoningTokens?: number;
|
|
18
|
-
totalTokens?: number;
|
|
19
|
-
speed?: "standard" | "fast";
|
|
20
|
-
}
|
|
21
|
-
export interface ToolCall {
|
|
22
|
-
id: string;
|
|
23
|
-
name: string;
|
|
24
|
-
input: JsonValue;
|
|
25
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
26
|
-
}
|
|
27
|
-
export interface ToolExecutionResult {
|
|
28
|
-
toolCallId: string;
|
|
29
|
-
toolName: string;
|
|
30
|
-
output?: JsonValue;
|
|
31
|
-
error?: {
|
|
32
|
-
message: string;
|
|
33
|
-
code?: "TOOL_INPUT_VALIDATION_ERROR" | "TOOL_NOT_REGISTERED" | "TOOL_BATCH_NOT_EXECUTED";
|
|
34
|
-
issues?: Array<{
|
|
35
|
-
code: string;
|
|
36
|
-
path: Array<string | number>;
|
|
37
|
-
}>;
|
|
38
|
-
};
|
|
39
|
-
isError: boolean;
|
|
40
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
41
|
-
}
|
|
42
|
-
export type ToolChoice = "auto" | "none" | "required" | {
|
|
43
|
-
type: "tool";
|
|
44
|
-
toolName: string;
|
|
45
|
-
};
|
|
46
|
-
export interface TextPart {
|
|
47
|
-
type: "text";
|
|
48
|
-
text: string;
|
|
49
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
50
|
-
}
|
|
51
|
-
export interface ImagePart {
|
|
52
|
-
type: "image";
|
|
53
|
-
image: string;
|
|
54
|
-
mediaType?: string;
|
|
55
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
56
|
-
}
|
|
57
|
-
export interface AudioPart {
|
|
58
|
-
type: "audio";
|
|
59
|
-
data: string | Uint8Array | ArrayBuffer;
|
|
60
|
-
mediaType: string;
|
|
61
|
-
filename?: string;
|
|
62
|
-
format?: string;
|
|
63
|
-
transcript?: string;
|
|
64
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
65
|
-
}
|
|
66
|
-
export interface FilePart {
|
|
67
|
-
type: "file";
|
|
68
|
-
data: string;
|
|
69
|
-
mediaType: string;
|
|
70
|
-
filename?: string;
|
|
71
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
72
|
-
}
|
|
73
|
-
export interface ToolCallPart {
|
|
74
|
-
type: "tool-call";
|
|
75
|
-
toolCall: ToolCall;
|
|
76
|
-
}
|
|
77
|
-
export interface ToolResultPart {
|
|
78
|
-
type: "tool-result";
|
|
79
|
-
toolResult: ToolExecutionResult;
|
|
80
|
-
}
|
|
81
|
-
export interface ProviderDataPart {
|
|
82
|
-
type: "provider-data";
|
|
83
|
-
provider: string;
|
|
84
|
-
data: JsonValue;
|
|
85
|
-
}
|
|
86
|
-
export type ContentPart = TextPart | ImagePart | AudioPart | FilePart | ToolCallPart | ToolResultPart | ProviderDataPart;
|
|
87
|
-
export interface ModelMessage {
|
|
88
|
-
role: MessageRole;
|
|
89
|
-
parts: ContentPart[];
|
|
90
|
-
}
|
|
91
|
-
export interface ModelCapabilities {
|
|
92
|
-
/** Preserves complete callable tool history, including multiple results and error state.
|
|
93
|
-
* json adapters must honor ModelGenerateInput.toolResultFormat = "envelope".
|
|
94
|
-
*/
|
|
95
|
-
toolHistory?: "native" | "json";
|
|
96
|
-
streaming: boolean;
|
|
97
|
-
tools: boolean;
|
|
98
|
-
structuredOutput: boolean;
|
|
99
|
-
jsonMode: boolean;
|
|
100
|
-
toolChoice: boolean;
|
|
101
|
-
parallelToolCalls: boolean;
|
|
102
|
-
vision: boolean;
|
|
103
|
-
files: boolean;
|
|
104
|
-
audioInput: boolean;
|
|
105
|
-
audioOutput: boolean;
|
|
106
|
-
embeddings: boolean;
|
|
107
|
-
imageGeneration?: boolean;
|
|
108
|
-
videoGeneration?: boolean;
|
|
109
|
-
musicGeneration?: boolean;
|
|
110
|
-
fileSearch?: boolean;
|
|
111
|
-
urlContext?: boolean;
|
|
112
|
-
contextCaching?: boolean;
|
|
113
|
-
explicitPromptCaching?: boolean;
|
|
114
|
-
batch?: boolean;
|
|
115
|
-
interactions?: boolean;
|
|
116
|
-
rawPrediction?: boolean;
|
|
117
|
-
reasoningEfforts?: Array<NonNullable<ReasoningConfig["effort"]>>;
|
|
118
|
-
reasoningModes?: Array<NonNullable<ReasoningConfig["mode"]>>;
|
|
119
|
-
reasoningContexts?: Array<NonNullable<ReasoningConfig["context"]>>;
|
|
120
|
-
computerUse?: boolean;
|
|
121
|
-
reasoning: boolean;
|
|
122
|
-
webSearch: boolean;
|
|
123
|
-
realtime?: {
|
|
124
|
-
sessions: boolean;
|
|
125
|
-
audioInput: boolean;
|
|
126
|
-
audioOutput: boolean;
|
|
127
|
-
imageInput: boolean;
|
|
128
|
-
tools: boolean;
|
|
129
|
-
browserTokens: boolean;
|
|
130
|
-
/** Continuous speech without authoritative response/turn completion events. */
|
|
131
|
-
fullDuplex?: boolean;
|
|
132
|
-
clientDelegation?: boolean;
|
|
133
|
-
};
|
|
134
|
-
agentCapabilities?: AgentCapabilities;
|
|
135
|
-
}
|
|
136
|
-
export interface AgentCapabilities {
|
|
137
|
-
supportTier: AgentSupportTier;
|
|
138
|
-
toolChoiceNone: boolean;
|
|
139
|
-
approvalRequests: boolean;
|
|
140
|
-
hostedWebSearch: boolean;
|
|
141
|
-
hostedFileSearch: boolean;
|
|
142
|
-
remoteMcp: boolean;
|
|
143
|
-
computerUse: boolean;
|
|
144
|
-
codeExecution: boolean;
|
|
145
|
-
shell?: boolean;
|
|
146
|
-
applyPatch?: boolean;
|
|
147
|
-
toolSearch?: boolean;
|
|
148
|
-
webExtraction?: boolean;
|
|
149
|
-
skills?: boolean;
|
|
150
|
-
programmaticToolCalling?: boolean;
|
|
151
|
-
multiAgent?: boolean;
|
|
152
|
-
toolsets: boolean;
|
|
153
|
-
}
|
|
154
|
-
export type AgentSupportTier = "tier-a" | "tier-b" | "tier-c";
|
|
155
|
-
export interface RetryOptions {
|
|
156
|
-
abortSignal?: AbortSignal;
|
|
157
|
-
timeoutMs?: number;
|
|
158
|
-
maxRetries?: number;
|
|
159
|
-
retryBackoffMs?: number;
|
|
160
|
-
}
|
|
161
|
-
export interface ToolExecutionOptions {
|
|
162
|
-
parallel?: boolean;
|
|
163
|
-
/** Only explicitly independent ordinary tools may overlap; all others form serial barriers. */
|
|
164
|
-
independentOnly?: boolean;
|
|
165
|
-
maxConcurrency?: number;
|
|
166
|
-
timeoutMs?: number;
|
|
167
|
-
stopOnError?: boolean;
|
|
168
|
-
/** Return sanitized schema errors to the model; strict rejection is the default. maxSteps bounds corrections. */
|
|
169
|
-
validationErrorMode?: "throw" | "tool-result";
|
|
170
|
-
/** Recover only names absent from the exact registry; never resolves aliases or bypasses availability. */
|
|
171
|
-
unknownToolMode?: "throw" | "tool-result";
|
|
172
|
-
}
|
|
173
|
-
export type ToolApprovalMode = "policy" | "interrupt";
|
|
174
|
-
export interface ToolApprovalSigner {
|
|
175
|
-
sign(payload: string): string | Promise<string>;
|
|
176
|
-
verify?(payload: string, signature: string): boolean | Promise<boolean>;
|
|
177
|
-
}
|
|
178
|
-
export interface ToolGuardrailTrigger {
|
|
179
|
-
triggered: true;
|
|
180
|
-
reason?: string;
|
|
181
|
-
metadata?: Record<string, JsonValue>;
|
|
182
|
-
}
|
|
183
|
-
export interface ToolRuntimeContext<TContext = any> {
|
|
184
|
-
context?: TContext;
|
|
185
|
-
/** Durable run that owns this execution, when invoked by the agent runtime. */
|
|
186
|
-
runId?: string;
|
|
187
|
-
agentId?: string;
|
|
188
|
-
/** Human-readable, low-cardinality agent name used for telemetry. */
|
|
189
|
-
agentName?: string;
|
|
190
|
-
scope?: AgentStoreScope;
|
|
191
|
-
metadata?: Record<string, JsonValue>;
|
|
192
|
-
/** Acquired execution boundary for this run. Callbacks and secrets are never persisted. */
|
|
193
|
-
executionEnvironment?: AgentExecutionEnvironmentSession<TContext>;
|
|
194
|
-
}
|
|
195
|
-
export type AgentExecutionEnvironmentBackend = "host" | "process" | "container" | "microvm" | "remote" | "custom";
|
|
196
|
-
export interface AgentExecutionEnvironmentManifest {
|
|
197
|
-
schemaVersion: 1;
|
|
198
|
-
id: string;
|
|
199
|
-
version?: string;
|
|
200
|
-
backend: AgentExecutionEnvironmentBackend;
|
|
201
|
-
assurance: "best-effort" | "enforced";
|
|
202
|
-
isolation: "shared" | "per-run" | "per-tool-call";
|
|
203
|
-
workspace?: {
|
|
204
|
-
id?: string;
|
|
205
|
-
root: string;
|
|
206
|
-
cwd?: string;
|
|
207
|
-
access: "read-only" | "read-write";
|
|
208
|
-
followSymlinks?: boolean;
|
|
209
|
-
readablePaths?: string[];
|
|
210
|
-
writablePaths?: string[];
|
|
211
|
-
};
|
|
212
|
-
permissions?: {
|
|
213
|
-
undeclaredTools?: "allow" | "deny";
|
|
214
|
-
filesystem?: "deny" | "read-only" | "read-write";
|
|
215
|
-
network?: {
|
|
216
|
-
mode: "deny" | "allowlist";
|
|
217
|
-
allowedDomains?: string[];
|
|
218
|
-
allowedPorts?: number[];
|
|
219
|
-
allowPrivateNetworks?: boolean;
|
|
220
|
-
};
|
|
221
|
-
process?: {
|
|
222
|
-
shell: "deny" | "allowlist" | "allow";
|
|
223
|
-
allowedCommands?: string[];
|
|
224
|
-
};
|
|
225
|
-
environment?: {
|
|
226
|
-
inheritedVariables?: string[];
|
|
227
|
-
};
|
|
228
|
-
};
|
|
229
|
-
limits?: {
|
|
230
|
-
maxProcessRuntimeMs?: number;
|
|
231
|
-
maxProcessOutputBytes?: number;
|
|
232
|
-
maxConcurrentProcesses?: number;
|
|
233
|
-
maxMemoryMb?: number;
|
|
234
|
-
maxWorkspaceBytes?: number;
|
|
235
|
-
maxFileWriteBytes?: number;
|
|
236
|
-
maxNetworkRequests?: number;
|
|
237
|
-
maxNetworkBytes?: number;
|
|
238
|
-
};
|
|
239
|
-
metadata?: Record<string, JsonValue>;
|
|
240
|
-
}
|
|
241
|
-
export interface AgentExecutionEnvironmentBinding {
|
|
242
|
-
environmentId: string;
|
|
243
|
-
environmentVersion?: string;
|
|
244
|
-
fingerprint: string;
|
|
245
|
-
workspaceId?: string;
|
|
246
|
-
}
|
|
247
|
-
export interface AgentExecutionEnvironmentAcquireRequest<TContext = any> {
|
|
248
|
-
runId: string;
|
|
249
|
-
agentId?: string;
|
|
250
|
-
scope?: AgentStoreScope;
|
|
251
|
-
context?: TContext;
|
|
252
|
-
metadata?: Record<string, JsonValue>;
|
|
253
|
-
abortSignal?: AbortSignal;
|
|
254
|
-
}
|
|
255
|
-
export interface AgentExecutionAuthorizationRequest<TContext = any> {
|
|
256
|
-
manifest: AgentExecutionEnvironmentManifest;
|
|
257
|
-
binding: AgentExecutionEnvironmentBinding;
|
|
258
|
-
tool: ToolDefinition;
|
|
259
|
-
toolCall: ToolCall;
|
|
260
|
-
input: unknown;
|
|
261
|
-
context: ToolExecutionContext<TContext>;
|
|
262
|
-
phase: "preflight" | "execute";
|
|
263
|
-
}
|
|
264
|
-
export type AgentExecutionAuthorizationDecision = {
|
|
265
|
-
decision: "allow";
|
|
266
|
-
metadata?: Record<string, JsonValue>;
|
|
267
|
-
} | {
|
|
268
|
-
decision: "deny";
|
|
269
|
-
reason: string;
|
|
270
|
-
metadata?: Record<string, JsonValue>;
|
|
271
|
-
};
|
|
272
|
-
export interface AgentExecutionEnvironmentSession<TContext = any> {
|
|
273
|
-
readonly manifest: AgentExecutionEnvironmentManifest;
|
|
274
|
-
readonly binding: AgentExecutionEnvironmentBinding;
|
|
275
|
-
authorize(request: AgentExecutionAuthorizationRequest<TContext>): AgentExecutionAuthorizationDecision | Promise<AgentExecutionAuthorizationDecision>;
|
|
276
|
-
execute<TResult>(request: AgentExecutionAuthorizationRequest<TContext>, operation: () => TResult | Promise<TResult>): TResult | Promise<TResult>;
|
|
277
|
-
release?(result: {
|
|
278
|
-
status: AgentStatus;
|
|
279
|
-
error?: {
|
|
280
|
-
message: string;
|
|
281
|
-
};
|
|
282
|
-
}): void | Promise<void>;
|
|
283
|
-
}
|
|
284
|
-
export interface AgentExecutionEnvironment<TContext = any> {
|
|
285
|
-
readonly manifest: AgentExecutionEnvironmentManifest;
|
|
286
|
-
acquire(request: AgentExecutionEnvironmentAcquireRequest<TContext>): AgentExecutionEnvironmentSession<TContext> | Promise<AgentExecutionEnvironmentSession<TContext>>;
|
|
287
|
-
}
|
|
288
|
-
export interface StructuredOutputConfig<TSchema extends ZodTypeAny = ZodTypeAny> {
|
|
289
|
-
schema: TSchema;
|
|
290
|
-
mode: StructuredOutputMode;
|
|
291
|
-
name?: string;
|
|
292
|
-
description?: string;
|
|
293
|
-
}
|
|
294
|
-
export interface ReasoningConfig {
|
|
295
|
-
effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max";
|
|
296
|
-
mode?: "standard" | "pro";
|
|
297
|
-
context?: "auto" | "current_turn" | "all_turns";
|
|
298
|
-
budgetTokens?: number;
|
|
299
|
-
includeThoughts?: boolean;
|
|
300
|
-
}
|
|
301
|
-
export interface StreamTextDeltaEvent {
|
|
302
|
-
type: "text-delta";
|
|
303
|
-
textDelta: string;
|
|
304
|
-
}
|
|
305
|
-
export interface StreamToolCallEvent {
|
|
306
|
-
type: "tool-call";
|
|
307
|
-
toolCall: ToolCall;
|
|
308
|
-
}
|
|
309
|
-
export interface StreamToolResultEvent {
|
|
310
|
-
type: "tool-result";
|
|
311
|
-
toolResult: ToolExecutionResult;
|
|
312
|
-
}
|
|
313
|
-
export interface StreamToolApprovalRequestEvent {
|
|
314
|
-
type: "tool-approval-request";
|
|
315
|
-
approval: AgentApprovalRequest;
|
|
316
|
-
}
|
|
317
|
-
export interface StreamProviderDataEvent {
|
|
318
|
-
type: "provider-data";
|
|
319
|
-
provider: string;
|
|
320
|
-
data: JsonValue;
|
|
321
|
-
}
|
|
322
|
-
export interface StreamImageGenerationEvent {
|
|
323
|
-
type: "image-generation";
|
|
324
|
-
provider: string;
|
|
325
|
-
image: GeneratedMedia;
|
|
326
|
-
partial: boolean;
|
|
327
|
-
id?: string;
|
|
328
|
-
index?: number;
|
|
329
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
330
|
-
}
|
|
331
|
-
export interface StreamFinishEvent {
|
|
332
|
-
type: "finish";
|
|
333
|
-
finishReason?: FinishReason;
|
|
334
|
-
providerFinishReason?: string;
|
|
335
|
-
usage?: TokenUsage;
|
|
336
|
-
}
|
|
337
|
-
export interface StreamErrorEvent {
|
|
338
|
-
type: "error";
|
|
339
|
-
error: Error;
|
|
340
|
-
}
|
|
341
|
-
export type StreamEvent = StreamTextDeltaEvent | StreamToolCallEvent | StreamToolResultEvent | StreamToolApprovalRequestEvent | StreamProviderDataEvent | StreamImageGenerationEvent | StreamFinishEvent | StreamErrorEvent;
|
|
342
|
-
export interface AgentRunStartEvent {
|
|
343
|
-
type: "agent-run-start";
|
|
344
|
-
currentStep: number;
|
|
345
|
-
maxSteps: number;
|
|
346
|
-
}
|
|
347
|
-
export interface AgentStepStartEvent {
|
|
348
|
-
type: "agent-step-start";
|
|
349
|
-
stepIndex: number;
|
|
350
|
-
}
|
|
351
|
-
export interface AgentStepFinishEvent {
|
|
352
|
-
type: "agent-step-finish";
|
|
353
|
-
step: AgentStep;
|
|
354
|
-
}
|
|
355
|
-
export interface AgentApprovalRequestEvent {
|
|
356
|
-
type: "agent-approval-request";
|
|
357
|
-
approval: AgentApprovalRequest;
|
|
358
|
-
}
|
|
359
|
-
export interface AgentApprovalResolvedEvent {
|
|
360
|
-
type: "agent-approval-resolved";
|
|
361
|
-
approval: AgentApprovalResponse;
|
|
362
|
-
}
|
|
363
|
-
export interface AgentCompactionEvent {
|
|
364
|
-
type: "agent-compaction";
|
|
365
|
-
compaction: AgentCompactionRecord;
|
|
366
|
-
}
|
|
367
|
-
export interface AgentRunFinishEvent {
|
|
368
|
-
type: "agent-run-finish";
|
|
369
|
-
status: AgentStatus;
|
|
370
|
-
state: AgentRunState;
|
|
371
|
-
}
|
|
372
|
-
export type AgentStreamEvent = StreamEvent | AgentRunStartEvent | AgentStepStartEvent | AgentStepFinishEvent | AgentApprovalRequestEvent | AgentApprovalResolvedEvent | AgentCompactionEvent | AgentRunFinishEvent;
|
|
373
|
-
export interface StreamObjectDeltaEvent {
|
|
374
|
-
type: "object-delta";
|
|
375
|
-
textDelta: string;
|
|
376
|
-
partialText: string;
|
|
377
|
-
}
|
|
378
|
-
export interface StreamObjectPartialEvent<TObject = PartialJsonValue> {
|
|
379
|
-
type: "object-partial";
|
|
380
|
-
partialObject: TObject;
|
|
381
|
-
}
|
|
382
|
-
export interface StreamObjectCompleteEvent<TObject = JsonValue> {
|
|
383
|
-
type: "object-complete";
|
|
384
|
-
object: TObject;
|
|
385
|
-
}
|
|
386
|
-
export type ObjectStreamEvent<TObject = JsonValue, TPartialObject = PartialJsonValue> = StreamEvent | StreamObjectDeltaEvent | StreamObjectPartialEvent<TPartialObject> | StreamObjectCompleteEvent<TObject>;
|
|
387
|
-
export interface GenerateResult {
|
|
388
|
-
message?: ModelMessage;
|
|
389
|
-
messages?: ModelMessage[];
|
|
390
|
-
text?: string;
|
|
391
|
-
audio?: GeneratedMedia[];
|
|
392
|
-
images?: GeneratedMedia[];
|
|
393
|
-
finishReason?: FinishReason;
|
|
394
|
-
providerFinishReason?: string;
|
|
395
|
-
usage?: TokenUsage;
|
|
396
|
-
rawResponse?: unknown;
|
|
397
|
-
}
|
|
398
|
-
export interface EmbedResult {
|
|
399
|
-
embeddings: number[][];
|
|
400
|
-
usage?: TokenUsage;
|
|
401
|
-
rawResponse?: unknown;
|
|
402
|
-
}
|
|
403
|
-
export interface AudioInput {
|
|
404
|
-
data: string | Uint8Array | ArrayBuffer;
|
|
405
|
-
mediaType: string;
|
|
406
|
-
filename?: string;
|
|
407
|
-
}
|
|
408
|
-
export interface MediaInput {
|
|
409
|
-
data?: string | Uint8Array | ArrayBuffer;
|
|
410
|
-
uri?: string;
|
|
411
|
-
mediaType: string;
|
|
412
|
-
filename?: string;
|
|
413
|
-
providerMetadata?: Record<string, unknown>;
|
|
414
|
-
}
|
|
415
|
-
export type EmbedValue = string | MediaInput;
|
|
416
|
-
export interface GeneratedMedia {
|
|
417
|
-
data?: Uint8Array;
|
|
418
|
-
uri?: string;
|
|
419
|
-
mediaType: string;
|
|
420
|
-
text?: string;
|
|
421
|
-
providerMetadata?: Record<string, unknown>;
|
|
422
|
-
}
|
|
423
|
-
export interface TranscriptionResult {
|
|
424
|
-
text: string;
|
|
425
|
-
rawResponse?: unknown;
|
|
426
|
-
}
|
|
427
|
-
export interface SpeechResult {
|
|
428
|
-
audio: Uint8Array;
|
|
429
|
-
mediaType: string;
|
|
430
|
-
rawResponse?: unknown;
|
|
431
|
-
}
|
|
432
|
-
export interface ImageGenerationResult {
|
|
433
|
-
images: GeneratedMedia[];
|
|
434
|
-
text?: string;
|
|
435
|
-
rawResponse?: unknown;
|
|
436
|
-
}
|
|
437
|
-
export interface VideoGenerationResult {
|
|
438
|
-
videos: GeneratedMedia[];
|
|
439
|
-
operationName?: string;
|
|
440
|
-
rawResponse?: unknown;
|
|
441
|
-
}
|
|
442
|
-
export interface MusicGenerationResult {
|
|
443
|
-
audio: GeneratedMedia[];
|
|
444
|
-
text?: string;
|
|
445
|
-
rawResponse?: unknown;
|
|
446
|
-
}
|
|
447
|
-
export interface UploadedFile {
|
|
448
|
-
name: string;
|
|
449
|
-
uri?: string;
|
|
450
|
-
mimeType?: string;
|
|
451
|
-
sizeBytes?: string | number;
|
|
452
|
-
state?: string;
|
|
453
|
-
displayName?: string;
|
|
454
|
-
rawResponse?: unknown;
|
|
455
|
-
providerMetadata?: Record<string, unknown>;
|
|
456
|
-
}
|
|
457
|
-
export interface FileSearchStore {
|
|
458
|
-
name: string;
|
|
459
|
-
displayName?: string;
|
|
460
|
-
createTime?: string;
|
|
461
|
-
updateTime?: string;
|
|
462
|
-
rawResponse?: unknown;
|
|
463
|
-
providerMetadata?: Record<string, unknown>;
|
|
464
|
-
}
|
|
465
|
-
export interface CachedContent {
|
|
466
|
-
name: string;
|
|
467
|
-
model?: string;
|
|
468
|
-
displayName?: string;
|
|
469
|
-
createTime?: string;
|
|
470
|
-
updateTime?: string;
|
|
471
|
-
expireTime?: string;
|
|
472
|
-
usageMetadata?: Record<string, unknown>;
|
|
473
|
-
rawResponse?: unknown;
|
|
474
|
-
providerMetadata?: Record<string, unknown>;
|
|
475
|
-
}
|
|
476
|
-
export interface BatchJob {
|
|
477
|
-
name: string;
|
|
478
|
-
model?: string;
|
|
479
|
-
state?: string;
|
|
480
|
-
done?: boolean;
|
|
481
|
-
createTime?: string;
|
|
482
|
-
updateTime?: string;
|
|
483
|
-
rawResponse?: unknown;
|
|
484
|
-
providerMetadata?: Record<string, unknown>;
|
|
485
|
-
}
|
|
486
|
-
export type InteractionStatus = "in_progress" | "requires_action" | "completed" | "failed" | "cancelled" | "incomplete" | "budget_exceeded" | (string & {});
|
|
487
|
-
/**
|
|
488
|
-
* A raw content block returned by an interaction step.
|
|
489
|
-
*
|
|
490
|
-
* Provider field names are intentionally preserved so steps can be sent back
|
|
491
|
-
* unchanged when callers manage stateless interaction history.
|
|
492
|
-
*/
|
|
493
|
-
export interface InteractionContent {
|
|
494
|
-
type: string;
|
|
495
|
-
text?: string;
|
|
496
|
-
data?: string;
|
|
497
|
-
uri?: string;
|
|
498
|
-
mime_type?: string;
|
|
499
|
-
[key: string]: unknown;
|
|
500
|
-
}
|
|
501
|
-
/** A chronological step returned by the Interactions API. */
|
|
502
|
-
export interface InteractionStep {
|
|
503
|
-
type: string;
|
|
504
|
-
id?: string;
|
|
505
|
-
name?: string;
|
|
506
|
-
arguments?: JsonValue;
|
|
507
|
-
call_id?: string;
|
|
508
|
-
content?: InteractionContent[];
|
|
509
|
-
result?: InteractionContent[] | JsonValue;
|
|
510
|
-
signature?: string;
|
|
511
|
-
summary?: InteractionContent[];
|
|
512
|
-
status?: string;
|
|
513
|
-
[key: string]: unknown;
|
|
514
|
-
}
|
|
515
|
-
export interface Interaction {
|
|
516
|
-
id: string;
|
|
517
|
-
name?: string;
|
|
518
|
-
model?: string;
|
|
519
|
-
agent?: string;
|
|
520
|
-
status?: InteractionStatus;
|
|
521
|
-
object?: string;
|
|
522
|
-
createTime?: string;
|
|
523
|
-
updateTime?: string;
|
|
524
|
-
previousInteractionId?: string;
|
|
525
|
-
environmentId?: string;
|
|
526
|
-
steps?: InteractionStep[];
|
|
527
|
-
/**
|
|
528
|
-
* Backward-compatible output blocks. Current responses are normalized from
|
|
529
|
-
* the latest model output step when the provider no longer returns outputs.
|
|
530
|
-
*/
|
|
531
|
-
outputs?: unknown[];
|
|
532
|
-
outputText?: string;
|
|
533
|
-
outputImage?: InteractionContent;
|
|
534
|
-
outputAudio?: InteractionContent;
|
|
535
|
-
outputVideo?: InteractionContent;
|
|
536
|
-
usage?: TokenUsage;
|
|
537
|
-
error?: unknown;
|
|
538
|
-
rawResponse?: unknown;
|
|
539
|
-
providerMetadata?: Record<string, unknown>;
|
|
540
|
-
}
|
|
541
|
-
export interface PredictionOperation {
|
|
542
|
-
name: string;
|
|
543
|
-
done?: boolean;
|
|
544
|
-
response?: unknown;
|
|
545
|
-
error?: unknown;
|
|
546
|
-
metadata?: unknown;
|
|
547
|
-
rawResponse?: unknown;
|
|
548
|
-
}
|
|
549
|
-
export interface PredictionResult {
|
|
550
|
-
predictions?: unknown[];
|
|
551
|
-
operationName?: string;
|
|
552
|
-
operation?: PredictionOperation;
|
|
553
|
-
rawResponse?: unknown;
|
|
554
|
-
providerMetadata?: Record<string, unknown>;
|
|
555
|
-
}
|
|
556
|
-
export interface GroundingSource {
|
|
557
|
-
title?: string;
|
|
558
|
-
url: string;
|
|
559
|
-
snippet?: string;
|
|
560
|
-
providerMetadata?: Record<string, unknown>;
|
|
561
|
-
}
|
|
562
|
-
export interface GroundedGenerateResult {
|
|
563
|
-
text: string;
|
|
564
|
-
sources: GroundingSource[];
|
|
565
|
-
finishReason?: FinishReason;
|
|
566
|
-
providerFinishReason?: string;
|
|
567
|
-
usage?: TokenUsage;
|
|
568
|
-
rawResponse?: unknown;
|
|
569
|
-
}
|
|
570
|
-
export type GenerateInputSource = {
|
|
571
|
-
prompt: string;
|
|
572
|
-
messages?: never;
|
|
573
|
-
} | {
|
|
574
|
-
prompt?: never;
|
|
575
|
-
messages: ModelMessage[];
|
|
576
|
-
} | {
|
|
577
|
-
prompt?: undefined;
|
|
578
|
-
messages?: undefined;
|
|
579
|
-
};
|
|
580
|
-
/**
|
|
581
|
-
* Provider-specific request fields. Known provider adapters expose narrower
|
|
582
|
-
* generic option types. Arbitrary passthrough fields are Experimental; wrap
|
|
583
|
-
* them with `experimentalRawProviderOptions()` so the dependency is explicit.
|
|
584
|
-
*/
|
|
585
|
-
export type ProviderOptions = Record<string, unknown>;
|
|
586
|
-
export interface ModelGenerateInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
587
|
-
messages: ModelMessage[];
|
|
588
|
-
/** Opt-in discriminated JSON tool outputs: { output } on success, { error } on failure.
|
|
589
|
-
* Only use with models advertising toolHistory: "json"; legacy serialization is the default.
|
|
590
|
-
*/
|
|
591
|
-
toolResultFormat?: "raw" | "envelope";
|
|
592
|
-
tools?: ToolSet;
|
|
593
|
-
toolChoice?: ToolChoice;
|
|
594
|
-
toolExecution?: ToolExecutionOptions;
|
|
595
|
-
temperature?: number;
|
|
596
|
-
maxTokens?: number;
|
|
597
|
-
reasoning?: ReasoningConfig;
|
|
598
|
-
providerOptions?: TProviderOptions;
|
|
599
|
-
structuredOutput?: StructuredOutputConfig;
|
|
600
|
-
}
|
|
601
|
-
export interface TranscriptionModelInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
602
|
-
audio: AudioInput;
|
|
603
|
-
prompt?: string;
|
|
604
|
-
language?: string;
|
|
605
|
-
providerOptions?: TProviderOptions;
|
|
606
|
-
}
|
|
607
|
-
export interface SpeechModelInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
608
|
-
input: string;
|
|
609
|
-
voice?: string;
|
|
610
|
-
providerOptions?: TProviderOptions;
|
|
611
|
-
}
|
|
612
|
-
export type GroundedModelGenerateInput<TProviderOptions extends ProviderOptions = ProviderOptions> = RetryOptions & GenerateInputSource & {
|
|
613
|
-
system?: string;
|
|
614
|
-
temperature?: number;
|
|
615
|
-
maxTokens?: number;
|
|
616
|
-
reasoning?: ReasoningConfig;
|
|
617
|
-
providerOptions?: TProviderOptions;
|
|
618
|
-
};
|
|
619
|
-
export interface LanguageModel<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
620
|
-
readonly provider: string;
|
|
621
|
-
readonly modelId: string;
|
|
622
|
-
readonly capabilities: ModelCapabilities;
|
|
623
|
-
generate(input: ModelGenerateInput<TProviderOptions>): Promise<GenerateResult>;
|
|
624
|
-
stream?(input: ModelGenerateInput<TProviderOptions>): Promise<AsyncIterable<StreamEvent>>;
|
|
625
|
-
}
|
|
626
|
-
export interface TranscriptionModel<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
627
|
-
readonly provider: string;
|
|
628
|
-
readonly modelId: string;
|
|
629
|
-
readonly capabilities: ModelCapabilities;
|
|
630
|
-
transcribe(input: TranscriptionModelInput<TProviderOptions>): Promise<TranscriptionResult>;
|
|
631
|
-
}
|
|
632
|
-
export interface SpeechModel<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
633
|
-
readonly provider: string;
|
|
634
|
-
readonly modelId: string;
|
|
635
|
-
readonly capabilities: ModelCapabilities;
|
|
636
|
-
generateSpeech(input: SpeechModelInput<TProviderOptions>): Promise<SpeechResult>;
|
|
637
|
-
streamSpeech?(input: SpeechModelInput<TProviderOptions>): Promise<AsyncIterable<SpeechResult>>;
|
|
638
|
-
}
|
|
639
|
-
export interface ImageGenerationModel<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
640
|
-
readonly provider: string;
|
|
641
|
-
readonly modelId: string;
|
|
642
|
-
readonly capabilities: ModelCapabilities;
|
|
643
|
-
generateImage(input: ImageGenerationModelInput<TProviderOptions>): Promise<ImageGenerationResult>;
|
|
644
|
-
}
|
|
645
|
-
export interface VideoGenerationModel<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
646
|
-
readonly provider: string;
|
|
647
|
-
readonly modelId: string;
|
|
648
|
-
readonly capabilities: ModelCapabilities;
|
|
649
|
-
generateVideo(input: VideoGenerationModelInput<TProviderOptions>): Promise<VideoGenerationResult>;
|
|
650
|
-
}
|
|
651
|
-
export interface MusicGenerationModel<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
652
|
-
readonly provider: string;
|
|
653
|
-
readonly modelId: string;
|
|
654
|
-
readonly capabilities: ModelCapabilities;
|
|
655
|
-
generateMusic(input: MusicGenerationModelInput<TProviderOptions>): Promise<MusicGenerationResult>;
|
|
656
|
-
}
|
|
657
|
-
export interface FileUploadInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
658
|
-
data: string | Uint8Array | ArrayBuffer | Blob;
|
|
659
|
-
mediaType: string;
|
|
660
|
-
displayName?: string;
|
|
661
|
-
name?: string;
|
|
662
|
-
filename?: string;
|
|
663
|
-
providerOptions?: TProviderOptions;
|
|
664
|
-
}
|
|
665
|
-
export interface FileListInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
666
|
-
pageSize?: number;
|
|
667
|
-
pageToken?: string;
|
|
668
|
-
providerOptions?: TProviderOptions;
|
|
669
|
-
}
|
|
670
|
-
export interface FileGetInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
671
|
-
name: string;
|
|
672
|
-
providerOptions?: TProviderOptions;
|
|
673
|
-
}
|
|
674
|
-
export interface FileDeleteInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
675
|
-
name: string;
|
|
676
|
-
providerOptions?: TProviderOptions;
|
|
677
|
-
}
|
|
678
|
-
export interface FilesClient<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
679
|
-
upload(input: FileUploadInput<TProviderOptions>): Promise<UploadedFile>;
|
|
680
|
-
get(input: FileGetInput<TProviderOptions>): Promise<UploadedFile>;
|
|
681
|
-
list(input?: FileListInput<TProviderOptions>): Promise<{
|
|
682
|
-
files: UploadedFile[];
|
|
683
|
-
nextPageToken?: string;
|
|
684
|
-
rawResponse?: unknown;
|
|
685
|
-
}>;
|
|
686
|
-
delete(input: FileDeleteInput<TProviderOptions>): Promise<{
|
|
687
|
-
name: string;
|
|
688
|
-
rawResponse?: unknown;
|
|
689
|
-
}>;
|
|
690
|
-
}
|
|
691
|
-
export interface FileSearchStoreCreateInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
692
|
-
displayName?: string;
|
|
693
|
-
providerOptions?: TProviderOptions;
|
|
694
|
-
}
|
|
695
|
-
export interface FileSearchStoreListInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
696
|
-
pageSize?: number;
|
|
697
|
-
pageToken?: string;
|
|
698
|
-
providerOptions?: TProviderOptions;
|
|
699
|
-
}
|
|
700
|
-
export interface FileSearchStoreGetInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
701
|
-
name: string;
|
|
702
|
-
providerOptions?: TProviderOptions;
|
|
703
|
-
}
|
|
704
|
-
export interface FileSearchStoreDeleteInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
705
|
-
name: string;
|
|
706
|
-
providerOptions?: TProviderOptions;
|
|
707
|
-
}
|
|
708
|
-
export interface FileSearchStoreUploadInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
709
|
-
storeName: string;
|
|
710
|
-
data: string | Uint8Array | ArrayBuffer | Blob;
|
|
711
|
-
mediaType: string;
|
|
712
|
-
displayName?: string;
|
|
713
|
-
filename?: string;
|
|
714
|
-
pollIntervalMs?: number;
|
|
715
|
-
providerOptions?: TProviderOptions;
|
|
716
|
-
}
|
|
717
|
-
export interface FileSearchStoreImportInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
718
|
-
storeName: string;
|
|
719
|
-
fileName: string;
|
|
720
|
-
pollIntervalMs?: number;
|
|
721
|
-
providerOptions?: TProviderOptions;
|
|
722
|
-
}
|
|
723
|
-
export interface FileSearchStoresClient<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
724
|
-
create(input?: FileSearchStoreCreateInput<TProviderOptions>): Promise<FileSearchStore>;
|
|
725
|
-
upload(input: FileSearchStoreUploadInput<TProviderOptions>): Promise<PredictionOperation>;
|
|
726
|
-
importFile(input: FileSearchStoreImportInput<TProviderOptions>): Promise<PredictionOperation>;
|
|
727
|
-
get(input: FileSearchStoreGetInput<TProviderOptions>): Promise<FileSearchStore>;
|
|
728
|
-
list(input?: FileSearchStoreListInput<TProviderOptions>): Promise<{
|
|
729
|
-
stores: FileSearchStore[];
|
|
730
|
-
nextPageToken?: string;
|
|
731
|
-
rawResponse?: unknown;
|
|
732
|
-
}>;
|
|
733
|
-
delete(input: FileSearchStoreDeleteInput<TProviderOptions>): Promise<{
|
|
734
|
-
name: string;
|
|
735
|
-
rawResponse?: unknown;
|
|
736
|
-
}>;
|
|
737
|
-
}
|
|
738
|
-
export interface ContextCacheCreateInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
739
|
-
modelId: string;
|
|
740
|
-
contents: ModelMessage[];
|
|
741
|
-
system?: string;
|
|
742
|
-
displayName?: string;
|
|
743
|
-
ttl?: string;
|
|
744
|
-
expireTime?: string;
|
|
745
|
-
tools?: ToolCollection;
|
|
746
|
-
providerOptions?: TProviderOptions;
|
|
747
|
-
}
|
|
748
|
-
export interface ContextCacheGetInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
749
|
-
name: string;
|
|
750
|
-
providerOptions?: TProviderOptions;
|
|
751
|
-
}
|
|
752
|
-
export interface ContextCacheListInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
753
|
-
pageSize?: number;
|
|
754
|
-
pageToken?: string;
|
|
755
|
-
providerOptions?: TProviderOptions;
|
|
756
|
-
}
|
|
757
|
-
export interface ContextCacheDeleteInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
758
|
-
name: string;
|
|
759
|
-
providerOptions?: TProviderOptions;
|
|
760
|
-
}
|
|
761
|
-
export interface ContextCachesClient<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
762
|
-
create(input: ContextCacheCreateInput<TProviderOptions>): Promise<CachedContent>;
|
|
763
|
-
get(input: ContextCacheGetInput<TProviderOptions>): Promise<CachedContent>;
|
|
764
|
-
list(input?: ContextCacheListInput<TProviderOptions>): Promise<{
|
|
765
|
-
caches: CachedContent[];
|
|
766
|
-
nextPageToken?: string;
|
|
767
|
-
rawResponse?: unknown;
|
|
768
|
-
}>;
|
|
769
|
-
delete(input: ContextCacheDeleteInput<TProviderOptions>): Promise<{
|
|
770
|
-
name: string;
|
|
771
|
-
rawResponse?: unknown;
|
|
772
|
-
}>;
|
|
773
|
-
}
|
|
774
|
-
export interface BatchCreateInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
775
|
-
modelId: string;
|
|
776
|
-
displayName?: string;
|
|
777
|
-
requests?: Array<{
|
|
778
|
-
request: unknown;
|
|
779
|
-
metadata?: Record<string, unknown>;
|
|
780
|
-
}>;
|
|
781
|
-
fileName?: string;
|
|
782
|
-
providerOptions?: TProviderOptions;
|
|
783
|
-
}
|
|
784
|
-
export interface BatchGetInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
785
|
-
name: string;
|
|
786
|
-
providerOptions?: TProviderOptions;
|
|
787
|
-
}
|
|
788
|
-
export interface BatchListInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
789
|
-
pageSize?: number;
|
|
790
|
-
pageToken?: string;
|
|
791
|
-
providerOptions?: TProviderOptions;
|
|
792
|
-
}
|
|
793
|
-
export interface BatchDeleteInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
794
|
-
name: string;
|
|
795
|
-
providerOptions?: TProviderOptions;
|
|
796
|
-
}
|
|
797
|
-
export interface BatchCancelInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
798
|
-
name: string;
|
|
799
|
-
providerOptions?: TProviderOptions;
|
|
800
|
-
}
|
|
801
|
-
export interface BatchesClient<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
802
|
-
create(input: BatchCreateInput<TProviderOptions>): Promise<BatchJob>;
|
|
803
|
-
get(input: BatchGetInput<TProviderOptions>): Promise<BatchJob>;
|
|
804
|
-
list(input?: BatchListInput<TProviderOptions>): Promise<{
|
|
805
|
-
batches: BatchJob[];
|
|
806
|
-
nextPageToken?: string;
|
|
807
|
-
rawResponse?: unknown;
|
|
808
|
-
}>;
|
|
809
|
-
cancel(input: BatchCancelInput<TProviderOptions>): Promise<BatchJob>;
|
|
810
|
-
delete(input: BatchDeleteInput<TProviderOptions>): Promise<{
|
|
811
|
-
name: string;
|
|
812
|
-
rawResponse?: unknown;
|
|
813
|
-
}>;
|
|
814
|
-
}
|
|
815
|
-
export interface InteractionCreateInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
816
|
-
modelId?: string;
|
|
817
|
-
agent?: string;
|
|
818
|
-
input: unknown;
|
|
819
|
-
previousInteractionId?: string;
|
|
820
|
-
tools?: ToolCollection;
|
|
821
|
-
systemInstruction?: string;
|
|
822
|
-
responseFormat?: JsonValue | JsonValue[];
|
|
823
|
-
generationConfig?: JsonValue;
|
|
824
|
-
agentConfig?: JsonValue;
|
|
825
|
-
environment?: string | JsonValue;
|
|
826
|
-
labels?: Record<string, string>;
|
|
827
|
-
background?: boolean;
|
|
828
|
-
store?: boolean;
|
|
829
|
-
providerOptions?: TProviderOptions;
|
|
830
|
-
}
|
|
831
|
-
export interface InteractionGetInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
832
|
-
id: string;
|
|
833
|
-
providerOptions?: TProviderOptions;
|
|
834
|
-
}
|
|
835
|
-
export interface InteractionCancelInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
836
|
-
id: string;
|
|
837
|
-
providerOptions?: TProviderOptions;
|
|
838
|
-
}
|
|
839
|
-
export interface InteractionDeleteInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
840
|
-
id: string;
|
|
841
|
-
providerOptions?: TProviderOptions;
|
|
842
|
-
}
|
|
843
|
-
export interface InteractionResumeInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
844
|
-
id: string;
|
|
845
|
-
lastEventId?: string;
|
|
846
|
-
providerOptions?: TProviderOptions;
|
|
847
|
-
}
|
|
848
|
-
export interface InteractionsClient<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
849
|
-
create(input: InteractionCreateInput<TProviderOptions>): Promise<Interaction>;
|
|
850
|
-
get(input: InteractionGetInput<TProviderOptions>): Promise<Interaction>;
|
|
851
|
-
cancel(input: InteractionCancelInput<TProviderOptions>): Promise<Interaction>;
|
|
852
|
-
delete(input: InteractionDeleteInput<TProviderOptions>): Promise<{
|
|
853
|
-
id: string;
|
|
854
|
-
rawResponse?: unknown;
|
|
855
|
-
}>;
|
|
856
|
-
resume(input: InteractionResumeInput<TProviderOptions>): Promise<AsyncIterable<StreamEvent>>;
|
|
857
|
-
stream(input: InteractionCreateInput<TProviderOptions>): Promise<AsyncIterable<StreamEvent>>;
|
|
858
|
-
}
|
|
859
|
-
export interface PredictionModel<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
860
|
-
readonly provider: string;
|
|
861
|
-
readonly modelId: string;
|
|
862
|
-
readonly capabilities: ModelCapabilities;
|
|
863
|
-
predictRaw(input: PredictionModelInput<TProviderOptions>): Promise<PredictionResult>;
|
|
864
|
-
rawPredict?(input: PredictionModelInput<TProviderOptions>): Promise<PredictionResult>;
|
|
865
|
-
invoke?(input: PredictionModelInput<TProviderOptions>): Promise<PredictionResult>;
|
|
866
|
-
predictLongRunning(input: PredictionModelInput<TProviderOptions>): Promise<PredictionOperation>;
|
|
867
|
-
fetchPredictionOperation(input: PredictionOperationInput<TProviderOptions>): Promise<PredictionOperation>;
|
|
868
|
-
}
|
|
869
|
-
export interface AudioFrame {
|
|
870
|
-
data: string | Uint8Array | ArrayBuffer;
|
|
871
|
-
mediaType: string;
|
|
872
|
-
sampleRateHz?: number;
|
|
873
|
-
channels?: number;
|
|
874
|
-
isFinal?: boolean;
|
|
875
|
-
}
|
|
876
|
-
export interface MediaFrame {
|
|
877
|
-
data: string | Uint8Array | ArrayBuffer;
|
|
878
|
-
mediaType: string;
|
|
879
|
-
}
|
|
880
|
-
export interface RealtimeConnectOptions {
|
|
881
|
-
/** Maximum time allowed to establish the provider transport. */
|
|
882
|
-
timeoutMs?: number;
|
|
883
|
-
/** Cancels connection establishment and is passed to the transport for session-lifetime cancellation. */
|
|
884
|
-
signal?: AbortSignal;
|
|
885
|
-
subprotocols?: string[];
|
|
886
|
-
/** Maximum accepted inbound WebSocket frame size. */
|
|
887
|
-
maxIncomingFrameBytes?: number;
|
|
888
|
-
}
|
|
889
|
-
export interface RealtimeSessionConfig {
|
|
890
|
-
/** Backend execution is owned by the application, separately from speech. */
|
|
891
|
-
delegation?: {
|
|
892
|
-
type: "client";
|
|
893
|
-
};
|
|
894
|
-
mode?: "conversation" | "translation" | "transcription";
|
|
895
|
-
instructions?: string;
|
|
896
|
-
voice?: string;
|
|
897
|
-
tools?: ToolCollection;
|
|
898
|
-
toolChoice?: ToolChoice;
|
|
899
|
-
reasoning?: ReasoningConfig;
|
|
900
|
-
inputTranscription?: {
|
|
901
|
-
model?: string;
|
|
902
|
-
language?: string;
|
|
903
|
-
prompt?: string;
|
|
904
|
-
includeLogprobs?: boolean;
|
|
905
|
-
delay?: "minimal" | "low" | "medium" | "high" | "xhigh";
|
|
906
|
-
};
|
|
907
|
-
inputAudioTranscription?: boolean | Record<string, unknown>;
|
|
908
|
-
/** Enable this when an audio-output model must also produce `outputText`. */
|
|
909
|
-
outputAudioTranscription?: boolean | Record<string, unknown>;
|
|
910
|
-
translation?: {
|
|
911
|
-
targetLanguage: string;
|
|
912
|
-
sourceLanguage?: string;
|
|
913
|
-
instructions?: string;
|
|
914
|
-
};
|
|
915
|
-
inputAudioMediaType?: string;
|
|
916
|
-
outputAudioMediaType?: string;
|
|
917
|
-
inputSampleRateHz?: number;
|
|
918
|
-
outputSampleRateHz?: number;
|
|
919
|
-
channels?: number;
|
|
920
|
-
turnDetection?: Record<string, unknown> | null;
|
|
921
|
-
noiseReduction?: Record<string, unknown> | null;
|
|
922
|
-
mediaResolution?: string;
|
|
923
|
-
affectiveDialog?: boolean;
|
|
924
|
-
proactiveAudio?: boolean;
|
|
925
|
-
providerOptions?: ProviderOptions;
|
|
926
|
-
metadata?: Record<string, JsonValue>;
|
|
927
|
-
autoResponse?: boolean;
|
|
928
|
-
}
|
|
929
|
-
export interface RealtimeTokenResult {
|
|
930
|
-
value: string;
|
|
931
|
-
expiresAtMs?: number;
|
|
932
|
-
rawResponse?: unknown;
|
|
933
|
-
}
|
|
934
|
-
export interface RealtimeSessionStartedEvent {
|
|
935
|
-
type: "realtime-start";
|
|
936
|
-
sessionId?: string;
|
|
937
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
938
|
-
}
|
|
939
|
-
export interface RealtimeTextDeltaEvent {
|
|
940
|
-
type: "realtime-text-delta";
|
|
941
|
-
textDelta: string;
|
|
942
|
-
itemId?: string;
|
|
943
|
-
responseId?: string;
|
|
944
|
-
role?: "assistant";
|
|
945
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
946
|
-
}
|
|
947
|
-
export interface RealtimeAudioOutputEvent {
|
|
948
|
-
type: "realtime-audio-output";
|
|
949
|
-
audio: Uint8Array;
|
|
950
|
-
mediaType: string;
|
|
951
|
-
sampleRateHz?: number;
|
|
952
|
-
channels?: number;
|
|
953
|
-
itemId?: string;
|
|
954
|
-
responseId?: string;
|
|
955
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
956
|
-
}
|
|
957
|
-
export interface RealtimeTranscriptEvent {
|
|
958
|
-
type: "realtime-transcript";
|
|
959
|
-
/** Complete transcript when `isFinal` is true; otherwise an incremental chunk. */
|
|
960
|
-
text: string;
|
|
961
|
-
role: "user" | "assistant";
|
|
962
|
-
/** Explicit provider signal that no more transcript chunks remain for this item. */
|
|
963
|
-
isFinal: boolean;
|
|
964
|
-
/** Provider session timeline, not wall-clock time or playback completion. */
|
|
965
|
-
startMs?: number;
|
|
966
|
-
endMs?: number;
|
|
967
|
-
itemId?: string;
|
|
968
|
-
responseId?: string;
|
|
969
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
970
|
-
}
|
|
971
|
-
export interface RealtimeToolCallEvent {
|
|
972
|
-
type: "realtime-tool-call";
|
|
973
|
-
toolCall: ToolCall;
|
|
974
|
-
}
|
|
975
|
-
export interface RealtimeDelegationEvent {
|
|
976
|
-
type: "realtime-delegation";
|
|
977
|
-
/** Opaque provider ID. A delegation does not contain task text or tool arguments. */
|
|
978
|
-
delegationId: string;
|
|
979
|
-
offsetMs?: number;
|
|
980
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
981
|
-
}
|
|
982
|
-
export interface RealtimeContextUpdate {
|
|
983
|
-
kind: "instructions" | "context" | "commentary";
|
|
984
|
-
content: string;
|
|
985
|
-
/** Omit for session-wide context. Only known client delegation IDs are valid. */
|
|
986
|
-
delegationId?: string;
|
|
987
|
-
eventId?: string;
|
|
988
|
-
}
|
|
989
|
-
export interface RealtimeToolResultEvent {
|
|
990
|
-
type: "realtime-tool-result";
|
|
991
|
-
toolResult: ToolExecutionResult;
|
|
992
|
-
}
|
|
993
|
-
export interface RealtimeProviderDataEvent {
|
|
994
|
-
type: "realtime-provider-data";
|
|
995
|
-
provider: string;
|
|
996
|
-
data: JsonValue;
|
|
997
|
-
}
|
|
998
|
-
export interface RealtimeResponseCompleteEvent {
|
|
999
|
-
type: "realtime-response-complete";
|
|
1000
|
-
reason?: string;
|
|
1001
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
1002
|
-
}
|
|
1003
|
-
export interface RealtimeSessionResumptionEvent {
|
|
1004
|
-
type: "realtime-session-resumption";
|
|
1005
|
-
handle?: string;
|
|
1006
|
-
resumable?: boolean;
|
|
1007
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
1008
|
-
}
|
|
1009
|
-
export interface RealtimeGoAwayEvent {
|
|
1010
|
-
type: "realtime-go-away";
|
|
1011
|
-
timeLeftMs?: number;
|
|
1012
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
1013
|
-
}
|
|
1014
|
-
export interface RealtimeSessionEndedEvent {
|
|
1015
|
-
type: "realtime-end";
|
|
1016
|
-
reason?: string;
|
|
1017
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
1018
|
-
}
|
|
1019
|
-
export interface RealtimeErrorEvent {
|
|
1020
|
-
type: "realtime-error";
|
|
1021
|
-
error?: Error;
|
|
1022
|
-
message?: string;
|
|
1023
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
1024
|
-
}
|
|
1025
|
-
export type RealtimeEvent = RealtimeSessionStartedEvent | RealtimeDelegationEvent | RealtimeTextDeltaEvent | RealtimeAudioOutputEvent | RealtimeTranscriptEvent | RealtimeToolCallEvent | RealtimeToolResultEvent | RealtimeProviderDataEvent | RealtimeResponseCompleteEvent | RealtimeSessionResumptionEvent | RealtimeGoAwayEvent | RealtimeSessionEndedEvent | RealtimeErrorEvent;
|
|
1026
|
-
export interface RealtimeSession {
|
|
1027
|
-
readonly provider: string;
|
|
1028
|
-
readonly modelId: string;
|
|
1029
|
-
readonly capabilities: ModelCapabilities;
|
|
1030
|
-
readonly config: RealtimeSessionConfig;
|
|
1031
|
-
sendAudio(frame: AudioFrame): Promise<void>;
|
|
1032
|
-
sendMedia(frame: MediaFrame): Promise<void>;
|
|
1033
|
-
sendText(text: string): Promise<void>;
|
|
1034
|
-
sendToolResult(result: ToolExecutionResult): Promise<void>;
|
|
1035
|
-
appendContext?(update: RealtimeContextUpdate): Promise<void>;
|
|
1036
|
-
setInputMuted?(muted: boolean): Promise<void>;
|
|
1037
|
-
update(config: Partial<RealtimeSessionConfig>): Promise<void>;
|
|
1038
|
-
eventStream(): AsyncIterable<RealtimeEvent>;
|
|
1039
|
-
close(): Promise<void>;
|
|
1040
|
-
}
|
|
1041
|
-
export interface RealtimeModel {
|
|
1042
|
-
readonly provider: string;
|
|
1043
|
-
readonly modelId: string;
|
|
1044
|
-
readonly capabilities: ModelCapabilities;
|
|
1045
|
-
connect(config?: RealtimeSessionConfig, options?: RealtimeConnectOptions): Promise<RealtimeSession>;
|
|
1046
|
-
createBrowserToken?(config?: RealtimeSessionConfig, options?: RealtimeConnectOptions): Promise<RealtimeTokenResult>;
|
|
1047
|
-
}
|
|
1048
|
-
export interface GroundedLanguageModel<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
1049
|
-
readonly provider: string;
|
|
1050
|
-
readonly modelId: string;
|
|
1051
|
-
readonly capabilities: ModelCapabilities;
|
|
1052
|
-
generate(input: GroundedModelGenerateInput<TProviderOptions>): Promise<GroundedGenerateResult>;
|
|
1053
|
-
}
|
|
1054
|
-
export interface EmbeddingModel {
|
|
1055
|
-
readonly provider: string;
|
|
1056
|
-
readonly modelId: string;
|
|
1057
|
-
readonly capabilities: ModelCapabilities;
|
|
1058
|
-
embed(input: EmbedInput & RetryOptions): Promise<EmbedResult>;
|
|
1059
|
-
}
|
|
1060
|
-
export interface ProviderAdapter<TLanguageModel extends LanguageModel = LanguageModel> {
|
|
1061
|
-
readonly name: string;
|
|
1062
|
-
languageModel(modelId: string): TLanguageModel;
|
|
1063
|
-
embeddingModel?: (modelId: string) => EmbeddingModel;
|
|
1064
|
-
transcriptionModel?: (modelId: string) => TranscriptionModel;
|
|
1065
|
-
speechModel?: (modelId: string) => SpeechModel;
|
|
1066
|
-
imageGenerationModel?: (modelId: string) => ImageGenerationModel;
|
|
1067
|
-
videoGenerationModel?: (modelId: string) => VideoGenerationModel;
|
|
1068
|
-
musicGenerationModel?: (modelId: string) => MusicGenerationModel;
|
|
1069
|
-
realtimeModel?: (modelId: string) => RealtimeModel;
|
|
1070
|
-
groundedLanguageModel?: (modelId: string) => GroundedLanguageModel;
|
|
1071
|
-
files?: FilesClient;
|
|
1072
|
-
fileSearchStores?: FileSearchStoresClient;
|
|
1073
|
-
caches?: ContextCachesClient;
|
|
1074
|
-
batches?: BatchesClient;
|
|
1075
|
-
interactions?: InteractionsClient;
|
|
1076
|
-
predictionModel?: (modelId: string) => PredictionModel;
|
|
1077
|
-
}
|
|
1078
|
-
export type CallableProviderAdapter<TLanguageModel extends LanguageModel = LanguageModel> = ProviderAdapter<TLanguageModel> & ((modelId: string) => TLanguageModel);
|
|
1079
|
-
export interface ToolDefinition<TSchema extends ZodTypeAny = any, TResult = JsonValue, TContext = any> {
|
|
1080
|
-
name: string;
|
|
1081
|
-
/** Application assertion that this tool may overlap with other independent tools. */
|
|
1082
|
-
independent?: boolean;
|
|
1083
|
-
description?: string;
|
|
1084
|
-
schema: TSchema;
|
|
1085
|
-
metadata?: Record<string, JsonValue>;
|
|
1086
|
-
requiresApproval?: boolean;
|
|
1087
|
-
/**
|
|
1088
|
-
* "policy" preserves the immediate allow/deny policy behavior. "interrupt"
|
|
1089
|
-
* creates a resumable local approval request before any tool side effect.
|
|
1090
|
-
*/
|
|
1091
|
-
approvalMode?: ToolApprovalMode;
|
|
1092
|
-
/** Bump when approval-relevant tool behavior changes so stale approvals cannot be replayed. */
|
|
1093
|
-
approvalVersion?: string;
|
|
1094
|
-
isEnabled?: (input: z.infer<TSchema>, context: ToolExecutionContext<TContext>) => boolean | Promise<boolean>;
|
|
1095
|
-
inputGuardrails?: ToolInputGuardrail<TSchema, TContext>[];
|
|
1096
|
-
outputGuardrails?: ToolOutputGuardrail<TSchema, TResult, TContext>[];
|
|
1097
|
-
onError?: ToolErrorHandler<TSchema, TResult, TContext>;
|
|
1098
|
-
execute: (input: z.infer<TSchema>, context?: ToolExecutionContext<TContext>) => Promise<TResult> | TResult;
|
|
1099
|
-
}
|
|
1100
|
-
export interface ToolExecutionContext<TContext = any> extends ToolRuntimeContext<TContext> {
|
|
1101
|
-
abortSignal?: AbortSignal;
|
|
1102
|
-
toolCall: ToolCall;
|
|
1103
|
-
step: number;
|
|
1104
|
-
model: LanguageModel | RealtimeModel;
|
|
1105
|
-
/** Forward this key to side-effecting APIs to make retries externally idempotent. */
|
|
1106
|
-
idempotencyKey?: string;
|
|
1107
|
-
request?: ModelGenerateInput;
|
|
1108
|
-
realtimeConfig?: RealtimeSessionConfig;
|
|
1109
|
-
}
|
|
1110
|
-
export interface ToolInputGuardrailRequest<TSchema extends ZodTypeAny = any, TContext = any> {
|
|
1111
|
-
tool: ToolDefinition;
|
|
1112
|
-
input: z.infer<TSchema>;
|
|
1113
|
-
context: ToolExecutionContext<TContext>;
|
|
1114
|
-
}
|
|
1115
|
-
export interface ToolOutputGuardrailRequest<TSchema extends ZodTypeAny = any, TResult = JsonValue, TContext = any> extends ToolInputGuardrailRequest<TSchema, TContext> {
|
|
1116
|
-
output: TResult;
|
|
1117
|
-
}
|
|
1118
|
-
export type ToolInputGuardrail<TSchema extends ZodTypeAny = any, TContext = any> = (request: ToolInputGuardrailRequest<TSchema, TContext>) => ToolGuardrailTrigger | void | Promise<ToolGuardrailTrigger | void>;
|
|
1119
|
-
export type ToolOutputGuardrail<TSchema extends ZodTypeAny = any, TResult = JsonValue, TContext = any> = (request: ToolOutputGuardrailRequest<TSchema, TResult, TContext>) => ToolGuardrailTrigger | void | Promise<ToolGuardrailTrigger | void>;
|
|
1120
|
-
export type ToolErrorHandler<TSchema extends ZodTypeAny = any, TResult = JsonValue, TContext = any> = (error: Error, request: ToolInputGuardrailRequest<TSchema, TContext>) => TResult | void | Promise<TResult | void>;
|
|
1121
|
-
export type HostedToolClass = "web-search" | "file-search" | "remote-mcp" | "computer-use" | "code-execution" | "shell" | "apply-patch" | "tool-search" | "web-extraction" | "skill" | "toolset" | "custom";
|
|
1122
|
-
export interface HostedToolDefinition<TConfig extends JsonValue = JsonValue> {
|
|
1123
|
-
kind: "hosted";
|
|
1124
|
-
name: string;
|
|
1125
|
-
provider?: string;
|
|
1126
|
-
type: string;
|
|
1127
|
-
config?: TConfig;
|
|
1128
|
-
toolClass?: HostedToolClass;
|
|
1129
|
-
requiresApproval?: boolean;
|
|
1130
|
-
metadata?: Record<string, JsonValue>;
|
|
1131
|
-
}
|
|
1132
|
-
export type AnyToolDefinition = ToolDefinition<any, any, any> | HostedToolDefinition;
|
|
1133
|
-
export type ToolSet = Record<string, AnyToolDefinition>;
|
|
1134
|
-
export interface ToolRegistryLike {
|
|
1135
|
-
get(name: string): AnyToolDefinition | undefined;
|
|
1136
|
-
has(name: string): boolean;
|
|
1137
|
-
entries(): Iterable<[string, AnyToolDefinition]>;
|
|
1138
|
-
toToolSet(): ToolSet;
|
|
1139
|
-
}
|
|
1140
|
-
export type ToolCollection = ToolSet | ToolRegistryLike;
|
|
1141
|
-
export interface ToolApprovalRequest<TContext = any> {
|
|
1142
|
-
toolCall: ToolCall;
|
|
1143
|
-
tool: ToolDefinition;
|
|
1144
|
-
input: JsonValue;
|
|
1145
|
-
step: number;
|
|
1146
|
-
model: LanguageModel | RealtimeModel;
|
|
1147
|
-
request?: ModelGenerateInput;
|
|
1148
|
-
executionContext?: ToolExecutionContext<TContext>;
|
|
1149
|
-
realtimeConfig?: RealtimeSessionConfig;
|
|
1150
|
-
}
|
|
1151
|
-
export interface ToolApprovalDecision {
|
|
1152
|
-
approved: boolean;
|
|
1153
|
-
/** Requests resumable human approval instead of treating approved:false as a final denial. */
|
|
1154
|
-
approvalRequired?: boolean;
|
|
1155
|
-
reason?: string;
|
|
1156
|
-
metadata?: Record<string, JsonValue>;
|
|
1157
|
-
}
|
|
1158
|
-
export interface ToolApprovalEvent {
|
|
1159
|
-
request: ToolApprovalRequest;
|
|
1160
|
-
decision: ToolApprovalDecision;
|
|
1161
|
-
}
|
|
1162
|
-
export type ToolApprovalPolicy<TContext = any> = (request: ToolApprovalRequest<TContext>) => ToolApprovalDecision | boolean | Promise<ToolApprovalDecision | boolean>;
|
|
1163
|
-
export type ToolApprovalObserver = (event: ToolApprovalEvent) => void | Promise<void>;
|
|
1164
|
-
export type ProviderOptionsOf<TModel extends LanguageModel> = TModel extends LanguageModel<infer TProviderOptions> ? TProviderOptions : ProviderOptions;
|
|
1165
|
-
export type GenerateTextOptions<TModel extends LanguageModel = LanguageModel, TContext = unknown> = RetryOptions & GenerateInputSource & {
|
|
1166
|
-
model: TModel;
|
|
1167
|
-
system?: string;
|
|
1168
|
-
tools?: ToolCollection;
|
|
1169
|
-
toolChoice?: ToolChoice;
|
|
1170
|
-
toolExecution?: ToolExecutionOptions;
|
|
1171
|
-
toolApprovalPolicy?: ToolApprovalPolicy<TContext>;
|
|
1172
|
-
toolApprovalSigner?: ToolApprovalSigner;
|
|
1173
|
-
/** Resolved local approvals supplied by a durable agent runtime. */
|
|
1174
|
-
toolApprovalResolutions?: AgentApprovalResolution[];
|
|
1175
|
-
toolContext?: ToolRuntimeContext<TContext>;
|
|
1176
|
-
onToolApprovalDecision?: ToolApprovalObserver;
|
|
1177
|
-
/** Durable runtimes may replace the active context before each provider request. */
|
|
1178
|
-
prepareModelMessages?: (context: {
|
|
1179
|
-
messages: readonly ModelMessage[];
|
|
1180
|
-
step: number;
|
|
1181
|
-
}) => ModelMessage[] | undefined | Promise<ModelMessage[] | undefined>;
|
|
1182
|
-
/** Called immediately before each model request. Throw to stop the loop. */
|
|
1183
|
-
onBeforeModelStep?: (context: {
|
|
1184
|
-
request: ModelGenerateInput;
|
|
1185
|
-
step: number;
|
|
1186
|
-
}) => void | Promise<void>;
|
|
1187
|
-
/** Called before a batch of approved local tool calls is executed. */
|
|
1188
|
-
onBeforeToolExecution?: (context: {
|
|
1189
|
-
request: ModelGenerateInput;
|
|
1190
|
-
step: number;
|
|
1191
|
-
toolCalls: ToolCall[];
|
|
1192
|
-
}) => void | Promise<void>;
|
|
1193
|
-
/** Durable runtimes use this hook to checkpoint a model response before tools run. */
|
|
1194
|
-
onModelStep?: (context: {
|
|
1195
|
-
request: ModelGenerateInput;
|
|
1196
|
-
response: GenerateResult;
|
|
1197
|
-
step: number;
|
|
1198
|
-
toolCalls: ToolCall[];
|
|
1199
|
-
approvalRequests: AgentApprovalRequest[];
|
|
1200
|
-
/** Terminal preflight failure: paired results for the entire unexecuted batch. */
|
|
1201
|
-
failedToolResults?: ToolExecutionResult[];
|
|
1202
|
-
}) => void | Promise<void>;
|
|
1203
|
-
/** Durable runtimes use this hook to checkpoint tool results before the next model request. */
|
|
1204
|
-
onToolExecutionComplete?: (context: {
|
|
1205
|
-
request: ModelGenerateInput;
|
|
1206
|
-
step: number;
|
|
1207
|
-
toolResults: ToolExecutionResult[];
|
|
1208
|
-
}) => void | Promise<void>;
|
|
1209
|
-
/** Existing completed steps preceding this invocation. */
|
|
1210
|
-
stepOffset?: number;
|
|
1211
|
-
maxSteps?: number;
|
|
1212
|
-
temperature?: number;
|
|
1213
|
-
maxTokens?: number;
|
|
1214
|
-
reasoning?: ReasoningConfig;
|
|
1215
|
-
providerOptions?: ProviderOptionsOf<TModel>;
|
|
1216
|
-
structuredOutput?: StructuredOutputConfig;
|
|
1217
|
-
};
|
|
1218
|
-
export interface GenerateTextStep {
|
|
1219
|
-
request: ModelGenerateInput;
|
|
1220
|
-
response: GenerateResult;
|
|
1221
|
-
}
|
|
1222
|
-
export interface GenerateTextOutput {
|
|
1223
|
-
text: string;
|
|
1224
|
-
finishReason?: FinishReason;
|
|
1225
|
-
providerFinishReason?: string;
|
|
1226
|
-
usage?: TokenUsage;
|
|
1227
|
-
steps: GenerateTextStep[];
|
|
1228
|
-
messages: ModelMessage[];
|
|
1229
|
-
toolResults: ToolExecutionResult[];
|
|
1230
|
-
/** Local resumable approval requests produced before any tool in the batch executes. */
|
|
1231
|
-
approvalRequests?: AgentApprovalRequest[];
|
|
1232
|
-
}
|
|
1233
|
-
export type AgentStatus = "queued" | "running" | "completed"
|
|
1234
|
-
/**
|
|
1235
|
-
* @deprecated Use "waiting_approval". Kept for legacy persisted run states.
|
|
1236
|
-
*/
|
|
1237
|
-
| "suspended" | "waiting_approval" | "cancel_requested" | "failed" | "cancelled" | "timed_out";
|
|
1238
|
-
export type AgentStepStatus = "running" | "completed" | "suspended" | "waiting_approval" | "failed";
|
|
1239
|
-
export interface AgentRunPolicy {
|
|
1240
|
-
timeoutMs?: number;
|
|
1241
|
-
onTimeout?: "fail" | "cancel-requested";
|
|
1242
|
-
/** Explicit migration escape hatch for pre-fingerprint durable states. */
|
|
1243
|
-
allowLegacyHarnessResume?: boolean;
|
|
1244
|
-
/** Explicit migration escape hatch for states created before environment binding. */
|
|
1245
|
-
allowLegacyExecutionEnvironmentResume?: boolean;
|
|
1246
|
-
/** Disable only for stores that intentionally provide CAS without worker leases. */
|
|
1247
|
-
leaseMode?: "required" | "disabled";
|
|
1248
|
-
/** Duration of the exclusive worker lease. Defaults to 30 seconds. */
|
|
1249
|
-
leaseTtlMs?: number;
|
|
1250
|
-
/** Lease renewal interval. Defaults to one third of leaseTtlMs. */
|
|
1251
|
-
heartbeatMs?: number;
|
|
1252
|
-
/** How often an active worker checks durable cancellation. Defaults to 1 second. */
|
|
1253
|
-
cancellationPollMs?: number;
|
|
1254
|
-
/** Maximum retained events for agent stream replay. Defaults to 4096. */
|
|
1255
|
-
maxStreamEvents?: number;
|
|
1256
|
-
/** Maximum serialized durable state size. Defaults to 4 MiB. */
|
|
1257
|
-
maxStateBytes?: number;
|
|
1258
|
-
/** Optional preflight limits enforced before model and tool operations. */
|
|
1259
|
-
budget?: {
|
|
1260
|
-
maxSteps?: number;
|
|
1261
|
-
maxToolCalls?: number;
|
|
1262
|
-
maxToolErrors?: number;
|
|
1263
|
-
maxInputTokens?: number;
|
|
1264
|
-
maxOutputTokens?: number;
|
|
1265
|
-
maxTotalTokens?: number;
|
|
1266
|
-
includeChildRuns?: boolean;
|
|
1267
|
-
};
|
|
1268
|
-
}
|
|
1269
|
-
export type AgentCompactionReason = "message-count" | "estimated-input-tokens";
|
|
1270
|
-
export interface AgentCompactionRequest<TContext = any> {
|
|
1271
|
-
runId: string;
|
|
1272
|
-
agentId?: string;
|
|
1273
|
-
scope?: AgentStoreScope;
|
|
1274
|
-
beforeStep: number;
|
|
1275
|
-
context?: TContext;
|
|
1276
|
-
/** Historical prefix being summarized. System messages are never included. */
|
|
1277
|
-
messages: ModelMessage[];
|
|
1278
|
-
/** Literal tail preserved after the summary. */
|
|
1279
|
-
retainedMessages: ModelMessage[];
|
|
1280
|
-
reasons: AgentCompactionReason[];
|
|
1281
|
-
estimatedTokensBefore: number;
|
|
1282
|
-
sourceDigest: string;
|
|
1283
|
-
idempotencyKey: string;
|
|
1284
|
-
metadata?: Record<string, JsonValue>;
|
|
1285
|
-
abortSignal?: AbortSignal;
|
|
1286
|
-
}
|
|
1287
|
-
export interface AgentCompactionResult {
|
|
1288
|
-
summary: string;
|
|
1289
|
-
usage?: TokenUsage;
|
|
1290
|
-
metadata?: Record<string, JsonValue>;
|
|
1291
|
-
}
|
|
1292
|
-
export type AgentCompactor<TContext = any> = (request: AgentCompactionRequest<TContext>) => AgentCompactionResult | Promise<AgentCompactionResult>;
|
|
1293
|
-
export interface AgentCompactionOptions<TContext = any> {
|
|
1294
|
-
/** Compaction runs when either configured threshold is exceeded. */
|
|
1295
|
-
maxMessages?: number;
|
|
1296
|
-
maxEstimatedInputTokens?: number;
|
|
1297
|
-
/** Literal non-system tail retained after compaction. Defaults to 8 messages. */
|
|
1298
|
-
keepRecentMessages?: number;
|
|
1299
|
-
estimateTokens?: (messages: readonly ModelMessage[]) => number;
|
|
1300
|
-
compactor: AgentCompactor<TContext>;
|
|
1301
|
-
}
|
|
1302
|
-
export interface AgentCompactionRecord {
|
|
1303
|
-
id: string;
|
|
1304
|
-
beforeStep: number;
|
|
1305
|
-
createdAt: number;
|
|
1306
|
-
reasons: AgentCompactionReason[];
|
|
1307
|
-
sourceDigest: string;
|
|
1308
|
-
resultDigest: string;
|
|
1309
|
-
summaryDigest: string;
|
|
1310
|
-
summary: string;
|
|
1311
|
-
messageCountBefore: number;
|
|
1312
|
-
messageCountAfter: number;
|
|
1313
|
-
compactedMessageCount: number;
|
|
1314
|
-
retainedMessageCount: number;
|
|
1315
|
-
estimatedTokensBefore: number;
|
|
1316
|
-
estimatedTokensAfter: number;
|
|
1317
|
-
usage?: TokenUsage;
|
|
1318
|
-
metadata?: Record<string, JsonValue>;
|
|
1319
|
-
}
|
|
1320
|
-
export interface AgentStepRequest {
|
|
1321
|
-
/** Index in the full conversation where this incremental snapshot begins. */
|
|
1322
|
-
messageOffset?: number;
|
|
1323
|
-
messages: ModelMessage[];
|
|
1324
|
-
toolChoice?: ToolChoice;
|
|
1325
|
-
toolExecution?: ToolExecutionOptions;
|
|
1326
|
-
temperature?: number;
|
|
1327
|
-
maxTokens?: number;
|
|
1328
|
-
reasoning?: ReasoningConfig;
|
|
1329
|
-
providerOptions?: ProviderOptions;
|
|
1330
|
-
timeoutMs?: number;
|
|
1331
|
-
maxRetries?: number;
|
|
1332
|
-
retryBackoffMs?: number;
|
|
1333
|
-
}
|
|
1334
|
-
export interface AgentStepResponse {
|
|
1335
|
-
messages: ModelMessage[];
|
|
1336
|
-
text?: string;
|
|
1337
|
-
finishReason?: FinishReason;
|
|
1338
|
-
providerFinishReason?: string;
|
|
1339
|
-
usage?: TokenUsage;
|
|
1340
|
-
}
|
|
1341
|
-
export type ProviderToolCallErrorReason = "empty_arguments" | "invalid_json" | "arguments_too_large" | "incomplete_arguments" | "inconsistent_metadata" | "response_failed" | "response_incomplete" | "stream_truncated";
|
|
1342
|
-
/** Sanitized, durable projection of an agent failure. */
|
|
1343
|
-
export interface AgentRunError {
|
|
1344
|
-
message: string;
|
|
1345
|
-
diagnosticCode?: string;
|
|
1346
|
-
category?: "provider-tool-call";
|
|
1347
|
-
provider?: string;
|
|
1348
|
-
transport?: string;
|
|
1349
|
-
reason?: ProviderToolCallErrorReason;
|
|
1350
|
-
retryable?: boolean;
|
|
1351
|
-
effectsPossible?: boolean;
|
|
1352
|
-
}
|
|
1353
|
-
export interface AgentStep {
|
|
1354
|
-
index: number;
|
|
1355
|
-
status: AgentStepStatus;
|
|
1356
|
-
startedAt?: number;
|
|
1357
|
-
finishedAt?: number;
|
|
1358
|
-
request: AgentStepRequest;
|
|
1359
|
-
response?: AgentStepResponse;
|
|
1360
|
-
toolResults: ToolExecutionResult[];
|
|
1361
|
-
error?: AgentRunError;
|
|
1362
|
-
}
|
|
1363
|
-
export interface AgentChildRun {
|
|
1364
|
-
runId: string;
|
|
1365
|
-
agentId?: string;
|
|
1366
|
-
parentRunId?: string;
|
|
1367
|
-
toolName?: string;
|
|
1368
|
-
toolCallId?: string;
|
|
1369
|
-
status: AgentStatus;
|
|
1370
|
-
outputText: string;
|
|
1371
|
-
steps: number;
|
|
1372
|
-
toolCalls: number;
|
|
1373
|
-
toolErrors: number;
|
|
1374
|
-
usage?: TokenUsage;
|
|
1375
|
-
startedAt?: number;
|
|
1376
|
-
updatedAt?: number;
|
|
1377
|
-
error?: AgentRunError;
|
|
1378
|
-
metadata?: Record<string, JsonValue>;
|
|
1379
|
-
/** Durable child state retained only while the parent must resume a child approval. */
|
|
1380
|
-
resumeState?: AgentRunState;
|
|
1381
|
-
}
|
|
1382
|
-
export interface AgentHarnessBinding {
|
|
1383
|
-
schemaVersion: 1;
|
|
1384
|
-
id: string;
|
|
1385
|
-
version: string;
|
|
1386
|
-
fingerprint: string;
|
|
1387
|
-
algorithm: "sha256";
|
|
1388
|
-
}
|
|
1389
|
-
export interface AgentTaskOutcome {
|
|
1390
|
-
status: "in_progress" | "resolved" | "denied" | "failed" | "needs_reconciliation";
|
|
1391
|
-
operations: Array<{
|
|
1392
|
-
toolCallId: string;
|
|
1393
|
-
toolName: string;
|
|
1394
|
-
idempotencyKey: string;
|
|
1395
|
-
diagnosticCode: "INDETERMINATE_TOOL_EXECUTION";
|
|
1396
|
-
}>;
|
|
1397
|
-
}
|
|
1398
|
-
/** Evidence must be authenticated against an authoritative external source by the verifier. */
|
|
1399
|
-
export interface AgentToolReconciliationEvidence {
|
|
1400
|
-
operationId: string;
|
|
1401
|
-
runId: string;
|
|
1402
|
-
scope?: AgentStoreScope;
|
|
1403
|
-
toolCallId: string;
|
|
1404
|
-
toolName: string;
|
|
1405
|
-
idempotencyKey: string;
|
|
1406
|
-
input: JsonValue;
|
|
1407
|
-
output: JsonValue;
|
|
1408
|
-
source: string;
|
|
1409
|
-
proof: JsonValue;
|
|
1410
|
-
}
|
|
1411
|
-
export interface AgentToolReconciliationRecord {
|
|
1412
|
-
evidence: AgentToolReconciliationEvidence;
|
|
1413
|
-
decision: "confirmed";
|
|
1414
|
-
verifiedAt: number;
|
|
1415
|
-
previousOutcome?: AgentTaskOutcome;
|
|
1416
|
-
previousOutputText: string;
|
|
1417
|
-
}
|
|
1418
|
-
export interface AgentRunState {
|
|
1419
|
-
schemaVersion: 1;
|
|
1420
|
-
taskOutcome?: AgentTaskOutcome;
|
|
1421
|
-
reconciliations?: AgentToolReconciliationRecord[];
|
|
1422
|
-
/**
|
|
1423
|
-
* Monotonic durable-store revision. Legacy states without a revision are
|
|
1424
|
-
* normalized to revision 0 before their next write.
|
|
1425
|
-
*/
|
|
1426
|
-
revision?: number;
|
|
1427
|
-
/** Tenant/user isolation boundary propagated by the runtime. */
|
|
1428
|
-
scope?: AgentStoreScope;
|
|
1429
|
-
runId: string;
|
|
1430
|
-
idempotencyKey?: string;
|
|
1431
|
-
agentId?: string;
|
|
1432
|
-
parentRunId?: string;
|
|
1433
|
-
provider: string;
|
|
1434
|
-
modelId: string;
|
|
1435
|
-
harness?: AgentHarnessBinding;
|
|
1436
|
-
executionEnvironment?: AgentExecutionEnvironmentBinding;
|
|
1437
|
-
status: AgentStatus;
|
|
1438
|
-
messages: ModelMessage[];
|
|
1439
|
-
steps: AgentStep[];
|
|
1440
|
-
toolResults: ToolExecutionResult[];
|
|
1441
|
-
currentStep: number;
|
|
1442
|
-
maxSteps: number;
|
|
1443
|
-
outputText: string;
|
|
1444
|
-
finalOutput?: JsonValue;
|
|
1445
|
-
outputMode?: Exclude<StructuredOutputMode, "auto">;
|
|
1446
|
-
finishReason?: FinishReason;
|
|
1447
|
-
providerFinishReason?: string;
|
|
1448
|
-
usage?: TokenUsage;
|
|
1449
|
-
pendingApprovals: AgentApprovalRequest[];
|
|
1450
|
-
approvalHistory?: AgentApprovalResolution[];
|
|
1451
|
-
childRuns?: AgentChildRun[];
|
|
1452
|
-
compactions?: AgentCompactionRecord[];
|
|
1453
|
-
metadata?: Record<string, JsonValue>;
|
|
1454
|
-
handoff?: AgentHandoff;
|
|
1455
|
-
startedAt?: number;
|
|
1456
|
-
updatedAt?: number;
|
|
1457
|
-
cancelledAt?: number;
|
|
1458
|
-
cancellationReason?: string;
|
|
1459
|
-
error?: AgentRunError;
|
|
1460
|
-
}
|
|
1461
|
-
/**
|
|
1462
|
-
* Logical isolation boundary for durable agent data. Applications should use
|
|
1463
|
-
* one scope per tenant and, when memory must be private, per end user.
|
|
1464
|
-
*/
|
|
1465
|
-
export interface AgentStoreScope {
|
|
1466
|
-
tenantId: string;
|
|
1467
|
-
userId?: string;
|
|
1468
|
-
namespace?: string;
|
|
1469
|
-
}
|
|
1470
|
-
export interface AgentRunStoreScopeOptions {
|
|
1471
|
-
/** Fixed scope applied to every key handled by this store instance. */
|
|
1472
|
-
scope?: AgentStoreScope;
|
|
1473
|
-
}
|
|
1474
|
-
export interface AgentRunLease {
|
|
1475
|
-
runId: string;
|
|
1476
|
-
ownerId: string;
|
|
1477
|
-
expiresAt: number;
|
|
1478
|
-
}
|
|
1479
|
-
export interface AgentRunLeaseOptions {
|
|
1480
|
-
ownerId: string;
|
|
1481
|
-
ttlMs: number;
|
|
1482
|
-
/** Injectable clock used by deterministic workers and tests. */
|
|
1483
|
-
now?: number;
|
|
1484
|
-
}
|
|
1485
|
-
export type AgentToolCallJournalStatus = "pending" | "running" | "completed" | "failed";
|
|
1486
|
-
export interface AgentToolCallJournalEntry {
|
|
1487
|
-
providerToolCallId?: string;
|
|
1488
|
-
reconciliation?: AgentToolReconciliationRecord;
|
|
1489
|
-
runId: string;
|
|
1490
|
-
scope?: AgentStoreScope;
|
|
1491
|
-
toolCallId: string;
|
|
1492
|
-
toolName: string;
|
|
1493
|
-
status: AgentToolCallJournalStatus;
|
|
1494
|
-
/** Stable key that must also be forwarded to side-effecting integrations. */
|
|
1495
|
-
idempotencyKey: string;
|
|
1496
|
-
revision: number;
|
|
1497
|
-
input?: JsonValue;
|
|
1498
|
-
output?: JsonValue;
|
|
1499
|
-
error?: {
|
|
1500
|
-
message: string;
|
|
1501
|
-
};
|
|
1502
|
-
startedAt?: number;
|
|
1503
|
-
completedAt?: number;
|
|
1504
|
-
updatedAt: number;
|
|
1505
|
-
}
|
|
1506
|
-
export interface AgentToolCallJournalSaveOptions {
|
|
1507
|
-
leaseOwnerId?: string;
|
|
1508
|
-
expectedRevision?: number;
|
|
1509
|
-
}
|
|
1510
|
-
export interface AgentToolExecutionClaimResult {
|
|
1511
|
-
claimed: boolean;
|
|
1512
|
-
entry: AgentToolCallJournalEntry;
|
|
1513
|
-
}
|
|
1514
|
-
export interface AgentRunListOptions {
|
|
1515
|
-
agentId?: string;
|
|
1516
|
-
parentRunId?: string;
|
|
1517
|
-
statuses?: AgentStatus[];
|
|
1518
|
-
updatedAfter?: number;
|
|
1519
|
-
updatedBefore?: number;
|
|
1520
|
-
limit?: number;
|
|
1521
|
-
/** Opaque cursor returned by the previous page. */
|
|
1522
|
-
cursor?: string;
|
|
1523
|
-
}
|
|
1524
|
-
export interface AgentRunPage {
|
|
1525
|
-
items: AgentRunState[];
|
|
1526
|
-
nextCursor?: string;
|
|
1527
|
-
}
|
|
1528
|
-
export interface AgentRunRetentionOptions {
|
|
1529
|
-
before: number;
|
|
1530
|
-
statuses?: AgentStatus[];
|
|
1531
|
-
limit?: number;
|
|
1532
|
-
}
|
|
1533
|
-
export interface AgentRunSaveOptions {
|
|
1534
|
-
leaseOwnerId?: string;
|
|
1535
|
-
expectedRevision?: number;
|
|
1536
|
-
}
|
|
1537
|
-
export interface AgentRunClaimResult {
|
|
1538
|
-
claimed: boolean;
|
|
1539
|
-
state: AgentRunState;
|
|
1540
|
-
}
|
|
1541
|
-
export interface AgentRunStore {
|
|
1542
|
-
/** Lease ownership is checked atomically with reconciliation writes. */
|
|
1543
|
-
reconciliationFencing?: boolean;
|
|
1544
|
-
load(runId: string, scope?: AgentStoreScope): Promise<AgentRunState | undefined> | AgentRunState | undefined;
|
|
1545
|
-
findByIdempotencyKey?(idempotencyKey: string, scope?: AgentStoreScope): Promise<AgentRunState | undefined> | AgentRunState | undefined;
|
|
1546
|
-
findByParentRunId?(parentRunId: string, scope?: AgentStoreScope): Promise<AgentRunState[]> | AgentRunState[];
|
|
1547
|
-
/**
|
|
1548
|
-
* Atomically reserves an idempotency key for a fresh run. Returns the
|
|
1549
|
-
* caller's state when the reservation succeeds, or the already-reserved
|
|
1550
|
-
* state when another caller owns the key.
|
|
1551
|
-
*/
|
|
1552
|
-
claimIdempotencyKey?(state: AgentRunState & {
|
|
1553
|
-
idempotencyKey: string;
|
|
1554
|
-
}): Promise<AgentRunClaimResult> | AgentRunClaimResult;
|
|
1555
|
-
save(state: AgentRunState, options?: AgentRunSaveOptions): Promise<void> | void;
|
|
1556
|
-
delete?(runId: string, scope?: AgentStoreScope): Promise<void> | void;
|
|
1557
|
-
list?(options?: AgentRunListOptions, scope?: AgentStoreScope): Promise<AgentRunPage> | AgentRunPage;
|
|
1558
|
-
deleteExpired?(options: AgentRunRetentionOptions, scope?: AgentStoreScope): Promise<number> | number;
|
|
1559
|
-
acquireLease?(runId: string, options: AgentRunLeaseOptions, scope?: AgentStoreScope): Promise<AgentRunLease | undefined> | AgentRunLease | undefined;
|
|
1560
|
-
renewLease?(runId: string, options: AgentRunLeaseOptions, scope?: AgentStoreScope): Promise<AgentRunLease | undefined> | AgentRunLease | undefined;
|
|
1561
|
-
releaseLease?(runId: string, ownerId: string, scope?: AgentStoreScope): Promise<boolean> | boolean;
|
|
1562
|
-
loadToolCall?(runId: string, toolCallId: string, scope?: AgentStoreScope): Promise<AgentToolCallJournalEntry | undefined> | AgentToolCallJournalEntry | undefined;
|
|
1563
|
-
loadToolExecution?(runId: string, toolCallId: string, scope?: AgentStoreScope): Promise<AgentToolCallJournalEntry | undefined> | AgentToolCallJournalEntry | undefined;
|
|
1564
|
-
listToolCalls?(runId: string, scope?: AgentStoreScope): Promise<AgentToolCallJournalEntry[]> | AgentToolCallJournalEntry[];
|
|
1565
|
-
saveToolCall?(entry: AgentToolCallJournalEntry, options?: AgentToolCallJournalSaveOptions): Promise<AgentToolCallJournalEntry> | AgentToolCallJournalEntry;
|
|
1566
|
-
claimToolExecution?(entry: AgentToolCallJournalEntry): Promise<AgentToolExecutionClaimResult> | AgentToolExecutionClaimResult;
|
|
1567
|
-
completeToolExecution?(entry: AgentToolCallJournalEntry, options: AgentToolCallJournalSaveOptions & {
|
|
1568
|
-
expectedRevision: number;
|
|
1569
|
-
}): Promise<AgentToolCallJournalEntry> | AgentToolCallJournalEntry;
|
|
1570
|
-
}
|
|
1571
|
-
export interface AgentRunCancellationOptions {
|
|
1572
|
-
reason?: string;
|
|
1573
|
-
cascade?: boolean;
|
|
1574
|
-
mode?: "request" | "final";
|
|
1575
|
-
scope?: AgentStoreScope;
|
|
1576
|
-
}
|
|
1577
|
-
export interface AgentRunTreeCancellationResult {
|
|
1578
|
-
parent?: AgentRunState;
|
|
1579
|
-
children: AgentRunState[];
|
|
1580
|
-
}
|
|
1581
|
-
export interface AgentMemoryContext {
|
|
1582
|
-
runId: string;
|
|
1583
|
-
agentId?: string;
|
|
1584
|
-
scope?: AgentStoreScope;
|
|
1585
|
-
state?: AgentRunState;
|
|
1586
|
-
metadata?: Record<string, JsonValue>;
|
|
1587
|
-
}
|
|
1588
|
-
export interface AgentMemoryStore {
|
|
1589
|
-
load(context: AgentMemoryContext): Promise<ModelMessage[]> | ModelMessage[];
|
|
1590
|
-
save?(context: AgentMemoryContext & {
|
|
1591
|
-
state: AgentRunState;
|
|
1592
|
-
}): Promise<void> | void;
|
|
1593
|
-
}
|
|
1594
|
-
export interface SqliteStatementLike<TResult extends Record<string, unknown> = Record<string, unknown>> {
|
|
1595
|
-
run(params?: readonly unknown[] | Record<string, unknown>): unknown;
|
|
1596
|
-
get(params?: readonly unknown[] | Record<string, unknown>): TResult | undefined;
|
|
1597
|
-
all?(params?: readonly unknown[] | Record<string, unknown>): TResult[];
|
|
1598
|
-
}
|
|
1599
|
-
export interface SqliteDatabaseLike {
|
|
1600
|
-
exec(sql: string): unknown;
|
|
1601
|
-
prepare?<TResult extends Record<string, unknown> = Record<string, unknown>>(sql: string): SqliteStatementLike<TResult>;
|
|
1602
|
-
query?<TResult extends Record<string, unknown> = Record<string, unknown>>(sql: string): SqliteStatementLike<TResult>;
|
|
1603
|
-
}
|
|
1604
|
-
export interface SqliteAgentRunStoreOptions {
|
|
1605
|
-
db: SqliteDatabaseLike;
|
|
1606
|
-
tableName?: string;
|
|
1607
|
-
scope?: AgentStoreScope;
|
|
1608
|
-
}
|
|
1609
|
-
export interface SqliteAgentMemoryStoreOptions {
|
|
1610
|
-
db: SqliteDatabaseLike;
|
|
1611
|
-
tableName?: string;
|
|
1612
|
-
key?: (context: AgentMemoryContext) => string;
|
|
1613
|
-
selectMessages?: (state: AgentRunState) => ModelMessage[];
|
|
1614
|
-
scope?: AgentStoreScope;
|
|
1615
|
-
}
|
|
1616
|
-
export interface PostgresQueryResultLike<TResult extends Record<string, unknown> = Record<string, unknown>> {
|
|
1617
|
-
rows: TResult[];
|
|
1618
|
-
}
|
|
1619
|
-
export interface PostgresClientLike {
|
|
1620
|
-
query<TResult extends Record<string, unknown> = Record<string, unknown>>(sql: string, params?: readonly unknown[]): Promise<PostgresQueryResultLike<TResult>> | PostgresQueryResultLike<TResult>;
|
|
1621
|
-
}
|
|
1622
|
-
export interface PostgresAgentRunStoreOptions {
|
|
1623
|
-
client: PostgresClientLike;
|
|
1624
|
-
tableName?: string;
|
|
1625
|
-
scope?: AgentStoreScope;
|
|
1626
|
-
}
|
|
1627
|
-
export interface PostgresAgentMemoryStoreOptions {
|
|
1628
|
-
client: PostgresClientLike;
|
|
1629
|
-
tableName?: string;
|
|
1630
|
-
key?: (context: AgentMemoryContext) => string;
|
|
1631
|
-
selectMessages?: (state: AgentRunState) => ModelMessage[];
|
|
1632
|
-
scope?: AgentStoreScope;
|
|
1633
|
-
}
|
|
1634
|
-
export interface AgentHandoff {
|
|
1635
|
-
id: string;
|
|
1636
|
-
fromRunId: string;
|
|
1637
|
-
scope?: AgentStoreScope;
|
|
1638
|
-
fromAgentId?: string;
|
|
1639
|
-
toAgentId?: string;
|
|
1640
|
-
summary: string;
|
|
1641
|
-
contextMessages: ModelMessage[];
|
|
1642
|
-
metadata?: Record<string, JsonValue>;
|
|
1643
|
-
}
|
|
1644
|
-
export interface AgentTelemetryRunStartEvent {
|
|
1645
|
-
type: "run-start";
|
|
1646
|
-
runId: string;
|
|
1647
|
-
agentId?: string;
|
|
1648
|
-
agentName?: string;
|
|
1649
|
-
provider: string;
|
|
1650
|
-
modelId: string;
|
|
1651
|
-
maxSteps: number;
|
|
1652
|
-
startedAt?: number;
|
|
1653
|
-
}
|
|
1654
|
-
export interface AgentTelemetryStepStartEvent {
|
|
1655
|
-
type: "step-start";
|
|
1656
|
-
runId: string;
|
|
1657
|
-
agentId?: string;
|
|
1658
|
-
agentName?: string;
|
|
1659
|
-
stepIndex: number;
|
|
1660
|
-
startedAt?: number;
|
|
1661
|
-
}
|
|
1662
|
-
export interface AgentTelemetryStepFinishEvent {
|
|
1663
|
-
type: "step-finish";
|
|
1664
|
-
runId: string;
|
|
1665
|
-
agentId?: string;
|
|
1666
|
-
step: AgentStep;
|
|
1667
|
-
}
|
|
1668
|
-
export interface AgentTelemetryToolStartEvent {
|
|
1669
|
-
type: "tool-start";
|
|
1670
|
-
runId: string;
|
|
1671
|
-
agentId?: string;
|
|
1672
|
-
agentName?: string;
|
|
1673
|
-
stepIndex: number;
|
|
1674
|
-
toolCall: ToolCall;
|
|
1675
|
-
startedAt?: number;
|
|
1676
|
-
}
|
|
1677
|
-
export interface AgentTelemetryApprovalRequestEvent {
|
|
1678
|
-
type: "approval-request";
|
|
1679
|
-
runId: string;
|
|
1680
|
-
agentId?: string;
|
|
1681
|
-
approval: AgentApprovalRequest;
|
|
1682
|
-
}
|
|
1683
|
-
export interface AgentTelemetryApprovalResolvedEvent {
|
|
1684
|
-
type: "approval-resolved";
|
|
1685
|
-
runId: string;
|
|
1686
|
-
agentId?: string;
|
|
1687
|
-
approval: AgentApprovalResponse;
|
|
1688
|
-
}
|
|
1689
|
-
export interface AgentTelemetryToolApprovalEvent {
|
|
1690
|
-
type: "tool-approval";
|
|
1691
|
-
runId: string;
|
|
1692
|
-
agentId?: string;
|
|
1693
|
-
toolCall: ToolCall;
|
|
1694
|
-
approved: boolean;
|
|
1695
|
-
reason?: string;
|
|
1696
|
-
metadata?: Record<string, JsonValue>;
|
|
1697
|
-
}
|
|
1698
|
-
export interface AgentTelemetryMemoryLoadedEvent {
|
|
1699
|
-
type: "memory-loaded";
|
|
1700
|
-
runId: string;
|
|
1701
|
-
agentId?: string;
|
|
1702
|
-
messageCount: number;
|
|
1703
|
-
}
|
|
1704
|
-
export interface AgentGuardrailTrigger {
|
|
1705
|
-
triggered: true;
|
|
1706
|
-
reason?: string;
|
|
1707
|
-
metadata?: Record<string, JsonValue>;
|
|
1708
|
-
}
|
|
1709
|
-
export interface AgentInputGuardrailRequest<TContext = any> {
|
|
1710
|
-
runId: string;
|
|
1711
|
-
agentId?: string;
|
|
1712
|
-
context?: TContext;
|
|
1713
|
-
state: AgentRunState;
|
|
1714
|
-
messages: ModelMessage[];
|
|
1715
|
-
metadata?: Record<string, JsonValue>;
|
|
1716
|
-
}
|
|
1717
|
-
export interface AgentOutputGuardrailRequest<TContext = any, TOutput = any> {
|
|
1718
|
-
runId: string;
|
|
1719
|
-
agentId?: string;
|
|
1720
|
-
context?: TContext;
|
|
1721
|
-
state: AgentRunState;
|
|
1722
|
-
output: AgentRunOutput<TOutput> | LiveAgentRunOutput;
|
|
1723
|
-
metadata?: Record<string, JsonValue>;
|
|
1724
|
-
}
|
|
1725
|
-
export type AgentInputGuardrail<TContext = any> = (request: AgentInputGuardrailRequest<TContext>) => AgentGuardrailTrigger | void | Promise<AgentGuardrailTrigger | void>;
|
|
1726
|
-
export type AgentOutputGuardrail<TContext = any, TOutput = any> = (request: AgentOutputGuardrailRequest<TContext, TOutput>) => AgentGuardrailTrigger | void | Promise<AgentGuardrailTrigger | void>;
|
|
1727
|
-
export interface AgentTelemetryGuardrailTriggeredEvent {
|
|
1728
|
-
type: "guardrail-triggered";
|
|
1729
|
-
runId: string;
|
|
1730
|
-
agentId?: string;
|
|
1731
|
-
stage: "input" | "output";
|
|
1732
|
-
reason?: string;
|
|
1733
|
-
metadata?: Record<string, JsonValue>;
|
|
1734
|
-
}
|
|
1735
|
-
export interface AgentTelemetryStateSavedEvent {
|
|
1736
|
-
type: "state-saved";
|
|
1737
|
-
runId: string;
|
|
1738
|
-
agentId?: string;
|
|
1739
|
-
status: AgentStatus;
|
|
1740
|
-
}
|
|
1741
|
-
export interface AgentTelemetryHandoffEvent {
|
|
1742
|
-
type: "handoff";
|
|
1743
|
-
runId: string;
|
|
1744
|
-
agentId?: string;
|
|
1745
|
-
handoff: AgentHandoff;
|
|
1746
|
-
}
|
|
1747
|
-
export interface AgentTelemetrySubAgentStartEvent {
|
|
1748
|
-
type: "subagent-start";
|
|
1749
|
-
runId: string;
|
|
1750
|
-
agentId?: string;
|
|
1751
|
-
childAgentId?: string;
|
|
1752
|
-
toolName: string;
|
|
1753
|
-
}
|
|
1754
|
-
export interface AgentTelemetrySubAgentFinishEvent {
|
|
1755
|
-
type: "subagent-finish";
|
|
1756
|
-
runId: string;
|
|
1757
|
-
agentId?: string;
|
|
1758
|
-
childRun: AgentChildRun;
|
|
1759
|
-
}
|
|
1760
|
-
export interface AgentTelemetryRunFinishEvent {
|
|
1761
|
-
type: "run-finish";
|
|
1762
|
-
runId: string;
|
|
1763
|
-
agentId?: string;
|
|
1764
|
-
agentName?: string;
|
|
1765
|
-
status: AgentStatus;
|
|
1766
|
-
state: AgentRunState;
|
|
1767
|
-
finishedAt?: number;
|
|
1768
|
-
}
|
|
1769
|
-
export type AgentTelemetryEvent = AgentTelemetryRunStartEvent | AgentTelemetryStepStartEvent | AgentTelemetryStepFinishEvent | AgentTelemetryToolStartEvent | AgentTelemetryApprovalRequestEvent | AgentTelemetryApprovalResolvedEvent | AgentTelemetryToolApprovalEvent | AgentTelemetryMemoryLoadedEvent | AgentTelemetryGuardrailTriggeredEvent | AgentTelemetryStateSavedEvent | AgentTelemetryHandoffEvent | AgentTelemetrySubAgentStartEvent | AgentTelemetrySubAgentFinishEvent | AgentTelemetryRunFinishEvent;
|
|
1770
|
-
export interface AgentTelemetryInvocationStart {
|
|
1771
|
-
runId: string;
|
|
1772
|
-
agentId?: string;
|
|
1773
|
-
agentName?: string;
|
|
1774
|
-
provider: string;
|
|
1775
|
-
modelId: string;
|
|
1776
|
-
maxSteps: number;
|
|
1777
|
-
startedAt: number;
|
|
1778
|
-
}
|
|
1779
|
-
export interface AgentTelemetryInvocationFinish {
|
|
1780
|
-
runId: string;
|
|
1781
|
-
agentId?: string;
|
|
1782
|
-
agentName?: string;
|
|
1783
|
-
status: AgentStatus;
|
|
1784
|
-
error?: Error;
|
|
1785
|
-
finishedAt: number;
|
|
1786
|
-
}
|
|
1787
|
-
export type AgentTelemetryObserver = ((event: AgentTelemetryEvent) => void | Promise<void>) & {
|
|
1788
|
-
/** Starts an invocation boundary before context, store, lease, and preflight work. */
|
|
1789
|
-
startInvocation?(event: AgentTelemetryInvocationStart): void | Promise<void>;
|
|
1790
|
-
/** Closes that boundary even when setup fails before the normal run lifecycle starts. */
|
|
1791
|
-
finishInvocation?(event: AgentTelemetryInvocationFinish): void | Promise<void>;
|
|
1792
|
-
/** Runs work with the matching agent invocation span active when supported. */
|
|
1793
|
-
withRunContext?<T>(runId: string, callback: () => T | Promise<T>): Promise<T>;
|
|
1794
|
-
/** Runs work with the matching agent step span active when supported. */
|
|
1795
|
-
withStepContext?<T>(runId: string, stepIndex: number, callback: () => T | Promise<T>): Promise<T>;
|
|
1796
|
-
};
|
|
1797
|
-
export type AgentHookFailureMode = "ignore" | "fail";
|
|
1798
|
-
export interface AgentOperationalError {
|
|
1799
|
-
source: "telemetry" | "memory";
|
|
1800
|
-
operation: string;
|
|
1801
|
-
runId?: string;
|
|
1802
|
-
error: Error;
|
|
1803
|
-
}
|
|
1804
|
-
export interface AgentHookFailurePolicy {
|
|
1805
|
-
/** Telemetry is best-effort by default and cannot fail a run. */
|
|
1806
|
-
telemetry?: AgentHookFailureMode;
|
|
1807
|
-
/** Memory hooks are best-effort by default and cannot fail durable execution. */
|
|
1808
|
-
memory?: AgentHookFailureMode;
|
|
1809
|
-
onError?: (event: AgentOperationalError) => void | Promise<void>;
|
|
1810
|
-
}
|
|
1811
|
-
export interface AgentDefinition<TModel extends LanguageModel = LanguageModel, TContext = any, TOutput = any> {
|
|
1812
|
-
id?: string;
|
|
1813
|
-
/** Human-readable, low-cardinality name. `id` remains the stable definition identifier. */
|
|
1814
|
-
name?: string;
|
|
1815
|
-
model: TModel;
|
|
1816
|
-
instructions?: string;
|
|
1817
|
-
contextSchema?: z.ZodType<TContext>;
|
|
1818
|
-
tools?: ToolCollection;
|
|
1819
|
-
maxSteps?: number;
|
|
1820
|
-
temperature?: number;
|
|
1821
|
-
maxTokens?: number;
|
|
1822
|
-
reasoning?: ReasoningConfig;
|
|
1823
|
-
outputSchema?: z.ZodType<TOutput>;
|
|
1824
|
-
outputMode?: StructuredOutputMode;
|
|
1825
|
-
outputName?: string;
|
|
1826
|
-
outputDescription?: string;
|
|
1827
|
-
toolExecution?: ToolExecutionOptions;
|
|
1828
|
-
toolApprovalPolicy?: ToolApprovalPolicy<TContext>;
|
|
1829
|
-
toolApprovalSigner?: ToolApprovalSigner;
|
|
1830
|
-
inputGuardrails?: AgentInputGuardrail<TContext>[];
|
|
1831
|
-
outputGuardrails?: AgentOutputGuardrail<TContext, TOutput>[];
|
|
1832
|
-
providerOptions?: ProviderOptionsOf<TModel>;
|
|
1833
|
-
subagents?: AgentSubAgentDefinition[];
|
|
1834
|
-
/** Immutable identity of the capsule/spec that owns durable resume semantics. */
|
|
1835
|
-
harness?: AgentHarnessBinding;
|
|
1836
|
-
executionEnvironment?: AgentExecutionEnvironment<TContext>;
|
|
1837
|
-
compaction?: AgentCompactionOptions<TContext>;
|
|
1838
|
-
policy?: AgentRunPolicy;
|
|
1839
|
-
metadata?: Record<string, JsonValue>;
|
|
1840
|
-
store?: AgentRunStore;
|
|
1841
|
-
memory?: AgentMemoryStore;
|
|
1842
|
-
onTelemetryEvent?: AgentTelemetryObserver;
|
|
1843
|
-
hookFailurePolicy?: AgentHookFailurePolicy;
|
|
1844
|
-
}
|
|
1845
|
-
export interface LiveAgentDefinition<TModel extends RealtimeModel = RealtimeModel> {
|
|
1846
|
-
id?: string;
|
|
1847
|
-
/** Human-readable, low-cardinality name. `id` remains the stable definition identifier. */
|
|
1848
|
-
name?: string;
|
|
1849
|
-
model: TModel;
|
|
1850
|
-
instructions?: string;
|
|
1851
|
-
tools?: ToolCollection;
|
|
1852
|
-
toolChoice?: ToolChoice;
|
|
1853
|
-
toolExecution?: ToolExecutionOptions;
|
|
1854
|
-
toolApprovalPolicy?: ToolApprovalPolicy;
|
|
1855
|
-
inputGuardrails?: AgentInputGuardrail[];
|
|
1856
|
-
outputGuardrails?: AgentOutputGuardrail[];
|
|
1857
|
-
providerOptions?: ProviderOptions;
|
|
1858
|
-
metadata?: Record<string, JsonValue>;
|
|
1859
|
-
store?: AgentRunStore;
|
|
1860
|
-
memory?: AgentMemoryStore;
|
|
1861
|
-
onTelemetryEvent?: AgentTelemetryObserver;
|
|
1862
|
-
}
|
|
1863
|
-
export interface AgentApprovalRequest {
|
|
1864
|
-
/** Absent on legacy persisted states and treated as "provider". */
|
|
1865
|
-
kind?: "provider" | "local-tool" | "subagent";
|
|
1866
|
-
provider: string;
|
|
1867
|
-
id: string;
|
|
1868
|
-
name: string;
|
|
1869
|
-
arguments: string;
|
|
1870
|
-
serverLabel?: string;
|
|
1871
|
-
toolCallId?: string;
|
|
1872
|
-
step?: number;
|
|
1873
|
-
inputDigest?: string;
|
|
1874
|
-
toolVersion?: string;
|
|
1875
|
-
signature?: string;
|
|
1876
|
-
childRunId?: string;
|
|
1877
|
-
childAgentId?: string;
|
|
1878
|
-
childApprovalRequestId?: string;
|
|
1879
|
-
rawData: JsonValue;
|
|
1880
|
-
}
|
|
1881
|
-
export interface AgentApprovalResponse {
|
|
1882
|
-
provider: string;
|
|
1883
|
-
approvalRequestId: string;
|
|
1884
|
-
approve: boolean;
|
|
1885
|
-
id?: string;
|
|
1886
|
-
reason?: string;
|
|
1887
|
-
}
|
|
1888
|
-
export interface AgentApprovalResolution {
|
|
1889
|
-
requestId: string;
|
|
1890
|
-
kind: "provider" | "local-tool" | "subagent";
|
|
1891
|
-
provider: string;
|
|
1892
|
-
approve: boolean;
|
|
1893
|
-
reason?: string;
|
|
1894
|
-
toolCallId?: string;
|
|
1895
|
-
step?: number;
|
|
1896
|
-
inputDigest?: string;
|
|
1897
|
-
toolVersion?: string;
|
|
1898
|
-
signature?: string;
|
|
1899
|
-
childRunId?: string;
|
|
1900
|
-
childAgentId?: string;
|
|
1901
|
-
childApprovalRequestId?: string;
|
|
1902
|
-
resolvedAt: number;
|
|
1903
|
-
}
|
|
1904
|
-
export type AgentRunInput<TModel extends LanguageModel = LanguageModel, TContext = any> = RetryOptions & GenerateInputSource & {
|
|
1905
|
-
runId?: string;
|
|
1906
|
-
/** Required isolation boundary for shared durable stores and memory. */
|
|
1907
|
-
scope?: AgentStoreScope;
|
|
1908
|
-
idempotencyKey?: string;
|
|
1909
|
-
/** Ephemeral application context. Callers must provide it again when resuming a run. */
|
|
1910
|
-
context?: TContext;
|
|
1911
|
-
state?: AgentRunState;
|
|
1912
|
-
approvals?: AgentApprovalResponse[];
|
|
1913
|
-
handoff?: AgentHandoff;
|
|
1914
|
-
parentRunId?: string;
|
|
1915
|
-
system?: string;
|
|
1916
|
-
tools?: ToolCollection;
|
|
1917
|
-
toolChoice?: ToolChoice;
|
|
1918
|
-
toolExecution?: ToolExecutionOptions;
|
|
1919
|
-
toolApprovalPolicy?: ToolApprovalPolicy<TContext>;
|
|
1920
|
-
executionEnvironment?: AgentExecutionEnvironment<TContext>;
|
|
1921
|
-
/** Pass false to disable the agent default for this invocation. */
|
|
1922
|
-
compaction?: AgentCompactionOptions<TContext> | false;
|
|
1923
|
-
maxSteps?: number;
|
|
1924
|
-
temperature?: number;
|
|
1925
|
-
maxTokens?: number;
|
|
1926
|
-
reasoning?: ReasoningConfig;
|
|
1927
|
-
providerOptions?: ProviderOptionsOf<TModel>;
|
|
1928
|
-
policy?: AgentRunPolicy;
|
|
1929
|
-
metadata?: Record<string, JsonValue>;
|
|
1930
|
-
};
|
|
1931
|
-
export interface AgentRunOutput<TOutput = unknown> {
|
|
1932
|
-
taskOutcome?: AgentTaskOutcome;
|
|
1933
|
-
status: AgentStatus;
|
|
1934
|
-
outputText: string;
|
|
1935
|
-
finalOutput?: TOutput;
|
|
1936
|
-
finishReason?: FinishReason;
|
|
1937
|
-
providerFinishReason?: string;
|
|
1938
|
-
usage?: TokenUsage;
|
|
1939
|
-
messages: ModelMessage[];
|
|
1940
|
-
steps: AgentStep[];
|
|
1941
|
-
toolResults: ToolExecutionResult[];
|
|
1942
|
-
state: AgentRunState;
|
|
1943
|
-
error?: AgentRunError;
|
|
1944
|
-
}
|
|
1945
|
-
export interface AgentSubAgentDefinition<TModel extends LanguageModel = LanguageModel> {
|
|
1946
|
-
agent: AgentDefinition<TModel>;
|
|
1947
|
-
name?: string;
|
|
1948
|
-
description?: string;
|
|
1949
|
-
maxSteps?: number;
|
|
1950
|
-
system?: string;
|
|
1951
|
-
metadata?: Record<string, JsonValue>;
|
|
1952
|
-
requiresApproval?: boolean;
|
|
1953
|
-
}
|
|
1954
|
-
export interface SubAgentToolInput {
|
|
1955
|
-
prompt: string;
|
|
1956
|
-
system?: string;
|
|
1957
|
-
}
|
|
1958
|
-
export type SubAgentToolOutput = Record<string, JsonValue>;
|
|
1959
|
-
export interface CreateSubAgentToolOptions<TModel extends LanguageModel = LanguageModel> extends AgentSubAgentDefinition<TModel> {
|
|
1960
|
-
parentRunId?: string;
|
|
1961
|
-
parentAgentId?: string;
|
|
1962
|
-
scope?: AgentStoreScope;
|
|
1963
|
-
toolName?: string;
|
|
1964
|
-
onStart?: (request: {
|
|
1965
|
-
toolName: string;
|
|
1966
|
-
childAgentId?: string;
|
|
1967
|
-
parentRunId?: string;
|
|
1968
|
-
}) => void | Promise<void>;
|
|
1969
|
-
onFinish?: (childRun: AgentChildRun) => void | Promise<void>;
|
|
1970
|
-
}
|
|
1971
|
-
export interface AgentGroupMember<TModel extends LanguageModel = LanguageModel> {
|
|
1972
|
-
name?: string;
|
|
1973
|
-
agent: AgentDefinition<TModel>;
|
|
1974
|
-
input?: AgentRunInput<TModel>;
|
|
1975
|
-
}
|
|
1976
|
-
export type AgentGroupRunInput<TModel extends LanguageModel = LanguageModel> = AgentRunInput<TModel> & {
|
|
1977
|
-
stopOnError?: boolean;
|
|
1978
|
-
/** Maximum active members. Omitted means all members may run concurrently. */
|
|
1979
|
-
maxConcurrency?: number;
|
|
1980
|
-
};
|
|
1981
|
-
export interface AgentGroupMemberResult {
|
|
1982
|
-
name?: string;
|
|
1983
|
-
agentId?: string;
|
|
1984
|
-
status: "fulfilled" | "rejected";
|
|
1985
|
-
output?: AgentRunOutput;
|
|
1986
|
-
error?: {
|
|
1987
|
-
message: string;
|
|
1988
|
-
};
|
|
1989
|
-
}
|
|
1990
|
-
export interface AgentGroupRunOutput {
|
|
1991
|
-
status: AgentStatus;
|
|
1992
|
-
parentRunId?: string;
|
|
1993
|
-
outputs: AgentGroupMemberResult[];
|
|
1994
|
-
}
|
|
1995
|
-
export interface PrepareSubagentsForAgentOptions {
|
|
1996
|
-
store?: AgentRunStore;
|
|
1997
|
-
memory?: AgentMemoryStore;
|
|
1998
|
-
onTelemetryEvent?: AgentTelemetryObserver;
|
|
1999
|
-
toolApprovalPolicy?: ToolApprovalPolicy;
|
|
2000
|
-
toolExecution?: ToolExecutionOptions;
|
|
2001
|
-
executionEnvironment?: AgentExecutionEnvironment;
|
|
2002
|
-
compaction?: AgentCompactionOptions;
|
|
2003
|
-
metadata?: Record<string, JsonValue>;
|
|
2004
|
-
}
|
|
2005
|
-
export type LiveAgentRunInput = GenerateInputSource & RetryOptions & {
|
|
2006
|
-
runId?: string;
|
|
2007
|
-
/** Tenant/user isolation boundary propagated to durable state, memory, and tool journals. */
|
|
2008
|
-
scope?: AgentStoreScope;
|
|
2009
|
-
/**
|
|
2010
|
-
* Atomically reserves this invocation when a durable store is configured.
|
|
2011
|
-
* A terminal reservation is replayed without opening another realtime session.
|
|
2012
|
-
*/
|
|
2013
|
-
idempotencyKey?: string;
|
|
2014
|
-
system?: string;
|
|
2015
|
-
tools?: ToolCollection;
|
|
2016
|
-
toolChoice?: ToolChoice;
|
|
2017
|
-
toolExecution?: ToolExecutionOptions;
|
|
2018
|
-
/**
|
|
2019
|
-
* Live sessions support immediate allow/deny decisions. Returning
|
|
2020
|
-
* `approvalRequired: true` fails closed because live runs do not expose a
|
|
2021
|
-
* resumable approval handle.
|
|
2022
|
-
*/
|
|
2023
|
-
toolApprovalPolicy?: ToolApprovalPolicy;
|
|
2024
|
-
providerOptions?: ProviderOptions;
|
|
2025
|
-
metadata?: Record<string, JsonValue>;
|
|
2026
|
-
realtime?: RealtimeSessionConfig;
|
|
2027
|
-
connectOptions?: RealtimeConnectOptions;
|
|
2028
|
-
};
|
|
2029
|
-
export interface LiveAgentRunOutput {
|
|
2030
|
-
status: AgentStatus;
|
|
2031
|
-
outputText: string;
|
|
2032
|
-
messages: ModelMessage[];
|
|
2033
|
-
toolResults: ToolExecutionResult[];
|
|
2034
|
-
state: AgentRunState;
|
|
2035
|
-
error?: AgentRunError;
|
|
2036
|
-
}
|
|
2037
|
-
export interface AgentStreamResult<TOutput = unknown> {
|
|
2038
|
-
eventStream: AsyncIterable<AgentStreamEvent>;
|
|
2039
|
-
textStream: AsyncIterable<string>;
|
|
2040
|
-
collect: () => Promise<AgentRunOutput<TOutput>>;
|
|
2041
|
-
}
|
|
2042
|
-
export type AgentLiveEvent = AgentStreamEvent | RealtimeEvent;
|
|
2043
|
-
export interface AgentLiveStreamResult {
|
|
2044
|
-
eventStream: AsyncIterable<AgentLiveEvent>;
|
|
2045
|
-
textStream: AsyncIterable<string>;
|
|
2046
|
-
session: Promise<RealtimeSession>;
|
|
2047
|
-
collect: () => Promise<LiveAgentRunOutput>;
|
|
2048
|
-
}
|
|
2049
|
-
export type TranscribeAudioOptions<TModel extends TranscriptionModel = TranscriptionModel> = RetryOptions & {
|
|
2050
|
-
model: TModel;
|
|
2051
|
-
audio: AudioInput;
|
|
2052
|
-
prompt?: string;
|
|
2053
|
-
language?: string;
|
|
2054
|
-
providerOptions?: TModel extends TranscriptionModel<infer TProviderOptions> ? TProviderOptions : ProviderOptions;
|
|
2055
|
-
};
|
|
2056
|
-
export interface TranscriptionOutput extends TranscriptionResult {
|
|
2057
|
-
audio: AudioInput;
|
|
2058
|
-
}
|
|
2059
|
-
export type GenerateSpeechOptions<TModel extends SpeechModel = SpeechModel> = RetryOptions & {
|
|
2060
|
-
model: TModel;
|
|
2061
|
-
input: string;
|
|
2062
|
-
voice?: string;
|
|
2063
|
-
providerOptions?: TModel extends SpeechModel<infer TProviderOptions> ? TProviderOptions : ProviderOptions;
|
|
2064
|
-
};
|
|
2065
|
-
export type StreamSpeechOptions<TModel extends SpeechModel = SpeechModel> = GenerateSpeechOptions<TModel>;
|
|
2066
|
-
export interface SpeechOutput extends SpeechResult {
|
|
2067
|
-
input: string;
|
|
2068
|
-
}
|
|
2069
|
-
export interface ImageGenerationModelInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
2070
|
-
prompt: string;
|
|
2071
|
-
images?: MediaInput[];
|
|
2072
|
-
count?: number;
|
|
2073
|
-
aspectRatio?: string;
|
|
2074
|
-
size?: string;
|
|
2075
|
-
negativePrompt?: string;
|
|
2076
|
-
outputMimeType?: string;
|
|
2077
|
-
providerOptions?: TProviderOptions;
|
|
2078
|
-
}
|
|
2079
|
-
export interface VideoGenerationModelInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
2080
|
-
prompt: string;
|
|
2081
|
-
image?: MediaInput;
|
|
2082
|
-
count?: number;
|
|
2083
|
-
aspectRatio?: string;
|
|
2084
|
-
negativePrompt?: string;
|
|
2085
|
-
durationSeconds?: number;
|
|
2086
|
-
outputStorageUri?: string;
|
|
2087
|
-
pollIntervalMs?: number;
|
|
2088
|
-
providerOptions?: TProviderOptions;
|
|
2089
|
-
}
|
|
2090
|
-
export interface MusicGenerationModelInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
2091
|
-
prompt: string;
|
|
2092
|
-
images?: MediaInput[];
|
|
2093
|
-
negativePrompt?: string;
|
|
2094
|
-
outputMimeType?: string;
|
|
2095
|
-
providerOptions?: TProviderOptions;
|
|
2096
|
-
}
|
|
2097
|
-
export type GenerateImageOptions<TModel extends ImageGenerationModel = ImageGenerationModel> = ImageGenerationModelInput<TModel extends ImageGenerationModel<infer TProviderOptions> ? TProviderOptions : ProviderOptions> & {
|
|
2098
|
-
model: TModel;
|
|
2099
|
-
};
|
|
2100
|
-
export interface GenerateImageOutput extends ImageGenerationResult {
|
|
2101
|
-
prompt: string;
|
|
2102
|
-
}
|
|
2103
|
-
export type GenerateVideoOptions<TModel extends VideoGenerationModel = VideoGenerationModel> = VideoGenerationModelInput<TModel extends VideoGenerationModel<infer TProviderOptions> ? TProviderOptions : ProviderOptions> & {
|
|
2104
|
-
model: TModel;
|
|
2105
|
-
};
|
|
2106
|
-
export interface GenerateVideoOutput extends VideoGenerationResult {
|
|
2107
|
-
prompt: string;
|
|
2108
|
-
}
|
|
2109
|
-
export type GenerateMusicOptions<TModel extends MusicGenerationModel = MusicGenerationModel> = MusicGenerationModelInput<TModel extends MusicGenerationModel<infer TProviderOptions> ? TProviderOptions : ProviderOptions> & {
|
|
2110
|
-
model: TModel;
|
|
2111
|
-
};
|
|
2112
|
-
export interface GenerateMusicOutput extends MusicGenerationResult {
|
|
2113
|
-
prompt: string;
|
|
2114
|
-
}
|
|
2115
|
-
export type UploadFileOptions<TProvider extends ProviderAdapter = ProviderAdapter> = FileUploadInput & {
|
|
2116
|
-
provider: TProvider;
|
|
2117
|
-
};
|
|
2118
|
-
export type GetFileOptions<TProvider extends ProviderAdapter = ProviderAdapter> = FileGetInput & {
|
|
2119
|
-
provider: TProvider;
|
|
2120
|
-
};
|
|
2121
|
-
export type ListFilesOptions<TProvider extends ProviderAdapter = ProviderAdapter> = FileListInput & {
|
|
2122
|
-
provider: TProvider;
|
|
2123
|
-
};
|
|
2124
|
-
export type DeleteFileOptions<TProvider extends ProviderAdapter = ProviderAdapter> = FileDeleteInput & {
|
|
2125
|
-
provider: TProvider;
|
|
2126
|
-
};
|
|
2127
|
-
export type CreateFileSearchStoreOptions<TProvider extends ProviderAdapter = ProviderAdapter> = FileSearchStoreCreateInput & {
|
|
2128
|
-
provider: TProvider;
|
|
2129
|
-
};
|
|
2130
|
-
export type UploadToFileSearchStoreOptions<TProvider extends ProviderAdapter = ProviderAdapter> = FileSearchStoreUploadInput & {
|
|
2131
|
-
provider: TProvider;
|
|
2132
|
-
};
|
|
2133
|
-
export type ImportFileToFileSearchStoreOptions<TProvider extends ProviderAdapter = ProviderAdapter> = FileSearchStoreImportInput & {
|
|
2134
|
-
provider: TProvider;
|
|
2135
|
-
};
|
|
2136
|
-
export type GetFileSearchStoreOptions<TProvider extends ProviderAdapter = ProviderAdapter> = FileSearchStoreGetInput & {
|
|
2137
|
-
provider: TProvider;
|
|
2138
|
-
};
|
|
2139
|
-
export type ListFileSearchStoresOptions<TProvider extends ProviderAdapter = ProviderAdapter> = FileSearchStoreListInput & {
|
|
2140
|
-
provider: TProvider;
|
|
2141
|
-
};
|
|
2142
|
-
export type DeleteFileSearchStoreOptions<TProvider extends ProviderAdapter = ProviderAdapter> = FileSearchStoreDeleteInput & {
|
|
2143
|
-
provider: TProvider;
|
|
2144
|
-
};
|
|
2145
|
-
export type CreateContextCacheOptions<TProvider extends ProviderAdapter = ProviderAdapter> = ContextCacheCreateInput & {
|
|
2146
|
-
provider: TProvider;
|
|
2147
|
-
};
|
|
2148
|
-
export type GetContextCacheOptions<TProvider extends ProviderAdapter = ProviderAdapter> = ContextCacheGetInput & {
|
|
2149
|
-
provider: TProvider;
|
|
2150
|
-
};
|
|
2151
|
-
export type ListContextCachesOptions<TProvider extends ProviderAdapter = ProviderAdapter> = ContextCacheListInput & {
|
|
2152
|
-
provider: TProvider;
|
|
2153
|
-
};
|
|
2154
|
-
export type DeleteContextCacheOptions<TProvider extends ProviderAdapter = ProviderAdapter> = ContextCacheDeleteInput & {
|
|
2155
|
-
provider: TProvider;
|
|
2156
|
-
};
|
|
2157
|
-
export type CreateBatchOptions<TProvider extends ProviderAdapter = ProviderAdapter> = BatchCreateInput & {
|
|
2158
|
-
provider: TProvider;
|
|
2159
|
-
};
|
|
2160
|
-
export type GetBatchOptions<TProvider extends ProviderAdapter = ProviderAdapter> = BatchGetInput & {
|
|
2161
|
-
provider: TProvider;
|
|
2162
|
-
};
|
|
2163
|
-
export type ListBatchesOptions<TProvider extends ProviderAdapter = ProviderAdapter> = BatchListInput & {
|
|
2164
|
-
provider: TProvider;
|
|
2165
|
-
};
|
|
2166
|
-
export type CancelBatchOptions<TProvider extends ProviderAdapter = ProviderAdapter> = BatchCancelInput & {
|
|
2167
|
-
provider: TProvider;
|
|
2168
|
-
};
|
|
2169
|
-
export type DeleteBatchOptions<TProvider extends ProviderAdapter = ProviderAdapter> = BatchDeleteInput & {
|
|
2170
|
-
provider: TProvider;
|
|
2171
|
-
};
|
|
2172
|
-
export type CreateInteractionOptions<TProvider extends ProviderAdapter = ProviderAdapter> = InteractionCreateInput & {
|
|
2173
|
-
provider: TProvider;
|
|
2174
|
-
};
|
|
2175
|
-
export type GetInteractionOptions<TProvider extends ProviderAdapter = ProviderAdapter> = InteractionGetInput & {
|
|
2176
|
-
provider: TProvider;
|
|
2177
|
-
};
|
|
2178
|
-
export type CancelInteractionOptions<TProvider extends ProviderAdapter = ProviderAdapter> = InteractionCancelInput & {
|
|
2179
|
-
provider: TProvider;
|
|
2180
|
-
};
|
|
2181
|
-
export type DeleteInteractionOptions<TProvider extends ProviderAdapter = ProviderAdapter> = InteractionDeleteInput & {
|
|
2182
|
-
provider: TProvider;
|
|
2183
|
-
};
|
|
2184
|
-
export type ResumeInteractionOptions<TProvider extends ProviderAdapter = ProviderAdapter> = InteractionResumeInput & {
|
|
2185
|
-
provider: TProvider;
|
|
2186
|
-
};
|
|
2187
|
-
export type StreamInteractionOptions<TProvider extends ProviderAdapter = ProviderAdapter> = InteractionCreateInput & {
|
|
2188
|
-
provider: TProvider;
|
|
2189
|
-
};
|
|
2190
|
-
export interface PredictionModelInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
2191
|
-
instances?: unknown[];
|
|
2192
|
-
parameters?: Record<string, unknown>;
|
|
2193
|
-
body?: unknown;
|
|
2194
|
-
providerOptions?: TProviderOptions;
|
|
2195
|
-
}
|
|
2196
|
-
export interface PredictionOperationInput<TProviderOptions extends ProviderOptions = ProviderOptions> extends RetryOptions {
|
|
2197
|
-
name: string;
|
|
2198
|
-
providerOptions?: TProviderOptions;
|
|
2199
|
-
}
|
|
2200
|
-
export type PredictRawOptions<TModel extends PredictionModel = PredictionModel> = PredictionModelInput<TModel extends PredictionModel<infer TProviderOptions> ? TProviderOptions : ProviderOptions> & {
|
|
2201
|
-
model: TModel;
|
|
2202
|
-
};
|
|
2203
|
-
export type PredictLongRunningOptions<TModel extends PredictionModel = PredictionModel> = PredictionModelInput<TModel extends PredictionModel<infer TProviderOptions> ? TProviderOptions : ProviderOptions> & {
|
|
2204
|
-
model: TModel;
|
|
2205
|
-
};
|
|
2206
|
-
export type FetchPredictionOperationOptions<TModel extends PredictionModel = PredictionModel> = PredictionOperationInput<TModel extends PredictionModel<infer TProviderOptions> ? TProviderOptions : ProviderOptions> & {
|
|
2207
|
-
model: TModel;
|
|
2208
|
-
};
|
|
2209
|
-
export type GenerateGroundedTextOptions<TModel extends GroundedLanguageModel = GroundedLanguageModel> = RetryOptions & GenerateInputSource & {
|
|
2210
|
-
model: TModel;
|
|
2211
|
-
system?: string;
|
|
2212
|
-
temperature?: number;
|
|
2213
|
-
maxTokens?: number;
|
|
2214
|
-
reasoning?: ReasoningConfig;
|
|
2215
|
-
providerOptions?: TModel extends GroundedLanguageModel<infer TProviderOptions> ? TProviderOptions : ProviderOptions;
|
|
2216
|
-
};
|
|
2217
|
-
export interface GenerateGroundedTextOutput extends GroundedGenerateResult {
|
|
2218
|
-
messages: ModelMessage[];
|
|
2219
|
-
}
|
|
2220
|
-
export type GenerateObjectOptions<TSchema extends ZodTypeAny, TModel extends LanguageModel = LanguageModel> = GenerateTextOptions<TModel> & {
|
|
2221
|
-
schema: TSchema;
|
|
2222
|
-
mode?: StructuredOutputMode;
|
|
2223
|
-
schemaName?: string;
|
|
2224
|
-
schemaDescription?: string;
|
|
2225
|
-
};
|
|
2226
|
-
export interface GenerateObjectOutput<TSchema extends ZodTypeAny> extends GenerateTextOutput {
|
|
2227
|
-
object: z.infer<TSchema>;
|
|
2228
|
-
objectMode: Exclude<StructuredOutputMode, "auto">;
|
|
2229
|
-
}
|
|
2230
|
-
export interface StreamObjectResult<TSchema extends ZodTypeAny> {
|
|
2231
|
-
eventStream: AsyncIterable<ObjectStreamEvent<z.infer<TSchema>, Partial<z.infer<TSchema>>>>;
|
|
2232
|
-
partialObjectStream: AsyncIterable<Partial<z.infer<TSchema>>>;
|
|
2233
|
-
textStream: AsyncIterable<string>;
|
|
2234
|
-
collect: () => Promise<GenerateObjectOutput<TSchema>>;
|
|
2235
|
-
}
|
|
2236
|
-
export interface StreamTextResult {
|
|
2237
|
-
eventStream: AsyncIterable<StreamEvent>;
|
|
2238
|
-
textStream: AsyncIterable<string>;
|
|
2239
|
-
collect: () => Promise<GenerateTextOutput>;
|
|
2240
|
-
}
|
|
2241
|
-
export interface LanguageModelMiddlewareContext<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2242
|
-
model: LanguageModel<TProviderOptions>;
|
|
2243
|
-
input: ModelGenerateInput<TProviderOptions>;
|
|
2244
|
-
}
|
|
2245
|
-
export interface LanguageModelMiddlewareNext<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2246
|
-
(): Promise<GenerateResult>;
|
|
2247
|
-
}
|
|
2248
|
-
export interface LanguageModelStreamMiddlewareContext<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2249
|
-
model: LanguageModel<TProviderOptions>;
|
|
2250
|
-
input: ModelGenerateInput<TProviderOptions>;
|
|
2251
|
-
}
|
|
2252
|
-
export interface LanguageModelStreamMiddlewareNext<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2253
|
-
(): Promise<AsyncIterable<StreamEvent>>;
|
|
2254
|
-
}
|
|
2255
|
-
export interface LanguageModelMiddleware<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2256
|
-
name?: string;
|
|
2257
|
-
wrapGenerate?: (context: LanguageModelMiddlewareContext<TProviderOptions>, next: LanguageModelMiddlewareNext<TProviderOptions>) => Promise<GenerateResult>;
|
|
2258
|
-
wrapStream?: (context: LanguageModelStreamMiddlewareContext<TProviderOptions>, next: LanguageModelStreamMiddlewareNext<TProviderOptions>) => Promise<AsyncIterable<StreamEvent>>;
|
|
2259
|
-
}
|
|
2260
|
-
export interface CircuitBreakerState {
|
|
2261
|
-
failures: number;
|
|
2262
|
-
openedAt?: number;
|
|
2263
|
-
}
|
|
2264
|
-
export interface TelemetryGenerateStartEvent<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2265
|
-
type: "generate-start";
|
|
2266
|
-
generateId?: number;
|
|
2267
|
-
model: LanguageModel<TProviderOptions>;
|
|
2268
|
-
input: ModelGenerateInput<TProviderOptions>;
|
|
2269
|
-
startedAt: number;
|
|
2270
|
-
}
|
|
2271
|
-
export interface TelemetryGenerateFinishEvent<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2272
|
-
type: "generate-finish";
|
|
2273
|
-
generateId?: number;
|
|
2274
|
-
model: LanguageModel<TProviderOptions>;
|
|
2275
|
-
input: ModelGenerateInput<TProviderOptions>;
|
|
2276
|
-
output: GenerateResult;
|
|
2277
|
-
startedAt: number;
|
|
2278
|
-
finishedAt: number;
|
|
2279
|
-
latencyMs: number;
|
|
2280
|
-
}
|
|
2281
|
-
export interface TelemetryGenerateErrorEvent<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2282
|
-
type: "generate-error";
|
|
2283
|
-
generateId?: number;
|
|
2284
|
-
model: LanguageModel<TProviderOptions>;
|
|
2285
|
-
input: ModelGenerateInput<TProviderOptions>;
|
|
2286
|
-
error: Error;
|
|
2287
|
-
startedAt: number;
|
|
2288
|
-
finishedAt: number;
|
|
2289
|
-
latencyMs: number;
|
|
2290
|
-
}
|
|
2291
|
-
export interface TelemetryStreamStartEvent<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2292
|
-
type: "stream-start";
|
|
2293
|
-
streamId?: number;
|
|
2294
|
-
model: LanguageModel<TProviderOptions>;
|
|
2295
|
-
input: ModelGenerateInput<TProviderOptions>;
|
|
2296
|
-
startedAt: number;
|
|
2297
|
-
}
|
|
2298
|
-
/** Timing-only signal for one logical non-terminal stream chunk; never includes model output content. */
|
|
2299
|
-
export interface TelemetryStreamChunkEvent<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2300
|
-
type: "stream-chunk";
|
|
2301
|
-
streamId?: number;
|
|
2302
|
-
model: LanguageModel<TProviderOptions>;
|
|
2303
|
-
input: ModelGenerateInput<TProviderOptions>;
|
|
2304
|
-
startedAt: number;
|
|
2305
|
-
chunkAt: number;
|
|
2306
|
-
chunkIndex: number;
|
|
2307
|
-
timeToFirstChunkMs?: number;
|
|
2308
|
-
timeSincePreviousChunkMs?: number;
|
|
2309
|
-
}
|
|
2310
|
-
export interface TelemetryStreamFinishEvent<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2311
|
-
type: "stream-finish";
|
|
2312
|
-
streamId?: number;
|
|
2313
|
-
model: LanguageModel<TProviderOptions>;
|
|
2314
|
-
input: ModelGenerateInput<TProviderOptions>;
|
|
2315
|
-
startedAt: number;
|
|
2316
|
-
finishedAt: number;
|
|
2317
|
-
latencyMs: number;
|
|
2318
|
-
finishReason?: FinishReason;
|
|
2319
|
-
providerFinishReason?: string;
|
|
2320
|
-
usage?: TokenUsage;
|
|
2321
|
-
/** Number of non-terminal output chunks observed. */
|
|
2322
|
-
outputChunkCount?: number;
|
|
2323
|
-
}
|
|
2324
|
-
export interface TelemetryStreamErrorEvent<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2325
|
-
type: "stream-error";
|
|
2326
|
-
streamId?: number;
|
|
2327
|
-
model: LanguageModel<TProviderOptions>;
|
|
2328
|
-
input: ModelGenerateInput<TProviderOptions>;
|
|
2329
|
-
error: Error;
|
|
2330
|
-
startedAt: number;
|
|
2331
|
-
finishedAt: number;
|
|
2332
|
-
latencyMs: number;
|
|
2333
|
-
outputChunkCount?: number;
|
|
2334
|
-
}
|
|
2335
|
-
export interface TelemetryToolExecutionStartEvent<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2336
|
-
type: "tool-execution-start";
|
|
2337
|
-
model: LanguageModel<TProviderOptions>;
|
|
2338
|
-
input: ModelGenerateInput<TProviderOptions>;
|
|
2339
|
-
step: number;
|
|
2340
|
-
toolCall: ToolCall;
|
|
2341
|
-
startedAt: number;
|
|
2342
|
-
}
|
|
2343
|
-
export interface TelemetryToolExecutionFinishEvent<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2344
|
-
type: "tool-execution-finish";
|
|
2345
|
-
model: LanguageModel<TProviderOptions>;
|
|
2346
|
-
input: ModelGenerateInput<TProviderOptions>;
|
|
2347
|
-
step: number;
|
|
2348
|
-
toolCall: ToolCall;
|
|
2349
|
-
toolResult: ToolExecutionResult;
|
|
2350
|
-
startedAt: number;
|
|
2351
|
-
finishedAt: number;
|
|
2352
|
-
latencyMs: number;
|
|
2353
|
-
}
|
|
2354
|
-
export interface TelemetryToolExecutionErrorEvent<TProviderOptions extends ProviderOptions = ProviderOptions> {
|
|
2355
|
-
type: "tool-execution-error";
|
|
2356
|
-
model: LanguageModel<TProviderOptions>;
|
|
2357
|
-
input: ModelGenerateInput<TProviderOptions>;
|
|
2358
|
-
step: number;
|
|
2359
|
-
toolCall: ToolCall;
|
|
2360
|
-
error: Error;
|
|
2361
|
-
startedAt: number;
|
|
2362
|
-
finishedAt: number;
|
|
2363
|
-
latencyMs: number;
|
|
2364
|
-
}
|
|
2365
|
-
export type LanguageModelTelemetryEvent<TProviderOptions extends ProviderOptions = ProviderOptions> = TelemetryGenerateStartEvent<TProviderOptions> | TelemetryGenerateFinishEvent<TProviderOptions> | TelemetryGenerateErrorEvent<TProviderOptions> | TelemetryStreamStartEvent<TProviderOptions> | TelemetryStreamChunkEvent<TProviderOptions> | TelemetryStreamFinishEvent<TProviderOptions> | TelemetryStreamErrorEvent<TProviderOptions> | TelemetryToolExecutionStartEvent<TProviderOptions> | TelemetryToolExecutionFinishEvent<TProviderOptions> | TelemetryToolExecutionErrorEvent<TProviderOptions>;
|
|
2366
|
-
export interface UIMessage {
|
|
2367
|
-
id: string;
|
|
2368
|
-
role: MessageRole;
|
|
2369
|
-
parts: ContentPart[];
|
|
2370
|
-
}
|
|
2371
|
-
export interface UIMessageTextChunk {
|
|
2372
|
-
type: "text-delta";
|
|
2373
|
-
messageId: string;
|
|
2374
|
-
role: "assistant";
|
|
2375
|
-
textDelta: string;
|
|
2376
|
-
}
|
|
2377
|
-
export interface UIMessageToolCallChunk {
|
|
2378
|
-
type: "tool-call";
|
|
2379
|
-
messageId: string;
|
|
2380
|
-
role: "assistant";
|
|
2381
|
-
toolCall: ToolCall;
|
|
2382
|
-
}
|
|
2383
|
-
export interface UIMessageToolResultChunk {
|
|
2384
|
-
type: "tool-result";
|
|
2385
|
-
messageId: string;
|
|
2386
|
-
role: "tool";
|
|
2387
|
-
toolResult: ToolExecutionResult;
|
|
2388
|
-
}
|
|
2389
|
-
export interface UIMessageToolApprovalRequestChunk {
|
|
2390
|
-
type: "tool-approval-request";
|
|
2391
|
-
messageId: string;
|
|
2392
|
-
role: "assistant";
|
|
2393
|
-
approval: AgentApprovalRequest;
|
|
2394
|
-
}
|
|
2395
|
-
export interface UIMessageProviderDataChunk {
|
|
2396
|
-
type: "provider-data";
|
|
2397
|
-
messageId: string;
|
|
2398
|
-
role: "assistant";
|
|
2399
|
-
provider: string;
|
|
2400
|
-
data: JsonValue;
|
|
2401
|
-
}
|
|
2402
|
-
export interface UIMessageGeneratedMedia {
|
|
2403
|
-
data?: string;
|
|
2404
|
-
encoding?: "base64";
|
|
2405
|
-
uri?: string;
|
|
2406
|
-
mediaType: string;
|
|
2407
|
-
text?: string;
|
|
2408
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
2409
|
-
}
|
|
2410
|
-
export interface UIMessageImageGenerationChunk {
|
|
2411
|
-
type: "image-generation";
|
|
2412
|
-
messageId: string;
|
|
2413
|
-
role: "assistant";
|
|
2414
|
-
provider: string;
|
|
2415
|
-
image: UIMessageGeneratedMedia;
|
|
2416
|
-
partial: boolean;
|
|
2417
|
-
id?: string;
|
|
2418
|
-
index?: number;
|
|
2419
|
-
providerMetadata?: Record<string, JsonValue>;
|
|
2420
|
-
}
|
|
2421
|
-
export interface UIMessageFinishChunk {
|
|
2422
|
-
type: "finish";
|
|
2423
|
-
messageId: string;
|
|
2424
|
-
finishReason?: FinishReason;
|
|
2425
|
-
providerFinishReason?: string;
|
|
2426
|
-
usage?: TokenUsage;
|
|
2427
|
-
}
|
|
2428
|
-
export interface UIMessageErrorChunk {
|
|
2429
|
-
type: "error";
|
|
2430
|
-
messageId: string;
|
|
2431
|
-
error: {
|
|
2432
|
-
message: string;
|
|
2433
|
-
};
|
|
2434
|
-
}
|
|
2435
|
-
export interface UIAgentRunStartChunk {
|
|
2436
|
-
type: "agent-run-start";
|
|
2437
|
-
currentStep: number;
|
|
2438
|
-
maxSteps: number;
|
|
2439
|
-
}
|
|
2440
|
-
export interface UIAgentStepStartChunk {
|
|
2441
|
-
type: "agent-step-start";
|
|
2442
|
-
stepIndex: number;
|
|
2443
|
-
}
|
|
2444
|
-
export interface UIAgentStepFinishChunk {
|
|
2445
|
-
type: "agent-step-finish";
|
|
2446
|
-
step: AgentStep;
|
|
2447
|
-
}
|
|
2448
|
-
export interface UIAgentApprovalRequestChunk {
|
|
2449
|
-
type: "agent-approval-request";
|
|
2450
|
-
approval: AgentApprovalRequest;
|
|
2451
|
-
}
|
|
2452
|
-
export interface UIAgentApprovalResolvedChunk {
|
|
2453
|
-
type: "agent-approval-resolved";
|
|
2454
|
-
approval: AgentApprovalResponse;
|
|
2455
|
-
}
|
|
2456
|
-
export interface UIAgentCompactionChunk {
|
|
2457
|
-
type: "agent-compaction";
|
|
2458
|
-
compaction: AgentCompactionRecord;
|
|
2459
|
-
}
|
|
2460
|
-
export interface UIAgentRunFinishChunk {
|
|
2461
|
-
type: "agent-run-finish";
|
|
2462
|
-
status: AgentStatus;
|
|
2463
|
-
state: AgentRunState;
|
|
2464
|
-
}
|
|
2465
|
-
export interface UISessionFinishChunk {
|
|
2466
|
-
type: "session-finish";
|
|
2467
|
-
sessionId: string;
|
|
2468
|
-
status: AgentStatus;
|
|
2469
|
-
}
|
|
2470
|
-
export type UIMessageChunk = UIMessageTextChunk | UIMessageToolCallChunk | UIMessageToolResultChunk | UIMessageToolApprovalRequestChunk | UIMessageProviderDataChunk | UIMessageImageGenerationChunk | UIMessageFinishChunk | UIMessageErrorChunk | UIAgentRunStartChunk | UIAgentStepStartChunk | UIAgentStepFinishChunk | UIAgentApprovalRequestChunk | UIAgentApprovalResolvedChunk | UIAgentCompactionChunk | UIAgentRunFinishChunk | UISessionFinishChunk;
|
|
2471
|
-
export interface EmbedInput {
|
|
2472
|
-
values: EmbedValue[];
|
|
2473
|
-
}
|
|
2474
|
-
export interface EmbedOptions extends RetryOptions {
|
|
2475
|
-
model: EmbeddingModel;
|
|
2476
|
-
value: EmbedValue | EmbedValue[];
|
|
2477
|
-
}
|
|
2478
|
-
export interface EmbedOutput extends EmbedResult {
|
|
2479
|
-
values: EmbedValue[];
|
|
2480
|
-
}
|
|
1
|
+
/** Shared public contracts. Domain modules are internal; this facade preserves existing imports. */
|
|
2
|
+
export type * from "./types/common.js";
|
|
3
|
+
export type * from "./types/messages.js";
|
|
4
|
+
export type * from "./types/model-tools.js";
|
|
5
|
+
export type * from "./types/stream.js";
|
|
6
|
+
export type * from "./types/agents.js";
|
|
7
|
+
export type * from "./types/media-data.js";
|
|
8
|
+
export type * from "./types/provider-resources.js";
|
|
9
|
+
export type * from "./types/media.js";
|
|
10
|
+
export type * from "./types/provider.js";
|
|
11
|
+
export type * from "./types/generation.js";
|
|
12
|
+
export type * from "./types/agent-state.js";
|
|
13
|
+
export type * from "./types/persistence.js";
|
|
14
|
+
export type * from "./types/resource-options.js";
|
|
15
|
+
export type * from "./types/middleware.js";
|
|
16
|
+
export type * from "./types/ui.js";
|
|
2481
17
|
//# sourceMappingURL=types.d.ts.map
|