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 that retrieves from an EmbeddingStore.
By default, it retrieves the 3 most similar Contents to the provided Query, without any Filtering.

Configurable parameters (optional):
- displayName: Display name for logging purposes, e.g. when multiple instances are used.
- maxResults: The maximum number of Contents to retrieve.
- dynamicMaxResults: It is a Function that accepts a Query and returns a maxResults value. It can be used to dynamically define maxResults value, depending on factors such as the query, the user (using Metadata#chatMemoryId()} from Query.metadata()), etc.
- minScore: The minimum relevance score for the returned Contents. Contents scoring below #minScore are excluded from the results.
- dynamicMinScore: It is a Function that accepts a Query and returns a minScore value. It can be used to dynamically define minScore value, depending on factors such as the query, the user (using Metadata#chatMemoryId()} from Query.metadata()), etc.
- filter: The Filter that will be applied to a Metadata in the Content.textSegment().
- dynamicFilter: It is a Function that accepts a Query and returns a filter value. It can be used to dynamically define filter value, depending on factors such as the query, the user (using Metadata#chatMemoryId()} from Query.metadata()), etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbeddingStoreContentRetriever.EmbeddingStoreContentRetrieverBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_DISPLAY_NAME
static final Function<Query,Filter>	DEFAULT_FILTER
static final Function<Query,Integer>	DEFAULT_MAX_RESULTS
static final Function<Query,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
static EmbeddingStoreContentRetriever	from(EmbeddingStore<TextSegment> embeddingStore)	Creates an instance of an EmbeddingStoreContentRetriever from the specified EmbeddingStore and EmbeddingModel found through SPI (see EmbeddingModelFactory).
List<Content>	retrieve(Query query)	Retrieves relevant Contents using a given Query.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MAX_RESULTS

public static final Function<Query,Integer> DEFAULT_MAX_RESULTS

DEFAULT_MIN_SCORE

public static final Function<Query,Double> DEFAULT_MIN_SCORE

DEFAULT_FILTER

public static final Function<Query,Filter> DEFAULT_FILTER

DEFAULT_DISPLAY_NAME

public static final String DEFAULT_DISPLAY_NAME

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

from

public static EmbeddingStoreContentRetriever from(EmbeddingStore<TextSegment> embeddingStore)

Creates an instance of an EmbeddingStoreContentRetriever from the specified EmbeddingStore and EmbeddingModel found through SPI (see EmbeddingModelFactory).

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.

toString

public String toString()

Overrides:

toString in class Object