Package dev.langchain4j.rag.content.retriever

Class EmbeddingStoreContentRetriever

java.lang.Object

dev.langchain4j.rag.content.retriever.EmbeddingStoreContentRetriever

All Implemented Interfaces:

ContentRetriever

public class EmbeddingStoreContentRetriever
extends Object
implements ContentRetriever

A ContentRetriever backed by an EmbeddingStore.
By default, this retriever fetches the 3 most similar Contents relevant to the provided Query.

Configurable parameters (optional):
- maxResults: The maximum number of Contents to retrieve.
- minScore: The minimum relevance score for the returned Contents. Contents scoring below minScore are excluded from the results.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_RESULTS
static final double	DEFAULT_MIN_SCORE

Constructor Summary

Constructors

Constructor	Description
EmbeddingStoreContentRetriever(EmbeddingStore<TextSegment> embeddingStore, EmbeddingModel embeddingModel)
EmbeddingStoreContentRetriever(EmbeddingStore<TextSegment> embeddingStore, EmbeddingModel embeddingModel, int maxResults)
EmbeddingStoreContentRetriever(EmbeddingStore<TextSegment> embeddingStore, EmbeddingModel embeddingModel, Integer maxResults, Double minScore)

Method Summary

Modifier and Type	Method	Description
List<Content>	retrieve(Query query)	Retrieves relevant Contents using a given Query.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MAX_RESULTS

public static final int DEFAULT_MAX_RESULTS

See Also:

• Constant Field Values

DEFAULT_MIN_SCORE

public static final double DEFAULT_MIN_SCORE

See Also:

• Constant Field Values

Constructor Details

EmbeddingStoreContentRetriever

public EmbeddingStoreContentRetriever(EmbeddingStore<TextSegment> embeddingStore,
 EmbeddingModel embeddingModel)

EmbeddingStoreContentRetriever

public EmbeddingStoreContentRetriever(EmbeddingStore<TextSegment> embeddingStore,
 EmbeddingModel embeddingModel,
 int maxResults)

EmbeddingStoreContentRetriever

public EmbeddingStoreContentRetriever(EmbeddingStore<TextSegment> embeddingStore,
 EmbeddingModel embeddingModel,
 Integer maxResults,
 Double minScore)

Method Details

retrieve

public List<Content> retrieve(Query query)

Description copied from interface: ContentRetriever

Retrieves relevant Contents using a given Query. The Contents are sorted by relevance, with the most relevant Contents appearing at the beginning of the returned List<Content>.

Specified by:

retrieve in interface ContentRetriever

Parameters:

query - The Query to use for retrieval.

Returns:

A list of retrieved Contents.