autogen.agentchat.realtime.experimental.clients.RealtimeClientProtocol

RealtimeClientProtocol

RealtimeClientProtocol(*args, **kwargs)

Base class for protocol classes.
Protocol classes are defined as::
class Proto(Protocol):
def meth(self) -> int:
…
Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).
For example::
class C:
def meth(self) -> int:
return 0

def func(x: Proto) -> int:
return x.meth()

func(C()) # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures.
Protocol classes can be generic, they are defined as::
class GenProtoT:
def meth(self) -> T:
…

Parameters:

Name	Description
*args
**kwargs

Static Methods

get_factory

get_factory(
    llm_config: LLMConfig | dict[str, Any],
    logger: Logger,
    **kwargs: Any
) -> Callable[[], RealtimeClientProtocol] | None

Create a Realtime API client.

Parameters:

Name	Description
llm_config	The config for the client. Type: LLMConfig | dict[str, typing.Any]
logger	The logger to use for logging events. Type: logging.Logger
**kwargs	Additional arguments. Type: Any

Returns:

Type	Description
Callable[[], RealtimeClientProtocol] | None	RealtimeClientProtocol: The Realtime API client is returned if the model matches the pattern

Instance Methods

connect

connect(self) -> AsyncContextManager[None]

read_events

read_events(self) -> AsyncGenerator[RealtimeEvent, None]

Read events from a Realtime Client.

send_audio

send_audio(self, audio: str) -> None

Send audio to a Realtime API.

Parameters:

Name	Description
audio	The audio to send. Type: str

send_function_result

send_function_result(
    self,
    call_id: str,
    result: str
) -> None

Send the result of a function call to a Realtime API.

Parameters:

Name	Description
call_id	The ID of the function call. Type: str
result	The result of the function call. Type: str

send_text

send_text(
    self,
    *,
    role: Literal['user', 'assistant', 'system'],
    text: str
) -> None

Send a text message to a Realtime API.

Parameters:

Name	Description
role	The role of the message. Type: Literal[‘user’, ‘assistant’, ‘system’]
text	The text of the message. Type: str

session_update

session_update(self, session_options: dict[str, Any]) -> None

Send a session update to a Realtime API.

Parameters:

Name	Description
session_options	The session options to update. Type: dict[str, typing.Any]

truncate_audio

truncate_audio(
    self,
    audio_end_ms: int,
    content_index: int,
    item_id: str
) -> None

Truncate audio in a Realtime API.

Parameters:

Name	Description
audio_end_ms	The end of the audio to truncate. Type: int
content_index	The index of the content to truncate. Type: int
item_id	The ID of the item to truncate. Type: str