TODO comments

Author: seratch

src/agents/model_settings.py

@@ -120,7 +120,9 @@ class ModelSettings:
     """Whether to include usage chunk.
     Only available for Chat Completions API."""
 
-    # to include "web_search_call.action.sources" etc, added str here
+    # TODO: revisit ResponseIncludable | str if ResponseIncludable covers more cases
+    # We've added str to support missing ones like
+    # "web_search_call.action.sources" etc.
     response_include: list[ResponseIncludable | str] | None = None
     """Additional output data to include in the model response.
     [include parameter](https://platform.openai.com/docs/api-reference/responses/create#responses-create-include)"""

src/agents/models/openai_responses.py

@@ -337,6 +337,7 @@ def convert_tool_choice(
             }
         elif tool_choice == "web_search":
             return {
+                # TODO: revist the type: ignore comment when ToolChoice is updated in the future
                 "type": "web_search",  # type: ignore [typeddict-item]
             }
         elif tool_choice == "web_search_preview":
@@ -419,6 +420,7 @@ def _convert_tool(cls, tool: Tool) -> tuple[ToolParam, ResponseIncludable | None
             }
             includes: ResponseIncludable | None = None
         elif isinstance(tool, WebSearchTool):
+            # TODO: revist the type: ignore comment when ToolParam is updated in the future
             converted_tool = {
                 "type": "web_search",
                 "filters": tool.filters.model_dump() if tool.filters is not None else None,  # type: ignore [typeddict-item]