Software suite for deploying semantic search and RAG/no-hallucination LLM-chat over arbitrary data cards/chunks. Contains a server for duplication detection, bookmarks, retrieval, filtering, recommendations, etc. and also white-label'able UI's for search and retrieval-augmented LLM chat. Build, contribute, and stay-tuned!

Documentation • Debate Search Demo • RAG Debate Opponent Demo • Discord • Matrix

Arguflow

How to contribute

Fork the repository and clone it to your local machine
Create a new branch with a descriptive name: git checkout -b your-branch-name
Make your changes to the README file. Please ensure that your changes are relevant and add value to the project
Test your changes locally to ensure that they do not break anything
Commit your changes with a descriptive commit message: git commit -m "Add descriptive commit message here"
Push your changes to your forked repository: git push origin your-branch-name
Open a pull request to the main repository and describe your changes in the PR description

Self-hosting the API and UI's

We have a full self-hosting guide available on our documentation page here.

Local development

Install apt packages

curl \
gcc \
g++ \
make \
pkg-config \
python3 \
python3-pip \
libpq-dev \
libssl-dev \
openssl \
libreoffice

Install NodeJS and Yarn

You can use the following, but we recommend using NVM and then running yarn --cwd ./vault-nodejs install .

RUN curl -fsSL https://deb.nodesource.com/setup_18.x | bash - && \
    apt-get install -y nodejs && \
    npm install -g yarn && \
    yarn --cwd ./vault-nodejs install

Set rust to nightly

rustup default nightly

Install python requirements

pip install -r ./server/vault-python/requirements.txt

How to debug diesel by getting the exact generated SQL

diesel::debug*query::<diesel::pg::Pg, *>(&query);

How to set up the python verification script

virtualenv venv
source venv/bin/activate
pip install -r ./server/vault-python/requirements.txt

How to get Rust debug level logs

Run export RUST_LOG=debug

Recommended local dev setup

This repository used to solely house the server folder, but has recently been expanded to contain both search and chat. We recommend that you open VSCode for the search and chat folders independently.

Setup env's

cp .env.chat ./chat/.env
cp .env.search ./search/.env
cp ./server/.env.dist ./server/.env

Start docker container services needed for local dev

./convenience.sh -l

Start services for local dev

We know this is bad. Currently, We recommend managing this through tmux.

cd server
cargo watch -x run

cd search
yarn
yarn dev

cd chat
yarn
yarn dev

akhill10/arguflow