https://github.com/axflow/original-demo-ui

Demo UI for the axgen library
https://github.com/axflow/original-demo-ui

augmented context framework llm rag retrieval

Last synced: about 1 month ago
JSON representation

Demo UI for the axgen library

• Host: GitHub
• URL: https://github.com/axflow/original-demo-ui
• Owner: axflow
• Created: 2023-07-14T20:45:30.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-23T23:03:12.000Z (over 1 year ago)
• Last Synced: 2024-05-19T03:47:07.957Z (7 months ago)
• Topics: augmented, context, framework, llm, rag, retrieval
• Language: TypeScript
• Homepage: https://axflow.dev
• Size: 899 KB
• Stars: 71
• Watchers: 6
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Axilla demo UI

### [Demo video 🎥](https://www.loom.com/share/458f9b6679b740f0a5c78a33fffee3dc)

This demo UI showcases how to build RAG (retrieval augmented generation) workflows using the [axgen](https://github.com/axilla-io/axgen) library.

![Demo UI Screenshot](./public/demo-screenshot.png)

The UI covers the usual flow, which has 2 separate parts:

1.  Ingest documents into a vector store (this demo shows ingesting from files and from wikipedia, but you could plug any data source)

2.  Ask questions with augmented context for retrieval (by fetching chunks of the ingested documents to enrich the answer)

You can easily toggle document inclusion on/off, to see the difference. The UI also shows the documents that were retrieved which helps troubleshoot why the answer is what it is.

[Axgen](https://github.com/axilla-io/axgen) is fully configurable, as this UI demonstrates.

Please give us any feedback (bugs, requests, questions) at [email protected]. We love talking to our users so don't be shy.

## Axilla

At [Axilla](https://axilla.io), we are building an opinionated end-to-end framework to work with LLMs in TypeScript.

Our first module open source module is [axgen](https://github.com/axilla-io/axgen), focused on document ingestion and retrieval. Giving it a star ⭐️ is very helpful for our visibility, so we appreciate it if you can spare one!

## Usage

This is a simple nextJS application, that was tested using node 18.

### Steps

1. Clone the repo: `git clone https://github.com/axilla-io/demo-ui.git`

2. Ensure you have the right environment variables setup: `cp .env.example .env`

3. Install packages: `npm i`

4. Run it: `npm run dev  # will run on localhost:3300`

## License

Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.md).