@exulu/backend 1.37.0 → 1.39.0

package/dist/index.d.cts

@@ -83,6 +83,9 @@ type ExuluConfig = {
         s3endpoint?: string;
         s3prefix?: string;
     };
+    privacy?: {
+        systemPromptPersonalization?: boolean;
+    };
 };
 declare class ExuluApp {
     private _agents;
@@ -138,6 +141,8 @@ declare class ExuluApp {
 
 type User = {
     id: number;
+    firstname?: string;
+    lastname?: string;
     email: string;
     emailVerified?: string;
     type?: "api" | "user";
@@ -235,6 +240,13 @@ interface TestCase {
     updatedAt: string;
 }
 
+declare const VectorMethodEnum: {
+    readonly cosineDistance: "cosineDistance";
+    readonly hybridSearch: "hybridSearch";
+    readonly tsvector: "tsvector";
+};
+type VectorMethod = (typeof VectorMethodEnum)[keyof typeof VectorMethodEnum];
+
 interface RateLimiterRule {
     name?: string;
     rate_limit: {
@@ -398,6 +410,14 @@ declare class ExuluAgent {
         instructions?: string;
         outputSchema?: z.ZodType;
     }) => Promise<string | any>;
+    /**
+     * Convert file parts in messages to OpenAI Responses API compatible format.
+     * The OpenAI Responses API doesn't support inline file parts with type 'file'.
+     * This function converts:
+     * - Document files (PDF, DOCX, etc.) -> text parts with extracted content using officeparser
+     * - Image files -> image parts (which ARE supported by Responses API)
+     */
+    private processFilePartsInMessages;
     generateStream: ({ user, session, message, previousMessages, currentTools, allExuluTools, toolConfigs, providerapikey, contexts, exuluConfig, instructions, req, }: {
         user?: User;
         session?: string;
@@ -518,12 +538,12 @@ declare class ExuluTool {
 }
 type ExuluContextFieldProcessor = {
     description: string;
-    execute: ({ item, user, role, utils, config }: {
+    execute: ({ item, user, role, utils, exuluConfig }: {
         item: Item & {
             field: string;
         };
-        user: number;
-        role: string;
+        user?: number;
+        role?: string;
         utils: {
             storage: ExuluStorage;
             items: {
@@ -532,12 +552,13 @@ type ExuluContextFieldProcessor = {
                 delete: ExuluContext['deleteItem'];
             };
         };
-        config: ExuluConfig;
+        exuluConfig: ExuluConfig;
     }) => Promise<string>;
     config?: {
         queue?: Promise<ExuluQueueConfig>;
         timeoutInSeconds?: number;
-        trigger: "manual" | "onUpdate" | "onCreate" | "always";
+        trigger: "manual" | "onUpdate" | "onInsert" | "always";
+        generateEmbeddings?: boolean;
     };
 };
 type ExuluContextFieldDefinition = {
@@ -559,7 +580,7 @@ declare class ExuluStorage {
         config: ExuluConfig;
     });
     getPresignedUrl: (key: string) => Promise<string>;
-    uploadFile: (user: number, file: Buffer | Uint8Array, key: string, type: string, metadata?: Record<string, string>) => Promise<string>;
+    uploadFile: (file: Buffer | Uint8Array, key: string, type: string, user?: number, metadata?: Record<string, string>) => Promise<string>;
 }
 type ExuluContextSource = {
     id: string;
@@ -579,7 +600,10 @@ type ExuluContextSource = {
             default?: string;
         }[];
     };
-    execute: (inputs: any) => Promise<Item[]>;
+    execute: (inputs: {
+        exuluConfig: ExuluConfig;
+        [key: string]: any;
+    }) => Promise<Item[]>;
 };
 declare class ExuluContext {
     id: string;
@@ -615,14 +639,35 @@ declare class ExuluContext {
             language?: "german" | "english";
         };
     });
-    processField: (trigger: STATISTICS_LABELS, user: number, role: string, item: Item & {
+    processField: (trigger: STATISTICS_LABELS, item: Item & {
         field: string;
-    }, config: ExuluConfig) => Promise<{
+    }, exuluConfig: ExuluConfig, user?: number, role?: string) => Promise<{
         result: string;
         job?: string;
     }>;
+    search: (options: {
+        query: string;
+        filters: any[];
+        user?: User;
+        role?: string;
+        method: VectorMethod;
+        sort: any;
+        trigger: STATISTICS_LABELS;
+        limit: number;
+        page: number;
+    }) => Promise<{
+        filters: any[];
+        query: string;
+        method: VectorMethod;
+        context: {
+            name: string;
+            id: string;
+            embedder: string;
+        };
+        items: any[];
+    }>;
     deleteAll: () => Promise<VectorOperationResponse>;
-    executeSource: (source: ExuluContextSource, inputs: any) => Promise<Item[]>;
+    executeSource: (source: ExuluContextSource, inputs: any, exuluConfig: ExuluConfig) => Promise<Item[]>;
     tableExists: () => Promise<boolean>;
     chunksTableExists: () => Promise<boolean>;
     createAndUpsertEmbeddings: (item: Item, config: ExuluConfig, user?: number, statistics?: ExuluStatisticParams, role?: string, job?: string) => Promise<{
@@ -630,11 +675,11 @@ declare class ExuluContext {
         chunks?: number;
         job?: string;
     }>;
-    createItem: (item: Item, config: ExuluConfig, user?: number, role?: string, upsert?: boolean) => Promise<{
+    createItem: (item: Item, config: ExuluConfig, user?: number, role?: string, upsert?: boolean, generateEmbeddingsOverwrite?: boolean | undefined) => Promise<{
         item: Item;
         job?: string;
     }>;
-    updateItem: (item: Item, config: ExuluConfig, user?: number, role?: string) => Promise<{
+    updateItem: (item: Item, config: ExuluConfig, user?: number, role?: string, generateEmbeddingsOverwrite?: boolean | undefined) => Promise<{
         item: Item;
         job?: string;
     }>;
@@ -642,6 +687,13 @@ declare class ExuluContext {
         id: string;
         job?: string;
     }>;
+    getItem: ({ item }: {
+        item: Item;
+    }) => Promise<Item>;
+    getItems: ({ filters, fields }: {
+        filters?: any[];
+        fields?: string[];
+    }) => Promise<Item[]>;
     embeddings: {
         generate: {
             one: ({ item, user, role, trigger, config }: {

package/dist/index.d.ts

@@ -83,6 +83,9 @@ type ExuluConfig = {
         s3endpoint?: string;
         s3prefix?: string;
     };
+    privacy?: {
+        systemPromptPersonalization?: boolean;
+    };
 };
 declare class ExuluApp {
     private _agents;
@@ -138,6 +141,8 @@ declare class ExuluApp {
 
 type User = {
     id: number;
+    firstname?: string;
+    lastname?: string;
     email: string;
     emailVerified?: string;
     type?: "api" | "user";
@@ -235,6 +240,13 @@ interface TestCase {
     updatedAt: string;
 }
 
+declare const VectorMethodEnum: {
+    readonly cosineDistance: "cosineDistance";
+    readonly hybridSearch: "hybridSearch";
+    readonly tsvector: "tsvector";
+};
+type VectorMethod = (typeof VectorMethodEnum)[keyof typeof VectorMethodEnum];
+
 interface RateLimiterRule {
     name?: string;
     rate_limit: {
@@ -398,6 +410,14 @@ declare class ExuluAgent {
         instructions?: string;
         outputSchema?: z.ZodType;
     }) => Promise<string | any>;
+    /**
+     * Convert file parts in messages to OpenAI Responses API compatible format.
+     * The OpenAI Responses API doesn't support inline file parts with type 'file'.
+     * This function converts:
+     * - Document files (PDF, DOCX, etc.) -> text parts with extracted content using officeparser
+     * - Image files -> image parts (which ARE supported by Responses API)
+     */
+    private processFilePartsInMessages;
     generateStream: ({ user, session, message, previousMessages, currentTools, allExuluTools, toolConfigs, providerapikey, contexts, exuluConfig, instructions, req, }: {
         user?: User;
         session?: string;
@@ -518,12 +538,12 @@ declare class ExuluTool {
 }
 type ExuluContextFieldProcessor = {
     description: string;
-    execute: ({ item, user, role, utils, config }: {
+    execute: ({ item, user, role, utils, exuluConfig }: {
         item: Item & {
             field: string;
         };
-        user: number;
-        role: string;
+        user?: number;
+        role?: string;
         utils: {
             storage: ExuluStorage;
             items: {
@@ -532,12 +552,13 @@ type ExuluContextFieldProcessor = {
                 delete: ExuluContext['deleteItem'];
             };
         };
-        config: ExuluConfig;
+        exuluConfig: ExuluConfig;
     }) => Promise<string>;
     config?: {
         queue?: Promise<ExuluQueueConfig>;
         timeoutInSeconds?: number;
-        trigger: "manual" | "onUpdate" | "onCreate" | "always";
+        trigger: "manual" | "onUpdate" | "onInsert" | "always";
+        generateEmbeddings?: boolean;
     };
 };
 type ExuluContextFieldDefinition = {
@@ -559,7 +580,7 @@ declare class ExuluStorage {
         config: ExuluConfig;
     });
     getPresignedUrl: (key: string) => Promise<string>;
-    uploadFile: (user: number, file: Buffer | Uint8Array, key: string, type: string, metadata?: Record<string, string>) => Promise<string>;
+    uploadFile: (file: Buffer | Uint8Array, key: string, type: string, user?: number, metadata?: Record<string, string>) => Promise<string>;
 }
 type ExuluContextSource = {
     id: string;
@@ -579,7 +600,10 @@ type ExuluContextSource = {
             default?: string;
         }[];
     };
-    execute: (inputs: any) => Promise<Item[]>;
+    execute: (inputs: {
+        exuluConfig: ExuluConfig;
+        [key: string]: any;
+    }) => Promise<Item[]>;
 };
 declare class ExuluContext {
     id: string;
@@ -615,14 +639,35 @@ declare class ExuluContext {
             language?: "german" | "english";
         };
     });
-    processField: (trigger: STATISTICS_LABELS, user: number, role: string, item: Item & {
+    processField: (trigger: STATISTICS_LABELS, item: Item & {
         field: string;
-    }, config: ExuluConfig) => Promise<{
+    }, exuluConfig: ExuluConfig, user?: number, role?: string) => Promise<{
         result: string;
         job?: string;
     }>;
+    search: (options: {
+        query: string;
+        filters: any[];
+        user?: User;
+        role?: string;
+        method: VectorMethod;
+        sort: any;
+        trigger: STATISTICS_LABELS;
+        limit: number;
+        page: number;
+    }) => Promise<{
+        filters: any[];
+        query: string;
+        method: VectorMethod;
+        context: {
+            name: string;
+            id: string;
+            embedder: string;
+        };
+        items: any[];
+    }>;
     deleteAll: () => Promise<VectorOperationResponse>;
-    executeSource: (source: ExuluContextSource, inputs: any) => Promise<Item[]>;
+    executeSource: (source: ExuluContextSource, inputs: any, exuluConfig: ExuluConfig) => Promise<Item[]>;
     tableExists: () => Promise<boolean>;
     chunksTableExists: () => Promise<boolean>;
     createAndUpsertEmbeddings: (item: Item, config: ExuluConfig, user?: number, statistics?: ExuluStatisticParams, role?: string, job?: string) => Promise<{
@@ -630,11 +675,11 @@ declare class ExuluContext {
         chunks?: number;
         job?: string;
     }>;
-    createItem: (item: Item, config: ExuluConfig, user?: number, role?: string, upsert?: boolean) => Promise<{
+    createItem: (item: Item, config: ExuluConfig, user?: number, role?: string, upsert?: boolean, generateEmbeddingsOverwrite?: boolean | undefined) => Promise<{
         item: Item;
         job?: string;
     }>;
-    updateItem: (item: Item, config: ExuluConfig, user?: number, role?: string) => Promise<{
+    updateItem: (item: Item, config: ExuluConfig, user?: number, role?: string, generateEmbeddingsOverwrite?: boolean | undefined) => Promise<{
         item: Item;
         job?: string;
     }>;
@@ -642,6 +687,13 @@ declare class ExuluContext {
         id: string;
         job?: string;
     }>;
+    getItem: ({ item }: {
+        item: Item;
+    }) => Promise<Item>;
+    getItems: ({ filters, fields }: {
+        filters?: any[];
+        fields?: string[];
+    }) => Promise<Item[]>;
     embeddings: {
         generate: {
             one: ({ item, user, role, trigger, config }: {