Skip to main content

DocsChat 📚🗣️

docschat is a command-line interface that let's you start a local streamlit server and interact with your documents.

The chatbot utilizes a conversational retrieval chain to answer user queries based on the content of embedded documents. It leverages various NLP techniques, including language models and embeddings, to provide relevant responses.

Features

  • Document Embedding: Embeds PDF documents for efficient retrieval of information.
  • Conversational Interface: Allows users to interact with documents through a chat interface.
  • Settings: Provides customizable settings for configuring document retrieval and model parameters.

Installation

To run the application locally, follow these steps for installation.

pip install DocsChat

Pulll Ollama llm:

ollama pull llama3
ollama pull llama2
ollama pull gemma
ollama pull mistral
ollama pull codellama

Start the Ollama server:

ollama run llama3

Run the application:

docschat

Configure

DocsChat

PDF sources

  • Configure the PDF source directory from which all PDFs should be read in recusively.
  • Select a splitter, this has an influence on the chunks that we will make available to the LLM and thus also on the answers. By default no splitter is selected, this means a larger context.

Vector store

Vector store

  • Chroma DB in memory is used as a vector store, which stores the data in a Persit directory, so the data in the DB is also available after the restart.
  • The Retriever search type has and the various parameters influence the search of documents in the Vectore Store.

Ollama

Ollama

  • Configure the ollama server connection and the model with which the server was started.
  • the LLM parameters influence the embedding of the PDFs but also the answering of questions in the RAG pipeline.

Actions

Actions

There are two functions available, the sync of PDF documents into the Vectore Store. This can take some time depending on the system resources, embedding and splitter. The Delete DB function deletes the Chroma Collection.

Metadata

Release files for DocsChat 7.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for DocsChat 7.0.0
File Size Uploaded
docschat-7.0.0.tar.gz 10.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for DocsChat 7.0.0
File Interpreter ABI Platform
DocsChat-7.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 22.3 kB

Release files / docschat-7.0.0.tar.gz

Download URL docschat-7.0.0.tar.gz
Size 10.8 kB
Tags Source
SHA-256 checksum
How to use checksums
3c6abaefb1099cc02385e156da75abb2717109595226d0a4c22cd60c18021281
BLAKE2b-256 checksum
How to use checksums
2672ee51d0a335852b5da321d9a98b8ee1fe70788ba02e6334f89aada54604f6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.8

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 12, 2025.

Transparency log

Release files / DocsChat-7.0.0-py3-none-any.whl

Download URL DocsChat-7.0.0-py3-none-any.whl
Size 11.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4878058e8757808e135955277d8293cc53e4799f88e4a3c54b4b30e9227a9eb3
BLAKE2b-256 checksum
How to use checksums
637bc1d05f78abf474ec8163000a31f2882a46b906df6dfdb0b1e26ccdaa5be9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.8

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 12, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

7.0.0 This release

2 release files

6.0.0

2 release files

5.0.0

2 release files

4.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page