@wildix/wilma-agents-client 1.0.34 → 1.0.35
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 +6 -1
- package/dist-cjs/schemas/schemas_0.js +72 -14
- package/dist-es/models/enums.js +5 -0
- package/dist-es/schemas/schemas_0.js +70 -12
- package/dist-types/commands/CreateAgentCommand.d.ts +84 -10
- package/dist-types/commands/GetAgentCommand.d.ts +42 -5
- package/dist-types/commands/GetAgentVersionCommand.d.ts +42 -5
- package/dist-types/commands/ListAgentsCommand.d.ts +43 -6
- package/dist-types/commands/ListAgentsNamesCommand.d.ts +3 -2
- package/dist-types/commands/PublishAgentVersionCommand.d.ts +42 -5
- package/dist-types/commands/RestoreAgentVersionToDraftCommand.d.ts +42 -5
- package/dist-types/commands/UpdateAgentCommand.d.ts +84 -10
- package/dist-types/models/enums.d.ts +22 -0
- package/dist-types/models/models_0.d.ts +204 -1
- package/dist-types/schemas/schemas_0.d.ts +6 -0
- package/package.json +1 -1
|
@@ -53,6 +53,32 @@ declare const RestoreAgentVersionToDraftCommand_base: {
|
|
|
53
53
|
* // channels: { // AgentChannels
|
|
54
54
|
* // voice: { // VoiceChannelSettings
|
|
55
55
|
* // greeting: "STRING_VALUE",
|
|
56
|
+
* // backgroundSound: { // VoiceBackgroundSoundSettings
|
|
57
|
+
* // enabled: true || false, // required
|
|
58
|
+
* // sound: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // speech: { // VoiceSpeechSettings
|
|
61
|
+
* // languages: [ // VoiceLanguageList // required
|
|
62
|
+
* // { // VoiceLanguage
|
|
63
|
+
* // code: "STRING_VALUE", // required
|
|
64
|
+
* // voice: "STRING_VALUE", // required
|
|
65
|
+
* // greeting: "STRING_VALUE",
|
|
66
|
+
* // isDefault: true || false,
|
|
67
|
+
* // pronunciations: [ // VoicePronunciationList
|
|
68
|
+
* // { // VoicePronunciation
|
|
69
|
+
* // phrase: "STRING_VALUE", // required
|
|
70
|
+
* // as: "STRING_VALUE", // required
|
|
71
|
+
* // encoding: "alias" || "ipa",
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // greetEveryLanguage: true || false,
|
|
77
|
+
* // transcription: { // VoiceTranscriptionSettings
|
|
78
|
+
* // engine: "STRING_VALUE",
|
|
79
|
+
* // autoDetect: true || false,
|
|
80
|
+
* // },
|
|
81
|
+
* // },
|
|
56
82
|
* // interruptions: { // VoiceInterruptionSettings
|
|
57
83
|
* // enabled: true || false, // required
|
|
58
84
|
* // minWords: Number("int"),
|
|
@@ -117,6 +143,7 @@ declare const RestoreAgentVersionToDraftCommand_base: {
|
|
|
117
143
|
* // placeholder: "STRING_VALUE",
|
|
118
144
|
* // },
|
|
119
145
|
* // },
|
|
146
|
+
* // workflow: {},
|
|
120
147
|
* // },
|
|
121
148
|
* // engine: { // AgentEngine Union: only one key present
|
|
122
149
|
* // ai: { // AgentAiEngine
|
|
@@ -168,7 +195,7 @@ declare const RestoreAgentVersionToDraftCommand_base: {
|
|
|
168
195
|
* // prompt: "STRING_VALUE",
|
|
169
196
|
* // },
|
|
170
197
|
* // channels: [ // AgentCapabilityChannelsList
|
|
171
|
-
* // "voice" || "chat" || "assistant",
|
|
198
|
+
* // "voice" || "chat" || "assistant" || "workflow",
|
|
172
199
|
* // ],
|
|
173
200
|
* // annotations: [ // AgentToolAnnotationsList
|
|
174
201
|
* // { // AgentToolAnnotation Union: only one key present
|
|
@@ -198,7 +225,7 @@ declare const RestoreAgentVersionToDraftCommand_base: {
|
|
|
198
225
|
* // prompt: "STRING_VALUE",
|
|
199
226
|
* // },
|
|
200
227
|
* // channels: [
|
|
201
|
-
* // "voice" || "chat" || "assistant",
|
|
228
|
+
* // "voice" || "chat" || "assistant" || "workflow",
|
|
202
229
|
* // ],
|
|
203
230
|
* // annotations: [
|
|
204
231
|
* // {// Union: only one key present
|
|
@@ -221,7 +248,7 @@ declare const RestoreAgentVersionToDraftCommand_base: {
|
|
|
221
248
|
* // knowledgeBaseId: "STRING_VALUE",
|
|
222
249
|
* // instructions: "STRING_VALUE",
|
|
223
250
|
* // channels: [
|
|
224
|
-
* // "voice" || "chat" || "assistant",
|
|
251
|
+
* // "voice" || "chat" || "assistant" || "workflow",
|
|
225
252
|
* // ],
|
|
226
253
|
* // annotations: [
|
|
227
254
|
* // {// Union: only one key present
|
|
@@ -269,7 +296,7 @@ declare const RestoreAgentVersionToDraftCommand_base: {
|
|
|
269
296
|
* // timezone: "STRING_VALUE",
|
|
270
297
|
* // },
|
|
271
298
|
* // channels: [
|
|
272
|
-
* // "voice" || "chat" || "assistant",
|
|
299
|
+
* // "voice" || "chat" || "assistant" || "workflow",
|
|
273
300
|
* // ],
|
|
274
301
|
* // },
|
|
275
302
|
* // webFetch: { // AgentWebFetchCapability
|
|
@@ -277,7 +304,7 @@ declare const RestoreAgentVersionToDraftCommand_base: {
|
|
|
277
304
|
* // "STRING_VALUE",
|
|
278
305
|
* // ],
|
|
279
306
|
* // channels: [
|
|
280
|
-
* // "voice" || "chat" || "assistant",
|
|
307
|
+
* // "voice" || "chat" || "assistant" || "workflow",
|
|
281
308
|
* // ],
|
|
282
309
|
* // },
|
|
283
310
|
* // agent: { // AgentCallCapability
|
|
@@ -808,6 +835,16 @@ declare const RestoreAgentVersionToDraftCommand_base: {
|
|
|
808
835
|
* // },
|
|
809
836
|
* // ],
|
|
810
837
|
* // model: "STRING_VALUE",
|
|
838
|
+
* // action: {// Union: only one key present
|
|
839
|
+
* // observe: {},
|
|
840
|
+
* // redact: {},
|
|
841
|
+
* // block: {
|
|
842
|
+
* // message: "STRING_VALUE",
|
|
843
|
+
* // },
|
|
844
|
+
* // end: {
|
|
845
|
+
* // message: "STRING_VALUE",
|
|
846
|
+
* // },
|
|
847
|
+
* // },
|
|
811
848
|
* // mode: "blocking" || "parallel",
|
|
812
849
|
* // errorMode: "open" || "closed",
|
|
813
850
|
* // window: "lastMessage" || "lastWithPrior",
|
|
@@ -44,6 +44,32 @@ declare const UpdateAgentCommand_base: {
|
|
|
44
44
|
* channels: { // AgentChannels
|
|
45
45
|
* voice: { // VoiceChannelSettings
|
|
46
46
|
* greeting: "STRING_VALUE",
|
|
47
|
+
* backgroundSound: { // VoiceBackgroundSoundSettings
|
|
48
|
+
* enabled: true || false, // required
|
|
49
|
+
* sound: "STRING_VALUE",
|
|
50
|
+
* },
|
|
51
|
+
* speech: { // VoiceSpeechSettings
|
|
52
|
+
* languages: [ // VoiceLanguageList // required
|
|
53
|
+
* { // VoiceLanguage
|
|
54
|
+
* code: "STRING_VALUE", // required
|
|
55
|
+
* voice: "STRING_VALUE", // required
|
|
56
|
+
* greeting: "STRING_VALUE",
|
|
57
|
+
* isDefault: true || false,
|
|
58
|
+
* pronunciations: [ // VoicePronunciationList
|
|
59
|
+
* { // VoicePronunciation
|
|
60
|
+
* phrase: "STRING_VALUE", // required
|
|
61
|
+
* as: "STRING_VALUE", // required
|
|
62
|
+
* encoding: "alias" || "ipa",
|
|
63
|
+
* },
|
|
64
|
+
* ],
|
|
65
|
+
* },
|
|
66
|
+
* ],
|
|
67
|
+
* greetEveryLanguage: true || false,
|
|
68
|
+
* transcription: { // VoiceTranscriptionSettings
|
|
69
|
+
* engine: "STRING_VALUE",
|
|
70
|
+
* autoDetect: true || false,
|
|
71
|
+
* },
|
|
72
|
+
* },
|
|
47
73
|
* interruptions: { // VoiceInterruptionSettings
|
|
48
74
|
* enabled: true || false, // required
|
|
49
75
|
* minWords: Number("int"),
|
|
@@ -108,6 +134,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
108
134
|
* placeholder: "STRING_VALUE",
|
|
109
135
|
* },
|
|
110
136
|
* },
|
|
137
|
+
* workflow: {},
|
|
111
138
|
* },
|
|
112
139
|
* engine: { // AgentEngine Union: only one key present
|
|
113
140
|
* ai: { // AgentAiEngine
|
|
@@ -159,7 +186,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
159
186
|
* prompt: "STRING_VALUE",
|
|
160
187
|
* },
|
|
161
188
|
* channels: [ // AgentCapabilityChannelsList
|
|
162
|
-
* "voice" || "chat" || "assistant",
|
|
189
|
+
* "voice" || "chat" || "assistant" || "workflow",
|
|
163
190
|
* ],
|
|
164
191
|
* annotations: [ // AgentToolAnnotationsList
|
|
165
192
|
* { // AgentToolAnnotation Union: only one key present
|
|
@@ -189,7 +216,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
189
216
|
* prompt: "STRING_VALUE",
|
|
190
217
|
* },
|
|
191
218
|
* channels: [
|
|
192
|
-
* "voice" || "chat" || "assistant",
|
|
219
|
+
* "voice" || "chat" || "assistant" || "workflow",
|
|
193
220
|
* ],
|
|
194
221
|
* annotations: [
|
|
195
222
|
* {// Union: only one key present
|
|
@@ -212,7 +239,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
212
239
|
* knowledgeBaseId: "STRING_VALUE",
|
|
213
240
|
* instructions: "STRING_VALUE",
|
|
214
241
|
* channels: [
|
|
215
|
-
* "voice" || "chat" || "assistant",
|
|
242
|
+
* "voice" || "chat" || "assistant" || "workflow",
|
|
216
243
|
* ],
|
|
217
244
|
* annotations: [
|
|
218
245
|
* {// Union: only one key present
|
|
@@ -260,7 +287,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
260
287
|
* timezone: "STRING_VALUE",
|
|
261
288
|
* },
|
|
262
289
|
* channels: [
|
|
263
|
-
* "voice" || "chat" || "assistant",
|
|
290
|
+
* "voice" || "chat" || "assistant" || "workflow",
|
|
264
291
|
* ],
|
|
265
292
|
* },
|
|
266
293
|
* webFetch: { // AgentWebFetchCapability
|
|
@@ -268,7 +295,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
268
295
|
* "STRING_VALUE",
|
|
269
296
|
* ],
|
|
270
297
|
* channels: [
|
|
271
|
-
* "voice" || "chat" || "assistant",
|
|
298
|
+
* "voice" || "chat" || "assistant" || "workflow",
|
|
272
299
|
* ],
|
|
273
300
|
* },
|
|
274
301
|
* agent: { // AgentCallCapability
|
|
@@ -799,6 +826,16 @@ declare const UpdateAgentCommand_base: {
|
|
|
799
826
|
* },
|
|
800
827
|
* ],
|
|
801
828
|
* model: "STRING_VALUE",
|
|
829
|
+
* action: {// Union: only one key present
|
|
830
|
+
* observe: {},
|
|
831
|
+
* redact: {},
|
|
832
|
+
* block: {
|
|
833
|
+
* message: "STRING_VALUE",
|
|
834
|
+
* },
|
|
835
|
+
* end: {
|
|
836
|
+
* message: "STRING_VALUE",
|
|
837
|
+
* },
|
|
838
|
+
* },
|
|
802
839
|
* mode: "blocking" || "parallel",
|
|
803
840
|
* errorMode: "open" || "closed",
|
|
804
841
|
* window: "lastMessage" || "lastWithPrior",
|
|
@@ -856,6 +893,32 @@ declare const UpdateAgentCommand_base: {
|
|
|
856
893
|
* // channels: { // AgentChannels
|
|
857
894
|
* // voice: { // VoiceChannelSettings
|
|
858
895
|
* // greeting: "STRING_VALUE",
|
|
896
|
+
* // backgroundSound: { // VoiceBackgroundSoundSettings
|
|
897
|
+
* // enabled: true || false, // required
|
|
898
|
+
* // sound: "STRING_VALUE",
|
|
899
|
+
* // },
|
|
900
|
+
* // speech: { // VoiceSpeechSettings
|
|
901
|
+
* // languages: [ // VoiceLanguageList // required
|
|
902
|
+
* // { // VoiceLanguage
|
|
903
|
+
* // code: "STRING_VALUE", // required
|
|
904
|
+
* // voice: "STRING_VALUE", // required
|
|
905
|
+
* // greeting: "STRING_VALUE",
|
|
906
|
+
* // isDefault: true || false,
|
|
907
|
+
* // pronunciations: [ // VoicePronunciationList
|
|
908
|
+
* // { // VoicePronunciation
|
|
909
|
+
* // phrase: "STRING_VALUE", // required
|
|
910
|
+
* // as: "STRING_VALUE", // required
|
|
911
|
+
* // encoding: "alias" || "ipa",
|
|
912
|
+
* // },
|
|
913
|
+
* // ],
|
|
914
|
+
* // },
|
|
915
|
+
* // ],
|
|
916
|
+
* // greetEveryLanguage: true || false,
|
|
917
|
+
* // transcription: { // VoiceTranscriptionSettings
|
|
918
|
+
* // engine: "STRING_VALUE",
|
|
919
|
+
* // autoDetect: true || false,
|
|
920
|
+
* // },
|
|
921
|
+
* // },
|
|
859
922
|
* // interruptions: { // VoiceInterruptionSettings
|
|
860
923
|
* // enabled: true || false, // required
|
|
861
924
|
* // minWords: Number("int"),
|
|
@@ -920,6 +983,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
920
983
|
* // placeholder: "STRING_VALUE",
|
|
921
984
|
* // },
|
|
922
985
|
* // },
|
|
986
|
+
* // workflow: {},
|
|
923
987
|
* // },
|
|
924
988
|
* // engine: { // AgentEngine Union: only one key present
|
|
925
989
|
* // ai: { // AgentAiEngine
|
|
@@ -971,7 +1035,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
971
1035
|
* // prompt: "STRING_VALUE",
|
|
972
1036
|
* // },
|
|
973
1037
|
* // channels: [ // AgentCapabilityChannelsList
|
|
974
|
-
* // "voice" || "chat" || "assistant",
|
|
1038
|
+
* // "voice" || "chat" || "assistant" || "workflow",
|
|
975
1039
|
* // ],
|
|
976
1040
|
* // annotations: [ // AgentToolAnnotationsList
|
|
977
1041
|
* // { // AgentToolAnnotation Union: only one key present
|
|
@@ -1001,7 +1065,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
1001
1065
|
* // prompt: "STRING_VALUE",
|
|
1002
1066
|
* // },
|
|
1003
1067
|
* // channels: [
|
|
1004
|
-
* // "voice" || "chat" || "assistant",
|
|
1068
|
+
* // "voice" || "chat" || "assistant" || "workflow",
|
|
1005
1069
|
* // ],
|
|
1006
1070
|
* // annotations: [
|
|
1007
1071
|
* // {// Union: only one key present
|
|
@@ -1024,7 +1088,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
1024
1088
|
* // knowledgeBaseId: "STRING_VALUE",
|
|
1025
1089
|
* // instructions: "STRING_VALUE",
|
|
1026
1090
|
* // channels: [
|
|
1027
|
-
* // "voice" || "chat" || "assistant",
|
|
1091
|
+
* // "voice" || "chat" || "assistant" || "workflow",
|
|
1028
1092
|
* // ],
|
|
1029
1093
|
* // annotations: [
|
|
1030
1094
|
* // {// Union: only one key present
|
|
@@ -1072,7 +1136,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
1072
1136
|
* // timezone: "STRING_VALUE",
|
|
1073
1137
|
* // },
|
|
1074
1138
|
* // channels: [
|
|
1075
|
-
* // "voice" || "chat" || "assistant",
|
|
1139
|
+
* // "voice" || "chat" || "assistant" || "workflow",
|
|
1076
1140
|
* // ],
|
|
1077
1141
|
* // },
|
|
1078
1142
|
* // webFetch: { // AgentWebFetchCapability
|
|
@@ -1080,7 +1144,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
1080
1144
|
* // "STRING_VALUE",
|
|
1081
1145
|
* // ],
|
|
1082
1146
|
* // channels: [
|
|
1083
|
-
* // "voice" || "chat" || "assistant",
|
|
1147
|
+
* // "voice" || "chat" || "assistant" || "workflow",
|
|
1084
1148
|
* // ],
|
|
1085
1149
|
* // },
|
|
1086
1150
|
* // agent: { // AgentCallCapability
|
|
@@ -1611,6 +1675,16 @@ declare const UpdateAgentCommand_base: {
|
|
|
1611
1675
|
* // },
|
|
1612
1676
|
* // ],
|
|
1613
1677
|
* // model: "STRING_VALUE",
|
|
1678
|
+
* // action: {// Union: only one key present
|
|
1679
|
+
* // observe: {},
|
|
1680
|
+
* // redact: {},
|
|
1681
|
+
* // block: {
|
|
1682
|
+
* // message: "STRING_VALUE",
|
|
1683
|
+
* // },
|
|
1684
|
+
* // end: {
|
|
1685
|
+
* // message: "STRING_VALUE",
|
|
1686
|
+
* // },
|
|
1687
|
+
* // },
|
|
1614
1688
|
* // mode: "blocking" || "parallel",
|
|
1615
1689
|
* // errorMode: "open" || "closed",
|
|
1616
1690
|
* // window: "lastMessage" || "lastWithPrior",
|
|
@@ -20,6 +20,24 @@ export declare const AgentVisibility: {
|
|
|
20
20
|
* @public
|
|
21
21
|
*/
|
|
22
22
|
export type AgentVisibility = (typeof AgentVisibility)[keyof typeof AgentVisibility];
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
* @enum
|
|
26
|
+
*/
|
|
27
|
+
export declare const VoicePronunciationEncoding: {
|
|
28
|
+
/**
|
|
29
|
+
* A respelling substituted into the text before it reaches the provider. The only encoding version 1 applies.
|
|
30
|
+
*/
|
|
31
|
+
readonly ALIAS: "alias";
|
|
32
|
+
/**
|
|
33
|
+
* Phonetic transcription. Declared so IPA can be enabled per provider later; ignored by the runtime today.
|
|
34
|
+
*/
|
|
35
|
+
readonly IPA: "ipa";
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
export type VoicePronunciationEncoding = (typeof VoicePronunciationEncoding)[keyof typeof VoicePronunciationEncoding];
|
|
23
41
|
/**
|
|
24
42
|
* @public
|
|
25
43
|
* @enum
|
|
@@ -50,6 +68,10 @@ export declare const ChannelType: {
|
|
|
50
68
|
* Voice calls on the PBX.
|
|
51
69
|
*/
|
|
52
70
|
readonly VOICE: "voice";
|
|
71
|
+
/**
|
|
72
|
+
* No delivery channel: runs as background tasks — invoked by other agents (call / delegation / handover), by automations or over the API.
|
|
73
|
+
*/
|
|
74
|
+
readonly WORKFLOW: "workflow";
|
|
53
75
|
};
|
|
54
76
|
/**
|
|
55
77
|
* @public
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import type { ActorType, AgentGuardrailErrorMode, AgentGuardrailMode, AgentGuardrailPreset, AgentGuardrailSensitivity, AgentGuardrailWindow, AgentHandoverPipelineType, AgentHandoverVariant, AgentHangupPipelineType, AgentStatus, AgentToolPipelineType, AgentTransferPipelineType, AgentTransferVariant, AgentVariableType, AgentVisibility, AgentWorkflowEntryBehavior, AgentWorkflowFailureKind, AgentWorkflowLayout, AgentWorkflowMessageButtonVariant, ChannelType, SandboxNetworkAccess, SandboxSize, WebSearchContextSize } from "./enums";
|
|
2
|
+
import type { ActorType, AgentGuardrailErrorMode, AgentGuardrailMode, AgentGuardrailPreset, AgentGuardrailSensitivity, AgentGuardrailWindow, AgentHandoverPipelineType, AgentHandoverVariant, AgentHangupPipelineType, AgentStatus, AgentToolPipelineType, AgentTransferPipelineType, AgentTransferVariant, AgentVariableType, AgentVisibility, AgentWorkflowEntryBehavior, AgentWorkflowFailureKind, AgentWorkflowLayout, AgentWorkflowMessageButtonVariant, ChannelType, SandboxNetworkAccess, SandboxSize, VoicePronunciationEncoding, WebSearchContextSize } from "./enums";
|
|
3
3
|
/**
|
|
4
4
|
* A user or group that access is granted to.
|
|
5
5
|
* @public
|
|
@@ -140,6 +140,29 @@ export interface ChatChannelSettings {
|
|
|
140
140
|
*/
|
|
141
141
|
discoverable?: boolean | undefined;
|
|
142
142
|
}
|
|
143
|
+
/**
|
|
144
|
+
* Ambient background audio played under the call.
|
|
145
|
+
*
|
|
146
|
+
* A SETTINGS OBJECT like `interruptions` and `endCall`, rather than a loose name on the channel:
|
|
147
|
+
* it is one switchable call behaviour, it reads the same way as its siblings, and the volume and
|
|
148
|
+
* fade controls the console will want next have somewhere to go.
|
|
149
|
+
*
|
|
150
|
+
* ABSENT MEANS OFF — a bot that never touches it behaves exactly as every call did before this
|
|
151
|
+
* setting existed, and the PBX needs no new case.
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
export interface VoiceBackgroundSoundSettings {
|
|
155
|
+
/**
|
|
156
|
+
* Whether ambient background audio plays under the call.
|
|
157
|
+
* @public
|
|
158
|
+
*/
|
|
159
|
+
enabled: boolean;
|
|
160
|
+
/**
|
|
161
|
+
* Music-on-hold class the PBX plays. Absent with `enabled` true leaves the choice of class to the PBX.
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
sound?: string | undefined;
|
|
165
|
+
}
|
|
143
166
|
/**
|
|
144
167
|
* Caller context injected into the model prompt.
|
|
145
168
|
* @public
|
|
@@ -282,6 +305,150 @@ export interface VoiceSilenceTimeoutSettings {
|
|
|
282
305
|
seconds: number;
|
|
283
306
|
action: VoiceTerminateAction;
|
|
284
307
|
}
|
|
308
|
+
/**
|
|
309
|
+
* A pronunciation rule for one phrase. Belongs to a LANGUAGE, not to the agent: 'Wildix' is
|
|
310
|
+
* respelled differently for an Italian and a German voice, so one list shared ACROSS languages
|
|
311
|
+
* would fight itself. That is why the rules hang off the language and nowhere else — there is no
|
|
312
|
+
* company-wide dictionary above them to inherit from, or to disagree with.
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
export interface VoicePronunciation {
|
|
316
|
+
/**
|
|
317
|
+
* The phrase as it appears in the text, e.g. 'Wildix'. Bounded because every rule is compiled into ONE regular expression — see the list below.
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
phrase: string;
|
|
321
|
+
/**
|
|
322
|
+
* Respelling (ALIAS) or phonetic transcription (IPA), e.g. 'Wil-dix'.
|
|
323
|
+
* @public
|
|
324
|
+
*/
|
|
325
|
+
as: string;
|
|
326
|
+
/**
|
|
327
|
+
* Defaults to ALIAS.
|
|
328
|
+
* @public
|
|
329
|
+
*/
|
|
330
|
+
encoding?: VoicePronunciationEncoding | undefined;
|
|
331
|
+
}
|
|
332
|
+
/**
|
|
333
|
+
* One configured language: its voice, its initial phrase and its pronunciation rules.
|
|
334
|
+
* @public
|
|
335
|
+
*/
|
|
336
|
+
export interface VoiceLanguage {
|
|
337
|
+
/**
|
|
338
|
+
* BCP-47 code with locale, e.g. 'en-US', 'it-IT'.
|
|
339
|
+
* @public
|
|
340
|
+
*/
|
|
341
|
+
code: string;
|
|
342
|
+
/**
|
|
343
|
+
* Voice this language speaks with, as a URI — provider, voice id, synthesis parameters and,
|
|
344
|
+
* where the company uses its own provider account, an `apiKey=secrets:\{secretId\}` reference.
|
|
345
|
+
* See VoiceUri.
|
|
346
|
+
*
|
|
347
|
+
* PER LANGUAGE, and that is the whole reason the member is here rather than on the settings
|
|
348
|
+
* above: provider quality is not uniform across languages, a voice id belongs to exactly one
|
|
349
|
+
* provider, and a bot-wide provider made changing it invalidate every configured voice at
|
|
350
|
+
* once.
|
|
351
|
+
* @public
|
|
352
|
+
*/
|
|
353
|
+
voice: string;
|
|
354
|
+
/**
|
|
355
|
+
* Initial phrase spoken when the call starts in this language. Absent or empty means
|
|
356
|
+
* the agent says nothing and waits — it does NOT fall back to VoiceChannelSettings.greeting,
|
|
357
|
+
* which would speak one language's text in another language's voice.
|
|
358
|
+
* @public
|
|
359
|
+
*/
|
|
360
|
+
greeting?: string | undefined;
|
|
361
|
+
/**
|
|
362
|
+
* Marks the language a caller hears when their own matches nothing configured.
|
|
363
|
+
*
|
|
364
|
+
* THE FULL RESOLUTION ORDER, since a client author reading only this contract cannot
|
|
365
|
+
* otherwise find it: an exact match on the call's language, then a match on its primary
|
|
366
|
+
* subtag (`fr` finds `fr-FR`), then the language marked here, then a language whose
|
|
367
|
+
* primary subtag is `en`, then the first entry in the list.
|
|
368
|
+
*
|
|
369
|
+
* Marked is consulted BEFORE the English step, so a record with none marked resolves
|
|
370
|
+
* exactly as it did before this member existed. English is deliberate rather than
|
|
371
|
+
* arbitrary — it is the language a caller the agent was not built for is likeliest to
|
|
372
|
+
* understand — and the last step exists only to keep the rule total, which is why list
|
|
373
|
+
* order should not be treated as configuration.
|
|
374
|
+
*
|
|
375
|
+
* At most one language may carry it. A record with two — reachable through the API or
|
|
376
|
+
* the CLI, where no form prevents it — resolves to the first marked one in list order,
|
|
377
|
+
* because refusing a call over configuration drift is worse than serving it and saying
|
|
378
|
+
* so in the trace.
|
|
379
|
+
* @public
|
|
380
|
+
*/
|
|
381
|
+
isDefault?: boolean | undefined;
|
|
382
|
+
/**
|
|
383
|
+
* The rules this language is spoken with. THE WHOLE SET rather than an override layer: an
|
|
384
|
+
* agent's respellings are stored here and read from here, so what this list says is what the
|
|
385
|
+
* caller hears.
|
|
386
|
+
*
|
|
387
|
+
* THERE IS NOTHING ABOVE IT. An earlier draft of this contract carried a company-wide
|
|
388
|
+
* dictionary per language that every agent speaking it inherited, with a merge order over this
|
|
389
|
+
* member and an identity rule ('Wildix' -> 'Wildix') for declining an inherited respelling.
|
|
390
|
+
* It bought correcting a handful of names in one place, and cost a second store, a merge on
|
|
391
|
+
* every synthesis path, a screen of its own, and a reader who could not tell from an agent
|
|
392
|
+
* what that agent would actually say. Per language per agent is where the divergence that
|
|
393
|
+
* matters already lives.
|
|
394
|
+
* @public
|
|
395
|
+
*/
|
|
396
|
+
pronunciations?: VoicePronunciation[] | undefined;
|
|
397
|
+
}
|
|
398
|
+
/**
|
|
399
|
+
* Speech-to-text configuration: which recogniser listens to the caller, and whether it identifies the language while it does.
|
|
400
|
+
* @public
|
|
401
|
+
*/
|
|
402
|
+
export interface VoiceTranscriptionSettings {
|
|
403
|
+
/**
|
|
404
|
+
* Recogniser to transcribe the caller with. Absent resolves to the platform default ('aws://transcribe' today), resolved by the server so exactly one component decides it.
|
|
405
|
+
* @public
|
|
406
|
+
*/
|
|
407
|
+
engine?: string | undefined;
|
|
408
|
+
/**
|
|
409
|
+
* Identify the caller's language per utterance and switch voice and reply language mid-call.
|
|
410
|
+
*
|
|
411
|
+
* HERE RATHER THAN ON `VoiceSpeechSettings`, because identifying a language is something the
|
|
412
|
+
* RECOGNISER does: it becomes identify-multiple-languages plus language-options on the
|
|
413
|
+
* recognition stream, and nothing about synthesis reads it.
|
|
414
|
+
*
|
|
415
|
+
* Requires at least two configured languages and a recogniser that can identify them; the
|
|
416
|
+
* server clamps it to false otherwise, because forwarding true with a single candidate makes
|
|
417
|
+
* Amazon reject the stream outright.
|
|
418
|
+
* @public
|
|
419
|
+
*/
|
|
420
|
+
autoDetect?: boolean | undefined;
|
|
421
|
+
}
|
|
422
|
+
/**
|
|
423
|
+
* Speech configuration for the voice channel. When present it WINS over the dialplan's `voice` and
|
|
424
|
+
* `initialMessage` connect parameters; `language` is the single exception, because it is the
|
|
425
|
+
* channel's own input signal and the feature has no starting point without it.
|
|
426
|
+
* @public
|
|
427
|
+
*/
|
|
428
|
+
export interface VoiceSpeechSettings {
|
|
429
|
+
/**
|
|
430
|
+
* Configured languages. The @length bound is a STORAGE ceiling, not the product rule: the real
|
|
431
|
+
* cap is the recogniser's own candidate limit (five for Amazon Transcribe), enforced in the
|
|
432
|
+
* service so a recogniser with a different limit needs no model change.
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
languages: VoiceLanguage[];
|
|
436
|
+
/**
|
|
437
|
+
* Speak the first message of every configured language in turn when the call is answered, each
|
|
438
|
+
* in the voice, provider account and pronunciation rules of its own language, instead of only the
|
|
439
|
+
* language the call resolved to. Languages whose first message is empty, and languages the PBX
|
|
440
|
+
* synthesizes itself, are skipped. Absent means off. Requires at least two languages carrying a
|
|
441
|
+
* first message; below that the runtime speaks only the resolved language's phrase, and the
|
|
442
|
+
* console clamps the member on save.
|
|
443
|
+
* @public
|
|
444
|
+
*/
|
|
445
|
+
greetEveryLanguage?: boolean | undefined;
|
|
446
|
+
/**
|
|
447
|
+
* Which recogniser listens to the caller, and whether it identifies the language. Absent takes the platform default recogniser with no language identification.
|
|
448
|
+
* @public
|
|
449
|
+
*/
|
|
450
|
+
transcription?: VoiceTranscriptionSettings | undefined;
|
|
451
|
+
}
|
|
285
452
|
/**
|
|
286
453
|
* 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.
|
|
287
454
|
* @public
|
|
@@ -292,6 +459,21 @@ export interface VoiceChannelSettings {
|
|
|
292
459
|
* @public
|
|
293
460
|
*/
|
|
294
461
|
greeting?: string | undefined;
|
|
462
|
+
/**
|
|
463
|
+
* Ambient background audio played under the call.
|
|
464
|
+
*
|
|
465
|
+
* It belongs to the CHANNEL rather than to `speech`, even though the console shows the control
|
|
466
|
+
* under the automatic-language switch. `speech` is the recognition and synthesis
|
|
467
|
+
* configuration and is sent only when languages are configured — background audio has nothing
|
|
468
|
+
* to do with either, and a bot with no languages must still be able to have it.
|
|
469
|
+
* @public
|
|
470
|
+
*/
|
|
471
|
+
backgroundSound?: VoiceBackgroundSoundSettings | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* Languages, voices, initial phrases, recogniser and pronunciation. Absent means the legacy behavior: voice URI from the dialplan connect parameter, one voice, language as prompt context only.
|
|
474
|
+
* @public
|
|
475
|
+
*/
|
|
476
|
+
speech?: VoiceSpeechSettings | undefined;
|
|
295
477
|
interruptions?: VoiceInterruptionSettings | undefined;
|
|
296
478
|
silenceTimeout?: VoiceSilenceTimeoutSettings | undefined;
|
|
297
479
|
maxDuration?: VoiceMaxDurationSettings | undefined;
|
|
@@ -302,6 +484,12 @@ export interface VoiceChannelSettings {
|
|
|
302
484
|
*/
|
|
303
485
|
callerMetadata?: VoiceCallerMetadataSettings | undefined;
|
|
304
486
|
}
|
|
487
|
+
/**
|
|
488
|
+
* Enablement only: a workflow agent has no delivery surface to configure. Present so `channels` can express that the agent runs as background tasks.
|
|
489
|
+
* @public
|
|
490
|
+
*/
|
|
491
|
+
export interface WorkflowChannelSettings {
|
|
492
|
+
}
|
|
305
493
|
/**
|
|
306
494
|
* 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.
|
|
307
495
|
* @public
|
|
@@ -314,6 +502,11 @@ export interface AgentChannels {
|
|
|
314
502
|
voice?: VoiceChannelSettings | undefined;
|
|
315
503
|
chat?: ChatChannelSettings | undefined;
|
|
316
504
|
assistant?: AssistantChannelSettings | undefined;
|
|
505
|
+
/**
|
|
506
|
+
* Enablement only: a workflow agent has no delivery surface to configure. Present so `channels` can express that the agent runs as background tasks.
|
|
507
|
+
* @public
|
|
508
|
+
*/
|
|
509
|
+
workflow?: WorkflowChannelSettings | undefined;
|
|
317
510
|
}
|
|
318
511
|
/**
|
|
319
512
|
* Who performed an action: an interactive user, an API key or an internal service.
|
|
@@ -1724,6 +1917,11 @@ export interface AgentGuardrailInput {
|
|
|
1724
1917
|
* @public
|
|
1725
1918
|
*/
|
|
1726
1919
|
model?: string | undefined;
|
|
1920
|
+
/**
|
|
1921
|
+
* Action for checks that declare none. Defaults to a block.
|
|
1922
|
+
* @public
|
|
1923
|
+
*/
|
|
1924
|
+
action?: AgentGuardrailAction | undefined;
|
|
1727
1925
|
/**
|
|
1728
1926
|
* Runs the checker before the agent's model (BLOCKING) or alongside it (PARALLEL). Blocking costs the checker's latency on every turn but guarantees that a refused turn spent no tokens and fired no tool; parallel adds no latency and is the right trade on voice, where the delay is audible, at the risk that part of a reply reaches the caller and that a tool has already run before the cancellation lands. Defaults to BLOCKING.
|
|
1729
1927
|
* @public
|
|
@@ -3174,6 +3372,11 @@ export interface AgentInfo {
|
|
|
3174
3372
|
* @public
|
|
3175
3373
|
*/
|
|
3176
3374
|
channels: ChannelType[];
|
|
3375
|
+
/**
|
|
3376
|
+
* Whether the voice channel has at least one configured speech language. A dialplan form partitions its application lists on this, so the answer has to travel with the list rather than cost one lookup per entry — it is the reason this member exists and the reason removing it broke that form. Absent is read as false.
|
|
3377
|
+
* @public
|
|
3378
|
+
*/
|
|
3379
|
+
speechConfigured?: boolean | undefined;
|
|
3177
3380
|
/**
|
|
3178
3381
|
* Ids of the skills attached to this agent. Always active in this agent's sessions; user skill preferences cannot disable them.
|
|
3179
3382
|
* @public
|
|
@@ -134,15 +134,21 @@ export declare var RestoreAgentVersionToDraftInput$: StaticStructureSchema;
|
|
|
134
134
|
export declare var RestoreAgentVersionToDraftOutput$: StaticStructureSchema;
|
|
135
135
|
export declare var UpdateAgentInput$: StaticStructureSchema;
|
|
136
136
|
export declare var UpdateAgentOutput$: StaticStructureSchema;
|
|
137
|
+
export declare var VoiceBackgroundSoundSettings$: StaticStructureSchema;
|
|
137
138
|
export declare var VoiceCallerMetadataSettings$: StaticStructureSchema;
|
|
138
139
|
export declare var VoiceChannelSettings$: StaticStructureSchema;
|
|
139
140
|
export declare var VoiceEndCallSettings$: StaticStructureSchema;
|
|
140
141
|
export declare var VoiceInterruptionSettings$: StaticStructureSchema;
|
|
142
|
+
export declare var VoiceLanguage$: StaticStructureSchema;
|
|
141
143
|
export declare var VoiceMaxDurationSettings$: StaticStructureSchema;
|
|
144
|
+
export declare var VoicePronunciation$: StaticStructureSchema;
|
|
142
145
|
export declare var VoiceSilenceTimeoutSettings$: StaticStructureSchema;
|
|
146
|
+
export declare var VoiceSpeechSettings$: StaticStructureSchema;
|
|
143
147
|
export declare var VoiceTerminateHangupAction$: StaticStructureSchema;
|
|
148
|
+
export declare var VoiceTranscriptionSettings$: StaticStructureSchema;
|
|
144
149
|
export declare var VoiceTransferTarget$: StaticStructureSchema;
|
|
145
150
|
export declare var WebSearchUserLocation$: StaticStructureSchema;
|
|
151
|
+
export declare var WorkflowChannelSettings$: StaticStructureSchema;
|
|
146
152
|
export declare var Actor$: StaticStructureSchema;
|
|
147
153
|
export declare var SecretRef$: StaticStructureSchema;
|
|
148
154
|
export declare var AgentSkillReference$: StaticStructureSchema;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wildix/wilma-agents-client",
|
|
3
3
|
"description": "@wildix/wilma-agents-client client",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.35",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|