Skip to content

vllm.entrypoints.openai.realtime.protocol

ErrorEvent

Bases: OpenAIBaseModel

Error notification

Source code in vllm/entrypoints/openai/realtime/protocol.py
class ErrorEvent(OpenAIBaseModel):
    """Error notification"""

    type: Literal["error"] = "error"
    error: str
    code: str | None = None

code class-attribute instance-attribute

code: str | None = None

error instance-attribute

error: str

type class-attribute instance-attribute

type: Literal['error'] = 'error'

InputAudioBufferAppend

Bases: OpenAIBaseModel

Append audio chunk to buffer

Source code in vllm/entrypoints/openai/realtime/protocol.py
class InputAudioBufferAppend(OpenAIBaseModel):
    """Append audio chunk to buffer"""

    type: Literal["input_audio_buffer.append"] = "input_audio_buffer.append"
    audio: str  # base64-encoded PCM16 @ 16kHz

audio instance-attribute

audio: str

type class-attribute instance-attribute

type: Literal["input_audio_buffer.append"] = (
    "input_audio_buffer.append"
)

InputAudioBufferCommit

Bases: OpenAIBaseModel

Process accumulated audio buffer

Source code in vllm/entrypoints/openai/realtime/protocol.py
class InputAudioBufferCommit(OpenAIBaseModel):
    """Process accumulated audio buffer"""

    type: Literal["input_audio_buffer.commit"] = "input_audio_buffer.commit"
    final: bool = False

final class-attribute instance-attribute

final: bool = False

type class-attribute instance-attribute

type: Literal["input_audio_buffer.commit"] = (
    "input_audio_buffer.commit"
)

SessionCreated

Bases: OpenAIBaseModel

Connection established notification

Source code in vllm/entrypoints/openai/realtime/protocol.py
class SessionCreated(OpenAIBaseModel):
    """Connection established notification"""

    type: Literal["session.created"] = "session.created"
    id: str = Field(default_factory=lambda: f"sess-{random_uuid()}")
    created: int = Field(default_factory=lambda: int(time.time()))

created class-attribute instance-attribute

created: int = Field(default_factory=lambda: int(time()))

id class-attribute instance-attribute

id: str = Field(
    default_factory=lambda: f"sess-{random_uuid()}"
)

type class-attribute instance-attribute

type: Literal['session.created'] = 'session.created'

SessionUpdate

Bases: OpenAIBaseModel

Configure session parameters

Source code in vllm/entrypoints/openai/realtime/protocol.py
class SessionUpdate(OpenAIBaseModel):
    """Configure session parameters"""

    type: Literal["session.update"] = "session.update"
    model: str | None = None

model class-attribute instance-attribute

model: str | None = None

type class-attribute instance-attribute

type: Literal['session.update'] = 'session.update'

TranscriptionDelta

Bases: OpenAIBaseModel

Incremental transcription text

Source code in vllm/entrypoints/openai/realtime/protocol.py
class TranscriptionDelta(OpenAIBaseModel):
    """Incremental transcription text"""

    type: Literal["transcription.delta"] = "transcription.delta"
    delta: str  # Incremental text

delta instance-attribute

delta: str

type class-attribute instance-attribute

type: Literal["transcription.delta"] = "transcription.delta"

TranscriptionDone

Bases: OpenAIBaseModel

Final transcription with usage stats

Source code in vllm/entrypoints/openai/realtime/protocol.py
class TranscriptionDone(OpenAIBaseModel):
    """Final transcription with usage stats"""

    type: Literal["transcription.done"] = "transcription.done"
    text: str  # Complete transcription
    usage: UsageInfo | None = None

text instance-attribute

text: str

type class-attribute instance-attribute

type: Literal['transcription.done'] = 'transcription.done'

usage class-attribute instance-attribute

usage: UsageInfo | None = None