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

Clone repository:

git clone https://github.com/your-repository/solvedesk-ai.git
cd solvedesk-ai

Install dependencies:

pip install -r requirements.txt

Initialize project:

solvedesk conf init

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.1.1.tar.gz (9.4 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.1.1-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: solvedesk_ai-0.1.1.tar.gz
  • Upload date:
  • Size: 9.4 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.1.1.tar.gz
Algorithm Hash digest
SHA256 43361c2242f3d0288d21390a821339c3c6e1b1ec332713806b8f1f4b836591d2
MD5 93c6490ecf0970b39f3dad35b2ad210a
BLAKE2b-256 710e514709dcf5c16c4e9ad73ce03c69354497de2f59ebe854b53c8040b8af9a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: solvedesk_ai-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 12.1 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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d25a7e4cf24ec23c7d5a87e23d790150d3c3eca27847d02b9b4b61e3d1512102
MD5 e719446b27e5a936dd89d4973f3edcdf
BLAKE2b-256 3f21c4cffd5af0d0cec884f7de425309e541fb58ff30ab6f81e6cd42de307c01

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