Class OracleEmbeddingStore
- All Implemented Interfaces:
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 ClassesModifier and TypeClassDescriptionstatic classBuilder which configures and creates instances ofOracleEmbeddingStore. -
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.voidAdds a given embedding to the store.Adds multiple embeddings to the store.voidAdds multiple embeddings and their corresponding contents that have been embedded to the store.static OracleEmbeddingStore.Builderbuilder()Returns a builder which configures and creates instances ofOracleEmbeddingStore.voidRemoves all embeddings from the store.voidRemoves all embeddings that match the specifiedFilterfrom the store.voidremoveAll(Collection<String> ids) Removes all embeddings that match the specified IDs from the store.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, waitMethods inherited from interface EmbeddingStore
addAll, generateIds, remove
-
Method Details
-
add
Description copied from interface:EmbeddingStoreAdds a given embedding to the store.- Specified by:
addin interfaceEmbeddingStore<TextSegment>- Parameters:
embedding- The embedding to be added to the store.- Returns:
- The auto-generated ID associated with the added embedding.
-
addAll
Description copied from interface:EmbeddingStoreAdds multiple embeddings to the store.- Specified by:
addAllin 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.
-
add
Description copied from interface:EmbeddingStoreAdds a given embedding and the corresponding content that has been embedded to the store.- Specified by:
addin 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:EmbeddingStoreAdds multiple embeddings and their corresponding contents that have been embedded to the store.- Specified by:
addAllin interfaceEmbeddingStore<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
Description copied from interface:EmbeddingStoreAdds a given embedding to the store.- Specified by:
addin interfaceEmbeddingStore<TextSegment>- Parameters:
id- The unique identifier for the embedding to be added.embedding- The embedding to be added to the store.
-
removeAll
Description copied from interface:EmbeddingStoreRemoves all embeddings that match the specified IDs from the store.- Specified by:
removeAllin interfaceEmbeddingStore<TextSegment>- Parameters:
ids- A collection of unique IDs of the embeddings to be removed.
-
removeAll
Description copied from interface:EmbeddingStoreRemoves all embeddings that match the specifiedFilterfrom the store.- Specified by:
removeAllin interfaceEmbeddingStore<TextSegment>- Parameters:
filter- The filter to be applied to theMetadataof theTextSegmentduring removal. Only embeddings whoseTextSegment'sMetadatamatch theFilterwill be removed.
-
removeAll
public void removeAll()Description copied from interface:EmbeddingStoreRemoves all embeddings from the store.- Specified by:
removeAllin interfaceEmbeddingStore<TextSegment>
-
search
Description copied from interface:EmbeddingStoreSearches for the most similar (closest in the embedding space)Embeddings.
All search criteria are defined inside theEmbeddingSearchRequest.
EmbeddingSearchRequest.filter()can be used to filter by various metadata entries (e.g., user/memory ID). Please note that not allEmbeddingStoreimplementations supportFiltering.- Specified by:
searchin interfaceEmbeddingStore<TextSegment>- Parameters:
request- A request to search in anEmbeddingStore. Contains all search criteria.- Returns:
- An
EmbeddingSearchResultcontaining all foundEmbeddings.
-
builder
Returns a builder which configures and creates instances ofOracleEmbeddingStore.- Returns:
- A builder. Not null.
-