@wildix/wilma-agents-client 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (130) hide show
  1. package/dist-cjs/WilmaAgents.js +57 -0
  2. package/dist-cjs/WilmaAgentsClient.js +49 -0
  3. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
  4. package/dist-cjs/auth/httpAuthSchemeProvider.js +58 -0
  5. package/dist-cjs/commands/CompareAgentVersionsCommand.js +20 -0
  6. package/dist-cjs/commands/CreateAgentApiKeyCommand.js +20 -0
  7. package/dist-cjs/commands/CreateAgentCommand.js +20 -0
  8. package/dist-cjs/commands/CreateGuardrailCommand.js +20 -0
  9. package/dist-cjs/commands/DeleteAgentAliasCommand.js +20 -0
  10. package/dist-cjs/commands/DeleteAgentApiKeyCommand.js +20 -0
  11. package/dist-cjs/commands/DeleteAgentCommand.js +20 -0
  12. package/dist-cjs/commands/DeleteGuardrailCommand.js +20 -0
  13. package/dist-cjs/commands/ExecuteAgentCommand.js +20 -0
  14. package/dist-cjs/commands/GetAgentCommand.js +20 -0
  15. package/dist-cjs/commands/GetAgentVersionCommand.js +20 -0
  16. package/dist-cjs/commands/GetGuardrailCommand.js +20 -0
  17. package/dist-cjs/commands/ListAgentAliasesCommand.js +20 -0
  18. package/dist-cjs/commands/ListAgentApiKeysCommand.js +20 -0
  19. package/dist-cjs/commands/ListAgentVersionsCommand.js +20 -0
  20. package/dist-cjs/commands/ListAgentsCommand.js +20 -0
  21. package/dist-cjs/commands/ListAgentsNamesCommand.js +20 -0
  22. package/dist-cjs/commands/ListAuditRecordsCommand.js +20 -0
  23. package/dist-cjs/commands/ListGuardrailsCommand.js +20 -0
  24. package/dist-cjs/commands/PublishAgentVersionCommand.js +20 -0
  25. package/dist-cjs/commands/PutAgentAliasCommand.js +20 -0
  26. package/dist-cjs/commands/UpdateAgentCommand.js +20 -0
  27. package/dist-cjs/commands/UpdateGuardrailCommand.js +20 -0
  28. package/dist-cjs/commands/index.js +26 -0
  29. package/dist-cjs/endpoint/EndpointParameters.js +16 -0
  30. package/dist-cjs/endpoint/bdd.js +28 -0
  31. package/dist-cjs/endpoint/endpointResolver.js +16 -0
  32. package/dist-cjs/extensionConfiguration.js +2 -0
  33. package/dist-cjs/index.js +13 -0
  34. package/dist-cjs/models/WilmaAgentsServiceException.js +12 -0
  35. package/dist-cjs/models/enums.js +118 -0
  36. package/dist-cjs/models/errors.js +154 -0
  37. package/dist-cjs/models/models_0.js +2 -0
  38. package/dist-cjs/runtimeConfig.browser.js +32 -0
  39. package/dist-cjs/runtimeConfig.js +41 -0
  40. package/dist-cjs/runtimeConfig.native.js +15 -0
  41. package/dist-cjs/runtimeConfig.shared.js +41 -0
  42. package/dist-cjs/runtimeExtensions.js +12 -0
  43. package/dist-cjs/schemas/schemas_0.js +1168 -0
  44. package/dist-es/WilmaAgents.js +53 -0
  45. package/dist-es/WilmaAgentsClient.js +45 -0
  46. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  47. package/dist-es/auth/httpAuthSchemeProvider.js +52 -0
  48. package/dist-es/commands/CompareAgentVersionsCommand.js +16 -0
  49. package/dist-es/commands/CreateAgentApiKeyCommand.js +16 -0
  50. package/dist-es/commands/CreateAgentCommand.js +16 -0
  51. package/dist-es/commands/CreateGuardrailCommand.js +16 -0
  52. package/dist-es/commands/DeleteAgentAliasCommand.js +16 -0
  53. package/dist-es/commands/DeleteAgentApiKeyCommand.js +16 -0
  54. package/dist-es/commands/DeleteAgentCommand.js +16 -0
  55. package/dist-es/commands/DeleteGuardrailCommand.js +16 -0
  56. package/dist-es/commands/ExecuteAgentCommand.js +16 -0
  57. package/dist-es/commands/GetAgentCommand.js +16 -0
  58. package/dist-es/commands/GetAgentVersionCommand.js +16 -0
  59. package/dist-es/commands/GetGuardrailCommand.js +16 -0
  60. package/dist-es/commands/ListAgentAliasesCommand.js +16 -0
  61. package/dist-es/commands/ListAgentApiKeysCommand.js +16 -0
  62. package/dist-es/commands/ListAgentVersionsCommand.js +16 -0
  63. package/dist-es/commands/ListAgentsCommand.js +16 -0
  64. package/dist-es/commands/ListAgentsNamesCommand.js +16 -0
  65. package/dist-es/commands/ListAuditRecordsCommand.js +16 -0
  66. package/dist-es/commands/ListGuardrailsCommand.js +16 -0
  67. package/dist-es/commands/PublishAgentVersionCommand.js +16 -0
  68. package/dist-es/commands/PutAgentAliasCommand.js +16 -0
  69. package/dist-es/commands/UpdateAgentCommand.js +16 -0
  70. package/dist-es/commands/UpdateGuardrailCommand.js +16 -0
  71. package/dist-es/commands/index.js +23 -0
  72. package/dist-es/endpoint/EndpointParameters.js +12 -0
  73. package/dist-es/endpoint/bdd.js +25 -0
  74. package/dist-es/endpoint/endpointResolver.js +12 -0
  75. package/dist-es/extensionConfiguration.js +1 -0
  76. package/dist-es/index.js +8 -0
  77. package/dist-es/models/WilmaAgentsServiceException.js +8 -0
  78. package/dist-es/models/enums.js +115 -0
  79. package/dist-es/models/errors.js +141 -0
  80. package/dist-es/models/models_0.js +1 -0
  81. package/dist-es/runtimeConfig.browser.js +27 -0
  82. package/dist-es/runtimeConfig.js +36 -0
  83. package/dist-es/runtimeConfig.native.js +11 -0
  84. package/dist-es/runtimeConfig.shared.js +37 -0
  85. package/dist-es/runtimeExtensions.js +8 -0
  86. package/dist-es/schemas/schemas_0.js +1162 -0
  87. package/dist-types/WilmaAgents.d.ts +182 -0
  88. package/dist-types/WilmaAgentsClient.d.ts +192 -0
  89. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  90. package/dist-types/auth/httpAuthSchemeProvider.d.ts +81 -0
  91. package/dist-types/commands/CompareAgentVersionsCommand.d.ts +91 -0
  92. package/dist-types/commands/CreateAgentApiKeyCommand.d.ts +96 -0
  93. package/dist-types/commands/CreateAgentCommand.d.ts +654 -0
  94. package/dist-types/commands/CreateGuardrailCommand.d.ts +172 -0
  95. package/dist-types/commands/DeleteAgentAliasCommand.d.ts +82 -0
  96. package/dist-types/commands/DeleteAgentApiKeyCommand.d.ts +82 -0
  97. package/dist-types/commands/DeleteAgentCommand.d.ts +77 -0
  98. package/dist-types/commands/DeleteGuardrailCommand.d.ts +80 -0
  99. package/dist-types/commands/ExecuteAgentCommand.d.ts +112 -0
  100. package/dist-types/commands/GetAgentCommand.d.ts +386 -0
  101. package/dist-types/commands/GetAgentVersionCommand.d.ts +365 -0
  102. package/dist-types/commands/GetGuardrailCommand.d.ts +135 -0
  103. package/dist-types/commands/ListAgentAliasesCommand.d.ts +99 -0
  104. package/dist-types/commands/ListAgentApiKeysCommand.d.ts +95 -0
  105. package/dist-types/commands/ListAgentVersionsCommand.d.ts +99 -0
  106. package/dist-types/commands/ListAgentsCommand.d.ts +391 -0
  107. package/dist-types/commands/ListAgentsNamesCommand.d.ts +90 -0
  108. package/dist-types/commands/ListAuditRecordsCommand.d.ts +109 -0
  109. package/dist-types/commands/ListGuardrailsCommand.d.ts +137 -0
  110. package/dist-types/commands/PublishAgentVersionCommand.d.ts +370 -0
  111. package/dist-types/commands/PutAgentAliasCommand.d.ts +107 -0
  112. package/dist-types/commands/UpdateAgentCommand.d.ts +661 -0
  113. package/dist-types/commands/UpdateGuardrailCommand.d.ts +175 -0
  114. package/dist-types/commands/index.d.ts +23 -0
  115. package/dist-types/endpoint/EndpointParameters.d.ts +41 -0
  116. package/dist-types/endpoint/bdd.d.ts +2 -0
  117. package/dist-types/endpoint/endpointResolver.d.ts +8 -0
  118. package/dist-types/extensionConfiguration.d.ts +8 -0
  119. package/dist-types/index.d.ts +23 -0
  120. package/dist-types/models/WilmaAgentsServiceException.d.ts +14 -0
  121. package/dist-types/models/enums.d.ts +301 -0
  122. package/dist-types/models/errors.d.ts +129 -0
  123. package/dist-types/models/models_0.d.ts +2186 -0
  124. package/dist-types/runtimeConfig.browser.d.ts +55 -0
  125. package/dist-types/runtimeConfig.d.ts +55 -0
  126. package/dist-types/runtimeConfig.native.d.ts +54 -0
  127. package/dist-types/runtimeConfig.shared.d.ts +32 -0
  128. package/dist-types/runtimeExtensions.d.ts +17 -0
  129. package/dist-types/schemas/schemas_0.d.ts +160 -0
  130. package/package.json +57 -0
@@ -0,0 +1,2186 @@
1
+ import type { DocumentType as __DocumentType } from "@smithy/types";
2
+ import type { ActorType, AgentFileScope, AgentGrantPermission, AgentStatus, AgentVariableType, AgentVisibility, AuditAction, AuditResourceType, ChannelType, GuardrailAction, GuardrailContentCategory, GuardrailFilterStrength, GuardrailPiiAction, GuardrailPiiEntityType, SandboxNetworkAccess, SpeechProvider, WebhookMethod, WebSearchContextSize } from "./enums";
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
+ }
20
+ /**
21
+ * @public
22
+ */
23
+ export type AgentGrantPrincipal = AgentGrantPrincipal.GroupIdMember | AgentGrantPrincipal.UserIdMember | AgentGrantPrincipal.$UnknownMember;
24
+ /**
25
+ * @public
26
+ */
27
+ export declare namespace AgentGrantPrincipal {
28
+ interface UserIdMember {
29
+ userId: string;
30
+ groupId?: never;
31
+ $unknown?: never;
32
+ }
33
+ interface GroupIdMember {
34
+ userId?: never;
35
+ groupId: string;
36
+ $unknown?: never;
37
+ }
38
+ /**
39
+ * @public
40
+ */
41
+ interface $UnknownMember {
42
+ userId?: never;
43
+ groupId?: never;
44
+ $unknown: [string, any];
45
+ }
46
+ /**
47
+ * @deprecated unused in schema-serde mode.
48
+ *
49
+ */
50
+ interface Visitor<T> {
51
+ userId: (value: string) => T;
52
+ groupId: (value: string) => T;
53
+ _: (name: string, value: any) => T;
54
+ }
55
+ }
56
+ /**
57
+ * @public
58
+ */
59
+ export interface AgentGrant {
60
+ permission: AgentGrantPermission;
61
+ principal: AgentGrantPrincipal;
62
+ }
63
+ /**
64
+ * @public
65
+ */
66
+ 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
+ /**
93
+ * Weighted routing to published versions. A single route with weight 100 is the common case; two routes make a canary.
94
+ * @public
95
+ */
96
+ routing: AgentAliasRoute[];
97
+ /**
98
+ * ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
99
+ * @public
100
+ */
101
+ updatedAt: string;
102
+ /**
103
+ * Who performed an action: an interactive user, an API key or an internal service.
104
+ * @public
105
+ */
106
+ updatedBy: Actor;
107
+ }
108
+ /**
109
+ * @public
110
+ */
111
+ export interface ApiChannelSettings {
112
+ enabled: boolean;
113
+ }
114
+ /**
115
+ * @public
116
+ */
117
+ export interface AssistantChannelSettings {
118
+ enabled: boolean;
119
+ /**
120
+ * Offer this agent as the default assistant for users covered by the agent access settings.
121
+ * @public
122
+ */
123
+ default?: boolean | undefined;
124
+ }
125
+ /**
126
+ * @public
127
+ */
128
+ export interface ChatChannelSettings {
129
+ enabled: boolean;
130
+ /**
131
+ * Whether users can find and add this agent to conversations.
132
+ * @public
133
+ */
134
+ 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
+ }
146
+ /**
147
+ * Caller context injected into the model prompt.
148
+ * @public
149
+ */
150
+ export interface VoiceCallerMetadataSettings {
151
+ /**
152
+ * Include the caller name. Defaults to true.
153
+ * @public
154
+ */
155
+ callerName?: boolean | undefined;
156
+ /**
157
+ * Include the caller phone number. Defaults to true.
158
+ * @public
159
+ */
160
+ callerNumber?: boolean | undefined;
161
+ /**
162
+ * Include the caller email when known. Defaults to false.
163
+ * @public
164
+ */
165
+ callerEmail?: boolean | undefined;
166
+ /**
167
+ * Include the caller company when known. Defaults to false.
168
+ * @public
169
+ */
170
+ callerCompany?: boolean | undefined;
171
+ /**
172
+ * Include the current time. Defaults to false.
173
+ * @public
174
+ */
175
+ time?: boolean | undefined;
176
+ /**
177
+ * IANA timezone used when time is enabled. Defaults to 'UTC'.
178
+ * @public
179
+ */
180
+ timeZone?: string | undefined;
181
+ }
182
+ /**
183
+ * @public
184
+ */
185
+ export interface VoiceEndCallSettings {
186
+ enabled: boolean;
187
+ /**
188
+ * Comma-separated phrases that end the call, e.g. 'goodbye,bye'.
189
+ * @public
190
+ */
191
+ phrases?: string | undefined;
192
+ }
193
+ /**
194
+ * @public
195
+ */
196
+ export interface VoiceInterruptionSettings {
197
+ /**
198
+ * Whether the caller can interrupt the agent while it is speaking.
199
+ * @public
200
+ */
201
+ enabled: boolean;
202
+ /**
203
+ * Minimum number of caller words that count as an interruption.
204
+ * @public
205
+ */
206
+ minWords?: number | undefined;
207
+ }
208
+ /**
209
+ * @public
210
+ */
211
+ export interface VoiceTerminateHangupAction {
212
+ /**
213
+ * Message played before hanging up.
214
+ * @public
215
+ */
216
+ message?: string | undefined;
217
+ }
218
+ /**
219
+ * @public
220
+ */
221
+ export interface VoiceTransferTarget {
222
+ /**
223
+ * Human readable name the model can refer to, e.g. 'Billing department'.
224
+ * @public
225
+ */
226
+ name: string;
227
+ /**
228
+ * When this target should be chosen.
229
+ * @public
230
+ */
231
+ description?: string | undefined;
232
+ context: string;
233
+ extension: string;
234
+ }
235
+ /**
236
+ * @public
237
+ */
238
+ export type VoiceTerminateAction = VoiceTerminateAction.HangupMember | VoiceTerminateAction.TransferMember | VoiceTerminateAction.$UnknownMember;
239
+ /**
240
+ * @public
241
+ */
242
+ export declare namespace VoiceTerminateAction {
243
+ interface HangupMember {
244
+ hangup: VoiceTerminateHangupAction;
245
+ transfer?: never;
246
+ $unknown?: never;
247
+ }
248
+ interface TransferMember {
249
+ hangup?: never;
250
+ transfer: VoiceTransferTarget;
251
+ $unknown?: never;
252
+ }
253
+ /**
254
+ * @public
255
+ */
256
+ interface $UnknownMember {
257
+ hangup?: never;
258
+ transfer?: never;
259
+ $unknown: [string, any];
260
+ }
261
+ /**
262
+ * @deprecated unused in schema-serde mode.
263
+ *
264
+ */
265
+ interface Visitor<T> {
266
+ hangup: (value: VoiceTerminateHangupAction) => T;
267
+ transfer: (value: VoiceTransferTarget) => T;
268
+ _: (name: string, value: any) => T;
269
+ }
270
+ }
271
+ /**
272
+ * @public
273
+ */
274
+ export interface VoiceMaxDurationSettings {
275
+ /**
276
+ * Maximum call duration in seconds before the action is taken.
277
+ * @public
278
+ */
279
+ seconds: number;
280
+ action: VoiceTerminateAction;
281
+ }
282
+ /**
283
+ * @public
284
+ */
285
+ export interface VoiceSilenceTimeoutSettings {
286
+ /**
287
+ * Seconds of caller silence before the action is taken.
288
+ * @public
289
+ */
290
+ seconds: number;
291
+ action: VoiceTerminateAction;
292
+ }
293
+ /**
294
+ * @public
295
+ */
296
+ export interface VoiceSynthesisSettings {
297
+ provider: SpeechProvider;
298
+ /**
299
+ * Provider-specific voice identifier.
300
+ * @public
301
+ */
302
+ voiceId: string;
303
+ /**
304
+ * Playback speed multiplier.
305
+ * @public
306
+ */
307
+ speed?: number | undefined;
308
+ }
309
+ /**
310
+ * @public
311
+ */
312
+ export interface VoiceChannelSettings {
313
+ enabled: boolean;
314
+ /**
315
+ * BCP-47 language tag used for transcription and synthesis, e.g. 'en-US'.
316
+ * @public
317
+ */
318
+ language: string;
319
+ synthesis: VoiceSynthesisSettings;
320
+ /**
321
+ * Message spoken when the call starts.
322
+ * @public
323
+ */
324
+ greeting?: string | undefined;
325
+ interruptions?: VoiceInterruptionSettings | undefined;
326
+ silenceTimeout?: VoiceSilenceTimeoutSettings | undefined;
327
+ maxDuration?: VoiceMaxDurationSettings | undefined;
328
+ endCall?: VoiceEndCallSettings | undefined;
329
+ /**
330
+ * Caller context injected into the model prompt.
331
+ * @public
332
+ */
333
+ callerMetadata?: VoiceCallerMetadataSettings | undefined;
334
+ }
335
+ /**
336
+ * @public
337
+ */
338
+ export interface AgentChannels {
339
+ assistant?: AssistantChannelSettings | undefined;
340
+ chat?: ChatChannelSettings | undefined;
341
+ voice?: VoiceChannelSettings | undefined;
342
+ api?: ApiChannelSettings | undefined;
343
+ }
344
+ /**
345
+ * @public
346
+ */
347
+ export interface AgentToolVariableAutoHandler {
348
+ }
349
+ /**
350
+ * @public
351
+ */
352
+ export interface AgentToolVariableGuidedHandler {
353
+ description: string;
354
+ }
355
+ /**
356
+ * @public
357
+ */
358
+ export interface AgentToolVariablePredefinedHandler {
359
+ description: string;
360
+ }
361
+ /**
362
+ * @public
363
+ */
364
+ export type AgentToolVariableHandler = AgentToolVariableHandler.AutoMember | AgentToolVariableHandler.GuidedMember | AgentToolVariableHandler.PredefinedMember | AgentToolVariableHandler.$UnknownMember;
365
+ /**
366
+ * @public
367
+ */
368
+ export declare namespace AgentToolVariableHandler {
369
+ interface AutoMember {
370
+ auto: AgentToolVariableAutoHandler;
371
+ guided?: never;
372
+ predefined?: never;
373
+ $unknown?: never;
374
+ }
375
+ interface GuidedMember {
376
+ auto?: never;
377
+ guided: AgentToolVariableGuidedHandler;
378
+ predefined?: never;
379
+ $unknown?: never;
380
+ }
381
+ interface PredefinedMember {
382
+ auto?: never;
383
+ guided?: never;
384
+ predefined: AgentToolVariablePredefinedHandler;
385
+ $unknown?: never;
386
+ }
387
+ /**
388
+ * @public
389
+ */
390
+ interface $UnknownMember {
391
+ auto?: never;
392
+ guided?: never;
393
+ predefined?: never;
394
+ $unknown: [string, any];
395
+ }
396
+ /**
397
+ * @deprecated unused in schema-serde mode.
398
+ *
399
+ */
400
+ interface Visitor<T> {
401
+ auto: (value: AgentToolVariableAutoHandler) => T;
402
+ guided: (value: AgentToolVariableGuidedHandler) => T;
403
+ predefined: (value: AgentToolVariablePredefinedHandler) => T;
404
+ _: (name: string, value: any) => T;
405
+ }
406
+ }
407
+ /**
408
+ * @public
409
+ */
410
+ export interface AgentToolVariable {
411
+ /**
412
+ * Name of the tool variable, e.g.: 'myvar'
413
+ * @public
414
+ */
415
+ name: string;
416
+ handler?: AgentToolVariableHandler | undefined;
417
+ }
418
+ /**
419
+ * Invoke another agent as a dedicated execution with its own state. The called agent runs independently and returns its result.
420
+ * @public
421
+ */
422
+ export interface AgentCallCapability {
423
+ agentId: string;
424
+ variables?: AgentToolVariable[] | undefined;
425
+ }
426
+ /**
427
+ * Delegate the conversation to another agent (max 3 transitions per turn).
428
+ * @public
429
+ */
430
+ export interface AgentDelegationCapability {
431
+ /**
432
+ * Agents this agent may delegate to. Empty list means any agent of the company.
433
+ * @public
434
+ */
435
+ agents?: string[] | undefined;
436
+ /**
437
+ * Extra instructions for when the agent should delegate.
438
+ * @public
439
+ */
440
+ instructions?: string | undefined;
441
+ }
442
+ /**
443
+ * @public
444
+ */
445
+ export interface WebhookAuthorizationBasic {
446
+ username: string;
447
+ password: string;
448
+ }
449
+ /**
450
+ * @public
451
+ */
452
+ export interface WebhookAuthorizationBearer {
453
+ token: string;
454
+ }
455
+ /**
456
+ * @public
457
+ */
458
+ export interface WebhookAuthorizationOAuth {
459
+ clientId: string;
460
+ clientSecret: string;
461
+ endpointUrl: string;
462
+ scope?: string | undefined;
463
+ }
464
+ /**
465
+ * @public
466
+ */
467
+ export type WebhookAuthorization = WebhookAuthorization.BasicMember | WebhookAuthorization.BearerMember | WebhookAuthorization.OauthMember | WebhookAuthorization.$UnknownMember;
468
+ /**
469
+ * @public
470
+ */
471
+ export declare namespace WebhookAuthorization {
472
+ interface BearerMember {
473
+ bearer: WebhookAuthorizationBearer;
474
+ basic?: never;
475
+ oauth?: never;
476
+ $unknown?: never;
477
+ }
478
+ interface BasicMember {
479
+ bearer?: never;
480
+ basic: WebhookAuthorizationBasic;
481
+ oauth?: never;
482
+ $unknown?: never;
483
+ }
484
+ interface OauthMember {
485
+ bearer?: never;
486
+ basic?: never;
487
+ oauth: WebhookAuthorizationOAuth;
488
+ $unknown?: never;
489
+ }
490
+ /**
491
+ * @public
492
+ */
493
+ interface $UnknownMember {
494
+ bearer?: never;
495
+ basic?: never;
496
+ oauth?: never;
497
+ $unknown: [string, any];
498
+ }
499
+ /**
500
+ * @deprecated unused in schema-serde mode.
501
+ *
502
+ */
503
+ interface Visitor<T> {
504
+ bearer: (value: WebhookAuthorizationBearer) => T;
505
+ basic: (value: WebhookAuthorizationBasic) => T;
506
+ oauth: (value: WebhookAuthorizationOAuth) => T;
507
+ _: (name: string, value: any) => T;
508
+ }
509
+ }
510
+ /**
511
+ * @public
512
+ */
513
+ export interface WebhookHeader {
514
+ name: string;
515
+ value: string;
516
+ }
517
+ /**
518
+ * @public
519
+ */
520
+ export interface FunctionWebhookIntegration {
521
+ url: string;
522
+ method?: WebhookMethod | undefined;
523
+ /**
524
+ * Fire-and-forget: do not wait for the webhook response.
525
+ * @public
526
+ */
527
+ async?: boolean | undefined;
528
+ authorization?: WebhookAuthorization | undefined;
529
+ headers?: WebhookHeader[] | undefined;
530
+ /**
531
+ * Timeout in milliseconds for the webhook request.
532
+ * @public
533
+ */
534
+ timeout?: number | undefined;
535
+ /**
536
+ * Request payload template (JSON).
537
+ * @public
538
+ */
539
+ parameters?: __DocumentType | undefined;
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
+ }
553
+ /**
554
+ * @public
555
+ */
556
+ interface $UnknownMember {
557
+ webhook?: never;
558
+ $unknown: [string, any];
559
+ }
560
+ /**
561
+ * @deprecated unused in schema-serde mode.
562
+ *
563
+ */
564
+ interface Visitor<T> {
565
+ webhook: (value: FunctionWebhookIntegration) => T;
566
+ _: (name: string, value: any) => T;
567
+ }
568
+ }
569
+ /**
570
+ * @public
571
+ */
572
+ export interface AgentFunctionTool {
573
+ name: string;
574
+ /**
575
+ * Used by the model to decide when to invoke the function.
576
+ * @public
577
+ */
578
+ description?: string | undefined;
579
+ /**
580
+ * JSON Schema of the function parameters.
581
+ * @public
582
+ */
583
+ parameters?: __DocumentType | undefined;
584
+ integration?: FunctionIntegration | undefined;
585
+ }
586
+ /**
587
+ * Hand the conversation over to a human and leave it. Honoured on conversation channels (chat, assistant).
588
+ * @public
589
+ */
590
+ export interface AgentHandoverCapability {
591
+ /**
592
+ * Extra instructions for when the agent should hand over.
593
+ * @public
594
+ */
595
+ instructions?: string | undefined;
596
+ /**
597
+ * Message sent to the end user when the handover happens.
598
+ * @public
599
+ */
600
+ message?: string | undefined;
601
+ }
602
+ /**
603
+ * @public
604
+ */
605
+ export interface AgentKnowledgeBase {
606
+ knowledgeBaseId?: string | undefined;
607
+ /**
608
+ * Additional instructions for when the agent should use this knowledge base.
609
+ * @public
610
+ */
611
+ instructions?: string | undefined;
612
+ }
613
+ /**
614
+ * Remote MCP (Model Context Protocol) server whose tools are exposed to the agent.
615
+ * @public
616
+ */
617
+ export interface AgentMcpServerCapability {
618
+ url: string;
619
+ authorization?: WebhookAuthorization | undefined;
620
+ /**
621
+ * Restrict the tools exposed from this server. Empty list means all tools.
622
+ * @public
623
+ */
624
+ allowedTools?: string[] | undefined;
625
+ }
626
+ /**
627
+ * Sandbox launched from a pre-built snapshot managed by the wilma-sandbox service.
628
+ * @public
629
+ */
630
+ export interface AgentSnapshotSandboxOptions {
631
+ /**
632
+ * Snapshot to launch sandboxes from. Managed in the wilma-sandbox service; must be READY.
633
+ * @public
634
+ */
635
+ snapshotId: string;
636
+ /**
637
+ * Override the snapshot's network policy for this agent. Defaults to the snapshot's policy.
638
+ * @public
639
+ */
640
+ network?: SandboxNetworkAccess | undefined;
641
+ /**
642
+ * Domains allowed when network = ALLOWLIST.
643
+ * @public
644
+ */
645
+ allowedDomains?: string[] | undefined;
646
+ /**
647
+ * Override the number of vCPUs allocated. Defaults to the snapshot's resources.
648
+ * @public
649
+ */
650
+ vcpus?: number | undefined;
651
+ }
652
+ /**
653
+ * Vercel Sandbox configuration.
654
+ * @public
655
+ */
656
+ export interface AgentVercelSandboxOptions {
657
+ /**
658
+ * Number of vCPUs to allocate (2048 MB memory each).
659
+ * @public
660
+ */
661
+ vcpus?: number | undefined;
662
+ /**
663
+ * Network access. Defaults to deny-all.
664
+ * @public
665
+ */
666
+ network?: SandboxNetworkAccess | undefined;
667
+ /**
668
+ * Domains allowed when network = ALLOWLIST.
669
+ * @public
670
+ */
671
+ allowedDomains?: string[] | undefined;
672
+ }
673
+ /**
674
+ * Embedded sandbox: shell + file tools backed by an execution environment.
675
+ * @public
676
+ */
677
+ export type AgentSandboxCapability = AgentSandboxCapability.SnapshotMember | AgentSandboxCapability.VercelMember | AgentSandboxCapability.$UnknownMember;
678
+ /**
679
+ * @public
680
+ */
681
+ export declare namespace AgentSandboxCapability {
682
+ /**
683
+ * Ad-hoc Vercel Sandbox configured inline on the agent.
684
+ * @public
685
+ */
686
+ interface VercelMember {
687
+ vercel: AgentVercelSandboxOptions;
688
+ snapshot?: never;
689
+ $unknown?: never;
690
+ }
691
+ /**
692
+ * Sandbox launched from a reusable snapshot built via the wilma-sandbox service.
693
+ * @public
694
+ */
695
+ interface SnapshotMember {
696
+ vercel?: never;
697
+ snapshot: AgentSnapshotSandboxOptions;
698
+ $unknown?: never;
699
+ }
700
+ /**
701
+ * @public
702
+ */
703
+ interface $UnknownMember {
704
+ vercel?: never;
705
+ snapshot?: never;
706
+ $unknown: [string, any];
707
+ }
708
+ /**
709
+ * @deprecated unused in schema-serde mode.
710
+ *
711
+ */
712
+ interface Visitor<T> {
713
+ vercel: (value: AgentVercelSandboxOptions) => T;
714
+ snapshot: (value: AgentSnapshotSandboxOptions) => T;
715
+ _: (name: string, value: any) => T;
716
+ }
717
+ }
718
+ /**
719
+ * Emit suggested replies for human operators instead of, or in addition to, answering directly. Honoured on the chat channel.
720
+ * @public
721
+ */
722
+ export interface AgentSuggestionsCapability {
723
+ }
724
+ /**
725
+ * @public
726
+ */
727
+ export interface AgentTool {
728
+ /**
729
+ * Unique identifier of the tool using nanoid format
730
+ * @public
731
+ */
732
+ id: string;
733
+ variables?: AgentToolVariable[] | undefined;
734
+ }
735
+ /**
736
+ * Transfer the interaction to a PBX destination. Honoured on the voice channel.
737
+ * @public
738
+ */
739
+ export interface AgentTransferCapability {
740
+ targets: VoiceTransferTarget[];
741
+ /**
742
+ * Extra instructions for when the agent should transfer.
743
+ * @public
744
+ */
745
+ instructions?: string | undefined;
746
+ }
747
+ /**
748
+ * Server-side fetch of a URL, returning its readable text/markdown to the model.
749
+ * @public
750
+ */
751
+ export interface AgentWebFetchCapability {
752
+ /**
753
+ * Restrict fetches to these domains. Empty list means any domain is allowed.
754
+ * @public
755
+ */
756
+ allowedDomains?: string[] | undefined;
757
+ }
758
+ /**
759
+ * @public
760
+ */
761
+ export interface WebSearchUserLocation {
762
+ /**
763
+ * ISO 3166-1 alpha-2 country code, e.g. 'US'.
764
+ * @public
765
+ */
766
+ country?: string | undefined;
767
+ region?: string | undefined;
768
+ city?: string | undefined;
769
+ /**
770
+ * IANA timezone, e.g. 'Europe/Rome'.
771
+ * @public
772
+ */
773
+ timezone?: string | undefined;
774
+ }
775
+ /**
776
+ * Model-native web search. The provider tool is selected from the agent model.
777
+ * @public
778
+ */
779
+ export interface AgentWebSearchCapability {
780
+ /**
781
+ * Context size hint. Defaults to medium.
782
+ * @public
783
+ */
784
+ contextSize?: WebSearchContextSize | undefined;
785
+ /**
786
+ * Restrict results to these domains where the provider supports it.
787
+ * @public
788
+ */
789
+ allowedDomains?: string[] | undefined;
790
+ userLocation?: WebSearchUserLocation | undefined;
791
+ }
792
+ /**
793
+ * @public
794
+ */
795
+ export type AgentCapability = AgentCapability.AgentMember | AgentCapability.DelegationMember | AgentCapability.FunctionMember | AgentCapability.HandoverMember | AgentCapability.KbMember | AgentCapability.McpMember | AgentCapability.SandboxMember | AgentCapability.SuggestionsMember | AgentCapability.ToolMember | AgentCapability.TransferMember | AgentCapability.WebFetchMember | AgentCapability.WebSearchMember | AgentCapability.$UnknownMember;
796
+ /**
797
+ * @public
798
+ */
799
+ export declare namespace AgentCapability {
800
+ interface ToolMember {
801
+ tool: AgentTool;
802
+ function?: never;
803
+ kb?: never;
804
+ sandbox?: never;
805
+ webSearch?: never;
806
+ webFetch?: never;
807
+ 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
+ handover?: never;
825
+ delegation?: never;
826
+ transfer?: never;
827
+ suggestions?: never;
828
+ $unknown?: never;
829
+ }
830
+ interface KbMember {
831
+ tool?: never;
832
+ function?: never;
833
+ kb: AgentKnowledgeBase;
834
+ sandbox?: never;
835
+ webSearch?: never;
836
+ webFetch?: never;
837
+ agent?: never;
838
+ mcp?: never;
839
+ handover?: never;
840
+ delegation?: never;
841
+ transfer?: never;
842
+ suggestions?: never;
843
+ $unknown?: never;
844
+ }
845
+ /**
846
+ * Embedded sandbox: shell + file tools backed by an execution environment.
847
+ * @public
848
+ */
849
+ interface SandboxMember {
850
+ tool?: never;
851
+ function?: never;
852
+ kb?: never;
853
+ sandbox: AgentSandboxCapability;
854
+ webSearch?: never;
855
+ webFetch?: never;
856
+ agent?: never;
857
+ mcp?: never;
858
+ handover?: never;
859
+ delegation?: never;
860
+ transfer?: never;
861
+ suggestions?: never;
862
+ $unknown?: never;
863
+ }
864
+ /**
865
+ * Model-native web search. The provider tool is selected from the agent model.
866
+ * @public
867
+ */
868
+ interface WebSearchMember {
869
+ tool?: never;
870
+ function?: never;
871
+ kb?: never;
872
+ sandbox?: never;
873
+ webSearch: AgentWebSearchCapability;
874
+ webFetch?: never;
875
+ agent?: never;
876
+ mcp?: never;
877
+ handover?: never;
878
+ delegation?: never;
879
+ transfer?: never;
880
+ suggestions?: never;
881
+ $unknown?: never;
882
+ }
883
+ /**
884
+ * Server-side fetch of a URL, returning its readable text/markdown to the model.
885
+ * @public
886
+ */
887
+ interface WebFetchMember {
888
+ tool?: never;
889
+ function?: never;
890
+ kb?: never;
891
+ sandbox?: never;
892
+ webSearch?: never;
893
+ webFetch: AgentWebFetchCapability;
894
+ agent?: never;
895
+ mcp?: never;
896
+ handover?: never;
897
+ delegation?: never;
898
+ transfer?: never;
899
+ suggestions?: never;
900
+ $unknown?: never;
901
+ }
902
+ /**
903
+ * Invoke another agent as a dedicated execution with its own state. The called agent runs independently and returns its result.
904
+ * @public
905
+ */
906
+ interface AgentMember {
907
+ tool?: never;
908
+ function?: never;
909
+ kb?: never;
910
+ sandbox?: never;
911
+ webSearch?: never;
912
+ webFetch?: never;
913
+ agent: AgentCallCapability;
914
+ mcp?: never;
915
+ handover?: never;
916
+ delegation?: never;
917
+ transfer?: never;
918
+ suggestions?: never;
919
+ $unknown?: never;
920
+ }
921
+ /**
922
+ * Remote MCP (Model Context Protocol) server whose tools are exposed to the agent.
923
+ * @public
924
+ */
925
+ interface McpMember {
926
+ tool?: never;
927
+ function?: never;
928
+ kb?: never;
929
+ sandbox?: never;
930
+ webSearch?: never;
931
+ webFetch?: never;
932
+ agent?: never;
933
+ mcp: AgentMcpServerCapability;
934
+ handover?: never;
935
+ delegation?: never;
936
+ transfer?: never;
937
+ suggestions?: never;
938
+ $unknown?: never;
939
+ }
940
+ /**
941
+ * Hand the conversation over to a human and leave it. Honoured on conversation channels (chat, assistant).
942
+ * @public
943
+ */
944
+ interface HandoverMember {
945
+ tool?: never;
946
+ function?: never;
947
+ kb?: never;
948
+ sandbox?: never;
949
+ webSearch?: never;
950
+ webFetch?: never;
951
+ agent?: never;
952
+ mcp?: never;
953
+ handover: AgentHandoverCapability;
954
+ delegation?: never;
955
+ transfer?: never;
956
+ suggestions?: never;
957
+ $unknown?: never;
958
+ }
959
+ /**
960
+ * Delegate the conversation to another agent (max 3 transitions per turn).
961
+ * @public
962
+ */
963
+ interface DelegationMember {
964
+ tool?: never;
965
+ function?: never;
966
+ kb?: never;
967
+ sandbox?: never;
968
+ webSearch?: never;
969
+ webFetch?: never;
970
+ agent?: never;
971
+ mcp?: never;
972
+ handover?: never;
973
+ delegation: AgentDelegationCapability;
974
+ transfer?: never;
975
+ suggestions?: never;
976
+ $unknown?: never;
977
+ }
978
+ /**
979
+ * Transfer the interaction to a PBX destination. Honoured on the voice channel.
980
+ * @public
981
+ */
982
+ interface TransferMember {
983
+ tool?: never;
984
+ function?: never;
985
+ kb?: never;
986
+ sandbox?: never;
987
+ webSearch?: never;
988
+ webFetch?: never;
989
+ agent?: never;
990
+ mcp?: never;
991
+ handover?: never;
992
+ delegation?: never;
993
+ transfer: AgentTransferCapability;
994
+ suggestions?: never;
995
+ $unknown?: never;
996
+ }
997
+ /**
998
+ * Emit suggested replies for human operators instead of, or in addition to, answering directly. Honoured on the chat channel.
999
+ * @public
1000
+ */
1001
+ interface SuggestionsMember {
1002
+ tool?: never;
1003
+ function?: never;
1004
+ kb?: never;
1005
+ sandbox?: never;
1006
+ webSearch?: never;
1007
+ webFetch?: never;
1008
+ agent?: never;
1009
+ mcp?: never;
1010
+ handover?: never;
1011
+ delegation?: never;
1012
+ transfer?: never;
1013
+ suggestions: AgentSuggestionsCapability;
1014
+ $unknown?: never;
1015
+ }
1016
+ /**
1017
+ * @public
1018
+ */
1019
+ interface $UnknownMember {
1020
+ tool?: never;
1021
+ function?: never;
1022
+ kb?: never;
1023
+ sandbox?: never;
1024
+ webSearch?: never;
1025
+ webFetch?: never;
1026
+ agent?: never;
1027
+ mcp?: never;
1028
+ handover?: never;
1029
+ delegation?: never;
1030
+ transfer?: never;
1031
+ suggestions?: never;
1032
+ $unknown: [string, any];
1033
+ }
1034
+ /**
1035
+ * @deprecated unused in schema-serde mode.
1036
+ *
1037
+ */
1038
+ interface Visitor<T> {
1039
+ tool: (value: AgentTool) => T;
1040
+ function: (value: AgentFunctionTool) => T;
1041
+ kb: (value: AgentKnowledgeBase) => T;
1042
+ sandbox: (value: AgentSandboxCapability) => T;
1043
+ webSearch: (value: AgentWebSearchCapability) => T;
1044
+ webFetch: (value: AgentWebFetchCapability) => T;
1045
+ agent: (value: AgentCallCapability) => T;
1046
+ mcp: (value: AgentMcpServerCapability) => T;
1047
+ handover: (value: AgentHandoverCapability) => T;
1048
+ delegation: (value: AgentDelegationCapability) => T;
1049
+ transfer: (value: AgentTransferCapability) => T;
1050
+ suggestions: (value: AgentSuggestionsCapability) => T;
1051
+ _: (name: string, value: any) => T;
1052
+ }
1053
+ }
1054
+ /**
1055
+ * @public
1056
+ */
1057
+ export interface AgentVariable {
1058
+ name: string;
1059
+ type: AgentVariableType;
1060
+ optional: boolean;
1061
+ /**
1062
+ * What the variable means and how it should be filled.
1063
+ * @public
1064
+ */
1065
+ description?: string | undefined;
1066
+ }
1067
+ /**
1068
+ * Managed LLM engine: the platform runs the model, tools and knowledge lookups.
1069
+ * @public
1070
+ */
1071
+ export interface AgentLlmEngine {
1072
+ instructions: string;
1073
+ /**
1074
+ * Defaults to the platform default model when omitted.
1075
+ * @public
1076
+ */
1077
+ model?: string | undefined;
1078
+ /**
1079
+ * Skills attached to this agent (progressive disclosure).
1080
+ * @public
1081
+ */
1082
+ skills?: string[] | undefined;
1083
+ capabilities?: AgentCapability[] | undefined;
1084
+ variables?: AgentVariable[] | undefined;
1085
+ }
1086
+ /**
1087
+ * Bring-your-own backend over SQS: turns are forwarded to the queue, replies are posted back via the API.
1088
+ * @public
1089
+ */
1090
+ export interface AgentSqsEngine {
1091
+ url: string;
1092
+ key: string;
1093
+ secret: string;
1094
+ }
1095
+ /**
1096
+ * Bring-your-own backend over HTTPS: each turn is POSTed to the URL, the response is the reply.
1097
+ * @public
1098
+ */
1099
+ export interface AgentWebhookEngine {
1100
+ url: string;
1101
+ /**
1102
+ * Shared secret used to sign requests (HMAC).
1103
+ * @public
1104
+ */
1105
+ secret: string;
1106
+ timeout?: number | undefined;
1107
+ }
1108
+ /**
1109
+ * @public
1110
+ */
1111
+ export type AgentEngine = AgentEngine.LlmMember | AgentEngine.SqsMember | AgentEngine.WebhookMember | AgentEngine.$UnknownMember;
1112
+ /**
1113
+ * @public
1114
+ */
1115
+ export declare namespace AgentEngine {
1116
+ /**
1117
+ * Managed LLM engine: the platform runs the model, tools and knowledge lookups.
1118
+ * @public
1119
+ */
1120
+ interface LlmMember {
1121
+ llm: AgentLlmEngine;
1122
+ webhook?: never;
1123
+ sqs?: never;
1124
+ $unknown?: never;
1125
+ }
1126
+ /**
1127
+ * Bring-your-own backend over HTTPS: each turn is POSTed to the URL, the response is the reply.
1128
+ * @public
1129
+ */
1130
+ interface WebhookMember {
1131
+ llm?: never;
1132
+ webhook: AgentWebhookEngine;
1133
+ sqs?: never;
1134
+ $unknown?: never;
1135
+ }
1136
+ /**
1137
+ * Bring-your-own backend over SQS: turns are forwarded to the queue, replies are posted back via the API.
1138
+ * @public
1139
+ */
1140
+ interface SqsMember {
1141
+ llm?: never;
1142
+ webhook?: never;
1143
+ sqs: AgentSqsEngine;
1144
+ $unknown?: never;
1145
+ }
1146
+ /**
1147
+ * @public
1148
+ */
1149
+ interface $UnknownMember {
1150
+ llm?: never;
1151
+ webhook?: never;
1152
+ sqs?: never;
1153
+ $unknown: [string, any];
1154
+ }
1155
+ /**
1156
+ * @deprecated unused in schema-serde mode.
1157
+ *
1158
+ */
1159
+ interface Visitor<T> {
1160
+ llm: (value: AgentLlmEngine) => T;
1161
+ webhook: (value: AgentWebhookEngine) => T;
1162
+ sqs: (value: AgentSqsEngine) => T;
1163
+ _: (name: string, value: any) => T;
1164
+ }
1165
+ }
1166
+ /**
1167
+ * The complete, versionable configuration of an agent. This is what gets snapshotted when a version is published.
1168
+ * @public
1169
+ */
1170
+ export interface Agent {
1171
+ name: string;
1172
+ description?: string | undefined;
1173
+ /**
1174
+ * Category of the agent, e.g.: 'Support'.
1175
+ * @public
1176
+ */
1177
+ category?: string | undefined;
1178
+ /**
1179
+ * Avatar URL.
1180
+ * @public
1181
+ */
1182
+ picture?: string | undefined;
1183
+ engine: AgentEngine;
1184
+ /**
1185
+ * Per-channel deployment settings. An agent is reachable only on channels configured here.
1186
+ * @public
1187
+ */
1188
+ channels?: AgentChannels | undefined;
1189
+ /**
1190
+ * Guardrail policies applied to this agent's inputs and outputs.
1191
+ * @public
1192
+ */
1193
+ guardrails?: string[] | undefined;
1194
+ access?: AgentAccess | undefined;
1195
+ /**
1196
+ * ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
1197
+ * @public
1198
+ */
1199
+ createdAt: string;
1200
+ /**
1201
+ * Who performed an action: an interactive user, an API key or an internal service.
1202
+ * @public
1203
+ */
1204
+ createdBy: Actor;
1205
+ /**
1206
+ * ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
1207
+ * @public
1208
+ */
1209
+ updatedAt?: string | undefined;
1210
+ /**
1211
+ * Who performed an action: an interactive user, an API key or an internal service.
1212
+ * @public
1213
+ */
1214
+ updatedBy?: Actor | undefined;
1215
+ id: string;
1216
+ status: AgentStatus;
1217
+ /**
1218
+ * Monotonic revision of the draft, incremented on every update. Pass it back on update for optimistic locking.
1219
+ * @public
1220
+ */
1221
+ revision: number;
1222
+ /**
1223
+ * Latest published version number; absent while the agent is still a draft.
1224
+ * @public
1225
+ */
1226
+ latestVersion?: number | undefined;
1227
+ /**
1228
+ * Aliases of this agent with their version routing (e.g. 'production', 'staging').
1229
+ * @public
1230
+ */
1231
+ aliases?: AgentAlias[] | undefined;
1232
+ }
1233
+ /**
1234
+ * @public
1235
+ */
1236
+ export interface AgentApiKey {
1237
+ id: string;
1238
+ name?: string | undefined;
1239
+ /**
1240
+ * Non-secret prefix of the key, e.g. 'sk-a1b2', for display purposes.
1241
+ * @public
1242
+ */
1243
+ prefix: string;
1244
+ /**
1245
+ * ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
1246
+ * @public
1247
+ */
1248
+ createdAt: string;
1249
+ /**
1250
+ * Who performed an action: an interactive user, an API key or an internal service.
1251
+ * @public
1252
+ */
1253
+ createdBy: Actor;
1254
+ /**
1255
+ * ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
1256
+ * @public
1257
+ */
1258
+ expiresAt?: string | undefined;
1259
+ /**
1260
+ * ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
1261
+ * @public
1262
+ */
1263
+ lastUsedAt?: string | undefined;
1264
+ }
1265
+ /**
1266
+ * The complete, versionable configuration of an agent. This is what gets snapshotted when a version is published.
1267
+ * @public
1268
+ */
1269
+ export interface AgentDefinitionSnapshot {
1270
+ name: string;
1271
+ description?: string | undefined;
1272
+ /**
1273
+ * Category of the agent, e.g.: 'Support'.
1274
+ * @public
1275
+ */
1276
+ category?: string | undefined;
1277
+ /**
1278
+ * Avatar URL.
1279
+ * @public
1280
+ */
1281
+ picture?: string | undefined;
1282
+ engine: AgentEngine;
1283
+ /**
1284
+ * Per-channel deployment settings. An agent is reachable only on channels configured here.
1285
+ * @public
1286
+ */
1287
+ channels?: AgentChannels | undefined;
1288
+ /**
1289
+ * Guardrail policies applied to this agent's inputs and outputs.
1290
+ * @public
1291
+ */
1292
+ guardrails?: string[] | undefined;
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;
1358
+ /**
1359
+ * Files created by the agent during execution (downloadable via the Files API).
1360
+ * @public
1361
+ */
1362
+ files?: AgentFile[] | undefined;
1363
+ /**
1364
+ * Trace produced by this execution, inspectable via the wilma-traces API.
1365
+ * @public
1366
+ */
1367
+ traceId?: string | undefined;
1368
+ }
1369
+ /**
1370
+ * @public
1371
+ */
1372
+ export interface AgentInfo {
1373
+ id: string;
1374
+ name: string;
1375
+ category?: string | undefined;
1376
+ status: AgentStatus;
1377
+ /**
1378
+ * Channels this agent is deployed to.
1379
+ * @public
1380
+ */
1381
+ channels?: ChannelType[] | undefined;
1382
+ latestVersion?: number | undefined;
1383
+ }
1384
+ /**
1385
+ * @public
1386
+ */
1387
+ export interface AgentVersion {
1388
+ agentId: string;
1389
+ /**
1390
+ * Monotonic version number, starting at 1.
1391
+ * @public
1392
+ */
1393
+ version: number;
1394
+ /**
1395
+ * What changed in this version, provided at publish time.
1396
+ * @public
1397
+ */
1398
+ changelog?: string | undefined;
1399
+ /**
1400
+ * Immutable snapshot of the agent definition at publish time.
1401
+ * @public
1402
+ */
1403
+ definition: AgentDefinitionSnapshot;
1404
+ /**
1405
+ * ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
1406
+ * @public
1407
+ */
1408
+ publishedAt: string;
1409
+ /**
1410
+ * Who performed an action: an interactive user, an API key or an internal service.
1411
+ * @public
1412
+ */
1413
+ publishedBy: Actor;
1414
+ }
1415
+ /**
1416
+ * @public
1417
+ */
1418
+ export interface AgentVersionChange {
1419
+ /**
1420
+ * JSON pointer of the changed field within the agent definition, e.g. '/engine/llm/instructions'.
1421
+ * @public
1422
+ */
1423
+ path: string;
1424
+ /**
1425
+ * Value before the change (absent when the field was added).
1426
+ * @public
1427
+ */
1428
+ before?: __DocumentType | undefined;
1429
+ /**
1430
+ * Value after the change (absent when the field was removed).
1431
+ * @public
1432
+ */
1433
+ after?: __DocumentType | undefined;
1434
+ }
1435
+ /**
1436
+ * Version list entry without the full definition snapshot.
1437
+ * @public
1438
+ */
1439
+ export interface AgentVersionInfo {
1440
+ agentId: string;
1441
+ version: number;
1442
+ changelog?: string | undefined;
1443
+ /**
1444
+ * ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
1445
+ * @public
1446
+ */
1447
+ publishedAt: string;
1448
+ /**
1449
+ * Who performed an action: an interactive user, an API key or an internal service.
1450
+ * @public
1451
+ */
1452
+ publishedBy: Actor;
1453
+ /**
1454
+ * Names of the aliases currently routing to this version.
1455
+ * @public
1456
+ */
1457
+ aliases?: string[] | undefined;
1458
+ }
1459
+ /**
1460
+ * @public
1461
+ */
1462
+ export interface AuditRecord {
1463
+ id: string;
1464
+ /**
1465
+ * ISO-8601 timestamp, e.g. '2026-07-03T10:15:30.000Z'.
1466
+ * @public
1467
+ */
1468
+ timestamp: string;
1469
+ /**
1470
+ * Who performed an action: an interactive user, an API key or an internal service.
1471
+ * @public
1472
+ */
1473
+ actor: Actor;
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;
1487
+ /**
1488
+ * Correlation id of the API request that caused the change.
1489
+ * @public
1490
+ */
1491
+ requestId?: string | undefined;
1492
+ }
1493
+ /**
1494
+ * @public
1495
+ */
1496
+ export interface CompareAgentVersionsInput {
1497
+ company?: string | undefined;
1498
+ agentId: string;
1499
+ /**
1500
+ * Base version. 0 means the current draft.
1501
+ * @public
1502
+ */
1503
+ from: number;
1504
+ /**
1505
+ * Target version. 0 means the current draft.
1506
+ * @public
1507
+ */
1508
+ to: number;
1509
+ }
1510
+ /**
1511
+ * @public
1512
+ */
1513
+ export interface CompareAgentVersionsOutput {
1514
+ changes: AgentVersionChange[];
1515
+ }
1516
+ /**
1517
+ * The complete, versionable configuration of an agent. This is what gets snapshotted when a version is published.
1518
+ * @public
1519
+ */
1520
+ export interface CreateAgentInput {
1521
+ name: string;
1522
+ description?: string | undefined;
1523
+ /**
1524
+ * Category of the agent, e.g.: 'Support'.
1525
+ * @public
1526
+ */
1527
+ category?: string | undefined;
1528
+ /**
1529
+ * Avatar URL.
1530
+ * @public
1531
+ */
1532
+ picture?: string | undefined;
1533
+ engine: AgentEngine;
1534
+ /**
1535
+ * Per-channel deployment settings. An agent is reachable only on channels configured here.
1536
+ * @public
1537
+ */
1538
+ channels?: AgentChannels | undefined;
1539
+ /**
1540
+ * Guardrail policies applied to this agent's inputs and outputs.
1541
+ * @public
1542
+ */
1543
+ guardrails?: string[] | undefined;
1544
+ access?: AgentAccess | undefined;
1545
+ company?: string | undefined;
1546
+ }
1547
+ /**
1548
+ * @public
1549
+ */
1550
+ export interface CreateAgentOutput {
1551
+ /**
1552
+ * The complete, versionable configuration of an agent. This is what gets snapshotted when a version is published.
1553
+ * @public
1554
+ */
1555
+ agent: Agent;
1556
+ }
1557
+ /**
1558
+ * @public
1559
+ */
1560
+ export interface CreateAgentApiKeyInput {
1561
+ company?: string | undefined;
1562
+ agentId: string;
1563
+ name?: string | undefined;
1564
+ /**
1565
+ * Optional expiry; the key stops working after this time.
1566
+ * @public
1567
+ */
1568
+ expiresAt?: string | undefined;
1569
+ }
1570
+ /**
1571
+ * @public
1572
+ */
1573
+ export interface CreateAgentApiKeyOutput {
1574
+ key: AgentApiKey;
1575
+ /**
1576
+ * The full secret. Shown only once.
1577
+ * @public
1578
+ */
1579
+ secret: string;
1580
+ }
1581
+ /**
1582
+ * @public
1583
+ */
1584
+ export interface GuardrailContentFilter {
1585
+ category: GuardrailContentCategory;
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;
1683
+ /**
1684
+ * Answer returned to the end user when the agent output is blocked.
1685
+ * @public
1686
+ */
1687
+ blockedOutputMessage?: string | undefined;
1688
+ company?: string | undefined;
1689
+ }
1690
+ /**
1691
+ * Editable guardrail configuration.
1692
+ * @public
1693
+ */
1694
+ export interface Guardrail {
1695
+ name: string;
1696
+ description?: string | undefined;
1697
+ topicPolicy?: GuardrailTopicPolicy | undefined;
1698
+ contentPolicy?: GuardrailContentPolicy | undefined;
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;
1732
+ }
1733
+ /**
1734
+ * @public
1735
+ */
1736
+ export interface CreateGuardrailOutput {
1737
+ /**
1738
+ * Editable guardrail configuration.
1739
+ * @public
1740
+ */
1741
+ guardrail: Guardrail;
1742
+ }
1743
+ /**
1744
+ * @public
1745
+ */
1746
+ export interface DeleteAgentInput {
1747
+ company?: string | undefined;
1748
+ agentId: string;
1749
+ }
1750
+ /**
1751
+ * @public
1752
+ */
1753
+ export interface DeleteAgentOutput {
1754
+ }
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
+ /**
1773
+ * @public
1774
+ */
1775
+ export interface DeleteAgentApiKeyInput {
1776
+ company?: string | undefined;
1777
+ agentId: string;
1778
+ keyId: string;
1779
+ }
1780
+ /**
1781
+ * @public
1782
+ */
1783
+ export interface DeleteAgentApiKeyOutput {
1784
+ }
1785
+ /**
1786
+ * @public
1787
+ */
1788
+ export interface DeleteGuardrailInput {
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 {
1801
+ company?: string | undefined;
1802
+ agentId: string;
1803
+ /**
1804
+ * Message or task for the agent.
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.
1825
+ * @public
1826
+ */
1827
+ user?: string | undefined;
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;
1843
+ }
1844
+ /**
1845
+ * @public
1846
+ */
1847
+ export interface ExecuteAgentOutput {
1848
+ result: AgentExecutionResult;
1849
+ }
1850
+ /**
1851
+ * @public
1852
+ */
1853
+ export interface GetAgentInput {
1854
+ company?: string | undefined;
1855
+ agentId: string;
1856
+ }
1857
+ /**
1858
+ * @public
1859
+ */
1860
+ export interface GetAgentOutput {
1861
+ /**
1862
+ * The complete, versionable configuration of an agent. This is what gets snapshotted when a version is published.
1863
+ * @public
1864
+ */
1865
+ agent: Agent;
1866
+ }
1867
+ /**
1868
+ * @public
1869
+ */
1870
+ export interface GetAgentVersionInput {
1871
+ company?: string | undefined;
1872
+ agentId: string;
1873
+ version: number;
1874
+ }
1875
+ /**
1876
+ * @public
1877
+ */
1878
+ export interface GetAgentVersionOutput {
1879
+ version: AgentVersion;
1880
+ }
1881
+ /**
1882
+ * @public
1883
+ */
1884
+ export interface GetGuardrailInput {
1885
+ company?: string | undefined;
1886
+ guardrailId: string;
1887
+ }
1888
+ /**
1889
+ * @public
1890
+ */
1891
+ export interface GetGuardrailOutput {
1892
+ /**
1893
+ * Editable guardrail configuration.
1894
+ * @public
1895
+ */
1896
+ guardrail: Guardrail;
1897
+ }
1898
+ /**
1899
+ * @public
1900
+ */
1901
+ export interface ListAgentAliasesInput {
1902
+ company?: string | undefined;
1903
+ agentId: string;
1904
+ }
1905
+ /**
1906
+ * @public
1907
+ */
1908
+ export interface ListAgentAliasesOutput {
1909
+ aliases: AgentAlias[];
1910
+ }
1911
+ /**
1912
+ * @public
1913
+ */
1914
+ export interface ListAgentApiKeysInput {
1915
+ company?: string | undefined;
1916
+ agentId: string;
1917
+ }
1918
+ /**
1919
+ * @public
1920
+ */
1921
+ export interface ListAgentApiKeysOutput {
1922
+ keys: AgentApiKey[];
1923
+ }
1924
+ /**
1925
+ * @public
1926
+ */
1927
+ export interface ListAgentsInput {
1928
+ company?: string | undefined;
1929
+ /**
1930
+ * Only agents deployed to this channel.
1931
+ * @public
1932
+ */
1933
+ channel?: ChannelType | undefined;
1934
+ status?: AgentStatus | undefined;
1935
+ /**
1936
+ * Filter by name or category.
1937
+ * @public
1938
+ */
1939
+ search?: string | undefined;
1940
+ limit?: number | undefined;
1941
+ /**
1942
+ * Opaque cursor returned by a previous page; pass it back to fetch the next page.
1943
+ * @public
1944
+ */
1945
+ nextToken?: string | undefined;
1946
+ }
1947
+ /**
1948
+ * @public
1949
+ */
1950
+ export interface ListAgentsOutput {
1951
+ agents: Agent[];
1952
+ /**
1953
+ * Opaque cursor returned by a previous page; pass it back to fetch the next page.
1954
+ * @public
1955
+ */
1956
+ nextToken?: string | undefined;
1957
+ }
1958
+ /**
1959
+ * @public
1960
+ */
1961
+ export interface ListAgentsNamesInput {
1962
+ company?: string | undefined;
1963
+ /**
1964
+ * Delivery channel an agent can be deployed to.
1965
+ * @public
1966
+ */
1967
+ channel?: ChannelType | undefined;
1968
+ }
1969
+ /**
1970
+ * @public
1971
+ */
1972
+ export interface ListAgentsNamesOutput {
1973
+ agents: AgentInfo[];
1974
+ }
1975
+ /**
1976
+ * @public
1977
+ */
1978
+ export interface ListAgentVersionsInput {
1979
+ company?: string | undefined;
1980
+ agentId: string;
1981
+ limit?: number | undefined;
1982
+ /**
1983
+ * Opaque cursor returned by a previous page; pass it back to fetch the next page.
1984
+ * @public
1985
+ */
1986
+ nextToken?: string | undefined;
1987
+ }
1988
+ /**
1989
+ * @public
1990
+ */
1991
+ export interface ListAgentVersionsOutput {
1992
+ versions: AgentVersionInfo[];
1993
+ /**
1994
+ * Opaque cursor returned by a previous page; pass it back to fetch the next page.
1995
+ * @public
1996
+ */
1997
+ nextToken?: string | undefined;
1998
+ }
1999
+ /**
2000
+ * @public
2001
+ */
2002
+ export interface ListAuditRecordsInput {
2003
+ company?: string | undefined;
2004
+ agentId?: string | undefined;
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;
2023
+ /**
2024
+ * Opaque cursor returned by a previous page; pass it back to fetch the next page.
2025
+ * @public
2026
+ */
2027
+ nextToken?: string | undefined;
2028
+ }
2029
+ /**
2030
+ * @public
2031
+ */
2032
+ export interface ListAuditRecordsOutput {
2033
+ records: AuditRecord[];
2034
+ /**
2035
+ * Opaque cursor returned by a previous page; pass it back to fetch the next page.
2036
+ * @public
2037
+ */
2038
+ nextToken?: string | undefined;
2039
+ }
2040
+ /**
2041
+ * @public
2042
+ */
2043
+ export interface ListGuardrailsInput {
2044
+ company?: string | undefined;
2045
+ limit?: number | undefined;
2046
+ /**
2047
+ * Opaque cursor returned by a previous page; pass it back to fetch the next page.
2048
+ * @public
2049
+ */
2050
+ nextToken?: string | undefined;
2051
+ }
2052
+ /**
2053
+ * @public
2054
+ */
2055
+ export interface ListGuardrailsOutput {
2056
+ guardrails: Guardrail[];
2057
+ /**
2058
+ * Opaque cursor returned by a previous page; pass it back to fetch the next page.
2059
+ * @public
2060
+ */
2061
+ nextToken?: string | undefined;
2062
+ }
2063
+ /**
2064
+ * @public
2065
+ */
2066
+ export interface PublishAgentVersionInput {
2067
+ company?: string | undefined;
2068
+ agentId: string;
2069
+ /**
2070
+ * What changed in this version.
2071
+ * @public
2072
+ */
2073
+ changelog?: string | undefined;
2074
+ /**
2075
+ * Draft revision this publish is based on (optimistic locking).
2076
+ * @public
2077
+ */
2078
+ revision?: number | undefined;
2079
+ }
2080
+ /**
2081
+ * @public
2082
+ */
2083
+ export interface PublishAgentVersionOutput {
2084
+ version: AgentVersion;
2085
+ }
2086
+ /**
2087
+ * @public
2088
+ */
2089
+ export interface PutAgentAliasInput {
2090
+ company?: string | undefined;
2091
+ agentId: string;
2092
+ /**
2093
+ * Alias name, e.g. 'production', 'staging'.
2094
+ * @public
2095
+ */
2096
+ aliasName: string;
2097
+ description?: string | undefined;
2098
+ routing: AgentAliasRoute[];
2099
+ }
2100
+ /**
2101
+ * @public
2102
+ */
2103
+ export interface PutAgentAliasOutput {
2104
+ alias: AgentAlias;
2105
+ }
2106
+ /**
2107
+ * The complete, versionable configuration of an agent. This is what gets snapshotted when a version is published.
2108
+ * @public
2109
+ */
2110
+ export interface UpdateAgentInput {
2111
+ name: string;
2112
+ description?: string | undefined;
2113
+ /**
2114
+ * Category of the agent, e.g.: 'Support'.
2115
+ * @public
2116
+ */
2117
+ category?: string | undefined;
2118
+ /**
2119
+ * Avatar URL.
2120
+ * @public
2121
+ */
2122
+ picture?: string | undefined;
2123
+ engine: AgentEngine;
2124
+ /**
2125
+ * Per-channel deployment settings. An agent is reachable only on channels configured here.
2126
+ * @public
2127
+ */
2128
+ channels?: AgentChannels | undefined;
2129
+ /**
2130
+ * Guardrail policies applied to this agent's inputs and outputs.
2131
+ * @public
2132
+ */
2133
+ guardrails?: string[] | undefined;
2134
+ access?: AgentAccess | undefined;
2135
+ company?: string | undefined;
2136
+ agentId: string;
2137
+ /**
2138
+ * Draft revision this update is based on (optimistic locking). When it does not match the current revision, RevisionConflictException is returned.
2139
+ * @public
2140
+ */
2141
+ revision?: number | undefined;
2142
+ }
2143
+ /**
2144
+ * @public
2145
+ */
2146
+ export interface UpdateAgentOutput {
2147
+ /**
2148
+ * The complete, versionable configuration of an agent. This is what gets snapshotted when a version is published.
2149
+ * @public
2150
+ */
2151
+ agent: Agent;
2152
+ }
2153
+ /**
2154
+ * Editable guardrail configuration.
2155
+ * @public
2156
+ */
2157
+ export interface UpdateGuardrailInput {
2158
+ name: string;
2159
+ description?: string | undefined;
2160
+ topicPolicy?: GuardrailTopicPolicy | undefined;
2161
+ contentPolicy?: GuardrailContentPolicy | undefined;
2162
+ wordPolicy?: GuardrailWordPolicy | undefined;
2163
+ piiPolicy?: GuardrailPiiPolicy | undefined;
2164
+ /**
2165
+ * Answer returned to the end user when input is blocked.
2166
+ * @public
2167
+ */
2168
+ blockedInputMessage?: string | undefined;
2169
+ /**
2170
+ * Answer returned to the end user when the agent output is blocked.
2171
+ * @public
2172
+ */
2173
+ blockedOutputMessage?: string | undefined;
2174
+ company?: string | undefined;
2175
+ guardrailId: string;
2176
+ }
2177
+ /**
2178
+ * @public
2179
+ */
2180
+ export interface UpdateGuardrailOutput {
2181
+ /**
2182
+ * Editable guardrail configuration.
2183
+ * @public
2184
+ */
2185
+ guardrail: Guardrail;
2186
+ }