chatbot-util

Utility for generating similar FAQ's a la rag-fusion in a Dialogflow-ready, structured format

Docs deployed at https://collegiate-edu-nation.github.io/chatbot-util
Docs cover instructions and source code reference

Setup

Must install Ollama and flake-enabled Nix before running anything

Start Ollama server
I recommend running Ollama as a system service to avoid running this all the time

ollama serve

Download the LLM
Only needs to be run if mistral has not already been downloaded

ollama pull mistral

Usage

Before the FAQ can be extended by the LLM, the initial FAQ must be added to ~/.chatbot-util/

A list of employees, phrases to substitute, and answers must also be included in ~/.chatbot-util/Other.txt (see docs for more explanation)

Once there, run the app

nix run github:collegiate-edu-nation/chatbot-util

This will create the extended FAQ in the same directory

Advanced Usage

Verify results

flake.nix contains a basic script for verifying that the output of running chatbot-util either exactly matches the preexisting Permutated.csv, or only contains new and unmodified entries. This is very helpful for ensuring deterministic output over time

Run this command to verify. If successful, verified will be printed to console

nix develop github:collegiate-edu-nation/chatbot-util --command bash -c "verify"

Modifications

To edit the code itself, clone this repo

git clone https://github.com/collegiate-edu-nation/chatbot-util.git

Modify src as desired and add the changes
The build and format scripts will be helpful here

Run the app

nix run /path/to/chatbot-util

License

GPLv3