Skip to content

Commit

Permalink
docs: update README and home page help text. (#178)
Browse files Browse the repository at this point in the history
  • Loading branch information
janaka authored Dec 7, 2023
1 parent 4c44bcc commit e5cb7af
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 12 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,29 +15,36 @@
[![Slack][slack-shield]][slack-url]
[![X (formerly Twitter) Follow][twitter-shield]][twitter-url]

# Docq - Private & Secure AI Knowledge Insight
# Docq - Private & Secure AI Knowledge Insight from your docs.

**Your employees' private and secure ChatGPT / second-brain that knows your business**

![Docq Logo](https://docqai.github.io/docq/assets/Docq_design_key_ingredients.png)
![Docq overview in a single diagram](https://docqai.github.io/docq/assets/docq-diag-nov2023.png)

<!-- ABOUT THE PROJECT -->

## About The Project

Docq offers **private** and **secure** AI to utilise your organisation's documents for knowledge insight with minimal onboarding and operational effort.
Docq offers **private** and **secure** GenAI that unlocks knowledge from your organisation's documents, with minimal onboarding and operational effort.

- **Self-hosting** with your organisation's choice of cloud vendor.
- **Plug-n-Play** with minimal onboarding and operational effort.
- **Multi-modal** document format support including text, image and video.
- Support for **cloud-vendor-hosted & self-hosted LLMs** within same cloud account to address data security and privacy concerns.
Design tenants:

- **Data stays within your boundary** bring ML models to the data. Cloud-vendor-hosted & self-hosted LLMs within the same cloud account to address data security and privacy concerns.
- **Self-hosting** with your organisation's choice of cloud vendor. Minimal onboarding and operational effort. Can support air-gap use cases with local models.
- **multi-model** ability to utilise a variety of models and ability adopt new models quickly.
- **Multi-modal** supports text today. Image, video, and audio formats are on the roadmap.
- **Extensible** Abstractions to easily add custom data sources. Plugin system for extending application, from UI to database.

We offer Docq as a **turnkey** solution to lower the barrier for your organisation to adopt the latest AI innovation safely.

- Open-source (AGPLv3) to address your organisation's security and compliance needs.
- Commercial support available via a UK-based entity.
- Re-licensing option also available.

## Vision

Be the goto OSS GenAI application stack for the privacy and security concious.

## Demo

A [demo app](https://docq-ai.streamlit.app/) is hosted by [Streamlit Community Cloud](https://streamlit.io/cloud), subject to frequent data refresh and feature update.
Expand Down
10 changes: 5 additions & 5 deletions web/index.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,18 +57,18 @@

st.markdown(
"""
- Click on the _General Chat_ link to use Docq like ChatGPT.
- Click on the _Ask Your Documents_ link to ask questions and get answers from your own documents. You can also _Manage Your Documents_.
- Click on the _Ask Shared Documents_ link to ask questions and get answers from documents shared within your organisation.
- Click on _General Chat_ to use Docq like ChatGPT.
- Click on _Ask Shared Documents_ link to ask questions and get answers from documents shared within your organisation as a Space.
- Click on _Admin Spaces_ to create a new Space, add documents, and share with your organisation.
"""
)

st.subheader("Tips & Tricks")
st.markdown(
"""
- Always ask questions in plain English and try to be as specific as possible.
- You can manage the documents in your space which sets the context for your questions.
- Your access to shared spaces is subject to permissions set by your organisation.
- Admins can manage the documents in a Space which sets the context for your questions.
- Your access to shared spaces is subject to permissions set by your organisation admin.
- For any questions or feedback, please contact your organisation's Docq administrator.
Enjoy Docq!
Expand Down

0 comments on commit e5cb7af

Please sign in to comment.