Skip to content

A programming framework for agentic AI

[.NET] Return ChatCompletions instead of ChatResponseMessage for token usage. (#2545)

David Luong3e693578bf50
diff --git a/dotnet/src/AutoGen.OpenAI/Agent/OpenAIChatAgent.cs b/dotnet/src/AutoGen.OpenAI/Agent/OpenAIChatAgent.cs
index ecebe7fc3..487a361d7 100644
--- a/dotnet/src/AutoGen.OpenAI/Agent/OpenAIChatAgent.cs
+++ b/dotnet/src/AutoGen.OpenAI/Agent/OpenAIChatAgent.cs
@@ -84,7 +84,7 @@ public class OpenAIChatAgent : IStreamingAgent
var settings = this.CreateChatCompletionsOptions(options, messages);
var reply = await this.openAIClient.GetChatCompletionsAsync(settings, cancellationToken);
- return new MessageEnvelope<ChatResponseMessage>(reply.Value.Choices.First().Message, from: this.Name);
+ return new MessageEnvelope<ChatCompletions>(reply, from: this.Name);
}
public Task<IAsyncEnumerable<IStreamingMessage>> GenerateStreamingReplyAsync(
@@ -101,7 +101,7 @@ public class OpenAIChatAgent : IStreamingAgent
[EnumeratorCancellation] CancellationToken cancellationToken = default)
{
var settings = this.CreateChatCompletionsOptions(options, messages);
- var response = await this.openAIClient.GetChatCompletionsStreamingAsync(settings);
+ var response = await this.openAIClient.GetChatCompletionsStreamingAsync(settings, cancellationToken);
await foreach (var update in response.WithCancellation(cancellationToken))
{
if (update.ChoiceIndex > 0)
diff --git a/dotnet/src/AutoGen.OpenAI/Middleware/OpenAIChatRequestMessageConnector.cs b/dotnet/src/AutoGen.OpenAI/Middleware/OpenAIChatRequestMessageConnector.cs
index 1276e93f9..118d99703 100644
--- a/dotnet/src/AutoGen.OpenAI/Middleware/OpenAIChatRequestMessageConnector.cs
+++ b/dotnet/src/AutoGen.OpenAI/Middleware/OpenAIChatRequestMessageConnector.cs
@@ -98,6 +98,7 @@ public class OpenAIChatRequestMessageConnector : IMiddleware, IStreamingMiddlewa
Message => message,
AggregateMessage<ToolCallMessage, ToolCallResultMessage> => message,
IMessage<ChatResponseMessage> m => PostProcessMessage(m),
+ IMessage<ChatCompletions> m => PostProcessMessage(m),
_ => throw new InvalidOperationException("The type of message is not supported. Must be one of TextMessage, ImageMessage, MultiModalMessage, ToolCallMessage, ToolCallResultMessage, Message, IMessage<ChatRequestMessage>, AggregateMessage<ToolCallMessage, ToolCallResultMessage>"),
};
}
@@ -129,15 +130,24 @@ public class OpenAIChatRequestMessageConnector : IMiddleware, IStreamingMiddlewa
private IMessage PostProcessMessage(IMessage<ChatResponseMessage> message)
{
- var chatResponseMessage = message.Content;
+ return PostProcessMessage(message.Content, message.From);
+ }
+
+ private IMessage PostProcessMessage(IMessage<ChatCompletions> message)
+ {
+ return PostProcessMessage(message.Content.Choices[0].Message, message.From);
+ }
+
+ private IMessage PostProcessMessage(ChatResponseMessage chatResponseMessage, string? from)
+ {
if (chatResponseMessage.Content is string content)
{
- return new TextMessage(Role.Assistant, content, message.From);
+ return new TextMessage(Role.Assistant, content, from);
}
if (chatResponseMessage.FunctionCall is FunctionCall functionCall)
{
- return new ToolCallMessage(functionCall.Name, functionCall.Arguments, message.From);
+ return new ToolCallMessage(functionCall.Name, functionCall.Arguments, from);
}
if (chatResponseMessage.ToolCalls.Where(tc => tc is ChatCompletionsFunctionToolCall).Any())
@@ -148,7 +158,7 @@ public class OpenAIChatRequestMessageConnector : IMiddleware, IStreamingMiddlewa
var toolCalls = functionToolCalls.Select(tc => new ToolCall(tc.Name, tc.Arguments));
- return new ToolCallMessage(toolCalls, message.From);
+ return new ToolCallMessage(toolCalls, from);
}
throw new InvalidOperationException("Invalid ChatResponseMessage");
diff --git a/dotnet/test/AutoGen.Tests/OpenAIChatAgentTest.cs b/dotnet/test/AutoGen.Tests/OpenAIChatAgentTest.cs
index 8626618fe..a4753b668 100644
--- a/dotnet/test/AutoGen.Tests/OpenAIChatAgentTest.cs
+++ b/dotnet/test/AutoGen.Tests/OpenAIChatAgentTest.cs
@@ -41,9 +41,10 @@ public partial class OpenAIChatAgentTest
var chatMessageContent = MessageEnvelope.Create(new ChatRequestUserMessage("Hello"));
var reply = await openAIChatAgent.SendAsync(chatMessageContent);
- reply.Should().BeOfType<MessageEnvelope<ChatResponseMessage>>();
- reply.As<MessageEnvelope<ChatResponseMessage>>().From.Should().Be("assistant");
- reply.As<MessageEnvelope<ChatResponseMessage>>().Content.Role.Should().Be(ChatRole.Assistant);
+ reply.Should().BeOfType<MessageEnvelope<ChatCompletions>>();
+ reply.As<MessageEnvelope<ChatCompletions>>().From.Should().Be("assistant");
+ reply.As<MessageEnvelope<ChatCompletions>>().Content.Choices.First().Message.Role.Should().Be(ChatRole.Assistant);
+ reply.As<MessageEnvelope<ChatCompletions>>().Content.Usage.TotalTokens.Should().BeGreaterThan(0);
// test streaming
var streamingReply = await openAIChatAgent.GenerateStreamingReplyAsync(new[] { chatMessageContent });