Class MariaDbEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.mariadb.MariaDbEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>

public class MariaDbEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>

MariaDB EmbeddingStore Implementation

Using cosine or Euclidean similarity

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MariaDbEmbeddingStore.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_COLUMN_CONTENT
static final String	DEFAULT_COLUMN_EMBEDDING
static final String	DEFAULT_COLUMN_ID
static final String	DEFAULT_TABLE_NAME

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.
List<String>	addAll(List<Embedding> embeddings, List<TextSegment> embedded)	Adds multiple embeddings and their corresponding contents that have been embedded to the store.
void	addAll(List<String> ids, List<Embedding> embeddings, List<TextSegment> embedded)
static MariaDbEmbeddingStore.Builder	builder()
protected void	initTable(boolean dropTableFirst, boolean createTable, int dimension)	Initialize metadata table following configuration
void	removeAll()
void	removeAll(Filter filter)
void	removeAll(Collection<String> ids)
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

generateIds, remove

Field Details

DEFAULT_TABLE_NAME

public static final String DEFAULT_TABLE_NAME

See Also:

• Constant Field Values

DEFAULT_COLUMN_EMBEDDING

public static final String DEFAULT_COLUMN_EMBEDDING

See Also:

• Constant Field Values

DEFAULT_COLUMN_ID

public static final String DEFAULT_COLUMN_ID

See Also:

• Constant Field Values

DEFAULT_COLUMN_CONTENT

public static final String DEFAULT_COLUMN_CONTENT

See Also:

• Constant Field Values

Method Details

initTable

protected void initTable(boolean dropTableFirst,
 boolean createTable,
 int dimension)

Initialize metadata table following configuration

Parameters:

dropTableFirst - Should drop table first, usually for testing

createTable - Should create table automatically

dimension - The vector dimension

add

public String add(Embedding embedding)

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(String id,
 Embedding embedding)

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(Embedding embedding,
 TextSegment textSegment)

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(List<Embedding> embeddings)

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 List<String> addAll(List<Embedding> embeddings,
 List<TextSegment> embedded)

Adds multiple embeddings and their corresponding contents that have been embedded to the store.

Specified by:

addAll in interface EmbeddingStore<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.

addAll

public void addAll(List<String> ids,
 List<Embedding> embeddings,
 List<TextSegment> embedded)

Specified by:

addAll in interface EmbeddingStore<TextSegment>

removeAll

public void removeAll(Collection<String> ids)

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

removeAll

public void removeAll(Filter filter)

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

removeAll

public void removeAll()

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

search

public EmbeddingSearchResult<TextSegment> search(EmbeddingSearchRequest request)

Searches for the most similar (closest in the embedding space) Embeddings.
All search criteria are defined inside the EmbeddingSearchRequest.
EmbeddingSearchRequest.filter() is used to filter by meta dada.

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