GeminiRealtimeClient

GeminiRealtimeClient(
    *,
    llm_config: dict[str, typing.Any],
    logger: logging.Logger | None = None
)

(Experimental) Client for Gemini Realtime API.

(Experimental) Client for Gemini Realtime API.

Parameters:
NameDescription
llm_configThe config for the client.

Type: dict[str, typing.Any]
loggerType: logging.Logger | None

Default: None

Static Methods

get_factory

get_factory(
    llm_config: dict[str, typing.Any],
    logger: logging.Logger,
    **kwargs: Any
) -> 

Create a Realtime API client.

Parameters:
NameDescription
llm_configType: dict[str, typing.Any]
loggerThe logger for the client.

Type: logging.Logger
**kwargsType: Any

Instance Attributes

connection


Get the Gemini WebSocket connection.

logger


Get the logger for the Gemini Realtime API.

Instance Methods

connect

connect(self) -> AsyncGenerator[None, None]

Connect to the Gemini Realtime API.


read_events

read_events(self) -> AsyncGenerator[autogen.agentchat.realtime.experimental.realtime_events.RealtimeEvent, None]

Read Events from the Gemini Realtime API.


send_audio

send_audio(self, audio: str) -> None

Send audio to the Gemini Realtime API.

Parameters:
NameDescription
audioThe 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 the Gemini Realtime API.

Parameters:
NameDescription
call_idThe ID of the function call.

Type: str
resultThe result of the function call.

Type: str

send_text

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

Send a text message to the Gemini Realtime API.

Parameters:
NameDescription
roleThe role of the message.

Type: Literal['user', 'assistant', 'system']
textThe text of the message.

Type: str
turn_completeType: bool

Default: True

session_update

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

Record session updates to be applied when the connection is established.

Parameters:
NameDescription
session_optionsThe 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
Parameters:
NameDescription
audio_end_msType: int
content_indexType: int
item_idType: str