whatisgithub

What is docpaws?

biao994/docpaws — explained in plain English

Analysis updated 2026-05-18

55PythonAudience · developerComplexity · 3/5LicenseSetup · moderate

In one sentence

DocPaws lets users upload PDFs, build a searchable knowledge base, and ask questions answered with citations pulled directly from the documents.

Mindmap

A visual breakdown will appear here once this repo is fully enriched.

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Upload a set of PDFs and ask questions answered with citations to the source pages.

USE CASE 2

Scope a question to a single folder or file instead of the whole knowledge base.

USE CASE 3

Run the included Golden 20 evaluation suite to check answer quality after changing models.

USE CASE 4

Connect DeepSeek, SiliconFlow, or another OpenAI-compatible API as the language model.

What is it built with?

PythonFastAPIVueSQLiteFAISSCeleryRedis

How does it compare?

biao994/docpawsbhartiyashesh/purelymailcalendarequality-machine/claude-p
Stars555555
LanguagePythonPythonPython
Setup difficultymoderatemoderateeasy
Complexity3/54/53/5
Audiencedevelopergeneraldeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 1h+

Background indexing through Celery requires Redis, and Windows has a compatibility restriction for the worker pool.

Released under the MIT license, so it can be used, modified, and reused freely, including commercially, as long as the copyright notice is kept.

So what is it?

DocPaws is a document question-and-answer assistant that lets users upload PDF files, build a searchable knowledge base from them, and then ask questions in a chat interface. The AI finds relevant passages from the uploaded documents and cites them in its responses. If no relevant content is found above a configurable similarity threshold, the system declines to answer rather than guessing, which the project describes as "retrieval distance threshold rejection." The backend is written in Python using FastAPI, a web framework for building APIs, and stores data in SQLite with FAISS handling the vector index (a structure that allows fast similarity search over document chunks). The frontend is a Vue 3 single-page application. Users can organize documents into folders and scope a question to the full knowledge base, a specific folder, or a single file. Responses stream in real time, and a "thinking process" display is available during generation. The project connects to external AI services for both the language model and the embedding model (the part that converts text into searchable vectors). Supported providers include DeepSeek, SiliconFlow, and OpenAI-compatible APIs. API keys are stored in a local environment file that the README explicitly warns should not be committed to version control. Indexing uploaded PDFs can run synchronously or through a background task queue called Celery, which requires Redis. The Celery path is optional: without it, indexing runs inline. The README provides separate startup instructions for Windows and macOS/Linux, noting that Windows has a compatibility restriction for the Celery worker pool. The repository includes an evaluation suite called "Golden 20" with 20 test questions and reproducible scoring, intended for regression testing when the retrieval or model configuration changes. The backend also has over 79 automated test cases. The project is released under the MIT license.

Copy-paste prompts

Prompt 1
How do I set up DocPaws with Celery and Redis for background PDF indexing on Linux?
Prompt 2
Explain what 'retrieval distance threshold rejection' means and why DocPaws uses it.
Prompt 3
Walk me through configuring DocPaws to use the DeepSeek API instead of OpenAI.
Prompt 4
What does the Golden 20 evaluation suite check, and how do I run it?

Frequently asked questions

What is docpaws?

DocPaws lets users upload PDFs, build a searchable knowledge base, and ask questions answered with citations pulled directly from the documents.

What language is docpaws written in?

Mainly Python. The stack also includes Python, FastAPI, Vue.

What license does docpaws use?

Released under the MIT license, so it can be used, modified, and reused freely, including commercially, as long as the copyright notice is kept.

How hard is docpaws to set up?

Setup difficulty is rated moderate, with roughly 1h+ to a first successful run.

Who is docpaws for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.