Package org.springframework.ai.vectorstore

Class CouchbaseSearchVectorStore

java.lang.Object

org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

org.springframework.ai.vectorstore.CouchbaseSearchVectorStore

All Implemented Interfaces:

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

public class CouchbaseSearchVectorStore
extends AbstractObservationVectorStore
implements org.springframework.beans.factory.InitializingBean, AutoCloseable

Since:

1.0.0

Author:

Laurent Doguin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CouchbaseSearchVectorStore.Builder
static final record	CouchbaseSearchVectorStore.CouchbaseDocument

Field Summary

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

batchingStrategy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CouchbaseSearchVectorStore(CouchbaseSearchVectorStore.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
static CouchbaseSearchVectorStore.Builder	builder(com.couchbase.client.java.Cluster cluster, EmbeddingModel embeddingModel)
void	close()
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.
void	doDelete(Filter.Expression filterExpression)	Template method for concrete implementations to provide filter-based deletion logic.
List<Document>	doSimilaritySearch(SearchRequest springAiRequest)	Perform the actual similarity search operation.
<T> Optional<T>	getNativeClient()	Returns the native client if available in this vector store implementation.
void	initCluster()

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, similaritySearch

Constructor Details

CouchbaseSearchVectorStore

protected CouchbaseSearchVectorStore(CouchbaseSearchVectorStore.Builder builder)

Method Details

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

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

public 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 springAiRequest)

Description copied from class: AbstractObservationVectorStore

Perform the actual similarity search operation.

Specified by:

doSimilaritySearch in class AbstractObservationVectorStore

Parameters:

springAiRequest - the search request

Returns:

the list of documents that match the query request conditions

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 Optional<?> 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

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

builder

public static CouchbaseSearchVectorStore.Builder builder(com.couchbase.client.java.Cluster cluster,
 EmbeddingModel embeddingModel)

initCluster

public void initCluster()
                 throws InterruptedException

Throws:

InterruptedException

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception