[QUERY] What is the configuration structure for configuring the `OpenAIClient`?

Library name and version

Azure.AI.OpenAI 1.0.0-beta.5

Query/Question

I’m currently configuring the OpenAIClient by registering it into DI like this:

builder.Services.AddAzureClients(clientBuilder =>
{
    clientBuilder.AddOpenAIClient(
        new Uri(builder.Configuration["Azure:OpenAI:Endpoint"]),
        new AzureKeyCredential(builder.Configuration["Azure:OpenAI:ApiKey"])
    );
});

I know there’s also an overload to pass in configuration like this:

builder.Services.AddAzureClients(clientBuilder =>
{
    clientBuilder.AddOpenAIClient(builder.Configuration.GetSection("Azure:OpenAI"));
});

But I don’t know how to configure the Endpoint and ApiKey with this overload. So what should my configuration structure look like to configure it like the first sample?

Ideally, this would work with .NET’s autoreloading configuration, so I can swap API keys without having to restart my application.

Environment

No response

[IEvangelist]

After looking a bit at this @Swimburger - there are some folks speculating that if you were to configure a section like this:

{
  "Azure": {
    "OpenAI": {
      "Endpoint": "< your endpoint >",
      "Crendtial": "< your credential >"
    }
  }
}

And then get the section by its name:

builder.Services.AddAzureClients(clientBuilder =>
{
    clientBuilder.AddOpenAIClient(
        builder.Configuration.GetSection("Azure:OpenAI"));

    // This section would be the following values:
    // {
    //  "Endpoint": "< your endpoint >",
    //  "Crendtial": "< your credential >"
    // }
});

Notice that the property names match the parameter names of the corresponding parameterized call, I wonder if that’s how it maps?

builder.Services.AddAzureClients(clientBuilder =>
{
    clientBuilder.AddOpenAIClient(
        endpoint: new Uri(builder.Configuration["Azure:OpenAI:Endpoint"]),
        credential: new AzureKeyCredential(builder.Configuration["Azure:OpenAI:ApiKey"])
    );
});

Also, see here, as a somewhat related sample: https://learn.microsoft.com/dotnet/azure/sdk/dependency-injection#configure-a-new-retry-policy

[sjkp]

Doesnt seem like that overload works unless you have already registered the OpenAIClient with your DI container

 public static class AzureOpenAIClientBuilderExtensions
  {
    /// <summary> Registers a <see cref="T:Azure.AI.OpenAI.OpenAIClient" /> instance. </summary>
    /// <param name="builder"> The builder to register with. </param>
    /// <param name="endpoint">
    /// Supported Cognitive Services endpoints (protocol and hostname, for example:
    /// https://westus.api.cognitive.microsoft.com).
    /// </param>
    /// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
    public static IAzureClientBuilder<OpenAIClient, OpenAIClientOptions> AddOpenAIClient<TBuilder>(this TBuilder builder, Uri endpoint, AzureKeyCredential credential) where TBuilder : IAzureClientFactoryBuilder
    {
      return builder.RegisterClientFactory<OpenAIClient, OpenAIClientOptions>((Func<OpenAIClientOptions, OpenAIClient>) (options => new OpenAIClient(endpoint, credential, options)));
    }

    /// <summary> Registers a <see cref="T:Azure.AI.OpenAI.OpenAIClient" /> instance. </summary>
    /// <param name="builder"> The builder to register with. </param>
    /// <param name="endpoint">
    /// Supported Cognitive Services endpoints (protocol and hostname, for example:
    /// https://westus.api.cognitive.microsoft.com).
    /// </param>
    public static IAzureClientBuilder<OpenAIClient, OpenAIClientOptions> AddOpenAIClient<TBuilder>(this TBuilder builder, Uri endpoint) where TBuilder : IAzureClientFactoryBuilderWithCredential
    {
      return builder.RegisterClientFactory<OpenAIClient, OpenAIClientOptions>((Func<OpenAIClientOptions, TokenCredential, OpenAIClient>) ((options, cred) => new OpenAIClient(endpoint, cred, options)), true);
    }

    /// <summary> Registers a <see cref="T:Azure.AI.OpenAI.OpenAIClient" /> instance. </summary>
    /// <param name="builder"> The builder to register with. </param>
    /// <param name="configuration"> The configuration values. </param>
    public static IAzureClientBuilder<OpenAIClient, OpenAIClientOptions> AddOpenAIClient<TBuilder, TConfiguration>(this TBuilder builder, TConfiguration configuration) where TBuilder : IAzureClientFactoryBuilderWithConfiguration<TConfiguration>
    {
      return builder.RegisterClientFactory<OpenAIClient, OpenAIClientOptions>(configuration);
    }
  }

```