SWIRL

Give your team ChatGPT-level search without moving data to the cloud

RAG with One Drive & Microsoft 365 in 60 seconds

Ask question → Get answer with sources → Click through to source

Watch it on Youtube

Teams using SWIRL saves an average 7.5 hours of productive time per week.

⚡ Quick Start · 💬 Join Slack · 📚 Docs · 🔌 Connectors · 🤝 Contribute

🤔 Why SWIRL?

Skip the Complexity, Keep the Power

❌ Without SWIRL Set up vector databases Move data around Complex ETL pipelines Weeks of infrastructure work Security headaches

✅ With SWIRL One docker command Data stays in place No vector DB needed 2-minute setup Enterprise-grade security

🚀 Built Different

No Vector DB Drama

# No need for:
$ setup-vector-db
$ migrate-data
$ configure-indexes

# Just this:
$ curl https://raw.githubusercontent.com/swirlai/swirl-search/main/docker-compose.yaml -o docker-compose.yaml

💡 What Can You Build With SWIRL?

Real examples of what teams build with SWIRL:

🔍 Knowledge Base Search

• Connect SharePoint, Confluence, & Drive
• Get instant answers with source links
• Keep sensitive data secure

🤖 Customer Support Assistant

• Search across support docs & tickets
• Draft responses using your content
• Maintain consistent answers

👩‍💻 Developer Assistant

• Search GitHub, Jira, & documentation
• Find code examples & solutions
• Speed up development workflow

🏢 Unified Search

• Unified search across all tools
• Results respect existing permissions
• No data duplication needed

👀 See it in action

Schedule Your Free Demo of SWIRL Enterprise

Try SWIRL Enterprise for free for 30 Days. Click on the banner to contact us.

⚡ Why Teams Choose SWIRL

• 🔒 Your infrastructure, your control
• 🚀 Deploy in minutes, not months
• 🔌 100+ enterprise connectors
• 🤖 AI that respects your security

SWIRL's Ranking in Action

SWIRL doesn't just search - it understands your company's context. Instead of broad web results, you get precise answers from your private data, right where it lives.

SWIRL Features

Full list of connectors is available here.

For Support on Connectors Contact the Swirl Team at: [email protected]

🔥 Try Swirl Now In Docker

Prerequisites

• To run Swirl in Docker, you must have the latest Docker app for MacOS, Linux, or Windows installed and running locally. You can also watch the video tutorial to get started.

• Windows users must also install and configure either the WSL 2 or the Hyper-V backend, as outlined in the System Requirements for installing Docker Desktop on Windows.

Start Swirl in Docker

Warning Make sure the Docker app is running before proceeding!

• Download the YAML file: https://raw.githubusercontent.com/swirlai/swirl-search/main/docker-compose.yaml

curl https://raw.githubusercontent.com/swirlai/swirl-search/main/docker-compose.yaml -o docker-compose.yaml

• Optional: To enable Swirl's Real-Time Retrieval Augmented Generation (RAG) in Docker, run the following commands from the Console using a valid OpenAI API key:

export MSAL_CB_PORT=8000
export MSAL_HOST=localhost
export OPENAI_API_KEY=‘<your-OpenAI-API-key>’

🔑 Check out OpenAI's YouTube video if you don't have an OpenAI API Key.

• In MacOS or Linux, run the following command from the Console:

docker-compose pull && docker-compose up

• In Windows, run the following command from PowerShell:

docker compose up

After a few minutes the following or similar should appear:

• Open this URL with a browser: http://localhost:8000 (or http://localhost:8000/galaxy)

• If the search page appears, click Log Out at the top, right. The Swirl login page will appear.

• Enter the username admin and password password, then click Login.

• Enter a search in the search box and press the Search button. Ranked results appear in just a few seconds:

• To view the raw JSON, open http://localhost:8000/swirl/search/

The most recent Search object will be displayed at the top. Click on the result_url link to view the full JSON Response.

Notes 📝

Warning The Docker version of Swirl does not retain any data or configuration when shut down!

🔑 Swirl includes five (5) Google Programmable Search Engines (PSEs) to get you up and running right away. The credentials for these are shared with the Swirl Community.

🔑 Using Swirl with Microsoft 365 requires installation and approval by an authorized company Administrator. For more information, please review the M365 Guide or contact us.

Next Steps 👇

• Check out the details of our latest release!

• Head over to the Quick Start Guide and install Swirl locally!

Video Tutorial

Guide to Run SWIRL in Docker in 60 seconds.

🌟 Key Features

✦	Feature
📌	Microsoft 365 integration and OAUTH2 support
🔍	SearchProvider configurations for all included Connectors. They can be organized with the active, default and tags properties.
✏️	Adaptation of the query for each provider such as rewriting NOT term to -term, removing NOTted terms from providers that don't support NOT, and passing down the AND, + and OR operators.
⏳	Synchronous or asynchronous search federation via APIs
🛎️	Optional subscribe feature to continuously monitor any search for new results
🛠️	Pipelining of Processor stages for real-time adaptation and transformation of queries, responses and results
🗄️	Results stored in SQLite3 or PostgreSQL for post-processing, consumption and/or analytics
➡️	Built-in Query Transformation support, including re-writing and replacement
📖	Matching on word stems and handling of stopwords via NLTK
🚫	Duplicate detection on field or by configurable Cosine Similarity threshold
🔄	Re-ranking of unified results using Cosine Vector Similarity based on spaCy's large language model and NLTK
🎚️	Result mixers order results by relevancy, date or round-robin (stack) format, with optional filtering of just new items in subscribe mode
📄	Page through all results requested, re-run, re-score and update searches using URLs provided with each result set
📁	Sample data sets for use with SQLite3 and PostgreSQL
✒️	Optional spell correction using TextBlob
⌛	Optional search/result expiration service to limit storage use
🔌	Easily extensible Connector and Mixer objects

👩‍💻 Contributing to Swirl

Do you have a brilliant idea or improvement for SWIRL? We're all ears, and thrilled you're here to help!

🔗 Get Started in 3 Easy Steps:

1. Connect with Fellow Enthusiasts - Jump into the Swirl Slack Community and share your ideas. You'll find a welcoming group of Swirl enthusiasts and team members eager to assist and collaborate.
2. Branch It Out - Always branch off from the develop branch with a descriptive name that encapsulates your idea or fix.
3. Start Your Contribution - Ready to get your hands dirty? Make sure all contributions come through a GitHub pull request. We roughly follow the Gitflow branching model, so all changes destined for the next release should be made to the develop branch.

📚 First time contributing on GitHub? No worries, the GitHub documentation has you covered with a great guide on contributing to projects.

💡 Every contribution, big or small, makes a difference. Join us in shaping the future of Swirl!

☁ Use the Swirl Cloud

For information about Swirl as a managed service, please contact us!

📖 Documentation

🔗 SWIRL Documentation

👷‍♂️ Need Help? We're Here for You!

At Swirl, every user matters to us. Whether you're a beginner finding your way or an expert with feedback, we're here to support, listen, and help. Don't hesitate to reach out to us.

• Join the SWIRL Community Slack: Dive into our SWIRL Community on Slack - to discuss anything related to SWIRL.

• Direct Support: For any questions, suggestions, or even a simple hello, drop us an email at [email protected]. We cherish every message and promise to get back to you promptly!

• Request A Connector (Enterprise Support) Want to see a new connector quickly and fast. Contact the Swirl Team at: [email protected]