@stackfactor/client-api 1.19.3 → 1.20.2

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

@@ -1,786 +1,6 @@
-/**
- * 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 a knowledge base's 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.
- * Changing the mode or the list on update syncs every resource again.
- */
-export interface SkillSettings {
-    mode: "discover" | "guided" | "focused";
-    skills: ListedSkill[];
-}
-/** Create / update payload for a KB's metadata (§14 CRUD). */
-export interface KnowledgeBaseInput {
-    name?: string;
-    description?: string | null;
-    category?: string | null;
-    /** One of `KNOWLEDGE_BASE.VISIBILITY` — "private" | "team" | "public". */
-    visibility?: string;
-    embeddingProvider?: string;
-    embeddingModel?: string;
-    embeddingDimensions?: number;
-    redactionPolicy?: object;
-    status?: number;
-    skillSettings?: SkillSettings;
-}
-/** An access grant (§14 KB Access Management). */
-export interface AccessEntryInput {
-    /** One of `KNOWLEDGE_BASE.SUBJECT_TYPE` — "user" | "group" | "team". */
-    subjectType: string;
-    subjectId: string;
-    /** One of `KNOWLEDGE_BASE.ACCESS_ROLE` — "owner" | "editor" | "contributor" | "viewer". */
-    role: string;
-}
-/** Optional filters for the paginated document list (§14 Document Management). */
-export interface DocumentListParams {
-    page?: number;
-    limit?: number;
-    /** One of `KNOWLEDGE_BASE.DOCUMENT_STATUS`. */
-    status?: number;
-}
-/** 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;
-}
-/** A knowledge base document as its page shows it (`getDocument`). */
-export interface KnowledgeBaseDocumentInfo {
-    _id: string;
-    knowledgeBaseId: string;
-    knowledgeBaseSourceId: string;
-    name: string;
-    /** One of `KNOWLEDGE_BASE.DOCUMENT_STATUS`. */
-    status: number;
-    /** The source's connector type, or null when the source is gone. */
-    sourceType: string | null;
-    /** The document at its source (http or https only), or null. */
-    webUrl: string | null;
-    folderPath: string | null;
-    mimeType: string | null;
-    documentType: string | null;
-    chunkCount: number | null;
-    lastSync: string | null;
-    updatedAt: string | null;
-}
-/** A skill a chunk was labelled with, and its microskills. */
-export interface KnowledgeBaseChunkSkill {
-    name: string;
-    microSkills: string[];
-}
-/** One chunk of a knowledge base document, as the RAG holds it (redacted). */
-export interface KnowledgeBaseDocumentChunk {
-    _id: string;
-    chunkIndex: number;
-    sectionTitle: string | null;
-    pageNumber: number | null;
-    contentType: string | null;
-    text: string;
-    isImage: boolean;
-    imageDescription: string | null;
-    /**
-     * True for an image chunk whose picture can be shown: ask `getDocumentImage`
-     * for it. False for a text chunk, and for a picture that was never stored
-     * (an older sync) or is of a type the page does not show; such a passage
-     * keeps to its description.
-     */
-    hasImage: boolean;
-    skills: KnowledgeBaseChunkSkill[];
-}
-/** A knowledge base document and what the RAG holds for it (`getDocument`). */
-export interface KnowledgeBaseDocumentContent {
-    knowledgeBase: {
-        _id: string;
-        name: string;
-    };
-    document: KnowledgeBaseDocumentInfo;
-    /**
-     * By `chunkIndex`. Empty unless the document was processed and is not held
-     * for review or blocked.
-     */
-    chunks: KnowledgeBaseDocumentChunk[];
-    /** How many chunks the document has. */
-    chunksTotal: number;
-    /** True when it has more than 1000; only the first 1000 are returned. */
-    truncated: boolean;
-}
-/**
- * List the knowledge bases the caller can see.
- * GET /api/v1/knowledge-base
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const listKnowledgeBases: (authToken: string) => Promise<object>;
-/**
- * Create a knowledge base (the creator becomes owner automatically). Requires the
- * global CREATE_KNOWLEDGE_BASE capability.
- * POST /api/v1/knowledge-base
- * @param {KnowledgeBaseInput} data KB metadata (at minimum `name`)
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const createKnowledgeBase: (data: KnowledgeBaseInput, authToken: string) => Promise<object>;
-/**
- * Get a single knowledge base (plus stats).
- * GET /api/v1/knowledge-base/:id
- * @param {String} id The knowledge base id
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const getKnowledgeBase: (id: string, authToken: string) => Promise<object>;
-/**
- * Update a knowledge base's metadata. Owner or editor only. Does not touch
- * `access[]`, `sources`, or `createdBy` — those have their own gated flows.
- * PUT /api/v1/knowledge-base/:id
- * @param {String} id The knowledge base id
- * @param {KnowledgeBaseInput} data The fields to update
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const updateKnowledgeBase: (id: string, data: KnowledgeBaseInput, authToken: string) => Promise<object>;
-/**
- * Delete a knowledge base (cascades to its chunks). Owner only.
- * DELETE /api/v1/knowledge-base/:id
- * @param {String} id The knowledge base id
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const deleteKnowledgeBase: (id: string, authToken: string) => Promise<object>;
-/**
- * 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 {object} source The source configuration
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const addSource: (id: string, source: object, 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 {object} source The updated source configuration
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const updateSource: (id: string, sourceId: string, source: object, 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 a knowledge base's documents (paginated, with status + lastSync). There is
- * no upload endpoint — documents are only ingested via configured sources.
- * GET /api/v1/knowledge-base/:id/documents
- * @param {String} id The knowledge base id
- * @param {DocumentListParams} params Optional pagination / status filters
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const listDocuments: (id: string, params: DocumentListParams, authToken: string) => Promise<object>;
-/**
- * Get one knowledge base document and what the RAG holds for it: its chunks,
- * after redaction, in order (the first 1000; `truncated` says when there are
- * more). No chunks while the document is not processed, or is held for review
- * or blocked. Needs the knowledge base access search needs, and the
- * document's own source permissions (403); 404 when either is missing.
- * GET /api/v1/knowledge-base/:id/documents/:docId
- * @param {String} id The knowledge base id
- * @param {String} docId The document id
- * @param {String} authToken Authentication token
- * @returns {Promise<KnowledgeBaseDocumentContent>}
- */
-export declare const getDocument: (id: string, docId: string, authToken: string) => Promise<KnowledgeBaseDocumentContent>;
-/**
- * The size a document image is asked in (`getDocumentImage`): its preview (at
- * most 1280 pixels on its longest side, WebP, or the original itself when the
- * platform could not make one) or the full picture as stored.
- */
-export type DocumentImageSize = "preview" | "full";
-/**
- * Get the picture of one image passage (chunk) of a knowledge base document,
- * for the document's page: a chunk `getDocument` answered with `hasImage`.
- * Its preview unless `size` is "full", which is the stored original (often
- * several MB: ask for it only to show the picture full size). The same access
- * as `getDocument` applies (403), and only while its chunks are shown; 404
- * when the passage has no picture to show. Answered `private, no-cache`, so
- * the platform judges access each time it is asked.
- * GET /api/v1/knowledge-base/:id/documents/:docId/chunks/:chunkId/image[?size=full]
- * @param {String} id The knowledge base id
- * @param {String} docId The document id
- * @param {String} chunkId The image chunk id
- * @param {String} authToken Authentication token
- * @param {DocumentImageSize} size Optional: "full" for the stored original;
- *   the preview otherwise
- * @returns {Promise<Blob>} The picture, typed by what it is: the preview is
- *   WebP, or the original's own type when no preview could be made; the full
- *   picture is the original's type
- */
-export declare const getDocumentImage: (id: string, docId: string, chunkId: string, authToken: string, size?: DocumentImageSize) => Promise<Blob>;
-/**
- * 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>;
-/**
- * Delete a single document (cascades to chunks + S3 images + dependent entity
- * flags).
- * DELETE /api/v1/knowledge-base/:id/documents/:docId
- * @param {String} id The knowledge base id
- * @param {String} docId The document id
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const deleteDocument: (id: string, docId: string, authToken: string) => Promise<object>;
-/**
- * List a knowledge base's access entries.
- * GET /api/v1/knowledge-base/:id/access
- * @param {String} id The knowledge base id
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const listAccess: (id: string, authToken: string) => Promise<object>;
-/**
- * Grant (upsert) an access entry. Owner only. Access is keyed by
- * `(subjectType, subjectId)`, so re-granting a subject that already has an entry
- * updates its role — there is no separate "update role" endpoint.
- * POST /api/v1/knowledge-base/:id/access
- * @param {String} id The knowledge base id
- * @param {AccessEntryInput} entry The `{ subjectType, subjectId, role }` grant
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const grantAccess: (id: string, entry: AccessEntryInput, authToken: string) => Promise<object>;
-/**
- * Revoke a subject's access. Owner only. Keyed by `(subjectType, subjectId)` — the
- * same composite key `grantAccess` upserts on. The backend refuses to remove the
- * last owner.
- * DELETE /api/v1/knowledge-base/:id/access
- * @param {String} id The knowledge base id
- * @param {String} subjectType One of `KNOWLEDGE_BASE.SUBJECT_TYPE`
- * @param {String} subjectId The subject whose access is revoked
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const revokeAccess: (id: string, subjectType: string, subjectId: string, authToken: string) => Promise<object>;
-/**
- * Read a knowledge base's redaction policy.
- * GET /api/v1/knowledge-base/:id/redaction-policy
- * @param {String} id The knowledge base id
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const getRedactionPolicy: (id: string, authToken: string) => Promise<object>;
-/**
- * Set a knowledge base's per-KB redaction behavior + DLP provider.
- * PUT /api/v1/knowledge-base/:id/redaction-policy
- * @param {String} id The knowledge base id
- * @param {object} policy The redaction policy
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const updateRedactionPolicy: (id: string, policy: object, authToken: string) => Promise<object>;
-/**
- * Read the tenant's compliance profile (admin only). Governs which RAG processors
- * a KB may route to (e.g. HIPAA tenants → BAA-eligible processors only).
- * GET /api/v1/tenants/compliance-profile
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const getComplianceProfile: (authToken: string) => Promise<object>;
-/**
- * Update the tenant's compliance profile (admin only; not exposed via the KB UI).
- * PUT /api/v1/tenants/compliance-profile
- * @param {object} profile The compliance profile
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const updateComplianceProfile: (profile: object, authToken: string) => Promise<object>;
-/**
- * Trigger a GDPR subject-purge ("right to be forgotten"; admin only).
- * POST /api/v1/compliance/right-to-be-forgotten
- * @param {object} data The subject-purge request
- * @param {String} authToken Authentication token
- * @returns {Promise<object>}
- */
-export declare const rightToBeForgotten: (data: object, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const getReviewOverview: (id: string, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const listQuarantine: (id: string, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const listReleased: (id: string, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const releaseQuarantine: (id: string, docId: string, authToken: string) => Promise<object>;
-/**
- * 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 }] }`
- */
-export declare const decideQuarantine: (id: string, decisions: Array<{
-    documentId: string;
-    decision: string;
-    reason?: string;
-}>, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const reingestQuarantine: (id: string, docId: string, data: object, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const deleteQuarantine: (id: string, docId: string, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const listGeneratedReview: (id: string, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const approveGenerated: (id: string, entityId: string, data: object, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const editApproveGenerated: (id: string, entityId: string, data: object, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const rejectGenerated: (id: string, entityId: string, data: object, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const regenerateGenerated: (id: string, entityId: string, data: object, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const listContradictions: (id: string, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const decideContradiction: (id: string, chunkId: string, data: object, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const regenerateArtifact: (notificationId: string, artifactId: string, data: object, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const retireArtifact: (notificationId: string, artifactId: string, data: object, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const dismissArtifact: (notificationId: string, artifactId: string, data: object, authToken: string) => Promise<object>;
-/**
- * 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>}
- */
-export declare const dismissAllArtifacts: (notificationId: 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>;
+export * from "./knowledgeBase/knowledgeBases.js";
+export * from "./knowledgeBase/sources.js";
+export * from "./knowledgeBase/documents.js";
+export * from "./knowledgeBase/skills.js";
+export * from "./knowledgeBase/review.js";
 //# sourceMappingURL=knowledgeBase.d.ts.map