@wildix/wim-voicebots-client 1.1.7 → 1.1.9

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.
@@ -44,6 +44,7 @@ declare const DescribeEventCommand_base: {
44
44
  * // type: "started" || "ended" || "reply" || "audio" || "playback" || "transcription" || "interruption" || "complete", // required
45
45
  * // id: "STRING_VALUE", // required
46
46
  * // text: "STRING_VALUE", // required
47
+ * // confidence: Number("double"),
47
48
  * // final: true || false,
48
49
  * // time: Number("long"), // required
49
50
  * // },
@@ -161,6 +162,7 @@ declare const DescribeEventCommand_base: {
161
162
  * // type: "started" || "ended" || "reply" || "audio" || "playback" || "transcription" || "interruption" || "complete", // required
162
163
  * // id: "STRING_VALUE", // required
163
164
  * // text: "STRING_VALUE", // required
165
+ * // confidence: Number("double"),
164
166
  * // final: true || false,
165
167
  * // time: Number("long"), // required
166
168
  * // },
@@ -303,6 +305,7 @@ declare const DescribeEventCommand_base: {
303
305
  * // type: "started" || "ended" || "reply" || "audio" || "playback" || "transcription" || "interruption" || "complete", // required
304
306
  * // id: "STRING_VALUE", // required
305
307
  * // text: "STRING_VALUE", // required
308
+ * // confidence: Number("double"),
306
309
  * // final: true || false,
307
310
  * // time: Number("long"), // required
308
311
  * // },
@@ -335,6 +338,27 @@ declare const DescribeEventCommand_base: {
335
338
  * // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
336
339
  * // },
337
340
  * // },
341
+ * // annotationCommand: { // TraceAnnotationCommand
342
+ * // annotation: { // Annotation
343
+ * // id: "STRING_VALUE", // required
344
+ * // time: Number("long"), // required
345
+ * // payload: { // AnnotationPayload Union: only one key present
346
+ * // tag: "STRING_VALUE",
347
+ * // text: "STRING_VALUE",
348
+ * // variables: { // AnnotationVariablesValue
349
+ * // value: "DOCUMENT_VALUE", // required
350
+ * // },
351
+ * // result: { // AnnotationResultValue
352
+ * // value: "DOCUMENT_VALUE", // required
353
+ * // },
354
+ * // },
355
+ * // source: { // AnnotationSource
356
+ * // type: "chatbot" || "voicebot" || "user" || "system", // required
357
+ * // id: "STRING_VALUE",
358
+ * // name: "STRING_VALUE",
359
+ * // },
360
+ * // },
361
+ * // },
338
362
  * // silenceTimeoutTask: { // TraceSilenceTimeoutTaskTrigger
339
363
  * // parameters: "DOCUMENT_VALUE",
340
364
  * // },
@@ -114,6 +114,7 @@ declare const GetTraceCommand_base: {
114
114
  * // type: "started" || "ended" || "reply" || "audio" || "playback" || "transcription" || "interruption" || "complete", // required
115
115
  * // id: "STRING_VALUE", // required
116
116
  * // text: "STRING_VALUE", // required
117
+ * // confidence: Number("double"),
117
118
  * // final: true || false,
118
119
  * // time: Number("long"), // required
119
120
  * // },
@@ -146,6 +147,27 @@ declare const GetTraceCommand_base: {
146
147
  * // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
147
148
  * // },
148
149
  * // },
150
+ * // annotationCommand: { // TraceAnnotationCommand
151
+ * // annotation: { // Annotation
152
+ * // id: "STRING_VALUE", // required
153
+ * // time: Number("long"), // required
154
+ * // payload: { // AnnotationPayload Union: only one key present
155
+ * // tag: "STRING_VALUE",
156
+ * // text: "STRING_VALUE",
157
+ * // variables: { // AnnotationVariablesValue
158
+ * // value: "DOCUMENT_VALUE", // required
159
+ * // },
160
+ * // result: { // AnnotationResultValue
161
+ * // value: "DOCUMENT_VALUE", // required
162
+ * // },
163
+ * // },
164
+ * // source: { // AnnotationSource
165
+ * // type: "chatbot" || "voicebot" || "user" || "system", // required
166
+ * // id: "STRING_VALUE",
167
+ * // name: "STRING_VALUE",
168
+ * // },
169
+ * // },
170
+ * // },
149
171
  * // silenceTimeoutTask: { // TraceSilenceTimeoutTaskTrigger
150
172
  * // parameters: "DOCUMENT_VALUE",
151
173
  * // },
@@ -96,6 +96,22 @@ declare const GetVoiceBotCommand_base: {
96
96
  * // type: "HANGUP" || "TRANSFER" || "DELEGATE" || "WAIT", // required
97
97
  * // name: "STRING_VALUE", // required
98
98
  * // parameters: "DOCUMENT_VALUE",
99
+ * // annotations: [ // VoiceBotToolAnnotationsList
100
+ * // { // VoiceBotToolAnnotation Union: only one key present
101
+ * // tag: { // VoiceBotToolTagAnnotation
102
+ * // value: "STRING_VALUE",
103
+ * // applyOnSuccess: true || false,
104
+ * // applyOnFailure: true || false,
105
+ * // },
106
+ * // comment: { // VoiceBotToolCommentAnnotation
107
+ * // value: "STRING_VALUE",
108
+ * // applyOnSuccess: true || false,
109
+ * // applyOnFailure: true || false,
110
+ * // },
111
+ * // variables: {},
112
+ * // result: {},
113
+ * // },
114
+ * // ],
99
115
  * // },
100
116
  * // ],
101
117
  * // tools: [ // VoiceBotToolsList
@@ -137,6 +153,22 @@ declare const GetVoiceBotCommand_base: {
137
153
  * // },
138
154
  * // },
139
155
  * // },
156
+ * // annotations: [
157
+ * // {// Union: only one key present
158
+ * // tag: {
159
+ * // value: "STRING_VALUE",
160
+ * // applyOnSuccess: true || false,
161
+ * // applyOnFailure: true || false,
162
+ * // },
163
+ * // comment: {
164
+ * // value: "STRING_VALUE",
165
+ * // applyOnSuccess: true || false,
166
+ * // applyOnFailure: true || false,
167
+ * // },
168
+ * // variables: {},
169
+ * // result: {},
170
+ * // },
171
+ * // ],
140
172
  * // },
141
173
  * // ],
142
174
  * // capabilities: [ // VoiceBotCapabilitiesList
@@ -162,10 +194,42 @@ declare const GetVoiceBotCommand_base: {
162
194
  * // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
163
195
  * // instructions: "STRING_VALUE",
164
196
  * // },
197
+ * // annotations: [
198
+ * // {// Union: only one key present
199
+ * // tag: {
200
+ * // value: "STRING_VALUE",
201
+ * // applyOnSuccess: true || false,
202
+ * // applyOnFailure: true || false,
203
+ * // },
204
+ * // comment: {
205
+ * // value: "STRING_VALUE",
206
+ * // applyOnSuccess: true || false,
207
+ * // applyOnFailure: true || false,
208
+ * // },
209
+ * // variables: {},
210
+ * // result: {},
211
+ * // },
212
+ * // ],
165
213
  * // },
166
214
  * // kb: { // VoiceBotKnowledgeBase
167
215
  * // knowledgeBaseId: "STRING_VALUE",
168
216
  * // instructions: "STRING_VALUE",
217
+ * // annotations: [
218
+ * // {// Union: only one key present
219
+ * // tag: {
220
+ * // value: "STRING_VALUE",
221
+ * // applyOnSuccess: true || false,
222
+ * // applyOnFailure: true || false,
223
+ * // },
224
+ * // comment: {
225
+ * // value: "STRING_VALUE",
226
+ * // applyOnSuccess: true || false,
227
+ * // applyOnFailure: true || false,
228
+ * // },
229
+ * // variables: {},
230
+ * // result: {},
231
+ * // },
232
+ * // ],
169
233
  * // },
170
234
  * // },
171
235
  * // ],
@@ -218,13 +282,16 @@ declare const GetVoiceBotCommand_base: {
218
282
  * // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
219
283
  * // instructions: "STRING_VALUE",
220
284
  * // },
285
+ * // annotations: "<VoiceBotToolAnnotationsList>",
221
286
  * // },
222
287
  * // kb: {
223
288
  * // knowledgeBaseId: "STRING_VALUE",
224
289
  * // instructions: "STRING_VALUE",
290
+ * // annotations: "<VoiceBotToolAnnotationsList>",
225
291
  * // },
226
292
  * // },
227
293
  * // ],
294
+ * // groupId: "STRING_VALUE",
228
295
  * // id: "STRING_VALUE", // required
229
296
  * // createdAt: "STRING_VALUE", // required
230
297
  * // updatedAt: "STRING_VALUE",
@@ -96,6 +96,22 @@ declare const ListVoiceBotsCommand_base: {
96
96
  * // type: "HANGUP" || "TRANSFER" || "DELEGATE" || "WAIT", // required
97
97
  * // name: "STRING_VALUE", // required
98
98
  * // parameters: "DOCUMENT_VALUE",
99
+ * // annotations: [ // VoiceBotToolAnnotationsList
100
+ * // { // VoiceBotToolAnnotation Union: only one key present
101
+ * // tag: { // VoiceBotToolTagAnnotation
102
+ * // value: "STRING_VALUE",
103
+ * // applyOnSuccess: true || false,
104
+ * // applyOnFailure: true || false,
105
+ * // },
106
+ * // comment: { // VoiceBotToolCommentAnnotation
107
+ * // value: "STRING_VALUE",
108
+ * // applyOnSuccess: true || false,
109
+ * // applyOnFailure: true || false,
110
+ * // },
111
+ * // variables: {},
112
+ * // result: {},
113
+ * // },
114
+ * // ],
99
115
  * // },
100
116
  * // ],
101
117
  * // tools: [ // VoiceBotToolsList
@@ -137,6 +153,22 @@ declare const ListVoiceBotsCommand_base: {
137
153
  * // },
138
154
  * // },
139
155
  * // },
156
+ * // annotations: [
157
+ * // {// Union: only one key present
158
+ * // tag: {
159
+ * // value: "STRING_VALUE",
160
+ * // applyOnSuccess: true || false,
161
+ * // applyOnFailure: true || false,
162
+ * // },
163
+ * // comment: {
164
+ * // value: "STRING_VALUE",
165
+ * // applyOnSuccess: true || false,
166
+ * // applyOnFailure: true || false,
167
+ * // },
168
+ * // variables: {},
169
+ * // result: {},
170
+ * // },
171
+ * // ],
140
172
  * // },
141
173
  * // ],
142
174
  * // capabilities: [ // VoiceBotCapabilitiesList
@@ -162,10 +194,42 @@ declare const ListVoiceBotsCommand_base: {
162
194
  * // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
163
195
  * // instructions: "STRING_VALUE",
164
196
  * // },
197
+ * // annotations: [
198
+ * // {// Union: only one key present
199
+ * // tag: {
200
+ * // value: "STRING_VALUE",
201
+ * // applyOnSuccess: true || false,
202
+ * // applyOnFailure: true || false,
203
+ * // },
204
+ * // comment: {
205
+ * // value: "STRING_VALUE",
206
+ * // applyOnSuccess: true || false,
207
+ * // applyOnFailure: true || false,
208
+ * // },
209
+ * // variables: {},
210
+ * // result: {},
211
+ * // },
212
+ * // ],
165
213
  * // },
166
214
  * // kb: { // VoiceBotKnowledgeBase
167
215
  * // knowledgeBaseId: "STRING_VALUE",
168
216
  * // instructions: "STRING_VALUE",
217
+ * // annotations: [
218
+ * // {// Union: only one key present
219
+ * // tag: {
220
+ * // value: "STRING_VALUE",
221
+ * // applyOnSuccess: true || false,
222
+ * // applyOnFailure: true || false,
223
+ * // },
224
+ * // comment: {
225
+ * // value: "STRING_VALUE",
226
+ * // applyOnSuccess: true || false,
227
+ * // applyOnFailure: true || false,
228
+ * // },
229
+ * // variables: {},
230
+ * // result: {},
231
+ * // },
232
+ * // ],
169
233
  * // },
170
234
  * // },
171
235
  * // ],
@@ -218,13 +282,16 @@ declare const ListVoiceBotsCommand_base: {
218
282
  * // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
219
283
  * // instructions: "STRING_VALUE",
220
284
  * // },
285
+ * // annotations: "<VoiceBotToolAnnotationsList>",
221
286
  * // },
222
287
  * // kb: {
223
288
  * // knowledgeBaseId: "STRING_VALUE",
224
289
  * // instructions: "STRING_VALUE",
290
+ * // annotations: "<VoiceBotToolAnnotationsList>",
225
291
  * // },
226
292
  * // },
227
293
  * // ],
294
+ * // groupId: "STRING_VALUE",
228
295
  * // id: "STRING_VALUE", // required
229
296
  * // createdAt: "STRING_VALUE", // required
230
297
  * // updatedAt: "STRING_VALUE",
@@ -89,6 +89,22 @@ declare const UpdateVoiceBotCommand_base: {
89
89
  * type: "HANGUP" || "TRANSFER" || "DELEGATE" || "WAIT", // required
90
90
  * name: "STRING_VALUE", // required
91
91
  * parameters: "DOCUMENT_VALUE",
92
+ * annotations: [ // VoiceBotToolAnnotationsList
93
+ * { // VoiceBotToolAnnotation Union: only one key present
94
+ * tag: { // VoiceBotToolTagAnnotation
95
+ * value: "STRING_VALUE",
96
+ * applyOnSuccess: true || false,
97
+ * applyOnFailure: true || false,
98
+ * },
99
+ * comment: { // VoiceBotToolCommentAnnotation
100
+ * value: "STRING_VALUE",
101
+ * applyOnSuccess: true || false,
102
+ * applyOnFailure: true || false,
103
+ * },
104
+ * variables: {},
105
+ * result: {},
106
+ * },
107
+ * ],
92
108
  * },
93
109
  * ],
94
110
  * tools: [ // VoiceBotToolsList
@@ -130,6 +146,22 @@ declare const UpdateVoiceBotCommand_base: {
130
146
  * },
131
147
  * },
132
148
  * },
149
+ * annotations: [
150
+ * {// Union: only one key present
151
+ * tag: {
152
+ * value: "STRING_VALUE",
153
+ * applyOnSuccess: true || false,
154
+ * applyOnFailure: true || false,
155
+ * },
156
+ * comment: {
157
+ * value: "STRING_VALUE",
158
+ * applyOnSuccess: true || false,
159
+ * applyOnFailure: true || false,
160
+ * },
161
+ * variables: {},
162
+ * result: {},
163
+ * },
164
+ * ],
133
165
  * },
134
166
  * ],
135
167
  * capabilities: [ // VoiceBotCapabilitiesList
@@ -155,10 +187,42 @@ declare const UpdateVoiceBotCommand_base: {
155
187
  * type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
156
188
  * instructions: "STRING_VALUE",
157
189
  * },
190
+ * annotations: [
191
+ * {// Union: only one key present
192
+ * tag: {
193
+ * value: "STRING_VALUE",
194
+ * applyOnSuccess: true || false,
195
+ * applyOnFailure: true || false,
196
+ * },
197
+ * comment: {
198
+ * value: "STRING_VALUE",
199
+ * applyOnSuccess: true || false,
200
+ * applyOnFailure: true || false,
201
+ * },
202
+ * variables: {},
203
+ * result: {},
204
+ * },
205
+ * ],
158
206
  * },
159
207
  * kb: { // VoiceBotKnowledgeBase
160
208
  * knowledgeBaseId: "STRING_VALUE",
161
209
  * instructions: "STRING_VALUE",
210
+ * annotations: [
211
+ * {// Union: only one key present
212
+ * tag: {
213
+ * value: "STRING_VALUE",
214
+ * applyOnSuccess: true || false,
215
+ * applyOnFailure: true || false,
216
+ * },
217
+ * comment: {
218
+ * value: "STRING_VALUE",
219
+ * applyOnSuccess: true || false,
220
+ * applyOnFailure: true || false,
221
+ * },
222
+ * variables: {},
223
+ * result: {},
224
+ * },
225
+ * ],
162
226
  * },
163
227
  * },
164
228
  * ],
@@ -211,13 +275,16 @@ declare const UpdateVoiceBotCommand_base: {
211
275
  * type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
212
276
  * instructions: "STRING_VALUE",
213
277
  * },
278
+ * annotations: "<VoiceBotToolAnnotationsList>",
214
279
  * },
215
280
  * kb: {
216
281
  * knowledgeBaseId: "STRING_VALUE",
217
282
  * instructions: "STRING_VALUE",
283
+ * annotations: "<VoiceBotToolAnnotationsList>",
218
284
  * },
219
285
  * },
220
286
  * ],
287
+ * groupId: "STRING_VALUE",
221
288
  * company: "STRING_VALUE",
222
289
  * botId: "STRING_VALUE", // required
223
290
  * };
@@ -279,6 +346,22 @@ declare const UpdateVoiceBotCommand_base: {
279
346
  * // type: "HANGUP" || "TRANSFER" || "DELEGATE" || "WAIT", // required
280
347
  * // name: "STRING_VALUE", // required
281
348
  * // parameters: "DOCUMENT_VALUE",
349
+ * // annotations: [ // VoiceBotToolAnnotationsList
350
+ * // { // VoiceBotToolAnnotation Union: only one key present
351
+ * // tag: { // VoiceBotToolTagAnnotation
352
+ * // value: "STRING_VALUE",
353
+ * // applyOnSuccess: true || false,
354
+ * // applyOnFailure: true || false,
355
+ * // },
356
+ * // comment: { // VoiceBotToolCommentAnnotation
357
+ * // value: "STRING_VALUE",
358
+ * // applyOnSuccess: true || false,
359
+ * // applyOnFailure: true || false,
360
+ * // },
361
+ * // variables: {},
362
+ * // result: {},
363
+ * // },
364
+ * // ],
282
365
  * // },
283
366
  * // ],
284
367
  * // tools: [ // VoiceBotToolsList
@@ -320,6 +403,22 @@ declare const UpdateVoiceBotCommand_base: {
320
403
  * // },
321
404
  * // },
322
405
  * // },
406
+ * // annotations: [
407
+ * // {// Union: only one key present
408
+ * // tag: {
409
+ * // value: "STRING_VALUE",
410
+ * // applyOnSuccess: true || false,
411
+ * // applyOnFailure: true || false,
412
+ * // },
413
+ * // comment: {
414
+ * // value: "STRING_VALUE",
415
+ * // applyOnSuccess: true || false,
416
+ * // applyOnFailure: true || false,
417
+ * // },
418
+ * // variables: {},
419
+ * // result: {},
420
+ * // },
421
+ * // ],
323
422
  * // },
324
423
  * // ],
325
424
  * // capabilities: [ // VoiceBotCapabilitiesList
@@ -345,10 +444,42 @@ declare const UpdateVoiceBotCommand_base: {
345
444
  * // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
346
445
  * // instructions: "STRING_VALUE",
347
446
  * // },
447
+ * // annotations: [
448
+ * // {// Union: only one key present
449
+ * // tag: {
450
+ * // value: "STRING_VALUE",
451
+ * // applyOnSuccess: true || false,
452
+ * // applyOnFailure: true || false,
453
+ * // },
454
+ * // comment: {
455
+ * // value: "STRING_VALUE",
456
+ * // applyOnSuccess: true || false,
457
+ * // applyOnFailure: true || false,
458
+ * // },
459
+ * // variables: {},
460
+ * // result: {},
461
+ * // },
462
+ * // ],
348
463
  * // },
349
464
  * // kb: { // VoiceBotKnowledgeBase
350
465
  * // knowledgeBaseId: "STRING_VALUE",
351
466
  * // instructions: "STRING_VALUE",
467
+ * // annotations: [
468
+ * // {// Union: only one key present
469
+ * // tag: {
470
+ * // value: "STRING_VALUE",
471
+ * // applyOnSuccess: true || false,
472
+ * // applyOnFailure: true || false,
473
+ * // },
474
+ * // comment: {
475
+ * // value: "STRING_VALUE",
476
+ * // applyOnSuccess: true || false,
477
+ * // applyOnFailure: true || false,
478
+ * // },
479
+ * // variables: {},
480
+ * // result: {},
481
+ * // },
482
+ * // ],
352
483
  * // },
353
484
  * // },
354
485
  * // ],
@@ -401,13 +532,16 @@ declare const UpdateVoiceBotCommand_base: {
401
532
  * // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
402
533
  * // instructions: "STRING_VALUE",
403
534
  * // },
535
+ * // annotations: "<VoiceBotToolAnnotationsList>",
404
536
  * // },
405
537
  * // kb: {
406
538
  * // knowledgeBaseId: "STRING_VALUE",
407
539
  * // instructions: "STRING_VALUE",
540
+ * // annotations: "<VoiceBotToolAnnotationsList>",
408
541
  * // },
409
542
  * // },
410
543
  * // ],
544
+ * // groupId: "STRING_VALUE",
411
545
  * // id: "STRING_VALUE", // required
412
546
  * // createdAt: "STRING_VALUE", // required
413
547
  * // updatedAt: "STRING_VALUE",