RAG - Retrieval-Augmented Generation

Askimo App includes powerful RAG (Retrieval-Augmented Generation) capabilities that allow you to create project-based knowledge bases. Whether you’re a developer working with code, a writer managing documents, or a researcher organizing data, Askimo’s Lucene-powered indexing helps your AI conversations access and reference your files automatically.

---

What is RAG?

RAG (Retrieval-Augmented Generation) enhances AI conversations by:

• Accessing Your Project Files: AI can reference your local documents, code, research papers, or any other files
• Accurate Responses: Answers are grounded in your actual content, not just the AI’s training data
• Privacy-First: All indexing and retrieval happens locally on your machine
• Fast Search: Lucene-powered indexing provides lightning-fast retrieval across thousands of files

提示

RAG is perfect for asking questions about your codebase, research papers, business documents, creative writing projects, or any collection of files—without uploading anything to external servers.

How RAG Works in Askimo

Here’s how Askimo processes and retrieves information from your project files:

graph TB
    subgraph "1. Ingestion Process"
        A[Project Files] --> B[File Parser]
        B --> C{File Type Detection}
        C -->|Code| D[Code Parser]
        C -->|PDF| E[PDF Text Extractor]
        C -->|Office Docs| F[Office Parser]
        C -->|Text/Markdown| G[Text Parser]
        D --> H[Text Chunks]
        E --> H
        F --> H
        G --> H
    end

    subgraph "2. Indexing & Storage"
        H --> I[Document Chunker
256-2048 tokens]
        I --> J[Embedding Generator]
        J --> K[(JVector Store
Vector Embeddings)]
        J --> L[(Lucene Index
Full-Text Search)]
    end

    subgraph "3. Query & Retrieval"
        M[User Query] --> N[Query Embedding]
        N --> O[ContentRetriever]
        O --> K
        O --> L
        K --> P[Vector Similarity Search]
        L --> Q[Keyword Search]
        P --> R[Top-K Results]
        Q --> R
    end

    subgraph "4. Context Injection"
        R --> S[ContentInjector]
        S --> T[Rank & Filter Results]
        T --> U[Context Window Manager]
        U --> V[Inject into AI Prompt]
        V --> W[AI Model]
        W --> X[Enhanced Response]
    end

    style K fill:#e1f5ff
    style L fill:#e1f5ff
    style O fill:#fff4e6
    style S fill:#f3e8ff
    style W fill:#e8f5e9

The Process:

1. Ingestion: Files are parsed based on their type (code, PDF, Office docs, text)
2. Indexing: Content is split into chunks, embedded as vectors (JVector), and indexed for full-text search (Lucene)
3. Retrieval: When you ask a question, ContentRetriever searches both vector embeddings and full-text index
4. Injection: ContentInjector ranks results, manages context window, and injects relevant chunks into your AI conversation

All of this happens locally on your machine—no data ever leaves your computer.

---

Creating a Project with RAG

Step 1: Create a New Project

1. Open Project Manager

   • Click the “Projects” icon in the sidebar
   • Or use keyboard shortcut: ⌘/Ctrl + P

2. Create New Project

   • Click ”+ New Project” button
   • Enter a project name (e.g., “My Web App”, “Research Papers”, “Novel Draft”, “Marketing Documents”)
   • Optionally add a description

3. Select Project Directory

   • Click “Select Folder” to choose the project root directory
   • This directory and its subdirectories will be indexed automatically

Step 2: Automatic Indexing

Indexing starts automatically when you create a project:

1. Askimo detects the project type (Gradle, Maven, Python, Node.js, etc.)
2. Indexing begins immediately in the background
3. Monitor indexing progress in the status bar
4. Wait for indexing to complete (typically 10-60 seconds depending on project size)

提示

No manual configuration needed! Askimo intelligently indexes your project based on its type and structure.

What Gets Indexed:

Askimo automatically indexes:

• All text-based source files
• PDF files (text content extracted)
• Microsoft Office documents (.docx, .xlsx, .pptx)
• OpenOffice documents (.odt, .ods, .odp)
• Email files (.eml, .msg)
• Documentation files (.md, .txt, .rst, etc.)
• Configuration files (.json, .yaml, .xml, etc.)

What Gets Excluded:

Askimo intelligently excludes:

• Common build artifacts (build/, dist/, target/, .gradle/, etc.)
• Dependencies (node_modules/, vendor/, venv/, etc.)
• Files listed in .gitignore
• Binary files (except supported document types)
• Files larger than 5 MB
• IDE-specific directories (.idea/, .vscode/, etc.)

注意

Askimo uses smart defaults based on your project type. For example, Maven projects exclude target/ and .m2/, while Node.js projects exclude node_modules/ and dist/.

警告

Large projects (>10,000 files) may take several minutes to index initially. Subsequent updates are incremental and much faster.

---

Using RAG in Chat Sessions

Creating a New Chat in a Project

When you create a chat session within a project, RAG is automatically enabled to provide context from your indexed files.

1. Navigate to Your Project

   • Open the project in the sidebar
   • Your indexed project is ready to use

2. Start a New Chat

   • Click the ”+” button within the project
   • Or use ⌘/Ctrl + N while in project view

3. Chat with Context

   • RAG is enabled by default - no need to toggle!
   • The AI automatically retrieves relevant context from your indexed files
   • A small indicator shows which project’s knowledge is active

提示

Project Context Active: When chatting within a project, you’ll see an indicator showing that RAG is enabled and which project’s knowledge base is being used.

Example Queries

With RAG enabled, you can ask questions about your project:

For Developers:

• “What’s the purpose of the UserService class in this project?”
• “Show me all REST endpoints defined in the API controllers”
• “Explain the authentication flow used in this application”
• “How is error handling implemented across the codebase?”
• “What dependencies are used for database access?”
• “List all database models and their relationships”

For Writers & Content Creators:

• “Summarize the main topics covered in my documentation”
• “Find all mentions of pricing in my marketing documents”
• “What blog posts have I written about AI?”
• “Create an outline based on my research notes”
• “List all the characters mentioned in my story drafts”

For Researchers & Analysts:

• “What are the key findings in my research papers?”
• “Find all references to climate change in these PDFs”
• “Summarize the data from my Excel spreadsheets”
• “What patterns appear across my interview transcripts?”
• “Compare the methodology sections in my documents”

For Business & Project Managers:

• “What are the open action items from our meeting notes?”
• “Summarize the quarterly reports from last year”
• “Find all client feedback mentions in our emails”
• “What are the main risks mentioned in our project documentation?”
• “List all deliverables mentioned in our proposals”

---

Moving Existing Chats to Projects

You can organize existing chat sessions by moving them into projects. Once moved, RAG is automatically enabled.

1. Select Chat Session

   • Find the chat you want to move in the sidebar

2. Move to Project

   • Right-click the chat in the sidebar
   • Select “Move to Project”
   • Choose the target project

3. RAG Automatically Enabled

   • Once moved, RAG is automatically enabled for this chat
   • The AI now has access to the project’s knowledge base
   • The chat will use the project’s indexed files for context

提示

Moving chats to projects helps organize conversations by topic and automatically enables project context. This is useful for retroactively adding context to existing conversations.

---

Managing RAG Index

Re-indexing the Project

When you make significant changes to your project:

1. Open the project settings
2. Click “Re-index Project”
3. Wait for indexing to complete

When to Re-index:

• After major code refactoring
• When adding/removing large numbers of files
• If search results seem outdated

Incremental Updates

Askimo automatically detects file changes and updates the index:

• File Modified: Re-indexes the changed file
• File Added: Indexes the new file
• File Deleted: Removes from index

注意

Auto-indexing runs in the background without interrupting your work.

Index Storage

RAG indexes are stored locally:

• Location: ~/.askimo/projects/<project-id>/index/
• Size: Typically 10-30% of your source files
• Format: Lucene index format

---

Embedding Model Configuration

RAG (Retrieval-Augmented Generation) relies on embedding models to convert your documents and queries into vector representations. These embeddings enable semantic search, allowing the AI to find relevant content based on meaning rather than just keyword matching.

Why Embedding Models Matter

When you create a project with RAG:

1. Document Ingestion: Your files are split into chunks and converted into numerical vectors (embeddings) using an embedding model
2. Semantic Search: When you ask a question, your query is also converted into an embedding
3. Similarity Matching: The system finds the most semantically similar document chunks by comparing vector embeddings
4. Context Injection: Relevant chunks are injected into the AI’s context window to generate accurate, grounded responses

The quality and compatibility of the embedding model directly impact RAG’s ability to retrieve relevant information from your project files.

Default Embedding Models by Provider

Askimo uses different default embedding models depending on your AI provider. These are just defaults—you can customize them in Settings if you prefer different models.

Provider	Default Embedding Model
OpenAI	text-embedding-3-small
Google Gemini	text-embedding-004
Ollama	nomic-embed-text:latest
LM Studio	nomic-embed-text:latest
LocalAI	nomic-embed-text:latest
Docker AI	ai/qwen3-embedding:0.6B-F16

提示

Want to use a different embedding model? You can customize the embedding model for any provider in Settings > Advanced > Embedding Model By Provider. See the “Customizing Embedding Models” section below for details.

警告

Anthropic (Claude) and X.AI (Grok) do not currently provide embedding model APIs. If you’re using these providers for chat, RAG functionality requires configuring an alternative embedding provider (such as OpenAI or a local provider like Ollama).

Setting Up Local Embedding Models

For local AI providers (Ollama, LM Studio, LocalAI, Docker AI), you must manually pull the embedding model before using RAG:

For Ollama:

ollama pull nomic-embed-text:latest

For LM Studio:

1. Open LM Studio
2. Search for “nomic-embed-text”
3. Download the model

For LocalAI:

# Pull the model using LocalAI's CLI or API
curl http://localhost:8080/models/apply -H "Content-Type: application/json" -d '{
  "id": "nomic-embed-text:latest"
}'

For Docker AI:

# Pull the Qwen embedding model
docker exec -it <container-name> pull ai/qwen3-embedding:0.6B-F16

提示

Recommended Local Model: nomic-embed-text is a high-quality, efficient embedding model designed for retrieval tasks. It’s only ~140MB and performs well for code and documentation.

Customizing Embedding Models

You can change the default embedding model for any provider:

1. Open Settings

   • Go to Settings (⌘/Ctrl + ,)

2. Navigate to RAG Configuration

   • Select Advanced tab
   • Find RAG Configuration
   • Find Embedding Models by Provider

3. Configure Provider Models

   • Enter the model name for each provider
   • For cloud providers (OpenAI, Gemini): Use the official model identifier
   • For local providers: Ensure the model is already pulled/downloaded

Example Custom Configuration:

Provider	Custom Model
OpenAI	text-embedding-3-large (higher quality, larger)
Gemini	text-embedding-004 (default)
Ollama	mxbai-embed-large:latest (alternative local model)

警告

Important: For local AI providers, make sure the embedding model is already downloaded/pulled before configuring it. Askimo cannot automatically download models—you must do this manually using your provider’s CLI or UI.

Verifying Your Embedding Model

Askimo automatically validates your embedding model when you:

• Create a new RAG project, or
• Re-index an existing project (right-click project > “Re-index Project”)

During the indexing process, Askimo will check if the configured embedding model is available and valid. If the embedding model is invalid or unavailable, you’ll receive a clear error notification indicating the issue.

Common validation errors:

• Local providers (Ollama, LM Studio, LocalAI, Docker AI): Model not downloaded/pulled
• Cloud providers (OpenAI, Gemini): Invalid API key or model name
• Anthropic/X.AI users: No embedding model configured (these providers don’t offer embedding APIs)

If you encounter an embedding model error:

1. Review the error message to identify the specific issue
2. For local providers: Make sure you’ve manually pulled the embedding model (see “Setting Up Local Embedding Models” above)
3. For cloud providers: Verify your API key is valid and the model name is correct
4. Re-attempt indexing: After fixing the issue, try creating a new project or re-indexing your existing project
5. Still having issues? Post a detailed issue report on the Askimo GitHub Issues page including:
   • Your AI provider
   • The embedding model name you’re using
   • The exact error message
   • Your operating system

提示

Quick verification: For local providers like Ollama, run ollama list in your terminal to verify the embedding model is downloaded. For cloud providers, test your API key using their official documentation or API playground.

---

Supported File Types

Askimo can index a wide variety of file types:

Source Code Files:

• .java, .kt, .js, .ts, .jsx, .tsx
• .py, .rb, .go, .rs, .c, .cpp, .h, .hpp
• .cs, .php, .swift, .scala, .clj
• .sql, .sh, .bash, .ps1

Documentation Files:

• .md, .mdx, .txt, .rst, .adoc, .org
• PDF files (text content extracted)

Office Documents:

• Microsoft Office: .docx, .xlsx, .pptx, .doc, .xls, .ppt
• OpenOffice: .odt, .ods, .odp

Email Files:

• .eml, .msg

Configuration & Data Files:

• .json, .yaml, .yml, .toml, .ini
• .xml, .csv, .properties

Build & Project Files:

• pom.xml, build.gradle, package.json, requirements.txt
• Cargo.toml, go.mod, composer.json

注意

File Size Limit: Files larger than 5 MB are automatically excluded from indexing to maintain performance.

Automatically Detected Project Types:

• Java: Maven (pom.xml), Gradle (build.gradle, settings.gradle)
• JavaScript/TypeScript: Node.js (package.json), npm, yarn, pnpm
• Python: pip (requirements.txt), Poetry (pyproject.toml), virtualenv
• Go: Go modules (go.mod, go.sum)
• Rust: Cargo (Cargo.toml)
• PHP: Composer (composer.json)
• Ruby: Bundler (Gemfile)
• .NET: NuGet, MSBuild projects

---

Privacy & Security

Local-Only Processing

All RAG operations happen locally on your machine:

• No Data Upload: Your code never leaves your computer
• No Cloud Dependencies: Works completely offline
• Secure Storage: Indexes stored in your local Askimo directory

警告

Askimo automatically excludes common sensitive files (.env, .key, credentials.json) from indexing. However, always review what’s being indexed and avoid committing sensitive data to your project files.