@wildix/wilma-copilot-client 1.0.12 → 1.0.13

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,7 +44,280 @@ declare const GetProfileVersionCommand_base: {
44
44
  * const command = new GetProfileVersionCommand(input);
45
45
  * const response = await client.send(command);
46
46
  * // { // GetProfileVersionOutput
47
- * // version: Number("int"), // required
47
+ * // version: { // ProfileVersion
48
+ * // profileId: "STRING_VALUE", // required
49
+ * // version: Number("int"), // required
50
+ * // changelog: "STRING_VALUE",
51
+ * // definition: { // ProfileDefinitionSnapshot
52
+ * // name: "STRING_VALUE", // required
53
+ * // description: "STRING_VALUE",
54
+ * // channel: "calls" || "chats" || "any", // required
55
+ * // conditions: "DOCUMENT_VALUE",
56
+ * // access: { // CopilotAccess
57
+ * // visibility: "explicit" || "organization",
58
+ * // grants: [ // CopilotGrantPrincipalList
59
+ * // { // CopilotGrantPrincipal Union: only one key present
60
+ * // userId: "STRING_VALUE",
61
+ * // groupId: "STRING_VALUE",
62
+ * // },
63
+ * // ],
64
+ * // },
65
+ * // features: [ // CopilotFeaturesList
66
+ * // { // CopilotFeature Union: only one key present
67
+ * // csat: {},
68
+ * // sentiment: {},
69
+ * // talkRatio: {},
70
+ * // topics: {},
71
+ * // contextualKnowledgeAnswers: { // ContextualKnowledgeAnswersFeatureConfiguration
72
+ * // source: "knowledge_bases" || "agent", // required
73
+ * // knowledgeBaseIds: [ // KnowledgeBaseIdList
74
+ * // "STRING_VALUE",
75
+ * // ],
76
+ * // agentId: "STRING_VALUE",
77
+ * // mode: "suggest_action" || "automatic_answer", // required
78
+ * // },
79
+ * // },
80
+ * // ],
81
+ * // intents: [ // IntentSnapshotsList // required
82
+ * // { // IntentSnapshot
83
+ * // name: "STRING_VALUE", // required
84
+ * // description: "STRING_VALUE",
85
+ * // handlers: { // IntentHandlers
86
+ * // textMatch: { // IntentTextMatch
87
+ * // enabled: true || false, // required
88
+ * // options: [ // IntentTextMatchOptionsList
89
+ * // { // IntentTextMatchOption
90
+ * // id: "STRING_VALUE", // required
91
+ * // value: "STRING_VALUE", // required
92
+ * // mode: "exact" || "fuzzy" || "regex", // required
93
+ * // },
94
+ * // ],
95
+ * // },
96
+ * // aiMatch: { // IntentAiMatch
97
+ * // enabled: true || false, // required
98
+ * // instructions: "STRING_VALUE",
99
+ * // fields: [ // CopilotFieldsList
100
+ * // { // CopilotField
101
+ * // id: "STRING_VALUE", // required
102
+ * // name: "STRING_VALUE", // required
103
+ * // description: "STRING_VALUE",
104
+ * // optional: true || false,
105
+ * // parameter: { // CopilotFieldParameter Union: only one key present
106
+ * // text: { // CopilotTextParameter
107
+ * // examples: [ // StringList
108
+ * // "STRING_VALUE",
109
+ * // ],
110
+ * // },
111
+ * // multiline: { // CopilotMultilineParameter
112
+ * // examples: [
113
+ * // "STRING_VALUE",
114
+ * // ],
115
+ * // },
116
+ * // number: { // CopilotNumberParameter
117
+ * // min: Number("int"),
118
+ * // max: Number("int"),
119
+ * // },
120
+ * // selection: { // CopilotSelectionParameter
121
+ * // options: [ // required
122
+ * // "STRING_VALUE",
123
+ * // ],
124
+ * // multi: true || false,
125
+ * // adaptive: true || false,
126
+ * // adaptiveOptions: [
127
+ * // "STRING_VALUE",
128
+ * // ],
129
+ * // },
130
+ * // },
131
+ * // },
132
+ * // ],
133
+ * // },
134
+ * // },
135
+ * // conditions: "DOCUMENT_VALUE",
136
+ * // id: "STRING_VALUE", // required
137
+ * // },
138
+ * // ],
139
+ * // evaluations: [ // EvaluationSnapshotsList // required
140
+ * // { // EvaluationSnapshot
141
+ * // name: "STRING_VALUE", // required
142
+ * // description: "STRING_VALUE",
143
+ * // instructions: "STRING_VALUE", // required
144
+ * // fields: [
145
+ * // {
146
+ * // id: "STRING_VALUE", // required
147
+ * // name: "STRING_VALUE", // required
148
+ * // description: "STRING_VALUE",
149
+ * // optional: true || false,
150
+ * // parameter: {// Union: only one key present
151
+ * // text: {
152
+ * // examples: [
153
+ * // "STRING_VALUE",
154
+ * // ],
155
+ * // },
156
+ * // multiline: {
157
+ * // examples: "<StringList>",
158
+ * // },
159
+ * // number: {
160
+ * // min: Number("int"),
161
+ * // max: Number("int"),
162
+ * // },
163
+ * // selection: {
164
+ * // options: "<StringList>", // required
165
+ * // multi: true || false,
166
+ * // adaptive: true || false,
167
+ * // adaptiveOptions: "<StringList>",
168
+ * // },
169
+ * // },
170
+ * // },
171
+ * // ],
172
+ * // triggers: { // EvaluationTriggers
173
+ * // interval: { // EvaluationIntervalTrigger
174
+ * // enabled: true || false, // required
175
+ * // intervalSeconds: Number("int"),
176
+ * // },
177
+ * // customerEndSpeaking: true || false,
178
+ * // agentEndSpeaking: true || false,
179
+ * // immediatelyOncePerSession: true || false,
180
+ * // },
181
+ * // window: "new_transcript" || "new_with_prior" || "full_transcript", // required
182
+ * // model: "STRING_VALUE",
183
+ * // conditions: "DOCUMENT_VALUE",
184
+ * // id: "STRING_VALUE", // required
185
+ * // },
186
+ * // ],
187
+ * // automations: [ // AutomationSnapshotsList // required
188
+ * // { // AutomationSnapshot
189
+ * // name: "STRING_VALUE", // required
190
+ * // description: "STRING_VALUE",
191
+ * // handler: { // AutomationHandler Union: only one key present
192
+ * // agent: { // AgentAutomationHandler
193
+ * // agentId: "STRING_VALUE", // required
194
+ * // prompt: "STRING_VALUE",
195
+ * // outputMode: "card" || "silent",
196
+ * // parameters: [ // CopilotVariableBindingsList
197
+ * // { // CopilotVariableBinding
198
+ * // name: "STRING_VALUE", // required
199
+ * // type: "STRING_VALUE",
200
+ * // optional: true || false,
201
+ * // variant: "auto" || "guided" || "predefined", // required
202
+ * // description: "STRING_VALUE",
203
+ * // value: "STRING_VALUE",
204
+ * // },
205
+ * // ],
206
+ * // },
207
+ * // },
208
+ * // conditions: "DOCUMENT_VALUE",
209
+ * // id: "STRING_VALUE", // required
210
+ * // },
211
+ * // ],
212
+ * // assets: [ // AssetSnapshotsList // required
213
+ * // { // AssetSnapshot
214
+ * // key: "STRING_VALUE",
215
+ * // name: "STRING_VALUE", // required
216
+ * // description: "STRING_VALUE",
217
+ * // enabled: true || false,
218
+ * // title: "STRING_VALUE",
219
+ * // subtitle: "STRING_VALUE",
220
+ * // markdown: "STRING_VALUE",
221
+ * // footer: "STRING_VALUE",
222
+ * // severity: "neutral" || "success" || "warning" || "danger",
223
+ * // icon: "info" || "lightbulb" || "shield" || "book_open" || "alert" || "sparkles",
224
+ * // sticky: true || false,
225
+ * // content: { // AssetContent Union: only one key present
226
+ * // card: { // AssetCard
227
+ * // content: { // CardContent Union: only one key present
228
+ * // static: { // CardStaticContent
229
+ * // markdown: "STRING_VALUE",
230
+ * // },
231
+ * // agent: { // CardAgentContent
232
+ * // agentId: "STRING_VALUE", // required
233
+ * // variables: [
234
+ * // {
235
+ * // name: "STRING_VALUE", // required
236
+ * // type: "STRING_VALUE",
237
+ * // optional: true || false,
238
+ * // variant: "auto" || "guided" || "predefined", // required
239
+ * // description: "STRING_VALUE",
240
+ * // value: "STRING_VALUE",
241
+ * // },
242
+ * // ],
243
+ * // },
244
+ * // },
245
+ * // },
246
+ * // playbook: { // AssetPlaybook
247
+ * // goal: "STRING_VALUE",
248
+ * // steps: [ // PlaybookStepsList
249
+ * // { // PlaybookStep
250
+ * // id: "STRING_VALUE", // required
251
+ * // title: "STRING_VALUE", // required
252
+ * // markdown: "STRING_VALUE",
253
+ * // required: true || false,
254
+ * // autoComplete: true || false,
255
+ * // autoCompleteInstructions: "STRING_VALUE",
256
+ * // },
257
+ * // ],
258
+ * // completionCriteria: { // PlaybookCompletionCriteria Union: only one key present
259
+ * // manual: { // PlaybookManualCompletion
260
+ * // allowAgentMarkComplete: true || false, // required
261
+ * // },
262
+ * // semantic: { // PlaybookSemanticCompletion
263
+ * // description: "STRING_VALUE", // required
264
+ * // examples: "<StringList>",
265
+ * // },
266
+ * // },
267
+ * // },
268
+ * // smartAction: { // AssetSmartActions
269
+ * // actions: [ // SmartActionItemsList // required
270
+ * // { // SmartActionItem
271
+ * // id: "STRING_VALUE", // required
272
+ * // label: "STRING_VALUE", // required
273
+ * // description: "STRING_VALUE",
274
+ * // action: { // SmartAction Union: only one key present
275
+ * // openUrl: { // SmartActionOpenUrl
276
+ * // url: "STRING_VALUE", // required
277
+ * // openInNewTab: true || false,
278
+ * // },
279
+ * // runAgent: { // SmartActionRunAgent
280
+ * // agentId: "STRING_VALUE", // required
281
+ * // variables: "<CopilotVariableBindingsList>",
282
+ * // resultMode: "show_card" || "silent", // required
283
+ * // requireConfirmation: true || false,
284
+ * // },
285
+ * // runTool: { // SmartActionRunTool
286
+ * // toolId: "STRING_VALUE", // required
287
+ * // toolVersion: Number("int"),
288
+ * // variables: "<CopilotVariableBindingsList>",
289
+ * // resultMode: "show_card" || "silent", // required
290
+ * // requireConfirmation: true || false,
291
+ * // },
292
+ * // transfer: { // SmartActionTransfer
293
+ * // destination: "STRING_VALUE", // required
294
+ * // },
295
+ * // handover: { // SmartActionHandover
296
+ * // handoverVariant: "agent" || "service", // required
297
+ * // assignee: "STRING_VALUE",
298
+ * // service: "STRING_VALUE",
299
+ * // },
300
+ * // },
301
+ * // },
302
+ * // ],
303
+ * // },
304
+ * // knowledge: { // AssetKnowledge
305
+ * // summary: "STRING_VALUE",
306
+ * // sources: "STRING_VALUE",
307
+ * // },
308
+ * // },
309
+ * // conditions: "DOCUMENT_VALUE",
310
+ * // id: "STRING_VALUE", // required
311
+ * // },
312
+ * // ],
313
+ * // },
314
+ * // publishedAt: "STRING_VALUE", // required
315
+ * // publishedBy: { // Actor
316
+ * // type: "user" || "api_key" || "service", // required
317
+ * // id: "STRING_VALUE", // required
318
+ * // name: "STRING_VALUE",
319
+ * // },
320
+ * // },
48
321
  * // };
49
322
  *
50
323
  * ```
@@ -45,7 +45,280 @@ declare const PublishProfileVersionCommand_base: {
45
45
  * const command = new PublishProfileVersionCommand(input);
46
46
  * const response = await client.send(command);
47
47
  * // { // PublishProfileVersionOutput
48
- * // version: Number("int"), // required
48
+ * // version: { // ProfileVersion
49
+ * // profileId: "STRING_VALUE", // required
50
+ * // version: Number("int"), // required
51
+ * // changelog: "STRING_VALUE",
52
+ * // definition: { // ProfileDefinitionSnapshot
53
+ * // name: "STRING_VALUE", // required
54
+ * // description: "STRING_VALUE",
55
+ * // channel: "calls" || "chats" || "any", // required
56
+ * // conditions: "DOCUMENT_VALUE",
57
+ * // access: { // CopilotAccess
58
+ * // visibility: "explicit" || "organization",
59
+ * // grants: [ // CopilotGrantPrincipalList
60
+ * // { // CopilotGrantPrincipal Union: only one key present
61
+ * // userId: "STRING_VALUE",
62
+ * // groupId: "STRING_VALUE",
63
+ * // },
64
+ * // ],
65
+ * // },
66
+ * // features: [ // CopilotFeaturesList
67
+ * // { // CopilotFeature Union: only one key present
68
+ * // csat: {},
69
+ * // sentiment: {},
70
+ * // talkRatio: {},
71
+ * // topics: {},
72
+ * // contextualKnowledgeAnswers: { // ContextualKnowledgeAnswersFeatureConfiguration
73
+ * // source: "knowledge_bases" || "agent", // required
74
+ * // knowledgeBaseIds: [ // KnowledgeBaseIdList
75
+ * // "STRING_VALUE",
76
+ * // ],
77
+ * // agentId: "STRING_VALUE",
78
+ * // mode: "suggest_action" || "automatic_answer", // required
79
+ * // },
80
+ * // },
81
+ * // ],
82
+ * // intents: [ // IntentSnapshotsList // required
83
+ * // { // IntentSnapshot
84
+ * // name: "STRING_VALUE", // required
85
+ * // description: "STRING_VALUE",
86
+ * // handlers: { // IntentHandlers
87
+ * // textMatch: { // IntentTextMatch
88
+ * // enabled: true || false, // required
89
+ * // options: [ // IntentTextMatchOptionsList
90
+ * // { // IntentTextMatchOption
91
+ * // id: "STRING_VALUE", // required
92
+ * // value: "STRING_VALUE", // required
93
+ * // mode: "exact" || "fuzzy" || "regex", // required
94
+ * // },
95
+ * // ],
96
+ * // },
97
+ * // aiMatch: { // IntentAiMatch
98
+ * // enabled: true || false, // required
99
+ * // instructions: "STRING_VALUE",
100
+ * // fields: [ // CopilotFieldsList
101
+ * // { // CopilotField
102
+ * // id: "STRING_VALUE", // required
103
+ * // name: "STRING_VALUE", // required
104
+ * // description: "STRING_VALUE",
105
+ * // optional: true || false,
106
+ * // parameter: { // CopilotFieldParameter Union: only one key present
107
+ * // text: { // CopilotTextParameter
108
+ * // examples: [ // StringList
109
+ * // "STRING_VALUE",
110
+ * // ],
111
+ * // },
112
+ * // multiline: { // CopilotMultilineParameter
113
+ * // examples: [
114
+ * // "STRING_VALUE",
115
+ * // ],
116
+ * // },
117
+ * // number: { // CopilotNumberParameter
118
+ * // min: Number("int"),
119
+ * // max: Number("int"),
120
+ * // },
121
+ * // selection: { // CopilotSelectionParameter
122
+ * // options: [ // required
123
+ * // "STRING_VALUE",
124
+ * // ],
125
+ * // multi: true || false,
126
+ * // adaptive: true || false,
127
+ * // adaptiveOptions: [
128
+ * // "STRING_VALUE",
129
+ * // ],
130
+ * // },
131
+ * // },
132
+ * // },
133
+ * // ],
134
+ * // },
135
+ * // },
136
+ * // conditions: "DOCUMENT_VALUE",
137
+ * // id: "STRING_VALUE", // required
138
+ * // },
139
+ * // ],
140
+ * // evaluations: [ // EvaluationSnapshotsList // required
141
+ * // { // EvaluationSnapshot
142
+ * // name: "STRING_VALUE", // required
143
+ * // description: "STRING_VALUE",
144
+ * // instructions: "STRING_VALUE", // required
145
+ * // fields: [
146
+ * // {
147
+ * // id: "STRING_VALUE", // required
148
+ * // name: "STRING_VALUE", // required
149
+ * // description: "STRING_VALUE",
150
+ * // optional: true || false,
151
+ * // parameter: {// Union: only one key present
152
+ * // text: {
153
+ * // examples: [
154
+ * // "STRING_VALUE",
155
+ * // ],
156
+ * // },
157
+ * // multiline: {
158
+ * // examples: "<StringList>",
159
+ * // },
160
+ * // number: {
161
+ * // min: Number("int"),
162
+ * // max: Number("int"),
163
+ * // },
164
+ * // selection: {
165
+ * // options: "<StringList>", // required
166
+ * // multi: true || false,
167
+ * // adaptive: true || false,
168
+ * // adaptiveOptions: "<StringList>",
169
+ * // },
170
+ * // },
171
+ * // },
172
+ * // ],
173
+ * // triggers: { // EvaluationTriggers
174
+ * // interval: { // EvaluationIntervalTrigger
175
+ * // enabled: true || false, // required
176
+ * // intervalSeconds: Number("int"),
177
+ * // },
178
+ * // customerEndSpeaking: true || false,
179
+ * // agentEndSpeaking: true || false,
180
+ * // immediatelyOncePerSession: true || false,
181
+ * // },
182
+ * // window: "new_transcript" || "new_with_prior" || "full_transcript", // required
183
+ * // model: "STRING_VALUE",
184
+ * // conditions: "DOCUMENT_VALUE",
185
+ * // id: "STRING_VALUE", // required
186
+ * // },
187
+ * // ],
188
+ * // automations: [ // AutomationSnapshotsList // required
189
+ * // { // AutomationSnapshot
190
+ * // name: "STRING_VALUE", // required
191
+ * // description: "STRING_VALUE",
192
+ * // handler: { // AutomationHandler Union: only one key present
193
+ * // agent: { // AgentAutomationHandler
194
+ * // agentId: "STRING_VALUE", // required
195
+ * // prompt: "STRING_VALUE",
196
+ * // outputMode: "card" || "silent",
197
+ * // parameters: [ // CopilotVariableBindingsList
198
+ * // { // CopilotVariableBinding
199
+ * // name: "STRING_VALUE", // required
200
+ * // type: "STRING_VALUE",
201
+ * // optional: true || false,
202
+ * // variant: "auto" || "guided" || "predefined", // required
203
+ * // description: "STRING_VALUE",
204
+ * // value: "STRING_VALUE",
205
+ * // },
206
+ * // ],
207
+ * // },
208
+ * // },
209
+ * // conditions: "DOCUMENT_VALUE",
210
+ * // id: "STRING_VALUE", // required
211
+ * // },
212
+ * // ],
213
+ * // assets: [ // AssetSnapshotsList // required
214
+ * // { // AssetSnapshot
215
+ * // key: "STRING_VALUE",
216
+ * // name: "STRING_VALUE", // required
217
+ * // description: "STRING_VALUE",
218
+ * // enabled: true || false,
219
+ * // title: "STRING_VALUE",
220
+ * // subtitle: "STRING_VALUE",
221
+ * // markdown: "STRING_VALUE",
222
+ * // footer: "STRING_VALUE",
223
+ * // severity: "neutral" || "success" || "warning" || "danger",
224
+ * // icon: "info" || "lightbulb" || "shield" || "book_open" || "alert" || "sparkles",
225
+ * // sticky: true || false,
226
+ * // content: { // AssetContent Union: only one key present
227
+ * // card: { // AssetCard
228
+ * // content: { // CardContent Union: only one key present
229
+ * // static: { // CardStaticContent
230
+ * // markdown: "STRING_VALUE",
231
+ * // },
232
+ * // agent: { // CardAgentContent
233
+ * // agentId: "STRING_VALUE", // required
234
+ * // variables: [
235
+ * // {
236
+ * // name: "STRING_VALUE", // required
237
+ * // type: "STRING_VALUE",
238
+ * // optional: true || false,
239
+ * // variant: "auto" || "guided" || "predefined", // required
240
+ * // description: "STRING_VALUE",
241
+ * // value: "STRING_VALUE",
242
+ * // },
243
+ * // ],
244
+ * // },
245
+ * // },
246
+ * // },
247
+ * // playbook: { // AssetPlaybook
248
+ * // goal: "STRING_VALUE",
249
+ * // steps: [ // PlaybookStepsList
250
+ * // { // PlaybookStep
251
+ * // id: "STRING_VALUE", // required
252
+ * // title: "STRING_VALUE", // required
253
+ * // markdown: "STRING_VALUE",
254
+ * // required: true || false,
255
+ * // autoComplete: true || false,
256
+ * // autoCompleteInstructions: "STRING_VALUE",
257
+ * // },
258
+ * // ],
259
+ * // completionCriteria: { // PlaybookCompletionCriteria Union: only one key present
260
+ * // manual: { // PlaybookManualCompletion
261
+ * // allowAgentMarkComplete: true || false, // required
262
+ * // },
263
+ * // semantic: { // PlaybookSemanticCompletion
264
+ * // description: "STRING_VALUE", // required
265
+ * // examples: "<StringList>",
266
+ * // },
267
+ * // },
268
+ * // },
269
+ * // smartAction: { // AssetSmartActions
270
+ * // actions: [ // SmartActionItemsList // required
271
+ * // { // SmartActionItem
272
+ * // id: "STRING_VALUE", // required
273
+ * // label: "STRING_VALUE", // required
274
+ * // description: "STRING_VALUE",
275
+ * // action: { // SmartAction Union: only one key present
276
+ * // openUrl: { // SmartActionOpenUrl
277
+ * // url: "STRING_VALUE", // required
278
+ * // openInNewTab: true || false,
279
+ * // },
280
+ * // runAgent: { // SmartActionRunAgent
281
+ * // agentId: "STRING_VALUE", // required
282
+ * // variables: "<CopilotVariableBindingsList>",
283
+ * // resultMode: "show_card" || "silent", // required
284
+ * // requireConfirmation: true || false,
285
+ * // },
286
+ * // runTool: { // SmartActionRunTool
287
+ * // toolId: "STRING_VALUE", // required
288
+ * // toolVersion: Number("int"),
289
+ * // variables: "<CopilotVariableBindingsList>",
290
+ * // resultMode: "show_card" || "silent", // required
291
+ * // requireConfirmation: true || false,
292
+ * // },
293
+ * // transfer: { // SmartActionTransfer
294
+ * // destination: "STRING_VALUE", // required
295
+ * // },
296
+ * // handover: { // SmartActionHandover
297
+ * // handoverVariant: "agent" || "service", // required
298
+ * // assignee: "STRING_VALUE",
299
+ * // service: "STRING_VALUE",
300
+ * // },
301
+ * // },
302
+ * // },
303
+ * // ],
304
+ * // },
305
+ * // knowledge: { // AssetKnowledge
306
+ * // summary: "STRING_VALUE",
307
+ * // sources: "STRING_VALUE",
308
+ * // },
309
+ * // },
310
+ * // conditions: "DOCUMENT_VALUE",
311
+ * // id: "STRING_VALUE", // required
312
+ * // },
313
+ * // ],
314
+ * // },
315
+ * // publishedAt: "STRING_VALUE", // required
316
+ * // publishedBy: { // Actor
317
+ * // type: "user" || "api_key" || "service", // required
318
+ * // id: "STRING_VALUE", // required
319
+ * // name: "STRING_VALUE",
320
+ * // },
321
+ * // },
49
322
  * // };
50
323
  *
51
324
  * ```
@@ -121,6 +121,7 @@ declare const UpdateAssetCommand_base: {
121
121
  * },
122
122
  * runTool: { // SmartActionRunTool
123
123
  * toolId: "STRING_VALUE", // required
124
+ * toolVersion: Number("int"),
124
125
  * variables: [
125
126
  * {
126
127
  * name: "STRING_VALUE", // required
@@ -244,6 +245,7 @@ declare const UpdateAssetCommand_base: {
244
245
  * // },
245
246
  * // runTool: { // SmartActionRunTool
246
247
  * // toolId: "STRING_VALUE", // required
248
+ * // toolVersion: Number("int"),
247
249
  * // variables: [
248
250
  * // {
249
251
  * // name: "STRING_VALUE", // required