Class CoherenceEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.coherence.CoherenceEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>

public class CoherenceEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>

An EmbeddingStore backed by an Oracle Coherence NamedMap.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CoherenceEmbeddingStore.Builder	A builder to create CoherenceEmbeddingStore instances.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MAP_NAME	The default NamedMap name.
protected final com.tangosol.net.NamedMap<com.oracle.coherence.ai.DocumentChunk.Id, com.oracle.coherence.ai.DocumentChunk>	documentChunks	The NamedMap used to store the document chunks.
protected final boolean	normalizeEmbeddings

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CoherenceEmbeddingStore(com.tangosol.net.NamedMap<com.oracle.coherence.ai.DocumentChunk.Id, com.oracle.coherence.ai.DocumentChunk> namedMap, boolean normalizeEmbeddings)	Create an CoherenceEmbeddingStore.

Method Summary

Modifier and Type	Method	Description
String	add(Embedding embedding)	Adds a given embedding to the store.
String	add(Embedding embedding, TextSegment segment)	Adds a given embedding and the corresponding content that has been embedded to the store.
void	add(String id, Embedding embedding)	Adds a given embedding to the store.
List<String>	addAll(List<Embedding> embeddings)	Adds multiple embeddings to the store.
void	addAll(List<String> ids, List<Embedding> embeddings, List<TextSegment> segments)	Add multiple Embedding instances to the repository.
static CoherenceEmbeddingStore.Builder	builder()	Return a CoherenceEmbeddingStore.Builder to use to build a CoherenceEmbeddingStore.
static CoherenceEmbeddingStore	create()	Create a default CoherenceEmbeddingStore.
static CoherenceEmbeddingStore	create(com.tangosol.net.NamedMap<com.oracle.coherence.ai.DocumentChunk.Id, com.oracle.coherence.ai.DocumentChunk> map)	Create a CoherenceEmbeddingStore that uses the specified Coherence NamedMap name.
static CoherenceEmbeddingStore	create(String name)	Create a CoherenceEmbeddingStore that uses the specified Coherence NamedMap name.
void	remove(String id)	Removes a single embedding from the store by ID.
void	removeAll()	Removes all embeddings from the store.
void	removeAll(Filter filter)	Removes all embeddings that match the specified Filter from the store.
void	removeAll(Collection<String> ids)	Removes all embeddings that match the specified IDs from the store.
EmbeddingSearchResult<TextSegment>	search(EmbeddingSearchRequest request)	Searches for the most similar (closest in the embedding space) Embeddings.

Methods inherited from class Object

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

Methods inherited from interface EmbeddingStore

addAll, generateIds

Field Details

DEFAULT_MAP_NAME

public static final String DEFAULT_MAP_NAME

The default NamedMap name.

See Also:

• Constant Field Values

documentChunks

protected final com.tangosol.net.NamedMap<com.oracle.coherence.ai.DocumentChunk.Id, com.oracle.coherence.ai.DocumentChunk> documentChunks

The NamedMap used to store the document chunks.

normalizeEmbeddings

protected final boolean normalizeEmbeddings

Constructor Details

CoherenceEmbeddingStore

protected CoherenceEmbeddingStore(com.tangosol.net.NamedMap<com.oracle.coherence.ai.DocumentChunk.Id, com.oracle.coherence.ai.DocumentChunk> namedMap,
 boolean normalizeEmbeddings)

Create an CoherenceEmbeddingStore.

This method is protected, instances of CoherenceEmbeddingStore are created using the builder.

Parameters:

namedMap - the NamedMap to contain the document chunks

normalizeEmbeddings - true if this CoherenceEmbeddingStore should call Embedding.normalize() on embeddings when adding or searching

Method Details

add

public String add(Embedding embedding)

Description copied from interface: EmbeddingStore

Adds a given embedding to the store.

Specified by:

add in interface EmbeddingStore<TextSegment>

Parameters:

embedding - The embedding to be added to the store.

Returns:

The auto-generated ID associated with the added embedding.

add

public void add(String id,
 Embedding embedding)

Description copied from interface: EmbeddingStore

Adds a given embedding to the store.

Specified by:

add in interface EmbeddingStore<TextSegment>

Parameters:

id - The unique identifier for the embedding to be added.

embedding - The embedding to be added to the store.

add

public String add(Embedding embedding,
 TextSegment segment)

Description copied from interface: EmbeddingStore

Adds a given embedding and the corresponding content that has been embedded to the store.

Specified by:

add in interface EmbeddingStore<TextSegment>

Parameters:

embedding - The embedding to be added to the store.

segment - Original content that was embedded.

Returns:

The auto-generated ID associated with the added embedding.

addAll

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

Description copied from interface: EmbeddingStore

Adds multiple embeddings to the store.

Specified by:

addAll in interface EmbeddingStore<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.

remove

public void remove(String id)

Description copied from interface: EmbeddingStore

Removes a single embedding from the store by ID.

Specified by:

remove in interface EmbeddingStore<TextSegment>

Parameters:

id - The unique ID of the embedding to be removed.

removeAll

public void removeAll(Collection<String> ids)

Description copied from interface: EmbeddingStore

Removes all embeddings that match the specified IDs from the store.

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

Parameters:

ids - A collection of unique IDs of the embeddings to be removed.

removeAll

public void removeAll(Filter filter)

Description copied from interface: EmbeddingStore

Removes all embeddings that match the specified Filter from the store.

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

Parameters:

filter - The filter to be applied to the Metadata of the TextSegment during removal. Only embeddings whose TextSegment's Metadata match the Filter will be removed.

removeAll

public void removeAll()

Description copied from interface: EmbeddingStore

Removes all embeddings from the store.

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

search

public EmbeddingSearchResult<TextSegment> search(EmbeddingSearchRequest request)

Description copied from interface: EmbeddingStore

Searches for the most similar (closest in the embedding space) Embeddings.
All search criteria are defined inside the EmbeddingSearchRequest.
EmbeddingSearchRequest.filter() can be used to filter by various metadata entries (e.g., user/memory ID). Please note that not all EmbeddingStore implementations support Filtering.

Specified by:

search in interface EmbeddingStore<TextSegment>

Parameters:

request - A request to search in an EmbeddingStore. Contains all search criteria.

Returns:

An EmbeddingSearchResult containing all found Embeddings.

addAll

public void addAll(List<String> ids,
 List<Embedding> embeddings,
 List<TextSegment> segments)

Add multiple Embedding instances to the repository.

Specified by:

addAll in interface EmbeddingStore<TextSegment>

Parameters:

ids - the list of identifiers to use for each of the Embedding

embeddings - the Embedding to add

segments - an optional list of TextSegment to add with the embeddings

create

public static CoherenceEmbeddingStore create()

Create a default CoherenceEmbeddingStore.

Returns:

a default CoherenceEmbeddingStore

create

public static CoherenceEmbeddingStore create(String name)

Create a CoherenceEmbeddingStore that uses the specified Coherence NamedMap name.

Parameters:

name - the name of the Coherence NamedMap used to store documents

Returns:

a CoherenceEmbeddingStore

create

public static CoherenceEmbeddingStore create(com.tangosol.net.NamedMap<com.oracle.coherence.ai.DocumentChunk.Id, com.oracle.coherence.ai.DocumentChunk> map)

Create a CoherenceEmbeddingStore that uses the specified Coherence NamedMap name.

Parameters:

map - the NamedMap used to store documents

Returns:

a CoherenceEmbeddingStore

builder

public static CoherenceEmbeddingStore.Builder builder()

Return a CoherenceEmbeddingStore.Builder to use to build a CoherenceEmbeddingStore.

Returns:

a CoherenceEmbeddingStore.Builder to use to build a CoherenceEmbeddingStore