@stackfactor/client-api 1.19.3 → 1.20.1

package/dist/cjs/lib/knowledgeBase/review.js

@@ -0,0 +1,413 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dismissAllArtifacts = exports.dismissArtifact = exports.retireArtifact = exports.regenerateArtifact = exports.decideContradiction = exports.listContradictions = exports.regenerateGenerated = exports.rejectGenerated = exports.editApproveGenerated = exports.approveGenerated = exports.listGeneratedReview = exports.deleteQuarantine = exports.reingestQuarantine = exports.decideQuarantine = exports.releaseQuarantine = exports.listReleased = exports.listQuarantine = exports.getReviewOverview = void 0;
+const axiosClient_js_1 = require("../axiosClient.js");
+//
+// Knowledge Base management operations — Review Center (quarantine, generated content, contradictions) and out-of-sync notification actions.
+// Re-exported by `../knowledgeBase.ts`, which keeps the public entry.
+//
+// ── Review Center — overview ──────────────────────────────────────────────────
+/**
+ * Overview of all Review Center streams + counts for a knowledge base.
+ * GET /api/v1/knowledge-base/:id/review
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const getReviewOverview = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.get(`/api/v1/knowledge-base/${id}/review`, {
+            headers: { authorization: authToken },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.getReviewOverview = getReviewOverview;
+// ── Review Center — Stream 1: Quarantine release ──────────────────────────────
+/**
+ * List QUARANTINED documents (Review Center stream 1).
+ * GET /api/v1/knowledge-base/:id/review/quarantine
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const listQuarantine = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.get(`/api/v1/knowledge-base/${id}/review/quarantine`, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.listQuarantine = listQuarantine;
+/**
+ * List the documents released from review (Review Center stream 1): every one
+ * released and not held again since, the newest release first, each with
+ * `quarantineReleasedAt` and `quarantineReleasedByName` (who released it, or
+ * null). Requires RELEASE_QUARANTINE + owner|editor, as the held list does.
+ * GET /api/v1/knowledge-base/:id/review/quarantine?state=released
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const listReleased = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.get(`/api/v1/knowledge-base/${id}/review/quarantine`, { headers: { authorization: authToken }, params: { state: "released" } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.listReleased = listReleased;
+/**
+ * Release a quarantined document. Requires RELEASE_QUARANTINE + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/quarantine/:docId/release
+ * @param {String} id The knowledge base id
+ * @param {String} docId The document id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const releaseQuarantine = (id, docId, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/knowledge-base/${id}/review/quarantine/${docId}/release`, {}, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.releaseQuarantine = releaseQuarantine;
+/**
+ * Apply a reviewer's decisions to many held documents at once: release each
+ * named document back through ingestion, keep it in quarantine as reviewed, or
+ * block it from the knowledge base. One run per source released into is asked
+ * for, never one per document. Requires RELEASE_QUARANTINE + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/quarantine/decisions
+ * @param {String} id The knowledge base id
+ * @param {Array<{documentId: string, decision: "release"|"quarantine"|"block", reason?: string}>} decisions One decision per document, at most 500
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>} `{ results: [{ documentId, decision, outcome }], runs: [{ sourceId, correlationId, started }] }`
+ */
+const decideQuarantine = (id, decisions, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/knowledge-base/${id}/review/quarantine/decisions`, { decisions }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.decideQuarantine = decideQuarantine;
+/**
+ * Re-ingest a quarantined document (optionally with an updated redaction policy).
+ * Publishes a kb-source-event (trigger="quarantine_re_ingest"). Requires
+ * RELEASE_QUARANTINE + owner.
+ * POST /api/v1/knowledge-base/:id/review/quarantine/:docId/re-ingest
+ * @param {String} id The knowledge base id
+ * @param {String} docId The document id
+ * @param {object} data Optional body, e.g. `{ updatedRedactionPolicy }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const reingestQuarantine = (id, docId, data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/knowledge-base/${id}/review/quarantine/${docId}/re-ingest`, data, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.reingestQuarantine = reingestQuarantine;
+/**
+ * Delete a quarantined document. Requires RELEASE_QUARANTINE + owner.
+ * POST /api/v1/knowledge-base/:id/review/quarantine/:docId/delete
+ * @param {String} id The knowledge base id
+ * @param {String} docId The document id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const deleteQuarantine = (id, docId, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/knowledge-base/${id}/review/quarantine/${docId}/delete`, {}, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.deleteQuarantine = deleteQuarantine;
+// ── Review Center — Stream 2: Generated content review ────────────────────────
+/**
+ * List generated artifacts awaiting review (needsReview=true).
+ * Requires GENERATE_FROM_KB + owner|editor.
+ * GET /api/v1/knowledge-base/:id/review/generated
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const listGeneratedReview = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.get(`/api/v1/knowledge-base/${id}/review/generated`, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.listGeneratedReview = listGeneratedReview;
+/**
+ * Approve a generated artifact. Requires GENERATE_FROM_KB + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/generated/:entityId/approve
+ * @param {String} id The knowledge base id
+ * @param {String} entityId The artifact/entity id
+ * @param {object} data Body `{ entityType, notes? }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const approveGenerated = (id, entityId, data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/knowledge-base/${id}/review/generated/${entityId}/approve`, data, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.approveGenerated = approveGenerated;
+/**
+ * Approve a generated artifact with edits.
+ * Requires GENERATE_FROM_KB + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/generated/:entityId/edit-approve
+ * @param {String} id The knowledge base id
+ * @param {String} entityId The artifact/entity id
+ * @param {object} data Body `{ entityType, edits, notes? }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const editApproveGenerated = (id, entityId, data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/knowledge-base/${id}/review/generated/${entityId}/edit-approve`, data, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.editApproveGenerated = editApproveGenerated;
+/**
+ * Reject a generated artifact. Requires GENERATE_FROM_KB + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/generated/:entityId/reject
+ * @param {String} id The knowledge base id
+ * @param {String} entityId The artifact/entity id
+ * @param {object} data Body `{ entityType, reason }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const rejectGenerated = (id, entityId, data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/knowledge-base/${id}/review/generated/${entityId}/reject`, data, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.rejectGenerated = rejectGenerated;
+/**
+ * Regenerate a generated artifact using current chunks.
+ * Requires GENERATE_FROM_KB + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/generated/:entityId/regenerate
+ * @param {String} id The knowledge base id
+ * @param {String} entityId The artifact/entity id
+ * @param {object} data Body `{ entityType, regenerationHints? }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const regenerateGenerated = (id, entityId, data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/knowledge-base/${id}/review/generated/${entityId}/regenerate`, data, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.regenerateGenerated = regenerateGenerated;
+// ── Review Center — Stream 3: Contradiction flags ─────────────────────────────
+/**
+ * List chunks with non-empty contradictionFlags[].
+ * Requires GENERATE_FROM_KB + owner|editor.
+ * GET /api/v1/knowledge-base/:id/review/contradictions
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const listContradictions = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.get(`/api/v1/knowledge-base/${id}/review/contradictions`, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.listContradictions = listContradictions;
+/**
+ * Decide a contradiction between two chunks.
+ * Requires GENERATE_FROM_KB + owner|editor.
+ * POST /api/v1/knowledge-base/:id/review/contradictions/:chunkId/decide
+ * @param {String} id The knowledge base id
+ * @param {String} chunkId The chunk id carrying the contradiction flag
+ * @param {object} data Body `{ decision, otherChunkId, notes }` — `decision` is one
+ *   of `KNOWLEDGE_BASE.CONTRADICTION_DECISION`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const decideContradiction = (id, chunkId, data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/knowledge-base/${id}/review/contradictions/${chunkId}/decide`, data, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.decideContradiction = decideContradiction;
+// ── Out-of-Sync Notification Actions ──────────────────────────────────────────
+// (design §14 / §14A — surfaced as notifications, acted on per-artifact.
+//  Requires GENERATE_FROM_KB + owner|editor on the KB.)
+/**
+ * Regenerate a stale artifact from a notification using current chunks.
+ * POST /api/v1/notifications/:notificationId/artifacts/:artifactId/regenerate
+ * @param {String} notificationId The notification id
+ * @param {String} artifactId The artifact id
+ * @param {object} data Body `{ entityType }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const regenerateArtifact = (notificationId, artifactId, data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/notifications/${notificationId}/artifacts/${artifactId}/regenerate`, data, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.regenerateArtifact = regenerateArtifact;
+/**
+ * Retire (soft-delete) a stale artifact from a notification.
+ * POST /api/v1/notifications/:notificationId/artifacts/:artifactId/retire
+ * @param {String} notificationId The notification id
+ * @param {String} artifactId The artifact id
+ * @param {object} data Body `{ entityType }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const retireArtifact = (notificationId, artifactId, data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/notifications/${notificationId}/artifacts/${artifactId}/retire`, data, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.retireArtifact = retireArtifact;
+/**
+ * Dismiss a stale-artifact flag (mark the staleness acceptable).
+ * POST /api/v1/notifications/:notificationId/artifacts/:artifactId/dismiss
+ * @param {String} notificationId The notification id
+ * @param {String} artifactId The artifact id
+ * @param {object} data Body `{ entityType, reason? }`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const dismissArtifact = (notificationId, artifactId, data, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/notifications/${notificationId}/artifacts/${artifactId}/dismiss`, data, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.dismissArtifact = dismissArtifact;
+/**
+ * Dismiss an entire out-of-sync notification (all artifacts).
+ * POST /api/v1/notifications/:notificationId/dismiss-all
+ * @param {String} notificationId The notification id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+const dismissAllArtifacts = (notificationId, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = axiosClient_js_1.client.post(`/api/v1/notifications/${notificationId}/dismiss-all`, {}, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+exports.dismissAllArtifacts = dismissAllArtifacts;
+//# sourceMappingURL=review.js.map

package/dist/cjs/lib/knowledgeBase/review.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"review.js","sourceRoot":"","sources":["../../../../src/lib/knowledgeBase/review.ts"],"names":[],"mappings":";;;AACA,sDAA2C;AAE3C,EAAE;AACF,6IAA6I;AAC7I,sEAAsE;AACtE,EAAE;AAEF,iFAAiF;AAEjF;;;;;;GAMG;AACI,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,uBAAM,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;AAhBW,QAAA,iBAAiB,qBAgB5B;AAEF,iFAAiF;AAEjF;;;;;;GAMG;AACI,MAAM,cAAc,GAAG,CAC5B,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,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;AAjBW,QAAA,cAAc,kBAiBzB;AAEF;;;;;;;;;GASG;AACI,MAAM,YAAY,GAAG,CAC1B,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,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;AAjBW,QAAA,YAAY,gBAiBvB;AAEF;;;;;;;GAOG;AACI,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,uBAAM,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;AAnBW,QAAA,iBAAiB,qBAmB5B;AAEF;;;;;;;;;;GAUG;AACI,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,uBAAM,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;AAnBW,QAAA,gBAAgB,oBAmB3B;AAEF;;;;;;;;;;GAUG;AACI,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,uBAAM,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;AApBW,QAAA,kBAAkB,sBAoB7B;AAEF;;;;;;;GAOG;AACI,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,uBAAM,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;AAnBW,QAAA,gBAAgB,oBAmB3B;AAEF,iFAAiF;AAEjF;;;;;;;GAOG;AACI,MAAM,mBAAmB,GAAG,CACjC,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,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;AAjBW,QAAA,mBAAmB,uBAiB9B;AAEF;;;;;;;;GAQG;AACI,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,uBAAM,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;AApBW,QAAA,gBAAgB,oBAoB3B;AAEF;;;;;;;;;GASG;AACI,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,uBAAM,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;AApBW,QAAA,oBAAoB,wBAoB/B;AAEF;;;;;;;;GAQG;AACI,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,uBAAM,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;AApBW,QAAA,eAAe,mBAoB1B;AAEF;;;;;;;;;GASG;AACI,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,uBAAM,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;AApBW,QAAA,mBAAmB,uBAoB9B;AAEF,iFAAiF;AAEjF;;;;;;;GAOG;AACI,MAAM,kBAAkB,GAAG,CAChC,EAAU,EACV,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,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;AAjBW,QAAA,kBAAkB,sBAiB7B;AAEF;;;;;;;;;;GAUG;AACI,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,uBAAM,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;AApBW,QAAA,mBAAmB,uBAoB9B;AAEF,iFAAiF;AACjF,yEAAyE;AACzE,wDAAwD;AAExD;;;;;;;;GAQG;AACI,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,uBAAM,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;AApBW,QAAA,kBAAkB,sBAoB7B;AAEF;;;;;;;;GAQG;AACI,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,uBAAM,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;AApBW,QAAA,cAAc,kBAoBzB;AAEF;;;;;;;;GAQG;AACI,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,uBAAM,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;AApBW,QAAA,eAAe,mBAoB1B;AAEF;;;;;;GAMG;AACI,MAAM,mBAAmB,GAAG,CACjC,cAAsB,EACtB,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,uBAAM,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;AAlBW,QAAA,mBAAmB,uBAkB9B"}

package/dist/cjs/lib/knowledgeBase/skills.d.ts

@@ -0,0 +1,247 @@
+/**
+ * A skill a knowledge base's people listed for labelling to look for. Picked
+ * from the catalog, it names the catalog skill: the tenant's skills
+ * (`"skill"`) or the platform's skill templates (`"skillTemplate"`). The
+ * platform reads that skill's own microskills; any sent are ignored.
+ */
+export interface ListedSkill {
+    name: string;
+    catalogId?: string | null;
+    catalogType?: "skill" | "skillTemplate" | null;
+    /** Read-only: the catalog skill's own microskills, as stored. */
+    microSkills?: string[];
+}
+/**
+ * What labelling looks for in content: every skill it teaches (`"discover"`,
+ * the default), the listed skills first, under their names, and any others
+ * (`"guided"`), or only the listed ones (`"focused"`). Guided and focused need
+ * at least one skill, at most 50; discover lists none. Each connection holds
+ * its own (`SourceInput.skillSettings`).
+ */
+export interface SkillSettings {
+    mode: "discover" | "guided" | "focused";
+    skills: ListedSkill[];
+}
+/** Optional options for the list of a knowledge base's skills. */
+export interface SkillListParams {
+    /** How many skills, most named first: 1 to 200 (default 50). */
+    limit?: number;
+}
+/**
+ * One way a knowledge base's people name a skill its content was labelled
+ * with: `from`, a skill's name (any spelling of it), becomes `to` — a new name,
+ * or the name of a skill it merges into — or null, which removes the skill.
+ */
+export interface SkillMapping {
+    from: string;
+    to: string | null;
+}
+/** A knowledge base that holds documents about a skill (`getSkillCoverage`). */
+export interface SkillCoverageKnowledgeBase {
+    _id: string;
+    name: string;
+    /** How many of its documents the caller may read name the skill. */
+    documentCount: number;
+    /** The kinds of resource those documents came from. */
+    sourceTypes: string[];
+}
+/** What the knowledge bases the caller can open hold about one skill. */
+export interface SkillCoverage {
+    /** The skill's name as it was matched: spaces collapsed, trimmed. */
+    skill: string;
+    documentCount: number;
+    /** Most documents first. */
+    knowledgeBases: SkillCoverageKnowledgeBase[];
+    /** The microskills their passages cover most, at most 12. */
+    microSkills: string[];
+    /** Every microskill they cover. */
+    microSkillCount: number;
+}
+/** Options for the skill names the caller's knowledge bases suggest (`getSkillSuggestions`). */
+export interface SkillSuggestionParams {
+    /** How many suggestions: 1 to 25 (default 10). */
+    limit?: number;
+    /**
+     * Where a name that already exists is looked for: the tenant's skills
+     * (`"skill"`, the default) or, for the skill template form, the platform's
+     * skill templates (`"skillTemplate"`, a StackFactor admin tenant only).
+     */
+    catalog?: "skill" | "skillTemplate";
+    /** The skill or skill template being edited: its own name is no clash. */
+    excludeId?: string | null;
+}
+/** A skill name the caller's knowledge bases suggest (`getSkillSuggestions`). */
+export interface SkillSuggestion {
+    /** The spelling most of its documents use. */
+    name: string;
+    /** How many documents the caller may read name it. */
+    documentCount: number;
+    /** How many knowledge bases those documents are in. */
+    knowledgeBaseCount: number;
+    /**
+     * A skill (with `catalog` "skillTemplate", a skill template) already has
+     * this name, in some spelling: a new one may not take it.
+     */
+    existingSkill: boolean;
+    /**
+     * How the skill (skill template) that already has the name spells it, which
+     * may differ from `name` ("react" for "React"); null when none has it.
+     */
+    existingSkillName: string | null;
+}
+/** One of a knowledge base skill's microskills, and how many passages teach it. */
+export interface KnowledgeBaseMicroSkill {
+    name: string;
+    passages: number;
+}
+/**
+ * Where a knowledge base's microskill grouping stands, read from what the
+ * platform stores: asked for and not started (`queued`, since `requestedAt`),
+ * under way (`running`, since `startedAt`) or neither (`idle`); and when the
+ * last grouping ended, null before the first.
+ */
+export interface KnowledgeBaseMicroSkillGrouping {
+    state: "idle" | "queued" | "running";
+    requestedAt: string | null;
+    startedAt: string | null;
+    finishedAt: string | null;
+}
+/** A knowledge base skill's microskills (`listMicroSkills`). */
+export interface KnowledgeBaseMicroSkills {
+    /** The skill as it was asked for: spaces collapsed, trimmed. */
+    skill: string;
+    /**
+     * True when the passages' tags were grouped into microskills; false before,
+     * when `microSkills` are the tags as labelling gave them.
+     */
+    consolidated: boolean;
+    consolidatedAt: string | null;
+    /** Most passages first. Every one, however many. */
+    microSkills: KnowledgeBaseMicroSkill[];
+    microSkillCount: number;
+    /** How many distinct passage tags they were grouped from. */
+    passageTags: number;
+    /**
+     * How many passages carry the skill's tags, each once. Absent, like the two
+     * fields below, from a platform older than Group now.
+     */
+    passages?: number;
+    /**
+     * True when those passages are fewer than a microskill needs: grouping never
+     * groups the skill, so its tags stay as they are and Group now would change
+     * nothing for it.
+     */
+    belowGroupingThreshold?: boolean;
+    /** Where the knowledge base's grouping stands. */
+    grouping?: KnowledgeBaseMicroSkillGrouping;
+    /**
+     * When the last grouping of a skill not grouped failed; null when it did not,
+     * or the skill is grouped.
+     */
+    groupingFailedAt?: string | null;
+    /**
+     * Why, when the platform's RAG processor was refused for good (none enabled
+     * or allowed by the compliance profile, or the one named switched off);
+     * null otherwise.
+     */
+    groupingFailure?: string | null;
+}
+/**
+ * List the skills a knowledge base's content was labelled with, across its
+ * processed documents, most named first: `{ items, total, limit }`, each item
+ * `{ name, nameNormalized, scope, proficiencyLevels, documentCount }`, where
+ * `scope` is "organization", "general" or null (labelled before skills had one).
+ * GET /api/v1/knowledge-base/:id/skills
+ * @param {String} id The knowledge base id
+ * @param {SkillListParams} params Optional limit
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const listSkills: (id: string, params: SkillListParams, authToken: string) => Promise<object>;
+/**
+ * Set how a knowledge base's skills are named, and rename them on every
+ * document and chunk already labelled; every document labelled later takes
+ * them too. The mappings replace the ones before; an empty list gives back
+ * every skill as labelling named it. Owner or editor only; refused while a sync
+ * of one of its sources is under way (409) and for mappings that do not hold —
+ * a skill mapped twice, or mappings that lead a skill back to itself (400).
+ * PUT /api/v1/knowledge-base/:id/skill-mappings
+ * @param {String} id The knowledge base id
+ * @param {SkillMapping[]} skillMappings The mappings, `[{ from, to }]`
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>} { knowledgeBase, documents, chunks }: the knowledge
+ *   base with the mappings as stored, and how many documents and chunks were
+ *   rewritten
+ */
+export declare const setSkillMappings: (id: string, skillMappings: SkillMapping[], authToken: string) => Promise<object>;
+/**
+ * What the knowledge bases the caller can open hold about one skill: how many
+ * of their documents name it (any spelling, under the names set with Edit
+ * skill names), in which knowledge bases, and the microskills their passages
+ * cover. The skill and skill template Additional Information dialogs ask it
+ * before they offer StackFactor as a data source. Only what the caller may
+ * open counts: their role on each knowledge base and each document's source
+ * permissions decide. Requires VIEW_KNOWLEDGE_BASE; the name must be 1 to 200
+ * characters (400 otherwise).
+ * GET /api/v1/knowledge-base/skill-coverage
+ * @param {String} skill The skill's or skill template's name
+ * @param {String} authToken Authentication token
+ * @returns {Promise<SkillCoverage>}
+ */
+export declare const getSkillCoverage: (skill: string, authToken: string) => Promise<SkillCoverage>;
+/**
+ * The skill names the knowledge bases the caller can open suggest while a
+ * skill's or skill template's name is typed: the skills their documents were
+ * classified with whose name has a word starting with what was typed, in any
+ * spelling ("gov" suggests "AI Governance"), one per skill, most documents
+ * first. Only what the caller may open counts, as for `getSkillCoverage`.
+ * Fewer than 2 characters to match answer no suggestions. Requires
+ * VIEW_KNOWLEDGE_BASE; `q` is at most 200 characters (400 otherwise).
+ * GET /api/v1/knowledge-base/skill-suggestions
+ * @param {String} q What was typed
+ * @param {SkillSuggestionParams} params Optional limit, catalog and the id of
+ *   the skill or skill template being edited
+ * @param {String} authToken Authentication token
+ * @returns {Promise<SkillSuggestion[]>}
+ */
+export declare const getSkillSuggestions: (q: string, params: SkillSuggestionParams | undefined, authToken: string) => Promise<SkillSuggestion[]>;
+/**
+ * One of a knowledge base's skills, opened on its page: its microskills, as
+ * grouped, each with how many passages teach it, most first, and where the
+ * knowledge base's grouping stands (`grouping`). Any spelling of the skill
+ * matches. Requires VIEW_KNOWLEDGE_BASE and a role on the knowledge base; the
+ * name must be 1 to 200 characters (400 otherwise).
+ * GET /api/v1/knowledge-base/:id/skills/micro-skills
+ * @param {String} id The knowledge base id
+ * @param {String} skill The skill's name
+ * @param {String} authToken Authentication token
+ * @returns {Promise<KnowledgeBaseMicroSkills>}
+ */
+export declare const listMicroSkills: (id: string, skill: string, authToken: string) => Promise<KnowledgeBaseMicroSkills>;
+/**
+ * Where a knowledge base's microskill grouping stands: queued, running or
+ * idle, and when the last one ended. What a page polls while a grouping is
+ * under way, rather than `listMicroSkills`: the platform reads the knowledge
+ * base and nothing else. Requires VIEW_KNOWLEDGE_BASE and a role on the
+ * knowledge base.
+ * GET /api/v1/knowledge-base/:id/skills/micro-skills/grouping
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<KnowledgeBaseMicroSkillGrouping>}
+ */
+export declare const getMicroSkillGrouping: (id: string, authToken: string) => Promise<KnowledgeBaseMicroSkillGrouping>;
+/**
+ * Group now: groups the knowledge base's skills' passage tags into their
+ * microskills, in the background. Owner or editor only, as setting how its
+ * skills are named (403 otherwise; 404 for no such knowledge base). Asked
+ * while a grouping runs, nothing more is asked: the answer is that it is
+ * running. `getMicroSkillGrouping` says when it is done (no longer queued or
+ * running). The skills whose grouping failed are sent again now.
+ * POST /api/v1/knowledge-base/:id/skills/micro-skills/group
+ * @param {String} id The knowledge base id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<KnowledgeBaseMicroSkillGrouping>} Where the grouping
+ *   stands: queued or running, and when the last one ended
+ */
+export declare const groupMicroSkills: (id: string, authToken: string) => Promise<KnowledgeBaseMicroSkillGrouping>;
+//# sourceMappingURL=skills.d.ts.map