Package org.springframework.ai.retriever

Class VectorStoreRetriever

java.lang.Object

org.springframework.ai.retriever.VectorStoreRetriever

All Implemented Interfaces:

Function<String,List<Document>>, DocumentRetriever

public class VectorStoreRetriever
extends Object
implements DocumentRetriever

Constructor Summary

Constructors

Constructor	Description
VectorStoreRetriever(VectorStore vectorStore)
VectorStoreRetriever(VectorStore vectorStore, int k)
VectorStoreRetriever(VectorStore vectorStore, int k, double threshold)

Method Summary

Modifier and Type	Method	Description
int	getK()
Optional<Double>	getThreshold()
VectorStore	getVectorStore()
List<Document>	retrieve(String query)	Retrieves relevant documents however the implementation sees fit.

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.DocumentRetriever

apply

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Details

VectorStoreRetriever

public VectorStoreRetriever(VectorStore vectorStore)

VectorStoreRetriever

public VectorStoreRetriever(VectorStore vectorStore,
 int k)

VectorStoreRetriever

public VectorStoreRetriever(VectorStore vectorStore,
 int k,
 double threshold)

Method Details

getVectorStore

public VectorStore getVectorStore()

getK

public int getK()

getThreshold

public Optional<Double> getThreshold()

retrieve

public List<Document> retrieve(String query)

Description copied from interface: DocumentRetriever

Retrieves relevant documents however the implementation sees fit.

Specified by:

retrieve in interface DocumentRetriever

Parameters:

query - query string

Returns:

relevant documents