@elizaos/plugin-knowledge 1.0.0 → 1.0.1

package/README.md

@@ -4,6 +4,8 @@ This plugin provides Retrieval Augmented Generation (Knowledge) capabilities for
 
 ## Quick Setup
 
+> **⚠️ Note**: `TEXT_PROVIDER` and `TEXT_MODEL` configuration are temporarily disabled. The plugin currently uses `runtime.useModel(TEXT_LARGE)` for text generation. Full provider configuration support will be added soon.
+
 ### Basic Setup (With plugin-openai)
 
 If you already have plugin-openai configured, you don't need any additional environment variables! The Knowledge plugin will automatically use your OpenAI configuration.
@@ -22,11 +24,13 @@ If you already have plugin-openai configured, you don't need any additional envi
 
 If you want enhanced Knowledge capabilities with contextual embeddings, add:
 
+> **Note**: The TEXT_PROVIDER and TEXT_MODEL settings below are temporarily disabled. The plugin will use `runtime.useModel(TEXT_LARGE)` for now.
+
 ```env
 # Enable contextual Knowledge
 CTX_KNOWLEDGE_ENABLED=true
 
-# Required text generation settings
+# Required text generation settings (TEMPORARILY DISABLED)
 TEXT_PROVIDER=openrouter  # Choose your provider: openai, anthropic, openrouter, or google
 TEXT_MODEL=anthropic/claude-3.5-sonnet  # Model for your chosen provider
 
@@ -109,6 +113,31 @@ OPENROUTER_BASE_URL=https://your-openrouter-proxy.com/api/v1
 GOOGLE_BASE_URL=https://your-google-proxy.com
 ```
 
+### Knowledge Document Path
+
+By default, the plugin looks for knowledge documents in a `docs` folder in your project root. You can customize this location using the `KNOWLEDGE_PATH` environment variable:
+
+```env
+# Custom path to your knowledge documents
+KNOWLEDGE_PATH=/path/to/your/documents
+
+# Examples:
+# KNOWLEDGE_PATH=./my-docs           # Relative path from project root
+# KNOWLEDGE_PATH=/home/user/docs     # Absolute path
+# KNOWLEDGE_PATH=../shared/knowledge # Relative path to parent directory
+```
+
+**How it works:**
+- If `KNOWLEDGE_PATH` is set, the plugin will use that directory for loading knowledge documents
+- If `KNOWLEDGE_PATH` is not set, the plugin defaults to `./docs` (a `docs` folder in your project root)
+- Both relative and absolute paths are supported
+- If the specified path doesn't exist, the plugin will log a warning but continue to function
+
+**Supported document formats:**
+- PDF files (`.pdf`)
+- Text files (`.txt`, `.md`)
+- And other formats supported by the document processor
+
 ### Token Limits
 
 ```env

package/dist/.vite/manifest.json

@@ -1,11 +1,11 @@
 {
   "index.html": {
-    "file": "assets/index-lAKoVTZd.js",
+    "file": "assets/index-BRhhNXdt.js",
     "name": "index",
     "src": "index.html",
     "isEntry": true,
     "css": [
-      "assets/index-BdT7VEOH.css"
+      "assets/index-Clk6Xgn1.css"
     ]
   }
 }