Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sciphi-ai/r2r-app-demo
https://github.com/sciphi-ai/r2r-app-demo
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sciphi-ai/r2r-app-demo
- Owner: SciPhi-AI
- License: apache-2.0
- Created: 2024-03-21T03:47:17.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-25T07:11:11.000Z (9 months ago)
- Last Synced: 2024-04-25T08:23:45.211Z (9 months ago)
- Language: TypeScript
- Homepage: https://app-basic-rag-template.vercel.app
- Size: 85 KB
- Stars: 1
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RAG Pipeline Web Application
This repository contains a web application that interacts with a deployed RAG (Retrieval Augmented Generation) pipeline built using the R2R framework and the SciPhi cloud platform. The web application allows users to upload documents, submit queries, and receive AI-generated answers based on the uploaded documents.
## Prerequisites
Before using the web application, ensure that you have deployed the RAG pipeline using the [R2R-local-rag-prebuilt](https://github.com/SciPhi-AI/R2R-local-qna-rag-prebuilt) repository. Follow the instructions in the template's README to set up and configure the pipeline.
## Features
- User-specific document management: Each user has their own set of uploaded documents.
- Document upload: Users can upload documents through the application interface.
- Query submission: Users can submit queries based on their uploaded documents.
- AI-generated answers: The application communicates with the deployed RAG pipeline to process the uploaded documents and generate answers to user queries.
- Source citations: The generated answers include citations to the relevant documents used to derive the answer.
- Responsive design: The application is designed to be responsive and work well on different screen sizes.
## Installation
1. Clone this repository:
```
git clone [email protected]:SciPhi-AI/R2R-App-Demo.git
```
2. Navigate to the project directory:
```
cd web
```
3. Install the dependencies using pnpm:
```
pnpm install
```
## Usage
1. Start the development server:
```
pnpm dev
```
This will start the application in development mode and open it in your default browser.
2. Open the application in your browser at `http://localhost:3000`.
3. Enter the URL of your deployed RAG pipeline in the "API URL" input box at the top of the page.
4. Upload documents using the "Upload File" button in the sidebar.
5. Submit queries using the search input at the bottom of the main content area.
6. View the generated answers and source citations in the main content area.
7. Build the server:
```
pnpm build
```