@stackfactor/client-api 1.19.3 → 1.20.2

package/dist/esm/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

package/dist/esm/lib/knowledgeBase/skills.d.ts.map

@@ -0,0 +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"}

package/dist/esm/lib/knowledgeBase/skills.js

@@ -0,0 +1,189 @@
+import { client } from "../axiosClient.js";
+/**
+ * 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 const listSkills = (id, params, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.get(`/api/v1/knowledge-base/${id}/skills`, {
+            headers: { authorization: authToken },
+            params: params,
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const setSkillMappings = (id, skillMappings, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.put(`/api/v1/knowledge-base/${id}/skill-mappings`, { skillMappings }, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const getSkillCoverage = (skill, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.get(`/api/v1/knowledge-base/skill-coverage`, {
+            headers: { authorization: authToken },
+            params: { skill },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const getSkillSuggestions = (q, params, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.get(`/api/v1/knowledge-base/skill-suggestions`, {
+            headers: { authorization: authToken },
+            params: { ...params, q },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const listMicroSkills = (id, skill, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.get(`/api/v1/knowledge-base/${id}/skills/micro-skills`, {
+            headers: { authorization: authToken },
+            params: { skill },
+        });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const getMicroSkillGrouping = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.get(`/api/v1/knowledge-base/${id}/skills/micro-skills/grouping`, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+/**
+ * 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 const groupMicroSkills = (id, authToken) => {
+    return new Promise((resolve, reject) => {
+        const request = client.post(`/api/v1/knowledge-base/${id}/skills/micro-skills/group`, {}, { headers: { authorization: authToken } });
+        request
+            .then((response) => {
+            resolve(response.data);
+        })
+            .catch((error) => {
+            reject(error);
+        });
+    });
+};
+//# sourceMappingURL=skills.js.map

package/dist/esm/lib/knowledgeBase/skills.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"skills.js","sourceRoot":"","sources":["../../../../src/lib/knowledgeBase/skills.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAsK3C;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,EAAU,EACV,MAAuB,EACvB,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;YACrC,MAAM,EAAE,MAAM;SACf,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;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,EAAU,EACV,aAA6B,EAC7B,SAAiB,EACA,EAAE;IACnB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,0BAA0B,EAAE,iBAAiB,EAC7C,EAAE,aAAa,EAAE,EACjB,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;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,KAAa,EACb,SAAiB,EACO,EAAE;IAC1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,uCAAuC,EAAE;YAClE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;YACrC,MAAM,EAAE,EAAE,KAAK,EAAE;SAClB,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;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,CAAS,EACT,MAAyC,EACzC,SAAiB,EACW,EAAE;IAC9B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,0CAA0C,EAAE;YACrE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;YACrC,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,EAAE;SACzB,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;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,EAAU,EACV,KAAa,EACb,SAAiB,EACkB,EAAE;IACrC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,0BAA0B,EAAE,sBAAsB,EAClD;YACE,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;YACrC,MAAM,EAAE,EAAE,KAAK,EAAE;SAClB,CACF,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,qBAAqB,GAAG,CACnC,EAAU,EACV,SAAiB,EACyB,EAAE;IAC5C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CACxB,0BAA0B,EAAE,+BAA+B,EAC3D,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;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,EAAU,EACV,SAAiB,EACyB,EAAE;IAC5C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,0BAA0B,EAAE,4BAA4B,EACxD,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"}

package/dist/esm/lib/knowledgeBase/sources.d.ts

@@ -0,0 +1,136 @@
+import type { SkillSettings } from "./skills.js";
+/**
+ * What happens to sensitive data found in content: it is masked and the
+ * document indexed (`"redact_in_place"`), the document is held for review
+ * (`"quarantine"`), or it is refused (`"fail"`). `providerIntegrationId` names
+ * a DLP_PROVIDER integration; null falls back to the tenant's default.
+ */
+export interface RedactionPolicy {
+    behavior: "redact_in_place" | "quarantine" | "fail";
+    providerIntegrationId?: string | null;
+}
+/**
+ * A connection's configuration, as `addSource` and `updateSource` send it.
+ *
+ * `skillSettings` and `redactionPolicy` are the connection's — the knowledge
+ * base holds neither. Omitted on add, a connection discovers and redacts in
+ * place; omitted on update, they are left as they are; null is refused.
+ * Setting `redactionPolicy` asks for MANAGE_COMPLIANCE; without it the call is
+ * refused (403) and nothing else in the same payload is saved either. Changing
+ * `skillSettings` labels that connection's documents again on the sync the
+ * save raises. A knowledge base read gives every connection both.
+ */
+export interface SourceInput {
+    name?: string;
+    /** The KB_SOURCE_CONNECTOR integration to sync through. */
+    integrationId?: string;
+    type?: string | null;
+    url?: string;
+    /** The connector's own selection rules, or null for none. */
+    syncFilters?: object | null;
+    /** 1 to 365 days, or null for manual-only. Default 7. */
+    syncFrequencyDays?: number | null;
+    /** One-time handle for credentials parked at OAuth exchange. */
+    authenticationHandle?: string;
+    /** `null` clears the stored credentials; omitted leaves them alone. */
+    authentication?: object | null;
+    /** What labelling looks for in this connection's content. */
+    skillSettings?: SkillSettings;
+    /** What happens to sensitive data found in it. Needs MANAGE_COMPLIANCE. */
+    redactionPolicy?: RedactionPolicy;
+}
+/**
+ * List the available KB_SOURCE_CONNECTOR integrations (enabled integrations +
+ * capability manifests for the source-creation form).
+ * GET /api/v1/knowledge-base/source-connectors
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const listSourceConnectors: (authToken: string) => Promise<object>;
+/**
+ * Add a source to a knowledge base (`integrationId` + credentials +
+ * `syncFrequencyDays`, default 7). Publishes a kb-source-event (changeType="add").
+ * POST /api/v1/knowledge-base/:id/sources
+ * @param {String} id The knowledge base id
+ * @param {SourceInput} source The source configuration
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const addSource: (id: string, source: SourceInput, authToken: string) => Promise<object>;
+/**
+ * Update a knowledge base source. Publishes a kb-source-event per changed source.
+ * PUT /api/v1/knowledge-base/:id/sources/:sourceId
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {SourceInput} source The updated source configuration
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const updateSource: (id: string, sourceId: string, source: SourceInput, authToken: string) => Promise<object>;
+/**
+ * Remove a source from a knowledge base. Publishes a kb-source-event
+ * (changeType="delete").
+ * DELETE /api/v1/knowledge-base/:id/sources/:sourceId
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const deleteSource: (id: string, sourceId: string, authToken: string) => Promise<object>;
+/**
+ * Trigger a manual re-sync of a source. Publishes a kb-source-event
+ * (changeType="update", trigger="manual_sync").
+ * POST /api/v1/knowledge-base/:id/sources/:sourceId/sync
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const syncSource: (id: string, sourceId: string, authToken: string) => Promise<object>;
+/**
+ * Process every processed document of a source again — classification, labels,
+ * chunks and embeddings redone — on a run of the source. Quarantined and blocked
+ * documents are left as they are. A run starts now, or a follow-up run is owed
+ * while one is outstanding (trigger="reprocess").
+ * POST /api/v1/knowledge-base/:id/sources/:sourceId/reprocess
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>} { ok, documents, correlationId, started }: how many
+ *   documents were marked, the run, and whether it started now
+ */
+export declare const reprocessSource: (id: string, sourceId: string, authToken: string) => Promise<object>;
+/**
+ * Test a source's connector credentials (dispatches TEST_CONNECTION).
+ * POST /api/v1/knowledge-base/:id/sources/:sourceId/test
+ * @param {String} id The knowledge base id
+ * @param {String} sourceId The source id
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const testSource: (id: string, sourceId: string, authToken: string) => Promise<object>;
+/**
+ * List the current user's source-side identities.
+ * GET /api/v1/identity/source-mappings
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const listSourceMappings: (authToken: string) => Promise<object>;
+/**
+ * Tenant-admin override for a user's source identity mapping.
+ * PUT /api/v1/identity/source-mappings/:sourceType
+ * @param {String} sourceType The source type key
+ * @param {object} data The mapping override
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const updateSourceMapping: (sourceType: string, data: object, authToken: string) => Promise<object>;
+/**
+ * Bulk-resolve source principal IDs → tenant users (internal / service-to-service).
+ * POST /api/v1/identity/source-mappings/resolve
+ * @param {object} data Body carrying the principal IDs to resolve
+ * @param {String} authToken Authentication token
+ * @returns {Promise<object>}
+ */
+export declare const resolveSourceMappings: (data: object, authToken: string) => Promise<object>;
+//# sourceMappingURL=sources.d.ts.map

package/dist/esm/lib/knowledgeBase/sources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sources.d.ts","sourceRoot":"","sources":["../../../../src/lib/knowledgeBase/sources.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAOjD;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,iBAAiB,GAAG,YAAY,GAAG,MAAM,CAAC;IACpD,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,yDAAyD;IACzD,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,gEAAgE;IAChE,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,uEAAuE;IACvE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,6DAA6D;IAC7D,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,2EAA2E;IAC3E,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAID;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAI,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,CAatE,CAAC;AAWF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,GACpB,IAAI,MAAM,EACV,QAAQ,WAAW,EACnB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,QAAQ,WAAW,EACnB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GACvB,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAchB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,GACrB,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,GAC1B,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,GACrB,IAAI,MAAM,EACV,UAAU,MAAM,EAChB,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAKF;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,CAapE,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAC9B,YAAY,MAAM,EAClB,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAChC,MAAM,MAAM,EACZ,WAAW,MAAM,KAChB,OAAO,CAAC,MAAM,CAehB,CAAC"}