@operla-ai/sdk 0.3.5 → 0.4.0
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/generated/index.d.ts +2 -2
- package/dist/generated/index.d.ts.map +1 -1
- package/dist/generated/index.js +2 -1
- package/dist/generated/index.js.map +1 -1
- package/dist/generated/sdk.gen.d.ts +49 -11
- package/dist/generated/sdk.gen.d.ts.map +1 -1
- package/dist/generated/sdk.gen.js +84 -1
- package/dist/generated/sdk.gen.js.map +1 -1
- package/dist/generated/types.gen.d.ts +2370 -121
- package/dist/generated/types.gen.d.ts.map +1 -1
- package/dist/index.d.ts +186 -31
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +30 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -50,12 +50,33 @@ export type ListResponses = {
|
|
|
50
50
|
* Successful response
|
|
51
51
|
*/
|
|
52
52
|
200: {
|
|
53
|
+
/**
|
|
54
|
+
* Agents visible at the caller's scope.
|
|
55
|
+
*/
|
|
53
56
|
agents: Array<{
|
|
57
|
+
/**
|
|
58
|
+
* Machine name of the agent (e.g. `orchestrator`, `response`, `specialist_billing`).
|
|
59
|
+
*/
|
|
54
60
|
name: string;
|
|
61
|
+
/**
|
|
62
|
+
* Human-readable label shown in the dashboard.
|
|
63
|
+
*/
|
|
55
64
|
label: string;
|
|
65
|
+
/**
|
|
66
|
+
* Cascade level of this view (global / organization / entity).
|
|
67
|
+
*/
|
|
56
68
|
scope: {
|
|
69
|
+
/**
|
|
70
|
+
* Cascade level this config lives at — `global` (whole tenant), `organization` (per-org override), or `entity` (per-entity override).
|
|
71
|
+
*/
|
|
57
72
|
level: 'global' | 'organization' | 'entity';
|
|
73
|
+
/**
|
|
74
|
+
* ID of the organization when `level` is `organization` or `entity`.
|
|
75
|
+
*/
|
|
58
76
|
organizationId?: string;
|
|
77
|
+
/**
|
|
78
|
+
* ID of the entity when `level` is `entity`.
|
|
79
|
+
*/
|
|
59
80
|
entityId?: string;
|
|
60
81
|
};
|
|
61
82
|
/**
|
|
@@ -84,12 +105,58 @@ export type CreateData = {
|
|
|
84
105
|
* Hard rules to attach to the agent at creation.
|
|
85
106
|
*/
|
|
86
107
|
hardRules?: Array<{
|
|
108
|
+
/**
|
|
109
|
+
* Stable identifier for the rule. Also used as the merge key when this rule is overridden at a deeper scope (organization/entity).
|
|
110
|
+
*/
|
|
87
111
|
name: string;
|
|
112
|
+
/**
|
|
113
|
+
* Plain-text instruction injected into the agent's prompt. The agent must always respect it.
|
|
114
|
+
*/
|
|
88
115
|
instruction: string;
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
116
|
+
/**
|
|
117
|
+
* Restrict the rule to specific intents. Empty array = the rule applies on every turn regardless of intent.
|
|
118
|
+
*/
|
|
119
|
+
intents?: Array<string>;
|
|
120
|
+
/**
|
|
121
|
+
* Relative priority within the agent's rule set (0–100, higher first). Use it to order conflicting rules; values are not absolute.
|
|
122
|
+
*/
|
|
92
123
|
priority?: number;
|
|
124
|
+
/**
|
|
125
|
+
* Set on an override doc to filter out an inherited rule of the same name at runtime. The rule shape is kept so toggling back works.
|
|
126
|
+
*/
|
|
127
|
+
disabled?: boolean;
|
|
128
|
+
}>;
|
|
129
|
+
/**
|
|
130
|
+
* Few-shot examples to attach to the agent at creation.
|
|
131
|
+
*/
|
|
132
|
+
examples?: Array<{
|
|
133
|
+
/**
|
|
134
|
+
* Stable identifier for the example. Also used as the merge key when this example is overridden at a deeper scope (organization/entity).
|
|
135
|
+
*/
|
|
136
|
+
name?: string;
|
|
137
|
+
/**
|
|
138
|
+
* Short human-readable description of the scenario this example illustrates.
|
|
139
|
+
*/
|
|
140
|
+
description: string;
|
|
141
|
+
/**
|
|
142
|
+
* User message used as the example input.
|
|
143
|
+
*/
|
|
144
|
+
input: string;
|
|
145
|
+
/**
|
|
146
|
+
* Expected agent output. Shape depends on the agent type (structured JSON for orchestrator/specialist, plain text for response). Write outputs in English — the runtime LLM transposes them into the user's language.
|
|
147
|
+
*/
|
|
148
|
+
output?: unknown;
|
|
149
|
+
/**
|
|
150
|
+
* Optional scenario context (user data, KB facts, previous decisions) attached to this example for the agent to read alongside the input.
|
|
151
|
+
*/
|
|
152
|
+
context?: unknown;
|
|
153
|
+
/**
|
|
154
|
+
* Restrict the example to specific intents. Applied at runtime by specialist and response agents — the orchestrator ignores it since it runs before intent detection. Empty array = the example applies regardless of intent.
|
|
155
|
+
*/
|
|
156
|
+
intents?: Array<string>;
|
|
157
|
+
/**
|
|
158
|
+
* Set on an override doc to filter out an inherited example of the same name at runtime.
|
|
159
|
+
*/
|
|
93
160
|
disabled?: boolean;
|
|
94
161
|
}>;
|
|
95
162
|
};
|
|
@@ -135,87 +202,317 @@ export type CreateResponses = {
|
|
|
135
202
|
* Successful response
|
|
136
203
|
*/
|
|
137
204
|
200: {
|
|
205
|
+
/**
|
|
206
|
+
* Machine name of the agent (e.g. `orchestrator`, `response`, `specialist_billing`).
|
|
207
|
+
*/
|
|
138
208
|
name: string;
|
|
209
|
+
/**
|
|
210
|
+
* Human-readable label shown in the dashboard.
|
|
211
|
+
*/
|
|
139
212
|
label: string;
|
|
213
|
+
/**
|
|
214
|
+
* Cascade level of this view (global / organization / entity).
|
|
215
|
+
*/
|
|
140
216
|
scope: {
|
|
217
|
+
/**
|
|
218
|
+
* Cascade level this config lives at — `global` (whole tenant), `organization` (per-org override), or `entity` (per-entity override).
|
|
219
|
+
*/
|
|
141
220
|
level: 'global' | 'organization' | 'entity';
|
|
221
|
+
/**
|
|
222
|
+
* ID of the organization when `level` is `organization` or `entity`.
|
|
223
|
+
*/
|
|
142
224
|
organizationId?: string;
|
|
225
|
+
/**
|
|
226
|
+
* ID of the entity when `level` is `entity`.
|
|
227
|
+
*/
|
|
143
228
|
entityId?: string;
|
|
144
229
|
};
|
|
145
230
|
/**
|
|
146
231
|
* The agent config the runtime sees at the request scope, after cascade resolution.
|
|
147
232
|
*/
|
|
148
233
|
resolved: {
|
|
234
|
+
/**
|
|
235
|
+
* Monotonic version number of this snapshot at its scope.
|
|
236
|
+
*/
|
|
149
237
|
version: number;
|
|
238
|
+
/**
|
|
239
|
+
* System prompt active in this snapshot. Omitted on override snapshots that inherit the prompt from the cascade.
|
|
240
|
+
*/
|
|
150
241
|
prompt?: string;
|
|
242
|
+
/**
|
|
243
|
+
* Resolved list of hard rules. On override snapshots, may be omitted when the override doesn't customise rules.
|
|
244
|
+
*/
|
|
151
245
|
hardRules?: Array<{
|
|
246
|
+
/**
|
|
247
|
+
* Stable identifier for the rule. Also used as the merge key when this rule is overridden at a deeper scope (organization/entity).
|
|
248
|
+
*/
|
|
152
249
|
name: string;
|
|
250
|
+
/**
|
|
251
|
+
* Plain-text instruction injected into the agent's prompt. The agent must always respect it.
|
|
252
|
+
*/
|
|
153
253
|
instruction: string;
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
254
|
+
/**
|
|
255
|
+
* Restrict the rule to specific intents. Empty array = the rule applies on every turn regardless of intent.
|
|
256
|
+
*/
|
|
257
|
+
intents?: Array<string>;
|
|
258
|
+
/**
|
|
259
|
+
* Relative priority within the agent's rule set (0–100, higher first). Use it to order conflicting rules; values are not absolute.
|
|
260
|
+
*/
|
|
157
261
|
priority?: number;
|
|
262
|
+
/**
|
|
263
|
+
* Set on an override doc to filter out an inherited rule of the same name at runtime. The rule shape is kept so toggling back works.
|
|
264
|
+
*/
|
|
265
|
+
disabled?: boolean;
|
|
266
|
+
}>;
|
|
267
|
+
/**
|
|
268
|
+
* Resolved list of few-shot examples. On override snapshots, may be omitted when the override doesn't customise examples.
|
|
269
|
+
*/
|
|
270
|
+
examples?: Array<{
|
|
271
|
+
/**
|
|
272
|
+
* Stable identifier for the example. Also used as the merge key when this example is overridden at a deeper scope (organization/entity).
|
|
273
|
+
*/
|
|
274
|
+
name?: string;
|
|
275
|
+
/**
|
|
276
|
+
* Short human-readable description of the scenario this example illustrates.
|
|
277
|
+
*/
|
|
278
|
+
description: string;
|
|
279
|
+
/**
|
|
280
|
+
* User message used as the example input.
|
|
281
|
+
*/
|
|
282
|
+
input: string;
|
|
283
|
+
/**
|
|
284
|
+
* Expected agent output. Shape depends on the agent type (structured JSON for orchestrator/specialist, plain text for response). Write outputs in English — the runtime LLM transposes them into the user's language.
|
|
285
|
+
*/
|
|
286
|
+
output?: unknown;
|
|
287
|
+
/**
|
|
288
|
+
* Optional scenario context (user data, KB facts, previous decisions) attached to this example for the agent to read alongside the input.
|
|
289
|
+
*/
|
|
290
|
+
context?: unknown;
|
|
291
|
+
/**
|
|
292
|
+
* Restrict the example to specific intents. Applied at runtime by specialist and response agents — the orchestrator ignores it since it runs before intent detection. Empty array = the example applies regardless of intent.
|
|
293
|
+
*/
|
|
294
|
+
intents?: Array<string>;
|
|
295
|
+
/**
|
|
296
|
+
* Set on an override doc to filter out an inherited example of the same name at runtime.
|
|
297
|
+
*/
|
|
158
298
|
disabled?: boolean;
|
|
159
299
|
}>;
|
|
300
|
+
/**
|
|
301
|
+
* Toggled user-context fields exposed to the agent.
|
|
302
|
+
*/
|
|
160
303
|
userContextConfig?: {
|
|
161
304
|
[key: string]: boolean;
|
|
162
305
|
};
|
|
306
|
+
/**
|
|
307
|
+
* Per-channel writing style (response agent only).
|
|
308
|
+
*/
|
|
163
309
|
responseConfig?: {
|
|
310
|
+
/**
|
|
311
|
+
* Writing style applied when the conversation channel is email.
|
|
312
|
+
*/
|
|
164
313
|
email?: {
|
|
314
|
+
/**
|
|
315
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
316
|
+
*/
|
|
165
317
|
greeting?: string;
|
|
318
|
+
/**
|
|
319
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
320
|
+
*/
|
|
166
321
|
signature?: string;
|
|
322
|
+
/**
|
|
323
|
+
* Writing tone for this channel.
|
|
324
|
+
*/
|
|
167
325
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
326
|
+
/**
|
|
327
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
328
|
+
*/
|
|
168
329
|
addressForm?: 'formal' | 'informal';
|
|
330
|
+
/**
|
|
331
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
332
|
+
*/
|
|
169
333
|
allowEmojis?: boolean;
|
|
170
334
|
};
|
|
335
|
+
/**
|
|
336
|
+
* Writing style applied when the conversation channel is chat.
|
|
337
|
+
*/
|
|
171
338
|
chat?: {
|
|
339
|
+
/**
|
|
340
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
341
|
+
*/
|
|
172
342
|
greeting?: string;
|
|
343
|
+
/**
|
|
344
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
345
|
+
*/
|
|
173
346
|
signature?: string;
|
|
347
|
+
/**
|
|
348
|
+
* Writing tone for this channel.
|
|
349
|
+
*/
|
|
174
350
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
351
|
+
/**
|
|
352
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
353
|
+
*/
|
|
175
354
|
addressForm?: 'formal' | 'informal';
|
|
355
|
+
/**
|
|
356
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
357
|
+
*/
|
|
176
358
|
allowEmojis?: boolean;
|
|
177
359
|
};
|
|
178
360
|
};
|
|
361
|
+
/**
|
|
362
|
+
* Optional release note attached when this version was published.
|
|
363
|
+
*/
|
|
179
364
|
message?: string;
|
|
365
|
+
/**
|
|
366
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
367
|
+
*/
|
|
180
368
|
publishedAt?: string;
|
|
369
|
+
/**
|
|
370
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
371
|
+
*/
|
|
181
372
|
updatedAt?: string;
|
|
182
373
|
};
|
|
183
374
|
/**
|
|
184
375
|
* Override draft at this scope, when one exists.
|
|
185
376
|
*/
|
|
186
377
|
draft?: {
|
|
378
|
+
/**
|
|
379
|
+
* Monotonic version number of this snapshot at its scope.
|
|
380
|
+
*/
|
|
187
381
|
version: number;
|
|
382
|
+
/**
|
|
383
|
+
* System prompt active in this snapshot. Omitted on override snapshots that inherit the prompt from the cascade.
|
|
384
|
+
*/
|
|
188
385
|
prompt?: string;
|
|
386
|
+
/**
|
|
387
|
+
* Resolved list of hard rules. On override snapshots, may be omitted when the override doesn't customise rules.
|
|
388
|
+
*/
|
|
189
389
|
hardRules?: Array<{
|
|
390
|
+
/**
|
|
391
|
+
* Stable identifier for the rule. Also used as the merge key when this rule is overridden at a deeper scope (organization/entity).
|
|
392
|
+
*/
|
|
190
393
|
name: string;
|
|
394
|
+
/**
|
|
395
|
+
* Plain-text instruction injected into the agent's prompt. The agent must always respect it.
|
|
396
|
+
*/
|
|
191
397
|
instruction: string;
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
398
|
+
/**
|
|
399
|
+
* Restrict the rule to specific intents. Empty array = the rule applies on every turn regardless of intent.
|
|
400
|
+
*/
|
|
401
|
+
intents?: Array<string>;
|
|
402
|
+
/**
|
|
403
|
+
* Relative priority within the agent's rule set (0–100, higher first). Use it to order conflicting rules; values are not absolute.
|
|
404
|
+
*/
|
|
195
405
|
priority?: number;
|
|
406
|
+
/**
|
|
407
|
+
* Set on an override doc to filter out an inherited rule of the same name at runtime. The rule shape is kept so toggling back works.
|
|
408
|
+
*/
|
|
409
|
+
disabled?: boolean;
|
|
410
|
+
}>;
|
|
411
|
+
/**
|
|
412
|
+
* Resolved list of few-shot examples. On override snapshots, may be omitted when the override doesn't customise examples.
|
|
413
|
+
*/
|
|
414
|
+
examples?: Array<{
|
|
415
|
+
/**
|
|
416
|
+
* Stable identifier for the example. Also used as the merge key when this example is overridden at a deeper scope (organization/entity).
|
|
417
|
+
*/
|
|
418
|
+
name?: string;
|
|
419
|
+
/**
|
|
420
|
+
* Short human-readable description of the scenario this example illustrates.
|
|
421
|
+
*/
|
|
422
|
+
description: string;
|
|
423
|
+
/**
|
|
424
|
+
* User message used as the example input.
|
|
425
|
+
*/
|
|
426
|
+
input: string;
|
|
427
|
+
/**
|
|
428
|
+
* Expected agent output. Shape depends on the agent type (structured JSON for orchestrator/specialist, plain text for response). Write outputs in English — the runtime LLM transposes them into the user's language.
|
|
429
|
+
*/
|
|
430
|
+
output?: unknown;
|
|
431
|
+
/**
|
|
432
|
+
* Optional scenario context (user data, KB facts, previous decisions) attached to this example for the agent to read alongside the input.
|
|
433
|
+
*/
|
|
434
|
+
context?: unknown;
|
|
435
|
+
/**
|
|
436
|
+
* Restrict the example to specific intents. Applied at runtime by specialist and response agents — the orchestrator ignores it since it runs before intent detection. Empty array = the example applies regardless of intent.
|
|
437
|
+
*/
|
|
438
|
+
intents?: Array<string>;
|
|
439
|
+
/**
|
|
440
|
+
* Set on an override doc to filter out an inherited example of the same name at runtime.
|
|
441
|
+
*/
|
|
196
442
|
disabled?: boolean;
|
|
197
443
|
}>;
|
|
444
|
+
/**
|
|
445
|
+
* Toggled user-context fields exposed to the agent.
|
|
446
|
+
*/
|
|
198
447
|
userContextConfig?: {
|
|
199
448
|
[key: string]: boolean;
|
|
200
449
|
};
|
|
450
|
+
/**
|
|
451
|
+
* Per-channel writing style (response agent only).
|
|
452
|
+
*/
|
|
201
453
|
responseConfig?: {
|
|
454
|
+
/**
|
|
455
|
+
* Writing style applied when the conversation channel is email.
|
|
456
|
+
*/
|
|
202
457
|
email?: {
|
|
458
|
+
/**
|
|
459
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
460
|
+
*/
|
|
203
461
|
greeting?: string;
|
|
462
|
+
/**
|
|
463
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
464
|
+
*/
|
|
204
465
|
signature?: string;
|
|
466
|
+
/**
|
|
467
|
+
* Writing tone for this channel.
|
|
468
|
+
*/
|
|
205
469
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
470
|
+
/**
|
|
471
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
472
|
+
*/
|
|
206
473
|
addressForm?: 'formal' | 'informal';
|
|
474
|
+
/**
|
|
475
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
476
|
+
*/
|
|
207
477
|
allowEmojis?: boolean;
|
|
208
478
|
};
|
|
479
|
+
/**
|
|
480
|
+
* Writing style applied when the conversation channel is chat.
|
|
481
|
+
*/
|
|
209
482
|
chat?: {
|
|
483
|
+
/**
|
|
484
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
485
|
+
*/
|
|
210
486
|
greeting?: string;
|
|
487
|
+
/**
|
|
488
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
489
|
+
*/
|
|
211
490
|
signature?: string;
|
|
491
|
+
/**
|
|
492
|
+
* Writing tone for this channel.
|
|
493
|
+
*/
|
|
212
494
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
495
|
+
/**
|
|
496
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
497
|
+
*/
|
|
213
498
|
addressForm?: 'formal' | 'informal';
|
|
499
|
+
/**
|
|
500
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
501
|
+
*/
|
|
214
502
|
allowEmojis?: boolean;
|
|
215
503
|
};
|
|
216
504
|
};
|
|
505
|
+
/**
|
|
506
|
+
* Optional release note attached when this version was published.
|
|
507
|
+
*/
|
|
217
508
|
message?: string;
|
|
509
|
+
/**
|
|
510
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
511
|
+
*/
|
|
218
512
|
publishedAt?: string;
|
|
513
|
+
/**
|
|
514
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
515
|
+
*/
|
|
219
516
|
updatedAt?: string;
|
|
220
517
|
};
|
|
221
518
|
};
|
|
@@ -270,6 +567,9 @@ export type DeleteResponses = {
|
|
|
270
567
|
* Successful response
|
|
271
568
|
*/
|
|
272
569
|
200: {
|
|
570
|
+
/**
|
|
571
|
+
* Confirmation message describing the deletion outcome.
|
|
572
|
+
*/
|
|
273
573
|
message: string;
|
|
274
574
|
};
|
|
275
575
|
};
|
|
@@ -328,87 +628,317 @@ export type GetResponses = {
|
|
|
328
628
|
* Successful response
|
|
329
629
|
*/
|
|
330
630
|
200: {
|
|
631
|
+
/**
|
|
632
|
+
* Machine name of the agent (e.g. `orchestrator`, `response`, `specialist_billing`).
|
|
633
|
+
*/
|
|
331
634
|
name: string;
|
|
635
|
+
/**
|
|
636
|
+
* Human-readable label shown in the dashboard.
|
|
637
|
+
*/
|
|
332
638
|
label: string;
|
|
639
|
+
/**
|
|
640
|
+
* Cascade level of this view (global / organization / entity).
|
|
641
|
+
*/
|
|
333
642
|
scope: {
|
|
643
|
+
/**
|
|
644
|
+
* Cascade level this config lives at — `global` (whole tenant), `organization` (per-org override), or `entity` (per-entity override).
|
|
645
|
+
*/
|
|
334
646
|
level: 'global' | 'organization' | 'entity';
|
|
647
|
+
/**
|
|
648
|
+
* ID of the organization when `level` is `organization` or `entity`.
|
|
649
|
+
*/
|
|
335
650
|
organizationId?: string;
|
|
651
|
+
/**
|
|
652
|
+
* ID of the entity when `level` is `entity`.
|
|
653
|
+
*/
|
|
336
654
|
entityId?: string;
|
|
337
655
|
};
|
|
338
656
|
/**
|
|
339
657
|
* The agent config the runtime sees at the request scope, after cascade resolution.
|
|
340
658
|
*/
|
|
341
659
|
resolved: {
|
|
660
|
+
/**
|
|
661
|
+
* Monotonic version number of this snapshot at its scope.
|
|
662
|
+
*/
|
|
342
663
|
version: number;
|
|
664
|
+
/**
|
|
665
|
+
* System prompt active in this snapshot. Omitted on override snapshots that inherit the prompt from the cascade.
|
|
666
|
+
*/
|
|
343
667
|
prompt?: string;
|
|
668
|
+
/**
|
|
669
|
+
* Resolved list of hard rules. On override snapshots, may be omitted when the override doesn't customise rules.
|
|
670
|
+
*/
|
|
344
671
|
hardRules?: Array<{
|
|
672
|
+
/**
|
|
673
|
+
* Stable identifier for the rule. Also used as the merge key when this rule is overridden at a deeper scope (organization/entity).
|
|
674
|
+
*/
|
|
345
675
|
name: string;
|
|
676
|
+
/**
|
|
677
|
+
* Plain-text instruction injected into the agent's prompt. The agent must always respect it.
|
|
678
|
+
*/
|
|
346
679
|
instruction: string;
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
680
|
+
/**
|
|
681
|
+
* Restrict the rule to specific intents. Empty array = the rule applies on every turn regardless of intent.
|
|
682
|
+
*/
|
|
683
|
+
intents?: Array<string>;
|
|
684
|
+
/**
|
|
685
|
+
* Relative priority within the agent's rule set (0–100, higher first). Use it to order conflicting rules; values are not absolute.
|
|
686
|
+
*/
|
|
350
687
|
priority?: number;
|
|
688
|
+
/**
|
|
689
|
+
* Set on an override doc to filter out an inherited rule of the same name at runtime. The rule shape is kept so toggling back works.
|
|
690
|
+
*/
|
|
351
691
|
disabled?: boolean;
|
|
352
692
|
}>;
|
|
693
|
+
/**
|
|
694
|
+
* Resolved list of few-shot examples. On override snapshots, may be omitted when the override doesn't customise examples.
|
|
695
|
+
*/
|
|
696
|
+
examples?: Array<{
|
|
697
|
+
/**
|
|
698
|
+
* Stable identifier for the example. Also used as the merge key when this example is overridden at a deeper scope (organization/entity).
|
|
699
|
+
*/
|
|
700
|
+
name?: string;
|
|
701
|
+
/**
|
|
702
|
+
* Short human-readable description of the scenario this example illustrates.
|
|
703
|
+
*/
|
|
704
|
+
description: string;
|
|
705
|
+
/**
|
|
706
|
+
* User message used as the example input.
|
|
707
|
+
*/
|
|
708
|
+
input: string;
|
|
709
|
+
/**
|
|
710
|
+
* Expected agent output. Shape depends on the agent type (structured JSON for orchestrator/specialist, plain text for response). Write outputs in English — the runtime LLM transposes them into the user's language.
|
|
711
|
+
*/
|
|
712
|
+
output?: unknown;
|
|
713
|
+
/**
|
|
714
|
+
* Optional scenario context (user data, KB facts, previous decisions) attached to this example for the agent to read alongside the input.
|
|
715
|
+
*/
|
|
716
|
+
context?: unknown;
|
|
717
|
+
/**
|
|
718
|
+
* Restrict the example to specific intents. Applied at runtime by specialist and response agents — the orchestrator ignores it since it runs before intent detection. Empty array = the example applies regardless of intent.
|
|
719
|
+
*/
|
|
720
|
+
intents?: Array<string>;
|
|
721
|
+
/**
|
|
722
|
+
* Set on an override doc to filter out an inherited example of the same name at runtime.
|
|
723
|
+
*/
|
|
724
|
+
disabled?: boolean;
|
|
725
|
+
}>;
|
|
726
|
+
/**
|
|
727
|
+
* Toggled user-context fields exposed to the agent.
|
|
728
|
+
*/
|
|
353
729
|
userContextConfig?: {
|
|
354
730
|
[key: string]: boolean;
|
|
355
731
|
};
|
|
732
|
+
/**
|
|
733
|
+
* Per-channel writing style (response agent only).
|
|
734
|
+
*/
|
|
356
735
|
responseConfig?: {
|
|
736
|
+
/**
|
|
737
|
+
* Writing style applied when the conversation channel is email.
|
|
738
|
+
*/
|
|
357
739
|
email?: {
|
|
740
|
+
/**
|
|
741
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
742
|
+
*/
|
|
358
743
|
greeting?: string;
|
|
744
|
+
/**
|
|
745
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
746
|
+
*/
|
|
359
747
|
signature?: string;
|
|
748
|
+
/**
|
|
749
|
+
* Writing tone for this channel.
|
|
750
|
+
*/
|
|
360
751
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
752
|
+
/**
|
|
753
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
754
|
+
*/
|
|
361
755
|
addressForm?: 'formal' | 'informal';
|
|
756
|
+
/**
|
|
757
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
758
|
+
*/
|
|
362
759
|
allowEmojis?: boolean;
|
|
363
760
|
};
|
|
761
|
+
/**
|
|
762
|
+
* Writing style applied when the conversation channel is chat.
|
|
763
|
+
*/
|
|
364
764
|
chat?: {
|
|
765
|
+
/**
|
|
766
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
767
|
+
*/
|
|
365
768
|
greeting?: string;
|
|
769
|
+
/**
|
|
770
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
771
|
+
*/
|
|
366
772
|
signature?: string;
|
|
773
|
+
/**
|
|
774
|
+
* Writing tone for this channel.
|
|
775
|
+
*/
|
|
367
776
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
777
|
+
/**
|
|
778
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
779
|
+
*/
|
|
368
780
|
addressForm?: 'formal' | 'informal';
|
|
781
|
+
/**
|
|
782
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
783
|
+
*/
|
|
369
784
|
allowEmojis?: boolean;
|
|
370
785
|
};
|
|
371
786
|
};
|
|
787
|
+
/**
|
|
788
|
+
* Optional release note attached when this version was published.
|
|
789
|
+
*/
|
|
372
790
|
message?: string;
|
|
791
|
+
/**
|
|
792
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
793
|
+
*/
|
|
373
794
|
publishedAt?: string;
|
|
795
|
+
/**
|
|
796
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
797
|
+
*/
|
|
374
798
|
updatedAt?: string;
|
|
375
799
|
};
|
|
376
800
|
/**
|
|
377
801
|
* Override draft at this scope, when one exists.
|
|
378
802
|
*/
|
|
379
803
|
draft?: {
|
|
804
|
+
/**
|
|
805
|
+
* Monotonic version number of this snapshot at its scope.
|
|
806
|
+
*/
|
|
380
807
|
version: number;
|
|
808
|
+
/**
|
|
809
|
+
* System prompt active in this snapshot. Omitted on override snapshots that inherit the prompt from the cascade.
|
|
810
|
+
*/
|
|
381
811
|
prompt?: string;
|
|
812
|
+
/**
|
|
813
|
+
* Resolved list of hard rules. On override snapshots, may be omitted when the override doesn't customise rules.
|
|
814
|
+
*/
|
|
382
815
|
hardRules?: Array<{
|
|
816
|
+
/**
|
|
817
|
+
* Stable identifier for the rule. Also used as the merge key when this rule is overridden at a deeper scope (organization/entity).
|
|
818
|
+
*/
|
|
383
819
|
name: string;
|
|
820
|
+
/**
|
|
821
|
+
* Plain-text instruction injected into the agent's prompt. The agent must always respect it.
|
|
822
|
+
*/
|
|
384
823
|
instruction: string;
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
824
|
+
/**
|
|
825
|
+
* Restrict the rule to specific intents. Empty array = the rule applies on every turn regardless of intent.
|
|
826
|
+
*/
|
|
827
|
+
intents?: Array<string>;
|
|
828
|
+
/**
|
|
829
|
+
* Relative priority within the agent's rule set (0–100, higher first). Use it to order conflicting rules; values are not absolute.
|
|
830
|
+
*/
|
|
388
831
|
priority?: number;
|
|
832
|
+
/**
|
|
833
|
+
* Set on an override doc to filter out an inherited rule of the same name at runtime. The rule shape is kept so toggling back works.
|
|
834
|
+
*/
|
|
389
835
|
disabled?: boolean;
|
|
390
836
|
}>;
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
837
|
+
/**
|
|
838
|
+
* Resolved list of few-shot examples. On override snapshots, may be omitted when the override doesn't customise examples.
|
|
839
|
+
*/
|
|
840
|
+
examples?: Array<{
|
|
841
|
+
/**
|
|
842
|
+
* Stable identifier for the example. Also used as the merge key when this example is overridden at a deeper scope (organization/entity).
|
|
843
|
+
*/
|
|
844
|
+
name?: string;
|
|
845
|
+
/**
|
|
846
|
+
* Short human-readable description of the scenario this example illustrates.
|
|
847
|
+
*/
|
|
848
|
+
description: string;
|
|
849
|
+
/**
|
|
850
|
+
* User message used as the example input.
|
|
851
|
+
*/
|
|
852
|
+
input: string;
|
|
853
|
+
/**
|
|
854
|
+
* Expected agent output. Shape depends on the agent type (structured JSON for orchestrator/specialist, plain text for response). Write outputs in English — the runtime LLM transposes them into the user's language.
|
|
855
|
+
*/
|
|
856
|
+
output?: unknown;
|
|
857
|
+
/**
|
|
858
|
+
* Optional scenario context (user data, KB facts, previous decisions) attached to this example for the agent to read alongside the input.
|
|
859
|
+
*/
|
|
860
|
+
context?: unknown;
|
|
861
|
+
/**
|
|
862
|
+
* Restrict the example to specific intents. Applied at runtime by specialist and response agents — the orchestrator ignores it since it runs before intent detection. Empty array = the example applies regardless of intent.
|
|
863
|
+
*/
|
|
864
|
+
intents?: Array<string>;
|
|
865
|
+
/**
|
|
866
|
+
* Set on an override doc to filter out an inherited example of the same name at runtime.
|
|
867
|
+
*/
|
|
868
|
+
disabled?: boolean;
|
|
869
|
+
}>;
|
|
870
|
+
/**
|
|
871
|
+
* Toggled user-context fields exposed to the agent.
|
|
872
|
+
*/
|
|
873
|
+
userContextConfig?: {
|
|
874
|
+
[key: string]: boolean;
|
|
875
|
+
};
|
|
876
|
+
/**
|
|
877
|
+
* Per-channel writing style (response agent only).
|
|
878
|
+
*/
|
|
879
|
+
responseConfig?: {
|
|
880
|
+
/**
|
|
881
|
+
* Writing style applied when the conversation channel is email.
|
|
882
|
+
*/
|
|
883
|
+
email?: {
|
|
884
|
+
/**
|
|
885
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
886
|
+
*/
|
|
887
|
+
greeting?: string;
|
|
888
|
+
/**
|
|
889
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
890
|
+
*/
|
|
891
|
+
signature?: string;
|
|
892
|
+
/**
|
|
893
|
+
* Writing tone for this channel.
|
|
894
|
+
*/
|
|
895
|
+
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
896
|
+
/**
|
|
897
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
898
|
+
*/
|
|
899
|
+
addressForm?: 'formal' | 'informal';
|
|
900
|
+
/**
|
|
901
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
902
|
+
*/
|
|
903
|
+
allowEmojis?: boolean;
|
|
904
|
+
};
|
|
905
|
+
/**
|
|
906
|
+
* Writing style applied when the conversation channel is chat.
|
|
907
|
+
*/
|
|
908
|
+
chat?: {
|
|
909
|
+
/**
|
|
910
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
911
|
+
*/
|
|
912
|
+
greeting?: string;
|
|
913
|
+
/**
|
|
914
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
915
|
+
*/
|
|
404
916
|
signature?: string;
|
|
917
|
+
/**
|
|
918
|
+
* Writing tone for this channel.
|
|
919
|
+
*/
|
|
405
920
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
921
|
+
/**
|
|
922
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
923
|
+
*/
|
|
406
924
|
addressForm?: 'formal' | 'informal';
|
|
925
|
+
/**
|
|
926
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
927
|
+
*/
|
|
407
928
|
allowEmojis?: boolean;
|
|
408
929
|
};
|
|
409
930
|
};
|
|
931
|
+
/**
|
|
932
|
+
* Optional release note attached when this version was published.
|
|
933
|
+
*/
|
|
410
934
|
message?: string;
|
|
935
|
+
/**
|
|
936
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
937
|
+
*/
|
|
411
938
|
publishedAt?: string;
|
|
939
|
+
/**
|
|
940
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
941
|
+
*/
|
|
412
942
|
updatedAt?: string;
|
|
413
943
|
};
|
|
414
944
|
};
|
|
@@ -424,12 +954,58 @@ export type UpdateData = {
|
|
|
424
954
|
* Constraints the agent must follow, injected into its prompt.
|
|
425
955
|
*/
|
|
426
956
|
hardRules?: Array<{
|
|
957
|
+
/**
|
|
958
|
+
* Stable identifier for the rule. Also used as the merge key when this rule is overridden at a deeper scope (organization/entity).
|
|
959
|
+
*/
|
|
427
960
|
name: string;
|
|
961
|
+
/**
|
|
962
|
+
* Plain-text instruction injected into the agent's prompt. The agent must always respect it.
|
|
963
|
+
*/
|
|
428
964
|
instruction: string;
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
965
|
+
/**
|
|
966
|
+
* Restrict the rule to specific intents. Empty array = the rule applies on every turn regardless of intent.
|
|
967
|
+
*/
|
|
968
|
+
intents?: Array<string>;
|
|
969
|
+
/**
|
|
970
|
+
* Relative priority within the agent's rule set (0–100, higher first). Use it to order conflicting rules; values are not absolute.
|
|
971
|
+
*/
|
|
432
972
|
priority?: number;
|
|
973
|
+
/**
|
|
974
|
+
* Set on an override doc to filter out an inherited rule of the same name at runtime. The rule shape is kept so toggling back works.
|
|
975
|
+
*/
|
|
976
|
+
disabled?: boolean;
|
|
977
|
+
}>;
|
|
978
|
+
/**
|
|
979
|
+
* Few-shot examples shown to the agent in its prompt. Use them to demonstrate input → output patterns.
|
|
980
|
+
*/
|
|
981
|
+
examples?: Array<{
|
|
982
|
+
/**
|
|
983
|
+
* Stable identifier for the example. Also used as the merge key when this example is overridden at a deeper scope (organization/entity).
|
|
984
|
+
*/
|
|
985
|
+
name?: string;
|
|
986
|
+
/**
|
|
987
|
+
* Short human-readable description of the scenario this example illustrates.
|
|
988
|
+
*/
|
|
989
|
+
description: string;
|
|
990
|
+
/**
|
|
991
|
+
* User message used as the example input.
|
|
992
|
+
*/
|
|
993
|
+
input: string;
|
|
994
|
+
/**
|
|
995
|
+
* Expected agent output. Shape depends on the agent type (structured JSON for orchestrator/specialist, plain text for response). Write outputs in English — the runtime LLM transposes them into the user's language.
|
|
996
|
+
*/
|
|
997
|
+
output?: unknown;
|
|
998
|
+
/**
|
|
999
|
+
* Optional scenario context (user data, KB facts, previous decisions) attached to this example for the agent to read alongside the input.
|
|
1000
|
+
*/
|
|
1001
|
+
context?: unknown;
|
|
1002
|
+
/**
|
|
1003
|
+
* Restrict the example to specific intents. Applied at runtime by specialist and response agents — the orchestrator ignores it since it runs before intent detection. Empty array = the example applies regardless of intent.
|
|
1004
|
+
*/
|
|
1005
|
+
intents?: Array<string>;
|
|
1006
|
+
/**
|
|
1007
|
+
* Set on an override doc to filter out an inherited example of the same name at runtime.
|
|
1008
|
+
*/
|
|
433
1009
|
disabled?: boolean;
|
|
434
1010
|
}>;
|
|
435
1011
|
/**
|
|
@@ -442,18 +1018,54 @@ export type UpdateData = {
|
|
|
442
1018
|
* Per-channel writing style. Editable on the response agent only.
|
|
443
1019
|
*/
|
|
444
1020
|
responseConfig?: {
|
|
1021
|
+
/**
|
|
1022
|
+
* Writing style applied when the conversation channel is email.
|
|
1023
|
+
*/
|
|
445
1024
|
email?: {
|
|
1025
|
+
/**
|
|
1026
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
1027
|
+
*/
|
|
446
1028
|
greeting?: string;
|
|
1029
|
+
/**
|
|
1030
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
1031
|
+
*/
|
|
447
1032
|
signature?: string;
|
|
1033
|
+
/**
|
|
1034
|
+
* Writing tone for this channel.
|
|
1035
|
+
*/
|
|
448
1036
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
1037
|
+
/**
|
|
1038
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
1039
|
+
*/
|
|
449
1040
|
addressForm?: 'formal' | 'informal';
|
|
1041
|
+
/**
|
|
1042
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
1043
|
+
*/
|
|
450
1044
|
allowEmojis?: boolean;
|
|
451
1045
|
};
|
|
1046
|
+
/**
|
|
1047
|
+
* Writing style applied when the conversation channel is chat.
|
|
1048
|
+
*/
|
|
452
1049
|
chat?: {
|
|
1050
|
+
/**
|
|
1051
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
1052
|
+
*/
|
|
453
1053
|
greeting?: string;
|
|
1054
|
+
/**
|
|
1055
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
1056
|
+
*/
|
|
454
1057
|
signature?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* Writing tone for this channel.
|
|
1060
|
+
*/
|
|
455
1061
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
1062
|
+
/**
|
|
1063
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
1064
|
+
*/
|
|
456
1065
|
addressForm?: 'formal' | 'informal';
|
|
1066
|
+
/**
|
|
1067
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
1068
|
+
*/
|
|
457
1069
|
allowEmojis?: boolean;
|
|
458
1070
|
};
|
|
459
1071
|
};
|
|
@@ -514,87 +1126,317 @@ export type UpdateResponses = {
|
|
|
514
1126
|
* Successful response
|
|
515
1127
|
*/
|
|
516
1128
|
200: {
|
|
1129
|
+
/**
|
|
1130
|
+
* Machine name of the agent (e.g. `orchestrator`, `response`, `specialist_billing`).
|
|
1131
|
+
*/
|
|
517
1132
|
name: string;
|
|
1133
|
+
/**
|
|
1134
|
+
* Human-readable label shown in the dashboard.
|
|
1135
|
+
*/
|
|
518
1136
|
label: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* Cascade level of this view (global / organization / entity).
|
|
1139
|
+
*/
|
|
519
1140
|
scope: {
|
|
1141
|
+
/**
|
|
1142
|
+
* Cascade level this config lives at — `global` (whole tenant), `organization` (per-org override), or `entity` (per-entity override).
|
|
1143
|
+
*/
|
|
520
1144
|
level: 'global' | 'organization' | 'entity';
|
|
1145
|
+
/**
|
|
1146
|
+
* ID of the organization when `level` is `organization` or `entity`.
|
|
1147
|
+
*/
|
|
521
1148
|
organizationId?: string;
|
|
1149
|
+
/**
|
|
1150
|
+
* ID of the entity when `level` is `entity`.
|
|
1151
|
+
*/
|
|
522
1152
|
entityId?: string;
|
|
523
1153
|
};
|
|
524
1154
|
/**
|
|
525
1155
|
* The agent config the runtime sees at the request scope, after cascade resolution.
|
|
526
1156
|
*/
|
|
527
1157
|
resolved: {
|
|
1158
|
+
/**
|
|
1159
|
+
* Monotonic version number of this snapshot at its scope.
|
|
1160
|
+
*/
|
|
528
1161
|
version: number;
|
|
1162
|
+
/**
|
|
1163
|
+
* System prompt active in this snapshot. Omitted on override snapshots that inherit the prompt from the cascade.
|
|
1164
|
+
*/
|
|
529
1165
|
prompt?: string;
|
|
1166
|
+
/**
|
|
1167
|
+
* Resolved list of hard rules. On override snapshots, may be omitted when the override doesn't customise rules.
|
|
1168
|
+
*/
|
|
530
1169
|
hardRules?: Array<{
|
|
1170
|
+
/**
|
|
1171
|
+
* Stable identifier for the rule. Also used as the merge key when this rule is overridden at a deeper scope (organization/entity).
|
|
1172
|
+
*/
|
|
531
1173
|
name: string;
|
|
1174
|
+
/**
|
|
1175
|
+
* Plain-text instruction injected into the agent's prompt. The agent must always respect it.
|
|
1176
|
+
*/
|
|
532
1177
|
instruction: string;
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
1178
|
+
/**
|
|
1179
|
+
* Restrict the rule to specific intents. Empty array = the rule applies on every turn regardless of intent.
|
|
1180
|
+
*/
|
|
1181
|
+
intents?: Array<string>;
|
|
1182
|
+
/**
|
|
1183
|
+
* Relative priority within the agent's rule set (0–100, higher first). Use it to order conflicting rules; values are not absolute.
|
|
1184
|
+
*/
|
|
536
1185
|
priority?: number;
|
|
1186
|
+
/**
|
|
1187
|
+
* Set on an override doc to filter out an inherited rule of the same name at runtime. The rule shape is kept so toggling back works.
|
|
1188
|
+
*/
|
|
1189
|
+
disabled?: boolean;
|
|
1190
|
+
}>;
|
|
1191
|
+
/**
|
|
1192
|
+
* Resolved list of few-shot examples. On override snapshots, may be omitted when the override doesn't customise examples.
|
|
1193
|
+
*/
|
|
1194
|
+
examples?: Array<{
|
|
1195
|
+
/**
|
|
1196
|
+
* Stable identifier for the example. Also used as the merge key when this example is overridden at a deeper scope (organization/entity).
|
|
1197
|
+
*/
|
|
1198
|
+
name?: string;
|
|
1199
|
+
/**
|
|
1200
|
+
* Short human-readable description of the scenario this example illustrates.
|
|
1201
|
+
*/
|
|
1202
|
+
description: string;
|
|
1203
|
+
/**
|
|
1204
|
+
* User message used as the example input.
|
|
1205
|
+
*/
|
|
1206
|
+
input: string;
|
|
1207
|
+
/**
|
|
1208
|
+
* Expected agent output. Shape depends on the agent type (structured JSON for orchestrator/specialist, plain text for response). Write outputs in English — the runtime LLM transposes them into the user's language.
|
|
1209
|
+
*/
|
|
1210
|
+
output?: unknown;
|
|
1211
|
+
/**
|
|
1212
|
+
* Optional scenario context (user data, KB facts, previous decisions) attached to this example for the agent to read alongside the input.
|
|
1213
|
+
*/
|
|
1214
|
+
context?: unknown;
|
|
1215
|
+
/**
|
|
1216
|
+
* Restrict the example to specific intents. Applied at runtime by specialist and response agents — the orchestrator ignores it since it runs before intent detection. Empty array = the example applies regardless of intent.
|
|
1217
|
+
*/
|
|
1218
|
+
intents?: Array<string>;
|
|
1219
|
+
/**
|
|
1220
|
+
* Set on an override doc to filter out an inherited example of the same name at runtime.
|
|
1221
|
+
*/
|
|
537
1222
|
disabled?: boolean;
|
|
538
1223
|
}>;
|
|
1224
|
+
/**
|
|
1225
|
+
* Toggled user-context fields exposed to the agent.
|
|
1226
|
+
*/
|
|
539
1227
|
userContextConfig?: {
|
|
540
1228
|
[key: string]: boolean;
|
|
541
1229
|
};
|
|
1230
|
+
/**
|
|
1231
|
+
* Per-channel writing style (response agent only).
|
|
1232
|
+
*/
|
|
542
1233
|
responseConfig?: {
|
|
1234
|
+
/**
|
|
1235
|
+
* Writing style applied when the conversation channel is email.
|
|
1236
|
+
*/
|
|
543
1237
|
email?: {
|
|
1238
|
+
/**
|
|
1239
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
1240
|
+
*/
|
|
544
1241
|
greeting?: string;
|
|
1242
|
+
/**
|
|
1243
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
1244
|
+
*/
|
|
545
1245
|
signature?: string;
|
|
1246
|
+
/**
|
|
1247
|
+
* Writing tone for this channel.
|
|
1248
|
+
*/
|
|
546
1249
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
1250
|
+
/**
|
|
1251
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
1252
|
+
*/
|
|
547
1253
|
addressForm?: 'formal' | 'informal';
|
|
1254
|
+
/**
|
|
1255
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
1256
|
+
*/
|
|
548
1257
|
allowEmojis?: boolean;
|
|
549
1258
|
};
|
|
1259
|
+
/**
|
|
1260
|
+
* Writing style applied when the conversation channel is chat.
|
|
1261
|
+
*/
|
|
550
1262
|
chat?: {
|
|
1263
|
+
/**
|
|
1264
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
1265
|
+
*/
|
|
551
1266
|
greeting?: string;
|
|
1267
|
+
/**
|
|
1268
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
1269
|
+
*/
|
|
552
1270
|
signature?: string;
|
|
1271
|
+
/**
|
|
1272
|
+
* Writing tone for this channel.
|
|
1273
|
+
*/
|
|
553
1274
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
1275
|
+
/**
|
|
1276
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
1277
|
+
*/
|
|
554
1278
|
addressForm?: 'formal' | 'informal';
|
|
1279
|
+
/**
|
|
1280
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
1281
|
+
*/
|
|
555
1282
|
allowEmojis?: boolean;
|
|
556
1283
|
};
|
|
557
1284
|
};
|
|
1285
|
+
/**
|
|
1286
|
+
* Optional release note attached when this version was published.
|
|
1287
|
+
*/
|
|
558
1288
|
message?: string;
|
|
1289
|
+
/**
|
|
1290
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
1291
|
+
*/
|
|
559
1292
|
publishedAt?: string;
|
|
1293
|
+
/**
|
|
1294
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
1295
|
+
*/
|
|
560
1296
|
updatedAt?: string;
|
|
561
1297
|
};
|
|
562
1298
|
/**
|
|
563
1299
|
* Override draft at this scope, when one exists.
|
|
564
1300
|
*/
|
|
565
1301
|
draft?: {
|
|
1302
|
+
/**
|
|
1303
|
+
* Monotonic version number of this snapshot at its scope.
|
|
1304
|
+
*/
|
|
566
1305
|
version: number;
|
|
1306
|
+
/**
|
|
1307
|
+
* System prompt active in this snapshot. Omitted on override snapshots that inherit the prompt from the cascade.
|
|
1308
|
+
*/
|
|
567
1309
|
prompt?: string;
|
|
1310
|
+
/**
|
|
1311
|
+
* Resolved list of hard rules. On override snapshots, may be omitted when the override doesn't customise rules.
|
|
1312
|
+
*/
|
|
568
1313
|
hardRules?: Array<{
|
|
1314
|
+
/**
|
|
1315
|
+
* Stable identifier for the rule. Also used as the merge key when this rule is overridden at a deeper scope (organization/entity).
|
|
1316
|
+
*/
|
|
569
1317
|
name: string;
|
|
1318
|
+
/**
|
|
1319
|
+
* Plain-text instruction injected into the agent's prompt. The agent must always respect it.
|
|
1320
|
+
*/
|
|
570
1321
|
instruction: string;
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
1322
|
+
/**
|
|
1323
|
+
* Restrict the rule to specific intents. Empty array = the rule applies on every turn regardless of intent.
|
|
1324
|
+
*/
|
|
1325
|
+
intents?: Array<string>;
|
|
1326
|
+
/**
|
|
1327
|
+
* Relative priority within the agent's rule set (0–100, higher first). Use it to order conflicting rules; values are not absolute.
|
|
1328
|
+
*/
|
|
574
1329
|
priority?: number;
|
|
1330
|
+
/**
|
|
1331
|
+
* Set on an override doc to filter out an inherited rule of the same name at runtime. The rule shape is kept so toggling back works.
|
|
1332
|
+
*/
|
|
1333
|
+
disabled?: boolean;
|
|
1334
|
+
}>;
|
|
1335
|
+
/**
|
|
1336
|
+
* Resolved list of few-shot examples. On override snapshots, may be omitted when the override doesn't customise examples.
|
|
1337
|
+
*/
|
|
1338
|
+
examples?: Array<{
|
|
1339
|
+
/**
|
|
1340
|
+
* Stable identifier for the example. Also used as the merge key when this example is overridden at a deeper scope (organization/entity).
|
|
1341
|
+
*/
|
|
1342
|
+
name?: string;
|
|
1343
|
+
/**
|
|
1344
|
+
* Short human-readable description of the scenario this example illustrates.
|
|
1345
|
+
*/
|
|
1346
|
+
description: string;
|
|
1347
|
+
/**
|
|
1348
|
+
* User message used as the example input.
|
|
1349
|
+
*/
|
|
1350
|
+
input: string;
|
|
1351
|
+
/**
|
|
1352
|
+
* Expected agent output. Shape depends on the agent type (structured JSON for orchestrator/specialist, plain text for response). Write outputs in English — the runtime LLM transposes them into the user's language.
|
|
1353
|
+
*/
|
|
1354
|
+
output?: unknown;
|
|
1355
|
+
/**
|
|
1356
|
+
* Optional scenario context (user data, KB facts, previous decisions) attached to this example for the agent to read alongside the input.
|
|
1357
|
+
*/
|
|
1358
|
+
context?: unknown;
|
|
1359
|
+
/**
|
|
1360
|
+
* Restrict the example to specific intents. Applied at runtime by specialist and response agents — the orchestrator ignores it since it runs before intent detection. Empty array = the example applies regardless of intent.
|
|
1361
|
+
*/
|
|
1362
|
+
intents?: Array<string>;
|
|
1363
|
+
/**
|
|
1364
|
+
* Set on an override doc to filter out an inherited example of the same name at runtime.
|
|
1365
|
+
*/
|
|
575
1366
|
disabled?: boolean;
|
|
576
1367
|
}>;
|
|
1368
|
+
/**
|
|
1369
|
+
* Toggled user-context fields exposed to the agent.
|
|
1370
|
+
*/
|
|
577
1371
|
userContextConfig?: {
|
|
578
1372
|
[key: string]: boolean;
|
|
579
1373
|
};
|
|
1374
|
+
/**
|
|
1375
|
+
* Per-channel writing style (response agent only).
|
|
1376
|
+
*/
|
|
580
1377
|
responseConfig?: {
|
|
1378
|
+
/**
|
|
1379
|
+
* Writing style applied when the conversation channel is email.
|
|
1380
|
+
*/
|
|
581
1381
|
email?: {
|
|
1382
|
+
/**
|
|
1383
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
1384
|
+
*/
|
|
582
1385
|
greeting?: string;
|
|
1386
|
+
/**
|
|
1387
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
1388
|
+
*/
|
|
583
1389
|
signature?: string;
|
|
1390
|
+
/**
|
|
1391
|
+
* Writing tone for this channel.
|
|
1392
|
+
*/
|
|
584
1393
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
1394
|
+
/**
|
|
1395
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
1396
|
+
*/
|
|
585
1397
|
addressForm?: 'formal' | 'informal';
|
|
1398
|
+
/**
|
|
1399
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
1400
|
+
*/
|
|
586
1401
|
allowEmojis?: boolean;
|
|
587
1402
|
};
|
|
1403
|
+
/**
|
|
1404
|
+
* Writing style applied when the conversation channel is chat.
|
|
1405
|
+
*/
|
|
588
1406
|
chat?: {
|
|
1407
|
+
/**
|
|
1408
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
1409
|
+
*/
|
|
589
1410
|
greeting?: string;
|
|
1411
|
+
/**
|
|
1412
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
1413
|
+
*/
|
|
590
1414
|
signature?: string;
|
|
1415
|
+
/**
|
|
1416
|
+
* Writing tone for this channel.
|
|
1417
|
+
*/
|
|
591
1418
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
1419
|
+
/**
|
|
1420
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
1421
|
+
*/
|
|
592
1422
|
addressForm?: 'formal' | 'informal';
|
|
1423
|
+
/**
|
|
1424
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
1425
|
+
*/
|
|
593
1426
|
allowEmojis?: boolean;
|
|
594
1427
|
};
|
|
595
1428
|
};
|
|
1429
|
+
/**
|
|
1430
|
+
* Optional release note attached when this version was published.
|
|
1431
|
+
*/
|
|
596
1432
|
message?: string;
|
|
1433
|
+
/**
|
|
1434
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
1435
|
+
*/
|
|
597
1436
|
publishedAt?: string;
|
|
1437
|
+
/**
|
|
1438
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
1439
|
+
*/
|
|
598
1440
|
updatedAt?: string;
|
|
599
1441
|
};
|
|
600
1442
|
};
|
|
@@ -654,6 +1496,9 @@ export type DeleteOverrideResponses = {
|
|
|
654
1496
|
* Successful response
|
|
655
1497
|
*/
|
|
656
1498
|
200: {
|
|
1499
|
+
/**
|
|
1500
|
+
* Confirmation message describing the deletion outcome.
|
|
1501
|
+
*/
|
|
657
1502
|
message: string;
|
|
658
1503
|
};
|
|
659
1504
|
};
|
|
@@ -717,87 +1562,317 @@ export type PublishResponses = {
|
|
|
717
1562
|
* Successful response
|
|
718
1563
|
*/
|
|
719
1564
|
200: {
|
|
1565
|
+
/**
|
|
1566
|
+
* Machine name of the agent (e.g. `orchestrator`, `response`, `specialist_billing`).
|
|
1567
|
+
*/
|
|
720
1568
|
name: string;
|
|
1569
|
+
/**
|
|
1570
|
+
* Human-readable label shown in the dashboard.
|
|
1571
|
+
*/
|
|
721
1572
|
label: string;
|
|
1573
|
+
/**
|
|
1574
|
+
* Cascade level of this view (global / organization / entity).
|
|
1575
|
+
*/
|
|
722
1576
|
scope: {
|
|
1577
|
+
/**
|
|
1578
|
+
* Cascade level this config lives at — `global` (whole tenant), `organization` (per-org override), or `entity` (per-entity override).
|
|
1579
|
+
*/
|
|
723
1580
|
level: 'global' | 'organization' | 'entity';
|
|
1581
|
+
/**
|
|
1582
|
+
* ID of the organization when `level` is `organization` or `entity`.
|
|
1583
|
+
*/
|
|
724
1584
|
organizationId?: string;
|
|
1585
|
+
/**
|
|
1586
|
+
* ID of the entity when `level` is `entity`.
|
|
1587
|
+
*/
|
|
725
1588
|
entityId?: string;
|
|
726
1589
|
};
|
|
727
1590
|
/**
|
|
728
1591
|
* The agent config the runtime sees at the request scope, after cascade resolution.
|
|
729
1592
|
*/
|
|
730
1593
|
resolved: {
|
|
1594
|
+
/**
|
|
1595
|
+
* Monotonic version number of this snapshot at its scope.
|
|
1596
|
+
*/
|
|
731
1597
|
version: number;
|
|
1598
|
+
/**
|
|
1599
|
+
* System prompt active in this snapshot. Omitted on override snapshots that inherit the prompt from the cascade.
|
|
1600
|
+
*/
|
|
732
1601
|
prompt?: string;
|
|
1602
|
+
/**
|
|
1603
|
+
* Resolved list of hard rules. On override snapshots, may be omitted when the override doesn't customise rules.
|
|
1604
|
+
*/
|
|
733
1605
|
hardRules?: Array<{
|
|
1606
|
+
/**
|
|
1607
|
+
* Stable identifier for the rule. Also used as the merge key when this rule is overridden at a deeper scope (organization/entity).
|
|
1608
|
+
*/
|
|
734
1609
|
name: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* Plain-text instruction injected into the agent's prompt. The agent must always respect it.
|
|
1612
|
+
*/
|
|
735
1613
|
instruction: string;
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
1614
|
+
/**
|
|
1615
|
+
* Restrict the rule to specific intents. Empty array = the rule applies on every turn regardless of intent.
|
|
1616
|
+
*/
|
|
1617
|
+
intents?: Array<string>;
|
|
1618
|
+
/**
|
|
1619
|
+
* Relative priority within the agent's rule set (0–100, higher first). Use it to order conflicting rules; values are not absolute.
|
|
1620
|
+
*/
|
|
739
1621
|
priority?: number;
|
|
1622
|
+
/**
|
|
1623
|
+
* Set on an override doc to filter out an inherited rule of the same name at runtime. The rule shape is kept so toggling back works.
|
|
1624
|
+
*/
|
|
740
1625
|
disabled?: boolean;
|
|
741
1626
|
}>;
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
1627
|
+
/**
|
|
1628
|
+
* Resolved list of few-shot examples. On override snapshots, may be omitted when the override doesn't customise examples.
|
|
1629
|
+
*/
|
|
1630
|
+
examples?: Array<{
|
|
1631
|
+
/**
|
|
1632
|
+
* Stable identifier for the example. Also used as the merge key when this example is overridden at a deeper scope (organization/entity).
|
|
1633
|
+
*/
|
|
1634
|
+
name?: string;
|
|
1635
|
+
/**
|
|
1636
|
+
* Short human-readable description of the scenario this example illustrates.
|
|
1637
|
+
*/
|
|
1638
|
+
description: string;
|
|
1639
|
+
/**
|
|
1640
|
+
* User message used as the example input.
|
|
1641
|
+
*/
|
|
1642
|
+
input: string;
|
|
1643
|
+
/**
|
|
1644
|
+
* Expected agent output. Shape depends on the agent type (structured JSON for orchestrator/specialist, plain text for response). Write outputs in English — the runtime LLM transposes them into the user's language.
|
|
1645
|
+
*/
|
|
1646
|
+
output?: unknown;
|
|
1647
|
+
/**
|
|
1648
|
+
* Optional scenario context (user data, KB facts, previous decisions) attached to this example for the agent to read alongside the input.
|
|
1649
|
+
*/
|
|
1650
|
+
context?: unknown;
|
|
1651
|
+
/**
|
|
1652
|
+
* Restrict the example to specific intents. Applied at runtime by specialist and response agents — the orchestrator ignores it since it runs before intent detection. Empty array = the example applies regardless of intent.
|
|
1653
|
+
*/
|
|
1654
|
+
intents?: Array<string>;
|
|
1655
|
+
/**
|
|
1656
|
+
* Set on an override doc to filter out an inherited example of the same name at runtime.
|
|
1657
|
+
*/
|
|
1658
|
+
disabled?: boolean;
|
|
1659
|
+
}>;
|
|
1660
|
+
/**
|
|
1661
|
+
* Toggled user-context fields exposed to the agent.
|
|
1662
|
+
*/
|
|
1663
|
+
userContextConfig?: {
|
|
1664
|
+
[key: string]: boolean;
|
|
1665
|
+
};
|
|
1666
|
+
/**
|
|
1667
|
+
* Per-channel writing style (response agent only).
|
|
1668
|
+
*/
|
|
1669
|
+
responseConfig?: {
|
|
1670
|
+
/**
|
|
1671
|
+
* Writing style applied when the conversation channel is email.
|
|
1672
|
+
*/
|
|
1673
|
+
email?: {
|
|
1674
|
+
/**
|
|
1675
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
1676
|
+
*/
|
|
1677
|
+
greeting?: string;
|
|
1678
|
+
/**
|
|
1679
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
1680
|
+
*/
|
|
1681
|
+
signature?: string;
|
|
1682
|
+
/**
|
|
1683
|
+
* Writing tone for this channel.
|
|
1684
|
+
*/
|
|
1685
|
+
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
1686
|
+
/**
|
|
1687
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
1688
|
+
*/
|
|
750
1689
|
addressForm?: 'formal' | 'informal';
|
|
1690
|
+
/**
|
|
1691
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
1692
|
+
*/
|
|
751
1693
|
allowEmojis?: boolean;
|
|
752
1694
|
};
|
|
1695
|
+
/**
|
|
1696
|
+
* Writing style applied when the conversation channel is chat.
|
|
1697
|
+
*/
|
|
753
1698
|
chat?: {
|
|
1699
|
+
/**
|
|
1700
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
1701
|
+
*/
|
|
754
1702
|
greeting?: string;
|
|
1703
|
+
/**
|
|
1704
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
1705
|
+
*/
|
|
755
1706
|
signature?: string;
|
|
1707
|
+
/**
|
|
1708
|
+
* Writing tone for this channel.
|
|
1709
|
+
*/
|
|
756
1710
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
1711
|
+
/**
|
|
1712
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
1713
|
+
*/
|
|
757
1714
|
addressForm?: 'formal' | 'informal';
|
|
1715
|
+
/**
|
|
1716
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
1717
|
+
*/
|
|
758
1718
|
allowEmojis?: boolean;
|
|
759
1719
|
};
|
|
760
1720
|
};
|
|
1721
|
+
/**
|
|
1722
|
+
* Optional release note attached when this version was published.
|
|
1723
|
+
*/
|
|
761
1724
|
message?: string;
|
|
1725
|
+
/**
|
|
1726
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
1727
|
+
*/
|
|
762
1728
|
publishedAt?: string;
|
|
1729
|
+
/**
|
|
1730
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
1731
|
+
*/
|
|
763
1732
|
updatedAt?: string;
|
|
764
1733
|
};
|
|
765
1734
|
/**
|
|
766
1735
|
* Override draft at this scope, when one exists.
|
|
767
1736
|
*/
|
|
768
1737
|
draft?: {
|
|
1738
|
+
/**
|
|
1739
|
+
* Monotonic version number of this snapshot at its scope.
|
|
1740
|
+
*/
|
|
769
1741
|
version: number;
|
|
1742
|
+
/**
|
|
1743
|
+
* System prompt active in this snapshot. Omitted on override snapshots that inherit the prompt from the cascade.
|
|
1744
|
+
*/
|
|
770
1745
|
prompt?: string;
|
|
1746
|
+
/**
|
|
1747
|
+
* Resolved list of hard rules. On override snapshots, may be omitted when the override doesn't customise rules.
|
|
1748
|
+
*/
|
|
771
1749
|
hardRules?: Array<{
|
|
1750
|
+
/**
|
|
1751
|
+
* Stable identifier for the rule. Also used as the merge key when this rule is overridden at a deeper scope (organization/entity).
|
|
1752
|
+
*/
|
|
772
1753
|
name: string;
|
|
1754
|
+
/**
|
|
1755
|
+
* Plain-text instruction injected into the agent's prompt. The agent must always respect it.
|
|
1756
|
+
*/
|
|
773
1757
|
instruction: string;
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
1758
|
+
/**
|
|
1759
|
+
* Restrict the rule to specific intents. Empty array = the rule applies on every turn regardless of intent.
|
|
1760
|
+
*/
|
|
1761
|
+
intents?: Array<string>;
|
|
1762
|
+
/**
|
|
1763
|
+
* Relative priority within the agent's rule set (0–100, higher first). Use it to order conflicting rules; values are not absolute.
|
|
1764
|
+
*/
|
|
777
1765
|
priority?: number;
|
|
1766
|
+
/**
|
|
1767
|
+
* Set on an override doc to filter out an inherited rule of the same name at runtime. The rule shape is kept so toggling back works.
|
|
1768
|
+
*/
|
|
1769
|
+
disabled?: boolean;
|
|
1770
|
+
}>;
|
|
1771
|
+
/**
|
|
1772
|
+
* Resolved list of few-shot examples. On override snapshots, may be omitted when the override doesn't customise examples.
|
|
1773
|
+
*/
|
|
1774
|
+
examples?: Array<{
|
|
1775
|
+
/**
|
|
1776
|
+
* Stable identifier for the example. Also used as the merge key when this example is overridden at a deeper scope (organization/entity).
|
|
1777
|
+
*/
|
|
1778
|
+
name?: string;
|
|
1779
|
+
/**
|
|
1780
|
+
* Short human-readable description of the scenario this example illustrates.
|
|
1781
|
+
*/
|
|
1782
|
+
description: string;
|
|
1783
|
+
/**
|
|
1784
|
+
* User message used as the example input.
|
|
1785
|
+
*/
|
|
1786
|
+
input: string;
|
|
1787
|
+
/**
|
|
1788
|
+
* Expected agent output. Shape depends on the agent type (structured JSON for orchestrator/specialist, plain text for response). Write outputs in English — the runtime LLM transposes them into the user's language.
|
|
1789
|
+
*/
|
|
1790
|
+
output?: unknown;
|
|
1791
|
+
/**
|
|
1792
|
+
* Optional scenario context (user data, KB facts, previous decisions) attached to this example for the agent to read alongside the input.
|
|
1793
|
+
*/
|
|
1794
|
+
context?: unknown;
|
|
1795
|
+
/**
|
|
1796
|
+
* Restrict the example to specific intents. Applied at runtime by specialist and response agents — the orchestrator ignores it since it runs before intent detection. Empty array = the example applies regardless of intent.
|
|
1797
|
+
*/
|
|
1798
|
+
intents?: Array<string>;
|
|
1799
|
+
/**
|
|
1800
|
+
* Set on an override doc to filter out an inherited example of the same name at runtime.
|
|
1801
|
+
*/
|
|
778
1802
|
disabled?: boolean;
|
|
779
1803
|
}>;
|
|
1804
|
+
/**
|
|
1805
|
+
* Toggled user-context fields exposed to the agent.
|
|
1806
|
+
*/
|
|
780
1807
|
userContextConfig?: {
|
|
781
1808
|
[key: string]: boolean;
|
|
782
1809
|
};
|
|
1810
|
+
/**
|
|
1811
|
+
* Per-channel writing style (response agent only).
|
|
1812
|
+
*/
|
|
783
1813
|
responseConfig?: {
|
|
1814
|
+
/**
|
|
1815
|
+
* Writing style applied when the conversation channel is email.
|
|
1816
|
+
*/
|
|
784
1817
|
email?: {
|
|
1818
|
+
/**
|
|
1819
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
1820
|
+
*/
|
|
785
1821
|
greeting?: string;
|
|
1822
|
+
/**
|
|
1823
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
1824
|
+
*/
|
|
786
1825
|
signature?: string;
|
|
1826
|
+
/**
|
|
1827
|
+
* Writing tone for this channel.
|
|
1828
|
+
*/
|
|
787
1829
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
1830
|
+
/**
|
|
1831
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
1832
|
+
*/
|
|
788
1833
|
addressForm?: 'formal' | 'informal';
|
|
1834
|
+
/**
|
|
1835
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
1836
|
+
*/
|
|
789
1837
|
allowEmojis?: boolean;
|
|
790
1838
|
};
|
|
1839
|
+
/**
|
|
1840
|
+
* Writing style applied when the conversation channel is chat.
|
|
1841
|
+
*/
|
|
791
1842
|
chat?: {
|
|
1843
|
+
/**
|
|
1844
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
1845
|
+
*/
|
|
792
1846
|
greeting?: string;
|
|
1847
|
+
/**
|
|
1848
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
1849
|
+
*/
|
|
793
1850
|
signature?: string;
|
|
1851
|
+
/**
|
|
1852
|
+
* Writing tone for this channel.
|
|
1853
|
+
*/
|
|
794
1854
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
1855
|
+
/**
|
|
1856
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
1857
|
+
*/
|
|
795
1858
|
addressForm?: 'formal' | 'informal';
|
|
1859
|
+
/**
|
|
1860
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
1861
|
+
*/
|
|
796
1862
|
allowEmojis?: boolean;
|
|
797
1863
|
};
|
|
798
1864
|
};
|
|
1865
|
+
/**
|
|
1866
|
+
* Optional release note attached when this version was published.
|
|
1867
|
+
*/
|
|
799
1868
|
message?: string;
|
|
1869
|
+
/**
|
|
1870
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
1871
|
+
*/
|
|
800
1872
|
publishedAt?: string;
|
|
1873
|
+
/**
|
|
1874
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
1875
|
+
*/
|
|
801
1876
|
updatedAt?: string;
|
|
802
1877
|
};
|
|
803
1878
|
};
|
|
@@ -862,87 +1937,317 @@ export type RollbackResponses = {
|
|
|
862
1937
|
* Successful response
|
|
863
1938
|
*/
|
|
864
1939
|
200: {
|
|
1940
|
+
/**
|
|
1941
|
+
* Machine name of the agent (e.g. `orchestrator`, `response`, `specialist_billing`).
|
|
1942
|
+
*/
|
|
865
1943
|
name: string;
|
|
1944
|
+
/**
|
|
1945
|
+
* Human-readable label shown in the dashboard.
|
|
1946
|
+
*/
|
|
866
1947
|
label: string;
|
|
1948
|
+
/**
|
|
1949
|
+
* Cascade level of this view (global / organization / entity).
|
|
1950
|
+
*/
|
|
867
1951
|
scope: {
|
|
1952
|
+
/**
|
|
1953
|
+
* Cascade level this config lives at — `global` (whole tenant), `organization` (per-org override), or `entity` (per-entity override).
|
|
1954
|
+
*/
|
|
868
1955
|
level: 'global' | 'organization' | 'entity';
|
|
1956
|
+
/**
|
|
1957
|
+
* ID of the organization when `level` is `organization` or `entity`.
|
|
1958
|
+
*/
|
|
869
1959
|
organizationId?: string;
|
|
1960
|
+
/**
|
|
1961
|
+
* ID of the entity when `level` is `entity`.
|
|
1962
|
+
*/
|
|
870
1963
|
entityId?: string;
|
|
871
1964
|
};
|
|
872
1965
|
/**
|
|
873
1966
|
* The agent config the runtime sees at the request scope, after cascade resolution.
|
|
874
1967
|
*/
|
|
875
1968
|
resolved: {
|
|
1969
|
+
/**
|
|
1970
|
+
* Monotonic version number of this snapshot at its scope.
|
|
1971
|
+
*/
|
|
876
1972
|
version: number;
|
|
1973
|
+
/**
|
|
1974
|
+
* System prompt active in this snapshot. Omitted on override snapshots that inherit the prompt from the cascade.
|
|
1975
|
+
*/
|
|
877
1976
|
prompt?: string;
|
|
1977
|
+
/**
|
|
1978
|
+
* Resolved list of hard rules. On override snapshots, may be omitted when the override doesn't customise rules.
|
|
1979
|
+
*/
|
|
878
1980
|
hardRules?: Array<{
|
|
1981
|
+
/**
|
|
1982
|
+
* Stable identifier for the rule. Also used as the merge key when this rule is overridden at a deeper scope (organization/entity).
|
|
1983
|
+
*/
|
|
879
1984
|
name: string;
|
|
1985
|
+
/**
|
|
1986
|
+
* Plain-text instruction injected into the agent's prompt. The agent must always respect it.
|
|
1987
|
+
*/
|
|
880
1988
|
instruction: string;
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
1989
|
+
/**
|
|
1990
|
+
* Restrict the rule to specific intents. Empty array = the rule applies on every turn regardless of intent.
|
|
1991
|
+
*/
|
|
1992
|
+
intents?: Array<string>;
|
|
1993
|
+
/**
|
|
1994
|
+
* Relative priority within the agent's rule set (0–100, higher first). Use it to order conflicting rules; values are not absolute.
|
|
1995
|
+
*/
|
|
884
1996
|
priority?: number;
|
|
1997
|
+
/**
|
|
1998
|
+
* Set on an override doc to filter out an inherited rule of the same name at runtime. The rule shape is kept so toggling back works.
|
|
1999
|
+
*/
|
|
2000
|
+
disabled?: boolean;
|
|
2001
|
+
}>;
|
|
2002
|
+
/**
|
|
2003
|
+
* Resolved list of few-shot examples. On override snapshots, may be omitted when the override doesn't customise examples.
|
|
2004
|
+
*/
|
|
2005
|
+
examples?: Array<{
|
|
2006
|
+
/**
|
|
2007
|
+
* Stable identifier for the example. Also used as the merge key when this example is overridden at a deeper scope (organization/entity).
|
|
2008
|
+
*/
|
|
2009
|
+
name?: string;
|
|
2010
|
+
/**
|
|
2011
|
+
* Short human-readable description of the scenario this example illustrates.
|
|
2012
|
+
*/
|
|
2013
|
+
description: string;
|
|
2014
|
+
/**
|
|
2015
|
+
* User message used as the example input.
|
|
2016
|
+
*/
|
|
2017
|
+
input: string;
|
|
2018
|
+
/**
|
|
2019
|
+
* Expected agent output. Shape depends on the agent type (structured JSON for orchestrator/specialist, plain text for response). Write outputs in English — the runtime LLM transposes them into the user's language.
|
|
2020
|
+
*/
|
|
2021
|
+
output?: unknown;
|
|
2022
|
+
/**
|
|
2023
|
+
* Optional scenario context (user data, KB facts, previous decisions) attached to this example for the agent to read alongside the input.
|
|
2024
|
+
*/
|
|
2025
|
+
context?: unknown;
|
|
2026
|
+
/**
|
|
2027
|
+
* Restrict the example to specific intents. Applied at runtime by specialist and response agents — the orchestrator ignores it since it runs before intent detection. Empty array = the example applies regardless of intent.
|
|
2028
|
+
*/
|
|
2029
|
+
intents?: Array<string>;
|
|
2030
|
+
/**
|
|
2031
|
+
* Set on an override doc to filter out an inherited example of the same name at runtime.
|
|
2032
|
+
*/
|
|
885
2033
|
disabled?: boolean;
|
|
886
2034
|
}>;
|
|
2035
|
+
/**
|
|
2036
|
+
* Toggled user-context fields exposed to the agent.
|
|
2037
|
+
*/
|
|
887
2038
|
userContextConfig?: {
|
|
888
2039
|
[key: string]: boolean;
|
|
889
2040
|
};
|
|
2041
|
+
/**
|
|
2042
|
+
* Per-channel writing style (response agent only).
|
|
2043
|
+
*/
|
|
890
2044
|
responseConfig?: {
|
|
2045
|
+
/**
|
|
2046
|
+
* Writing style applied when the conversation channel is email.
|
|
2047
|
+
*/
|
|
891
2048
|
email?: {
|
|
2049
|
+
/**
|
|
2050
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
2051
|
+
*/
|
|
892
2052
|
greeting?: string;
|
|
2053
|
+
/**
|
|
2054
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
2055
|
+
*/
|
|
893
2056
|
signature?: string;
|
|
2057
|
+
/**
|
|
2058
|
+
* Writing tone for this channel.
|
|
2059
|
+
*/
|
|
894
2060
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
2061
|
+
/**
|
|
2062
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
2063
|
+
*/
|
|
895
2064
|
addressForm?: 'formal' | 'informal';
|
|
2065
|
+
/**
|
|
2066
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
2067
|
+
*/
|
|
896
2068
|
allowEmojis?: boolean;
|
|
897
2069
|
};
|
|
2070
|
+
/**
|
|
2071
|
+
* Writing style applied when the conversation channel is chat.
|
|
2072
|
+
*/
|
|
898
2073
|
chat?: {
|
|
2074
|
+
/**
|
|
2075
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
2076
|
+
*/
|
|
899
2077
|
greeting?: string;
|
|
2078
|
+
/**
|
|
2079
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
2080
|
+
*/
|
|
900
2081
|
signature?: string;
|
|
2082
|
+
/**
|
|
2083
|
+
* Writing tone for this channel.
|
|
2084
|
+
*/
|
|
901
2085
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
2086
|
+
/**
|
|
2087
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
2088
|
+
*/
|
|
902
2089
|
addressForm?: 'formal' | 'informal';
|
|
2090
|
+
/**
|
|
2091
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
2092
|
+
*/
|
|
903
2093
|
allowEmojis?: boolean;
|
|
904
2094
|
};
|
|
905
2095
|
};
|
|
2096
|
+
/**
|
|
2097
|
+
* Optional release note attached when this version was published.
|
|
2098
|
+
*/
|
|
906
2099
|
message?: string;
|
|
2100
|
+
/**
|
|
2101
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
2102
|
+
*/
|
|
907
2103
|
publishedAt?: string;
|
|
2104
|
+
/**
|
|
2105
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
2106
|
+
*/
|
|
908
2107
|
updatedAt?: string;
|
|
909
2108
|
};
|
|
910
2109
|
/**
|
|
911
2110
|
* Override draft at this scope, when one exists.
|
|
912
2111
|
*/
|
|
913
2112
|
draft?: {
|
|
2113
|
+
/**
|
|
2114
|
+
* Monotonic version number of this snapshot at its scope.
|
|
2115
|
+
*/
|
|
914
2116
|
version: number;
|
|
2117
|
+
/**
|
|
2118
|
+
* System prompt active in this snapshot. Omitted on override snapshots that inherit the prompt from the cascade.
|
|
2119
|
+
*/
|
|
915
2120
|
prompt?: string;
|
|
2121
|
+
/**
|
|
2122
|
+
* Resolved list of hard rules. On override snapshots, may be omitted when the override doesn't customise rules.
|
|
2123
|
+
*/
|
|
916
2124
|
hardRules?: Array<{
|
|
2125
|
+
/**
|
|
2126
|
+
* Stable identifier for the rule. Also used as the merge key when this rule is overridden at a deeper scope (organization/entity).
|
|
2127
|
+
*/
|
|
917
2128
|
name: string;
|
|
2129
|
+
/**
|
|
2130
|
+
* Plain-text instruction injected into the agent's prompt. The agent must always respect it.
|
|
2131
|
+
*/
|
|
918
2132
|
instruction: string;
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
2133
|
+
/**
|
|
2134
|
+
* Restrict the rule to specific intents. Empty array = the rule applies on every turn regardless of intent.
|
|
2135
|
+
*/
|
|
2136
|
+
intents?: Array<string>;
|
|
2137
|
+
/**
|
|
2138
|
+
* Relative priority within the agent's rule set (0–100, higher first). Use it to order conflicting rules; values are not absolute.
|
|
2139
|
+
*/
|
|
922
2140
|
priority?: number;
|
|
2141
|
+
/**
|
|
2142
|
+
* Set on an override doc to filter out an inherited rule of the same name at runtime. The rule shape is kept so toggling back works.
|
|
2143
|
+
*/
|
|
2144
|
+
disabled?: boolean;
|
|
2145
|
+
}>;
|
|
2146
|
+
/**
|
|
2147
|
+
* Resolved list of few-shot examples. On override snapshots, may be omitted when the override doesn't customise examples.
|
|
2148
|
+
*/
|
|
2149
|
+
examples?: Array<{
|
|
2150
|
+
/**
|
|
2151
|
+
* Stable identifier for the example. Also used as the merge key when this example is overridden at a deeper scope (organization/entity).
|
|
2152
|
+
*/
|
|
2153
|
+
name?: string;
|
|
2154
|
+
/**
|
|
2155
|
+
* Short human-readable description of the scenario this example illustrates.
|
|
2156
|
+
*/
|
|
2157
|
+
description: string;
|
|
2158
|
+
/**
|
|
2159
|
+
* User message used as the example input.
|
|
2160
|
+
*/
|
|
2161
|
+
input: string;
|
|
2162
|
+
/**
|
|
2163
|
+
* Expected agent output. Shape depends on the agent type (structured JSON for orchestrator/specialist, plain text for response). Write outputs in English — the runtime LLM transposes them into the user's language.
|
|
2164
|
+
*/
|
|
2165
|
+
output?: unknown;
|
|
2166
|
+
/**
|
|
2167
|
+
* Optional scenario context (user data, KB facts, previous decisions) attached to this example for the agent to read alongside the input.
|
|
2168
|
+
*/
|
|
2169
|
+
context?: unknown;
|
|
2170
|
+
/**
|
|
2171
|
+
* Restrict the example to specific intents. Applied at runtime by specialist and response agents — the orchestrator ignores it since it runs before intent detection. Empty array = the example applies regardless of intent.
|
|
2172
|
+
*/
|
|
2173
|
+
intents?: Array<string>;
|
|
2174
|
+
/**
|
|
2175
|
+
* Set on an override doc to filter out an inherited example of the same name at runtime.
|
|
2176
|
+
*/
|
|
923
2177
|
disabled?: boolean;
|
|
924
2178
|
}>;
|
|
2179
|
+
/**
|
|
2180
|
+
* Toggled user-context fields exposed to the agent.
|
|
2181
|
+
*/
|
|
925
2182
|
userContextConfig?: {
|
|
926
2183
|
[key: string]: boolean;
|
|
927
2184
|
};
|
|
2185
|
+
/**
|
|
2186
|
+
* Per-channel writing style (response agent only).
|
|
2187
|
+
*/
|
|
928
2188
|
responseConfig?: {
|
|
2189
|
+
/**
|
|
2190
|
+
* Writing style applied when the conversation channel is email.
|
|
2191
|
+
*/
|
|
929
2192
|
email?: {
|
|
2193
|
+
/**
|
|
2194
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
2195
|
+
*/
|
|
930
2196
|
greeting?: string;
|
|
2197
|
+
/**
|
|
2198
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
2199
|
+
*/
|
|
931
2200
|
signature?: string;
|
|
2201
|
+
/**
|
|
2202
|
+
* Writing tone for this channel.
|
|
2203
|
+
*/
|
|
932
2204
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
2205
|
+
/**
|
|
2206
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
2207
|
+
*/
|
|
933
2208
|
addressForm?: 'formal' | 'informal';
|
|
2209
|
+
/**
|
|
2210
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
2211
|
+
*/
|
|
934
2212
|
allowEmojis?: boolean;
|
|
935
2213
|
};
|
|
2214
|
+
/**
|
|
2215
|
+
* Writing style applied when the conversation channel is chat.
|
|
2216
|
+
*/
|
|
936
2217
|
chat?: {
|
|
2218
|
+
/**
|
|
2219
|
+
* Greeting text to start the agent's response. The agent translates it into the user's language.
|
|
2220
|
+
*/
|
|
937
2221
|
greeting?: string;
|
|
2222
|
+
/**
|
|
2223
|
+
* Sign-off text appended to the agent's response. The agent translates it into the user's language.
|
|
2224
|
+
*/
|
|
938
2225
|
signature?: string;
|
|
2226
|
+
/**
|
|
2227
|
+
* Writing tone for this channel.
|
|
2228
|
+
*/
|
|
939
2229
|
tone?: 'empathetic' | 'formal' | 'friendly';
|
|
2230
|
+
/**
|
|
2231
|
+
* `formal` uses the polite pronoun in T-V languages (e.g. French "vous"); `informal` uses the familiar one. Defaults to `formal`.
|
|
2232
|
+
*/
|
|
940
2233
|
addressForm?: 'formal' | 'informal';
|
|
2234
|
+
/**
|
|
2235
|
+
* Allow the agent to use one emoji per message. Defaults to `false`.
|
|
2236
|
+
*/
|
|
941
2237
|
allowEmojis?: boolean;
|
|
942
2238
|
};
|
|
943
2239
|
};
|
|
2240
|
+
/**
|
|
2241
|
+
* Optional release note attached when this version was published.
|
|
2242
|
+
*/
|
|
944
2243
|
message?: string;
|
|
2244
|
+
/**
|
|
2245
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
2246
|
+
*/
|
|
945
2247
|
publishedAt?: string;
|
|
2248
|
+
/**
|
|
2249
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
2250
|
+
*/
|
|
946
2251
|
updatedAt?: string;
|
|
947
2252
|
};
|
|
948
2253
|
};
|
|
@@ -1966,20 +3271,12 @@ export type List4Data = {
|
|
|
1966
3271
|
body?: never;
|
|
1967
3272
|
path?: never;
|
|
1968
3273
|
query?: {
|
|
1969
|
-
/**
|
|
1970
|
-
* Max number of items to return per page (1-100).
|
|
1971
|
-
*/
|
|
1972
|
-
limit?: number;
|
|
1973
|
-
/**
|
|
1974
|
-
* Number of items to skip for pagination.
|
|
1975
|
-
*/
|
|
1976
|
-
offset?: number | null;
|
|
1977
3274
|
/**
|
|
1978
3275
|
* Target a specific entity (under the caller's organization).
|
|
1979
3276
|
*/
|
|
1980
3277
|
entityId?: string;
|
|
1981
3278
|
};
|
|
1982
|
-
url: '/
|
|
3279
|
+
url: '/intents';
|
|
1983
3280
|
};
|
|
1984
3281
|
export type List4Errors = {
|
|
1985
3282
|
/**
|
|
@@ -2019,22 +3316,686 @@ export type List4Responses = {
|
|
|
2019
3316
|
* Successful response
|
|
2020
3317
|
*/
|
|
2021
3318
|
200: {
|
|
2022
|
-
|
|
3319
|
+
/**
|
|
3320
|
+
* Intents visible at the caller's scope.
|
|
3321
|
+
*/
|
|
3322
|
+
intents: Array<{
|
|
3323
|
+
/**
|
|
3324
|
+
* Opaque intent id (prefixed `int_`).
|
|
3325
|
+
*/
|
|
2023
3326
|
id: string;
|
|
2024
|
-
|
|
2025
|
-
|
|
3327
|
+
/**
|
|
3328
|
+
* Machine name — stable identifier used across the API.
|
|
3329
|
+
*/
|
|
3330
|
+
intent: string;
|
|
3331
|
+
/**
|
|
3332
|
+
* Human-readable label.
|
|
3333
|
+
*/
|
|
3334
|
+
label: string;
|
|
3335
|
+
/**
|
|
3336
|
+
* Description the orchestrator uses to classify user messages.
|
|
3337
|
+
*/
|
|
3338
|
+
description: string;
|
|
3339
|
+
/**
|
|
3340
|
+
* Where the intent is routed once detected — response agent, human escalation, or a specialist.
|
|
3341
|
+
*/
|
|
3342
|
+
route: {
|
|
3343
|
+
/**
|
|
3344
|
+
* Routing target — `response` (straight to the response agent), `human` (escalation), or `specialist`.
|
|
3345
|
+
*/
|
|
3346
|
+
type: 'response' | 'human' | 'specialist';
|
|
3347
|
+
/**
|
|
3348
|
+
* Machine name of the specialist agent — required when `type` is `specialist`, ignored otherwise.
|
|
3349
|
+
*/
|
|
3350
|
+
agentName?: string;
|
|
3351
|
+
};
|
|
3352
|
+
/**
|
|
3353
|
+
* Effective processing mode at the request scope.
|
|
3354
|
+
*/
|
|
3355
|
+
mode: 'disabled' | 'copilot' | 'autopilot';
|
|
3356
|
+
/**
|
|
3357
|
+
* Whether the user must be identified before processing.
|
|
3358
|
+
*/
|
|
3359
|
+
requiresUserInfo: boolean;
|
|
3360
|
+
/**
|
|
3361
|
+
* Display order in the intent list.
|
|
3362
|
+
*/
|
|
3363
|
+
order: number;
|
|
3364
|
+
/**
|
|
3365
|
+
* Cascade level this view was resolved at.
|
|
3366
|
+
*/
|
|
2026
3367
|
scope: {
|
|
3368
|
+
/**
|
|
3369
|
+
* Cascade level of this view — `global` (applies everywhere), `organization`, or `entity`.
|
|
3370
|
+
*/
|
|
2027
3371
|
level: 'global' | 'organization' | 'entity';
|
|
3372
|
+
/**
|
|
3373
|
+
* Organization id when `level` is `organization` or `entity`.
|
|
3374
|
+
*/
|
|
2028
3375
|
organizationId?: string;
|
|
3376
|
+
/**
|
|
3377
|
+
* Entity id when `level` is `entity`.
|
|
3378
|
+
*/
|
|
2029
3379
|
entityId?: string;
|
|
2030
3380
|
};
|
|
2031
|
-
version: number;
|
|
2032
|
-
hasDraft: boolean;
|
|
2033
|
-
publishedAt?: string;
|
|
2034
|
-
updatedAt: string;
|
|
2035
3381
|
}>;
|
|
2036
|
-
|
|
2037
|
-
|
|
3382
|
+
};
|
|
3383
|
+
};
|
|
3384
|
+
export type List4Response = List4Responses[keyof List4Responses];
|
|
3385
|
+
export type Create3Data = {
|
|
3386
|
+
body?: {
|
|
3387
|
+
/**
|
|
3388
|
+
* Human-readable label. The intent's machine name is derived from it (lower-cased, words joined by `_`).
|
|
3389
|
+
*/
|
|
3390
|
+
label: string;
|
|
3391
|
+
/**
|
|
3392
|
+
* Description the orchestrator uses to classify user messages.
|
|
3393
|
+
*/
|
|
3394
|
+
description: string;
|
|
3395
|
+
/**
|
|
3396
|
+
* Where the intent is routed once detected — response agent, human escalation, or a specialist. Defaults to direct response.
|
|
3397
|
+
*/
|
|
3398
|
+
route?: {
|
|
3399
|
+
/**
|
|
3400
|
+
* Routing target — `response` (straight to the response agent), `human` (escalation), or `specialist`.
|
|
3401
|
+
*/
|
|
3402
|
+
type: 'response' | 'human' | 'specialist';
|
|
3403
|
+
/**
|
|
3404
|
+
* Machine name of the specialist agent — required when `type` is `specialist`, ignored otherwise.
|
|
3405
|
+
*/
|
|
3406
|
+
agentName?: string;
|
|
3407
|
+
};
|
|
3408
|
+
/**
|
|
3409
|
+
* Processing mode (`disabled` / `copilot` / `autopilot`). Defaults to `copilot`.
|
|
3410
|
+
*/
|
|
3411
|
+
mode?: 'disabled' | 'copilot' | 'autopilot';
|
|
3412
|
+
/**
|
|
3413
|
+
* Whether the user must be identified before the intent is processed. Defaults to `true`.
|
|
3414
|
+
*/
|
|
3415
|
+
requiresUserInfo?: boolean;
|
|
3416
|
+
/**
|
|
3417
|
+
* Display order in the intent list (lower first). Defaults to 0.
|
|
3418
|
+
*/
|
|
3419
|
+
order?: number;
|
|
3420
|
+
};
|
|
3421
|
+
path?: never;
|
|
3422
|
+
query?: never;
|
|
3423
|
+
url: '/intents';
|
|
3424
|
+
};
|
|
3425
|
+
export type Create3Errors = {
|
|
3426
|
+
/**
|
|
3427
|
+
* Bad request
|
|
3428
|
+
*/
|
|
3429
|
+
400: {
|
|
3430
|
+
statusCode: number;
|
|
3431
|
+
error: {
|
|
3432
|
+
code: 'MISSING-ORG' | 'VALIDATION' | 'INVALID-JSON';
|
|
3433
|
+
message: string;
|
|
3434
|
+
};
|
|
3435
|
+
};
|
|
3436
|
+
/**
|
|
3437
|
+
* Authentication required
|
|
3438
|
+
*/
|
|
3439
|
+
401: {
|
|
3440
|
+
statusCode: number;
|
|
3441
|
+
error: {
|
|
3442
|
+
code: 'AUTH';
|
|
3443
|
+
message: string;
|
|
3444
|
+
};
|
|
3445
|
+
};
|
|
3446
|
+
/**
|
|
3447
|
+
* Insufficient permissions
|
|
3448
|
+
*/
|
|
3449
|
+
403: {
|
|
3450
|
+
statusCode: number;
|
|
3451
|
+
error: {
|
|
3452
|
+
code: 'FORBIDDEN' | 'SCOPE-FORBIDDEN';
|
|
3453
|
+
message: string;
|
|
3454
|
+
};
|
|
3455
|
+
};
|
|
3456
|
+
};
|
|
3457
|
+
export type Create3Error = Create3Errors[keyof Create3Errors];
|
|
3458
|
+
export type Create3Responses = {
|
|
3459
|
+
/**
|
|
3460
|
+
* Successful response
|
|
3461
|
+
*/
|
|
3462
|
+
200: {
|
|
3463
|
+
/**
|
|
3464
|
+
* Opaque intent id (prefixed `int_`).
|
|
3465
|
+
*/
|
|
3466
|
+
id: string;
|
|
3467
|
+
/**
|
|
3468
|
+
* Machine name — stable identifier used across the API.
|
|
3469
|
+
*/
|
|
3470
|
+
intent: string;
|
|
3471
|
+
/**
|
|
3472
|
+
* Human-readable label.
|
|
3473
|
+
*/
|
|
3474
|
+
label: string;
|
|
3475
|
+
/**
|
|
3476
|
+
* Description the orchestrator uses to classify user messages.
|
|
3477
|
+
*/
|
|
3478
|
+
description: string;
|
|
3479
|
+
/**
|
|
3480
|
+
* Where the intent is routed once detected — response agent, human escalation, or a specialist.
|
|
3481
|
+
*/
|
|
3482
|
+
route: {
|
|
3483
|
+
/**
|
|
3484
|
+
* Routing target — `response` (straight to the response agent), `human` (escalation), or `specialist`.
|
|
3485
|
+
*/
|
|
3486
|
+
type: 'response' | 'human' | 'specialist';
|
|
3487
|
+
/**
|
|
3488
|
+
* Machine name of the specialist agent — required when `type` is `specialist`, ignored otherwise.
|
|
3489
|
+
*/
|
|
3490
|
+
agentName?: string;
|
|
3491
|
+
};
|
|
3492
|
+
/**
|
|
3493
|
+
* Effective processing mode at the request scope.
|
|
3494
|
+
*/
|
|
3495
|
+
mode: 'disabled' | 'copilot' | 'autopilot';
|
|
3496
|
+
/**
|
|
3497
|
+
* Whether the user must be identified before processing.
|
|
3498
|
+
*/
|
|
3499
|
+
requiresUserInfo: boolean;
|
|
3500
|
+
/**
|
|
3501
|
+
* Display order in the intent list.
|
|
3502
|
+
*/
|
|
3503
|
+
order: number;
|
|
3504
|
+
/**
|
|
3505
|
+
* Cascade level this view was resolved at.
|
|
3506
|
+
*/
|
|
3507
|
+
scope: {
|
|
3508
|
+
/**
|
|
3509
|
+
* Cascade level of this view — `global` (applies everywhere), `organization`, or `entity`.
|
|
3510
|
+
*/
|
|
3511
|
+
level: 'global' | 'organization' | 'entity';
|
|
3512
|
+
/**
|
|
3513
|
+
* Organization id when `level` is `organization` or `entity`.
|
|
3514
|
+
*/
|
|
3515
|
+
organizationId?: string;
|
|
3516
|
+
/**
|
|
3517
|
+
* Entity id when `level` is `entity`.
|
|
3518
|
+
*/
|
|
3519
|
+
entityId?: string;
|
|
3520
|
+
};
|
|
3521
|
+
};
|
|
3522
|
+
};
|
|
3523
|
+
export type Create3Response = Create3Responses[keyof Create3Responses];
|
|
3524
|
+
export type Delete3Data = {
|
|
3525
|
+
body?: never;
|
|
3526
|
+
path: {
|
|
3527
|
+
id: string;
|
|
3528
|
+
};
|
|
3529
|
+
query?: never;
|
|
3530
|
+
url: '/intents/{id}';
|
|
3531
|
+
};
|
|
3532
|
+
export type Delete3Errors = {
|
|
3533
|
+
/**
|
|
3534
|
+
* Bad request
|
|
3535
|
+
*/
|
|
3536
|
+
400: {
|
|
3537
|
+
statusCode: number;
|
|
3538
|
+
error: {
|
|
3539
|
+
code: 'MISSING-ORG';
|
|
3540
|
+
message: string;
|
|
3541
|
+
};
|
|
3542
|
+
};
|
|
3543
|
+
/**
|
|
3544
|
+
* Authentication required
|
|
3545
|
+
*/
|
|
3546
|
+
401: {
|
|
3547
|
+
statusCode: number;
|
|
3548
|
+
error: {
|
|
3549
|
+
code: 'AUTH';
|
|
3550
|
+
message: string;
|
|
3551
|
+
};
|
|
3552
|
+
};
|
|
3553
|
+
/**
|
|
3554
|
+
* Insufficient permissions
|
|
3555
|
+
*/
|
|
3556
|
+
403: {
|
|
3557
|
+
statusCode: number;
|
|
3558
|
+
error: {
|
|
3559
|
+
code: 'FORBIDDEN' | 'SCOPE-FORBIDDEN';
|
|
3560
|
+
message: string;
|
|
3561
|
+
};
|
|
3562
|
+
};
|
|
3563
|
+
};
|
|
3564
|
+
export type Delete3Error = Delete3Errors[keyof Delete3Errors];
|
|
3565
|
+
export type Delete3Responses = {
|
|
3566
|
+
/**
|
|
3567
|
+
* Successful response
|
|
3568
|
+
*/
|
|
3569
|
+
200: {
|
|
3570
|
+
/**
|
|
3571
|
+
* Confirmation message describing the outcome.
|
|
3572
|
+
*/
|
|
3573
|
+
message: string;
|
|
3574
|
+
};
|
|
3575
|
+
};
|
|
3576
|
+
export type Delete3Response = Delete3Responses[keyof Delete3Responses];
|
|
3577
|
+
export type Get4Data = {
|
|
3578
|
+
body?: never;
|
|
3579
|
+
path: {
|
|
3580
|
+
id: string;
|
|
3581
|
+
};
|
|
3582
|
+
query?: {
|
|
3583
|
+
/**
|
|
3584
|
+
* Target a specific entity (under the caller's organization).
|
|
3585
|
+
*/
|
|
3586
|
+
entityId?: string;
|
|
3587
|
+
};
|
|
3588
|
+
url: '/intents/{id}';
|
|
3589
|
+
};
|
|
3590
|
+
export type Get4Errors = {
|
|
3591
|
+
/**
|
|
3592
|
+
* Bad request
|
|
3593
|
+
*/
|
|
3594
|
+
400: {
|
|
3595
|
+
statusCode: number;
|
|
3596
|
+
error: {
|
|
3597
|
+
code: 'MISSING-ORG' | 'VALIDATION' | 'INVALID-JSON';
|
|
3598
|
+
message: string;
|
|
3599
|
+
};
|
|
3600
|
+
};
|
|
3601
|
+
/**
|
|
3602
|
+
* Authentication required
|
|
3603
|
+
*/
|
|
3604
|
+
401: {
|
|
3605
|
+
statusCode: number;
|
|
3606
|
+
error: {
|
|
3607
|
+
code: 'AUTH';
|
|
3608
|
+
message: string;
|
|
3609
|
+
};
|
|
3610
|
+
};
|
|
3611
|
+
/**
|
|
3612
|
+
* Insufficient permissions
|
|
3613
|
+
*/
|
|
3614
|
+
403: {
|
|
3615
|
+
statusCode: number;
|
|
3616
|
+
error: {
|
|
3617
|
+
code: 'FORBIDDEN' | 'SCOPE-FORBIDDEN';
|
|
3618
|
+
message: string;
|
|
3619
|
+
};
|
|
3620
|
+
};
|
|
3621
|
+
};
|
|
3622
|
+
export type Get4Error = Get4Errors[keyof Get4Errors];
|
|
3623
|
+
export type Get4Responses = {
|
|
3624
|
+
/**
|
|
3625
|
+
* Successful response
|
|
3626
|
+
*/
|
|
3627
|
+
200: {
|
|
3628
|
+
/**
|
|
3629
|
+
* Opaque intent id (prefixed `int_`).
|
|
3630
|
+
*/
|
|
3631
|
+
id: string;
|
|
3632
|
+
/**
|
|
3633
|
+
* Machine name — stable identifier used across the API.
|
|
3634
|
+
*/
|
|
3635
|
+
intent: string;
|
|
3636
|
+
/**
|
|
3637
|
+
* Human-readable label.
|
|
3638
|
+
*/
|
|
3639
|
+
label: string;
|
|
3640
|
+
/**
|
|
3641
|
+
* Description the orchestrator uses to classify user messages.
|
|
3642
|
+
*/
|
|
3643
|
+
description: string;
|
|
3644
|
+
/**
|
|
3645
|
+
* Where the intent is routed once detected — response agent, human escalation, or a specialist.
|
|
3646
|
+
*/
|
|
3647
|
+
route: {
|
|
3648
|
+
/**
|
|
3649
|
+
* Routing target — `response` (straight to the response agent), `human` (escalation), or `specialist`.
|
|
3650
|
+
*/
|
|
3651
|
+
type: 'response' | 'human' | 'specialist';
|
|
3652
|
+
/**
|
|
3653
|
+
* Machine name of the specialist agent — required when `type` is `specialist`, ignored otherwise.
|
|
3654
|
+
*/
|
|
3655
|
+
agentName?: string;
|
|
3656
|
+
};
|
|
3657
|
+
/**
|
|
3658
|
+
* Effective processing mode at the request scope.
|
|
3659
|
+
*/
|
|
3660
|
+
mode: 'disabled' | 'copilot' | 'autopilot';
|
|
3661
|
+
/**
|
|
3662
|
+
* Whether the user must be identified before processing.
|
|
3663
|
+
*/
|
|
3664
|
+
requiresUserInfo: boolean;
|
|
3665
|
+
/**
|
|
3666
|
+
* Display order in the intent list.
|
|
3667
|
+
*/
|
|
3668
|
+
order: number;
|
|
3669
|
+
/**
|
|
3670
|
+
* Cascade level this view was resolved at.
|
|
3671
|
+
*/
|
|
3672
|
+
scope: {
|
|
3673
|
+
/**
|
|
3674
|
+
* Cascade level of this view — `global` (applies everywhere), `organization`, or `entity`.
|
|
3675
|
+
*/
|
|
3676
|
+
level: 'global' | 'organization' | 'entity';
|
|
3677
|
+
/**
|
|
3678
|
+
* Organization id when `level` is `organization` or `entity`.
|
|
3679
|
+
*/
|
|
3680
|
+
organizationId?: string;
|
|
3681
|
+
/**
|
|
3682
|
+
* Entity id when `level` is `entity`.
|
|
3683
|
+
*/
|
|
3684
|
+
entityId?: string;
|
|
3685
|
+
};
|
|
3686
|
+
};
|
|
3687
|
+
};
|
|
3688
|
+
export type Get4Response = Get4Responses[keyof Get4Responses];
|
|
3689
|
+
export type Update3Data = {
|
|
3690
|
+
body?: {
|
|
3691
|
+
/**
|
|
3692
|
+
* Human-readable label.
|
|
3693
|
+
*/
|
|
3694
|
+
label?: string;
|
|
3695
|
+
/**
|
|
3696
|
+
* Description the orchestrator uses to classify user messages.
|
|
3697
|
+
*/
|
|
3698
|
+
description?: string;
|
|
3699
|
+
/**
|
|
3700
|
+
* Where the intent is routed once detected. Editable at global scope only.
|
|
3701
|
+
*/
|
|
3702
|
+
route?: {
|
|
3703
|
+
/**
|
|
3704
|
+
* Routing target — `response` (straight to the response agent), `human` (escalation), or `specialist`.
|
|
3705
|
+
*/
|
|
3706
|
+
type: 'response' | 'human' | 'specialist';
|
|
3707
|
+
/**
|
|
3708
|
+
* Machine name of the specialist agent — required when `type` is `specialist`, ignored otherwise.
|
|
3709
|
+
*/
|
|
3710
|
+
agentName?: string;
|
|
3711
|
+
};
|
|
3712
|
+
/**
|
|
3713
|
+
* Processing mode (`disabled` / `copilot` / `autopilot`) — the only field accepted at organization/entity scope.
|
|
3714
|
+
*/
|
|
3715
|
+
mode?: 'disabled' | 'copilot' | 'autopilot';
|
|
3716
|
+
/**
|
|
3717
|
+
* Whether the user must be identified before processing.
|
|
3718
|
+
*/
|
|
3719
|
+
requiresUserInfo?: boolean;
|
|
3720
|
+
/**
|
|
3721
|
+
* Display order in the intent list (lower first).
|
|
3722
|
+
*/
|
|
3723
|
+
order?: number;
|
|
3724
|
+
};
|
|
3725
|
+
path: {
|
|
3726
|
+
id: string;
|
|
3727
|
+
};
|
|
3728
|
+
query?: {
|
|
3729
|
+
/**
|
|
3730
|
+
* Target a specific entity (under the caller's organization).
|
|
3731
|
+
*/
|
|
3732
|
+
entityId?: string;
|
|
3733
|
+
};
|
|
3734
|
+
url: '/intents/{id}';
|
|
3735
|
+
};
|
|
3736
|
+
export type Update3Errors = {
|
|
3737
|
+
/**
|
|
3738
|
+
* Bad request
|
|
3739
|
+
*/
|
|
3740
|
+
400: {
|
|
3741
|
+
statusCode: number;
|
|
3742
|
+
error: {
|
|
3743
|
+
code: 'MISSING-ORG' | 'VALIDATION' | 'INVALID-JSON';
|
|
3744
|
+
message: string;
|
|
3745
|
+
};
|
|
3746
|
+
};
|
|
3747
|
+
/**
|
|
3748
|
+
* Authentication required
|
|
3749
|
+
*/
|
|
3750
|
+
401: {
|
|
3751
|
+
statusCode: number;
|
|
3752
|
+
error: {
|
|
3753
|
+
code: 'AUTH';
|
|
3754
|
+
message: string;
|
|
3755
|
+
};
|
|
3756
|
+
};
|
|
3757
|
+
/**
|
|
3758
|
+
* Insufficient permissions
|
|
3759
|
+
*/
|
|
3760
|
+
403: {
|
|
3761
|
+
statusCode: number;
|
|
3762
|
+
error: {
|
|
3763
|
+
code: 'FORBIDDEN' | 'SCOPE-FORBIDDEN';
|
|
3764
|
+
message: string;
|
|
3765
|
+
};
|
|
3766
|
+
};
|
|
3767
|
+
};
|
|
3768
|
+
export type Update3Error = Update3Errors[keyof Update3Errors];
|
|
3769
|
+
export type Update3Responses = {
|
|
3770
|
+
/**
|
|
3771
|
+
* Successful response
|
|
3772
|
+
*/
|
|
3773
|
+
200: {
|
|
3774
|
+
/**
|
|
3775
|
+
* Opaque intent id (prefixed `int_`).
|
|
3776
|
+
*/
|
|
3777
|
+
id: string;
|
|
3778
|
+
/**
|
|
3779
|
+
* Machine name — stable identifier used across the API.
|
|
3780
|
+
*/
|
|
3781
|
+
intent: string;
|
|
3782
|
+
/**
|
|
3783
|
+
* Human-readable label.
|
|
3784
|
+
*/
|
|
3785
|
+
label: string;
|
|
3786
|
+
/**
|
|
3787
|
+
* Description the orchestrator uses to classify user messages.
|
|
3788
|
+
*/
|
|
3789
|
+
description: string;
|
|
3790
|
+
/**
|
|
3791
|
+
* Where the intent is routed once detected — response agent, human escalation, or a specialist.
|
|
3792
|
+
*/
|
|
3793
|
+
route: {
|
|
3794
|
+
/**
|
|
3795
|
+
* Routing target — `response` (straight to the response agent), `human` (escalation), or `specialist`.
|
|
3796
|
+
*/
|
|
3797
|
+
type: 'response' | 'human' | 'specialist';
|
|
3798
|
+
/**
|
|
3799
|
+
* Machine name of the specialist agent — required when `type` is `specialist`, ignored otherwise.
|
|
3800
|
+
*/
|
|
3801
|
+
agentName?: string;
|
|
3802
|
+
};
|
|
3803
|
+
/**
|
|
3804
|
+
* Effective processing mode at the request scope.
|
|
3805
|
+
*/
|
|
3806
|
+
mode: 'disabled' | 'copilot' | 'autopilot';
|
|
3807
|
+
/**
|
|
3808
|
+
* Whether the user must be identified before processing.
|
|
3809
|
+
*/
|
|
3810
|
+
requiresUserInfo: boolean;
|
|
3811
|
+
/**
|
|
3812
|
+
* Display order in the intent list.
|
|
3813
|
+
*/
|
|
3814
|
+
order: number;
|
|
3815
|
+
/**
|
|
3816
|
+
* Cascade level this view was resolved at.
|
|
3817
|
+
*/
|
|
3818
|
+
scope: {
|
|
3819
|
+
/**
|
|
3820
|
+
* Cascade level of this view — `global` (applies everywhere), `organization`, or `entity`.
|
|
3821
|
+
*/
|
|
3822
|
+
level: 'global' | 'organization' | 'entity';
|
|
3823
|
+
/**
|
|
3824
|
+
* Organization id when `level` is `organization` or `entity`.
|
|
3825
|
+
*/
|
|
3826
|
+
organizationId?: string;
|
|
3827
|
+
/**
|
|
3828
|
+
* Entity id when `level` is `entity`.
|
|
3829
|
+
*/
|
|
3830
|
+
entityId?: string;
|
|
3831
|
+
};
|
|
3832
|
+
};
|
|
3833
|
+
};
|
|
3834
|
+
export type Update3Response = Update3Responses[keyof Update3Responses];
|
|
3835
|
+
export type DeleteOverride2Data = {
|
|
3836
|
+
body?: never;
|
|
3837
|
+
path: {
|
|
3838
|
+
id: string;
|
|
3839
|
+
};
|
|
3840
|
+
query?: {
|
|
3841
|
+
/**
|
|
3842
|
+
* Target a specific entity (under the caller's organization).
|
|
3843
|
+
*/
|
|
3844
|
+
entityId?: string;
|
|
3845
|
+
};
|
|
3846
|
+
url: '/intents/{id}/override';
|
|
3847
|
+
};
|
|
3848
|
+
export type DeleteOverride2Errors = {
|
|
3849
|
+
/**
|
|
3850
|
+
* Bad request
|
|
3851
|
+
*/
|
|
3852
|
+
400: {
|
|
3853
|
+
statusCode: number;
|
|
3854
|
+
error: {
|
|
3855
|
+
code: 'MISSING-ORG' | 'VALIDATION' | 'INVALID-JSON';
|
|
3856
|
+
message: string;
|
|
3857
|
+
};
|
|
3858
|
+
};
|
|
3859
|
+
/**
|
|
3860
|
+
* Authentication required
|
|
3861
|
+
*/
|
|
3862
|
+
401: {
|
|
3863
|
+
statusCode: number;
|
|
3864
|
+
error: {
|
|
3865
|
+
code: 'AUTH';
|
|
3866
|
+
message: string;
|
|
3867
|
+
};
|
|
3868
|
+
};
|
|
3869
|
+
/**
|
|
3870
|
+
* Insufficient permissions
|
|
3871
|
+
*/
|
|
3872
|
+
403: {
|
|
3873
|
+
statusCode: number;
|
|
3874
|
+
error: {
|
|
3875
|
+
code: 'FORBIDDEN' | 'SCOPE-FORBIDDEN';
|
|
3876
|
+
message: string;
|
|
3877
|
+
};
|
|
3878
|
+
};
|
|
3879
|
+
};
|
|
3880
|
+
export type DeleteOverride2Error = DeleteOverride2Errors[keyof DeleteOverride2Errors];
|
|
3881
|
+
export type DeleteOverride2Responses = {
|
|
3882
|
+
/**
|
|
3883
|
+
* Successful response
|
|
3884
|
+
*/
|
|
3885
|
+
200: {
|
|
3886
|
+
/**
|
|
3887
|
+
* Confirmation message describing the outcome.
|
|
3888
|
+
*/
|
|
3889
|
+
message: string;
|
|
3890
|
+
};
|
|
3891
|
+
};
|
|
3892
|
+
export type DeleteOverride2Response = DeleteOverride2Responses[keyof DeleteOverride2Responses];
|
|
3893
|
+
export type List5Data = {
|
|
3894
|
+
body?: never;
|
|
3895
|
+
path?: never;
|
|
3896
|
+
query?: {
|
|
3897
|
+
/**
|
|
3898
|
+
* Max number of items to return per page (1-100).
|
|
3899
|
+
*/
|
|
3900
|
+
limit?: number;
|
|
3901
|
+
/**
|
|
3902
|
+
* Number of items to skip for pagination.
|
|
3903
|
+
*/
|
|
3904
|
+
offset?: number | null;
|
|
3905
|
+
/**
|
|
3906
|
+
* Target a specific entity (under the caller's organization).
|
|
3907
|
+
*/
|
|
3908
|
+
entityId?: string;
|
|
3909
|
+
};
|
|
3910
|
+
url: '/kb';
|
|
3911
|
+
};
|
|
3912
|
+
export type List5Errors = {
|
|
3913
|
+
/**
|
|
3914
|
+
* Bad request
|
|
3915
|
+
*/
|
|
3916
|
+
400: {
|
|
3917
|
+
statusCode: number;
|
|
3918
|
+
error: {
|
|
3919
|
+
code: 'MISSING-ORG' | 'VALIDATION' | 'INVALID-JSON';
|
|
3920
|
+
message: string;
|
|
3921
|
+
};
|
|
3922
|
+
};
|
|
3923
|
+
/**
|
|
3924
|
+
* Authentication required
|
|
3925
|
+
*/
|
|
3926
|
+
401: {
|
|
3927
|
+
statusCode: number;
|
|
3928
|
+
error: {
|
|
3929
|
+
code: 'AUTH';
|
|
3930
|
+
message: string;
|
|
3931
|
+
};
|
|
3932
|
+
};
|
|
3933
|
+
/**
|
|
3934
|
+
* Insufficient permissions
|
|
3935
|
+
*/
|
|
3936
|
+
403: {
|
|
3937
|
+
statusCode: number;
|
|
3938
|
+
error: {
|
|
3939
|
+
code: 'FORBIDDEN' | 'SCOPE-FORBIDDEN';
|
|
3940
|
+
message: string;
|
|
3941
|
+
};
|
|
3942
|
+
};
|
|
3943
|
+
};
|
|
3944
|
+
export type List5Error = List5Errors[keyof List5Errors];
|
|
3945
|
+
export type List5Responses = {
|
|
3946
|
+
/**
|
|
3947
|
+
* Successful response
|
|
3948
|
+
*/
|
|
3949
|
+
200: {
|
|
3950
|
+
articles: Array<{
|
|
3951
|
+
/**
|
|
3952
|
+
* KB article ID (format: kb_xxxxxxxxxxxx).
|
|
3953
|
+
*/
|
|
3954
|
+
id: string;
|
|
3955
|
+
/**
|
|
3956
|
+
* Current published title of the article.
|
|
3957
|
+
*/
|
|
3958
|
+
title: string;
|
|
3959
|
+
/**
|
|
3960
|
+
* Intent IDs this article serves. Empty array = always-on within its scope.
|
|
3961
|
+
*/
|
|
3962
|
+
intents: Array<string>;
|
|
3963
|
+
/**
|
|
3964
|
+
* Cascade level at which this article was created.
|
|
3965
|
+
*/
|
|
3966
|
+
scope: {
|
|
3967
|
+
/**
|
|
3968
|
+
* Cascade level this article lives at — `global` (whole tenant), `organization` (per-org), or `entity` (per-entity).
|
|
3969
|
+
*/
|
|
3970
|
+
level: 'global' | 'organization' | 'entity';
|
|
3971
|
+
/**
|
|
3972
|
+
* ID of the organization when `level` is `organization` or `entity`.
|
|
3973
|
+
*/
|
|
3974
|
+
organizationId?: string;
|
|
3975
|
+
/**
|
|
3976
|
+
* ID of the entity when `level` is `entity`.
|
|
3977
|
+
*/
|
|
3978
|
+
entityId?: string;
|
|
3979
|
+
};
|
|
3980
|
+
/**
|
|
3981
|
+
* Version number of the published content.
|
|
3982
|
+
*/
|
|
3983
|
+
version: number;
|
|
3984
|
+
/**
|
|
3985
|
+
* True when an unpublished draft exists on this article.
|
|
3986
|
+
*/
|
|
3987
|
+
hasDraft: boolean;
|
|
3988
|
+
/**
|
|
3989
|
+
* ISO timestamp of the last publication.
|
|
3990
|
+
*/
|
|
3991
|
+
publishedAt?: string;
|
|
3992
|
+
/**
|
|
3993
|
+
* ISO timestamp of the last modification.
|
|
3994
|
+
*/
|
|
3995
|
+
updatedAt: string;
|
|
3996
|
+
}>;
|
|
3997
|
+
/**
|
|
3998
|
+
* Total number of items matching the query.
|
|
2038
3999
|
*/
|
|
2039
4000
|
total: number;
|
|
2040
4001
|
/**
|
|
@@ -2047,8 +4008,8 @@ export type List4Responses = {
|
|
|
2047
4008
|
offset: number;
|
|
2048
4009
|
};
|
|
2049
4010
|
};
|
|
2050
|
-
export type
|
|
2051
|
-
export type
|
|
4011
|
+
export type List5Response = List5Responses[keyof List5Responses];
|
|
4012
|
+
export type Create4Data = {
|
|
2052
4013
|
body?: {
|
|
2053
4014
|
/**
|
|
2054
4015
|
* Article title.
|
|
@@ -2072,7 +4033,7 @@ export type Create3Data = {
|
|
|
2072
4033
|
};
|
|
2073
4034
|
url: '/kb';
|
|
2074
4035
|
};
|
|
2075
|
-
export type
|
|
4036
|
+
export type Create4Errors = {
|
|
2076
4037
|
/**
|
|
2077
4038
|
* Bad request
|
|
2078
4039
|
*/
|
|
@@ -2104,8 +4065,8 @@ export type Create3Errors = {
|
|
|
2104
4065
|
};
|
|
2105
4066
|
};
|
|
2106
4067
|
};
|
|
2107
|
-
export type
|
|
2108
|
-
export type
|
|
4068
|
+
export type Create4Error = Create4Errors[keyof Create4Errors];
|
|
4069
|
+
export type Create4Responses = {
|
|
2109
4070
|
/**
|
|
2110
4071
|
* Successful response
|
|
2111
4072
|
*/
|
|
@@ -2114,32 +4075,89 @@ export type Create3Responses = {
|
|
|
2114
4075
|
* KB article ID (format: kb_xxxxxxxxxxxx).
|
|
2115
4076
|
*/
|
|
2116
4077
|
id: string;
|
|
4078
|
+
/**
|
|
4079
|
+
* Cascade level at which this article was created.
|
|
4080
|
+
*/
|
|
2117
4081
|
scope: {
|
|
4082
|
+
/**
|
|
4083
|
+
* Cascade level this article lives at — `global` (whole tenant), `organization` (per-org), or `entity` (per-entity).
|
|
4084
|
+
*/
|
|
2118
4085
|
level: 'global' | 'organization' | 'entity';
|
|
4086
|
+
/**
|
|
4087
|
+
* ID of the organization when `level` is `organization` or `entity`.
|
|
4088
|
+
*/
|
|
2119
4089
|
organizationId?: string;
|
|
4090
|
+
/**
|
|
4091
|
+
* ID of the entity when `level` is `entity`.
|
|
4092
|
+
*/
|
|
2120
4093
|
entityId?: string;
|
|
2121
4094
|
};
|
|
4095
|
+
/**
|
|
4096
|
+
* Intent IDs this article serves. Empty array = always-on within its scope.
|
|
4097
|
+
*/
|
|
2122
4098
|
intents: Array<string>;
|
|
4099
|
+
/**
|
|
4100
|
+
* Currently published content of the article.
|
|
4101
|
+
*/
|
|
2123
4102
|
published: {
|
|
4103
|
+
/**
|
|
4104
|
+
* Monotonic version number of this snapshot.
|
|
4105
|
+
*/
|
|
2124
4106
|
version: number;
|
|
4107
|
+
/**
|
|
4108
|
+
* Article title at this version.
|
|
4109
|
+
*/
|
|
2125
4110
|
title: string;
|
|
4111
|
+
/**
|
|
4112
|
+
* Article body (Markdown) at this version.
|
|
4113
|
+
*/
|
|
2126
4114
|
content: string;
|
|
4115
|
+
/**
|
|
4116
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
4117
|
+
*/
|
|
2127
4118
|
publishedAt?: string;
|
|
4119
|
+
/**
|
|
4120
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
4121
|
+
*/
|
|
2128
4122
|
updatedAt?: string;
|
|
2129
4123
|
};
|
|
4124
|
+
/**
|
|
4125
|
+
* Pending draft content, when one exists. Promote it via `publish: true` on update.
|
|
4126
|
+
*/
|
|
2130
4127
|
draft?: {
|
|
4128
|
+
/**
|
|
4129
|
+
* Monotonic version number of this snapshot.
|
|
4130
|
+
*/
|
|
2131
4131
|
version: number;
|
|
4132
|
+
/**
|
|
4133
|
+
* Article title at this version.
|
|
4134
|
+
*/
|
|
2132
4135
|
title: string;
|
|
4136
|
+
/**
|
|
4137
|
+
* Article body (Markdown) at this version.
|
|
4138
|
+
*/
|
|
2133
4139
|
content: string;
|
|
4140
|
+
/**
|
|
4141
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
4142
|
+
*/
|
|
2134
4143
|
publishedAt?: string;
|
|
4144
|
+
/**
|
|
4145
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
4146
|
+
*/
|
|
2135
4147
|
updatedAt?: string;
|
|
2136
4148
|
};
|
|
4149
|
+
/**
|
|
4150
|
+
* ISO timestamp when the article was created.
|
|
4151
|
+
*/
|
|
2137
4152
|
createdAt: string;
|
|
4153
|
+
/**
|
|
4154
|
+
* ISO timestamp of the last modification (publish, draft edit, intents change).
|
|
4155
|
+
*/
|
|
2138
4156
|
updatedAt: string;
|
|
2139
4157
|
};
|
|
2140
4158
|
};
|
|
2141
|
-
export type
|
|
2142
|
-
export type
|
|
4159
|
+
export type Create4Response = Create4Responses[keyof Create4Responses];
|
|
4160
|
+
export type Delete4Data = {
|
|
2143
4161
|
body?: never;
|
|
2144
4162
|
path: {
|
|
2145
4163
|
/**
|
|
@@ -2150,7 +4168,7 @@ export type Delete3Data = {
|
|
|
2150
4168
|
query?: never;
|
|
2151
4169
|
url: '/kb/{id}';
|
|
2152
4170
|
};
|
|
2153
|
-
export type
|
|
4171
|
+
export type Delete4Errors = {
|
|
2154
4172
|
/**
|
|
2155
4173
|
* Bad request
|
|
2156
4174
|
*/
|
|
@@ -2182,17 +4200,20 @@ export type Delete3Errors = {
|
|
|
2182
4200
|
};
|
|
2183
4201
|
};
|
|
2184
4202
|
};
|
|
2185
|
-
export type
|
|
2186
|
-
export type
|
|
4203
|
+
export type Delete4Error = Delete4Errors[keyof Delete4Errors];
|
|
4204
|
+
export type Delete4Responses = {
|
|
2187
4205
|
/**
|
|
2188
4206
|
* Successful response
|
|
2189
4207
|
*/
|
|
2190
4208
|
200: {
|
|
4209
|
+
/**
|
|
4210
|
+
* Confirmation message describing the deletion outcome.
|
|
4211
|
+
*/
|
|
2191
4212
|
message: string;
|
|
2192
4213
|
};
|
|
2193
4214
|
};
|
|
2194
|
-
export type
|
|
2195
|
-
export type
|
|
4215
|
+
export type Delete4Response = Delete4Responses[keyof Delete4Responses];
|
|
4216
|
+
export type Get5Data = {
|
|
2196
4217
|
body?: never;
|
|
2197
4218
|
path: {
|
|
2198
4219
|
/**
|
|
@@ -2203,7 +4224,7 @@ export type Get4Data = {
|
|
|
2203
4224
|
query?: never;
|
|
2204
4225
|
url: '/kb/{id}';
|
|
2205
4226
|
};
|
|
2206
|
-
export type
|
|
4227
|
+
export type Get5Errors = {
|
|
2207
4228
|
/**
|
|
2208
4229
|
* Bad request
|
|
2209
4230
|
*/
|
|
@@ -2235,8 +4256,8 @@ export type Get4Errors = {
|
|
|
2235
4256
|
};
|
|
2236
4257
|
};
|
|
2237
4258
|
};
|
|
2238
|
-
export type
|
|
2239
|
-
export type
|
|
4259
|
+
export type Get5Error = Get5Errors[keyof Get5Errors];
|
|
4260
|
+
export type Get5Responses = {
|
|
2240
4261
|
/**
|
|
2241
4262
|
* Successful response
|
|
2242
4263
|
*/
|
|
@@ -2245,32 +4266,89 @@ export type Get4Responses = {
|
|
|
2245
4266
|
* KB article ID (format: kb_xxxxxxxxxxxx).
|
|
2246
4267
|
*/
|
|
2247
4268
|
id: string;
|
|
4269
|
+
/**
|
|
4270
|
+
* Cascade level at which this article was created.
|
|
4271
|
+
*/
|
|
2248
4272
|
scope: {
|
|
4273
|
+
/**
|
|
4274
|
+
* Cascade level this article lives at — `global` (whole tenant), `organization` (per-org), or `entity` (per-entity).
|
|
4275
|
+
*/
|
|
2249
4276
|
level: 'global' | 'organization' | 'entity';
|
|
4277
|
+
/**
|
|
4278
|
+
* ID of the organization when `level` is `organization` or `entity`.
|
|
4279
|
+
*/
|
|
2250
4280
|
organizationId?: string;
|
|
4281
|
+
/**
|
|
4282
|
+
* ID of the entity when `level` is `entity`.
|
|
4283
|
+
*/
|
|
2251
4284
|
entityId?: string;
|
|
2252
4285
|
};
|
|
4286
|
+
/**
|
|
4287
|
+
* Intent IDs this article serves. Empty array = always-on within its scope.
|
|
4288
|
+
*/
|
|
2253
4289
|
intents: Array<string>;
|
|
4290
|
+
/**
|
|
4291
|
+
* Currently published content of the article.
|
|
4292
|
+
*/
|
|
2254
4293
|
published: {
|
|
4294
|
+
/**
|
|
4295
|
+
* Monotonic version number of this snapshot.
|
|
4296
|
+
*/
|
|
2255
4297
|
version: number;
|
|
4298
|
+
/**
|
|
4299
|
+
* Article title at this version.
|
|
4300
|
+
*/
|
|
2256
4301
|
title: string;
|
|
4302
|
+
/**
|
|
4303
|
+
* Article body (Markdown) at this version.
|
|
4304
|
+
*/
|
|
2257
4305
|
content: string;
|
|
4306
|
+
/**
|
|
4307
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
4308
|
+
*/
|
|
2258
4309
|
publishedAt?: string;
|
|
4310
|
+
/**
|
|
4311
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
4312
|
+
*/
|
|
2259
4313
|
updatedAt?: string;
|
|
2260
4314
|
};
|
|
4315
|
+
/**
|
|
4316
|
+
* Pending draft content, when one exists. Promote it via `publish: true` on update.
|
|
4317
|
+
*/
|
|
2261
4318
|
draft?: {
|
|
4319
|
+
/**
|
|
4320
|
+
* Monotonic version number of this snapshot.
|
|
4321
|
+
*/
|
|
2262
4322
|
version: number;
|
|
4323
|
+
/**
|
|
4324
|
+
* Article title at this version.
|
|
4325
|
+
*/
|
|
2263
4326
|
title: string;
|
|
4327
|
+
/**
|
|
4328
|
+
* Article body (Markdown) at this version.
|
|
4329
|
+
*/
|
|
2264
4330
|
content: string;
|
|
4331
|
+
/**
|
|
4332
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
4333
|
+
*/
|
|
2265
4334
|
publishedAt?: string;
|
|
4335
|
+
/**
|
|
4336
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
4337
|
+
*/
|
|
2266
4338
|
updatedAt?: string;
|
|
2267
4339
|
};
|
|
4340
|
+
/**
|
|
4341
|
+
* ISO timestamp when the article was created.
|
|
4342
|
+
*/
|
|
2268
4343
|
createdAt: string;
|
|
4344
|
+
/**
|
|
4345
|
+
* ISO timestamp of the last modification (publish, draft edit, intents change).
|
|
4346
|
+
*/
|
|
2269
4347
|
updatedAt: string;
|
|
2270
4348
|
};
|
|
2271
4349
|
};
|
|
2272
|
-
export type
|
|
2273
|
-
export type
|
|
4350
|
+
export type Get5Response = Get5Responses[keyof Get5Responses];
|
|
4351
|
+
export type Update4Data = {
|
|
2274
4352
|
body?: {
|
|
2275
4353
|
/**
|
|
2276
4354
|
* New article title.
|
|
@@ -2298,7 +4376,7 @@ export type Update3Data = {
|
|
|
2298
4376
|
query?: never;
|
|
2299
4377
|
url: '/kb/{id}';
|
|
2300
4378
|
};
|
|
2301
|
-
export type
|
|
4379
|
+
export type Update4Errors = {
|
|
2302
4380
|
/**
|
|
2303
4381
|
* Bad request
|
|
2304
4382
|
*/
|
|
@@ -2330,8 +4408,8 @@ export type Update3Errors = {
|
|
|
2330
4408
|
};
|
|
2331
4409
|
};
|
|
2332
4410
|
};
|
|
2333
|
-
export type
|
|
2334
|
-
export type
|
|
4411
|
+
export type Update4Error = Update4Errors[keyof Update4Errors];
|
|
4412
|
+
export type Update4Responses = {
|
|
2335
4413
|
/**
|
|
2336
4414
|
* Successful response
|
|
2337
4415
|
*/
|
|
@@ -2340,31 +4418,88 @@ export type Update3Responses = {
|
|
|
2340
4418
|
* KB article ID (format: kb_xxxxxxxxxxxx).
|
|
2341
4419
|
*/
|
|
2342
4420
|
id: string;
|
|
4421
|
+
/**
|
|
4422
|
+
* Cascade level at which this article was created.
|
|
4423
|
+
*/
|
|
2343
4424
|
scope: {
|
|
4425
|
+
/**
|
|
4426
|
+
* Cascade level this article lives at — `global` (whole tenant), `organization` (per-org), or `entity` (per-entity).
|
|
4427
|
+
*/
|
|
2344
4428
|
level: 'global' | 'organization' | 'entity';
|
|
4429
|
+
/**
|
|
4430
|
+
* ID of the organization when `level` is `organization` or `entity`.
|
|
4431
|
+
*/
|
|
2345
4432
|
organizationId?: string;
|
|
4433
|
+
/**
|
|
4434
|
+
* ID of the entity when `level` is `entity`.
|
|
4435
|
+
*/
|
|
2346
4436
|
entityId?: string;
|
|
2347
4437
|
};
|
|
4438
|
+
/**
|
|
4439
|
+
* Intent IDs this article serves. Empty array = always-on within its scope.
|
|
4440
|
+
*/
|
|
2348
4441
|
intents: Array<string>;
|
|
4442
|
+
/**
|
|
4443
|
+
* Currently published content of the article.
|
|
4444
|
+
*/
|
|
2349
4445
|
published: {
|
|
4446
|
+
/**
|
|
4447
|
+
* Monotonic version number of this snapshot.
|
|
4448
|
+
*/
|
|
2350
4449
|
version: number;
|
|
4450
|
+
/**
|
|
4451
|
+
* Article title at this version.
|
|
4452
|
+
*/
|
|
2351
4453
|
title: string;
|
|
4454
|
+
/**
|
|
4455
|
+
* Article body (Markdown) at this version.
|
|
4456
|
+
*/
|
|
2352
4457
|
content: string;
|
|
4458
|
+
/**
|
|
4459
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
4460
|
+
*/
|
|
2353
4461
|
publishedAt?: string;
|
|
4462
|
+
/**
|
|
4463
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
4464
|
+
*/
|
|
2354
4465
|
updatedAt?: string;
|
|
2355
4466
|
};
|
|
4467
|
+
/**
|
|
4468
|
+
* Pending draft content, when one exists. Promote it via `publish: true` on update.
|
|
4469
|
+
*/
|
|
2356
4470
|
draft?: {
|
|
4471
|
+
/**
|
|
4472
|
+
* Monotonic version number of this snapshot.
|
|
4473
|
+
*/
|
|
2357
4474
|
version: number;
|
|
4475
|
+
/**
|
|
4476
|
+
* Article title at this version.
|
|
4477
|
+
*/
|
|
2358
4478
|
title: string;
|
|
4479
|
+
/**
|
|
4480
|
+
* Article body (Markdown) at this version.
|
|
4481
|
+
*/
|
|
2359
4482
|
content: string;
|
|
4483
|
+
/**
|
|
4484
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
4485
|
+
*/
|
|
2360
4486
|
publishedAt?: string;
|
|
4487
|
+
/**
|
|
4488
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
4489
|
+
*/
|
|
2361
4490
|
updatedAt?: string;
|
|
2362
4491
|
};
|
|
4492
|
+
/**
|
|
4493
|
+
* ISO timestamp when the article was created.
|
|
4494
|
+
*/
|
|
2363
4495
|
createdAt: string;
|
|
4496
|
+
/**
|
|
4497
|
+
* ISO timestamp of the last modification (publish, draft edit, intents change).
|
|
4498
|
+
*/
|
|
2364
4499
|
updatedAt: string;
|
|
2365
4500
|
};
|
|
2366
4501
|
};
|
|
2367
|
-
export type
|
|
4502
|
+
export type Update4Response = Update4Responses[keyof Update4Responses];
|
|
2368
4503
|
export type Publish2Data = {
|
|
2369
4504
|
body?: never;
|
|
2370
4505
|
path: {
|
|
@@ -2418,27 +4553,84 @@ export type Publish2Responses = {
|
|
|
2418
4553
|
* KB article ID (format: kb_xxxxxxxxxxxx).
|
|
2419
4554
|
*/
|
|
2420
4555
|
id: string;
|
|
4556
|
+
/**
|
|
4557
|
+
* Cascade level at which this article was created.
|
|
4558
|
+
*/
|
|
2421
4559
|
scope: {
|
|
4560
|
+
/**
|
|
4561
|
+
* Cascade level this article lives at — `global` (whole tenant), `organization` (per-org), or `entity` (per-entity).
|
|
4562
|
+
*/
|
|
2422
4563
|
level: 'global' | 'organization' | 'entity';
|
|
4564
|
+
/**
|
|
4565
|
+
* ID of the organization when `level` is `organization` or `entity`.
|
|
4566
|
+
*/
|
|
2423
4567
|
organizationId?: string;
|
|
4568
|
+
/**
|
|
4569
|
+
* ID of the entity when `level` is `entity`.
|
|
4570
|
+
*/
|
|
2424
4571
|
entityId?: string;
|
|
2425
4572
|
};
|
|
4573
|
+
/**
|
|
4574
|
+
* Intent IDs this article serves. Empty array = always-on within its scope.
|
|
4575
|
+
*/
|
|
2426
4576
|
intents: Array<string>;
|
|
4577
|
+
/**
|
|
4578
|
+
* Currently published content of the article.
|
|
4579
|
+
*/
|
|
2427
4580
|
published: {
|
|
4581
|
+
/**
|
|
4582
|
+
* Monotonic version number of this snapshot.
|
|
4583
|
+
*/
|
|
2428
4584
|
version: number;
|
|
4585
|
+
/**
|
|
4586
|
+
* Article title at this version.
|
|
4587
|
+
*/
|
|
2429
4588
|
title: string;
|
|
4589
|
+
/**
|
|
4590
|
+
* Article body (Markdown) at this version.
|
|
4591
|
+
*/
|
|
2430
4592
|
content: string;
|
|
4593
|
+
/**
|
|
4594
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
4595
|
+
*/
|
|
2431
4596
|
publishedAt?: string;
|
|
4597
|
+
/**
|
|
4598
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
4599
|
+
*/
|
|
2432
4600
|
updatedAt?: string;
|
|
2433
4601
|
};
|
|
4602
|
+
/**
|
|
4603
|
+
* Pending draft content, when one exists. Promote it via `publish: true` on update.
|
|
4604
|
+
*/
|
|
2434
4605
|
draft?: {
|
|
4606
|
+
/**
|
|
4607
|
+
* Monotonic version number of this snapshot.
|
|
4608
|
+
*/
|
|
2435
4609
|
version: number;
|
|
4610
|
+
/**
|
|
4611
|
+
* Article title at this version.
|
|
4612
|
+
*/
|
|
2436
4613
|
title: string;
|
|
4614
|
+
/**
|
|
4615
|
+
* Article body (Markdown) at this version.
|
|
4616
|
+
*/
|
|
2437
4617
|
content: string;
|
|
4618
|
+
/**
|
|
4619
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
4620
|
+
*/
|
|
2438
4621
|
publishedAt?: string;
|
|
4622
|
+
/**
|
|
4623
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
4624
|
+
*/
|
|
2439
4625
|
updatedAt?: string;
|
|
2440
4626
|
};
|
|
4627
|
+
/**
|
|
4628
|
+
* ISO timestamp when the article was created.
|
|
4629
|
+
*/
|
|
2441
4630
|
createdAt: string;
|
|
4631
|
+
/**
|
|
4632
|
+
* ISO timestamp of the last modification (publish, draft edit, intents change).
|
|
4633
|
+
*/
|
|
2442
4634
|
updatedAt: string;
|
|
2443
4635
|
};
|
|
2444
4636
|
};
|
|
@@ -2501,32 +4693,89 @@ export type Rollback2Responses = {
|
|
|
2501
4693
|
* KB article ID (format: kb_xxxxxxxxxxxx).
|
|
2502
4694
|
*/
|
|
2503
4695
|
id: string;
|
|
4696
|
+
/**
|
|
4697
|
+
* Cascade level at which this article was created.
|
|
4698
|
+
*/
|
|
2504
4699
|
scope: {
|
|
4700
|
+
/**
|
|
4701
|
+
* Cascade level this article lives at — `global` (whole tenant), `organization` (per-org), or `entity` (per-entity).
|
|
4702
|
+
*/
|
|
2505
4703
|
level: 'global' | 'organization' | 'entity';
|
|
4704
|
+
/**
|
|
4705
|
+
* ID of the organization when `level` is `organization` or `entity`.
|
|
4706
|
+
*/
|
|
2506
4707
|
organizationId?: string;
|
|
4708
|
+
/**
|
|
4709
|
+
* ID of the entity when `level` is `entity`.
|
|
4710
|
+
*/
|
|
2507
4711
|
entityId?: string;
|
|
2508
4712
|
};
|
|
4713
|
+
/**
|
|
4714
|
+
* Intent IDs this article serves. Empty array = always-on within its scope.
|
|
4715
|
+
*/
|
|
2509
4716
|
intents: Array<string>;
|
|
4717
|
+
/**
|
|
4718
|
+
* Currently published content of the article.
|
|
4719
|
+
*/
|
|
2510
4720
|
published: {
|
|
4721
|
+
/**
|
|
4722
|
+
* Monotonic version number of this snapshot.
|
|
4723
|
+
*/
|
|
2511
4724
|
version: number;
|
|
4725
|
+
/**
|
|
4726
|
+
* Article title at this version.
|
|
4727
|
+
*/
|
|
2512
4728
|
title: string;
|
|
4729
|
+
/**
|
|
4730
|
+
* Article body (Markdown) at this version.
|
|
4731
|
+
*/
|
|
2513
4732
|
content: string;
|
|
4733
|
+
/**
|
|
4734
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
4735
|
+
*/
|
|
2514
4736
|
publishedAt?: string;
|
|
4737
|
+
/**
|
|
4738
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
4739
|
+
*/
|
|
2515
4740
|
updatedAt?: string;
|
|
2516
4741
|
};
|
|
4742
|
+
/**
|
|
4743
|
+
* Pending draft content, when one exists. Promote it via `publish: true` on update.
|
|
4744
|
+
*/
|
|
2517
4745
|
draft?: {
|
|
4746
|
+
/**
|
|
4747
|
+
* Monotonic version number of this snapshot.
|
|
4748
|
+
*/
|
|
2518
4749
|
version: number;
|
|
4750
|
+
/**
|
|
4751
|
+
* Article title at this version.
|
|
4752
|
+
*/
|
|
2519
4753
|
title: string;
|
|
4754
|
+
/**
|
|
4755
|
+
* Article body (Markdown) at this version.
|
|
4756
|
+
*/
|
|
2520
4757
|
content: string;
|
|
4758
|
+
/**
|
|
4759
|
+
* ISO timestamp of the publication that produced this snapshot.
|
|
4760
|
+
*/
|
|
2521
4761
|
publishedAt?: string;
|
|
4762
|
+
/**
|
|
4763
|
+
* ISO timestamp of the last draft edit (drafts only).
|
|
4764
|
+
*/
|
|
2522
4765
|
updatedAt?: string;
|
|
2523
4766
|
};
|
|
4767
|
+
/**
|
|
4768
|
+
* ISO timestamp when the article was created.
|
|
4769
|
+
*/
|
|
2524
4770
|
createdAt: string;
|
|
4771
|
+
/**
|
|
4772
|
+
* ISO timestamp of the last modification (publish, draft edit, intents change).
|
|
4773
|
+
*/
|
|
2525
4774
|
updatedAt: string;
|
|
2526
4775
|
};
|
|
2527
4776
|
};
|
|
2528
4777
|
export type Rollback2Response = Rollback2Responses[keyof Rollback2Responses];
|
|
2529
|
-
export type
|
|
4778
|
+
export type List6Data = {
|
|
2530
4779
|
body?: never;
|
|
2531
4780
|
path?: never;
|
|
2532
4781
|
query?: {
|
|
@@ -2545,7 +4794,7 @@ export type List5Data = {
|
|
|
2545
4794
|
};
|
|
2546
4795
|
url: '/organizations';
|
|
2547
4796
|
};
|
|
2548
|
-
export type
|
|
4797
|
+
export type List6Errors = {
|
|
2549
4798
|
/**
|
|
2550
4799
|
* Bad request
|
|
2551
4800
|
*/
|
|
@@ -2577,8 +4826,8 @@ export type List5Errors = {
|
|
|
2577
4826
|
};
|
|
2578
4827
|
};
|
|
2579
4828
|
};
|
|
2580
|
-
export type
|
|
2581
|
-
export type
|
|
4829
|
+
export type List6Error = List6Errors[keyof List6Errors];
|
|
4830
|
+
export type List6Responses = {
|
|
2582
4831
|
/**
|
|
2583
4832
|
* Successful response
|
|
2584
4833
|
*/
|
|
@@ -2615,8 +4864,8 @@ export type List5Responses = {
|
|
|
2615
4864
|
offset: number;
|
|
2616
4865
|
};
|
|
2617
4866
|
};
|
|
2618
|
-
export type
|
|
2619
|
-
export type
|
|
4867
|
+
export type List6Response = List6Responses[keyof List6Responses];
|
|
4868
|
+
export type Create5Data = {
|
|
2620
4869
|
body?: {
|
|
2621
4870
|
/**
|
|
2622
4871
|
* Human-readable name of the organization (must be unique).
|
|
@@ -2637,7 +4886,7 @@ export type Create4Data = {
|
|
|
2637
4886
|
query?: never;
|
|
2638
4887
|
url: '/organizations';
|
|
2639
4888
|
};
|
|
2640
|
-
export type
|
|
4889
|
+
export type Create5Errors = {
|
|
2641
4890
|
/**
|
|
2642
4891
|
* Bad request
|
|
2643
4892
|
*/
|
|
@@ -2669,8 +4918,8 @@ export type Create4Errors = {
|
|
|
2669
4918
|
};
|
|
2670
4919
|
};
|
|
2671
4920
|
};
|
|
2672
|
-
export type
|
|
2673
|
-
export type
|
|
4921
|
+
export type Create5Error = Create5Errors[keyof Create5Errors];
|
|
4922
|
+
export type Create5Responses = {
|
|
2674
4923
|
/**
|
|
2675
4924
|
* Successful response
|
|
2676
4925
|
*/
|
|
@@ -2708,8 +4957,8 @@ export type Create4Responses = {
|
|
|
2708
4957
|
apiKey?: string;
|
|
2709
4958
|
};
|
|
2710
4959
|
};
|
|
2711
|
-
export type
|
|
2712
|
-
export type
|
|
4960
|
+
export type Create5Response = Create5Responses[keyof Create5Responses];
|
|
4961
|
+
export type Delete5Data = {
|
|
2713
4962
|
body?: never;
|
|
2714
4963
|
path: {
|
|
2715
4964
|
/**
|
|
@@ -2720,7 +4969,7 @@ export type Delete4Data = {
|
|
|
2720
4969
|
query?: never;
|
|
2721
4970
|
url: '/organizations/{id}';
|
|
2722
4971
|
};
|
|
2723
|
-
export type
|
|
4972
|
+
export type Delete5Errors = {
|
|
2724
4973
|
/**
|
|
2725
4974
|
* Bad request
|
|
2726
4975
|
*/
|
|
@@ -2752,8 +5001,8 @@ export type Delete4Errors = {
|
|
|
2752
5001
|
};
|
|
2753
5002
|
};
|
|
2754
5003
|
};
|
|
2755
|
-
export type
|
|
2756
|
-
export type
|
|
5004
|
+
export type Delete5Error = Delete5Errors[keyof Delete5Errors];
|
|
5005
|
+
export type Delete5Responses = {
|
|
2757
5006
|
/**
|
|
2758
5007
|
* Successful response
|
|
2759
5008
|
*/
|
|
@@ -2764,8 +5013,8 @@ export type Delete4Responses = {
|
|
|
2764
5013
|
message: string;
|
|
2765
5014
|
};
|
|
2766
5015
|
};
|
|
2767
|
-
export type
|
|
2768
|
-
export type
|
|
5016
|
+
export type Delete5Response = Delete5Responses[keyof Delete5Responses];
|
|
5017
|
+
export type Get6Data = {
|
|
2769
5018
|
body?: never;
|
|
2770
5019
|
path: {
|
|
2771
5020
|
/**
|
|
@@ -2776,7 +5025,7 @@ export type Get5Data = {
|
|
|
2776
5025
|
query?: never;
|
|
2777
5026
|
url: '/organizations/{id}';
|
|
2778
5027
|
};
|
|
2779
|
-
export type
|
|
5028
|
+
export type Get6Errors = {
|
|
2780
5029
|
/**
|
|
2781
5030
|
* Bad request
|
|
2782
5031
|
*/
|
|
@@ -2808,8 +5057,8 @@ export type Get5Errors = {
|
|
|
2808
5057
|
};
|
|
2809
5058
|
};
|
|
2810
5059
|
};
|
|
2811
|
-
export type
|
|
2812
|
-
export type
|
|
5060
|
+
export type Get6Error = Get6Errors[keyof Get6Errors];
|
|
5061
|
+
export type Get6Responses = {
|
|
2813
5062
|
/**
|
|
2814
5063
|
* Successful response
|
|
2815
5064
|
*/
|
|
@@ -2838,8 +5087,8 @@ export type Get5Responses = {
|
|
|
2838
5087
|
};
|
|
2839
5088
|
};
|
|
2840
5089
|
};
|
|
2841
|
-
export type
|
|
2842
|
-
export type
|
|
5090
|
+
export type Get6Response = Get6Responses[keyof Get6Responses];
|
|
5091
|
+
export type Update5Data = {
|
|
2843
5092
|
body?: {
|
|
2844
5093
|
/**
|
|
2845
5094
|
* New name for the organization.
|
|
@@ -2861,7 +5110,7 @@ export type Update4Data = {
|
|
|
2861
5110
|
query?: never;
|
|
2862
5111
|
url: '/organizations/{id}';
|
|
2863
5112
|
};
|
|
2864
|
-
export type
|
|
5113
|
+
export type Update5Errors = {
|
|
2865
5114
|
/**
|
|
2866
5115
|
* Bad request
|
|
2867
5116
|
*/
|
|
@@ -2893,8 +5142,8 @@ export type Update4Errors = {
|
|
|
2893
5142
|
};
|
|
2894
5143
|
};
|
|
2895
5144
|
};
|
|
2896
|
-
export type
|
|
2897
|
-
export type
|
|
5145
|
+
export type Update5Error = Update5Errors[keyof Update5Errors];
|
|
5146
|
+
export type Update5Responses = {
|
|
2898
5147
|
/**
|
|
2899
5148
|
* Successful response
|
|
2900
5149
|
*/
|
|
@@ -2923,5 +5172,5 @@ export type Update4Responses = {
|
|
|
2923
5172
|
};
|
|
2924
5173
|
};
|
|
2925
5174
|
};
|
|
2926
|
-
export type
|
|
5175
|
+
export type Update5Response = Update5Responses[keyof Update5Responses];
|
|
2927
5176
|
//# sourceMappingURL=types.gen.d.ts.map
|