Documentation

AirgapAI Knowledge Base

Setup guides, how-tos, and reference for your secure, fully offline AI assistant.

Guide Connect AirgapAI to an On-Prem Server Step-by-step, screenshot-driven setup — VPN, connection wizard, and first use. Open →

Onboarding & Initial Setup (4 articles)

Chat Interactions (12 articles)

Upload Document to Chat Context

Upload documents (PDF, DOCX, TXT, CSV) to chat input to include their content in your message. System extracts text from files and combines with your typed message, allowing AI to reference document content. Up to 10 documents can be added to a single message.

Pin/Unpin Chat to Favorites

This flow allows users to "pin" important or frequently-used chat conversations to keep them easily accessible at the top of their chat list. Pinned chats appear in a dedicated "Pinned" section, separate from date-organized chats, making them quick to find regardless of when they were last used.

Chat with Dataset Query Enabled

This flow enables users to have conversations with the AI where responses are informed by a specific dataset (corpus) of documents. When dataset query is enabled, the system automatically searches your uploaded documents for relevant information and includes that context in the AI's response, resulting in more accurate, grounded answers based on your specific knowledge base.

Create New Empty Chat

This flow allows users to start a fresh conversation with the AI without any predefined templates or settings. It creates a blank slate for free-form conversation where users can ask any questions or have any type of discussion with the AI model.

Create New Chat from Template

This flow allows users to create a new chat conversation using a predefined template that includes pre-configured settings, personas, prompts, and behaviors. Templates streamline common workflows like creating social media content, generating proposals, or conducting multi-perspective analysis.

Entourage Mode Manage Chat Personas

This flow enables users to configure multiple AI "personas" within a single chat conversation. Each persona can have different behaviors, contexts, and purposes - for example, one persona that searches datasets, another that provides creative responses, or multiple personas simulating a team discussion. This allows for sophisticated multi-agent conversations and specialized AI behaviors.

Export Chat as PDF

This flow allows users to export their chat conversation as a formatted PDF document, suitable for printing, sharing, or professional documentation. The PDF preserves conversation structure with visual formatting for improved readability.

Export Chat as Text File

This flow allows users to export their chat conversation as a plain text file that can be saved, shared, or archived. The exported file contains all messages in the conversation in a readable format, preserving the structure and content for external use.

Conduct Multi-Turn Conversation

This flow describes how users continue an ongoing conversation with the AI, sending multiple messages back and forth. The AI maintains context from previous messages in the conversation, allowing for natural, contextual discussions where questions can reference earlier parts of the conversation.

Delete a Chat Conversation

This flow allows users to permanently remove a chat conversation from the application. This is useful for cleaning up unwanted conversations, removing test chats, or managing privacy by deleting sensitive conversations.

Generate Chat Name with AI

This flow enables users to automatically generate a descriptive chat name using AI by analyzing the conversation content. The AI reads recent messages and creates a concise, relevant title that captures the conversation's essence.

Edit Chat Name Manually

This flow allows users to change the name of a chat conversation to something more descriptive and memorable. Custom names make it easier to find specific conversations later, especially when managing many chats.

Blockify Processing (9 articles)

Select Embedding Model for Job

Choose which embedding model will be used to generate vector representations of processed chunks. Required for creating searchable dataset. Model selection depends on whether creating new dataset or adding to existing one.

Test Blockify Model

Test blockify model with sample text before running full job. Allows verifying model works correctly, understanding output format, and checking processing speed with small test.

Upload Files for Processing

This flow describes how users upload document files to a blockify or chunking job for AI processing. The system extracts text from various file formats (PDF, DOCX, TXT, CSV, ZIP) and prepares them for chunking and structuring. Multiple files can be uploaded, and ZIP archives are automatically extracted.

Schedule Job for Future Execution

Configure job to start processing automatically at specified future date and time instead of immediately. Useful for scheduling resource-intensive processing during off-hours or specific times.

Select Target Dataset for Job

Choose whether to create new dataset or add to existing dataset when creating blockify/chunking job. Determines where processed results will be stored.

Create New Blockify Job

This flow enables users to process documents using AI to break them down into structured "IdeaBlocks" - meaningful chunks of information with names, critical questions, and trusted answers. This structured format makes documents more searchable and useful for AI-powered conversations. The process creates a searchable dataset from your documents.

Create Basic Chunking Job

Create job that splits documents into basic chunks without AI structuring. Faster and simpler than blockify mode, suitable when documents don't need AI-enhanced structure or when speed is priority over sophisticated organization.

Configure Advanced Chunk Settings with Preview

Access detailed chunk preview showing exactly how each uploaded file will be split based on current settings. Allows fine-tuning chunk size and overlap while seeing real-time preview of results for each file.

Configure Basic Chunk Settings

Adjust chunk size and overlap settings during job creation to control how documents are split into pieces. Settings affect search precision, processing speed, and result quality.

Settings & Configuration (7 articles)

Upload Model from Settings Page

Upload AI models (language or embedding models) directly from Settings page through dedicated model management interface. This is the standard location for adding new models outside of onboarding.

Navigate Between Settings Tabs

Move between different settings categories using tabbed interface to access various configuration areas including models, chat options, benchmarking, and admin overrides.

Set Admin Performance Overrides

Configure advanced system-wide performance settings including CPU worker count for parallel processing and default chat template. These settings affect all users and all operations.

Upload Dataset from Settings Page

Upload pre-processed dataset files directly from Settings page. Alternative access point to dataset upload for users managing datasets through settings interface rather than from job completion context.

Configure Chat Behavior Settings

Adjust global chat behavior settings that affect how the AI responds, including temperature (creativity), frequency penalty (repetition reduction), lookback size (conversation memory), and dataset query parameters.

Configure Context Window in Settings

Adjust context window size through Settings > Chat Options interface. This is the primary location for context window configuration, accessed through the Settings page tabbed interface rather than other possible access points.

Set Default Chat Template

Set a default template that automatically applies when creating new chats by typing without selecting a specific template. Streamlines workflow for users who consistently use same chat configuration.

Dataset/Corpus Management (7 articles)

Navigate Through Dataset Pages

Navigate through multiple pages of dataset items using pagination controls when dataset contains more items than can be displayed on one page.

View Dataset Details and Contents

This flow enables users to view comprehensive details about a dataset, including all the structured items (IdeaBlocks) it contains, statistics, and metadata. Users can browse through potentially thousands of items, search for specific content, and verify the quality of their dataset before using it in conversations.

View Dataset List

View all uploaded datasets in list format with key information like name, status, size, and quick actions. Provides overview of available knowledge bases.

Upload New Dataset

This flow allows users to upload a pre-processed dataset file (in JSONL format) to the application. These datasets contain structured information that can be queried during AI conversations, enabling the AI to provide answers based on your specific documents and data rather than just its general knowledge.

Download Dataset File

This flow allows users to download their dataset as a JSONL file to their computer. This is useful for backing up datasets, sharing them with others, transferring between systems, or archiving for future use. The exported file contains all structured items with their text and vector embeddings.

Filter and Search Dataset Items

Search and filter dataset items to find specific information quickly. Search works across all text fields (block names, questions, answers) with real-time results.

Activate/Deactivate Dataset

This flow enables users to activate or deactivate a dataset for use in AI conversations. Only one dataset can be active at a time. The active dataset is the one that will be queried when the dataset query feature is enabled in chat conversations, providing context-specific information from your documents.

Job Management (9 articles)

View Active Jobs Status Badge

This flow describes how users monitor background job processing through a persistent status badge that appears in the bottom-right corner of the screen when jobs are running. The badge provides at-a-glance status of processing jobs without requiring users to navigate away from their current task.

View All Jobs in Table

View comprehensive list of all processing jobs (past and present) in table format with sorting, filtering, and status information. Provides overview of all document processing activity.

View Job Performance Charts

Explore different visualization charts showing job processing performance including progress, speed, latency, and throughput. Charts help understand patterns, identify issues, and assess efficiency.

View Job Details Dashboard

This flow enables users to access a comprehensive dashboard showing detailed information about a specific processing job, including real-time progress, performance analytics, file-by-file breakdowns, charts, and structured results. This dashboard serves as the central monitoring and analysis interface for document processing jobs.

Monitor Job Progress in Real-Time

Observe real-time updates of job processing progress including completion percentage, current stage, processing rate, and estimated time remaining. Enables passive or active monitoring without manual refreshes.

Retry a Failed Job

This flow allows users to restart a job that previously failed or was cancelled. The retry attempts to process the job again from the beginning, giving users a chance to succeed after resolving the issue that caused the original failure.

View Individual File Analytics

Drill down into specific file within job to see detailed analytics, charts, and processing statistics unique to that file. Useful for comparing file processing performance or troubleshooting specific file issues.

Cancel a Running Job

This flow allows users to stop a currently processing job, terminating all active tasks and preventing further processing. This is useful when users need to reconfigure settings, realize they uploaded wrong files, or need to free up system resources.

Filter Jobs by Status

Filter jobs table to show only jobs with specific status (pending, processing, completed, failed, or cancelled). Helps users quickly find jobs in particular states without scanning entire list.

Model Management (7 articles)

View Model Information

View detailed information about an uploaded model including its name, type, file path, capabilities, and configuration. Helps users understand model specifications and verify correct model is being used.

Select Active Embedding Model

Choose which embedding model will be used for converting text into vectors for semantic search. This model is used when creating datasets, querying datasets during chat, and processing documents.

Select Active Chat Model

This flow allows users to choose which AI language model will be used for chat conversations. Different models have different capabilities, speeds, and specialties. Selecting the appropriate model ensures optimal performance for your specific needs.

Delete a Model

Permanently remove an AI model from the application to free up disk space or clean up unused models.

Upload Embedding Model

Upload an embedding model that converts text into numerical vectors for semantic search. Required for dataset query functionality and creating searchable datasets from documents.

Upload Large Language Model

This flow allows users to add a new AI language model to the application. Models are required to enable chat functionality. The model file is uploaded from your computer to the application and becomes available for use in conversations.

Configure Context Window Size

Adjust how much conversation history the AI model can process at once. Larger context windows allow AI to remember more messages but take longer to process. Finding optimal balance between memory and speed is key to good performance.

Performance Benchmarking (5 articles)

Use Cases (1 articles)