Update README.md

Add embeds + update features / roadmap
This commit is contained in:
Chris Weaver 2023-08-28 02:42:01 -07:00 committed by GitHub
parent 96575bf893
commit cddd86dd1c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -22,23 +22,60 @@
<strong>[Danswer](https://www.danswer.ai/)</strong> allows you to ask natural language questions against internal documents and get back reliable answers backed by quotes and references from the source material so that you can always trust what you get back. You can connect to a number of common tools such as Slack, GitHub, Confluence, amongst others.
Check out our <strong><a href="https://www.youtube.com/watch?v=geNzY1nbCnU">Video Demo</a></strong>!
<h3>Usage</h3>
Danswer provides a fully-featured web UI:
## Features 💃
https://github.com/danswer-ai/danswer/assets/25087905/619607a1-4ad2-41a0-9728-351752acc26e
Or, if you prefer, you can plug Danswer into your existing flows:
https://github.com/danswer-ai/danswer/assets/25087905/3e19739b-d178-4371-9a38-011430bdec1b
For more details on the admin controls, check out our <strong><a href="https://www.youtube.com/watch?v=geNzY1nbCnU">Full Video Demo</a></strong>!
<h3>Deployment</h3>
Danswer can easily be tested locally or deployed on a virtual machine with a single `docker compose` command. Checkout our [docs](https://docs.danswer.dev/quickstart) to learn more.
We also have built-in support for deployment on Kubernetes. Files for that can be found [here](https://github.com/danswer-ai/danswer/tree/main/deployment/kubernetes).
## 💃 Features
* Direct QA powered by Generative AI models with answers backed by quotes and source links.
* Intelligent Document Retrieval (Semantic Search/Reranking) using the latest LLMs.
* An AI Helper backed by a custom Deep Learning model to interpret user intent.
* User authentication and document level access management.
* Connectors to Slack, GitHub, GoogleDrive, Confluence, local files, and web scraping, with more to come.
* Option to use Opensource LLMs like Orca, Falcon etc. in place of OpenAI GPT.
* Support for an LLM of your choice (GPT-4, Llama2, Orca, etc.)
* Management Dashboard to manage connectors and set up features such as live update fetching.
* One line Docker Compose (or Kubernetes) deployment to host Danswer anywhere.
## Upcoming
## 🔌 Connectors
Danswer currently syncs documents (every 10 minutes) from:
* Slack
* GitHub
* Google Drive
* Confluence
* Jira
* Notion
* Slab
* Linear
* Productboard
* Guru
* Zulip
* Bookstack
* Local Files
* Websites
* With more to come...
## 🚧 Roadmap
* Chat/Conversation support.
* Templates to easily build custom connectors.
* Personalized search
* Organizational understanding.
* Ability to locate and suggest experts.
## 💡 Contributing
Looking to contribute? Please check out the [Contribution Guide](CONTRIBUTING.md) for more details.