Package org.springframework.ai.rag.retrieval.source

Interface DocumentRetriever

All Superinterfaces:

Function<Query,List<Document>>

All Known Implementing Classes:

VectorStoreDocumentRetriever

public interface DocumentRetriever
extends Function<Query,List<Document>>

API for retrieving Documents from an underlying data source.

Since:

1.0.0

Author:

Christian Tzolov, Thomas Vitale

Method Summary

Modifier and Type	Method	Description
default List<Document>	apply(Query query)	Retrieves Documents from an underlying data source using the given Query.
default List<Document>	retrieve(String query)	Retrieves Documents from an underlying data source using the given query string.
List<Document>	retrieve(Query query)	Retrieves Documents from an underlying data source using the given Query.

Methods inherited from interface java.util.function.Function

andThen, compose

Method Details

retrieve

List<Document> retrieve(Query query)

Retrieves Documents from an underlying data source using the given Query.

retrieve

default List<Document> retrieve(String query)

Retrieves Documents from an underlying data source using the given query string.

apply

default List<Document> apply(Query query)

Retrieves Documents from an underlying data source using the given Query.

Specified by:

apply in interface Function<Query,List<Document>>