2.4.4

AgentProtocol

Package: flyte.ai.agents

Minimal protocol that any agent must satisfy to work with :class:AgentChatAppEnvironment.

protocol AgentProtocol()

Methods

Method Description
run() Process message (with prior memory) and return an :class:AgentResult.
tool_descriptions() Return JSON-friendly metadata for every registered tool.

run() 

def run(
    message: str,
    memory: list[dict[str, Any]] | 'MemoryStore' | None,
) -> AgentResult

Process message (with prior memory) and return an :class:AgentResult.

memory may be a list[dict] of prior messages (e.g. a chat history) or a :class:MemoryStore for durable, cross-run state.

Synchronous entry point. In async contexts, use run.aio(...).

Parameter Type Description
message str
memory list[dict[str, Any]] | 'MemoryStore' | None

tool_descriptions() 

def tool_descriptions()

Return JSON-friendly metadata for every registered tool.

Each dict should contain at least name, signature, and description keys.