@elizaos/plugin-google-genai 2.0.0-alpha.9 → 2.0.11-beta.7

package/README.md

@@ -0,0 +1,114 @@
+# @elizaos/plugin-google-genai
+
+Google Generative AI (Gemini) model provider for [elizaOS](https://github.com/elizaos/eliza) agents. Registers handlers for text generation, embeddings, and image description across all elizaOS model tiers, backed by the Google Generative AI API.
+
+## Capabilities
+
+- **Text generation** across all model tiers: nano, small, medium, large, mega, response handler, action planner.
+- **Text embeddings** with `text-embedding-004` (768 dimensions).
+- **Image description** — fetch an image by URL, encode it inline, and return a `{ title, description }` object.
+- **Structured output** — pass a JSON Schema as `responseSchema` to any text handler to get `application/json` back from the model.
+- **Tool use** — pass function declarations via `tools` / `toolChoice` to enable function-calling on supported models.
+
+## Auto-enable
+
+The plugin is automatically enabled by elizaOS when any of the following environment variables is set and non-empty:
+
+- `GOOGLE_API_KEY`
+- `GOOGLE_GENERATIVE_AI_API_KEY`
+- `GEMINI_API_KEY`
+
+## Installation
+
+```bash
+bun add @elizaos/plugin-google-genai
+```
+
+Or register it explicitly in your agent character file:
+
+```json
+{
+  "plugins": ["@elizaos/plugin-google-genai"]
+}
+```
+
+## Configuration
+
+| Environment variable | Required | Default | Description |
+|---|---|---|---|
+| `GOOGLE_GENERATIVE_AI_API_KEY` | Yes | — | API key from [Google AI Studio](https://aistudio.google.com/) |
+| `GOOGLE_SMALL_MODEL` | No | `gemini-2.0-flash-001` | Small/fast text model |
+| `GOOGLE_LARGE_MODEL` | No | `gemini-2.5-pro-preview-03-25` | Large/capable text model |
+| `GOOGLE_NANO_MODEL` | No | falls back to small | Nano text model |
+| `GOOGLE_MEDIUM_MODEL` | No | falls back to small | Medium text model |
+| `GOOGLE_MEGA_MODEL` | No | falls back to large | Mega text model |
+| `GOOGLE_RESPONSE_HANDLER_MODEL` | No | falls back to nano | Response handler model |
+| `GOOGLE_ACTION_PLANNER_MODEL` | No | falls back to medium | Action planner model |
+| `GOOGLE_EMBEDDING_MODEL` | No | `text-embedding-004` | Embedding model |
+| `GOOGLE_IMAGE_MODEL` | No | `gemini-2.5-pro-preview-03-25` | Image description model |
+
+Generic fallbacks (`SMALL_MODEL`, `LARGE_MODEL`, `IMAGE_MODEL`, etc.) are also respected when the `GOOGLE_*` prefix variants are not set.
+
+## Usage
+
+Once the plugin is loaded, use any Gemini model through the standard elizaOS runtime interface:
+
+```typescript
+import { ModelType } from "@elizaos/core";
+
+// Text generation
+const text = await runtime.useModel(ModelType.TEXT_LARGE, {
+  prompt: "Explain quantum entanglement in plain language.",
+});
+
+// Embeddings
+const embedding = await runtime.useModel(ModelType.TEXT_EMBEDDING, {
+  text: "Hello, world!",
+});
+// embedding is number[] with 768 dimensions
+
+// Image description
+const result = await runtime.useModel(
+  ModelType.IMAGE_DESCRIPTION,
+  "https://example.com/image.jpg",
+);
+// result: { title: string; description: string }
+
+// Structured output
+const person = await runtime.useModel(ModelType.TEXT_SMALL, {
+  prompt: "Generate a sample person profile.",
+  responseSchema: {
+    type: "object",
+    properties: {
+      name: { type: "string" },
+      age: { type: "number" },
+    },
+    required: ["name", "age"],
+  },
+});
+```
+
+## Available model tiers
+
+| ModelType | Default model | Notes |
+|---|---|---|
+| `TEXT_NANO` | falls back to small | Fastest; shares small model by default |
+| `TEXT_SMALL` | `gemini-2.0-flash-001` | Fast + structured output |
+| `TEXT_MEDIUM` | falls back to small | |
+| `TEXT_LARGE` | `gemini-2.5-pro-preview-03-25` | High-quality + structured output |
+| `TEXT_MEGA` | falls back to large | |
+| `RESPONSE_HANDLER` | falls back to nano | |
+| `ACTION_PLANNER` | falls back to medium | |
+| `TEXT_EMBEDDING` | `text-embedding-004` | 768-dim vectors |
+| `IMAGE_DESCRIPTION` | `gemini-2.5-pro-preview-03-25` | Multimodal; fetches image by URL |
+
+## Development
+
+```bash
+bun install
+bun run --cwd plugins/plugin-google-genai build
+bun run --cwd plugins/plugin-google-genai test
+bun run --cwd plugins/plugin-google-genai typecheck
+```
+
+See [AGENTS.md](AGENTS.md) for the agent-facing layout reference and extension guide.

package/auto-enable.ts

@@ -0,0 +1,21 @@
+// Auto-enable check for @elizaos/plugin-google-genai.
+//
+// Plugin manifest entry-point — referenced by package.json's
+// `elizaos.plugin.autoEnableModule`. Keep this module light: env reads only,
+// no service init, no transitive imports of the full plugin runtime. The
+// auto-enable engine loads dozens of these per boot.
+import type { PluginAutoEnableContext } from "@elizaos/core";
+
+const ENV_KEYS = [
+  "GOOGLE_API_KEY",
+  "GOOGLE_GENERATIVE_AI_API_KEY",
+  "GEMINI_API_KEY",
+] as const;
+
+/** Enable when a Google Generative AI / Gemini API key is present. */
+export function shouldEnable(ctx: PluginAutoEnableContext): boolean {
+  return ENV_KEYS.some((k) => {
+    const v = ctx.env[k];
+    return typeof v === "string" && v.trim() !== "";
+  });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elizaos/plugin-google-genai",
-  "version": "2.0.0-alpha.9",
+  "version": "2.0.11-beta.7",
   "type": "module",
   "main": "dist/node/index.node.js",
   "module": "dist/node/index.node.js",
@@ -27,36 +27,59 @@
         "types": "./dist/node/index.d.ts",
         "default": "./dist/node/index.node.js"
       },
-      "require": "./dist/cjs/index.node.cjs",
       "default": "./dist/node/index.node.js"
+    },
+    "./*.css": "./dist/*.css",
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "import": "./dist/*.js",
+      "default": "./dist/*.js"
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "auto-enable.ts"
   ],
+  "elizaos": {
+    "plugin": {
+      "autoEnableModule": "./auto-enable.ts",
+      "capabilities": [
+        "text-large",
+        "text-small",
+        "tool-use",
+        "embedding",
+        "image-description"
+      ]
+    }
+  },
+  "sideEffects": false,
   "dependencies": {
-    "@elizaos/core": "alpha",
-    "@google/genai": "^1.5.1",
-    "undici": "^7.9.0"
+    "@google/genai": "^1.5.1"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.3.11",
+    "@biomejs/biome": "^2.4.14",
+    "@elizaos/core": "2.0.11-beta.7",
     "@types/node": "^25.0.3",
+    "bun-types": "^1.3.12",
     "dotenv": "^17.2.3",
-    "typescript": "^5.9.3"
+    "typescript": "^6.0.3",
+    "vitest": "^4.0.0"
+  },
+  "peerDependencies": {
+    "@elizaos/core": "2.0.11-beta.7"
   },
   "scripts": {
     "dev": "bun run build.ts --watch",
-    "clean": "rm -rf dist .turbo node_modules .turbo-tsconfig.json tsconfig.tsbuildinfo",
+    "clean": "rm -rf dist .turbo .turbo-tsconfig.json tsconfig.tsbuildinfo",
     "format": "bunx @biomejs/biome format --write .",
     "format:check": "bunx @biomejs/biome format .",
-    "typecheck": "tsc --noEmit -p tsconfig.json",
-    "test": "bun run test:unit && bun run test:integration",
-    "test:unit": "vitest run --passWithNoTests __tests__/unit/",
-    "test:integration": "vitest run --passWithNoTests __tests__/integration/",
-    "test:watch": "vitest",
-    "lint": "bunx @biomejs/biome check --write .",
-    "lint:check": "bunx @biomejs/biome check .",
+    "typecheck": "tsgo --noEmit -p tsconfig.json",
+    "test": "bunx vitest run --config vitest.config.ts",
+    "test:unit": "bunx vitest run --config vitest.config.ts --dir __tests__/unit",
+    "test:integration": "bunx vitest run --config vitest.config.ts --dir __tests__/integration",
+    "test:watch": "bunx vitest --config vitest.config.ts",
+    "lint": "bunx @biomejs/biome check --write --unsafe build.ts index.ts index.browser.ts index.node.ts init.ts __tests__ generated models types utils",
+    "lint:check": "bunx @biomejs/biome check build.ts index.ts index.browser.ts index.node.ts init.ts __tests__ generated models types utils",
     "build": "bun run build.ts",
     "build:ts": "bun run build.ts"
   },
@@ -123,8 +146,8 @@
       }
     }
   },
-  "gitHead": "646c632924826e2b75c2304a75ee56959fe4a460",
-  "milaidy": {
+  "gitHead": "cdbc876f793d96073d7eb0d09715a031ce0cd32e",
+  "eliza": {
     "platforms": [
       "browser",
       "node"