From 18552d4d4494a72420fc78ebe67782e19197c4a2 Mon Sep 17 00:00:00 2001 From: Andreas Klos Date: Mon, 20 Jan 2025 19:57:57 +0100 Subject: [PATCH 1/3] chore: update readme links in readme.md file Cross reference to submodules readme. Relativ links are currently not supported from github --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e802b46..ce2f5ac 100644 --- a/README.md +++ b/README.md @@ -30,24 +30,24 @@ This repository contains the following components: - [*document-extractor*](#113-document-extractor): Extracts content from documents and Confluence spaces. - *frontend*: Frontend for both, chat and admin APIs. - *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. -- *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). +- *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/README.md). #### 1.1.1 Rag backend The backend is the main component of the RAG. It handles all connections to the vector database, as well as chatting. -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). +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/README.md#1-rag-core-api). #### 1.1.2 Admin backend 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. -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). +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/README.md#2-admin-api-lib). #### 1.1.3 Document extractor The Document extractor is a component that is used to extract the content from the documents and confluence spaces. -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). +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/README.md#3-extractor-api-lib). ### 1.2 Requirements @@ -74,7 +74,7 @@ This example of the rag-template includes a WebUI for document-management, as we 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. After uploading a file in the document-management WebUI you can start asking question about your document in the chat WebUI. -For a complete documentation of the available REST-APIs, please consult [the README of the rag-core-library](./rag-core-library/README.md). +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/README.md). 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). From cbcb1ca83be9ff7df2cc62a7613caa0959b81742 Mon Sep 17 00:00:00 2001 From: Andreas Klos Date: Mon, 20 Jan 2025 20:01:07 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ce2f5ac..fcc16b8 100644 --- a/README.md +++ b/README.md @@ -30,24 +30,24 @@ This repository contains the following components: - [*document-extractor*](#113-document-extractor): Extracts content from documents and Confluence spaces. - *frontend*: Frontend for both, chat and admin APIs. - *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. -- *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/README.md). +- *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). #### 1.1.1 Rag backend The backend is the main component of the RAG. It handles all connections to the vector database, as well as chatting. -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/README.md#1-rag-core-api). +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). #### 1.1.2 Admin backend 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. -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/README.md#2-admin-api-lib). +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). #### 1.1.3 Document extractor The Document extractor is a component that is used to extract the content from the documents and confluence spaces. -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/README.md#3-extractor-api-lib). +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). ### 1.2 Requirements @@ -74,7 +74,7 @@ This example of the rag-template includes a WebUI for document-management, as we 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. After uploading a file in the document-management WebUI you can start asking question about your document in the chat WebUI. -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/README.md). +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). 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). From a7d6313842752b2193c4789b8d66b0302a142d7d Mon Sep 17 00:00:00 2001 From: Andreas Klos Date: Mon, 20 Jan 2025 20:03:12 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fcc16b8..1fcd074 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ This repository contains the following components: - [*admin-backend*](#112-admin-backend): Manages user documents and confluence spaces, interacts with document-extractor and rag-backend. - [*document-extractor*](#113-document-extractor): Extracts content from documents and Confluence spaces. - *frontend*: Frontend for both, chat and admin APIs. -- *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. +- *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. - *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). #### 1.1.1 Rag backend @@ -145,7 +145,7 @@ In the following, the *k3d* cluster setup and the setup inside the *k3d* will be #### 1.4.1 *k3d* cluster setup -For a detailed explanation of the *k3d* setup, please consult the [rag-infrastructure README](./rag-infrastructure/README.md#211-k3d-cluster-setup). +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). #### 1.4.2 Tilt deployment @@ -294,7 +294,7 @@ tilt down #### 1.4.3 Access via ingress -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). +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). @@ -358,11 +358,11 @@ resource "stackit_objectstorage_bucket" "docs" { For further information please consult the [STACKIT Terrraform Provider documentation](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs). -Further requirements for the server can be found [here](./rag-infrastructure/README.md#22-production-setup-instructions). +Further requirements for the server can be found [here](https://github.com/stackitcloud/rag-infrastructure/blob/main/README.md#22-production-setup-instructions). ### 2.2 Langfuse -A detailed description regarding the configuration of Langfuse can be found [here](./rag-infrastructure/README.md#11-langfuse). +A detailed description regarding the configuration of Langfuse can be found [here](https://github.com/stackitcloud/rag-infrastructure/blob/main/README.md#11-langfuse). ## 3. Build and Test