Class EmbeddingSearchRequest

java.lang.Object

dev.langchain4j.store.embedding.EmbeddingSearchRequest

public class EmbeddingSearchRequest
extends Object

Represents a request to search in an EmbeddingStore.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbeddingSearchRequest.EmbeddingSearchRequestBuilder

Constructor Summary

Constructors

Constructor	Description
EmbeddingSearchRequest(Embedding queryEmbedding, Integer maxResults, Double minScore, Filter filter)	Creates an instance of an EmbeddingSearchRequest.

Method Summary

Modifier and Type	Method	Description
static EmbeddingSearchRequest.EmbeddingSearchRequestBuilder	builder()
boolean	equals(Object o)
Filter	filter()
int	hashCode()
int	maxResults()
double	minScore()
Embedding	queryEmbedding()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EmbeddingSearchRequest

public EmbeddingSearchRequest(Embedding queryEmbedding,
 Integer maxResults,
 Double minScore,
 Filter filter)

Creates an instance of an EmbeddingSearchRequest.

Parameters:

queryEmbedding - The embedding used as a reference. Found embeddings should be similar to this one. This is a mandatory parameter.

maxResults - The maximum number of embeddings to return. This is an optional parameter. Default: 3

minScore - The minimum score, ranging from 0 to 1 (inclusive). Only embeddings with a score >= minScore will be returned. This is an optional parameter. Default: 0

filter - The filter to be applied to the Metadata during search. Only TextSegments whose Metadata matches the Filter will be returned. Please note that not all EmbeddingStores support this feature yet. This is an optional parameter. Default: no filtering

Method Details

builder

public static EmbeddingSearchRequest.EmbeddingSearchRequestBuilder builder()

queryEmbedding

public Embedding queryEmbedding()

maxResults

public int maxResults()

minScore

public double minScore()

filter

public Filter filter()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object