DocChat is a Python application that allows users to interact with documents using natural language. It leverages LangChain, Gradio, and the OpenAI API to create a chat interface for document-based conversations.
Installation
To get started with DocChat, follow these steps:
- Clone the repository to your local machine:
git clone https://github.com/BackyardML/DocChat.git
- Change the directory to the project folder:
cd DocChat
- Install Poetry (if you haven't already):
pip install poetry
- Install project dependencies using Poetry:
poetry install
- Obtain an API key from OpenAI.
Usage
Running DocChat
You can run DocChat by executing the app.py script:
poetry run python app.py
This will start a Gradio web application with a chat interface that you can access through your web browser.
Interacting with DocChat
- Launch the Gradio application by running the app.py script.
- Set your OpenAI API key by entering it in the "OpenAI API Key" textbox.
- Upload the document you want to chat about using the file uploader.
- Click the "Run" button to create a chatbot for the document.
- Start chatting with the document! You can type messages in the "Message" textbox, and the chatbot will respond based on the content of the document.
- To clear the chat history, click the "Clear" button.
Contact
If you have any questions or need assistance, feel free to contact me at patrik@backyardml.se
1 maintainer
Metadata
1 maintainer
Release files for docchat 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| docchat-0.1.2.tar.gz | 3.1 kB | Without provenance | Details for docchat-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| docchat-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for docchat-0.1.2-py3-none-any.whl |
Total release size: 6.8 kB
Release files / docchat-0.1.2.tar.gz
| Download URL | docchat-0.1.2.tar.gz |
|---|---|
| Size | 3.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1ea6848a17a4f18c0c4b661d1ed3a7984fd7cfe69b20071135262d9831cc7180
|
|
BLAKE2b-256 checksum How to use checksums |
83c702741da336b2f3bc7a9f209f0db52a997537391896b1b67e4bd16a86c224
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Release files / docchat-0.1.2-py3-none-any.whl
| Download URL | docchat-0.1.2-py3-none-any.whl |
|---|---|
| Size | 3.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8c507cab9b1b31d1163e94956559f43fc77dd98664bbc3ea63c6028edd9e3ab6
|
|
BLAKE2b-256 checksum How to use checksums |
4f7dd6967aa619f2db070099d87f88b4efb0ca66bd8d439336e1ac426f10f9a5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Security for docchat 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
