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)
String	add(Embedding embedding, TextSegment segment)
void	add(String id, Embedding embedding)
List<String>	addAll(List<Embedding> embeddings)
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)
void	removeAll()
void	removeAll(Filter filter)
void	removeAll(Collection<String> ids)
EmbeddingSearchResult<TextSegment>	search(EmbeddingSearchRequest request)

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)

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 segment)

Specified by:

add in interface EmbeddingStore<TextSegment>

addAll

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

Specified by:

addAll in interface EmbeddingStore<TextSegment>

remove

public void remove(String id)

Specified by:

remove in interface EmbeddingStore<TextSegment>

removeAll

public void removeAll(Collection<String> ids)

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

removeAll

public void removeAll(Filter filter)

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

removeAll

public void removeAll()

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

search

public EmbeddingSearchResult<TextSegment> search(EmbeddingSearchRequest request)

Specified by:

search in interface EmbeddingStore<TextSegment>

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