Class ElasticsearchEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.elasticsearch.AbstractElasticsearchEmbeddingStore

dev.langchain4j.store.embedding.elasticsearch.ElasticsearchEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>

public class ElasticsearchEmbeddingStore
extends AbstractElasticsearchEmbeddingStore
implements EmbeddingStore<TextSegment>

Represents an Elasticsearch index as an embedding store.

See Also:

• for the exact brute force implementation (slower - 100% accurate)
• for the knn search implementation (faster - approximative)
  Supports storing Metadata and filtering by it using Filter (provided inside EmbeddingSearchRequest).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElasticsearchEmbeddingStore.Builder

Field Summary

Fields inherited from class AbstractElasticsearchEmbeddingStore

client, configuration, indexName

Constructor Summary

Constructors

Constructor	Description
ElasticsearchEmbeddingStore(ElasticsearchConfiguration configuration, String serverUrl, String apiKey, String userName, String password, String indexName)	Deprecated, for removal: This API element is subject to removal in a future version. by ElasticsearchEmbeddingStore(ElasticsearchConfiguration, RestClient, String)
ElasticsearchEmbeddingStore(ElasticsearchConfiguration configuration, String serverUrl, String apiKey, String userName, String password, String indexName, Integer dimension)	Deprecated, for removal: This API element is subject to removal in a future version. by ElasticsearchEmbeddingStore(ElasticsearchConfiguration, RestClient, String)
ElasticsearchEmbeddingStore(ElasticsearchConfiguration configuration, org.elasticsearch.client.RestClient restClient, String indexName)	Constructor using a RestClient

Method Summary

Modifier and Type	Method	Description
static ElasticsearchEmbeddingStore.Builder	builder()

Methods inherited from class AbstractElasticsearchEmbeddingStore

add, add, add, add, add, addAll, addAll, addAllText, fullTextSearch, hybridSearch, initialize, removeAll, removeAll, removeAll, search

Methods inherited from class Object

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

Methods inherited from interface EmbeddingStore

add, add, add, addAll, addAll, addAll, addListener, addListeners, generateIds, remove, removeAll, removeAll, removeAll, search

Constructor Details

ElasticsearchEmbeddingStore

@Deprecated(forRemoval=true)
public ElasticsearchEmbeddingStore(ElasticsearchConfiguration configuration,
 String serverUrl,
 String apiKey,
 String userName,
 String password,
 String indexName,
 Integer dimension)

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

by ElasticsearchEmbeddingStore(ElasticsearchConfiguration, RestClient, String)

Creates an instance of ElasticsearchEmbeddingStore.

Parameters:

configuration - Elasticsearch configuration to use (Knn or Script)

serverUrl - Elasticsearch Server URL (mandatory)

apiKey - Elasticsearch API key (optional)

userName - Elasticsearch userName (optional)

password - Elasticsearch password (optional)

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

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

ElasticsearchEmbeddingStore

@Deprecated(forRemoval=true)
public ElasticsearchEmbeddingStore(ElasticsearchConfiguration configuration,
 String serverUrl,
 String apiKey,
 String userName,
 String password,
 String indexName)

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

by ElasticsearchEmbeddingStore(ElasticsearchConfiguration, RestClient, String)

Creates an instance of ElasticsearchEmbeddingStore.

Parameters:

configuration - Elasticsearch configuration to use (Knn or Script)

serverUrl - Elasticsearch Server URL (mandatory)

apiKey - Elasticsearch API key (optional)

userName - Elasticsearch userName (optional)

password - Elasticsearch password (optional)

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

ElasticsearchEmbeddingStore

public ElasticsearchEmbeddingStore(ElasticsearchConfiguration configuration,
 org.elasticsearch.client.RestClient restClient,
 String indexName)

Constructor using a RestClient

Parameters:

configuration - Elasticsearch configuration to use (Knn or Script)

restClient - Elasticsearch Rest Client (mandatory)

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

Method Details

builder

public static ElasticsearchEmbeddingStore.Builder builder()