Azure .NET OpenAPI version 2 has breaking changes

Question

Azure .NET OpenAPI version 2 has breaking changes

David Thielen 3,231

Hi all;

Is the new version 2 OpenAIClient and associated classes documented anywhere. All I can find is the 1.0 documentation.

And hopefully guidance on how to change my code for the new API.

Changes I’ve found (likely many more):

Namespace changed from Azure.AI.OpenAI to OpenAI
Parameters for OpenAIClient constructor have changed (not sure to what - no documentation).
The following classes no longer exist.
1. ChatRequestMessage
2. ChatRequestSystemMessage
3. ChatRequestUserMessage
4. ChatCompletionsOptions
The method OpenAIClient.GetChatCompletionsAsync() no longer exists.

thanks - dave

YutongTie-9091 54,021 Reputation points Moderator

2024-06-20T21:01:51.56+00:00

Hello Dave,

Thanks for reaching out to us, there is a dropdown menu and if you click on it you should see the 2.0 version as below -

I hope this helps.

Regards,

Yutong

David Thielen 3,231

@Anonymous First off thanks. My wife says I'm am the least observant person in the world and yet again - I missed something obvious.

Second, when I upgraded in NuGet it changed the namespace to OpenAI for OpenAI.OpenAIClient and while the documentation shows

AzureOpenAIClient (Uri endpoint, System.ClientModel.ApiKeyCredential credential, Azure.AI.OpenAI.AzureOpenAIClientOptions options = null);

It does not exist (compile error). Also, is there documentation saying how I should now do the following as all these classes are now gone?

				var messages = new List<ChatRequestMessage>()
				{
					new ChatRequestSystemMessage(_systemMessage),
					new ChatRequestUserMessage(text),
				};

				var options = new ChatCompletionsOptions("sandbox1", messages)
				{
					MaxTokens = 1500,
					Temperature = 0,
					FrequencyPenalty = 0,
					PresencePenalty = 0,
				};

				var chatCompletions = await Client.GetChatCompletionsAsync(options);

thanks - dave

YutongTie-9091 54,021 Moderator

Hello Dave,

Thanks for your confirmation, below is a code sample you may want to refer to, please have a try -

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Identity;
using Azure.AI.OpenAI;
using Azure.AI.OpenAI.Models;

public class ChatExample
{
    private static string _systemMessage = "Your system message here";
    private static AzureOpenAIClient Client;

    public static async Task Main(string[] args)
    {
        // Define the endpoint
        var endpoint = new Uri("https://my-resource.openai.azure.com");

        // Use DefaultAzureCredential for authentication
        TokenCredential credential = new DefaultAzureCredential();

        // Create options if needed (can be null if default options are sufficient)
        var options = new AzureOpenAIClientOptions();

        // Initialize the AzureOpenAIClient with TokenCredential
        Client = new AzureOpenAIClient(endpoint, credential, options);

        // Define user message
        string text = "Your user message here";

        // Create chat messages
        var messages = new List<ChatMessage>
        {
            new ChatMessage(ChatMessageRole.System, _systemMessage),
            new ChatMessage(ChatMessageRole.User, text)
        };

        // Set up chat completion options
        var chatOptions = new ChatCompletionsOptions
        {
            Messages = messages,
            MaxTokens = 1500,
            Temperature = 0,
            FrequencyPenalty = 0,
            PresencePenalty = 0
        };

        // Get chat completions
        var chatCompletions = await Client.GetChatCompletionsAsync(chatOptions);

        // Handle the response
        Console.WriteLine(chatCompletions.Choices[0].Message.Content);
    }
}

Regards,

Yutong

David Thielen 3,231 Reputation points

2024-07-01T15:51:46.3533333+00:00
@Anonymous I tried this and found a couple of problems:

ChatMessage is an abstract class. So I can't create the new ChatMessage() calls.

The class ChatCompletionsOptions does not exist.

The method Client.GetChatCompletionsAsync() does not exist.

??? - thanks - dave
David Thielen 3,231 Reputation points

2024-07-09T17:38:36.71+00:00

@Anonymous Should I enter a ticket with Microsoft support to answer this issue?

thanks - dave
YutongTie-9091 54,021 Reputation points Moderator

2024-07-09T22:33:51.72+00:00

Hello David, sorry I failed to respond to you sooner, if you need a support ticket to check on details of your code and environment for this issue, yes, please let us know your Azure Subscription ID in private message, I am happy to enable you one.

Regards,

Yutong
David Thielen 3,231 Reputation points

2024-07-09T22:45:25.69+00:00

@Anonymous I don't know how to send a private message. Can you tell me how?

thanks - dave
YutongTie-9091 54,021 Reputation points Moderator

2024-07-09T22:54:36.0866667+00:00

I just sent you a private message, please respond to it.
Gabriele C 0 Reputation points Microsoft Employee

2024-10-07T18:53:09.5366667+00:00

@David Thielen , did you ever get an answer for this?
I am having exactly the same issues as you described in this post and not sure how to fix them.

Thanks,

Gabriele
DongMsLearn 0 Reputation points

2025-03-20T14:12:58.4733333+00:00

Hi all, do you get the answer for this? I am getting the same issues as well. I am using Azure.AI.OpenAI (2.1.0).

Thanks,

Dong

1 answer

Your answer

YutongTie-9091 54,021 Reputation points Moderator

2024-06-20T21:01:51.56+00:00

Hello Dave,

Thanks for reaching out to us, there is a dropdown menu and if you click on it you should see the 2.0 version as below -

I hope this helps.

Regards,

Yutong
David Thielen 3,231 Reputation points

2024-06-20T21:55:04.27+00:00

@Anonymous First off thanks. My wife says I'm am the least observant person in the world and yet again - I missed something obvious.

Second, when I upgraded in NuGet it changed the namespace to OpenAI for OpenAI.OpenAIClient and while the documentation shows

AzureOpenAIClient (Uri endpoint, System.ClientModel.ApiKeyCredential credential, Azure.AI.OpenAI.AzureOpenAIClientOptions options = null);

It does not exist (compile error). Also, is there documentation saying how I should now do the following as all these classes are now gone?

var messages = new List<ChatRequestMessage>() { new ChatRequestSystemMessage(_systemMessage), new ChatRequestUserMessage(text), }; var options = new ChatCompletionsOptions("sandbox1", messages) { MaxTokens = 1500, Temperature = 0, FrequencyPenalty = 0, PresencePenalty = 0, }; var chatCompletions = await Client.GetChatCompletionsAsync(options);

thanks - dave
YutongTie-9091 54,021 Reputation points Moderator

2024-06-22T22:27:24.62+00:00

Hello Dave,

Thanks for your confirmation, below is a code sample you may want to refer to, please have a try -

using System; using System.Collections.Generic; using System.Threading.Tasks; using Azure; using Azure.Identity; using Azure.AI.OpenAI; using Azure.AI.OpenAI.Models; public class ChatExample { private static string _systemMessage = "Your system message here"; private static AzureOpenAIClient Client; public static async Task Main(string[] args) { // Define the endpoint var endpoint = new Uri("https://my-resource.openai.azure.com"); // Use DefaultAzureCredential for authentication TokenCredential credential = new DefaultAzureCredential(); // Create options if needed (can be null if default options are sufficient) var options = new AzureOpenAIClientOptions(); // Initialize the AzureOpenAIClient with TokenCredential Client = new AzureOpenAIClient(endpoint, credential, options); // Define user message string text = "Your user message here"; // Create chat messages var messages = new List<ChatMessage> { new ChatMessage(ChatMessageRole.System, _systemMessage), new ChatMessage(ChatMessageRole.User, text) }; // Set up chat completion options var chatOptions = new ChatCompletionsOptions { Messages = messages, MaxTokens = 1500, Temperature = 0, FrequencyPenalty = 0, PresencePenalty = 0 }; // Get chat completions var chatCompletions = await Client.GetChatCompletionsAsync(chatOptions); // Handle the response Console.WriteLine(chatCompletions.Choices[0].Message.Content); } }

Regards,

Yutong
David Thielen 3,231 Reputation points

2024-07-01T15:51:46.3533333+00:00

@Anonymous I tried this and found a couple of problems:

ChatMessage is an abstract class. So I can't create the new ChatMessage() calls.

The class ChatCompletionsOptions does not exist.

The method Client.GetChatCompletionsAsync() does not exist.

??? - thanks - dave
David Thielen 3,231 Reputation points

2024-07-09T17:38:36.71+00:00

@Anonymous Should I enter a ticket with Microsoft support to answer this issue?

thanks - dave
YutongTie-9091 54,021 Reputation points Moderator

2024-07-09T22:33:51.72+00:00

Hello David, sorry I failed to respond to you sooner, if you need a support ticket to check on details of your code and environment for this issue, yes, please let us know your Azure Subscription ID in private message, I am happy to enable you one.

Regards,

Yutong
David Thielen 3,231 Reputation points

2024-07-09T22:45:25.69+00:00

@Anonymous I don't know how to send a private message. Can you tell me how?

thanks - dave
YutongTie-9091 54,021 Reputation points Moderator

2024-07-09T22:54:36.0866667+00:00

I just sent you a private message, please respond to it.
Gabriele C 0 Reputation points Microsoft Employee

2024-10-07T18:53:09.5366667+00:00

@David Thielen , did you ever get an answer for this?
I am having exactly the same issues as you described in this post and not sure how to fix them.

Thanks,

Gabriele
DongMsLearn 0 Reputation points

2025-03-20T14:12:58.4733333+00:00

Hi all, do you get the answer for this? I am getting the same issues as well. I am using Azure.AI.OpenAI (2.1.0).

Thanks,

Dong

Answer 1

YutongTie-9091 54,021 Moderator

We close this issue with support ticket, once there is a solution from support team, will post here.

Thanks,

Yutong

-Please kindly accept the answer if you feel helpful to support the community, thanks a lot.

0 comments

Share via

Azure .NET OpenAPI version 2 has breaking changes

1 answer

Your answer