You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-3Lines changed: 8 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,18 @@
4
4
5
5
LLAMARA - **L**arge **L**anguage **A**ssistant for **M**odel-**A**ugmented **R**etrieval and **A**nalysis - is an LLM-based assistant for information retrieval from a provided knowledge base.
6
6
7
-
Initially designed to support researchers working with scientific papers, whitepapers, and documentation,
7
+
Initially designed to support researchers working with scientific papers, white papers, and documentation,
8
8
LLAMARA has also proven useful for students working with lecture slides.
9
9
It efficiently handles large datasets, accurately identifying and retrieving relevant information.
10
10
Additionally, LAMARA ensures full transparency by providing sources with references to the knowledge base, making research findings accessible to both researchers and the public.
11
11
12
12
> **NOTE:** This repository contains the LLAMARA backend only.
13
13
14
+
> [!WARNING]
15
+
> This project is not maintained anymore.
16
+
> We do **not** recommend deploying this publicly in its current state, as several dependencies are outdated, posing a potential security risk.
17
+
> In case you are interested in continuting development, please contact us at <dev@florianhotze.com>.
18
+
14
19
## Features
15
20
16
21
-**Retrieval-Augmented-Generation (RAG)** chat functionality with provided knowledge
@@ -162,7 +167,7 @@ If you need it in production, you can enable it by setting `quarkus.swagger-ui.e
162
167
163
168
### Info Endpoint
164
169
165
-
The `/q/info` endpoint provides information about LLAMARA backend, including Git, Java, OS and build details.
170
+
The `/q/info` endpoint provides information about LLAMARA backend, including Git, Java, OS, and build details.
166
171
167
172
### Health Endpoint
168
173
@@ -175,7 +180,7 @@ LLAMARA backend exposes four REST endpoints according to the [Eclipse Microprofi
175
180
176
181
## Serving a Frontend
177
182
178
-
LLAMARA backend is able to serve a JavaScript Single-Page-Application, such as a React, Vue or Angular application, as its frontend.
183
+
LLAMARA backend is able to serve a JavaScript Single-Page-Application, such as a React, Vue, or Angular application, as its frontend.
179
184
180
185
To do so, you need to place the build output of your bundler, e.g. Webpack or Vite, into the [`META-INF/resources`](src/main/resources/META-INF/resources) folder during build-time of LLAMARA backend.
181
186
The bundled JavaScript SPA will then be part of the build JAR and automatically served by Quarkus on the applications root path.
0 commit comments