@elizaos/plugin-knowledge 1.6.1 → 2.0.0-alpha.1

package/dist/config.d.ts

@@ -0,0 +1,5 @@
+import type { IAgentRuntime } from "@elizaos/core";
+import { type ModelConfig, type ProviderRateLimits } from "./types.ts";
+export declare function validateModelConfig(runtime?: IAgentRuntime): ModelConfig;
+export declare function getProviderRateLimits(runtime?: IAgentRuntime): Promise<ProviderRateLimits>;
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,EAAE,KAAK,WAAW,EAAqB,KAAK,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAS1F,wBAAgB,mBAAmB,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,WAAW,CAgExE;AAgCD,wBAAsB,qBAAqB,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,kBAAkB,CAAC,CA8BhG"}

package/dist/ctx-embeddings.d.ts

@@ -0,0 +1,53 @@
+export declare const DEFAULT_CHUNK_TOKEN_SIZE = 500;
+export declare const DEFAULT_CHUNK_OVERLAP_TOKENS = 100;
+export declare const DEFAULT_CHARS_PER_TOKEN = 3.5;
+export declare const CONTEXT_TARGETS: {
+    DEFAULT: {
+        MIN_TOKENS: number;
+        MAX_TOKENS: number;
+    };
+    PDF: {
+        MIN_TOKENS: number;
+        MAX_TOKENS: number;
+    };
+    MATH_PDF: {
+        MIN_TOKENS: number;
+        MAX_TOKENS: number;
+    };
+    CODE: {
+        MIN_TOKENS: number;
+        MAX_TOKENS: number;
+    };
+    TECHNICAL: {
+        MIN_TOKENS: number;
+        MAX_TOKENS: number;
+    };
+};
+export declare const SYSTEM_PROMPT = "You are a precision text augmentation tool. Your task is to expand a given text chunk with its direct context from a larger document. You must: 1) Keep the original chunk intact; 2) Add critical context from surrounding text; 3) Never summarize or rephrase the original chunk; 4) Create contextually rich output for improved semantic retrieval.";
+export declare const SYSTEM_PROMPTS: {
+    DEFAULT: string;
+    CODE: string;
+    PDF: string;
+    MATH_PDF: string;
+    TECHNICAL: string;
+};
+export declare const CONTEXTUAL_CHUNK_ENRICHMENT_PROMPT_TEMPLATE = "\n<document>\n{doc_content}\n</document>\n\nHere is the chunk we want to situate within the whole document:\n<chunk>\n{chunk_content}\n</chunk>\n\nCreate an enriched version of this chunk by adding critical surrounding context. Follow these guidelines:\n\n1. Identify the document's main topic and key information relevant to understanding this chunk\n2. Include 2-3 sentences before the chunk that provide essential context\n3. Include 2-3 sentences after the chunk that complete thoughts or provide resolution\n4. For technical documents, include any definitions or explanations of terms used in the chunk\n5. For narrative content, include character or setting information needed to understand the chunk\n6. Keep the original chunk text COMPLETELY INTACT and UNCHANGED in your response\n7. Do not use phrases like \"this chunk discusses\" - directly present the context\n8. The total length should be between {min_tokens} and {max_tokens} tokens\n9. Format the response as a single coherent paragraph\n\nProvide ONLY the enriched chunk text in your response:";
+export declare const CACHED_CHUNK_PROMPT_TEMPLATE = "\nHere is the chunk we want to situate within the whole document:\n<chunk>\n{chunk_content}\n</chunk>\n\nCreate an enriched version of this chunk by adding critical surrounding context. Follow these guidelines:\n\n1. Identify the document's main topic and key information relevant to understanding this chunk\n2. Include 2-3 sentences before the chunk that provide essential context\n3. Include 2-3 sentences after the chunk that complete thoughts or provide resolution\n4. For technical documents, include any definitions or explanations of terms used in the chunk\n5. For narrative content, include character or setting information needed to understand the chunk\n6. Keep the original chunk text COMPLETELY INTACT and UNCHANGED in your response\n7. Do not use phrases like \"this chunk discusses\" - directly present the context\n8. The total length should be between {min_tokens} and {max_tokens} tokens\n9. Format the response as a single coherent paragraph\n\nProvide ONLY the enriched chunk text in your response:";
+export declare const CACHED_CODE_CHUNK_PROMPT_TEMPLATE = "\nHere is the chunk of code we want to situate within the whole document:\n<chunk>\n{chunk_content}\n</chunk>\n\nCreate an enriched version of this code chunk by adding critical surrounding context. Follow these guidelines:\n\n1. Preserve ALL code syntax, indentation, and comments exactly as they appear\n2. Include any import statements, function definitions, or class declarations that this code depends on\n3. Add necessary type definitions or interfaces that are referenced in this chunk\n4. Include any crucial comments from elsewhere in the document that explain this code\n5. If there are key variable declarations or initializations earlier in the document, include those\n6. Keep the original chunk COMPLETELY INTACT and UNCHANGED in your response\n7. The total length should be between {min_tokens} and {max_tokens} tokens\n8. Do NOT include implementation details for functions that are only called but not defined in this chunk\n\nProvide ONLY the enriched code chunk in your response:";
+export declare const CACHED_MATH_PDF_PROMPT_TEMPLATE = "\nHere is the chunk we want to situate within the whole document:\n<chunk>\n{chunk_content}\n</chunk>\n\nCreate an enriched version of this chunk by adding critical surrounding context. This document contains mathematical content that requires special handling. Follow these guidelines:\n\n1. Preserve ALL mathematical notation exactly as it appears in the chunk\n2. Include any defining equations, variables, or parameters mentioned earlier in the document that relate to this chunk\n3. Add section/subsection names or figure references if they help situate the chunk\n4. If variables or symbols are defined elsewhere in the document, include these definitions\n5. If mathematical expressions appear corrupted, try to infer their meaning from context\n6. Keep the original chunk text COMPLETELY INTACT and UNCHANGED in your response\n7. The total length should be between {min_tokens} and {max_tokens} tokens\n8. Format the response as a coherent mathematical explanation\n\nProvide ONLY the enriched chunk text in your response:";
+export declare const CACHED_TECHNICAL_PROMPT_TEMPLATE = "\nHere is the chunk we want to situate within the whole document:\n<chunk>\n{chunk_content}\n</chunk>\n\nCreate an enriched version of this chunk by adding critical surrounding context. This appears to be technical documentation that requires special handling. Follow these guidelines:\n\n1. Preserve ALL technical terminology, product names, and version numbers exactly as they appear\n2. Include any prerequisite information or requirements mentioned earlier in the document\n3. Add section/subsection headings or navigation path to situate this chunk within the document structure\n4. Include any definitions of technical terms, acronyms, or jargon used in this chunk\n5. If this chunk references specific configurations, include relevant parameter explanations\n6. Keep the original chunk text COMPLETELY INTACT and UNCHANGED in your response\n7. The total length should be between {min_tokens} and {max_tokens} tokens\n8. Format the response maintaining any hierarchical structure present in the original\n\nProvide ONLY the enriched chunk text in your response:";
+export declare const MATH_PDF_PROMPT_TEMPLATE = "\n<document>\n{doc_content}\n</document>\n\nHere is the chunk we want to situate within the whole document:\n<chunk>\n{chunk_content}\n</chunk>\n\nCreate an enriched version of this chunk by adding critical surrounding context. This document contains mathematical content that requires special handling. Follow these guidelines:\n\n1. Preserve ALL mathematical notation exactly as it appears in the chunk\n2. Include any defining equations, variables, or parameters mentioned earlier in the document that relate to this chunk\n3. Add section/subsection names or figure references if they help situate the chunk\n4. If variables or symbols are defined elsewhere in the document, include these definitions\n5. If mathematical expressions appear corrupted, try to infer their meaning from context\n6. Keep the original chunk text COMPLETELY INTACT and UNCHANGED in your response\n7. The total length should be between {min_tokens} and {max_tokens} tokens\n8. Format the response as a coherent mathematical explanation\n\nProvide ONLY the enriched chunk text in your response:";
+export declare const CODE_PROMPT_TEMPLATE = "\n<document>\n{doc_content}\n</document>\n\nHere is the chunk of code we want to situate within the whole document:\n<chunk>\n{chunk_content}\n</chunk>\n\nCreate an enriched version of this code chunk by adding critical surrounding context. Follow these guidelines:\n\n1. Preserve ALL code syntax, indentation, and comments exactly as they appear\n2. Include any import statements, function definitions, or class declarations that this code depends on\n3. Add necessary type definitions or interfaces that are referenced in this chunk\n4. Include any crucial comments from elsewhere in the document that explain this code\n5. If there are key variable declarations or initializations earlier in the document, include those\n6. Keep the original chunk COMPLETELY INTACT and UNCHANGED in your response\n7. The total length should be between {min_tokens} and {max_tokens} tokens\n8. Do NOT include implementation details for functions that are only called but not defined in this chunk\n\nProvide ONLY the enriched code chunk in your response:";
+export declare const TECHNICAL_PROMPT_TEMPLATE = "\n<document>\n{doc_content}\n</document>\n\nHere is the chunk we want to situate within the whole document:\n<chunk>\n{chunk_content}\n</chunk>\n\nCreate an enriched version of this chunk by adding critical surrounding context. This appears to be technical documentation that requires special handling. Follow these guidelines:\n\n1. Preserve ALL technical terminology, product names, and version numbers exactly as they appear\n2. Include any prerequisite information or requirements mentioned earlier in the document\n3. Add section/subsection headings or navigation path to situate this chunk within the document structure\n4. Include any definitions of technical terms, acronyms, or jargon used in this chunk\n5. If this chunk references specific configurations, include relevant parameter explanations\n6. Keep the original chunk text COMPLETELY INTACT and UNCHANGED in your response\n7. The total length should be between {min_tokens} and {max_tokens} tokens\n8. Format the response maintaining any hierarchical structure present in the original\n\nProvide ONLY the enriched chunk text in your response:";
+export declare function getContextualizationPrompt(docContent: string, chunkContent: string, minTokens?: number, maxTokens?: number, promptTemplate?: string): string;
+export declare function getCachingContextualizationPrompt(chunkContent: string, contentType?: string, minTokens?: number, maxTokens?: number): {
+    prompt: string;
+    systemPrompt: string;
+};
+export declare function getPromptForMimeType(mimeType: string, docContent: string, chunkContent: string): string;
+export declare function getCachingPromptForMimeType(mimeType: string, chunkContent: string): {
+    prompt: string;
+    systemPrompt: string;
+};
+export declare function getChunkWithContext(chunkContent: string, generatedContext: string): string;
+//# sourceMappingURL=ctx-embeddings.d.ts.map

package/dist/ctx-embeddings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctx-embeddings.d.ts","sourceRoot":"","sources":["../ctx-embeddings.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAC5C,eAAO,MAAM,4BAA4B,MAAM,CAAC;AAChD,eAAO,MAAM,uBAAuB,MAAM,CAAC;AAE3C,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;CAqB3B,CAAC;AAEF,eAAO,MAAM,aAAa,6VACkU,CAAC;AAE7V,eAAO,MAAM,cAAc;;;;;;CAa1B,CAAC;AAEF,eAAO,MAAM,2CAA2C,0iCAsBD,CAAC;AAExD,eAAO,MAAM,4BAA4B,ggCAkBc,CAAC;AAExD,eAAO,MAAM,iCAAiC,2+BAiBS,CAAC;AAExD,eAAO,MAAM,+BAA+B,2gCAiBW,CAAC;AAExD,eAAO,MAAM,gCAAgC,gjCAiBU,CAAC;AAExD,eAAO,MAAM,wBAAwB,qjCAqBkB,CAAC;AAExD,eAAO,MAAM,oBAAoB,qhCAqBsB,CAAC;AAExD,eAAO,MAAM,yBAAyB,0lCAqBiB,CAAC;AAExD,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,SAAS,SAAqC,EAC9C,SAAS,SAAqC,EAC9C,cAAc,SAA8C,GAC3D,MAAM,CAiBR;AAED,wBAAgB,iCAAiC,CAC/C,YAAY,EAAE,MAAM,EACpB,WAAW,CAAC,EAAE,MAAM,EACpB,SAAS,SAAqC,EAC9C,SAAS,SAAqC,GAC7C;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CAsD1C;AAED,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,GACnB,MAAM,CAoCR;AAED,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,GACnB;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CA+B1C;AA0FD,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAK1F"}

package/dist/docs-loader.d.ts

@@ -0,0 +1,9 @@
+import { type UUID } from "@elizaos/core";
+import type { KnowledgeService } from "./service.ts";
+export declare function getKnowledgePath(runtimePath?: string): string;
+export declare function loadDocsFromPath(service: KnowledgeService, agentId: UUID, worldId?: UUID, knowledgePath?: string): Promise<{
+    total: number;
+    successful: number;
+    failed: number;
+}>;
+//# sourceMappingURL=docs-loader.d.ts.map

package/dist/docs-loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-loader.d.ts","sourceRoot":"","sources":["../docs-loader.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,KAAK,IAAI,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAIrD,wBAAgB,gBAAgB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAmB7D;AAED,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,IAAI,EACb,OAAO,CAAC,EAAE,IAAI,EACd,aAAa,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAwEhE"}

package/dist/document-processor.d.ts

@@ -0,0 +1,26 @@
+import type { Buffer } from "node:buffer";
+import { type IAgentRuntime, type Memory, type UUID } from "@elizaos/core";
+export declare function processFragmentsSynchronously({ runtime, documentId, fullDocumentText, agentId, contentType, roomId, entityId, worldId, documentTitle, }: {
+    runtime: IAgentRuntime;
+    documentId: UUID;
+    fullDocumentText: string;
+    agentId: UUID;
+    contentType?: string;
+    roomId?: UUID;
+    entityId?: UUID;
+    worldId?: UUID;
+    documentTitle?: string;
+}): Promise<number>;
+export declare function extractTextFromDocument(fileBuffer: Buffer, contentType: string, originalFilename: string): Promise<string>;
+export declare function createDocumentMemory({ text, agentId, clientDocumentId, originalFilename, contentType, worldId, fileSize, documentId, customMetadata, }: {
+    text: string;
+    agentId: UUID;
+    clientDocumentId: UUID;
+    originalFilename: string;
+    contentType: string;
+    worldId: UUID;
+    fileSize: number;
+    documentId?: UUID;
+    customMetadata?: Record<string, unknown>;
+}): Memory;
+//# sourceMappingURL=document-processor.d.ts.map

package/dist/document-processor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-processor.d.ts","sourceRoot":"","sources":["../document-processor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAEL,KAAK,aAAa,EAElB,KAAK,MAAM,EAIX,KAAK,IAAI,EACV,MAAM,eAAe,CAAC;AA8DvB,wBAAsB,6BAA6B,CAAC,EAClD,OAAO,EACP,UAAU,EACV,gBAAgB,EAChB,OAAO,EACP,WAAW,EACX,MAAM,EACN,QAAQ,EACR,OAAO,EACP,aAAa,GACd,EAAE;IACD,OAAO,EAAE,aAAa,CAAC;IACvB,UAAU,EAAE,IAAI,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,IAAI,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,GAAG,OAAO,CAAC,MAAM,CAAC,CA6ClB;AAED,wBAAsB,uBAAuB,CAC3C,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,MAAM,CAAC,CA6BjB;AAED,wBAAgB,oBAAoB,CAAC,EACnC,IAAI,EACJ,OAAO,EACP,gBAAgB,EAChB,gBAAgB,EAChB,WAAW,EACX,OAAO,EACP,QAAQ,EACR,UAAU,EACV,cAAc,GACf,EAAE;IACD,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,IAAI,CAAC;IACd,gBAAgB,EAAE,IAAI,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,IAAI,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC1C,GAAG,MAAM,CAyBT"}

package/dist/documents-provider.d.ts

@@ -0,0 +1,3 @@
+import type { Provider } from "@elizaos/core";
+export declare const documentsProvider: Provider;
+//# sourceMappingURL=documents-provider.d.ts.map

package/dist/documents-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documents-provider.d.ts","sourceRoot":"","sources":["../documents-provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAiB,QAAQ,EAAE,MAAM,eAAe,CAAC;AAK7D,eAAO,MAAM,iBAAiB,EAAE,QAqH/B,CAAC"}

package/dist/index.browser.d.ts

@@ -0,0 +1,5 @@
+export { documentsProvider } from "./documents-provider";
+export type { KnowledgePluginConfig } from "./index";
+export { knowledgeProvider } from "./provider";
+export * from "./types";
+//# sourceMappingURL=index.browser.d.ts.map

package/dist/index.browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.d.ts","sourceRoot":"","sources":["../index.browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,YAAY,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,cAAc,SAAS,CAAC"}

package/dist/index.d.ts

@@ -1,429 +1,17 @@
-import { UUID, Service, Metadata, IAgentRuntime, Memory, KnowledgeItem, Provider, Plugin } from '@elizaos/core';
-import z from 'zod';
-
-declare const ModelConfigSchema: z.ZodObject<{
-    EMBEDDING_PROVIDER: z.ZodOptional<z.ZodEnum<["openai", "google"]>>;
-    TEXT_PROVIDER: z.ZodOptional<z.ZodEnum<["openai", "anthropic", "openrouter", "google"]>>;
-    OPENAI_API_KEY: z.ZodOptional<z.ZodString>;
-    ANTHROPIC_API_KEY: z.ZodOptional<z.ZodString>;
-    OPENROUTER_API_KEY: z.ZodOptional<z.ZodString>;
-    GOOGLE_API_KEY: z.ZodOptional<z.ZodString>;
-    OPENAI_BASE_URL: z.ZodOptional<z.ZodString>;
-    ANTHROPIC_BASE_URL: z.ZodOptional<z.ZodString>;
-    OPENROUTER_BASE_URL: z.ZodOptional<z.ZodString>;
-    GOOGLE_BASE_URL: z.ZodOptional<z.ZodString>;
-    TEXT_EMBEDDING_MODEL: z.ZodString;
-    TEXT_MODEL: z.ZodOptional<z.ZodString>;
-    MAX_INPUT_TOKENS: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>;
-    MAX_OUTPUT_TOKENS: z.ZodEffects<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>, number, string | number | undefined>;
-    EMBEDDING_DIMENSION: z.ZodEffects<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>, number, string | number | undefined>;
-    LOAD_DOCS_ON_STARTUP: z.ZodDefault<z.ZodBoolean>;
-    CTX_KNOWLEDGE_ENABLED: z.ZodDefault<z.ZodBoolean>;
-    RATE_LIMIT_ENABLED: z.ZodDefault<z.ZodBoolean>;
-    MAX_CONCURRENT_REQUESTS: z.ZodEffects<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>, number, string | number | undefined>;
-    REQUESTS_PER_MINUTE: z.ZodEffects<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>, number, string | number | undefined>;
-    TOKENS_PER_MINUTE: z.ZodEffects<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>, number, string | number | undefined>;
-    BATCH_DELAY_MS: z.ZodEffects<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>, number, string | number | undefined>;
-}, "strip", z.ZodTypeAny, {
-    TEXT_EMBEDDING_MODEL: string;
-    MAX_INPUT_TOKENS: number;
-    MAX_OUTPUT_TOKENS: number;
-    EMBEDDING_DIMENSION: number;
-    LOAD_DOCS_ON_STARTUP: boolean;
-    CTX_KNOWLEDGE_ENABLED: boolean;
-    RATE_LIMIT_ENABLED: boolean;
-    MAX_CONCURRENT_REQUESTS: number;
-    REQUESTS_PER_MINUTE: number;
-    TOKENS_PER_MINUTE: number;
-    BATCH_DELAY_MS: number;
-    EMBEDDING_PROVIDER?: "openai" | "google" | undefined;
-    TEXT_PROVIDER?: "openai" | "google" | "anthropic" | "openrouter" | undefined;
-    OPENAI_API_KEY?: string | undefined;
-    ANTHROPIC_API_KEY?: string | undefined;
-    OPENROUTER_API_KEY?: string | undefined;
-    GOOGLE_API_KEY?: string | undefined;
-    OPENAI_BASE_URL?: string | undefined;
-    ANTHROPIC_BASE_URL?: string | undefined;
-    OPENROUTER_BASE_URL?: string | undefined;
-    GOOGLE_BASE_URL?: string | undefined;
-    TEXT_MODEL?: string | undefined;
-}, {
-    TEXT_EMBEDDING_MODEL: string;
-    MAX_INPUT_TOKENS: string | number;
-    EMBEDDING_PROVIDER?: "openai" | "google" | undefined;
-    TEXT_PROVIDER?: "openai" | "google" | "anthropic" | "openrouter" | undefined;
-    OPENAI_API_KEY?: string | undefined;
-    ANTHROPIC_API_KEY?: string | undefined;
-    OPENROUTER_API_KEY?: string | undefined;
-    GOOGLE_API_KEY?: string | undefined;
-    OPENAI_BASE_URL?: string | undefined;
-    ANTHROPIC_BASE_URL?: string | undefined;
-    OPENROUTER_BASE_URL?: string | undefined;
-    GOOGLE_BASE_URL?: string | undefined;
-    TEXT_MODEL?: string | undefined;
-    MAX_OUTPUT_TOKENS?: string | number | undefined;
-    EMBEDDING_DIMENSION?: string | number | undefined;
-    LOAD_DOCS_ON_STARTUP?: boolean | undefined;
-    CTX_KNOWLEDGE_ENABLED?: boolean | undefined;
-    RATE_LIMIT_ENABLED?: boolean | undefined;
-    MAX_CONCURRENT_REQUESTS?: string | number | undefined;
-    REQUESTS_PER_MINUTE?: string | number | undefined;
-    TOKENS_PER_MINUTE?: string | number | undefined;
-    BATCH_DELAY_MS?: string | number | undefined;
-}>;
-type ModelConfig = z.infer<typeof ModelConfigSchema>;
-/**
- * Interface for provider rate limits
- */
-interface ProviderRateLimits {
-    maxConcurrentRequests: number;
-    requestsPerMinute: number;
-    tokensPerMinute?: number;
-    provider: string;
-    rateLimitEnabled: boolean;
-    batchDelayMs: number;
-}
-/**
- * Options for text generation overrides
- */
-interface TextGenerationOptions {
-    provider?: 'anthropic' | 'openai' | 'openrouter' | 'google';
-    modelName?: string;
-    maxTokens?: number;
-    /**
-     * Document to cache for contextual retrieval.
-     * When provided (along with an Anthropic model via OpenRouter), this enables prompt caching.
-     * The document is cached with the provider and subsequent requests will reuse the cached document,
-     * significantly reducing costs for multiple operations on the same document.
-     * Most effective with contextual retrieval for Knowledge applications.
-     */
-    cacheDocument?: string;
-    /**
-     * Options for controlling the cache behavior.
-     * Currently supports { type: 'ephemeral' } which sets up a temporary cache.
-     * Cache expires after approximately 5 minutes with Anthropic models.
-     * This can reduce costs by up to 90% for reads after the initial cache write.
-     */
-    cacheOptions?: {
-        type: 'ephemeral';
-    };
-    /**
-     * Whether to automatically detect and enable caching for contextual retrieval.
-     * Default is true for OpenRouter+Anthropic models with document-chunk prompts.
-     * Set to false to disable automatic caching detection.
-     */
-    autoCacheContextualRetrieval?: boolean;
-}
-/**
- * Options for adding knowledge to the system
- */
-interface AddKnowledgeOptions {
-    /** Agent ID from the frontend - if not provided, will use runtime.agentId */
-    agentId?: UUID;
-    worldId: UUID;
-    roomId: UUID;
-    entityId: UUID;
-    /** Client-provided document ID */
-    clientDocumentId: UUID;
-    /** MIME type of the file */
-    contentType: string;
-    /** Original filename */
-    originalFilename: string;
-    /**
-     * Content of the document. Should be:
-     * - Base64 encoded string for binary files (PDFs, DOCXs, etc)
-     * - Plain text for text files
-     */
-    content: string;
-    /**
-     * Optional metadata to associate with the knowledge
-     * Used for storing additional information like source URL
-     */
-    metadata?: Record<string, unknown>;
-}
-declare module '@elizaos/core' {
-    interface ServiceTypeRegistry {
-        KNOWLEDGE: 'knowledge';
-    }
-}
-declare const KnowledgeServiceType: {
-    KNOWLEDGE: "knowledge";
-};
-interface KnowledgeDocumentMetadata extends Record<string, any> {
-    type: string;
-    source: string;
-    title?: string;
-    filename?: string;
-    fileExt?: string;
-    fileType?: string;
-    fileSize?: number;
-}
-interface KnowledgeConfig {
-    CTX_KNOWLEDGE_ENABLED: boolean;
-    LOAD_DOCS_ON_STARTUP: boolean;
-    MAX_INPUT_TOKENS?: string | number;
-    MAX_OUTPUT_TOKENS?: string | number;
-    EMBEDDING_PROVIDER?: string;
-    TEXT_PROVIDER?: string;
-    TEXT_EMBEDDING_MODEL?: string;
-    RATE_LIMIT_ENABLED?: boolean;
-    MAX_CONCURRENT_REQUESTS?: number;
-    REQUESTS_PER_MINUTE?: number;
-    TOKENS_PER_MINUTE?: number;
-    BATCH_DELAY_MS?: number;
-}
-interface LoadResult {
-    successful: number;
-    failed: number;
-    errors?: Array<{
-        filename: string;
-        error: string;
-    }>;
-}
-/**
- * Extends the base MemoryMetadata from @elizaos/core with additional fields
- */
-interface ExtendedMemoryMetadata extends Record<string, any> {
-    type?: string;
-    title?: string;
-    filename?: string;
-    path?: string;
-    description?: string;
-    fileExt?: string;
-    timestamp?: number;
-    contentType?: string;
-    documentId?: string;
-    source?: string;
-    fileType?: string;
-    fileSize?: number;
-    position?: number;
-    originalFilename?: string;
-    url?: string;
-}
-
-/**
- * Knowledge Service - Provides retrieval augmented generation capabilities
- */
-declare class KnowledgeService extends Service {
-    static readonly serviceType = "knowledge";
-    config: Metadata;
-    private knowledgeConfig;
-    capabilityDescription: string;
-    private knowledgeProcessingSemaphore;
-    /**
-     * Create a new Knowledge service
-     * @param runtime Agent runtime
-     */
-    constructor(runtime: IAgentRuntime, config?: Partial<KnowledgeConfig>);
-    private loadInitialDocuments;
-    /**
-     * Start the Knowledge service
-     * @param runtime Agent runtime
-     * @returns Initialized Knowledge service
-     */
-    static start(runtime: IAgentRuntime): Promise<KnowledgeService>;
-    /**
-     * Stop the Knowledge service
-     * @param runtime Agent runtime
-     */
-    static stop(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Stop the service
-     */
-    stop(): Promise<void>;
-    /**
-     * Add knowledge to the system
-     * @param options Knowledge options
-     * @returns Promise with document processing result
-     */
-    addKnowledge(options: AddKnowledgeOptions): Promise<{
-        clientDocumentId: string;
-        storedDocumentMemoryId: UUID;
-        fragmentCount: number;
-    }>;
-    /**
-     * Process a document regardless of type - Called by public addKnowledge
-     * @param options Document options
-     * @returns Promise with document processing result
-     */
-    private processDocument;
-    private handleProcessingError;
-    checkExistingKnowledge(knowledgeId: UUID): Promise<boolean>;
-    getKnowledge(message: Memory, scope?: {
-        roomId?: UUID;
-        worldId?: UUID;
-        entityId?: UUID;
-    }): Promise<KnowledgeItem[]>;
-    /**
-     * Enrich a conversation memory with RAG metadata
-     * This can be called after response generation to add RAG tracking data
-     * @param memoryId The ID of the conversation memory to enrich
-     * @param ragMetadata The RAG metadata to add
-     */
-    enrichConversationMemoryWithRAG(memoryId: UUID, ragMetadata: {
-        retrievedFragments: Array<{
-            fragmentId: UUID;
-            documentTitle: string;
-            similarityScore?: number;
-            contentPreview: string;
-        }>;
-        queryText: string;
-        totalFragments: number;
-        retrievalTimestamp: number;
-    }): Promise<void>;
-    /**
-     * Set the current response memory ID for RAG tracking
-     * This is called by the knowledge provider to track which response memory to enrich
-     */
-    private pendingRAGEnrichment;
-    /**
-     * Store RAG metadata for the next conversation memory that gets created
-     * @param ragMetadata The RAG metadata to associate with the next memory
-     */
-    setPendingRAGMetadata(ragMetadata: any): void;
-    /**
-     * Try to enrich recent conversation memories with pending RAG metadata
-     * This is called periodically to catch memories that were created after RAG retrieval
-     */
-    enrichRecentMemoriesWithPendingRAG(): Promise<void>;
-    processCharacterKnowledge(items: string[]): Promise<void>;
-    _internalAddKnowledge(item: KnowledgeItem, // item.id here is expected to be the ID of the "document"
-    options?: {
-        targetTokens: number;
-        overlap: number;
-        modelContextSize: number;
-    }, scope?: {
-        roomId: `${string}-${string}-${string}-${string}-${string}`;
-        entityId: `${string}-${string}-${string}-${string}-${string}`;
-        worldId: `${string}-${string}-${string}-${string}-${string}`;
-    }): Promise<void>;
-    private processDocumentFragment;
-    private splitAndCreateFragments;
-    /**
-     * Retrieves memories, typically documents, for the agent.
-     * Corresponds to GET /plugins/knowledge/documents
-     */
-    getMemories(params: {
-        tableName: string;
-        roomId?: UUID;
-        count?: number;
-        offset?: number;
-        end?: number;
-    }): Promise<Memory[]>;
-    /**
-     * Counts memories for pagination.
-     * Corresponds to counting documents or fragments.
-     */
-    countMemories(params: {
-        tableName: string;
-        roomId?: UUID;
-        unique?: boolean;
-    }): Promise<number>;
-    /**
-     * Deletes a specific memory item (knowledge document) by its ID.
-     * Corresponds to DELETE /plugins/knowledge/documents/:knowledgeId
-     * Assumes the memoryId corresponds to an item in the 'documents' table or that
-     * runtime.deleteMemory can correctly identify it.
-     */
-    deleteMemory(memoryId: UUID): Promise<void>;
-}
-
-/**
- * Represents a knowledge provider that retrieves knowledge from the knowledge base.
- * @type {Provider}
- * @property {string} name - The name of the knowledge provider.
- * @property {string} description - The description of the knowledge provider.
- * @property {boolean} dynamic - Indicates if the knowledge provider is dynamic or static.
- * @property {Function} get - Asynchronously retrieves knowledge from the knowledge base.
- * @param {IAgentRuntime} runtime - The agent runtime object.
- * @param {Memory} message - The message containing the query for knowledge retrieval.
- * @returns {Object} An object containing the retrieved knowledge data, values, and text.
- */
-declare const knowledgeProvider: Provider;
-
-/**
- * Represents a static provider that lists available documents in the knowledge base.
- * This provider helps the agent understand which documents are available for retrieval.
- * @type {Provider}
- * @property {string} name - The name of the documents provider.
- * @property {string} description - The description of the documents provider.
- * @property {boolean} dynamic - Indicates if the provider is static (false).
- * @property {Function} get - Asynchronously retrieves the list of available documents.
- * @param {IAgentRuntime} runtime - The agent runtime object.
- * @returns {Object} An object containing the available documents list.
- */
-declare const documentsProvider: Provider;
-
-/**
- * Knowledge Plugin - Main Entry Point
- *
- * This file exports all the necessary functions and types for the Knowledge plugin.
- */
-
-/**
- * Configuration options for the Knowledge Plugin
- */
-interface KnowledgePluginConfig {
-    /**
-     * Enable frontend UI and routes
-     * Set to false for cloud/server-only deployments
-     * @default true
-     */
+import type { Plugin } from "@elizaos/core";
+export interface KnowledgePluginConfig {
     enableUI?: boolean;
-    /**
-     * Enable HTTP routes for document management
-     * Set to false for browser-only or minimal deployments
-     * @default true
-     */
     enableRoutes?: boolean;
-    /**
-     * Enable actions (PROCESS_KNOWLEDGE, SEARCH_KNOWLEDGE)
-     * @default true
-     */
     enableActions?: boolean;
-    /**
-     * Enable tests
-     * @default true
-     */
     enableTests?: boolean;
 }
-/**
- * Create a Knowledge Plugin with custom configuration
- * @param config Plugin configuration options
- * @returns Configured Plugin instance
- *
- * @example
- * // Cloud runtime mode (service + provider only)
- * const plugin = createKnowledgePlugin({
- *   enableUI: false,
- *   enableRoutes: false,
- * });
- *
- * @example
- * // Browser-only mode (no routes)
- * const plugin = createKnowledgePlugin({
- *   enableRoutes: false,
- * });
- *
- * @example
- * // Full mode (default)
- * const plugin = createKnowledgePlugin();
- */
-declare function createKnowledgePlugin(config?: KnowledgePluginConfig): Plugin;
-/**
- * Knowledge Plugin - Core mode (Service + Provider only)
- * Use this for cloud runtimes or minimal deployments
- */
-declare const knowledgePluginCore: Plugin;
-/**
- * Knowledge Plugin - Headless mode (Service + Provider + Actions, no UI)
- * Use this for server deployments without frontend
- */
-declare const knowledgePluginHeadless: Plugin;
-/**
- * Knowledge Plugin - Full mode (default)
- * Includes everything: Service, Provider, Actions, Routes, UI, Tests
- */
-declare const knowledgePlugin: Plugin;
-
-export { type AddKnowledgeOptions, type ExtendedMemoryMetadata, type KnowledgeConfig, type KnowledgeDocumentMetadata, type KnowledgePluginConfig, KnowledgeService, KnowledgeServiceType, type LoadResult, type ModelConfig, ModelConfigSchema, type ProviderRateLimits, type TextGenerationOptions, createKnowledgePlugin, knowledgePlugin as default, documentsProvider, knowledgePlugin, knowledgePluginCore, knowledgePluginHeadless, knowledgeProvider };
+export declare function createKnowledgePlugin(config?: KnowledgePluginConfig): Plugin;
+export declare const knowledgePluginCore: Plugin;
+export declare const knowledgePluginHeadless: Plugin;
+export declare const knowledgePlugin: Plugin;
+export default knowledgePlugin;
+export { documentsProvider } from "./documents-provider";
+export { knowledgeProvider } from "./provider";
+export { KnowledgeService } from "./service";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAO5C,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,wBAAgB,qBAAqB,CAAC,MAAM,GAAE,qBAA0B,GAAG,MAAM,CA2BhF;AAED,eAAO,MAAM,mBAAmB,EAAE,MAKhC,CAAC;AAEH,eAAO,MAAM,uBAAuB,EAAE,MAKpC,CAAC;AAEH,eAAO,MAAM,eAAe,EAAE,MAK5B,CAAC;AAEH,eAAe,eAAe,CAAC;AAE/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,cAAc,SAAS,CAAC"}

package/dist/index.node.d.ts

@@ -0,0 +1,2 @@
+export * from "./index";
+//# sourceMappingURL=index.node.d.ts.map

package/dist/index.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.node.d.ts","sourceRoot":"","sources":["../index.node.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC"}

package/dist/llm.d.ts

@@ -0,0 +1,27 @@
+import { type IAgentRuntime } from "@elizaos/core";
+interface TextGenerationResult {
+    text: string;
+    usage: {
+        inputTokens?: number;
+        outputTokens?: number;
+        totalTokens?: number;
+    };
+    finishReason?: string;
+    response?: {
+        id?: string;
+        modelId?: string;
+    };
+}
+import type { TextGenerationOptions } from "./types";
+export declare function generateTextEmbedding(runtime: IAgentRuntime, text: string): Promise<{
+    embedding: number[];
+}>;
+export declare function generateTextEmbeddingsBatch(runtime: IAgentRuntime, texts: string[], batchSize?: number): Promise<Array<{
+    embedding: number[] | null;
+    success: boolean;
+    error?: unknown;
+    index: number;
+}>>;
+export declare function generateText(runtime: IAgentRuntime, prompt: string, system?: string, overrideConfig?: TextGenerationOptions): Promise<TextGenerationResult>;
+export {};
+//# sourceMappingURL=llm.d.ts.map

package/dist/llm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"llm.d.ts","sourceRoot":"","sources":["../llm.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,aAAa,EAAU,MAAM,eAAe,CAAC;AAM3D,UAAU,oBAAoB;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE;QACT,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAGD,OAAO,KAAK,EAAe,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAElE,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,aAAa,EACtB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CAgBlC;AAED,wBAAsB,2BAA2B,CAC/C,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,MAAM,EAAE,EACf,SAAS,GAAE,MAAW,GACrB,OAAO,CACR,KAAK,CAAC;IAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,CACxF,CAyCA;AA8DD,wBAAsB,YAAY,CAChC,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,EACf,cAAc,CAAC,EAAE,qBAAqB,GACrC,OAAO,CAAC,oBAAoB,CAAC,CAqC/B"}