@elizaos/plugin-openai 1.6.0 → 2.0.0-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elizaos/plugin-openai",
-  "version": "1.6.0",
+  "version": "2.0.0-alpha.2",
   "type": "module",
   "main": "dist/cjs/index.node.cjs",
   "module": "dist/node/index.node.js",
@@ -27,44 +27,40 @@
         "default": "./dist/node/index.node.js"
       },
       "default": "./dist/node/index.node.js"
-    },
-    "./node": {
-      "types": "./dist/node/index.d.ts",
-      "import": "./dist/node/index.node.js",
-      "default": "./dist/node/index.node.js"
-    },
-    "./browser": {
-      "types": "./dist/browser/index.d.ts",
-      "import": "./dist/browser/index.browser.js",
-      "default": "./dist/browser/index.browser.js"
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "rust"
   ],
   "dependencies": {
-    "@ai-sdk/openai": "^2.0.32",
-    "@elizaos/core": "^1.7.0",
-    "ai": "^5.0.47",
+    "@ai-sdk/openai": "^3.0.9",
+    "@elizaos/core": "2.0.0-alpha.2",
+    "ai": "^6.0.30",
     "js-tiktoken": "^1.0.21",
     "undici": "^7.16.0"
   },
   "devDependencies": {
+    "@biomejs/biome": "^2.3.11",
     "@types/json-schema": "^7.0.15",
-    "@types/node": "^24.5.2",
-    "prettier": "3.6.2",
-    "typescript": "^5.9.2"
+    "@types/node": "^25.0.3",
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
     "zod": "^3.25.76 || ^4.1.8"
   },
   "scripts": {
-    "build": "bun run build.ts",
+    "build:ts": "bun run build.ts",
     "dev": "bun --hot build.ts",
-    "lint": "prettier --write ./src",
-    "clean": "rm -rf dist .turbo node_modules .turbo-tsconfig.json tsconfig.tsbuildinfo",
-    "format": "prettier --write ./src",
-    "format:check": "prettier --check ./src"
+    "lint": "bunx @biomejs/biome check --write --unsafe .",
+    "lint:check": "bunx @biomejs/biome check .",
+    "clean": "rm -rf dist   .turbo node_modules",
+    "format": "bunx @biomejs/biome format --write .",
+    "format:check": "bunx @biomejs/biome format .",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:ts": "vitest run",
+    "build": "bun run build.ts"
   },
   "publishConfig": {
     "access": "public"
@@ -95,7 +91,7 @@
         "type": "string",
         "description": "Fallback identifier for the small language model if OPENAI_SMALL_MODEL is not set.",
         "required": false,
-        "default": "gpt-5-nano",
+        "default": "gpt-5-mini",
         "sensitive": false
       },
       "OPENAI_LARGE_MODEL": {
@@ -108,7 +104,7 @@
         "type": "string",
         "description": "Fallback identifier for the large language model if OPENAI_LARGE_MODEL is not set.",
         "required": false,
-        "default": "gpt-5-mini",
+        "default": "gpt-5",
         "sensitive": false
       },
       "OPENAI_EMBEDDING_MODEL": {
@@ -141,7 +137,7 @@
         "type": "string",
         "description": "Identifier of the model used for describing images.",
         "required": false,
-        "default": "gpt-5-nano",
+        "default": "gpt-5-mini",
         "sensitive": false
       },
       "OPENAI_IMAGE_DESCRIPTION_MAX_TOKENS": {
@@ -155,7 +151,7 @@
         "type": "string",
         "description": "Identifier of the model used for text-to-speech generation.",
         "required": false,
-        "default": "gpt-4o-mini-tts",
+        "default": "gpt-5-mini-tts",
         "sensitive": false
       },
       "OPENAI_TTS_VOICE": {
@@ -192,5 +188,5 @@
       }
     }
   },
-  "gitHead": "646c632924826e2b75c2304a75ee56959fe4a460"
+  "gitHead": "bc6cac8d36845d7cbde51a64307c6a57c16378ad"
 }

package/README.md

@@ -1,160 +0,0 @@
-# OpenAI Plugin
-
-This plugin provides integration with OpenAI's models through the ElizaOS platform.
-
-## Usage
-
-Add the plugin to your character configuration:
-
-```json
-"plugins": ["@elizaos-plugins/plugin-openai"]
-```
-
-## Configuration
-
-The plugin requires these environment variables (can be set in .env file or character settings):
-
-```json
-"settings": {
-  "OPENAI_API_KEY": "your_openai_api_key",
-  "OPENAI_BASE_URL": "optional_custom_endpoint",
-  "OPENAI_SMALL_MODEL": "gpt-4o-mini",
-  "OPENAI_LARGE_MODEL": "gpt-4o",
-  "OPENAI_EMBEDDING_MODEL": "text-embedding-3-small",
-  "OPENAI_EMBEDDING_API_KEY": "your_openai_api_key_for_embedding",
-  "OPENAI_EMBEDDING_URL": "optional_custom_endpoint",
-  "OPENAI_EMBEDDING_DIMENSIONS": "1536",
-  "OPENAI_IMAGE_DESCRIPTION_MODEL": "gpt-4o-mini",
-  "OPENAI_IMAGE_DESCRIPTION_MAX_TOKENS": "8192",
-  "OPENAI_EXPERIMENTAL_TELEMETRY": "false",
-  "OPENAI_BROWSER_BASE_URL": "https://your-proxy.example.com/openai",
-  "OPENAI_BROWSER_EMBEDDING_URL": "https://your-proxy.example.com/openai"
-}
-```
-
-Or in `.env` file:
-
-```
-OPENAI_API_KEY=your_openai_api_key
-# Optional overrides:
-OPENAI_BASE_URL=optional_custom_endpoint
-OPENAI_SMALL_MODEL=gpt-4o-mini
-OPENAI_LARGE_MODEL=gpt-4o
-OPENAI_EMBEDDING_MODEL=text-embedding-3-small
-OPENAI_EMBEDDING_API_KEY=your_openai_api_key_for_embedding
-OPENAI_EMBEDDING_URL=optional_custom_endpoint
-OPENAI_EMBEDDING_DIMENSIONS=1536
-OPENAI_IMAGE_DESCRIPTION_MODEL=gpt-4o-mini
-OPENAI_IMAGE_DESCRIPTION_MAX_TOKENS=8192
-OPENAI_EXPERIMENTAL_TELEMETRY=false
-# Browser proxy (frontend builds only)
-OPENAI_BROWSER_BASE_URL=https://your-proxy.example.com/openai
-OPENAI_BROWSER_EMBEDDING_URL=https://your-proxy.example.com/openai
-```
-
-### Configuration Options
-
-- `OPENAI_API_KEY` (required): Your OpenAI API credentials
-- `OPENAI_BASE_URL`: Custom API endpoint (default: https://api.openai.com/v1)
-- `OPENAI_SMALL_MODEL`: Defaults to GPT-4o Mini ("gpt-4o-mini")
-- `OPENAI_LARGE_MODEL`: Defaults to GPT-4o ("gpt-4o")
-- `OPENAI_EMBEDDING_MODEL`: Defaults to text-embedding-3-small ("text-embedding-3-small")
-- `OPENAI_EMBEDDING_API_KEY`: Custom embedding api key (defaults to `OPENAI_API_KEY`)
-- `OPENAI_EMBEDDING_URL`: Custom embedding endpoint (defaults to `OPENAI_BASE_URL`)
-- `OPENAI_EMBEDDING_DIMENSIONS`: Defaults to 1536 (1536)
-- `OPENAI_IMAGE_DESCRIPTION_MODEL`: Model used for image description (default: "gpt-4o-mini")
-- `OPENAI_IMAGE_DESCRIPTION_MAX_TOKENS`: Maximum tokens for image descriptions (default: 8192)
-- `OPENAI_EXPERIMENTAL_TELEMETRY`: Enable experimental telemetry features for enhanced debugging and usage analytics (default: false)
-- `OPENAI_BROWSER_BASE_URL`: Browser-only base URL to a proxy endpoint that forwards requests to OpenAI without exposing keys
-- `OPENAI_BROWSER_EMBEDDING_URL`: Browser-only embeddings endpoint base URL
-
-### Browser mode and proxying
-
-When bundled for the browser, this plugin avoids sending Authorization headers. Set `OPENAI_BROWSER_BASE_URL` (and optionally `OPENAI_BROWSER_EMBEDDING_URL`) to a server-side proxy you control that injects the OpenAI API key. This prevents exposing secrets in frontend builds.
-
-Example minimal proxy (Express):
-
-```ts
-import express from 'express';
-import fetch from 'node-fetch';
-
-const app = express();
-app.use(express.json());
-
-app.post('/openai/*', async (req, res) => {
-  const url = `https://api.openai.com/v1/${req.params[0]}`;
-  const r = await fetch(url, {
-    method: 'POST',
-    headers: {
-      'Authorization': `Bearer ${process.env.OPENAI_API_KEY}`,
-      'Content-Type': 'application/json',
-    },
-    body: JSON.stringify(req.body),
-  });
-  res.status(r.status).set(Object.fromEntries(r.headers)).send(await r.text());
-});
-
-app.listen(3000);
-```
-
-### Experimental Telemetry
-
-When `OPENAI_EXPERIMENTAL_TELEMETRY` is set to `true`, the plugin enables advanced telemetry features that provide:
-
-- Enhanced debugging capabilities for model performance issues
-- Detailed usage analytics for optimization
-- Better observability into OpenAI API interactions
-- Foundation for future monitoring and analytics features through Sentry or other frameworks
-
-**Note**: This feature is opt-in due to privacy considerations, as telemetry data may contain information about model usage patterns. Enable only when you need enhanced debugging or analytics capabilities.
-
-The plugin provides these model classes:
-
-- `TEXT_SMALL`: Optimized for fast, cost-effective responses
-- `TEXT_LARGE`: For complex tasks requiring deeper reasoning
-- `TEXT_EMBEDDING`: Text embedding model (text-embedding-3-small by default)
-- `IMAGE`: DALL-E image generation
-- `IMAGE_DESCRIPTION`: GPT-4o image analysis
-- `TRANSCRIPTION`: Whisper audio transcription
-- `TEXT_TOKENIZER_ENCODE`: Text tokenization
-- `TEXT_TOKENIZER_DECODE`: Token decoding
-
-## Additional Features
-
-### Image Generation
-
-```js
-await runtime.useModel(ModelType.IMAGE, {
-  prompt: "A sunset over mountains",
-  n: 1, // number of images
-  size: "1024x1024", // image resolution
-});
-```
-
-### Audio Transcription
-
-```js
-const transcription = await runtime.useModel(
-  ModelType.TRANSCRIPTION,
-  audioBuffer
-);
-```
-
-### Image Analysis
-
-```js
-const { title, description } = await runtime.useModel(
-  ModelType.IMAGE_DESCRIPTION,
-  "https://example.com/image.jpg"
-);
-```
-
-### Text Embeddings
-
-```js
-await runtime.useModel(ModelType.TEXT_EMBEDDING, "text to embed");
-```
-
-### Tokenizer in browser
-
-js-tiktoken is WASM and browser-safe; this plugin uses `encodingForModel` directly in both Node and browser builds.