orkajs 1.0.0

package/dist/types-BOtPFeGu.d.cts

@@ -0,0 +1,31 @@
+import { Document, Chunk } from './types/index.cjs';
+
+interface TextSplitter {
+    split(text: string): string[];
+    splitDocuments(documents: Document[]): Chunk[];
+}
+interface RecursiveCharacterTextSplitterOptions {
+    chunkSize?: number;
+    chunkOverlap?: number;
+    separators?: string[];
+    keepSeparator?: boolean;
+    trimWhitespace?: boolean;
+}
+interface MarkdownTextSplitterOptions {
+    chunkSize?: number;
+    chunkOverlap?: number;
+    trimWhitespace?: boolean;
+}
+interface CodeTextSplitterOptions {
+    chunkSize?: number;
+    chunkOverlap?: number;
+    language: 'typescript' | 'javascript' | 'python' | 'java' | 'go' | 'rust' | 'cpp' | 'html' | 'css';
+    trimWhitespace?: boolean;
+}
+interface TokenTextSplitterOptions {
+    chunkSize?: number;
+    chunkOverlap?: number;
+    estimatedTokensPerChar?: number;
+}
+
+export type { CodeTextSplitterOptions as C, MarkdownTextSplitterOptions as M, RecursiveCharacterTextSplitterOptions as R, TextSplitter as T, TokenTextSplitterOptions as a };

package/dist/types-Bpr6Mq8H.d.ts

@@ -0,0 +1,60 @@
+import { VectorSearchResult, LLMAdapter } from './types/index.js';
+import { R as Retriever } from './types-BLcg9dP2.js';
+
+interface ChainResult {
+    answer: string;
+    sources?: VectorSearchResult[];
+    intermediateSteps?: IntermediateStep[];
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+        totalTokens: number;
+    };
+}
+interface IntermediateStep {
+    name: string;
+    input: string;
+    output: string;
+    latencyMs?: number;
+}
+interface RetrievalQAChainOptions {
+    llm: LLMAdapter;
+    retriever: Retriever;
+    collection: string;
+    systemPrompt?: string;
+    returnSources?: boolean;
+    maxSourceTokens?: number;
+    topK?: number;
+}
+interface ConversationalRetrievalChainOptions {
+    llm: LLMAdapter;
+    retriever: Retriever;
+    collection: string;
+    systemPrompt?: string;
+    returnSources?: boolean;
+    maxHistoryLength?: number;
+    condenseQuestionPrompt?: string;
+}
+interface ChatHistoryEntry {
+    role: 'user' | 'assistant';
+    content: string;
+}
+interface SummarizationChainOptions {
+    llm: LLMAdapter;
+    strategy: 'stuff' | 'map-reduce' | 'refine';
+    systemPrompt?: string;
+    maxChunkSize?: number;
+    combinePrompt?: string;
+    refinePrompt?: string;
+}
+interface QAChainOptions {
+    llm: LLMAdapter;
+    retriever: Retriever;
+    collection: string;
+    systemPrompt?: string;
+    returnSources?: boolean;
+    strategy?: 'stuff' | 'map-reduce' | 'refine';
+    maxSourceTokens?: number;
+}
+
+export type { ChainResult as C, IntermediateStep as I, QAChainOptions as Q, RetrievalQAChainOptions as R, SummarizationChainOptions as S, ChatHistoryEntry as a, ConversationalRetrievalChainOptions as b };

package/dist/types-C6ECq49L.d.ts

@@ -0,0 +1,37 @@
+import { Document } from './types/index.js';
+
+interface LoaderOptions {
+    metadata?: Record<string, unknown>;
+}
+interface DocumentLoader {
+    load(): Promise<Document[]>;
+}
+interface CSVLoaderOptions extends LoaderOptions {
+    separator?: string;
+    columns?: string[];
+    contentColumn?: string;
+}
+interface JSONLoaderOptions extends LoaderOptions {
+    contentField?: string;
+    metadataFields?: string[];
+    jsonPath?: string;
+}
+interface MarkdownLoaderOptions extends LoaderOptions {
+    removeFrontmatter?: boolean;
+    includeHeaders?: boolean;
+}
+interface PDFLoaderOptions extends LoaderOptions {
+    pages?: number[];
+    maxPages?: number;
+}
+interface TextLoaderOptions extends LoaderOptions {
+    encoding?: BufferEncoding;
+}
+interface DirectoryLoaderOptions extends LoaderOptions {
+    glob?: string;
+    recursive?: boolean;
+    exclude?: string[];
+    loaders?: Record<string, (path: string, options?: LoaderOptions) => DocumentLoader>;
+}
+
+export type { CSVLoaderOptions as C, DirectoryLoaderOptions as D, JSONLoaderOptions as J, LoaderOptions as L, MarkdownLoaderOptions as M, PDFLoaderOptions as P, TextLoaderOptions as T, DocumentLoader as a };

package/dist/types-CE-enj7A.d.cts

@@ -0,0 +1,47 @@
+import { VectorSearchResult, LLMAdapter, VectorDBAdapter } from './types/index.cjs';
+
+interface Retriever {
+    retrieve(query: string, collection: string): Promise<VectorSearchResult[]>;
+}
+interface MultiQueryRetrieverOptions {
+    llm: LLMAdapter;
+    vectorDB: VectorDBAdapter;
+    queryCount?: number;
+    topK?: number;
+    minScore?: number;
+    deduplicateByContent?: boolean;
+}
+interface ContextualCompressionRetrieverOptions {
+    llm: LLMAdapter;
+    vectorDB: VectorDBAdapter;
+    topK?: number;
+    minScore?: number;
+    maxCompressedLength?: number;
+}
+interface EnsembleRetrieverOptions {
+    retrievers: Retriever[];
+    weights?: number[];
+    topK?: number;
+}
+interface ParentDocumentRetrieverOptions {
+    vectorDB: VectorDBAdapter;
+    llm: LLMAdapter;
+    childTopK?: number;
+    parentTopK?: number;
+    minScore?: number;
+}
+interface SelfQueryRetrieverOptions {
+    llm: LLMAdapter;
+    vectorDB: VectorDBAdapter;
+    metadataFields: MetadataFieldInfo[];
+    topK?: number;
+    minScore?: number;
+}
+interface MetadataFieldInfo {
+    name: string;
+    type: 'string' | 'number' | 'boolean' | 'date';
+    description: string;
+    enumValues?: string[];
+}
+
+export type { ContextualCompressionRetrieverOptions as C, EnsembleRetrieverOptions as E, MetadataFieldInfo as M, ParentDocumentRetrieverOptions as P, Retriever as R, SelfQueryRetrieverOptions as S, MultiQueryRetrieverOptions as a };

package/dist/types-CJFtM2H2.d.cts

@@ -0,0 +1,36 @@
+interface CacheStore {
+    get<T = unknown>(key: string): Promise<T | undefined>;
+    set<T = unknown>(key: string, value: T, ttlMs?: number): Promise<void>;
+    delete(key: string): Promise<boolean>;
+    clear(): Promise<void>;
+    has(key: string): Promise<boolean>;
+    readonly name: string;
+}
+interface CacheOptions {
+    ttlMs?: number;
+    maxSize?: number;
+    namespace?: string;
+}
+interface LLMCacheOptions extends CacheOptions {
+    hashFn?: (prompt: string, options?: Record<string, unknown>) => string;
+}
+interface EmbeddingCacheOptions extends CacheOptions {
+    hashFn?: (text: string) => string;
+}
+interface RedisCacheOptions extends CacheOptions {
+    url: string;
+    keyPrefix?: string;
+}
+interface CacheEntry<T = unknown> {
+    value: T;
+    createdAt: number;
+    expiresAt?: number;
+}
+interface CacheStats {
+    hits: number;
+    misses: number;
+    size: number;
+    hitRate: number;
+}
+
+export type { CacheEntry as C, EmbeddingCacheOptions as E, LLMCacheOptions as L, RedisCacheOptions as R, CacheOptions as a, CacheStats as b, CacheStore as c };

package/dist/types-CJFtM2H2.d.ts

@@ -0,0 +1,36 @@
+interface CacheStore {
+    get<T = unknown>(key: string): Promise<T | undefined>;
+    set<T = unknown>(key: string, value: T, ttlMs?: number): Promise<void>;
+    delete(key: string): Promise<boolean>;
+    clear(): Promise<void>;
+    has(key: string): Promise<boolean>;
+    readonly name: string;
+}
+interface CacheOptions {
+    ttlMs?: number;
+    maxSize?: number;
+    namespace?: string;
+}
+interface LLMCacheOptions extends CacheOptions {
+    hashFn?: (prompt: string, options?: Record<string, unknown>) => string;
+}
+interface EmbeddingCacheOptions extends CacheOptions {
+    hashFn?: (text: string) => string;
+}
+interface RedisCacheOptions extends CacheOptions {
+    url: string;
+    keyPrefix?: string;
+}
+interface CacheEntry<T = unknown> {
+    value: T;
+    createdAt: number;
+    expiresAt?: number;
+}
+interface CacheStats {
+    hits: number;
+    misses: number;
+    size: number;
+    hitRate: number;
+}
+
+export type { CacheEntry as C, EmbeddingCacheOptions as E, LLMCacheOptions as L, RedisCacheOptions as R, CacheOptions as a, CacheStats as b, CacheStore as c };

package/dist/types-D1nxKbZC.d.cts

@@ -0,0 +1,60 @@
+import { VectorSearchResult, LLMAdapter } from './types/index.cjs';
+import { R as Retriever } from './types-CE-enj7A.cjs';
+
+interface ChainResult {
+    answer: string;
+    sources?: VectorSearchResult[];
+    intermediateSteps?: IntermediateStep[];
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+        totalTokens: number;
+    };
+}
+interface IntermediateStep {
+    name: string;
+    input: string;
+    output: string;
+    latencyMs?: number;
+}
+interface RetrievalQAChainOptions {
+    llm: LLMAdapter;
+    retriever: Retriever;
+    collection: string;
+    systemPrompt?: string;
+    returnSources?: boolean;
+    maxSourceTokens?: number;
+    topK?: number;
+}
+interface ConversationalRetrievalChainOptions {
+    llm: LLMAdapter;
+    retriever: Retriever;
+    collection: string;
+    systemPrompt?: string;
+    returnSources?: boolean;
+    maxHistoryLength?: number;
+    condenseQuestionPrompt?: string;
+}
+interface ChatHistoryEntry {
+    role: 'user' | 'assistant';
+    content: string;
+}
+interface SummarizationChainOptions {
+    llm: LLMAdapter;
+    strategy: 'stuff' | 'map-reduce' | 'refine';
+    systemPrompt?: string;
+    maxChunkSize?: number;
+    combinePrompt?: string;
+    refinePrompt?: string;
+}
+interface QAChainOptions {
+    llm: LLMAdapter;
+    retriever: Retriever;
+    collection: string;
+    systemPrompt?: string;
+    returnSources?: boolean;
+    strategy?: 'stuff' | 'map-reduce' | 'refine';
+    maxSourceTokens?: number;
+}
+
+export type { ChainResult as C, IntermediateStep as I, QAChainOptions as Q, RetrievalQAChainOptions as R, SummarizationChainOptions as S, ChatHistoryEntry as a, ConversationalRetrievalChainOptions as b };

package/dist/types-D_0MABWj.d.cts

@@ -0,0 +1,46 @@
+import { RetrievedContext, LLMAdapter, VectorDBAdapter } from './types/index.cjs';
+import { Knowledge } from './core/knowledge.cjs';
+
+interface WorkflowContext {
+    input: string;
+    output: string;
+    history: WorkflowStepResult[];
+    context: RetrievedContext[];
+    metadata: Record<string, unknown>;
+    llm: LLMAdapter;
+    vectorDB?: VectorDBAdapter;
+    knowledge?: Knowledge;
+}
+interface WorkflowStepResult {
+    stepName: string;
+    output: string;
+    latencyMs: number;
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+        totalTokens: number;
+    };
+    metadata?: Record<string, unknown>;
+}
+interface WorkflowStep {
+    name: string;
+    execute(ctx: WorkflowContext): Promise<WorkflowContext>;
+}
+interface WorkflowConfig {
+    name: string;
+    steps: WorkflowStep[];
+    onStepComplete?: (result: WorkflowStepResult, ctx: WorkflowContext) => void;
+    onError?: (error: Error, stepName: string, ctx: WorkflowContext) => void;
+    maxRetries?: number;
+}
+interface WorkflowResult {
+    name: string;
+    input: string;
+    output: string;
+    steps: WorkflowStepResult[];
+    totalLatencyMs: number;
+    totalTokens: number;
+    metadata: Record<string, unknown>;
+}
+
+export type { WorkflowConfig as W, WorkflowContext as a, WorkflowResult as b, WorkflowStep as c, WorkflowStepResult as d };

package/dist/types-DlK2Z6wF.d.ts

@@ -0,0 +1,31 @@
+import { Document, Chunk } from './types/index.js';
+
+interface TextSplitter {
+    split(text: string): string[];
+    splitDocuments(documents: Document[]): Chunk[];
+}
+interface RecursiveCharacterTextSplitterOptions {
+    chunkSize?: number;
+    chunkOverlap?: number;
+    separators?: string[];
+    keepSeparator?: boolean;
+    trimWhitespace?: boolean;
+}
+interface MarkdownTextSplitterOptions {
+    chunkSize?: number;
+    chunkOverlap?: number;
+    trimWhitespace?: boolean;
+}
+interface CodeTextSplitterOptions {
+    chunkSize?: number;
+    chunkOverlap?: number;
+    language: 'typescript' | 'javascript' | 'python' | 'java' | 'go' | 'rust' | 'cpp' | 'html' | 'css';
+    trimWhitespace?: boolean;
+}
+interface TokenTextSplitterOptions {
+    chunkSize?: number;
+    chunkOverlap?: number;
+    estimatedTokensPerChar?: number;
+}
+
+export type { CodeTextSplitterOptions as C, MarkdownTextSplitterOptions as M, RecursiveCharacterTextSplitterOptions as R, TextSplitter as T, TokenTextSplitterOptions as a };

package/dist/types-DsOo4p3H.d.ts

@@ -0,0 +1,52 @@
+import { RetrievedContext, LLMAdapter, VectorDBAdapter } from './types/index.js';
+import { Knowledge } from './core/knowledge.js';
+
+interface GraphContext {
+    input: string;
+    output: string;
+    nodeOutputs: Record<string, string>;
+    context: RetrievedContext[];
+    metadata: Record<string, unknown>;
+    llm: LLMAdapter;
+    vectorDB?: VectorDBAdapter;
+    knowledge?: Knowledge;
+}
+interface GraphNode {
+    id: string;
+    type: 'action' | 'condition' | 'parallel' | 'start' | 'end';
+    execute?: (ctx: GraphContext) => Promise<GraphContext>;
+    condition?: (ctx: GraphContext) => string;
+    parallelNodes?: string[];
+    metadata?: Record<string, unknown>;
+}
+interface GraphEdge {
+    from: string;
+    to: string;
+    label?: string;
+}
+interface GraphConfig {
+    name: string;
+    nodes: GraphNode[];
+    edges: GraphEdge[];
+    maxIterations?: number;
+    onNodeComplete?: (nodeId: string, ctx: GraphContext) => void;
+    onError?: (error: Error, nodeId: string) => void;
+}
+interface GraphNodeResult {
+    nodeId: string;
+    type: GraphNode['type'];
+    output: string;
+    latencyMs: number;
+    metadata?: Record<string, unknown>;
+}
+interface GraphResult {
+    name: string;
+    input: string;
+    output: string;
+    nodeResults: GraphNodeResult[];
+    path: string[];
+    totalLatencyMs: number;
+    metadata: Record<string, unknown>;
+}
+
+export type { GraphConfig as G, GraphContext as a, GraphEdge as b, GraphNode as c, GraphNodeResult as d, GraphResult as e };

package/dist/types-DxUxY78w.d.ts

@@ -0,0 +1,46 @@
+import { RetrievedContext, LLMAdapter, VectorDBAdapter } from './types/index.js';
+import { Knowledge } from './core/knowledge.js';
+
+interface WorkflowContext {
+    input: string;
+    output: string;
+    history: WorkflowStepResult[];
+    context: RetrievedContext[];
+    metadata: Record<string, unknown>;
+    llm: LLMAdapter;
+    vectorDB?: VectorDBAdapter;
+    knowledge?: Knowledge;
+}
+interface WorkflowStepResult {
+    stepName: string;
+    output: string;
+    latencyMs: number;
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+        totalTokens: number;
+    };
+    metadata?: Record<string, unknown>;
+}
+interface WorkflowStep {
+    name: string;
+    execute(ctx: WorkflowContext): Promise<WorkflowContext>;
+}
+interface WorkflowConfig {
+    name: string;
+    steps: WorkflowStep[];
+    onStepComplete?: (result: WorkflowStepResult, ctx: WorkflowContext) => void;
+    onError?: (error: Error, stepName: string, ctx: WorkflowContext) => void;
+    maxRetries?: number;
+}
+interface WorkflowResult {
+    name: string;
+    input: string;
+    output: string;
+    steps: WorkflowStepResult[];
+    totalLatencyMs: number;
+    totalTokens: number;
+    metadata: Record<string, unknown>;
+}
+
+export type { WorkflowConfig as W, WorkflowContext as a, WorkflowResult as b, WorkflowStep as c, WorkflowStepResult as d };

package/dist/types-ZpM642VC.d.cts

@@ -0,0 +1,148 @@
+import { LLMAdapter, VectorDBAdapter } from './types/index.cjs';
+import { Knowledge } from './core/knowledge.cjs';
+import { Memory } from './memory/memory.cjs';
+
+interface Tool {
+    name: string;
+    description: string;
+    parameters?: ToolParameter[];
+    execute(input: Record<string, unknown>): Promise<ToolResult>;
+}
+interface ToolParameter {
+    name: string;
+    type: 'string' | 'number' | 'boolean' | 'object';
+    description: string;
+    required?: boolean;
+}
+interface ToolResult {
+    output: string;
+    metadata?: Record<string, unknown>;
+    error?: string;
+}
+interface AgentConfig {
+    name?: string;
+    goal: string;
+    tools: Tool[];
+    policy?: AgentPolicy;
+    systemPrompt?: string;
+    maxSteps?: number;
+    temperature?: number;
+}
+interface AgentPolicy {
+    maxSteps?: number;
+    noHallucination?: boolean;
+    requireSource?: boolean;
+    rules?: string[];
+    allowedTools?: string[];
+    blockedTools?: string[];
+}
+interface AgentContext {
+    goal: string;
+    input: string;
+    steps: AgentStepResult[];
+    llm: LLMAdapter;
+    vectorDB?: VectorDBAdapter;
+    knowledge?: Knowledge;
+    memory?: Memory;
+    metadata: Record<string, unknown>;
+}
+interface AgentStepResult {
+    thought: string;
+    action: string;
+    actionInput: Record<string, unknown>;
+    observation: string;
+    latencyMs: number;
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+        totalTokens: number;
+    };
+}
+interface AgentResult {
+    input: string;
+    output: string;
+    steps: AgentStepResult[];
+    totalLatencyMs: number;
+    totalTokens: number;
+    toolsUsed: string[];
+    metadata: Record<string, unknown>;
+}
+interface ReActAgentConfig {
+    name?: string;
+    goal: string;
+    tools: Tool[];
+    policy?: AgentPolicy;
+    systemPrompt?: string;
+    maxSteps?: number;
+    temperature?: number;
+    verbose?: boolean;
+}
+interface PlanStep {
+    id: number;
+    description: string;
+    status: 'pending' | 'in_progress' | 'completed' | 'failed';
+    result?: string;
+}
+interface PlanAndExecuteAgentConfig {
+    name?: string;
+    goal: string;
+    tools: Tool[];
+    policy?: AgentPolicy;
+    systemPrompt?: string;
+    maxSteps?: number;
+    temperature?: number;
+    replanOnFailure?: boolean;
+}
+interface PlanAndExecuteResult extends AgentResult {
+    plan: PlanStep[];
+}
+interface OpenAIFunction {
+    name: string;
+    description: string;
+    parameters: {
+        type: 'object';
+        properties: Record<string, {
+            type: string;
+            description?: string;
+            enum?: string[];
+        }>;
+        required?: string[];
+    };
+}
+interface OpenAIFunctionsAgentConfig {
+    name?: string;
+    goal: string;
+    tools: Tool[];
+    functions?: OpenAIFunction[];
+    policy?: AgentPolicy;
+    systemPrompt?: string;
+    maxSteps?: number;
+    temperature?: number;
+}
+interface StructuredChatAgentConfig {
+    name?: string;
+    goal: string;
+    tools: Tool[];
+    policy?: AgentPolicy;
+    systemPrompt?: string;
+    maxSteps?: number;
+    temperature?: number;
+    outputSchema?: Record<string, unknown>;
+}
+interface AgentToolkit {
+    name: string;
+    description: string;
+    tools: Tool[];
+}
+interface SQLToolkitConfig {
+    execute: (query: string) => Promise<string>;
+    schema?: string;
+    readOnly?: boolean;
+    maxRows?: number;
+}
+interface CSVToolkitConfig {
+    data: string;
+    separator?: string;
+}
+
+export type { AgentConfig as A, CSVToolkitConfig as C, OpenAIFunction as O, PlanAndExecuteAgentConfig as P, ReActAgentConfig as R, SQLToolkitConfig as S, Tool as T, AgentContext as a, AgentPolicy as b, AgentResult as c, AgentStepResult as d, AgentToolkit as e, OpenAIFunctionsAgentConfig as f, PlanAndExecuteResult as g, PlanStep as h, StructuredChatAgentConfig as i, ToolParameter as j, ToolResult as k };

package/dist/types-hvrMBxDL.d.cts

@@ -0,0 +1,37 @@
+import { Document } from './types/index.cjs';
+
+interface LoaderOptions {
+    metadata?: Record<string, unknown>;
+}
+interface DocumentLoader {
+    load(): Promise<Document[]>;
+}
+interface CSVLoaderOptions extends LoaderOptions {
+    separator?: string;
+    columns?: string[];
+    contentColumn?: string;
+}
+interface JSONLoaderOptions extends LoaderOptions {
+    contentField?: string;
+    metadataFields?: string[];
+    jsonPath?: string;
+}
+interface MarkdownLoaderOptions extends LoaderOptions {
+    removeFrontmatter?: boolean;
+    includeHeaders?: boolean;
+}
+interface PDFLoaderOptions extends LoaderOptions {
+    pages?: number[];
+    maxPages?: number;
+}
+interface TextLoaderOptions extends LoaderOptions {
+    encoding?: BufferEncoding;
+}
+interface DirectoryLoaderOptions extends LoaderOptions {
+    glob?: string;
+    recursive?: boolean;
+    exclude?: string[];
+    loaders?: Record<string, (path: string, options?: LoaderOptions) => DocumentLoader>;
+}
+
+export type { CSVLoaderOptions as C, DirectoryLoaderOptions as D, JSONLoaderOptions as J, LoaderOptions as L, MarkdownLoaderOptions as M, PDFLoaderOptions as P, TextLoaderOptions as T, DocumentLoader as a };