From 165038d362a04d010e32b634e5ed21c6538de899 Mon Sep 17 00:00:00 2001 From: Max Parke Date: Wed, 27 May 2026 10:58:58 -0400 Subject: [PATCH] docs(agentex): use canonical agentex.protocol.acp import paths Protocol-shape types (RPCMethod, CreateTaskParams, SendMessageParams, SendEventParams, CancelTaskParams) moved from agentex.lib.types.acp to the new canonical agentex.protocol.acp location in scaleapi/scale-agentex-python#371. The old path still works via a back-compat shim, but scaffolded user code following these docs should start on the canonical path. Updates: - 8 `from agentex.lib.types.acp import ...` imports in code samples - 2 `::: agentex.lib.types.acp.X` mkdocstrings references in API docs No content / behavior changes; same classes, new import path. The other lib/types/* modules (tracing, agent_card, credentials, etc.) stay on the old path because they have heavier transitive deps and weren't migrated. Co-Authored-By: Claude Opus 4.7 (1M context) --- agentex/docs/docs/acp/agentic/base.md | 6 +++--- agentex/docs/docs/acp/agentic/temporal.md | 2 +- agentex/docs/docs/agent_types/async/base.md | 8 ++++---- agentex/docs/docs/agent_types/async/temporal.md | 6 +++--- agentex/docs/docs/agent_types/sync.md | 4 ++-- agentex/docs/docs/api/overview.md | 2 +- agentex/docs/docs/api/types.md | 8 ++++---- agentex/docs/docs/concepts/streaming.md | 2 +- agentex/docs/docs/getting_started/project_structure.md | 6 +++--- .../docs/docs/temporal_development/openai_integration.md | 2 +- 10 files changed, 23 insertions(+), 23 deletions(-) diff --git a/agentex/docs/docs/acp/agentic/base.md b/agentex/docs/docs/acp/agentic/base.md index f6e896c8..6eff1d00 100644 --- a/agentex/docs/docs/acp/agentic/base.md +++ b/agentex/docs/docs/acp/agentic/base.md @@ -157,7 +157,7 @@ async def process_workflow_step(params: SendEventParams): Used in `@acp.on_task_create` for task initialization: -::: agentex.lib.types.acp.CreateTaskParams +::: agentex.protocol.acp.CreateTaskParams options: heading_level: 4 show_root_heading: false @@ -167,7 +167,7 @@ Used in `@acp.on_task_create` for task initialization: Used in `@acp.on_task_event_send` for processing events: -::: agentex.lib.types.acp.SendEventParams +::: agentex.protocol.acp.SendEventParams options: heading_level: 4 show_root_heading: false @@ -177,7 +177,7 @@ Used in `@acp.on_task_event_send` for processing events: Used in `@acp.on_task_cancel` for cleanup: -::: agentex.lib.types.acp.CancelTaskParams +::: agentex.protocol.acp.CancelTaskParams options: heading_level: 4 show_root_heading: false diff --git a/agentex/docs/docs/acp/agentic/temporal.md b/agentex/docs/docs/acp/agentic/temporal.md index a17d7fd6..20776e72 100644 --- a/agentex/docs/docs/acp/agentic/temporal.md +++ b/agentex/docs/docs/acp/agentic/temporal.md @@ -48,7 +48,7 @@ Instead of ACP handlers, you implement standard Temporal workflows: ```python from temporalio import workflow from agentex import adk -from agentex.lib.types.acp import CreateTaskParams, SendEventParams +from agentex.protocol.acp import CreateTaskParams, SendEventParams from agentex.core.temporal.workflows.workflow import BaseWorkflow from agentex.core.temporal.types.workflow import SignalName from agentex.types.message_author import MessageAuthor diff --git a/agentex/docs/docs/agent_types/async/base.md b/agentex/docs/docs/agent_types/async/base.md index 637e48b5..45e69b1f 100644 --- a/agentex/docs/docs/agent_types/async/base.md +++ b/agentex/docs/docs/agent_types/async/base.md @@ -39,7 +39,7 @@ sequenceDiagram ```python from agentex.lib.sdk.fastacp.fastacp import FastACP from agentex.lib.types.fastacp import AsyncACPConfig -from agentex.lib.types.acp import CreateTaskParams, SendEventParams, CancelTaskParams +from agentex.protocol.acp import CreateTaskParams, SendEventParams, CancelTaskParams from agentex.lib import adk # Create Base Async ACP server @@ -78,7 +78,7 @@ async def handle_task_cancel(params: CancelTaskParams) -> None: Used in `@acp.on_task_create` for task initialization: -::: agentex.lib.types.acp.CreateTaskParams +::: agentex.protocol.acp.CreateTaskParams options: heading_level: 4 show_root_heading: false @@ -88,7 +88,7 @@ Used in `@acp.on_task_create` for task initialization: Used in `@acp.on_task_event_send` for processing events: -::: agentex.lib.types.acp.SendEventParams +::: agentex.protocol.acp.SendEventParams options: heading_level: 4 show_root_heading: false @@ -98,7 +98,7 @@ Used in `@acp.on_task_event_send` for processing events: Used in `@acp.on_task_cancel` for cleanup: -::: agentex.lib.types.acp.CancelTaskParams +::: agentex.protocol.acp.CancelTaskParams options: heading_level: 4 show_root_heading: false diff --git a/agentex/docs/docs/agent_types/async/temporal.md b/agentex/docs/docs/agent_types/async/temporal.md index 2e8c26cf..b1e2a367 100644 --- a/agentex/docs/docs/agent_types/async/temporal.md +++ b/agentex/docs/docs/agent_types/async/temporal.md @@ -51,7 +51,7 @@ sequenceDiagram ```python from temporalio import workflow from agentex import adk -from agentex.lib.types.acp import CreateTaskParams, SendEventParams +from agentex.protocol.acp import CreateTaskParams, SendEventParams from agentex.core.temporal.workflows.workflow import BaseWorkflow from agentex.core.temporal.types.workflow import SignalName from agentex.types.message_author import MessageAuthor @@ -159,7 +159,7 @@ if __name__ == "__main__": Used in `@workflow.run` (replaces `@acp.on_task_create`): -::: agentex.lib.types.acp.CreateTaskParams +::: agentex.protocol.acp.CreateTaskParams options: heading_level: 4 show_root_heading: false @@ -169,7 +169,7 @@ Used in `@workflow.run` (replaces `@acp.on_task_create`): Used in `@workflow.signal(name=SignalName.RECEIVE_EVENT)` (replaces `@acp.on_task_event_send`): -::: agentex.lib.types.acp.SendEventParams +::: agentex.protocol.acp.SendEventParams options: heading_level: 4 show_root_heading: false diff --git a/agentex/docs/docs/agent_types/sync.md b/agentex/docs/docs/agent_types/sync.md index e1fe12b2..f269791a 100644 --- a/agentex/docs/docs/agent_types/sync.md +++ b/agentex/docs/docs/agent_types/sync.md @@ -31,7 +31,7 @@ sequenceDiagram ```python from agentex.lib.sdk.fastacp.fastacp import FastACP -from agentex.lib.types.acp import SendMessageParams +from agentex.protocol.acp import SendMessageParams from agentex.types.text_content import TextContent from agentex.types.message_author import MessageAuthor @@ -61,7 +61,7 @@ async def handle_message(params: SendMessageParams): The `@acp.on_message_send` handler receives: -::: agentex.lib.types.acp.SendMessageParams +::: agentex.protocol.acp.SendMessageParams options: heading_level: 4 show_root_heading: false diff --git a/agentex/docs/docs/api/overview.md b/agentex/docs/docs/api/overview.md index 4d67c952..c244dc4d 100644 --- a/agentex/docs/docs/api/overview.md +++ b/agentex/docs/docs/api/overview.md @@ -62,7 +62,7 @@ Python library for use **WITHIN** your agent code. The ADK provides high-level a from agentex.types.task_message_content import TaskMessageContent from agentex.types.text_content import TextContent from agentex.types.message_author import MessageAuthor -from agentex.lib.types.acp import SendMessageParams, CreateTaskParams, SendEventParams +from agentex.protocol.acp import SendMessageParams, CreateTaskParams, SendEventParams from agentex.types.task import Task from agentex.types.event import Event ``` diff --git a/agentex/docs/docs/api/types.md b/agentex/docs/docs/api/types.md index 73f573f3..a767420a 100644 --- a/agentex/docs/docs/api/types.md +++ b/agentex/docs/docs/api/types.md @@ -6,19 +6,19 @@ Comprehensive API reference for all core object types in Agentex. These types ar ### CreateTaskParams -::: agentex.lib.types.acp.CreateTaskParams +::: agentex.protocol.acp.CreateTaskParams ### SendMessageParams -::: agentex.lib.types.acp.SendMessageParams +::: agentex.protocol.acp.SendMessageParams ### SendEventParams -::: agentex.lib.types.acp.SendEventParams +::: agentex.protocol.acp.SendEventParams ### CancelTaskParams -::: agentex.lib.types.acp.CancelTaskParams +::: agentex.protocol.acp.CancelTaskParams ## Agent diff --git a/agentex/docs/docs/concepts/streaming.md b/agentex/docs/docs/concepts/streaming.md index 24208ff6..80e0dba1 100644 --- a/agentex/docs/docs/concepts/streaming.md +++ b/agentex/docs/docs/concepts/streaming.md @@ -146,7 +146,7 @@ Here's a complete example showing how to stream content in an Async Agent: ```python from agentex.lib import adk -from agentex.lib.types.acp import SendEventParams +from agentex.protocol.acp import SendEventParams from agentex.types.text_content import TextContent from agentex.types.task_message_delta import TextDelta from agentex.types.task_message_update import ( diff --git a/agentex/docs/docs/getting_started/project_structure.md b/agentex/docs/docs/getting_started/project_structure.md index a71f7309..ff2a062a 100644 --- a/agentex/docs/docs/getting_started/project_structure.md +++ b/agentex/docs/docs/getting_started/project_structure.md @@ -42,7 +42,7 @@ Your ACP server defines how the agent responds to incoming messages. For sync ag ```python from agentex.lib.sdk.fastacp.fastacp import FastACP -from agentex.lib.types.acp import SendMessageParams +from agentex.protocol.acp import SendMessageParams from agentex.types.task_message_content import TaskMessageContent from agentex.types.text_content import TextContent @@ -111,7 +111,7 @@ The base async ACP server gives you a starting point for custom async implementa ```python from agentex.lib.sdk.fastacp.fastacp import FastACP from agentex.lib.types.fastacp import AgenticBaseACPConfig -from agentex.lib.types.acp import CreateTaskParams, SendEventParams, CancelTaskParams +from agentex.protocol.acp import CreateTaskParams, SendEventParams, CancelTaskParams # Create a base agentic ACP server acp = FastACP.create( @@ -216,7 +216,7 @@ Your workflow is where all the agent logic lives. It's a class that Temporal man import json from temporalio import workflow from agentex.lib import adk -from agentex.lib.types.acp import CreateTaskParams, SendEventParams +from agentex.protocol.acp import CreateTaskParams, SendEventParams from agentex.lib.core.temporal.workflows.workflow import BaseWorkflow from agentex.lib.core.temporal.types.workflow import SignalName from agentex.types.text_content import TextContent diff --git a/agentex/docs/docs/temporal_development/openai_integration.md b/agentex/docs/docs/temporal_development/openai_integration.md index cb1dfc3e..85202dee 100644 --- a/agentex/docs/docs/temporal_development/openai_integration.md +++ b/agentex/docs/docs/temporal_development/openai_integration.md @@ -146,7 +146,7 @@ The new streaming implementation uses Temporal's interceptor pattern to enable r # workflow.py from agents import Agent, Runner from agentex import adk -from agentex.lib.types.acp import SendEventParams +from agentex.protocol.acp import SendEventParams from agentex.lib.core.temporal.types.workflow import SignalName from agentex.types.text_content import TextContent from temporalio import workflow