Module `livekit.plugins.xai.realtime.realtime_model`

Classes

class RealtimeModel (*, voice: Literal['ara', 'eve', 'leo'] | str | livekit.agents.types.NotGiven | None = 'ara', api_key: str | None = None, base_url: str | livekit.agents.types.NotGiven = NOT_GIVEN, turn_detection: openai.types.beta.realtime.session.TurnDetection | livekit.agents.types.NotGiven | None = ServerVad(type='server_vad', create_response=True, idle_timeout_ms=None, interrupt_response=True, prefix_padding_ms=300, silence_duration_ms=200, threshold=0.5), http_session: aiohttp.client.ClientSession | None = None, max_session_duration: float | livekit.agents.types.NotGiven | None = NOT_GIVEN, conn_options: livekit.agents.types.APIConnectOptions = APIConnectOptions(max_retry=3, retry_interval=2.0, timeout=10.0))

Expand source code

class RealtimeModel(openai.realtime.RealtimeModel):
    def __init__(
        self,
        *,
        voice: NotGivenOr[GrokVoices | str | None] = "ara",
        api_key: str | None = None,
        base_url: NotGivenOr[str] = NOT_GIVEN,
        turn_detection: NotGivenOr[TurnDetection | None] = XAI_DEFAULT_TURN_DETECTION,
        http_session: aiohttp.ClientSession | None = None,
        max_session_duration: NotGivenOr[float | None] = NOT_GIVEN,
        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
    ) -> None:
        api_key = api_key or os.environ.get("XAI_API_KEY")
        if api_key is None:
            raise ValueError(
                "The api_key client option must be set either by passing api_key "
                "to the client or by setting the XAI_API_KEY environment variable"
            )

        if is_given(base_url):
            base_url_val = base_url
        else:
            base_url_val = XAI_BASE_URL
        super().__init__(
            base_url=base_url_val,
            model="grok-4-1-fast-non-reasoning",
            voice=voice,
            api_key=api_key,
            modalities=["audio"],
            turn_detection=turn_detection,
            http_session=http_session if is_given(http_session) else None,
            max_session_duration=max_session_duration if is_given(max_session_duration) else None,
            conn_options=conn_options,
        )

Initialize a Realtime model client for OpenAI or Azure OpenAI.

Args

model : str: Realtime model name, e.g., "gpt-realtime".
voice : str: Voice used for audio responses. Defaults to "marin".
modalities (list[Literal["text", "audio"]] | NotGiven): Modalities to enable. Defaults to ["text", "audio"] if not provided.
tool_choice : llm.ToolChoice | None | NotGiven: Tool selection policy for responses.
base_url : str | NotGiven: HTTP base URL of the OpenAI/Azure API. If not provided, uses OPENAI_BASE_URL for OpenAI; for Azure, constructed from AZURE_OPENAI_ENDPOINT.
input_audio_transcription : AudioTranscription | None | NotGiven: Options for transcribing input audio.
input_audio_noise_reduction : NoiseReductionType | NoiseReduction | InputAudioNoiseReduction | None | NotGiven: Input audio noise reduction settings.
turn_detection : RealtimeAudioInputTurnDetection | None | NotGiven: Server-side turn-detection options.
speed : float | NotGiven: Audio playback speed multiplier.
tracing : Tracing | None | NotGiven: Tracing configuration for OpenAI Realtime.
api_key : str | None: OpenAI API key. If None and not using Azure, read from OPENAI_API_KEY.
http_session : aiohttp.ClientSession | None: Optional shared HTTP session.
azure_deployment : str | None: Azure deployment name. Presence of any Azure-specific option enables Azure mode.
entra_token : str | None: Azure Entra token auth (alternative to api_key).
api_version : str | None: Azure OpenAI API version appended as query parameter.
max_session_duration : float | None | NotGiven: Seconds before recycling the connection.
conn_options : APIConnectOptions: Retry/backoff and connection settings.
temperature : float | NotGiven: Deprecated; ignored by Realtime v1.

Raises

ValueError: If OPENAI_API_KEY is missing in non-Azure mode, or if Azure endpoint cannot be determined when in Azure mode.

Examples

Basic OpenAI usage:

from livekit.plugins.openai.realtime import RealtimeModel
from openai.types import realtime

model = RealtimeModel(
    voice="marin",
    modalities=["audio"],
    input_audio_transcription=realtime.AudioTranscription(
        model="gpt-4o-transcribe",
    ),
    input_audio_noise_reduction="near_field",
    turn_detection=realtime.realtime_audio_input_turn_detection.SemanticVad(
        type="semantic_vad",
        create_response=True,
        eagerness="auto",
        interrupt_response=True,
    ),
)
session = AgentSession(llm=model)

Ancestors

livekit.plugins.openai.realtime.realtime_model.RealtimeModel
livekit.agents.llm.realtime.RealtimeModel