diff --git a/README.md b/README.md index c7ae9b5..af7ad33 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ In a world dominated by Artificial Intelligence, having the ability to think **Open Notebook empowers you to:** - 🔒 **Control your data** - Keep your research private and secure -- 🤖 **Choose your AI models** - Support for 15+ providers including OpenAI, Anthropic, Ollama, and more +- 🤖 **Choose your AI models** - Support for 16+ providers including OpenAI, Anthropic, Ollama, LM Studio, and more - 📚 **Organize multi-modal content** - PDFs, videos, audio, web pages, and more - 🎙️ **Generate professional podcasts** - Advanced multi-speaker podcast generation - 🔍 **Search intelligently** - Full-text and vector search across all your content @@ -61,7 +61,7 @@ Learn more about our project at [https://www.open-notebook.ai](https://www.open- | Feature | Open Notebook | Google Notebook LM | Advantage | |---------|---------------|--------------------|-----------| | **Privacy & Control** | Self-hosted, your data | Google cloud only | Complete data sovereignty | -| **AI Provider Choice** | 15+ providers (OpenAI, Anthropic, Ollama, etc.) | Google models only | Flexibility and cost optimization | +| **AI Provider Choice** | 16+ providers (OpenAI, Anthropic, Ollama, LM Studio, etc.) | Google models only | Flexibility and cost optimization | | **Podcast Speakers** | 1-4 speakers with custom profiles | 2 speakers only | Extreme flexibility | | **Context Control** | 3 granular levels | All-or-nothing | Privacy and performance tuning | | **Content Transformations** | Custom and built-in | Limited options | Unlimited processing power | @@ -152,6 +152,9 @@ Thanks to the [Esperanto](https://github.com/lfnovo/esperanto) library, we suppo | Voyage | ❌ | ✅ | ❌ | ❌ | | xAI | ✅ | ❌ | ❌ | ❌ | | OpenRouter | ✅ | ❌ | ❌ | ❌ | +| OpenAI Compatible* | ✅ | ❌ | ❌ | ❌ | + +*Supports LM Studio and any OpenAI-compatible endpoint ## ✨ Key Features @@ -159,7 +162,7 @@ Thanks to the [Esperanto](https://github.com/lfnovo/esperanto) library, we suppo - **🔒 Privacy-First**: Your data stays under your control - no cloud dependencies - **🎯 Multi-Notebook Organization**: Manage multiple research projects seamlessly - **📚 Universal Content Support**: PDFs, videos, audio, web pages, Office docs, and more -- **🤖 Multi-Model AI Support**: 15+ providers including OpenAI, Anthropic, Ollama, Google, and more +- **🤖 Multi-Model AI Support**: 16+ providers including OpenAI, Anthropic, Ollama, Google, LM Studio, and more - **🎙️ Professional Podcast Generation**: Advanced multi-speaker podcasts with Episode Profiles - **🔍 Intelligent Search**: Full-text and vector search across all your content - **💬 Context-Aware Chat**: AI conversations powered by your research materials @@ -217,7 +220,7 @@ Thanks to the [Esperanto](https://github.com/lfnovo/esperanto) library, we suppo ### Recently Completed ✅ - **Comprehensive REST API**: Full programmatic access to all functionality -- **Multi-Model Support**: 15+ AI providers including OpenAI, Anthropic, Ollama +- **Multi-Model Support**: 16+ AI providers including OpenAI, Anthropic, Ollama, LM Studio - **Advanced Podcast Generator**: Professional multi-speaker podcasts with Episode Profiles - **Content Transformations**: Powerful customizable actions for content processing - **Enhanced Citations**: Improved layout and finer control for source citations diff --git a/docs/features/ai-models.md b/docs/features/ai-models.md index cd6c945..b2f8a2f 100644 --- a/docs/features/ai-models.md +++ b/docs/features/ai-models.md @@ -1,6 +1,6 @@ # AI Models & Providers -Open Notebook supports 15+ AI providers, giving you complete flexibility in choosing the AI models that best fit your needs, budget, and privacy requirements. This comprehensive guide covers everything you need to know about selecting, configuring, and optimizing your AI models. +Open Notebook supports 16+ AI providers, giving you complete flexibility in choosing the AI models that best fit your needs, budget, and privacy requirements. This comprehensive guide covers everything you need to know about selecting, configuring, and optimizing your AI models. ## Quick Start @@ -72,6 +72,7 @@ Open Notebook uses four distinct types of AI models, each optimized for specific | **Azure OpenAI** | ✅ | ✅ | ❌ | ❌ | | **OpenRouter** | ✅ | ❌ | ❌ | ❌ | | **Perplexity** | ✅ | ❌ | ❌ | ❌ | +| **OpenAI Compatible** | ✅ | ❌ | ❌ | ❌ | ## Model Selection Guide @@ -315,6 +316,34 @@ export VOYAGE_API_KEY=your_api_key_here - Embedding-only provider - Requires other providers for language models +--- + +### 🔧 OpenAI Compatible (LM Studio & Others) +**Best for**: Using any OpenAI-compatible API endpoint, including LM Studio + +**Environment Setup** +```bash +export OPENAI_COMPATIBLE_BASE_URL=http://localhost:1234/v1 +# Optional - only if your endpoint requires authentication +export OPENAI_COMPATIBLE_API_KEY=your_key_here +``` + +**Common Use Cases** +- **LM Studio**: Run models locally with a familiar UI +- **Text Generation WebUI**: Alternative local inference +- **Custom Endpoints**: Any OpenAI-compatible API + +**Strengths** +- Use any OpenAI-compatible endpoint +- Perfect for LM Studio users +- Flexibility in model deployment +- Works with local and remote endpoints + +**Considerations** +- Performance depends on your hardware (for local) +- Model availability varies by endpoint +- Some endpoints may not support all features + ## 🧠 Reasoning Models Open Notebook fully supports **reasoning models** that show their transparent thinking process. These models output their internal reasoning within `` tags, which Open Notebook automatically handles. @@ -486,6 +515,10 @@ export AZURE_OPENAI_DEPLOYMENT_NAME=your_deployment export VERTEX_PROJECT=your_project export GOOGLE_APPLICATION_CREDENTIALS=./google-credentials.json export VERTEX_LOCATION=us-east5 + +# OpenAI Compatible (LM Studio, etc.) +export OPENAI_COMPATIBLE_BASE_URL=http://localhost:1234/v1 +export OPENAI_COMPATIBLE_API_KEY=your_key # Optional ``` ### 2. Using Docker diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 2e771a3..9723f92 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -195,6 +195,11 @@ AZURE_OPENAI_API_KEY=your-azure-key-here AZURE_OPENAI_ENDPOINT=https://your-endpoint.openai.azure.com/ AZURE_OPENAI_API_VERSION="2024-12-01-preview" AZURE_OPENAI_DEPLOYMENT_NAME=your-deployment-name + +# OpenAI Compatible (LM Studio, etc.) +OPENAI_COMPATIBLE_BASE_URL=http://localhost:1234/v1 +# Optional - only if your endpoint requires authentication +OPENAI_COMPATIBLE_API_KEY=your-key-here ``` ### Optional Services