README.md

Docq - Private & Secure AI Knowledge Insight

A turnkey product to utilise your organisation's documents for AI-induced productivity boost.

Demo app in action »
Explore the docs »
Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Docq offers private and secure AI to utilise your organisation's documents for knowledge insight 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 and image.

We offer Docq as a turnkey solution to maximise ROI for your organisation to adopt the latest AI innovations.

• 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.

(back to top)

Getting Started

To run this project locally, you will need to install the prerequisites and follow the installation section.

Prerequisites

This Project depends on the following projects.

• Poetry

  pip install --user --upgrade poetry

• Poe the Poet

  pip install --user --upgrade poethepoet

Installation

1. Clone the repo

   git clone https://github.com/docqai/docq
   cd docq

2. Install Poe the Poet and Poetry

   pip install --user --upgrade poethepoet poetry

3. Install requirements for development

   poe install-dev

4. Run tests

   poe test

(back to top)

Usage

Some useful examples of how this project can be used:

• Install requirements

  poe install-dev

• Run tests

  poe test

• Run the project

  poe run

• Generate API documentation

  poe do

• Build a docker image for tests

  poe docker-build --target test --build-tag 3.10-alpine --test true
  poe docker-run --target test

• Build a docker image to run the root files only without running any test

  • Build image

  poe docker-build

  • Add a .env file with the following

  OPENAI_API_KEY # don't add secret values here, only var name. set value in your env with set/export.
  DOCQ_DATA=./.persisted/
  STREAMLIT_SERVER_ADDRESS=0.0.0.0
  STREAMLIT_SERVER_PORT=8501 # option 8501 is the default
  

  • set secrets export OPEN_API_KEY=<your secret token>. Note that the .env file only has the env name not the value for secrets. It's best practice not to add secret to files even if gitignored.
  • Run container

  poe docker-run

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Add tests
• Add code coverage
• Improve documentation
• Include more tests

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Docq.AI - @docqai - support@docq.ai

Project Link: https://github.com/docqai/docq/

(back to top)

Acknowledgments

The project would not have been possible without the following libraries:

• @jerryjliu Llama Index
• Streamlit and many open-source Streamlit components as well as its Community Cloud

This project was created using cookiecutter and NullHack's python-project-template:

• @NullHack python-project-template

(back to top)

License

Distributed under the AGPLv3 License. See LICENSE for more information.

(back to top)