@wildix/wilma-agents-client 1.0.43 → 1.0.44
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 +11 -1
- package/dist-cjs/schemas/schemas_0.js +44 -57
- package/dist-es/models/enums.js +10 -0
- package/dist-es/schemas/schemas_0.js +40 -53
- package/dist-types/commands/CreateAgentCommand.d.ts +82 -34
- package/dist-types/commands/GetAgentCommand.d.ts +41 -17
- package/dist-types/commands/GetAgentVersionCommand.d.ts +41 -17
- package/dist-types/commands/ListAgentsCommand.d.ts +41 -17
- package/dist-types/commands/PublishAgentVersionCommand.d.ts +41 -17
- package/dist-types/commands/RestoreAgentVersionToDraftCommand.d.ts +41 -17
- package/dist-types/commands/UpdateAgentCommand.d.ts +82 -34
- package/dist-types/models/enums.d.ts +35 -0
- package/dist-types/models/models_0.d.ts +79 -111
- package/dist-types/schemas/schemas_0.d.ts +1 -4
- package/package.json +56 -56
|
@@ -79,6 +79,12 @@ declare const UpdateAgentCommand_base: {
|
|
|
79
79
|
* action: { // VoiceTerminateAction Union: only one key present
|
|
80
80
|
* hangup: { // VoiceTerminateHangupAction
|
|
81
81
|
* message: "STRING_VALUE",
|
|
82
|
+
* messages: [ // AgentSpokenPhraseList
|
|
83
|
+
* { // AgentSpokenPhrase
|
|
84
|
+
* language: "STRING_VALUE", // required
|
|
85
|
+
* text: "STRING_VALUE", // required
|
|
86
|
+
* },
|
|
87
|
+
* ],
|
|
82
88
|
* },
|
|
83
89
|
* transfer: { // VoiceTransferTarget
|
|
84
90
|
* name: "STRING_VALUE", // required
|
|
@@ -93,6 +99,12 @@ declare const UpdateAgentCommand_base: {
|
|
|
93
99
|
* action: {// Union: only one key present
|
|
94
100
|
* hangup: {
|
|
95
101
|
* message: "STRING_VALUE",
|
|
102
|
+
* messages: [
|
|
103
|
+
* {
|
|
104
|
+
* language: "STRING_VALUE", // required
|
|
105
|
+
* text: "STRING_VALUE", // required
|
|
106
|
+
* },
|
|
107
|
+
* ],
|
|
96
108
|
* },
|
|
97
109
|
* transfer: {
|
|
98
110
|
* name: "STRING_VALUE", // required
|
|
@@ -133,23 +145,6 @@ declare const UpdateAgentCommand_base: {
|
|
|
133
145
|
* ],
|
|
134
146
|
* placeholder: "STRING_VALUE",
|
|
135
147
|
* },
|
|
136
|
-
* audio: { // AssistantAudioSettings
|
|
137
|
-
* enabled: true || false, // required
|
|
138
|
-
* engine: "STRING_VALUE",
|
|
139
|
-
* speech: { // AssistantSpeechSettings
|
|
140
|
-
* languages: [ // AssistantLanguageList // required
|
|
141
|
-
* { // AssistantLanguage
|
|
142
|
-
* code: "STRING_VALUE", // required
|
|
143
|
-
* voice: "STRING_VALUE", // required
|
|
144
|
-
* isDefault: true || false,
|
|
145
|
-
* },
|
|
146
|
-
* ],
|
|
147
|
-
* transcription: { // AssistantTranscriptionSettings
|
|
148
|
-
* engine: "STRING_VALUE",
|
|
149
|
-
* autoDetect: true || false,
|
|
150
|
-
* },
|
|
151
|
-
* },
|
|
152
|
-
* },
|
|
153
148
|
* },
|
|
154
149
|
* },
|
|
155
150
|
* engine: { // AgentEngine Union: only one key present
|
|
@@ -194,6 +189,12 @@ declare const UpdateAgentCommand_base: {
|
|
|
194
189
|
* },
|
|
195
190
|
* ],
|
|
196
191
|
* startMessage: "STRING_VALUE",
|
|
192
|
+
* startMessages: [
|
|
193
|
+
* {
|
|
194
|
+
* language: "STRING_VALUE", // required
|
|
195
|
+
* text: "STRING_VALUE", // required
|
|
196
|
+
* },
|
|
197
|
+
* ],
|
|
197
198
|
* pipeline: { // AgentToolPipeline
|
|
198
199
|
* type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
|
|
199
200
|
* instructions: "STRING_VALUE",
|
|
@@ -224,6 +225,12 @@ declare const UpdateAgentCommand_base: {
|
|
|
224
225
|
* connector: { // AgentConnectorCapability
|
|
225
226
|
* id: "STRING_VALUE", // required
|
|
226
227
|
* startMessage: "STRING_VALUE",
|
|
228
|
+
* startMessages: [
|
|
229
|
+
* {
|
|
230
|
+
* language: "STRING_VALUE", // required
|
|
231
|
+
* text: "STRING_VALUE", // required
|
|
232
|
+
* },
|
|
233
|
+
* ],
|
|
227
234
|
* pipeline: {
|
|
228
235
|
* type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
|
|
229
236
|
* instructions: "STRING_VALUE",
|
|
@@ -254,6 +261,9 @@ declare const UpdateAgentCommand_base: {
|
|
|
254
261
|
* kb: { // AgentKnowledgeBase
|
|
255
262
|
* knowledgeBaseId: "STRING_VALUE",
|
|
256
263
|
* instructions: "STRING_VALUE",
|
|
264
|
+
* searchStrategy: "bm25" || "vector" || "hybrid",
|
|
265
|
+
* searchThreshold: "low" || "medium" || "high",
|
|
266
|
+
* searchLimit: Number("int"),
|
|
257
267
|
* channels: [
|
|
258
268
|
* "voice" || "chat" || "assistant",
|
|
259
269
|
* ],
|
|
@@ -410,6 +420,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
410
420
|
* },
|
|
411
421
|
* suggestions: { // AgentSuggestionsCapability
|
|
412
422
|
* name: "STRING_VALUE",
|
|
423
|
+
* instructions: "STRING_VALUE",
|
|
413
424
|
* channels: "<AgentCapabilityChannelsList>",
|
|
414
425
|
* annotations: "<AgentToolAnnotationsList>",
|
|
415
426
|
* },
|
|
@@ -427,6 +438,12 @@ declare const UpdateAgentCommand_base: {
|
|
|
427
438
|
* name: "STRING_VALUE",
|
|
428
439
|
* description: "STRING_VALUE",
|
|
429
440
|
* message: "STRING_VALUE",
|
|
441
|
+
* messages: [
|
|
442
|
+
* {
|
|
443
|
+
* language: "STRING_VALUE", // required
|
|
444
|
+
* text: "STRING_VALUE", // required
|
|
445
|
+
* },
|
|
446
|
+
* ],
|
|
430
447
|
* channels: "<AgentCapabilityChannelsList>",
|
|
431
448
|
* annotations: "<AgentToolAnnotationsList>",
|
|
432
449
|
* },
|
|
@@ -485,6 +502,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
485
502
|
* },
|
|
486
503
|
* ],
|
|
487
504
|
* startMessage: "STRING_VALUE",
|
|
505
|
+
* startMessages: "<AgentSpokenPhraseList>",
|
|
488
506
|
* pipeline: {
|
|
489
507
|
* type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
|
|
490
508
|
* instructions: "STRING_VALUE",
|
|
@@ -498,6 +516,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
498
516
|
* connector: {
|
|
499
517
|
* id: "STRING_VALUE", // required
|
|
500
518
|
* startMessage: "STRING_VALUE",
|
|
519
|
+
* startMessages: "<AgentSpokenPhraseList>",
|
|
501
520
|
* pipeline: {
|
|
502
521
|
* type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
|
|
503
522
|
* instructions: "STRING_VALUE",
|
|
@@ -586,6 +605,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
586
605
|
* name: "STRING_VALUE",
|
|
587
606
|
* description: "STRING_VALUE",
|
|
588
607
|
* message: "STRING_VALUE",
|
|
608
|
+
* messages: "<AgentSpokenPhraseList>",
|
|
589
609
|
* channels: "<AgentCapabilityChannelsList>",
|
|
590
610
|
* annotations: "<AgentToolAnnotationsList>",
|
|
591
611
|
* },
|
|
@@ -664,6 +684,9 @@ declare const UpdateAgentCommand_base: {
|
|
|
664
684
|
* kb: {
|
|
665
685
|
* knowledgeBaseId: "STRING_VALUE",
|
|
666
686
|
* instructions: "STRING_VALUE",
|
|
687
|
+
* searchStrategy: "bm25" || "vector" || "hybrid",
|
|
688
|
+
* searchThreshold: "low" || "medium" || "high",
|
|
689
|
+
* searchLimit: Number("int"),
|
|
667
690
|
* channels: "<AgentCapabilityChannelsList>",
|
|
668
691
|
* annotations: "<AgentToolAnnotationsList>",
|
|
669
692
|
* },
|
|
@@ -701,6 +724,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
701
724
|
* transfer: "<AgentTransferCapability>",
|
|
702
725
|
* suggestions: {
|
|
703
726
|
* name: "STRING_VALUE",
|
|
727
|
+
* instructions: "STRING_VALUE",
|
|
704
728
|
* channels: "<AgentCapabilityChannelsList>",
|
|
705
729
|
* annotations: "<AgentToolAnnotationsList>",
|
|
706
730
|
* },
|
|
@@ -944,6 +968,12 @@ declare const UpdateAgentCommand_base: {
|
|
|
944
968
|
* // action: { // VoiceTerminateAction Union: only one key present
|
|
945
969
|
* // hangup: { // VoiceTerminateHangupAction
|
|
946
970
|
* // message: "STRING_VALUE",
|
|
971
|
+
* // messages: [ // AgentSpokenPhraseList
|
|
972
|
+
* // { // AgentSpokenPhrase
|
|
973
|
+
* // language: "STRING_VALUE", // required
|
|
974
|
+
* // text: "STRING_VALUE", // required
|
|
975
|
+
* // },
|
|
976
|
+
* // ],
|
|
947
977
|
* // },
|
|
948
978
|
* // transfer: { // VoiceTransferTarget
|
|
949
979
|
* // name: "STRING_VALUE", // required
|
|
@@ -958,6 +988,12 @@ declare const UpdateAgentCommand_base: {
|
|
|
958
988
|
* // action: {// Union: only one key present
|
|
959
989
|
* // hangup: {
|
|
960
990
|
* // message: "STRING_VALUE",
|
|
991
|
+
* // messages: [
|
|
992
|
+
* // {
|
|
993
|
+
* // language: "STRING_VALUE", // required
|
|
994
|
+
* // text: "STRING_VALUE", // required
|
|
995
|
+
* // },
|
|
996
|
+
* // ],
|
|
961
997
|
* // },
|
|
962
998
|
* // transfer: {
|
|
963
999
|
* // name: "STRING_VALUE", // required
|
|
@@ -998,23 +1034,6 @@ declare const UpdateAgentCommand_base: {
|
|
|
998
1034
|
* // ],
|
|
999
1035
|
* // placeholder: "STRING_VALUE",
|
|
1000
1036
|
* // },
|
|
1001
|
-
* // audio: { // AssistantAudioSettings
|
|
1002
|
-
* // enabled: true || false, // required
|
|
1003
|
-
* // engine: "STRING_VALUE",
|
|
1004
|
-
* // speech: { // AssistantSpeechSettings
|
|
1005
|
-
* // languages: [ // AssistantLanguageList // required
|
|
1006
|
-
* // { // AssistantLanguage
|
|
1007
|
-
* // code: "STRING_VALUE", // required
|
|
1008
|
-
* // voice: "STRING_VALUE", // required
|
|
1009
|
-
* // isDefault: true || false,
|
|
1010
|
-
* // },
|
|
1011
|
-
* // ],
|
|
1012
|
-
* // transcription: { // AssistantTranscriptionSettings
|
|
1013
|
-
* // engine: "STRING_VALUE",
|
|
1014
|
-
* // autoDetect: true || false,
|
|
1015
|
-
* // },
|
|
1016
|
-
* // },
|
|
1017
|
-
* // },
|
|
1018
1037
|
* // },
|
|
1019
1038
|
* // },
|
|
1020
1039
|
* // engine: { // AgentEngine Union: only one key present
|
|
@@ -1059,6 +1078,12 @@ declare const UpdateAgentCommand_base: {
|
|
|
1059
1078
|
* // },
|
|
1060
1079
|
* // ],
|
|
1061
1080
|
* // startMessage: "STRING_VALUE",
|
|
1081
|
+
* // startMessages: [
|
|
1082
|
+
* // {
|
|
1083
|
+
* // language: "STRING_VALUE", // required
|
|
1084
|
+
* // text: "STRING_VALUE", // required
|
|
1085
|
+
* // },
|
|
1086
|
+
* // ],
|
|
1062
1087
|
* // pipeline: { // AgentToolPipeline
|
|
1063
1088
|
* // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
|
|
1064
1089
|
* // instructions: "STRING_VALUE",
|
|
@@ -1089,6 +1114,12 @@ declare const UpdateAgentCommand_base: {
|
|
|
1089
1114
|
* // connector: { // AgentConnectorCapability
|
|
1090
1115
|
* // id: "STRING_VALUE", // required
|
|
1091
1116
|
* // startMessage: "STRING_VALUE",
|
|
1117
|
+
* // startMessages: [
|
|
1118
|
+
* // {
|
|
1119
|
+
* // language: "STRING_VALUE", // required
|
|
1120
|
+
* // text: "STRING_VALUE", // required
|
|
1121
|
+
* // },
|
|
1122
|
+
* // ],
|
|
1092
1123
|
* // pipeline: {
|
|
1093
1124
|
* // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
|
|
1094
1125
|
* // instructions: "STRING_VALUE",
|
|
@@ -1119,6 +1150,9 @@ declare const UpdateAgentCommand_base: {
|
|
|
1119
1150
|
* // kb: { // AgentKnowledgeBase
|
|
1120
1151
|
* // knowledgeBaseId: "STRING_VALUE",
|
|
1121
1152
|
* // instructions: "STRING_VALUE",
|
|
1153
|
+
* // searchStrategy: "bm25" || "vector" || "hybrid",
|
|
1154
|
+
* // searchThreshold: "low" || "medium" || "high",
|
|
1155
|
+
* // searchLimit: Number("int"),
|
|
1122
1156
|
* // channels: [
|
|
1123
1157
|
* // "voice" || "chat" || "assistant",
|
|
1124
1158
|
* // ],
|
|
@@ -1275,6 +1309,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
1275
1309
|
* // },
|
|
1276
1310
|
* // suggestions: { // AgentSuggestionsCapability
|
|
1277
1311
|
* // name: "STRING_VALUE",
|
|
1312
|
+
* // instructions: "STRING_VALUE",
|
|
1278
1313
|
* // channels: "<AgentCapabilityChannelsList>",
|
|
1279
1314
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
1280
1315
|
* // },
|
|
@@ -1292,6 +1327,12 @@ declare const UpdateAgentCommand_base: {
|
|
|
1292
1327
|
* // name: "STRING_VALUE",
|
|
1293
1328
|
* // description: "STRING_VALUE",
|
|
1294
1329
|
* // message: "STRING_VALUE",
|
|
1330
|
+
* // messages: [
|
|
1331
|
+
* // {
|
|
1332
|
+
* // language: "STRING_VALUE", // required
|
|
1333
|
+
* // text: "STRING_VALUE", // required
|
|
1334
|
+
* // },
|
|
1335
|
+
* // ],
|
|
1295
1336
|
* // channels: "<AgentCapabilityChannelsList>",
|
|
1296
1337
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
1297
1338
|
* // },
|
|
@@ -1350,6 +1391,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
1350
1391
|
* // },
|
|
1351
1392
|
* // ],
|
|
1352
1393
|
* // startMessage: "STRING_VALUE",
|
|
1394
|
+
* // startMessages: "<AgentSpokenPhraseList>",
|
|
1353
1395
|
* // pipeline: {
|
|
1354
1396
|
* // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
|
|
1355
1397
|
* // instructions: "STRING_VALUE",
|
|
@@ -1363,6 +1405,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
1363
1405
|
* // connector: {
|
|
1364
1406
|
* // id: "STRING_VALUE", // required
|
|
1365
1407
|
* // startMessage: "STRING_VALUE",
|
|
1408
|
+
* // startMessages: "<AgentSpokenPhraseList>",
|
|
1366
1409
|
* // pipeline: {
|
|
1367
1410
|
* // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
|
|
1368
1411
|
* // instructions: "STRING_VALUE",
|
|
@@ -1451,6 +1494,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
1451
1494
|
* // name: "STRING_VALUE",
|
|
1452
1495
|
* // description: "STRING_VALUE",
|
|
1453
1496
|
* // message: "STRING_VALUE",
|
|
1497
|
+
* // messages: "<AgentSpokenPhraseList>",
|
|
1454
1498
|
* // channels: "<AgentCapabilityChannelsList>",
|
|
1455
1499
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
1456
1500
|
* // },
|
|
@@ -1529,6 +1573,9 @@ declare const UpdateAgentCommand_base: {
|
|
|
1529
1573
|
* // kb: {
|
|
1530
1574
|
* // knowledgeBaseId: "STRING_VALUE",
|
|
1531
1575
|
* // instructions: "STRING_VALUE",
|
|
1576
|
+
* // searchStrategy: "bm25" || "vector" || "hybrid",
|
|
1577
|
+
* // searchThreshold: "low" || "medium" || "high",
|
|
1578
|
+
* // searchLimit: Number("int"),
|
|
1532
1579
|
* // channels: "<AgentCapabilityChannelsList>",
|
|
1533
1580
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
1534
1581
|
* // },
|
|
@@ -1566,6 +1613,7 @@ declare const UpdateAgentCommand_base: {
|
|
|
1566
1613
|
* // transfer: "<AgentTransferCapability>",
|
|
1567
1614
|
* // suggestions: {
|
|
1568
1615
|
* // name: "STRING_VALUE",
|
|
1616
|
+
* // instructions: "STRING_VALUE",
|
|
1569
1617
|
* // channels: "<AgentCapabilityChannelsList>",
|
|
1570
1618
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
1571
1619
|
* // },
|
|
@@ -161,6 +161,41 @@ export declare const AgentHangupPipelineType: {
|
|
|
161
161
|
* @public
|
|
162
162
|
*/
|
|
163
163
|
export type AgentHangupPipelineType = (typeof AgentHangupPipelineType)[keyof typeof AgentHangupPipelineType];
|
|
164
|
+
/**
|
|
165
|
+
* @public
|
|
166
|
+
* @enum
|
|
167
|
+
*/
|
|
168
|
+
export declare const KnowledgeBaseSearchStrategy: {
|
|
169
|
+
/**
|
|
170
|
+
* Full-text keyword search. Suits corpora callers address by exact product name, code or error string.
|
|
171
|
+
*/
|
|
172
|
+
readonly BM25: "bm25";
|
|
173
|
+
/**
|
|
174
|
+
* Both, combined. The service default and the right answer for most agents.
|
|
175
|
+
*/
|
|
176
|
+
readonly HYBRID: "hybrid";
|
|
177
|
+
/**
|
|
178
|
+
* Semantic similarity over embeddings. Suits callers who paraphrase rather than quote.
|
|
179
|
+
*/
|
|
180
|
+
readonly VECTOR: "vector";
|
|
181
|
+
};
|
|
182
|
+
/**
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
export type KnowledgeBaseSearchStrategy = (typeof KnowledgeBaseSearchStrategy)[keyof typeof KnowledgeBaseSearchStrategy];
|
|
186
|
+
/**
|
|
187
|
+
* @public
|
|
188
|
+
* @enum
|
|
189
|
+
*/
|
|
190
|
+
export declare const KnowledgeBaseSearchThreshold: {
|
|
191
|
+
readonly HIGH: "high";
|
|
192
|
+
readonly LOW: "low";
|
|
193
|
+
readonly MEDIUM: "medium";
|
|
194
|
+
};
|
|
195
|
+
/**
|
|
196
|
+
* @public
|
|
197
|
+
*/
|
|
198
|
+
export type KnowledgeBaseSearchThreshold = (typeof KnowledgeBaseSearchThreshold)[keyof typeof KnowledgeBaseSearchThreshold];
|
|
164
199
|
/**
|
|
165
200
|
* @public
|
|
166
201
|
* @enum
|
|
@@ -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, VoicePronunciationEncoding, 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, KnowledgeBaseSearchStrategy, KnowledgeBaseSearchThreshold, SandboxNetworkAccess, SandboxSize, VoicePronunciationEncoding, WebSearchContextSize } from "./enums";
|
|
3
3
|
/**
|
|
4
4
|
* A user or group that access is granted to.
|
|
5
5
|
* @public
|
|
@@ -57,102 +57,6 @@ export interface AgentAccess {
|
|
|
57
57
|
*/
|
|
58
58
|
grants?: AgentGrantPrincipal[] | undefined;
|
|
59
59
|
}
|
|
60
|
-
/**
|
|
61
|
-
* One language the assistant audio channel can recognise and speak. There is deliberately no
|
|
62
|
-
* greeting here: an assistant conversation is already open when its audio call starts, so there
|
|
63
|
-
* is no new conversation to welcome and no initial phrase for the runtime to choose or repeat.
|
|
64
|
-
* @public
|
|
65
|
-
*/
|
|
66
|
-
export interface AssistantLanguage {
|
|
67
|
-
/**
|
|
68
|
-
* BCP-47 code with locale, e.g. 'en-US', 'it-IT'. Reuses the channel-neutral language value so assistant and voice configuration accept the same codes without sharing policy structures.
|
|
69
|
-
* @public
|
|
70
|
-
*/
|
|
71
|
-
code: string;
|
|
72
|
-
/**
|
|
73
|
-
* Voice this language speaks with. Reuses the channel-neutral URI value so providers and synthesis parameters have the same representation in every channel without coupling their language rules.
|
|
74
|
-
* @public
|
|
75
|
-
*/
|
|
76
|
-
voice: string;
|
|
77
|
-
/**
|
|
78
|
-
* Marks the language used when the caller's language matches nothing configured.
|
|
79
|
-
*
|
|
80
|
-
* THE FULL RESOLUTION ORDER, because a client author reading only this contract cannot
|
|
81
|
-
* otherwise find it: an exact match on the call's language, then a match on its primary
|
|
82
|
-
* subtag (`fr` finds `fr-FR`), then the language marked here, then a language whose primary
|
|
83
|
-
* subtag is `en`, then the first entry in the list. The same order the voice channel resolves
|
|
84
|
-
* by — the rule belongs to choosing a language, not to a channel.
|
|
85
|
-
*
|
|
86
|
-
* At most one language may carry it. A record with two — reachable through the API, where no
|
|
87
|
-
* form prevents it — resolves to the first marked one in list order: refusing an
|
|
88
|
-
* already-open assistant conversation over configuration drift is worse than serving it.
|
|
89
|
-
* @public
|
|
90
|
-
*/
|
|
91
|
-
isDefault?: boolean | undefined;
|
|
92
|
-
}
|
|
93
|
-
/**
|
|
94
|
-
* Speech-to-text configuration owned by the assistant channel, so changes to assistant recognition policy cannot alter telephony calls.
|
|
95
|
-
* @public
|
|
96
|
-
*/
|
|
97
|
-
export interface AssistantTranscriptionSettings {
|
|
98
|
-
/**
|
|
99
|
-
* Recogniser used for assistant audio. Absent resolves to the platform default, resolved by the server so exactly one component decides it.
|
|
100
|
-
* @public
|
|
101
|
-
*/
|
|
102
|
-
engine?: string | undefined;
|
|
103
|
-
/**
|
|
104
|
-
* Identify the caller's language per utterance and switch voice and reply language while the
|
|
105
|
-
* audio call is open. Absent means off. It requires at least two configured languages and a
|
|
106
|
-
* recogniser that can identify them; the server clamps it to false otherwise because passing
|
|
107
|
-
* one candidate to an identifying recogniser can make it reject the stream.
|
|
108
|
-
* @public
|
|
109
|
-
*/
|
|
110
|
-
autoDetect?: boolean | undefined;
|
|
111
|
-
}
|
|
112
|
-
/**
|
|
113
|
-
* Recognition and synthesis policy for assistant audio. This is assistant-owned rather than a
|
|
114
|
-
* VoiceSpeechSettings reuse so telephony and assistant audio can evolve independently. It has no
|
|
115
|
-
* language greeting and no greet-every-language switch because an assistant conversation is
|
|
116
|
-
* already open when its audio call starts, leaving nothing for the channel to greet.
|
|
117
|
-
* @public
|
|
118
|
-
*/
|
|
119
|
-
export interface AssistantSpeechSettings {
|
|
120
|
-
/**
|
|
121
|
-
* Languages the assistant audio channel can recognise and speak. The @length bound is a
|
|
122
|
-
* STORAGE ceiling, not the product rule: the real cap is the recogniser's own candidate limit,
|
|
123
|
-
* enforced in the service so a recogniser with a different limit needs no model change.
|
|
124
|
-
* @public
|
|
125
|
-
*/
|
|
126
|
-
languages: AssistantLanguage[];
|
|
127
|
-
/**
|
|
128
|
-
* Which recogniser listens to assistant audio and whether it identifies the language. Absent uses the platform default recogniser without language identification.
|
|
129
|
-
* @public
|
|
130
|
-
*/
|
|
131
|
-
transcription?: AssistantTranscriptionSettings | undefined;
|
|
132
|
-
}
|
|
133
|
-
/**
|
|
134
|
-
* Switchable audio for the assistant channel. The settings object keeps enablement beside its
|
|
135
|
-
* speech policy, matching the voice channel's switchable blocks so a disabled configuration can
|
|
136
|
-
* be retained without serving audio.
|
|
137
|
-
* @public
|
|
138
|
-
*/
|
|
139
|
-
export interface AssistantAudioSettings {
|
|
140
|
-
/**
|
|
141
|
-
* Whether the assistant accepts audio calls. Required so the presence of saved speech configuration is never mistaken for enablement.
|
|
142
|
-
* @public
|
|
143
|
-
*/
|
|
144
|
-
enabled: boolean;
|
|
145
|
-
/**
|
|
146
|
-
* Which runtime carries the call. Absent is 'voice'.
|
|
147
|
-
* @public
|
|
148
|
-
*/
|
|
149
|
-
engine?: string | undefined;
|
|
150
|
-
/**
|
|
151
|
-
* Languages, voices and recognition policy for assistant audio. Absent leaves those choices to platform defaults, including when audio is enabled.
|
|
152
|
-
* @public
|
|
153
|
-
*/
|
|
154
|
-
speech?: AssistantSpeechSettings | undefined;
|
|
155
|
-
}
|
|
156
60
|
/**
|
|
157
61
|
* A starter prompt offered as a card on an empty thread. Picking it sends `prompt` as the user's first message, so the user never types it.
|
|
158
62
|
* @public
|
|
@@ -212,7 +116,6 @@ export interface AssistantUiSettings {
|
|
|
212
116
|
placeholder?: string | undefined;
|
|
213
117
|
}
|
|
214
118
|
/**
|
|
215
|
-
* Assistant channel settings. Presence enables the in-app assistant surface; audio remains unavailable unless its separate settings are present and enabled.
|
|
216
119
|
* @public
|
|
217
120
|
*/
|
|
218
121
|
export interface AssistantChannelSettings {
|
|
@@ -226,11 +129,6 @@ export interface AssistantChannelSettings {
|
|
|
226
129
|
* @public
|
|
227
130
|
*/
|
|
228
131
|
ui?: AssistantUiSettings | undefined;
|
|
229
|
-
/**
|
|
230
|
-
* Audio configuration owned by the assistant channel. Absent means the assistant has no audio at all, preserving the behaviour of every existing agent without consulting `channels.voice`.
|
|
231
|
-
* @public
|
|
232
|
-
*/
|
|
233
|
-
audio?: AssistantAudioSettings | undefined;
|
|
234
132
|
}
|
|
235
133
|
/**
|
|
236
134
|
* @public
|
|
@@ -322,15 +220,41 @@ export interface VoiceInterruptionSettings {
|
|
|
322
220
|
*/
|
|
323
221
|
minWords?: number | undefined;
|
|
324
222
|
}
|
|
223
|
+
/**
|
|
224
|
+
* One phrase in one language, for a capability that speaks a fixed line on the voice channel.
|
|
225
|
+
* Which entry is spoken is decided by the call's current language — the one the call resolved
|
|
226
|
+
* to at connect, or the one automatic detection switched to — matched on `language`
|
|
227
|
+
* CASE-INSENSITIVELY, the same rule `VoiceBotSpokenPhrase` states for the legacy stack, so a
|
|
228
|
+
* code written in either case reaches the same entry on either. Blank `text` means the agent
|
|
229
|
+
* says nothing in that language; it does NOT fall back to the language-agnostic member beside
|
|
230
|
+
* the list, which would speak one language's text in another language's voice.
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
export interface AgentSpokenPhrase {
|
|
234
|
+
/**
|
|
235
|
+
* BCP-47 language tag, optionally with a region subtag: 'en', 'en-US', 'pt-BR'. Deliberately a
|
|
236
|
+
* constrained string rather than an enum: the offerable set is a property of the selected
|
|
237
|
+
* recogniser and changes with it, so an enumeration here would cap the set at whatever was known
|
|
238
|
+
* when the model was released.
|
|
239
|
+
* @public
|
|
240
|
+
*/
|
|
241
|
+
language: string;
|
|
242
|
+
text: string;
|
|
243
|
+
}
|
|
325
244
|
/**
|
|
326
245
|
* @public
|
|
327
246
|
*/
|
|
328
247
|
export interface VoiceTerminateHangupAction {
|
|
329
248
|
/**
|
|
330
|
-
* Message played before hanging up.
|
|
249
|
+
* Message played before hanging up. Played in every language of the call while `messages` is absent or empty; not consulted once `messages` carries any entry.
|
|
331
250
|
* @public
|
|
332
251
|
*/
|
|
333
252
|
message?: string | undefined;
|
|
253
|
+
/**
|
|
254
|
+
* Per-language messages played before hanging up. Same rule as `AgentTool.startMessages`: the entry for the call's current language is played, a language with no entry is silent, and with no effective speech configuration `message` is played.
|
|
255
|
+
* @public
|
|
256
|
+
*/
|
|
257
|
+
messages?: AgentSpokenPhrase[] | undefined;
|
|
334
258
|
}
|
|
335
259
|
/**
|
|
336
260
|
* @public
|
|
@@ -597,10 +521,6 @@ export interface AgentChannels {
|
|
|
597
521
|
*/
|
|
598
522
|
voice?: VoiceChannelSettings | undefined;
|
|
599
523
|
chat?: ChatChannelSettings | undefined;
|
|
600
|
-
/**
|
|
601
|
-
* Assistant channel settings. Presence enables the in-app assistant surface; audio remains unavailable unless its separate settings are present and enabled.
|
|
602
|
-
* @public
|
|
603
|
-
*/
|
|
604
524
|
assistant?: AssistantChannelSettings | undefined;
|
|
605
525
|
}
|
|
606
526
|
/**
|
|
@@ -921,10 +841,15 @@ export interface AgentConnectorCapability {
|
|
|
921
841
|
*/
|
|
922
842
|
id: string;
|
|
923
843
|
/**
|
|
924
|
-
* Message spoken when a connector action call starts. Honoured on the voice channel. Mirrors `AgentTool.startMessage`. Not applied to the read-only `help` action.
|
|
844
|
+
* Message spoken when a connector action call starts. Honoured on the voice channel. Mirrors `AgentTool.startMessage`. Not applied to the read-only `help` action. Not consulted once `startMessages` carries any entry.
|
|
925
845
|
* @public
|
|
926
846
|
*/
|
|
927
847
|
startMessage?: string | undefined;
|
|
848
|
+
/**
|
|
849
|
+
* Forward-compatible per-language connector start messages, mirroring `AgentTool.startMessages`. Accepted and stored so clients can configure connector and tool phrases consistently, but currently ignored at execution time because the voice runtime does not read connector start messages yet. Runtime enablement is tracked in wilma-services docs/todo.md item 8.
|
|
850
|
+
* @public
|
|
851
|
+
*/
|
|
852
|
+
startMessages?: AgentSpokenPhrase[] | undefined;
|
|
928
853
|
/**
|
|
929
854
|
* How the model waits for a connector action and whether it synthesizes a reply from the result. The `help` action carries no pipeline.
|
|
930
855
|
* @public
|
|
@@ -1081,6 +1006,21 @@ export interface AgentKnowledgeBase {
|
|
|
1081
1006
|
* @public
|
|
1082
1007
|
*/
|
|
1083
1008
|
instructions?: string | undefined;
|
|
1009
|
+
/**
|
|
1010
|
+
* Search algorithm used for this capability. Defaults to the knowledge base service's own default (`hybrid`) when omitted.
|
|
1011
|
+
* @public
|
|
1012
|
+
*/
|
|
1013
|
+
searchStrategy?: KnowledgeBaseSearchStrategy | undefined;
|
|
1014
|
+
/**
|
|
1015
|
+
* Minimum similarity a passage needs to be returned by this capability. Defaults to the knowledge base service's own default (`medium`) when omitted. Worth raising on voice, where an off-target passage is spoken aloud.
|
|
1016
|
+
* @public
|
|
1017
|
+
*/
|
|
1018
|
+
searchThreshold?: KnowledgeBaseSearchThreshold | undefined;
|
|
1019
|
+
/**
|
|
1020
|
+
* Maximum number of passages this capability returns. Defaults to the knowledge base service's own default (10) when omitted. Keep it low on voice: every passage is prompt the model reads before it can speak.
|
|
1021
|
+
* @public
|
|
1022
|
+
*/
|
|
1023
|
+
searchLimit?: number | undefined;
|
|
1084
1024
|
/**
|
|
1085
1025
|
* Channels this capability is offered on. Absent or empty — the default — means every channel the agent serves
|
|
1086
1026
|
* that can honour it. Listing channels narrows that set and never widens it: a `transfer` listed for `chat` is
|
|
@@ -1192,6 +1132,20 @@ export interface AgentSuggestionsCapability {
|
|
|
1192
1132
|
* @public
|
|
1193
1133
|
*/
|
|
1194
1134
|
name?: string | undefined;
|
|
1135
|
+
/**
|
|
1136
|
+
* Steers what the suggestions say. Appended to the platform's own generation prompt rather than
|
|
1137
|
+
* replacing it, so the shape of a suggestion — short, tappable, a plausible next thing to send —
|
|
1138
|
+
* stays the platform's to keep, and this narrows the subject: 'offer a callback and a link to the
|
|
1139
|
+
* status page, never a discount'.
|
|
1140
|
+
*
|
|
1141
|
+
* NOT a tool description, unlike the `description` every other capability carries: suggestions are
|
|
1142
|
+
* not a tool the model chooses to call. They are generated from a reply that has already been
|
|
1143
|
+
* written, so there is no decision to describe — only the generation to steer.
|
|
1144
|
+
*
|
|
1145
|
+
* Absent means the platform's prompt alone.
|
|
1146
|
+
* @public
|
|
1147
|
+
*/
|
|
1148
|
+
instructions?: string | undefined;
|
|
1195
1149
|
/**
|
|
1196
1150
|
* Channels this capability is offered on. Absent or empty — the default — means every channel the agent serves
|
|
1197
1151
|
* that can honour it. Listing channels narrows that set and never widens it: a `transfer` listed for `chat` is
|
|
@@ -1296,10 +1250,19 @@ export interface AgentTool {
|
|
|
1296
1250
|
*/
|
|
1297
1251
|
fields?: AgentToolField[] | undefined;
|
|
1298
1252
|
/**
|
|
1299
|
-
* Message spoken when the tool call starts. Honoured on the voice channel.
|
|
1253
|
+
* Message spoken when the tool call starts. Honoured on the voice channel. Spoken in every language of the call while `startMessages` is absent or empty; not consulted once `startMessages` carries any entry.
|
|
1300
1254
|
* @public
|
|
1301
1255
|
*/
|
|
1302
1256
|
startMessage?: string | undefined;
|
|
1257
|
+
/**
|
|
1258
|
+
* Per-language start messages. When present and non-empty, the entry for the call's current
|
|
1259
|
+
* language is spoken and `startMessage` is not consulted; a language with no entry is silent.
|
|
1260
|
+
* When absent or empty, `startMessage` is spoken as before. On a call with no effective speech
|
|
1261
|
+
* configuration — no configured languages, or a PBX below protocol 2 — `startMessage` is spoken
|
|
1262
|
+
* regardless, because there is no current language to choose by.
|
|
1263
|
+
* @public
|
|
1264
|
+
*/
|
|
1265
|
+
startMessages?: AgentSpokenPhrase[] | undefined;
|
|
1303
1266
|
/**
|
|
1304
1267
|
* How the model waits for the tool and whether it synthesizes a reply from the result.
|
|
1305
1268
|
* @public
|
|
@@ -1382,10 +1345,15 @@ export interface AgentWaitCapability {
|
|
|
1382
1345
|
*/
|
|
1383
1346
|
description?: string | undefined;
|
|
1384
1347
|
/**
|
|
1385
|
-
* Message spoken when entering the wait state.
|
|
1348
|
+
* Message spoken when entering the wait state. Spoken in every language of the call while `messages` is absent or empty; not consulted once `messages` carries any entry.
|
|
1386
1349
|
* @public
|
|
1387
1350
|
*/
|
|
1388
1351
|
message?: string | undefined;
|
|
1352
|
+
/**
|
|
1353
|
+
* Per-language wait messages. Same rule as `AgentTool.startMessages`: the entry for the call's current language is spoken, a language with no entry is silent, and with no effective speech configuration `message` is spoken.
|
|
1354
|
+
* @public
|
|
1355
|
+
*/
|
|
1356
|
+
messages?: AgentSpokenPhrase[] | undefined;
|
|
1389
1357
|
/**
|
|
1390
1358
|
* Channels this capability is offered on. Absent or empty — the default — means every channel the agent serves
|
|
1391
1359
|
* that can honour it. Listing channels narrows that set and never widens it: a `transfer` listed for `chat` is
|
|
@@ -39,6 +39,7 @@ export declare var AgentInfo$: StaticStructureSchema;
|
|
|
39
39
|
export declare var AgentKnowledgeBase$: StaticStructureSchema;
|
|
40
40
|
export declare var AgentSettings$: StaticStructureSchema;
|
|
41
41
|
export declare var AgentSnapshotSandboxOptions$: StaticStructureSchema;
|
|
42
|
+
export declare var AgentSpokenPhrase$: StaticStructureSchema;
|
|
42
43
|
export declare var AgentSqsEngine$: StaticStructureSchema;
|
|
43
44
|
export declare var AgentSuggestionsCapability$: StaticStructureSchema;
|
|
44
45
|
export declare var AgentTool$: StaticStructureSchema;
|
|
@@ -95,12 +96,8 @@ export declare var AgentWorkflowStep$: StaticStructureSchema;
|
|
|
95
96
|
export declare var AgentWorkflowStepPosition$: StaticStructureSchema;
|
|
96
97
|
export declare var AgentWorkflowTransition$: StaticStructureSchema;
|
|
97
98
|
export declare var AgentWorkflowVariablesHandler$: StaticStructureSchema;
|
|
98
|
-
export declare var AssistantAudioSettings$: StaticStructureSchema;
|
|
99
99
|
export declare var AssistantChannelSettings$: StaticStructureSchema;
|
|
100
|
-
export declare var AssistantLanguage$: StaticStructureSchema;
|
|
101
100
|
export declare var AssistantQuickCommand$: StaticStructureSchema;
|
|
102
|
-
export declare var AssistantSpeechSettings$: StaticStructureSchema;
|
|
103
|
-
export declare var AssistantTranscriptionSettings$: StaticStructureSchema;
|
|
104
101
|
export declare var AssistantUiSettings$: StaticStructureSchema;
|
|
105
102
|
export declare var AssistantWelcomeSettings$: StaticStructureSchema;
|
|
106
103
|
export declare var ChatChannelSettings$: StaticStructureSchema;
|