Class ElasticsearchContentRetriever.Builder

java.lang.Object

dev.langchain4j.rag.content.retriever.elasticsearch.ElasticsearchContentRetriever.Builder

Enclosing class:

ElasticsearchContentRetriever

public static class ElasticsearchContentRetriever.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ElasticsearchContentRetriever	build()
ElasticsearchContentRetriever.Builder	client(co.elastic.clients.elasticsearch.ElasticsearchClient client)
ElasticsearchContentRetriever.Builder	configuration(ElasticsearchConfiguration configuration)
ElasticsearchContentRetriever.Builder	embeddingModel(EmbeddingModel embeddingModel)
ElasticsearchContentRetriever.Builder	filter(Filter filter)
ElasticsearchContentRetriever.Builder	indexName(String indexName)
ElasticsearchContentRetriever.Builder	maxResults(int maxResults)
ElasticsearchContentRetriever.Builder	minScore(double minScore)
ElasticsearchContentRetriever.Builder	refresh(co.elastic.clients.elasticsearch._types.Refresh refresh)	Controls when documents written or removed by ID become visible to search.
ElasticsearchContentRetriever.Builder	restClient(org.elasticsearch.client.RestClient restClient)	Deprecated, for removal: This API element is subject to removal in a future version. Use client(ElasticsearchClient) instead.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

restClient

@Deprecated(forRemoval=true)
public ElasticsearchContentRetriever.Builder restClient(org.elasticsearch.client.RestClient restClient)

Deprecated, for removal: This API element is subject to removal in a future version.

Use client(ElasticsearchClient) instead.

Parameters:

restClient - Elasticsearch RestClient.

Returns:

builder

client

public ElasticsearchContentRetriever.Builder client(co.elastic.clients.elasticsearch.ElasticsearchClient client)

Parameters:

client - Elasticsearch Client.

Returns:

builder

indexName

public ElasticsearchContentRetriever.Builder indexName(String indexName)

Parameters:

indexName - Elasticsearch index name (optional). Default value: "default".

Returns:

builder

configuration

public ElasticsearchContentRetriever.Builder configuration(ElasticsearchConfiguration configuration)

Parameters:

configuration - the configuration to use

Returns:

builder

embeddingModel

public ElasticsearchContentRetriever.Builder embeddingModel(EmbeddingModel embeddingModel)

maxResults

public ElasticsearchContentRetriever.Builder maxResults(int maxResults)

minScore

public ElasticsearchContentRetriever.Builder minScore(double minScore)

filter

public ElasticsearchContentRetriever.Builder filter(Filter filter)

refresh

public ElasticsearchContentRetriever.Builder refresh(co.elastic.clients.elasticsearch._types.Refresh refresh)

Controls when documents written or removed by ID become visible to search. Searches and filtered removal are not affected.

Parameters:

refresh - Refresh.False (default) leaves refreshing to Elasticsearch, Refresh.True refreshes immediately after the request, and Refresh.WaitFor waits for a refresh before the request returns.

Returns:

builder

build

public ElasticsearchContentRetriever build()