Python: [BREAKING] added SerializationMixin and applied to contents, agents, chat client… (#1012)

* added SerializationMixin and applied to contents, agents, chat clients, removed AFBaseModel

* fix annotations type

* mypy fixes

* fix tests

* fix serializable subvalues and added large docstring

* updated indents in code block

* fixed exported urls

python/samples/getting_started/agents/anthropic/anthropic_with_openai_chat_client.py

@@ -38,7 +38,7 @@ async def non_streaming_example() -> None:
     agent = OpenAIChatClient(
         api_key=os.getenv("ANTHROPIC_API_KEY"),
         base_url="https://api.anthropic.com/v1/",
-        ai_model_id=os.getenv("ANTHROPIC_MODEL"),
+        model_id=os.getenv("ANTHROPIC_MODEL"),
     ).create_agent(
         name="WeatherAgent",
         instructions="You are a helpful weather agent.",
@@ -58,7 +58,7 @@ async def streaming_example() -> None:
     agent = OpenAIChatClient(
         api_key=os.getenv("ANTHROPIC_API_KEY"),
         base_url="https://api.anthropic.com/v1/",
-        ai_model_id=os.getenv("ANTHROPIC_MODEL"),
+        model_id=os.getenv("ANTHROPIC_MODEL"),
     ).create_agent(
         name="WeatherAgent",
         instructions="You are a helpful weather agent.",

python/samples/getting_started/agents/custom/custom_chat_client.py

@@ -3,7 +3,7 @@
 import asyncio
 import random
 from collections.abc import AsyncIterable, MutableSequence
-from typing import Any
+from typing import Any, ClassVar
 
 from agent_framework import (
     BaseChatClient,
@@ -46,9 +46,7 @@ class EchoingChatClient(BaseChatClient):
     and implementing the required _inner_get_response() and _inner_get_streaming_response() methods.
     """
 
-    OTEL_PROVIDER_NAME: str = "EchoingChatClient"
-
-    prefix: str = "Echo:"
+    OTEL_PROVIDER_NAME: ClassVar[str] = "EchoingChatClient"
 
     def __init__(self, *, prefix: str = "Echo:", **kwargs: Any) -> None:
         """Initialize the EchoingChatClient.
@@ -57,10 +55,8 @@ class EchoingChatClient(BaseChatClient):
             prefix: Prefix to add to echoed messages.
             **kwargs: Additional keyword arguments passed to BaseChatClient.
         """
-        super().__init__(
-            prefix=prefix,  # type: ignore
-            **kwargs,
-        )
+        super().__init__(**kwargs)
+        self.prefix = prefix
 
     async def _inner_get_response(
         self,

python/samples/getting_started/agents/openai/openai_assistants_with_explicit_settings.py

@@ -21,7 +21,7 @@ async def main() -> None:
     print("=== OpenAI Assistants Client with Explicit Settings ===")
 
     async with OpenAIAssistantsClient(
-        ai_model_id=os.environ["OPENAI_CHAT_MODEL_ID"],
+        model_id=os.environ["OPENAI_CHAT_MODEL_ID"],
         api_key=os.environ["OPENAI_API_KEY"],
     ).create_agent(
         instructions="You are a helpful weather agent.",

python/samples/getting_started/agents/openai/openai_chat_client_with_explicit_settings.py

@@ -21,7 +21,7 @@ async def main() -> None:
     print("=== OpenAI Chat Client with Explicit Settings ===")
 
     agent = OpenAIChatClient(
-        ai_model_id=os.environ["OPENAI_CHAT_MODEL_ID"],
+        model_id=os.environ["OPENAI_CHAT_MODEL_ID"],
         api_key=os.environ["OPENAI_API_KEY"],
     ).create_agent(
         instructions="You are a helpful weather agent.",

python/samples/getting_started/agents/openai/openai_chat_client_with_web_search.py

@@ -7,7 +7,7 @@ from agent_framework.openai import OpenAIChatClient
 
 
 async def main() -> None:
-    client = OpenAIChatClient(ai_model_id="gpt-4o-search-preview")
+    client = OpenAIChatClient(model_id="gpt-4o-search-preview")
 
     message = "What is the current weather? Do not ask for my current location."
     # Test that the client will use the web search tool with location

python/samples/getting_started/agents/openai/openai_responses_client_reasoning.py

@@ -10,7 +10,7 @@ async def reasoning_example() -> None:
     """Example of reasoning response (get results as they are generated)."""
     print("=== Reasoning Example ===")
 
-    agent = OpenAIResponsesClient(ai_model_id="gpt-5").create_agent(
+    agent = OpenAIResponsesClient(model_id="gpt-5").create_agent(
         name="MathHelper",
         instructions="You are a personal math tutor. When asked a math question, "
         "write and run code using the python tool to answer the question.",

python/samples/getting_started/agents/openai/openai_responses_client_with_explicit_settings.py

@@ -21,7 +21,7 @@ async def main() -> None:
     print("=== OpenAI Responses Client with Explicit Settings ===")
 
     agent = OpenAIResponsesClient(
-        ai_model_id=os.environ["OPENAI_RESPONSES_MODEL_ID"],
+        model_id=os.environ["OPENAI_RESPONSES_MODEL_ID"],
         api_key=os.environ["OPENAI_API_KEY"],
     ).create_agent(
         instructions="You are a helpful weather agent.",