@memberjunction/ai-lmstudio 4.0.0 → 4.1.0

package/README.md

@@ -0,0 +1,84 @@
+# @memberjunction/ai-lm-studio
+
+MemberJunction AI provider for LM Studio, enabling integration with locally-hosted models through LM Studio's OpenAI-compatible API. This package extends the OpenAI provider to connect to LM Studio's local inference server.
+
+## Architecture
+
+```mermaid
+graph TD
+    A["LMStudioLLM<br/>(Provider)"] -->|extends| B["OpenAILLM<br/>(@memberjunction/ai-openai)"]
+    B -->|extends| C["BaseLLM<br/>(@memberjunction/ai)"]
+    A -->|connects to| D["LM Studio Server<br/>(localhost:1234/v1)"]
+    D -->|runs| E["Local Models<br/>(GGUF, GGML)"]
+    C -->|registered via| F["@RegisterClass"]
+
+    style A fill:#7c5295,stroke:#563a6b,color:#fff
+    style B fill:#2d6a9f,stroke:#1a4971,color:#fff
+    style C fill:#2d6a9f,stroke:#1a4971,color:#fff
+    style D fill:#2d8659,stroke:#1a5c3a,color:#fff
+    style E fill:#b8762f,stroke:#8a5722,color:#fff
+    style F fill:#b8762f,stroke:#8a5722,color:#fff
+```
+
+## Features
+
+- **Local Model Hosting**: Run AI models locally without cloud dependencies
+- **OpenAI Compatible**: Inherits all features from the OpenAI provider
+- **Streaming**: Full streaming support for real-time responses
+- **No API Key Required**: Connects to local server (API key parameter ignored)
+- **Model Flexibility**: Use any model loaded in LM Studio (GGUF, GGML formats)
+- **Privacy**: All data stays on your local machine
+- **Configurable Endpoint**: Support for custom host and port settings
+
+## Installation
+
+```bash
+npm install @memberjunction/ai-lm-studio
+```
+
+## Usage
+
+```typescript
+import { LMStudioLLM } from '@memberjunction/ai-lm-studio';
+
+// API key is not used but required by the interface
+const llm = new LMStudioLLM('not-used');
+
+const result = await llm.ChatCompletion({
+    model: 'local-model', // Model loaded in LM Studio
+    messages: [
+        { role: 'system', content: 'You are a helpful assistant.' },
+        { role: 'user', content: 'Explain how local inference works.' }
+    ],
+    temperature: 0.7
+});
+
+if (result.success) {
+    console.log(result.data.choices[0].message.content);
+}
+```
+
+## Configuration
+
+The default endpoint is `http://localhost:1234/v1`. Configure via `SetAdditionalSettings` if using a different host/port.
+
+## How It Works
+
+`LMStudioLLM` is a thin subclass of `OpenAILLM` that redirects API calls to LM Studio's local server endpoint. LM Studio provides an OpenAI-compatible API, so all chat, streaming, and parameter handling is inherited from the OpenAI provider.
+
+## Prerequisites
+
+1. Install [LM Studio](https://lmstudio.ai/)
+2. Download and load a model in LM Studio
+3. Start the local server (default: port 1234)
+4. Configure the provider in your MemberJunction application
+
+## Class Registration
+
+Registered as `LMStudioLLM` via `@RegisterClass(BaseLLM, 'LMStudioLLM')`.
+
+## Dependencies
+
+- `@memberjunction/ai` - Core AI abstractions
+- `@memberjunction/ai-openai` - OpenAI provider (parent class)
+- `@memberjunction/global` - Class registration

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@memberjunction/ai-lmstudio",
   "type": "module",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "MemberJunction Wrapper for LM Studio AI - Local Inference Engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,8 +20,8 @@
     "typescript": "^5.9.3"
   },
   "dependencies": {
-    "@memberjunction/ai": "4.0.0",
-    "@memberjunction/global": "4.0.0",
+    "@memberjunction/ai": "4.1.0",
+    "@memberjunction/global": "4.1.0",
     "@lmstudio/sdk": "^1.5.0"
   },
   "repository": {