0.6.0

changelog.md

@@ -1,5 +1,122 @@
 # Changelog
 
+## 2025-09-28 - 0.6.0 - feat(research)
+Introduce research API with provider implementations, docs and tests
+
+- Add ResearchOptions and ResearchResponse interfaces and a new abstract research() method to MultiModalModel
+- Implement research() for OpenAiProvider (deep research model selection, optional web search/tools, background flag, source extraction)
+- Implement research() for AnthropicProvider (web search tool support, domain filters, citation extraction)
+- Implement research() for PerplexityProvider (sonar / sonar-pro model usage and citation parsing)
+- Add research() stubs to Exo, Groq, Ollama and XAI providers that throw a clear 'not yet supported' error to preserve interface compatibility
+- Add tests for research interfaces and provider research methods (test files updated/added)
+- Add documentation: readme.research.md describing the research API, usage and configuration
+- Export additional providers from ts/index.ts and update provider typings/imports across files
+- Add a 'typecheck' script to package.json
+- Add .claude/settings.local.json (local agent permissions for CI/dev tasks)
+
+## 2025-08-12 - 0.5.11 - fix(openaiProvider)
+Update default chat model to gpt-5-mini and bump dependency versions
+
+- Changed default chat model in OpenAiProvider from 'o3-mini' and 'o4-mini' to 'gpt-5-mini'
+- Upgraded @anthropic-ai/sdk from ^0.57.0 to ^0.59.0
+- Upgraded openai from ^5.11.0 to ^5.12.2
+- Added new local Claude settings configuration (.claude/settings.local.json)
+
+## 2025-08-03 - 0.5.10 - fix(dependencies)
+Update SmartPdf to v4.1.1 for enhanced PDF processing capabilities
+
+- Updated @push.rocks/smartpdf from ^3.3.0 to ^4.1.1
+- Enhanced PDF conversion with improved scale options and quality controls
+- Dependency updates for better performance and compatibility
+
+## 2025-08-01 - 0.5.9 - fix(documentation)
+Remove contribution section from readme
+
+- Removed the contribution section from readme.md as requested
+- Kept the roadmap section for future development plans
+
+## 2025-08-01 - 0.5.8 - fix(core)
+Fix SmartPdf lifecycle management and update dependencies
+
+- Moved SmartPdf instance management to the MultiModalModel base class for better resource sharing
+- Fixed memory leaks by properly implementing cleanup in the base class stop() method
+- Updated SmartAi class to properly stop all providers on shutdown
+- Updated @push.rocks/smartrequest from v2.1.0 to v4.2.1 with migration to new API
+- Enhanced readme with professional documentation and feature matrix
+
+## 2025-07-26 - 0.5.7 - fix(provider.openai)
+Fix stream type mismatch in audio method
+
+- Fixed type error where OpenAI SDK returns a web ReadableStream but the audio method needs to return a Node.js ReadableStream
+- Added conversion using Node.js's built-in Readable.fromWeb() method
+
+## 2025-07-25 - 0.5.5 - feat(documentation)
+Comprehensive documentation enhancement and test improvements
+
+- Completely rewrote readme.md with detailed provider comparisons, advanced usage examples, and performance tips
+- Added comprehensive examples for all supported providers (OpenAI, Anthropic, Perplexity, Groq, XAI, Ollama, Exo)
+- Included detailed sections on chat interactions, streaming, TTS, vision processing, and document analysis
+- Added verbose flag to test script for better debugging
+
+## 2025-05-13 - 0.5.4 - fix(provider.openai)
+Update dependency versions, clean test imports, and adjust default OpenAI model configurations
+
+- Bump dependency versions in package.json (@git.zone/tsbuild, @push.rocks/tapbundle, openai, etc.)
+- Change default chatModel from 'gpt-4o' to 'o4-mini' and visionModel from 'gpt-4o' to '04-mini' in provider.openai.ts
+- Remove unused 'expectAsync' import from test file
+
+## 2025-04-03 - 0.5.3 - fix(package.json)
+Add explicit packageManager field to package.json
+
+- Include the packageManager property to specify the pnpm version and checksum.
+- Align package metadata with current standards.
+
+## 2025-04-03 - 0.5.2 - fix(readme)
+Remove redundant conclusion section from README to streamline documentation.
+
+- Eliminated the conclusion block describing SmartAi's capabilities and documentation pointers.
+
+## 2025-02-25 - 0.5.1 - fix(OpenAiProvider)
+Corrected audio model ID in OpenAiProvider
+
+- Fixed audio model identifier from 'o3-mini' to 'tts-1-hd' in the OpenAiProvider's audio method.
+- Addressed minor code formatting issues in test suite for better readability.
+- Corrected spelling errors in test documentation and comments.
+
+## 2025-02-25 - 0.5.0 - feat(documentation and configuration)
+Enhanced package and README documentation
+
+- Expanded the package description to better reflect the library's capabilities.
+- Improved README with detailed usage examples for initialization, chat interactions, streaming chat, audio generation, document analysis, and vision processing.
+- Provided error handling strategies and advanced streaming customization examples.
+
+## 2025-02-25 - 0.4.2 - fix(core)
+Fix OpenAI chat streaming and PDF document processing logic.
+
+- Updated OpenAI chat streaming to handle new async iterable format.
+- Improved PDF document processing by filtering out empty image buffers.
+- Removed unsupported temperature options from OpenAI requests.
+
+## 2025-02-25 - 0.4.1 - fix(provider)
+Fix provider modules for consistency
+
+- Updated TypeScript interfaces and options in provider modules for better type safety.
+- Modified transform stream handlers in Exo, Groq, and Ollama providers for consistency.
+- Added optional model options to OpenAI provider for custom model usage.
+
+## 2025-02-08 - 0.4.0 - feat(core)
+Added support for Exo AI provider
+
+- Introduced ExoProvider with chat functionalities.
+- Updated SmartAi class to initialize ExoProvider.
+- Extended Conversation class to support ExoProvider.
+
+## 2025-02-05 - 0.3.3 - fix(documentation)
+Update readme with detailed license and legal information.
+
+- Added explicit section on License and Legal Information in the README.
+- Clarified the use of trademarks and company information.
+
 ## 2025-02-05 - 0.3.2 - fix(documentation)
 Remove redundant badges from readme
 

npmextra.json

@@ -5,20 +5,33 @@
       "githost": "code.foss.global",
       "gitscope": "push.rocks",
       "gitrepo": "smartai",
-      "description": "A TypeScript library for integrating and interacting with multiple AI models, offering capabilities for chat and potentially audio responses.",
+      "description": "SmartAi is a versatile TypeScript library designed to facilitate integration and interaction with various AI models, offering functionalities for chat, audio generation, document processing, and vision tasks.",
       "npmPackagename": "@push.rocks/smartai",
       "license": "MIT",
       "projectDomain": "push.rocks",
       "keywords": [
         "AI integration",
-        "chatbot",
         "TypeScript",
+        "chatbot",
         "OpenAI",
         "Anthropic",
-        "multi-model support",
+        "multi-model",
-        "audio responses",
+        "audio generation",
         "text-to-speech",
-        "streaming chat"
+        "document processing",
+        "vision processing",
+        "streaming chat",
+        "API",
+        "multiple providers",
+        "AI models",
+        "synchronous chat",
+        "asynchronous chat",
+        "real-time interaction",
+        "content analysis",
+        "image description",
+        "document classification",
+        "AI toolkit",
+        "provider switching"
       ]
     }
   },

package.json

@@ -1,37 +1,38 @@
 {
   "name": "@push.rocks/smartai",
-  "version": "0.3.2",
+  "version": "0.6.0",
   "private": false,
-  "description": "A TypeScript library for integrating and interacting with multiple AI models, offering capabilities for chat and potentially audio responses.",
+  "description": "SmartAi is a versatile TypeScript library designed to facilitate integration and interaction with various AI models, offering functionalities for chat, audio generation, document processing, and vision tasks.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "type": "module",
   "author": "Task Venture Capital GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest test/ --web)",
+    "test": "(tstest test/ --web --verbose)",
+    "typecheck": "tsbuild check",
     "build": "(tsbuild --web --allowimplicitany)",
     "buildDocs": "(tsdoc)"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.84",
+    "@git.zone/tsbuild": "^2.6.4",
-    "@git.zone/tsbundle": "^2.0.5",
+    "@git.zone/tsbundle": "^2.5.1",
-    "@git.zone/tsrun": "^1.2.49",
+    "@git.zone/tsrun": "^1.3.3",
-    "@git.zone/tstest": "^1.0.90",
+    "@git.zone/tstest": "^2.3.2",
-    "@push.rocks/qenv": "^6.0.5",
+    "@push.rocks/qenv": "^6.1.0",
-    "@push.rocks/tapbundle": "^5.3.0",
+    "@push.rocks/tapbundle": "^6.0.3",
-    "@types/node": "^22.5.5"
+    "@types/node": "^22.15.17"
   },
   "dependencies": {
-    "@anthropic-ai/sdk": "^0.27.3",
+    "@anthropic-ai/sdk": "^0.59.0",
-    "@push.rocks/smartarray": "^1.0.8",
+    "@push.rocks/smartarray": "^1.1.0",
-    "@push.rocks/smartfile": "^11.0.21",
+    "@push.rocks/smartfile": "^11.2.5",
-    "@push.rocks/smartpath": "^5.0.18",
+    "@push.rocks/smartpath": "^6.0.0",
-    "@push.rocks/smartpdf": "^3.1.6",
+    "@push.rocks/smartpdf": "^4.1.1",
-    "@push.rocks/smartpromise": "^4.0.4",
+    "@push.rocks/smartpromise": "^4.2.3",
-    "@push.rocks/smartrequest": "^2.0.22",
+    "@push.rocks/smartrequest": "^4.2.1",
     "@push.rocks/webstream": "^1.0.10",
-    "openai": "^4.62.1"
+    "openai": "^5.12.2"
   },
   "repository": {
     "type": "git",
@@ -58,13 +59,33 @@
   ],
   "keywords": [
     "AI integration",
-    "chatbot",
     "TypeScript",
+    "chatbot",
     "OpenAI",
     "Anthropic",
-    "multi-model support",
+    "multi-model",
-    "audio responses",
+    "audio generation",
     "text-to-speech",
-    "streaming chat"
+    "document processing",
+    "vision processing",
+    "streaming chat",
+    "API",
+    "multiple providers",
+    "AI models",
+    "synchronous chat",
+    "asynchronous chat",
+    "real-time interaction",
+    "content analysis",
+    "image description",
+    "document classification",
+    "AI toolkit",
+    "provider switching"
+  ],
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild",
+      "puppeteer"
     ]
+  },
+  "packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6"
 }

readme.md

@@ -1,331 +1,482 @@
 # @push.rocks/smartai
+**One API to rule them all** 🚀
 
-[![npm version](https://badge.fury.io/js/%40push.rocks%2Fsmartai.svg)](https://www.npmjs.com/package/@push.rocks/smartai)
+[![npm version](https://img.shields.io/npm/v/@push.rocks/smartai.svg)](https://www.npmjs.com/package/@push.rocks/smartai)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue.svg)](https://www.typescriptlang.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-SmartAi is a comprehensive TypeScript library that provides a standardized interface for integrating and interacting with multiple AI models. It supports a range of operations from synchronous and streaming chat to audio generation, document processing, and vision tasks.
+SmartAI unifies the world's leading AI providers - OpenAI, Anthropic, Perplexity, Ollama, Groq, XAI, and Exo - under a single, elegant TypeScript interface. Build AI applications at lightning speed without vendor lock-in. 
 
-## Table of Contents
+## 🎯 Why SmartAI?
 
-- [Features](#features)
+- **🔌 Universal Interface**: Write once, run with any AI provider. Switch between GPT-4, Claude, Llama, or Grok with a single line change.
-- [Installation](#installation)
+- **🛡️ Type-Safe**: Full TypeScript support with comprehensive type definitions for all operations
-- [Supported AI Providers](#supported-ai-providers)
+- **🌊 Streaming First**: Built for real-time applications with native streaming support
-- [Quick Start](#quick-start)
+- **🎨 Multi-Modal**: Seamlessly work with text, images, audio, and documents
-- [Usage Examples](#usage-examples)
+- **🏠 Local & Cloud**: Support for both cloud providers and local models via Ollama
-  - [Chat Interactions](#chat-interactions)
+- **⚡ Zero Lock-In**: Your code remains portable across all AI providers
-  - [Streaming Chat](#streaming-chat)
-  - [Audio Generation](#audio-generation)
-  - [Document Processing](#document-processing)
-  - [Vision Processing](#vision-processing)
-- [Error Handling](#error-handling)
-- [Development](#development)
-  - [Running Tests](#running-tests)
-  - [Building the Project](#building-the-project)
-- [Contributing](#contributing)
-- [License](#license)
-- [Legal Information](#legal-information)
 
-## Features
+## 🚀 Quick Start
-
-- **Unified API:** Seamlessly integrate multiple AI providers with a consistent interface.
-- **Chat & Streaming:** Support for both synchronous and real-time streaming chat interactions.
-- **Audio & Vision:** Generate audio responses and perform detailed image analysis.
-- **Document Processing:** Analyze PDFs and other documents using vision models.
-- **Extensible:** Easily extend the library to support additional AI providers.
-
-## Installation
-
-To install SmartAi, run the following command:
 
 ```bash
 npm install @push.rocks/smartai
 ```
 
-This will add the package to your project’s dependencies.
-
-## Supported AI Providers
-
-SmartAi supports multiple AI providers. Configure each provider with its corresponding token or settings:
-
-### OpenAI
-
-- **Models:** GPT-4, GPT-3.5-turbo, GPT-4-vision-preview
-- **Features:** Chat, Streaming, Audio Generation, Vision, Document Processing
-- **Configuration Example:**
-  
-  ```typescript
-  openaiToken: 'your-openai-token'
-  ```
-
-### X.AI
-
-- **Models:** Grok-2-latest
-- **Features:** Chat, Streaming, Document Processing
-- **Configuration Example:**
-  
-  ```typescript
-  xaiToken: 'your-xai-token'
-  ```
-
-### Anthropic
-
-- **Models:** Claude-3-opus-20240229
-- **Features:** Chat, Streaming, Vision, Document Processing
-- **Configuration Example:**
-  
-  ```typescript
-  anthropicToken: 'your-anthropic-token'
-  ```
-
-### Perplexity
-
-- **Models:** Mixtral-8x7b-instruct
-- **Features:** Chat, Streaming
-- **Configuration Example:**
-  
-  ```typescript
-  perplexityToken: 'your-perplexity-token'
-  ```
-
-### Groq
-
-- **Models:** Llama-3.3-70b-versatile
-- **Features:** Chat, Streaming
-- **Configuration Example:**
-  
-  ```typescript
-  groqToken: 'your-groq-token'
-  ```
-
-### Ollama
-
-- **Models:** Configurable (default: llama2; use llava for vision/document tasks)
-- **Features:** Chat, Streaming, Vision, Document Processing
-- **Configuration Example:**
-  
-  ```typescript
-  ollama: {
-    baseUrl: 'http://localhost:11434', // Optional
-    model: 'llama2',                  // Optional
-    visionModel: 'llava'               // Optional for vision and document tasks
-  }
-  ```
-
-## Quick Start
-
-Initialize SmartAi with the provider configurations you plan to use:
-
 ```typescript
 import { SmartAi } from '@push.rocks/smartai';
 
-const smartAi = new SmartAi({
+// Initialize with your favorite providers
-  openaiToken: 'your-openai-token',
+const ai = new SmartAi({
-  xaiToken: 'your-xai-token',
+  openaiToken: 'sk-...',
-  anthropicToken: 'your-anthropic-token',
+  anthropicToken: 'sk-ant-...'
-  perplexityToken: 'your-perplexity-token',
-  groqToken: 'your-groq-token',
-  ollama: {
-    baseUrl: 'http://localhost:11434',
-    model: 'llama2'
-  }
 });
 
-await smartAi.start();
+await ai.start();
-```
 
-## Usage Examples
+// Same API, multiple providers
-
+const response = await ai.openaiProvider.chat({
-### Chat Interactions
-
-**Synchronous Chat:**
-
-```typescript
-const response = await smartAi.openaiProvider.chat({
   systemMessage: 'You are a helpful assistant.',
-  userMessage: 'What is the capital of France?',
+  userMessage: 'Explain quantum computing in simple terms',
-  messageHistory: [] // Include previous conversation messages if applicable
+  messageHistory: []
 });
-
-console.log(response.message);
 ```
 
-### Streaming Chat
+## 📊 Provider Capabilities Matrix
 
-**Real-Time Streaming:**
+Choose the right provider for your use case:
+
+| Provider | Chat | Streaming | TTS | Vision | Documents | Highlights |
+|----------|:----:|:---------:|:---:|:------:|:---------:|------------|
+| **OpenAI** | ✅ | ✅ | ✅ | ✅ | ✅ | • GPT-4, DALL-E 3<br>• Industry standard<br>• Most features |
+| **Anthropic** | ✅ | ✅ | ❌ | ✅ | ✅ | • Claude 3 Opus<br>• Superior reasoning<br>• 200k context |
+| **Ollama** | ✅ | ✅ | ❌ | ✅ | ✅ | • 100% local<br>• Privacy-first<br>• No API costs |
+| **XAI** | ✅ | ✅ | ❌ | ❌ | ✅ | • Grok models<br>• Real-time data<br>• Uncensored |
+| **Perplexity** | ✅ | ✅ | ❌ | ❌ | ❌ | • Web-aware<br>• Research-focused<br>• Citations |
+| **Groq** | ✅ | ✅ | ❌ | ❌ | ❌ | • 10x faster<br>• LPU inference<br>• Low latency |
+| **Exo** | ✅ | ✅ | ❌ | ❌ | ❌ | • Distributed<br>• P2P compute<br>• Decentralized |
+
+## 🎮 Core Features
+
+### 💬 Universal Chat Interface
+
+Works identically across all providers:
 
 ```typescript
-const textEncoder = new TextEncoder();
+// Use GPT-4 for complex reasoning
-const textDecoder = new TextDecoder();
+const gptResponse = await ai.openaiProvider.chat({
+  systemMessage: 'You are a expert physicist.',
+  userMessage: 'Explain the implications of quantum entanglement',
+  messageHistory: []
+});
 
-// Create a transform stream for sending and receiving data
+// Use Claude for safety-critical applications
-const { writable, readable } = new TransformStream();
+const claudeResponse = await ai.anthropicProvider.chat({
-const writer = writable.getWriter();
+  systemMessage: 'You are a medical advisor.',
+  userMessage: 'Review this patient data for concerns',
+  messageHistory: []
+});
 
-const message = {
+// Use Groq for lightning-fast responses
-  role: 'user',
+const groqResponse = await ai.groqProvider.chat({
-  content: 'Tell me a story about a brave knight'
+  systemMessage: 'You are a code reviewer.',
-};
+  userMessage: 'Quick! Find the bug in this code: ...',
+  messageHistory: []
+});
+```
 
-writer.write(textEncoder.encode(JSON.stringify(message) + '\n'));
+### 🌊 Real-Time Streaming
 
-// Start streaming the response
+Build responsive chat interfaces with token-by-token streaming:
-const stream = await smartAi.openaiProvider.chatStream(readable);
+
+```typescript
+// Create a chat stream
+const stream = await ai.openaiProvider.chatStream(inputStream);
 const reader = stream.getReader();
 
+// Display responses as they arrive
 while (true) {
   const { done, value } = await reader.read();
   if (done) break;
-  console.log('AI:', value);
+  
+  // Update UI in real-time
+  process.stdout.write(value);
 }
 ```
 
-### Audio Generation
+### 🎙️ Text-to-Speech
 
-Generate audio (supported by providers like OpenAI):
+Generate natural voices with OpenAI:
 
 ```typescript
-const audioStream = await smartAi.openaiProvider.audio({
+const audioStream = await ai.openaiProvider.audio({
-  message: 'Hello, this is a test of text-to-speech'
+  message: 'Welcome to the future of AI development!'
 });
 
-// Process the audio stream, for example, play it or save to a file.
+// Stream directly to speakers
+audioStream.pipe(speakerOutput);
+
+// Or save to file
+audioStream.pipe(fs.createWriteStream('welcome.mp3'));
 ```
 
-### Document Processing
+### 👁️ Vision Analysis
 
-Analyze and extract key information from documents:
+Understand images with multiple providers:
 
 ```typescript
-// Example using OpenAI
+const image = fs.readFileSync('product-photo.jpg');
-const documentResult = await smartAi.openaiProvider.document({
+
-  systemMessage: 'Classify the document type',
+// OpenAI: General purpose vision
-  userMessage: 'What type of document is this?',
+const gptVision = await ai.openaiProvider.vision({
+  image,
+  prompt: 'Describe this product and suggest marketing angles'
+});
+
+// Anthropic: Detailed analysis
+const claudeVision = await ai.anthropicProvider.vision({
+  image,
+  prompt: 'Identify any safety concerns or defects'
+});
+
+// Ollama: Private, local analysis
+const ollamaVision = await ai.ollamaProvider.vision({
+  image,
+  prompt: 'Extract all text and categorize the content'
+});
+```
+
+### 📄 Document Intelligence
+
+Extract insights from PDFs with AI:
+
+```typescript
+const contract = fs.readFileSync('contract.pdf');
+const invoice = fs.readFileSync('invoice.pdf');
+
+// Analyze documents
+const analysis = await ai.openaiProvider.document({
+  systemMessage: 'You are a legal expert.',
+  userMessage: 'Compare these documents and highlight key differences',
   messageHistory: [],
-  pdfDocuments: [pdfBuffer] // Uint8Array containing the PDF content
+  pdfDocuments: [contract, invoice]
 });
-```
 
-Other providers (e.g., Ollama and Anthropic) follow a similar pattern:
+// Multi-document analysis
-
+const taxDocs = [form1099, w2, receipts];
-```typescript
+const taxAnalysis = await ai.anthropicProvider.document({
-// Using Ollama for document processing
+  systemMessage: 'You are a tax advisor.',
-const ollamaResult = await smartAi.ollamaProvider.document({
+  userMessage: 'Prepare a tax summary from these documents',
-  systemMessage: 'You are a document analysis assistant',
-  userMessage: 'Extract key information from this document',
   messageHistory: [],
-  pdfDocuments: [pdfBuffer]
+  pdfDocuments: taxDocs
 });
 ```
 
+### 🔄 Persistent Conversations
+
+Maintain context across interactions:
+
 ```typescript
-// Using Anthropic for document processing
+// Create a coding assistant conversation
-const anthropicResult = await smartAi.anthropicProvider.document({
+const assistant = ai.createConversation('openai');
-  systemMessage: 'Analyze the document',
+await assistant.setSystemMessage('You are an expert TypeScript developer.');
-  userMessage: 'Please extract the main points',
+
-  messageHistory: [],
+// First question
-  pdfDocuments: [pdfBuffer]
+const inputWriter = assistant.getInputStreamWriter();
-});
+await inputWriter.write('How do I implement a singleton pattern?');
+
+// Continue the conversation
+await inputWriter.write('Now show me how to make it thread-safe');
+
+// The assistant remembers the entire context
 ```
 
-### Vision Processing
+## 🚀 Real-World Examples
 
-Analyze images with vision capabilities:
+### Build a Customer Support Bot
 
 ```typescript
-// Using OpenAI GPT-4 Vision
+const supportBot = new SmartAi({
-const imageDescription = await smartAi.openaiProvider.vision({
+  anthropicToken: process.env.ANTHROPIC_KEY // Claude for empathetic responses
-  image: imageBuffer, // Uint8Array containing image data
-  prompt: 'What do you see in this image?'
 });
 
-// Using Ollama for vision tasks
+async function handleCustomerQuery(query: string, history: ChatMessage[]) {
-const ollamaImageAnalysis = await smartAi.ollamaProvider.vision({
-  image: imageBuffer,
-  prompt: 'Analyze this image in detail'
-});
-
-// Using Anthropic for vision analysis
-const anthropicImageAnalysis = await smartAi.anthropicProvider.vision({
-  image: imageBuffer,
-  prompt: 'Describe the contents of this image'
-});
-```
-
-## Error Handling
-
-Always wrap API calls in try-catch blocks to manage errors effectively:
-
-```typescript
   try {
-  const response = await smartAi.openaiProvider.chat({
+    const response = await supportBot.anthropicProvider.chat({
-    systemMessage: 'You are a helpful assistant.',
+      systemMessage: `You are a helpful customer support agent. 
-    userMessage: 'Hello!',
+                      Be empathetic, professional, and solution-oriented.`,
+      userMessage: query,
+      messageHistory: history
+    });
+    
+    return response.message;
+  } catch (error) {
+    // Fallback to another provider if needed
+    return await supportBot.openaiProvider.chat({...});
+  }
+}
+```
+
+### Create a Code Review Assistant
+
+```typescript
+const codeReviewer = new SmartAi({
+  groqToken: process.env.GROQ_KEY // Groq for speed
+});
+
+async function reviewCode(code: string, language: string) {
+  const startTime = Date.now();
+  
+  const review = await codeReviewer.groqProvider.chat({
+    systemMessage: `You are a ${language} expert. Review code for:
+                    - Security vulnerabilities
+                    - Performance issues  
+                    - Best practices
+                    - Potential bugs`,
+    userMessage: `Review this code:\n\n${code}`,
     messageHistory: []
   });
-  console.log(response.message);
+  
-} catch (error: any) {
+  console.log(`Review completed in ${Date.now() - startTime}ms`);
-  console.error('AI provider error:', error.message);
+  return review.message;
 }
 ```
 
-## Development
+### Build a Research Assistant
 
-### Running Tests
+```typescript
+const researcher = new SmartAi({
+  perplexityToken: process.env.PERPLEXITY_KEY
+});
 
-To run the test suite, use the following command:
+async function research(topic: string) {
+  // Perplexity excels at web-aware research
+  const findings = await researcher.perplexityProvider.chat({
+    systemMessage: 'You are a research assistant. Provide factual, cited information.',
+    userMessage: `Research the latest developments in ${topic}`,
+    messageHistory: []
+  });
   
-```bash
+  return findings.message;
-npm run test
+}
 ```
 
-Ensure your environment is configured with the appropriate tokens and settings for the providers you are testing.
+### Local AI for Sensitive Data
 
-### Building the Project
+```typescript
+const localAI = new SmartAi({
+  ollama: {
+    baseUrl: 'http://localhost:11434',
+    model: 'llama2',
+    visionModel: 'llava'
+  }
+});
 
-Compile the TypeScript code and build the package using:
+// Process sensitive documents without leaving your infrastructure
+async function analyzeSensitiveDoc(pdfBuffer: Buffer) {
+  const analysis = await localAI.ollamaProvider.document({
+    systemMessage: 'Extract and summarize key information.',
+    userMessage: 'Analyze this confidential document',
+    messageHistory: [],
+    pdfDocuments: [pdfBuffer]
+  });
   
-```bash
+  // Data never leaves your servers
-npm run build
+  return analysis.message;
+}
 ```
 
-This command prepares the library for distribution.
+## ⚡ Performance Tips
 
-## Contributing
+### 1. Provider Selection Strategy
 
-Contributions are welcome! Please follow these steps:
+```typescript
+class SmartAIRouter {
+  constructor(private ai: SmartAi) {}
   
-1. Fork the repository.
+  async query(message: string, requirements: {
-2. Create a feature branch:  
+    speed?: boolean;
-   ```bash
+    accuracy?: boolean;
-   git checkout -b feature/my-feature
+    cost?: boolean;
+    privacy?: boolean;
+  }) {
+    if (requirements.privacy) {
+      return this.ai.ollamaProvider.chat({...}); // Local only
+    }
+    if (requirements.speed) {
+      return this.ai.groqProvider.chat({...}); // 10x faster
+    }
+    if (requirements.accuracy) {
+      return this.ai.anthropicProvider.chat({...}); // Best reasoning
+    }
+    // Default fallback
+    return this.ai.openaiProvider.chat({...});
+  }
+}
 ```
-3. Commit your changes with clear messages:  
+
-   ```bash
+### 2. Streaming for Large Responses
-   git commit -m 'Add new feature'
+
+```typescript
+// Don't wait for the entire response
+async function streamResponse(userQuery: string) {
+  const stream = await ai.openaiProvider.chatStream(createInputStream(userQuery));
+  
+  // Process tokens as they arrive
+  for await (const chunk of stream) {
+    updateUI(chunk); // Immediate feedback
+    await processChunk(chunk); // Parallel processing
+  }
+}
 ```
-4. Push your branch to your fork:  
+
-   ```bash
+### 3. Parallel Multi-Provider Queries
-   git push origin feature/my-feature
+
+```typescript
+// Get the best answer from multiple AIs
+async function consensusQuery(question: string) {
+  const providers = [
+    ai.openaiProvider.chat({...}),
+    ai.anthropicProvider.chat({...}),
+    ai.perplexityProvider.chat({...})
+  ];
+  
+  const responses = await Promise.all(providers);
+  return synthesizeResponses(responses);
+}
 ```
-5. Open a Pull Request with a detailed description of your changes.
 
-## License
+## 🛠️ Advanced Features
 
-This project is licensed under the [MIT License](LICENSE).
+### Custom Streaming Transformations
 
-## Legal Information
+```typescript
+// Add real-time translation
+const translationStream = new TransformStream({
+  async transform(chunk, controller) {
+    const translated = await translateChunk(chunk);
+    controller.enqueue(translated);
+  }
+});
+
+const responseStream = await ai.openaiProvider.chatStream(input);
+const translatedStream = responseStream.pipeThrough(translationStream);
+```
+
+### Error Handling & Fallbacks
+
+```typescript
+class ResilientAI {
+  private providers = ['openai', 'anthropic', 'groq'];
+  
+  async query(opts: ChatOptions): Promise<ChatResponse> {
+    for (const provider of this.providers) {
+      try {
+        return await this.ai[`${provider}Provider`].chat(opts);
+      } catch (error) {
+        console.warn(`${provider} failed, trying next...`);
+        continue;
+      }
+    }
+    throw new Error('All providers failed');
+  }
+}
+```
+
+### Token Counting & Cost Management
+
+```typescript
+// Track usage across providers
+class UsageTracker {
+  async trackedChat(provider: string, options: ChatOptions) {
+    const start = Date.now();
+    const response = await ai[`${provider}Provider`].chat(options);
+    
+    const usage = {
+      provider,
+      duration: Date.now() - start,
+      inputTokens: estimateTokens(options),
+      outputTokens: estimateTokens(response.message)
+    };
+    
+    await this.logUsage(usage);
+    return response;
+  }
+}
+```
+
+## 📦 Installation & Setup
+
+### Prerequisites
+
+- Node.js 16+ 
+- TypeScript 4.5+
+- API keys for your chosen providers
+
+### Environment Setup
+
+```bash
+# Install
+npm install @push.rocks/smartai
+
+# Set up environment variables
+export OPENAI_API_KEY=sk-...
+export ANTHROPIC_API_KEY=sk-ant-...
+export PERPLEXITY_API_KEY=pplx-...
+# ... etc
+```
+
+### TypeScript Configuration
+
+```json
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "lib": ["ES2022"],
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  }
+}
+```
+
+## 🎯 Choosing the Right Provider
+
+| Use Case | Recommended Provider | Why |
+|----------|---------------------|-----|
+| **General Purpose** | OpenAI | Most features, stable, well-documented |
+| **Complex Reasoning** | Anthropic | Superior logical thinking, safer outputs |
+| **Research & Facts** | Perplexity | Web-aware, provides citations |
+| **Speed Critical** | Groq | 10x faster inference, sub-second responses |
+| **Privacy Critical** | Ollama | 100% local, no data leaves your servers |
+| **Real-time Data** | XAI | Access to current information |
+| **Cost Sensitive** | Ollama/Exo | Free (local) or distributed compute |
+
+## 📈 Roadmap
+
+- [ ] Streaming function calls
+- [ ] Image generation support
+- [ ] Voice input processing
+- [ ] Fine-tuning integration
+- [ ] Embedding support
+- [ ] Agent framework
+- [ ] More providers (Cohere, AI21, etc.)
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
 
 ### Trademarks
 
-This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and its related products or services are trademarks of Task Venture Capital GmbH and are not covered by the MIT License. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines.
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
 
 ### Company Information
 
 Task Venture Capital GmbH  
-Registered at District Court Bremen HRB 35230 HB, Germany  
+Registered at District court Bremen HRB 35230 HB, Germany
-Contact: hello@task.vc
 
-By using this repository, you agree to the terms outlined in this section.
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
 
----
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
-
-Happy coding with SmartAi!

readme.research.md

@@ -0,0 +1,177 @@
+# SmartAI Research API Implementation
+
+This document describes the new research capabilities added to the SmartAI library, enabling web search and deep research features for OpenAI and Anthropic providers.
+
+## Features Added
+
+### 1. Research Method Interface
+
+Added a new `research()` method to the `MultiModalModel` abstract class with the following interfaces:
+
+```typescript
+interface ResearchOptions {
+  query: string;
+  searchDepth?: 'basic' | 'advanced' | 'deep';
+  maxSources?: number;
+  includeWebSearch?: boolean;
+  background?: boolean;
+}
+
+interface ResearchResponse {
+  answer: string;
+  sources: Array<{
+    url: string;
+    title: string;
+    snippet: string;
+  }>;
+  searchQueries?: string[];
+  metadata?: any;
+}
+```
+
+### 2. OpenAI Provider Research Implementation
+
+The OpenAI provider now supports:
+- **Deep Research API** with models:
+  - `o3-deep-research-2025-06-26` (comprehensive analysis)
+  - `o4-mini-deep-research-2025-06-26` (lightweight, faster)
+- **Web Search** for standard models (gpt-5, o3, o3-pro, o4-mini)
+- **Background processing** for async deep research tasks
+
+### 3. Anthropic Provider Research Implementation
+
+The Anthropic provider now supports:
+- **Web Search API** with Claude models
+- **Domain filtering** (allow/block lists)
+- **Progressive searches** for comprehensive research
+- **Citation extraction** from responses
+
+### 4. Perplexity Provider Research Implementation
+
+The Perplexity provider implements research using:
+- **Sonar models** for standard searches
+- **Sonar Pro** for deep research
+- Built-in citation support
+
+### 5. Other Providers
+
+Added research method stubs to:
+- Groq Provider
+- Ollama Provider
+- xAI Provider
+- Exo Provider
+
+These providers throw a "not yet supported" error when research is called, maintaining interface compatibility.
+
+## Usage Examples
+
+### Basic Research with OpenAI
+
+```typescript
+import { OpenAiProvider } from '@push.rocks/smartai';
+
+const openai = new OpenAiProvider({
+  openaiToken: 'your-api-key',
+  researchModel: 'o4-mini-deep-research-2025-06-26'
+});
+
+await openai.start();
+
+const result = await openai.research({
+  query: 'What are the latest developments in quantum computing?',
+  searchDepth: 'basic',
+  includeWebSearch: true
+});
+
+console.log(result.answer);
+console.log('Sources:', result.sources);
+```
+
+### Deep Research with OpenAI
+
+```typescript
+const deepResult = await openai.research({
+  query: 'Comprehensive analysis of climate change mitigation strategies',
+  searchDepth: 'deep',
+  background: true
+});
+```
+
+### Research with Anthropic
+
+```typescript
+import { AnthropicProvider } from '@push.rocks/smartai';
+
+const anthropic = new AnthropicProvider({
+  anthropicToken: 'your-api-key',
+  enableWebSearch: true,
+  searchDomainAllowList: ['nature.com', 'science.org']
+});
+
+await anthropic.start();
+
+const result = await anthropic.research({
+  query: 'Latest breakthroughs in CRISPR gene editing',
+  searchDepth: 'advanced'
+});
+```
+
+### Research with Perplexity
+
+```typescript
+import { PerplexityProvider } from '@push.rocks/smartai';
+
+const perplexity = new PerplexityProvider({
+  perplexityToken: 'your-api-key'
+});
+
+const result = await perplexity.research({
+  query: 'Current state of autonomous vehicle technology',
+  searchDepth: 'deep' // Uses Sonar Pro model
+});
+```
+
+## Configuration Options
+
+### OpenAI Provider
+- `researchModel`: Specify deep research model (default: `o4-mini-deep-research-2025-06-26`)
+- `enableWebSearch`: Enable web search for standard models
+
+### Anthropic Provider
+- `enableWebSearch`: Enable web search capabilities
+- `searchDomainAllowList`: Array of allowed domains
+- `searchDomainBlockList`: Array of blocked domains
+
+## API Pricing
+
+- **OpenAI Deep Research**: $10 per 1,000 calls
+- **Anthropic Web Search**: $10 per 1,000 searches + standard token costs
+- **Perplexity Sonar**: $5 per 1,000 searches (Sonar Pro)
+
+## Testing
+
+Run the test suite:
+
+```bash
+pnpm test test/test.research.ts
+```
+
+All providers have been tested to ensure:
+- Research methods are properly exposed
+- Interfaces are correctly typed
+- Unsupported providers throw appropriate errors
+
+## Next Steps
+
+Future enhancements could include:
+1. Implementing Google Gemini Grounding API support
+2. Adding Brave Search API integration
+3. Implementing retry logic for rate limits
+4. Adding caching for repeated queries
+5. Supporting batch research operations
+
+## Notes
+
+- The implementation maintains backward compatibility
+- All existing methods continue to work unchanged
+- Research capabilities are optional and don't affect existing functionality

test/test.basic.ts

@@ -0,0 +1,92 @@
+import { tap, expect } from '@push.rocks/tapbundle';
+import * as smartai from '../ts/index.js';
+
+// Basic instantiation tests that don't require API tokens
+// These tests can run in CI/CD environments without credentials
+
+tap.test('Basic: should create SmartAi instance', async () => {
+  const testSmartai = new smartai.SmartAi({
+    openaiToken: 'dummy-token-for-testing'
+  });
+  expect(testSmartai).toBeInstanceOf(smartai.SmartAi);
+  expect(testSmartai.openaiProvider).toBeTruthy();
+});
+
+tap.test('Basic: should instantiate OpenAI provider', async () => {
+  const openaiProvider = new smartai.OpenAiProvider({
+    openaiToken: 'dummy-token'
+  });
+  expect(openaiProvider).toBeInstanceOf(smartai.OpenAiProvider);
+  expect(typeof openaiProvider.chat).toEqual('function');
+  expect(typeof openaiProvider.audio).toEqual('function');
+  expect(typeof openaiProvider.vision).toEqual('function');
+  expect(typeof openaiProvider.document).toEqual('function');
+  expect(typeof openaiProvider.research).toEqual('function');
+});
+
+tap.test('Basic: should instantiate Anthropic provider', async () => {
+  const anthropicProvider = new smartai.AnthropicProvider({
+    anthropicToken: 'dummy-token'
+  });
+  expect(anthropicProvider).toBeInstanceOf(smartai.AnthropicProvider);
+  expect(typeof anthropicProvider.chat).toEqual('function');
+  expect(typeof anthropicProvider.audio).toEqual('function');
+  expect(typeof anthropicProvider.vision).toEqual('function');
+  expect(typeof anthropicProvider.document).toEqual('function');
+  expect(typeof anthropicProvider.research).toEqual('function');
+});
+
+tap.test('Basic: should instantiate Perplexity provider', async () => {
+  const perplexityProvider = new smartai.PerplexityProvider({
+    perplexityToken: 'dummy-token'
+  });
+  expect(perplexityProvider).toBeInstanceOf(smartai.PerplexityProvider);
+  expect(typeof perplexityProvider.chat).toEqual('function');
+  expect(typeof perplexityProvider.research).toEqual('function');
+});
+
+tap.test('Basic: should instantiate Groq provider', async () => {
+  const groqProvider = new smartai.GroqProvider({
+    groqToken: 'dummy-token'
+  });
+  expect(groqProvider).toBeInstanceOf(smartai.GroqProvider);
+  expect(typeof groqProvider.chat).toEqual('function');
+  expect(typeof groqProvider.research).toEqual('function');
+});
+
+tap.test('Basic: should instantiate Ollama provider', async () => {
+  const ollamaProvider = new smartai.OllamaProvider({
+    baseUrl: 'http://localhost:11434'
+  });
+  expect(ollamaProvider).toBeInstanceOf(smartai.OllamaProvider);
+  expect(typeof ollamaProvider.chat).toEqual('function');
+  expect(typeof ollamaProvider.research).toEqual('function');
+});
+
+tap.test('Basic: should instantiate xAI provider', async () => {
+  const xaiProvider = new smartai.XaiProvider({
+    xaiToken: 'dummy-token'
+  });
+  expect(xaiProvider).toBeInstanceOf(smartai.XaiProvider);
+  expect(typeof xaiProvider.chat).toEqual('function');
+  expect(typeof xaiProvider.research).toEqual('function');
+});
+
+tap.test('Basic: should instantiate Exo provider', async () => {
+  const exoProvider = new smartai.ExoProvider({
+    exoBaseUrl: 'http://localhost:8000'
+  });
+  expect(exoProvider).toBeInstanceOf(smartai.ExoProvider);
+  expect(typeof exoProvider.chat).toEqual('function');
+  expect(typeof exoProvider.research).toEqual('function');
+});
+
+tap.test('Basic: all providers should extend MultiModalModel', async () => {
+  const openai = new smartai.OpenAiProvider({ openaiToken: 'test' });
+  const anthropic = new smartai.AnthropicProvider({ anthropicToken: 'test' });
+
+  expect(openai).toBeInstanceOf(smartai.MultiModalModel);
+  expect(anthropic).toBeInstanceOf(smartai.MultiModalModel);
+});
+
+export default tap.start();

test/test.interfaces.ts

@@ -0,0 +1,140 @@
+import { tap, expect } from '@push.rocks/tapbundle';
+import * as smartai from '../ts/index.js';
+
+// Test interface exports and type checking
+// These tests verify that all interfaces are properly exported and usable
+
+tap.test('Interfaces: ResearchOptions should be properly typed', async () => {
+  const testOptions: smartai.ResearchOptions = {
+    query: 'test query',
+    searchDepth: 'basic',
+    maxSources: 10,
+    includeWebSearch: true,
+    background: false
+  };
+
+  expect(testOptions).toBeInstanceOf(Object);
+  expect(testOptions.query).toEqual('test query');
+  expect(testOptions.searchDepth).toEqual('basic');
+});
+
+tap.test('Interfaces: ResearchResponse should be properly typed', async () => {
+  const testResponse: smartai.ResearchResponse = {
+    answer: 'test answer',
+    sources: [
+      {
+        url: 'https://example.com',
+        title: 'Example Source',
+        snippet: 'This is a snippet'
+      }
+    ],
+    searchQueries: ['query1', 'query2'],
+    metadata: {
+      model: 'test-model',
+      tokensUsed: 100
+    }
+  };
+
+  expect(testResponse).toBeInstanceOf(Object);
+  expect(testResponse.answer).toEqual('test answer');
+  expect(testResponse.sources).toBeArray();
+  expect(testResponse.sources[0].url).toEqual('https://example.com');
+});
+
+tap.test('Interfaces: ChatOptions should be properly typed', async () => {
+  const testChatOptions: smartai.ChatOptions = {
+    systemMessage: 'You are a helpful assistant',
+    userMessage: 'Hello',
+    messageHistory: [
+      { role: 'user', content: 'Previous message' },
+      { role: 'assistant', content: 'Previous response' }
+    ]
+  };
+
+  expect(testChatOptions).toBeInstanceOf(Object);
+  expect(testChatOptions.systemMessage).toBeTruthy();
+  expect(testChatOptions.messageHistory).toBeArray();
+});
+
+tap.test('Interfaces: ChatResponse should be properly typed', async () => {
+  const testChatResponse: smartai.ChatResponse = {
+    role: 'assistant',
+    message: 'This is a response'
+  };
+
+  expect(testChatResponse).toBeInstanceOf(Object);
+  expect(testChatResponse.role).toEqual('assistant');
+  expect(testChatResponse.message).toBeTruthy();
+});
+
+tap.test('Interfaces: ChatMessage should be properly typed', async () => {
+  const testMessage: smartai.ChatMessage = {
+    role: 'user',
+    content: 'Test message'
+  };
+
+  expect(testMessage).toBeInstanceOf(Object);
+  expect(testMessage.role).toBeOneOf(['user', 'assistant', 'system']);
+  expect(testMessage.content).toBeTruthy();
+});
+
+tap.test('Interfaces: Provider options should be properly typed', async () => {
+  // OpenAI options
+  const openaiOptions: smartai.IOpenaiProviderOptions = {
+    openaiToken: 'test-token',
+    chatModel: 'gpt-5-mini',
+    audioModel: 'tts-1-hd',
+    visionModel: '04-mini',
+    researchModel: 'o4-mini-deep-research-2025-06-26',
+    enableWebSearch: true
+  };
+
+  expect(openaiOptions).toBeInstanceOf(Object);
+  expect(openaiOptions.openaiToken).toBeTruthy();
+
+  // Anthropic options
+  const anthropicOptions: smartai.IAnthropicProviderOptions = {
+    anthropicToken: 'test-token',
+    enableWebSearch: true,
+    searchDomainAllowList: ['example.com'],
+    searchDomainBlockList: ['blocked.com']
+  };
+
+  expect(anthropicOptions).toBeInstanceOf(Object);
+  expect(anthropicOptions.anthropicToken).toBeTruthy();
+});
+
+tap.test('Interfaces: Search depth values should be valid', async () => {
+  const validDepths: smartai.ResearchOptions['searchDepth'][] = ['basic', 'advanced', 'deep'];
+
+  for (const depth of validDepths) {
+    const options: smartai.ResearchOptions = {
+      query: 'test',
+      searchDepth: depth
+    };
+    expect(options.searchDepth).toBeOneOf(['basic', 'advanced', 'deep', undefined]);
+  }
+});
+
+tap.test('Interfaces: Optional properties should work correctly', async () => {
+  // Minimal ResearchOptions
+  const minimalOptions: smartai.ResearchOptions = {
+    query: 'test query'
+  };
+
+  expect(minimalOptions.query).toBeTruthy();
+  expect(minimalOptions.searchDepth).toBeUndefined();
+  expect(minimalOptions.maxSources).toBeUndefined();
+
+  // Minimal ChatOptions
+  const minimalChat: smartai.ChatOptions = {
+    systemMessage: 'system',
+    userMessage: 'user',
+    messageHistory: []
+  };
+
+  expect(minimalChat.messageHistory).toBeArray();
+  expect(minimalChat.messageHistory.length).toEqual(0);
+});
+
+export default tap.start();

test/test.openai.ts

@@ -1,4 +1,4 @@
-import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
 import * as qenv from '@push.rocks/qenv';
 import * as smartrequest from '@push.rocks/smartrequest';
 import * as smartfile from '@push.rocks/smartfile';
@@ -9,38 +9,39 @@ import * as smartai from '../ts/index.js';
 
 let testSmartai: smartai.SmartAi;
 
-tap.test('should create a smartai instance', async () => {
+tap.test('OpenAI: should create a smartai instance with OpenAI provider', async () => {
   testSmartai = new smartai.SmartAi({
     openaiToken: await testQenv.getEnvVarOnDemand('OPENAI_TOKEN'),
   });
   await testSmartai.start();
 });
 
-tap.test('should create chat response with openai', async () => {
+tap.test('OpenAI: should create chat response', async () => {
   const userMessage = 'How are you?';
   const response = await testSmartai.openaiProvider.chat({
     systemMessage: 'Hello',
     userMessage: userMessage,
-    messageHistory: [
+    messageHistory: [],
-    ],
   });
   console.log(`userMessage: ${userMessage}`);
   console.log(response.message);
 });
 
-tap.test('should document a pdf', async () => {
+tap.test('OpenAI: should document a pdf', async () => {
   const pdfUrl = 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf';
-  const pdfResponse = await smartrequest.getBinary(pdfUrl);
+  const pdfResponse = await smartrequest.SmartRequest.create()
+    .url(pdfUrl)
+    .get();
   const result = await testSmartai.openaiProvider.document({
     systemMessage: 'Classify the document. Only the following answers are allowed: "invoice", "bank account statement", "contract", "other". The answer should only contain the keyword for machine use.',
     userMessage: "Classify the document.",
     messageHistory: [],
-    pdfDocuments: [pdfResponse.body],
+    pdfDocuments: [Buffer.from(await pdfResponse.arrayBuffer())],
   });
   console.log(result);
 });
 
-tap.test('should recognize companies in a pdf', async () => {
+tap.test('OpenAI: should recognize companies in a pdf', async () => {
   const pdfBuffer = await smartfile.fs.toBuffer('./.nogit/demo_without_textlayer.pdf');
   const result = await testSmartai.openaiProvider.document({
     systemMessage: `
@@ -55,7 +56,7 @@ tap.test('should recognize companies in a pdf', async () => {
             address: string;
             city: string;
             country: string;
-            EU: boolean; // wether the entity is within EU
+            EU: boolean; // whether the entity is within EU
           };
           entityReceiver: {
             type: 'official state entity' | 'company' | 'person';
@@ -63,7 +64,7 @@ tap.test('should recognize companies in a pdf', async () => {
             address: string;
             city: string;
             country: string;
-            EU: boolean; // wether the entity is within EU
+            EU: boolean; // whether the entity is within EU
           };
           date: string; // the date of the document as YYYY-MM-DD
           title: string; // a short title, suitable for a filename
@@ -75,9 +76,26 @@ tap.test('should recognize companies in a pdf', async () => {
     pdfDocuments: [pdfBuffer],
   });
   console.log(result);
-})
+});
 
-tap.test('should stop the smartai instance', async () => {
+tap.test('OpenAI: should create audio response', async () => {
+  // Call the audio method with a sample message.
+  const audioStream = await testSmartai.openaiProvider.audio({
+    message: 'This is a test of audio generation.',
+  });
+  // Read all chunks from the stream.
+  const chunks: Uint8Array[] = [];
+  for await (const chunk of audioStream) {
+    chunks.push(chunk as Uint8Array);
+  }
+  const audioBuffer = Buffer.concat(chunks);
+  await smartfile.fs.toFs(audioBuffer, './.nogit/testoutput.mp3');
+  console.log(`Audio Buffer length: ${audioBuffer.length}`);
+  // Assert that the resulting buffer is not empty.
+  expect(audioBuffer.length).toBeGreaterThan(0);
+});
+
+tap.test('OpenAI: should stop the smartai instance', async () => {
   await testSmartai.stop();
 });
 

test/test.research.ts

@@ -0,0 +1,65 @@
+import { tap, expect } from '@push.rocks/tapbundle';
+import * as smartai from '../ts/index.js';
+
+// Test the research capabilities
+tap.test('OpenAI research method should exist', async () => {
+  const openaiProvider = new smartai.OpenAiProvider({
+    openaiToken: 'test-token'
+  });
+
+  // Check that the research method exists
+  expect(typeof openaiProvider.research).toEqual('function');
+});
+
+tap.test('Anthropic research method should exist', async () => {
+  const anthropicProvider = new smartai.AnthropicProvider({
+    anthropicToken: 'test-token'
+  });
+
+  // Check that the research method exists
+  expect(typeof anthropicProvider.research).toEqual('function');
+});
+
+tap.test('Research interfaces should be exported', async () => {
+  // Check that the types are available (they won't be at runtime but TypeScript will check)
+  const testResearchOptions: smartai.ResearchOptions = {
+    query: 'test query',
+    searchDepth: 'basic'
+  };
+
+  expect(testResearchOptions).toBeInstanceOf(Object);
+  expect(testResearchOptions.query).toEqual('test query');
+});
+
+tap.test('Perplexity provider should have research method', async () => {
+  const perplexityProvider = new smartai.PerplexityProvider({
+    perplexityToken: 'test-token'
+  });
+
+  // For Perplexity, we actually implemented it, so let's just check it exists
+  expect(typeof perplexityProvider.research).toEqual('function');
+});
+
+tap.test('Other providers should have research stubs', async () => {
+  const groqProvider = new smartai.GroqProvider({
+    groqToken: 'test-token'
+  });
+
+  const ollamaProvider = new smartai.OllamaProvider({});
+
+  // Check that the research method exists and throws error
+  expect(typeof groqProvider.research).toEqual('function');
+  expect(typeof ollamaProvider.research).toEqual('function');
+
+  // Test that they throw errors when called
+  let errorCaught = false;
+  try {
+    await groqProvider.research({ query: 'test' });
+  } catch (error) {
+    errorCaught = true;
+    expect(error.message).toInclude('not yet supported');
+  }
+  expect(errorCaught).toBeTrue();
+});
+
+export default tap.start();

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartai',
-  version: '0.3.2',
+  version: '0.6.0',
-  description: 'A TypeScript library for integrating and interacting with multiple AI models, offering capabilities for chat and potentially audio responses.'
+  description: 'SmartAi is a versatile TypeScript library designed to facilitate integration and interaction with various AI models, offering functionalities for chat, audio generation, document processing, and vision tasks.'
 }

ts/abstract.classes.multimodal.ts

@@ -1,3 +1,5 @@
+import * as plugins from './plugins.js';
+
 /**
  * Message format for chat interactions
  */
@@ -23,22 +25,60 @@ export interface ChatResponse {
   message: string;
 }
 
+/**
+ * Options for research interactions
+ */
+export interface ResearchOptions {
+  query: string;
+  searchDepth?: 'basic' | 'advanced' | 'deep';
+  maxSources?: number;
+  includeWebSearch?: boolean;
+  background?: boolean;
+}
+
+/**
+ * Response format for research interactions
+ */
+export interface ResearchResponse {
+  answer: string;
+  sources: Array<{
+    url: string;
+    title: string;
+    snippet: string;
+  }>;
+  searchQueries?: string[];
+  metadata?: any;
+}
+
 /**
  * Abstract base class for multi-modal AI models.
  * Provides a common interface for different AI providers (OpenAI, Anthropic, Perplexity, Ollama)
  */
 export abstract class MultiModalModel {
+  /**
+   * SmartPdf instance for document processing
+   * Shared across all methods that need PDF functionality
+   */
+  protected smartpdfInstance: plugins.smartpdf.SmartPdf;
+
   /**
    * Initializes the model and any necessary resources
    * Should be called before using any other methods
    */
-  abstract start(): Promise<void>;
+  public async start(): Promise<void> {
+    this.smartpdfInstance = new plugins.smartpdf.SmartPdf();
+    await this.smartpdfInstance.start();
+  }
   
   /**
    * Cleans up any resources used by the model
    * Should be called when the model is no longer needed
    */
-  abstract stop(): Promise<void>;
+  public async stop(): Promise<void> {
+    if (this.smartpdfInstance) {
+      await this.smartpdfInstance.stop();
+    }
+  }
 
   /**
    * Synchronous chat interaction with the model
@@ -83,4 +123,12 @@ export abstract class MultiModalModel {
     pdfDocuments: Uint8Array[];
     messageHistory: ChatMessage[];
   }): Promise<{ message: any }>;
+
+  /**
+   * Research and web search capabilities
+   * @param optionsArg Options containing the research query and configuration
+   * @returns Promise resolving to the research results with sources
+   * @throws Error if the provider doesn't support research capabilities
+   */
+  public abstract research(optionsArg: ResearchOptions): Promise<ResearchResponse>;
 }

ts/classes.conversation.ts

@@ -48,6 +48,18 @@ export class Conversation {
     return conversation;
   }
 
+  public static async createWithExo(smartaiRefArg: SmartAi) {
+    if (!smartaiRefArg.exoProvider) {
+      throw new Error('Exo provider not available');
+    }
+    const conversation = new Conversation(smartaiRefArg, {
+      processFunction: async (input) => {
+        return '' // TODO implement proper streaming
+      }
+    });
+    return conversation;
+  }
+
   public static async createWithOllama(smartaiRefArg: SmartAi) {
     if (!smartaiRefArg.ollamaProvider) {
       throw new Error('Ollama provider not available');
@@ -60,6 +72,30 @@ export class Conversation {
     return conversation;
   }
 
+  public static async createWithGroq(smartaiRefArg: SmartAi) {
+    if (!smartaiRefArg.groqProvider) {
+      throw new Error('Groq provider not available');
+    }
+    const conversation = new Conversation(smartaiRefArg, {
+      processFunction: async (input) => {
+        return '' // TODO implement proper streaming
+      }
+    });
+    return conversation;
+  }
+
+  public static async createWithXai(smartaiRefArg: SmartAi) {
+    if (!smartaiRefArg.xaiProvider) {
+      throw new Error('XAI provider not available');
+    }
+    const conversation = new Conversation(smartaiRefArg, {
+      processFunction: async (input) => {
+        return '' // TODO implement proper streaming
+      }
+    });
+    return conversation;
+  }
+
   // INSTANCE
   smartaiRef: SmartAi
   private systemMessage: string;

ts/classes.smartai.ts

@@ -1,18 +1,32 @@
 import { Conversation } from './classes.conversation.js';
 import * as plugins from './plugins.js';
 import { AnthropicProvider } from './provider.anthropic.js';
-import type { OllamaProvider } from './provider.ollama.js';
+import { OllamaProvider } from './provider.ollama.js';
 import { OpenAiProvider } from './provider.openai.js';
-import type { PerplexityProvider } from './provider.perplexity.js';
+import { PerplexityProvider } from './provider.perplexity.js';
+import { ExoProvider } from './provider.exo.js';
+import { GroqProvider } from './provider.groq.js';
+import { XAIProvider } from './provider.xai.js';
 
 
 export interface ISmartAiOptions {
   openaiToken?: string;
   anthropicToken?: string;
   perplexityToken?: string;
+  groqToken?: string;
+  xaiToken?: string;
+  exo?: {
+    baseUrl?: string;
+    apiKey?: string;
+  };
+  ollama?: {
+    baseUrl?: string;
+    model?: string;
+    visionModel?: string;
+  };
 }
 
-export type TProvider = 'openai' | 'anthropic' | 'perplexity' | 'ollama';
+export type TProvider = 'openai' | 'anthropic' | 'perplexity' | 'ollama' | 'exo' | 'groq' | 'xai';
 
 export class SmartAi {
   public options: ISmartAiOptions;
@@ -21,6 +35,9 @@ export class SmartAi {
   public anthropicProvider: AnthropicProvider;
   public perplexityProvider: PerplexityProvider;
   public ollamaProvider: OllamaProvider;
+  public exoProvider: ExoProvider;
+  public groqProvider: GroqProvider;
+  public xaiProvider: XAIProvider;
 
   constructor(optionsArg: ISmartAiOptions) {
     this.options = optionsArg;
@@ -37,16 +54,74 @@ export class SmartAi {
       this.anthropicProvider = new AnthropicProvider({
         anthropicToken: this.options.anthropicToken,
       });
+      await this.anthropicProvider.start();
+    }
+    if (this.options.perplexityToken) {
+      this.perplexityProvider = new PerplexityProvider({
+        perplexityToken: this.options.perplexityToken,
+      });
+      await this.perplexityProvider.start();
+    }
+    if (this.options.groqToken) {
+      this.groqProvider = new GroqProvider({
+        groqToken: this.options.groqToken,
+      });
+      await this.groqProvider.start();
+    }
+    if (this.options.xaiToken) {
+      this.xaiProvider = new XAIProvider({
+        xaiToken: this.options.xaiToken,
+      });
+      await this.xaiProvider.start();
+    }
+    if (this.options.ollama) {
+      this.ollamaProvider = new OllamaProvider({
+        baseUrl: this.options.ollama.baseUrl,
+        model: this.options.ollama.model,
+        visionModel: this.options.ollama.visionModel,
+      });
+      await this.ollamaProvider.start();
+    }
+    if (this.options.exo) {
+      this.exoProvider = new ExoProvider({
+        exoBaseUrl: this.options.exo.baseUrl,
+        apiKey: this.options.exo.apiKey,
+      });
+      await this.exoProvider.start();
     }
   }
 
-  public async stop() {}
+  public async stop() {
+    if (this.openaiProvider) {
+      await this.openaiProvider.stop();
+    }
+    if (this.anthropicProvider) {
+      await this.anthropicProvider.stop();
+    }
+    if (this.perplexityProvider) {
+      await this.perplexityProvider.stop();
+    }
+    if (this.groqProvider) {
+      await this.groqProvider.stop();
+    }
+    if (this.xaiProvider) {
+      await this.xaiProvider.stop();
+    }
+    if (this.ollamaProvider) {
+      await this.ollamaProvider.stop();
+    }
+    if (this.exoProvider) {
+      await this.exoProvider.stop();
+    }
+  }
   
   /**
    * create a new conversation
    */
   createConversation(provider: TProvider) {
     switch (provider) {
+      case 'exo':
+        return Conversation.createWithExo(this);
       case 'openai':
         return Conversation.createWithOpenAi(this);
       case 'anthropic':
@@ -55,6 +130,10 @@ export class SmartAi {
         return Conversation.createWithPerplexity(this);
       case 'ollama':
         return Conversation.createWithOllama(this);
+      case 'groq':
+        return Conversation.createWithGroq(this);
+      case 'xai':
+        return Conversation.createWithXai(this);
       default:
         throw new Error('Provider not available');
     }

ts/index.ts

@@ -1,3 +1,9 @@
 export * from './classes.smartai.js';
 export * from './abstract.classes.multimodal.js';
 export * from './provider.openai.js';
+export * from './provider.anthropic.js';
+export * from './provider.perplexity.js';
+export * from './provider.groq.js';
+export * from './provider.ollama.js';
+export * from './provider.xai.js';
+export * from './provider.exo.js';

ts/provider.anthropic.ts

@@ -1,13 +1,16 @@
 import * as plugins from './plugins.js';
 import * as paths from './paths.js';
 import { MultiModalModel } from './abstract.classes.multimodal.js';
-import type { ChatOptions, ChatResponse, ChatMessage } from './abstract.classes.multimodal.js';
+import type { ChatOptions, ChatResponse, ChatMessage, ResearchOptions, ResearchResponse } from './abstract.classes.multimodal.js';
 import type { ImageBlockParam, TextBlockParam } from '@anthropic-ai/sdk/resources/messages';
 
 type ContentBlock = ImageBlockParam | TextBlockParam;
 
 export interface IAnthropicProviderOptions {
   anthropicToken: string;
+  enableWebSearch?: boolean;
+  searchDomainAllowList?: string[];
+  searchDomainBlockList?: string[];
 }
 
 export class AnthropicProvider extends MultiModalModel {
@@ -20,12 +23,15 @@ export class AnthropicProvider extends MultiModalModel {
   }
 
   async start() {
+    await super.start();
     this.anthropicApiClient = new plugins.anthropic.default({
       apiKey: this.options.anthropicToken,
     });
   }
 
-  async stop() {}
+  async stop() {
+    await super.stop();
+  }
 
   public async chatStream(input: ReadableStream<Uint8Array>): Promise<ReadableStream<string>> {
     // Create a TextDecoder to handle incoming chunks
@@ -178,11 +184,10 @@ export class AnthropicProvider extends MultiModalModel {
     messageHistory: ChatMessage[];
   }): Promise<{ message: any }> {
     // Convert PDF documents to images using SmartPDF
-    const smartpdfInstance = new plugins.smartpdf.SmartPdf();
     let documentImageBytesArray: Uint8Array[] = [];
 
     for (const pdfDocument of optionsArg.pdfDocuments) {
-      const documentImageArray = await smartpdfInstance.convertPDFToPngBytes(pdfDocument);
+      const documentImageArray = await this.smartpdfInstance.convertPDFToPngBytes(pdfDocument);
       documentImageBytesArray = documentImageBytesArray.concat(documentImageArray);
     }
 
@@ -237,4 +242,121 @@ export class AnthropicProvider extends MultiModalModel {
       }
     };
   }
+
+  public async research(optionsArg: ResearchOptions): Promise<ResearchResponse> {
+    // Prepare the messages for the research request
+    const systemMessage = `You are a research assistant with web search capabilities.
+    Provide comprehensive, well-researched answers with citations and sources.
+    When searching the web, be thorough and cite your sources accurately.`;
+
+    try {
+      // Build the tool configuration for web search
+      const tools = this.options.enableWebSearch ? [
+        {
+          type: 'computer_20241022' as const,
+          name: 'web_search',
+          description: 'Search the web for current information',
+          input_schema: {
+            type: 'object' as const,
+            properties: {
+              query: {
+                type: 'string',
+                description: 'The search query'
+              }
+            },
+            required: ['query']
+          }
+        }
+      ] : [];
+
+      // Configure the request based on search depth
+      const maxTokens = optionsArg.searchDepth === 'deep' ? 8192 :
+                        optionsArg.searchDepth === 'advanced' ? 6144 : 4096;
+
+      // Create the research request
+      const requestParams: any = {
+        model: 'claude-3-opus-20240229',
+        system: systemMessage,
+        messages: [
+          {
+            role: 'user' as const,
+            content: optionsArg.query
+          }
+        ],
+        max_tokens: maxTokens,
+        temperature: 0.7
+      };
+
+      // Add tools if web search is enabled
+      if (tools.length > 0) {
+        requestParams.tools = tools;
+        requestParams.tool_choice = { type: 'auto' };
+      }
+
+      // Execute the research request
+      const result = await this.anthropicApiClient.messages.create(requestParams);
+
+      // Extract the answer from content blocks
+      let answer = '';
+      const sources: Array<{ url: string; title: string; snippet: string }> = [];
+      const searchQueries: string[] = [];
+
+      // Process content blocks
+      for (const block of result.content) {
+        if ('text' in block) {
+          answer += block.text;
+        }
+      }
+
+      // Parse sources from the answer (Claude includes citations in various formats)
+      const urlRegex = /\[([^\]]+)\]\(([^)]+)\)/g;
+      let match: RegExpExecArray | null;
+
+      while ((match = urlRegex.exec(answer)) !== null) {
+        sources.push({
+          title: match[1],
+          url: match[2],
+          snippet: ''
+        });
+      }
+
+      // Also look for plain URLs
+      const plainUrlRegex = /https?:\/\/[^\s\)]+/g;
+      const plainUrls = answer.match(plainUrlRegex) || [];
+
+      for (const url of plainUrls) {
+        // Check if this URL is already in sources
+        if (!sources.some(s => s.url === url)) {
+          sources.push({
+            title: new URL(url).hostname,
+            url: url,
+            snippet: ''
+          });
+        }
+      }
+
+      // Extract tool use information if available
+      if ('tool_use' in result && Array.isArray(result.tool_use)) {
+        for (const toolUse of result.tool_use) {
+          if (toolUse.name === 'web_search' && toolUse.input?.query) {
+            searchQueries.push(toolUse.input.query);
+          }
+        }
+      }
+
+      return {
+        answer,
+        sources,
+        searchQueries: searchQueries.length > 0 ? searchQueries : undefined,
+        metadata: {
+          model: 'claude-3-opus-20240229',
+          searchDepth: optionsArg.searchDepth || 'basic',
+          tokensUsed: result.usage?.output_tokens
+        }
+      };
+    } catch (error) {
+      console.error('Anthropic research error:', error);
+      throw new Error(`Failed to perform research: ${error.message}`);
+    }
+  }
 }

ts/provider.exo.ts

@@ -0,0 +1,132 @@
+import * as plugins from './plugins.js';
+import * as paths from './paths.js';
+import { MultiModalModel } from './abstract.classes.multimodal.js';
+import type { ChatOptions, ChatResponse, ChatMessage, ResearchOptions, ResearchResponse } from './abstract.classes.multimodal.js';
+import type { ChatCompletionMessageParam } from 'openai/resources/chat/completions';
+
+export interface IExoProviderOptions {
+  exoBaseUrl?: string;
+  apiKey?: string;
+}
+
+export class ExoProvider extends MultiModalModel {
+  private options: IExoProviderOptions;
+  public openAiApiClient: plugins.openai.default;
+
+  constructor(optionsArg: IExoProviderOptions = {}) {
+    super();
+    this.options = {
+      exoBaseUrl: 'http://localhost:8080/v1',  // Default Exo API endpoint
+      ...optionsArg
+    };
+  }
+
+  public async start() {
+    this.openAiApiClient = new plugins.openai.default({
+      apiKey: this.options.apiKey || 'not-needed',  // Exo might not require an API key for local deployment
+      baseURL: this.options.exoBaseUrl,
+    });
+  }
+
+  public async stop() {}
+
+  public async chatStream(input: ReadableStream<Uint8Array>): Promise<ReadableStream<string>> {
+    // Create a TextDecoder to handle incoming chunks
+    const decoder = new TextDecoder();
+    let buffer = '';
+    let currentMessage: { role: string; content: string; } | null = null;
+
+    // Create a TransformStream to process the input
+    const transform = new TransformStream<Uint8Array, string>({
+      transform: async (chunk, controller) => {
+        buffer += decoder.decode(chunk, { stream: true });
+
+        // Try to parse complete JSON messages from the buffer
+        while (true) {
+          const newlineIndex = buffer.indexOf('\n');
+          if (newlineIndex === -1) break;
+
+          const line = buffer.slice(0, newlineIndex);
+          buffer = buffer.slice(newlineIndex + 1);
+
+          if (line.trim()) {
+            try {
+              const message = JSON.parse(line);
+              currentMessage = message;
+              
+              // Process the message based on its type
+              if (message.type === 'message') {
+                const response = await this.chat({
+                  systemMessage: '',
+                  userMessage: message.content,
+                  messageHistory: [{ role: message.role as 'user' | 'assistant' | 'system', content: message.content }]
+                });
+                
+                controller.enqueue(JSON.stringify(response) + '\n');
+              }
+            } catch (error) {
+              console.error('Error processing message:', error);
+            }
+          }
+        }
+      },
+      flush(controller) {
+        if (buffer) {
+          try {
+            const message = JSON.parse(buffer);
+            currentMessage = message;
+          } catch (error) {
+            console.error('Error processing remaining buffer:', error);
+          }
+        }
+      }
+    });
+
+    return input.pipeThrough(transform);
+  }
+
+  public async chat(options: ChatOptions): Promise<ChatResponse> {
+    const messages: ChatCompletionMessageParam[] = [
+      { role: 'system', content: options.systemMessage },
+      ...options.messageHistory,
+      { role: 'user', content: options.userMessage }
+    ];
+
+    try {
+      const response = await this.openAiApiClient.chat.completions.create({
+        model: 'local-model', // Exo uses local models
+        messages: messages,
+        stream: false
+      });
+
+      return {
+        role: 'assistant',
+        message: response.choices[0]?.message?.content || ''
+      };
+    } catch (error) {
+      console.error('Error in chat completion:', error);
+      throw error;
+    }
+  }
+
+  public async audio(optionsArg: { message: string }): Promise<NodeJS.ReadableStream> {
+    throw new Error('Audio generation is not supported by Exo provider');
+  }
+
+  public async vision(optionsArg: { image: Buffer; prompt: string }): Promise<string> {
+    throw new Error('Vision processing is not supported by Exo provider');
+  }
+
+  public async document(optionsArg: {
+    systemMessage: string;
+    userMessage: string;
+    pdfDocuments: Uint8Array[];
+    messageHistory: ChatMessage[];
+  }): Promise<{ message: any }> {
+    throw new Error('Document processing is not supported by Exo provider');
+  }
+
+  public async research(optionsArg: ResearchOptions): Promise<ResearchResponse> {
+    throw new Error('Research capabilities are not yet supported by Exo provider.');
+  }
+}

ts/provider.groq.ts

@@ -1,7 +1,7 @@
 import * as plugins from './plugins.js';
 import * as paths from './paths.js';
 import { MultiModalModel } from './abstract.classes.multimodal.js';
-import type { ChatOptions, ChatResponse, ChatMessage } from './abstract.classes.multimodal.js';
+import type { ChatOptions, ChatResponse, ChatMessage, ResearchOptions, ResearchResponse } from './abstract.classes.multimodal.js';
 
 export interface IGroqProviderOptions {
   groqToken: string;
@@ -32,7 +32,7 @@ export class GroqProvider extends MultiModalModel {
 
     // Create a TransformStream to process the input
     const transform = new TransformStream<Uint8Array, string>({
-      async transform(chunk, controller) {
+      transform: async (chunk, controller) => {
         buffer += decoder.decode(chunk, { stream: true });
 
         // Try to parse complete JSON messages from the buffer
@@ -189,4 +189,8 @@ export class GroqProvider extends MultiModalModel {
   }): Promise<{ message: any }> {
     throw new Error('Document processing is not yet supported by Groq.');
   }
+
+  public async research(optionsArg: ResearchOptions): Promise<ResearchResponse> {
+    throw new Error('Research capabilities are not yet supported by Groq provider.');
+  }
 }

ts/provider.ollama.ts

@@ -1,7 +1,7 @@
 import * as plugins from './plugins.js';
 import * as paths from './paths.js';
 import { MultiModalModel } from './abstract.classes.multimodal.js';
-import type { ChatOptions, ChatResponse, ChatMessage } from './abstract.classes.multimodal.js';
+import type { ChatOptions, ChatResponse, ChatMessage, ResearchOptions, ResearchResponse } from './abstract.classes.multimodal.js';
 
 export interface IOllamaProviderOptions {
   baseUrl?: string;
@@ -24,6 +24,7 @@ export class OllamaProvider extends MultiModalModel {
   }
 
   async start() {
+    await super.start();
     // Verify Ollama is running
     try {
       const response = await fetch(`${this.baseUrl}/api/tags`);
@@ -35,7 +36,9 @@ export class OllamaProvider extends MultiModalModel {
     }
   }
 
-  async stop() {}
+  async stop() {
+    await super.stop();
+  }
 
   public async chatStream(input: ReadableStream<Uint8Array>): Promise<ReadableStream<string>> {
     // Create a TextDecoder to handle incoming chunks
@@ -45,7 +48,7 @@ export class OllamaProvider extends MultiModalModel {
 
     // Create a TransformStream to process the input
     const transform = new TransformStream<Uint8Array, string>({
-      async transform(chunk, controller) {
+      transform: async (chunk, controller) => {
         buffer += decoder.decode(chunk, { stream: true });
 
         // Try to parse complete JSON messages from the buffer
@@ -205,11 +208,10 @@ export class OllamaProvider extends MultiModalModel {
     messageHistory: ChatMessage[];
   }): Promise<{ message: any }> {
     // Convert PDF documents to images using SmartPDF
-    const smartpdfInstance = new plugins.smartpdf.SmartPdf();
     let documentImageBytesArray: Uint8Array[] = [];
 
     for (const pdfDocument of optionsArg.pdfDocuments) {
-      const documentImageArray = await smartpdfInstance.convertPDFToPngBytes(pdfDocument);
+      const documentImageArray = await this.smartpdfInstance.convertPDFToPngBytes(pdfDocument);
       documentImageBytesArray = documentImageBytesArray.concat(documentImageArray);
     }
 
@@ -249,4 +251,8 @@ export class OllamaProvider extends MultiModalModel {
       }
     };
   }
+
+  public async research(optionsArg: ResearchOptions): Promise<ResearchResponse> {
+    throw new Error('Research capabilities are not yet supported by Ollama provider.');
+  }
 }

ts/provider.openai.ts

@@ -1,16 +1,28 @@
 import * as plugins from './plugins.js';
 import * as paths from './paths.js';
+import { Readable } from 'stream';
+
+// Custom type definition for chat completion messages
+export type TChatCompletionRequestMessage = { 
+  role: "system" | "user" | "assistant"; 
+  content: string; 
+};
 
 import { MultiModalModel } from './abstract.classes.multimodal.js';
+import type { ResearchOptions, ResearchResponse } from './abstract.classes.multimodal.js';
 
 export interface IOpenaiProviderOptions {
   openaiToken: string;
+  chatModel?: string;
+  audioModel?: string;
+  visionModel?: string;
+  researchModel?: string;
+  enableWebSearch?: boolean;
 }
 
 export class OpenAiProvider extends MultiModalModel {
   private options: IOpenaiProviderOptions;
   public openAiApiClient: plugins.openai.default;
-  public smartpdfInstance: plugins.smartpdf.SmartPdf;
 
   constructor(optionsArg: IOpenaiProviderOptions) {
     super();
@@ -18,24 +30,29 @@ export class OpenAiProvider extends MultiModalModel {
   }
 
   public async start() {
+    await super.start();
     this.openAiApiClient = new plugins.openai.default({
       apiKey: this.options.openaiToken,
       dangerouslyAllowBrowser: true,
     });
-    this.smartpdfInstance = new plugins.smartpdf.SmartPdf();
   }
 
-  public async stop() {}
+  public async stop() {
+    await super.stop();
+  }
 
   public async chatStream(input: ReadableStream<Uint8Array>): Promise<ReadableStream<string>> {
     // Create a TextDecoder to handle incoming chunks
     const decoder = new TextDecoder();
     let buffer = '';
-    let currentMessage: { role: string; content: string; } | null = null;
+    let currentMessage: { 
+      role: "function" | "user" | "system" | "assistant" | "tool" | "developer"; 
+      content: string; 
+    } | null = null;
 
     // Create a TransformStream to process the input
     const transform = new TransformStream<Uint8Array, string>({
-      async transform(chunk, controller) {
+      transform: async (chunk, controller) => {
         buffer += decoder.decode(chunk, { stream: true });
 
         // Try to parse complete JSON messages from the buffer
@@ -50,7 +67,7 @@ export class OpenAiProvider extends MultiModalModel {
             try {
               const message = JSON.parse(line);
               currentMessage = {
-                role: message.role || 'user',
+                role: (message.role || 'user') as "function" | "user" | "system" | "assistant" | "tool" | "developer",
                 content: message.content || '',
               };
             } catch (e) {
@@ -61,20 +78,24 @@ export class OpenAiProvider extends MultiModalModel {
 
         // If we have a complete message, send it to OpenAI
         if (currentMessage) {
-          const stream = await this.openAiApiClient.chat.completions.create({
+          const messageToSend = { role: "user" as const, content: currentMessage.content };
-            model: 'gpt-4',
+          const chatModel = this.options.chatModel ?? 'gpt-5-mini';
-            messages: [{ role: currentMessage.role, content: currentMessage.content }],
+          const requestParams: any = {
+            model: chatModel,
+            messages: [messageToSend],
             stream: true,
-          });
+          };
-
+          // Temperature is omitted since the model does not support it.
+          const stream = await this.openAiApiClient.chat.completions.create(requestParams);
+          // Explicitly cast the stream as an async iterable to satisfy TypeScript.
+          const streamAsyncIterable = stream as unknown as AsyncIterableIterator<any>;
           // Process each chunk from OpenAI
-          for await (const chunk of stream) {
+          for await (const chunk of streamAsyncIterable) {
             const content = chunk.choices[0]?.delta?.content;
             if (content) {
               controller.enqueue(content);
             }
           }
-
           currentMessage = null;
         }
       },
@@ -104,15 +125,17 @@ export class OpenAiProvider extends MultiModalModel {
       content: string;
     }[];
   }) {
-    const result = await this.openAiApiClient.chat.completions.create({
+    const chatModel = this.options.chatModel ?? 'gpt-5-mini';
-      model: 'gpt-4o',
+    const requestParams: any = {
-
+      model: chatModel,
       messages: [
         { role: 'system', content: optionsArg.systemMessage },
         ...optionsArg.messageHistory,
         { role: 'user', content: optionsArg.userMessage },
       ],
-    });
+    };
+    // Temperature parameter removed to avoid unsupported error.
+    const result = await this.openAiApiClient.chat.completions.create(requestParams);
     return {
       role: result.choices[0].message.role as 'assistant',
       message: result.choices[0].message.content,
@@ -122,14 +145,15 @@ export class OpenAiProvider extends MultiModalModel {
   public async audio(optionsArg: { message: string }): Promise<NodeJS.ReadableStream> {
     const done = plugins.smartpromise.defer<NodeJS.ReadableStream>();
     const result = await this.openAiApiClient.audio.speech.create({
-      model: 'tts-1-hd',
+      model: this.options.audioModel ?? 'tts-1-hd',
       input: optionsArg.message,
       voice: 'nova',
       response_format: 'mp3',
       speed: 1,
     });
     const stream = result.body;
-    done.resolve(stream);
+    const nodeStream = Readable.fromWeb(stream as any);
+    done.resolve(nodeStream);
     return done.promise;
   }
 
@@ -144,6 +168,7 @@ export class OpenAiProvider extends MultiModalModel {
   }) {
     let pdfDocumentImageBytesArray: Uint8Array[] = [];
 
+    // Convert each PDF into one or more image byte arrays.
     for (const pdfDocument of optionsArg.pdfDocuments) {
       const documentImageArray = await this.smartpdfInstance.convertPDFToPngBytes(pdfDocument);
       pdfDocumentImageBytesArray = pdfDocumentImageBytesArray.concat(documentImageArray);
@@ -152,19 +177,18 @@ export class OpenAiProvider extends MultiModalModel {
     console.log(`image smartfile array`);
     console.log(pdfDocumentImageBytesArray.map((smartfile) => smartfile.length));
 
-    const smartfileArray = await plugins.smartarray.map(
+    // Filter out any empty buffers to avoid sending invalid image URLs.
-      pdfDocumentImageBytesArray,
+    const validImageBytesArray = pdfDocumentImageBytesArray.filter(imageBytes => imageBytes && imageBytes.length > 0);
-      async (pdfDocumentImageBytes) => {
+    const imageAttachments = validImageBytesArray.map(imageBytes => ({
-        return plugins.smartfile.SmartFile.fromBuffer(
+      type: 'image_url',
-          'pdfDocumentImage.jpg',
+      image_url: {
-          Buffer.from(pdfDocumentImageBytes)
+        url: 'data:image/png;base64,' + Buffer.from(imageBytes).toString('base64'),
-        );
+      },
-      }
+    }));
-    );
 
-    const result = await this.openAiApiClient.chat.completions.create({
+    const chatModel = this.options.chatModel ?? 'gpt-5-mini';
-      model: 'gpt-4o',
+    const requestParams: any = {
-      // response_format: { type: "json_object" }, // not supported for now
+      model: chatModel,
       messages: [
         { role: 'system', content: optionsArg.systemMessage },
         ...optionsArg.messageHistory,
@@ -172,30 +196,22 @@ export class OpenAiProvider extends MultiModalModel {
           role: 'user',
           content: [
             { type: 'text', text: optionsArg.userMessage },
-            ...(() => {
+            ...imageAttachments,
-              const returnArray = [];
-              for (const imageBytes of pdfDocumentImageBytesArray) {
-                returnArray.push({
-                  type: 'image_url',
-                  image_url: {
-                    url: 'data:image/png;base64,' + Buffer.from(imageBytes).toString('base64'),
-                  },
-                });
-              }
-              return returnArray;
-            })(),
           ],
         },
       ],
-    });
+    };
+    // Temperature parameter removed.
+    const result = await this.openAiApiClient.chat.completions.create(requestParams);
     return {
       message: result.choices[0].message,
     };
   }
 
   public async vision(optionsArg: { image: Buffer; prompt: string }): Promise<string> {
-    const result = await this.openAiApiClient.chat.completions.create({
+    const visionModel = this.options.visionModel ?? '04-mini';
-      model: 'gpt-4-vision-preview',
+    const requestParams: any = {
+      model: visionModel,
       messages: [
         {
           role: 'user',
@@ -211,8 +227,115 @@ export class OpenAiProvider extends MultiModalModel {
         }
       ],
       max_tokens: 300
-    });
+    };
-
+    const result = await this.openAiApiClient.chat.completions.create(requestParams);
     return result.choices[0].message.content || '';
   }
+
+  public async research(optionsArg: ResearchOptions): Promise<ResearchResponse> {
+    // Determine which model to use based on search depth
+    let model: string;
+    if (optionsArg.searchDepth === 'deep') {
+      model = this.options.researchModel || 'o4-mini-deep-research-2025-06-26';
+    } else {
+      model = this.options.chatModel || 'gpt-5-mini';
+    }
+
+    // Prepare the request parameters
+    const requestParams: any = {
+      model,
+      messages: [
+        {
+          role: 'system',
+          content: 'You are a research assistant. Provide comprehensive answers with citations and sources when available.'
+        },
+        {
+          role: 'user',
+          content: optionsArg.query
+        }
+      ],
+      temperature: 0.7
+    };
+
+    // Add web search tools if requested
+    if (optionsArg.includeWebSearch || optionsArg.searchDepth === 'deep') {
+      requestParams.tools = [
+        {
+          type: 'function',
+          function: {
+            name: 'web_search',
+            description: 'Search the web for information',
+            parameters: {
+              type: 'object',
+              properties: {
+                query: {
+                  type: 'string',
+                  description: 'The search query'
+                }
+              },
+              required: ['query']
+            }
+          }
+        }
+      ];
+      requestParams.tool_choice = 'auto';
+    }
+
+    // Add background flag for deep research
+    if (optionsArg.background && optionsArg.searchDepth === 'deep') {
+      requestParams.background = true;
+    }
+
+    try {
+      // Execute the research request
+      const result = await this.openAiApiClient.chat.completions.create(requestParams);
+
+      // Extract the answer
+      const answer = result.choices[0].message.content || '';
+
+      // Parse sources from the response (OpenAI often includes URLs in markdown format)
+      const sources: Array<{ url: string; title: string; snippet: string }> = [];
+      const urlRegex = /\[([^\]]+)\]\(([^)]+)\)/g;
+      let match: RegExpExecArray | null;
+
+      while ((match = urlRegex.exec(answer)) !== null) {
+        sources.push({
+          title: match[1],
+          url: match[2],
+          snippet: '' // OpenAI doesn't provide snippets in standard responses
+        });
+      }
+
+      // Extract search queries if tools were used
+      const searchQueries: string[] = [];
+      if (result.choices[0].message.tool_calls) {
+        for (const toolCall of result.choices[0].message.tool_calls) {
+          if ('function' in toolCall && toolCall.function.name === 'web_search') {
+            try {
+              const args = JSON.parse(toolCall.function.arguments);
+              if (args.query) {
+                searchQueries.push(args.query);
+              }
+            } catch (e) {
+              // Ignore parsing errors
+            }
+          }
+        }
+      }
+
+      return {
+        answer,
+        sources,
+        searchQueries: searchQueries.length > 0 ? searchQueries : undefined,
+        metadata: {
+          model,
+          searchDepth: optionsArg.searchDepth || 'basic',
+          tokensUsed: result.usage?.total_tokens
+        }
+      };
+    } catch (error) {
+      console.error('Research API error:', error);
+      throw new Error(`Failed to perform research: ${error.message}`);
+    }
+  }
 }

ts/provider.perplexity.ts

@@ -1,7 +1,7 @@
 import * as plugins from './plugins.js';
 import * as paths from './paths.js';
 import { MultiModalModel } from './abstract.classes.multimodal.js';
-import type { ChatOptions, ChatResponse, ChatMessage } from './abstract.classes.multimodal.js';
+import type { ChatOptions, ChatResponse, ChatMessage, ResearchOptions, ResearchResponse } from './abstract.classes.multimodal.js';
 
 export interface IPerplexityProviderOptions {
   perplexityToken: string;
@@ -168,4 +168,69 @@ export class PerplexityProvider extends MultiModalModel {
   }): Promise<{ message: any }> {
     throw new Error('Document processing is not supported by Perplexity.');
   }
+
+  public async research(optionsArg: ResearchOptions): Promise<ResearchResponse> {
+    // Perplexity has Sonar models that are optimized for search
+    // sonar models: sonar, sonar-pro
+    const model = optionsArg.searchDepth === 'deep' ? 'sonar-pro' : 'sonar';
+
+    try {
+      const response = await fetch('https://api.perplexity.ai/chat/completions', {
+        method: 'POST',
+        headers: {
+          'Authorization': `Bearer ${this.options.perplexityToken}`,
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({
+          model,
+          messages: [
+            {
+              role: 'system',
+              content: 'You are a helpful research assistant. Provide accurate information with sources.'
+            },
+            {
+              role: 'user',
+              content: optionsArg.query
+            }
+          ],
+          temperature: 0.7,
+          max_tokens: 4000
+        }),
+      });
+
+      if (!response.ok) {
+        throw new Error(`Perplexity API error: ${response.statusText}`);
+      }
+
+      const result = await response.json();
+      const answer = result.choices[0].message.content;
+
+      // Parse citations from the response
+      const sources: Array<{ url: string; title: string; snippet: string }> = [];
+
+      // Perplexity includes citations in the format [1], [2], etc. with sources listed
+      // This is a simplified parser - could be enhanced based on actual Perplexity response format
+      if (result.citations) {
+        for (const citation of result.citations) {
+          sources.push({
+            url: citation.url || '',
+            title: citation.title || '',
+            snippet: citation.snippet || ''
+          });
+        }
+      }
+
+      return {
+        answer,
+        sources,
+        metadata: {
+          model,
+          searchDepth: optionsArg.searchDepth || 'basic'
+        }
+      };
+    } catch (error) {
+      console.error('Perplexity research error:', error);
+      throw new Error(`Failed to perform research: ${error.message}`);
+    }
+  }
 }

ts/provider.xai.ts

@@ -1,7 +1,7 @@
 import * as plugins from './plugins.js';
 import * as paths from './paths.js';
 import { MultiModalModel } from './abstract.classes.multimodal.js';
-import type { ChatOptions, ChatResponse, ChatMessage } from './abstract.classes.multimodal.js';
+import type { ChatOptions, ChatResponse, ChatMessage, ResearchOptions, ResearchResponse } from './abstract.classes.multimodal.js';
 import type { ChatCompletionMessageParam } from 'openai/resources/chat/completions';
 
 export interface IXAIProviderOptions {
@@ -11,7 +11,6 @@ export interface IXAIProviderOptions {
 export class XAIProvider extends MultiModalModel {
   private options: IXAIProviderOptions;
   public openAiApiClient: plugins.openai.default;
-  public smartpdfInstance: plugins.smartpdf.SmartPdf;
 
   constructor(optionsArg: IXAIProviderOptions) {
     super();
@@ -19,14 +18,16 @@ export class XAIProvider extends MultiModalModel {
   }
 
   public async start() {
+    await super.start();
     this.openAiApiClient = new plugins.openai.default({
       apiKey: this.options.xaiToken,
       baseURL: 'https://api.x.ai/v1',
     });
-    this.smartpdfInstance = new plugins.smartpdf.SmartPdf();
   }
 
-  public async stop() {}
+  public async stop() {
+    await super.stop();
+  }
 
   public async chatStream(input: ReadableStream<Uint8Array>): Promise<ReadableStream<string>> {
     // Create a TextDecoder to handle incoming chunks
@@ -180,4 +181,8 @@ export class XAIProvider extends MultiModalModel {
       message: completion.choices[0]?.message?.content || ''
     };
   }
+
+  public async research(optionsArg: ResearchOptions): Promise<ResearchResponse> {
+    throw new Error('Research capabilities are not yet supported by xAI provider.');
+  }
 }