How shubham0204/ondevice-rag-android works
This is an Android document-question-answering app using local retrieval-augmented generation: users import documents, ask questions, and receive answers grounded in retrieved chunks. The documented ingestion stages are parsing, whitespace chunking, embedding, and vector storage; the chat stage retrieves similar chunks and sends a context-filled prompt to either a local LiteRT model or Gemini. The app also supports credential editing and downloading/loading local models. Ingestion and several management-screen links are based on the README and source index; their implementation details were not sampled.
Main entry points: ChatViewModel.kt Chat workflow · MainActivity.kt App navigation · LocalModelsViewModel.kt Model download workflow · DocsViewModel.kt Document workflow
Components 22
App navigation
- App navigation
app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt - Chat interface
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatScreen.kt - Chat workflow
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt - Document manager
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/docs/DocsScreen.kt
Document ingestion
- Document workflow
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/docs/DocsViewModel.kt - Document readers
app/src/main/java/com/ml/shubham0204/docqa/domain/readers/Readers.kt - Text chunking
app/src/main/java/com/ml/shubham0204/docqa/domain/WhiteSpaceSplitter.kt
Retrieval and storage
- Sentence embeddings
app/src/main/java/com/ml/shubham0204/docqa/domain/SentenceEmbeddingProvider.kt - Chunk vector store
app/src/main/java/com/ml/shubham0204/docqa/data/ChunksDB.kt - Document store
app/src/main/java/com/ml/shubham0204/docqa/data/DocumentsDB.kt - ObjectBox store
app/src/main/java/com/ml/shubham0204/docqa/data/ObjectBoxStore.kt
Answer generation
- Inference contract
app/src/main/java/com/ml/shubham0204/docqa/domain/llm/LLMInferenceAPI.kt - Gemini inference
app/src/main/java/com/ml/shubham0204/docqa/domain/llm/GeminiRemoteAPI.kt - Local inference
app/src/main/java/com/ml/shubham0204/docqa/domain/llm/LiteRTAPI.kt
Model and credentials
- Credential editor
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/edit_credentials/EditCredentialsScreen.kt - Gemini key storage
app/src/main/java/com/ml/shubham0204/docqa/data/GeminiAPIKey.kt - Local model manager
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsScreen.kt - Model download workflow
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsViewModel.kt - Local model catalog
app/src/main/java/com/ml/shubham0204/docqa/data/LocalModel.kt
Other components
- User
- Gemini service
- Hugging Face
Connections 31
- User → App navigation: opens app
app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt - App navigation → Chat interface: routes to
app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt - App navigation → Document manager: routes to
app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt - App navigation → Local model manager: routes to
app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt - User → Document manager: selects document
README.md - Document manager → Document workflow: sends events
- Document workflow → Document readers: parses document
README.md - Document readers → Text chunking: provides text
README.md - Text chunking → Sentence embeddings: produces chunks
README.md - Sentence embeddings → Chunk vector store: encodes and stores
README.md - Document workflow → Document store: records document
- User → Chat interface: submits question
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatScreen.kt - Chat interface → Chat workflow: sends query
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatScreen.kt - Chat workflow → Document store: checks document count
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt - Chat workflow → Sentence embeddings: encodes query
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt - Chat workflow → Chunk vector store: retrieves similar chunks
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt - Chat workflow → Local inference: uses when loaded
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt - Chat workflow → Gemini inference: otherwise selects
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt - Gemini inference → Inference contract: implements
app/src/main/java/com/ml/shubham0204/docqa/domain/llm/GeminiRemoteAPI.kt - Local inference → Inference contract: implements
app/src/main/java/com/ml/shubham0204/docqa/domain/llm/LiteRTAPI.kt - Gemini inference → Gemini service: requests generation
- Chat workflow → Gemini key storage: reads API key
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt - User → Credential editor: edits credentials
README.md - Credential editor → Gemini key storage: saves key
- User → Local model manager: manages models
README.md - Local model manager → Model download workflow: sends events
- Model download workflow → Local model catalog: uses catalog
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsViewModel.kt - Model download workflow → Hugging Face: downloads models
- Model download workflow → Local inference: loads model
app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsViewModel.kt - ObjectBox store → Chunk vector store: backs storage
app/src/main/java/com/ml/shubham0204/docqa/data/ChunksDB.kt - ObjectBox store → Document store: backs storage
app/src/main/java/com/ml/shubham0204/docqa/data/DocumentsDB.kt