feat: add utility functions to stream widgets, events and client tools / update version to 0.0.5

Author: ksachdeva

README.md

@@ -31,7 +31,7 @@ Make sure you open this repository in vscode `devcontainer` and all dependencies
 cp .env.example .env
 ```
 
-There is one backend and one frontend that hosts 3 agents (chatkit servers) and their corresponding user interface.
+There is one backend and one frontend that hosts 4 agents (chatkit servers) and their corresponding user interface.
 
 ```bash
 # Run the backend

adk-chatkit/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "adk-chatkit"
-version = "0.0.4"
+version = "0.0.5"
 description = "OpenAI chatkit backend support for Google ADK"
 readme = "README.md"
 authors = [

adk-chatkit/src/adk_chatkit/__about__.py

@@ -1,3 +1,3 @@
 __author__ = "Kapil Sachdeva"
 __application__ = "adk-chatkit"
-__version__ = "0.0.4"
+__version__ = "0.0.5"

adk-chatkit/src/adk_chatkit/__init__.py

@@ -1,6 +1,6 @@
 from .__about__ import __application__, __author__, __version__
 from ._client_tool_call import ClientToolCallState
-from ._context import ADKAgentContext, ADKContext, ChatkitRunConfig
+from ._context import ADKAgentContext, ADKContext, ChatkitRunConfig, issue_client_tool_call, stream_event, stream_widget
 from ._response import stream_agent_response
 from ._store import ADKStore
 from ._widgets import serialize_widget_item
@@ -16,4 +16,7 @@
     "ClientToolCallState",
     "ChatkitRunConfig",
     "serialize_widget_item",
+    "issue_client_tool_call",
+    "stream_widget",
+    "stream_event",
 ]

adk-chatkit/src/adk_chatkit/_context.py

@@ -63,3 +63,48 @@ def _complete(self) -> None:
 
 class ChatkitRunConfig(RunConfig):
     context: ADKAgentContext
+
+
+async def stream_event(event: ThreadStreamEvent, tool_context: ToolContext) -> None:
+    """Stream an event to the chat interface.
+
+    Args:
+        event: The event to stream.
+        tool_context: The tool context associated with the event.
+    """
+    chatkit_run_config = tool_context._invocation_context.run_config
+    if not isinstance(chatkit_run_config, ChatkitRunConfig):
+        raise ValueError("Make sure to set run_config for runner to ChatkitRunConfig")
+
+    await chatkit_run_config.context.stream(event)
+
+
+async def stream_widget(widget: WidgetRoot, tool_context: ToolContext) -> None:
+    """Stream a widget to the chat interface.
+
+    Args:
+        widget: The widget to stream.
+        tool_context: The tool context associated with the widget.
+    """
+    chatkit_run_config = tool_context._invocation_context.run_config
+    if not isinstance(chatkit_run_config, ChatkitRunConfig):
+        raise ValueError("Make sure to set run_config for runner to ChatkitRunConfig")
+
+    await chatkit_run_config.context.stream_widget(widget, tool_context)
+
+
+async def issue_client_tool_call(
+    client_tool_call: ClientToolCallState,
+    tool_context: ToolContext,
+) -> None:
+    """Issue a client tool call to the chat interface.
+
+    Args:
+        client_tool_call: The client tool call state to issue.
+        tool_context: The tool context associated with the client tool call.
+    """
+    chatkit_run_config = tool_context._invocation_context.run_config
+    if not isinstance(chatkit_run_config, ChatkitRunConfig):
+        raise ValueError("Make sure to set run_config for runner to ChatkitRunConfig")
+
+    await chatkit_run_config.context.issue_client_tool_call(client_tool_call, tool_context)

examples/backend/src/backend/agents/facts/_tools.py

@@ -1,6 +1,6 @@
-from typing import Any, Final, Literal, cast
+from typing import Any, Final, Literal
 
-from adk_chatkit import ChatkitRunConfig, ClientToolCallState
+from adk_chatkit import ClientToolCallState, issue_client_tool_call, stream_widget
 from google.adk.tools import ToolContext
 
 from ._sample_widget import render_weather_widget
@@ -50,9 +50,7 @@ async def save_fact(
 
     result = {"fact_id": confirmed.id, "status": "saved"}
 
-    # add_client_tool_call_to_tool_response(result, client_tool_call, tool_context)
-    chatkit_run_config = cast(ChatkitRunConfig, tool_context._invocation_context.run_config)
-    await chatkit_run_config.context.issue_client_tool_call(client_tool_call, tool_context)
+    await issue_client_tool_call(client_tool_call, tool_context)
 
     return result
 
@@ -75,9 +73,7 @@ async def switch_theme(theme: str, tool_context: ToolContext) -> dict[str, str]:
 
     result = {"theme": requested}
 
-    # add_client_tool_call_to_tool_response(result, client_tool_call, tool_context)
-    chatkit_run_config = cast(ChatkitRunConfig, tool_context._invocation_context.run_config)
-    await chatkit_run_config.context.issue_client_tool_call(client_tool_call, tool_context)
+    await issue_client_tool_call(client_tool_call, tool_context)
 
     return result
 
@@ -131,10 +127,8 @@ async def get_weather(
     if observed:
         result["observation_time"] = observed
 
-    chatkit_run_config = cast(ChatkitRunConfig, tool_context._invocation_context.run_config)
-
     try:
-        await chatkit_run_config.context.stream_widget(widget, tool_context)
+        await stream_widget(widget, tool_context)
     except Exception as exc:  # noqa: BLE001
         print("[WeatherTool] widget stream failed", {"error": str(exc)})
         raise ValueError("Weather data is currently unavailable for that location.") from exc

examples/backend/src/backend/agents/widgets/_tools.py

@@ -1,7 +1,7 @@
 import asyncio
 from typing import cast
 
-from adk_chatkit import ChatkitRunConfig
+from adk_chatkit import ChatkitRunConfig, stream_event, stream_widget
 from chatkit.types import ProgressUpdateEvent
 from google.adk.tools import ToolContext
 
@@ -13,17 +13,11 @@ async def render_tasks_widget(tool_context: ToolContext) -> dict[str, str]:
 
     result = dict(success="true")
 
-    # we are fetching the list of tasks
-    run_config = tool_context._invocation_context.run_config
-    assert run_config is not None
-
-    chatkit_run_config = cast(ChatkitRunConfig, run_config)
-
-    await chatkit_run_config.context.stream(ProgressUpdateEvent(text="Fetching tasks widget..."))
+    await stream_event(ProgressUpdateEvent(text="Fetching tasks widget..."), tool_context)
     await asyncio.sleep(2)
 
     widget = make_widget()
 
-    await chatkit_run_config.context.stream_widget(widget, tool_context)
+    await stream_widget(widget, tool_context)
 
     return result