AspireAzureOpenAIExtensions.AddAzureOpenAIClient Method

Reference

Definition

Namespace:: Microsoft.Extensions.Hosting

Assembly:: Aspire.Azure.AI.OpenAI.dll

Package:: Aspire.Azure.AI.OpenAI v8.2.2-preview.1.24521.5

Package:: Aspire.Azure.AI.OpenAI v9.0.0-preview.5.24551.3

Package:: Aspire.Azure.AI.OpenAI v9.1.0-preview.1.25121.10

Source:: AspireAzureOpenAIExtensions.cs

Source:: AspireAzureOpenAIExtensions.cs

Source:: AspireAzureOpenAIExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Registers AzureOpenAIClient as a singleton in the services provided by the builder.

Additionally, registers the AzureOpenAIClient as an OpenAI.OpenAIClient service.

public static void AddAzureOpenAIClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string connectionName, Action<Aspire.Azure.AI.OpenAI.AzureOpenAISettings>? configureSettings = default, Action<Azure.Core.Extensions.IAzureClientBuilder<Azure.AI.OpenAI.AzureOpenAIClient,Azure.AI.OpenAI.AzureOpenAIClientOptions>>? configureClientBuilder = default);

public static Aspire.Azure.AI.OpenAI.AspireAzureOpenAIClientBuilder AddAzureOpenAIClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string connectionName, Action<Aspire.Azure.AI.OpenAI.AzureOpenAISettings>? configureSettings = default, Action<Azure.Core.Extensions.IAzureClientBuilder<Azure.AI.OpenAI.AzureOpenAIClient,Azure.AI.OpenAI.AzureOpenAIClientOptions>>? configureClientBuilder = default);

static member AddAzureOpenAIClient : Microsoft.Extensions.Hosting.IHostApplicationBuilder * string * Action<Aspire.Azure.AI.OpenAI.AzureOpenAISettings> * Action<Azure.Core.Extensions.IAzureClientBuilder<Azure.AI.OpenAI.AzureOpenAIClient, Azure.AI.OpenAI.AzureOpenAIClientOptions>> -> unit

static member AddAzureOpenAIClient : Microsoft.Extensions.Hosting.IHostApplicationBuilder * string * Action<Aspire.Azure.AI.OpenAI.AzureOpenAISettings> * Action<Azure.Core.Extensions.IAzureClientBuilder<Azure.AI.OpenAI.AzureOpenAIClient, Azure.AI.OpenAI.AzureOpenAIClientOptions>> -> Aspire.Azure.AI.OpenAI.AspireAzureOpenAIClientBuilder

<Extension()>
Public Sub AddAzureOpenAIClient (builder As IHostApplicationBuilder, connectionName As String, Optional configureSettings As Action(Of AzureOpenAISettings) = Nothing, Optional configureClientBuilder As Action(Of IAzureClientBuilder(Of AzureOpenAIClient, AzureOpenAIClientOptions)) = Nothing)

<Extension()>
Public Function AddAzureOpenAIClient (builder As IHostApplicationBuilder, connectionName As String, Optional configureSettings As Action(Of AzureOpenAISettings) = Nothing, Optional configureClientBuilder As Action(Of IAzureClientBuilder(Of AzureOpenAIClient, AzureOpenAIClientOptions)) = Nothing) As AspireAzureOpenAIClientBuilder

Parameters

builder: IHostApplicationBuilder

The IHostApplicationBuilder to read config from and add services to.

connectionName: String

A name used to retrieve the connection string from the ConnectionStrings configuration section.

configureSettings: Action<AzureOpenAISettings>

An optional method that can be used for customizing the AzureOpenAISettings. It's invoked after the settings are read from the configuration.

configureClientBuilder: Action<IAzureClientBuilder<AzureOpenAIClient,AzureOpenAIClientOptions>>

An optional method that can be used for customizing the IAzureClientBuilder<TClient,TOptions>.

Returns

AspireAzureOpenAIClientBuilder

An AspireAzureOpenAIClientBuilder that can be used to register additional services.

Remarks

Reads the configuration from "Aspire.Azure.AI.OpenAI" section.

Applies to

Sdílet prostřednictvím