Docs: Add DepthAPI project overview and extraction libs
Browse files
README.md
CHANGED
|
@@ -16,7 +16,16 @@ size_categories:
|
|
| 16 |
|
| 17 |
The **DepthAPI Technical Corpus** is a curated, high-quality retrieval corpus designed for modern RAG (Retrieval-Augmented Generation) systems. It features clean, aggressively normalized technical documentation, code snippets, engineering post-mortems, and system design literature.
|
| 18 |
|
| 19 |
-
This dataset was explicitly built to serve as the local ground-truth for the [DepthAPI](https://github.com/sanjeevafk/depthapi) project
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 20 |
|
| 21 |
## Included Data Sources
|
| 22 |
|
|
@@ -29,7 +38,11 @@ The corpus aggregates multiple highly-valued technical domains, explicitly isola
|
|
| 29 |
|
| 30 |
## Ingestion Pipeline Details
|
| 31 |
|
| 32 |
-
The corpus is powered by the **DepthAPI Declarative Ingestion Pipeline**,
|
|
|
|
|
|
|
|
|
|
|
|
|
| 33 |
|
| 34 |
Key features of the pipeline used to create this dataset:
|
| 35 |
- **Declarative Sources:** Ingestion configs declare `LocalDirSource` with strict glob matching.
|
|
|
|
| 16 |
|
| 17 |
The **DepthAPI Technical Corpus** is a curated, high-quality retrieval corpus designed for modern RAG (Retrieval-Augmented Generation) systems. It features clean, aggressively normalized technical documentation, code snippets, engineering post-mortems, and system design literature.
|
| 18 |
|
| 19 |
+
This dataset was explicitly built to serve as the local ground-truth for the [DepthAPI](https://github.com/sanjeevafk/depthapi) project.
|
| 20 |
+
|
| 21 |
+
### About the DepthAPI Project
|
| 22 |
+
DepthAPI is an enterprise-grade, declarative RAG pipeline built with asynchronous concurrency and Supabase Vector embeddings. It aims to systematize RAG data ingestion by moving away from hardcoded scripts to a configuration-driven architecture, ensuring maximum throughput, observability, and resilience.
|
| 23 |
+
|
| 24 |
+
Key features of DepthAPI include:
|
| 25 |
+
- **Plugin-based Architecture**: Easily extendable ingestion strategies via declarative configurations.
|
| 26 |
+
- **Async Concurrency**: High-throughput processing using bounded, multi-document orchestration.
|
| 27 |
+
- **Namespace Isolation**: Precise control over data organization within the vector store.
|
| 28 |
+
- **Idempotency**: Safe, hash-based upserts to avoid duplication and state corruption.
|
| 29 |
|
| 30 |
## Included Data Sources
|
| 31 |
|
|
|
|
| 38 |
|
| 39 |
## Ingestion Pipeline Details
|
| 40 |
|
| 41 |
+
The corpus is powered by the **DepthAPI Declarative Ingestion Pipeline**, moving from manual scripts to a `config.yaml` driven approach.
|
| 42 |
+
|
| 43 |
+
During the ingestion of this corpus, we heavily utilized the following open-source extraction libraries:
|
| 44 |
+
- [**Scrapling**](https://github.com/D4Vinci/Scrapling): Used for live technical documentation crawling and structured HTML extraction from documentation websites.
|
| 45 |
+
- [**opendataloader-pdf**](https://github.com/opendataloader-project/opendataloader-pdf): Used for PDF extraction when ingesting book-like and document-style technical sources into normalized markdown/text blocks.
|
| 46 |
|
| 47 |
Key features of the pipeline used to create this dataset:
|
| 48 |
- **Declarative Sources:** Ingestion configs declare `LocalDirSource` with strict glob matching.
|