Package org.springframework.ai.vectorstore.typesense

Class TypesenseVectorStore

java.lang.Object

org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

org.springframework.ai.vectorstore.typesense.TypesenseVectorStore

All Implemented Interfaces:

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

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

A vector store implementation that uses Typesense as the backend. This implementation supports storing and searching document embeddings using Typesense's vector search capabilities.

Example usage:

 TypesenseVectorStore vectorStore = TypesenseVectorStore.builder(client, embeddingModel)
     .collectionName("my_collection")
     .embeddingDimension(1536)
     .initializeSchema(true)
     .build();
 

Author:

Dhanush Anumula, Christian Tzolov, Eddú Meléndez, Mark Pollack, Soby Chacko

See Also:

• VectorStore
• EmbeddingModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TypesenseVectorStore.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_FIELD_NAME
static final String	DEFAULT_COLLECTION_NAME
static final String	DOC_ID_FIELD_NAME	The name of the field that contains the document ID.
static final String	EMBEDDING_FIELD_NAME
final FilterExpressionConverter	filterExpressionConverter
static final int	INVALID_EMBEDDING_DIMENSION
static final String	METADATA_FIELD_NAME
static final int	OPENAI_EMBEDDING_DIMENSION_SIZE

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

batchingStrategy, embeddingModel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TypesenseVectorStore(TypesenseVectorStore.Builder builder)	Protected constructor for creating a TypesenseVectorStore instance using the builder pattern.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
static TypesenseVectorStore.Builder	builder(org.typesense.api.Client client, EmbeddingModel embeddingModel)	Creates a new TypesenseBuilder instance.
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.

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

DOC_ID_FIELD_NAME

public static final String DOC_ID_FIELD_NAME

The name of the field that contains the document ID. It is mandatory to set "id" as the field name because that is the name that typesense is going to look for.

See Also:

• Constant Field Values

CONTENT_FIELD_NAME

public static final String CONTENT_FIELD_NAME

See Also:

• Constant Field Values

METADATA_FIELD_NAME

public static final String METADATA_FIELD_NAME

See Also:

• Constant Field Values

EMBEDDING_FIELD_NAME

public static final String EMBEDDING_FIELD_NAME

See Also:

• Constant Field Values

OPENAI_EMBEDDING_DIMENSION_SIZE

public static final int OPENAI_EMBEDDING_DIMENSION_SIZE

See Also:

• Constant Field Values

DEFAULT_COLLECTION_NAME

public static final String DEFAULT_COLLECTION_NAME

See Also:

• Constant Field Values

INVALID_EMBEDDING_DIMENSION

public static final int INVALID_EMBEDDING_DIMENSION

See Also:

• Constant Field Values

filterExpressionConverter

public final FilterExpressionConverter filterExpressionConverter

Constructor Details

TypesenseVectorStore

protected TypesenseVectorStore(TypesenseVectorStore.Builder builder)

Protected constructor for creating a TypesenseVectorStore instance using the builder pattern. This constructor initializes the vector store with the configured settings from the builder and performs necessary validations.

Parameters:

builder - the TypesenseVectorStore.Builder containing all configuration settings

Throws:

IllegalArgumentException - if the client is null

IllegalArgumentException - if the embeddingModel is null

Since:

1.0.0

See Also:

• TypesenseVectorStore.Builder

Method Details

builder

public static TypesenseVectorStore.Builder builder(org.typesense.api.Client client,
 EmbeddingModel embeddingModel)

Creates a new TypesenseBuilder instance. This is the recommended way to instantiate a TypesenseVectorStore.

Returns:

a new TypesenseBuilder instance

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

Specified by:

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

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