Class ElasticsearchEmbeddingStore
java.lang.Object
dev.langchain4j.store.embedding.elasticsearch.ElasticsearchEmbeddingStore
- All Implemented Interfaces:
EmbeddingStore<TextSegment>
Represents an Elasticsearch index as an embedding store.
- See Also:
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsConstructorDescriptionElasticsearchEmbeddingStore
(ElasticsearchConfiguration configuration, String serverUrl, String apiKey, String userName, String password, String indexName) Deprecated.ElasticsearchEmbeddingStore
(ElasticsearchConfiguration configuration, String serverUrl, String apiKey, String userName, String password, String indexName, Integer dimension) ElasticsearchEmbeddingStore
(ElasticsearchConfiguration configuration, org.elasticsearch.client.RestClient restClient, String indexName) Constructor using a RestClient -
Method Summary
Modifier and TypeMethodDescriptionAdds a given embedding to the store.add
(Embedding embedding, TextSegment textSegment) Adds a given embedding and the corresponding content that has been embedded to the store.void
Adds a given embedding to the store.Adds multiple embeddings to the store.addAll
(List<Embedding> embeddings, List<TextSegment> embedded) Adds multiple embeddings and their corresponding contents that have been embedded to the store.builder()
void
The Elasticsearch implementation will simply drop the index instead of removing all documents one by one.void
Removes all embeddings that match the specifiedFilter
from the store.void
removeAll
(Collection<String> ids) Removes all embeddings that match the specified IDs from the store.search
(EmbeddingSearchRequest embeddingSearchRequest) Searches for the most similar (closest in the embedding space)Embedding
s.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, findRelevant, remove
-
Constructor Details
-
ElasticsearchEmbeddingStore
@Deprecated public ElasticsearchEmbeddingStore(ElasticsearchConfiguration configuration, String serverUrl, String apiKey, String userName, String password, String indexName, Integer dimension) 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 public ElasticsearchEmbeddingStore(ElasticsearchConfiguration configuration, String serverUrl, String apiKey, String userName, String password, String indexName) 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
-
add
Description copied from interface:EmbeddingStore
Adds a given embedding to the store.- Specified by:
add
in interfaceEmbeddingStore<TextSegment>
- Parameters:
embedding
- The embedding to be added to the store.- Returns:
- The auto-generated ID associated with the added embedding.
-
add
Description copied from interface:EmbeddingStore
Adds a given embedding to the store.- Specified by:
add
in interfaceEmbeddingStore<TextSegment>
- Parameters:
id
- The unique identifier for the embedding to be added.embedding
- The embedding to be added to the store.
-
add
Description copied from interface:EmbeddingStore
Adds a given embedding and the corresponding content that has been embedded to the store.- Specified by:
add
in interfaceEmbeddingStore<TextSegment>
- Parameters:
embedding
- The embedding to be added to the store.textSegment
- Original content that was embedded.- Returns:
- The auto-generated ID associated with the added embedding.
-
addAll
Description copied from interface:EmbeddingStore
Adds multiple embeddings to the store.- Specified by:
addAll
in interfaceEmbeddingStore<TextSegment>
- Parameters:
embeddings
- A list of embeddings to be added to the store.- Returns:
- A list of auto-generated IDs associated with the added embeddings.
-
addAll
Description copied from interface:EmbeddingStore
Adds multiple embeddings and their corresponding contents that have been embedded to the store.- Specified by:
addAll
in interfaceEmbeddingStore<TextSegment>
- Parameters:
embeddings
- A list of embeddings to be added to the store.embedded
- A list of original contents that were embedded.- Returns:
- A list of auto-generated IDs associated with the added embeddings.
-
search
Description copied from interface:EmbeddingStore
Searches for the most similar (closest in the embedding space)Embedding
s.
All search criteria are defined inside theEmbeddingSearchRequest
.
EmbeddingSearchRequest.filter()
can be used to filter by user/memory ID. Please note that not allEmbeddingStore
implementations supportFilter
ing.- Specified by:
search
in interfaceEmbeddingStore<TextSegment>
- Parameters:
embeddingSearchRequest
- A request to search in anEmbeddingStore
. Contains all search criteria.- Returns:
- An
EmbeddingSearchResult
containing all foundEmbedding
s.
-
removeAll
Description copied from interface:EmbeddingStore
Removes all embeddings that match the specified IDs from the store.- Specified by:
removeAll
in interfaceEmbeddingStore<TextSegment>
- Parameters:
ids
- A collection of unique IDs of the embeddings to be removed.
-
removeAll
Description copied from interface:EmbeddingStore
Removes all embeddings that match the specifiedFilter
from the store.- Specified by:
removeAll
in interfaceEmbeddingStore<TextSegment>
- Parameters:
filter
- The filter to be applied to theMetadata
of theTextSegment
during removal. Only embeddings whoseTextSegment
'sMetadata
match theFilter
will be removed.
-
removeAll
public void removeAll()The Elasticsearch implementation will simply drop the index instead of removing all documents one by one.- Specified by:
removeAll
in interfaceEmbeddingStore<TextSegment>
-
ElasticsearchEmbeddingStore(ElasticsearchConfiguration, RestClient, String)