Skip to content

docs(agentex): use canonical agentex.protocol.acp import paths #254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
max-parke-scale wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(agentex): use canonical agentex.protocol.acp import paths #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions agentex/docs/docs/acp/agentic/base.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion agentex/docs/docs/acp/agentic/temporal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions agentex/docs/docs/agent_types/async/base.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions agentex/docs/docs/agent_types/async/temporal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions agentex/docs/docs/agent_types/sync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion agentex/docs/docs/api/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
8 changes: 4 additions & 4 deletions agentex/docs/docs/api/types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion agentex/docs/docs/concepts/streaming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down
6 changes: 3 additions & 3 deletions agentex/docs/docs/getting_started/project_structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion agentex/docs/docs/temporal_development/openai_integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading