@elizaos/plugin-local-ai 1.0.0-alpha.7 → 1.0.0-beta.0

package/README.md

@@ -19,7 +19,7 @@ The plugin requires these environment variables (can be set in .env file or char
   "USE_LOCAL_AI": true,
   "USE_STUDIOLM_TEXT_MODELS": false,
   "USE_OLLAMA_TEXT_MODELS": false,
-  
+
   "OLLAMA_SERVER_URL": "http://localhost:11434",
   "OLLAMA_MODEL": "deepseek-r1-distill-qwen-7b",
   "USE_OLLAMA_EMBEDDING": false,
@@ -27,7 +27,7 @@ The plugin requires these environment variables (can be set in .env file or char
   "SMALL_OLLAMA_MODEL": "deepseek-r1:1.5b",
   "MEDIUM_OLLAMA_MODEL": "deepseek-r1:7b",
   "LARGE_OLLAMA_MODEL": "deepseek-r1:7b",
-  
+
   "STUDIOLM_SERVER_URL": "http://localhost:1234",
   "STUDIOLM_SMALL_MODEL": "lmstudio-community/deepseek-r1-distill-qwen-1.5b",
   "STUDIOLM_MEDIUM_MODEL": "deepseek-r1-distill-qwen-7b",
@@ -36,6 +36,7 @@ The plugin requires these environment variables (can be set in .env file or char
 ```
 
 Or in `.env` file:
+
 ```env
 # Local AI Configuration
 USE_LOCAL_AI=true
@@ -61,11 +62,13 @@ STUDIOLM_EMBEDDING_MODEL=false
 ### Configuration Options
 
 #### Text Model Source (Choose One)
+
 - `USE_STUDIOLM_TEXT_MODELS`: Enable StudioLM text models
 - `USE_OLLAMA_TEXT_MODELS`: Enable Ollama text models
-Note: Only one text model source can be enabled at a time
+  Note: Only one text model source can be enabled at a time
 
 #### Ollama Settings
+
 - `OLLAMA_SERVER_URL`: Ollama API endpoint (default: http://localhost:11434)
 - `OLLAMA_MODEL`: Default model for general use
 - `USE_OLLAMA_EMBEDDING`: Enable Ollama for embeddings
@@ -75,6 +78,7 @@ Note: Only one text model source can be enabled at a time
 - `LARGE_OLLAMA_MODEL`: Model for complex tasks
 
 #### StudioLM Settings
+
 - `STUDIOLM_SERVER_URL`: StudioLM API endpoint (default: http://localhost:1234)
 - `STUDIOLM_SMALL_MODEL`: Model for lighter tasks
 - `STUDIOLM_MEDIUM_MODEL`: Model for standard tasks
@@ -83,6 +87,7 @@ Note: Only one text model source can be enabled at a time
 ## Features
 
 The plugin provides these model classes:
+
 - `TEXT_SMALL`: Fast, efficient text generation using smaller models
 - `TEXT_LARGE`: More capable text generation using larger models
 - `IMAGE_DESCRIPTION`: Local image analysis using Florence-2 vision model
@@ -90,53 +95,46 @@ The plugin provides these model classes:
 - `TRANSCRIPTION`: Local audio transcription using Whisper
 
 ### Image Analysis
+
 ```typescript
 const { title, description } = await runtime.useModel(
-  ModelClass.IMAGE_DESCRIPTION,
-  "https://example.com/image.jpg"
+  ModelType.IMAGE_DESCRIPTION,
+  'https://example.com/image.jpg'
 );
 ```
 
 ### Text-to-Speech
+
 ```typescript
-const audioStream = await runtime.useModel(
-  ModelClass.TEXT_TO_SPEECH,
-  "Text to convert to speech"
-);
+const audioStream = await runtime.useModel(ModelType.TEXT_TO_SPEECH, 'Text to convert to speech');
 ```
 
 ### Audio Transcription
+
 ```typescript
-const transcription = await runtime.useModel(
-  ModelClass.TRANSCRIPTION,
-  audioBuffer
-);
+const transcription = await runtime.useModel(ModelType.TRANSCRIPTION, audioBuffer);
 ```
 
 ### Text Generation
+
 ```typescript
 // Using small model
-const smallResponse = await runtime.useModel(
-  ModelClass.TEXT_SMALL,
-  {
-    context: "Generate a short response",
-    stopSequences: []
-  }
-);
+const smallResponse = await runtime.useModel(ModelType.TEXT_SMALL, {
+  context: 'Generate a short response',
+  stopSequences: [],
+});
 
 // Using large model
-const largeResponse = await runtime.useModel(
-  ModelClass.TEXT_LARGE,
-  {
-    context: "Generate a detailed response",
-    stopSequences: []
-  }
-);
+const largeResponse = await runtime.useModel(ModelType.TEXT_LARGE, {
+  context: 'Generate a detailed response',
+  stopSequences: [],
+});
 ```
 
 ## Model Sources
 
 ### 1. StudioLM (LM Studio)
+
 - Local inference server for running various open models
 - Supports chat completion API similar to OpenAI
 - Configure with `USE_STUDIOLM_TEXT_MODELS=true`
@@ -144,10 +142,11 @@ const largeResponse = await runtime.useModel(
 - Optional embedding model support
 
 ### 2. Ollama
+
 - Local model server with optimized inference
 - Supports various open models in GGUF format
 - Configure with `USE_OLLAMA_TEXT_MODELS=true`
 - Supports small, medium, and large models
 - Optional embedding model support
 
-Note: The plugin validates that only one text model source is enabled at a time to prevent conflicts.
+Note: The plugin validates that only one text model source is enabled at a time to prevent conflicts.