v3.0.0

![Swirl Logo](https://raw.githubusercontent.com/swirlai/swirl-search/main/docs/images/transparent_header_3.png)

## Team Swirl is announcing General Availability of Swirl 3.0!
Swirl 3.0 includes Real-Time Retrieval Augmented Generation (RAG). Harness the power of Generative AI like OpenAI ChatGPT with internal data by querying existing search engines, databases, applications and enterprise services. Search for anything; Swirl will use a built-in non-generative LLM to find the best results from all sources, and present them. Adjust the selections, then RAG in real-time to get human-directed, verifiable AI insight. Fetch the freshest available data from systems of record - without extracting, copying and pre-indexing *anything*.

### Community Contributions
:trophy: This version of Swirl includes numerous contributions from the open source community.  A thousand thank-you's to the following GitHub users for their accepted, merged PRs: Yash Mathur ([Yash-sudo-web](https://github.com/Yash-sudo-web)), [s-vamshi](https://github.com/s-vamshi), Ikko Eltociear Ashimine ([eltociear](https://github.com/eltociear)), Akash Kundu ([Akash190104](https://github.com/Akash190104)), Biplob Sutradhar ([biplobsd](https://github.com/biplobsd)), Harsh Mahajan ([HarshMN2345](https://github.com/HarshMN2345)), Varanasi Aditya Sai ([fvaysh](https://github.com/fvaysh)), Neel Shah ([neelshah2409](https://github.com/neelshah2409)) and Chandan Mali ([Chandanmali](https://github.com/Chandanmali))

### PLEASE STAR OUR REPO: [https://github.com/swirlai/swirl-search](https://github.com/swirlai/swirl-search)

<br/>

# New Features

:small_blue_diamond: Swirl 3.0 supports Real-Time [Retrieval Augmented Generation (RAG)](https://docs.swirl.today/index#what-is-retrieval-augmented-generation-rag-does-swirl-support-it). No copying or indexing of data is required as Swirl queries existing search APIs. Once RAG is triggered, optionally using the updated Galaxy UI, the new Page Fetcher component will retrieve result URLs and prepare a prompt. Note that the community edition only supports fetching of pages that don't require authentication. Contact [hello@swirl.today](mailtO:hello@swirl.today) if you need to RAG using authenticated sources like M365, ServiceNow or Salesforce. Follow [the new AI Guide](https://docs.swirl.today/AI-Guide) to get started - the main requirement is to add an OpenAI ChatGPT API key. (Other Generative AI platforms will be supported soon.) The European PMC SearchProvider is pre-configured for RAG so insights can be generated in minutes. 

:small_blue_diamond: The European PMC SearchProvider has been preloaded, set to active status, and configured to participate in RAG by default.
![Swirl RAG with EPMC](https://raw.githubusercontent.com/swirlai/swirl-search/main/docs/images/3_0_0-RAG-EMPC.png)

:small_blue_diamond: The new Retrieval Augmented Generation (RAG) Web Socket API is now available to developers. Refer to the [Developer Guide](https://docs.swirl.today/Developer-Guide#retrieval-augmented-generation-web-socket-api) for details.

## New Swirl Documentation:  [https://docs.swirl.today/](https://docs.swirl.today/)
Swirl's product documentation has a new home, a new template, and a handy new find-in-page option! 

Check it out:
![Swirl docs](https://raw.githubusercontent.com/swirlai/swirl-search/main/docs/images/3_0_0-Docs-1.png)
![Swirl docs find in page](https://raw.githubusercontent.com/swirlai/swirl-search/main/docs/images/3_0_0-Docs-2.png)

Swirl 3.0 includes a new Google PSE SearchProvider that targets the Swirl documentation website. This SearchProvider is enabled by default so you can search Swirl documentation with Swirl!
![Swirl docs result](https://raw.githubusercontent.com/swirlai/swirl-search/main/docs/images/3_0_0-Docs-3.png)

## New SearchProviders
Query for a specific Bitcoin Address or Transaction Hash using the new Blockchain.com Bitcoin SearchProviders:
![Bitcoin Address result](https://raw.githubusercontent.com/swirlai/swirl-search/main/docs/images/3_0_0-BTC-address.png)
![Bitcoin Transaction result](https://raw.githubusercontent.com/swirlai/swirl-search/main/docs/images/3_0_0-BTC-transaction.png)

Search organizations in Crunchbase with our new Crunchbase Basic SearchProvider:
![Crunchbase result](https://raw.githubusercontent.com/swirlai/swirl-search/main/docs/images/3_0_0-Crunchbase.png)

:key: Note: SearchProviders contributed by the Swirl Community, including those for Algolia and Trello, may be found in the `SearchProviders/untested` directory. Some may include Connectors as well as SearchProviders. All will be moved into the production SearchProviders and pre-loaded in future releases.

# Improvements

:small_blue_diamond: Repository Standards: Swirl has published a full set of [GitHub Community Standards](https://github.com/swirlai/swirl-search/community) to support our growing community of contributors.

:small_blue_diamond: Microsoft OneDrive SearchProvider was updated to omit folders as results; it now only returns documents.

# Resolved Issues

:small_blue_diamond: The Microsoft Authenticator toggle now turns green when active.

:small_blue_diamond: The updated RequestsGet connector now handles sources that return only a single result.

:small_blue_diamond: The legacy `redis.conf` file was removed.

:small_blue_diamond: The Galaxy UI login page now handles window resizing more gracefully.

# Known Issues

:small_blue_diamond: Clicking a Microsoft Teams result sometimes results in this error from the Teams app:
```
We cannot take you to that message because it's in a chat you're not in.
```
For Teams links to resolve correctly, you must have the Microsoft Teams app open *before* clicking the result link.

:small_blue_diamond: [Creating searches from a browser with q=](https://docs.swirl.today/Developer-Guide.html#create-a-search-object-with-the-q-url-parameter) can sometimes create two Search objects. 

This is because of browser prefetch AKA predictive service. [Turn off Chrome prediction service](https://www.ghacks.net/2019/04/23/missing-chromes-use-a-prediction-service-setting/). [Turn off Safari prefetch](https://stackoverflow.com/questions/29214246/how-to-turn-off-safaris-prefetch-feature).

Please report any issues with this to [support](#support).


# Upgrading

:warning:  Version 3.0.0 requires database migration. See [Upgrading Swirl](https://docs.swirl.today/Admin-Guide.html#upgrading-swirl).

:warning: As of version 2.6, Swirl's start-up process no longer starts `redis`.  You must now have `redis` installed *and running* before starting Swirl.


# Documentation

[Overview](https://docs.swirl.today/) | [Quick Start](https://docs.swirl.today/Quick-Start) | [User Guide](https://docs.swirl.today/User-Guide) | [Admin Guide](https://docs.swirl.today/Admin-Guide) | [M365 Guide](https://docs.swirl.today/M365-Guide) | [Developer Guide](https://docs.swirl.today/Developer-Guide) | [Developer Reference](https://docs.swirl.today/Developer-Reference) | [AI Guide](https://docs.swirl.today/AI-Guide)

# Support

:small_blue_diamond: [Join the Swirl Community on Slack!](https://join.slack.com/t/swirlmetasearch/shared_invite/zt-1qk7q02eo-kpqFAbiZJGOdqgYVvR1sfw)

:small_blue_diamond: Email: [support@swirl.today](mailto:support@swirl.today) with issues, requests, questions, etc - we'd love to hear from you!