Skip to content

Commit 6fc7226

Browse files
committed
added ingestion service architecture overview
1 parent 021dc22 commit 6fc7226

File tree

3 files changed

+20
-2
lines changed

3 files changed

+20
-2
lines changed
73.9 KB
Loading

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This document is currently under development. The content is expected to undergo
1010
This book is also expected to replace the [BrainKB design document](https://github.com/sensein/brainkb-design-document/tree/design-doc).
1111
```
1212

13-
**Last Updated:** `February 09, 2025`
13+
**Last Updated:** `March 03, 2025`
1414

1515
## Purpose of the book
1616
- **Comprehensive Resource on BrainKB:** To provide detailed information about BrainKB, including its guiding principles, architecture, and service components.

docs/ingestion_service.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
11
# Ingestion service
22

3-
# Ingestion Service Flow Diagram
3+
{numref}`brainkb_intestion_architecture_figure` illustrates the architecture of the ingestion service, which follows the producer-consumer pattern and leverages RabbitMQ for scalable data ingestion. The service is composed of two main components: (i) the producer and (ii) the consumer.
4+
The producer component exposes API endpoints (see {numref}`brainkb_ingestion_service_api_endpoints`) that allow clients or users to ingest data. Currently, it supports the ingestion of KGs represented in JSON-LD and Turtle formats. Users can ingest raw JSON-LD data as well as upload files, either individually or in batches. At present, the ingestion of other file types, such as PDF, text, and JSON, has been disabled due to the incomplete implementation of the required functionalities.
5+
6+
7+
8+
```{figure} images/ingest.png
9+
:name: brainkb_intestion_architecture_figure
10+
Architecture of Ingestion Service.
11+
```
12+
13+
```{figure} images/api_endpoints_ingestion_service.png
14+
:name: brainkb_ingestion_service_api_endpoints
15+
Currently Enabled API Endpoints.
16+
```
17+
18+
19+
20+
21+
## Sequence Diagram
422

523
```{mermaid}
624
sequenceDiagram

0 commit comments

Comments
 (0)