# shubham0204/ondevice-rag-android architecture

> Architecture diagram of the GitHub repository shubham0204/ondevice-rag-android, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shubham0204/ondevice-rag-android
- Repository: https://github.com/shubham0204/ondevice-rag-android

## Overview

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: [`app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt`](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt) (Chat workflow), [`app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt`](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt) (App navigation), [`app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsViewModel.kt`](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsViewModel.kt) (Model download workflow), [`app/src/main/java/com/ml/shubham0204/docqa/ui/screens/docs/DocsViewModel.kt`](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/docs/DocsViewModel.kt) (Document workflow)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_navigation["App navigation"]
  node_main["App navigation<br/>[MainActivity.kt]"]
  node_chat["Chat interface<br/>[ChatScreen.kt]"]
  node_chatvm["Chat workflow<br/>[ChatViewModel.kt]"]
  node_docsui["Document manager<br/>[DocsScreen.kt]"]
end

subgraph group_ingestion["Document ingestion"]
  node_docslogic["Document workflow<br/>[DocsViewModel.kt]"]
  node_readers["Document readers<br/>[Readers.kt]"]
  node_splitter["Text chunking"]
end

subgraph group_retrieval["Retrieval and storage"]
  node_embedder["Sentence embeddings"]
  node_chunks[("Chunk vector store<br/>[ChunksDB.kt]")]
  node_documents[("Document store<br/>[DocumentsDB.kt]")]
  node_objectbox[("ObjectBox store<br/>[ObjectBoxStore.kt]")]
end

subgraph group_generation["Answer generation"]
  node_llmapi["Inference contract<br/>[LLMInferenceAPI.kt]"]
  node_gemini["Gemini inference<br/>[GeminiRemoteAPI.kt]"]
  node_litert["Local inference<br/>[LiteRTAPI.kt]"]
end

subgraph group_management["Model and credentials"]
  node_credentials["Credential editor"]
  node_key[("Gemini key storage<br/>[GeminiAPIKey.kt]")]
  node_modelsui["Local model manager"]
  node_modelslogic["Model download workflow"]
  node_modeldata["Local model catalog<br/>[LocalModel.kt]"]
end

node_user(("User"))
node_google{{"Gemini service"}}
node_huggingface{{"Hugging Face"}}

node_user -->|"opens app"| node_main
node_main -->|"routes to"| node_chat
node_main -->|"routes to"| node_docsui
node_main -->|"routes to"| node_modelsui
node_user -->|"selects document"| node_docsui
node_docsui -.->|"sends events"| node_docslogic
node_docslogic -->|"parses document"| node_readers
node_readers -->|"provides text"| node_splitter
node_splitter -->|"produces chunks"| node_embedder
node_embedder -->|"encodes and stores"| node_chunks
node_docslogic -.->|"records document"| node_documents
node_user -->|"submits question"| node_chat
node_chat -->|"sends query"| node_chatvm
node_chatvm -->|"checks document count"| node_documents
node_chatvm -->|"encodes query"| node_embedder
node_chatvm -->|"retrieves similar chunks"| node_chunks
node_chatvm -->|"uses when loaded"| node_litert
node_chatvm -->|"otherwise selects"| node_gemini
node_gemini -->|"implements"| node_llmapi
node_litert -->|"implements"| node_llmapi
node_gemini -.->|"requests generation"| node_google
node_chatvm -->|"reads API key"| node_key
node_user -->|"edits credentials"| node_credentials
node_credentials -.->|"saves key"| node_key
node_user -->|"manages models"| node_modelsui
node_modelsui -.->|"sends events"| node_modelslogic
node_modelslogic -->|"uses catalog"| node_modeldata
node_modelslogic -.->|"downloads models"| node_huggingface
node_modelslogic -->|"loads model"| node_litert
node_objectbox -->|"backs storage"| node_chunks
node_objectbox -->|"backs storage"| node_documents

click node_main "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt"
click node_chat "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatScreen.kt"
click node_chatvm "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt"
click node_docsui "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/docs/DocsScreen.kt"
click node_docslogic "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/docs/DocsViewModel.kt"
click node_readers "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/domain/readers/Readers.kt"
click node_splitter "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/domain/WhiteSpaceSplitter.kt"
click node_embedder "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/domain/SentenceEmbeddingProvider.kt"
click node_chunks "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/data/ChunksDB.kt"
click node_documents "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/data/DocumentsDB.kt"
click node_objectbox "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/data/ObjectBoxStore.kt"
click node_llmapi "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/domain/llm/LLMInferenceAPI.kt"
click node_gemini "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/domain/llm/GeminiRemoteAPI.kt"
click node_litert "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/domain/llm/LiteRTAPI.kt"
click node_credentials "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/edit_credentials/EditCredentialsScreen.kt"
click node_key "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/data/GeminiAPIKey.kt"
click node_modelsui "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsScreen.kt"
click node_modelslogic "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsViewModel.kt"
click node_modeldata "https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/data/LocalModel.kt"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_main,node_chat,node_chatvm,node_docsui,node_user toneBlue
class node_docslogic,node_readers,node_splitter toneAmber
class node_embedder,node_chunks,node_documents,node_objectbox toneMint
class node_llmapi,node_gemini,node_litert toneRose
class node_credentials,node_key,node_modelsui,node_modelslogic,node_modeldata,node_google,node_huggingface toneIndigo
```

## Components

### App navigation

- [App navigation](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt): `app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt`
- [Chat interface](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatScreen.kt): `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatScreen.kt`
- [Chat workflow](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt): `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt`
- [Document manager](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/docs/DocsScreen.kt): `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/docs/DocsScreen.kt`

### Document ingestion

- [Document workflow](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/docs/DocsViewModel.kt): `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/docs/DocsViewModel.kt`
- [Document readers](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/domain/readers/Readers.kt): `app/src/main/java/com/ml/shubham0204/docqa/domain/readers/Readers.kt`
- [Text chunking](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/domain/WhiteSpaceSplitter.kt): `app/src/main/java/com/ml/shubham0204/docqa/domain/WhiteSpaceSplitter.kt`

### Retrieval and storage

- [Sentence embeddings](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/domain/SentenceEmbeddingProvider.kt): `app/src/main/java/com/ml/shubham0204/docqa/domain/SentenceEmbeddingProvider.kt`
- [Chunk vector store](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/data/ChunksDB.kt): `app/src/main/java/com/ml/shubham0204/docqa/data/ChunksDB.kt`
- [Document store](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/data/DocumentsDB.kt): `app/src/main/java/com/ml/shubham0204/docqa/data/DocumentsDB.kt`
- [ObjectBox store](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/data/ObjectBoxStore.kt): `app/src/main/java/com/ml/shubham0204/docqa/data/ObjectBoxStore.kt`

### Answer generation

- [Inference contract](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/domain/llm/LLMInferenceAPI.kt): `app/src/main/java/com/ml/shubham0204/docqa/domain/llm/LLMInferenceAPI.kt`
- [Gemini inference](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/domain/llm/GeminiRemoteAPI.kt): `app/src/main/java/com/ml/shubham0204/docqa/domain/llm/GeminiRemoteAPI.kt`
- [Local inference](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/domain/llm/LiteRTAPI.kt): `app/src/main/java/com/ml/shubham0204/docqa/domain/llm/LiteRTAPI.kt`

### Model and credentials

- [Credential editor](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/edit_credentials/EditCredentialsScreen.kt): `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/edit_credentials/EditCredentialsScreen.kt`
- [Gemini key storage](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/data/GeminiAPIKey.kt): `app/src/main/java/com/ml/shubham0204/docqa/data/GeminiAPIKey.kt`
- [Local model manager](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsScreen.kt): `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsScreen.kt`
- [Model download workflow](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsViewModel.kt): `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsViewModel.kt`
- [Local model catalog](https://github.com/shubham0204/ondevice-rag-android/blob/main/app/src/main/java/com/ml/shubham0204/docqa/data/LocalModel.kt): `app/src/main/java/com/ml/shubham0204/docqa/data/LocalModel.kt`

### Other components

- **User**
- **Gemini service**
- **Hugging Face**

## Connections

- User → App navigation: opens app (evidence: `app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt`)
- App navigation → Chat interface: routes to (evidence: `app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt`)
- App navigation → Document manager: routes to (evidence: `app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt`)
- App navigation → Local model manager: routes to (evidence: `app/src/main/java/com/ml/shubham0204/docqa/MainActivity.kt`)
- User → Document manager: selects document (evidence: `README.md`)
- Document manager → Document workflow: sends events
- Document workflow → Document readers: parses document (evidence: `README.md`)
- Document readers → Text chunking: provides text (evidence: `README.md`)
- Text chunking → Sentence embeddings: produces chunks (evidence: `README.md`)
- Sentence embeddings → Chunk vector store: encodes and stores (evidence: `README.md`)
- Document workflow → Document store: records document
- User → Chat interface: submits question (evidence: `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatScreen.kt`)
- Chat interface → Chat workflow: sends query (evidence: `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatScreen.kt`)
- Chat workflow → Document store: checks document count (evidence: `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt`)
- Chat workflow → Sentence embeddings: encodes query (evidence: `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt`)
- Chat workflow → Chunk vector store: retrieves similar chunks (evidence: `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt`)
- Chat workflow → Local inference: uses when loaded (evidence: `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt`)
- Chat workflow → Gemini inference: otherwise selects (evidence: `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt`)
- Gemini inference → Inference contract: implements (evidence: `app/src/main/java/com/ml/shubham0204/docqa/domain/llm/GeminiRemoteAPI.kt`)
- Local inference → Inference contract: implements (evidence: `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 (evidence: `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/chat/ChatViewModel.kt`)
- User → Credential editor: edits credentials (evidence: `README.md`)
- Credential editor → Gemini key storage: saves key
- User → Local model manager: manages models (evidence: `README.md`)
- Local model manager → Model download workflow: sends events
- Model download workflow → Local model catalog: uses catalog (evidence: `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 (evidence: `app/src/main/java/com/ml/shubham0204/docqa/ui/screens/local_models/LocalModelsViewModel.kt`)
- ObjectBox store → Chunk vector store: backs storage (evidence: `app/src/main/java/com/ml/shubham0204/docqa/data/ChunksDB.kt`)
- ObjectBox store → Document store: backs storage (evidence: `app/src/main/java/com/ml/shubham0204/docqa/data/DocumentsDB.kt`)
