Skip to content

Commit 7dc5f19

Browse files
committed
Documentation improvements
1 parent a5682f7 commit 7dc5f19

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed
1.27 MB
Loading
15.7 KB
Loading

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/etl-pipeline.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,19 @@ The RAG use case is text to augment the capabilities of generative models by ret
88

99
== API Overview
1010

11+
The ETL pipelines creates, transforms and stores `Document` instances.
12+
13+
image::spring-ai-document1-api.jpg[Spring AI Message API, width=400, align="center"]
14+
15+
The `Document` class contains text, metadata and optionally additionall media types like images, audio and video.
16+
1117
There are three main components of the ETL pipeline,
1218

1319
* `DocumentReader` that implements `Supplier<List<Document>>`
1420
* `DocumentTransformer` that implements `Function<List<Document>, List<Document>>`
1521
* `DocumentWriter` that implements `Consumer<List<Document>>`
1622

17-
The `Document` class contains text and metadata and is created from PDFs, text files and other document types via the `DocumentReader`.
23+
The `Document` class content is created from PDFs, text files and other document types throught the help of `DocumentReader`.
1824

1925
To construct a simple ETL pipeline, you can chain together an instance of each type.
2026

0 commit comments

Comments
 (0)