@stackfactor/client-api 1.19.3 → 1.20.1

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.
Files changed (87) hide show
  1. package/dist/cjs/lib/constants.d.ts +2 -1
  2. package/dist/cjs/lib/constants.d.ts.map +1 -1
  3. package/dist/cjs/lib/constants.js +3 -1
  4. package/dist/cjs/lib/constants.js.map +1 -1
  5. package/dist/cjs/lib/knowledgeAssessmentAttempts.d.ts +22 -0
  6. package/dist/cjs/lib/knowledgeAssessmentAttempts.d.ts.map +1 -1
  7. package/dist/cjs/lib/knowledgeAssessmentAttempts.js +44 -1
  8. package/dist/cjs/lib/knowledgeAssessmentAttempts.js.map +1 -1
  9. package/dist/cjs/lib/knowledgeBase/documents.d.ts +127 -0
  10. package/dist/cjs/lib/knowledgeBase/documents.d.ts.map +1 -0
  11. package/dist/cjs/lib/knowledgeBase/documents.js +114 -0
  12. package/dist/cjs/lib/knowledgeBase/documents.js.map +1 -0
  13. package/dist/cjs/lib/knowledgeBase/knowledgeBases.d.ts +118 -0
  14. package/dist/cjs/lib/knowledgeBase/knowledgeBases.d.ts.map +1 -0
  15. package/dist/cjs/lib/knowledgeBase/knowledgeBases.js +256 -0
  16. package/dist/cjs/lib/knowledgeBase/knowledgeBases.js.map +1 -0
  17. package/dist/cjs/lib/knowledgeBase/review.d.ts +184 -0
  18. package/dist/cjs/lib/knowledgeBase/review.d.ts.map +1 -0
  19. package/dist/cjs/lib/knowledgeBase/review.js +413 -0
  20. package/dist/cjs/lib/knowledgeBase/review.js.map +1 -0
  21. package/dist/cjs/lib/knowledgeBase/skills.d.ts +247 -0
  22. package/dist/cjs/lib/knowledgeBase/skills.d.ts.map +1 -0
  23. package/dist/cjs/lib/knowledgeBase/skills.js +199 -0
  24. package/dist/cjs/lib/knowledgeBase/skills.js.map +1 -0
  25. package/dist/cjs/lib/knowledgeBase/sources.d.ts +136 -0
  26. package/dist/cjs/lib/knowledgeBase/sources.d.ts.map +1 -0
  27. package/dist/cjs/lib/knowledgeBase/sources.js +234 -0
  28. package/dist/cjs/lib/knowledgeBase/sources.js.map +1 -0
  29. package/dist/cjs/lib/knowledgeBase.d.ts +5 -785
  30. package/dist/cjs/lib/knowledgeBase.d.ts.map +1 -1
  31. package/dist/cjs/lib/knowledgeBase.js +32 -1229
  32. package/dist/cjs/lib/knowledgeBase.js.map +1 -1
  33. package/dist/cjs/lib/knowledgeBaseAgent.d.ts +33 -1
  34. package/dist/cjs/lib/knowledgeBaseAgent.d.ts.map +1 -1
  35. package/dist/cjs/lib/knowledgeBaseAgent.js +18 -3
  36. package/dist/cjs/lib/knowledgeBaseAgent.js.map +1 -1
  37. package/dist/cjs/lib/learningContent.d.ts.map +1 -1
  38. package/dist/cjs/lib/learningContent.js +12 -2
  39. package/dist/cjs/lib/learningContent.js.map +1 -1
  40. package/dist/cjs/lib/learningContentCohorts.d.ts +80 -0
  41. package/dist/cjs/lib/learningContentCohorts.d.ts.map +1 -1
  42. package/dist/cjs/lib/learningContentCohorts.js +80 -1
  43. package/dist/cjs/lib/learningContentCohorts.js.map +1 -1
  44. package/dist/esm/lib/constants.d.ts +2 -1
  45. package/dist/esm/lib/constants.d.ts.map +1 -1
  46. package/dist/esm/lib/constants.js +3 -1
  47. package/dist/esm/lib/constants.js.map +1 -1
  48. package/dist/esm/lib/knowledgeAssessmentAttempts.d.ts +22 -0
  49. package/dist/esm/lib/knowledgeAssessmentAttempts.d.ts.map +1 -1
  50. package/dist/esm/lib/knowledgeAssessmentAttempts.js +40 -0
  51. package/dist/esm/lib/knowledgeAssessmentAttempts.js.map +1 -1
  52. package/dist/esm/lib/knowledgeBase/documents.d.ts +127 -0
  53. package/dist/esm/lib/knowledgeBase/documents.d.ts.map +1 -0
  54. package/dist/esm/lib/knowledgeBase/documents.js +107 -0
  55. package/dist/esm/lib/knowledgeBase/documents.js.map +1 -0
  56. package/dist/esm/lib/knowledgeBase/knowledgeBases.d.ts +118 -0
  57. package/dist/esm/lib/knowledgeBase/knowledgeBases.d.ts.map +1 -0
  58. package/dist/esm/lib/knowledgeBase/knowledgeBases.js +242 -0
  59. package/dist/esm/lib/knowledgeBase/knowledgeBases.js.map +1 -0
  60. package/dist/esm/lib/knowledgeBase/review.d.ts +184 -0
  61. package/dist/esm/lib/knowledgeBase/review.d.ts.map +1 -0
  62. package/dist/esm/lib/knowledgeBase/review.js +392 -0
  63. package/dist/esm/lib/knowledgeBase/review.js.map +1 -0
  64. package/dist/esm/lib/knowledgeBase/skills.d.ts +247 -0
  65. package/dist/esm/lib/knowledgeBase/skills.d.ts.map +1 -0
  66. package/dist/esm/lib/knowledgeBase/skills.js +189 -0
  67. package/dist/esm/lib/knowledgeBase/skills.js.map +1 -0
  68. package/dist/esm/lib/knowledgeBase/sources.d.ts +136 -0
  69. package/dist/esm/lib/knowledgeBase/sources.d.ts.map +1 -0
  70. package/dist/esm/lib/knowledgeBase/sources.js +221 -0
  71. package/dist/esm/lib/knowledgeBase/sources.js.map +1 -0
  72. package/dist/esm/lib/knowledgeBase.d.ts +5 -785
  73. package/dist/esm/lib/knowledgeBase.d.ts.map +1 -1
  74. package/dist/esm/lib/knowledgeBase.js +18 -1175
  75. package/dist/esm/lib/knowledgeBase.js.map +1 -1
  76. package/dist/esm/lib/knowledgeBaseAgent.d.ts +33 -1
  77. package/dist/esm/lib/knowledgeBaseAgent.d.ts.map +1 -1
  78. package/dist/esm/lib/knowledgeBaseAgent.js +16 -2
  79. package/dist/esm/lib/knowledgeBaseAgent.js.map +1 -1
  80. package/dist/esm/lib/learningContent.d.ts.map +1 -1
  81. package/dist/esm/lib/learningContent.js +12 -2
  82. package/dist/esm/lib/learningContent.js.map +1 -1
  83. package/dist/esm/lib/learningContentCohorts.d.ts +80 -0
  84. package/dist/esm/lib/learningContentCohorts.d.ts.map +1 -1
  85. package/dist/esm/lib/learningContentCohorts.js +66 -0
  86. package/dist/esm/lib/learningContentCohorts.js.map +1 -1
  87. package/package.json +1 -3
@@ -0,0 +1,392 @@
1
+ import { client } from "../axiosClient.js";
2
+ //
3
+ // Knowledge Base management operations — Review Center (quarantine, generated content, contradictions) and out-of-sync notification actions.
4
+ // Re-exported by `../knowledgeBase.ts`, which keeps the public entry.
5
+ //
6
+ // ── Review Center — overview ──────────────────────────────────────────────────
7
+ /**
8
+ * Overview of all Review Center streams + counts for a knowledge base.
9
+ * GET /api/v1/knowledge-base/:id/review
10
+ * @param {String} id The knowledge base id
11
+ * @param {String} authToken Authentication token
12
+ * @returns {Promise<object>}
13
+ */
14
+ export const getReviewOverview = (id, authToken) => {
15
+ return new Promise((resolve, reject) => {
16
+ const request = client.get(`/api/v1/knowledge-base/${id}/review`, {
17
+ headers: { authorization: authToken },
18
+ });
19
+ request
20
+ .then((response) => {
21
+ resolve(response.data);
22
+ })
23
+ .catch((error) => {
24
+ reject(error);
25
+ });
26
+ });
27
+ };
28
+ // ── Review Center — Stream 1: Quarantine release ──────────────────────────────
29
+ /**
30
+ * List QUARANTINED documents (Review Center stream 1).
31
+ * GET /api/v1/knowledge-base/:id/review/quarantine
32
+ * @param {String} id The knowledge base id
33
+ * @param {String} authToken Authentication token
34
+ * @returns {Promise<object>}
35
+ */
36
+ export const listQuarantine = (id, authToken) => {
37
+ return new Promise((resolve, reject) => {
38
+ const request = client.get(`/api/v1/knowledge-base/${id}/review/quarantine`, { headers: { authorization: authToken } });
39
+ request
40
+ .then((response) => {
41
+ resolve(response.data);
42
+ })
43
+ .catch((error) => {
44
+ reject(error);
45
+ });
46
+ });
47
+ };
48
+ /**
49
+ * List the documents released from review (Review Center stream 1): every one
50
+ * released and not held again since, the newest release first, each with
51
+ * `quarantineReleasedAt` and `quarantineReleasedByName` (who released it, or
52
+ * null). Requires RELEASE_QUARANTINE + owner|editor, as the held list does.
53
+ * GET /api/v1/knowledge-base/:id/review/quarantine?state=released
54
+ * @param {String} id The knowledge base id
55
+ * @param {String} authToken Authentication token
56
+ * @returns {Promise<object>}
57
+ */
58
+ export const listReleased = (id, authToken) => {
59
+ return new Promise((resolve, reject) => {
60
+ const request = client.get(`/api/v1/knowledge-base/${id}/review/quarantine`, { headers: { authorization: authToken }, params: { state: "released" } });
61
+ request
62
+ .then((response) => {
63
+ resolve(response.data);
64
+ })
65
+ .catch((error) => {
66
+ reject(error);
67
+ });
68
+ });
69
+ };
70
+ /**
71
+ * Release a quarantined document. Requires RELEASE_QUARANTINE + owner|editor.
72
+ * POST /api/v1/knowledge-base/:id/review/quarantine/:docId/release
73
+ * @param {String} id The knowledge base id
74
+ * @param {String} docId The document id
75
+ * @param {String} authToken Authentication token
76
+ * @returns {Promise<object>}
77
+ */
78
+ export const releaseQuarantine = (id, docId, authToken) => {
79
+ return new Promise((resolve, reject) => {
80
+ const request = client.post(`/api/v1/knowledge-base/${id}/review/quarantine/${docId}/release`, {}, { headers: { authorization: authToken } });
81
+ request
82
+ .then((response) => {
83
+ resolve(response.data);
84
+ })
85
+ .catch((error) => {
86
+ reject(error);
87
+ });
88
+ });
89
+ };
90
+ /**
91
+ * Apply a reviewer's decisions to many held documents at once: release each
92
+ * named document back through ingestion, keep it in quarantine as reviewed, or
93
+ * block it from the knowledge base. One run per source released into is asked
94
+ * for, never one per document. Requires RELEASE_QUARANTINE + owner|editor.
95
+ * POST /api/v1/knowledge-base/:id/review/quarantine/decisions
96
+ * @param {String} id The knowledge base id
97
+ * @param {Array<{documentId: string, decision: "release"|"quarantine"|"block", reason?: string}>} decisions One decision per document, at most 500
98
+ * @param {String} authToken Authentication token
99
+ * @returns {Promise<object>} `{ results: [{ documentId, decision, outcome }], runs: [{ sourceId, correlationId, started }] }`
100
+ */
101
+ export const decideQuarantine = (id, decisions, authToken) => {
102
+ return new Promise((resolve, reject) => {
103
+ const request = client.post(`/api/v1/knowledge-base/${id}/review/quarantine/decisions`, { decisions }, { headers: { authorization: authToken } });
104
+ request
105
+ .then((response) => {
106
+ resolve(response.data);
107
+ })
108
+ .catch((error) => {
109
+ reject(error);
110
+ });
111
+ });
112
+ };
113
+ /**
114
+ * Re-ingest a quarantined document (optionally with an updated redaction policy).
115
+ * Publishes a kb-source-event (trigger="quarantine_re_ingest"). Requires
116
+ * RELEASE_QUARANTINE + owner.
117
+ * POST /api/v1/knowledge-base/:id/review/quarantine/:docId/re-ingest
118
+ * @param {String} id The knowledge base id
119
+ * @param {String} docId The document id
120
+ * @param {object} data Optional body, e.g. `{ updatedRedactionPolicy }`
121
+ * @param {String} authToken Authentication token
122
+ * @returns {Promise<object>}
123
+ */
124
+ export const reingestQuarantine = (id, docId, data, authToken) => {
125
+ return new Promise((resolve, reject) => {
126
+ const request = client.post(`/api/v1/knowledge-base/${id}/review/quarantine/${docId}/re-ingest`, data, { headers: { authorization: authToken } });
127
+ request
128
+ .then((response) => {
129
+ resolve(response.data);
130
+ })
131
+ .catch((error) => {
132
+ reject(error);
133
+ });
134
+ });
135
+ };
136
+ /**
137
+ * Delete a quarantined document. Requires RELEASE_QUARANTINE + owner.
138
+ * POST /api/v1/knowledge-base/:id/review/quarantine/:docId/delete
139
+ * @param {String} id The knowledge base id
140
+ * @param {String} docId The document id
141
+ * @param {String} authToken Authentication token
142
+ * @returns {Promise<object>}
143
+ */
144
+ export const deleteQuarantine = (id, docId, authToken) => {
145
+ return new Promise((resolve, reject) => {
146
+ const request = client.post(`/api/v1/knowledge-base/${id}/review/quarantine/${docId}/delete`, {}, { headers: { authorization: authToken } });
147
+ request
148
+ .then((response) => {
149
+ resolve(response.data);
150
+ })
151
+ .catch((error) => {
152
+ reject(error);
153
+ });
154
+ });
155
+ };
156
+ // ── Review Center — Stream 2: Generated content review ────────────────────────
157
+ /**
158
+ * List generated artifacts awaiting review (needsReview=true).
159
+ * Requires GENERATE_FROM_KB + owner|editor.
160
+ * GET /api/v1/knowledge-base/:id/review/generated
161
+ * @param {String} id The knowledge base id
162
+ * @param {String} authToken Authentication token
163
+ * @returns {Promise<object>}
164
+ */
165
+ export const listGeneratedReview = (id, authToken) => {
166
+ return new Promise((resolve, reject) => {
167
+ const request = client.get(`/api/v1/knowledge-base/${id}/review/generated`, { headers: { authorization: authToken } });
168
+ request
169
+ .then((response) => {
170
+ resolve(response.data);
171
+ })
172
+ .catch((error) => {
173
+ reject(error);
174
+ });
175
+ });
176
+ };
177
+ /**
178
+ * Approve a generated artifact. Requires GENERATE_FROM_KB + owner|editor.
179
+ * POST /api/v1/knowledge-base/:id/review/generated/:entityId/approve
180
+ * @param {String} id The knowledge base id
181
+ * @param {String} entityId The artifact/entity id
182
+ * @param {object} data Body `{ entityType, notes? }`
183
+ * @param {String} authToken Authentication token
184
+ * @returns {Promise<object>}
185
+ */
186
+ export const approveGenerated = (id, entityId, data, authToken) => {
187
+ return new Promise((resolve, reject) => {
188
+ const request = client.post(`/api/v1/knowledge-base/${id}/review/generated/${entityId}/approve`, data, { headers: { authorization: authToken } });
189
+ request
190
+ .then((response) => {
191
+ resolve(response.data);
192
+ })
193
+ .catch((error) => {
194
+ reject(error);
195
+ });
196
+ });
197
+ };
198
+ /**
199
+ * Approve a generated artifact with edits.
200
+ * Requires GENERATE_FROM_KB + owner|editor.
201
+ * POST /api/v1/knowledge-base/:id/review/generated/:entityId/edit-approve
202
+ * @param {String} id The knowledge base id
203
+ * @param {String} entityId The artifact/entity id
204
+ * @param {object} data Body `{ entityType, edits, notes? }`
205
+ * @param {String} authToken Authentication token
206
+ * @returns {Promise<object>}
207
+ */
208
+ export const editApproveGenerated = (id, entityId, data, authToken) => {
209
+ return new Promise((resolve, reject) => {
210
+ const request = client.post(`/api/v1/knowledge-base/${id}/review/generated/${entityId}/edit-approve`, data, { headers: { authorization: authToken } });
211
+ request
212
+ .then((response) => {
213
+ resolve(response.data);
214
+ })
215
+ .catch((error) => {
216
+ reject(error);
217
+ });
218
+ });
219
+ };
220
+ /**
221
+ * Reject a generated artifact. Requires GENERATE_FROM_KB + owner|editor.
222
+ * POST /api/v1/knowledge-base/:id/review/generated/:entityId/reject
223
+ * @param {String} id The knowledge base id
224
+ * @param {String} entityId The artifact/entity id
225
+ * @param {object} data Body `{ entityType, reason }`
226
+ * @param {String} authToken Authentication token
227
+ * @returns {Promise<object>}
228
+ */
229
+ export const rejectGenerated = (id, entityId, data, authToken) => {
230
+ return new Promise((resolve, reject) => {
231
+ const request = client.post(`/api/v1/knowledge-base/${id}/review/generated/${entityId}/reject`, data, { headers: { authorization: authToken } });
232
+ request
233
+ .then((response) => {
234
+ resolve(response.data);
235
+ })
236
+ .catch((error) => {
237
+ reject(error);
238
+ });
239
+ });
240
+ };
241
+ /**
242
+ * Regenerate a generated artifact using current chunks.
243
+ * Requires GENERATE_FROM_KB + owner|editor.
244
+ * POST /api/v1/knowledge-base/:id/review/generated/:entityId/regenerate
245
+ * @param {String} id The knowledge base id
246
+ * @param {String} entityId The artifact/entity id
247
+ * @param {object} data Body `{ entityType, regenerationHints? }`
248
+ * @param {String} authToken Authentication token
249
+ * @returns {Promise<object>}
250
+ */
251
+ export const regenerateGenerated = (id, entityId, data, authToken) => {
252
+ return new Promise((resolve, reject) => {
253
+ const request = client.post(`/api/v1/knowledge-base/${id}/review/generated/${entityId}/regenerate`, data, { headers: { authorization: authToken } });
254
+ request
255
+ .then((response) => {
256
+ resolve(response.data);
257
+ })
258
+ .catch((error) => {
259
+ reject(error);
260
+ });
261
+ });
262
+ };
263
+ // ── Review Center — Stream 3: Contradiction flags ─────────────────────────────
264
+ /**
265
+ * List chunks with non-empty contradictionFlags[].
266
+ * Requires GENERATE_FROM_KB + owner|editor.
267
+ * GET /api/v1/knowledge-base/:id/review/contradictions
268
+ * @param {String} id The knowledge base id
269
+ * @param {String} authToken Authentication token
270
+ * @returns {Promise<object>}
271
+ */
272
+ export const listContradictions = (id, authToken) => {
273
+ return new Promise((resolve, reject) => {
274
+ const request = client.get(`/api/v1/knowledge-base/${id}/review/contradictions`, { headers: { authorization: authToken } });
275
+ request
276
+ .then((response) => {
277
+ resolve(response.data);
278
+ })
279
+ .catch((error) => {
280
+ reject(error);
281
+ });
282
+ });
283
+ };
284
+ /**
285
+ * Decide a contradiction between two chunks.
286
+ * Requires GENERATE_FROM_KB + owner|editor.
287
+ * POST /api/v1/knowledge-base/:id/review/contradictions/:chunkId/decide
288
+ * @param {String} id The knowledge base id
289
+ * @param {String} chunkId The chunk id carrying the contradiction flag
290
+ * @param {object} data Body `{ decision, otherChunkId, notes }` — `decision` is one
291
+ * of `KNOWLEDGE_BASE.CONTRADICTION_DECISION`
292
+ * @param {String} authToken Authentication token
293
+ * @returns {Promise<object>}
294
+ */
295
+ export const decideContradiction = (id, chunkId, data, authToken) => {
296
+ return new Promise((resolve, reject) => {
297
+ const request = client.post(`/api/v1/knowledge-base/${id}/review/contradictions/${chunkId}/decide`, data, { headers: { authorization: authToken } });
298
+ request
299
+ .then((response) => {
300
+ resolve(response.data);
301
+ })
302
+ .catch((error) => {
303
+ reject(error);
304
+ });
305
+ });
306
+ };
307
+ // ── Out-of-Sync Notification Actions ──────────────────────────────────────────
308
+ // (design §14 / §14A — surfaced as notifications, acted on per-artifact.
309
+ // Requires GENERATE_FROM_KB + owner|editor on the KB.)
310
+ /**
311
+ * Regenerate a stale artifact from a notification using current chunks.
312
+ * POST /api/v1/notifications/:notificationId/artifacts/:artifactId/regenerate
313
+ * @param {String} notificationId The notification id
314
+ * @param {String} artifactId The artifact id
315
+ * @param {object} data Body `{ entityType }`
316
+ * @param {String} authToken Authentication token
317
+ * @returns {Promise<object>}
318
+ */
319
+ export const regenerateArtifact = (notificationId, artifactId, data, authToken) => {
320
+ return new Promise((resolve, reject) => {
321
+ const request = client.post(`/api/v1/notifications/${notificationId}/artifacts/${artifactId}/regenerate`, data, { headers: { authorization: authToken } });
322
+ request
323
+ .then((response) => {
324
+ resolve(response.data);
325
+ })
326
+ .catch((error) => {
327
+ reject(error);
328
+ });
329
+ });
330
+ };
331
+ /**
332
+ * Retire (soft-delete) a stale artifact from a notification.
333
+ * POST /api/v1/notifications/:notificationId/artifacts/:artifactId/retire
334
+ * @param {String} notificationId The notification id
335
+ * @param {String} artifactId The artifact id
336
+ * @param {object} data Body `{ entityType }`
337
+ * @param {String} authToken Authentication token
338
+ * @returns {Promise<object>}
339
+ */
340
+ export const retireArtifact = (notificationId, artifactId, data, authToken) => {
341
+ return new Promise((resolve, reject) => {
342
+ const request = client.post(`/api/v1/notifications/${notificationId}/artifacts/${artifactId}/retire`, data, { headers: { authorization: authToken } });
343
+ request
344
+ .then((response) => {
345
+ resolve(response.data);
346
+ })
347
+ .catch((error) => {
348
+ reject(error);
349
+ });
350
+ });
351
+ };
352
+ /**
353
+ * Dismiss a stale-artifact flag (mark the staleness acceptable).
354
+ * POST /api/v1/notifications/:notificationId/artifacts/:artifactId/dismiss
355
+ * @param {String} notificationId The notification id
356
+ * @param {String} artifactId The artifact id
357
+ * @param {object} data Body `{ entityType, reason? }`
358
+ * @param {String} authToken Authentication token
359
+ * @returns {Promise<object>}
360
+ */
361
+ export const dismissArtifact = (notificationId, artifactId, data, authToken) => {
362
+ return new Promise((resolve, reject) => {
363
+ const request = client.post(`/api/v1/notifications/${notificationId}/artifacts/${artifactId}/dismiss`, data, { headers: { authorization: authToken } });
364
+ request
365
+ .then((response) => {
366
+ resolve(response.data);
367
+ })
368
+ .catch((error) => {
369
+ reject(error);
370
+ });
371
+ });
372
+ };
373
+ /**
374
+ * Dismiss an entire out-of-sync notification (all artifacts).
375
+ * POST /api/v1/notifications/:notificationId/dismiss-all
376
+ * @param {String} notificationId The notification id
377
+ * @param {String} authToken Authentication token
378
+ * @returns {Promise<object>}
379
+ */
380
+ export const dismissAllArtifacts = (notificationId, authToken) => {
381
+ return new Promise((resolve, reject) => {
382
+ const request = client.post(`/api/v1/notifications/${notificationId}/dismiss-all`, {}, { headers: { authorization: authToken } });
383
+ request
384
+ .then((response) => {
385
+ resolve(response.data);
386
+ })
387
+ .catch((error) => {
388
+ reject(error);
389
+ });
390
+ });
391
+ };
392
+ //# sourceMappingURL=review.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"review.js","sourceRoot":"","sources":["../../../../src/lib/knowledgeBase/review.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,EAAE;AACF,6IAA6I;AAC7I,sEAAsE;AACtE,EAAE;AAEF,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,0BAA0B,EAAE,SAAS,EAAE;YAChE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;SACtC,CAAC,CAAC;QACH,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,0BAA0B,EAAE,oBAAoB,EAChD,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,0BAA0B,EAAE,oBAAoB,EAChD,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,CACzE,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,EAAU,EACV,KAAa,EACb,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,sBAAsB,KAAK,UAAU,EACjE,EAAE,EACF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,EAAU,EACV,SAA2E,EAC3E,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,8BAA8B,EAC1D,EAAE,SAAS,EAAE,EACb,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,EAAU,EACV,KAAa,EACb,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,sBAAsB,KAAK,YAAY,EACnE,IAAI,EACJ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,EAAU,EACV,KAAa,EACb,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,sBAAsB,KAAK,SAAS,EAChE,EAAE,EACF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,iFAAiF;AAEjF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,0BAA0B,EAAE,mBAAmB,EAC/C,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,EAAU,EACV,QAAgB,EAChB,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,qBAAqB,QAAQ,UAAU,EACnE,IAAI,EACJ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,EAAU,EACV,QAAgB,EAChB,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,qBAAqB,QAAQ,eAAe,EACxE,IAAI,EACJ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,EAAU,EACV,QAAgB,EAChB,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,qBAAqB,QAAQ,SAAS,EAClE,IAAI,EACJ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,EAAU,EACV,QAAgB,EAChB,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,qBAAqB,QAAQ,aAAa,EACtE,IAAI,EACJ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,iFAAiF;AAEjF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,0BAA0B,EAAE,wBAAwB,EACpD,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,EAAU,EACV,OAAe,EACf,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,0BAA0B,OAAO,SAAS,EACtE,IAAI,EACJ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,iFAAiF;AACjF,yEAAyE;AACzE,wDAAwD;AAExD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,cAAsB,EACtB,UAAkB,EAClB,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,yBAAyB,cAAc,cAAc,UAAU,aAAa,EAC5E,IAAI,EACJ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,cAAsB,EACtB,UAAkB,EAClB,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,yBAAyB,cAAc,cAAc,UAAU,SAAS,EACxE,IAAI,EACJ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,cAAsB,EACtB,UAAkB,EAClB,IAAY,EACZ,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,yBAAyB,cAAc,cAAc,UAAU,UAAU,EACzE,IAAI,EACJ,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,cAAsB,EACtB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,yBAAyB,cAAc,cAAc,EACrD,EAAE,EACF,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,CAC1C,CAAC;QACF,OAAO;aACJ,IAAI,CAAC,CAAC,QAAuB,EAAE,EAAE;YAChC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAiB,EAAE,EAAE;YAC3B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}
@@ -0,0 +1,247 @@
1
+ /**
2
+ * A skill a knowledge base's people listed for labelling to look for. Picked
3
+ * from the catalog, it names the catalog skill: the tenant's skills
4
+ * (`"skill"`) or the platform's skill templates (`"skillTemplate"`). The
5
+ * platform reads that skill's own microskills; any sent are ignored.
6
+ */
7
+ export interface ListedSkill {
8
+ name: string;
9
+ catalogId?: string | null;
10
+ catalogType?: "skill" | "skillTemplate" | null;
11
+ /** Read-only: the catalog skill's own microskills, as stored. */
12
+ microSkills?: string[];
13
+ }
14
+ /**
15
+ * What labelling looks for in content: every skill it teaches (`"discover"`,
16
+ * the default), the listed skills first, under their names, and any others
17
+ * (`"guided"`), or only the listed ones (`"focused"`). Guided and focused need
18
+ * at least one skill, at most 50; discover lists none. Each connection holds
19
+ * its own (`SourceInput.skillSettings`).
20
+ */
21
+ export interface SkillSettings {
22
+ mode: "discover" | "guided" | "focused";
23
+ skills: ListedSkill[];
24
+ }
25
+ /** Optional options for the list of a knowledge base's skills. */
26
+ export interface SkillListParams {
27
+ /** How many skills, most named first: 1 to 200 (default 50). */
28
+ limit?: number;
29
+ }
30
+ /**
31
+ * One way a knowledge base's people name a skill its content was labelled
32
+ * with: `from`, a skill's name (any spelling of it), becomes `to` — a new name,
33
+ * or the name of a skill it merges into — or null, which removes the skill.
34
+ */
35
+ export interface SkillMapping {
36
+ from: string;
37
+ to: string | null;
38
+ }
39
+ /** A knowledge base that holds documents about a skill (`getSkillCoverage`). */
40
+ export interface SkillCoverageKnowledgeBase {
41
+ _id: string;
42
+ name: string;
43
+ /** How many of its documents the caller may read name the skill. */
44
+ documentCount: number;
45
+ /** The kinds of resource those documents came from. */
46
+ sourceTypes: string[];
47
+ }
48
+ /** What the knowledge bases the caller can open hold about one skill. */
49
+ export interface SkillCoverage {
50
+ /** The skill's name as it was matched: spaces collapsed, trimmed. */
51
+ skill: string;
52
+ documentCount: number;
53
+ /** Most documents first. */
54
+ knowledgeBases: SkillCoverageKnowledgeBase[];
55
+ /** The microskills their passages cover most, at most 12. */
56
+ microSkills: string[];
57
+ /** Every microskill they cover. */
58
+ microSkillCount: number;
59
+ }
60
+ /** Options for the skill names the caller's knowledge bases suggest (`getSkillSuggestions`). */
61
+ export interface SkillSuggestionParams {
62
+ /** How many suggestions: 1 to 25 (default 10). */
63
+ limit?: number;
64
+ /**
65
+ * Where a name that already exists is looked for: the tenant's skills
66
+ * (`"skill"`, the default) or, for the skill template form, the platform's
67
+ * skill templates (`"skillTemplate"`, a StackFactor admin tenant only).
68
+ */
69
+ catalog?: "skill" | "skillTemplate";
70
+ /** The skill or skill template being edited: its own name is no clash. */
71
+ excludeId?: string | null;
72
+ }
73
+ /** A skill name the caller's knowledge bases suggest (`getSkillSuggestions`). */
74
+ export interface SkillSuggestion {
75
+ /** The spelling most of its documents use. */
76
+ name: string;
77
+ /** How many documents the caller may read name it. */
78
+ documentCount: number;
79
+ /** How many knowledge bases those documents are in. */
80
+ knowledgeBaseCount: number;
81
+ /**
82
+ * A skill (with `catalog` "skillTemplate", a skill template) already has
83
+ * this name, in some spelling: a new one may not take it.
84
+ */
85
+ existingSkill: boolean;
86
+ /**
87
+ * How the skill (skill template) that already has the name spells it, which
88
+ * may differ from `name` ("react" for "React"); null when none has it.
89
+ */
90
+ existingSkillName: string | null;
91
+ }
92
+ /** One of a knowledge base skill's microskills, and how many passages teach it. */
93
+ export interface KnowledgeBaseMicroSkill {
94
+ name: string;
95
+ passages: number;
96
+ }
97
+ /**
98
+ * Where a knowledge base's microskill grouping stands, read from what the
99
+ * platform stores: asked for and not started (`queued`, since `requestedAt`),
100
+ * under way (`running`, since `startedAt`) or neither (`idle`); and when the
101
+ * last grouping ended, null before the first.
102
+ */
103
+ export interface KnowledgeBaseMicroSkillGrouping {
104
+ state: "idle" | "queued" | "running";
105
+ requestedAt: string | null;
106
+ startedAt: string | null;
107
+ finishedAt: string | null;
108
+ }
109
+ /** A knowledge base skill's microskills (`listMicroSkills`). */
110
+ export interface KnowledgeBaseMicroSkills {
111
+ /** The skill as it was asked for: spaces collapsed, trimmed. */
112
+ skill: string;
113
+ /**
114
+ * True when the passages' tags were grouped into microskills; false before,
115
+ * when `microSkills` are the tags as labelling gave them.
116
+ */
117
+ consolidated: boolean;
118
+ consolidatedAt: string | null;
119
+ /** Most passages first. Every one, however many. */
120
+ microSkills: KnowledgeBaseMicroSkill[];
121
+ microSkillCount: number;
122
+ /** How many distinct passage tags they were grouped from. */
123
+ passageTags: number;
124
+ /**
125
+ * How many passages carry the skill's tags, each once. Absent, like the two
126
+ * fields below, from a platform older than Group now.
127
+ */
128
+ passages?: number;
129
+ /**
130
+ * True when those passages are fewer than a microskill needs: grouping never
131
+ * groups the skill, so its tags stay as they are and Group now would change
132
+ * nothing for it.
133
+ */
134
+ belowGroupingThreshold?: boolean;
135
+ /** Where the knowledge base's grouping stands. */
136
+ grouping?: KnowledgeBaseMicroSkillGrouping;
137
+ /**
138
+ * When the last grouping of a skill not grouped failed; null when it did not,
139
+ * or the skill is grouped.
140
+ */
141
+ groupingFailedAt?: string | null;
142
+ /**
143
+ * Why, when the platform's RAG processor was refused for good (none enabled
144
+ * or allowed by the compliance profile, or the one named switched off);
145
+ * null otherwise.
146
+ */
147
+ groupingFailure?: string | null;
148
+ }
149
+ /**
150
+ * List the skills a knowledge base's content was labelled with, across its
151
+ * processed documents, most named first: `{ items, total, limit }`, each item
152
+ * `{ name, nameNormalized, scope, proficiencyLevels, documentCount }`, where
153
+ * `scope` is "organization", "general" or null (labelled before skills had one).
154
+ * GET /api/v1/knowledge-base/:id/skills
155
+ * @param {String} id The knowledge base id
156
+ * @param {SkillListParams} params Optional limit
157
+ * @param {String} authToken Authentication token
158
+ * @returns {Promise<object>}
159
+ */
160
+ export declare const listSkills: (id: string, params: SkillListParams, authToken: string) => Promise<object>;
161
+ /**
162
+ * Set how a knowledge base's skills are named, and rename them on every
163
+ * document and chunk already labelled; every document labelled later takes
164
+ * them too. The mappings replace the ones before; an empty list gives back
165
+ * every skill as labelling named it. Owner or editor only; refused while a sync
166
+ * of one of its sources is under way (409) and for mappings that do not hold —
167
+ * a skill mapped twice, or mappings that lead a skill back to itself (400).
168
+ * PUT /api/v1/knowledge-base/:id/skill-mappings
169
+ * @param {String} id The knowledge base id
170
+ * @param {SkillMapping[]} skillMappings The mappings, `[{ from, to }]`
171
+ * @param {String} authToken Authentication token
172
+ * @returns {Promise<object>} { knowledgeBase, documents, chunks }: the knowledge
173
+ * base with the mappings as stored, and how many documents and chunks were
174
+ * rewritten
175
+ */
176
+ export declare const setSkillMappings: (id: string, skillMappings: SkillMapping[], authToken: string) => Promise<object>;
177
+ /**
178
+ * What the knowledge bases the caller can open hold about one skill: how many
179
+ * of their documents name it (any spelling, under the names set with Edit
180
+ * skill names), in which knowledge bases, and the microskills their passages
181
+ * cover. The skill and skill template Additional Information dialogs ask it
182
+ * before they offer StackFactor as a data source. Only what the caller may
183
+ * open counts: their role on each knowledge base and each document's source
184
+ * permissions decide. Requires VIEW_KNOWLEDGE_BASE; the name must be 1 to 200
185
+ * characters (400 otherwise).
186
+ * GET /api/v1/knowledge-base/skill-coverage
187
+ * @param {String} skill The skill's or skill template's name
188
+ * @param {String} authToken Authentication token
189
+ * @returns {Promise<SkillCoverage>}
190
+ */
191
+ export declare const getSkillCoverage: (skill: string, authToken: string) => Promise<SkillCoverage>;
192
+ /**
193
+ * The skill names the knowledge bases the caller can open suggest while a
194
+ * skill's or skill template's name is typed: the skills their documents were
195
+ * classified with whose name has a word starting with what was typed, in any
196
+ * spelling ("gov" suggests "AI Governance"), one per skill, most documents
197
+ * first. Only what the caller may open counts, as for `getSkillCoverage`.
198
+ * Fewer than 2 characters to match answer no suggestions. Requires
199
+ * VIEW_KNOWLEDGE_BASE; `q` is at most 200 characters (400 otherwise).
200
+ * GET /api/v1/knowledge-base/skill-suggestions
201
+ * @param {String} q What was typed
202
+ * @param {SkillSuggestionParams} params Optional limit, catalog and the id of
203
+ * the skill or skill template being edited
204
+ * @param {String} authToken Authentication token
205
+ * @returns {Promise<SkillSuggestion[]>}
206
+ */
207
+ export declare const getSkillSuggestions: (q: string, params: SkillSuggestionParams | undefined, authToken: string) => Promise<SkillSuggestion[]>;
208
+ /**
209
+ * One of a knowledge base's skills, opened on its page: its microskills, as
210
+ * grouped, each with how many passages teach it, most first, and where the
211
+ * knowledge base's grouping stands (`grouping`). Any spelling of the skill
212
+ * matches. Requires VIEW_KNOWLEDGE_BASE and a role on the knowledge base; the
213
+ * name must be 1 to 200 characters (400 otherwise).
214
+ * GET /api/v1/knowledge-base/:id/skills/micro-skills
215
+ * @param {String} id The knowledge base id
216
+ * @param {String} skill The skill's name
217
+ * @param {String} authToken Authentication token
218
+ * @returns {Promise<KnowledgeBaseMicroSkills>}
219
+ */
220
+ export declare const listMicroSkills: (id: string, skill: string, authToken: string) => Promise<KnowledgeBaseMicroSkills>;
221
+ /**
222
+ * Where a knowledge base's microskill grouping stands: queued, running or
223
+ * idle, and when the last one ended. What a page polls while a grouping is
224
+ * under way, rather than `listMicroSkills`: the platform reads the knowledge
225
+ * base and nothing else. Requires VIEW_KNOWLEDGE_BASE and a role on the
226
+ * knowledge base.
227
+ * GET /api/v1/knowledge-base/:id/skills/micro-skills/grouping
228
+ * @param {String} id The knowledge base id
229
+ * @param {String} authToken Authentication token
230
+ * @returns {Promise<KnowledgeBaseMicroSkillGrouping>}
231
+ */
232
+ export declare const getMicroSkillGrouping: (id: string, authToken: string) => Promise<KnowledgeBaseMicroSkillGrouping>;
233
+ /**
234
+ * Group now: groups the knowledge base's skills' passage tags into their
235
+ * microskills, in the background. Owner or editor only, as setting how its
236
+ * skills are named (403 otherwise; 404 for no such knowledge base). Asked
237
+ * while a grouping runs, nothing more is asked: the answer is that it is
238
+ * running. `getMicroSkillGrouping` says when it is done (no longer queued or
239
+ * running). The skills whose grouping failed are sent again now.
240
+ * POST /api/v1/knowledge-base/:id/skills/micro-skills/group
241
+ * @param {String} id The knowledge base id
242
+ * @param {String} authToken Authentication token
243
+ * @returns {Promise<KnowledgeBaseMicroSkillGrouping>} Where the grouping
244
+ * stands: queued or running, and when the last one ended
245
+ */
246
+ export declare const groupMicroSkills: (id: string, authToken: string) => Promise<KnowledgeBaseMicroSkillGrouping>;
247
+ //# sourceMappingURL=skills.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"skills.d.ts","sourceRoot":"","sources":["../../../../src/lib/knowledgeBase/skills.ts"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,CAAC,EAAE,OAAO,GAAG,eAAe,GAAG,IAAI,CAAC;IAC/C,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,UAAU,GAAG,QAAQ,GAAG,SAAS,CAAC;IACxC,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB;AAED,kEAAkE;AAClE,MAAM,WAAW,eAAe;IAC9B,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;CACnB;AAED,gFAAgF;AAChF,MAAM,WAAW,0BAA0B;IACzC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,oEAAoE;IACpE,aAAa,EAAE,MAAM,CAAC;IACtB,uDAAuD;IACvD,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,yEAAyE;AACzE,MAAM,WAAW,aAAa;IAC5B,qEAAqE;IACrE,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,4BAA4B;IAC5B,cAAc,EAAE,0BAA0B,EAAE,CAAC;IAC7C,6DAA6D;IAC7D,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,mCAAmC;IACnC,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,gGAAgG;AAChG,MAAM,WAAW,qBAAqB;IACpC,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,eAAe,CAAC;IACpC,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,iFAAiF;AACjF,MAAM,WAAW,eAAe;IAC9B,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,sDAAsD;IACtD,aAAa,EAAE,MAAM,CAAC;IACtB,uDAAuD;IACvD,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,mFAAmF;AACnF,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,+BAA+B;IAC9C,KAAK,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACrC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,gEAAgE;AAChE,MAAM,WAAW,wBAAwB;IACvC,gEAAgE;IAChE,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,oDAAoD;IACpD,WAAW,EAAE,uBAAuB,EAAE,CAAC;IACvC,eAAe,EAAE,MAAM,CAAC;IACxB,6DAA6D;IAC7D,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,kDAAkD;IAClD,QAAQ,CAAC,EAAE,+BAA+B,CAAC;IAC3C;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,GACrB,IAAI,MAAM,EACV,QAAQ,eAAe,EACvB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,eAAe,YAAY,EAAE,EAC7B,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gBAAgB,GAC3B,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,aAAa,CAcvB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,mBAAmB,GAC9B,GAAG,MAAM,EACT,QAAQ,qBAAqB,GAAG,SAAS,EACzC,WAAW,MAAM,KAChB,OAAO,CAAC,eAAe,EAAE,CAc3B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,GAC1B,IAAI,MAAM,EACV,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC,wBAAwB,CAiBlC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,GAChC,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,+BAA+B,CAczC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB,GAC3B,IAAI,MAAM,EACV,WAAW,MAAM,KAChB,OAAO,CAAC,+BAA+B,CAezC,CAAC"}