@wildix/wilma-agents-client 1.0.26 → 1.0.28
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/models/enums.js +28 -1
- package/dist-cjs/schemas/schemas_0.js +106 -21
- package/dist-es/models/enums.js +27 -0
- package/dist-es/schemas/schemas_0.js +102 -17
- package/dist-types/commands/CreateAgentCommand.d.ts +94 -4
- package/dist-types/commands/GetAgentCommand.d.ts +47 -2
- package/dist-types/commands/GetAgentVersionCommand.d.ts +47 -2
- package/dist-types/commands/ListAgentsCommand.d.ts +47 -2
- package/dist-types/commands/PublishAgentVersionCommand.d.ts +47 -2
- package/dist-types/commands/RestoreAgentVersionToDraftCommand.d.ts +47 -2
- package/dist-types/commands/UpdateAgentCommand.d.ts +94 -4
- package/dist-types/models/enums.d.ts +91 -0
- package/dist-types/models/models_0.d.ts +302 -7
- package/dist-types/schemas/schemas_0.d.ts +11 -0
- package/package.json +1 -1
|
@@ -121,7 +121,6 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
121
121
|
* // { // AgentWorkflowStep
|
|
122
122
|
* // id: "STRING_VALUE", // required
|
|
123
123
|
* // label: "STRING_VALUE", // required
|
|
124
|
-
* // summary: "STRING_VALUE",
|
|
125
124
|
* // stage: "STRING_VALUE",
|
|
126
125
|
* // handler: { // AgentWorkflowHandler Union: only one key present
|
|
127
126
|
* // conversation: { // AgentWorkflowConversationHandler
|
|
@@ -578,7 +577,6 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
578
577
|
* // {
|
|
579
578
|
* // id: "STRING_VALUE", // required
|
|
580
579
|
* // label: "STRING_VALUE", // required
|
|
581
|
-
* // summary: "STRING_VALUE",
|
|
582
580
|
* // stage: "STRING_VALUE",
|
|
583
581
|
* // handler: {// Union: only one key present
|
|
584
582
|
* // conversation: {
|
|
@@ -738,6 +736,53 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
738
736
|
* // layout: "flow" || "compact" || "stages",
|
|
739
737
|
* // },
|
|
740
738
|
* // },
|
|
739
|
+
* // guardrails: { // AgentGuardrails
|
|
740
|
+
* // input: { // AgentGuardrailInput
|
|
741
|
+
* // checks: [ // AgentGuardrailChecksList
|
|
742
|
+
* // { // AgentGuardrailCheck
|
|
743
|
+
* // name: "STRING_VALUE", // required
|
|
744
|
+
* // description: "STRING_VALUE",
|
|
745
|
+
* // kind: { // AgentGuardrailCheckKind Union: only one key present
|
|
746
|
+
* // preset: { // AgentGuardrailPresetCheck
|
|
747
|
+
* // preset: "jailbreak" || "offTopic" || "abuse" || "harmful" || "selfHarm" || "pii" || "secrets" || "regulatedAdvice", // required
|
|
748
|
+
* // notes: "STRING_VALUE",
|
|
749
|
+
* // },
|
|
750
|
+
* // custom: { // AgentGuardrailCustomCheck
|
|
751
|
+
* // instructions: "STRING_VALUE", // required
|
|
752
|
+
* // examples: [ // AgentGuardrailExamplesList
|
|
753
|
+
* // "STRING_VALUE",
|
|
754
|
+
* // ],
|
|
755
|
+
* // },
|
|
756
|
+
* // },
|
|
757
|
+
* // sensitivity: "low" || "medium" || "high",
|
|
758
|
+
* // action: { // AgentGuardrailAction Union: only one key present
|
|
759
|
+
* // observe: {},
|
|
760
|
+
* // redact: {},
|
|
761
|
+
* // block: { // AgentGuardrailBlockAction
|
|
762
|
+
* // message: "STRING_VALUE",
|
|
763
|
+
* // },
|
|
764
|
+
* // end: { // AgentGuardrailEndAction
|
|
765
|
+
* // message: "STRING_VALUE",
|
|
766
|
+
* // },
|
|
767
|
+
* // },
|
|
768
|
+
* // },
|
|
769
|
+
* // ],
|
|
770
|
+
* // model: "STRING_VALUE",
|
|
771
|
+
* // action: {// Union: only one key present
|
|
772
|
+
* // observe: {},
|
|
773
|
+
* // redact: {},
|
|
774
|
+
* // block: {
|
|
775
|
+
* // message: "STRING_VALUE",
|
|
776
|
+
* // },
|
|
777
|
+
* // end: {
|
|
778
|
+
* // message: "STRING_VALUE",
|
|
779
|
+
* // },
|
|
780
|
+
* // },
|
|
781
|
+
* // mode: "blocking" || "parallel",
|
|
782
|
+
* // errorMode: "open" || "closed",
|
|
783
|
+
* // window: "lastMessage" || "lastWithPrior",
|
|
784
|
+
* // },
|
|
785
|
+
* // },
|
|
741
786
|
* // model: "STRING_VALUE",
|
|
742
787
|
* // timeZone: "STRING_VALUE",
|
|
743
788
|
* // artifacts: true || false,
|
|
@@ -114,7 +114,6 @@ declare const RestoreAgentVersionToDraftCommand_base: {
|
|
|
114
114
|
* // { // AgentWorkflowStep
|
|
115
115
|
* // id: "STRING_VALUE", // required
|
|
116
116
|
* // label: "STRING_VALUE", // required
|
|
117
|
-
* // summary: "STRING_VALUE",
|
|
118
117
|
* // stage: "STRING_VALUE",
|
|
119
118
|
* // handler: { // AgentWorkflowHandler Union: only one key present
|
|
120
119
|
* // conversation: { // AgentWorkflowConversationHandler
|
|
@@ -571,7 +570,6 @@ declare const RestoreAgentVersionToDraftCommand_base: {
|
|
|
571
570
|
* // {
|
|
572
571
|
* // id: "STRING_VALUE", // required
|
|
573
572
|
* // label: "STRING_VALUE", // required
|
|
574
|
-
* // summary: "STRING_VALUE",
|
|
575
573
|
* // stage: "STRING_VALUE",
|
|
576
574
|
* // handler: {// Union: only one key present
|
|
577
575
|
* // conversation: {
|
|
@@ -731,6 +729,53 @@ declare const RestoreAgentVersionToDraftCommand_base: {
|
|
|
731
729
|
* // layout: "flow" || "compact" || "stages",
|
|
732
730
|
* // },
|
|
733
731
|
* // },
|
|
732
|
+
* // guardrails: { // AgentGuardrails
|
|
733
|
+
* // input: { // AgentGuardrailInput
|
|
734
|
+
* // checks: [ // AgentGuardrailChecksList
|
|
735
|
+
* // { // AgentGuardrailCheck
|
|
736
|
+
* // name: "STRING_VALUE", // required
|
|
737
|
+
* // description: "STRING_VALUE",
|
|
738
|
+
* // kind: { // AgentGuardrailCheckKind Union: only one key present
|
|
739
|
+
* // preset: { // AgentGuardrailPresetCheck
|
|
740
|
+
* // preset: "jailbreak" || "offTopic" || "abuse" || "harmful" || "selfHarm" || "pii" || "secrets" || "regulatedAdvice", // required
|
|
741
|
+
* // notes: "STRING_VALUE",
|
|
742
|
+
* // },
|
|
743
|
+
* // custom: { // AgentGuardrailCustomCheck
|
|
744
|
+
* // instructions: "STRING_VALUE", // required
|
|
745
|
+
* // examples: [ // AgentGuardrailExamplesList
|
|
746
|
+
* // "STRING_VALUE",
|
|
747
|
+
* // ],
|
|
748
|
+
* // },
|
|
749
|
+
* // },
|
|
750
|
+
* // sensitivity: "low" || "medium" || "high",
|
|
751
|
+
* // action: { // AgentGuardrailAction Union: only one key present
|
|
752
|
+
* // observe: {},
|
|
753
|
+
* // redact: {},
|
|
754
|
+
* // block: { // AgentGuardrailBlockAction
|
|
755
|
+
* // message: "STRING_VALUE",
|
|
756
|
+
* // },
|
|
757
|
+
* // end: { // AgentGuardrailEndAction
|
|
758
|
+
* // message: "STRING_VALUE",
|
|
759
|
+
* // },
|
|
760
|
+
* // },
|
|
761
|
+
* // },
|
|
762
|
+
* // ],
|
|
763
|
+
* // model: "STRING_VALUE",
|
|
764
|
+
* // action: {// Union: only one key present
|
|
765
|
+
* // observe: {},
|
|
766
|
+
* // redact: {},
|
|
767
|
+
* // block: {
|
|
768
|
+
* // message: "STRING_VALUE",
|
|
769
|
+
* // },
|
|
770
|
+
* // end: {
|
|
771
|
+
* // message: "STRING_VALUE",
|
|
772
|
+
* // },
|
|
773
|
+
* // },
|
|
774
|
+
* // mode: "blocking" || "parallel",
|
|
775
|
+
* // errorMode: "open" || "closed",
|
|
776
|
+
* // window: "lastMessage" || "lastWithPrior",
|
|
777
|
+
* // },
|
|
778
|
+
* // },
|
|
734
779
|
* // model: "STRING_VALUE",
|
|
735
780
|
* // timeZone: "STRING_VALUE",
|
|
736
781
|
* // artifacts: true || false,
|
|
@@ -105,7 +105,6 @@ declare const UpdateAgentCommand_base: {
|
|
|
105
105
|
* { // AgentWorkflowStep
|
|
106
106
|
* id: "STRING_VALUE", // required
|
|
107
107
|
* label: "STRING_VALUE", // required
|
|
108
|
-
* summary: "STRING_VALUE",
|
|
109
108
|
* stage: "STRING_VALUE",
|
|
110
109
|
* handler: { // AgentWorkflowHandler Union: only one key present
|
|
111
110
|
* conversation: { // AgentWorkflowConversationHandler
|
|
@@ -562,7 +561,6 @@ declare const UpdateAgentCommand_base: {
|
|
|
562
561
|
* {
|
|
563
562
|
* id: "STRING_VALUE", // required
|
|
564
563
|
* label: "STRING_VALUE", // required
|
|
565
|
-
* summary: "STRING_VALUE",
|
|
566
564
|
* stage: "STRING_VALUE",
|
|
567
565
|
* handler: {// Union: only one key present
|
|
568
566
|
* conversation: {
|
|
@@ -722,6 +720,53 @@ declare const UpdateAgentCommand_base: {
|
|
|
722
720
|
* layout: "flow" || "compact" || "stages",
|
|
723
721
|
* },
|
|
724
722
|
* },
|
|
723
|
+
* guardrails: { // AgentGuardrails
|
|
724
|
+
* input: { // AgentGuardrailInput
|
|
725
|
+
* checks: [ // AgentGuardrailChecksList
|
|
726
|
+
* { // AgentGuardrailCheck
|
|
727
|
+
* name: "STRING_VALUE", // required
|
|
728
|
+
* description: "STRING_VALUE",
|
|
729
|
+
* kind: { // AgentGuardrailCheckKind Union: only one key present
|
|
730
|
+
* preset: { // AgentGuardrailPresetCheck
|
|
731
|
+
* preset: "jailbreak" || "offTopic" || "abuse" || "harmful" || "selfHarm" || "pii" || "secrets" || "regulatedAdvice", // required
|
|
732
|
+
* notes: "STRING_VALUE",
|
|
733
|
+
* },
|
|
734
|
+
* custom: { // AgentGuardrailCustomCheck
|
|
735
|
+
* instructions: "STRING_VALUE", // required
|
|
736
|
+
* examples: [ // AgentGuardrailExamplesList
|
|
737
|
+
* "STRING_VALUE",
|
|
738
|
+
* ],
|
|
739
|
+
* },
|
|
740
|
+
* },
|
|
741
|
+
* sensitivity: "low" || "medium" || "high",
|
|
742
|
+
* action: { // AgentGuardrailAction Union: only one key present
|
|
743
|
+
* observe: {},
|
|
744
|
+
* redact: {},
|
|
745
|
+
* block: { // AgentGuardrailBlockAction
|
|
746
|
+
* message: "STRING_VALUE",
|
|
747
|
+
* },
|
|
748
|
+
* end: { // AgentGuardrailEndAction
|
|
749
|
+
* message: "STRING_VALUE",
|
|
750
|
+
* },
|
|
751
|
+
* },
|
|
752
|
+
* },
|
|
753
|
+
* ],
|
|
754
|
+
* model: "STRING_VALUE",
|
|
755
|
+
* action: {// Union: only one key present
|
|
756
|
+
* observe: {},
|
|
757
|
+
* redact: {},
|
|
758
|
+
* block: {
|
|
759
|
+
* message: "STRING_VALUE",
|
|
760
|
+
* },
|
|
761
|
+
* end: {
|
|
762
|
+
* message: "STRING_VALUE",
|
|
763
|
+
* },
|
|
764
|
+
* },
|
|
765
|
+
* mode: "blocking" || "parallel",
|
|
766
|
+
* errorMode: "open" || "closed",
|
|
767
|
+
* window: "lastMessage" || "lastWithPrior",
|
|
768
|
+
* },
|
|
769
|
+
* },
|
|
725
770
|
* model: "STRING_VALUE",
|
|
726
771
|
* timeZone: "STRING_VALUE",
|
|
727
772
|
* artifacts: true || false,
|
|
@@ -835,7 +880,6 @@ declare const UpdateAgentCommand_base: {
|
|
|
835
880
|
* // { // AgentWorkflowStep
|
|
836
881
|
* // id: "STRING_VALUE", // required
|
|
837
882
|
* // label: "STRING_VALUE", // required
|
|
838
|
-
* // summary: "STRING_VALUE",
|
|
839
883
|
* // stage: "STRING_VALUE",
|
|
840
884
|
* // handler: { // AgentWorkflowHandler Union: only one key present
|
|
841
885
|
* // conversation: { // AgentWorkflowConversationHandler
|
|
@@ -1292,7 +1336,6 @@ declare const UpdateAgentCommand_base: {
|
|
|
1292
1336
|
* // {
|
|
1293
1337
|
* // id: "STRING_VALUE", // required
|
|
1294
1338
|
* // label: "STRING_VALUE", // required
|
|
1295
|
-
* // summary: "STRING_VALUE",
|
|
1296
1339
|
* // stage: "STRING_VALUE",
|
|
1297
1340
|
* // handler: {// Union: only one key present
|
|
1298
1341
|
* // conversation: {
|
|
@@ -1452,6 +1495,53 @@ declare const UpdateAgentCommand_base: {
|
|
|
1452
1495
|
* // layout: "flow" || "compact" || "stages",
|
|
1453
1496
|
* // },
|
|
1454
1497
|
* // },
|
|
1498
|
+
* // guardrails: { // AgentGuardrails
|
|
1499
|
+
* // input: { // AgentGuardrailInput
|
|
1500
|
+
* // checks: [ // AgentGuardrailChecksList
|
|
1501
|
+
* // { // AgentGuardrailCheck
|
|
1502
|
+
* // name: "STRING_VALUE", // required
|
|
1503
|
+
* // description: "STRING_VALUE",
|
|
1504
|
+
* // kind: { // AgentGuardrailCheckKind Union: only one key present
|
|
1505
|
+
* // preset: { // AgentGuardrailPresetCheck
|
|
1506
|
+
* // preset: "jailbreak" || "offTopic" || "abuse" || "harmful" || "selfHarm" || "pii" || "secrets" || "regulatedAdvice", // required
|
|
1507
|
+
* // notes: "STRING_VALUE",
|
|
1508
|
+
* // },
|
|
1509
|
+
* // custom: { // AgentGuardrailCustomCheck
|
|
1510
|
+
* // instructions: "STRING_VALUE", // required
|
|
1511
|
+
* // examples: [ // AgentGuardrailExamplesList
|
|
1512
|
+
* // "STRING_VALUE",
|
|
1513
|
+
* // ],
|
|
1514
|
+
* // },
|
|
1515
|
+
* // },
|
|
1516
|
+
* // sensitivity: "low" || "medium" || "high",
|
|
1517
|
+
* // action: { // AgentGuardrailAction Union: only one key present
|
|
1518
|
+
* // observe: {},
|
|
1519
|
+
* // redact: {},
|
|
1520
|
+
* // block: { // AgentGuardrailBlockAction
|
|
1521
|
+
* // message: "STRING_VALUE",
|
|
1522
|
+
* // },
|
|
1523
|
+
* // end: { // AgentGuardrailEndAction
|
|
1524
|
+
* // message: "STRING_VALUE",
|
|
1525
|
+
* // },
|
|
1526
|
+
* // },
|
|
1527
|
+
* // },
|
|
1528
|
+
* // ],
|
|
1529
|
+
* // model: "STRING_VALUE",
|
|
1530
|
+
* // action: {// Union: only one key present
|
|
1531
|
+
* // observe: {},
|
|
1532
|
+
* // redact: {},
|
|
1533
|
+
* // block: {
|
|
1534
|
+
* // message: "STRING_VALUE",
|
|
1535
|
+
* // },
|
|
1536
|
+
* // end: {
|
|
1537
|
+
* // message: "STRING_VALUE",
|
|
1538
|
+
* // },
|
|
1539
|
+
* // },
|
|
1540
|
+
* // mode: "blocking" || "parallel",
|
|
1541
|
+
* // errorMode: "open" || "closed",
|
|
1542
|
+
* // window: "lastMessage" || "lastWithPrior",
|
|
1543
|
+
* // },
|
|
1544
|
+
* // },
|
|
1455
1545
|
* // model: "STRING_VALUE",
|
|
1456
1546
|
* // timeZone: "STRING_VALUE",
|
|
1457
1547
|
* // artifacts: true || false,
|
|
@@ -213,6 +213,97 @@ export declare const WebSearchContextSize: {
|
|
|
213
213
|
* @public
|
|
214
214
|
*/
|
|
215
215
|
export type WebSearchContextSize = (typeof WebSearchContextSize)[keyof typeof WebSearchContextSize];
|
|
216
|
+
/**
|
|
217
|
+
* @public
|
|
218
|
+
* @enum
|
|
219
|
+
*/
|
|
220
|
+
export declare const AgentGuardrailPreset: {
|
|
221
|
+
/**
|
|
222
|
+
* Slurs and sustained abuse aimed at the agent or at staff. Not the same as profanity in passing.
|
|
223
|
+
*/
|
|
224
|
+
readonly ABUSE: "abuse";
|
|
225
|
+
/**
|
|
226
|
+
* Violence, hate, sexual content, weapons and illegal activity — the MLCommons-shaped set, minus self-harm, which is SELF_HARM because the right response to it is different.
|
|
227
|
+
*/
|
|
228
|
+
readonly HARMFUL: "harmful";
|
|
229
|
+
/**
|
|
230
|
+
* Instruction override, role-play as an unrestricted persona, embedded fake dialogue, and encoding tricks. Written from the attack subtypes Azure publishes for Prompt Shields.
|
|
231
|
+
*/
|
|
232
|
+
readonly JAILBREAK: "jailbreak";
|
|
233
|
+
/**
|
|
234
|
+
* Anything outside the agent's own stated purpose. The only preset that reads `engine.ai.instructions`, and meaningless without them.
|
|
235
|
+
*/
|
|
236
|
+
readonly OFF_TOPIC: "offTopic";
|
|
237
|
+
/**
|
|
238
|
+
* Card numbers, national IDs and credentials the caller volunteers. Returns spans, so it is one of the two presets `redact` may be used with.
|
|
239
|
+
*/
|
|
240
|
+
readonly PII: "pii";
|
|
241
|
+
/**
|
|
242
|
+
* Soliciting legal, medical or financial advice.
|
|
243
|
+
*/
|
|
244
|
+
readonly REGULATED_ADVICE: "regulatedAdvice";
|
|
245
|
+
/**
|
|
246
|
+
* API keys, tokens and passwords pasted into a turn. Returns spans. Mostly an assistant and chat problem.
|
|
247
|
+
*/
|
|
248
|
+
readonly SECRETS: "secrets";
|
|
249
|
+
/**
|
|
250
|
+
* Suicidal ideation, self-harm intent or instructions. Its own preset so that its action can differ: the default is a block whose message routes the caller to help, and it must never be `end`, which on voice hangs up on someone in distress.
|
|
251
|
+
*/
|
|
252
|
+
readonly SELF_HARM: "selfHarm";
|
|
253
|
+
};
|
|
254
|
+
/**
|
|
255
|
+
* @public
|
|
256
|
+
*/
|
|
257
|
+
export type AgentGuardrailPreset = (typeof AgentGuardrailPreset)[keyof typeof AgentGuardrailPreset];
|
|
258
|
+
/**
|
|
259
|
+
* @public
|
|
260
|
+
* @enum
|
|
261
|
+
*/
|
|
262
|
+
export declare const AgentGuardrailSensitivity: {
|
|
263
|
+
readonly HIGH: "high";
|
|
264
|
+
readonly LOW: "low";
|
|
265
|
+
readonly MEDIUM: "medium";
|
|
266
|
+
};
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
export type AgentGuardrailSensitivity = (typeof AgentGuardrailSensitivity)[keyof typeof AgentGuardrailSensitivity];
|
|
271
|
+
/**
|
|
272
|
+
* @public
|
|
273
|
+
* @enum
|
|
274
|
+
*/
|
|
275
|
+
export declare const AgentGuardrailErrorMode: {
|
|
276
|
+
readonly CLOSED: "closed";
|
|
277
|
+
readonly OPEN: "open";
|
|
278
|
+
};
|
|
279
|
+
/**
|
|
280
|
+
* @public
|
|
281
|
+
*/
|
|
282
|
+
export type AgentGuardrailErrorMode = (typeof AgentGuardrailErrorMode)[keyof typeof AgentGuardrailErrorMode];
|
|
283
|
+
/**
|
|
284
|
+
* @public
|
|
285
|
+
* @enum
|
|
286
|
+
*/
|
|
287
|
+
export declare const AgentGuardrailMode: {
|
|
288
|
+
readonly BLOCKING: "blocking";
|
|
289
|
+
readonly PARALLEL: "parallel";
|
|
290
|
+
};
|
|
291
|
+
/**
|
|
292
|
+
* @public
|
|
293
|
+
*/
|
|
294
|
+
export type AgentGuardrailMode = (typeof AgentGuardrailMode)[keyof typeof AgentGuardrailMode];
|
|
295
|
+
/**
|
|
296
|
+
* @public
|
|
297
|
+
* @enum
|
|
298
|
+
*/
|
|
299
|
+
export declare const AgentGuardrailWindow: {
|
|
300
|
+
readonly LAST_MESSAGE: "lastMessage";
|
|
301
|
+
readonly LAST_WITH_PRIOR: "lastWithPrior";
|
|
302
|
+
};
|
|
303
|
+
/**
|
|
304
|
+
* @public
|
|
305
|
+
*/
|
|
306
|
+
export type AgentGuardrailWindow = (typeof AgentGuardrailWindow)[keyof typeof AgentGuardrailWindow];
|
|
216
307
|
/**
|
|
217
308
|
* @public
|
|
218
309
|
* @enum
|