Share via


AzureCosmosDBNoSQLKernelBuilderExtensions.AddAzureCosmosDBNoSQLVectorStore Method

Definition

Overloads

AddAzureCosmosDBNoSQLVectorStore(IKernelBuilder, AzureCosmosDBNoSQLVectorStoreOptions, String)

Register an Azure CosmosDB NoSQL IVectorStore with the specified service ID and where the Azure CosmosDB NoSQL Database is retrieved from the dependency injection container.

AddAzureCosmosDBNoSQLVectorStore(IKernelBuilder, String, String, AzureCosmosDBNoSQLVectorStoreOptions, String)

Register an Azure CosmosDB NoSQL IVectorStore with the specified service ID and where the Azure CosmosDB NoSQL Database is constructed using the provided connectionString and databaseName.

AddAzureCosmosDBNoSQLVectorStore(IKernelBuilder, AzureCosmosDBNoSQLVectorStoreOptions, String)

Register an Azure CosmosDB NoSQL IVectorStore with the specified service ID and where the Azure CosmosDB NoSQL Database is retrieved from the dependency injection container.

public static Microsoft.SemanticKernel.IKernelBuilder AddAzureCosmosDBNoSQLVectorStore (this Microsoft.SemanticKernel.IKernelBuilder builder, Microsoft.SemanticKernel.Connectors.AzureCosmosDBNoSQL.AzureCosmosDBNoSQLVectorStoreOptions? options = default, string? serviceId = default);
static member AddAzureCosmosDBNoSQLVectorStore : Microsoft.SemanticKernel.IKernelBuilder * Microsoft.SemanticKernel.Connectors.AzureCosmosDBNoSQL.AzureCosmosDBNoSQLVectorStoreOptions * string -> Microsoft.SemanticKernel.IKernelBuilder
<Extension()>
Public Function AddAzureCosmosDBNoSQLVectorStore (builder As IKernelBuilder, Optional options As AzureCosmosDBNoSQLVectorStoreOptions = Nothing, Optional serviceId As String = Nothing) As IKernelBuilder

Parameters

builder
IKernelBuilder

The builder to register the IVectorStore on.

options
AzureCosmosDBNoSQLVectorStoreOptions

Optional options to further configure the IVectorStore.

serviceId
String

An optional service id to use as the service key.

Returns

The kernel builder.

Applies to

AddAzureCosmosDBNoSQLVectorStore(IKernelBuilder, String, String, AzureCosmosDBNoSQLVectorStoreOptions, String)

Register an Azure CosmosDB NoSQL IVectorStore with the specified service ID and where the Azure CosmosDB NoSQL Database is constructed using the provided connectionString and databaseName.

public static Microsoft.SemanticKernel.IKernelBuilder AddAzureCosmosDBNoSQLVectorStore (this Microsoft.SemanticKernel.IKernelBuilder builder, string connectionString, string databaseName, Microsoft.SemanticKernel.Connectors.AzureCosmosDBNoSQL.AzureCosmosDBNoSQLVectorStoreOptions? options = default, string? serviceId = default);
static member AddAzureCosmosDBNoSQLVectorStore : Microsoft.SemanticKernel.IKernelBuilder * string * string * Microsoft.SemanticKernel.Connectors.AzureCosmosDBNoSQL.AzureCosmosDBNoSQLVectorStoreOptions * string -> Microsoft.SemanticKernel.IKernelBuilder
<Extension()>
Public Function AddAzureCosmosDBNoSQLVectorStore (builder As IKernelBuilder, connectionString As String, databaseName As String, Optional options As AzureCosmosDBNoSQLVectorStoreOptions = 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 NoSQL.

databaseName
String

Database name for Azure CosmosDB NoSQL.

options
AzureCosmosDBNoSQLVectorStoreOptions

Optional options to further configure the IVectorStore.

serviceId
String

An optional service id to use as the service key.

Returns

The kernel builder.

Applies to