Skip to content

Commit 7fdbfd8

Browse files
committed
docs: update README files to include links for services and clarify responsibilities
1 parent e82beac commit 7fdbfd8

2 files changed

Lines changed: 10 additions & 5 deletions

File tree

libs/admin-api-lib/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Document lifecycle orchestration for the STACKIT RAG template. This library exposes a FastAPI-compatible admin surface that receives raw user content, coordinates extraction, summarisation, chunking, and storage, and finally hands normalized information pieces to the core RAG API.
44

5-
It powers the `services/admin-backend` deployment and is the primary integration point for operators managing their document corpus.
5+
It powers the [`services/admin-backend`](https://github.com/stackitcloud/rag-template/tree/main/services/admin-backend) deployment and is the primary integration point for operators managing their document corpus.
66

77
## Responsibilities
88

libs/rag-core-api/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
# rag-core-api
22

3-
High-level API layer for the STACKIT RAG template. It transforms its own primitives and those from [`rag-core-lib`](../rag-core-lib/) into a production-ready FastAPI surface, exposing chat, evaluation, and document-management endpoints used by `services/rag-backend` and the MCP server of the [`RAG-Template`](https://github.com/stackitcloud/rag-template).
3+
High-level API layer for the STACKIT [`RAG-Template`](https://github.com/stackitcloud/rag-template). It transforms its own primitives and those from [`rag-core-lib`](../rag-core-lib/) into a production-ready FastAPI surface, exposing chat, evaluation, and document-management endpoints used by [`services/rag-backend`](https://github.com/stackitcloud/rag-template/tree/main/services/rag-backend) and the MCP server of the `RAG-Template`.
44

5-
`rag-core-api` composes a dependency-injector container that wires together LLMs, embeddings, vector stores, rerankers, retrievers, API endpoints and more. The shared logic (LLMs, embeddings, tracing etc.) comes from [`rag-core-lib`](../rag-core-lib/). Technically, `rag-core-api` ships a fully functional FastAPI app that can be run directly, but it can be also embedded in custom services or extended with new logic, see the [services of the RAG-Template repository](https://github.com/stackitcloud/rag-template/tree/main/services).
5+
## Responsibilities
66

7-
## Highlights
7+
- **Dependency Injection** – Compose the dependency-injector container to assemble LLMs, embeddings, vector stores, rerankers, and retrievers from [`rag-core-lib`](../rag-core-lib/).
8+
- **API Exposure** – Expose production-ready FastAPI routers for chat, evaluation, and information piece management.
9+
- **Chat Orchestration** – Provide default LangGraph chat orchestration and evaluation pipelines that downstream services can reuse or override.
10+
- **Knowledge base integration** – Manages all interaction with the knowledge base (vector database).
11+
12+
## Feature highlights
813

914
- **Chat graph built on LangGraph** – Default `DefaultChatGraph` stitches together language detection, question rephrasing, retrieval (with reranking), answer generation, and Langfuse tracing.
1015
- **Evaluation endpoint** – Ships a Langfuse + RAGAS evaluator so you can score QA datasets against your RAG stack without custom plumbing.
@@ -66,7 +71,7 @@ Refer to [`libs/README.md`](../README.md#1-rag-core-api) for in-depth API docume
6671

6772
The Helm chart supplies these values through `backend.envs.*`. Local development can rely on `.env` configuration (see repository root documentation).
6873

69-
## Quick start
74+
## Typical usage
7075

7176
```python
7277
from rag_core_api.main import app as perfect_rag_app

0 commit comments

Comments
 (0)