CoexistAI

# CoexistAI CoexistAI is a modular, developer-friendly research assistant framework. It enables you to build, search, summarize, and automate research workflows using LLMs, web search, Reddit, YouTube, git and mapping tools—all with simple API calls or Python functions. <p align="center"> <img src="artifacts/logo.jpeg" alt="CoexistAI Logo" width="200"/> </p> ## 🎙️ New Features & Updates - 🔥 _Docker Installation available (Thanks for all the feedback, hope this makes installations easy)_. For a containerized setup with Docker, follow the instructions in [README.docker.md](README.docker.md). - **Text → Podcast**: Instantly turn written content into engaging podcast episodes—ideal for on-the-go listening or repurposing articles/notes/blogs. Example: Converted [this article](https://www.theatlantic.com/newsletters/archive/2025/08/ai-high-school-college/684057/) to a podcast. **[Listen here](output/podcasts/podcast_58fc33d6.wav)** - **Text → Speech**: Convert text to high-quality audio using advanced TTS. Check [Notebook](coexist_tutorial.ipynb) for examples. - **Flexible Integration**: Generate audio files via FastAPI or MCP—integrate with agents or use standalone. - **Direct Location Search**: Search for any place, not just routes. - **Advanced Reddit Search**: Custom phrases with BM25 ranking for sharper discovery. - **YouTube Power-Up**: Search/summarize videos or URLs with custom prompts. - **File/Folder Exploration**: Explore local folders/files with vision support for images (.png, .jpg, etc.). - **Sharper Web Search**: More focused, actionable results. - **MCP Support Everywhere**: Full integration with LM Studio and other MCP hosts. [See Guide](README_MCP.md) - **GitHub & Local Repo Explorer**: Ask questions about codebases (GitHub or local). ## 🚀 Features - **Web Explorer**: Query the web, summarize results, and extract context using LLMs. - **Reddit Explorer**: Fetch and summarize reddit via search phrase or subreddit focused queries - **YouTube Transcript Explorer**: Search youtube with search phrases and summarise/QA any video - **Map Explorer**: Generate maps, explore routes, locations with points of interest like hotels, cafes near given locations. - **Github Explorer**: Explore/summarise/explain/QA any github or even local git codebases - **Pluggable LLMs and Embedders**: Use any LLMs Google Gemini, OpenAI, Ollama, and any embedders - **Async & Parallel**: Fast, scalable, and robust asynchronous execution. - **Notebook & API Ready**: Use as a Python library or via a FAST API. - **MCP ready**: Spins up the MCP server on the fly along with FAST API server --- ## 🛠️ Installation **Prerequisite:** Make sure Docker is installed and the Docker daemon is running. ### Method 1: Docker (Recommended) New 🔥 For a containerized setup with Docker, follow the instructions in [README.docker.md](README.docker.md). This method uses Method A (helper script) to automate the process and provides an Admin UI for easy configuration. ### Method 2: Local Setup 1. **Clone the repository:** ```sh git clone https://github.com/SPThole/CoexistAI.git coexistai cd coexistai ``` 2. **Configure your model and embedding settings:** - [NEW] Edit `config/model_config.json` to set your preferred LLM and embedding model. - Edit above file to set your preferred SearxNG host and port (if needed) - Add LLM and Embedder API Key (for google mode both would be same) - Example (for full local mode): ```json { "llm_model_name": "jan-nano", "llm_type": "local", // based on baseurl dict given below "embed_mode": "infinity_emb", "embedding_model_name": "nomic-ai/nomic-embed-text-v1", "llm_kwargs": { "temperature": 0.1, "max_tokens": null, "timeout": null, "max_retries": 2 }, "embed_kwargs": {}, "llm_api_key": "dummy", "HOST_APP": "localhost", "PORT_NUM_APP": 8000, "HOST_SEARXNG": "localhost", "PORT_NUM_SEARXNG": 8080, "openai_compatible": { "google": "https://generativelanguage.googleapis.com/v1beta/openai/", "local": "http://localhost:1234/v1", "groq": "https://api.groq.com/openai/v1", "openai": "https://api.openai.com/v1", "others": "https://openrouter.ai/api/v1" } } ``` - See the file for all available options and defaults. - If you using others llm type, then check the openai_compatible url dict for others key, you can generally find it by "googling YOUR provider name openai api base compatilble url" 3. **Run the setup script:** - For macOS or Linux with zsh: ```sh zsh quick_setup.sh ``` - For Linux with bash: ```sh bash quick_setup.sh ``` > The script will: > - Pull the SearxNG Docker image > - Create and activate a Python virtual environment > - **USER ACTION NEEDED** Set your `GOOGLE_API_KEY` (edit the script to use your real key). [Obtain your API key (Currently Gemini, OpenAI and ollama is supported)](https://ai.go