Skip to content

.NET: Adds Valkey to chat message history - issue 5445 - #5542

Merged
westey (westey-m) merged 11 commits into
microsoft:mainfrom
MatthiasHowellYopp:issue-5445
Jun 11, 2026
Merged

.NET: Adds Valkey to chat message history - issue 5445#5542
westey (westey-m) merged 11 commits into
microsoft:mainfrom
MatthiasHowellYopp:issue-5445

Conversation

@MatthiasHowellYopp

@MatthiasHowellYopp Matthias Howell (MatthiasHowellYopp) commented Apr 28, 2026

Copy link
Copy Markdown
Contributor

Motivation and Context
The .NET Agent Framework currently has no dedicated Valkey integration package. Teams running Valkey in production — whether self-hosted or through managed cloud services like AWS ElastiCache for Valkey or GCP Memorystore for Valkey — have no first-party way to use Valkey for persistent chat history or long-term memory context. This has become increasingly common since the Redis license change.

The Microsoft.Agents.AI.Valkey package was scaffolded with working ValkeyChatHistoryProvider and ValkeyContextProvider implementations. This PR completes the package by adding missing pieces identified during review, fixing bugs in the existing sample, and adding a Bedrock-powered sample for AWS users.

Fixes issue #5445

Description
###Valkey package improvements:

  • Added ValkeyProviderScope copy constructor matching the Mem0ProviderScope pattern, with null-guard via Throw.IfNull
  • Added XML doc tags to all ValkeyProviderScope properties for consistency with Mem0ProviderScope
  • Kept the package dependency lean — only references Microsoft.Agents.AI.Abstractions (no dependency on Microsoft.Agents.AI)

###Bug fix in existing sample:

  • Fixed Program.cs — the stateInitializer referenced session?.Id which doesn't exist on AgentSession. Replaced with Guid.NewGuid():N using a discard parameter to make intent clear

###New Bedrock sample (AgentWithMemory_Step03_MemoryUsingValkey_Bedrock):

  • Demonstrates both ValkeyChatHistoryProvider and ValkeyContextProvider powered by Amazon Bedrock via AWSSDK.Extensions.Bedrock.MEAI
  • Uses IAmazonBedrockRuntime.AsIChatClient() which provides an IChatClient that plugs directly into the Agent Framework's ChatClientAgent
  • Uses the standard AWS credential chain (env vars, profile, IAM role)
  • Includes README with prerequisites, environment variables, and run instructions

###Infrastructure:

  • Added AWSSDK.Extensions.Bedrock.MEAI v4.0.6.10 to Directory.Packages.props
  • Registered the Bedrock sample in agent-framework-dotnet.slnx

Unit tests:

Added tests for ValkeyProviderScope copy constructor (clone all properties, null source throws)
23 tests total, all passing

Contribution Checklist
[x] The code builds clean without any errors or warnings
[x] The PR follows the Contribution Guidelines
[x] All unit tests pass, and I have added new tests where possible
[ ] Is this a breaking change? If yes, add "[BREAKING]" prefix to the title of the PR.

@moonbox3 Evan Mattson (moonbox3) added documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs .NET Usage: [Issues, PRs], Target: .Net labels Apr 28, 2026
@github-actions github-actions Bot changed the title Adds Valkey to chat message history - issue 5445 .NET: Adds Valkey to chat message history - issue 5445 Apr 28, 2026
Copilot AI review requested due to automatic review settings April 29, 2026 18:05
Copilot AI reviewed Apr 29, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Completes the new .NET Valkey integration by adding Valkey-backed chat history/context providers, unit tests, and two samples (Azure OpenAI + Amazon Bedrock), plus wiring the new projects into the solution and central package versions.

Changes:

  • Added Microsoft.Agents.AI.Valkey package implementation: ValkeyChatHistoryProvider, ValkeyContextProvider, and ValkeyProviderScope.
  • Added a new Valkey unit test project with coverage for provider behavior and scope cloning.
  • Added new AgentWithMemory step 03 samples (Azure OpenAI + Bedrock), plus solution and package version updates.

Reviewed changes

Copilot reviewed 16 out of 17 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
dotnet/tests/Microsoft.Agents.AI.Valkey.UnitTests/ValkeyContextProviderTests.cs Adds unit tests for ValkeyContextProvider behaviors (escaping, parsing, disposal, scope/state).
dotnet/tests/Microsoft.Agents.AI.Valkey.UnitTests/ValkeyChatHistoryProviderTests.cs Adds unit tests for ValkeyChatHistoryProvider behaviors (store/retrieve/trim/dispose).
dotnet/tests/Microsoft.Agents.AI.Valkey.UnitTests/TestHelpers.cs Adds shared test helpers for constructing provider invoke contexts and a test AgentSession.
dotnet/tests/Microsoft.Agents.AI.Valkey.UnitTests/Microsoft.Agents.AI.Valkey.UnitTests.csproj Introduces the Valkey unit test project.
dotnet/src/Microsoft.Agents.AI.Valkey/ValkeyProviderScope.cs Adds ValkeyProviderScope including copy constructor and XML docs.
dotnet/src/Microsoft.Agents.AI.Valkey/ValkeyContextProvider.cs Introduces Valkey full-text-search-backed long-term memory/context provider.
dotnet/src/Microsoft.Agents.AI.Valkey/ValkeyChatHistoryProvider.cs Introduces Valkey-backed persistent chat history provider using list operations.
dotnet/src/Microsoft.Agents.AI.Valkey/Microsoft.Agents.AI.Valkey.csproj Adds new Valkey project with dependencies and InternalsVisibleTo for tests.
dotnet/samples/02-agents/AgentWithMemory/AgentWithMemory_Step03_MemoryUsingValkey_Bedrock/README.md Adds Bedrock+Valkey sample documentation.
dotnet/samples/02-agents/AgentWithMemory/AgentWithMemory_Step03_MemoryUsingValkey_Bedrock/Program.cs Adds Bedrock-powered sample using both Valkey providers.
dotnet/samples/02-agents/AgentWithMemory/AgentWithMemory_Step03_MemoryUsingValkey_Bedrock/AgentWithMemory_Step03_MemoryUsingValkey_Bedrock.csproj Adds Bedrock sample project and dependency on AWSSDK.Extensions.Bedrock.MEAI.
dotnet/samples/02-agents/AgentWithMemory/AgentWithMemory_Step03_MemoryUsingValkey/README.md Adds Azure OpenAI+Valkey sample documentation.
dotnet/samples/02-agents/AgentWithMemory/AgentWithMemory_Step03_MemoryUsingValkey/Program.cs Adds Azure OpenAI powered sample using both Valkey providers.
dotnet/samples/02-agents/AgentWithMemory/AgentWithMemory_Step03_MemoryUsingValkey/AgentWithMemory_Step03_MemoryUsingValkey.csproj Adds Azure OpenAI sample project references.
dotnet/agent-framework-dotnet.slnx Registers the new Valkey project, new Valkey unit tests, and new samples in the solution.
dotnet/Directory.Packages.props Adds centrally managed version for AWSSDK.Extensions.Bedrock.MEAI.
.gitignore Ignores .kiro/ folder.

Comment thread dotnet/src/Microsoft.Agents.AI.Valkey/ValkeyContextProvider.cs Outdated
Comment thread dotnet/src/Microsoft.Agents.AI.Valkey/ValkeyContextProvider.cs Outdated
Comment thread dotnet/src/Microsoft.Agents.AI.Valkey/ValkeyContextProvider.cs Outdated
Comment thread dotnet/src/Microsoft.Agents.AI.Valkey/ValkeyChatHistoryProvider.cs Outdated
Comment thread dotnet/tests/Microsoft.Agents.AI.Valkey.UnitTests/TestHelpers.cs
@MatthiasHowellYopp

Matthias Howell (MatthiasHowellYopp) commented May 20, 2026

Copy link
Copy Markdown
Contributor Author

westey (@westey-m) Hoping I can get a review on this this week, tks

westey-m
westey (westey-m) reviewed May 21, 2026
View reviewed changes
Comment thread dotnet/src/Microsoft.Agents.AI.Valkey/Microsoft.Agents.AI.Valkey.csproj Outdated
westey-m
westey (westey-m) reviewed May 21, 2026
View reviewed changes
Comment thread dotnet/src/Microsoft.Agents.AI.Valkey/ValkeyChatHistoryProvider.cs Outdated
westey-m
westey (westey-m) reviewed May 21, 2026
View reviewed changes
Comment thread dotnet/src/Microsoft.Agents.AI.Valkey/ValkeyChatHistoryProvider.cs Outdated
westey-m
westey (westey-m) reviewed May 21, 2026
View reviewed changes
Comment thread dotnet/src/Microsoft.Agents.AI.Valkey/ValkeyChatHistoryProvider.cs Outdated
westey-m
westey (westey-m) reviewed May 21, 2026
View reviewed changes
Comment thread dotnet/src/Microsoft.Agents.AI.Valkey/ValkeyContextProvider.cs Outdated
Matthias Howell and others added 6 commits June 9, 2026 09:37
Matthias Howell @MatthiasHowellYopp
Adds Valkey to chat message history
8dc2645
@MatthiasHowellYopp
Address review: switch to Valkey.Glide, add options class, remove con…
b0b5470 
…text provider

- Switch from StackExchange.Redis to Valkey.Glide 1.1.0 (official Valkey .NET client)
- Extract optional params into ValkeyChatHistoryProviderOptions
- Add JsonSerializerOptions support, remove [RequiresUnreferencedCode]
- Make MaxMessages/MaxMessagesToRetrieve readonly via options
- Remove ValkeyContextProvider (overlaps with ChatHistoryMemoryProvider + MEVD)
- Remove ValkeyProviderScope (only used by context provider)
- Remove connection string constructors (caller manages IConnectionMultiplexer)
- Update samples to use new API and gpt-5.4-mini
@MatthiasHowellYopp
Use type-safe JsonSerializer overloads, remove suppress attributes
f32cb6f 
Use JsonSerializerOptions.GetTypeInfo() for Serialize/Deserialize calls
to enable NativeAOT/trimming compatibility without suppress attributes.
Default to AgentAbstractionsJsonUtilities.DefaultOptions when no options provided.

Signed-off-by: Matthias Howell <matthias.howell@improving.com>
@MatthiasHowellYopp
Update READMEs: remove context provider references
969f649 
Remove ValkeyContextProvider and long-term memory references from sample
READMEs since the context provider was removed from this PR. Simplify
Valkey server requirements (no search module needed for chat history).

Signed-off-by: Matthias Howell <matthias.howell@improving.com>
@westey-m @MatthiasHowellYopp
Apply suggestion from @westey-m
f468cf8
@MatthiasHowellYopp
Fix formatting (dotnet format)
a18915f 
Signed-off-by: Matthias Howell <matthias.howell@improving.com>
@MatthiasHowellYopp @rogerbarreto
Update dotnet/src/Microsoft.Agents.AI.Valkey/Microsoft.Agents.AI.Valk…
30935e1 
…ey.csproj

Co-authored-by: Roger Barreto <19890735+rogerbarreto@users.noreply.github.com>
@MatthiasHowellYopp
Merge branch 'main' into issue-5445
7c532a6
@westey-m
westey (westey-m) added this pull request to the merge queue Jun 11, 2026
Merged via the queue into microsoft:main with commit 8e1998d Jun 11, 2026
28 of 32 checks passed
@github-project-automation github-project-automation Bot moved this from Community PR to Done in Agent Framework Jun 11, 2026
@westey-m

westey (westey-m) commented Jun 11, 2026

Copy link
Copy Markdown
Collaborator

Thanks for the contribution Matthias Howell (@MatthiasHowellYopp)!

@Murat7Ay Murat Ay (Murat7Ay) mentioned this pull request Oct 10, 2026
Draft
5 of 7 tasks

This branch was previously deployed

1 inactive deployment
integration — 46e57572 Deployed Jun 11, 2026 by MatthiasHowellYopp via dotnet-test (net10.0, ubuntu-latest, Release, true, integration) #20910
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@rogerbarreto Roger Barreto (rogerbarreto) rogerbarreto approved these changes
@SergeyMenshykh SergeyMenshykh SergeyMenshykh approved these changes
@peibekwe Peter Ibekwe (peibekwe) peibekwe approved these changes
@westey-m westey (westey-m) westey-m approved these changes
+1 more reviewer
@jbrinkman Joe Brinkman (jbrinkman) jbrinkman left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@westey-m westey (westey-m)

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs .NET Usage: [Issues, PRs], Target: .Net

Projects

Agent Framework
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@MatthiasHowellYopp @westey-m @jbrinkman @rogerbarreto @SergeyMenshykh @peibekwe @moonbox3