@wildix/wilma-copilot-client 1.0.2
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/WilmaCopilot.js +75 -0
- package/dist-cjs/WilmaCopilotClient.js +49 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +58 -0
- package/dist-cjs/commands/AttachProfileResourceCommand.js +20 -0
- package/dist-cjs/commands/CompareProfileVersionsCommand.js +20 -0
- package/dist-cjs/commands/CreateAssetCommand.js +20 -0
- package/dist-cjs/commands/CreateAutomationCommand.js +20 -0
- package/dist-cjs/commands/CreateEvaluationCommand.js +20 -0
- package/dist-cjs/commands/CreateIntentCommand.js +20 -0
- package/dist-cjs/commands/CreateProfileCommand.js +20 -0
- package/dist-cjs/commands/DeleteAssetCommand.js +20 -0
- package/dist-cjs/commands/DeleteAutomationCommand.js +20 -0
- package/dist-cjs/commands/DeleteEvaluationCommand.js +20 -0
- package/dist-cjs/commands/DeleteIntentCommand.js +20 -0
- package/dist-cjs/commands/DeleteProfileCommand.js +20 -0
- package/dist-cjs/commands/DeleteProfileResourceCommand.js +20 -0
- package/dist-cjs/commands/GetAssetCommand.js +20 -0
- package/dist-cjs/commands/GetAutomationCommand.js +20 -0
- package/dist-cjs/commands/GetEvaluationCommand.js +20 -0
- package/dist-cjs/commands/GetIntentCommand.js +20 -0
- package/dist-cjs/commands/GetProfileCommand.js +20 -0
- package/dist-cjs/commands/GetProfileVersionCommand.js +20 -0
- package/dist-cjs/commands/ListAssetsCommand.js +20 -0
- package/dist-cjs/commands/ListAutomationsCommand.js +20 -0
- package/dist-cjs/commands/ListEvaluationsCommand.js +20 -0
- package/dist-cjs/commands/ListIntentsCommand.js +20 -0
- package/dist-cjs/commands/ListProfileVersionsCommand.js +20 -0
- package/dist-cjs/commands/ListProfilesCommand.js +20 -0
- package/dist-cjs/commands/PublishProfileVersionCommand.js +20 -0
- package/dist-cjs/commands/RestoreProfileVersionToDraftCommand.js +20 -0
- package/dist-cjs/commands/UpdateAssetCommand.js +20 -0
- package/dist-cjs/commands/UpdateAutomationCommand.js +20 -0
- package/dist-cjs/commands/UpdateEvaluationCommand.js +20 -0
- package/dist-cjs/commands/UpdateIntentCommand.js +20 -0
- package/dist-cjs/commands/UpdateProfileCommand.js +20 -0
- package/dist-cjs/commands/index.js +35 -0
- package/dist-cjs/endpoint/EndpointParameters.js +16 -0
- package/dist-cjs/endpoint/bdd.js +28 -0
- package/dist-cjs/endpoint/endpointResolver.js +16 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +13 -0
- package/dist-cjs/models/WilmaCopilotServiceException.js +12 -0
- package/dist-cjs/models/enums.js +95 -0
- package/dist-cjs/models/errors.js +287 -0
- package/dist-cjs/models/models_0.js +2 -0
- package/dist-cjs/runtimeConfig.browser.js +32 -0
- package/dist-cjs/runtimeConfig.js +41 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +41 -0
- package/dist-cjs/runtimeExtensions.js +12 -0
- package/dist-cjs/schemas/schemas_0.js +1249 -0
- package/dist-es/WilmaCopilot.js +71 -0
- package/dist-es/WilmaCopilotClient.js +45 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +52 -0
- package/dist-es/commands/AttachProfileResourceCommand.js +16 -0
- package/dist-es/commands/CompareProfileVersionsCommand.js +16 -0
- package/dist-es/commands/CreateAssetCommand.js +16 -0
- package/dist-es/commands/CreateAutomationCommand.js +16 -0
- package/dist-es/commands/CreateEvaluationCommand.js +16 -0
- package/dist-es/commands/CreateIntentCommand.js +16 -0
- package/dist-es/commands/CreateProfileCommand.js +16 -0
- package/dist-es/commands/DeleteAssetCommand.js +16 -0
- package/dist-es/commands/DeleteAutomationCommand.js +16 -0
- package/dist-es/commands/DeleteEvaluationCommand.js +16 -0
- package/dist-es/commands/DeleteIntentCommand.js +16 -0
- package/dist-es/commands/DeleteProfileCommand.js +16 -0
- package/dist-es/commands/DeleteProfileResourceCommand.js +16 -0
- package/dist-es/commands/GetAssetCommand.js +16 -0
- package/dist-es/commands/GetAutomationCommand.js +16 -0
- package/dist-es/commands/GetEvaluationCommand.js +16 -0
- package/dist-es/commands/GetIntentCommand.js +16 -0
- package/dist-es/commands/GetProfileCommand.js +16 -0
- package/dist-es/commands/GetProfileVersionCommand.js +16 -0
- package/dist-es/commands/ListAssetsCommand.js +16 -0
- package/dist-es/commands/ListAutomationsCommand.js +16 -0
- package/dist-es/commands/ListEvaluationsCommand.js +16 -0
- package/dist-es/commands/ListIntentsCommand.js +16 -0
- package/dist-es/commands/ListProfileVersionsCommand.js +16 -0
- package/dist-es/commands/ListProfilesCommand.js +16 -0
- package/dist-es/commands/PublishProfileVersionCommand.js +16 -0
- package/dist-es/commands/RestoreProfileVersionToDraftCommand.js +16 -0
- package/dist-es/commands/UpdateAssetCommand.js +16 -0
- package/dist-es/commands/UpdateAutomationCommand.js +16 -0
- package/dist-es/commands/UpdateEvaluationCommand.js +16 -0
- package/dist-es/commands/UpdateIntentCommand.js +16 -0
- package/dist-es/commands/UpdateProfileCommand.js +16 -0
- package/dist-es/commands/index.js +32 -0
- package/dist-es/endpoint/EndpointParameters.js +12 -0
- package/dist-es/endpoint/bdd.js +25 -0
- package/dist-es/endpoint/endpointResolver.js +12 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +8 -0
- package/dist-es/models/WilmaCopilotServiceException.js +8 -0
- package/dist-es/models/enums.js +92 -0
- package/dist-es/models/errors.js +265 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/runtimeConfig.browser.js +27 -0
- package/dist-es/runtimeConfig.js +36 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +37 -0
- package/dist-es/runtimeExtensions.js +8 -0
- package/dist-es/schemas/schemas_0.js +1243 -0
- package/dist-types/WilmaCopilot.d.ts +254 -0
- package/dist-types/WilmaCopilotClient.d.ts +209 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +81 -0
- package/dist-types/commands/AttachProfileResourceCommand.d.ts +165 -0
- package/dist-types/commands/CompareProfileVersionsCommand.d.ts +91 -0
- package/dist-types/commands/CreateAssetCommand.d.ts +328 -0
- package/dist-types/commands/CreateAutomationCommand.d.ts +176 -0
- package/dist-types/commands/CreateEvaluationCommand.d.ts +196 -0
- package/dist-types/commands/CreateIntentCommand.d.ts +202 -0
- package/dist-types/commands/CreateProfileCommand.d.ts +181 -0
- package/dist-types/commands/DeleteAssetCommand.d.ts +83 -0
- package/dist-types/commands/DeleteAutomationCommand.d.ts +83 -0
- package/dist-types/commands/DeleteEvaluationCommand.d.ts +83 -0
- package/dist-types/commands/DeleteIntentCommand.d.ts +83 -0
- package/dist-types/commands/DeleteProfileCommand.d.ts +79 -0
- package/dist-types/commands/DeleteProfileResourceCommand.d.ts +147 -0
- package/dist-types/commands/GetAssetCommand.d.ts +213 -0
- package/dist-types/commands/GetAutomationCommand.d.ts +137 -0
- package/dist-types/commands/GetEvaluationCommand.d.ts +147 -0
- package/dist-types/commands/GetIntentCommand.d.ts +150 -0
- package/dist-types/commands/GetProfileCommand.d.ts +141 -0
- package/dist-types/commands/GetProfileVersionCommand.d.ts +82 -0
- package/dist-types/commands/ListAssetsCommand.d.ts +107 -0
- package/dist-types/commands/ListAutomationsCommand.d.ts +103 -0
- package/dist-types/commands/ListEvaluationsCommand.d.ts +104 -0
- package/dist-types/commands/ListIntentsCommand.d.ts +103 -0
- package/dist-types/commands/ListProfileVersionsCommand.d.ts +95 -0
- package/dist-types/commands/ListProfilesCommand.d.ts +110 -0
- package/dist-types/commands/PublishProfileVersionCommand.d.ts +87 -0
- package/dist-types/commands/RestoreProfileVersionToDraftCommand.d.ts +146 -0
- package/dist-types/commands/UpdateAssetCommand.d.ts +335 -0
- package/dist-types/commands/UpdateAutomationCommand.d.ts +183 -0
- package/dist-types/commands/UpdateEvaluationCommand.d.ts +203 -0
- package/dist-types/commands/UpdateIntentCommand.d.ts +209 -0
- package/dist-types/commands/UpdateProfileCommand.d.ts +160 -0
- package/dist-types/commands/index.d.ts +32 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +41 -0
- package/dist-types/endpoint/bdd.d.ts +2 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/index.d.ts +31 -0
- package/dist-types/models/WilmaCopilotServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +287 -0
- package/dist-types/models/errors.d.ts +239 -0
- package/dist-types/models/models_0.d.ts +2808 -0
- package/dist-types/runtimeConfig.browser.d.ts +55 -0
- package/dist-types/runtimeConfig.d.ts +55 -0
- package/dist-types/runtimeConfig.native.d.ts +54 -0
- package/dist-types/runtimeConfig.shared.d.ts +32 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +182 -0
- package/package.json +57 -0
|
@@ -0,0 +1,2808 @@
|
|
|
1
|
+
import type { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
+
import type { ActorType, AssetContentType, AssetIcon, AssetSeverity, AssetType, AutomationHandlerType, AutomationOutputMode, ContextualKnowledgeMode, ContextualKnowledgeSource, CopilotChannel, CopilotVariableMode, CopilotVisibility, EvaluationWindow, IntentTextMatchMode, ProfileResourceType, ProfileStatus, SmartActionHandoverVariant, SmartActionResultMode } from "./enums";
|
|
3
|
+
/**
|
|
4
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface Actor {
|
|
8
|
+
type: ActorType;
|
|
9
|
+
/**
|
|
10
|
+
* User id, API key id or service name, depending on the actor type.
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
id: string;
|
|
14
|
+
/**
|
|
15
|
+
* Human readable name of the actor at the time of the action.
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
name?: string | undefined;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Binds an input variable of an agent or tool invocation to a value or a fill strategy.
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
export interface CopilotVariableBinding {
|
|
25
|
+
name: string;
|
|
26
|
+
/**
|
|
27
|
+
* Declared value type, e.g. 'string' or 'number'.
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
type?: string | undefined;
|
|
31
|
+
optional?: boolean | undefined;
|
|
32
|
+
variant: CopilotVariableMode;
|
|
33
|
+
/**
|
|
34
|
+
* Guidance for the model when variant is `guided`.
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
description?: string | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* Fixed value when variant is `predefined`. Supports handlebars against the session state, e.g. '\{\{call.remotePhone\}\}'.
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
value?: string | undefined;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Runs a Wilma agent and optionally shows its generated content to the agent.
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
export interface AgentAutomationHandler {
|
|
49
|
+
agentId: string;
|
|
50
|
+
/**
|
|
51
|
+
* Prompt handed to the agent; the live conversation context is added automatically.
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
prompt?: string | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* Where the automation's result is delivered.
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
outputMode?: AutomationOutputMode | undefined;
|
|
60
|
+
parameters?: CopilotVariableBinding[] | undefined;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Card content generated on demand by an agent.
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export interface CardAgentContent {
|
|
67
|
+
agentId: string;
|
|
68
|
+
/**
|
|
69
|
+
* Variables passed to the agent when generating the card.
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
variables?: CopilotVariableBinding[] | undefined;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Static markdown card content.
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
export interface CardStaticContent {
|
|
79
|
+
markdown?: string | undefined;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* How a card's body is produced. Exactly one member is set.
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
export type CardContent = CardContent.AgentMember | CardContent.StaticMember | CardContent.$UnknownMember;
|
|
86
|
+
/**
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
export declare namespace CardContent {
|
|
90
|
+
/**
|
|
91
|
+
* Static markdown card content.
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
interface StaticMember {
|
|
95
|
+
static: CardStaticContent;
|
|
96
|
+
agent?: never;
|
|
97
|
+
$unknown?: never;
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Card content generated on demand by an agent.
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
interface AgentMember {
|
|
104
|
+
static?: never;
|
|
105
|
+
agent: CardAgentContent;
|
|
106
|
+
$unknown?: never;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
interface $UnknownMember {
|
|
112
|
+
static?: never;
|
|
113
|
+
agent?: never;
|
|
114
|
+
$unknown: [string, any];
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* @deprecated unused in schema-serde mode.
|
|
118
|
+
*
|
|
119
|
+
*/
|
|
120
|
+
interface Visitor<T> {
|
|
121
|
+
static: (value: CardStaticContent) => T;
|
|
122
|
+
agent: (value: CardAgentContent) => T;
|
|
123
|
+
_: (name: string, value: any) => T;
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* An informational card: title, markdown body and optional dynamic content.
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
export interface AssetCard {
|
|
131
|
+
/**
|
|
132
|
+
* How a card's body is produced. Exactly one member is set.
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
content?: CardContent | undefined;
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* A knowledge answer with its supporting sources.
|
|
139
|
+
* @public
|
|
140
|
+
*/
|
|
141
|
+
export interface AssetKnowledge {
|
|
142
|
+
summary?: string | undefined;
|
|
143
|
+
sources?: string | undefined;
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* The playbook is completed manually by the agent.
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
export interface PlaybookManualCompletion {
|
|
150
|
+
allowAgentMarkComplete: boolean;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* The playbook is completed automatically when the model judges its goal met.
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
export interface PlaybookSemanticCompletion {
|
|
157
|
+
description: string;
|
|
158
|
+
examples?: string[] | undefined;
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* How a playbook is judged complete. Exactly one member is set.
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
export type PlaybookCompletionCriteria = PlaybookCompletionCriteria.ManualMember | PlaybookCompletionCriteria.SemanticMember | PlaybookCompletionCriteria.$UnknownMember;
|
|
165
|
+
/**
|
|
166
|
+
* @public
|
|
167
|
+
*/
|
|
168
|
+
export declare namespace PlaybookCompletionCriteria {
|
|
169
|
+
/**
|
|
170
|
+
* The playbook is completed manually by the agent.
|
|
171
|
+
* @public
|
|
172
|
+
*/
|
|
173
|
+
interface ManualMember {
|
|
174
|
+
manual: PlaybookManualCompletion;
|
|
175
|
+
semantic?: never;
|
|
176
|
+
$unknown?: never;
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* The playbook is completed automatically when the model judges its goal met.
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
interface SemanticMember {
|
|
183
|
+
manual?: never;
|
|
184
|
+
semantic: PlaybookSemanticCompletion;
|
|
185
|
+
$unknown?: never;
|
|
186
|
+
}
|
|
187
|
+
/**
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
interface $UnknownMember {
|
|
191
|
+
manual?: never;
|
|
192
|
+
semantic?: never;
|
|
193
|
+
$unknown: [string, any];
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* @deprecated unused in schema-serde mode.
|
|
197
|
+
*
|
|
198
|
+
*/
|
|
199
|
+
interface Visitor<T> {
|
|
200
|
+
manual: (value: PlaybookManualCompletion) => T;
|
|
201
|
+
semantic: (value: PlaybookSemanticCompletion) => T;
|
|
202
|
+
_: (name: string, value: any) => T;
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
208
|
+
export interface PlaybookStep {
|
|
209
|
+
id: string;
|
|
210
|
+
title: string;
|
|
211
|
+
markdown?: string | undefined;
|
|
212
|
+
/**
|
|
213
|
+
* Whether the step must be completed.
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
required?: boolean | undefined;
|
|
217
|
+
/**
|
|
218
|
+
* Whether the system marks the step complete automatically from the transcript.
|
|
219
|
+
* @public
|
|
220
|
+
*/
|
|
221
|
+
autoComplete?: boolean | undefined;
|
|
222
|
+
/**
|
|
223
|
+
* Instructions the model follows to decide the step is complete, when autoComplete is set.
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
autoCompleteInstructions?: string | undefined;
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* A step-by-step playbook for the agent to follow.
|
|
230
|
+
* @public
|
|
231
|
+
*/
|
|
232
|
+
export interface AssetPlaybook {
|
|
233
|
+
goal?: string | undefined;
|
|
234
|
+
steps?: PlaybookStep[] | undefined;
|
|
235
|
+
/**
|
|
236
|
+
* How a playbook is judged complete. Exactly one member is set.
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
completionCriteria?: PlaybookCompletionCriteria | undefined;
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* Hands the live chat over to an agent or service. Chats only.
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
export interface SmartActionHandover {
|
|
246
|
+
/**
|
|
247
|
+
* Target of a chat handover smart action.
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
handoverVariant: SmartActionHandoverVariant;
|
|
251
|
+
/**
|
|
252
|
+
* Wilma agent to hand over to when handoverVariant is `agent`.
|
|
253
|
+
* @public
|
|
254
|
+
*/
|
|
255
|
+
assignee?: string | undefined;
|
|
256
|
+
/**
|
|
257
|
+
* x-bees service to hand over to when handoverVariant is `service`.
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
260
|
+
service?: string | undefined;
|
|
261
|
+
}
|
|
262
|
+
/**
|
|
263
|
+
* Opens a URL for the agent.
|
|
264
|
+
* @public
|
|
265
|
+
*/
|
|
266
|
+
export interface SmartActionOpenUrl {
|
|
267
|
+
url: string;
|
|
268
|
+
openInNewTab?: boolean | undefined;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* Runs a Wilma agent.
|
|
272
|
+
* @public
|
|
273
|
+
*/
|
|
274
|
+
export interface SmartActionRunAgent {
|
|
275
|
+
agentId: string;
|
|
276
|
+
variables?: CopilotVariableBinding[] | undefined;
|
|
277
|
+
/**
|
|
278
|
+
* Where a smart action's result is delivered.
|
|
279
|
+
* @public
|
|
280
|
+
*/
|
|
281
|
+
resultMode: SmartActionResultMode;
|
|
282
|
+
/**
|
|
283
|
+
* Ask the agent to confirm before running. Defaults to false.
|
|
284
|
+
* @public
|
|
285
|
+
*/
|
|
286
|
+
requireConfirmation?: boolean | undefined;
|
|
287
|
+
}
|
|
288
|
+
/**
|
|
289
|
+
* Runs a shared tool.
|
|
290
|
+
* @public
|
|
291
|
+
*/
|
|
292
|
+
export interface SmartActionRunTool {
|
|
293
|
+
/**
|
|
294
|
+
* Unique identifier of the tool using nanoid format
|
|
295
|
+
* @public
|
|
296
|
+
*/
|
|
297
|
+
toolId: string;
|
|
298
|
+
variables?: CopilotVariableBinding[] | undefined;
|
|
299
|
+
/**
|
|
300
|
+
* Where a smart action's result is delivered.
|
|
301
|
+
* @public
|
|
302
|
+
*/
|
|
303
|
+
resultMode: SmartActionResultMode;
|
|
304
|
+
requireConfirmation?: boolean | undefined;
|
|
305
|
+
}
|
|
306
|
+
/**
|
|
307
|
+
* Transfers the live call to a destination. Voice calls only.
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
export interface SmartActionTransfer {
|
|
311
|
+
/**
|
|
312
|
+
* Extension or phone number to transfer to.
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
destination: string;
|
|
316
|
+
}
|
|
317
|
+
/**
|
|
318
|
+
* A button shown under an asset. Exactly one member is set; it selects what happens when clicked.
|
|
319
|
+
* @public
|
|
320
|
+
*/
|
|
321
|
+
export type SmartAction = SmartAction.HandoverMember | SmartAction.OpenUrlMember | SmartAction.RunAgentMember | SmartAction.RunToolMember | SmartAction.TransferMember | SmartAction.$UnknownMember;
|
|
322
|
+
/**
|
|
323
|
+
* @public
|
|
324
|
+
*/
|
|
325
|
+
export declare namespace SmartAction {
|
|
326
|
+
/**
|
|
327
|
+
* Opens a URL for the agent.
|
|
328
|
+
* @public
|
|
329
|
+
*/
|
|
330
|
+
interface OpenUrlMember {
|
|
331
|
+
openUrl: SmartActionOpenUrl;
|
|
332
|
+
runAgent?: never;
|
|
333
|
+
runTool?: never;
|
|
334
|
+
transfer?: never;
|
|
335
|
+
handover?: never;
|
|
336
|
+
$unknown?: never;
|
|
337
|
+
}
|
|
338
|
+
/**
|
|
339
|
+
* Runs a Wilma agent.
|
|
340
|
+
* @public
|
|
341
|
+
*/
|
|
342
|
+
interface RunAgentMember {
|
|
343
|
+
openUrl?: never;
|
|
344
|
+
runAgent: SmartActionRunAgent;
|
|
345
|
+
runTool?: never;
|
|
346
|
+
transfer?: never;
|
|
347
|
+
handover?: never;
|
|
348
|
+
$unknown?: never;
|
|
349
|
+
}
|
|
350
|
+
/**
|
|
351
|
+
* Runs a shared tool.
|
|
352
|
+
* @public
|
|
353
|
+
*/
|
|
354
|
+
interface RunToolMember {
|
|
355
|
+
openUrl?: never;
|
|
356
|
+
runAgent?: never;
|
|
357
|
+
runTool: SmartActionRunTool;
|
|
358
|
+
transfer?: never;
|
|
359
|
+
handover?: never;
|
|
360
|
+
$unknown?: never;
|
|
361
|
+
}
|
|
362
|
+
/**
|
|
363
|
+
* Transfers the live call to a destination. Voice calls only.
|
|
364
|
+
* @public
|
|
365
|
+
*/
|
|
366
|
+
interface TransferMember {
|
|
367
|
+
openUrl?: never;
|
|
368
|
+
runAgent?: never;
|
|
369
|
+
runTool?: never;
|
|
370
|
+
transfer: SmartActionTransfer;
|
|
371
|
+
handover?: never;
|
|
372
|
+
$unknown?: never;
|
|
373
|
+
}
|
|
374
|
+
/**
|
|
375
|
+
* Hands the live chat over to an agent or service. Chats only.
|
|
376
|
+
* @public
|
|
377
|
+
*/
|
|
378
|
+
interface HandoverMember {
|
|
379
|
+
openUrl?: never;
|
|
380
|
+
runAgent?: never;
|
|
381
|
+
runTool?: never;
|
|
382
|
+
transfer?: never;
|
|
383
|
+
handover: SmartActionHandover;
|
|
384
|
+
$unknown?: never;
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
interface $UnknownMember {
|
|
390
|
+
openUrl?: never;
|
|
391
|
+
runAgent?: never;
|
|
392
|
+
runTool?: never;
|
|
393
|
+
transfer?: never;
|
|
394
|
+
handover?: never;
|
|
395
|
+
$unknown: [string, any];
|
|
396
|
+
}
|
|
397
|
+
/**
|
|
398
|
+
* @deprecated unused in schema-serde mode.
|
|
399
|
+
*
|
|
400
|
+
*/
|
|
401
|
+
interface Visitor<T> {
|
|
402
|
+
openUrl: (value: SmartActionOpenUrl) => T;
|
|
403
|
+
runAgent: (value: SmartActionRunAgent) => T;
|
|
404
|
+
runTool: (value: SmartActionRunTool) => T;
|
|
405
|
+
transfer: (value: SmartActionTransfer) => T;
|
|
406
|
+
handover: (value: SmartActionHandover) => T;
|
|
407
|
+
_: (name: string, value: any) => T;
|
|
408
|
+
}
|
|
409
|
+
}
|
|
410
|
+
/**
|
|
411
|
+
* A smart action with its label and payload.
|
|
412
|
+
* @public
|
|
413
|
+
*/
|
|
414
|
+
export interface SmartActionItem {
|
|
415
|
+
id: string;
|
|
416
|
+
label: string;
|
|
417
|
+
description?: string | undefined;
|
|
418
|
+
/**
|
|
419
|
+
* A button shown under an asset. Exactly one member is set; it selects what happens when clicked.
|
|
420
|
+
* @public
|
|
421
|
+
*/
|
|
422
|
+
action: SmartAction;
|
|
423
|
+
}
|
|
424
|
+
/**
|
|
425
|
+
* A set of one-click smart actions offered to the agent.
|
|
426
|
+
* @public
|
|
427
|
+
*/
|
|
428
|
+
export interface AssetSmartActions {
|
|
429
|
+
actions: SmartActionItem[];
|
|
430
|
+
}
|
|
431
|
+
/**
|
|
432
|
+
* The kind-specific payload of an asset. Exactly one member is set.
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
export type AssetContent = AssetContent.CardMember | AssetContent.KnowledgeMember | AssetContent.PlaybookMember | AssetContent.SmartActionMember | AssetContent.$UnknownMember;
|
|
436
|
+
/**
|
|
437
|
+
* @public
|
|
438
|
+
*/
|
|
439
|
+
export declare namespace AssetContent {
|
|
440
|
+
/**
|
|
441
|
+
* An informational card: title, markdown body and optional dynamic content.
|
|
442
|
+
* @public
|
|
443
|
+
*/
|
|
444
|
+
interface CardMember {
|
|
445
|
+
card: AssetCard;
|
|
446
|
+
playbook?: never;
|
|
447
|
+
smartAction?: never;
|
|
448
|
+
knowledge?: never;
|
|
449
|
+
$unknown?: never;
|
|
450
|
+
}
|
|
451
|
+
/**
|
|
452
|
+
* A step-by-step playbook for the agent to follow.
|
|
453
|
+
* @public
|
|
454
|
+
*/
|
|
455
|
+
interface PlaybookMember {
|
|
456
|
+
card?: never;
|
|
457
|
+
playbook: AssetPlaybook;
|
|
458
|
+
smartAction?: never;
|
|
459
|
+
knowledge?: never;
|
|
460
|
+
$unknown?: never;
|
|
461
|
+
}
|
|
462
|
+
/**
|
|
463
|
+
* A set of one-click smart actions offered to the agent.
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
466
|
+
interface SmartActionMember {
|
|
467
|
+
card?: never;
|
|
468
|
+
playbook?: never;
|
|
469
|
+
smartAction: AssetSmartActions;
|
|
470
|
+
knowledge?: never;
|
|
471
|
+
$unknown?: never;
|
|
472
|
+
}
|
|
473
|
+
/**
|
|
474
|
+
* A knowledge answer with its supporting sources.
|
|
475
|
+
* @public
|
|
476
|
+
*/
|
|
477
|
+
interface KnowledgeMember {
|
|
478
|
+
card?: never;
|
|
479
|
+
playbook?: never;
|
|
480
|
+
smartAction?: never;
|
|
481
|
+
knowledge: AssetKnowledge;
|
|
482
|
+
$unknown?: never;
|
|
483
|
+
}
|
|
484
|
+
/**
|
|
485
|
+
* @public
|
|
486
|
+
*/
|
|
487
|
+
interface $UnknownMember {
|
|
488
|
+
card?: never;
|
|
489
|
+
playbook?: never;
|
|
490
|
+
smartAction?: never;
|
|
491
|
+
knowledge?: never;
|
|
492
|
+
$unknown: [string, any];
|
|
493
|
+
}
|
|
494
|
+
/**
|
|
495
|
+
* @deprecated unused in schema-serde mode.
|
|
496
|
+
*
|
|
497
|
+
*/
|
|
498
|
+
interface Visitor<T> {
|
|
499
|
+
card: (value: AssetCard) => T;
|
|
500
|
+
playbook: (value: AssetPlaybook) => T;
|
|
501
|
+
smartAction: (value: AssetSmartActions) => T;
|
|
502
|
+
knowledge: (value: AssetKnowledge) => T;
|
|
503
|
+
_: (name: string, value: any) => T;
|
|
504
|
+
}
|
|
505
|
+
}
|
|
506
|
+
/**
|
|
507
|
+
* A reusable asset. Referenced by profiles via `assets`.
|
|
508
|
+
* @public
|
|
509
|
+
*/
|
|
510
|
+
export interface Asset {
|
|
511
|
+
/**
|
|
512
|
+
* Stable programmatic key referenced from suggestions and traces.
|
|
513
|
+
* @public
|
|
514
|
+
*/
|
|
515
|
+
key?: string | undefined;
|
|
516
|
+
name: string;
|
|
517
|
+
description?: string | undefined;
|
|
518
|
+
/**
|
|
519
|
+
* Whether the asset participates in matching. Defaults to true.
|
|
520
|
+
* @public
|
|
521
|
+
*/
|
|
522
|
+
enabled?: boolean | undefined;
|
|
523
|
+
/**
|
|
524
|
+
* Semantic classification of the asset, driving default presentation.
|
|
525
|
+
* @public
|
|
526
|
+
*/
|
|
527
|
+
type?: AssetType | undefined;
|
|
528
|
+
/**
|
|
529
|
+
* Card headline.
|
|
530
|
+
* @public
|
|
531
|
+
*/
|
|
532
|
+
title?: string | undefined;
|
|
533
|
+
subtitle?: string | undefined;
|
|
534
|
+
/**
|
|
535
|
+
* Markdown body shown on the card.
|
|
536
|
+
* @public
|
|
537
|
+
*/
|
|
538
|
+
markdown?: string | undefined;
|
|
539
|
+
footer?: string | undefined;
|
|
540
|
+
/**
|
|
541
|
+
* Visual emphasis of the asset card.
|
|
542
|
+
* @public
|
|
543
|
+
*/
|
|
544
|
+
severity?: AssetSeverity | undefined;
|
|
545
|
+
/**
|
|
546
|
+
* Icon shown on the asset card.
|
|
547
|
+
* @public
|
|
548
|
+
*/
|
|
549
|
+
icon?: AssetIcon | undefined;
|
|
550
|
+
/**
|
|
551
|
+
* Keep the asset pinned in the UI rather than dismissible.
|
|
552
|
+
* @public
|
|
553
|
+
*/
|
|
554
|
+
sticky?: boolean | undefined;
|
|
555
|
+
/**
|
|
556
|
+
* The kind-specific payload (card, playbook, smart actions or knowledge).
|
|
557
|
+
* @public
|
|
558
|
+
*/
|
|
559
|
+
content: AssetContent;
|
|
560
|
+
/**
|
|
561
|
+
* Conditions that show the asset. It is shown at most once per session when they first become true.
|
|
562
|
+
* @public
|
|
563
|
+
*/
|
|
564
|
+
conditions?: __DocumentType | undefined;
|
|
565
|
+
/**
|
|
566
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
567
|
+
* @public
|
|
568
|
+
*/
|
|
569
|
+
createdAt: string;
|
|
570
|
+
/**
|
|
571
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
572
|
+
* @public
|
|
573
|
+
*/
|
|
574
|
+
createdBy: Actor;
|
|
575
|
+
/**
|
|
576
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
577
|
+
* @public
|
|
578
|
+
*/
|
|
579
|
+
updatedAt?: string | undefined;
|
|
580
|
+
/**
|
|
581
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
582
|
+
* @public
|
|
583
|
+
*/
|
|
584
|
+
updatedBy?: Actor | undefined;
|
|
585
|
+
id: string;
|
|
586
|
+
/**
|
|
587
|
+
* Monotonic revision, incremented on every update. Pass it back on update for optimistic locking.
|
|
588
|
+
* @public
|
|
589
|
+
*/
|
|
590
|
+
revision: number;
|
|
591
|
+
/**
|
|
592
|
+
* Times shown over the trailing 30 days; null when not yet computed.
|
|
593
|
+
* @public
|
|
594
|
+
*/
|
|
595
|
+
usageLast30Days?: number | undefined;
|
|
596
|
+
}
|
|
597
|
+
/**
|
|
598
|
+
* Summary entry returned by ListAssets.
|
|
599
|
+
* @public
|
|
600
|
+
*/
|
|
601
|
+
export interface AssetInfo {
|
|
602
|
+
/**
|
|
603
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
604
|
+
* @public
|
|
605
|
+
*/
|
|
606
|
+
createdAt: string;
|
|
607
|
+
/**
|
|
608
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
609
|
+
* @public
|
|
610
|
+
*/
|
|
611
|
+
createdBy: Actor;
|
|
612
|
+
/**
|
|
613
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
updatedAt?: string | undefined;
|
|
617
|
+
/**
|
|
618
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
619
|
+
* @public
|
|
620
|
+
*/
|
|
621
|
+
updatedBy?: Actor | undefined;
|
|
622
|
+
id: string;
|
|
623
|
+
name: string;
|
|
624
|
+
description?: string | undefined;
|
|
625
|
+
enabled: boolean;
|
|
626
|
+
/**
|
|
627
|
+
* Semantic classification of the asset, driving default presentation.
|
|
628
|
+
* @public
|
|
629
|
+
*/
|
|
630
|
+
type?: AssetType | undefined;
|
|
631
|
+
/**
|
|
632
|
+
* Which kind of content an asset carries.
|
|
633
|
+
* @public
|
|
634
|
+
*/
|
|
635
|
+
contentType: AssetContentType;
|
|
636
|
+
/**
|
|
637
|
+
* Number of matches/executions over the trailing 30 days, or null when not yet computed.
|
|
638
|
+
* @public
|
|
639
|
+
*/
|
|
640
|
+
usageLast30Days?: number | undefined;
|
|
641
|
+
}
|
|
642
|
+
/**
|
|
643
|
+
* Configuration for the built-in contextual knowledge answers feature.
|
|
644
|
+
* @public
|
|
645
|
+
*/
|
|
646
|
+
export interface ContextualKnowledgeAnswersFeatureConfiguration {
|
|
647
|
+
/**
|
|
648
|
+
* Where contextual-knowledge answers are sourced from.
|
|
649
|
+
* @public
|
|
650
|
+
*/
|
|
651
|
+
source: ContextualKnowledgeSource;
|
|
652
|
+
/**
|
|
653
|
+
* Knowledge bases used when source is `knowledge_bases`.
|
|
654
|
+
* @public
|
|
655
|
+
*/
|
|
656
|
+
knowledgeBaseIds?: string[] | undefined;
|
|
657
|
+
/**
|
|
658
|
+
* Agent used when source is `agent`.
|
|
659
|
+
* @public
|
|
660
|
+
*/
|
|
661
|
+
agentId?: string | undefined;
|
|
662
|
+
/**
|
|
663
|
+
* How contextual-knowledge answers are surfaced.
|
|
664
|
+
* @public
|
|
665
|
+
*/
|
|
666
|
+
mode: ContextualKnowledgeMode;
|
|
667
|
+
}
|
|
668
|
+
/**
|
|
669
|
+
* Configuration for the built-in CSAT feature.
|
|
670
|
+
* @public
|
|
671
|
+
*/
|
|
672
|
+
export interface CsatFeatureConfiguration {
|
|
673
|
+
}
|
|
674
|
+
/**
|
|
675
|
+
* Configuration for the built-in sentiment feature.
|
|
676
|
+
* @public
|
|
677
|
+
*/
|
|
678
|
+
export interface SentimentFeatureConfiguration {
|
|
679
|
+
}
|
|
680
|
+
/**
|
|
681
|
+
* Configuration for the built-in talk ratio feature.
|
|
682
|
+
* @public
|
|
683
|
+
*/
|
|
684
|
+
export interface TalkRatioFeatureConfiguration {
|
|
685
|
+
}
|
|
686
|
+
/**
|
|
687
|
+
* Configuration for the built-in topics feature.
|
|
688
|
+
* @public
|
|
689
|
+
*/
|
|
690
|
+
export interface TopicsFeatureConfiguration {
|
|
691
|
+
}
|
|
692
|
+
/**
|
|
693
|
+
* A Copilot feature enabled for a profile, with its type-specific configuration.
|
|
694
|
+
* @public
|
|
695
|
+
*/
|
|
696
|
+
export type CopilotFeature = CopilotFeature.ContextualKnowledgeAnswersMember | CopilotFeature.CsatMember | CopilotFeature.SentimentMember | CopilotFeature.TalkRatioMember | CopilotFeature.TopicsMember | CopilotFeature.$UnknownMember;
|
|
697
|
+
/**
|
|
698
|
+
* @public
|
|
699
|
+
*/
|
|
700
|
+
export declare namespace CopilotFeature {
|
|
701
|
+
/**
|
|
702
|
+
* Configuration for the built-in CSAT feature.
|
|
703
|
+
* @public
|
|
704
|
+
*/
|
|
705
|
+
interface CsatMember {
|
|
706
|
+
csat: CsatFeatureConfiguration;
|
|
707
|
+
sentiment?: never;
|
|
708
|
+
talkRatio?: never;
|
|
709
|
+
topics?: never;
|
|
710
|
+
contextualKnowledgeAnswers?: never;
|
|
711
|
+
$unknown?: never;
|
|
712
|
+
}
|
|
713
|
+
/**
|
|
714
|
+
* Configuration for the built-in sentiment feature.
|
|
715
|
+
* @public
|
|
716
|
+
*/
|
|
717
|
+
interface SentimentMember {
|
|
718
|
+
csat?: never;
|
|
719
|
+
sentiment: SentimentFeatureConfiguration;
|
|
720
|
+
talkRatio?: never;
|
|
721
|
+
topics?: never;
|
|
722
|
+
contextualKnowledgeAnswers?: never;
|
|
723
|
+
$unknown?: never;
|
|
724
|
+
}
|
|
725
|
+
/**
|
|
726
|
+
* Configuration for the built-in talk ratio feature.
|
|
727
|
+
* @public
|
|
728
|
+
*/
|
|
729
|
+
interface TalkRatioMember {
|
|
730
|
+
csat?: never;
|
|
731
|
+
sentiment?: never;
|
|
732
|
+
talkRatio: TalkRatioFeatureConfiguration;
|
|
733
|
+
topics?: never;
|
|
734
|
+
contextualKnowledgeAnswers?: never;
|
|
735
|
+
$unknown?: never;
|
|
736
|
+
}
|
|
737
|
+
/**
|
|
738
|
+
* Configuration for the built-in topics feature.
|
|
739
|
+
* @public
|
|
740
|
+
*/
|
|
741
|
+
interface TopicsMember {
|
|
742
|
+
csat?: never;
|
|
743
|
+
sentiment?: never;
|
|
744
|
+
talkRatio?: never;
|
|
745
|
+
topics: TopicsFeatureConfiguration;
|
|
746
|
+
contextualKnowledgeAnswers?: never;
|
|
747
|
+
$unknown?: never;
|
|
748
|
+
}
|
|
749
|
+
/**
|
|
750
|
+
* Configuration for the built-in contextual knowledge answers feature.
|
|
751
|
+
* @public
|
|
752
|
+
*/
|
|
753
|
+
interface ContextualKnowledgeAnswersMember {
|
|
754
|
+
csat?: never;
|
|
755
|
+
sentiment?: never;
|
|
756
|
+
talkRatio?: never;
|
|
757
|
+
topics?: never;
|
|
758
|
+
contextualKnowledgeAnswers: ContextualKnowledgeAnswersFeatureConfiguration;
|
|
759
|
+
$unknown?: never;
|
|
760
|
+
}
|
|
761
|
+
/**
|
|
762
|
+
* @public
|
|
763
|
+
*/
|
|
764
|
+
interface $UnknownMember {
|
|
765
|
+
csat?: never;
|
|
766
|
+
sentiment?: never;
|
|
767
|
+
talkRatio?: never;
|
|
768
|
+
topics?: never;
|
|
769
|
+
contextualKnowledgeAnswers?: never;
|
|
770
|
+
$unknown: [string, any];
|
|
771
|
+
}
|
|
772
|
+
/**
|
|
773
|
+
* @deprecated unused in schema-serde mode.
|
|
774
|
+
*
|
|
775
|
+
*/
|
|
776
|
+
interface Visitor<T> {
|
|
777
|
+
csat: (value: CsatFeatureConfiguration) => T;
|
|
778
|
+
sentiment: (value: SentimentFeatureConfiguration) => T;
|
|
779
|
+
talkRatio: (value: TalkRatioFeatureConfiguration) => T;
|
|
780
|
+
topics: (value: TopicsFeatureConfiguration) => T;
|
|
781
|
+
contextualKnowledgeAnswers: (value: ContextualKnowledgeAnswersFeatureConfiguration) => T;
|
|
782
|
+
_: (name: string, value: any) => T;
|
|
783
|
+
}
|
|
784
|
+
}
|
|
785
|
+
/**
|
|
786
|
+
* One feature or reusable library resource attached to a profile.
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
export type ProfileResource = ProfileResource.AssetMember | ProfileResource.AutomationMember | ProfileResource.EvaluationMember | ProfileResource.FeatureMember | ProfileResource.IntentMember | ProfileResource.$UnknownMember;
|
|
790
|
+
/**
|
|
791
|
+
* @public
|
|
792
|
+
*/
|
|
793
|
+
export declare namespace ProfileResource {
|
|
794
|
+
/**
|
|
795
|
+
* A Copilot feature enabled for a profile, with its type-specific configuration.
|
|
796
|
+
* @public
|
|
797
|
+
*/
|
|
798
|
+
interface FeatureMember {
|
|
799
|
+
feature: CopilotFeature;
|
|
800
|
+
asset?: never;
|
|
801
|
+
automation?: never;
|
|
802
|
+
intent?: never;
|
|
803
|
+
evaluation?: never;
|
|
804
|
+
$unknown?: never;
|
|
805
|
+
}
|
|
806
|
+
interface AssetMember {
|
|
807
|
+
feature?: never;
|
|
808
|
+
asset: string;
|
|
809
|
+
automation?: never;
|
|
810
|
+
intent?: never;
|
|
811
|
+
evaluation?: never;
|
|
812
|
+
$unknown?: never;
|
|
813
|
+
}
|
|
814
|
+
interface AutomationMember {
|
|
815
|
+
feature?: never;
|
|
816
|
+
asset?: never;
|
|
817
|
+
automation: string;
|
|
818
|
+
intent?: never;
|
|
819
|
+
evaluation?: never;
|
|
820
|
+
$unknown?: never;
|
|
821
|
+
}
|
|
822
|
+
interface IntentMember {
|
|
823
|
+
feature?: never;
|
|
824
|
+
asset?: never;
|
|
825
|
+
automation?: never;
|
|
826
|
+
intent: string;
|
|
827
|
+
evaluation?: never;
|
|
828
|
+
$unknown?: never;
|
|
829
|
+
}
|
|
830
|
+
interface EvaluationMember {
|
|
831
|
+
feature?: never;
|
|
832
|
+
asset?: never;
|
|
833
|
+
automation?: never;
|
|
834
|
+
intent?: never;
|
|
835
|
+
evaluation: string;
|
|
836
|
+
$unknown?: never;
|
|
837
|
+
}
|
|
838
|
+
/**
|
|
839
|
+
* @public
|
|
840
|
+
*/
|
|
841
|
+
interface $UnknownMember {
|
|
842
|
+
feature?: never;
|
|
843
|
+
asset?: never;
|
|
844
|
+
automation?: never;
|
|
845
|
+
intent?: never;
|
|
846
|
+
evaluation?: never;
|
|
847
|
+
$unknown: [string, any];
|
|
848
|
+
}
|
|
849
|
+
/**
|
|
850
|
+
* @deprecated unused in schema-serde mode.
|
|
851
|
+
*
|
|
852
|
+
*/
|
|
853
|
+
interface Visitor<T> {
|
|
854
|
+
feature: (value: CopilotFeature) => T;
|
|
855
|
+
asset: (value: string) => T;
|
|
856
|
+
automation: (value: string) => T;
|
|
857
|
+
intent: (value: string) => T;
|
|
858
|
+
evaluation: (value: string) => T;
|
|
859
|
+
_: (name: string, value: any) => T;
|
|
860
|
+
}
|
|
861
|
+
}
|
|
862
|
+
/**
|
|
863
|
+
* @public
|
|
864
|
+
*/
|
|
865
|
+
export interface AttachProfileResourceInput {
|
|
866
|
+
company?: string | undefined;
|
|
867
|
+
profileId: string;
|
|
868
|
+
/**
|
|
869
|
+
* Draft revision this update is based on (optimistic locking).
|
|
870
|
+
* @public
|
|
871
|
+
*/
|
|
872
|
+
revision: number;
|
|
873
|
+
/**
|
|
874
|
+
* One feature or reusable library resource attached to a profile.
|
|
875
|
+
* @public
|
|
876
|
+
*/
|
|
877
|
+
resource: ProfileResource;
|
|
878
|
+
}
|
|
879
|
+
/**
|
|
880
|
+
* A user or group access is granted to.
|
|
881
|
+
* @public
|
|
882
|
+
*/
|
|
883
|
+
export type CopilotGrantPrincipal = CopilotGrantPrincipal.GroupIdMember | CopilotGrantPrincipal.UserIdMember | CopilotGrantPrincipal.$UnknownMember;
|
|
884
|
+
/**
|
|
885
|
+
* @public
|
|
886
|
+
*/
|
|
887
|
+
export declare namespace CopilotGrantPrincipal {
|
|
888
|
+
interface UserIdMember {
|
|
889
|
+
userId: string;
|
|
890
|
+
groupId?: never;
|
|
891
|
+
$unknown?: never;
|
|
892
|
+
}
|
|
893
|
+
interface GroupIdMember {
|
|
894
|
+
userId?: never;
|
|
895
|
+
groupId: string;
|
|
896
|
+
$unknown?: never;
|
|
897
|
+
}
|
|
898
|
+
/**
|
|
899
|
+
* @public
|
|
900
|
+
*/
|
|
901
|
+
interface $UnknownMember {
|
|
902
|
+
userId?: never;
|
|
903
|
+
groupId?: never;
|
|
904
|
+
$unknown: [string, any];
|
|
905
|
+
}
|
|
906
|
+
/**
|
|
907
|
+
* @deprecated unused in schema-serde mode.
|
|
908
|
+
*
|
|
909
|
+
*/
|
|
910
|
+
interface Visitor<T> {
|
|
911
|
+
userId: (value: string) => T;
|
|
912
|
+
groupId: (value: string) => T;
|
|
913
|
+
_: (name: string, value: any) => T;
|
|
914
|
+
}
|
|
915
|
+
}
|
|
916
|
+
/**
|
|
917
|
+
* Who the profile assists. There is no view/edit dimension — editing is gated by API auth scopes.
|
|
918
|
+
* @public
|
|
919
|
+
*/
|
|
920
|
+
export interface CopilotAccess {
|
|
921
|
+
/**
|
|
922
|
+
* Usage scope. Defaults to `organization`.
|
|
923
|
+
* @public
|
|
924
|
+
*/
|
|
925
|
+
visibility?: CopilotVisibility | undefined;
|
|
926
|
+
/**
|
|
927
|
+
* Users and groups assisted by the profile. Applies when visibility is `explicit`.
|
|
928
|
+
* @public
|
|
929
|
+
*/
|
|
930
|
+
grants?: CopilotGrantPrincipal[] | undefined;
|
|
931
|
+
}
|
|
932
|
+
/**
|
|
933
|
+
* The complete configuration of a profile, including draft lifecycle state. Referenced library resources are listed by id; a published version resolves them into an immutable snapshot.
|
|
934
|
+
* @public
|
|
935
|
+
*/
|
|
936
|
+
export interface Profile {
|
|
937
|
+
name: string;
|
|
938
|
+
description?: string | undefined;
|
|
939
|
+
/**
|
|
940
|
+
* The conversation surface a copilot resource applies to. `calls` targets voice calls, `chats` targets chat conversations, `any` targets both.
|
|
941
|
+
* @public
|
|
942
|
+
*/
|
|
943
|
+
channel: CopilotChannel;
|
|
944
|
+
/**
|
|
945
|
+
* Conditions under which the profile matches a conversation. An empty tree always matches.
|
|
946
|
+
* @public
|
|
947
|
+
*/
|
|
948
|
+
conditions?: __DocumentType | undefined;
|
|
949
|
+
/**
|
|
950
|
+
* Who the profile assists. Defaults to organization-wide.
|
|
951
|
+
* @public
|
|
952
|
+
*/
|
|
953
|
+
access?: CopilotAccess | undefined;
|
|
954
|
+
/**
|
|
955
|
+
* Copilot features enabled for this profile. Each list item is a typed feature and its configuration.
|
|
956
|
+
* @public
|
|
957
|
+
*/
|
|
958
|
+
features?: CopilotFeature[] | undefined;
|
|
959
|
+
/**
|
|
960
|
+
* Assets referenced by this profile.
|
|
961
|
+
* @public
|
|
962
|
+
*/
|
|
963
|
+
assets?: string[] | undefined;
|
|
964
|
+
/**
|
|
965
|
+
* Intents referenced by this profile.
|
|
966
|
+
* @public
|
|
967
|
+
*/
|
|
968
|
+
intents?: string[] | undefined;
|
|
969
|
+
/**
|
|
970
|
+
* Evaluations referenced by this profile.
|
|
971
|
+
* @public
|
|
972
|
+
*/
|
|
973
|
+
evaluations?: string[] | undefined;
|
|
974
|
+
/**
|
|
975
|
+
* Automations referenced by this profile.
|
|
976
|
+
* @public
|
|
977
|
+
*/
|
|
978
|
+
automations?: string[] | undefined;
|
|
979
|
+
/**
|
|
980
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
981
|
+
* @public
|
|
982
|
+
*/
|
|
983
|
+
createdAt: string;
|
|
984
|
+
/**
|
|
985
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
986
|
+
* @public
|
|
987
|
+
*/
|
|
988
|
+
createdBy: Actor;
|
|
989
|
+
/**
|
|
990
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
991
|
+
* @public
|
|
992
|
+
*/
|
|
993
|
+
updatedAt?: string | undefined;
|
|
994
|
+
/**
|
|
995
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
996
|
+
* @public
|
|
997
|
+
*/
|
|
998
|
+
updatedBy?: Actor | undefined;
|
|
999
|
+
id: string;
|
|
1000
|
+
status: ProfileStatus;
|
|
1001
|
+
/**
|
|
1002
|
+
* Monotonic revision of the draft, incremented on every update. Pass it back on update for optimistic locking.
|
|
1003
|
+
* @public
|
|
1004
|
+
*/
|
|
1005
|
+
revision: number;
|
|
1006
|
+
/**
|
|
1007
|
+
* Latest published version number; absent while the profile is still a draft.
|
|
1008
|
+
* @public
|
|
1009
|
+
*/
|
|
1010
|
+
latestVersion?: number | undefined;
|
|
1011
|
+
/**
|
|
1012
|
+
* Published version number the current draft originated from; absent before the first version is published.
|
|
1013
|
+
* @public
|
|
1014
|
+
*/
|
|
1015
|
+
draftBaseVersion?: number | undefined;
|
|
1016
|
+
/**
|
|
1017
|
+
* Whether the profile is currently applied to live conversations (its latest version is deployed).
|
|
1018
|
+
* @public
|
|
1019
|
+
*/
|
|
1020
|
+
live: boolean;
|
|
1021
|
+
}
|
|
1022
|
+
/**
|
|
1023
|
+
* @public
|
|
1024
|
+
*/
|
|
1025
|
+
export interface AttachProfileResourceOutput {
|
|
1026
|
+
/**
|
|
1027
|
+
* The complete configuration of a profile, including draft lifecycle state. Referenced library resources are listed by id; a published version resolves them into an immutable snapshot.
|
|
1028
|
+
* @public
|
|
1029
|
+
*/
|
|
1030
|
+
profile: Profile;
|
|
1031
|
+
}
|
|
1032
|
+
/**
|
|
1033
|
+
* Queries a knowledge base and shows the answer as a card.
|
|
1034
|
+
* @public
|
|
1035
|
+
*/
|
|
1036
|
+
export interface KnowledgeBaseAutomationHandler {
|
|
1037
|
+
/**
|
|
1038
|
+
* Id of a knowledge base referenced by copilot. Managed in the wim-knowledge-base service.
|
|
1039
|
+
* @public
|
|
1040
|
+
*/
|
|
1041
|
+
knowledgeBaseId: string;
|
|
1042
|
+
}
|
|
1043
|
+
/**
|
|
1044
|
+
* Invokes a shared tool.
|
|
1045
|
+
* @public
|
|
1046
|
+
*/
|
|
1047
|
+
export interface ToolAutomationHandler {
|
|
1048
|
+
/**
|
|
1049
|
+
* Id of a shared tool managed in the wim-tools service.
|
|
1050
|
+
* @public
|
|
1051
|
+
*/
|
|
1052
|
+
toolId?: string | undefined;
|
|
1053
|
+
/**
|
|
1054
|
+
* Human-readable tool name shown in the console.
|
|
1055
|
+
* @public
|
|
1056
|
+
*/
|
|
1057
|
+
toolName: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* Tool action/operation to invoke, when the tool exposes several.
|
|
1060
|
+
* @public
|
|
1061
|
+
*/
|
|
1062
|
+
action?: string | undefined;
|
|
1063
|
+
/**
|
|
1064
|
+
* Handlebars template for the tool payload, resolved against the session state.
|
|
1065
|
+
* @public
|
|
1066
|
+
*/
|
|
1067
|
+
payloadTemplate?: string | undefined;
|
|
1068
|
+
/**
|
|
1069
|
+
* Where the automation's result is delivered.
|
|
1070
|
+
* @public
|
|
1071
|
+
*/
|
|
1072
|
+
outputMode?: AutomationOutputMode | undefined;
|
|
1073
|
+
parameters?: CopilotVariableBinding[] | undefined;
|
|
1074
|
+
}
|
|
1075
|
+
/**
|
|
1076
|
+
* What the automation does when it fires. Exactly one member is set.
|
|
1077
|
+
* @public
|
|
1078
|
+
*/
|
|
1079
|
+
export type AutomationHandler = AutomationHandler.AgentMember | AutomationHandler.KnowledgeBaseMember | AutomationHandler.ToolMember | AutomationHandler.$UnknownMember;
|
|
1080
|
+
/**
|
|
1081
|
+
* @public
|
|
1082
|
+
*/
|
|
1083
|
+
export declare namespace AutomationHandler {
|
|
1084
|
+
/**
|
|
1085
|
+
* Runs a Wilma agent and optionally shows its generated content to the agent.
|
|
1086
|
+
* @public
|
|
1087
|
+
*/
|
|
1088
|
+
interface AgentMember {
|
|
1089
|
+
agent: AgentAutomationHandler;
|
|
1090
|
+
tool?: never;
|
|
1091
|
+
knowledgeBase?: never;
|
|
1092
|
+
$unknown?: never;
|
|
1093
|
+
}
|
|
1094
|
+
/**
|
|
1095
|
+
* Invokes a shared tool.
|
|
1096
|
+
* @public
|
|
1097
|
+
*/
|
|
1098
|
+
interface ToolMember {
|
|
1099
|
+
agent?: never;
|
|
1100
|
+
tool: ToolAutomationHandler;
|
|
1101
|
+
knowledgeBase?: never;
|
|
1102
|
+
$unknown?: never;
|
|
1103
|
+
}
|
|
1104
|
+
/**
|
|
1105
|
+
* Queries a knowledge base and shows the answer as a card.
|
|
1106
|
+
* @public
|
|
1107
|
+
*/
|
|
1108
|
+
interface KnowledgeBaseMember {
|
|
1109
|
+
agent?: never;
|
|
1110
|
+
tool?: never;
|
|
1111
|
+
knowledgeBase: KnowledgeBaseAutomationHandler;
|
|
1112
|
+
$unknown?: never;
|
|
1113
|
+
}
|
|
1114
|
+
/**
|
|
1115
|
+
* @public
|
|
1116
|
+
*/
|
|
1117
|
+
interface $UnknownMember {
|
|
1118
|
+
agent?: never;
|
|
1119
|
+
tool?: never;
|
|
1120
|
+
knowledgeBase?: never;
|
|
1121
|
+
$unknown: [string, any];
|
|
1122
|
+
}
|
|
1123
|
+
/**
|
|
1124
|
+
* @deprecated unused in schema-serde mode.
|
|
1125
|
+
*
|
|
1126
|
+
*/
|
|
1127
|
+
interface Visitor<T> {
|
|
1128
|
+
agent: (value: AgentAutomationHandler) => T;
|
|
1129
|
+
tool: (value: ToolAutomationHandler) => T;
|
|
1130
|
+
knowledgeBase: (value: KnowledgeBaseAutomationHandler) => T;
|
|
1131
|
+
_: (name: string, value: any) => T;
|
|
1132
|
+
}
|
|
1133
|
+
}
|
|
1134
|
+
/**
|
|
1135
|
+
* A reusable automation. Referenced by profiles via `automations`.
|
|
1136
|
+
* @public
|
|
1137
|
+
*/
|
|
1138
|
+
export interface Automation {
|
|
1139
|
+
name: string;
|
|
1140
|
+
description?: string | undefined;
|
|
1141
|
+
/**
|
|
1142
|
+
* What the automation does when it fires. Exactly one member is set.
|
|
1143
|
+
* @public
|
|
1144
|
+
*/
|
|
1145
|
+
handler: AutomationHandler;
|
|
1146
|
+
/**
|
|
1147
|
+
* Conditions that trigger the automation. It fires at most once per session when they first become true.
|
|
1148
|
+
* @public
|
|
1149
|
+
*/
|
|
1150
|
+
conditions?: __DocumentType | undefined;
|
|
1151
|
+
/**
|
|
1152
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1153
|
+
* @public
|
|
1154
|
+
*/
|
|
1155
|
+
createdAt: string;
|
|
1156
|
+
/**
|
|
1157
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
1158
|
+
* @public
|
|
1159
|
+
*/
|
|
1160
|
+
createdBy: Actor;
|
|
1161
|
+
/**
|
|
1162
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1163
|
+
* @public
|
|
1164
|
+
*/
|
|
1165
|
+
updatedAt?: string | undefined;
|
|
1166
|
+
/**
|
|
1167
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
1168
|
+
* @public
|
|
1169
|
+
*/
|
|
1170
|
+
updatedBy?: Actor | undefined;
|
|
1171
|
+
id: string;
|
|
1172
|
+
/**
|
|
1173
|
+
* Monotonic revision, incremented on every update. Pass it back on update for optimistic locking.
|
|
1174
|
+
* @public
|
|
1175
|
+
*/
|
|
1176
|
+
revision: number;
|
|
1177
|
+
/**
|
|
1178
|
+
* Executions over the trailing 30 days; null when not yet computed.
|
|
1179
|
+
* @public
|
|
1180
|
+
*/
|
|
1181
|
+
executionsLast30Days?: number | undefined;
|
|
1182
|
+
}
|
|
1183
|
+
/**
|
|
1184
|
+
* Summary entry returned by ListAutomations.
|
|
1185
|
+
* @public
|
|
1186
|
+
*/
|
|
1187
|
+
export interface AutomationInfo {
|
|
1188
|
+
/**
|
|
1189
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1190
|
+
* @public
|
|
1191
|
+
*/
|
|
1192
|
+
createdAt: string;
|
|
1193
|
+
/**
|
|
1194
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
1195
|
+
* @public
|
|
1196
|
+
*/
|
|
1197
|
+
createdBy: Actor;
|
|
1198
|
+
/**
|
|
1199
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1200
|
+
* @public
|
|
1201
|
+
*/
|
|
1202
|
+
updatedAt?: string | undefined;
|
|
1203
|
+
/**
|
|
1204
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
1205
|
+
* @public
|
|
1206
|
+
*/
|
|
1207
|
+
updatedBy?: Actor | undefined;
|
|
1208
|
+
id: string;
|
|
1209
|
+
name: string;
|
|
1210
|
+
description?: string | undefined;
|
|
1211
|
+
/**
|
|
1212
|
+
* Which kind of handler an automation uses.
|
|
1213
|
+
* @public
|
|
1214
|
+
*/
|
|
1215
|
+
handlerType: AutomationHandlerType;
|
|
1216
|
+
/**
|
|
1217
|
+
* Number of matches/executions over the trailing 30 days, or null when not yet computed.
|
|
1218
|
+
* @public
|
|
1219
|
+
*/
|
|
1220
|
+
executionsLast30Days?: number | undefined;
|
|
1221
|
+
}
|
|
1222
|
+
/**
|
|
1223
|
+
* @public
|
|
1224
|
+
*/
|
|
1225
|
+
export interface CompareProfileVersionsInput {
|
|
1226
|
+
company?: string | undefined;
|
|
1227
|
+
profileId: string;
|
|
1228
|
+
/**
|
|
1229
|
+
* Base published version number. Omit when fromDraft is true.
|
|
1230
|
+
* @public
|
|
1231
|
+
*/
|
|
1232
|
+
from?: number | undefined;
|
|
1233
|
+
/**
|
|
1234
|
+
* Compare against the current draft instead of a published version.
|
|
1235
|
+
* @public
|
|
1236
|
+
*/
|
|
1237
|
+
fromDraft?: boolean | undefined;
|
|
1238
|
+
/**
|
|
1239
|
+
* Target published version number. Omit when toDraft is true.
|
|
1240
|
+
* @public
|
|
1241
|
+
*/
|
|
1242
|
+
to?: number | undefined;
|
|
1243
|
+
/**
|
|
1244
|
+
* Compare against the current draft instead of a published version.
|
|
1245
|
+
* @public
|
|
1246
|
+
*/
|
|
1247
|
+
toDraft?: boolean | undefined;
|
|
1248
|
+
}
|
|
1249
|
+
/**
|
|
1250
|
+
* @public
|
|
1251
|
+
*/
|
|
1252
|
+
export interface ProfileVersionChange {
|
|
1253
|
+
/**
|
|
1254
|
+
* JSON pointer of the changed field within the profile definition, e.g. '/assets/0/markdown'.
|
|
1255
|
+
* @public
|
|
1256
|
+
*/
|
|
1257
|
+
path: string;
|
|
1258
|
+
/**
|
|
1259
|
+
* Value before the change (absent when the field was added).
|
|
1260
|
+
* @public
|
|
1261
|
+
*/
|
|
1262
|
+
before?: __DocumentType | undefined;
|
|
1263
|
+
/**
|
|
1264
|
+
* Value after the change (absent when the field was removed).
|
|
1265
|
+
* @public
|
|
1266
|
+
*/
|
|
1267
|
+
after?: __DocumentType | undefined;
|
|
1268
|
+
}
|
|
1269
|
+
/**
|
|
1270
|
+
* @public
|
|
1271
|
+
*/
|
|
1272
|
+
export interface CompareProfileVersionsOutput {
|
|
1273
|
+
changes: ProfileVersionChange[];
|
|
1274
|
+
}
|
|
1275
|
+
/**
|
|
1276
|
+
* Free-form multi-line text value.
|
|
1277
|
+
* @public
|
|
1278
|
+
*/
|
|
1279
|
+
export interface CopilotMultilineParameter {
|
|
1280
|
+
examples?: string[] | undefined;
|
|
1281
|
+
}
|
|
1282
|
+
/**
|
|
1283
|
+
* Numeric value with optional bounds.
|
|
1284
|
+
* @public
|
|
1285
|
+
*/
|
|
1286
|
+
export interface CopilotNumberParameter {
|
|
1287
|
+
min?: number | undefined;
|
|
1288
|
+
max?: number | undefined;
|
|
1289
|
+
}
|
|
1290
|
+
/**
|
|
1291
|
+
* Value chosen from a fixed (or AI-extended) set of options.
|
|
1292
|
+
* @public
|
|
1293
|
+
*/
|
|
1294
|
+
export interface CopilotSelectionParameter {
|
|
1295
|
+
/**
|
|
1296
|
+
* The allowed options.
|
|
1297
|
+
* @public
|
|
1298
|
+
*/
|
|
1299
|
+
options: string[];
|
|
1300
|
+
/**
|
|
1301
|
+
* Whether more than one option may be selected.
|
|
1302
|
+
* @public
|
|
1303
|
+
*/
|
|
1304
|
+
multi?: boolean | undefined;
|
|
1305
|
+
/**
|
|
1306
|
+
* Whether the model may introduce new options beyond `options`.
|
|
1307
|
+
* @public
|
|
1308
|
+
*/
|
|
1309
|
+
adaptive?: boolean | undefined;
|
|
1310
|
+
/**
|
|
1311
|
+
* Options the model introduced when `adaptive` is enabled.
|
|
1312
|
+
* @public
|
|
1313
|
+
*/
|
|
1314
|
+
adaptiveOptions?: string[] | undefined;
|
|
1315
|
+
}
|
|
1316
|
+
/**
|
|
1317
|
+
* Free-form single-line text value.
|
|
1318
|
+
* @public
|
|
1319
|
+
*/
|
|
1320
|
+
export interface CopilotTextParameter {
|
|
1321
|
+
/**
|
|
1322
|
+
* Example values that steer extraction.
|
|
1323
|
+
* @public
|
|
1324
|
+
*/
|
|
1325
|
+
examples?: string[] | undefined;
|
|
1326
|
+
}
|
|
1327
|
+
/**
|
|
1328
|
+
* The value shape of a field. Exactly one member is set; the member selects how the model extracts and validates the value.
|
|
1329
|
+
* @public
|
|
1330
|
+
*/
|
|
1331
|
+
export type CopilotFieldParameter = CopilotFieldParameter.MultilineMember | CopilotFieldParameter.NumberMember | CopilotFieldParameter.SelectionMember | CopilotFieldParameter.TextMember | CopilotFieldParameter.$UnknownMember;
|
|
1332
|
+
/**
|
|
1333
|
+
* @public
|
|
1334
|
+
*/
|
|
1335
|
+
export declare namespace CopilotFieldParameter {
|
|
1336
|
+
/**
|
|
1337
|
+
* Free-form single-line text value.
|
|
1338
|
+
* @public
|
|
1339
|
+
*/
|
|
1340
|
+
interface TextMember {
|
|
1341
|
+
text: CopilotTextParameter;
|
|
1342
|
+
multiline?: never;
|
|
1343
|
+
number?: never;
|
|
1344
|
+
selection?: never;
|
|
1345
|
+
$unknown?: never;
|
|
1346
|
+
}
|
|
1347
|
+
/**
|
|
1348
|
+
* Free-form multi-line text value.
|
|
1349
|
+
* @public
|
|
1350
|
+
*/
|
|
1351
|
+
interface MultilineMember {
|
|
1352
|
+
text?: never;
|
|
1353
|
+
multiline: CopilotMultilineParameter;
|
|
1354
|
+
number?: never;
|
|
1355
|
+
selection?: never;
|
|
1356
|
+
$unknown?: never;
|
|
1357
|
+
}
|
|
1358
|
+
/**
|
|
1359
|
+
* Numeric value with optional bounds.
|
|
1360
|
+
* @public
|
|
1361
|
+
*/
|
|
1362
|
+
interface NumberMember {
|
|
1363
|
+
text?: never;
|
|
1364
|
+
multiline?: never;
|
|
1365
|
+
number: CopilotNumberParameter;
|
|
1366
|
+
selection?: never;
|
|
1367
|
+
$unknown?: never;
|
|
1368
|
+
}
|
|
1369
|
+
/**
|
|
1370
|
+
* Value chosen from a fixed (or AI-extended) set of options.
|
|
1371
|
+
* @public
|
|
1372
|
+
*/
|
|
1373
|
+
interface SelectionMember {
|
|
1374
|
+
text?: never;
|
|
1375
|
+
multiline?: never;
|
|
1376
|
+
number?: never;
|
|
1377
|
+
selection: CopilotSelectionParameter;
|
|
1378
|
+
$unknown?: never;
|
|
1379
|
+
}
|
|
1380
|
+
/**
|
|
1381
|
+
* @public
|
|
1382
|
+
*/
|
|
1383
|
+
interface $UnknownMember {
|
|
1384
|
+
text?: never;
|
|
1385
|
+
multiline?: never;
|
|
1386
|
+
number?: never;
|
|
1387
|
+
selection?: never;
|
|
1388
|
+
$unknown: [string, any];
|
|
1389
|
+
}
|
|
1390
|
+
/**
|
|
1391
|
+
* @deprecated unused in schema-serde mode.
|
|
1392
|
+
*
|
|
1393
|
+
*/
|
|
1394
|
+
interface Visitor<T> {
|
|
1395
|
+
text: (value: CopilotTextParameter) => T;
|
|
1396
|
+
multiline: (value: CopilotMultilineParameter) => T;
|
|
1397
|
+
number: (value: CopilotNumberParameter) => T;
|
|
1398
|
+
selection: (value: CopilotSelectionParameter) => T;
|
|
1399
|
+
_: (name: string, value: any) => T;
|
|
1400
|
+
}
|
|
1401
|
+
}
|
|
1402
|
+
/**
|
|
1403
|
+
* A named value the model extracts from the transcript, shared by intent AI matching and evaluations.
|
|
1404
|
+
* @public
|
|
1405
|
+
*/
|
|
1406
|
+
export interface CopilotField {
|
|
1407
|
+
id: string;
|
|
1408
|
+
name: string;
|
|
1409
|
+
description?: string | undefined;
|
|
1410
|
+
/**
|
|
1411
|
+
* Whether the model may leave this field unset. Defaults to true.
|
|
1412
|
+
* @public
|
|
1413
|
+
*/
|
|
1414
|
+
optional?: boolean | undefined;
|
|
1415
|
+
/**
|
|
1416
|
+
* The value shape of a field. Exactly one member is set; the member selects how the model extracts and validates the value.
|
|
1417
|
+
* @public
|
|
1418
|
+
*/
|
|
1419
|
+
parameter: CopilotFieldParameter;
|
|
1420
|
+
}
|
|
1421
|
+
/**
|
|
1422
|
+
* The editable definition of an asset.
|
|
1423
|
+
* @public
|
|
1424
|
+
*/
|
|
1425
|
+
export interface CreateAssetInput {
|
|
1426
|
+
/**
|
|
1427
|
+
* Stable programmatic key referenced from suggestions and traces.
|
|
1428
|
+
* @public
|
|
1429
|
+
*/
|
|
1430
|
+
key?: string | undefined;
|
|
1431
|
+
name: string;
|
|
1432
|
+
description?: string | undefined;
|
|
1433
|
+
/**
|
|
1434
|
+
* Whether the asset participates in matching. Defaults to true.
|
|
1435
|
+
* @public
|
|
1436
|
+
*/
|
|
1437
|
+
enabled?: boolean | undefined;
|
|
1438
|
+
/**
|
|
1439
|
+
* Semantic classification of the asset, driving default presentation.
|
|
1440
|
+
* @public
|
|
1441
|
+
*/
|
|
1442
|
+
type?: AssetType | undefined;
|
|
1443
|
+
/**
|
|
1444
|
+
* Card headline.
|
|
1445
|
+
* @public
|
|
1446
|
+
*/
|
|
1447
|
+
title?: string | undefined;
|
|
1448
|
+
subtitle?: string | undefined;
|
|
1449
|
+
/**
|
|
1450
|
+
* Markdown body shown on the card.
|
|
1451
|
+
* @public
|
|
1452
|
+
*/
|
|
1453
|
+
markdown?: string | undefined;
|
|
1454
|
+
footer?: string | undefined;
|
|
1455
|
+
/**
|
|
1456
|
+
* Visual emphasis of the asset card.
|
|
1457
|
+
* @public
|
|
1458
|
+
*/
|
|
1459
|
+
severity?: AssetSeverity | undefined;
|
|
1460
|
+
/**
|
|
1461
|
+
* Icon shown on the asset card.
|
|
1462
|
+
* @public
|
|
1463
|
+
*/
|
|
1464
|
+
icon?: AssetIcon | undefined;
|
|
1465
|
+
/**
|
|
1466
|
+
* Keep the asset pinned in the UI rather than dismissible.
|
|
1467
|
+
* @public
|
|
1468
|
+
*/
|
|
1469
|
+
sticky?: boolean | undefined;
|
|
1470
|
+
/**
|
|
1471
|
+
* The kind-specific payload (card, playbook, smart actions or knowledge).
|
|
1472
|
+
* @public
|
|
1473
|
+
*/
|
|
1474
|
+
content: AssetContent;
|
|
1475
|
+
/**
|
|
1476
|
+
* Conditions that show the asset. It is shown at most once per session when they first become true.
|
|
1477
|
+
* @public
|
|
1478
|
+
*/
|
|
1479
|
+
conditions?: __DocumentType | undefined;
|
|
1480
|
+
company?: string | undefined;
|
|
1481
|
+
}
|
|
1482
|
+
/**
|
|
1483
|
+
* @public
|
|
1484
|
+
*/
|
|
1485
|
+
export interface CreateAssetOutput {
|
|
1486
|
+
/**
|
|
1487
|
+
* A reusable asset. Referenced by profiles via `assets`.
|
|
1488
|
+
* @public
|
|
1489
|
+
*/
|
|
1490
|
+
asset: Asset;
|
|
1491
|
+
}
|
|
1492
|
+
/**
|
|
1493
|
+
* The editable definition of an automation.
|
|
1494
|
+
* @public
|
|
1495
|
+
*/
|
|
1496
|
+
export interface CreateAutomationInput {
|
|
1497
|
+
name: string;
|
|
1498
|
+
description?: string | undefined;
|
|
1499
|
+
/**
|
|
1500
|
+
* What the automation does when it fires. Exactly one member is set.
|
|
1501
|
+
* @public
|
|
1502
|
+
*/
|
|
1503
|
+
handler: AutomationHandler;
|
|
1504
|
+
/**
|
|
1505
|
+
* Conditions that trigger the automation. It fires at most once per session when they first become true.
|
|
1506
|
+
* @public
|
|
1507
|
+
*/
|
|
1508
|
+
conditions?: __DocumentType | undefined;
|
|
1509
|
+
company?: string | undefined;
|
|
1510
|
+
}
|
|
1511
|
+
/**
|
|
1512
|
+
* @public
|
|
1513
|
+
*/
|
|
1514
|
+
export interface CreateAutomationOutput {
|
|
1515
|
+
/**
|
|
1516
|
+
* A reusable automation. Referenced by profiles via `automations`.
|
|
1517
|
+
* @public
|
|
1518
|
+
*/
|
|
1519
|
+
automation: Automation;
|
|
1520
|
+
}
|
|
1521
|
+
/**
|
|
1522
|
+
* Re-run the evaluation on a fixed interval.
|
|
1523
|
+
* @public
|
|
1524
|
+
*/
|
|
1525
|
+
export interface EvaluationIntervalTrigger {
|
|
1526
|
+
enabled: boolean;
|
|
1527
|
+
/**
|
|
1528
|
+
* Seconds between runs. Allowed values: 5, 10, 20, 30, 45, 60, 90, 120, 180, 300.
|
|
1529
|
+
* @public
|
|
1530
|
+
*/
|
|
1531
|
+
intervalSeconds?: number | undefined;
|
|
1532
|
+
}
|
|
1533
|
+
/**
|
|
1534
|
+
* When an evaluation is re-run during a session. Multiple triggers may be enabled.
|
|
1535
|
+
* @public
|
|
1536
|
+
*/
|
|
1537
|
+
export interface EvaluationTriggers {
|
|
1538
|
+
/**
|
|
1539
|
+
* Re-run the evaluation on a fixed interval.
|
|
1540
|
+
* @public
|
|
1541
|
+
*/
|
|
1542
|
+
interval: EvaluationIntervalTrigger;
|
|
1543
|
+
/**
|
|
1544
|
+
* Re-run when the customer finishes speaking.
|
|
1545
|
+
* @public
|
|
1546
|
+
*/
|
|
1547
|
+
customerEndSpeaking?: boolean | undefined;
|
|
1548
|
+
/**
|
|
1549
|
+
* Re-run when the agent finishes speaking.
|
|
1550
|
+
* @public
|
|
1551
|
+
*/
|
|
1552
|
+
agentEndSpeaking?: boolean | undefined;
|
|
1553
|
+
/**
|
|
1554
|
+
* Run once, immediately, at the start of the session.
|
|
1555
|
+
* @public
|
|
1556
|
+
*/
|
|
1557
|
+
immediatelyOncePerSession?: boolean | undefined;
|
|
1558
|
+
}
|
|
1559
|
+
/**
|
|
1560
|
+
* The editable definition of an evaluation.
|
|
1561
|
+
* @public
|
|
1562
|
+
*/
|
|
1563
|
+
export interface CreateEvaluationInput {
|
|
1564
|
+
/**
|
|
1565
|
+
* Programmatic evaluation name used in the session state and condition fields, e.g. 'csat'.
|
|
1566
|
+
* @public
|
|
1567
|
+
*/
|
|
1568
|
+
name: string;
|
|
1569
|
+
description?: string | undefined;
|
|
1570
|
+
/**
|
|
1571
|
+
* Prompt the model follows to score the transcript.
|
|
1572
|
+
* @public
|
|
1573
|
+
*/
|
|
1574
|
+
instructions: string;
|
|
1575
|
+
/**
|
|
1576
|
+
* Structured values the evaluation produces.
|
|
1577
|
+
* @public
|
|
1578
|
+
*/
|
|
1579
|
+
fields?: CopilotField[] | undefined;
|
|
1580
|
+
/**
|
|
1581
|
+
* When an evaluation is re-run during a session. Multiple triggers may be enabled.
|
|
1582
|
+
* @public
|
|
1583
|
+
*/
|
|
1584
|
+
triggers: EvaluationTriggers;
|
|
1585
|
+
/**
|
|
1586
|
+
* How much of the transcript the model reads on each run.
|
|
1587
|
+
* @public
|
|
1588
|
+
*/
|
|
1589
|
+
window: EvaluationWindow;
|
|
1590
|
+
/**
|
|
1591
|
+
* Model used for the evaluation. Defaults to the platform default when omitted.
|
|
1592
|
+
* @public
|
|
1593
|
+
*/
|
|
1594
|
+
model?: string | undefined;
|
|
1595
|
+
/**
|
|
1596
|
+
* Optional grouping label for organizing evaluations in the console.
|
|
1597
|
+
* @public
|
|
1598
|
+
*/
|
|
1599
|
+
group?: string | undefined;
|
|
1600
|
+
/**
|
|
1601
|
+
* Extra conditions gating whether this evaluation runs for a session.
|
|
1602
|
+
* @public
|
|
1603
|
+
*/
|
|
1604
|
+
conditions?: __DocumentType | undefined;
|
|
1605
|
+
company?: string | undefined;
|
|
1606
|
+
}
|
|
1607
|
+
/**
|
|
1608
|
+
* A reusable evaluation. Referenced by profiles via `evaluations`.
|
|
1609
|
+
* @public
|
|
1610
|
+
*/
|
|
1611
|
+
export interface Evaluation {
|
|
1612
|
+
/**
|
|
1613
|
+
* Programmatic evaluation name used in the session state and condition fields, e.g. 'csat'.
|
|
1614
|
+
* @public
|
|
1615
|
+
*/
|
|
1616
|
+
name: string;
|
|
1617
|
+
description?: string | undefined;
|
|
1618
|
+
/**
|
|
1619
|
+
* Prompt the model follows to score the transcript.
|
|
1620
|
+
* @public
|
|
1621
|
+
*/
|
|
1622
|
+
instructions: string;
|
|
1623
|
+
/**
|
|
1624
|
+
* Structured values the evaluation produces.
|
|
1625
|
+
* @public
|
|
1626
|
+
*/
|
|
1627
|
+
fields?: CopilotField[] | undefined;
|
|
1628
|
+
/**
|
|
1629
|
+
* When an evaluation is re-run during a session. Multiple triggers may be enabled.
|
|
1630
|
+
* @public
|
|
1631
|
+
*/
|
|
1632
|
+
triggers: EvaluationTriggers;
|
|
1633
|
+
/**
|
|
1634
|
+
* How much of the transcript the model reads on each run.
|
|
1635
|
+
* @public
|
|
1636
|
+
*/
|
|
1637
|
+
window: EvaluationWindow;
|
|
1638
|
+
/**
|
|
1639
|
+
* Model used for the evaluation. Defaults to the platform default when omitted.
|
|
1640
|
+
* @public
|
|
1641
|
+
*/
|
|
1642
|
+
model?: string | undefined;
|
|
1643
|
+
/**
|
|
1644
|
+
* Optional grouping label for organizing evaluations in the console.
|
|
1645
|
+
* @public
|
|
1646
|
+
*/
|
|
1647
|
+
group?: string | undefined;
|
|
1648
|
+
/**
|
|
1649
|
+
* Extra conditions gating whether this evaluation runs for a session.
|
|
1650
|
+
* @public
|
|
1651
|
+
*/
|
|
1652
|
+
conditions?: __DocumentType | undefined;
|
|
1653
|
+
/**
|
|
1654
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1655
|
+
* @public
|
|
1656
|
+
*/
|
|
1657
|
+
createdAt: string;
|
|
1658
|
+
/**
|
|
1659
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
1660
|
+
* @public
|
|
1661
|
+
*/
|
|
1662
|
+
createdBy: Actor;
|
|
1663
|
+
/**
|
|
1664
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1665
|
+
* @public
|
|
1666
|
+
*/
|
|
1667
|
+
updatedAt?: string | undefined;
|
|
1668
|
+
/**
|
|
1669
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
1670
|
+
* @public
|
|
1671
|
+
*/
|
|
1672
|
+
updatedBy?: Actor | undefined;
|
|
1673
|
+
id: string;
|
|
1674
|
+
/**
|
|
1675
|
+
* Monotonic revision, incremented on every update. Pass it back on update for optimistic locking.
|
|
1676
|
+
* @public
|
|
1677
|
+
*/
|
|
1678
|
+
revision: number;
|
|
1679
|
+
/**
|
|
1680
|
+
* Runs over the trailing 30 days; null when not yet computed.
|
|
1681
|
+
* @public
|
|
1682
|
+
*/
|
|
1683
|
+
usageLast30Days?: number | undefined;
|
|
1684
|
+
}
|
|
1685
|
+
/**
|
|
1686
|
+
* @public
|
|
1687
|
+
*/
|
|
1688
|
+
export interface CreateEvaluationOutput {
|
|
1689
|
+
/**
|
|
1690
|
+
* A reusable evaluation. Referenced by profiles via `evaluations`.
|
|
1691
|
+
* @public
|
|
1692
|
+
*/
|
|
1693
|
+
evaluation: Evaluation;
|
|
1694
|
+
}
|
|
1695
|
+
/**
|
|
1696
|
+
* Semantic (AI) matching. Detects the intent from meaning and extracts structured fields into `intent.<name>.<field>`.
|
|
1697
|
+
* @public
|
|
1698
|
+
*/
|
|
1699
|
+
export interface IntentAiMatch {
|
|
1700
|
+
enabled: boolean;
|
|
1701
|
+
/**
|
|
1702
|
+
* Prompt describing when this intent applies.
|
|
1703
|
+
* @public
|
|
1704
|
+
*/
|
|
1705
|
+
instructions?: string | undefined;
|
|
1706
|
+
/**
|
|
1707
|
+
* Structured values the model extracts when the intent matches.
|
|
1708
|
+
* @public
|
|
1709
|
+
*/
|
|
1710
|
+
fields?: CopilotField[] | undefined;
|
|
1711
|
+
}
|
|
1712
|
+
/**
|
|
1713
|
+
* @public
|
|
1714
|
+
*/
|
|
1715
|
+
export interface IntentTextMatchOption {
|
|
1716
|
+
id: string;
|
|
1717
|
+
/**
|
|
1718
|
+
* The phrase, word or pattern to look for, e.g. 'refund', 'W-AIR' or a regex.
|
|
1719
|
+
* @public
|
|
1720
|
+
*/
|
|
1721
|
+
value: string;
|
|
1722
|
+
/**
|
|
1723
|
+
* How a literal phrase is compared against the transcript.
|
|
1724
|
+
* @public
|
|
1725
|
+
*/
|
|
1726
|
+
mode: IntentTextMatchMode;
|
|
1727
|
+
}
|
|
1728
|
+
/**
|
|
1729
|
+
* Literal-text matching. Checked before AI matching; a text hit short-circuits semantic evaluation.
|
|
1730
|
+
* @public
|
|
1731
|
+
*/
|
|
1732
|
+
export interface IntentTextMatch {
|
|
1733
|
+
enabled: boolean;
|
|
1734
|
+
options?: IntentTextMatchOption[] | undefined;
|
|
1735
|
+
}
|
|
1736
|
+
/**
|
|
1737
|
+
* The detection handlers for an intent. Text matching is attempted first, then AI matching.
|
|
1738
|
+
* @public
|
|
1739
|
+
*/
|
|
1740
|
+
export interface IntentHandlers {
|
|
1741
|
+
/**
|
|
1742
|
+
* Literal-text matching. Checked before AI matching; a text hit short-circuits semantic evaluation.
|
|
1743
|
+
* @public
|
|
1744
|
+
*/
|
|
1745
|
+
textMatch: IntentTextMatch;
|
|
1746
|
+
/**
|
|
1747
|
+
* Semantic (AI) matching. Detects the intent from meaning and extracts structured fields into `intent.<name>.<field>`.
|
|
1748
|
+
* @public
|
|
1749
|
+
*/
|
|
1750
|
+
aiMatch: IntentAiMatch;
|
|
1751
|
+
}
|
|
1752
|
+
/**
|
|
1753
|
+
* The editable definition of an intent.
|
|
1754
|
+
* @public
|
|
1755
|
+
*/
|
|
1756
|
+
export interface CreateIntentInput {
|
|
1757
|
+
/**
|
|
1758
|
+
* Programmatic intent name used in the session state and condition fields, e.g. 'refund_request'.
|
|
1759
|
+
* @public
|
|
1760
|
+
*/
|
|
1761
|
+
name: string;
|
|
1762
|
+
description?: string | undefined;
|
|
1763
|
+
/**
|
|
1764
|
+
* The detection handlers for an intent. Text matching is attempted first, then AI matching.
|
|
1765
|
+
* @public
|
|
1766
|
+
*/
|
|
1767
|
+
handlers: IntentHandlers;
|
|
1768
|
+
/**
|
|
1769
|
+
* Extra conditions gating whether this intent is evaluated for a session.
|
|
1770
|
+
* @public
|
|
1771
|
+
*/
|
|
1772
|
+
conditions?: __DocumentType | undefined;
|
|
1773
|
+
company?: string | undefined;
|
|
1774
|
+
}
|
|
1775
|
+
/**
|
|
1776
|
+
* A reusable intent. Referenced by profiles via `intents`.
|
|
1777
|
+
* @public
|
|
1778
|
+
*/
|
|
1779
|
+
export interface Intent {
|
|
1780
|
+
/**
|
|
1781
|
+
* Programmatic intent name used in the session state and condition fields, e.g. 'refund_request'.
|
|
1782
|
+
* @public
|
|
1783
|
+
*/
|
|
1784
|
+
name: string;
|
|
1785
|
+
description?: string | undefined;
|
|
1786
|
+
/**
|
|
1787
|
+
* The detection handlers for an intent. Text matching is attempted first, then AI matching.
|
|
1788
|
+
* @public
|
|
1789
|
+
*/
|
|
1790
|
+
handlers: IntentHandlers;
|
|
1791
|
+
/**
|
|
1792
|
+
* Extra conditions gating whether this intent is evaluated for a session.
|
|
1793
|
+
* @public
|
|
1794
|
+
*/
|
|
1795
|
+
conditions?: __DocumentType | undefined;
|
|
1796
|
+
/**
|
|
1797
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1798
|
+
* @public
|
|
1799
|
+
*/
|
|
1800
|
+
createdAt: string;
|
|
1801
|
+
/**
|
|
1802
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
1803
|
+
* @public
|
|
1804
|
+
*/
|
|
1805
|
+
createdBy: Actor;
|
|
1806
|
+
/**
|
|
1807
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
1808
|
+
* @public
|
|
1809
|
+
*/
|
|
1810
|
+
updatedAt?: string | undefined;
|
|
1811
|
+
/**
|
|
1812
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
1813
|
+
* @public
|
|
1814
|
+
*/
|
|
1815
|
+
updatedBy?: Actor | undefined;
|
|
1816
|
+
id: string;
|
|
1817
|
+
/**
|
|
1818
|
+
* Monotonic revision, incremented on every update. Pass it back on update for optimistic locking.
|
|
1819
|
+
* @public
|
|
1820
|
+
*/
|
|
1821
|
+
revision: number;
|
|
1822
|
+
/**
|
|
1823
|
+
* Matches over the trailing 30 days; null when not yet computed.
|
|
1824
|
+
* @public
|
|
1825
|
+
*/
|
|
1826
|
+
usageLast30Days?: number | undefined;
|
|
1827
|
+
}
|
|
1828
|
+
/**
|
|
1829
|
+
* @public
|
|
1830
|
+
*/
|
|
1831
|
+
export interface CreateIntentOutput {
|
|
1832
|
+
/**
|
|
1833
|
+
* A reusable intent. Referenced by profiles via `intents`.
|
|
1834
|
+
* @public
|
|
1835
|
+
*/
|
|
1836
|
+
intent: Intent;
|
|
1837
|
+
}
|
|
1838
|
+
/**
|
|
1839
|
+
* The editable definition of a profile: metadata plus attached features and library resources.
|
|
1840
|
+
* @public
|
|
1841
|
+
*/
|
|
1842
|
+
export interface CreateProfileInput {
|
|
1843
|
+
name: string;
|
|
1844
|
+
description?: string | undefined;
|
|
1845
|
+
/**
|
|
1846
|
+
* The conversation surface a copilot resource applies to. `calls` targets voice calls, `chats` targets chat conversations, `any` targets both.
|
|
1847
|
+
* @public
|
|
1848
|
+
*/
|
|
1849
|
+
channel: CopilotChannel;
|
|
1850
|
+
/**
|
|
1851
|
+
* Conditions under which the profile matches a conversation. An empty tree always matches.
|
|
1852
|
+
* @public
|
|
1853
|
+
*/
|
|
1854
|
+
conditions?: __DocumentType | undefined;
|
|
1855
|
+
/**
|
|
1856
|
+
* Who the profile assists. Defaults to organization-wide.
|
|
1857
|
+
* @public
|
|
1858
|
+
*/
|
|
1859
|
+
access?: CopilotAccess | undefined;
|
|
1860
|
+
/**
|
|
1861
|
+
* Copilot features enabled for this profile. Each list item is a typed feature and its configuration.
|
|
1862
|
+
* @public
|
|
1863
|
+
*/
|
|
1864
|
+
features?: CopilotFeature[] | undefined;
|
|
1865
|
+
/**
|
|
1866
|
+
* Assets referenced by this profile.
|
|
1867
|
+
* @public
|
|
1868
|
+
*/
|
|
1869
|
+
assets?: string[] | undefined;
|
|
1870
|
+
/**
|
|
1871
|
+
* Intents referenced by this profile.
|
|
1872
|
+
* @public
|
|
1873
|
+
*/
|
|
1874
|
+
intents?: string[] | undefined;
|
|
1875
|
+
/**
|
|
1876
|
+
* Evaluations referenced by this profile.
|
|
1877
|
+
* @public
|
|
1878
|
+
*/
|
|
1879
|
+
evaluations?: string[] | undefined;
|
|
1880
|
+
/**
|
|
1881
|
+
* Automations referenced by this profile.
|
|
1882
|
+
* @public
|
|
1883
|
+
*/
|
|
1884
|
+
automations?: string[] | undefined;
|
|
1885
|
+
company?: string | undefined;
|
|
1886
|
+
}
|
|
1887
|
+
/**
|
|
1888
|
+
* @public
|
|
1889
|
+
*/
|
|
1890
|
+
export interface CreateProfileOutput {
|
|
1891
|
+
/**
|
|
1892
|
+
* The complete configuration of a profile, including draft lifecycle state. Referenced library resources are listed by id; a published version resolves them into an immutable snapshot.
|
|
1893
|
+
* @public
|
|
1894
|
+
*/
|
|
1895
|
+
profile: Profile;
|
|
1896
|
+
}
|
|
1897
|
+
/**
|
|
1898
|
+
* @public
|
|
1899
|
+
*/
|
|
1900
|
+
export interface DeleteAssetInput {
|
|
1901
|
+
company?: string | undefined;
|
|
1902
|
+
assetId: string;
|
|
1903
|
+
/**
|
|
1904
|
+
* Detach the asset from referencing profile drafts instead of failing with AssetInUseException.
|
|
1905
|
+
* @public
|
|
1906
|
+
*/
|
|
1907
|
+
detach?: boolean | undefined;
|
|
1908
|
+
}
|
|
1909
|
+
/**
|
|
1910
|
+
* @public
|
|
1911
|
+
*/
|
|
1912
|
+
export interface DeleteAssetOutput {
|
|
1913
|
+
}
|
|
1914
|
+
/**
|
|
1915
|
+
* @public
|
|
1916
|
+
*/
|
|
1917
|
+
export interface DeleteAutomationInput {
|
|
1918
|
+
company?: string | undefined;
|
|
1919
|
+
automationId: string;
|
|
1920
|
+
/**
|
|
1921
|
+
* Detach the automation from referencing profile drafts instead of failing with AutomationInUseException.
|
|
1922
|
+
* @public
|
|
1923
|
+
*/
|
|
1924
|
+
detach?: boolean | undefined;
|
|
1925
|
+
}
|
|
1926
|
+
/**
|
|
1927
|
+
* @public
|
|
1928
|
+
*/
|
|
1929
|
+
export interface DeleteAutomationOutput {
|
|
1930
|
+
}
|
|
1931
|
+
/**
|
|
1932
|
+
* @public
|
|
1933
|
+
*/
|
|
1934
|
+
export interface DeleteEvaluationInput {
|
|
1935
|
+
company?: string | undefined;
|
|
1936
|
+
evaluationId: string;
|
|
1937
|
+
/**
|
|
1938
|
+
* Detach the evaluation from referencing profile drafts instead of failing with EvaluationInUseException.
|
|
1939
|
+
* @public
|
|
1940
|
+
*/
|
|
1941
|
+
detach?: boolean | undefined;
|
|
1942
|
+
}
|
|
1943
|
+
/**
|
|
1944
|
+
* @public
|
|
1945
|
+
*/
|
|
1946
|
+
export interface DeleteEvaluationOutput {
|
|
1947
|
+
}
|
|
1948
|
+
/**
|
|
1949
|
+
* @public
|
|
1950
|
+
*/
|
|
1951
|
+
export interface DeleteIntentInput {
|
|
1952
|
+
company?: string | undefined;
|
|
1953
|
+
intentId: string;
|
|
1954
|
+
/**
|
|
1955
|
+
* Detach the intent from referencing profile drafts instead of failing with IntentInUseException.
|
|
1956
|
+
* @public
|
|
1957
|
+
*/
|
|
1958
|
+
detach?: boolean | undefined;
|
|
1959
|
+
}
|
|
1960
|
+
/**
|
|
1961
|
+
* @public
|
|
1962
|
+
*/
|
|
1963
|
+
export interface DeleteIntentOutput {
|
|
1964
|
+
}
|
|
1965
|
+
/**
|
|
1966
|
+
* @public
|
|
1967
|
+
*/
|
|
1968
|
+
export interface DeleteProfileInput {
|
|
1969
|
+
company?: string | undefined;
|
|
1970
|
+
profileId: string;
|
|
1971
|
+
}
|
|
1972
|
+
/**
|
|
1973
|
+
* @public
|
|
1974
|
+
*/
|
|
1975
|
+
export interface DeleteProfileOutput {
|
|
1976
|
+
}
|
|
1977
|
+
/**
|
|
1978
|
+
* @public
|
|
1979
|
+
*/
|
|
1980
|
+
export interface DeleteProfileResourceInput {
|
|
1981
|
+
company?: string | undefined;
|
|
1982
|
+
profileId: string;
|
|
1983
|
+
/**
|
|
1984
|
+
* The kind of resource attached to a profile.
|
|
1985
|
+
* @public
|
|
1986
|
+
*/
|
|
1987
|
+
resourceType: ProfileResourceType;
|
|
1988
|
+
/**
|
|
1989
|
+
* Identifier of an attached profile resource. For a feature, use the feature union member name, such as `csat` or `sentiment`.
|
|
1990
|
+
* @public
|
|
1991
|
+
*/
|
|
1992
|
+
resourceId: string;
|
|
1993
|
+
/**
|
|
1994
|
+
* Draft revision this update is based on (optimistic locking).
|
|
1995
|
+
* @public
|
|
1996
|
+
*/
|
|
1997
|
+
revision: number;
|
|
1998
|
+
}
|
|
1999
|
+
/**
|
|
2000
|
+
* @public
|
|
2001
|
+
*/
|
|
2002
|
+
export interface DeleteProfileResourceOutput {
|
|
2003
|
+
/**
|
|
2004
|
+
* The complete configuration of a profile, including draft lifecycle state. Referenced library resources are listed by id; a published version resolves them into an immutable snapshot.
|
|
2005
|
+
* @public
|
|
2006
|
+
*/
|
|
2007
|
+
profile: Profile;
|
|
2008
|
+
}
|
|
2009
|
+
/**
|
|
2010
|
+
* Summary entry returned by ListEvaluations.
|
|
2011
|
+
* @public
|
|
2012
|
+
*/
|
|
2013
|
+
export interface EvaluationInfo {
|
|
2014
|
+
/**
|
|
2015
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
2016
|
+
* @public
|
|
2017
|
+
*/
|
|
2018
|
+
createdAt: string;
|
|
2019
|
+
/**
|
|
2020
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
2021
|
+
* @public
|
|
2022
|
+
*/
|
|
2023
|
+
createdBy: Actor;
|
|
2024
|
+
/**
|
|
2025
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
2026
|
+
* @public
|
|
2027
|
+
*/
|
|
2028
|
+
updatedAt?: string | undefined;
|
|
2029
|
+
/**
|
|
2030
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
2031
|
+
* @public
|
|
2032
|
+
*/
|
|
2033
|
+
updatedBy?: Actor | undefined;
|
|
2034
|
+
id: string;
|
|
2035
|
+
/**
|
|
2036
|
+
* Programmatic evaluation name used in the session state and condition fields, e.g. 'csat'.
|
|
2037
|
+
* @public
|
|
2038
|
+
*/
|
|
2039
|
+
name: string;
|
|
2040
|
+
description?: string | undefined;
|
|
2041
|
+
/**
|
|
2042
|
+
* How much of the transcript the model reads on each run.
|
|
2043
|
+
* @public
|
|
2044
|
+
*/
|
|
2045
|
+
window: EvaluationWindow;
|
|
2046
|
+
group?: string | undefined;
|
|
2047
|
+
/**
|
|
2048
|
+
* Number of matches/executions over the trailing 30 days, or null when not yet computed.
|
|
2049
|
+
* @public
|
|
2050
|
+
*/
|
|
2051
|
+
usageLast30Days?: number | undefined;
|
|
2052
|
+
}
|
|
2053
|
+
/**
|
|
2054
|
+
* @public
|
|
2055
|
+
*/
|
|
2056
|
+
export interface GetAssetInput {
|
|
2057
|
+
company?: string | undefined;
|
|
2058
|
+
assetId: string;
|
|
2059
|
+
}
|
|
2060
|
+
/**
|
|
2061
|
+
* @public
|
|
2062
|
+
*/
|
|
2063
|
+
export interface GetAssetOutput {
|
|
2064
|
+
/**
|
|
2065
|
+
* A reusable asset. Referenced by profiles via `assets`.
|
|
2066
|
+
* @public
|
|
2067
|
+
*/
|
|
2068
|
+
asset: Asset;
|
|
2069
|
+
}
|
|
2070
|
+
/**
|
|
2071
|
+
* @public
|
|
2072
|
+
*/
|
|
2073
|
+
export interface GetAutomationInput {
|
|
2074
|
+
company?: string | undefined;
|
|
2075
|
+
automationId: string;
|
|
2076
|
+
}
|
|
2077
|
+
/**
|
|
2078
|
+
* @public
|
|
2079
|
+
*/
|
|
2080
|
+
export interface GetAutomationOutput {
|
|
2081
|
+
/**
|
|
2082
|
+
* A reusable automation. Referenced by profiles via `automations`.
|
|
2083
|
+
* @public
|
|
2084
|
+
*/
|
|
2085
|
+
automation: Automation;
|
|
2086
|
+
}
|
|
2087
|
+
/**
|
|
2088
|
+
* @public
|
|
2089
|
+
*/
|
|
2090
|
+
export interface GetEvaluationInput {
|
|
2091
|
+
company?: string | undefined;
|
|
2092
|
+
evaluationId: string;
|
|
2093
|
+
}
|
|
2094
|
+
/**
|
|
2095
|
+
* @public
|
|
2096
|
+
*/
|
|
2097
|
+
export interface GetEvaluationOutput {
|
|
2098
|
+
/**
|
|
2099
|
+
* A reusable evaluation. Referenced by profiles via `evaluations`.
|
|
2100
|
+
* @public
|
|
2101
|
+
*/
|
|
2102
|
+
evaluation: Evaluation;
|
|
2103
|
+
}
|
|
2104
|
+
/**
|
|
2105
|
+
* @public
|
|
2106
|
+
*/
|
|
2107
|
+
export interface GetIntentInput {
|
|
2108
|
+
company?: string | undefined;
|
|
2109
|
+
intentId: string;
|
|
2110
|
+
}
|
|
2111
|
+
/**
|
|
2112
|
+
* @public
|
|
2113
|
+
*/
|
|
2114
|
+
export interface GetIntentOutput {
|
|
2115
|
+
/**
|
|
2116
|
+
* A reusable intent. Referenced by profiles via `intents`.
|
|
2117
|
+
* @public
|
|
2118
|
+
*/
|
|
2119
|
+
intent: Intent;
|
|
2120
|
+
}
|
|
2121
|
+
/**
|
|
2122
|
+
* @public
|
|
2123
|
+
*/
|
|
2124
|
+
export interface GetProfileInput {
|
|
2125
|
+
company?: string | undefined;
|
|
2126
|
+
profileId: string;
|
|
2127
|
+
}
|
|
2128
|
+
/**
|
|
2129
|
+
* @public
|
|
2130
|
+
*/
|
|
2131
|
+
export interface GetProfileOutput {
|
|
2132
|
+
/**
|
|
2133
|
+
* The complete configuration of a profile, including draft lifecycle state. Referenced library resources are listed by id; a published version resolves them into an immutable snapshot.
|
|
2134
|
+
* @public
|
|
2135
|
+
*/
|
|
2136
|
+
profile: Profile;
|
|
2137
|
+
}
|
|
2138
|
+
/**
|
|
2139
|
+
* @public
|
|
2140
|
+
*/
|
|
2141
|
+
export interface GetProfileVersionInput {
|
|
2142
|
+
company?: string | undefined;
|
|
2143
|
+
profileId: string;
|
|
2144
|
+
/**
|
|
2145
|
+
* Published profile version number. Monotonic within a profile's version history, starting at 1.
|
|
2146
|
+
* @public
|
|
2147
|
+
*/
|
|
2148
|
+
version: number;
|
|
2149
|
+
}
|
|
2150
|
+
/**
|
|
2151
|
+
* @public
|
|
2152
|
+
*/
|
|
2153
|
+
export interface GetProfileVersionOutput {
|
|
2154
|
+
/**
|
|
2155
|
+
* Published profile version number. Monotonic within a profile's version history, starting at 1.
|
|
2156
|
+
* @public
|
|
2157
|
+
*/
|
|
2158
|
+
version: number;
|
|
2159
|
+
}
|
|
2160
|
+
/**
|
|
2161
|
+
* Summary entry returned by ListIntents.
|
|
2162
|
+
* @public
|
|
2163
|
+
*/
|
|
2164
|
+
export interface IntentInfo {
|
|
2165
|
+
/**
|
|
2166
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
2167
|
+
* @public
|
|
2168
|
+
*/
|
|
2169
|
+
createdAt: string;
|
|
2170
|
+
/**
|
|
2171
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
2172
|
+
* @public
|
|
2173
|
+
*/
|
|
2174
|
+
createdBy: Actor;
|
|
2175
|
+
/**
|
|
2176
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
2177
|
+
* @public
|
|
2178
|
+
*/
|
|
2179
|
+
updatedAt?: string | undefined;
|
|
2180
|
+
/**
|
|
2181
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
2182
|
+
* @public
|
|
2183
|
+
*/
|
|
2184
|
+
updatedBy?: Actor | undefined;
|
|
2185
|
+
id: string;
|
|
2186
|
+
/**
|
|
2187
|
+
* Programmatic intent name used in the session state and condition fields, e.g. 'refund_request'.
|
|
2188
|
+
* @public
|
|
2189
|
+
*/
|
|
2190
|
+
name: string;
|
|
2191
|
+
description?: string | undefined;
|
|
2192
|
+
/**
|
|
2193
|
+
* Whether literal text matching is enabled.
|
|
2194
|
+
* @public
|
|
2195
|
+
*/
|
|
2196
|
+
textMatchEnabled: boolean;
|
|
2197
|
+
/**
|
|
2198
|
+
* Whether semantic AI matching is enabled.
|
|
2199
|
+
* @public
|
|
2200
|
+
*/
|
|
2201
|
+
aiMatchEnabled: boolean;
|
|
2202
|
+
/**
|
|
2203
|
+
* Number of matches/executions over the trailing 30 days, or null when not yet computed.
|
|
2204
|
+
* @public
|
|
2205
|
+
*/
|
|
2206
|
+
usageLast30Days?: number | undefined;
|
|
2207
|
+
}
|
|
2208
|
+
/**
|
|
2209
|
+
* @public
|
|
2210
|
+
*/
|
|
2211
|
+
export interface ListAssetsInput {
|
|
2212
|
+
company?: string | undefined;
|
|
2213
|
+
/**
|
|
2214
|
+
* Filter by content kind.
|
|
2215
|
+
* @public
|
|
2216
|
+
*/
|
|
2217
|
+
contentType?: AssetContentType | undefined;
|
|
2218
|
+
/**
|
|
2219
|
+
* Filter by semantic type.
|
|
2220
|
+
* @public
|
|
2221
|
+
*/
|
|
2222
|
+
type?: AssetType | undefined;
|
|
2223
|
+
/**
|
|
2224
|
+
* Filter by enabled state.
|
|
2225
|
+
* @public
|
|
2226
|
+
*/
|
|
2227
|
+
enabled?: boolean | undefined;
|
|
2228
|
+
/**
|
|
2229
|
+
* Filter by name or description.
|
|
2230
|
+
* @public
|
|
2231
|
+
*/
|
|
2232
|
+
search?: string | undefined;
|
|
2233
|
+
limit?: number | undefined;
|
|
2234
|
+
/**
|
|
2235
|
+
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2236
|
+
* @public
|
|
2237
|
+
*/
|
|
2238
|
+
cursor?: string | undefined;
|
|
2239
|
+
}
|
|
2240
|
+
/**
|
|
2241
|
+
* @public
|
|
2242
|
+
*/
|
|
2243
|
+
export interface ListAssetsOutput {
|
|
2244
|
+
assets: AssetInfo[];
|
|
2245
|
+
/**
|
|
2246
|
+
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2247
|
+
* @public
|
|
2248
|
+
*/
|
|
2249
|
+
nextCursor?: string | undefined;
|
|
2250
|
+
}
|
|
2251
|
+
/**
|
|
2252
|
+
* @public
|
|
2253
|
+
*/
|
|
2254
|
+
export interface ListAutomationsInput {
|
|
2255
|
+
company?: string | undefined;
|
|
2256
|
+
/**
|
|
2257
|
+
* Filter by handler type.
|
|
2258
|
+
* @public
|
|
2259
|
+
*/
|
|
2260
|
+
handlerType?: AutomationHandlerType | undefined;
|
|
2261
|
+
/**
|
|
2262
|
+
* Filter by name or description.
|
|
2263
|
+
* @public
|
|
2264
|
+
*/
|
|
2265
|
+
search?: string | undefined;
|
|
2266
|
+
limit?: number | undefined;
|
|
2267
|
+
/**
|
|
2268
|
+
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2269
|
+
* @public
|
|
2270
|
+
*/
|
|
2271
|
+
cursor?: string | undefined;
|
|
2272
|
+
}
|
|
2273
|
+
/**
|
|
2274
|
+
* @public
|
|
2275
|
+
*/
|
|
2276
|
+
export interface ListAutomationsOutput {
|
|
2277
|
+
automations: AutomationInfo[];
|
|
2278
|
+
/**
|
|
2279
|
+
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2280
|
+
* @public
|
|
2281
|
+
*/
|
|
2282
|
+
nextCursor?: string | undefined;
|
|
2283
|
+
}
|
|
2284
|
+
/**
|
|
2285
|
+
* @public
|
|
2286
|
+
*/
|
|
2287
|
+
export interface ListEvaluationsInput {
|
|
2288
|
+
company?: string | undefined;
|
|
2289
|
+
/**
|
|
2290
|
+
* Filter by grouping label.
|
|
2291
|
+
* @public
|
|
2292
|
+
*/
|
|
2293
|
+
group?: string | undefined;
|
|
2294
|
+
/**
|
|
2295
|
+
* Filter by name or description.
|
|
2296
|
+
* @public
|
|
2297
|
+
*/
|
|
2298
|
+
search?: string | undefined;
|
|
2299
|
+
limit?: number | undefined;
|
|
2300
|
+
/**
|
|
2301
|
+
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2302
|
+
* @public
|
|
2303
|
+
*/
|
|
2304
|
+
cursor?: string | undefined;
|
|
2305
|
+
}
|
|
2306
|
+
/**
|
|
2307
|
+
* @public
|
|
2308
|
+
*/
|
|
2309
|
+
export interface ListEvaluationsOutput {
|
|
2310
|
+
evaluations: EvaluationInfo[];
|
|
2311
|
+
/**
|
|
2312
|
+
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2313
|
+
* @public
|
|
2314
|
+
*/
|
|
2315
|
+
nextCursor?: string | undefined;
|
|
2316
|
+
}
|
|
2317
|
+
/**
|
|
2318
|
+
* @public
|
|
2319
|
+
*/
|
|
2320
|
+
export interface ListIntentsInput {
|
|
2321
|
+
company?: string | undefined;
|
|
2322
|
+
/**
|
|
2323
|
+
* Filter by name or description.
|
|
2324
|
+
* @public
|
|
2325
|
+
*/
|
|
2326
|
+
search?: string | undefined;
|
|
2327
|
+
limit?: number | undefined;
|
|
2328
|
+
/**
|
|
2329
|
+
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2330
|
+
* @public
|
|
2331
|
+
*/
|
|
2332
|
+
cursor?: string | undefined;
|
|
2333
|
+
}
|
|
2334
|
+
/**
|
|
2335
|
+
* @public
|
|
2336
|
+
*/
|
|
2337
|
+
export interface ListIntentsOutput {
|
|
2338
|
+
intents: IntentInfo[];
|
|
2339
|
+
/**
|
|
2340
|
+
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2341
|
+
* @public
|
|
2342
|
+
*/
|
|
2343
|
+
nextCursor?: string | undefined;
|
|
2344
|
+
}
|
|
2345
|
+
/**
|
|
2346
|
+
* @public
|
|
2347
|
+
*/
|
|
2348
|
+
export interface ListProfilesInput {
|
|
2349
|
+
company?: string | undefined;
|
|
2350
|
+
/**
|
|
2351
|
+
* Filter by status.
|
|
2352
|
+
* @public
|
|
2353
|
+
*/
|
|
2354
|
+
status?: ProfileStatus | undefined;
|
|
2355
|
+
/**
|
|
2356
|
+
* Filter by the conversation surface the profile applies to.
|
|
2357
|
+
* @public
|
|
2358
|
+
*/
|
|
2359
|
+
channel?: CopilotChannel | undefined;
|
|
2360
|
+
/**
|
|
2361
|
+
* Filter by name or description.
|
|
2362
|
+
* @public
|
|
2363
|
+
*/
|
|
2364
|
+
search?: string | undefined;
|
|
2365
|
+
limit?: number | undefined;
|
|
2366
|
+
/**
|
|
2367
|
+
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2368
|
+
* @public
|
|
2369
|
+
*/
|
|
2370
|
+
cursor?: string | undefined;
|
|
2371
|
+
}
|
|
2372
|
+
/**
|
|
2373
|
+
* Summary entry returned by ListProfiles.
|
|
2374
|
+
* @public
|
|
2375
|
+
*/
|
|
2376
|
+
export interface ProfileInfo {
|
|
2377
|
+
/**
|
|
2378
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
2379
|
+
* @public
|
|
2380
|
+
*/
|
|
2381
|
+
createdAt: string;
|
|
2382
|
+
/**
|
|
2383
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
2384
|
+
* @public
|
|
2385
|
+
*/
|
|
2386
|
+
createdBy: Actor;
|
|
2387
|
+
/**
|
|
2388
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
2389
|
+
* @public
|
|
2390
|
+
*/
|
|
2391
|
+
updatedAt?: string | undefined;
|
|
2392
|
+
/**
|
|
2393
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
2394
|
+
* @public
|
|
2395
|
+
*/
|
|
2396
|
+
updatedBy?: Actor | undefined;
|
|
2397
|
+
id: string;
|
|
2398
|
+
name: string;
|
|
2399
|
+
description?: string | undefined;
|
|
2400
|
+
/**
|
|
2401
|
+
* The conversation surface a copilot resource applies to. `calls` targets voice calls, `chats` targets chat conversations, `any` targets both.
|
|
2402
|
+
* @public
|
|
2403
|
+
*/
|
|
2404
|
+
channel: CopilotChannel;
|
|
2405
|
+
status: ProfileStatus;
|
|
2406
|
+
live: boolean;
|
|
2407
|
+
/**
|
|
2408
|
+
* Published profile version number. Monotonic within a profile's version history, starting at 1.
|
|
2409
|
+
* @public
|
|
2410
|
+
*/
|
|
2411
|
+
latestVersion?: number | undefined;
|
|
2412
|
+
/**
|
|
2413
|
+
* Number of referenced intents.
|
|
2414
|
+
* @public
|
|
2415
|
+
*/
|
|
2416
|
+
intentCount?: number | undefined;
|
|
2417
|
+
/**
|
|
2418
|
+
* Number of referenced evaluations.
|
|
2419
|
+
* @public
|
|
2420
|
+
*/
|
|
2421
|
+
evaluationCount?: number | undefined;
|
|
2422
|
+
/**
|
|
2423
|
+
* Number of referenced automations.
|
|
2424
|
+
* @public
|
|
2425
|
+
*/
|
|
2426
|
+
automationCount?: number | undefined;
|
|
2427
|
+
/**
|
|
2428
|
+
* Number of referenced assets.
|
|
2429
|
+
* @public
|
|
2430
|
+
*/
|
|
2431
|
+
assetCount?: number | undefined;
|
|
2432
|
+
}
|
|
2433
|
+
/**
|
|
2434
|
+
* @public
|
|
2435
|
+
*/
|
|
2436
|
+
export interface ListProfilesOutput {
|
|
2437
|
+
profiles: ProfileInfo[];
|
|
2438
|
+
/**
|
|
2439
|
+
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2440
|
+
* @public
|
|
2441
|
+
*/
|
|
2442
|
+
nextCursor?: string | undefined;
|
|
2443
|
+
}
|
|
2444
|
+
/**
|
|
2445
|
+
* @public
|
|
2446
|
+
*/
|
|
2447
|
+
export interface ListProfileVersionsInput {
|
|
2448
|
+
company?: string | undefined;
|
|
2449
|
+
profileId: string;
|
|
2450
|
+
limit?: number | undefined;
|
|
2451
|
+
/**
|
|
2452
|
+
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2453
|
+
* @public
|
|
2454
|
+
*/
|
|
2455
|
+
cursor?: string | undefined;
|
|
2456
|
+
}
|
|
2457
|
+
/**
|
|
2458
|
+
* Version list entry without the full definition snapshot.
|
|
2459
|
+
* @public
|
|
2460
|
+
*/
|
|
2461
|
+
export interface ProfileVersionInfo {
|
|
2462
|
+
profileId: string;
|
|
2463
|
+
/**
|
|
2464
|
+
* Published profile version number. Monotonic within a profile's version history, starting at 1.
|
|
2465
|
+
* @public
|
|
2466
|
+
*/
|
|
2467
|
+
version: number;
|
|
2468
|
+
/**
|
|
2469
|
+
* Human-readable description of what changed in a published version.
|
|
2470
|
+
* @public
|
|
2471
|
+
*/
|
|
2472
|
+
changelog?: string | undefined;
|
|
2473
|
+
/**
|
|
2474
|
+
* ISO-8601 timestamp with millisecond precision, e.g. '2026-07-10T14:12:30.123Z'.
|
|
2475
|
+
* @public
|
|
2476
|
+
*/
|
|
2477
|
+
publishedAt: string;
|
|
2478
|
+
/**
|
|
2479
|
+
* Who performed an action: an interactive user, an API key or an internal service.
|
|
2480
|
+
* @public
|
|
2481
|
+
*/
|
|
2482
|
+
publishedBy: Actor;
|
|
2483
|
+
/**
|
|
2484
|
+
* True when this version is the profile's latestVersion.
|
|
2485
|
+
* @public
|
|
2486
|
+
*/
|
|
2487
|
+
latest?: boolean | undefined;
|
|
2488
|
+
}
|
|
2489
|
+
/**
|
|
2490
|
+
* @public
|
|
2491
|
+
*/
|
|
2492
|
+
export interface ListProfileVersionsOutput {
|
|
2493
|
+
versions: ProfileVersionInfo[];
|
|
2494
|
+
/**
|
|
2495
|
+
* Opaque cursor returned by a previous page; pass it back to fetch the next page.
|
|
2496
|
+
* @public
|
|
2497
|
+
*/
|
|
2498
|
+
nextCursor?: string | undefined;
|
|
2499
|
+
}
|
|
2500
|
+
/**
|
|
2501
|
+
* @public
|
|
2502
|
+
*/
|
|
2503
|
+
export interface PublishProfileVersionInput {
|
|
2504
|
+
company?: string | undefined;
|
|
2505
|
+
profileId: string;
|
|
2506
|
+
/**
|
|
2507
|
+
* What changed in this version.
|
|
2508
|
+
* @public
|
|
2509
|
+
*/
|
|
2510
|
+
changelog?: string | undefined;
|
|
2511
|
+
/**
|
|
2512
|
+
* Draft revision this publish is based on (optimistic locking).
|
|
2513
|
+
* @public
|
|
2514
|
+
*/
|
|
2515
|
+
revision: number;
|
|
2516
|
+
}
|
|
2517
|
+
/**
|
|
2518
|
+
* @public
|
|
2519
|
+
*/
|
|
2520
|
+
export interface PublishProfileVersionOutput {
|
|
2521
|
+
/**
|
|
2522
|
+
* Published profile version number. Monotonic within a profile's version history, starting at 1.
|
|
2523
|
+
* @public
|
|
2524
|
+
*/
|
|
2525
|
+
version: number;
|
|
2526
|
+
}
|
|
2527
|
+
/**
|
|
2528
|
+
* @public
|
|
2529
|
+
*/
|
|
2530
|
+
export interface RestoreProfileVersionToDraftInput {
|
|
2531
|
+
company?: string | undefined;
|
|
2532
|
+
profileId: string;
|
|
2533
|
+
/**
|
|
2534
|
+
* Published profile version number. Monotonic within a profile's version history, starting at 1.
|
|
2535
|
+
* @public
|
|
2536
|
+
*/
|
|
2537
|
+
version: number;
|
|
2538
|
+
/**
|
|
2539
|
+
* Draft revision this restore is based on (optimistic locking).
|
|
2540
|
+
* @public
|
|
2541
|
+
*/
|
|
2542
|
+
revision: number;
|
|
2543
|
+
}
|
|
2544
|
+
/**
|
|
2545
|
+
* @public
|
|
2546
|
+
*/
|
|
2547
|
+
export interface RestoreProfileVersionToDraftOutput {
|
|
2548
|
+
/**
|
|
2549
|
+
* The complete configuration of a profile, including draft lifecycle state. Referenced library resources are listed by id; a published version resolves them into an immutable snapshot.
|
|
2550
|
+
* @public
|
|
2551
|
+
*/
|
|
2552
|
+
profile: Profile;
|
|
2553
|
+
}
|
|
2554
|
+
/**
|
|
2555
|
+
* The editable definition of an asset.
|
|
2556
|
+
* @public
|
|
2557
|
+
*/
|
|
2558
|
+
export interface UpdateAssetInput {
|
|
2559
|
+
/**
|
|
2560
|
+
* Stable programmatic key referenced from suggestions and traces.
|
|
2561
|
+
* @public
|
|
2562
|
+
*/
|
|
2563
|
+
key?: string | undefined;
|
|
2564
|
+
name: string;
|
|
2565
|
+
description?: string | undefined;
|
|
2566
|
+
/**
|
|
2567
|
+
* Whether the asset participates in matching. Defaults to true.
|
|
2568
|
+
* @public
|
|
2569
|
+
*/
|
|
2570
|
+
enabled?: boolean | undefined;
|
|
2571
|
+
/**
|
|
2572
|
+
* Semantic classification of the asset, driving default presentation.
|
|
2573
|
+
* @public
|
|
2574
|
+
*/
|
|
2575
|
+
type?: AssetType | undefined;
|
|
2576
|
+
/**
|
|
2577
|
+
* Card headline.
|
|
2578
|
+
* @public
|
|
2579
|
+
*/
|
|
2580
|
+
title?: string | undefined;
|
|
2581
|
+
subtitle?: string | undefined;
|
|
2582
|
+
/**
|
|
2583
|
+
* Markdown body shown on the card.
|
|
2584
|
+
* @public
|
|
2585
|
+
*/
|
|
2586
|
+
markdown?: string | undefined;
|
|
2587
|
+
footer?: string | undefined;
|
|
2588
|
+
/**
|
|
2589
|
+
* Visual emphasis of the asset card.
|
|
2590
|
+
* @public
|
|
2591
|
+
*/
|
|
2592
|
+
severity?: AssetSeverity | undefined;
|
|
2593
|
+
/**
|
|
2594
|
+
* Icon shown on the asset card.
|
|
2595
|
+
* @public
|
|
2596
|
+
*/
|
|
2597
|
+
icon?: AssetIcon | undefined;
|
|
2598
|
+
/**
|
|
2599
|
+
* Keep the asset pinned in the UI rather than dismissible.
|
|
2600
|
+
* @public
|
|
2601
|
+
*/
|
|
2602
|
+
sticky?: boolean | undefined;
|
|
2603
|
+
/**
|
|
2604
|
+
* The kind-specific payload (card, playbook, smart actions or knowledge).
|
|
2605
|
+
* @public
|
|
2606
|
+
*/
|
|
2607
|
+
content: AssetContent;
|
|
2608
|
+
/**
|
|
2609
|
+
* Conditions that show the asset. It is shown at most once per session when they first become true.
|
|
2610
|
+
* @public
|
|
2611
|
+
*/
|
|
2612
|
+
conditions?: __DocumentType | undefined;
|
|
2613
|
+
company?: string | undefined;
|
|
2614
|
+
assetId: string;
|
|
2615
|
+
/**
|
|
2616
|
+
* Revision this update is based on (optimistic locking).
|
|
2617
|
+
* @public
|
|
2618
|
+
*/
|
|
2619
|
+
revision: number;
|
|
2620
|
+
}
|
|
2621
|
+
/**
|
|
2622
|
+
* @public
|
|
2623
|
+
*/
|
|
2624
|
+
export interface UpdateAssetOutput {
|
|
2625
|
+
/**
|
|
2626
|
+
* A reusable asset. Referenced by profiles via `assets`.
|
|
2627
|
+
* @public
|
|
2628
|
+
*/
|
|
2629
|
+
asset: Asset;
|
|
2630
|
+
}
|
|
2631
|
+
/**
|
|
2632
|
+
* The editable definition of an automation.
|
|
2633
|
+
* @public
|
|
2634
|
+
*/
|
|
2635
|
+
export interface UpdateAutomationInput {
|
|
2636
|
+
name: string;
|
|
2637
|
+
description?: string | undefined;
|
|
2638
|
+
/**
|
|
2639
|
+
* What the automation does when it fires. Exactly one member is set.
|
|
2640
|
+
* @public
|
|
2641
|
+
*/
|
|
2642
|
+
handler: AutomationHandler;
|
|
2643
|
+
/**
|
|
2644
|
+
* Conditions that trigger the automation. It fires at most once per session when they first become true.
|
|
2645
|
+
* @public
|
|
2646
|
+
*/
|
|
2647
|
+
conditions?: __DocumentType | undefined;
|
|
2648
|
+
company?: string | undefined;
|
|
2649
|
+
automationId: string;
|
|
2650
|
+
/**
|
|
2651
|
+
* Revision this update is based on (optimistic locking).
|
|
2652
|
+
* @public
|
|
2653
|
+
*/
|
|
2654
|
+
revision: number;
|
|
2655
|
+
}
|
|
2656
|
+
/**
|
|
2657
|
+
* @public
|
|
2658
|
+
*/
|
|
2659
|
+
export interface UpdateAutomationOutput {
|
|
2660
|
+
/**
|
|
2661
|
+
* A reusable automation. Referenced by profiles via `automations`.
|
|
2662
|
+
* @public
|
|
2663
|
+
*/
|
|
2664
|
+
automation: Automation;
|
|
2665
|
+
}
|
|
2666
|
+
/**
|
|
2667
|
+
* The editable definition of an evaluation.
|
|
2668
|
+
* @public
|
|
2669
|
+
*/
|
|
2670
|
+
export interface UpdateEvaluationInput {
|
|
2671
|
+
/**
|
|
2672
|
+
* Programmatic evaluation name used in the session state and condition fields, e.g. 'csat'.
|
|
2673
|
+
* @public
|
|
2674
|
+
*/
|
|
2675
|
+
name: string;
|
|
2676
|
+
description?: string | undefined;
|
|
2677
|
+
/**
|
|
2678
|
+
* Prompt the model follows to score the transcript.
|
|
2679
|
+
* @public
|
|
2680
|
+
*/
|
|
2681
|
+
instructions: string;
|
|
2682
|
+
/**
|
|
2683
|
+
* Structured values the evaluation produces.
|
|
2684
|
+
* @public
|
|
2685
|
+
*/
|
|
2686
|
+
fields?: CopilotField[] | undefined;
|
|
2687
|
+
/**
|
|
2688
|
+
* When an evaluation is re-run during a session. Multiple triggers may be enabled.
|
|
2689
|
+
* @public
|
|
2690
|
+
*/
|
|
2691
|
+
triggers: EvaluationTriggers;
|
|
2692
|
+
/**
|
|
2693
|
+
* How much of the transcript the model reads on each run.
|
|
2694
|
+
* @public
|
|
2695
|
+
*/
|
|
2696
|
+
window: EvaluationWindow;
|
|
2697
|
+
/**
|
|
2698
|
+
* Model used for the evaluation. Defaults to the platform default when omitted.
|
|
2699
|
+
* @public
|
|
2700
|
+
*/
|
|
2701
|
+
model?: string | undefined;
|
|
2702
|
+
/**
|
|
2703
|
+
* Optional grouping label for organizing evaluations in the console.
|
|
2704
|
+
* @public
|
|
2705
|
+
*/
|
|
2706
|
+
group?: string | undefined;
|
|
2707
|
+
/**
|
|
2708
|
+
* Extra conditions gating whether this evaluation runs for a session.
|
|
2709
|
+
* @public
|
|
2710
|
+
*/
|
|
2711
|
+
conditions?: __DocumentType | undefined;
|
|
2712
|
+
company?: string | undefined;
|
|
2713
|
+
evaluationId: string;
|
|
2714
|
+
/**
|
|
2715
|
+
* Revision this update is based on (optimistic locking).
|
|
2716
|
+
* @public
|
|
2717
|
+
*/
|
|
2718
|
+
revision: number;
|
|
2719
|
+
}
|
|
2720
|
+
/**
|
|
2721
|
+
* @public
|
|
2722
|
+
*/
|
|
2723
|
+
export interface UpdateEvaluationOutput {
|
|
2724
|
+
/**
|
|
2725
|
+
* A reusable evaluation. Referenced by profiles via `evaluations`.
|
|
2726
|
+
* @public
|
|
2727
|
+
*/
|
|
2728
|
+
evaluation: Evaluation;
|
|
2729
|
+
}
|
|
2730
|
+
/**
|
|
2731
|
+
* The editable definition of an intent.
|
|
2732
|
+
* @public
|
|
2733
|
+
*/
|
|
2734
|
+
export interface UpdateIntentInput {
|
|
2735
|
+
/**
|
|
2736
|
+
* Programmatic intent name used in the session state and condition fields, e.g. 'refund_request'.
|
|
2737
|
+
* @public
|
|
2738
|
+
*/
|
|
2739
|
+
name: string;
|
|
2740
|
+
description?: string | undefined;
|
|
2741
|
+
/**
|
|
2742
|
+
* The detection handlers for an intent. Text matching is attempted first, then AI matching.
|
|
2743
|
+
* @public
|
|
2744
|
+
*/
|
|
2745
|
+
handlers: IntentHandlers;
|
|
2746
|
+
/**
|
|
2747
|
+
* Extra conditions gating whether this intent is evaluated for a session.
|
|
2748
|
+
* @public
|
|
2749
|
+
*/
|
|
2750
|
+
conditions?: __DocumentType | undefined;
|
|
2751
|
+
company?: string | undefined;
|
|
2752
|
+
intentId: string;
|
|
2753
|
+
/**
|
|
2754
|
+
* Revision this update is based on (optimistic locking).
|
|
2755
|
+
* @public
|
|
2756
|
+
*/
|
|
2757
|
+
revision: number;
|
|
2758
|
+
}
|
|
2759
|
+
/**
|
|
2760
|
+
* @public
|
|
2761
|
+
*/
|
|
2762
|
+
export interface UpdateIntentOutput {
|
|
2763
|
+
/**
|
|
2764
|
+
* A reusable intent. Referenced by profiles via `intents`.
|
|
2765
|
+
* @public
|
|
2766
|
+
*/
|
|
2767
|
+
intent: Intent;
|
|
2768
|
+
}
|
|
2769
|
+
/**
|
|
2770
|
+
* Profile fields shared by the editable draft and the published snapshot.
|
|
2771
|
+
* @public
|
|
2772
|
+
*/
|
|
2773
|
+
export interface UpdateProfileInput {
|
|
2774
|
+
name: string;
|
|
2775
|
+
description?: string | undefined;
|
|
2776
|
+
/**
|
|
2777
|
+
* The conversation surface a copilot resource applies to. `calls` targets voice calls, `chats` targets chat conversations, `any` targets both.
|
|
2778
|
+
* @public
|
|
2779
|
+
*/
|
|
2780
|
+
channel: CopilotChannel;
|
|
2781
|
+
/**
|
|
2782
|
+
* Conditions under which the profile matches a conversation. An empty tree always matches.
|
|
2783
|
+
* @public
|
|
2784
|
+
*/
|
|
2785
|
+
conditions?: __DocumentType | undefined;
|
|
2786
|
+
/**
|
|
2787
|
+
* Who the profile assists. Defaults to organization-wide.
|
|
2788
|
+
* @public
|
|
2789
|
+
*/
|
|
2790
|
+
access?: CopilotAccess | undefined;
|
|
2791
|
+
company?: string | undefined;
|
|
2792
|
+
profileId: string;
|
|
2793
|
+
/**
|
|
2794
|
+
* Draft revision this update is based on (optimistic locking). When it does not match the current revision, RevisionConflictException is returned.
|
|
2795
|
+
* @public
|
|
2796
|
+
*/
|
|
2797
|
+
revision: number;
|
|
2798
|
+
}
|
|
2799
|
+
/**
|
|
2800
|
+
* @public
|
|
2801
|
+
*/
|
|
2802
|
+
export interface UpdateProfileOutput {
|
|
2803
|
+
/**
|
|
2804
|
+
* The complete configuration of a profile, including draft lifecycle state. Referenced library resources are listed by id; a published version resolves them into an immutable snapshot.
|
|
2805
|
+
* @public
|
|
2806
|
+
*/
|
|
2807
|
+
profile: Profile;
|
|
2808
|
+
}
|