Class EmbeddingSearchRequest.EmbeddingSearchRequestBuilder

java.lang.Object

dev.langchain4j.store.embedding.EmbeddingSearchRequest.EmbeddingSearchRequestBuilder

Enclosing class:

EmbeddingSearchRequest

public static class EmbeddingSearchRequest.EmbeddingSearchRequestBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
EmbeddingSearchRequest	build()
EmbeddingSearchRequest.EmbeddingSearchRequestBuilder	filter(Filter filter)	The filter to be applied to the Metadata during search.
EmbeddingSearchRequest.EmbeddingSearchRequestBuilder	maxResults(Integer maxResults)	The maximum number of embeddings to return.
EmbeddingSearchRequest.EmbeddingSearchRequestBuilder	minScore(Double minScore)	The minimum score, ranging from 0 to 1 (inclusive).
EmbeddingSearchRequest.EmbeddingSearchRequestBuilder	query(String query)	The query used for search.
EmbeddingSearchRequest.EmbeddingSearchRequestBuilder	queryEmbedding(Embedding queryEmbedding)	The embedding used as a reference.

Methods inherited from class Object

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

Method Details

query

public EmbeddingSearchRequest.EmbeddingSearchRequestBuilder query(String query)

The query used for search. This is an optional parameter that can be used by EmbeddingStore implementations to support hybrid search.

queryEmbedding

public EmbeddingSearchRequest.EmbeddingSearchRequestBuilder queryEmbedding(Embedding queryEmbedding)

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

maxResults

public EmbeddingSearchRequest.EmbeddingSearchRequestBuilder maxResults(Integer maxResults)

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

minScore

public EmbeddingSearchRequest.EmbeddingSearchRequestBuilder minScore(Double 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

public EmbeddingSearchRequest.EmbeddingSearchRequestBuilder filter(Filter 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

build

public EmbeddingSearchRequest build()