Prerequisites

  • Tested on Ubuntu 22.04 and OpenSuse Tumbleweed.

  • Nvidia GPU is required for embeddings generation and usage of locally hosted models.

  • Python 3.10/3.11/3.12/3.13, including dev packages (python3-dev on Ubuntu)

  • Nvidia CUDA Toolkit

  • To interact with OpenAI models, create .env in the root directory of the repository, containing OpenAI API key. A template for the .env file is provided in .env_template

  • For parsing .epub documents, Pandoc is required - https://pandoc.org/installing.html

  • uv - https://github.com/astral-sh/uv#installation

Install Latest Version

# Create a new environment
uv venv --python 3.13 # Or any other supported version

# Activate new environment
source .venv/bin/activate

# Optional dependencues for Azure parser
uv pip install "pyllmsearch[azureparser]"

# Preferred method (much faster) - install packages using uv
uv pip install pyllmsearch

Install from source

# Clone the repository

git clone https://github.com/snexus/llm-search.git
cd llm-search
# Create a new environment
uv venv --python 3.13
# Activate new environment
source .venv/bin/activate
# Install packages using uv

uv sync

# Optional - install in the development mode
uv pip install -e . # or `pip install -e .` for development

# For Azure parser, install with optional dependencies
uv pip install ."[azureparser]"