@goscribe/server 1.6.0 → 1.7.0

package/dist/src/services/knowledge/knowledge-base.service.d.ts

@@ -0,0 +1,316 @@
+import type { PrismaClient } from '@prisma/client';
+import { BaseService } from '../base.service.js';
+interface AdminCreateInput {
+    name: string;
+    description?: string;
+    isCurated?: boolean;
+}
+interface AdminUpdateInput {
+    id: string;
+    name?: string;
+    description?: string | null;
+    isCurated?: boolean;
+}
+interface RequestUploadUrlInput {
+    knowledgeBaseId: string;
+    filename: string;
+    contentType: string;
+    size: number;
+}
+interface ProcessDocumentInput {
+    knowledgeBaseId: string;
+    documentId: string;
+}
+interface QueryInput {
+    knowledgeBaseId: string;
+    query: string;
+    topK?: number;
+    generateAnswer?: boolean;
+}
+export declare class KnowledgeBaseService extends BaseService {
+    constructor(db: PrismaClient);
+    private assertWorkspaceAccess;
+    /**
+     * Loads a knowledge base only if it's reachable to the calling user, i.e.
+     * either curated (visible in catalog) or attached to one of their accessible
+     * workspaces.
+     */
+    private loadKbForUser;
+    /** Admin-only: load by id without membership/curation checks. */
+    private loadKbAsAdmin;
+    /**
+     * KBs attached to a given workspace (the user's "library" for that
+     * workspace).
+     */
+    listForWorkspace(userId: string, workspaceId: string): Promise<{
+        attachmentId: string;
+        attachedAt: Date;
+        attachedById: string | null;
+        _count: {
+            documents: number;
+        };
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        description: string | null;
+        createdById: string | null;
+        status: import("@prisma/client").KnowledgeBaseStatus;
+        meta: import("@prisma/client/runtime/client").JsonValue | null;
+        isCurated: boolean;
+        embeddingModel: string;
+        embeddingDim: number;
+    }[]>;
+    /**
+     * Search the curated catalog. Optionally pass a workspaceId to also tag
+     * each result with whether the workspace already has it attached.
+     */
+    searchCatalog(userId: string, input: {
+        query?: string;
+        workspaceId?: string;
+        limit?: number;
+    }): Promise<{
+        attached: boolean;
+        _count: {
+            documents: number;
+        };
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        description: string | null;
+        createdById: string | null;
+        status: import("@prisma/client").KnowledgeBaseStatus;
+        meta: import("@prisma/client/runtime/client").JsonValue | null;
+        isCurated: boolean;
+        embeddingModel: string;
+        embeddingDim: number;
+    }[]>;
+    get(userId: string, id: string): Promise<{
+        documents: {
+            id: string;
+            name: string;
+            createdAt: Date;
+            updatedAt: Date;
+            size: number;
+            status: import("@prisma/client").KnowledgeBaseDocumentStatus;
+            objectKey: string | null;
+            mimeType: string;
+            bucket: string | null;
+            meta: import("@prisma/client/runtime/client").JsonValue | null;
+            knowledgeBaseId: string;
+            errorMessage: string | null;
+            numChunks: number;
+            numPages: number | null;
+        }[];
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        description: string | null;
+        createdById: string | null;
+        status: import("@prisma/client").KnowledgeBaseStatus;
+        meta: import("@prisma/client/runtime/client").JsonValue | null;
+        isCurated: boolean;
+        embeddingModel: string;
+        embeddingDim: number;
+    }>;
+    listDocuments(userId: string, knowledgeBaseId: string): Promise<{
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        size: number;
+        status: import("@prisma/client").KnowledgeBaseDocumentStatus;
+        objectKey: string | null;
+        mimeType: string;
+        bucket: string | null;
+        meta: import("@prisma/client/runtime/client").JsonValue | null;
+        knowledgeBaseId: string;
+        errorMessage: string | null;
+        numChunks: number;
+        numPages: number | null;
+    }[]>;
+    /** Attach a curated KB to one of the user's workspaces. */
+    addToWorkspace(userId: string, input: {
+        workspaceId: string;
+        knowledgeBaseId: string;
+    }): Promise<{
+        id: string;
+        createdAt: Date;
+        workspaceId: string;
+        knowledgeBaseId: string;
+        addedById: string | null;
+    }>;
+    /** Detach a KB from one of the user's workspaces. */
+    removeFromWorkspace(userId: string, input: {
+        workspaceId: string;
+        knowledgeBaseId: string;
+    }): Promise<boolean>;
+    query(userId: string, input: QueryInput): Promise<{
+        matches: {
+            chunkId: string;
+            documentId: string;
+            documentName: string;
+            chunkIndex: number;
+            content: string;
+            score: number;
+        }[];
+        answer: string | null;
+    }>;
+    private queryForKb;
+    private processDocumentForKb;
+    adminListAll(): Promise<({
+        _count: {
+            workspaces: number;
+            documents: number;
+        };
+    } & {
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        description: string | null;
+        createdById: string | null;
+        status: import("@prisma/client").KnowledgeBaseStatus;
+        meta: import("@prisma/client/runtime/client").JsonValue | null;
+        isCurated: boolean;
+        embeddingModel: string;
+        embeddingDim: number;
+    })[]>;
+    adminGet(id: string): Promise<{
+        documents: {
+            id: string;
+            name: string;
+            createdAt: Date;
+            updatedAt: Date;
+            size: number;
+            status: import("@prisma/client").KnowledgeBaseDocumentStatus;
+            objectKey: string | null;
+            mimeType: string;
+            bucket: string | null;
+            meta: import("@prisma/client/runtime/client").JsonValue | null;
+            knowledgeBaseId: string;
+            errorMessage: string | null;
+            numChunks: number;
+            numPages: number | null;
+        }[];
+        workspaces: ({
+            workspace: {
+                id: string;
+                title: string;
+                icon: string;
+            };
+        } & {
+            id: string;
+            createdAt: Date;
+            workspaceId: string;
+            knowledgeBaseId: string;
+            addedById: string | null;
+        })[];
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        description: string | null;
+        createdById: string | null;
+        status: import("@prisma/client").KnowledgeBaseStatus;
+        meta: import("@prisma/client/runtime/client").JsonValue | null;
+        isCurated: boolean;
+        embeddingModel: string;
+        embeddingDim: number;
+    }>;
+    adminListDocuments(knowledgeBaseId: string): Promise<{
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        size: number;
+        status: import("@prisma/client").KnowledgeBaseDocumentStatus;
+        objectKey: string | null;
+        mimeType: string;
+        bucket: string | null;
+        meta: import("@prisma/client/runtime/client").JsonValue | null;
+        knowledgeBaseId: string;
+        errorMessage: string | null;
+        numChunks: number;
+        numPages: number | null;
+    }[]>;
+    adminCreate(actorUserId: string, input: AdminCreateInput): Promise<{
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        description: string | null;
+        createdById: string | null;
+        status: import("@prisma/client").KnowledgeBaseStatus;
+        meta: import("@prisma/client/runtime/client").JsonValue | null;
+        isCurated: boolean;
+        embeddingModel: string;
+        embeddingDim: number;
+    }>;
+    adminUpdate(input: AdminUpdateInput): Promise<{
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        description: string | null;
+        createdById: string | null;
+        status: import("@prisma/client").KnowledgeBaseStatus;
+        meta: import("@prisma/client/runtime/client").JsonValue | null;
+        isCurated: boolean;
+        embeddingModel: string;
+        embeddingDim: number;
+    }>;
+    adminDelete(id: string): Promise<boolean>;
+    /** Admin-only: attach a KB to a workspace (curated or not). */
+    adminAttachToWorkspace(actorUserId: string, input: {
+        workspaceId: string;
+        knowledgeBaseId: string;
+    }): Promise<{
+        id: string;
+        createdAt: Date;
+        workspaceId: string;
+        knowledgeBaseId: string;
+        addedById: string | null;
+    }>;
+    adminDetachFromWorkspace(input: {
+        workspaceId: string;
+        knowledgeBaseId: string;
+    }): Promise<boolean>;
+    adminRequestUploadUrl(input: RequestUploadUrlInput): Promise<{
+        documentId: string;
+        uploadUrl: string;
+        bucket: string;
+        objectKey: string;
+    }>;
+    adminProcessDocument(input: ProcessDocumentInput): Promise<{
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        size: number;
+        status: import("@prisma/client").KnowledgeBaseDocumentStatus;
+        objectKey: string | null;
+        mimeType: string;
+        bucket: string | null;
+        meta: import("@prisma/client/runtime/client").JsonValue | null;
+        knowledgeBaseId: string;
+        errorMessage: string | null;
+        numChunks: number;
+        numPages: number | null;
+    } | null>;
+    adminDeleteDocument(documentId: string): Promise<boolean>;
+    adminQuery(input: QueryInput): Promise<{
+        matches: {
+            chunkId: string;
+            documentId: string;
+            documentName: string;
+            chunkIndex: number;
+            content: string;
+            score: number;
+        }[];
+        answer: string | null;
+    }>;
+}
+export {};