@brainpilot/backend-core 0.0.9 → 0.0.11

package/dist/kb-builder.d.ts

@@ -0,0 +1,120 @@
+export interface KbBuildOptions {
+    /** Per-run override of the KnowledgeBase root. Falls through to env / default. */
+    kbRoot?: string;
+    /** SiliconFlow API key for OCR; forwarded as --ocr-api-key. */
+    ocrApiKey?: string;
+    /** Per-PDF concurrency; forwarded as --ocr-concurrency. */
+    ocrConcurrency?: number;
+    /** Cap on number of PDFs (smoke testing). */
+    ocrLimit?: number;
+    /** Metadata-extraction LLM credentials (OpenAI-compatible). */
+    metaApiKey?: string;
+    metaBaseUrl?: string;
+    metaModel?: string;
+    /** Stages to skip; mutually exclusive with `only`. */
+    skip?: Array<"ocr" | "extract" | "chunk" | "vectorize">;
+    /** Stages to run (overrides skip). */
+    only?: Array<"ocr" | "extract" | "chunk" | "vectorize">;
+    /** HuggingFace mirror URL for auto model download (e.g. https://hf-mirror.com). */
+    hfMirror?: string;
+}
+export interface KbBuildEvent {
+    ts: string;
+    stage: string;
+    event: string;
+    msg: string;
+    [key: string]: unknown;
+}
+export type Listener = (ev: KbBuildEvent) => void;
+export interface StartResult {
+    ok: boolean;
+    message?: string;
+    startedAt?: number;
+}
+/**
+ * Bootstrap the KnowledgeBase Python venv via ``scripts/setup_env.py``.
+ *
+ * Owns SLOTS.envSetup. Can run concurrently with startKbModelSetup (they
+ * don't touch the same files); guarded against a second env-setup only.
+ * Build refuses to start while env-setup is running via its own check
+ * inside startKbBuild.
+ *
+ * The setup script is **pure stdlib Python**, so we deliberately do NOT
+ * resolve via the venv (which doesn't exist yet). Priority for the
+ * bootstrap interpreter:
+ *   1. ``opts.python``     — explicit override from the UI
+ *   2. ``BP_KB_PYTHON``    — env var (probably wrong here, but honour it)
+ *   3. ``python3`` / ``python`` on PATH
+ */
+export declare function startKbEnvSetup(opts?: {
+    python?: string;
+    reinstall?: boolean;
+    kbRoot?: string;
+}): StartResult;
+/**
+ * Download the bge-m3 + bge-reranker-v2-m3 weights (~2.5 GB) via
+ * ``scripts/setup_models.py``. Runs in its own SLOTS.modelSetup slot so it
+ * can execute concurrently with setup_env — the two don't touch the same
+ * files. Reuses the venv's Python if present (needed for huggingface_hub);
+ * falls back to system Python otherwise (which will fail loudly if the
+ * package isn't there, letting the operator know to run env setup first).
+ */
+export declare function startKbModelSetup(opts?: {
+    hfMirror?: string;
+    kbRoot?: string;
+}): StartResult;
+/**
+ * One-click orchestration: start venv setup, then chain model download when
+ * (and only when) the venv build exits 0. huggingface_hub lives inside the
+ * venv, so kicking off model download before it exists would fail — the
+ * chaining is required, not just a nice-to-have.
+ *
+ * Emits a synthetic ``setup-full`` info event so the frontend can display a
+ * single "combined setup" banner and know when the whole thing is done.
+ */
+export declare function startKbFullSetup(opts?: {
+    python?: string;
+    reinstall?: boolean;
+    hfMirror?: string;
+    kbRoot?: string;
+}): StartResult;
+export declare function startKbBuild(opts?: KbBuildOptions): StartResult;
+export interface KbBuildStatus {
+    active: boolean;
+    startedAt: number | null;
+    finishedAt: number | null;
+    exitCode: number | null | undefined;
+    error?: string;
+    recentEvents: KbBuildEvent[];
+    /** Diagnostic info the UI shows in the panel BEFORE a build starts. */
+    environment: KbEnvironment;
+}
+export interface KbEnvironment {
+    /** Absolute path to the python the build will use. */
+    python: string;
+    /** True if the chosen python is the bundled venv (recommended). */
+    pythonIsVenv: boolean;
+    /** Did setup_env.sh ever finish? */
+    venvExists: boolean;
+    /** Path to the bundled venv even if it doesn't exist yet (for the UI hint). */
+    expectedVenvPath: string;
+    /** True iff the four pipeline scripts + the orchestrator are all present. */
+    scriptsPresent: boolean;
+    /** Resolved KnowledgeBase root the backend will use by default. */
+    kbRoot: string;
+}
+export declare function findKbRoot(): string;
+export declare function getKbBuildStatus(): KbBuildStatus;
+export interface SubscribeHandle {
+    unsubscribe: () => void;
+    /** Replay of buffered events for late subscribers. */
+    history: KbBuildEvent[];
+    /** Resolves when every active slot finishes (or immediately if none is running). */
+    done: Promise<void>;
+}
+export declare function subscribeKbBuild(listener: Listener): SubscribeHandle;
+export declare function cancelKbBuild(): {
+    ok: boolean;
+    message?: string;
+};
+//# sourceMappingURL=kb-builder.d.ts.map

package/dist/kb-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kb-builder.d.ts","sourceRoot":"","sources":["../src/kb-builder.ts"],"names":[],"mappings":"AAuBA,MAAM,WAAW,cAAc;IAC7B,kFAAkF;IAClF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2DAA2D;IAC3D,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,CAAC,CAAC;IACxD,sCAAsC;IACtC,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,WAAW,CAAC,CAAC;IACxD,mFAAmF;IACnF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,MAAM,QAAQ,GAAG,CAAC,EAAE,EAAE,YAAY,KAAK,IAAI,CAAC;AAuJlD,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,IAAI,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,WAAW,CA2EjH;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,GAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,WAAW,CAsEhG;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GACtF,WAAW,CAsEb;AAED,wBAAgB,YAAY,CAAC,IAAI,GAAE,cAAmB,GAAG,WAAW,CAiFnE;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,YAAY,EAAE,CAAC;IAC7B,uEAAuE;IACvE,WAAW,EAAE,aAAa,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,sDAAsD;IACtD,MAAM,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,YAAY,EAAE,OAAO,CAAC;IACtB,oCAAoC;IACpC,UAAU,EAAE,OAAO,CAAC;IACpB,+EAA+E;IAC/E,gBAAgB,EAAE,MAAM,CAAC;IACzB,6EAA6E;IAC7E,cAAc,EAAE,OAAO,CAAC;IACxB,mEAAmE;IACnE,MAAM,EAAE,MAAM,CAAC;CAChB;AAqBD,wBAAgB,UAAU,IAAI,MAAM,CAWnC;AAED,wBAAgB,gBAAgB,IAAI,aAAa,CA6BhD;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,IAAI,CAAC;IACxB,sDAAsD;IACtD,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,oFAAoF;IACpF,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACrB;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,eAAe,CA4BpE;AAED,wBAAgB,aAAa,IAAI;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAoBjE"}