@wildix/wilma-agents-client 1.0.27 → 1.0.29
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/WilmaAgents.js +6 -0
- package/dist-cjs/commands/DeletePronunciationDictionaryCommand.js +20 -0
- package/dist-cjs/commands/ListPronunciationDictionariesCommand.js +20 -0
- package/dist-cjs/commands/PutPronunciationDictionaryCommand.js +20 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/models/enums.js +46 -7
- package/dist-cjs/schemas/schemas_0.js +333 -99
- package/dist-es/WilmaAgents.js +6 -0
- package/dist-es/commands/DeletePronunciationDictionaryCommand.js +16 -0
- package/dist-es/commands/ListPronunciationDictionariesCommand.js +16 -0
- package/dist-es/commands/PutPronunciationDictionaryCommand.js +16 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/enums.js +45 -6
- package/dist-es/schemas/schemas_0.js +329 -95
- package/dist-types/WilmaAgents.d.ts +25 -3
- package/dist-types/WilmaAgentsClient.d.ts +8 -5
- package/dist-types/commands/CreateAgentCommand.d.ts +286 -16
- package/dist-types/commands/DeletePronunciationDictionaryCommand.d.ts +82 -0
- package/dist-types/commands/GetAgentCommand.d.ts +143 -8
- package/dist-types/commands/GetAgentVersionCommand.d.ts +143 -8
- package/dist-types/commands/ListAgentsCommand.d.ts +144 -9
- package/dist-types/commands/ListAgentsNamesCommand.d.ts +18 -2
- package/dist-types/commands/ListPronunciationDictionariesCommand.d.ts +103 -0
- package/dist-types/commands/PublishAgentVersionCommand.d.ts +143 -8
- package/dist-types/commands/PutPronunciationDictionaryCommand.d.ts +117 -0
- package/dist-types/commands/RestoreAgentVersionToDraftCommand.d.ts +143 -8
- package/dist-types/commands/UpdateAgentCommand.d.ts +286 -16
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/index.d.ts +3 -3
- package/dist-types/models/enums.d.ts +159 -26
- package/dist-types/models/models_0.d.ts +913 -49
- package/dist-types/schemas/schemas_0.d.ts +29 -1
- package/package.json +2 -2
|
@@ -60,6 +60,61 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
60
60
|
* // channels: { // AgentChannels
|
|
61
61
|
* // voice: { // VoiceChannelSettings
|
|
62
62
|
* // greeting: "STRING_VALUE",
|
|
63
|
+
* // backgroundSound: "STRING_VALUE",
|
|
64
|
+
* // speech: { // VoiceSpeechSettings
|
|
65
|
+
* // provider: "elevenlabs" || "google" || "amazon_polly", // required
|
|
66
|
+
* // languages: [ // VoiceLanguageList // required
|
|
67
|
+
* // { // VoiceLanguage
|
|
68
|
+
* // code: "STRING_VALUE", // required
|
|
69
|
+
* // provider: "elevenlabs" || "google" || "amazon_polly",
|
|
70
|
+
* // voice: "STRING_VALUE", // required
|
|
71
|
+
* // greeting: "STRING_VALUE",
|
|
72
|
+
* // isDefault: true || false,
|
|
73
|
+
* // instructions: "STRING_VALUE",
|
|
74
|
+
* // synthesis: { // VoiceSynthesisOptions
|
|
75
|
+
* // model: "STRING_VALUE",
|
|
76
|
+
* // speed: Number("float"),
|
|
77
|
+
* // stability: Number("float"),
|
|
78
|
+
* // similarity: Number("float"),
|
|
79
|
+
* // style: Number("float"),
|
|
80
|
+
* // speakerBoost: true || false,
|
|
81
|
+
* // pitch: Number("float"),
|
|
82
|
+
* // volumeGain: Number("float"),
|
|
83
|
+
* // },
|
|
84
|
+
* // credential: { // SecretRef
|
|
85
|
+
* // id: "STRING_VALUE", // required
|
|
86
|
+
* // },
|
|
87
|
+
* // pronunciations: [ // VoicePronunciationList
|
|
88
|
+
* // { // VoicePronunciation
|
|
89
|
+
* // phrase: "STRING_VALUE", // required
|
|
90
|
+
* // as: "STRING_VALUE", // required
|
|
91
|
+
* // encoding: "alias" || "ipa",
|
|
92
|
+
* // },
|
|
93
|
+
* // ],
|
|
94
|
+
* // pronunciationSuppressions: [ // VoicePronunciationSuppressionList
|
|
95
|
+
* // "STRING_VALUE",
|
|
96
|
+
* // ],
|
|
97
|
+
* // },
|
|
98
|
+
* // ],
|
|
99
|
+
* // autoDetect: true || false,
|
|
100
|
+
* // greetEveryLanguage: true || false,
|
|
101
|
+
* // transcription: { // VoiceTranscriptionSettings
|
|
102
|
+
* // vendor: "aws",
|
|
103
|
+
* // },
|
|
104
|
+
* // synthesis: {
|
|
105
|
+
* // model: "STRING_VALUE",
|
|
106
|
+
* // speed: Number("float"),
|
|
107
|
+
* // stability: Number("float"),
|
|
108
|
+
* // similarity: Number("float"),
|
|
109
|
+
* // style: Number("float"),
|
|
110
|
+
* // speakerBoost: true || false,
|
|
111
|
+
* // pitch: Number("float"),
|
|
112
|
+
* // volumeGain: Number("float"),
|
|
113
|
+
* // },
|
|
114
|
+
* // credential: {
|
|
115
|
+
* // id: "STRING_VALUE", // required
|
|
116
|
+
* // },
|
|
117
|
+
* // },
|
|
63
118
|
* // interruptions: { // VoiceInterruptionSettings
|
|
64
119
|
* // enabled: true || false, // required
|
|
65
120
|
* // minWords: Number("int"),
|
|
@@ -109,8 +164,21 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
109
164
|
* // },
|
|
110
165
|
* // assistant: { // AssistantChannelSettings
|
|
111
166
|
* // default: true || false,
|
|
167
|
+
* // ui: { // AssistantUiSettings
|
|
168
|
+
* // welcome: { // AssistantWelcomeSettings
|
|
169
|
+
* // title: "STRING_VALUE",
|
|
170
|
+
* // subtitle: "STRING_VALUE",
|
|
171
|
+
* // },
|
|
172
|
+
* // commands: [ // AssistantQuickCommandsList
|
|
173
|
+
* // { // AssistantQuickCommand
|
|
174
|
+
* // title: "STRING_VALUE", // required
|
|
175
|
+
* // description: "STRING_VALUE",
|
|
176
|
+
* // prompt: "STRING_VALUE", // required
|
|
177
|
+
* // },
|
|
178
|
+
* // ],
|
|
179
|
+
* // placeholder: "STRING_VALUE",
|
|
180
|
+
* // },
|
|
112
181
|
* // },
|
|
113
|
-
* // workflow: {},
|
|
114
182
|
* // },
|
|
115
183
|
* // engine: { // AgentEngine Union: only one key present
|
|
116
184
|
* // ai: { // AgentAiEngine
|
|
@@ -121,7 +189,6 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
121
189
|
* // { // AgentWorkflowStep
|
|
122
190
|
* // id: "STRING_VALUE", // required
|
|
123
191
|
* // label: "STRING_VALUE", // required
|
|
124
|
-
* // summary: "STRING_VALUE",
|
|
125
192
|
* // stage: "STRING_VALUE",
|
|
126
193
|
* // handler: { // AgentWorkflowHandler Union: only one key present
|
|
127
194
|
* // conversation: { // AgentWorkflowConversationHandler
|
|
@@ -162,6 +229,9 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
162
229
|
* // approval: { // AgentToolApproval
|
|
163
230
|
* // prompt: "STRING_VALUE",
|
|
164
231
|
* // },
|
|
232
|
+
* // channels: [ // AgentCapabilityChannelsList
|
|
233
|
+
* // "voice" || "chat" || "assistant",
|
|
234
|
+
* // ],
|
|
165
235
|
* // annotations: [ // AgentToolAnnotationsList
|
|
166
236
|
* // { // AgentToolAnnotation Union: only one key present
|
|
167
237
|
* // tag: { // AgentToolTagAnnotation
|
|
@@ -189,6 +259,9 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
189
259
|
* // approval: {
|
|
190
260
|
* // prompt: "STRING_VALUE",
|
|
191
261
|
* // },
|
|
262
|
+
* // channels: [
|
|
263
|
+
* // "voice" || "chat" || "assistant",
|
|
264
|
+
* // ],
|
|
192
265
|
* // annotations: [
|
|
193
266
|
* // {// Union: only one key present
|
|
194
267
|
* // tag: {
|
|
@@ -209,6 +282,9 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
209
282
|
* // kb: { // AgentKnowledgeBase
|
|
210
283
|
* // knowledgeBaseId: "STRING_VALUE",
|
|
211
284
|
* // instructions: "STRING_VALUE",
|
|
285
|
+
* // channels: [
|
|
286
|
+
* // "voice" || "chat" || "assistant",
|
|
287
|
+
* // ],
|
|
212
288
|
* // annotations: [
|
|
213
289
|
* // {// Union: only one key present
|
|
214
290
|
* // tag: {
|
|
@@ -254,17 +330,23 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
254
330
|
* // city: "STRING_VALUE",
|
|
255
331
|
* // timezone: "STRING_VALUE",
|
|
256
332
|
* // },
|
|
333
|
+
* // channels: [
|
|
334
|
+
* // "voice" || "chat" || "assistant",
|
|
335
|
+
* // ],
|
|
257
336
|
* // },
|
|
258
337
|
* // webFetch: { // AgentWebFetchCapability
|
|
259
338
|
* // allowedDomains: [
|
|
260
339
|
* // "STRING_VALUE",
|
|
261
340
|
* // ],
|
|
341
|
+
* // channels: [
|
|
342
|
+
* // "voice" || "chat" || "assistant",
|
|
343
|
+
* // ],
|
|
262
344
|
* // },
|
|
263
345
|
* // agent: { // AgentCallCapability
|
|
264
346
|
* // agentId: "STRING_VALUE", // required
|
|
265
347
|
* // agentVersion: Number("int"),
|
|
266
348
|
* // access: { // AgentAccess
|
|
267
|
-
* // visibility: "explicit" || "organization",
|
|
349
|
+
* // visibility: "explicit" || "organization" || "public",
|
|
268
350
|
* // grants: [ // AgentGrantPrincipalList
|
|
269
351
|
* // { // AgentGrantPrincipal Union: only one key present
|
|
270
352
|
* // userId: "STRING_VALUE",
|
|
@@ -286,6 +368,7 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
286
368
|
* // },
|
|
287
369
|
* // },
|
|
288
370
|
* // ],
|
|
371
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
289
372
|
* // },
|
|
290
373
|
* // handover: { // AgentHandoverCapability
|
|
291
374
|
* // name: "STRING_VALUE",
|
|
@@ -299,6 +382,7 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
299
382
|
* // type: "handover" || "reply_and_handover" || "reply_instructed_and_handover",
|
|
300
383
|
* // instructions: "STRING_VALUE",
|
|
301
384
|
* // },
|
|
385
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
302
386
|
* // annotations: [
|
|
303
387
|
* // {// Union: only one key present
|
|
304
388
|
* // tag: {
|
|
@@ -321,6 +405,7 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
321
405
|
* // description: "STRING_VALUE",
|
|
322
406
|
* // id: "STRING_VALUE", // required
|
|
323
407
|
* // agentVersion: Number("int"),
|
|
408
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
324
409
|
* // annotations: [
|
|
325
410
|
* // {// Union: only one key present
|
|
326
411
|
* // tag: {
|
|
@@ -348,10 +433,12 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
348
433
|
* // type: "transfer" || "reply_and_transfer" || "reply_instructed_and_transfer",
|
|
349
434
|
* // instructions: "STRING_VALUE",
|
|
350
435
|
* // },
|
|
436
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
351
437
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
352
438
|
* // },
|
|
353
439
|
* // suggestions: { // AgentSuggestionsCapability
|
|
354
440
|
* // name: "STRING_VALUE",
|
|
441
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
355
442
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
356
443
|
* // },
|
|
357
444
|
* // hangup: { // AgentHangupCapability
|
|
@@ -361,12 +448,14 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
361
448
|
* // type: "hangup" || "reply_and_hangup" || "reply_instructed_and_hangup",
|
|
362
449
|
* // instructions: "STRING_VALUE",
|
|
363
450
|
* // },
|
|
451
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
364
452
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
365
453
|
* // },
|
|
366
454
|
* // wait: { // AgentWaitCapability
|
|
367
455
|
* // name: "STRING_VALUE",
|
|
368
456
|
* // description: "STRING_VALUE",
|
|
369
457
|
* // message: "STRING_VALUE",
|
|
458
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
370
459
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
371
460
|
* // },
|
|
372
461
|
* // },
|
|
@@ -431,6 +520,7 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
431
520
|
* // approval: {
|
|
432
521
|
* // prompt: "STRING_VALUE",
|
|
433
522
|
* // },
|
|
523
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
434
524
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
435
525
|
* // },
|
|
436
526
|
* // connector: {
|
|
@@ -443,13 +533,14 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
443
533
|
* // approval: {
|
|
444
534
|
* // prompt: "STRING_VALUE",
|
|
445
535
|
* // },
|
|
536
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
446
537
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
447
538
|
* // },
|
|
448
539
|
* // agent: {
|
|
449
540
|
* // agentId: "STRING_VALUE", // required
|
|
450
541
|
* // agentVersion: Number("int"),
|
|
451
542
|
* // access: {
|
|
452
|
-
* // visibility: "explicit" || "organization",
|
|
543
|
+
* // visibility: "explicit" || "organization" || "public",
|
|
453
544
|
* // grants: [
|
|
454
545
|
* // {// Union: only one key present
|
|
455
546
|
* // userId: "STRING_VALUE",
|
|
@@ -471,6 +562,7 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
471
562
|
* // },
|
|
472
563
|
* // },
|
|
473
564
|
* // ],
|
|
565
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
474
566
|
* // },
|
|
475
567
|
* // handover: {
|
|
476
568
|
* // name: "STRING_VALUE",
|
|
@@ -484,6 +576,7 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
484
576
|
* // type: "handover" || "reply_and_handover" || "reply_instructed_and_handover",
|
|
485
577
|
* // instructions: "STRING_VALUE",
|
|
486
578
|
* // },
|
|
579
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
487
580
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
488
581
|
* // },
|
|
489
582
|
* // delegation: {
|
|
@@ -491,6 +584,7 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
491
584
|
* // description: "STRING_VALUE",
|
|
492
585
|
* // id: "STRING_VALUE", // required
|
|
493
586
|
* // agentVersion: Number("int"),
|
|
587
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
494
588
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
495
589
|
* // },
|
|
496
590
|
* // transfer: {
|
|
@@ -503,6 +597,7 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
503
597
|
* // type: "transfer" || "reply_and_transfer" || "reply_instructed_and_transfer",
|
|
504
598
|
* // instructions: "STRING_VALUE",
|
|
505
599
|
* // },
|
|
600
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
506
601
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
507
602
|
* // },
|
|
508
603
|
* // hangup: {
|
|
@@ -512,12 +607,14 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
512
607
|
* // type: "hangup" || "reply_and_hangup" || "reply_instructed_and_hangup",
|
|
513
608
|
* // instructions: "STRING_VALUE",
|
|
514
609
|
* // },
|
|
610
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
515
611
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
516
612
|
* // },
|
|
517
613
|
* // wait: {
|
|
518
614
|
* // name: "STRING_VALUE",
|
|
519
615
|
* // description: "STRING_VALUE",
|
|
520
616
|
* // message: "STRING_VALUE",
|
|
617
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
521
618
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
522
619
|
* // },
|
|
523
620
|
* // },
|
|
@@ -578,7 +675,6 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
578
675
|
* // {
|
|
579
676
|
* // id: "STRING_VALUE", // required
|
|
580
677
|
* // label: "STRING_VALUE", // required
|
|
581
|
-
* // summary: "STRING_VALUE",
|
|
582
678
|
* // stage: "STRING_VALUE",
|
|
583
679
|
* // handler: {// Union: only one key present
|
|
584
680
|
* // conversation: {
|
|
@@ -596,6 +692,7 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
596
692
|
* // kb: {
|
|
597
693
|
* // knowledgeBaseId: "STRING_VALUE",
|
|
598
694
|
* // instructions: "STRING_VALUE",
|
|
695
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
599
696
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
600
697
|
* // },
|
|
601
698
|
* // sandbox: {// Union: only one key present
|
|
@@ -620,9 +717,11 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
620
717
|
* // city: "STRING_VALUE",
|
|
621
718
|
* // timezone: "STRING_VALUE",
|
|
622
719
|
* // },
|
|
720
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
623
721
|
* // },
|
|
624
722
|
* // webFetch: {
|
|
625
723
|
* // allowedDomains: "<DomainNameList>",
|
|
724
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
626
725
|
* // },
|
|
627
726
|
* // agent: "<AgentCallCapability>",
|
|
628
727
|
* // handover: "<AgentHandoverCapability>",
|
|
@@ -630,6 +729,7 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
630
729
|
* // transfer: "<AgentTransferCapability>",
|
|
631
730
|
* // suggestions: {
|
|
632
731
|
* // name: "STRING_VALUE",
|
|
732
|
+
* // channels: "<AgentCapabilityChannelsList>",
|
|
633
733
|
* // annotations: "<AgentToolAnnotationsList>",
|
|
634
734
|
* // },
|
|
635
735
|
* // hangup: "<AgentHangupCapability>",
|
|
@@ -738,6 +838,43 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
738
838
|
* // layout: "flow" || "compact" || "stages",
|
|
739
839
|
* // },
|
|
740
840
|
* // },
|
|
841
|
+
* // guardrails: { // AgentGuardrails
|
|
842
|
+
* // input: { // AgentGuardrailInput
|
|
843
|
+
* // checks: [ // AgentGuardrailChecksList
|
|
844
|
+
* // { // AgentGuardrailCheck
|
|
845
|
+
* // name: "STRING_VALUE", // required
|
|
846
|
+
* // description: "STRING_VALUE",
|
|
847
|
+
* // kind: { // AgentGuardrailCheckKind Union: only one key present
|
|
848
|
+
* // preset: { // AgentGuardrailPresetCheck
|
|
849
|
+
* // preset: "jailbreak" || "offTopic" || "abuse" || "harmful" || "selfHarm" || "pii" || "secrets" || "regulatedAdvice", // required
|
|
850
|
+
* // notes: "STRING_VALUE",
|
|
851
|
+
* // },
|
|
852
|
+
* // custom: { // AgentGuardrailCustomCheck
|
|
853
|
+
* // instructions: "STRING_VALUE", // required
|
|
854
|
+
* // examples: [ // AgentGuardrailExamplesList
|
|
855
|
+
* // "STRING_VALUE",
|
|
856
|
+
* // ],
|
|
857
|
+
* // },
|
|
858
|
+
* // },
|
|
859
|
+
* // sensitivity: "low" || "medium" || "high",
|
|
860
|
+
* // action: { // AgentGuardrailAction Union: only one key present
|
|
861
|
+
* // observe: {},
|
|
862
|
+
* // redact: {},
|
|
863
|
+
* // block: { // AgentGuardrailBlockAction
|
|
864
|
+
* // message: "STRING_VALUE",
|
|
865
|
+
* // },
|
|
866
|
+
* // end: { // AgentGuardrailEndAction
|
|
867
|
+
* // message: "STRING_VALUE",
|
|
868
|
+
* // },
|
|
869
|
+
* // },
|
|
870
|
+
* // },
|
|
871
|
+
* // ],
|
|
872
|
+
* // model: "STRING_VALUE",
|
|
873
|
+
* // mode: "blocking" || "parallel",
|
|
874
|
+
* // errorMode: "open" || "closed",
|
|
875
|
+
* // window: "lastMessage" || "lastWithPrior",
|
|
876
|
+
* // },
|
|
877
|
+
* // },
|
|
741
878
|
* // model: "STRING_VALUE",
|
|
742
879
|
* // timeZone: "STRING_VALUE",
|
|
743
880
|
* // artifacts: true || false,
|
|
@@ -766,9 +903,7 @@ declare const PublishAgentVersionCommand_base: {
|
|
|
766
903
|
* // sqs: { // AgentSqsEngine
|
|
767
904
|
* // url: "STRING_VALUE", // required
|
|
768
905
|
* // key: "STRING_VALUE", // required
|
|
769
|
-
* // secret:
|
|
770
|
-
* // id: "STRING_VALUE", // required
|
|
771
|
-
* // },
|
|
906
|
+
* // secret: "<SecretRef>", // required
|
|
772
907
|
* // },
|
|
773
908
|
* // },
|
|
774
909
|
* // settings: { // AgentSettings
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { PutPronunciationDictionaryInput, PutPronunciationDictionaryOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link PutPronunciationDictionaryCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PutPronunciationDictionaryCommandInput extends PutPronunciationDictionaryInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PutPronunciationDictionaryCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PutPronunciationDictionaryCommandOutput extends PutPronunciationDictionaryOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const PutPronunciationDictionaryCommand_base: {
|
|
25
|
+
new (input: PutPronunciationDictionaryCommandInput): import("@smithy/core/client").CommandImpl<PutPronunciationDictionaryCommandInput, PutPronunciationDictionaryCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: PutPronunciationDictionaryCommandInput): import("@smithy/core/client").CommandImpl<PutPronunciationDictionaryCommandInput, PutPronunciationDictionaryCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Creates or replaces the whole rule list for one language.
|
|
31
|
+
*
|
|
32
|
+
* REPLACE RATHER THAN PATCH: the editor holds the entire list anyway, and a patch protocol for
|
|
33
|
+
* an unordered set of rules buys nothing but a second way to be wrong.
|
|
34
|
+
*
|
|
35
|
+
* REFUSES when the result would push any agent's merged list past the 200-rule limit, naming
|
|
36
|
+
* the agents. The dictionary is shared, so a rule added here can overflow an agent nobody
|
|
37
|
+
* editing it is looking at; truncating silently would drop rules from a running agent with no
|
|
38
|
+
* signal anywhere.
|
|
39
|
+
*
|
|
40
|
+
* OPTIMISTIC LOCKING via `expectedUpdatedAt`, for the same reason the write is a replace: two
|
|
41
|
+
* administrators editing one company dictionary otherwise silently lose one of the two edits,
|
|
42
|
+
* and every agent speaking that language loses the missing rules on its next call. Absent means
|
|
43
|
+
* last-write-wins, exactly as before this member existed.
|
|
44
|
+
* @example
|
|
45
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
46
|
+
* ```javascript
|
|
47
|
+
* import { WilmaAgentsClient, PutPronunciationDictionaryCommand } from "@wildix/wilma-agents-client"; // ES Modules import
|
|
48
|
+
* // const { WilmaAgentsClient, PutPronunciationDictionaryCommand } = require("@wildix/wilma-agents-client"); // CommonJS import
|
|
49
|
+
* // import type { WilmaAgentsClientConfig } from "@wildix/wilma-agents-client";
|
|
50
|
+
* const config = {}; // type is WilmaAgentsClientConfig
|
|
51
|
+
* const client = new WilmaAgentsClient(config);
|
|
52
|
+
* const input = { // PutPronunciationDictionaryInput
|
|
53
|
+
* company: "STRING_VALUE",
|
|
54
|
+
* code: "STRING_VALUE", // required
|
|
55
|
+
* rules: [ // VoicePronunciationList // required
|
|
56
|
+
* { // VoicePronunciation
|
|
57
|
+
* phrase: "STRING_VALUE", // required
|
|
58
|
+
* as: "STRING_VALUE", // required
|
|
59
|
+
* encoding: "alias" || "ipa",
|
|
60
|
+
* },
|
|
61
|
+
* ],
|
|
62
|
+
* expectedUpdatedAt: "STRING_VALUE",
|
|
63
|
+
* };
|
|
64
|
+
* const command = new PutPronunciationDictionaryCommand(input);
|
|
65
|
+
* const response = await client.send(command);
|
|
66
|
+
* // { // PutPronunciationDictionaryOutput
|
|
67
|
+
* // dictionary: { // PronunciationDictionary
|
|
68
|
+
* // id: "STRING_VALUE", // required
|
|
69
|
+
* // code: "STRING_VALUE", // required
|
|
70
|
+
* // rules: [ // VoicePronunciationList // required
|
|
71
|
+
* // { // VoicePronunciation
|
|
72
|
+
* // phrase: "STRING_VALUE", // required
|
|
73
|
+
* // as: "STRING_VALUE", // required
|
|
74
|
+
* // encoding: "alias" || "ipa",
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
77
|
+
* // updatedAt: "STRING_VALUE", // required
|
|
78
|
+
* // updatedBy: { // Actor
|
|
79
|
+
* // type: "user" || "api_key" || "service", // required
|
|
80
|
+
* // id: "STRING_VALUE", // required
|
|
81
|
+
* // name: "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // },
|
|
84
|
+
* // };
|
|
85
|
+
*
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
88
|
+
* @param PutPronunciationDictionaryCommandInput - {@link PutPronunciationDictionaryCommandInput}
|
|
89
|
+
* @returns {@link PutPronunciationDictionaryCommandOutput}
|
|
90
|
+
* @see {@link PutPronunciationDictionaryCommandInput} for command's `input` shape.
|
|
91
|
+
* @see {@link PutPronunciationDictionaryCommandOutput} for command's `response` shape.
|
|
92
|
+
* @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link RevisionConflictException} (client fault)
|
|
95
|
+
* The resource was modified concurrently; re-read it and retry with the latest revision.
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link ValidationException} (client fault)
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link WilmaAgentsServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from WilmaAgents service.</p>
|
|
101
|
+
*
|
|
102
|
+
*
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export declare class PutPronunciationDictionaryCommand extends PutPronunciationDictionaryCommand_base {
|
|
106
|
+
/** @internal type navigation helper, not in runtime. */
|
|
107
|
+
protected static __types: {
|
|
108
|
+
api: {
|
|
109
|
+
input: PutPronunciationDictionaryInput;
|
|
110
|
+
output: PutPronunciationDictionaryOutput;
|
|
111
|
+
};
|
|
112
|
+
sdk: {
|
|
113
|
+
input: PutPronunciationDictionaryCommandInput;
|
|
114
|
+
output: PutPronunciationDictionaryCommandOutput;
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
}
|