Package org.springframework.ai.reader.markdown

Class MarkdownDocumentReader

java.lang.Object

org.springframework.ai.reader.markdown.MarkdownDocumentReader

All Implemented Interfaces:

Supplier<List<Document>>, DocumentReader

public class MarkdownDocumentReader
extends Object
implements DocumentReader

Reads the given Markdown resource and groups headers, paragraphs, or text divided by horizontal lines (depending on the MarkdownDocumentReaderConfig.horizontalRuleCreateDocument configuration) into Documents.

Author:

Piotr Olaszewski

Constructor Summary

Constructors

Constructor	Description
MarkdownDocumentReader(String markdownResource)
MarkdownDocumentReader(String markdownResource, MarkdownDocumentReaderConfig config)
MarkdownDocumentReader(org.springframework.core.io.Resource markdownResource, MarkdownDocumentReaderConfig config)

Method Summary

Modifier and Type	Method	Description
List<Document>	get()	Extracts and returns a list of documents from the resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.ai.document.DocumentReader

read

Constructor Details

MarkdownDocumentReader

public MarkdownDocumentReader(String markdownResource)

MarkdownDocumentReader

public MarkdownDocumentReader(String markdownResource,
 MarkdownDocumentReaderConfig config)

MarkdownDocumentReader

public MarkdownDocumentReader(org.springframework.core.io.Resource markdownResource,
 MarkdownDocumentReaderConfig config)

Method Details

get

public List<Document> get()

Extracts and returns a list of documents from the resource.

Specified by:

get in interface Supplier<List<Document>>

Returns:

List of extracted Document