Package dev.langchain4j.store.embedding.elasticsearch

Class ElasticsearchEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.elasticsearch.ElasticsearchEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>

public class ElasticsearchEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>

Represents an Elasticsearch index as an embedding store. Current implementation assumes the index uses the cosine distance metric.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElasticsearchEmbeddingStore.Builder

Constructor Summary

Constructors

Constructor	Description
ElasticsearchEmbeddingStore(String serverUrl, String apiKey, String userName, String password, String indexName, Integer dimension)	Creates an instance of ElasticsearchEmbeddingStore.
ElasticsearchEmbeddingStore(org.elasticsearch.client.RestClient restClient, String indexName, Integer dimension)

Method Summary

Modifier and Type	Method	Description
String	add(Embedding embedding)
String	add(Embedding embedding, TextSegment textSegment)
void	add(String id, Embedding embedding)
List<String>	addAll(List<Embedding> embeddings)
List<String>	addAll(List<Embedding> embeddings, List<TextSegment> embedded)
static ElasticsearchEmbeddingStore.Builder	builder()
List<EmbeddingMatch<TextSegment>>	findRelevant(Embedding referenceEmbedding, int maxResults, double minScore)

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.store.embedding.EmbeddingStore

findRelevant, findRelevant, findRelevant

Constructor Details

ElasticsearchEmbeddingStore

public ElasticsearchEmbeddingStore(String serverUrl,
 String apiKey,
 String userName,
 String password,
 String indexName,
 Integer dimension)

Creates an instance of ElasticsearchEmbeddingStore.

Parameters:

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

public ElasticsearchEmbeddingStore(org.elasticsearch.client.RestClient restClient,
 String indexName,
 Integer dimension)

Method Details

builder

public static ElasticsearchEmbeddingStore.Builder builder()

add

public String add(Embedding embedding)

Specified by:

add in interface EmbeddingStore<TextSegment>

add

public void add(String id,
 Embedding embedding)

Specified by:

add in interface EmbeddingStore<TextSegment>

add

public String add(Embedding embedding,
 TextSegment textSegment)

Specified by:

add in interface EmbeddingStore<TextSegment>

addAll

public List<String> addAll(List<Embedding> embeddings)

Specified by:

addAll in interface EmbeddingStore<TextSegment>

addAll

public List<String> addAll(List<Embedding> embeddings,
 List<TextSegment> embedded)

Specified by:

addAll in interface EmbeddingStore<TextSegment>

findRelevant

public List<EmbeddingMatch<TextSegment>> findRelevant(Embedding referenceEmbedding,
 int maxResults,
 double minScore)

Specified by:

findRelevant in interface EmbeddingStore<TextSegment>