AzureCosmosDBMongoDBKernelBuilderExtensions.AddAzureCosmosDBMongoDBVectorStore Method

Definition

Namespace:

Microsoft.SemanticKernel

Assembly:

Microsoft.SemanticKernel.Connectors.AzureCosmosDBMongoDB.dll

Package:

Microsoft.SemanticKernel.Connectors.AzureCosmosDBMongoDB v1.20.0-alpha

Overloads

AddAzureCosmosDBMongoDBVectorStore(IKernelBuilder, AzureCosmosDBMongoDBVectorStoreOptions, String)	Register a Azure CosmosDB MongoDB IVectorStore with the specified service ID and where the Azure CosmosDB MongoDB MongoDB.Driver.IMongoDatabase is retrieved from the dependency injection container.
AddAzureCosmosDBMongoDBVectorStore(IKernelBuilder, String, String, AzureCosmosDBMongoDBVectorStoreOptions, String)	Register a Azure CosmosDB MongoDB IVectorStore with the specified service ID and where the Azure CosmosDB MongoDB MongoDB.Driver.IMongoDatabase is constructed using the provided connectionString and databaseName.

AddAzureCosmosDBMongoDBVectorStore(IKernelBuilder, AzureCosmosDBMongoDBVectorStoreOptions, String)

Register a Azure CosmosDB MongoDB IVectorStore with the specified service ID and where the Azure CosmosDB MongoDB MongoDB.Driver.IMongoDatabase is retrieved from the dependency injection container.

public static Microsoft.SemanticKernel.IKernelBuilder AddAzureCosmosDBMongoDBVectorStore (this Microsoft.SemanticKernel.IKernelBuilder builder, Microsoft.SemanticKernel.Connectors.AzureCosmosDBMongoDB.AzureCosmosDBMongoDBVectorStoreOptions? options = default, string? serviceId = default);

static member AddAzureCosmosDBMongoDBVectorStore : Microsoft.SemanticKernel.IKernelBuilder * Microsoft.SemanticKernel.Connectors.AzureCosmosDBMongoDB.AzureCosmosDBMongoDBVectorStoreOptions * string -> Microsoft.SemanticKernel.IKernelBuilder

<Extension()>
Public Function AddAzureCosmosDBMongoDBVectorStore (builder As IKernelBuilder, Optional options As AzureCosmosDBMongoDBVectorStoreOptions = Nothing, Optional serviceId As String = Nothing) As IKernelBuilder

Parameters

builder

IKernelBuilder

The builder to register the IVectorStore on.

options

AzureCosmosDBMongoDBVectorStoreOptions

Optional options to further configure the IVectorStore.

serviceId

String

An optional service id to use as the service key.

Returns

IKernelBuilder

The kernel builder.

AddAzureCosmosDBMongoDBVectorStore(IKernelBuilder, String, String, AzureCosmosDBMongoDBVectorStoreOptions, String)

Register a Azure CosmosDB MongoDB IVectorStore with the specified service ID and where the Azure CosmosDB MongoDB MongoDB.Driver.IMongoDatabase is constructed using the provided connectionString and databaseName.

public static Microsoft.SemanticKernel.IKernelBuilder AddAzureCosmosDBMongoDBVectorStore (this Microsoft.SemanticKernel.IKernelBuilder builder, string connectionString, string databaseName, Microsoft.SemanticKernel.Connectors.AzureCosmosDBMongoDB.AzureCosmosDBMongoDBVectorStoreOptions? options = default, string? serviceId = default);

static member AddAzureCosmosDBMongoDBVectorStore : Microsoft.SemanticKernel.IKernelBuilder * string * string * Microsoft.SemanticKernel.Connectors.AzureCosmosDBMongoDB.AzureCosmosDBMongoDBVectorStoreOptions * string -> Microsoft.SemanticKernel.IKernelBuilder

<Extension()>
Public Function AddAzureCosmosDBMongoDBVectorStore (builder As IKernelBuilder, connectionString As String, databaseName As String, Optional options As AzureCosmosDBMongoDBVectorStoreOptions = Nothing, Optional serviceId As String = Nothing) As IKernelBuilder

Parameters

builder

IKernelBuilder

The builder to register the IVectorStore on.

connectionString

String

Connection string required to connect to Azure CosmosDB MongoDB.

databaseName

String

Database name for Azure CosmosDB MongoDB.

options

AzureCosmosDBMongoDBVectorStoreOptions

Optional options to further configure the IVectorStore.

serviceId

String

An optional service id to use as the service key.

Returns

IKernelBuilder

The kernel builder.