@exulu/backend 0.3.12 → 1.2.0

package/dist/index.d.cts

@@ -1,8 +1,9 @@
 import * as bullmq from 'bullmq';
 import { Queue } from 'bullmq';
 import { RedisClientType } from 'redis';
+import * as ai from 'ai';
+import { Tool, LanguageModelV1, Message } from 'ai';
 import { ZodSchema, z } from 'zod';
-import { Tool, LanguageModelV1 } from 'ai';
 import { Express } from 'express';
 import { Knex } from 'knex';
 import { Tiktoken } from 'tiktoken/lite';
@@ -108,17 +109,16 @@ type ExuluAgentEval = {
 interface ExuluAgentParams {
     id: string;
     name: string;
-    type: "agent" | "workflow";
+    type: "agent" | "workflow" | "custom";
     description: string;
-    config: ExuluAgentConfig;
-    capabilities: {
+    config?: ExuluAgentConfig | undefined;
+    capabilities?: {
         tools: boolean;
         images: string[];
         files: string[];
         audio: string[];
         video: string[];
     };
-    tools?: ExuluTool[];
     evals?: ExuluAgentEval[];
     outputSchema?: ZodSchema;
     rateLimit?: RateLimiterRule;
@@ -128,24 +128,32 @@ declare class ExuluAgent {
     name: string;
     description: string;
     slug: string;
+    type: "agent" | "workflow" | "custom";
     streaming: boolean;
     rateLimit?: RateLimiterRule;
-    config: ExuluAgentConfig;
-    tools?: ExuluTool[];
+    config?: ExuluAgentConfig | undefined;
     evals?: ExuluAgentEval[];
     model?: LanguageModelV1;
     capabilities: {
-        tools: boolean;
         images: string[];
         files: string[];
         audio: string[];
         video: string[];
     };
-    constructor({ id, name, description, config, rateLimit, capabilities, tools, evals }: ExuluAgentParams);
-    generate: ({ prompt, stream }: {
-        prompt: string;
-        stream?: boolean;
-    }) => Promise<any>;
+    constructor({ id, name, description, config, rateLimit, capabilities, type, evals }: ExuluAgentParams);
+    tool: () => ExuluTool;
+    generateSync: ({ messages, prompt, tools, statistics }: {
+        messages?: Message[];
+        prompt?: string;
+        tools?: ExuluTool[];
+        statistics?: ExuluStatisticParams;
+    }) => Promise<string>;
+    generateStream: ({ messages, prompt, tools, statistics }: {
+        messages?: Message[];
+        prompt?: string;
+        tools?: ExuluTool[];
+        statistics?: ExuluStatisticParams;
+    }) => ai.StreamTextResult<Record<string, Tool>, never>;
 }
 type VectorOperationResponse = Promise<{
     count: number;
@@ -192,14 +200,8 @@ declare class ExuluEmbedder {
         vectorDimensions: number;
         maxChunkSize: number;
     });
-    generateFromQuery(query: string, statistics?: {
-        label: string;
-        trigger: string;
-    }): VectorGenerationResponse;
-    generateFromDocument(input: Item, statistics?: {
-        label: string;
-        trigger: string;
-    }): VectorGenerationResponse;
+    generateFromQuery(query: string, statistics?: ExuluStatisticParams): VectorGenerationResponse;
+    generateFromDocument(input: Item, statistics?: ExuluStatisticParams): VectorGenerationResponse;
 }
 type ExuluWorkflowStep = {
     id: string;
@@ -298,15 +300,15 @@ declare class ExuluTool {
     id: string;
     name: string;
     description: string;
-    parameters?: ZodSchema;
-    type: "context" | "function";
+    inputSchema?: ZodSchema;
+    type: "context" | "function" | "agent";
     tool: Tool;
-    constructor({ id, name, description, parameters, type, execute }: {
+    constructor({ id, name, description, inputSchema, type, execute }: {
         id: string;
         name: string;
         description: string;
-        parameters: ZodSchema;
-        type: "context" | "function";
+        inputSchema?: ZodSchema;
+        type: "context" | "function" | "agent";
         execute: (inputs: any) => Promise<any>;
     });
 }
@@ -325,7 +327,9 @@ declare class ExuluContext {
     queryRewriter?: (query: string) => Promise<string>;
     resultReranker?: (results: any[]) => Promise<any[]>;
     private _sources;
-    private configuration;
+    configuration: {
+        calculateVectors: "manual" | "onUpdate" | "onInsert" | "always";
+    };
     constructor({ id, name, description, embedder, active, rateLimit, fields, queryRewriter, resultReranker, configuration }: {
         id: string;
         name: string;
@@ -353,12 +357,11 @@ declare class ExuluContext {
         id: string;
         job?: string;
     }>;
-    getItems: ({ statistics, limit, page, name, archived, query, method }: {
-        statistics?: {
-            label: string;
-            trigger: string;
-        };
+    getItems: ({ statistics, limit, sort, order, page, name, archived, query, method }: {
+        statistics?: ExuluStatisticParams;
         page: number;
+        sort?: "created_at" | "embeddings_updated_at";
+        order?: "desc" | "asc";
         limit: number;
         name?: string;
         archived?: boolean;
@@ -441,6 +444,14 @@ type ExuluSourceUpdaterArgs = {
         example: string;
     }>;
 };
+type ExuluStatistic = {
+    name: string;
+    label: string;
+    type: STATISTICS_TYPE;
+    trigger: "tool" | "agent" | "flow" | "api" | "claude-code";
+    total: number;
+};
+type ExuluStatisticParams = Omit<ExuluStatistic, "total" | "name" | "type">;
 type ExuluSourceUpdater = ExuluSourceUpdaterArgs & {
     slug?: string;
 };
@@ -466,28 +477,24 @@ declare class ExuluApp {
     private _agents;
     private _workflows;
     private _config?;
-    private _embedders;
     private _queues;
     private _contexts?;
     private _tools;
     private _expressApp;
     constructor();
-    create: ({ contexts, embedders, agents, workflows, config, tools }: {
+    create: ({ contexts, agents, workflows, config, tools }: {
         contexts?: Record<string, ExuluContext>;
         config: ExuluConfig;
-        embedders?: ExuluEmbedder[];
         agents?: ExuluAgent[];
         workflows?: ExuluWorkflow[];
         tools?: ExuluTool[];
     }) => Promise<Express>;
     get expressApp(): Express;
-    embedder(id: string): ExuluEmbedder | undefined;
     tool(id: string): ExuluTool | undefined;
     tools(): ExuluTool[];
     context(id: string): ExuluContext | undefined;
     agent(id: string): ExuluAgent | undefined;
     workflow(id: string): ExuluWorkflow | undefined;
-    get embedders(): ExuluEmbedder[];
     get contexts(): ExuluContext[];
     get workflows(): ExuluWorkflow[];
     get agents(): ExuluAgent[];
@@ -504,6 +511,7 @@ type User = {
     email: string;
     emailVerified?: string;
     type?: "api" | "user";
+    anthropic_token?: string;
     roles?: {
         id: string;
         role: string;
@@ -1007,8 +1015,6 @@ declare class RecursiveChunker extends BaseChunker {
      *
      * @example <caption>Accessing properties and methods</caption>
      * const chunker = await RecursiveChunker.create();
-     * console.log(chunker.chunkSize); // 512
-     * console.log(chunker.rules); // RecursiveRules instance
      * const chunks = await chunker.chunk("Some text"); // Use as object method
      *
      * @note
@@ -1398,10 +1404,6 @@ declare const JOB_STATUS_ENUM: {
     stuck: string;
 };
 
-declare const _default: {
-    run: (exulu: ExuluApp) => void;
-};
-
 declare const ExuluJobs: {
     redis: typeof redisClient;
     jobs: {
@@ -1423,4 +1425,4 @@ declare const ExuluDatabase: {
     }>;
 };
 
-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, _default as ExuluCli, ExuluContext, ExuluDatabase, ExuluEmbedder, ExuluEval, type Job as ExuluJob, ExuluJobs, ExuluLogger, queues as ExuluQueues, ExuluSource, ExuluTool, ExuluWorkflow, type ExuluWorkflowStep, ExuluZodFileType };
+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, ExuluDatabase, ExuluEmbedder, ExuluEval, type Job as ExuluJob, ExuluJobs, ExuluLogger, queues as ExuluQueues, ExuluSource, ExuluTool, ExuluWorkflow, type ExuluWorkflowStep, ExuluZodFileType };

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 import * as bullmq from 'bullmq';
 import { Queue } from 'bullmq';
 import { RedisClientType } from 'redis';
+import * as ai from 'ai';
+import { Tool, LanguageModelV1, Message } from 'ai';
 import { ZodSchema, z } from 'zod';
-import { Tool, LanguageModelV1 } from 'ai';
 import { Express } from 'express';
 import { Knex } from 'knex';
 import { Tiktoken } from 'tiktoken/lite';
@@ -108,17 +109,16 @@ type ExuluAgentEval = {
 interface ExuluAgentParams {
     id: string;
     name: string;
-    type: "agent" | "workflow";
+    type: "agent" | "workflow" | "custom";
     description: string;
-    config: ExuluAgentConfig;
-    capabilities: {
+    config?: ExuluAgentConfig | undefined;
+    capabilities?: {
         tools: boolean;
         images: string[];
         files: string[];
         audio: string[];
         video: string[];
     };
-    tools?: ExuluTool[];
     evals?: ExuluAgentEval[];
     outputSchema?: ZodSchema;
     rateLimit?: RateLimiterRule;
@@ -128,24 +128,32 @@ declare class ExuluAgent {
     name: string;
     description: string;
     slug: string;
+    type: "agent" | "workflow" | "custom";
     streaming: boolean;
     rateLimit?: RateLimiterRule;
-    config: ExuluAgentConfig;
-    tools?: ExuluTool[];
+    config?: ExuluAgentConfig | undefined;
     evals?: ExuluAgentEval[];
     model?: LanguageModelV1;
     capabilities: {
-        tools: boolean;
         images: string[];
         files: string[];
         audio: string[];
         video: string[];
     };
-    constructor({ id, name, description, config, rateLimit, capabilities, tools, evals }: ExuluAgentParams);
-    generate: ({ prompt, stream }: {
-        prompt: string;
-        stream?: boolean;
-    }) => Promise<any>;
+    constructor({ id, name, description, config, rateLimit, capabilities, type, evals }: ExuluAgentParams);
+    tool: () => ExuluTool;
+    generateSync: ({ messages, prompt, tools, statistics }: {
+        messages?: Message[];
+        prompt?: string;
+        tools?: ExuluTool[];
+        statistics?: ExuluStatisticParams;
+    }) => Promise<string>;
+    generateStream: ({ messages, prompt, tools, statistics }: {
+        messages?: Message[];
+        prompt?: string;
+        tools?: ExuluTool[];
+        statistics?: ExuluStatisticParams;
+    }) => ai.StreamTextResult<Record<string, Tool>, never>;
 }
 type VectorOperationResponse = Promise<{
     count: number;
@@ -192,14 +200,8 @@ declare class ExuluEmbedder {
         vectorDimensions: number;
         maxChunkSize: number;
     });
-    generateFromQuery(query: string, statistics?: {
-        label: string;
-        trigger: string;
-    }): VectorGenerationResponse;
-    generateFromDocument(input: Item, statistics?: {
-        label: string;
-        trigger: string;
-    }): VectorGenerationResponse;
+    generateFromQuery(query: string, statistics?: ExuluStatisticParams): VectorGenerationResponse;
+    generateFromDocument(input: Item, statistics?: ExuluStatisticParams): VectorGenerationResponse;
 }
 type ExuluWorkflowStep = {
     id: string;
@@ -298,15 +300,15 @@ declare class ExuluTool {
     id: string;
     name: string;
     description: string;
-    parameters?: ZodSchema;
-    type: "context" | "function";
+    inputSchema?: ZodSchema;
+    type: "context" | "function" | "agent";
     tool: Tool;
-    constructor({ id, name, description, parameters, type, execute }: {
+    constructor({ id, name, description, inputSchema, type, execute }: {
         id: string;
         name: string;
         description: string;
-        parameters: ZodSchema;
-        type: "context" | "function";
+        inputSchema?: ZodSchema;
+        type: "context" | "function" | "agent";
         execute: (inputs: any) => Promise<any>;
     });
 }
@@ -325,7 +327,9 @@ declare class ExuluContext {
     queryRewriter?: (query: string) => Promise<string>;
     resultReranker?: (results: any[]) => Promise<any[]>;
     private _sources;
-    private configuration;
+    configuration: {
+        calculateVectors: "manual" | "onUpdate" | "onInsert" | "always";
+    };
     constructor({ id, name, description, embedder, active, rateLimit, fields, queryRewriter, resultReranker, configuration }: {
         id: string;
         name: string;
@@ -353,12 +357,11 @@ declare class ExuluContext {
         id: string;
         job?: string;
     }>;
-    getItems: ({ statistics, limit, page, name, archived, query, method }: {
-        statistics?: {
-            label: string;
-            trigger: string;
-        };
+    getItems: ({ statistics, limit, sort, order, page, name, archived, query, method }: {
+        statistics?: ExuluStatisticParams;
         page: number;
+        sort?: "created_at" | "embeddings_updated_at";
+        order?: "desc" | "asc";
         limit: number;
         name?: string;
         archived?: boolean;
@@ -441,6 +444,14 @@ type ExuluSourceUpdaterArgs = {
         example: string;
     }>;
 };
+type ExuluStatistic = {
+    name: string;
+    label: string;
+    type: STATISTICS_TYPE;
+    trigger: "tool" | "agent" | "flow" | "api" | "claude-code";
+    total: number;
+};
+type ExuluStatisticParams = Omit<ExuluStatistic, "total" | "name" | "type">;
 type ExuluSourceUpdater = ExuluSourceUpdaterArgs & {
     slug?: string;
 };
@@ -466,28 +477,24 @@ declare class ExuluApp {
     private _agents;
     private _workflows;
     private _config?;
-    private _embedders;
     private _queues;
     private _contexts?;
     private _tools;
     private _expressApp;
     constructor();
-    create: ({ contexts, embedders, agents, workflows, config, tools }: {
+    create: ({ contexts, agents, workflows, config, tools }: {
         contexts?: Record<string, ExuluContext>;
         config: ExuluConfig;
-        embedders?: ExuluEmbedder[];
         agents?: ExuluAgent[];
         workflows?: ExuluWorkflow[];
         tools?: ExuluTool[];
     }) => Promise<Express>;
     get expressApp(): Express;
-    embedder(id: string): ExuluEmbedder | undefined;
     tool(id: string): ExuluTool | undefined;
     tools(): ExuluTool[];
     context(id: string): ExuluContext | undefined;
     agent(id: string): ExuluAgent | undefined;
     workflow(id: string): ExuluWorkflow | undefined;
-    get embedders(): ExuluEmbedder[];
     get contexts(): ExuluContext[];
     get workflows(): ExuluWorkflow[];
     get agents(): ExuluAgent[];
@@ -504,6 +511,7 @@ type User = {
     email: string;
     emailVerified?: string;
     type?: "api" | "user";
+    anthropic_token?: string;
     roles?: {
         id: string;
         role: string;
@@ -1007,8 +1015,6 @@ declare class RecursiveChunker extends BaseChunker {
      *
      * @example <caption>Accessing properties and methods</caption>
      * const chunker = await RecursiveChunker.create();
-     * console.log(chunker.chunkSize); // 512
-     * console.log(chunker.rules); // RecursiveRules instance
      * const chunks = await chunker.chunk("Some text"); // Use as object method
      *
      * @note
@@ -1398,10 +1404,6 @@ declare const JOB_STATUS_ENUM: {
     stuck: string;
 };
 
-declare const _default: {
-    run: (exulu: ExuluApp) => void;
-};
-
 declare const ExuluJobs: {
     redis: typeof redisClient;
     jobs: {
@@ -1423,4 +1425,4 @@ declare const ExuluDatabase: {
     }>;
 };
 
-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, _default as ExuluCli, ExuluContext, ExuluDatabase, ExuluEmbedder, ExuluEval, type Job as ExuluJob, ExuluJobs, ExuluLogger, queues as ExuluQueues, ExuluSource, ExuluTool, ExuluWorkflow, type ExuluWorkflowStep, ExuluZodFileType };
+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, ExuluDatabase, ExuluEmbedder, ExuluEval, type Job as ExuluJob, ExuluJobs, ExuluLogger, queues as ExuluQueues, ExuluSource, ExuluTool, ExuluWorkflow, type ExuluWorkflowStep, ExuluZodFileType };