Skip to content
This repository has been archived by the owner on Aug 28, 2024. It is now read-only.
/ howabout Public archive

Retrieval-augmented document search, answers questions about your archive with Kernel Memory.

Notifications You must be signed in to change notification settings

plastic-plant/howabout

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

84 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Answers questions about your documents with language models. Howabout starts a small webserver and let's you chat in a web browser or in the console. Show-and-tell: a playground for retrieval-augmented document search.

Browser window showing chat

How to use

Install on Linux, macOS, Windows, Docker, Kubernetes. Start the application and open http://localhost:5000 in a browser. Alternatively, build from source and run with Visual Studio IDE, Visual Studio Code, JetBrains Rider, dotnet-cli or dotnet-sdk containers.

howabout start
howabout add mydocument.txt
howabout ask Can you give me a summary?

Howabout is configured in appsettings.json. Both through the command line and the web interface, you can add documents, ask questions, and get answers. The app uses language models to find information and answer questions about your documents. You can choose between different models and providers.

The aim of this app is to have a demoable playground for RAG written in C# that is flexible enough to be used in Kubernetes, Linux and Windows. That means there's a bit of work to do after downloading a release from the menu. Before you run Howabout for the first time, configure a model. You can configure additional options too. Here's how.

See How to install latest release and read How to setup a model with remote providers like OpenAI and OpenRouter, and local providers like LM Studio, Jan.ai, etc. Supports local GGUF models invoking Llama.cpp too. There's an option to help you download models from Hugging Face, private Git repos, local and remote locations. Cheers!