Class FullTextSearchRequest.Builder

java.lang.Object

dev.langchain4j.store.embedding.elasticsearch.FullTextSearchRequest.Builder

Enclosing class:

FullTextSearchRequest

public static class FullTextSearchRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FullTextSearchRequest	build()
FullTextSearchRequest.Builder	filter(Filter filter)	The filter to be applied to the Metadata during search.
FullTextSearchRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return.
FullTextSearchRequest.Builder	minScore(Double minScore)	The minimum relevance score.
FullTextSearchRequest.Builder	textQuery(String textQuery)	The text to search for.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

textQuery

public FullTextSearchRequest.Builder textQuery(String textQuery)

The text to search for. This is a mandatory parameter.

maxResults

public FullTextSearchRequest.Builder maxResults(Integer maxResults)

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

minScore

public FullTextSearchRequest.Builder minScore(Double minScore)

The minimum relevance score. Only results with a score >= minScore will be returned. Unlike vector search, full text search scores are not normalized: they are BM25 scores and can be greater than 1. This is an optional parameter. Default: 0

filter

public FullTextSearchRequest.Builder filter(Filter filter)

The filter to be applied to the Metadata during search. Only TextSegments whose Metadata matches the Filter will be returned. This is an optional parameter. Default: no filtering

build

public FullTextSearchRequest build()