Package org.springframework.ai.vectorstore.oracle

Class OracleVectorStore

java.lang.Object

org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

org.springframework.ai.vectorstore.oracle.OracleVectorStore

All Implemented Interfaces:

Consumer<List<Document>>, DocumentWriter, VectorStore, VectorStoreRetriever, org.springframework.beans.factory.InitializingBean

public class OracleVectorStore
extends AbstractObservationVectorStore
implements org.springframework.beans.factory.InitializingBean

Integration of Oracle database 23ai as a Vector Store.

With the release 23ai (23.4), the Oracle database provides numerous features useful for artificial intelligence such as Vectors, Similarity search, Vector indexes, ONNX models...

This Spring AI Vector store supports the following features:

• Vectors with unspecified or fixed dimensions
• Distance type for similarity search (note that similarity threshold can be used only with distance type COSINE and DOT when ingested vectors are normalized, see forcedNormalization)
• Vector indexes (use IVF as of 23.4)
• Exact and Approximate similarity search
• Filter expression as SQL/JSON Path expression evaluation

Author:

Loïc Lefèvre, Christian Tzolov, Soby Chacko, Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OracleVectorStore.Builder	Builder class for creating OracleVectorStore instances.
static enum	OracleVectorStore.OracleVectorStoreDistanceType
static enum	OracleVectorStore.OracleVectorStoreIndexType

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_DIMENSIONS
static final OracleVectorStore.OracleVectorStoreDistanceType	DEFAULT_DISTANCE_TYPE
static final OracleVectorStore.OracleVectorStoreIndexType	DEFAULT_INDEX_TYPE
static final int	DEFAULT_SEARCH_ACCURACY
static final String	DEFAULT_TABLE_NAME
final FilterExpressionConverter	filterExpressionConverter
static final double	SIMILARITY_THRESHOLD_EXACT_MATCH

Fields inherited from class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

batchingStrategy, embeddingModel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OracleVectorStore(OracleVectorStore.Builder builder)	Protected constructor that accepts a builder instance.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
static OracleVectorStore.Builder	builder(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate, EmbeddingModel embeddingModel)
VectorStoreObservationContext.Builder	createObservationContextBuilder(String operationName)	Create a new VectorStoreObservationContext.Builder instance.
void	doAdd(List<Document> documents)	Perform the actual add operation.
void	doDelete(List<String> idList)	Perform the actual delete operation.
protected void	doDelete(Filter.Expression filterExpression)	Template method for concrete implementations to provide filter-based deletion logic.
List<Document>	doSimilaritySearch(SearchRequest request)	Perform the actual similarity search operation.
<T> Optional<T>	getNativeClient()	Returns the native client if available in this vector store implementation.
String	getTableName()

Methods inherited from class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

add, delete, delete, similaritySearch

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.springframework.ai.document.DocumentWriter

write

Methods inherited from interface org.springframework.ai.vectorstore.VectorStore

accept, delete, getName

Methods inherited from interface org.springframework.ai.vectorstore.VectorStoreRetriever

similaritySearch

Field Details

SIMILARITY_THRESHOLD_EXACT_MATCH

public static final double SIMILARITY_THRESHOLD_EXACT_MATCH

See Also:

• Constant Field Values

DEFAULT_TABLE_NAME

public static final String DEFAULT_TABLE_NAME

See Also:

• Constant Field Values

DEFAULT_INDEX_TYPE

public static final OracleVectorStore.OracleVectorStoreIndexType DEFAULT_INDEX_TYPE

DEFAULT_DISTANCE_TYPE

public static final OracleVectorStore.OracleVectorStoreDistanceType DEFAULT_DISTANCE_TYPE

DEFAULT_DIMENSIONS

public static final int DEFAULT_DIMENSIONS

See Also:

• Constant Field Values

DEFAULT_SEARCH_ACCURACY

public static final int DEFAULT_SEARCH_ACCURACY

See Also:

• Constant Field Values

filterExpressionConverter

public final FilterExpressionConverter filterExpressionConverter

Constructor Details

OracleVectorStore

protected OracleVectorStore(OracleVectorStore.Builder builder)

Protected constructor that accepts a builder instance. This is the preferred way to create new OracleVectorStore instances.

Parameters:

builder - the configured builder instance

Method Details

builder

public static OracleVectorStore.Builder builder(org.springframework.jdbc.core.JdbcTemplate jdbcTemplate,
 EmbeddingModel embeddingModel)

doAdd

public void doAdd(List<Document> documents)

Description copied from class: AbstractObservationVectorStore

Perform the actual add operation.

Specified by:

doAdd in class AbstractObservationVectorStore

Parameters:

documents - the documents to add

doDelete

public void doDelete(List<String> idList)

Description copied from class: AbstractObservationVectorStore

Perform the actual delete operation.

Specified by:

doDelete in class AbstractObservationVectorStore

Parameters:

idList - the list of document IDs to delete

doDelete

protected void doDelete(Filter.Expression filterExpression)

Description copied from class: AbstractObservationVectorStore

Template method for concrete implementations to provide filter-based deletion logic.

Overrides:

doDelete in class AbstractObservationVectorStore

Parameters:

filterExpression - Filter expression to identify documents to delete

doSimilaritySearch

public List<Document> doSimilaritySearch(SearchRequest request)

Description copied from class: AbstractObservationVectorStore

Perform the actual similarity search operation.

Specified by:

doSimilaritySearch in class AbstractObservationVectorStore

Parameters:

request - the search request

Returns:

the list of documents that match the query request conditions

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getTableName

public String getTableName()

createObservationContextBuilder

public VectorStoreObservationContext.Builder createObservationContextBuilder(String operationName)

Description copied from class: AbstractObservationVectorStore

Create a new VectorStoreObservationContext.Builder instance.

Specified by:

createObservationContextBuilder in class AbstractObservationVectorStore

Parameters:

operationName - the operation name

Returns:

the observation context builder

getNativeClient

public <T> Optional<T> getNativeClient()

Description copied from interface: VectorStore

Returns the native client if available in this vector store implementation. Note on usage: 1. Returns empty Optional when no native client is available 2. Due to Java type erasure, runtime type checking is not possible Example usage: When working with implementation with known native client: Optional client = vectorStore.getNativeClient(); Note: Using Optionalinvalid input: '<'?> will return the native client if one exists, rather than an empty Optional. For type safety, prefer using the specific client type.

Specified by:

getNativeClient in interface VectorStore

Type Parameters:

T - The type of the native client

Returns:

Optional containing native client if available, empty Optional otherwise