ChatClientBuilderServiceCollectionExtensions.AddKeyedChatClient Method

Definition

Namespace:

Microsoft.Extensions.DependencyInjection

Assembly:

Microsoft.Extensions.AI.dll

Package:

Microsoft.Extensions.AI v9.0.1-preview.1.24570.5

Overloads

AddKeyedChatClient(IServiceCollection, Object, IChatClient)	Registers a keyed singleton IChatClient in the IServiceCollection.
AddKeyedChatClient(IServiceCollection, Object, Func<IServiceProvider,IChatClient>)	Registers a keyed singleton IChatClient in the IServiceCollection.

AddKeyedChatClient(IServiceCollection, Object, IChatClient)

Source:

ChatClientBuilderServiceCollectionExtensions.cs

Registers a keyed singleton IChatClient in the IServiceCollection.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::AI::ChatClientBuilder ^ AddKeyedChatClient(Microsoft::Extensions::DependencyInjection::IServiceCollection ^ serviceCollection, System::Object ^ serviceKey, Microsoft::Extensions::AI::IChatClient ^ innerClient);

public static Microsoft.Extensions.AI.ChatClientBuilder AddKeyedChatClient (this Microsoft.Extensions.DependencyInjection.IServiceCollection serviceCollection, object serviceKey, Microsoft.Extensions.AI.IChatClient innerClient);

static member AddKeyedChatClient : Microsoft.Extensions.DependencyInjection.IServiceCollection * obj * Microsoft.Extensions.AI.IChatClient -> Microsoft.Extensions.AI.ChatClientBuilder

<Extension()>
Public Function AddKeyedChatClient (serviceCollection As IServiceCollection, serviceKey As Object, innerClient As IChatClient) As ChatClientBuilder

Parameters

serviceCollection

IServiceCollection

The IServiceCollection to which the client should be added.

serviceKey

Object

The key with which to associate the client.

innerClient

IChatClient

The inner IChatClient that represents the underlying backend.

Returns

ChatClientBuilder

A ChatClientBuilder that can be used to build a pipeline around the inner client.

Remarks

The client is registered as a scoped service.

AddKeyedChatClient(IServiceCollection, Object, Func<IServiceProvider,IChatClient>)

Source:

ChatClientBuilderServiceCollectionExtensions.cs

Registers a keyed singleton IChatClient in the IServiceCollection.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::AI::ChatClientBuilder ^ AddKeyedChatClient(Microsoft::Extensions::DependencyInjection::IServiceCollection ^ serviceCollection, System::Object ^ serviceKey, Func<IServiceProvider ^, Microsoft::Extensions::AI::IChatClient ^> ^ innerClientFactory);

public static Microsoft.Extensions.AI.ChatClientBuilder AddKeyedChatClient (this Microsoft.Extensions.DependencyInjection.IServiceCollection serviceCollection, object serviceKey, Func<IServiceProvider,Microsoft.Extensions.AI.IChatClient> innerClientFactory);

static member AddKeyedChatClient : Microsoft.Extensions.DependencyInjection.IServiceCollection * obj * Func<IServiceProvider, Microsoft.Extensions.AI.IChatClient> -> Microsoft.Extensions.AI.ChatClientBuilder

<Extension()>
Public Function AddKeyedChatClient (serviceCollection As IServiceCollection, serviceKey As Object, innerClientFactory As Func(Of IServiceProvider, IChatClient)) As ChatClientBuilder

Parameters

serviceCollection

IServiceCollection

The IServiceCollection to which the client should be added.

serviceKey

Object

The key with which to associate the client.

innerClientFactory

Func<IServiceProvider,IChatClient>

A callback that produces the inner IChatClient that represents the underlying backend.

Returns

ChatClientBuilder

A ChatClientBuilder that can be used to build a pipeline around the inner client.

Remarks

The client is registered as a scoped service.