package.json

{
  "name": "@elizaos/plugin-knowledge-root",
  "private": true,
  "version": "2.0.0-alpha.1",
  "description": "Knowledge and RAG plugin for elizaOS - provides retrieval augmented generation capabilities",
  "type": "module",
  "main": "typescript/dist/index.js",
  "types": "typescript/dist/index.d.ts",
  "exports": {
    "./package.json": "./package.json",
    ".": {
      "types": "./typescript/dist/index.d.ts",
      "import": "./typescript/dist/index.js",
      "default": "./typescript/dist/index.js"
    },
    "./rust": {
      "import": "./rust/pkg/node/elizaos_plugin_plugin_knowledge.js"
    }
  },
  "files": [
    "typescript/dist",
    "README.md",
    "python",
    "rust/src",
    "rust/Cargo.toml"
  ],
  "keywords": [
    "plugin",
    "elizaos",
    "knowledge",
    "rag",
    "retrieval-augmented-generation",
    "embeddings"
  ],
  "author": "elizaOS",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/elizaos-plugins/plugin-knowledge.git"
  },
  "scripts": {
    "build": "bun run build:ts && bun run build:rust && bun run build:python",
    "build:ts": "cd typescript && bun run build.ts",
    "build:rust": "test -d rust && cd rust && cargo build --release || echo 'Rust build skipped - no rust directory'",
    "build:python": "test -n \"$SKIP_PYTHON_BUILD\" && echo 'Python build skipped (SKIP_PYTHON_BUILD set)' || (test -d python && cd python && (timeout 120 python3 -m build 2>/dev/null || timeout 120 pyproject-build 2>/dev/null) || echo 'Python build skipped or timed out')",
    "dev": "cd typescript && bun --hot build.ts",
    "test": "bun run test:ts && bun run test:rust && bun run test:python",
    "test:ts": "cd typescript && vitest run || echo 'TypeScript tests skipped - no tests found'",
    "test:rust": "test -d rust && cd rust && cargo test || echo 'Rust tests skipped'",
    "test:python": "test -d python && cd python && pytest -p no:anchorpy --asyncio-mode=auto || echo 'Python tests skipped'",
    "typecheck": "tsc --noEmit -p typescript/tsconfig.json",
    "lint": "bunx @biomejs/biome check --write ./typescript",
    "lint:check": "bunx @biomejs/biome check ./typescript",
    "lint:rust": "test -d rust && cd rust && cargo clippy --all-targets --fix --allow-dirty --allow-staged -- -D warnings && cargo fmt || echo 'Rust lint skipped'",
    "lint:python": "test -d python && cd python && ruff check --fix . && ruff format . || echo 'Python lint skipped'",
    "clean": "rm -rf typescript/dist python/dist rust/target .turbo node_modules",
    "format": "bunx @biomejs/biome format --write ./typescript",
    "format:check": "bunx @biomejs/biome format ./typescript",
    "typecheck:python": "test -d python && cd python && mypy . --ignore-missing-imports || echo 'Python typecheck skipped'",
    "typecheck:rust": "test -d rust && cd rust && cargo check || echo 'Rust typecheck skipped'"
  },
  "devDependencies": {
    "@biomejs/biome": "^2.3.11",
    "@types/bun": "^1.3.5",
    "@types/node": "^25.0.3",
    "typescript": "^5.9.3"
  },
  "peerDependencies": {
    "@elizaos/core": "workspace:*"
  },
  "agentConfig": {
    "pluginType": "elizaos:plugin:1.0.0",
    "pluginParameters": {
      "CTX_KNOWLEDGE_ENABLED": {
        "type": "boolean",
        "description": "Enables or disables contextual knowledge functionality; when set to 'true' additional text-generation settings are validated.",
        "required": false,
        "default": "false",
        "sensitive": false
      },
      "EMBEDDING_PROVIDER": {
        "type": "string",
        "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
      },
      "OPENAI_API_KEY": {
        "type": "string",
        "description": "API key used to authenticate requests to OpenAI services for embeddings or text generation.",
        "required": false,
        "sensitive": true
      },
      "OPENAI_EMBEDDING_MODEL": {
        "type": "string",
        "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 configured EMBEDDING_PROVIDER.",
        "required": false,
        "default": "text-embedding-3-small",
        "sensitive": false
      },
      "EMBEDDING_DIMENSION": {
        "type": "number",
        "description": "Custom embedding dimension size.",
        "required": false,
        "default": 1536,
        "sensitive": false
      },
      "OPENAI_EMBEDDING_DIMENSIONS": {
        "type": "number",
        "description": "Alternative variable to supply embedding dimension when using OpenAI.",
        "required": false,
        "default": 1536,
        "sensitive": false
      },
      "TEXT_PROVIDER": {
        "type": "string",
        "description": "Provider to use for text generation when contextual knowledge is enabled (e.g., openai, anthropic, openrouter, google).",
        "required": false,
        "sensitive": false
      },
      "ANTHROPIC_API_KEY": {
        "type": "string",
        "description": "API key for Anthropic text generation models.",
        "required": false,
        "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,
        "sensitive": false
      },
      "ANTHROPIC_BASE_URL": {
        "type": "string",
        "description": "Custom base URL for Anthropic API requests.",
        "required": false,
        "sensitive": false
      },
      "OPENROUTER_BASE_URL": {
        "type": "string",
        "description": "Custom base URL for OpenRouter API requests.",
        "required": false,
        "sensitive": false
      },
      "GOOGLE_BASE_URL": {
        "type": "string",
        "description": "Custom base URL for Google AI API requests.",
        "required": false,
        "sensitive": false
      },
      "TEXT_MODEL": {
        "type": "string",
        "description": "The specific text generation model to use with the selected TEXT_PROVIDER.",
        "required": false,
        "sensitive": false
      },
      "MAX_INPUT_TOKENS": {
        "type": "number",
        "description": "Maximum number of input tokens permitted per request.",
        "required": false,
        "default": 4000,
        "sensitive": false
      },
      "MAX_OUTPUT_TOKENS": {
        "type": "number",
        "description": "Maximum number of output tokens that can be generated.",
        "required": false,
        "default": 4096,
        "sensitive": false
      },
      "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": "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": "./docs",
        "sensitive": false
      },
      "LOAD_DOCS_ON_STARTUP": {
        "type": "boolean",
        "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,
        "sensitive": false
      }
    }
  },
  "gitHead": "05d4ca11d769db8c7f54a722ee24b2ce2b951543"
}