You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f7cf350
Browse filesBrowse the repository at this point in the historyBrowse files
**DocsGuide** is a bilingual AI assistant that helps people navigate Nepali government document procedures. It uses retrieval-augmented generation (RAG) to provide step-by-step answers grounded in verified official documents, with source citations.
4
6
5
7
## Features
@@ -90,6 +92,14 @@ The web client is available at <http://localhost:3000>.
90
92
For a deployed frontend, copy `frontend/.env.example` to
91
93
`frontend/.env.local` and set `NEXT_PUBLIC_API_URL` to the public API URL.
92
94
95
+
## Demo and screenshots
96
+
97
+
Run the frontend and backend locally using the Quickstart commands above, then
98
+
open <http://localhost:3000>. The system design below shows the full request
99
+
path from the web client through retrieval and generation:
100
+
101
+

102
+
93
103
## Deployment
94
104
95
105
The repository includes deployment manifests for the two-service setup:
@@ -118,6 +128,11 @@ needs a separately hosted API to answer questions.
118
128
- Manually labeled chunks used as ground truth
119
129
- 43 real-world citizenship and passport queries in total
120
130
131
+
The fixtures are in `data/qa/citizenship_qa.json`, `data/qa/passport_qa.json`,
132
+
and `data/qa/test_mixed_qa.json`. The evaluation notebooks are
133
+
`src/qa_test.ipynb`, `src/rag_pipeline_test.ipynb`, and
134
+
`src/rag_pipeline.ipynb`.
135
+
121
136
## Performance
122
137
123
138
Our best hybrid-search configuration uses a 50/50 dense/sparse split, document-type filtering, and reranking:
@@ -133,11 +148,29 @@ These results use a small manually labeled benchmark and should be treated as an
133
148
134
149
- Never commit `.env` files, API keys, Pinecone credentials, or generated vector databases.
135
150
- Set `NEXT_PUBLIC_API_URL` in `frontend/.env.local` when the API is not running on localhost.
151
+
- If a key is exposed, revoke it in the provider dashboard immediately and replace it in local and deployed secrets.
136
152
- The assistant is informational and does not replace official government guidance. Users should verify requirements with the linked source documents.
137
153
154
+
## Limitations
155
+
156
+
- Current coverage focuses on citizenship and passport procedures.
157
+
- Answer quality depends on the completeness and freshness of the ingested official documents.
158
+
- Responses are informational and are not legal advice or a guarantee that an application will be accepted.
159
+
- The benchmark is small and manually labeled, so its scores are an initial baseline rather than a general accuracy guarantee.
160
+
161
+
## Roadmap
162
+
163
+
- Expand coverage to PAN, driving license, land records, and additional government services.
164
+
- Add a user-feedback loop for retrieval and answer quality improvements.
165
+
- Add OCR and speech support for scanned forms and mixed-language queries.
166
+
- Publish a hosted demo when the backend credentials and deployment service are configured.
167
+
138
168
## Attribution
139
169
140
-
This repository is a structured copy of the original DocsGuide project by the FuseAI Fellowship team. See the project documentation in `docs/` for the proposal, literature review, system design, and defense materials.
170
+
This repository is a structured copy of the original [HelpingHands repository](https://github.com/Dipin-Adhikari/HelpingHands) by the FuseAI Fellowship team. It preserves the original application and data while adding a cleaner project README, deployment manifests, CI, environment templates, and security-focused configuration defaults. See `docs/` for the proposal, literature review, system design, and defense materials.
171
+
172
+
The source repository does not include a license file. Confirm the original
173
+
team's licensing terms before redistributing or deploying this copy.
0 commit comments