Python: [BREAKING] Scope provider state by source_id and standardize source IDs (#3995)

* Initial plan

* Add FoundryMemoryProvider and tests

Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com>

* Add sample and documentation for FoundryMemoryProvider

Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com>

* Address code review feedback for FoundryMemoryProvider

Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com>

* Address PR review comments: Add DEFAULT_SOURCE_ID, use logging.getLogger, move state to session.state

Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com>

* Fix Foundry memory ItemParam usage and exports

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Refactor provider hook state and standardize source IDs

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Support endpoint-based Foundry memory init

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix core README workflows link

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* updated implementation and sample

* Split out Foundry memory provider changes

Remove FoundryMemoryProvider implementation/tests/sample plus export and docs mentions from this branch so only non-Foundry changes remain.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Trigger CI rerun for PR #3995

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

python/samples/02-agents/providers/azure_openai/azure_chat_client_with_session.py

@@ -4,7 +4,7 @@ import asyncio
 from random import randint
 from typing import Annotated
 
-from agent_framework import Agent, AgentSession, tool
+from agent_framework import Agent, AgentSession, InMemoryHistoryProvider, tool
 from agent_framework.azure import AzureOpenAIChatClient
 from azure.identity import AzureCliCredential
 from pydantic import Field
@@ -112,7 +112,7 @@ async def example_with_existing_session_messages() -> None:
     print(f"Agent: {result1.text}")
 
     # The session now contains the conversation history in state
-    memory_state = session.state.get("memory", {})
+    memory_state = session.state.get(InMemoryHistoryProvider.DEFAULT_SOURCE_ID, {})
     messages = memory_state.get("messages", [])
     if messages:
         print(f"Session contains {len(messages)} messages")

python/samples/02-agents/providers/custom/custom_agent.py

@@ -10,6 +10,7 @@ from agent_framework import (
     AgentSession,
     BaseAgent,
     Content,
+    InMemoryHistoryProvider,
     Message,
     Role,
     normalize_messages,
@@ -93,7 +94,9 @@ class EchoAgent(BaseAgent):
         if not normalized_messages:
             response_message = Message(
                 role=Role.ASSISTANT,
-                contents=[Content.from_text(text="Hello! I'm a custom echo agent. Send me a message and I'll echo it back.")],
+                contents=[
+                    Content.from_text(text="Hello! I'm a custom echo agent. Send me a message and I'll echo it back.")
+                ],
             )
         else:
             # For simplicity, echo the last user message
@@ -199,7 +202,7 @@ async def main() -> None:
     print(f"Agent: {result2.messages[0].text}")
 
     # Check conversation history
-    memory_state = session.state.get("memory", {})
+    memory_state = session.state.get(InMemoryHistoryProvider.DEFAULT_SOURCE_ID, {})
     messages = memory_state.get("messages", [])
     if messages:
         print(f"\nSession contains {len(messages)} messages in history")

python/samples/02-agents/providers/openai/openai_chat_client_with_session.py

@@ -4,7 +4,7 @@ import asyncio
 from random import randint
 from typing import Annotated
 
-from agent_framework import Agent, AgentSession, tool
+from agent_framework import Agent, AgentSession, InMemoryHistoryProvider, tool
 from agent_framework.openai import OpenAIChatClient
 from pydantic import Field
 
@@ -105,7 +105,7 @@ async def example_with_existing_session_messages() -> None:
     print(f"Agent: {result1.text}")
 
     # The session now contains the conversation history in state
-    memory_state = session.state.get("memory", {})
+    memory_state = session.state.get(InMemoryHistoryProvider.DEFAULT_SOURCE_ID, {})
     messages = memory_state.get("messages", [])
     if messages:
         print(f"Session contains {len(messages)} messages")