npm - @elizaos/plugin-knowledge - Versions diffs - 1.0.2 → 1.0.3 - Mend

@elizaos/plugin-knowledge 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1) hide show

package/package.json +95 -68

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@elizaos/plugin-knowledge",
   "description": "Plugin for Knowledge",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -78,128 +78,155 @@
   "agentConfig": {
     "pluginType": "elizaos:plugin:1.0.0",
     "pluginParameters": {
-      "OPENAI_API_KEY": {
-        "type": "string",
-        "description": "API key for authenticating requests to OpenAI services used by the Knowledge plugin.",
-        "required": false
-      },
-      "OPENAI_EMBEDDING_MODEL": {
-        "type": "string",
-        "description": "Specifies the OpenAI embedding model to use when generating vector embeddings.",
-        "required": false
-      },
       "CTX_KNOWLEDGE_ENABLED": {
         "type": "boolean",
-        "description": "Enables contextual knowledge functionality with enriched embeddings.",
-        "required": false
-      },
-      "TEXT_PROVIDER": {
-        "type": "string",
-        "description": "LLM provider for text generation (e.g., openai, anthropic, openrouter, google).",
-        "required": false
-      },
-      "TEXT_MODEL": {
-        "type": "string",
-        "description": "Name of the text generation model to use with the selected provider.",
-        "required": false
-      },
-      "OPENROUTER_API_KEY": {
-        "type": "string",
-        "description": "API key for authenticating with the OpenRouter service when TEXT_PROVIDER=openrouter.",
-        "required": false
+        "description": "Enables or disables contextual knowledge functionality; when set to 'true' additional text-generation settings are validated.",
+        "required": false,
+        "default": "false",
+        "sensitive": false
       },
-      "ANTHROPIC_API_KEY": {
+      "EMBEDDING_PROVIDER": {
         "type": "string",
-        "description": "API key for Anthropic models when TEXT_PROVIDER=anthropic.",
-        "required": false
+        "description": "Specifies which provider to use for generating embeddings (e.g., openai, google). If omitted the code assumes 'openai' through plugin-openai.",
+        "required": false,
+        "default": "openai",
+        "sensitive": false
       },
-      "GOOGLE_API_KEY": {
+      "OPENAI_API_KEY": {
         "type": "string",
-        "description": "API key for Google AI models when TEXT_PROVIDER=google or EMBEDDING_PROVIDER=google.",
-        "required": false
+        "description": "API key used to authenticate requests to OpenAI services for embeddings or text generation.",
+        "required": false,
+        "sensitive": true
       },
-      "EMBEDDING_PROVIDER": {
+      "OPENAI_EMBEDDING_MODEL": {
         "type": "string",
-        "description": "Provider to use for generating embeddings (e.g., openai, google).",
-        "required": false
+        "description": "Name of the OpenAI embedding model; also used as a fallback for TEXT_EMBEDDING_MODEL when EMBEDDING_PROVIDER defaults to openai.",
+        "required": false,
+        "sensitive": false
       },
       "TEXT_EMBEDDING_MODEL": {
         "type": "string",
-        "description": "Embedding model name to use with the selected EMBEDDING_PROVIDER.",
-        "required": false
+        "description": "Embedding model name to use with the configured EMBEDDING_PROVIDER.",
+        "required": false,
+        "default": "text-embedding-3-small",
+        "sensitive": false
       },
       "EMBEDDING_DIMENSION": {
         "type": "number",
-        "description": "Custom dimension size for generated embeddings.",
-        "required": false
+        "description": "Custom embedding dimension size.",
+        "required": false,
+        "default": 1536,
+        "sensitive": false
       },
-      "MAX_CONCURRENT_REQUESTS": {
+      "OPENAI_EMBEDDING_DIMENSIONS": {
         "type": "number",
-        "description": "Maximum number of concurrent API requests allowed for rate limiting.",
+        "description": "Alternative variable to supply embedding dimension when using OpenAI.",
         "required": false,
-        "default": 30
+        "default": 1536,
+        "sensitive": false
       },
-      "REQUESTS_PER_MINUTE": {
-        "type": "number",
-        "description": "Maximum number of API requests permitted per minute.",
+      "TEXT_PROVIDER": {
+        "type": "string",
+        "description": "Provider to use for text generation when contextual knowledge is enabled (e.g., openai, anthropic, openrouter, google).",
         "required": false,
-        "default": 60
+        "sensitive": false
       },
-      "TOKENS_PER_MINUTE": {
-        "type": "number",
-        "description": "Maximum number of tokens that can be processed per minute.",
+      "ANTHROPIC_API_KEY": {
+        "type": "string",
+        "description": "API key for Anthropic text generation models.",
         "required": false,
-        "default": 150000
+        "sensitive": true
+      },
+      "OPENROUTER_API_KEY": {
+        "type": "string",
+        "description": "API key for OpenRouter when using it as a text provider.",
+        "required": false,
+        "sensitive": true
+      },
+      "GOOGLE_API_KEY": {
+        "type": "string",
+        "description": "API key for Google AI services used for embeddings or text generation.",
+        "required": false,
+        "sensitive": true
       },
       "OPENAI_BASE_URL": {
         "type": "string",
         "description": "Custom base URL for routing OpenAI API requests (useful for proxies).",
-        "required": false
+        "required": false,
+        "sensitive": false
       },
       "ANTHROPIC_BASE_URL": {
         "type": "string",
         "description": "Custom base URL for Anthropic API requests.",
-        "required": false
+        "required": false,
+        "sensitive": false
       },
       "OPENROUTER_BASE_URL": {
         "type": "string",
         "description": "Custom base URL for OpenRouter API requests.",
-        "required": false
+        "required": false,
+        "sensitive": false
       },
       "GOOGLE_BASE_URL": {
         "type": "string",
         "description": "Custom base URL for Google AI API requests.",
-        "required": false
+        "required": false,
+        "sensitive": false
       },
-      "KNOWLEDGE_PATH": {
+      "TEXT_MODEL": {
         "type": "string",
-        "description": "Filesystem path where the plugin should look for knowledge documents.",
+        "description": "The specific text generation model to use with the selected TEXT_PROVIDER.",
         "required": false,
-        "default": "./docs"
+        "sensitive": false
       },
       "MAX_INPUT_TOKENS": {
         "type": "number",
-        "description": "Maximum number of input tokens allowed per request.",
+        "description": "Maximum number of input tokens permitted per request.",
         "required": false,
-        "default": 4000
+        "default": 4000,
+        "sensitive": false
       },
       "MAX_OUTPUT_TOKENS": {
         "type": "number",
-        "description": "Maximum number of output tokens that the model can generate.",
+        "description": "Maximum number of output tokens that can be generated.",
         "required": false,
-        "default": 4096
+        "default": 4096,
+        "sensitive": false
       },
-      "OPENAI_EMBEDDING_DIMENSIONS": {
+      "MAX_CONCURRENT_REQUESTS": {
+        "type": "number",
+        "description": "Upper bound on concurrent API requests for rate limiting.",
+        "required": false,
+        "default": 30,
+        "sensitive": false
+      },
+      "REQUESTS_PER_MINUTE": {
+        "type": "number",
+        "description": "Maximum number of API requests allowed per minute.",
+        "required": false,
+        "default": 60,
+        "sensitive": false
+      },
+      "TOKENS_PER_MINUTE": {
         "type": "number",
-        "description": "Alternative environment variable for embedding dimension when using OpenAI.",
+        "description": "Maximum number of tokens that can be processed per minute.",
+        "required": false,
+        "default": 150000,
+        "sensitive": false
+      },
+      "KNOWLEDGE_PATH": {
+        "type": "string",
+        "description": "Filesystem path where the knowledge loader searches for documents. Overrides the default ./docs directory.",
         "required": false,
-        "default": 1536
+        "default": "./docs",
+        "sensitive": false
       },
       "LOAD_DOCS_ON_STARTUP": {
         "type": "boolean",
-        "description": "Determines whether documents should be automatically loaded from the docs folder when the plugin starts. Any value other than the string 'false' enables loading.",
+        "description": "Controls whether the plugin should automatically load documents from the docs folder when the agent starts. Any value other than the string 'false' enables loading.",
         "required": false,
-        "default": true
+        "default": true,
+        "sensitive": false
       }
     }
   }