autogen.agentchat.realtime.experimental.RealtimeAgent

RealtimeAgent

RealtimeAgent(
    *,
    name: str,
    audio_adapter: RealtimeObserver | None = None,
    system_message: str = 'You are a helpful AI Assistant.',
    llm_config: LLMConfig | dict[str, Any] | None = None,
    logger: Logger | None = None,
    observers: list[RealtimeObserver] | None = None,
    **client_kwargs: Any
)

(Experimental) Agent for interacting with the Realtime Clients.

Parameters:

Name	Description
name	Type: str
audio_adapter	Type: RealtimeObserver | None Default: None
system_message	Type: str Default: ‘You are a helpful AI Assistant.‘
llm_config	Type: LLMConfig | dict[str, typing.Any] | None Default: None
logger	Type: logging.Logger | None Default: None
observers	Type: list[RealtimeObserver] | None Default: None
**client_kwargs	Type: Any

Instance Attributes

logger

Get the logger for the agent.

realtime_client

Get the OpenAI Realtime Client.

registered_realtime_tools

Get the registered realtime tools.

system_message

Get the system message for the agent.

Instance Methods

register_observer

register_observer(self, observer: RealtimeObserver) -> None

Register an observer with the Realtime Agent.

Parameters:

Name	Description
observer	The observer to register. Type: RealtimeObserver

register_realtime_function

register_realtime_function(
    self,
    *,
    name: str | None = None,
    description: str | None = None
) -> Callable[[~F | Tool], Tool]

Decorator for registering a function to be used by an agent.

Parameters:

Name	Description
name	The name of the function. Type: str | None Default: None
description	The description of the function. Type: str | None Default: None

Returns:

Type	Description
Callable[[~F | Tool], Tool]	Callable[[Union[F, Tool]], Tool]: The decorator for registering a function.

run

run(self) -> None

Run the agent.

start_observers

start_observers(self) -> None