khronoz's picture
Added Metadata to README for HF Spaces
22e4c8b
|
raw
history blame
3.34 kB
metadata
title: Smart Retrieval API
emoji: πŸ“
colorFrom: blue
colorTo: indigo
sdk: docker
python_version: 3.11.4
app_port: 8000
pinned: false

Project logo

Smart Retrieval

Status GitHub Issues GitHub Pull Requests License


A Large Language Model (LLM) powered platform for information retrieval.

πŸ“ Table of Contents

🧐 About

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.

🏁 Getting Started

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

  1. First, startup the backend as described in the backend README.

  2. Second, run the development server of the frontend as described in the frontend README.

  3. Open http://localhost:3000 with your browser to see the result.

πŸš€ Deployment

How to deploy this on a live system.

⛏️ Built Using

  • NextJs - Frontend Web Framework
  • Vercel AI - AI SDK library for building AI-powered streaming text and chat UIs.
  • NodeJs - Frontend Server Environment
  • Python - Backend Server Environment
  • FastAPI - Backend API Web Framework
  • LlamaIndex - Data Framework for LLM

✍️ Authors

See also the list of contributors who participated in this project.

πŸŽ‰ Acknowledgements

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