Class AzureCosmosDbMongoVCoreEmbeddingStore.Builder

java.lang.Object

dev.langchain4j.store.embedding.azure.cosmos.mongo.vcore.AzureCosmosDbMongoVCoreEmbeddingStore.Builder

Enclosing class:

AzureCosmosDbMongoVCoreEmbeddingStore

public static class AzureCosmosDbMongoVCoreEmbeddingStore.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	applicationName(String applicationName)
AzureCosmosDbMongoVCoreEmbeddingStore	build()
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	collectionName(String collectionName)
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	connectionString(String connectionString)	Sets the Azure CosmosDB Mongo vCore connectionString.
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	createCollectionOptions(com.mongodb.client.model.CreateCollectionOptions createCollectionOptions)
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	createIndex(Boolean createIndex)	Set to true if you want the application to create an index, or false if you want to create it manually.
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	databaseName(String databaseName)
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	dimensions(Integer dimensions)
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	efConstruction(Integer efConstruction)
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	efSearch(Integer efSearch)
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	indexName(String indexName)
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	kind(String kind)
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	m(Integer m)
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	mongoClient(com.mongodb.client.MongoClient mongoClient)	Build Mongo Client, Please close the client to release resources after usage.
AzureCosmosDbMongoVCoreEmbeddingStore.Builder	numLists(Integer numLists)

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

mongoClient

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder mongoClient(com.mongodb.client.MongoClient mongoClient)

Build Mongo Client, Please close the client to release resources after usage. This is a mandatory parameter if not providing the connectionString.

connectionString

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder connectionString(String connectionString)

Sets the Azure CosmosDB Mongo vCore connectionString. This is a mandatory parameter if not providing the Mongo Client.

Parameters:

connectionString - The Azure CosmosDB Mongo vCore connectionString.

Returns:

builder

databaseName

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder databaseName(String databaseName)

collectionName

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder collectionName(String collectionName)

indexName

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder indexName(String indexName)

applicationName

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder applicationName(String applicationName)

createCollectionOptions

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder createCollectionOptions(com.mongodb.client.model.CreateCollectionOptions createCollectionOptions)

createIndex

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder createIndex(Boolean createIndex)

Set to true if you want the application to create an index, or false if you want to create it manually.

default value is false

Parameters:

createIndex - whether in production mode

Returns:

builder

kind

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder kind(String kind)

Parameters:

kind - - Type of vector index to create. Possible options are: - vector-ivf - vector-hnsw: available as a preview feature only, to enable visit https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/preview-feature

numLists

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder numLists(Integer numLists)

Parameters:

numLists - - This integer is the number of clusters that the inverted file (IVF) index uses to group the vector data. We recommend that numLists is set to documentCount/1000 for up to 1 million documents and to sqrt(documentCount) for more than 1 million documents. Using a numLists value of 1 is akin to performing brute-force search, which has limited performance.

Returns:

dimensions

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder dimensions(Integer dimensions)

Parameters:

dimensions - - Number of dimensions for vector similarity. The maximum number of supported dimensions is 2000.

Returns:

m

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder m(Integer m)

Parameters:

m - - The max number of connections per layer (16 by default, minimum value is 2, maximum value is 100). Higher m is suitable for datasets with high dimensionality and/or high accuracy requirements.

Returns:

efConstruction

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder efConstruction(Integer efConstruction)

Parameters:

efConstruction - - the size of the dynamic candidate list for constructing the graph (64 by default, minimum value is 4, maximum value is 1000). Higher ef_construction will result in better index quality and higher accuracy, but it will also increase the time required to build the index. ef_construction has to be at least 2 * m.

Returns:

efSearch

public AzureCosmosDbMongoVCoreEmbeddingStore.Builder efSearch(Integer efSearch)

Parameters:

efSearch - - The size of the dynamic candidate list for search (40 by default). A higher value provides better recall at the cost of speed.

Returns:

build

public AzureCosmosDbMongoVCoreEmbeddingStore build()