Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme links in readme.md file #4

Merged
merged 3 commits into from
Jan 21, 2025
Merged

chore: update readme links in readme.md file #4

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
18552d4
chore: update readme links in readme.md file
a-klos Jan 20, 2025
cbcb1ca
Update README.md
a-klos Jan 20, 2025
a7d6313
Update README.md
a-klos Jan 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,25 +29,25 @@ 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-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-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
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/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](./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](./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

Expand All @@ -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/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).

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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).



Expand Down Expand Up @@ -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
Expand Down
Loading