README.md

---
title: Smart Retrieval API
emoji: 📝
colorFrom: blue
colorTo: indigo
sdk: docker
python_version: 3.11.4
app_port: 8000
pinned: false
---

<p align="center">
  <a href="" rel="noopener">
 <img width=200px height=200px src="smart retrieval.webp" alt="Project logo"></a>
</p>

<h3 align="center">Smart Retrieval</h3>

<div align="center">

[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/digitalbuiltenvironment/Smart-Retrieval.svg)](https://github.com/digitalbuiltenvironment/Smart-Retrieval/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/digitalbuiltenvironment/Smart-Retrieval.svg)](https://github.com/digitalbuiltenvironment/Smart-Retrieval/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

</div>

---

<p align="center"> A Large Language Model (LLM) powered platform for information retrieval.
    <br>
</p>

## 📝 Table of Contents

- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Built Using](#built_using)
- [Contributing](../CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)

## 🧐 About <a name = "about"></a>

Smart Retrieval is a platform for efficient and streamlined information retrieval, especially in the realm of legal and compliance documents.
With the power of Open-Source Large Language Models (LLM) and Retrieval Augmented Generation (RAG), it aims to enhance user experiences at JTC by addressing key challenges such as manual search inefficiencies and rigid file naming conventions, revolutionizing the way JTC employees access and comprehend crucial documents

Project files bootstrapped with [`create-llama`](https://github.com/run-llama/LlamaIndexTS/tree/main/packages/create-llama).

## 🏁 Getting Started <a name = "getting_started"></a>

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.

1) First, startup the backend as described in the [backend README](./backend/README.md).

2) Second, run the development server of the frontend as described in the [frontend README](./frontend/README.md).

3) Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.


## 🚀 Deployment <a name = "deployment"></a>

How to deploy this on a live system.

## ⛏️ Built Using <a name = "built_using"></a>

- [NextJs](https://nextjs.org/) - Frontend Web Framework
- [Vercel AI](https://vercel.com/ai) - AI SDK library for building AI-powered streaming text and chat UIs.
- [NodeJs](https://nodejs.org/en/) - Frontend Server Environment
- [Python](https://python.org/) - Backend Server Environment
- [FastAPI](https://fastapi.tiangolo.com/) - Backend API Web Framework
- [LlamaIndex](https://www.llamaindex.ai/) - Data Framework for LLM

## ✍️ Authors <a name = "authors"></a>

- [@xkhronoz](https://github.com/xkhronoz) - Initial work

See also the list of [contributors](https://github.com/digitalbuiltenvironment/Smart-Retrieval/contributors) who participated in this project.

## 🎉 Acknowledgements <a name = "acknowledgement"></a>

- Hat tip to anyone whose code was used
- Inspiration
- References