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 markdownResources)	Create a new MarkdownDocumentReader instance.
MarkdownDocumentReader(String markdownResources, MarkdownDocumentReaderConfig config)	Create a new MarkdownDocumentReader instance.
MarkdownDocumentReader(List<org.springframework.core.io.Resource> markdownResources, MarkdownDocumentReaderConfig config)	Create a new MarkdownDocumentReader instance using already resolved resources.
MarkdownDocumentReader(org.springframework.core.io.Resource markdownResource, MarkdownDocumentReaderConfig config)	Create a new MarkdownDocumentReader instance using a single Resource.

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 markdownResources)

Create a new MarkdownDocumentReader instance.

Parameters:

markdownResources - the resources to read, will be resolved via PathMatchingResourcePatternResolver

MarkdownDocumentReader

public MarkdownDocumentReader(String markdownResources,
 MarkdownDocumentReaderConfig config)

Create a new MarkdownDocumentReader instance.

Parameters:

markdownResources - the resources to read, will be resolved via PathMatchingResourcePatternResolver

config - the configuration to use

MarkdownDocumentReader

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

Create a new MarkdownDocumentReader instance using a single Resource.

Parameters:

markdownResource - the resource to read

MarkdownDocumentReader

public MarkdownDocumentReader(List<org.springframework.core.io.Resource> markdownResources,
 MarkdownDocumentReaderConfig config)

Create a new MarkdownDocumentReader instance using already resolved resources.

Parameters:

markdownResources - the resources to read

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