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
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -29,25 +29,25 @@ This repository contains the following components:
29
29
-[*admin-backend*](#112-admin-backend): Manages user documents and confluence spaces, interacts with document-extractor and rag-backend.
30
30
-[*document-extractor*](#113-document-extractor): Extracts content from documents and Confluence spaces.
31
31
-*frontend*: Frontend for both, chat and admin APIs.
32
-
-*rag-infrastructure*: Contains the helm-chart and other files related to infrastructure and deployment. Please consult [this README](./rag-infrastructure/README.md) for further information.
33
-
-*rag-core-library*: Contains the API-libraries that are used to construct the backend-services in this repository. For further information, please consult [this README](./rag-core-library/README.md).
32
+
-*rag-infrastructure*: Contains the helm-chart and other files related to infrastructure and deployment. Please consult [this README](https://github.com/stackitcloud/rag-infrastructure/blob/main/README.md) for further information.
33
+
-*rag-core-library*: Contains the API-libraries that are used to construct the backend-services in this repository. For further information, please consult [this README](https://github.com/stackitcloud/rag-core-library/blob/main/README.md).
34
34
35
35
#### 1.1.1 Rag backend
36
36
The backend is the main component of the RAG. It handles all connections to the vector database, as well as chatting.
37
37
38
-
All components are provided by the *rag-core-api*. For further information on endpoints and requirements, please consult [this README](./rag-core-library/README.md#1-rag-core-api).
38
+
All components are provided by the *rag-core-api*. For further information on endpoints and requirements, please consult [this README](https://github.com/stackitcloud/rag-core-library/blob/main/README.md#1-rag-core-api).
39
39
40
40
#### 1.1.2 Admin backend
41
41
42
42
The Admin backend is a component that is used to manage user provided documents and confluence spaces. It communicates with the document-extractor to extract the content from the documents and confluence spaces. Besides, it communicates with the rag-backend to store the document chunks into the vector database. For storing the documents, it uses the S3 object storage. It also acts as interface to provide the current status of the documents and confluence spaces in the RAG.
43
43
44
-
All components are provided by the *admin-api-lib*. For further information on endpoints and requirements, please consult [this README](./rag-core-library/README.md#2-admin-api-lib).
44
+
All components are provided by the *admin-api-lib*. For further information on endpoints and requirements, please consult [this README](https://github.com/stackitcloud/rag-core-library/blob/main/README.md#2-admin-api-lib).
45
45
46
46
#### 1.1.3 Document extractor
47
47
48
48
The Document extractor is a component that is used to extract the content from the documents and confluence spaces.
49
49
50
-
All components are provided by the *extractor-api-lib*. For further information on endpoints and requirements, please consult [this README](./rag-core-library/README.md#3-extractor-api-lib).
50
+
All components are provided by the *extractor-api-lib*. For further information on endpoints and requirements, please consult [this README](https://github.com/stackitcloud/rag-core-library/blob/main/README.md#3-extractor-api-lib).
51
51
52
52
### 1.2 Requirements
53
53
@@ -74,7 +74,7 @@ This example of the rag-template includes a WebUI for document-management, as we
74
74
After following the setup instruction for either the [local installation](#-local-setup-instructions) or the [installation on a server](#-Deployment-to-server) the WebUI is accessible via the configured ingress.
75
75
After uploading a file in the document-management WebUI you can start asking question about your document in the chat WebUI.
76
76
77
-
For a complete documentation of the available REST-APIs, please consult [the README of the rag-core-library](./rag-core-library/README.md).
77
+
For a complete documentation of the available REST-APIs, please consult [the README of the rag-core-library](https://github.com/stackitcloud/rag-core-library/blob/main/README.md).
78
78
79
79
If you want to replace some dependencies with you own dependencies, see the rag-backend folder, especially the [main.py](./rag-backend/main.py), [container.py](./rag-backend/container.py) and [chat_endpoint.py](./rag-backend/chat_endpoint.py).
80
80
@@ -145,7 +145,7 @@ In the following, the *k3d* cluster setup and the setup inside the *k3d* will be
145
145
146
146
#### 1.4.1 *k3d* cluster setup
147
147
148
-
For a detailed explanation of the *k3d* setup, please consult the [rag-infrastructure README](./rag-infrastructure/README.md#211-k3d-cluster-setup).
148
+
For a detailed explanation of the *k3d* setup, please consult the [rag-infrastructure README](https://github.com/stackitcloud/rag-infrastructure/blob/main/README.md#211-k3d-cluster-setup).
149
149
150
150
#### 1.4.2 Tilt deployment
151
151
@@ -294,7 +294,7 @@ tilt down
294
294
295
295
#### 1.4.3 Access via ingress
296
296
297
-
A detailed explanation of, how to access a service via ingress, can be found in the [rag-infrastructure README](./rag-infrastructure/README.md#213-access-via-ingress).
297
+
A detailed explanation of, how to access a service via ingress, can be found in the [rag-infrastructure README](https://github.com/stackitcloud/rag-infrastructure/blob/main/README.md#213-access-via-ingress).
For further information please consult the [STACKIT Terrraform Provider documentation](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs).
360
360
361
-
Further requirements for the server can be found [here](./rag-infrastructure/README.md#22-production-setup-instructions).
361
+
Further requirements for the server can be found [here](https://github.com/stackitcloud/rag-infrastructure/blob/main/README.md#22-production-setup-instructions).
362
362
363
363
### 2.2 Langfuse
364
364
365
-
A detailed description regarding the configuration of Langfuse can be found [here](./rag-infrastructure/README.md#11-langfuse).
365
+
A detailed description regarding the configuration of Langfuse can be found [here](https://github.com/stackitcloud/rag-infrastructure/blob/main/README.md#11-langfuse).
0 commit comments