Giter Club home page Giter Club logo

doc_query's Introduction

Documentation query app

This is a Shiny for Python application which allows you to ask questions about a set of documents. It uses the chatstream package to query the OpenAI API.

First, install some Python packages:

pip install -r requirements.txt

Then load at least one set of text/markdown/PDF files into a vector database, using doc_db.py script. This will save the documents in a database in a directory named doc_db/.

The syntax is:

./doc_db.py add-dir <collection name> <directory> <file pattern>

For example:

./doc_db.py add-dir admin-guide ../docs/admin "*.qmd"
./doc_db.py add-dir user-guide ../docs/user "*.qmd"

After the documents are loaded into the vector database, they can be queried using the Shiny app.

To use the Shiny app, you need an API key from OpenAI. After you have it, you can set an environment variable named OPENAI_API_KEY:

export OPENAI_API_KEY="<your_openai_api_key>"

Then you can run the app with:

shiny run app.py --launch-browser

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.