Skip to main content

Local RAG framework for building intelligent knowledge bases

Project description

SolveDesk AI

Intelligent knowledge base powered by embeddings, vector search and Retrieval-Augmented Generation (RAG).

Overview

SolveDesk AI is a lightweight open-source framework for building local intelligent knowledge bases. The project provides a command-line interface for creating vector databases, importing documents, generating embeddings, performing semantic search, and integrating with local Large Language Models (LLMs).

Inspired by frameworks such as Laravel and Django, SolveDesk AI simplifies the process of building Retrieval-Augmented Generation (RAG) systems by providing ready-to-use commands and a modular architecture.

The framework can be used both as a production-ready knowledge base solution and as an educational platform for learning modern AI technologies, vector databases, embeddings, and semantic retrieval.


Features

  • Local knowledge base creation
  • Semantic document search
  • Retrieval-Augmented Generation (RAG)
  • Vector database management
  • Embedding generation
  • Local LLM integration through Ollama
  • Data synchronization from APIs
  • CSV, JSON and XLSX import support
  • Embedding quality analysis
  • Document chunking
  • FastAPI integration
  • Command-line interface

Architecture

Documents / API
       │
       ▼
Embedding Model
       │
       ▼
    ChromaDB
       │
       ▼
Semantic Search
       │
       ▼
      LLM
    Ollama
       │
       ▼
 Generated Response

Technologies

Technology Purpose
Python 3.11 Application runtime
FastAPI REST API
ChromaDB Vector database
silver-retriever-base-v1 Embedding model
Sentence Transformers Embedding generation
Ollama Local LLM integration
Matplotlib Data visualization
Typer Command-line interface

Installation

Install solvedesk:

venv\Scripts\activate 
(venv) pip install solvedesk-ai

Initialize project:

(venv) C:\path\to\project> solvedesk conf init

[INFO] SolveDesk AI - Project Generator

[INPUT] Project name: Test123
[INPUT] Project description [Local RAG knowledge base]:

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
[INFO] Configuration
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
[DETAILS] Name        : Test123
[DETAILS] Description : Local RAG knowledge base
[DETAILS] Template    : https://github.com/studiocyfrowe/solvedesk-ai

[CONFIRM] Continue project creation? [y/N]: y

[STATUS] Downloading template...

[STATUS] Project created successfully

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
[INFO] Project information
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
[DETAILS] Location : C:\path\to\project\Test123
[DETAILS] Name     : Test123
[DETAILS] Description : Local RAG knowledge base

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
[INFO] Next steps:

cd Test123
solvedesk db init
solvedesk llm init
solvedesk run:app

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
[STATUS] Happy coding!
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Initialize vector database:

solvedesk db init

Configure local LLM:

solvedesk llm init

CLI Commands

Project Configuration

solvedesk conf init

Initialize project environment.

Database

solvedesk db init

Create vector database and download embedding model.

solvedesk db list

Display available collections.

solvedesk db details COLLECTION_NAME

Display collection details.

Data Synchronization

solvedesk sync api

Import documents from external API.

solvedesk sync file

Import documents from CSV, JSON or XLSX files.

Data Analysis

solvedesk data revision

Generate reports containing:

  • cosine similarity statistics
  • cluster distribution
  • token statistics
  • PCA visualization

Chunking

solvedesk data chunk

Split large documents into smaller chunks suitable for RAG systems.

LLM Configuration

solvedesk llm init

Configure Ollama host and model.

Run Application

solvedesk run:app

Start FastAPI server.


Supported Data Structures

FAQ

{
  "question": "How to reset password?",
  "answer": "Use reset password page."
}

Knowledge Base

{
  "name": "VPN Connection",
  "question": "Cannot connect to VPN",
  "answer": "Verify credentials and VPN client configuration."
}

Example Workflow

solvedesk conf init
solvedesk db init
solvedesk sync file
solvedesk data revision
solvedesk llm init
solvedesk run:app

Project Goals

  • Build local intelligent knowledge bases
  • Simplify RAG implementation
  • Support AI experimentation
  • Provide full control over data
  • Enable local LLM deployments
  • Offer educational value for learning AI technologies

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

solvedesk_ai-0.2.1.tar.gz (26.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

solvedesk_ai-0.2.1-py3-none-any.whl (41.3 kB view details)

Uploaded Python 3

File details

Details for the file solvedesk_ai-0.2.1.tar.gz.

File metadata

  • Download URL: solvedesk_ai-0.2.1.tar.gz
  • Upload date:
  • Size: 26.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for solvedesk_ai-0.2.1.tar.gz
Algorithm Hash digest
SHA256 3274f9fa21af5c290aeafbb189936d7f74c828bb50032f3481ad5788431f2bc5
MD5 0a0823991c3899f0cac927d3f3981260
BLAKE2b-256 54831e970bdb032f5f1554ed20e19c55edd2c9a3a8dc431ccf31cae9ba9a155d

See more details on using hashes here.

File details

Details for the file solvedesk_ai-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: solvedesk_ai-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 41.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for solvedesk_ai-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ee95737409d655c970caef86112be1e7d6664730dccf60a78c312d5a55718210
MD5 72bfb6bf3d7d4cfe91267cbd7737bb06
BLAKE2b-256 39cad624a4acaf1867f89f9a3cf32136dc3fc3873b54f28b007cb2cd5cf06508

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page