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)
.
An inverted flat file (IVF) vector index is created on the embedding column. The index is named
"{tableName}_EMBEDDING_INDEX", where {tableName} is the name configured using the OracleEmbeddingStore.Builder
.
Instances of this embedding store are safe for use by multiple threads.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Builder 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.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.static OracleEmbeddingStore.Builder
builder()
Returns a builder which configures and creates instances ofOracleEmbeddingStore
.void
Removes all embeddings from the store.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 request) 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
-
Method Details
-
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.
-
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.
-
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 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.
-
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.
-
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()Description copied from interface:EmbeddingStore
Removes all embeddings from the store.- Specified by:
removeAll
in interfaceEmbeddingStore<TextSegment>
-
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 various metadata entries (e.g., user/memory ID). Please note that not allEmbeddingStore
implementations supportFilter
ing.- Specified by:
search
in interfaceEmbeddingStore<TextSegment>
- Parameters:
request
- A request to search in anEmbeddingStore
. Contains all search criteria.- Returns:
- An
EmbeddingSearchResult
containing all foundEmbedding
s.
-
builder
Returns a builder which configures and creates instances ofOracleEmbeddingStore
.- Returns:
- A builder. Not null.
-