Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Lunatix01 authored Aug 22, 2024
1 parent dbba289 commit 12ceab6
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ Simple CLI Retrieval Augmented Generation Scanner
=================================================
Aim of the project: A showcase of a RAG scanner written in Java and using [Spring AI](https://docs.spring.io/spring-ai/reference/api/index.html), which scans the targeted documents and you can ask questions to the LLM regarding the given documents.

## Disclaimer
This tool is intended for educational and productivity purposes only. It is designed to assist users in managing and querying their own documents. Any illegal or unethical use of this software is strictly prohibited.

## Requirements
1. [Java 21](https://www.oracle.com/java/technologies/javase/jdk21-archive-downloads.html) installed on your device
2. [Docker](https://www.docker.com/products/docker-desktop/)
Expand All @@ -20,7 +23,6 @@ Aim of the project: A showcase of a RAG scanner written in Java and using [Sprin
5. Finally in the shell write `ask "your question here"` and that's it.



### Notes
It's a simple project, needs a lot of improvements like:
1. Improve chunking documents (Currently chunked by token size)
Expand Down

0 comments on commit 12ceab6

Please sign in to comment.