Python: [BREAKING]: Introducing Options as TypedDict and Generic (#3140)

* WIP typeddict for options

* updated all clients and ChatAgents

* updated everything

* added ADR

* fix mypy

* proper typevar imports

* fixed import

* fixed other imports

* slight update in the sample

* updated from feedback

* fixes

* fixed missing covariants and test fixes

* fixed typing

* updated anthropic thinking config

* ruff fixes

* fixed int tests

* fix tests and mypy

* updated integration tests

* updated docstring and test fix

* improved options handling in obser

* mypy fix

* updated a host of integration tests

* fix tests

* bedrock fix

python/packages/bedrock/tests/test_bedrock_client.py

@@ -6,7 +6,7 @@ import asyncio
 from typing import Any
 
 import pytest
-from agent_framework import ChatMessage, ChatOptions, Role, TextContent
+from agent_framework import ChatMessage, Role, TextContent
 from agent_framework.exceptions import ServiceInitializationError
 
 from agent_framework_bedrock import BedrockChatClient
@@ -46,7 +46,7 @@ def test_get_response_invokes_bedrock_runtime() -> None:
         ChatMessage(role=Role.USER, contents=[TextContent(text="hello")]),
     ]
 
-    response = asyncio.run(client.get_response(messages=messages, chat_options=ChatOptions(max_tokens=32)))
+    response = asyncio.run(client.get_response(messages=messages, options={"max_tokens": 32}))
 
     assert stub.calls, "Expected the runtime client to be called"
     payload = stub.calls[0]
@@ -66,4 +66,4 @@ def test_build_request_requires_non_system_messages() -> None:
     messages = [ChatMessage(role=Role.SYSTEM, contents=[TextContent(text="Only system text")])]
 
     with pytest.raises(ServiceInitializationError):
-        client._build_converse_request(messages, ChatOptions())
+        client._prepare_options(messages, {})

python/packages/bedrock/tests/test_bedrock_settings.py

@@ -13,7 +13,6 @@ from agent_framework import (
     FunctionResultContent,
     Role,
     TextContent,
-    ToolMode,
 )
 from pydantic import BaseModel
 
@@ -46,10 +45,13 @@ def test_build_request_includes_tool_config() -> None:
     client = _build_client()
 
     tool = AIFunction(name="get_weather", description="desc", func=_dummy_weather, input_model=_WeatherArgs)
-    options = ChatOptions(tools=[tool], tool_choice=ToolMode.REQUIRED("get_weather"))
+    options = {
+        "tools": [tool],
+        "tool_choice": {"mode": "required", "required_function_name": "get_weather"},
+    }
     messages = [ChatMessage(role=Role.USER, contents=[TextContent(text="hi")])]
 
-    request = client._build_converse_request(messages, options)
+    request = client._prepare_options(messages, options)
 
     assert request["toolConfig"]["tools"][0]["toolSpec"]["name"] == "get_weather"
     assert request["toolConfig"]["toolChoice"] == {"tool": {"name": "get_weather"}}
@@ -57,7 +59,7 @@ def test_build_request_includes_tool_config() -> None:
 
 def test_build_request_serializes_tool_history() -> None:
     client = _build_client()
-    options = ChatOptions()
+    options: ChatOptions = {}
     messages = [
         ChatMessage(role=Role.USER, contents=[TextContent(text="how's weather?")]),
         ChatMessage(
@@ -70,7 +72,7 @@ def test_build_request_serializes_tool_history() -> None:
         ),
     ]
 
-    request = client._build_converse_request(messages, options)
+    request = client._prepare_options(messages, options)
     assistant_block = request["messages"][1]["content"][0]["toolUse"]
     result_block = request["messages"][2]["content"][0]["toolResult"]