acp-sdk 0.7.3__tar.gz → 0.8.0__tar.gz

{acp_sdk-0.7.3 → acp_sdk-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acp-sdk
-Version: 0.7.3
+Version: 0.8.0
 Summary: Agent Communication Protocol SDK
 Author: IBM Corp.
 Maintainer-email: Tomas Pilar <thomas7pilar@gmail.com>

{acp_sdk-0.7.3 → acp_sdk-0.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "acp-sdk"
-version = "0.7.3"
+version = "0.8.0"
 description = "Agent Communication Protocol SDK"
 license = "Apache-2.0"
 readme = "README.md"

{acp_sdk-0.7.3 → acp_sdk-0.8.0}/src/acp_sdk/client/client.py

@@ -23,10 +23,12 @@ from acp_sdk.models import (
     AwaitResume,
     Error,
     Event,
+    PingResponse,
     Run,
     RunCancelResponse,
     RunCreateRequest,
     RunCreateResponse,
+    RunEventsListResponse,
     RunId,
     RunMode,
     RunResumeRequest,
@@ -120,9 +122,10 @@ class Client:
         return Agent(**response.model_dump())
 
     async def ping(self) -> bool:
-        response = await self._client.get("/healthcheck")
+        response = await self._client.get("/ping")
         self._raise_error(response)
-        return response.json() == "OK"
+        PingResponse.model_validate(response.json())
+        return
 
     async def run_sync(self, input: Input, *, agent: AgentName) -> Run:
         response = await self._client.post(
@@ -172,6 +175,13 @@ class Client:
         self._raise_error(response)
         return Run.model_validate(response.json())
 
+    async def run_events(self, *, run_id: RunId) -> AsyncIterator[Event]:
+        response = await self._client.get(f"/runs/{run_id}/events")
+        self._raise_error(response)
+        response = RunEventsListResponse.model_validate(response.json())
+        for event in response.events:
+            yield event
+
     async def run_cancel(self, *, run_id: RunId) -> Run:
         response = await self._client.post(f"/runs/{run_id}/cancel")
         self._raise_error(response)

{acp_sdk-0.7.3 → acp_sdk-0.8.0}/src/acp_sdk/models/models.py

@@ -1,5 +1,5 @@
 import uuid
-from datetime import datetime
+from datetime import datetime, timezone
 from enum import Enum
 from typing import Any, Literal, Optional, Union
 
@@ -95,11 +95,17 @@ class Artifact(MessagePart):
 
 class Message(BaseModel):
     parts: list[MessagePart]
+    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
+    completed_at: datetime | None = Field(default_factory=lambda: datetime.now(timezone.utc))
 
     def __add__(self, other: "Message") -> "Message":
         if not isinstance(other, Message):
             raise TypeError(f"Cannot concatenate Message with {type(other).__name__}")
-        return Message(parts=self.parts + other.parts)
+        return Message(
+            parts=self.parts + other.parts,
+            created_at=min(self.created_at, other.created_at),
+            completed_at=max(self.completed_at, other.completed_at),
+        )
 
     def __str__(self) -> str:
         return "".join(
@@ -134,7 +140,7 @@ class Message(BaseModel):
                 parts[-1] = join(parts[-1], part)
             else:
                 parts.append(part)
-        return Message(parts=parts)
+        return Message(parts=parts, created_at=self.created_at, completed_at=self.completed_at)
 
 
 AgentName = str
@@ -185,6 +191,8 @@ class Run(BaseModel):
     await_request: AwaitRequest | None = None
     output: list[Message] = []
     error: Error | None = None
+    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
+    finished_at: datetime | None = None
 
 
 class MessageCreatedEvent(BaseModel):

{acp_sdk-0.7.3 → acp_sdk-0.8.0}/src/acp_sdk/models/schemas.py

@@ -1,6 +1,10 @@
 from pydantic import BaseModel
 
-from acp_sdk.models.models import Agent, AgentName, AwaitResume, Message, Run, RunMode, SessionId
+from acp_sdk.models.models import Agent, AgentName, AwaitResume, Event, Message, Run, RunMode, SessionId
+
+
+class PingResponse(BaseModel):
+    pass
 
 
 class AgentsListResponse(BaseModel):
@@ -37,3 +41,7 @@ class RunReadResponse(Run):
 
 class RunCancelResponse(Run):
     pass
+
+
+class RunEventsListResponse(BaseModel):
+    events: list[Event]

{acp_sdk-0.7.3 → acp_sdk-0.8.0}/src/acp_sdk/server/app.py

@@ -21,6 +21,7 @@ from acp_sdk.models import (
     RunCancelResponse,
     RunCreateRequest,
     RunCreateResponse,
+    RunEventsListResponse,
     RunId,
     RunMode,
     RunReadResponse,
@@ -29,6 +30,7 @@ from acp_sdk.models import (
     SessionId,
 )
 from acp_sdk.models.errors import ACPError
+from acp_sdk.models.schemas import PingResponse
 from acp_sdk.server.agent import Agent
 from acp_sdk.server.bundle import RunBundle
 from acp_sdk.server.errors import (
@@ -104,9 +106,9 @@ def create_app(
         agent = find_agent(name)
         return AgentModel(name=agent.name, description=agent.description, metadata=agent.metadata)
 
-    @app.get("/healthcheck")
-    async def healthcheck() -> str:
-        return "OK"
+    @app.get("/ping")
+    async def ping() -> PingResponse:
+        return PingResponse()
 
     @app.post("/runs")
     async def create_run(request: RunCreateRequest) -> RunCreateResponse:
@@ -155,6 +157,11 @@ def create_app(
         bundle = find_run_bundle(run_id)
         return bundle.run
 
+    @app.get("/runs/{run_id}/events")
+    async def list_run_events(run_id: RunId) -> RunEventsListResponse:
+        bundle = find_run_bundle(run_id)
+        return RunEventsListResponse(events=bundle.events)
+
     @app.post("/runs/{run_id}")
     async def resume_run(run_id: RunId, request: RunResumeRequest) -> RunResumeResponse:
         bundle = find_run_bundle(run_id)

{acp_sdk-0.7.3 → acp_sdk-0.8.0}/src/acp_sdk/server/bundle.py

@@ -2,6 +2,7 @@ import asyncio
 import logging
 from collections.abc import AsyncGenerator
 from concurrent.futures import ThreadPoolExecutor
+from datetime import datetime, timezone
 
 from pydantic import BaseModel, ValidationError
 
@@ -43,6 +44,7 @@ class RunBundle:
         self.history = history
 
         self.stream_queue: asyncio.Queue[Event] = asyncio.Queue()
+        self.events: list[Event] = []
 
         self.await_queue: asyncio.Queue[AwaitResume] = asyncio.Queue(maxsize=1)
         self.await_or_terminate_event = asyncio.Event()
@@ -58,7 +60,9 @@ class RunBundle:
             self.stream_queue.task_done()
 
     async def emit(self, event: Event) -> None:
-        await self.stream_queue.put(event)
+        freeze = event.model_copy(deep=True)
+        self.events.append(freeze)
+        await self.stream_queue.put(freeze)
 
     async def await_(self) -> AwaitResume:
         await self.stream_queue.put(None)
@@ -92,7 +96,9 @@ class RunBundle:
             async def flush_message() -> None:
                 nonlocal in_message
                 if in_message:
-                    await self.emit(MessageCompletedEvent(message=self.run.output[-1]))
+                    message = self.run.output[-1]
+                    message.completed_at = datetime.now(timezone.utc)
+                    await self.emit(MessageCompletedEvent(message=message))
                     in_message = False
 
             try:
@@ -114,7 +120,7 @@ class RunBundle:
                         if isinstance(next, str):
                             next = MessagePart(content=next)
                         if not in_message:
-                            self.run.output.append(Message(parts=[]))
+                            self.run.output.append(Message(parts=[], completed_at=None))
                             in_message = True
                             await self.emit(MessageCreatedEvent(message=self.run.output[-1]))
                         self.run.output[-1].parts.append(next)
@@ -149,10 +155,12 @@ class RunBundle:
             except StopAsyncIteration:
                 await flush_message()
                 self.run.status = RunStatus.COMPLETED
+                self.run.finished_at = datetime.now(timezone.utc)
                 await self.emit(RunCompletedEvent(run=self.run))
                 run_logger.info("Run completed")
             except asyncio.CancelledError:
                 self.run.status = RunStatus.CANCELLED
+                self.run.finished_at = datetime.now(timezone.utc)
                 await self.emit(RunCancelledEvent(run=self.run))
                 run_logger.info("Run cancelled")
             except Exception as e:
@@ -161,6 +169,7 @@ class RunBundle:
                 else:
                     self.run.error = Error(code=ErrorCode.SERVER_ERROR, message=str(e))
                 self.run.status = RunStatus.FAILED
+                self.run.finished_at = datetime.now(timezone.utc)
                 await self.emit(RunFailedEvent(run=self.run))
                 run_logger.exception("Run failed")
                 raise

{acp_sdk-0.7.3 → acp_sdk-0.8.0}/tests/e2e/test_suites/test_discovery.py

@@ -4,6 +4,12 @@ from acp_sdk.models import Agent
 from acp_sdk.server import Server
 
 
+@pytest.mark.asyncio
+async def test_ping(server: Server, client: Client) -> None:
+    await client.ping()
+    assert True
+
+
 @pytest.mark.asyncio
 async def test_agents_list(server: Server, client: Client) -> None:
     async for agent in client.agents():

{acp_sdk-0.7.3 → acp_sdk-0.8.0}/tests/e2e/test_suites/test_runs.py

@@ -9,8 +9,8 @@ from acp_sdk.models import (
     ErrorCode,
     Message,
     MessageAwaitResume,
-    MessageCreatedEvent,
     MessagePart,
+    MessagePartEvent,
     RunCompletedEvent,
     RunCreatedEvent,
     RunInProgressEvent,
@@ -51,6 +51,24 @@ async def test_run_status(server: Server, client: Client) -> None:
     assert run.status == RunStatus.COMPLETED
 
 
+@pytest.mark.asyncio
+async def test_run_events(server: Server, client: Client) -> None:
+    run = await client.run_sync(agent="echo", input=input)
+    events = [event async for event in client.run_events(run_id=run.run_id)]
+    assert isinstance(events[0], RunCreatedEvent)
+    assert isinstance(events[-1], RunCompletedEvent)
+
+
+@pytest.mark.asyncio
+async def test_run_events_are_stream(server: Server, client: Client) -> None:
+    stream = [event async for event in client.run_stream(agent="echo", input=input)]
+    print(stream)
+    assert isinstance(stream[0], RunCreatedEvent)
+    events = [event async for event in client.run_events(run_id=stream[0].run.run_id)]
+    print(events)
+    assert stream == events
+
+
 @pytest.mark.asyncio
 async def test_failure(server: Server, client: Client) -> None:
     run = await client.run_sync(agent="failer", input=input)
@@ -184,11 +202,11 @@ async def test_artifact_streaming(server: Server, client: Client) -> None:
     assert isinstance(events[0], RunCreatedEvent)
     assert isinstance(events[-1], RunCompletedEvent)
 
-    message_events = [e for e in events if isinstance(e, MessageCreatedEvent)]
+    message_part_events = [e for e in events if isinstance(e, MessagePartEvent)]
     artifact_events = [e for e in events if isinstance(e, ArtifactEvent)]
 
-    assert len(message_events) == 1
-    assert message_events[0].message.parts[0].content == "Processing with artifacts"
+    assert len(message_part_events) == 1
+    assert message_part_events[0].part.content == "Processing with artifacts"
 
     assert len(artifact_events) == 3
 

{acp_sdk-0.7.3 → acp_sdk-0.8.0}/tests/unit/client/test_client.py

@@ -3,8 +3,16 @@ import uuid
 
 import pytest
 from acp_sdk.client import Client
-from acp_sdk.models import Agent, AgentsListResponse, Message, MessagePart, Run, RunCompletedEvent
-from acp_sdk.models.models import MessageAwaitResume
+from acp_sdk.models import (
+    Agent,
+    AgentsListResponse,
+    Message,
+    MessageAwaitResume,
+    MessagePart,
+    Run,
+    RunCompletedEvent,
+    RunEventsListResponse,
+)
 from pytest_httpx import HTTPXMock
 
 mock_agent = Agent(name="mock")
@@ -128,6 +136,20 @@ async def test_run_resume_stream(httpx_mock: HTTPXMock) -> None:
             assert event == mock_event
 
 
+@pytest.mark.asyncio
+async def test_run_events(httpx_mock: HTTPXMock) -> None:
+    mock_event = RunCompletedEvent(run=mock_run)
+    httpx_mock.add_response(
+        url=f"http://test/runs/{mock_run.run_id}/events",
+        method="GET",
+        content=RunEventsListResponse(events=[mock_event]).model_dump_json(),
+    )
+
+    async with Client(base_url="http://test") as client:
+        async for event in client.run_events(run_id=mock_run.run_id):
+            assert event == mock_event
+
+
 @pytest.mark.asyncio
 async def test_session(httpx_mock: HTTPXMock) -> None:
     httpx_mock.add_response(url="http://test/runs", method="POST", content=mock_run.model_dump_json(), is_reusable=True)

{acp_sdk-0.7.3 → acp_sdk-0.8.0}/tests/unit/client/test_utils.py

@@ -18,7 +18,8 @@ from acp_sdk.models import Message, MessagePart
 )
 def test_input_to_messages(input: Input, messages: list[Message]) -> None:
     result = input_to_messages(input)
-    assert result == messages
+    for r, m in zip(result, messages):
+        assert r.parts == m.parts
 
 
 @pytest.mark.parametrize(

{acp_sdk-0.7.3 → acp_sdk-0.8.0}/tests/unit/models/test_models.py

@@ -1,18 +1,30 @@
 import pytest
 from acp_sdk.models.models import Message, MessagePart
 
+timestamp = "2021-09-09T22:02:47.89Z"
+
 
 @pytest.mark.parametrize(
     "first,second,result",
     [
         (
-            Message(parts=[MessagePart(content_type="text/plain", content="Foo")]),
-            Message(parts=[MessagePart(content_type="text/plain", content="Bar")]),
+            Message(
+                parts=[MessagePart(content_type="text/plain", content="Foo")],
+                created_at=timestamp,
+                completed_at=timestamp,
+            ),
+            Message(
+                parts=[MessagePart(content_type="text/plain", content="Bar")],
+                created_at=timestamp,
+                completed_at=timestamp,
+            ),
             Message(
                 parts=[
                     MessagePart(content_type="text/plain", content="Foo"),
                     MessagePart(content_type="text/plain", content="Bar"),
-                ]
+                ],
+                created_at=timestamp,
+                completed_at=timestamp,
             ),
         )
     ],
@@ -29,9 +41,15 @@ def test_message_add(first: Message, second: Message, result: Message) -> None:
                 parts=[
                     MessagePart(content_type="text/plain", content="Foo"),
                     MessagePart(content_type="text/plain", content="Bar"),
-                ]
+                ],
+                created_at=timestamp,
+                completed_at=timestamp,
+            ),
+            Message(
+                parts=[MessagePart(content_type="text/plain", content="FooBar")],
+                created_at=timestamp,
+                completed_at=timestamp,
             ),
-            Message(parts=[MessagePart(content_type="text/plain", content="FooBar")]),
         ),
         (
             Message(
@@ -40,14 +58,18 @@ def test_message_add(first: Message, second: Message, result: Message) -> None:
                     MessagePart(content_type="text/html", content="<head>"),
                     MessagePart(content_type="text/plain", content="Foo"),
                     MessagePart(content_type="text/plain", content="Bar"),
-                ]
+                ],
+                created_at=timestamp,
+                completed_at=timestamp,
             ),
             Message(
                 parts=[
                     MessagePart(content_type="text/plain", content="Foo"),
                     MessagePart(content_type="text/html", content="<head>"),
                     MessagePart(content_type="text/plain", content="FooBar"),
-                ]
+                ],
+                created_at=timestamp,
+                completed_at=timestamp,
             ),
         ),
     ],