@wildix/wilma-agents-client 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/WilmaAgents.js +12 -20
- package/dist-cjs/commands/{DeleteGuardrailCommand.js → CreateAgentDeploymentCommand.js} +6 -6
- package/dist-cjs/commands/{ExecuteAgentCommand.js → DeleteAgentDeploymentCommand.js} +6 -6
- package/dist-cjs/commands/{CreateGuardrailCommand.js → GetAgentDeploymentCommand.js} +6 -6
- package/dist-cjs/commands/{DeleteAgentAliasCommand.js → ListAgentDeploymentsCommand.js} +6 -6
- package/dist-cjs/commands/RestoreAgentVersionToDraftCommand.js +20 -0
- package/dist-cjs/commands/UpdateAgentDeploymentCommand.js +20 -0
- package/dist-cjs/commands/index.js +6 -10
- package/dist-cjs/models/enums.js +36 -81
- package/dist-cjs/models/errors.js +51 -36
- package/dist-cjs/schemas/schemas_0.js +356 -538
- package/dist-es/WilmaAgents.js +12 -20
- package/dist-es/commands/{DeleteAgentAliasCommand.js → CreateAgentDeploymentCommand.js} +5 -5
- package/dist-es/commands/{ExecuteAgentCommand.js → DeleteAgentDeploymentCommand.js} +5 -5
- package/dist-es/commands/{CreateGuardrailCommand.js → GetAgentDeploymentCommand.js} +5 -5
- package/dist-es/commands/{DeleteGuardrailCommand.js → ListAgentDeploymentsCommand.js} +5 -5
- package/dist-es/commands/RestoreAgentVersionToDraftCommand.js +16 -0
- package/dist-es/commands/UpdateAgentDeploymentCommand.js +16 -0
- package/dist-es/commands/index.js +6 -10
- package/dist-es/models/enums.js +35 -80
- package/dist-es/models/errors.js +42 -28
- package/dist-es/schemas/schemas_0.js +354 -535
- package/dist-types/WilmaAgents.d.ts +42 -71
- package/dist-types/WilmaAgentsClient.d.ts +16 -19
- package/dist-types/commands/CompareAgentVersionsCommand.d.ts +5 -5
- package/dist-types/commands/CreateAgentApiKeyCommand.d.ts +1 -3
- package/dist-types/commands/CreateAgentCommand.d.ts +450 -323
- package/dist-types/commands/CreateAgentDeploymentCommand.d.ts +116 -0
- package/dist-types/commands/DeleteAgentApiKeyCommand.d.ts +1 -3
- package/dist-types/commands/DeleteAgentCommand.d.ts +5 -4
- package/dist-types/commands/DeleteAgentDeploymentCommand.d.ts +83 -0
- package/dist-types/commands/GetAgentCommand.d.ts +236 -169
- package/dist-types/commands/GetAgentDeploymentCommand.d.ts +106 -0
- package/dist-types/commands/GetAgentVersionCommand.d.ts +216 -156
- package/dist-types/commands/ListAgentApiKeysCommand.d.ts +1 -3
- package/dist-types/commands/ListAgentDeploymentsCommand.d.ts +105 -0
- package/dist-types/commands/ListAgentVersionsCommand.d.ts +6 -6
- package/dist-types/commands/ListAgentsCommand.d.ts +240 -173
- package/dist-types/commands/ListAgentsNamesCommand.d.ts +5 -7
- package/dist-types/commands/PublishAgentVersionCommand.d.ts +219 -158
- package/dist-types/commands/RestoreAgentVersionToDraftCommand.d.ts +460 -0
- package/dist-types/commands/UpdateAgentCommand.d.ts +450 -323
- package/dist-types/commands/UpdateAgentDeploymentCommand.d.ts +120 -0
- package/dist-types/commands/index.d.ts +6 -10
- package/dist-types/index.d.ts +8 -7
- package/dist-types/models/enums.d.ts +126 -161
- package/dist-types/models/errors.d.ts +35 -22
- package/dist-types/models/models_0.d.ts +689 -741
- package/dist-types/schemas/schemas_0.d.ts +41 -61
- package/package.json +1 -1
- package/dist-cjs/commands/GetGuardrailCommand.js +0 -20
- package/dist-cjs/commands/ListAgentAliasesCommand.js +0 -20
- package/dist-cjs/commands/ListAuditRecordsCommand.js +0 -20
- package/dist-cjs/commands/ListGuardrailsCommand.js +0 -20
- package/dist-cjs/commands/PutAgentAliasCommand.js +0 -20
- package/dist-cjs/commands/UpdateGuardrailCommand.js +0 -20
- package/dist-es/commands/GetGuardrailCommand.js +0 -16
- package/dist-es/commands/ListAgentAliasesCommand.js +0 -16
- package/dist-es/commands/ListAuditRecordsCommand.js +0 -16
- package/dist-es/commands/ListGuardrailsCommand.js +0 -16
- package/dist-es/commands/PutAgentAliasCommand.js +0 -16
- package/dist-es/commands/UpdateGuardrailCommand.js +0 -16
- package/dist-types/commands/CreateGuardrailCommand.d.ts +0 -172
- package/dist-types/commands/DeleteAgentAliasCommand.d.ts +0 -82
- package/dist-types/commands/DeleteGuardrailCommand.d.ts +0 -80
- package/dist-types/commands/ExecuteAgentCommand.d.ts +0 -112
- package/dist-types/commands/GetGuardrailCommand.d.ts +0 -135
- package/dist-types/commands/ListAgentAliasesCommand.d.ts +0 -99
- package/dist-types/commands/ListAuditRecordsCommand.d.ts +0 -109
- package/dist-types/commands/ListGuardrailsCommand.d.ts +0 -137
- package/dist-types/commands/PutAgentAliasCommand.d.ts +0 -107
- package/dist-types/commands/UpdateGuardrailCommand.d.ts +0 -175
|
@@ -1,23 +1,7 @@
|
|
|
1
1
|
import type { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import type { ActorType,
|
|
3
|
-
/**
|
|
4
|
-
* Who performed an action: an interactive user, an API key or an internal service.
|
|
5
|
-
* @public
|
|
6
|
-
*/
|
|
7
|
-
export interface Actor {
|
|
8
|
-
type: ActorType;
|
|
9
|
-
/**
|
|
10
|
-
* User id, API key id or service name, depending on the actor type.
|
|
11
|
-
* @public
|
|
12
|
-
*/
|
|
13
|
-
id: string;
|
|
14
|
-
/**
|
|
15
|
-
* Human readable name of the actor at the time of the action.
|
|
16
|
-
* @public
|
|
17
|
-
*/
|
|
18
|
-
name?: string | undefined;
|
|
19
|
-
}
|
|
2
|
+
import type { ActorType, AgentDeploymentStatus, AgentHandoverPipelineType, AgentHandoverVariant, AgentHangupPipelineType, AgentStatus, AgentToolPipelineType, AgentTransferPipelineType, AgentTransferVariant, AgentVariableType, AgentVisibility, ChannelType, SandboxNetworkAccess, WebSearchContextSize } from "./enums";
|
|
20
3
|
/**
|
|
4
|
+
* A user or group that access is granted to.
|
|
21
5
|
* @public
|
|
22
6
|
*/
|
|
23
7
|
export type AgentGrantPrincipal = AgentGrantPrincipal.GroupIdMember | AgentGrantPrincipal.UserIdMember | AgentGrantPrincipal.$UnknownMember;
|
|
@@ -54,94 +38,48 @@ export declare namespace AgentGrantPrincipal {
|
|
|
54
38
|
}
|
|
55
39
|
}
|
|
56
40
|
/**
|
|
57
|
-
*
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
principal: AgentGrantPrincipal;
|
|
62
|
-
}
|
|
63
|
-
/**
|
|
41
|
+
* Who is allowed to use the agent. There is no view/edit dimension — access solely grants the ability to use the agent.
|
|
42
|
+
* Per channel: on `chat` and `assistant` agents `grants` govern which colleagues can use the agent; on `voice` agents `grants`
|
|
43
|
+
* are ignored (inbound calls are routed by the PBX dialplan, and data ACL is the agent-level `settings.pbxGroupId`); on `autonomous` agents agent-level
|
|
44
|
+
* access is not used — invocation access is configured per reference on the calling agent (see AgentCallCapability.access).
|
|
64
45
|
* @public
|
|
65
46
|
*/
|
|
66
47
|
export interface AgentAccess {
|
|
67
|
-
visibility?: AgentVisibility | undefined;
|
|
68
|
-
grants?: AgentGrant[] | undefined;
|
|
69
|
-
}
|
|
70
|
-
/**
|
|
71
|
-
* @public
|
|
72
|
-
*/
|
|
73
|
-
export interface AgentAliasRoute {
|
|
74
|
-
version: number;
|
|
75
|
-
/**
|
|
76
|
-
* Percentage of new sessions routed to this version. Weights of an alias must sum to 100.
|
|
77
|
-
* @public
|
|
78
|
-
*/
|
|
79
|
-
weight: number;
|
|
80
|
-
}
|
|
81
|
-
/**
|
|
82
|
-
* @public
|
|
83
|
-
*/
|
|
84
|
-
export interface AgentAlias {
|
|
85
|
-
/**
|
|
86
|
-
* Alias name, e.g. 'production', 'staging'.
|
|
87
|
-
* @public
|
|
88
|
-
*/
|
|
89
|
-
name: string;
|
|
90
|
-
agentId: string;
|
|
91
|
-
description?: string | undefined;
|
|
92
48
|
/**
|
|
93
|
-
*
|
|
49
|
+
* Usage scope. Defaults to `explicit` (only the listed grants).
|
|
94
50
|
* @public
|
|
95
51
|
*/
|
|
96
|
-
|
|
97
|
-
/**
|
|
98
|
-
* ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
|
|
99
|
-
* @public
|
|
100
|
-
*/
|
|
101
|
-
updatedAt: string;
|
|
52
|
+
visibility?: AgentVisibility | undefined;
|
|
102
53
|
/**
|
|
103
|
-
*
|
|
54
|
+
* Users and groups granted the ability to use the agent. Applies when visibility is `explicit`.
|
|
104
55
|
* @public
|
|
105
56
|
*/
|
|
106
|
-
|
|
107
|
-
}
|
|
108
|
-
/**
|
|
109
|
-
* @public
|
|
110
|
-
*/
|
|
111
|
-
export interface ApiChannelSettings {
|
|
112
|
-
enabled: boolean;
|
|
57
|
+
grants?: AgentGrantPrincipal[] | undefined;
|
|
113
58
|
}
|
|
114
59
|
/**
|
|
115
60
|
* @public
|
|
116
61
|
*/
|
|
117
62
|
export interface AssistantChannelSettings {
|
|
118
|
-
enabled: boolean;
|
|
119
63
|
/**
|
|
120
64
|
* Offer this agent as the default assistant for users covered by the agent access settings.
|
|
121
65
|
* @public
|
|
122
66
|
*/
|
|
123
67
|
default?: boolean | undefined;
|
|
124
68
|
}
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
export interface AutonomousChannelSettings {
|
|
73
|
+
}
|
|
125
74
|
/**
|
|
126
75
|
* @public
|
|
127
76
|
*/
|
|
128
77
|
export interface ChatChannelSettings {
|
|
129
|
-
enabled: boolean;
|
|
130
78
|
/**
|
|
131
|
-
* Whether users can find and add this agent to conversations.
|
|
79
|
+
* Whether users can find and add this agent to conversations. Maps from the legacy xbees-users bot `searchable`.
|
|
132
80
|
* @public
|
|
133
81
|
*/
|
|
134
82
|
discoverable?: boolean | undefined;
|
|
135
|
-
/**
|
|
136
|
-
* PBX group used for data ACL (e.g. Sales Intelligence lookups).
|
|
137
|
-
* @public
|
|
138
|
-
*/
|
|
139
|
-
pbxGroupId?: string | undefined;
|
|
140
|
-
/**
|
|
141
|
-
* Message posted when the agent joins a conversation.
|
|
142
|
-
* @public
|
|
143
|
-
*/
|
|
144
|
-
welcomeMessage?: string | undefined;
|
|
145
83
|
}
|
|
146
84
|
/**
|
|
147
85
|
* Caller context injected into the model prompt.
|
|
@@ -291,72 +229,134 @@ export interface VoiceSilenceTimeoutSettings {
|
|
|
291
229
|
action: VoiceTerminateAction;
|
|
292
230
|
}
|
|
293
231
|
/**
|
|
232
|
+
* Voice channel settings. Note: a voice agent's AgentAccess.grants are ignored — inbound calls are routed by the PBX dialplan and data ACL is the agent-level `settings.pbxGroupId`, not per-user grants.
|
|
294
233
|
* @public
|
|
295
234
|
*/
|
|
296
|
-
export interface
|
|
297
|
-
provider: SpeechProvider;
|
|
235
|
+
export interface VoiceChannelSettings {
|
|
298
236
|
/**
|
|
299
|
-
*
|
|
237
|
+
* Message spoken when the call starts. Maps from the legacy wim-voicebots `message`.
|
|
300
238
|
* @public
|
|
301
239
|
*/
|
|
302
|
-
|
|
240
|
+
greeting?: string | undefined;
|
|
241
|
+
interruptions?: VoiceInterruptionSettings | undefined;
|
|
242
|
+
silenceTimeout?: VoiceSilenceTimeoutSettings | undefined;
|
|
243
|
+
maxDuration?: VoiceMaxDurationSettings | undefined;
|
|
244
|
+
endCall?: VoiceEndCallSettings | undefined;
|
|
303
245
|
/**
|
|
304
|
-
*
|
|
246
|
+
* Caller context injected into the model prompt.
|
|
305
247
|
* @public
|
|
306
248
|
*/
|
|
307
|
-
|
|
249
|
+
callerMetadata?: VoiceCallerMetadataSettings | undefined;
|
|
308
250
|
}
|
|
309
251
|
/**
|
|
252
|
+
* The channels an agent serves and their channel-specific settings. Presence of a member enables that channel; at least one must be set. Enabled channels are mirrored as ChannelType values on AgentInfo.
|
|
310
253
|
* @public
|
|
311
254
|
*/
|
|
312
|
-
export interface
|
|
313
|
-
enabled: boolean;
|
|
255
|
+
export interface AgentChannels {
|
|
314
256
|
/**
|
|
315
|
-
*
|
|
257
|
+
* Voice channel settings. Note: a voice agent's AgentAccess.grants are ignored — inbound calls are routed by the PBX dialplan and data ACL is the agent-level `settings.pbxGroupId`, not per-user grants.
|
|
316
258
|
* @public
|
|
317
259
|
*/
|
|
318
|
-
|
|
319
|
-
|
|
260
|
+
voice?: VoiceChannelSettings | undefined;
|
|
261
|
+
chat?: ChatChannelSettings | undefined;
|
|
262
|
+
assistant?: AssistantChannelSettings | undefined;
|
|
263
|
+
autonomous?: AutonomousChannelSettings | undefined;
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
267
|
+
* @public
|
|
268
|
+
*/
|
|
269
|
+
export interface Actor {
|
|
270
|
+
type: ActorType;
|
|
320
271
|
/**
|
|
321
|
-
*
|
|
272
|
+
* User id, API key id or service name, depending on the actor type.
|
|
322
273
|
* @public
|
|
323
274
|
*/
|
|
324
|
-
|
|
325
|
-
interruptions?: VoiceInterruptionSettings | undefined;
|
|
326
|
-
silenceTimeout?: VoiceSilenceTimeoutSettings | undefined;
|
|
327
|
-
maxDuration?: VoiceMaxDurationSettings | undefined;
|
|
328
|
-
endCall?: VoiceEndCallSettings | undefined;
|
|
275
|
+
id: string;
|
|
329
276
|
/**
|
|
330
|
-
*
|
|
277
|
+
* Human readable name of the actor at the time of the action.
|
|
331
278
|
* @public
|
|
332
279
|
*/
|
|
333
|
-
|
|
280
|
+
name?: string | undefined;
|
|
334
281
|
}
|
|
335
282
|
/**
|
|
336
283
|
* @public
|
|
337
284
|
*/
|
|
338
|
-
export interface
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
285
|
+
export interface AgentDeploymentRoute {
|
|
286
|
+
/**
|
|
287
|
+
* Published agent version number. Monotonic within an agent's version history, starting at 1.
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
version: number;
|
|
291
|
+
/**
|
|
292
|
+
* Percentage of eligible new sessions routed to this version. Percentages in a deployment must sum to 100.
|
|
293
|
+
* @public
|
|
294
|
+
*/
|
|
295
|
+
percentage: number;
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* Standard audit fields carried by every managed resource.
|
|
299
|
+
* @public
|
|
300
|
+
*/
|
|
301
|
+
export interface AgentDeployment {
|
|
302
|
+
/**
|
|
303
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
304
|
+
* @public
|
|
305
|
+
*/
|
|
306
|
+
createdAt: string;
|
|
307
|
+
/**
|
|
308
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
309
|
+
* @public
|
|
310
|
+
*/
|
|
311
|
+
createdBy: Actor;
|
|
312
|
+
/**
|
|
313
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
314
|
+
* @public
|
|
315
|
+
*/
|
|
316
|
+
updatedAt?: string | undefined;
|
|
317
|
+
/**
|
|
318
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
319
|
+
* @public
|
|
320
|
+
*/
|
|
321
|
+
updatedBy?: Actor | undefined;
|
|
322
|
+
agentId: string;
|
|
323
|
+
/**
|
|
324
|
+
* Deployment name, e.g. 'production' or 'staging'. Sessions default to 'production' when no deployment, version or draft selector is provided.
|
|
325
|
+
* @public
|
|
326
|
+
*/
|
|
327
|
+
name: string;
|
|
328
|
+
description?: string | undefined;
|
|
329
|
+
status: AgentDeploymentStatus;
|
|
330
|
+
/**
|
|
331
|
+
* Weighted routing over distinct published versions. Percentages must sum to 100. Selection is deterministic for a session, and the resolved version is pinned for the session lifetime.
|
|
332
|
+
* @public
|
|
333
|
+
*/
|
|
334
|
+
routing: AgentDeploymentRoute[];
|
|
335
|
+
/**
|
|
336
|
+
* Monotonic revision incremented on every deployment update. Used for optimistic locking.
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
339
|
+
revision: number;
|
|
343
340
|
}
|
|
344
341
|
/**
|
|
342
|
+
* The model fills this variable itself, from conversation context. Included in the tool's input schema.
|
|
345
343
|
* @public
|
|
346
344
|
*/
|
|
347
345
|
export interface AgentToolVariableAutoHandler {
|
|
348
346
|
}
|
|
349
347
|
/**
|
|
348
|
+
* The model fills this variable, guided by this description. Included in the tool's input schema with the description attached.
|
|
350
349
|
* @public
|
|
351
350
|
*/
|
|
352
351
|
export interface AgentToolVariableGuidedHandler {
|
|
353
352
|
description: string;
|
|
354
353
|
}
|
|
355
354
|
/**
|
|
355
|
+
* A fixed value bound to the variable and injected directly into the tool call. Not exposed to the model (excluded from the tool's input schema). Supports handlebars templates resolved against agent variables and session context (e.g. '\{\{callerName\}\}').
|
|
356
356
|
* @public
|
|
357
357
|
*/
|
|
358
358
|
export interface AgentToolVariablePredefinedHandler {
|
|
359
|
-
|
|
359
|
+
value: string;
|
|
360
360
|
}
|
|
361
361
|
/**
|
|
362
362
|
* @public
|
|
@@ -366,18 +366,30 @@ export type AgentToolVariableHandler = AgentToolVariableHandler.AutoMember | Age
|
|
|
366
366
|
* @public
|
|
367
367
|
*/
|
|
368
368
|
export declare namespace AgentToolVariableHandler {
|
|
369
|
+
/**
|
|
370
|
+
* The model fills this variable itself, from conversation context. Included in the tool's input schema.
|
|
371
|
+
* @public
|
|
372
|
+
*/
|
|
369
373
|
interface AutoMember {
|
|
370
374
|
auto: AgentToolVariableAutoHandler;
|
|
371
375
|
guided?: never;
|
|
372
376
|
predefined?: never;
|
|
373
377
|
$unknown?: never;
|
|
374
378
|
}
|
|
379
|
+
/**
|
|
380
|
+
* The model fills this variable, guided by this description. Included in the tool's input schema with the description attached.
|
|
381
|
+
* @public
|
|
382
|
+
*/
|
|
375
383
|
interface GuidedMember {
|
|
376
384
|
auto?: never;
|
|
377
385
|
guided: AgentToolVariableGuidedHandler;
|
|
378
386
|
predefined?: never;
|
|
379
387
|
$unknown?: never;
|
|
380
388
|
}
|
|
389
|
+
/**
|
|
390
|
+
* A fixed value bound to the variable and injected directly into the tool call. Not exposed to the model (excluded from the tool's input schema). Supports handlebars templates resolved against agent variables and session context (e.g. '\{\{callerName\}\}').
|
|
391
|
+
* @public
|
|
392
|
+
*/
|
|
381
393
|
interface PredefinedMember {
|
|
382
394
|
auto?: never;
|
|
383
395
|
guided?: never;
|
|
@@ -416,84 +428,146 @@ export interface AgentToolVariable {
|
|
|
416
428
|
handler?: AgentToolVariableHandler | undefined;
|
|
417
429
|
}
|
|
418
430
|
/**
|
|
419
|
-
* Invoke another agent as a dedicated execution with its own state. The called agent runs independently and returns its result.
|
|
431
|
+
* Invoke another agent (typically an autonomous agent) as a dedicated execution with its own state. The called agent runs independently and returns its result.
|
|
420
432
|
* @public
|
|
421
433
|
*/
|
|
422
434
|
export interface AgentCallCapability {
|
|
423
435
|
agentId: string;
|
|
436
|
+
/**
|
|
437
|
+
* Pin a specific published version of the called agent. Mutually exclusive with agentDeployment.
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
agentVersion?: number | undefined;
|
|
441
|
+
/**
|
|
442
|
+
* Resolve the called agent through this deployment. When neither agentVersion nor agentDeployment is set, the called agent's 'production' deployment is resolved at invocation time.
|
|
443
|
+
* @public
|
|
444
|
+
*/
|
|
445
|
+
agentDeployment?: string | undefined;
|
|
446
|
+
/**
|
|
447
|
+
* Who may invoke this sub-agent tool. Evaluated per invoking user when the calling agent (chat / assistant) builds its
|
|
448
|
+
* toolset: if the user is not granted, this capability is omitted from the tools offered to the model for that session.
|
|
449
|
+
* When omitted, the tool is available to everyone who can use the calling agent. This is where an autonomous agent's
|
|
450
|
+
* invocation access is configured, since autonomous agents have no agent-level access of their own.
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
453
|
+
access?: AgentAccess | undefined;
|
|
424
454
|
variables?: AgentToolVariable[] | undefined;
|
|
425
455
|
}
|
|
426
456
|
/**
|
|
427
|
-
*
|
|
457
|
+
* Comment annotation emitted after a tool completes.
|
|
428
458
|
* @public
|
|
429
459
|
*/
|
|
430
|
-
export interface
|
|
460
|
+
export interface AgentToolCommentAnnotation {
|
|
431
461
|
/**
|
|
432
|
-
*
|
|
462
|
+
* Static handlebars expression resolved against agent variables and helpers.
|
|
433
463
|
* @public
|
|
434
464
|
*/
|
|
435
|
-
|
|
465
|
+
value?: string | undefined;
|
|
436
466
|
/**
|
|
437
|
-
*
|
|
467
|
+
* Apply when the tool succeeds.
|
|
438
468
|
* @public
|
|
439
469
|
*/
|
|
440
|
-
|
|
470
|
+
applyOnSuccess?: boolean | undefined;
|
|
471
|
+
/**
|
|
472
|
+
* Apply when the tool fails.
|
|
473
|
+
* @public
|
|
474
|
+
*/
|
|
475
|
+
applyOnFailure?: boolean | undefined;
|
|
441
476
|
}
|
|
442
477
|
/**
|
|
478
|
+
* Result annotation emitted after a tool completes.
|
|
443
479
|
* @public
|
|
444
480
|
*/
|
|
445
|
-
export interface
|
|
446
|
-
username: string;
|
|
447
|
-
password: string;
|
|
481
|
+
export interface AgentToolResultAnnotation {
|
|
448
482
|
}
|
|
449
483
|
/**
|
|
484
|
+
* Tag annotation emitted after a tool completes.
|
|
450
485
|
* @public
|
|
451
486
|
*/
|
|
452
|
-
export interface
|
|
453
|
-
|
|
487
|
+
export interface AgentToolTagAnnotation {
|
|
488
|
+
/**
|
|
489
|
+
* Static handlebars expression resolved against agent variables and helpers.
|
|
490
|
+
* @public
|
|
491
|
+
*/
|
|
492
|
+
value?: string | undefined;
|
|
493
|
+
/**
|
|
494
|
+
* Apply when the tool succeeds.
|
|
495
|
+
* @public
|
|
496
|
+
*/
|
|
497
|
+
applyOnSuccess?: boolean | undefined;
|
|
498
|
+
/**
|
|
499
|
+
* Apply when the tool fails.
|
|
500
|
+
* @public
|
|
501
|
+
*/
|
|
502
|
+
applyOnFailure?: boolean | undefined;
|
|
454
503
|
}
|
|
455
504
|
/**
|
|
505
|
+
* Variables annotation emitted after a tool completes.
|
|
456
506
|
* @public
|
|
457
507
|
*/
|
|
458
|
-
export interface
|
|
459
|
-
clientId: string;
|
|
460
|
-
clientSecret: string;
|
|
461
|
-
endpointUrl: string;
|
|
462
|
-
scope?: string | undefined;
|
|
508
|
+
export interface AgentToolVariablesAnnotation {
|
|
463
509
|
}
|
|
464
510
|
/**
|
|
511
|
+
* Configuration for annotations emitted after a tool completes.
|
|
465
512
|
* @public
|
|
466
513
|
*/
|
|
467
|
-
export type
|
|
514
|
+
export type AgentToolAnnotation = AgentToolAnnotation.CommentMember | AgentToolAnnotation.ResultMember | AgentToolAnnotation.TagMember | AgentToolAnnotation.VariablesMember | AgentToolAnnotation.$UnknownMember;
|
|
468
515
|
/**
|
|
469
516
|
* @public
|
|
470
517
|
*/
|
|
471
|
-
export declare namespace
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
518
|
+
export declare namespace AgentToolAnnotation {
|
|
519
|
+
/**
|
|
520
|
+
* Tag annotation emitted after a tool completes.
|
|
521
|
+
* @public
|
|
522
|
+
*/
|
|
523
|
+
interface TagMember {
|
|
524
|
+
tag: AgentToolTagAnnotation;
|
|
525
|
+
comment?: never;
|
|
526
|
+
variables?: never;
|
|
527
|
+
result?: never;
|
|
528
|
+
$unknown?: never;
|
|
529
|
+
}
|
|
530
|
+
/**
|
|
531
|
+
* Comment annotation emitted after a tool completes.
|
|
532
|
+
* @public
|
|
533
|
+
*/
|
|
534
|
+
interface CommentMember {
|
|
535
|
+
tag?: never;
|
|
536
|
+
comment: AgentToolCommentAnnotation;
|
|
537
|
+
variables?: never;
|
|
538
|
+
result?: never;
|
|
476
539
|
$unknown?: never;
|
|
477
540
|
}
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
541
|
+
/**
|
|
542
|
+
* Variables annotation emitted after a tool completes.
|
|
543
|
+
* @public
|
|
544
|
+
*/
|
|
545
|
+
interface VariablesMember {
|
|
546
|
+
tag?: never;
|
|
547
|
+
comment?: never;
|
|
548
|
+
variables: AgentToolVariablesAnnotation;
|
|
549
|
+
result?: never;
|
|
482
550
|
$unknown?: never;
|
|
483
551
|
}
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
552
|
+
/**
|
|
553
|
+
* Result annotation emitted after a tool completes.
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
interface ResultMember {
|
|
557
|
+
tag?: never;
|
|
558
|
+
comment?: never;
|
|
559
|
+
variables?: never;
|
|
560
|
+
result: AgentToolResultAnnotation;
|
|
488
561
|
$unknown?: never;
|
|
489
562
|
}
|
|
490
563
|
/**
|
|
491
564
|
* @public
|
|
492
565
|
*/
|
|
493
566
|
interface $UnknownMember {
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
567
|
+
tag?: never;
|
|
568
|
+
comment?: never;
|
|
569
|
+
variables?: never;
|
|
570
|
+
result?: never;
|
|
497
571
|
$unknown: [string, any];
|
|
498
572
|
}
|
|
499
573
|
/**
|
|
@@ -501,87 +575,55 @@ export declare namespace WebhookAuthorization {
|
|
|
501
575
|
*
|
|
502
576
|
*/
|
|
503
577
|
interface Visitor<T> {
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
578
|
+
tag: (value: AgentToolTagAnnotation) => T;
|
|
579
|
+
comment: (value: AgentToolCommentAnnotation) => T;
|
|
580
|
+
variables: (value: AgentToolVariablesAnnotation) => T;
|
|
581
|
+
result: (value: AgentToolResultAnnotation) => T;
|
|
507
582
|
_: (name: string, value: any) => T;
|
|
508
583
|
}
|
|
509
584
|
}
|
|
510
585
|
/**
|
|
586
|
+
* Delegate the conversation to another agent (max 3 transitions per turn). One capability entry per delegate target.
|
|
511
587
|
* @public
|
|
512
588
|
*/
|
|
513
|
-
export interface
|
|
514
|
-
name: string;
|
|
515
|
-
value: string;
|
|
516
|
-
}
|
|
517
|
-
/**
|
|
518
|
-
* @public
|
|
519
|
-
*/
|
|
520
|
-
export interface FunctionWebhookIntegration {
|
|
521
|
-
url: string;
|
|
522
|
-
method?: WebhookMethod | undefined;
|
|
589
|
+
export interface AgentDelegationCapability {
|
|
523
590
|
/**
|
|
524
|
-
*
|
|
591
|
+
* Tool name exposed to the model. Auto-generated when omitted.
|
|
525
592
|
* @public
|
|
526
593
|
*/
|
|
527
|
-
|
|
528
|
-
authorization?: WebhookAuthorization | undefined;
|
|
529
|
-
headers?: WebhookHeader[] | undefined;
|
|
594
|
+
name?: string | undefined;
|
|
530
595
|
/**
|
|
531
|
-
*
|
|
596
|
+
* Description for the model to decide when to delegate.
|
|
532
597
|
* @public
|
|
533
598
|
*/
|
|
534
|
-
|
|
599
|
+
description?: string | undefined;
|
|
535
600
|
/**
|
|
536
|
-
*
|
|
601
|
+
* Agent to delegate to.
|
|
537
602
|
* @public
|
|
538
603
|
*/
|
|
539
|
-
|
|
540
|
-
}
|
|
541
|
-
/**
|
|
542
|
-
* @public
|
|
543
|
-
*/
|
|
544
|
-
export type FunctionIntegration = FunctionIntegration.WebhookMember | FunctionIntegration.$UnknownMember;
|
|
545
|
-
/**
|
|
546
|
-
* @public
|
|
547
|
-
*/
|
|
548
|
-
export declare namespace FunctionIntegration {
|
|
549
|
-
interface WebhookMember {
|
|
550
|
-
webhook: FunctionWebhookIntegration;
|
|
551
|
-
$unknown?: never;
|
|
552
|
-
}
|
|
604
|
+
id: string;
|
|
553
605
|
/**
|
|
606
|
+
* Pin a specific published version of the delegate agent. Mutually exclusive with agentDeployment.
|
|
554
607
|
* @public
|
|
555
608
|
*/
|
|
556
|
-
|
|
557
|
-
webhook?: never;
|
|
558
|
-
$unknown: [string, any];
|
|
559
|
-
}
|
|
609
|
+
agentVersion?: number | undefined;
|
|
560
610
|
/**
|
|
561
|
-
*
|
|
562
|
-
*
|
|
611
|
+
* Resolve the delegate agent through this deployment. When neither agentVersion nor agentDeployment is set, the delegate's 'production' deployment is resolved at delegation time.
|
|
612
|
+
* @public
|
|
563
613
|
*/
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
_: (name: string, value: any) => T;
|
|
567
|
-
}
|
|
614
|
+
agentDeployment?: string | undefined;
|
|
615
|
+
annotations?: AgentToolAnnotation[] | undefined;
|
|
568
616
|
}
|
|
569
617
|
/**
|
|
570
618
|
* @public
|
|
571
619
|
*/
|
|
572
|
-
export interface
|
|
573
|
-
|
|
574
|
-
/**
|
|
575
|
-
* Used by the model to decide when to invoke the function.
|
|
576
|
-
* @public
|
|
577
|
-
*/
|
|
578
|
-
description?: string | undefined;
|
|
620
|
+
export interface AgentHandoverPipeline {
|
|
621
|
+
type?: AgentHandoverPipelineType | undefined;
|
|
579
622
|
/**
|
|
580
|
-
*
|
|
623
|
+
* Instructions for the model reply when type is REPLY_INSTRUCTED_AND_HANDOVER.
|
|
581
624
|
* @public
|
|
582
625
|
*/
|
|
583
|
-
|
|
584
|
-
integration?: FunctionIntegration | undefined;
|
|
626
|
+
instructions?: string | undefined;
|
|
585
627
|
}
|
|
586
628
|
/**
|
|
587
629
|
* Hand the conversation over to a human and leave it. Honoured on conversation channels (chat, assistant).
|
|
@@ -589,39 +631,84 @@ export interface AgentFunctionTool {
|
|
|
589
631
|
*/
|
|
590
632
|
export interface AgentHandoverCapability {
|
|
591
633
|
/**
|
|
592
|
-
*
|
|
634
|
+
* Tool name exposed to the model. Auto-generated when omitted.
|
|
593
635
|
* @public
|
|
594
636
|
*/
|
|
595
|
-
|
|
637
|
+
name?: string | undefined;
|
|
596
638
|
/**
|
|
597
|
-
*
|
|
639
|
+
* Description for the model to decide when to hand over.
|
|
598
640
|
* @public
|
|
599
641
|
*/
|
|
600
|
-
|
|
642
|
+
description?: string | undefined;
|
|
643
|
+
variant?: AgentHandoverVariant | undefined;
|
|
644
|
+
/**
|
|
645
|
+
* Wilma agent to hand over to when variant = AGENT.
|
|
646
|
+
* @public
|
|
647
|
+
*/
|
|
648
|
+
agent?: string | undefined;
|
|
649
|
+
/**
|
|
650
|
+
* Pin a specific published version of the target agent when variant = AGENT. Mutually exclusive with agentDeployment.
|
|
651
|
+
* @public
|
|
652
|
+
*/
|
|
653
|
+
agentVersion?: number | undefined;
|
|
654
|
+
/**
|
|
655
|
+
* Resolve the target agent through this deployment when variant = AGENT. When neither agentVersion nor agentDeployment is set, the target's 'production' deployment is resolved at handover time.
|
|
656
|
+
* @public
|
|
657
|
+
*/
|
|
658
|
+
agentDeployment?: string | undefined;
|
|
659
|
+
/**
|
|
660
|
+
* x-bees service id to hand over to when variant = SERVICE.
|
|
661
|
+
* @public
|
|
662
|
+
*/
|
|
663
|
+
service?: string | undefined;
|
|
664
|
+
/**
|
|
665
|
+
* Hand over without posting a visible message to the user.
|
|
666
|
+
* @public
|
|
667
|
+
*/
|
|
668
|
+
silent?: boolean | undefined;
|
|
669
|
+
pipeline?: AgentHandoverPipeline | undefined;
|
|
670
|
+
annotations?: AgentToolAnnotation[] | undefined;
|
|
601
671
|
}
|
|
602
672
|
/**
|
|
603
673
|
* @public
|
|
604
674
|
*/
|
|
605
|
-
export interface
|
|
606
|
-
|
|
675
|
+
export interface AgentHangupPipeline {
|
|
676
|
+
type?: AgentHangupPipelineType | undefined;
|
|
607
677
|
/**
|
|
608
|
-
*
|
|
678
|
+
* Instructions for the model reply when type is REPLY_INSTRUCTED_AND_HANGUP.
|
|
609
679
|
* @public
|
|
610
680
|
*/
|
|
611
681
|
instructions?: string | undefined;
|
|
612
682
|
}
|
|
613
683
|
/**
|
|
614
|
-
*
|
|
684
|
+
* Let the model end the call. Honoured on the voice channel. Maps from the wim-voicebots HANGUP embedded tool.
|
|
615
685
|
* @public
|
|
616
686
|
*/
|
|
617
|
-
export interface
|
|
618
|
-
|
|
619
|
-
|
|
687
|
+
export interface AgentHangupCapability {
|
|
688
|
+
/**
|
|
689
|
+
* Tool name exposed to the model. Auto-generated when omitted.
|
|
690
|
+
* @public
|
|
691
|
+
*/
|
|
692
|
+
name?: string | undefined;
|
|
620
693
|
/**
|
|
621
|
-
*
|
|
694
|
+
* Description for the model to decide when to hang up.
|
|
622
695
|
* @public
|
|
623
696
|
*/
|
|
624
|
-
|
|
697
|
+
description?: string | undefined;
|
|
698
|
+
pipeline?: AgentHangupPipeline | undefined;
|
|
699
|
+
annotations?: AgentToolAnnotation[] | undefined;
|
|
700
|
+
}
|
|
701
|
+
/**
|
|
702
|
+
* @public
|
|
703
|
+
*/
|
|
704
|
+
export interface AgentKnowledgeBase {
|
|
705
|
+
knowledgeBaseId?: string | undefined;
|
|
706
|
+
/**
|
|
707
|
+
* Additional instructions for when the agent should use this knowledge base.
|
|
708
|
+
* @public
|
|
709
|
+
*/
|
|
710
|
+
instructions?: string | undefined;
|
|
711
|
+
annotations?: AgentToolAnnotation[] | undefined;
|
|
625
712
|
}
|
|
626
713
|
/**
|
|
627
714
|
* Sandbox launched from a pre-built snapshot managed by the wilma-sandbox service.
|
|
@@ -716,10 +803,42 @@ export declare namespace AgentSandboxCapability {
|
|
|
716
803
|
}
|
|
717
804
|
}
|
|
718
805
|
/**
|
|
719
|
-
* Emit suggested replies for human operators
|
|
806
|
+
* Emit suggested replies for human operators. Honoured on the chat channel.
|
|
720
807
|
* @public
|
|
721
808
|
*/
|
|
722
809
|
export interface AgentSuggestionsCapability {
|
|
810
|
+
/**
|
|
811
|
+
* Tool name. Auto-generated when omitted.
|
|
812
|
+
* @public
|
|
813
|
+
*/
|
|
814
|
+
name?: string | undefined;
|
|
815
|
+
annotations?: AgentToolAnnotation[] | undefined;
|
|
816
|
+
}
|
|
817
|
+
/**
|
|
818
|
+
* Human-in-the-loop confirmation for a tool. Presence requires approval: the agent pauses before running the tool and the session user (whoever controls the session) approves or denies inline.
|
|
819
|
+
* @public
|
|
820
|
+
*/
|
|
821
|
+
export interface AgentToolApproval {
|
|
822
|
+
/**
|
|
823
|
+
* Optional message shown in the confirmation prompt. Supports handlebars against agent variables and the pending tool arguments. When omitted, a default prompt is shown.
|
|
824
|
+
* @public
|
|
825
|
+
*/
|
|
826
|
+
prompt?: string | undefined;
|
|
827
|
+
}
|
|
828
|
+
/**
|
|
829
|
+
* @public
|
|
830
|
+
*/
|
|
831
|
+
export interface AgentToolPipeline {
|
|
832
|
+
/**
|
|
833
|
+
* How the model waits for a tool and whether it synthesizes a reply from the result. Mirrors the legacy VoiceBot/Bot capability-tool pipeline.
|
|
834
|
+
* @public
|
|
835
|
+
*/
|
|
836
|
+
type?: AgentToolPipelineType | undefined;
|
|
837
|
+
/**
|
|
838
|
+
* Reply instructions for the *_GUIDED pipeline types. Use \{\{response\}\} to reference the tool result.
|
|
839
|
+
* @public
|
|
840
|
+
*/
|
|
841
|
+
instructions?: string | undefined;
|
|
723
842
|
}
|
|
724
843
|
/**
|
|
725
844
|
* @public
|
|
@@ -731,19 +850,85 @@ export interface AgentTool {
|
|
|
731
850
|
*/
|
|
732
851
|
id: string;
|
|
733
852
|
variables?: AgentToolVariable[] | undefined;
|
|
853
|
+
/**
|
|
854
|
+
* Message spoken when the tool call starts. Honoured on the voice channel. Maps from the legacy wim-voicebots capability-tool `startMessage`.
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
startMessage?: string | undefined;
|
|
858
|
+
/**
|
|
859
|
+
* How the model waits for the tool and whether it synthesizes a reply from the result.
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
862
|
+
pipeline?: AgentToolPipeline | undefined;
|
|
863
|
+
/**
|
|
864
|
+
* When present, the tool requires inline approval from the session user before it runs. New feature; no legacy equivalent.
|
|
865
|
+
* @public
|
|
866
|
+
*/
|
|
867
|
+
approval?: AgentToolApproval | undefined;
|
|
868
|
+
annotations?: AgentToolAnnotation[] | undefined;
|
|
734
869
|
}
|
|
735
870
|
/**
|
|
736
|
-
* Transfer the interaction to a PBX destination. Honoured on the voice channel.
|
|
737
871
|
* @public
|
|
738
872
|
*/
|
|
739
|
-
export interface
|
|
740
|
-
|
|
873
|
+
export interface AgentTransferPipeline {
|
|
874
|
+
type?: AgentTransferPipelineType | undefined;
|
|
741
875
|
/**
|
|
742
|
-
*
|
|
876
|
+
* Instructions for the model reply when type is REPLY_INSTRUCTED_AND_TRANSFER.
|
|
743
877
|
* @public
|
|
744
878
|
*/
|
|
745
879
|
instructions?: string | undefined;
|
|
746
880
|
}
|
|
881
|
+
/**
|
|
882
|
+
* Transfer the call to a PBX destination. Honoured on the voice channel. One capability entry per transfer target.
|
|
883
|
+
* @public
|
|
884
|
+
*/
|
|
885
|
+
export interface AgentTransferCapability {
|
|
886
|
+
/**
|
|
887
|
+
* Tool name exposed to the model. Auto-generated when omitted.
|
|
888
|
+
* @public
|
|
889
|
+
*/
|
|
890
|
+
name?: string | undefined;
|
|
891
|
+
/**
|
|
892
|
+
* Description for the model to decide when to transfer.
|
|
893
|
+
* @public
|
|
894
|
+
*/
|
|
895
|
+
description?: string | undefined;
|
|
896
|
+
variant?: AgentTransferVariant | undefined;
|
|
897
|
+
/**
|
|
898
|
+
* Routing context for PREDEFINED transfers.
|
|
899
|
+
* @public
|
|
900
|
+
*/
|
|
901
|
+
context?: string | undefined;
|
|
902
|
+
/**
|
|
903
|
+
* Extension or phone number for PREDEFINED transfers.
|
|
904
|
+
* @public
|
|
905
|
+
*/
|
|
906
|
+
extension?: string | undefined;
|
|
907
|
+
pipeline?: AgentTransferPipeline | undefined;
|
|
908
|
+
annotations?: AgentToolAnnotation[] | undefined;
|
|
909
|
+
}
|
|
910
|
+
/**
|
|
911
|
+
* Let the model hold the call while it works (e.g. a lookup), keeping the caller on the line. Honoured on the voice channel. Maps from the wim-voicebots WAIT embedded tool.
|
|
912
|
+
* @public
|
|
913
|
+
*/
|
|
914
|
+
export interface AgentWaitCapability {
|
|
915
|
+
/**
|
|
916
|
+
* Tool name exposed to the model. Auto-generated when omitted.
|
|
917
|
+
* @public
|
|
918
|
+
*/
|
|
919
|
+
name?: string | undefined;
|
|
920
|
+
/**
|
|
921
|
+
* Description for the model to decide when to wait.
|
|
922
|
+
* @public
|
|
923
|
+
*/
|
|
924
|
+
description?: string | undefined;
|
|
925
|
+
/**
|
|
926
|
+
* Message spoken when entering the wait state.
|
|
927
|
+
* @public
|
|
928
|
+
*/
|
|
929
|
+
message?: string | undefined;
|
|
930
|
+
annotations?: AgentToolAnnotation[] | undefined;
|
|
931
|
+
}
|
|
747
932
|
/**
|
|
748
933
|
* Server-side fetch of a URL, returning its readable text/markdown to the model.
|
|
749
934
|
* @public
|
|
@@ -792,54 +977,39 @@ export interface AgentWebSearchCapability {
|
|
|
792
977
|
/**
|
|
793
978
|
* @public
|
|
794
979
|
*/
|
|
795
|
-
export type AgentCapability = AgentCapability.AgentMember | AgentCapability.DelegationMember | AgentCapability.
|
|
980
|
+
export type AgentCapability = AgentCapability.AgentMember | AgentCapability.DelegationMember | AgentCapability.HandoverMember | AgentCapability.HangupMember | AgentCapability.KbMember | AgentCapability.SandboxMember | AgentCapability.SuggestionsMember | AgentCapability.ToolMember | AgentCapability.TransferMember | AgentCapability.WaitMember | AgentCapability.WebFetchMember | AgentCapability.WebSearchMember | AgentCapability.$UnknownMember;
|
|
796
981
|
/**
|
|
797
982
|
* @public
|
|
798
983
|
*/
|
|
799
984
|
export declare namespace AgentCapability {
|
|
800
985
|
interface ToolMember {
|
|
801
986
|
tool: AgentTool;
|
|
802
|
-
function?: never;
|
|
803
987
|
kb?: never;
|
|
804
988
|
sandbox?: never;
|
|
805
989
|
webSearch?: never;
|
|
806
990
|
webFetch?: never;
|
|
807
991
|
agent?: never;
|
|
808
|
-
mcp?: never;
|
|
809
|
-
handover?: never;
|
|
810
|
-
delegation?: never;
|
|
811
|
-
transfer?: never;
|
|
812
|
-
suggestions?: never;
|
|
813
|
-
$unknown?: never;
|
|
814
|
-
}
|
|
815
|
-
interface FunctionMember {
|
|
816
|
-
tool?: never;
|
|
817
|
-
function: AgentFunctionTool;
|
|
818
|
-
kb?: never;
|
|
819
|
-
sandbox?: never;
|
|
820
|
-
webSearch?: never;
|
|
821
|
-
webFetch?: never;
|
|
822
|
-
agent?: never;
|
|
823
|
-
mcp?: never;
|
|
824
992
|
handover?: never;
|
|
825
993
|
delegation?: never;
|
|
826
994
|
transfer?: never;
|
|
827
995
|
suggestions?: never;
|
|
996
|
+
hangup?: never;
|
|
997
|
+
wait?: never;
|
|
828
998
|
$unknown?: never;
|
|
829
999
|
}
|
|
830
1000
|
interface KbMember {
|
|
831
1001
|
tool?: never;
|
|
832
|
-
function?: never;
|
|
833
1002
|
kb: AgentKnowledgeBase;
|
|
834
1003
|
sandbox?: never;
|
|
835
1004
|
webSearch?: never;
|
|
836
1005
|
webFetch?: never;
|
|
837
1006
|
agent?: never;
|
|
838
|
-
mcp?: never;
|
|
839
1007
|
handover?: never;
|
|
840
1008
|
delegation?: never;
|
|
841
1009
|
transfer?: never;
|
|
842
1010
|
suggestions?: never;
|
|
1011
|
+
hangup?: never;
|
|
1012
|
+
wait?: never;
|
|
843
1013
|
$unknown?: never;
|
|
844
1014
|
}
|
|
845
1015
|
/**
|
|
@@ -848,17 +1018,17 @@ export declare namespace AgentCapability {
|
|
|
848
1018
|
*/
|
|
849
1019
|
interface SandboxMember {
|
|
850
1020
|
tool?: never;
|
|
851
|
-
function?: never;
|
|
852
1021
|
kb?: never;
|
|
853
1022
|
sandbox: AgentSandboxCapability;
|
|
854
1023
|
webSearch?: never;
|
|
855
1024
|
webFetch?: never;
|
|
856
1025
|
agent?: never;
|
|
857
|
-
mcp?: never;
|
|
858
1026
|
handover?: never;
|
|
859
1027
|
delegation?: never;
|
|
860
1028
|
transfer?: never;
|
|
861
1029
|
suggestions?: never;
|
|
1030
|
+
hangup?: never;
|
|
1031
|
+
wait?: never;
|
|
862
1032
|
$unknown?: never;
|
|
863
1033
|
}
|
|
864
1034
|
/**
|
|
@@ -867,17 +1037,17 @@ export declare namespace AgentCapability {
|
|
|
867
1037
|
*/
|
|
868
1038
|
interface WebSearchMember {
|
|
869
1039
|
tool?: never;
|
|
870
|
-
function?: never;
|
|
871
1040
|
kb?: never;
|
|
872
1041
|
sandbox?: never;
|
|
873
1042
|
webSearch: AgentWebSearchCapability;
|
|
874
1043
|
webFetch?: never;
|
|
875
1044
|
agent?: never;
|
|
876
|
-
mcp?: never;
|
|
877
1045
|
handover?: never;
|
|
878
1046
|
delegation?: never;
|
|
879
1047
|
transfer?: never;
|
|
880
1048
|
suggestions?: never;
|
|
1049
|
+
hangup?: never;
|
|
1050
|
+
wait?: never;
|
|
881
1051
|
$unknown?: never;
|
|
882
1052
|
}
|
|
883
1053
|
/**
|
|
@@ -886,131 +1056,150 @@ export declare namespace AgentCapability {
|
|
|
886
1056
|
*/
|
|
887
1057
|
interface WebFetchMember {
|
|
888
1058
|
tool?: never;
|
|
889
|
-
function?: never;
|
|
890
1059
|
kb?: never;
|
|
891
1060
|
sandbox?: never;
|
|
892
1061
|
webSearch?: never;
|
|
893
1062
|
webFetch: AgentWebFetchCapability;
|
|
894
1063
|
agent?: never;
|
|
895
|
-
mcp?: never;
|
|
896
1064
|
handover?: never;
|
|
897
1065
|
delegation?: never;
|
|
898
1066
|
transfer?: never;
|
|
899
1067
|
suggestions?: never;
|
|
1068
|
+
hangup?: never;
|
|
1069
|
+
wait?: never;
|
|
900
1070
|
$unknown?: never;
|
|
901
1071
|
}
|
|
902
1072
|
/**
|
|
903
|
-
* Invoke another agent as a dedicated execution with its own state. The called agent runs independently and returns its result.
|
|
1073
|
+
* Invoke another agent (typically an autonomous agent) as a dedicated execution with its own state. The called agent runs independently and returns its result.
|
|
904
1074
|
* @public
|
|
905
1075
|
*/
|
|
906
1076
|
interface AgentMember {
|
|
907
1077
|
tool?: never;
|
|
908
|
-
function?: never;
|
|
909
1078
|
kb?: never;
|
|
910
1079
|
sandbox?: never;
|
|
911
1080
|
webSearch?: never;
|
|
912
1081
|
webFetch?: never;
|
|
913
1082
|
agent: AgentCallCapability;
|
|
914
|
-
mcp?: never;
|
|
915
1083
|
handover?: never;
|
|
916
1084
|
delegation?: never;
|
|
917
1085
|
transfer?: never;
|
|
918
1086
|
suggestions?: never;
|
|
1087
|
+
hangup?: never;
|
|
1088
|
+
wait?: never;
|
|
919
1089
|
$unknown?: never;
|
|
920
1090
|
}
|
|
921
1091
|
/**
|
|
922
|
-
*
|
|
1092
|
+
* Hand the conversation over to a human and leave it. Honoured on conversation channels (chat, assistant).
|
|
923
1093
|
* @public
|
|
924
1094
|
*/
|
|
925
|
-
interface
|
|
1095
|
+
interface HandoverMember {
|
|
926
1096
|
tool?: never;
|
|
927
|
-
function?: never;
|
|
928
1097
|
kb?: never;
|
|
929
1098
|
sandbox?: never;
|
|
930
1099
|
webSearch?: never;
|
|
931
1100
|
webFetch?: never;
|
|
932
1101
|
agent?: never;
|
|
933
|
-
|
|
934
|
-
handover?: never;
|
|
1102
|
+
handover: AgentHandoverCapability;
|
|
935
1103
|
delegation?: never;
|
|
936
1104
|
transfer?: never;
|
|
937
1105
|
suggestions?: never;
|
|
1106
|
+
hangup?: never;
|
|
1107
|
+
wait?: never;
|
|
938
1108
|
$unknown?: never;
|
|
939
1109
|
}
|
|
940
1110
|
/**
|
|
941
|
-
*
|
|
1111
|
+
* Delegate the conversation to another agent (max 3 transitions per turn). One capability entry per delegate target.
|
|
942
1112
|
* @public
|
|
943
1113
|
*/
|
|
944
|
-
interface
|
|
1114
|
+
interface DelegationMember {
|
|
945
1115
|
tool?: never;
|
|
946
|
-
function?: never;
|
|
947
1116
|
kb?: never;
|
|
948
1117
|
sandbox?: never;
|
|
949
1118
|
webSearch?: never;
|
|
950
1119
|
webFetch?: never;
|
|
951
1120
|
agent?: never;
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
delegation?: never;
|
|
1121
|
+
handover?: never;
|
|
1122
|
+
delegation: AgentDelegationCapability;
|
|
955
1123
|
transfer?: never;
|
|
956
1124
|
suggestions?: never;
|
|
1125
|
+
hangup?: never;
|
|
1126
|
+
wait?: never;
|
|
957
1127
|
$unknown?: never;
|
|
958
1128
|
}
|
|
959
1129
|
/**
|
|
960
|
-
*
|
|
1130
|
+
* Transfer the call to a PBX destination. Honoured on the voice channel. One capability entry per transfer target.
|
|
961
1131
|
* @public
|
|
962
1132
|
*/
|
|
963
|
-
interface
|
|
1133
|
+
interface TransferMember {
|
|
964
1134
|
tool?: never;
|
|
965
|
-
function?: never;
|
|
966
1135
|
kb?: never;
|
|
967
1136
|
sandbox?: never;
|
|
968
1137
|
webSearch?: never;
|
|
969
1138
|
webFetch?: never;
|
|
970
1139
|
agent?: never;
|
|
971
|
-
mcp?: never;
|
|
972
1140
|
handover?: never;
|
|
973
|
-
delegation
|
|
974
|
-
transfer
|
|
1141
|
+
delegation?: never;
|
|
1142
|
+
transfer: AgentTransferCapability;
|
|
975
1143
|
suggestions?: never;
|
|
1144
|
+
hangup?: never;
|
|
1145
|
+
wait?: never;
|
|
976
1146
|
$unknown?: never;
|
|
977
1147
|
}
|
|
978
1148
|
/**
|
|
979
|
-
*
|
|
1149
|
+
* Emit suggested replies for human operators. Honoured on the chat channel.
|
|
980
1150
|
* @public
|
|
981
1151
|
*/
|
|
982
|
-
interface
|
|
1152
|
+
interface SuggestionsMember {
|
|
983
1153
|
tool?: never;
|
|
984
|
-
function?: never;
|
|
985
1154
|
kb?: never;
|
|
986
1155
|
sandbox?: never;
|
|
987
1156
|
webSearch?: never;
|
|
988
1157
|
webFetch?: never;
|
|
989
1158
|
agent?: never;
|
|
990
|
-
mcp?: never;
|
|
991
1159
|
handover?: never;
|
|
992
1160
|
delegation?: never;
|
|
993
|
-
transfer
|
|
1161
|
+
transfer?: never;
|
|
1162
|
+
suggestions: AgentSuggestionsCapability;
|
|
1163
|
+
hangup?: never;
|
|
1164
|
+
wait?: never;
|
|
1165
|
+
$unknown?: never;
|
|
1166
|
+
}
|
|
1167
|
+
/**
|
|
1168
|
+
* Let the model end the call. Honoured on the voice channel. Maps from the wim-voicebots HANGUP embedded tool.
|
|
1169
|
+
* @public
|
|
1170
|
+
*/
|
|
1171
|
+
interface HangupMember {
|
|
1172
|
+
tool?: never;
|
|
1173
|
+
kb?: never;
|
|
1174
|
+
sandbox?: never;
|
|
1175
|
+
webSearch?: never;
|
|
1176
|
+
webFetch?: never;
|
|
1177
|
+
agent?: never;
|
|
1178
|
+
handover?: never;
|
|
1179
|
+
delegation?: never;
|
|
1180
|
+
transfer?: never;
|
|
994
1181
|
suggestions?: never;
|
|
1182
|
+
hangup: AgentHangupCapability;
|
|
1183
|
+
wait?: never;
|
|
995
1184
|
$unknown?: never;
|
|
996
1185
|
}
|
|
997
1186
|
/**
|
|
998
|
-
*
|
|
1187
|
+
* Let the model hold the call while it works (e.g. a lookup), keeping the caller on the line. Honoured on the voice channel. Maps from the wim-voicebots WAIT embedded tool.
|
|
999
1188
|
* @public
|
|
1000
1189
|
*/
|
|
1001
|
-
interface
|
|
1190
|
+
interface WaitMember {
|
|
1002
1191
|
tool?: never;
|
|
1003
|
-
function?: never;
|
|
1004
1192
|
kb?: never;
|
|
1005
1193
|
sandbox?: never;
|
|
1006
1194
|
webSearch?: never;
|
|
1007
1195
|
webFetch?: never;
|
|
1008
1196
|
agent?: never;
|
|
1009
|
-
mcp?: never;
|
|
1010
1197
|
handover?: never;
|
|
1011
1198
|
delegation?: never;
|
|
1012
1199
|
transfer?: never;
|
|
1013
|
-
suggestions
|
|
1200
|
+
suggestions?: never;
|
|
1201
|
+
hangup?: never;
|
|
1202
|
+
wait: AgentWaitCapability;
|
|
1014
1203
|
$unknown?: never;
|
|
1015
1204
|
}
|
|
1016
1205
|
/**
|
|
@@ -1018,17 +1207,17 @@ export declare namespace AgentCapability {
|
|
|
1018
1207
|
*/
|
|
1019
1208
|
interface $UnknownMember {
|
|
1020
1209
|
tool?: never;
|
|
1021
|
-
function?: never;
|
|
1022
1210
|
kb?: never;
|
|
1023
1211
|
sandbox?: never;
|
|
1024
1212
|
webSearch?: never;
|
|
1025
1213
|
webFetch?: never;
|
|
1026
1214
|
agent?: never;
|
|
1027
|
-
mcp?: never;
|
|
1028
1215
|
handover?: never;
|
|
1029
1216
|
delegation?: never;
|
|
1030
1217
|
transfer?: never;
|
|
1031
1218
|
suggestions?: never;
|
|
1219
|
+
hangup?: never;
|
|
1220
|
+
wait?: never;
|
|
1032
1221
|
$unknown: [string, any];
|
|
1033
1222
|
}
|
|
1034
1223
|
/**
|
|
@@ -1037,20 +1226,37 @@ export declare namespace AgentCapability {
|
|
|
1037
1226
|
*/
|
|
1038
1227
|
interface Visitor<T> {
|
|
1039
1228
|
tool: (value: AgentTool) => T;
|
|
1040
|
-
function: (value: AgentFunctionTool) => T;
|
|
1041
1229
|
kb: (value: AgentKnowledgeBase) => T;
|
|
1042
1230
|
sandbox: (value: AgentSandboxCapability) => T;
|
|
1043
1231
|
webSearch: (value: AgentWebSearchCapability) => T;
|
|
1044
1232
|
webFetch: (value: AgentWebFetchCapability) => T;
|
|
1045
1233
|
agent: (value: AgentCallCapability) => T;
|
|
1046
|
-
mcp: (value: AgentMcpServerCapability) => T;
|
|
1047
1234
|
handover: (value: AgentHandoverCapability) => T;
|
|
1048
1235
|
delegation: (value: AgentDelegationCapability) => T;
|
|
1049
1236
|
transfer: (value: AgentTransferCapability) => T;
|
|
1050
1237
|
suggestions: (value: AgentSuggestionsCapability) => T;
|
|
1238
|
+
hangup: (value: AgentHangupCapability) => T;
|
|
1239
|
+
wait: (value: AgentWaitCapability) => T;
|
|
1051
1240
|
_: (name: string, value: any) => T;
|
|
1052
1241
|
}
|
|
1053
1242
|
}
|
|
1243
|
+
/**
|
|
1244
|
+
* Reference to a skill attached to an agent.
|
|
1245
|
+
* @public
|
|
1246
|
+
*/
|
|
1247
|
+
export interface AgentSkillReference {
|
|
1248
|
+
id: string;
|
|
1249
|
+
/**
|
|
1250
|
+
* Pin a specific published skill version. When omitted, latestVersion is resolved.
|
|
1251
|
+
* @public
|
|
1252
|
+
*/
|
|
1253
|
+
skillVersion?: number | undefined;
|
|
1254
|
+
/**
|
|
1255
|
+
* Override access for this skill on this agent. When omitted, the agent's default access policy applies.
|
|
1256
|
+
* @public
|
|
1257
|
+
*/
|
|
1258
|
+
access?: AgentAccess | undefined;
|
|
1259
|
+
}
|
|
1054
1260
|
/**
|
|
1055
1261
|
* @public
|
|
1056
1262
|
*/
|
|
@@ -1065,10 +1271,10 @@ export interface AgentVariable {
|
|
|
1065
1271
|
description?: string | undefined;
|
|
1066
1272
|
}
|
|
1067
1273
|
/**
|
|
1068
|
-
* Managed
|
|
1274
|
+
* Managed AI engine: the platform runs the model, tools and knowledge lookups.
|
|
1069
1275
|
* @public
|
|
1070
1276
|
*/
|
|
1071
|
-
export interface
|
|
1277
|
+
export interface AgentAiEngine {
|
|
1072
1278
|
instructions: string;
|
|
1073
1279
|
/**
|
|
1074
1280
|
* Defaults to the platform default model when omitted.
|
|
@@ -1079,7 +1285,7 @@ export interface AgentLlmEngine {
|
|
|
1079
1285
|
* Skills attached to this agent (progressive disclosure).
|
|
1080
1286
|
* @public
|
|
1081
1287
|
*/
|
|
1082
|
-
skills?:
|
|
1288
|
+
skills?: AgentSkillReference[] | undefined;
|
|
1083
1289
|
capabilities?: AgentCapability[] | undefined;
|
|
1084
1290
|
variables?: AgentVariable[] | undefined;
|
|
1085
1291
|
}
|
|
@@ -1106,19 +1312,20 @@ export interface AgentWebhookEngine {
|
|
|
1106
1312
|
timeout?: number | undefined;
|
|
1107
1313
|
}
|
|
1108
1314
|
/**
|
|
1315
|
+
* How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend. The legacy Dialogflow CX and OpenAI Assistant backends are intentionally not carried over.
|
|
1109
1316
|
* @public
|
|
1110
1317
|
*/
|
|
1111
|
-
export type AgentEngine = AgentEngine.
|
|
1318
|
+
export type AgentEngine = AgentEngine.AiMember | AgentEngine.SqsMember | AgentEngine.WebhookMember | AgentEngine.$UnknownMember;
|
|
1112
1319
|
/**
|
|
1113
1320
|
* @public
|
|
1114
1321
|
*/
|
|
1115
1322
|
export declare namespace AgentEngine {
|
|
1116
1323
|
/**
|
|
1117
|
-
* Managed
|
|
1324
|
+
* Managed AI engine: the platform runs the model, tools and knowledge lookups.
|
|
1118
1325
|
* @public
|
|
1119
1326
|
*/
|
|
1120
|
-
interface
|
|
1121
|
-
|
|
1327
|
+
interface AiMember {
|
|
1328
|
+
ai: AgentAiEngine;
|
|
1122
1329
|
webhook?: never;
|
|
1123
1330
|
sqs?: never;
|
|
1124
1331
|
$unknown?: never;
|
|
@@ -1128,7 +1335,7 @@ export declare namespace AgentEngine {
|
|
|
1128
1335
|
* @public
|
|
1129
1336
|
*/
|
|
1130
1337
|
interface WebhookMember {
|
|
1131
|
-
|
|
1338
|
+
ai?: never;
|
|
1132
1339
|
webhook: AgentWebhookEngine;
|
|
1133
1340
|
sqs?: never;
|
|
1134
1341
|
$unknown?: never;
|
|
@@ -1138,7 +1345,7 @@ export declare namespace AgentEngine {
|
|
|
1138
1345
|
* @public
|
|
1139
1346
|
*/
|
|
1140
1347
|
interface SqsMember {
|
|
1141
|
-
|
|
1348
|
+
ai?: never;
|
|
1142
1349
|
webhook?: never;
|
|
1143
1350
|
sqs: AgentSqsEngine;
|
|
1144
1351
|
$unknown?: never;
|
|
@@ -1147,7 +1354,7 @@ export declare namespace AgentEngine {
|
|
|
1147
1354
|
* @public
|
|
1148
1355
|
*/
|
|
1149
1356
|
interface $UnknownMember {
|
|
1150
|
-
|
|
1357
|
+
ai?: never;
|
|
1151
1358
|
webhook?: never;
|
|
1152
1359
|
sqs?: never;
|
|
1153
1360
|
$unknown: [string, any];
|
|
@@ -1157,12 +1364,23 @@ export declare namespace AgentEngine {
|
|
|
1157
1364
|
*
|
|
1158
1365
|
*/
|
|
1159
1366
|
interface Visitor<T> {
|
|
1160
|
-
|
|
1367
|
+
ai: (value: AgentAiEngine) => T;
|
|
1161
1368
|
webhook: (value: AgentWebhookEngine) => T;
|
|
1162
1369
|
sqs: (value: AgentSqsEngine) => T;
|
|
1163
1370
|
_: (name: string, value: any) => T;
|
|
1164
1371
|
}
|
|
1165
1372
|
}
|
|
1373
|
+
/**
|
|
1374
|
+
* Agent-level settings shared across all channels.
|
|
1375
|
+
* @public
|
|
1376
|
+
*/
|
|
1377
|
+
export interface AgentSettings {
|
|
1378
|
+
/**
|
|
1379
|
+
* PBX group used for data ACL (e.g. Sales Intelligence lookups). Maps from the legacy wim-voicebots / xbees-users bot `groupId`.
|
|
1380
|
+
* @public
|
|
1381
|
+
*/
|
|
1382
|
+
pbxGroupId?: string | undefined;
|
|
1383
|
+
}
|
|
1166
1384
|
/**
|
|
1167
1385
|
* The complete, versionable configuration of an agent. This is what gets snapshotted when a version is published.
|
|
1168
1386
|
* @public
|
|
@@ -1180,20 +1398,31 @@ export interface Agent {
|
|
|
1180
1398
|
* @public
|
|
1181
1399
|
*/
|
|
1182
1400
|
picture?: string | undefined;
|
|
1401
|
+
/**
|
|
1402
|
+
* The channels this agent serves and their channel-specific settings. A channel is enabled when its member is present; at least one must be set. An agent may serve multiple channels (e.g. chat + assistant) over the shared engine.
|
|
1403
|
+
* @public
|
|
1404
|
+
*/
|
|
1405
|
+
channels: AgentChannels;
|
|
1406
|
+
/**
|
|
1407
|
+
* How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend. The legacy Dialogflow CX and OpenAI Assistant backends are intentionally not carried over.
|
|
1408
|
+
* @public
|
|
1409
|
+
*/
|
|
1183
1410
|
engine: AgentEngine;
|
|
1184
1411
|
/**
|
|
1185
|
-
*
|
|
1412
|
+
* Agent-level settings shared across all channels.
|
|
1186
1413
|
* @public
|
|
1187
1414
|
*/
|
|
1188
|
-
|
|
1415
|
+
settings?: AgentSettings | undefined;
|
|
1189
1416
|
/**
|
|
1190
|
-
*
|
|
1417
|
+
* Who is allowed to use the agent. There is no view/edit dimension — access solely grants the ability to use the agent.
|
|
1418
|
+
* Per channel: on `chat` and `assistant` agents `grants` govern which colleagues can use the agent; on `voice` agents `grants`
|
|
1419
|
+
* are ignored (inbound calls are routed by the PBX dialplan, and data ACL is the agent-level `settings.pbxGroupId`); on `autonomous` agents agent-level
|
|
1420
|
+
* access is not used — invocation access is configured per reference on the calling agent (see AgentCallCapability.access).
|
|
1191
1421
|
* @public
|
|
1192
1422
|
*/
|
|
1193
|
-
guardrails?: string[] | undefined;
|
|
1194
1423
|
access?: AgentAccess | undefined;
|
|
1195
1424
|
/**
|
|
1196
|
-
* ISO-8601 timestamp, e.g. '2026-07-
|
|
1425
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1197
1426
|
* @public
|
|
1198
1427
|
*/
|
|
1199
1428
|
createdAt: string;
|
|
@@ -1203,7 +1432,7 @@ export interface Agent {
|
|
|
1203
1432
|
*/
|
|
1204
1433
|
createdBy: Actor;
|
|
1205
1434
|
/**
|
|
1206
|
-
* ISO-8601 timestamp, e.g. '2026-07-
|
|
1435
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1207
1436
|
* @public
|
|
1208
1437
|
*/
|
|
1209
1438
|
updatedAt?: string | undefined;
|
|
@@ -1225,10 +1454,15 @@ export interface Agent {
|
|
|
1225
1454
|
*/
|
|
1226
1455
|
latestVersion?: number | undefined;
|
|
1227
1456
|
/**
|
|
1228
|
-
*
|
|
1457
|
+
* Published version number from which the current draft originated. Absent before the first version is published.
|
|
1458
|
+
* @public
|
|
1459
|
+
*/
|
|
1460
|
+
draftBaseVersion?: number | undefined;
|
|
1461
|
+
/**
|
|
1462
|
+
* Named deployment configurations routing new sessions to published versions.
|
|
1229
1463
|
* @public
|
|
1230
1464
|
*/
|
|
1231
|
-
|
|
1465
|
+
deployments?: AgentDeployment[] | undefined;
|
|
1232
1466
|
}
|
|
1233
1467
|
/**
|
|
1234
1468
|
* @public
|
|
@@ -1242,7 +1476,7 @@ export interface AgentApiKey {
|
|
|
1242
1476
|
*/
|
|
1243
1477
|
prefix: string;
|
|
1244
1478
|
/**
|
|
1245
|
-
* ISO-8601 timestamp, e.g. '2026-07-
|
|
1479
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1246
1480
|
* @public
|
|
1247
1481
|
*/
|
|
1248
1482
|
createdAt: string;
|
|
@@ -1252,12 +1486,12 @@ export interface AgentApiKey {
|
|
|
1252
1486
|
*/
|
|
1253
1487
|
createdBy: Actor;
|
|
1254
1488
|
/**
|
|
1255
|
-
* ISO-8601 timestamp, e.g. '2026-07-
|
|
1489
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1256
1490
|
* @public
|
|
1257
1491
|
*/
|
|
1258
1492
|
expiresAt?: string | undefined;
|
|
1259
1493
|
/**
|
|
1260
|
-
* ISO-8601 timestamp, e.g. '2026-07-
|
|
1494
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1261
1495
|
* @public
|
|
1262
1496
|
*/
|
|
1263
1497
|
lastUsedAt?: string | undefined;
|
|
@@ -1279,92 +1513,29 @@ export interface AgentDefinitionSnapshot {
|
|
|
1279
1513
|
* @public
|
|
1280
1514
|
*/
|
|
1281
1515
|
picture?: string | undefined;
|
|
1282
|
-
engine: AgentEngine;
|
|
1283
1516
|
/**
|
|
1284
|
-
*
|
|
1517
|
+
* The channels this agent serves and their channel-specific settings. A channel is enabled when its member is present; at least one must be set. An agent may serve multiple channels (e.g. chat + assistant) over the shared engine.
|
|
1285
1518
|
* @public
|
|
1286
1519
|
*/
|
|
1287
|
-
channels
|
|
1520
|
+
channels: AgentChannels;
|
|
1288
1521
|
/**
|
|
1289
|
-
*
|
|
1522
|
+
* How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend. The legacy Dialogflow CX and OpenAI Assistant backends are intentionally not carried over.
|
|
1290
1523
|
* @public
|
|
1291
1524
|
*/
|
|
1292
|
-
|
|
1293
|
-
access?: AgentAccess | undefined;
|
|
1294
|
-
}
|
|
1295
|
-
/**
|
|
1296
|
-
* @public
|
|
1297
|
-
*/
|
|
1298
|
-
export interface AgentExecutionError {
|
|
1299
|
-
message: string;
|
|
1300
|
-
/**
|
|
1301
|
-
* Machine-readable error code, e.g. 'guardrail_blocked', 'engine_error'.
|
|
1302
|
-
* @public
|
|
1303
|
-
*/
|
|
1304
|
-
code?: string | undefined;
|
|
1305
|
-
}
|
|
1306
|
-
/**
|
|
1307
|
-
* A file produced (or shared) by an agent during a session or execution. Content lives in object storage; download via the Files API.
|
|
1308
|
-
* @public
|
|
1309
|
-
*/
|
|
1310
|
-
export interface AgentFile {
|
|
1311
|
-
/**
|
|
1312
|
-
* Nano-id file identifier (12 characters).
|
|
1313
|
-
* @public
|
|
1314
|
-
*/
|
|
1315
|
-
id: string;
|
|
1316
|
-
name: string;
|
|
1317
|
-
/**
|
|
1318
|
-
* MIME type, e.g. 'text/csv'.
|
|
1319
|
-
* @public
|
|
1320
|
-
*/
|
|
1321
|
-
contentType?: string | undefined;
|
|
1322
|
-
/**
|
|
1323
|
-
* Size in bytes.
|
|
1324
|
-
* @public
|
|
1325
|
-
*/
|
|
1326
|
-
size?: number | undefined;
|
|
1327
|
-
/**
|
|
1328
|
-
* Intended audience. Defaults to USER.
|
|
1329
|
-
* @public
|
|
1330
|
-
*/
|
|
1331
|
-
scope?: AgentFileScope | undefined;
|
|
1332
|
-
/**
|
|
1333
|
-
* Agent that created the file.
|
|
1334
|
-
* @public
|
|
1335
|
-
*/
|
|
1336
|
-
agentId?: string | undefined;
|
|
1337
|
-
/**
|
|
1338
|
-
* Session that created the file.
|
|
1339
|
-
* @public
|
|
1340
|
-
*/
|
|
1341
|
-
sessionId?: string | undefined;
|
|
1342
|
-
/**
|
|
1343
|
-
* ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
|
|
1344
|
-
* @public
|
|
1345
|
-
*/
|
|
1346
|
-
createdAt: string;
|
|
1347
|
-
}
|
|
1348
|
-
/**
|
|
1349
|
-
* @public
|
|
1350
|
-
*/
|
|
1351
|
-
export interface AgentExecutionResult {
|
|
1352
|
-
/**
|
|
1353
|
-
* Output of the execution.
|
|
1354
|
-
* @public
|
|
1355
|
-
*/
|
|
1356
|
-
output?: __DocumentType | undefined;
|
|
1357
|
-
error?: AgentExecutionError | undefined;
|
|
1525
|
+
engine: AgentEngine;
|
|
1358
1526
|
/**
|
|
1359
|
-
*
|
|
1527
|
+
* Agent-level settings shared across all channels.
|
|
1360
1528
|
* @public
|
|
1361
1529
|
*/
|
|
1362
|
-
|
|
1530
|
+
settings?: AgentSettings | undefined;
|
|
1363
1531
|
/**
|
|
1364
|
-
*
|
|
1532
|
+
* Who is allowed to use the agent. There is no view/edit dimension — access solely grants the ability to use the agent.
|
|
1533
|
+
* Per channel: on `chat` and `assistant` agents `grants` govern which colleagues can use the agent; on `voice` agents `grants`
|
|
1534
|
+
* are ignored (inbound calls are routed by the PBX dialplan, and data ACL is the agent-level `settings.pbxGroupId`); on `autonomous` agents agent-level
|
|
1535
|
+
* access is not used — invocation access is configured per reference on the calling agent (see AgentCallCapability.access).
|
|
1365
1536
|
* @public
|
|
1366
1537
|
*/
|
|
1367
|
-
|
|
1538
|
+
access?: AgentAccess | undefined;
|
|
1368
1539
|
}
|
|
1369
1540
|
/**
|
|
1370
1541
|
* @public
|
|
@@ -1375,10 +1546,14 @@ export interface AgentInfo {
|
|
|
1375
1546
|
category?: string | undefined;
|
|
1376
1547
|
status: AgentStatus;
|
|
1377
1548
|
/**
|
|
1378
|
-
*
|
|
1549
|
+
* The channels this agent serves (voice / chat / assistant / autonomous).
|
|
1550
|
+
* @public
|
|
1551
|
+
*/
|
|
1552
|
+
channels: ChannelType[];
|
|
1553
|
+
/**
|
|
1554
|
+
* Published agent version number. Monotonic within an agent's version history, starting at 1.
|
|
1379
1555
|
* @public
|
|
1380
1556
|
*/
|
|
1381
|
-
channels?: ChannelType[] | undefined;
|
|
1382
1557
|
latestVersion?: number | undefined;
|
|
1383
1558
|
}
|
|
1384
1559
|
/**
|
|
@@ -1387,10 +1562,20 @@ export interface AgentInfo {
|
|
|
1387
1562
|
export interface AgentVersion {
|
|
1388
1563
|
agentId: string;
|
|
1389
1564
|
/**
|
|
1390
|
-
* Monotonic version
|
|
1565
|
+
* Published agent version number. Monotonic within an agent's version history, starting at 1.
|
|
1391
1566
|
* @public
|
|
1392
1567
|
*/
|
|
1393
1568
|
version: number;
|
|
1569
|
+
/**
|
|
1570
|
+
* Published version from which the draft originated. Absent for the first version of a new agent.
|
|
1571
|
+
* @public
|
|
1572
|
+
*/
|
|
1573
|
+
basedOnVersion?: number | undefined;
|
|
1574
|
+
/**
|
|
1575
|
+
* Optional human-readable name supplied at publish time.
|
|
1576
|
+
* @public
|
|
1577
|
+
*/
|
|
1578
|
+
name?: string | undefined;
|
|
1394
1579
|
/**
|
|
1395
1580
|
* What changed in this version, provided at publish time.
|
|
1396
1581
|
* @public
|
|
@@ -1402,7 +1587,7 @@ export interface AgentVersion {
|
|
|
1402
1587
|
*/
|
|
1403
1588
|
definition: AgentDefinitionSnapshot;
|
|
1404
1589
|
/**
|
|
1405
|
-
* ISO-8601 timestamp, e.g. '2026-07-
|
|
1590
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1406
1591
|
* @public
|
|
1407
1592
|
*/
|
|
1408
1593
|
publishedAt: string;
|
|
@@ -1417,7 +1602,7 @@ export interface AgentVersion {
|
|
|
1417
1602
|
*/
|
|
1418
1603
|
export interface AgentVersionChange {
|
|
1419
1604
|
/**
|
|
1420
|
-
* JSON pointer of the changed field within the agent definition, e.g. '/engine/
|
|
1605
|
+
* JSON pointer of the changed field within the agent definition, e.g. '/engine/ai/instructions'.
|
|
1421
1606
|
* @public
|
|
1422
1607
|
*/
|
|
1423
1608
|
path: string;
|
|
@@ -1438,57 +1623,37 @@ export interface AgentVersionChange {
|
|
|
1438
1623
|
*/
|
|
1439
1624
|
export interface AgentVersionInfo {
|
|
1440
1625
|
agentId: string;
|
|
1441
|
-
version: number;
|
|
1442
|
-
changelog?: string | undefined;
|
|
1443
1626
|
/**
|
|
1444
|
-
*
|
|
1627
|
+
* Published agent version number. Monotonic within an agent's version history, starting at 1.
|
|
1445
1628
|
* @public
|
|
1446
1629
|
*/
|
|
1447
|
-
|
|
1630
|
+
version: number;
|
|
1448
1631
|
/**
|
|
1449
|
-
*
|
|
1632
|
+
* Published agent version number. Monotonic within an agent's version history, starting at 1.
|
|
1450
1633
|
* @public
|
|
1451
1634
|
*/
|
|
1452
|
-
|
|
1635
|
+
basedOnVersion?: number | undefined;
|
|
1636
|
+
name?: string | undefined;
|
|
1453
1637
|
/**
|
|
1454
|
-
*
|
|
1638
|
+
* Human-readable description of what changed in a published version.
|
|
1455
1639
|
* @public
|
|
1456
1640
|
*/
|
|
1457
|
-
|
|
1458
|
-
}
|
|
1459
|
-
/**
|
|
1460
|
-
* @public
|
|
1461
|
-
*/
|
|
1462
|
-
export interface AuditRecord {
|
|
1463
|
-
id: string;
|
|
1641
|
+
changelog?: string | undefined;
|
|
1464
1642
|
/**
|
|
1465
|
-
* ISO-8601 timestamp, e.g. '2026-07-
|
|
1643
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1466
1644
|
* @public
|
|
1467
1645
|
*/
|
|
1468
|
-
|
|
1646
|
+
publishedAt: string;
|
|
1469
1647
|
/**
|
|
1470
1648
|
* Who performed an action: an interactive user, an API key or an internal service.
|
|
1471
1649
|
* @public
|
|
1472
1650
|
*/
|
|
1473
|
-
|
|
1474
|
-
action: AuditAction;
|
|
1475
|
-
resourceType: AuditResourceType;
|
|
1476
|
-
resourceId: string;
|
|
1477
|
-
/**
|
|
1478
|
-
* The agent this record relates to, when the resource belongs to an agent.
|
|
1479
|
-
* @public
|
|
1480
|
-
*/
|
|
1481
|
-
agentId?: string | undefined;
|
|
1482
|
-
/**
|
|
1483
|
-
* Field-level before/after values for update actions.
|
|
1484
|
-
* @public
|
|
1485
|
-
*/
|
|
1486
|
-
changes?: AgentVersionChange[] | undefined;
|
|
1651
|
+
publishedBy: Actor;
|
|
1487
1652
|
/**
|
|
1488
|
-
*
|
|
1653
|
+
* Names of the deployments currently routing traffic to this version.
|
|
1489
1654
|
* @public
|
|
1490
1655
|
*/
|
|
1491
|
-
|
|
1656
|
+
deployments?: string[] | undefined;
|
|
1492
1657
|
}
|
|
1493
1658
|
/**
|
|
1494
1659
|
* @public
|
|
@@ -1497,15 +1662,25 @@ export interface CompareAgentVersionsInput {
|
|
|
1497
1662
|
company?: string | undefined;
|
|
1498
1663
|
agentId: string;
|
|
1499
1664
|
/**
|
|
1500
|
-
* Base version.
|
|
1665
|
+
* Base published version number. Omit when fromDraft is true.
|
|
1666
|
+
* @public
|
|
1667
|
+
*/
|
|
1668
|
+
from?: number | undefined;
|
|
1669
|
+
/**
|
|
1670
|
+
* Compare against the current draft instead of a published version.
|
|
1501
1671
|
* @public
|
|
1502
1672
|
*/
|
|
1503
|
-
|
|
1673
|
+
fromDraft?: boolean | undefined;
|
|
1504
1674
|
/**
|
|
1505
|
-
* Target version.
|
|
1675
|
+
* Target published version number. Omit when toDraft is true.
|
|
1506
1676
|
* @public
|
|
1507
1677
|
*/
|
|
1508
|
-
to
|
|
1678
|
+
to?: number | undefined;
|
|
1679
|
+
/**
|
|
1680
|
+
* Compare against the current draft instead of a published version.
|
|
1681
|
+
* @public
|
|
1682
|
+
*/
|
|
1683
|
+
toDraft?: boolean | undefined;
|
|
1509
1684
|
}
|
|
1510
1685
|
/**
|
|
1511
1686
|
* @public
|
|
@@ -1530,17 +1705,28 @@ export interface CreateAgentInput {
|
|
|
1530
1705
|
* @public
|
|
1531
1706
|
*/
|
|
1532
1707
|
picture?: string | undefined;
|
|
1708
|
+
/**
|
|
1709
|
+
* The channels this agent serves and their channel-specific settings. A channel is enabled when its member is present; at least one must be set. An agent may serve multiple channels (e.g. chat + assistant) over the shared engine.
|
|
1710
|
+
* @public
|
|
1711
|
+
*/
|
|
1712
|
+
channels: AgentChannels;
|
|
1713
|
+
/**
|
|
1714
|
+
* How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend. The legacy Dialogflow CX and OpenAI Assistant backends are intentionally not carried over.
|
|
1715
|
+
* @public
|
|
1716
|
+
*/
|
|
1533
1717
|
engine: AgentEngine;
|
|
1534
1718
|
/**
|
|
1535
|
-
*
|
|
1719
|
+
* Agent-level settings shared across all channels.
|
|
1536
1720
|
* @public
|
|
1537
1721
|
*/
|
|
1538
|
-
|
|
1722
|
+
settings?: AgentSettings | undefined;
|
|
1539
1723
|
/**
|
|
1540
|
-
*
|
|
1724
|
+
* Who is allowed to use the agent. There is no view/edit dimension — access solely grants the ability to use the agent.
|
|
1725
|
+
* Per channel: on `chat` and `assistant` agents `grants` govern which colleagues can use the agent; on `voice` agents `grants`
|
|
1726
|
+
* are ignored (inbound calls are routed by the PBX dialplan, and data ACL is the agent-level `settings.pbxGroupId`); on `autonomous` agents agent-level
|
|
1727
|
+
* access is not used — invocation access is configured per reference on the calling agent (see AgentCallCapability.access).
|
|
1541
1728
|
* @public
|
|
1542
1729
|
*/
|
|
1543
|
-
guardrails?: string[] | undefined;
|
|
1544
1730
|
access?: AgentAccess | undefined;
|
|
1545
1731
|
company?: string | undefined;
|
|
1546
1732
|
}
|
|
@@ -1581,164 +1767,27 @@ export interface CreateAgentApiKeyOutput {
|
|
|
1581
1767
|
/**
|
|
1582
1768
|
* @public
|
|
1583
1769
|
*/
|
|
1584
|
-
export interface
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
* Strength applied to user input. Defaults to NONE.
|
|
1588
|
-
* @public
|
|
1589
|
-
*/
|
|
1590
|
-
inputStrength?: GuardrailFilterStrength | undefined;
|
|
1591
|
-
/**
|
|
1592
|
-
* Strength applied to agent output. Defaults to NONE.
|
|
1593
|
-
* @public
|
|
1594
|
-
*/
|
|
1595
|
-
outputStrength?: GuardrailFilterStrength | undefined;
|
|
1596
|
-
}
|
|
1597
|
-
/**
|
|
1598
|
-
* @public
|
|
1599
|
-
*/
|
|
1600
|
-
export interface GuardrailContentPolicy {
|
|
1601
|
-
filters: GuardrailContentFilter[];
|
|
1602
|
-
}
|
|
1603
|
-
/**
|
|
1604
|
-
* @public
|
|
1605
|
-
*/
|
|
1606
|
-
export interface GuardrailPiiEntity {
|
|
1607
|
-
entityType: GuardrailPiiEntityType;
|
|
1608
|
-
/**
|
|
1609
|
-
* Regex for CUSTOM entities.
|
|
1610
|
-
* @public
|
|
1611
|
-
*/
|
|
1612
|
-
pattern?: string | undefined;
|
|
1613
|
-
action: GuardrailPiiAction;
|
|
1614
|
-
}
|
|
1615
|
-
/**
|
|
1616
|
-
* @public
|
|
1617
|
-
*/
|
|
1618
|
-
export interface GuardrailPiiPolicy {
|
|
1619
|
-
entities: GuardrailPiiEntity[];
|
|
1620
|
-
}
|
|
1621
|
-
/**
|
|
1622
|
-
* @public
|
|
1623
|
-
*/
|
|
1624
|
-
export interface GuardrailTopic {
|
|
1625
|
-
/**
|
|
1626
|
-
* Short topic name, e.g. 'investment-advice'.
|
|
1627
|
-
* @public
|
|
1628
|
-
*/
|
|
1629
|
-
name: string;
|
|
1630
|
-
/**
|
|
1631
|
-
* Natural-language definition of the topic used by the classifier.
|
|
1632
|
-
* @public
|
|
1633
|
-
*/
|
|
1634
|
-
definition: string;
|
|
1635
|
-
/**
|
|
1636
|
-
* Example phrases that belong to the topic, to sharpen classification.
|
|
1637
|
-
* @public
|
|
1638
|
-
*/
|
|
1639
|
-
examples?: string[] | undefined;
|
|
1640
|
-
/**
|
|
1641
|
-
* What to do when a policy matches.
|
|
1642
|
-
* @public
|
|
1643
|
-
*/
|
|
1644
|
-
action: GuardrailAction;
|
|
1645
|
-
}
|
|
1646
|
-
/**
|
|
1647
|
-
* @public
|
|
1648
|
-
*/
|
|
1649
|
-
export interface GuardrailTopicPolicy {
|
|
1650
|
-
topics: GuardrailTopic[];
|
|
1651
|
-
}
|
|
1652
|
-
/**
|
|
1653
|
-
* @public
|
|
1654
|
-
*/
|
|
1655
|
-
export interface GuardrailWordPolicy {
|
|
1656
|
-
/**
|
|
1657
|
-
* Exact words or phrases to block.
|
|
1658
|
-
* @public
|
|
1659
|
-
*/
|
|
1660
|
-
blockedWords?: string[] | undefined;
|
|
1661
|
-
/**
|
|
1662
|
-
* Also block common profanity.
|
|
1663
|
-
* @public
|
|
1664
|
-
*/
|
|
1665
|
-
profanity?: boolean | undefined;
|
|
1666
|
-
}
|
|
1667
|
-
/**
|
|
1668
|
-
* Editable guardrail configuration.
|
|
1669
|
-
* @public
|
|
1670
|
-
*/
|
|
1671
|
-
export interface CreateGuardrailInput {
|
|
1672
|
-
name: string;
|
|
1673
|
-
description?: string | undefined;
|
|
1674
|
-
topicPolicy?: GuardrailTopicPolicy | undefined;
|
|
1675
|
-
contentPolicy?: GuardrailContentPolicy | undefined;
|
|
1676
|
-
wordPolicy?: GuardrailWordPolicy | undefined;
|
|
1677
|
-
piiPolicy?: GuardrailPiiPolicy | undefined;
|
|
1678
|
-
/**
|
|
1679
|
-
* Answer returned to the end user when input is blocked.
|
|
1680
|
-
* @public
|
|
1681
|
-
*/
|
|
1682
|
-
blockedInputMessage?: string | undefined;
|
|
1770
|
+
export interface CreateAgentDeploymentInput {
|
|
1771
|
+
company?: string | undefined;
|
|
1772
|
+
agentId: string;
|
|
1683
1773
|
/**
|
|
1684
|
-
*
|
|
1774
|
+
* Deployment name, e.g. 'production' or 'staging'. Sessions default to 'production' when no deployment, version or draft selector is provided.
|
|
1685
1775
|
* @public
|
|
1686
1776
|
*/
|
|
1687
|
-
blockedOutputMessage?: string | undefined;
|
|
1688
|
-
company?: string | undefined;
|
|
1689
|
-
}
|
|
1690
|
-
/**
|
|
1691
|
-
* Editable guardrail configuration.
|
|
1692
|
-
* @public
|
|
1693
|
-
*/
|
|
1694
|
-
export interface Guardrail {
|
|
1695
1777
|
name: string;
|
|
1696
1778
|
description?: string | undefined;
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
wordPolicy?: GuardrailWordPolicy | undefined;
|
|
1700
|
-
piiPolicy?: GuardrailPiiPolicy | undefined;
|
|
1701
|
-
/**
|
|
1702
|
-
* Answer returned to the end user when input is blocked.
|
|
1703
|
-
* @public
|
|
1704
|
-
*/
|
|
1705
|
-
blockedInputMessage?: string | undefined;
|
|
1706
|
-
/**
|
|
1707
|
-
* Answer returned to the end user when the agent output is blocked.
|
|
1708
|
-
* @public
|
|
1709
|
-
*/
|
|
1710
|
-
blockedOutputMessage?: string | undefined;
|
|
1711
|
-
/**
|
|
1712
|
-
* ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
|
|
1713
|
-
* @public
|
|
1714
|
-
*/
|
|
1715
|
-
createdAt: string;
|
|
1716
|
-
/**
|
|
1717
|
-
* Who performed an action: an interactive user, an API key or an internal service.
|
|
1718
|
-
* @public
|
|
1719
|
-
*/
|
|
1720
|
-
createdBy: Actor;
|
|
1721
|
-
/**
|
|
1722
|
-
* ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
|
|
1723
|
-
* @public
|
|
1724
|
-
*/
|
|
1725
|
-
updatedAt?: string | undefined;
|
|
1726
|
-
/**
|
|
1727
|
-
* Who performed an action: an interactive user, an API key or an internal service.
|
|
1728
|
-
* @public
|
|
1729
|
-
*/
|
|
1730
|
-
updatedBy?: Actor | undefined;
|
|
1731
|
-
id: string;
|
|
1779
|
+
status: AgentDeploymentStatus;
|
|
1780
|
+
routing: AgentDeploymentRoute[];
|
|
1732
1781
|
}
|
|
1733
1782
|
/**
|
|
1734
1783
|
* @public
|
|
1735
1784
|
*/
|
|
1736
|
-
export interface
|
|
1785
|
+
export interface CreateAgentDeploymentOutput {
|
|
1737
1786
|
/**
|
|
1738
|
-
*
|
|
1787
|
+
* Standard audit fields carried by every managed resource.
|
|
1739
1788
|
* @public
|
|
1740
1789
|
*/
|
|
1741
|
-
|
|
1790
|
+
deployment: AgentDeployment;
|
|
1742
1791
|
}
|
|
1743
1792
|
/**
|
|
1744
1793
|
* @public
|
|
@@ -1752,23 +1801,6 @@ export interface DeleteAgentInput {
|
|
|
1752
1801
|
*/
|
|
1753
1802
|
export interface DeleteAgentOutput {
|
|
1754
1803
|
}
|
|
1755
|
-
/**
|
|
1756
|
-
* @public
|
|
1757
|
-
*/
|
|
1758
|
-
export interface DeleteAgentAliasInput {
|
|
1759
|
-
company?: string | undefined;
|
|
1760
|
-
agentId: string;
|
|
1761
|
-
/**
|
|
1762
|
-
* Alias name, e.g. 'production', 'staging'.
|
|
1763
|
-
* @public
|
|
1764
|
-
*/
|
|
1765
|
-
aliasName: string;
|
|
1766
|
-
}
|
|
1767
|
-
/**
|
|
1768
|
-
* @public
|
|
1769
|
-
*/
|
|
1770
|
-
export interface DeleteAgentAliasOutput {
|
|
1771
|
-
}
|
|
1772
1804
|
/**
|
|
1773
1805
|
* @public
|
|
1774
1806
|
*/
|
|
@@ -1785,67 +1817,19 @@ export interface DeleteAgentApiKeyOutput {
|
|
|
1785
1817
|
/**
|
|
1786
1818
|
* @public
|
|
1787
1819
|
*/
|
|
1788
|
-
export interface
|
|
1789
|
-
company?: string | undefined;
|
|
1790
|
-
guardrailId: string;
|
|
1791
|
-
}
|
|
1792
|
-
/**
|
|
1793
|
-
* @public
|
|
1794
|
-
*/
|
|
1795
|
-
export interface DeleteGuardrailOutput {
|
|
1796
|
-
}
|
|
1797
|
-
/**
|
|
1798
|
-
* @public
|
|
1799
|
-
*/
|
|
1800
|
-
export interface ExecuteAgentInput {
|
|
1820
|
+
export interface DeleteAgentDeploymentInput {
|
|
1801
1821
|
company?: string | undefined;
|
|
1802
1822
|
agentId: string;
|
|
1803
1823
|
/**
|
|
1804
|
-
*
|
|
1805
|
-
* @public
|
|
1806
|
-
*/
|
|
1807
|
-
input: string;
|
|
1808
|
-
/**
|
|
1809
|
-
* Values for the variables declared by the agent.
|
|
1810
|
-
* @public
|
|
1811
|
-
*/
|
|
1812
|
-
variables?: __DocumentType | undefined;
|
|
1813
|
-
/**
|
|
1814
|
-
* Alias to resolve. Defaults to 'production'. Mutually exclusive with version.
|
|
1815
|
-
* @public
|
|
1816
|
-
*/
|
|
1817
|
-
alias?: string | undefined;
|
|
1818
|
-
/**
|
|
1819
|
-
* Version to execute. 0 executes the current draft (for testing). Mutually exclusive with alias.
|
|
1820
|
-
* @public
|
|
1821
|
-
*/
|
|
1822
|
-
version?: number | undefined;
|
|
1823
|
-
/**
|
|
1824
|
-
* User on whose behalf the agent is executed, e.g. john.doe@example.com.
|
|
1824
|
+
* Deployment name, e.g. 'production' or 'staging'. Sessions default to 'production' when no deployment, version or draft selector is provided.
|
|
1825
1825
|
* @public
|
|
1826
1826
|
*/
|
|
1827
|
-
|
|
1828
|
-
/**
|
|
1829
|
-
* Parent agent id that invoked this execution (agent-to-agent calls).
|
|
1830
|
-
* @public
|
|
1831
|
-
*/
|
|
1832
|
-
parentAgentId?: string | undefined;
|
|
1833
|
-
/**
|
|
1834
|
-
* Parent trace id, to correlate nested executions.
|
|
1835
|
-
* @public
|
|
1836
|
-
*/
|
|
1837
|
-
parentTraceId?: string | undefined;
|
|
1838
|
-
/**
|
|
1839
|
-
* Files (by id) created by another agent to make available to this execution.
|
|
1840
|
-
* @public
|
|
1841
|
-
*/
|
|
1842
|
-
files?: string[] | undefined;
|
|
1827
|
+
deploymentName: string;
|
|
1843
1828
|
}
|
|
1844
1829
|
/**
|
|
1845
1830
|
* @public
|
|
1846
1831
|
*/
|
|
1847
|
-
export interface
|
|
1848
|
-
result: AgentExecutionResult;
|
|
1832
|
+
export interface DeleteAgentDeploymentOutput {
|
|
1849
1833
|
}
|
|
1850
1834
|
/**
|
|
1851
1835
|
* @public
|
|
@@ -1867,59 +1851,68 @@ export interface GetAgentOutput {
|
|
|
1867
1851
|
/**
|
|
1868
1852
|
* @public
|
|
1869
1853
|
*/
|
|
1870
|
-
export interface
|
|
1854
|
+
export interface GetAgentDeploymentInput {
|
|
1871
1855
|
company?: string | undefined;
|
|
1872
1856
|
agentId: string;
|
|
1873
|
-
|
|
1857
|
+
/**
|
|
1858
|
+
* Deployment name, e.g. 'production' or 'staging'. Sessions default to 'production' when no deployment, version or draft selector is provided.
|
|
1859
|
+
* @public
|
|
1860
|
+
*/
|
|
1861
|
+
deploymentName: string;
|
|
1874
1862
|
}
|
|
1875
1863
|
/**
|
|
1876
1864
|
* @public
|
|
1877
1865
|
*/
|
|
1878
|
-
export interface
|
|
1879
|
-
|
|
1866
|
+
export interface GetAgentDeploymentOutput {
|
|
1867
|
+
/**
|
|
1868
|
+
* Standard audit fields carried by every managed resource.
|
|
1869
|
+
* @public
|
|
1870
|
+
*/
|
|
1871
|
+
deployment: AgentDeployment;
|
|
1880
1872
|
}
|
|
1881
1873
|
/**
|
|
1882
1874
|
* @public
|
|
1883
1875
|
*/
|
|
1884
|
-
export interface
|
|
1876
|
+
export interface GetAgentVersionInput {
|
|
1885
1877
|
company?: string | undefined;
|
|
1886
|
-
|
|
1878
|
+
agentId: string;
|
|
1879
|
+
/**
|
|
1880
|
+
* Published agent version number. Monotonic within an agent's version history, starting at 1.
|
|
1881
|
+
* @public
|
|
1882
|
+
*/
|
|
1883
|
+
version: number;
|
|
1887
1884
|
}
|
|
1888
1885
|
/**
|
|
1889
1886
|
* @public
|
|
1890
1887
|
*/
|
|
1891
|
-
export interface
|
|
1892
|
-
|
|
1893
|
-
* Editable guardrail configuration.
|
|
1894
|
-
* @public
|
|
1895
|
-
*/
|
|
1896
|
-
guardrail: Guardrail;
|
|
1888
|
+
export interface GetAgentVersionOutput {
|
|
1889
|
+
version: AgentVersion;
|
|
1897
1890
|
}
|
|
1898
1891
|
/**
|
|
1899
1892
|
* @public
|
|
1900
1893
|
*/
|
|
1901
|
-
export interface
|
|
1894
|
+
export interface ListAgentApiKeysInput {
|
|
1902
1895
|
company?: string | undefined;
|
|
1903
1896
|
agentId: string;
|
|
1904
1897
|
}
|
|
1905
1898
|
/**
|
|
1906
1899
|
* @public
|
|
1907
1900
|
*/
|
|
1908
|
-
export interface
|
|
1909
|
-
|
|
1901
|
+
export interface ListAgentApiKeysOutput {
|
|
1902
|
+
keys: AgentApiKey[];
|
|
1910
1903
|
}
|
|
1911
1904
|
/**
|
|
1912
1905
|
* @public
|
|
1913
1906
|
*/
|
|
1914
|
-
export interface
|
|
1907
|
+
export interface ListAgentDeploymentsInput {
|
|
1915
1908
|
company?: string | undefined;
|
|
1916
1909
|
agentId: string;
|
|
1917
1910
|
}
|
|
1918
1911
|
/**
|
|
1919
1912
|
* @public
|
|
1920
1913
|
*/
|
|
1921
|
-
export interface
|
|
1922
|
-
|
|
1914
|
+
export interface ListAgentDeploymentsOutput {
|
|
1915
|
+
deployments: AgentDeployment[];
|
|
1923
1916
|
}
|
|
1924
1917
|
/**
|
|
1925
1918
|
* @public
|
|
@@ -1927,7 +1920,7 @@ export interface ListAgentApiKeysOutput {
|
|
|
1927
1920
|
export interface ListAgentsInput {
|
|
1928
1921
|
company?: string | undefined;
|
|
1929
1922
|
/**
|
|
1930
|
-
* Only agents
|
|
1923
|
+
* Only agents that have this channel enabled (voice / chat / assistant / autonomous).
|
|
1931
1924
|
* @public
|
|
1932
1925
|
*/
|
|
1933
1926
|
channel?: ChannelType | undefined;
|
|
@@ -1942,7 +1935,7 @@ export interface ListAgentsInput {
|
|
|
1942
1935
|
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
1943
1936
|
* @public
|
|
1944
1937
|
*/
|
|
1945
|
-
|
|
1938
|
+
cursor?: string | undefined;
|
|
1946
1939
|
}
|
|
1947
1940
|
/**
|
|
1948
1941
|
* @public
|
|
@@ -1953,7 +1946,7 @@ export interface ListAgentsOutput {
|
|
|
1953
1946
|
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
1954
1947
|
* @public
|
|
1955
1948
|
*/
|
|
1956
|
-
|
|
1949
|
+
nextCursor?: string | undefined;
|
|
1957
1950
|
}
|
|
1958
1951
|
/**
|
|
1959
1952
|
* @public
|
|
@@ -1961,7 +1954,7 @@ export interface ListAgentsOutput {
|
|
|
1961
1954
|
export interface ListAgentsNamesInput {
|
|
1962
1955
|
company?: string | undefined;
|
|
1963
1956
|
/**
|
|
1964
|
-
*
|
|
1957
|
+
* A channel an agent can serve (see AgentChannels for enablement). Also the runtime channel recorded by wilma-sessions / wilma-traces.
|
|
1965
1958
|
* @public
|
|
1966
1959
|
*/
|
|
1967
1960
|
channel?: ChannelType | undefined;
|
|
@@ -1983,7 +1976,7 @@ export interface ListAgentVersionsInput {
|
|
|
1983
1976
|
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
1984
1977
|
* @public
|
|
1985
1978
|
*/
|
|
1986
|
-
|
|
1979
|
+
cursor?: string | undefined;
|
|
1987
1980
|
}
|
|
1988
1981
|
/**
|
|
1989
1982
|
* @public
|
|
@@ -1994,114 +1987,62 @@ export interface ListAgentVersionsOutput {
|
|
|
1994
1987
|
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
1995
1988
|
* @public
|
|
1996
1989
|
*/
|
|
1997
|
-
|
|
1990
|
+
nextCursor?: string | undefined;
|
|
1998
1991
|
}
|
|
1999
1992
|
/**
|
|
2000
1993
|
* @public
|
|
2001
1994
|
*/
|
|
2002
|
-
export interface
|
|
1995
|
+
export interface PublishAgentVersionInput {
|
|
2003
1996
|
company?: string | undefined;
|
|
2004
|
-
agentId
|
|
2005
|
-
resourceType?: AuditResourceType | undefined;
|
|
2006
|
-
action?: AuditAction | undefined;
|
|
2007
|
-
/**
|
|
2008
|
-
* Filter by the user, API key or service that performed the action.
|
|
2009
|
-
* @public
|
|
2010
|
-
*/
|
|
2011
|
-
actorId?: string | undefined;
|
|
2012
|
-
/**
|
|
2013
|
-
* ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
|
|
2014
|
-
* @public
|
|
2015
|
-
*/
|
|
2016
|
-
from?: string | undefined;
|
|
2017
|
-
/**
|
|
2018
|
-
* ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
|
|
2019
|
-
* @public
|
|
2020
|
-
*/
|
|
2021
|
-
to?: string | undefined;
|
|
2022
|
-
limit?: number | undefined;
|
|
1997
|
+
agentId: string;
|
|
2023
1998
|
/**
|
|
2024
|
-
*
|
|
1999
|
+
* What changed in this version.
|
|
2025
2000
|
* @public
|
|
2026
2001
|
*/
|
|
2027
|
-
|
|
2028
|
-
}
|
|
2029
|
-
/**
|
|
2030
|
-
* @public
|
|
2031
|
-
*/
|
|
2032
|
-
export interface ListAuditRecordsOutput {
|
|
2033
|
-
records: AuditRecord[];
|
|
2002
|
+
changelog?: string | undefined;
|
|
2034
2003
|
/**
|
|
2035
|
-
*
|
|
2004
|
+
* Optional human-readable name for this version.
|
|
2036
2005
|
* @public
|
|
2037
2006
|
*/
|
|
2038
|
-
|
|
2039
|
-
}
|
|
2040
|
-
/**
|
|
2041
|
-
* @public
|
|
2042
|
-
*/
|
|
2043
|
-
export interface ListGuardrailsInput {
|
|
2044
|
-
company?: string | undefined;
|
|
2045
|
-
limit?: number | undefined;
|
|
2007
|
+
name?: string | undefined;
|
|
2046
2008
|
/**
|
|
2047
|
-
*
|
|
2009
|
+
* Draft revision this publish is based on (optimistic locking).
|
|
2048
2010
|
* @public
|
|
2049
2011
|
*/
|
|
2050
|
-
|
|
2012
|
+
revision: number;
|
|
2051
2013
|
}
|
|
2052
2014
|
/**
|
|
2053
2015
|
* @public
|
|
2054
2016
|
*/
|
|
2055
|
-
export interface
|
|
2056
|
-
|
|
2057
|
-
/**
|
|
2058
|
-
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2059
|
-
* @public
|
|
2060
|
-
*/
|
|
2061
|
-
nextToken?: string | undefined;
|
|
2017
|
+
export interface PublishAgentVersionOutput {
|
|
2018
|
+
version: AgentVersion;
|
|
2062
2019
|
}
|
|
2063
2020
|
/**
|
|
2064
2021
|
* @public
|
|
2065
2022
|
*/
|
|
2066
|
-
export interface
|
|
2023
|
+
export interface RestoreAgentVersionToDraftInput {
|
|
2067
2024
|
company?: string | undefined;
|
|
2068
2025
|
agentId: string;
|
|
2069
2026
|
/**
|
|
2070
|
-
*
|
|
2027
|
+
* Published agent version number. Monotonic within an agent's version history, starting at 1.
|
|
2071
2028
|
* @public
|
|
2072
2029
|
*/
|
|
2073
|
-
|
|
2030
|
+
version: number;
|
|
2074
2031
|
/**
|
|
2075
|
-
* Draft revision this
|
|
2032
|
+
* Draft revision this restore is based on (optimistic locking).
|
|
2076
2033
|
* @public
|
|
2077
2034
|
*/
|
|
2078
|
-
revision
|
|
2079
|
-
}
|
|
2080
|
-
/**
|
|
2081
|
-
* @public
|
|
2082
|
-
*/
|
|
2083
|
-
export interface PublishAgentVersionOutput {
|
|
2084
|
-
version: AgentVersion;
|
|
2035
|
+
revision: number;
|
|
2085
2036
|
}
|
|
2086
2037
|
/**
|
|
2087
2038
|
* @public
|
|
2088
2039
|
*/
|
|
2089
|
-
export interface
|
|
2090
|
-
company?: string | undefined;
|
|
2091
|
-
agentId: string;
|
|
2040
|
+
export interface RestoreAgentVersionToDraftOutput {
|
|
2092
2041
|
/**
|
|
2093
|
-
*
|
|
2042
|
+
* The complete, versionable configuration of an agent. This is what gets snapshotted when a version is published.
|
|
2094
2043
|
* @public
|
|
2095
2044
|
*/
|
|
2096
|
-
|
|
2097
|
-
description?: string | undefined;
|
|
2098
|
-
routing: AgentAliasRoute[];
|
|
2099
|
-
}
|
|
2100
|
-
/**
|
|
2101
|
-
* @public
|
|
2102
|
-
*/
|
|
2103
|
-
export interface PutAgentAliasOutput {
|
|
2104
|
-
alias: AgentAlias;
|
|
2045
|
+
agent: Agent;
|
|
2105
2046
|
}
|
|
2106
2047
|
/**
|
|
2107
2048
|
* The complete, versionable configuration of an agent. This is what gets snapshotted when a version is published.
|
|
@@ -2120,17 +2061,28 @@ export interface UpdateAgentInput {
|
|
|
2120
2061
|
* @public
|
|
2121
2062
|
*/
|
|
2122
2063
|
picture?: string | undefined;
|
|
2064
|
+
/**
|
|
2065
|
+
* The channels this agent serves and their channel-specific settings. A channel is enabled when its member is present; at least one must be set. An agent may serve multiple channels (e.g. chat + assistant) over the shared engine.
|
|
2066
|
+
* @public
|
|
2067
|
+
*/
|
|
2068
|
+
channels: AgentChannels;
|
|
2069
|
+
/**
|
|
2070
|
+
* How the agent produces replies. `ai` is the managed engine; `webhook` and `sqs` delegate to an external backend. The legacy Dialogflow CX and OpenAI Assistant backends are intentionally not carried over.
|
|
2071
|
+
* @public
|
|
2072
|
+
*/
|
|
2123
2073
|
engine: AgentEngine;
|
|
2124
2074
|
/**
|
|
2125
|
-
*
|
|
2075
|
+
* Agent-level settings shared across all channels.
|
|
2126
2076
|
* @public
|
|
2127
2077
|
*/
|
|
2128
|
-
|
|
2078
|
+
settings?: AgentSettings | undefined;
|
|
2129
2079
|
/**
|
|
2130
|
-
*
|
|
2080
|
+
* Who is allowed to use the agent. There is no view/edit dimension — access solely grants the ability to use the agent.
|
|
2081
|
+
* Per channel: on `chat` and `assistant` agents `grants` govern which colleagues can use the agent; on `voice` agents `grants`
|
|
2082
|
+
* are ignored (inbound calls are routed by the PBX dialplan, and data ACL is the agent-level `settings.pbxGroupId`); on `autonomous` agents agent-level
|
|
2083
|
+
* access is not used — invocation access is configured per reference on the calling agent (see AgentCallCapability.access).
|
|
2131
2084
|
* @public
|
|
2132
2085
|
*/
|
|
2133
|
-
guardrails?: string[] | undefined;
|
|
2134
2086
|
access?: AgentAccess | undefined;
|
|
2135
2087
|
company?: string | undefined;
|
|
2136
2088
|
agentId: string;
|
|
@@ -2138,7 +2090,7 @@ export interface UpdateAgentInput {
|
|
|
2138
2090
|
* Draft revision this update is based on (optimistic locking). When it does not match the current revision, RevisionConflictException is returned.
|
|
2139
2091
|
* @public
|
|
2140
2092
|
*/
|
|
2141
|
-
revision
|
|
2093
|
+
revision: number;
|
|
2142
2094
|
}
|
|
2143
2095
|
/**
|
|
2144
2096
|
* @public
|
|
@@ -2151,36 +2103,32 @@ export interface UpdateAgentOutput {
|
|
|
2151
2103
|
agent: Agent;
|
|
2152
2104
|
}
|
|
2153
2105
|
/**
|
|
2154
|
-
* Editable guardrail configuration.
|
|
2155
2106
|
* @public
|
|
2156
2107
|
*/
|
|
2157
|
-
export interface
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
topicPolicy?: GuardrailTopicPolicy | undefined;
|
|
2161
|
-
contentPolicy?: GuardrailContentPolicy | undefined;
|
|
2162
|
-
wordPolicy?: GuardrailWordPolicy | undefined;
|
|
2163
|
-
piiPolicy?: GuardrailPiiPolicy | undefined;
|
|
2108
|
+
export interface UpdateAgentDeploymentInput {
|
|
2109
|
+
company?: string | undefined;
|
|
2110
|
+
agentId: string;
|
|
2164
2111
|
/**
|
|
2165
|
-
*
|
|
2112
|
+
* Deployment name, e.g. 'production' or 'staging'. Sessions default to 'production' when no deployment, version or draft selector is provided.
|
|
2166
2113
|
* @public
|
|
2167
2114
|
*/
|
|
2168
|
-
|
|
2115
|
+
deploymentName: string;
|
|
2116
|
+
description?: string | undefined;
|
|
2117
|
+
status: AgentDeploymentStatus;
|
|
2118
|
+
routing: AgentDeploymentRoute[];
|
|
2169
2119
|
/**
|
|
2170
|
-
*
|
|
2120
|
+
* Deployment revision this update is based on (optimistic locking).
|
|
2171
2121
|
* @public
|
|
2172
2122
|
*/
|
|
2173
|
-
|
|
2174
|
-
company?: string | undefined;
|
|
2175
|
-
guardrailId: string;
|
|
2123
|
+
revision: number;
|
|
2176
2124
|
}
|
|
2177
2125
|
/**
|
|
2178
2126
|
* @public
|
|
2179
2127
|
*/
|
|
2180
|
-
export interface
|
|
2128
|
+
export interface UpdateAgentDeploymentOutput {
|
|
2181
2129
|
/**
|
|
2182
|
-
*
|
|
2130
|
+
* Standard audit fields carried by every managed resource.
|
|
2183
2131
|
* @public
|
|
2184
2132
|
*/
|
|
2185
|
-
|
|
2133
|
+
deployment: AgentDeployment;
|
|
2186
2134
|
}
|