Class HibernateEmbeddingStore.BaseBuilder<E>

java.lang.Object

dev.langchain4j.store.embedding.hibernate.HibernateEmbeddingStore.BaseBuilder<E>

Direct Known Subclasses:

HibernateEmbeddingStore.DynamicBuilder, HibernateEmbeddingStore.DynamicDatasourceBuilder

Enclosing class:

HibernateEmbeddingStore<E>

public static class HibernateEmbeddingStore.BaseBuilder<E>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	createIndex
protected Boolean	createTable
protected DatabaseKind	databaseKind
protected Integer	dimension
protected DistanceFunction	distanceFunction
protected Boolean	dropTableFirst
protected String	indexOptions
protected String	indexType
protected Map<String,Object>	queryHints
protected String	table

Constructor Summary

Constructors

Constructor	Description
BaseBuilder()

Method Summary

Modifier and Type	Method	Description
protected org.hibernate.cfg.Configuration	createConfiguration()
protected org.hibernate.cfg.Configuration	createConfiguration(DatabaseKind databaseKind)	Creates the Hibernate configuration for the embedding table.
HibernateEmbeddingStore.BaseBuilder<E>	createIndex(Boolean createIndex)
protected org.hibernate.SessionFactory	createSessionFactory(org.hibernate.cfg.Configuration cfg, DatabaseKind databaseKind)
HibernateEmbeddingStore.BaseBuilder<E>	createTable(Boolean createTable)
HibernateEmbeddingStore.BaseBuilder<E>	databaseKind(DatabaseKind databaseKind)
HibernateEmbeddingStore.BaseBuilder<E>	dimension(Integer dimension)
HibernateEmbeddingStore.BaseBuilder<E>	distanceFunction(DistanceFunction distanceFunction)
HibernateEmbeddingStore.BaseBuilder<E>	dropTableFirst(Boolean dropTableFirst)
HibernateEmbeddingStore.BaseBuilder<E>	indexOptions(String indexOptions)
HibernateEmbeddingStore.BaseBuilder<E>	indexType(String indexType)
HibernateEmbeddingStore.BaseBuilder<E>	queryHints(Map<String,Object> queryHints)	Sets query hints that are applied to every similarity search (search(...) and query(...)).
HibernateEmbeddingStore.BaseBuilder<E>	table(String table)

Methods inherited from class Object

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

Field Details

databaseKind

protected DatabaseKind databaseKind

table

protected String table

dimension

protected Integer dimension

createIndex

protected Boolean createIndex

indexType

protected String indexType

indexOptions

protected String indexOptions

createTable

protected Boolean createTable

dropTableFirst

protected Boolean dropTableFirst

distanceFunction

protected DistanceFunction distanceFunction

queryHints

protected Map<String,Object> queryHints

Constructor Details

BaseBuilder

public BaseBuilder()

Method Details

createConfiguration

protected org.hibernate.cfg.Configuration createConfiguration()

createConfiguration

protected org.hibernate.cfg.Configuration createConfiguration(DatabaseKind databaseKind)

Creates the Hibernate configuration for the embedding table.

Parameters:

databaseKind - the database kind of the store, which provides the index options of the table, see DatabaseKind.tableIndexOptions(boolean, DistanceFunction, String, String, String, String), or null for no index options

Returns:

the configuration

createSessionFactory

protected org.hibernate.SessionFactory createSessionFactory(org.hibernate.cfg.Configuration cfg,
 DatabaseKind databaseKind)

databaseKind

public HibernateEmbeddingStore.BaseBuilder<E> databaseKind(DatabaseKind databaseKind)

table

public HibernateEmbeddingStore.BaseBuilder<E> table(String table)

dimension

public HibernateEmbeddingStore.BaseBuilder<E> dimension(Integer dimension)

createIndex

public HibernateEmbeddingStore.BaseBuilder<E> createIndex(Boolean createIndex)

indexType

public HibernateEmbeddingStore.BaseBuilder<E> indexType(String indexType)

indexOptions

public HibernateEmbeddingStore.BaseBuilder<E> indexOptions(String indexOptions)

createTable

public HibernateEmbeddingStore.BaseBuilder<E> createTable(Boolean createTable)

dropTableFirst

public HibernateEmbeddingStore.BaseBuilder<E> dropTableFirst(Boolean dropTableFirst)

distanceFunction

public HibernateEmbeddingStore.BaseBuilder<E> distanceFunction(DistanceFunction distanceFunction)

queryHints

public HibernateEmbeddingStore.BaseBuilder<E> queryHints(Map<String,Object> queryHints)

Sets query hints that are applied to every similarity search (search(...) and query(...)). They are not applied when embeddings are added or removed.

Each entry is passed to Hibernate's SelectionQuery.setHint(String, Object). The value of HibernateHints.HINT_QUERY_DATABASE is written into the generated query, so it is specific to one database. To pass more than one such database hint, use a Collection of Strings as the value.

A database kind can add default hints, see DatabaseKind.defaultQueryHints(). A hint set here replaces the default hint with the same name. For example, a Milvus search uses the session consistency level by default, so it sees the embeddings that this application added just before it. To also see the embeddings that other applications added just before it, use the strong consistency level:

.queryHints(Map.of(HibernateHints.HINT_QUERY_DATABASE, MilvusDatabaseHints.CONSISTENCY_LEVEL + "=STRONG"))

Parameters:

queryHints - the query hints, or null for only the default hints of the database kind

Returns:

this builder