🐛 [BUG] - AzureOpenAIOptions doesn't allow to set ServiceVersion as a string value

[AndresSanchezEncamina]

Description

It is not possible to set the "ServiceVersion" configuration property on the AzureOpenAIOptions using a string value. To set this property the only current available option is to use he indexes of the "ServiceVersion" enumerate.

Reproduction steps

1. Go to 'The app settings of the application'.
2. Set the 'ServiceVersion' as a string.
3. Start the aplication.
4. See error:

System.InvalidOperationException: 'Failed to convert configuration value at 'AzureOpenAIOptions:ServiceVersion' to type 'Azure.AI.OpenAI.AzureOpenAIClientOptions+ServiceVersion'.'

Reproduction URL

No response

Screenshots

![DESCRIPTION](LINK.png)

Logs

Browsers

No response

OS

No response

[LuisM000]

Could you share an example of the string value you're setting for ServiceVersion that causes the error?
Have you tried using something like "V2025_01_01_Preview"?
It must match one of the versions available in the Azure OpenAI client — for example, in the latest release we’re using Azure.AI.OpenAI 2.2.0-beta.1.

[rliberoff]

For example setting a value like V2024_12_01_Preview fails.

  "AzureOpenAIOptions": {
    "ChatModelDeploymentName": "...",
    "ChatModelName": "...",
    "EmbeddingsModelDeploymentName": "...",
    "EmbeddingsModelName": "...",
    "Endpoint": "...",
    "Key": "...",
    "ServiceVersion": "V2024_12_01_Preview"
  },

[LuisM000]

Hmm, it works on my machine @rliberoff 🙂

Something like this (on a .NET 8.0 project, with these two NuGet packages):

<PackageReference Include="Encamina.Enmarcha.AI.OpenAI.Azure" Version="10.0.0-preview-06" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.2" />

using Encamina.Enmarcha.AI.OpenAI.Azure;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;

var builder = Host.CreateApplicationBuilder(args);

builder.Configuration.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true);

builder.Services
    .AddOptionsWithValidateOnStart<AzureOpenAIOptions>()
    .Bind(builder.Configuration.GetSection(nameof(AzureOpenAIOptions)))
    .ValidateDataAnnotations();

builder.Logging.AddConsole();

builder.Services.AddTransient<Test>();

using var host = builder.Build();

var test = host.Services.GetRequiredService<Test>();
test.Run();

public class Test
{
    private readonly AzureOpenAIOptions _options;

    public Test(IOptions<AzureOpenAIOptions> options)
    {
        _options = options.Value;
    }

    public void Run()
    {
        Console.WriteLine($"ServiceVersion: {_options.ServiceVersion}");        
    }
}

And here is the appsettings.json I used:

{
  "AzureOpenAIOptions": {
    "ChatModelDeploymentName": "...",
    "ChatModelName": "...",
    "EmbeddingsModelDeploymentName": "...",
    "EmbeddingsModelName": "...",
    "Endpoint": "...",
    "Key": "...",
    "ServiceVersion": "V2024_12_01_Preview"
  }
}

With this setup, everything works fine.

[rliberoff]

@AndresSanchezEncamina could you please reshare the screenshots of the error?

[AndresSanchezEncamina]

Resharing the screenshot

[LuisM000]

Resharing the screenshot

A few points to clarify 🙂

• I’m not entirely sure which Azure OpenAI API version you’re targeting — I don’t see a 2024-12-10 version listed here: https://learn.microsoft.com/en-us/azure/ai-foundry/openai/api-version-lifecycle.
• Also, the value should map exactly to the ServiceVersion enum from Azure.AI.OpenAI. In the latest version of Encamina.Enmarcha.AI.OpenAI.Azure, we’re using Azure.AI.OpenAI 2.2.0-beta.1, so it should match one of the versions defined here:
  https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.2.0-beta.1/sdk/openai/Azure.AI.OpenAI/src/Custom/AzureOpenAIClientOptions.cs#L80
  (since you’re mapping from a string to an enum).

A valid example would be V2024_06_01.