Package dev.langchain4j.store.embedding.oracle

Class OracleEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.oracle.OracleEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>

public final class OracleEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>

An EmbeddingStore which uses AI Vector Search capabilities of Oracle Database. This embedding store supports metadata filtering and removal

Instances of this store are created by configuring a builder:

 EmbeddingStore<TextSegment> example(DataSource dataSource) {
   return OracleEmbeddingStore.builder()
     .dataSource(dataSource)
     .embeddingTable("example")
     .build();
 }
 

It is recommended to configure a DataSource which pools connections, such as the Universal Connection Pool (UCP) or Hikari. A connection pool will avoid the latency of repeatedly creating new database connections.

This embedding store requires a EmbeddingTable to be configured with OracleEmbeddingStore.Builder.embeddingTable(String). If the table does not already exist, it can be created by passing a CreateOption to OracleEmbeddingStore.Builder.embeddingTable(String, CreateOption) or to EmbeddingTable.Builder.createOption(CreateOption).

By default no index is created on the EmbeddingTable. The OracleEmbeddingStore.Builder.index(Index...) allows to create indexes on the embedding and metadata columns of the embedding table. Two builders allow to configure an Index: IVFIndexBuilder to configure an IVF index on the embedding column and JSONIndexBuilder to configure function-based indexes on keys of the metadata column.

Instances of this embedding store are safe for use by multiple threads.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OracleEmbeddingStore.Builder	Builder which configures and creates instances of OracleEmbeddingStore.

Method Summary

Modifier and Type	Method	Description
String	add(Embedding embedding)	Adds a given embedding to the store.
String	add(Embedding embedding, TextSegment textSegment)	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> embedded)	Adds multiple embeddings and their corresponding contents that have been embedded to the store.
static OracleEmbeddingStore.Builder	builder()	Returns a builder which configures and creates instances of OracleEmbeddingStore.
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 java.lang.Object

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

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

addAll, findRelevant, findRelevant, findRelevant, findRelevant, generateIds, remove

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.

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.

add

public String add(Embedding embedding,
 TextSegment textSegment)

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.

textSegment - Original content that was embedded.

Returns:

The auto-generated ID associated with the added embedding.

addAll

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

Description copied from interface: EmbeddingStore

Adds multiple embeddings and their corresponding contents that have been embedded to the store.

Specified by:

addAll in interface EmbeddingStore<TextSegment>

Parameters:

ids - A list of IDs associated with the added embeddings.

embeddings - A list of embeddings to be added to the store.

embedded - A list of original contents that were embedded.

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.

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.

builder

public static OracleEmbeddingStore.Builder builder()

Returns a builder which configures and creates instances of OracleEmbeddingStore.

Returns:

A builder. Not null.