@exulu/backend 1.17.0 → 1.19.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as _opentelemetry_sdk_node from '@opentelemetry/sdk-node';
 import * as bullmq from 'bullmq';
-import { Queue, Job } from 'bullmq';
+import { Queue } from 'bullmq';
 import { RedisClientType } from 'redis';
 import { ZodSchema, z } from 'zod';
 import { Tool, LanguageModel, UIMessage } from 'ai';
@@ -37,7 +37,7 @@ interface Item {
     external_id?: string;
     source?: string;
     tags?: string[];
-    textLength?: number;
+    textlength?: number;
     chunks?: {
         id: string;
         index: number;
@@ -52,11 +52,8 @@ interface Item {
 
 declare const VectorMethodEnum: {
     readonly cosineDistance: "cosineDistance";
-    readonly l1Distance: "l1Distance";
-    readonly l2Distance: "l2Distance";
-    readonly hammingDistance: "hammingDistance";
-    readonly jaccardDistance: "jaccardDistance";
-    readonly maxInnerProduct: "maxInnerProduct";
+    readonly hybridSearch: "hybridSearch";
+    readonly tsvector: "tsvector";
 };
 type VectorMethod = (typeof VectorMethodEnum)[keyof typeof VectorMethodEnum];
 
@@ -229,13 +226,6 @@ declare class ExuluEmbedder {
     generateFromQuery(query: string, statistics?: ExuluStatisticParams, user?: string, role?: string): VectorGenerationResponse;
     generateFromDocument(input: Item, statistics?: ExuluStatisticParams, user?: string, role?: string): VectorGenerationResponse;
 }
-declare class ExuluLogger {
-    private readonly logPath?;
-    private readonly job?;
-    constructor(job?: Job, logsDir?: string);
-    write(message: string, level: "INFO" | "ERROR" | "WARNING"): Promise<void>;
-}
-type AddSourceArgs = Omit<ExuluSourceConstructorArgs, "context">;
 interface WorkflowVariable {
     name: string;
     description?: string;
@@ -347,6 +337,7 @@ type ExuluContextFieldDefinition = {
     type: ExuluFieldTypes;
     unique?: boolean;
 };
+type ExuluRightsMode = "private" | "users" | "roles" | "public" | "projects";
 declare class ExuluContext {
     id: string;
     name: string;
@@ -354,40 +345,57 @@ declare class ExuluContext {
     fields: ExuluContextFieldDefinition[];
     rateLimit?: RateLimiterRule;
     description: string;
-    embedder: ExuluEmbedder;
+    embedder?: ExuluEmbedder;
     queryRewriter?: (query: string) => Promise<string>;
     resultReranker?: (results: any[]) => Promise<any[]>;
-    private _sources;
     configuration: {
-        calculateVectors: "manual" | "onUpdate" | "onInsert" | "always";
+        calculateVectors?: "manual" | "onUpdate" | "onInsert" | "always";
+        defaultRightsMode?: ExuluRightsMode;
+        language?: "german" | "english";
     };
     constructor({ id, name, description, embedder, active, rateLimit, fields, queryRewriter, resultReranker, configuration }: {
         id: string;
         name: string;
         fields: ExuluContextFieldDefinition[];
         description: string;
-        embedder: ExuluEmbedder;
+        embedder?: ExuluEmbedder;
         active: boolean;
         rateLimit?: RateLimiterRule;
         queryRewriter?: (query: string) => Promise<string>;
         resultReranker?: (results: any[]) => Promise<any[]>;
         configuration?: {
-            calculateVectors: "manual" | "onUpdate" | "onInsert" | "always";
+            calculateVectors?: "manual" | "onUpdate" | "onInsert" | "always";
+            defaultRightsMode?: ExuluRightsMode;
+            language?: "german" | "english";
         };
     });
-    deleteOne: (id: string) => VectorOperationResponse;
-    deleteAll: () => VectorOperationResponse;
-    getTableName: () => string;
-    getChunksTableName: () => string;
+    deleteAll: () => Promise<VectorOperationResponse>;
     tableExists: () => Promise<boolean>;
-    createAndUpsertEmbeddings: (item: Item, user: string, statistics: ExuluStatisticParams, role?: string) => Promise<{
-        id: string | undefined;
-        chunks: number;
+    chunksTableExists: () => Promise<boolean>;
+    createAndUpsertEmbeddings: (item: Item, user?: string, statistics?: ExuluStatisticParams, role?: string, job?: string) => Promise<{
+        id: string;
+        chunks?: number;
+        job?: string;
     }>;
     updateItem(user: string, item: Item, role?: string, trigger?: STATISTICS_LABELS): Promise<{
         id: string;
         job?: string;
     }>;
+    embeddings: {
+        generate: {
+            one: ({ item, user, role, trigger }: {
+                item: Item;
+                user?: string;
+                role?: string;
+                trigger: STATISTICS_LABELS;
+            }) => Promise<{
+                id: string;
+                job?: string;
+                chunks?: number;
+            }>;
+            all: (context: ExuluContext, userId?: string, roleId?: string) => Promise<string[]>;
+        };
+    };
     insertItem(user: string, item: Item, upsert?: boolean, role?: string, trigger?: STATISTICS_LABELS): Promise<{
         id: string;
         job?: string;
@@ -424,7 +432,7 @@ declare class ExuluContext {
         context: {
             name: string;
             id: string;
-            embedder: string;
+            embedder: string | undefined;
         };
         items: any[];
     } | {
@@ -444,43 +452,7 @@ declare class ExuluContext {
     createItemsTable: () => Promise<void>;
     createChunksTable: () => Promise<void>;
     tool: () => ExuluTool;
-    sources: {
-        add: (inputs: AddSourceArgs) => ExuluSource;
-        get: (id?: string) => ExuluSource[] | (ExuluSource | undefined);
-    };
 }
-/**
- * @param updaters - Defines how this source decides when and which data to send to the embedder for updating vectors
- * @param updaters.type - The type of update mechanism:
- *   - "manual": Will be shown in the Exulu frontend UI via a Button for manual triggering
- *   - "cron": Will automatically update on a schedule
- *   - "webhook": Will update when triggered by an external webhook
- * @param updaters.fn - The function that handles the update logic
- * @param configuration - Defines fields shown in the UI that admins can set for each instance of the Source
- *   This allows reusing logic while exposing configurable variables (e.g. a "query" field)
- *   that admins can set differently for different instances in the UI
- */
-type ExuluSourceConstructorArgs = {
-    id: string;
-    name: string;
-    description: string;
-    updaters: ExuluSourceUpdaterArgs[];
-    context: string;
-};
-type SourceDocument = {
-    id: string;
-    content: string;
-    metadata?: Record<string, any>;
-};
-type ExuluSourceUpdaterArgs = {
-    id: string;
-    type: "manual" | "cron" | "webhook";
-    fn: (configuration: Record<string, any>) => Promise<SourceDocument[]>;
-    configuration: Record<string, {
-        type: "string" | "number" | "query";
-        example: string;
-    }>;
-};
 type STATISTICS_LABELS = "tool" | "agent" | "flow" | "api" | "claude-code" | "user";
 type ExuluStatistic = {
     name: string;
@@ -490,17 +462,6 @@ type ExuluStatistic = {
     total: number;
 };
 type ExuluStatisticParams = Omit<ExuluStatistic, "total" | "name" | "type">;
-type ExuluSourceUpdater = ExuluSourceUpdaterArgs & {
-    slug?: string;
-};
-declare class ExuluSource {
-    id: string;
-    name: string;
-    description: string;
-    updaters: ExuluSourceUpdater[];
-    context: string;
-    constructor({ id, name, description, updaters, context }: ExuluSourceConstructorArgs);
-}
 
 type ExuluConfig = {
     telemetry?: {
@@ -538,6 +499,21 @@ declare class ExuluApp {
     agent(id: string): ExuluAgent | undefined;
     get contexts(): ExuluContext[];
     get agents(): ExuluAgent[];
+    embeddings: {
+        generate: {
+            one: ({ context: contextId, item: itemId }: {
+                context: string;
+                item: string;
+            }) => Promise<{
+                id: string;
+                job?: string;
+                chunks?: number;
+            }>;
+            all: ({ context: contextId }: {
+                context: string;
+            }) => Promise<string[]>;
+        };
+    };
     bullmq: {
         workers: {
             create: () => Promise<bullmq.Worker<any, any, string>[]>;
@@ -1482,4 +1458,4 @@ declare const ExuluChunkers: {
     };
 };
 
-export { type JOB_STATUS as EXULU_JOB_STATUS, JOB_STATUS_ENUM as EXULU_JOB_STATUS_ENUM, type STATISTICS_TYPE as EXULU_STATISTICS_TYPE, STATISTICS_TYPE_ENUM as EXULU_STATISTICS_TYPE_ENUM, ExuluAgent, ExuluApp, authentication as ExuluAuthentication, ExuluChunkers, ExuluContext, ExuluEmbedder, ExuluEval, ExuluJobs, ExuluLogger, ExuluOtel, queues as ExuluQueues, ExuluSource, ExuluTool, ExuluZodFileType, db };
+export { type JOB_STATUS as EXULU_JOB_STATUS, JOB_STATUS_ENUM as EXULU_JOB_STATUS_ENUM, type STATISTICS_TYPE as EXULU_STATISTICS_TYPE, STATISTICS_TYPE_ENUM as EXULU_STATISTICS_TYPE_ENUM, ExuluAgent, ExuluApp, authentication as ExuluAuthentication, ExuluChunkers, ExuluContext, ExuluEmbedder, ExuluEval, ExuluJobs, ExuluOtel, queues as ExuluQueues, ExuluTool, ExuluZodFileType, db };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _opentelemetry_sdk_node from '@opentelemetry/sdk-node';
 import * as bullmq from 'bullmq';
-import { Queue, Job } from 'bullmq';
+import { Queue } from 'bullmq';
 import { RedisClientType } from 'redis';
 import { ZodSchema, z } from 'zod';
 import { Tool, LanguageModel, UIMessage } from 'ai';
@@ -37,7 +37,7 @@ interface Item {
     external_id?: string;
     source?: string;
     tags?: string[];
-    textLength?: number;
+    textlength?: number;
     chunks?: {
         id: string;
         index: number;
@@ -52,11 +52,8 @@ interface Item {
 
 declare const VectorMethodEnum: {
     readonly cosineDistance: "cosineDistance";
-    readonly l1Distance: "l1Distance";
-    readonly l2Distance: "l2Distance";
-    readonly hammingDistance: "hammingDistance";
-    readonly jaccardDistance: "jaccardDistance";
-    readonly maxInnerProduct: "maxInnerProduct";
+    readonly hybridSearch: "hybridSearch";
+    readonly tsvector: "tsvector";
 };
 type VectorMethod = (typeof VectorMethodEnum)[keyof typeof VectorMethodEnum];
 
@@ -229,13 +226,6 @@ declare class ExuluEmbedder {
     generateFromQuery(query: string, statistics?: ExuluStatisticParams, user?: string, role?: string): VectorGenerationResponse;
     generateFromDocument(input: Item, statistics?: ExuluStatisticParams, user?: string, role?: string): VectorGenerationResponse;
 }
-declare class ExuluLogger {
-    private readonly logPath?;
-    private readonly job?;
-    constructor(job?: Job, logsDir?: string);
-    write(message: string, level: "INFO" | "ERROR" | "WARNING"): Promise<void>;
-}
-type AddSourceArgs = Omit<ExuluSourceConstructorArgs, "context">;
 interface WorkflowVariable {
     name: string;
     description?: string;
@@ -347,6 +337,7 @@ type ExuluContextFieldDefinition = {
     type: ExuluFieldTypes;
     unique?: boolean;
 };
+type ExuluRightsMode = "private" | "users" | "roles" | "public" | "projects";
 declare class ExuluContext {
     id: string;
     name: string;
@@ -354,40 +345,57 @@ declare class ExuluContext {
     fields: ExuluContextFieldDefinition[];
     rateLimit?: RateLimiterRule;
     description: string;
-    embedder: ExuluEmbedder;
+    embedder?: ExuluEmbedder;
     queryRewriter?: (query: string) => Promise<string>;
     resultReranker?: (results: any[]) => Promise<any[]>;
-    private _sources;
     configuration: {
-        calculateVectors: "manual" | "onUpdate" | "onInsert" | "always";
+        calculateVectors?: "manual" | "onUpdate" | "onInsert" | "always";
+        defaultRightsMode?: ExuluRightsMode;
+        language?: "german" | "english";
     };
     constructor({ id, name, description, embedder, active, rateLimit, fields, queryRewriter, resultReranker, configuration }: {
         id: string;
         name: string;
         fields: ExuluContextFieldDefinition[];
         description: string;
-        embedder: ExuluEmbedder;
+        embedder?: ExuluEmbedder;
         active: boolean;
         rateLimit?: RateLimiterRule;
         queryRewriter?: (query: string) => Promise<string>;
         resultReranker?: (results: any[]) => Promise<any[]>;
         configuration?: {
-            calculateVectors: "manual" | "onUpdate" | "onInsert" | "always";
+            calculateVectors?: "manual" | "onUpdate" | "onInsert" | "always";
+            defaultRightsMode?: ExuluRightsMode;
+            language?: "german" | "english";
         };
     });
-    deleteOne: (id: string) => VectorOperationResponse;
-    deleteAll: () => VectorOperationResponse;
-    getTableName: () => string;
-    getChunksTableName: () => string;
+    deleteAll: () => Promise<VectorOperationResponse>;
     tableExists: () => Promise<boolean>;
-    createAndUpsertEmbeddings: (item: Item, user: string, statistics: ExuluStatisticParams, role?: string) => Promise<{
-        id: string | undefined;
-        chunks: number;
+    chunksTableExists: () => Promise<boolean>;
+    createAndUpsertEmbeddings: (item: Item, user?: string, statistics?: ExuluStatisticParams, role?: string, job?: string) => Promise<{
+        id: string;
+        chunks?: number;
+        job?: string;
     }>;
     updateItem(user: string, item: Item, role?: string, trigger?: STATISTICS_LABELS): Promise<{
         id: string;
         job?: string;
     }>;
+    embeddings: {
+        generate: {
+            one: ({ item, user, role, trigger }: {
+                item: Item;
+                user?: string;
+                role?: string;
+                trigger: STATISTICS_LABELS;
+            }) => Promise<{
+                id: string;
+                job?: string;
+                chunks?: number;
+            }>;
+            all: (context: ExuluContext, userId?: string, roleId?: string) => Promise<string[]>;
+        };
+    };
     insertItem(user: string, item: Item, upsert?: boolean, role?: string, trigger?: STATISTICS_LABELS): Promise<{
         id: string;
         job?: string;
@@ -424,7 +432,7 @@ declare class ExuluContext {
         context: {
             name: string;
             id: string;
-            embedder: string;
+            embedder: string | undefined;
         };
         items: any[];
     } | {
@@ -444,43 +452,7 @@ declare class ExuluContext {
     createItemsTable: () => Promise<void>;
     createChunksTable: () => Promise<void>;
     tool: () => ExuluTool;
-    sources: {
-        add: (inputs: AddSourceArgs) => ExuluSource;
-        get: (id?: string) => ExuluSource[] | (ExuluSource | undefined);
-    };
 }
-/**
- * @param updaters - Defines how this source decides when and which data to send to the embedder for updating vectors
- * @param updaters.type - The type of update mechanism:
- *   - "manual": Will be shown in the Exulu frontend UI via a Button for manual triggering
- *   - "cron": Will automatically update on a schedule
- *   - "webhook": Will update when triggered by an external webhook
- * @param updaters.fn - The function that handles the update logic
- * @param configuration - Defines fields shown in the UI that admins can set for each instance of the Source
- *   This allows reusing logic while exposing configurable variables (e.g. a "query" field)
- *   that admins can set differently for different instances in the UI
- */
-type ExuluSourceConstructorArgs = {
-    id: string;
-    name: string;
-    description: string;
-    updaters: ExuluSourceUpdaterArgs[];
-    context: string;
-};
-type SourceDocument = {
-    id: string;
-    content: string;
-    metadata?: Record<string, any>;
-};
-type ExuluSourceUpdaterArgs = {
-    id: string;
-    type: "manual" | "cron" | "webhook";
-    fn: (configuration: Record<string, any>) => Promise<SourceDocument[]>;
-    configuration: Record<string, {
-        type: "string" | "number" | "query";
-        example: string;
-    }>;
-};
 type STATISTICS_LABELS = "tool" | "agent" | "flow" | "api" | "claude-code" | "user";
 type ExuluStatistic = {
     name: string;
@@ -490,17 +462,6 @@ type ExuluStatistic = {
     total: number;
 };
 type ExuluStatisticParams = Omit<ExuluStatistic, "total" | "name" | "type">;
-type ExuluSourceUpdater = ExuluSourceUpdaterArgs & {
-    slug?: string;
-};
-declare class ExuluSource {
-    id: string;
-    name: string;
-    description: string;
-    updaters: ExuluSourceUpdater[];
-    context: string;
-    constructor({ id, name, description, updaters, context }: ExuluSourceConstructorArgs);
-}
 
 type ExuluConfig = {
     telemetry?: {
@@ -538,6 +499,21 @@ declare class ExuluApp {
     agent(id: string): ExuluAgent | undefined;
     get contexts(): ExuluContext[];
     get agents(): ExuluAgent[];
+    embeddings: {
+        generate: {
+            one: ({ context: contextId, item: itemId }: {
+                context: string;
+                item: string;
+            }) => Promise<{
+                id: string;
+                job?: string;
+                chunks?: number;
+            }>;
+            all: ({ context: contextId }: {
+                context: string;
+            }) => Promise<string[]>;
+        };
+    };
     bullmq: {
         workers: {
             create: () => Promise<bullmq.Worker<any, any, string>[]>;
@@ -1482,4 +1458,4 @@ declare const ExuluChunkers: {
     };
 };
 
-export { type JOB_STATUS as EXULU_JOB_STATUS, JOB_STATUS_ENUM as EXULU_JOB_STATUS_ENUM, type STATISTICS_TYPE as EXULU_STATISTICS_TYPE, STATISTICS_TYPE_ENUM as EXULU_STATISTICS_TYPE_ENUM, ExuluAgent, ExuluApp, authentication as ExuluAuthentication, ExuluChunkers, ExuluContext, ExuluEmbedder, ExuluEval, ExuluJobs, ExuluLogger, ExuluOtel, queues as ExuluQueues, ExuluSource, ExuluTool, ExuluZodFileType, db };
+export { type JOB_STATUS as EXULU_JOB_STATUS, JOB_STATUS_ENUM as EXULU_JOB_STATUS_ENUM, type STATISTICS_TYPE as EXULU_STATISTICS_TYPE, STATISTICS_TYPE_ENUM as EXULU_STATISTICS_TYPE_ENUM, ExuluAgent, ExuluApp, authentication as ExuluAuthentication, ExuluChunkers, ExuluContext, ExuluEmbedder, ExuluEval, ExuluJobs, ExuluOtel, queues as ExuluQueues, ExuluTool, ExuluZodFileType, db };