Class CouchbaseEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.couchbase.CouchbaseEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>

public class CouchbaseEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>

Represents a Couchbase index as an embedding store. Current implementation assumes the index uses the cosine distance metric.
Supports storing Metadata

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CouchbaseEmbeddingStore.Builder

Constructor Summary

Constructors

Constructor	Description
CouchbaseEmbeddingStore(String clusterUrl, String username, String password, String bucketName, String scopeName, String collectionName, String searchIndexName, Integer dimensions)	Creates an instance of CouchbaseEmbeddingStore
CouchbaseEmbeddingStore(String clusterUrl, String username, String password, String bucketName, String scopeName, String collectionName, String searchIndexName, Integer dimensions, Integer bucketTimeout)	Creates an instance of CouchbaseEmbeddingStore

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 CouchbaseEmbeddingStore.Builder	builder()
void	removeAll()	Removes all embeddings 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 Object

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

Methods inherited from interface EmbeddingStore

addAll, generateIds, remove, removeAll

Constructor Details

CouchbaseEmbeddingStore

public CouchbaseEmbeddingStore(String clusterUrl,
 String username,
 String password,
 String bucketName,
 String scopeName,
 String collectionName,
 String searchIndexName,
 Integer dimensions)

Creates an instance of CouchbaseEmbeddingStore

Parameters:

clusterUrl - the url of the couchbase cluster to be used by the store

username - username on the cluster

password - password on the cluster

bucketName - name of a cluster bucket in which to store the embeddings

scopeName - name of a scope in the bucket in which to store the embeddings

collectionName - name of a collection in the scope in which to store the embeddings

searchIndexName - name of the FTS index to be used for searching embeddings

dimensions - expected size (dimensionality) of vectors that will be stored

CouchbaseEmbeddingStore

public CouchbaseEmbeddingStore(String clusterUrl,
 String username,
 String password,
 String bucketName,
 String scopeName,
 String collectionName,
 String searchIndexName,
 Integer dimensions,
 Integer bucketTimeout)

Creates an instance of CouchbaseEmbeddingStore

Parameters:

clusterUrl - the url of the couchbase cluster to be used by the store

username - username on the cluster

password - password on the cluster

bucketName - name of a cluster bucket in which to store the embeddings

scopeName - name of a scope in the bucket in which to store the embeddings

collectionName - name of a collection in the scope in which to store the embeddings

searchIndexName - name of the FTS index to be used for searching embeddings

dimensions - expected size (dimensionality) of vectors that will be stored

bucketTimeout - bucket connection timeout

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.

add

public void add(@NonNull
 String id,
 @NonNull
 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.

add

public String add(@NonNull
 Embedding embedding,
 @Nullable
 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 List<String> addAll(@NonNull
 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.

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.

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()

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 CouchbaseEmbeddingStore.Builder builder()