Skip to content

.NET: fix service-stored history provider resolution #6209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
he-yufeng wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −10
Open

.NET: fix service-stored history provider resolution #6209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions dotnet/src/Microsoft.Agents.AI/ChatClient/ChatClientAgent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,7 @@ internal async Task NotifyProvidersOfNewMessagesAsync(
ChatOptions? chatOptions,
CancellationToken cancellationToken)
{
ChatHistoryProvider? chatHistoryProvider = this.ResolveChatHistoryProvider(chatOptions);
ChatHistoryProvider? chatHistoryProvider = this.ResolveChatHistoryProvider(session, chatOptions);

if (chatHistoryProvider is not null)
{
Expand Down Expand Up @@ -508,7 +508,7 @@ internal async Task NotifyProvidersOfFailureAsync(
ChatOptions? chatOptions,
CancellationToken cancellationToken)
{
ChatHistoryProvider? chatHistoryProvider = this.ResolveChatHistoryProvider(chatOptions);
ChatHistoryProvider? chatHistoryProvider = this.ResolveChatHistoryProvider(session, chatOptions);

if (chatHistoryProvider is not null)
{
Expand Down Expand Up @@ -974,14 +974,17 @@ private void WarnOnMissingPerServiceCallChatHistoryPersistingChatClient()
}
}

private ChatHistoryProvider? ResolveChatHistoryProvider(ChatOptions? chatOptions)
private ChatHistoryProvider? ResolveChatHistoryProvider(ChatClientAgentSession session, ChatOptions? chatOptions)
{
ChatHistoryProvider? provider = chatOptions?.ConversationId is null ? this.ChatHistoryProvider : null;
bool serviceStoresHistory = !this.RequiresPerServiceCallChatHistoryPersistence
&& (!string.IsNullOrWhiteSpace(session.ConversationId)
|| !string.IsNullOrWhiteSpace(chatOptions?.ConversationId));
ChatHistoryProvider? provider = serviceStoresHistory ? null : this.ChatHistoryProvider;

// If someone provided an override ChatHistoryProvider via AdditionalProperties, we should use that instead.
if (chatOptions?.AdditionalProperties?.TryGetValue(out ChatHistoryProvider? overrideProvider) is true)
{
if (this._agentOptions?.ThrowOnChatHistoryProviderConflict is true && string.IsNullOrWhiteSpace(chatOptions?.ConversationId) is false)
if (this._agentOptions?.ThrowOnChatHistoryProviderConflict is true && serviceStoresHistory)
{
throw new InvalidOperationException(
$"Only {nameof(ChatClientAgentSession.ConversationId)} or {nameof(this.ChatHistoryProvider)} may be used, but not both. The current {nameof(ChatClientAgentSession)} has a {nameof(ChatClientAgentSession.ConversationId)} indicating server-side chat history management, but an override {nameof(this.ChatHistoryProvider)} was provided via {nameof(AgentRunOptions.AdditionalProperties)}.");
Expand Down Expand Up @@ -1019,7 +1022,7 @@ internal async Task<IEnumerable<ChatMessage>> LoadChatHistoryAsync(
ChatOptions? chatOptions,
CancellationToken cancellationToken)
{
var chatHistoryProvider = this.ResolveChatHistoryProvider(chatOptions);
var chatHistoryProvider = this.ResolveChatHistoryProvider(session, chatOptions);
if (chatHistoryProvider is null)
{
return messages;
Expand Down
10 changes: 6 additions & 4 deletions ...ts/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgent_ChatHistoryManagementTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,11 +385,11 @@ public async Task RunAsync_Throws_WhenThrowEnabledRegardlessOfClearSettingAsync(
}

/// <summary>
/// Verify that RunAsync does not throw when no ChatHistoryProvider is configured on options,
/// even if the service returns a conversation id (default InMemoryChatHistoryProvider is used but not from options).
/// Verify that RunAsync does not persist to the default InMemoryChatHistoryProvider when
/// the service returns a conversation id.
/// </summary>
[Fact]
public async Task RunAsync_DoesNotThrow_WhenNoChatHistoryProviderInOptionsAndConversationIdReturnedAsync()
public async Task RunAsync_DoesNotUseDefaultInMemoryChatHistoryProvider_WhenConversationIdReturnedAsync()
{
// Arrange
Mock<IChatClient> mockService = new();
Expand All @@ -407,8 +407,10 @@ public async Task RunAsync_DoesNotThrow_WhenNoChatHistoryProviderInOptionsAndCon
ChatClientAgentSession? session = await agent.CreateSessionAsync() as ChatClientAgentSession;
await agent.RunAsync([new(ChatRole.User, "test")], session);

// Assert - no exception, session gets the conversation id
// Assert
Assert.Equal("ConvId", session!.ConversationId);
var inMemoryProvider = Assert.IsType<InMemoryChatHistoryProvider>(agent.ChatHistoryProvider);
Assert.Empty(inMemoryProvider.GetMessages(session));
}

#endregion
Expand Down