Package dev.langchain4j.store.embedding.elasticsearch

Class ElasticsearchEmbeddingStore.Builder

java.lang.Object

dev.langchain4j.store.embedding.elasticsearch.ElasticsearchEmbeddingStore.Builder

Enclosing class:

ElasticsearchEmbeddingStore

public static class ElasticsearchEmbeddingStore.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ElasticsearchEmbeddingStore.Builder	apiKey(String apiKey)
ElasticsearchEmbeddingStore	build()
ElasticsearchEmbeddingStore.Builder	dimension(Integer dimension)
ElasticsearchEmbeddingStore.Builder	indexName(String indexName)
ElasticsearchEmbeddingStore.Builder	password(String password)
ElasticsearchEmbeddingStore.Builder	restClient(org.elasticsearch.client.RestClient restClient)
ElasticsearchEmbeddingStore.Builder	serverUrl(String serverUrl)
ElasticsearchEmbeddingStore.Builder	userName(String userName)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

serverUrl

public ElasticsearchEmbeddingStore.Builder serverUrl(String serverUrl)

Parameters:

serverUrl - Elasticsearch Server URL

Returns:

builder

apiKey

public ElasticsearchEmbeddingStore.Builder apiKey(String apiKey)

Parameters:

apiKey - Elasticsearch API key (optional)

Returns:

builder

userName

public ElasticsearchEmbeddingStore.Builder userName(String userName)

Parameters:

userName - Elasticsearch userName (optional)

Returns:

builder

password

public ElasticsearchEmbeddingStore.Builder password(String password)

Parameters:

password - Elasticsearch password (optional)

Returns:

builder

restClient

public ElasticsearchEmbeddingStore.Builder restClient(org.elasticsearch.client.RestClient restClient)

Parameters:

restClient - Elasticsearch RestClient (optional). Effectively overrides all other connection parameters like serverUrl, etc.

Returns:

builder

indexName

public ElasticsearchEmbeddingStore.Builder indexName(String indexName)

Parameters:

indexName - Elasticsearch index name (optional). Default value: "default". Index will be created automatically if not exists.

Returns:

builder

dimension

public ElasticsearchEmbeddingStore.Builder dimension(Integer dimension)

Parameters:

dimension - Embedding vector dimension (mandatory when index does not exist yet).

Returns:

builder

build

public ElasticsearchEmbeddingStore build()