Admin Panel Specifications
Overview
The VoiceAssist Admin Panel provides a centralized web interface for system configuration, monitoring, and management. Accessible at admin.asimo.io.
Technology Stack
Frontend
- Framework: React 18+ with TypeScript
- Build Tool: Vite
- Styling: Tailwind CSS
- Component Library: shadcn/ui or Tremor (for dashboards)
- Charts: Recharts or Chart.js
- Tables: TanStack Table (React Table v8)
- State Management: Zustand or React Context
Backend
- Framework: FastAPI (Python)
- Authentication: JWT with admin role
- Database: PostgreSQL for admin data
- Real-time: WebSocket for live metrics
Standard API Envelope
All admin API calls return a standard envelope. See server/README.md for complete specification.
Use the same TypeScript types and fetch helper from WEB_APP_SPECS.md (can be shared package or duplicated).
Usage Example - KB Management
// admin/hooks/useKBManagement.ts import { useMutation, useQuery } from "@tanstack/react-query"; import { fetchAPI, APIError } from "@/lib/api"; import { KnowledgeDocument, IndexingJob } from "@/types"; // From DATA_MODEL.md import { toast } from "@/lib/toast"; export function useKBDocuments() { return useQuery({ queryKey: ["kb-documents"], queryFn: async () => { return fetchAPI<KnowledgeDocument[]>("/api/admin/kb/documents"); }, }); } export function useUploadDocument() { return useMutation({ mutationFn: async (file: File) => { const formData = new FormData(); formData.append("file", file); return fetchAPI<IndexingJob>("/api/admin/kb/upload", { method: "POST", body: formData, headers: { // Don't set Content-Type, let browser set it with boundary }, }); }, onSuccess: (job) => { toast.success(`Upload started: ${job.id}`); }, onError: (error: APIError) => { if (error.code === "VALIDATION_ERROR") { toast.error("Invalid file format. Only PDF and DOCX supported."); } else if (error.code === "CONFLICT") { toast.error("A document with this name already exists"); } else { toast.error(`Upload failed: ${error.message}`); } }, }); } export function useReindexDocuments() { return useMutation({ mutationFn: async (docIds: string[]) => { return fetchAPI<{ job_count: number }>("/api/admin/kb/reindex", { method: "POST", body: JSON.stringify({ document_ids: docIds }), }); }, }); }
API Integration Examples
Note: For canonical entity definitions (JSON Schema, Pydantic, TypeScript), see DATA_MODEL.md. This section provides usage examples specific to the admin panel.
Knowledge Base Management (TypeScript):
// services/api/admin.ts import axios from "axios"; const api = axios.create({ baseURL: import.meta.env.VITE_API_URL, withCredentials: true, // Send JWT cookies headers: { "Content-Type": "application/json", }, }); export interface DocumentUploadResponse { documentId: string; filename: string; status: string; message: string; } export interface DocumentListResponse { id: string; filename: string; sourceType: string; specialty: string; status: string; fileSize: number; chunkCount?: number; uploadedAt: string; indexedAt?: string; } export interface ReindexRequest { documentIds: string[]; force: boolean; } export interface ReindexResponse { jobId: string; documentCount: number; status: string; message: string; } // Upload document export async function uploadDocument( file: File, sourceType: string, specialty: string, ): Promise<DocumentUploadResponse> { const formData = new FormData(); formData.append("file", file); formData.append("sourceType", sourceType); formData.append("specialty", specialty); const response = await api.post("/api/admin/knowledge/upload", formData, { headers: { "Content-Type": "multipart/form-data", }, }); return response.data; } // List documents export async function listDocuments( skip: number = 0, limit: number = 50, status?: string, ): Promise<DocumentListResponse[]> { const response = await api.get("/api/admin/knowledge/documents", { params: { skip, limit, status }, }); return response.data; } // Trigger reindex export async function triggerReindex(documentIds: string[] = [], force: boolean = false): Promise<ReindexResponse> { const response = await api.post("/api/admin/knowledge/reindex", { documentIds, force, }); return response.data; } // Get vector DB stats export async function getVectorDBStats(): Promise<VectorDBStatsResponse> { const response = await api.get("/api/admin/knowledge/stats"); return response.data; }
React Hook for Document Management:
// hooks/useDocuments.ts import { useQuery, useMutation, useQueryClient } from '@tanstack/react-query'; import * as adminApi from '@/services/api/admin'; export function useDocuments(skip = 0, limit = 50, status?: string) { return useQuery({ queryKey: ['documents', skip, limit, status], queryFn: () => adminApi.listDocuments(skip, limit, status), }); } export function useUploadDocument() { const queryClient = useQueryClient(); return useMutation({ mutationFn: ({ file, sourceType, specialty, }: { file: File; sourceType: string; specialty: string; }) => adminApi.uploadDocument(file, sourceType, specialty), onSuccess: () => { // Invalidate documents list to refetch queryClient.invalidateQueries({ queryKey: ['documents'] }); }, }); } export function useReindexDocuments() { const queryClient = useQueryClient(); return useMutation({ mutationFn: ({ documentIds, force, }: { documentIds: string[]; force: boolean; }) => adminApi.triggerReindex(documentIds, force), onSuccess: () => { queryClient.invalidateQueries({ queryKey: ['documents'] }); }, }); } // Usage in component function KnowledgeBaseManager() { const { data: documents, isLoading } = useDocuments(0, 50); const uploadMutation = useUploadDocument(); const reindexMutation = useReindexDocuments(); const handleUpload = (file: File) => { uploadMutation.mutate({ file, sourceType: 'textbook', specialty: 'cardiology', }); }; const handleReindexAll = () => { reindexMutation.mutate({ documentIds: [], // Empty = reindex all force: false, }); }; return ( <div> <button onClick={handleReindexAll} disabled={reindexMutation.isPending}> Reindex All Documents </button> {/* Document list and upload UI */} </div> ); }
Real-time Metrics with WebSocket:
// hooks/useRealtimeMetrics.ts import { useEffect, useState } from 'react'; export interface SystemMetrics { cpuUsage: number; memoryUsage: number; diskUsage: number; activeSessions: number; apiCallsToday: number; errorRate: number; } export function useRealtimeMetrics() { const [metrics, setMetrics] = useState<SystemMetrics | null>(null); const [isConnected, setIsConnected] = useState(false); useEffect(() => { const ws = new WebSocket(`${import.meta.env.VITE_WS_URL}/admin/metrics`); ws.onopen = () => { setIsConnected(true); }; ws.onmessage = (event) => { const data = JSON.parse(event.data); setMetrics(data); }; ws.onerror = (error) => { console.error('WebSocket error:', error); }; ws.onclose = () => { setIsConnected(false); }; return () => { ws.close(); }; }, []); return { metrics, isConnected }; } // Usage in dashboard component function Dashboard() { const { metrics, isConnected } = useRealtimeMetrics(); if (!isConnected) { return <div>Connecting to metrics stream...</div>; } if (!metrics) { return <div>Loading metrics...</div>; } return ( <div className="grid grid-cols-4 gap-4"> <MetricCard title="Active Sessions" value={metrics.activeSessions} /> <MetricCard title="API Calls Today" value={metrics.apiCallsToday} /> <MetricCard title="CPU Usage" value={`${metrics.cpuUsage}%`} /> <MetricCard title="Error Rate" value={`${metrics.errorRate}%`} /> </div> ); }
Authentication & Authorization
Access Control
- Admin Role: Full access to all features
- Viewer Role: Read-only access (future)
- API Keys: Secure management with limited scopes
Security
- Strong password requirements
- Two-factor authentication (TOTP)
- Session timeout
- Login attempt limiting
- Audit log of all admin actions
Interface Layout
βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β Header β
β [Logo] Admin Panel Dr. Nazmy [Logout] βοΈ β
ββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ€
β β β
β Sidebar β Main Content Area β
β Menu β β
β β [Dashboard/Settings/etc content] β
β π Dashboardβ β
β βοΈ System β β
β π€ AI Modelsβ β
β π Knowledgeβ β
β π€ Users β β
β π Analyticsβ β
β π Integrations β
β π Security β β
β π Logs β β
β β β
ββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ
Core Pages
1. Dashboard (/dashboard)
Full Dashboard Wireframe:
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β VoiceAssist Admin π Alerts (2) Dr. Nazmy βΌ [Logout] β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ€
β β
β Dashboard Last updated: 10s ago β
β β
β ββββββββββββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββ¬βββββββββββββββββββ β
β β Active Sessions β API Calls Today β Avg Response β Error Rate β β
β β β β β β β
β β 3 β 1,247 β 1.8s β 0.3% β β
β β β +1 today β β +12% vs avg β β -0.2s β β -0.1% β β
β ββββββββββββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββ΄βββββββββββββββββββ β
β β
β βββββββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββ β
β β System Resources β Service Status β β
β β β β β
β β CPU Usage 68% ββββ β βββββββββββββββββββββββββ¬βββββββββββ β β
β β Memory Usage 45% βββ β β FastAPI Backend β π’ Up β β β
β β GPU Usage (Ollama) 82% ββββββ β PostgreSQL β π’ Up β β β
β β Disk Space 28% ββ β β Redis Cache β π’ Up β β β
β β Network I/O β12MB/s β β Vector DB (Qdrant) β π’ Up β β β
β β WS Connections 3 active β β Ollama (Local LLM) β π’ Up β β β
β β β β OpenAI API β π’ Up β β β
β β [View Details] β β Nextcloud β π‘ Slow β β β
β β β βββββββββββββββββββββββββ΄βββββββββββ β β
β β β β β
β βββββββββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββββββββ β
β β
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β Response Time (Last 24 Hours) β β
β β β β
β β 5s β€ β β
β β 4s β€ β β
β β 3s β€ β β β
β β 2s β€ ββββββββββββββββββββββββββββ Cloud API β β
β β 1s β€ββββββββββββββββββββββββββββββ Local Model β β
β β 0s βββ¬βββ¬βββ¬βββ¬βββ¬βββ¬βββ¬βββ¬βββ¬βββ¬βββ¬βββ¬ββββββββββ β β
β β 00 02 04 06 08 10 12 14 16 18 20 22 Now β β
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β
β ββββββββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ β
β β Recent Activity β Quick Actions β β
β β β β β
β β [10:32] Query: HTN management β [β³ Restart Services] β β
β β [10:28] Document indexed: DAPA β [ποΈ Clear Cache] β β
β β [10:15] Query: Drug interaction β [π Update Knowledge Base] β β
β β [09:58] Error: Nextcloud timeoutβ [π View System Logs] β β
β β [09:45] Query: Lab interpretationβ [β Run Health Check] β β
β β β β β
β β [View All Activity] β β β
β ββββββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ β
β β
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β Alerts & Notifications β β
β β β β
β β β οΈ [10:33] Nextcloud response time degraded (1.2s β 3.5s) β β
β β βΉοΈ [08:00] Backup completed successfully (Database: 2.3GB) β β
β β β β
β β [View All Alerts] β β
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
Dashboard Components Summary
System metrics defined in OBSERVABILITY.md.
System Overview Cards:
- Active Sessions: Current WebSocket/REST sessions
- API Calls Today: Total API requests with trend indicator
- Avg Response Time: Mean latency with change indicator
- Error Rate: Percentage of failed requests with trend
Real-Time Metrics:
- CPU, Memory, GPU usage with bar indicators
- Disk space utilization
- Network I/O (upload/download)
- Active WebSocket connections count
Service Status Table:
- Health check status for each service (π’ Up, π‘ Degraded, π΄ Down)
- Last check timestamp
- Click to view detailed metrics
Response Time Chart:
- Line chart showing 24-hour latency trends
- Separate lines for local model vs cloud API
- Hoverable data points
Recent Activity Feed:
- Last 10-20 system events
- Query summaries (sanitized)
- Document indexing events
- Error notifications
Quick Actions:
- One-click service management
- Cache clearing
- Knowledge base updates
- Log viewing
- Health check execution
2. System Settings (/system)
System settings are global - they affect all users and the entire VoiceAssist instance.
System Settings Interface
Complete TypeScript interface for system-level configuration:
// admin-panel/src/types/systemSettings.ts export interface SystemSettings { // General System Configuration general: { systemName: string; // Display name (e.g., "VoiceAssist Production") systemDescription: string; // Description for documentation timezone: string; // Default system timezone (IANA) language: "en" | "es" | "fr"; // Default interface language maintenanceMode: boolean; // Enable maintenance mode (blocks users) maintenanceMessage: string; // Message shown during maintenance }; // Data Retention & Cleanup dataRetention: { conversationLogs: number; // Days to keep conversation logs (7-365) errorLogs: number; // Days to keep error logs (30-365) accessLogs: number; // Days to keep access logs (30-730) auditLogs: number; // Days to keep audit logs (365-2555) tempFiles: number; // Days to keep temp files (1-30) autoCleanup: boolean; // Enable automatic cleanup cleanupSchedule: string; // Cron expression for cleanup }; // Backup Configuration backup: { enabled: boolean; destination: "local" | "nextcloud" | "s3" | "custom"; schedule: string; // Cron expression retention: number; // Number of backups to keep includeDatabase: boolean; includeVectorDB: boolean; includeDocuments: boolean; includeConfiguration: boolean; includeLogs: boolean; compression: "none" | "gzip" | "zstd"; encryption: boolean; }; // Model Routing & AI Configuration ai: { // Default model preferences defaultLocalModel: string; // e.g., "llama-3.1-8b" defaultCloudModel: string; // e.g., "gpt-4-turbo" defaultEmbeddingModel: string; // e.g., "text-embedding-3-large" // Routing rules routingStrategy: "auto" | "always_local" | "always_cloud"; phiDetectionEnabled: boolean; // Auto-detect PHI and route to local phiKeywords: string[]; // Keywords that trigger PHI detection // Performance limits maxConcurrentRequests: number; // Max concurrent AI requests requestTimeout: number; // Timeout in seconds retryAttempts: number; // Number of retry attempts // Rate limiting (per user) rateLimits: { queriesPerMinute: number; queriesPerHour: number; queriesPerDay: number; }; // Cost controls costLimits: { dailyLimit: number; // $ per day monthlyLimit: number; // $ per month alertThreshold: number; // % threshold for alerts (e.g., 80) }; }; // Logging & Monitoring logging: { level: "DEBUG" | "INFO" | "WARN" | "ERROR"; structuredLogging: boolean; // JSON format logToFile: boolean; logToConsole: boolean; logToSyslog: boolean; sensitiveDataRedaction: boolean; // Redact PHI/PII from logs performanceLogging: boolean; // Log slow queries performanceThreshold: number; // ms threshold for slow query logging }; // Security & Privacy security: { // Session management sessionTimeout: number; // Minutes of inactivity maxSessionDuration: number; // Max session duration in hours requireStrongPasswords: boolean; passwordMinLength: number; passwordRequireSpecialChars: boolean; passwordExpiryDays: number; // 0 = never // Two-factor authentication twoFactorRequired: boolean; twoFactorMethod: "totp" | "sms" | "email"; // API security apiRateLimiting: boolean; apiRateLimit: number; // Requests per minute corsOrigins: string[]; // Allowed CORS origins // Audit logging auditAllActions: boolean; auditLoginAttempts: boolean; auditDataAccess: boolean; auditConfigChanges: boolean; }; // Email Notifications (for alerts) email: { enabled: boolean; smtpHost: string; smtpPort: number; smtpUsername: string; smtpPassword: string; // Encrypted in storage smtpTLS: boolean; fromAddress: string; adminEmails: string[]; // Admins to notify }; // Feature Flags features: { voiceEnabled: boolean; fileUploadEnabled: boolean; knowledgeBaseEnabled: boolean; nextcloudIntegration: boolean; calendarIntegration: boolean; emailIntegration: boolean; webSearchEnabled: boolean; betaFeatures: boolean; }; // Resource Limits resources: { maxUploadSize: number; // MB maxDocuments: number; // Max documents in KB (0 = unlimited) maxVectorDBSize: number; // GB (0 = unlimited) maxConcurrentUsers: number; // (0 = unlimited) }; } // Default system settings export const DEFAULT_SYSTEM_SETTINGS: SystemSettings = { general: { systemName: "VoiceAssist", systemDescription: "Medical AI Assistant", timezone: "UTC", language: "en", maintenanceMode: false, maintenanceMessage: "System is currently under maintenance. Please check back soon.", }, dataRetention: { conversationLogs: 30, errorLogs: 90, accessLogs: 90, auditLogs: 365, tempFiles: 7, autoCleanup: true, cleanupSchedule: "0 2 * * *", // Daily at 2 AM }, backup: { enabled: true, destination: "local", schedule: "0 2 * * *", // Daily at 2 AM retention: 7, includeDatabase: true, includeVectorDB: true, includeDocuments: true, includeConfiguration: true, includeLogs: false, compression: "gzip", encryption: true, }, ai: { defaultLocalModel: "llama-3.1-8b", defaultCloudModel: "gpt-4-turbo", defaultEmbeddingModel: "text-embedding-3-large", routingStrategy: "auto", phiDetectionEnabled: true, phiKeywords: ["patient", "MRN", "DOB", "SSN", "medical record"], maxConcurrentRequests: 10, requestTimeout: 60, retryAttempts: 3, rateLimits: { queriesPerMinute: 20, queriesPerHour: 100, queriesPerDay: 1000, }, costLimits: { dailyLimit: 50, monthlyLimit: 1000, alertThreshold: 80, }, }, logging: { level: "INFO", structuredLogging: true, logToFile: true, logToConsole: true, logToSyslog: false, sensitiveDataRedaction: true, performanceLogging: true, performanceThreshold: 1000, }, security: { sessionTimeout: 30, maxSessionDuration: 8, requireStrongPasswords: true, passwordMinLength: 12, passwordRequireSpecialChars: true, passwordExpiryDays: 90, twoFactorRequired: false, twoFactorMethod: "totp", apiRateLimiting: true, apiRateLimit: 60, corsOrigins: [], auditAllActions: true, auditLoginAttempts: true, auditDataAccess: true, auditConfigChanges: true, }, email: { enabled: false, smtpHost: "", smtpPort: 587, smtpUsername: "", smtpPassword: "", smtpTLS: true, fromAddress: "", adminEmails: [], }, features: { voiceEnabled: true, fileUploadEnabled: true, knowledgeBaseEnabled: true, nextcloudIntegration: true, calendarIntegration: true, emailIntegration: false, webSearchEnabled: true, betaFeatures: false, }, resources: { maxUploadSize: 500, maxDocuments: 0, maxVectorDBSize: 0, maxConcurrentUsers: 0, }, };
Settings Comparison: User vs System
| Setting Category | User Settings (Per-User) | System Settings (Global) |
|---|---|---|
| Theme | β User chooses dark/light | β Not configurable globally |
| Language | β User's preferred language | β Default system language |
| Voice Input | β User enables/disables | β System enables feature |
| Citations | β User's display preference | β Not applicable |
| Logging | β Not user-configurable | β System log level |
| Backups | β Not user-configurable | β System backup schedule |
| AI Models | β User preference (fast/quality) | β System default models |
| Rate Limits | β Applied system-wide | β System rate limit rules |
| Data Retention | β User's conversation retention | β System-wide retention policy |
System Settings Backend API
# app/api/endpoints/admin/system_settings.py from fastapi import APIRouter, Depends, HTTPException from sqlalchemy.orm import Session from app.api.deps import get_db, get_admin_user from app.models.user import User from app.models.system_settings import SystemSettings as SystemSettingsModel from app.api.schemas.system_settings import SystemSettingsSchema from app.core.config import settings router = APIRouter() @router.get("/system/settings", response_model=SystemSettingsSchema) async def get_system_settings( db: Session = Depends(get_db), current_user: User = Depends(get_admin_user) ): """ Get system settings. Admin only. """ system_settings = db.query(SystemSettingsModel).first() if not system_settings: # Return defaults return SystemSettingsSchema.get_defaults() return system_settings.settings @router.patch("/system/settings", response_model=SystemSettingsSchema) async def update_system_settings( settings_update: SystemSettingsSchema, db: Session = Depends(get_db), current_user: User = Depends(get_admin_user) ): """ Update system settings. Admin only. Validates settings and logs changes to audit log. """ system_settings = db.query(SystemSettingsModel).first() if not system_settings: # Create initial settings system_settings = SystemSettingsModel(settings={}) db.add(system_settings) # Merge updates updated_settings = {**system_settings.settings, **settings_update.dict(exclude_unset=True)} # Validate critical settings if updated_settings['ai']['maxConcurrentRequests'] < 1: raise HTTPException(status_code=400, detail="maxConcurrentRequests must be >= 1") if updated_settings['dataRetention']['conversationLogs'] < 7: raise HTTPException(status_code=400, detail="Conversation log retention must be >= 7 days") # Log change to audit log from app.models.audit_log import AuditLog audit_entry = AuditLog( user_id=current_user.id, action='system_settings_update', resource='system_settings', changes=settings_update.dict(exclude_unset=True) ) db.add(audit_entry) system_settings.settings = updated_settings db.commit() db.refresh(system_settings) # Trigger settings reload in all services from app.core.events import emit_settings_change emit_settings_change() return system_settings.settings @router.post("/system/settings/validate") async def validate_system_settings( settings: SystemSettingsSchema, current_user: User = Depends(get_admin_user) ): """ Validate system settings without saving. Returns validation errors if any. """ errors = [] # Validate email settings if enabled if settings.email.enabled: if not settings.email.smtpHost: errors.append("SMTP host is required when email is enabled") if not settings.email.fromAddress: errors.append("From address is required when email is enabled") # Validate backup settings if settings.backup.enabled: if settings.backup.retention < 1: errors.append("Backup retention must be at least 1") # Validate AI settings if settings.ai.rateLimits.queriesPerMinute < 1: errors.append("Rate limit must be at least 1 query per minute") if errors: return {"valid": False, "errors": errors} return {"valid": True, "errors": []}
System Settings Storage
System settings are stored in:
- PostgreSQL
system_settingstable (single row) - Redis cache for fast access (with 5-minute TTL)
- File backup in
/etc/voiceassist/system.json(read on startup)
When settings change:
- Database is updated
- Redis cache is invalidated
- WebSocket broadcast to all services
- Services reload configuration
3. AI Models Configuration (/models)
Model Selection
Local Models (Ollama)
ββββββββββββββββββββββββββββββββββββββββββββ
β Local Model: [Dropdown] β
β β Llama 3.1 8B β
β β Llama 3.1 70B β
β β Mistral 7B β
β β Mixtral 8x7B β
β β
β [Download New Model] β
ββββββββββββββββββββββββββββββββββββββββββββ
Cloud API Configuration
ββββββββββββββββββββββββββββββββββββββββββββ
β OpenAI β
β API Key: [β’β’β’β’β’β’β’β’β’β’β’β’key] [Test] β
β Model: gpt-4-turbo β
β Max Tokens: 4096 β
β Temperature: 0.7 β
β β
β Anthropic Claude (Optional) β
β API Key: [Not configured] [Add] β
ββββββββββββββββββββββββββββββββββββββββββββ
Routing Logic
ββββββββββββββββββββββββββββββββββββββββββββ
β Request Routing β
β β
β βοΈ Auto-route based on privacy β
β β Always use local model β
β β Always use cloud API β
β β
β Classification Rules: β
β β’ File access β Local β
β β’ PHI detected β Local β
β β’ Medical literature β Cloud β
β β’ Complex reasoning β Cloud β
β β
β [Edit Rules] β
ββββββββββββββββββββββββββββββββββββββββββββ
Embedding Models
- OpenAI text-embedding-3-large (cloud)
- Local embedding model (if installed)
- Benchmark performance
Model Performance
- Average response time per model
- Token usage and costs
- Success/failure rates
- Switch recommendations based on usage
4. Knowledge Base Management (/knowledge)
Full Knowledge Base Page Wireframe:
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β Knowledge Base Management [Upload Document] β
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ€
β β
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β π Statistics β β
β β β β
β β ββββββββββββββββ¬βββββββββββββββ¬βββββββββββββββ¬βββββββββββββββ β β
β β β Documents β Total Chunks β Vector Size β Avg Query β β β
β β β β β β Latency β β β
β β β 247 β 128,452 β 8.4 GB β 0.12s β β β
β β ββββββββββββββββ΄βββββββββββββββ΄βββββββββββββββ΄βββββββββββββββ β β
β β β β
β β Most Queried Topics: Cardiology (487) Β· Diabetes (312) Β· ID (234) β β
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β π§ Indexing Jobs [View All Jobs] β β
β β β β
β β β³ In Progress: "SPRINT Trial" (PDF, 45 pages) - 67% complete β β
β β β
Completed: "Harrison's Ch. 234-240" - 3 minutes ago β β
β β β Failed: "corrupted_file.pdf" - Invalid format [Retry] β β
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β π Document Library β β
β β β β
β β [π Search documents...] β β
β β β β
β β Filters: Type: [All βΌ] Specialty: [All βΌ] Status: [Indexed βΌ] β β
β β Sort by: [Last Modified βΌ] Showing 1-10 of 247β β
β β β β
β β βββββ¬ββββββββββββββββββββββ¬ββββββββββββ¬βββββββββ¬βββββββββββ¬βββββββββββββ β β
β β β β β Name β Type β Pages β Chunks β Actions β β β
β β βββββΌββββββββββββββββββββββΌββββββββββββΌβββββββββΌβββββββββββΌβββββββββββββ€ β β
β β β β β Harrison's Princ... β Textbook β 3,402 β 18,234 β ποΈ βοΈ β¬οΈ ποΈβ β β
β β β β Internal Medicine β β β β β β β
β β β β 21st Edition β β β β β β β
β β β β π·οΈ Cardiology, GI β β
Indexedβ β 12 days β β β β
β β βββββΌββββββββββββββββββββββΌββββββββββββΌβββββββββΌβββββββββββΌβββββββββββββ€ β β
β β β β β DAPA-HF Trial β Journal β 15 β 145 β ποΈ βοΈ β¬οΈ ποΈβ β β
β β β β NEJM 2019 β β β β β β β
β β β β π·οΈ Cardiology β β
Indexedβ β 3 days β β β β
β β βββββΌββββββββββββββββββββββΌββββββββββββΌβββββββββΌβββββββββββΌβββββββββββββ€ β β
β β β β β 2023 AHA/ACC HTN β Guideline β 86 β 892 β ποΈ βοΈ β¬οΈ ποΈβ β β
β β β β Guidelines β β β β β β β
β β β β π·οΈ Cardiology, HTN β β
Indexedβ β 1 week β β β β
β β βββββΌββββββββββββββββββββββΌββββββββββββΌβββββββββΌβββββββββββΌβββββββββββββ€ β β
β β β β β UpToDate: DKA Mgmt β Reference β 8 β 67 β ποΈ βοΈ β¬οΈ ποΈβ β β
β β β β Updated Oct 2024 β β β β β β β
β β β β π·οΈ Endocrinology β β
Indexedβ β 2 days β β β β
β β βββββΌββββββββββββββββββββββΌββββββββββββΌβββββββββΌβββββββββββΌβββββββββββββ€ β β
β β β β β IDSA Sepsis Guide β Guideline β 42 β 438 β ποΈ βοΈ β¬οΈ ποΈβ β β
β β β β 2024 Edition β β β β β β β
β β β β π·οΈ ID, ICU β β³ Indexingβ β Now β β β β
β β βββββ΄ββββββββββββββββββββββ΄ββββββββββββ΄βββββββββ΄βββββββββββ΄βββββββββββββ β β
β β β β
β β [β Previous] [1] [2] [3] ... [25] [Next βΆ] β β
β β β β
β β Bulk Actions: [β Select All] [βοΈ Re-index Selected] [ποΈ Delete Selected] β β
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
Upload Document Modal:
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β Upload Medical Documents [β Close]β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ€
β β
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β β β
β β π Drag & Drop Files Here β β
β β or β β
β β [Browse Files] β β
β β β β
β β Supported: PDF, DOCX (max 500 MB) β β
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β
β Selected Files: β
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β β’ harrison_chapter_45.pdf (12.4 MB) [β] β β
β β β’ ACC_HF_Guidelines_2024.pdf (5.8 MB) [β] β β
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β
β Document Type: [Dropdown βΌ] β
β β Medical Textbook β
β β Journal Article β
β β Clinical Guideline β
β β Reference Material (UpToDate, etc.) β
β β Trial/Study β
β β
β Specialty Tags: [Multi-select] β
β [Cardiology β] [Endocrinology β] [+ Add Tag] β
β β
β Metadata (Optional): β
β Title: _______________________________________________ β
β Author(s): ___________________________________________ β
β Publication Year: [2024 βΌ] β
β Edition/Version: _____________________________________ β
β DOI/PMID: ____________________________________________ β
β β
β Indexing Options: β
β β Start indexing immediately β
β β Extract metadata automatically β
β β Detect specialty from content β
β β High priority (index first) β
β β
β [Cancel] [Upload & Index] β β
β β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
Document Detail View:
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β Document Details [β Close] β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ€
β β
β π Harrison's Principles of Internal Medicine - Chapter 45 β
β Atrial Fibrillation and Flutter β
β β
β ββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββ β
β β Status β β
Indexed β β
β β Document Type β Medical Textbook β β
β β Specialty β Cardiology, Arrhythmia β β
β β Pages β 18 β β
β β Chunks Generated β 124 β β
β β File Size β 2.4 MB β β
β β Uploaded β Nov 10, 2024 10:34 AM β β
β β Last Indexed β Nov 10, 2024 10:38 AM (4m 23s) β β
β β Uploaded By β Dr. Nazmy β β
β ββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββ β
β β
β Metadata: β
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β Authors: Dennis Kasper, Stephen Hauser, et al. β β
β β Edition: 21st Edition β β
β β Year: 2022 β β
β β Publisher: McGraw-Hill β β
β β ISBN: 978-1264268504 β β
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β
β Usage Statistics: β
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β Times Cited: 487 β β
β β Last Accessed: 2 hours ago β β
β β Avg Relevance: 0.82 (High) β β
β β Most Cited In: AF management, stroke prevention β β
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β
β Indexing Details: β
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β Chunking Strategy: Semantic (500 token windows) β β
β β Embedding Model: text-embedding-3-large β β
β β Vector Dimensions: 3072 β β
β β Processing Time: 4m 23s β β
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β
β Sample Chunks (first 3 of 124): β
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β 1. "Atrial fibrillation (AF) is the most common β β
β β sustained cardiac arrhythmia, affecting 1-2% of β β
β β the general population..." β β
β β β β
β β 2. "Risk stratification for stroke prevention uses β β
β β the CHA2DS2-VASc score. Patients with scores β β
β β β₯2 should receive anticoagulation..." β β
β β β β
β β 3. "Rate control strategies include beta-blockers, β β
β β calcium channel blockers, and digoxin..." β β
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
β β
β [β¬οΈ Download PDF] [βοΈ Re-index] [ποΈ Delete Document] β
β β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
Knowledge Base Management Endpoints
All KB management endpoints use the standard API envelope pattern. See server/README.md for complete specification.
| Endpoint | Method | Purpose | Request | Response |
|---|---|---|---|---|
/api/admin/kb/documents | GET | List documents | Query params (filters) | APIEnvelope<KnowledgeDocument[]> |
/api/admin/kb/documents/{id} | GET | Get document details | - | APIEnvelope<KnowledgeDocument> |
/api/admin/kb/documents | POST | Upload document | FormData (file) | APIEnvelope<IndexingJob> |
/api/admin/kb/documents/{id} | DELETE | Delete document | - | APIEnvelope<{success: true}> |
/api/admin/kb/jobs | GET | List indexing jobs | Query params (state filter) | APIEnvelope<IndexingJob[]> |
/api/admin/kb/jobs/{id} | GET | Get job details | - | APIEnvelope<IndexingJob> |
/api/admin/kb/jobs/{id}/retry | POST | Retry failed job | - | APIEnvelope<IndexingJob> |
/api/admin/kb/reindex | POST | Bulk reindex | {document_ids: string[]} | APIEnvelope<{job_count: number}> |
/api/admin/kb/search | POST | Test search | {query, filters} | APIEnvelope<SearchResult[]> |
All endpoints return standard APIEnvelope as defined in server/README.md.
All entity types reference DATA_MODEL.md.
Indexing Job UI Flow
Complete flow from document upload to indexed status:
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β Document Upload & Indexing Flow β
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
User selects file
β
[1. Client validation]
βββ Check file type (PDF, DOCX)
βββ Check file size (< 50MB)
β
[2. Upload: POST /api/admin/kb/documents]
βββ FormData with file
βββ Returns: APIEnvelope<IndexingJob>
β
[3. Job created: state = "pending"]
βββ Show in "Indexing Jobs" list
βββ Display: "Queued"
β
[4. Backend worker picks up job]
βββ State transition: pending β running
β
[5. Job running: state = "running"]
βββ UI polls: GET /api/admin/kb/jobs/{id}
βββ Display progress: "Processing... {processed_chunks}/{total_chunks}"
βββ Show spinner
β
[6a. Success: state = "completed"]
βββ Display: "β Indexed successfully"
βββ Show document in KB list
βββ Stop polling
[6b. Failure: state = "failed"]
βββ Display: "β Failed: {error_message}"
βββ Show "Retry" button
βββ Stop polling
[7. User clicks "Retry" (if failed)]
βββ POST /api/admin/kb/jobs/{id}/retry
βββ Job state: failed β pending
βββ Resume polling
Polling Strategy:
- Interval: 2 seconds while job is "running"
- Exponential backoff if server errors
- Stop when state is "completed" or "failed"
- Timeout after 5 minutes (show error)
Alternative: WebSocket Updates
- Connect to /ws/admin/jobs
- Receive real-time state updates
- No polling needed
Indexing Jobs Hook Example
Complete React hook for managing indexing jobs:
// admin/hooks/useIndexingJobs.ts import { useQuery, useMutation, useQueryClient } from "@tanstack/react-query"; import { fetchAPI } from "@/lib/api"; import { IndexingJob } from "@/types"; // From DATA_MODEL.md interface UseIndexingJobsOptions { stateFilter?: "pending" | "running" | "completed" | "failed"; pollInterval?: number; // Milliseconds (default: 2000) } export function useIndexingJobs(options: UseIndexingJobsOptions = {}) { const { stateFilter, pollInterval = 2000 } = options; const queryClient = useQueryClient(); // Fetch jobs list const jobsQuery = useQuery({ queryKey: ["indexing-jobs", stateFilter], queryFn: async () => { const params = new URLSearchParams(); if (stateFilter) params.append("state", stateFilter); return fetchAPI<IndexingJob[]>(`/api/admin/kb/jobs?${params.toString()}`); }, refetchInterval: (data) => { // Poll if any jobs are running const hasRunningJobs = data?.some((job) => job.state === "running"); return hasRunningJobs ? pollInterval : false; }, }); // Retry failed job const retryJob = useMutation({ mutationFn: async (jobId: string) => { return fetchAPI<IndexingJob>(`/api/admin/kb/jobs/${jobId}/retry`, { method: "POST", }); }, onSuccess: () => { // Refetch jobs list queryClient.invalidateQueries({ queryKey: ["indexing-jobs"] }); toast.success("Job retry initiated"); }, onError: (error: APIError) => { if (error.code === "VALIDATION_ERROR") { toast.error("Cannot retry: Max retries exceeded"); } else { toast.error(`Retry failed: ${error.message}`); } }, }); // Bulk reindex const reindexDocuments = useMutation({ mutationFn: async (documentIds: string[]) => { return fetchAPI<{ job_count: number }>("/api/admin/kb/reindex", { method: "POST", body: JSON.stringify({ document_ids: documentIds }), }); }, onSuccess: (data) => { queryClient.invalidateQueries({ queryKey: ["indexing-jobs"] }); toast.success(`${data.job_count} indexing jobs created`); }, }); return { jobs: jobsQuery.data || [], isLoading: jobsQuery.isLoading, isError: jobsQuery.isError, error: jobsQuery.error, retryJob: retryJob.mutate, isRetrying: retryJob.isPending, reindexDocuments: reindexDocuments.mutate, isReindexing: reindexDocuments.isPending, }; } // Fetch single job with detailed progress export function useIndexingJob(jobId: string) { return useQuery({ queryKey: ["indexing-job", jobId], queryFn: async () => { return fetchAPI<IndexingJob>(`/api/admin/kb/jobs/${jobId}`); }, refetchInterval: (data) => { // Poll while job is running return data?.state === "running" ? 2000 : false; }, enabled: !!jobId, }); }
Usage in Component:
// admin/components/IndexingJobsList.tsx export function IndexingJobsList() { const { jobs, isLoading, retryJob } = useIndexingJobs({ stateFilter: undefined, // Show all jobs }); if (isLoading) return <Spinner />; return ( <div className="jobs-list"> <h2>Indexing Jobs</h2> <table> <thead> <tr> <th>Document</th> <th>State</th> <th>Progress</th> <th>Started</th> <th>Actions</th> </tr> </thead> <tbody> {jobs.map(job => ( <tr key={job.id}> <td>{job.doc_key}</td> <td> <JobStateBadge state={job.state} /> </td> <td> {job.state === 'running' && ( <ProgressBar value={job.processed_chunks} max={job.total_chunks || 100} /> )} {job.processed_chunks}/{job.total_chunks || '?'} </td> <td>{formatDate(job.started_at)}</td> <td> {job.state === 'failed' && ( <button onClick={() => retryJob(job.id)}> Retry </button> )} </td> </tr> ))} </tbody> </table> </div> ); }
Document Library Features
Table View:
- Checkbox for bulk operations
- Sortable columns (name, type, pages, indexed date)
- Expandable rows showing tags and metadata
- Status indicators (β Indexed, β³ Indexing, β Failed, π Pending)
- Action buttons (ποΈ View, βοΈ Re-index, β¬οΈ Download, ποΈ Delete)
Filters & Search:
- Full-text search across titles, authors, content
- Filter by document type (textbook, journal, guideline, etc.)
- Filter by specialty (multi-select)
- Filter by status (indexed, pending, failed)
- Filter by date range
- Sort by: name, date added, date modified, pages, usage count
Document Actions:
- ποΈ View details & metadata with usage stats
- βοΈ Re-index (with progress tracking)
- β¬οΈ Download original PDF
- ποΈ Delete (with confirmation)
- π View citation analytics
Bulk Operations
Available Actions:
- Select all / Select filtered
- Batch re-indexing with priority queue
- Batch delete with confirmation
- Export metadata to CSV/JSON
- Bulk tag editing
- Backup selected documents
Indexing Status Panel
Real-time Progress:
- Current job name and status
- Progress bar with percentage
- Estimated time remaining
- Chunks processed / total
- Error count
Queue Management:
- List of pending indexing jobs
- Priority queue reordering
- Pause/resume indexing
- Cancel job option
- Retry failed jobs
Vector Database Statistics
Metrics Display:
- Total documents indexed
- Total text chunks generated
- Total vector embeddings
- Database disk size
- Index memory usage
- Average query latency
- Query throughput (queries/sec)
- Cache hit rate
Top Queried Topics:
- Bar chart of most-accessed specialties
- Most cited documents
- Trending topics this week
- Underutilized documents
5. User Management (/users)
Note: For single-user initially, this section is minimal. Expandable for multi-user future.
User Profile
- Name and email
- Profile picture
- Medical specialty
- Preferences
Session Management
- Active sessions
- Device/browser info
- Last activity
- Revoke session
API Keys (Personal)
- Generate API keys for programmatic access
- Scoped permissions
- Usage tracking
- Revoke keys
6. Analytics & Usage (/analytics)
Query Analytics
Overview Metrics
- Total queries (by period)
- Unique topics
- Most common medical specialties
- Peak usage times
Query Type Distribution (Pie Chart)
- Medical literature: 40%
- Textbook queries: 25%
- System commands: 20%
- Web search: 15%
Popular Topics (Bar Chart)
- Cardiology: 120 queries
- Diabetes: 95 queries
- Infectious Disease: 78 queries
- ...
Response Time Trends (Line Chart)
- Average response time over 30 days
- Separate lines for local vs cloud
Cost Analysis
API Usage
Month: November 2024
OpenAI API:
- Total tokens: 2,450,000
- Estimated cost: $45.00
- Breakdown:
β’ GPT-4: $38.00 (1.8M tokens)
β’ Embeddings: $5.00 (650k tokens)
β’ Realtime API: $2.00 (4.5 hours)
Other APIs:
- OpenEvidence: $10.00 (subscription)
Total: $55.00
Cost Trends (Line Chart)
- Daily/monthly spend over time
- Forecast next month
Knowledge Base Analytics
- Most accessed documents
- Citation frequency
- Specialties most queried
- Recent additions performance
User Activity
- Sessions per day
- Average session duration
- Conversation length (messages)
- Voice vs text usage ratio
Export Reports
- Generate PDF reports
- CSV data export
- Custom date ranges
7. Integrations (/integrations)
Nextcloud
ββββββββββββββββββββββββββββββββββββββββββββ
β Nextcloud Integration β
β β
β Status: π’ Connected β
β URL: https://asimo.io/nextcloud β
β Username: mohammednazmy β
β β
β βοΈ Auto-index medical documents β
β βοΈ Backup conversations β
β β Sync bookmarks β
β β
β Last Sync: 2 minutes ago β
β β
β [Test Connection] [Disconnect] β
ββββββββββββββββββββββββββββββββββββββββββββ
Calendar (macOS/Google)
ββββββββββββββββββββββββββββββββββββββββββββ
β Calendar Integration β
β β
β Status: π’ Enabled β
β Source: macOS Calendar (AppleScript) β
β β
β βοΈ Read events β
β βοΈ Create events β
β βοΈ Update events β
β β Delete events (disabled for safety) β
β β
β [Test] [Configure] β
ββββββββββββββββββββββββββββββββββββββββββββ
ββββββββββββββββββββββββββββββββββββββββββββ
β Email Integration β
β β
β Status: π‘ Configured but disabled β
β β
β IMAP Server: imap.gmail.com β
β SMTP Server: smtp.gmail.com β
β Email: doctor@example.com β
β β
β β Enable email access β
β β
β [Configure] [Test] β
ββββββββββββββββββββββββββββββββββββββββββββ
PubMed
ββββββββββββββββββββββββββββββββββββββββββββ
β PubMed / NCBI β
β β
β Status: π’ Active (Public API) β
β β
β API Key (optional): [Not set] β
β (Increases rate limit if provided) β
β β
β Queries today: 87 / 10,000 limit β
β β
β [Test API] β
ββββββββββββββββββββββββββββββββββββββββββββ
OpenEvidence
ββββββββββββββββββββββββββββββββββββββββββββ
β OpenEvidence β
β β
β Status: π΄ Not configured β
β β
β API Key: [_______________] [Save] β
β β
β [Sign up] [Test] β
ββββββββββββββββββββββββββββββββββββββββββββ
Web Search
ββββββββββββββββββββββββββββββββββββββββββββ
β Web Search β
β β
β Provider: [Brave Search API βΌ] β
β API Key: [β’β’β’β’β’β’β’β’β’β’β’β’key] β
β β
β βοΈ Enable web search β
β β
β [Test] [Configure] β
ββββββββββββββββββββββββββββββββββββββββββββ
8. Security & Privacy (/security)
Privacy Settings
ββββββββββββββββββββββββββββββββββββββββββββ
β Data Retention β
β β
β Conversation logs: [30 days βΌ] β
β Error logs: [90 days βΌ] β
β Access logs: [1 year βΌ] β
β β
β βοΈ Log all queries (for debugging) β
β β Include PHI in logs (DANGEROUS) β
ββββββββββββββββββββββββββββββββββββββββββββ
PHI Detection Rules
- Keyword list (MRN, patient name patterns, etc.)
- Regex patterns
- Directory blacklist (never send to cloud)
- Test PHI detector with examples
Data Handling Policy
- Document current privacy approach
- HIPAA compliance checklist
- Link to full privacy policy
Encryption
- Encryption at rest: Status
- Encryption in transit: Status
- Key management
Access Logs
- Admin login history
- Failed login attempts
- API access patterns
- Suspicious activity alerts
9. Logs & Monitoring (/logs)
Log Viewer
Real-Time Logs
ββββββββββββββββββββββββββββββββββββββββββββββββββββ
β [β Pause] [β³ Auto-refresh] [β¬οΈ Download] β
ββββββββββββββββββββββββββββββββββββββββββββββββββββ€
β 2024-11-19 14:32:15 [INFO] New query received β
β 2024-11-19 14:32:16 [INFO] Routed to cloud β
β 2024-11-19 14:32:18 [INFO] Response generated β
β 2024-11-19 14:32:18 [DEBUG] Citations: 2 β
β 2024-11-19 14:33:01 [ERROR] Nextcloud timeout β
β 2024-11-19 14:33:02 [WARN] Retrying connection β
ββββββββββββββββββββββββββββββββββββββββββββββββββββ
Filters
- Log level (DEBUG, INFO, WARN, ERROR)
- Service (backend, vector-db, ollama, etc.)
- Time range
- Search text
Error Tracking
- Error summary dashboard
- Error rate over time
- Most common errors
- Stack traces
- Error resolution status
Performance Logs
- Slow query log (> 5s)
- API latency tracking
- Database query performance
10. Backups & Maintenance (/maintenance)
Backup Configuration
ββββββββββββββββββββββββββββββββββββββββββββ
β Automated Backups β
β β
β Destination: Nextcloud β
β Schedule: Daily at 2:00 AM β
β β
β Backup includes: β
β βοΈ PostgreSQL database β
β βοΈ Vector database β
β βοΈ Uploaded documents β
β βοΈ Configuration files β
β β Conversation logs β
β β
β Retention: [7 days βΌ] β
β β
β Last backup: 8 hours ago β
β Status: Success β
β β
β [Run Backup Now] [Restore] β
ββββββββββββββββββββββββββββββββββββββββββββ
System Maintenance
- Database vacuum and optimization
- Clear old logs
- Rebuild vector index
- Clear Redis cache
- Prune old Docker images
Health Checks
- Run comprehensive system test
- Check all integrations
- Verify model availability
- Test API endpoints
- Database connectivity
Update Management
- Check for updates
- View changelog
- Schedule update
- Rollback to previous version
Mobile Responsiveness
- Responsive layout for tablet access
- Essential metrics on mobile
- Touch-friendly controls
- Simplified navigation
Notifications & Alerts
Alert Types
- Critical: Service down
- Warning: High error rate, disk space low
- Info: Update available, backup completed
Notification Channels
- In-app notifications
- Email alerts
- Webhook (Slack, Discord, etc.)
Alert Configuration
- Set thresholds (CPU > 90%, error rate > 5%, etc.)
- Enable/disable specific alerts
- Quiet hours
Tools & External Integrations
The admin panel provides comprehensive management of the tools layer and external service integrations. See TOOLS_AND_INTEGRATIONS.md for complete tool specifications.
Tools Overview Dashboard
// Page: /admin/tools interface ToolStatus { tool_name: string; enabled: boolean; category: 'calendar' | 'file' | 'medical' | 'calculation' | 'search'; total_calls_24h: number; success_rate: number; avg_duration_ms: number; last_error?: string; last_error_at?: string; phi_enabled: boolean; requires_confirmation: boolean; } // Display: Grid of tool cards {tools.map(tool => ( <ToolCard> <Header> <Icon /> {tool.tool_name} <StatusBadge success_rate={tool.success_rate} /> </Header> <Metrics> <Stat label="Calls (24h)" value={tool.total_calls_24h} /> <Stat label="Success Rate" value={`${tool.success_rate}%`} /> <Stat label="Avg Duration" value={`${tool.avg_duration_ms}ms`} /> </Metrics> <Footer> <Toggle checked={tool.enabled} onChange={toggleTool} /> <Button onClick={viewDetails}>Details</Button> </Footer> </ToolCard> ))}
Key Metrics:
- Total tool calls per tool (24h, 7d, 30d)
- Success rate percentage
- Average execution duration
- Error rate and last error
- PHI detection rate
Tool Configuration
// Page: /admin/tools/:tool_name interface ToolConfiguration { tool_name: string; enabled: boolean; timeout_seconds: number; rate_limit_per_user: number; rate_limit_window_seconds: number; requires_confirmation: boolean; phi_enabled: boolean; custom_settings?: Record<string, any>; } // Example: Calendar Tool Configuration <Form> <Toggle label="Enable Tool" checked={config.enabled} /> <NumberInput label="Timeout (seconds)" value={config.timeout_seconds} min={5} max={300} /> <NumberInput label="Rate Limit (calls per user)" value={config.rate_limit_per_user} min={1} max={1000} /> <NumberInput label="Rate Limit Window (seconds)" value={config.rate_limit_window_seconds} options={[60, 300, 3600]} /> <Toggle label="Require User Confirmation" checked={config.requires_confirmation} description="High-risk actions require explicit user approval" /> <Toggle label="Allow PHI" checked={config.phi_enabled} description="Enable this tool for queries containing PHI" /> <Button type="submit">Save Configuration</Button> </Form>
External API Integrations
// Page: /admin/integrations interface ExternalIntegration { name: string; category: 'medical_search' | 'calendar' | 'file_storage' | 'guidelines'; status: 'connected' | 'disconnected' | 'error'; api_key_configured: boolean; last_tested_at?: string; last_test_status?: 'success' | 'failure'; requests_24h: number; error_rate: number; } // List of integrations: const integrations: ExternalIntegration[] = [ { name: 'OpenEvidence', category: 'medical_search', status: 'connected', api_key_configured: true, last_tested_at: '2025-11-20T10:30:00Z', last_test_status: 'success', requests_24h: 342, error_rate: 0.02, }, { name: 'PubMed (NCBI E-utilities)', category: 'medical_search', status: 'connected', api_key_configured: false, // Public API last_tested_at: '2025-11-20T09:15:00Z', last_test_status: 'success', requests_24h: 156, error_rate: 0.01, }, // ... more integrations ]; <IntegrationsList> {integrations.map(integration => ( <IntegrationCard> <Header> <StatusIndicator status={integration.status} /> <h3>{integration.name}</h3> <CategoryBadge category={integration.category} /> </Header> <Metrics> <Stat label="Requests (24h)" value={integration.requests_24h} /> <Stat label="Error Rate" value={`${(integration.error_rate * 100).toFixed(1)}%`} /> <Stat label="Last Tested" value={formatRelativeTime(integration.last_tested_at)} /> </Metrics> <Actions> <Button onClick={() => configureIntegration(integration.name)}> Configure </Button> <Button onClick={() => testConnection(integration.name)}> Test Connection </Button> </Actions> </IntegrationCard> ))} </IntegrationsList>
Supported Integrations:
| Integration | Category | API Key Required | PHI Safe | Purpose |
|---|---|---|---|---|
| OpenEvidence | Medical Search | Yes | Yes (external) | Evidence-based medicine search |
| PubMed (NCBI) | Medical Search | No | Yes (external) | Biomedical literature search |
| Nextcloud | File Storage | No (internal) | No (local PHI) | Document storage and retrieval |
| CalDAV Server | Calendar | No (internal) | No (local PHI) | Calendar events (via Nextcloud) |
| Google Custom Search | Web Search | Yes | Yes (external) | General medical web search |
Integration Configuration UI
// Page: /admin/integrations/:integration_name interface IntegrationConfig { name: string; enabled: boolean; api_key?: string; api_url?: string; timeout_seconds: number; retry_attempts: number; rate_limit?: number; custom_headers?: Record<string, string>; } // Example: OpenEvidence Configuration <Form> <TextInput label="API Key" type="password" value={config.api_key} placeholder="sk_test_..." helpText="Get your API key from openevidence.com/api-keys" /> <TextInput label="API Base URL" value={config.api_url} placeholder="https://api.openevidence.com/v1" /> <NumberInput label="Timeout (seconds)" value={config.timeout_seconds} min={10} max={60} /> <NumberInput label="Retry Attempts" value={config.retry_attempts} min={0} max={5} /> <NumberInput label="Rate Limit (requests/minute)" value={config.rate_limit} helpText="Leave empty for no limit" /> <Button type="button" onClick={testConnection}> Test Connection </Button> <Button type="submit"> Save Configuration </Button> </Form>
Tool Invocation Logs
// Page: /admin/tools/logs interface ToolInvocationLog { id: string; tool_name: string; user_email: string; session_id: string; call_id: string; arguments: Record<string, any>; status: 'completed' | 'failed' | 'timeout' | 'cancelled'; duration_ms: number; phi_detected: boolean; confirmation_required: boolean; user_confirmed?: boolean; error_code?: string; error_message?: string; created_at: string; } // Display: Searchable table with filters <ToolLogsTable> <Filters> <Select label="Tool" options={allTools} value={filter.tool_name} /> <Select label="Status" options={['all', 'completed', 'failed', 'timeout']} value={filter.status} /> <Toggle label="PHI Only" checked={filter.phi_only} /> <DateRangePicker label="Date Range" value={filter.date_range} /> </Filters> <Table> <thead> <tr> <th>Timestamp</th> <th>Tool</th> <th>User</th> <th>Status</th> <th>Duration</th> <th>PHI</th> <th>Actions</th> </tr> </thead> <tbody> {logs.map(log => ( <tr> <td>{formatDateTime(log.created_at)}</td> <td><code>{log.tool_name}</code></td> <td>{log.user_email}</td> <td><StatusBadge status={log.status} /></td> <td>{log.duration_ms}ms</td> <td>{log.phi_detected && <PHIBadge />}</td> <td> <Button onClick={() => viewDetails(log)}>View</Button> </td> </tr> ))} </tbody> </Table> </ToolLogsTable>
Tool Usage Analytics
// Page: /admin/analytics/tools interface ToolAnalytics { tool_name: string; period: '24h' | '7d' | '30d'; total_calls: number; unique_users: number; success_count: number; failure_count: number; timeout_count: number; avg_duration_ms: number; p95_duration_ms: number; p99_duration_ms: number; phi_detection_rate: number; calls_per_day: Array<{ date: string; count: number }>; } // Visualizations: <Analytics> <MetricsGrid> <MetricCard title="Total Tool Calls" value={analytics.total_calls} trend={+12.5} period="vs last 7d" /> <MetricCard title="Success Rate" value={`${(analytics.success_count / analytics.total_calls * 100).toFixed(1)}%`} trend={+2.3} /> <MetricCard title="Avg Duration" value={`${analytics.avg_duration_ms}ms`} trend={-45} trendLabel="faster" /> <MetricCard title="Unique Users" value={analytics.unique_users} trend={+8} /> </MetricsGrid> <TimeSeriesChart title="Tool Calls Over Time" data={analytics.calls_per_day} xKey="date" yKey="count" /> <BarChart title="Tool Usage by Tool" data={toolsUsage} xKey="tool_name" yKey="total_calls" /> <PieChart title="Tool Status Distribution" data={[ { label: 'Success', value: analytics.success_count }, { label: 'Failed', value: analytics.failure_count }, { label: 'Timeout', value: analytics.timeout_count }, ]} /> </Analytics>
Tool Health Monitoring
// Component: ToolHealthMonitor interface ToolHealth { tool_name: string; status: 'healthy' | 'degraded' | 'down'; last_successful_call?: string; consecutive_failures: number; health_check_at: string; } <HealthMonitor> {toolsHealth.map(health => ( <HealthCard status={health.status}> <h4>{health.tool_name}</h4> {health.status === 'down' && ( <Alert severity="error"> Tool is down. {health.consecutive_failures} consecutive failures. Last success: {formatRelativeTime(health.last_successful_call)} </Alert> )} {health.status === 'degraded' && ( <Alert severity="warning"> Tool performance degraded. Error rate above threshold. </Alert> )} {health.status === 'healthy' && ( <Alert severity="success"> Tool operating normally. </Alert> )} </HealthCard> ))} </HealthMonitor>
Related Documentation:
- TOOLS_AND_INTEGRATIONS.md - Complete tools layer specification
- ORCHESTRATION_DESIGN.md - Backend tool execution flow
- DATA_MODEL.md - ToolCall and ToolResult entities
- OBSERVABILITY.md - Tool metrics and monitoring
API for Admin Panel
Endpoints
GET /api/admin/dashboard - Dashboard metrics
GET /api/admin/services/status - Service health
POST /api/admin/services/restart - Restart service
GET /api/admin/models - List models
PATCH /api/admin/models/config - Update model config
GET /api/admin/knowledge - List documents
POST /api/admin/knowledge/upload - Upload document
DELETE /api/admin/knowledge/:id - Delete document
POST /api/admin/knowledge/reindex - Trigger reindex
GET /api/admin/analytics/queries - Query analytics
GET /api/admin/analytics/costs - Cost data
GET /api/admin/integrations - Integration status
PATCH /api/admin/integrations/:name - Update integration
GET /api/admin/logs - Fetch logs
GET /api/admin/users - List users
POST /api/admin/backup - Trigger backup
GET /api/admin/health - System health check
Contextual Help & AI Assistant
The admin panel includes integrated help features that connect to the documentation site and provide AI-powered assistance.
HelpButton Component
Available from packages/ui, links to relevant documentation from any admin page:
// Usage in admin pages import { HelpButton } from "@voiceassist/ui"; <HelpButton docPath="admin/security" // Path to docs page section="permissions" // Optional section anchor variant="icon" | "text" | "both" // Display mode size="sm" | "md" | "lg" // Button size /> // Opens: https://assistdocs.asimo.io/admin/security#permissions
Implementation:
- Location:
packages/ui/src/components/HelpButton.tsx - Uses
NEXT_PUBLIC_DOCS_URLenvironment variable - Opens docs in new tab with appropriate section hash
- Keyboard accessible (Tab + Enter)
AskAIButton Component
Embedded in admin panel pages to provide contextual AI assistance:
// Location: apps/admin-panel/src/components/shared/AskAIButton.tsx <AskAIButton context={{ page: "security", // Current page context feature: "audit-logs", // Specific feature userId: currentUser.id, // Optional user context }} position="bottom-right" // Fab position />
User Flow:
- User clicks "Ask AI" floating action button
- Dialog opens with text input field
- Page context is pre-filled (user can modify)
- Submit sends request to
/api/ai/docs/ask - AI response includes relevant doc citations
- User can click citations to open full documentation
API Endpoint:
// POST /api/ai/docs/ask interface DocsAskRequest { question: string; context?: { page?: string; feature?: string; userId?: string; }; } interface DocsAskResponse { answer: string; citations: Array<{ doc_path: string; title: string; section?: string; relevance: number; }>; confidence: number; }
Backend Integration:
- Uses
docs_search_toolfor semantic search across documentation - Leverages Qdrant
platform_docscollection (1536-dim embeddings) - Returns top-k relevant passages with citations
- Confidence score indicates answer quality
See Also:
- DOCUMENTATION_SITE_SPECS.md - Full docs site specifications
- Agent API Reference - AI agent endpoints
Security Considerations
- Admin panel on separate subdomain
- Strong authentication required
- Rate limiting on all endpoints
- Audit log all admin actions
- No sensitive data in client-side code
- HTTPS only
- CSRF protection
Future Enhancements
Advanced Features
- Multi-user management with roles
- Team collaboration features
- Custom dashboard widgets
- Scheduled reports via email
- Mobile admin app
- A/B testing for model performance
- Cost optimization recommendations
- Automated scaling suggestions
AI-Powered Admin
- Anomaly detection in metrics
- Predictive maintenance alerts
- Intelligent log analysis
- Automatic optimization suggestions