agentscope.realtimeXAIRealtimeModel
class XAIRealtimeModel(RealtimeModelBase)agentscope/realtime/_xai/_model.py:18–379xAI 实时模型，处理低延迟的实时语音与多模态交互。位于 agentscope.realtime 包，继承自 RealtimeModelBase。核心成员包括 connect、close、events、push_audio、push_text、push_tool_result。
OpenAI-shaped, with three xAI departures: the audio format lives in a
nested session.audio block, the reply-side frames are the GA names
(response.output_audio.delta), and one response spans several
items, so events are grouped by response_id. The docs list no
conversation.item.truncate, so an interrupted reply is not
corrected on the provider side.
嵌套类摘要Nested Class Summary
| 类Class | 类型Kind | 说明Description |
|---|---|---|
Parameters | 类class | 参数，处理低延迟的实时语音与多模态交互。 Tuneables surfaced to the UI. |
构造器摘要Constructor Summary
| 构造器Constructor | 说明Description |
|---|---|
def __init__(model: str, credential: XAICredential, parameters: 'XAIRealtimeModel.Parameters | None' = None, model_card… | 初始化 `XAIRealtimeModel` 实例。 Initialize the xAI realtime model. |
属性摘要Property Summary
| 属性Property | 说明Description |
|---|---|
input_transcription_enabled | 读取 `input_transcription_enabled` 属性。 xAI always reports settled input transcription events. |
属性摘要Attribute Summary
| 属性Attribute | 类型Type | 说明Description | 值Value |
|---|---|---|---|
type | — | 类型字段。 | 'xai_realtime' |
supports_text_input | — | 支持文本输入字段。 | True |
方法摘要Method Summary
| 方法Method | 说明Description |
|---|---|
async def connect(instructions: str, tools: list[dict] | None = None, **kwargs: Any) -> Noneasync | 建立连接并完成初始化。 Open the WebSocket and send the session config. |
async def close() -> Noneasync | 关闭连接并释放相关资源。 Stop reading and close the WebSocket. |
async def events() -> AsyncIterator[me.ModelEvent]async | 返回事件。 Yield events until the session ends. |
async def push_audio(pcm: bytes) -> Noneasync | 设置推送音频。 Append PCM16 mono audio at :attr:`input_sample_rate`. |
async def push_text(text: str) -> Noneasync | 设置推送文本。 Send a text user turn and ask for the reply. |
async def push_tool_result(block: ToolResultBlock) -> Noneasync | 设置推送工具结果。 Send a ``function_call_output`` item. |
async def commit_turn() -> Noneasync | 返回提交轮次。 Commit the input buffer as one user turn. |
async def request_response() -> Noneasync | 返回请求响应。 Ask for a reply, cancelling one already in flight first. |
async def cancel_response() -> Noneasync | 返回取消响应。 Cancel the reply in flight, if any. |
构造器详情Constructor Detail
XAIRealtimeModel
def __init__(model: str, credential: XAICredential, parameters: 'XAIRealtimeModel.Parameters | None' = None, model_card: RealtimeModelCard | None = None) -> None初始化 XAIRealtimeModel 实例。
Initialize the xAI realtime model.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
model | str | 模型实例（类型 `str`）。The model name, e.g. `"grok-voice-latest"`. |
credential | XAICredential | xAI 凭证。The xAI credential. |
parameters默认default None | 'XAIRealtimeModel.Parameters | None' | 参数（类型 `'XAIRealtimeModel.Parameters | None'`）。Provider parameters; defaults are used if omitted. |
model_card默认default None | RealtimeModelCard | None | 模型卡片（类型 `RealtimeModelCard | None`）。The model card, looked up by name if omitted. |
agentscope/realtime/_xai/_model.py:63–88属性详情Attribute Detail
type
= 'xai_realtime'类型字段。
The type field.
agentscope/realtime/_xai/_model.py:55supports_text_input
= True支持文本输入字段。
The supports text input field.
agentscope/realtime/_xai/_model.py:56属性详情Property Detail
input_transcription_enabled
def input_transcription_enabled() -> bool读取 input_transcription_enabled 属性。
xAI always reports settled input transcription events.
agentscope/realtime/_xai/_model.py:59–61方法详情Method Detail
connect
async def connect(instructions: str, tools: list[dict] | None = None, **kwargs: Any) -> None建立连接并完成初始化。
Open the WebSocket and send the session config.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
instructions | str | 指令（类型 `str`）。The instructions. |
tools默认default None | list[dict] | None | 工具列表（类型 `list[dict] | None`）。The tools. |
kwargs | Any | 关键字参数（类型 `Any`）。The kwargs. |
agentscope/realtime/_xai/_model.py:94–122close
async def close() -> None关闭连接并释放相关资源。
Stop reading and close the WebSocket.
agentscope/realtime/_xai/_model.py:124–132events
async def events() -> AsyncIterator[me.ModelEvent]返回事件。
Yield events until the session ends.
agentscope/realtime/_xai/_model.py:134–140push_audio
async def push_audio(pcm: bytes) -> None设置推送音频。
Append PCM16 mono audio at :attr:input_sample_rate.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
pcm | bytes | pcm（类型 `bytes`）。The pcm. |
agentscope/realtime/_xai/_model.py:146–153push_text
async def push_text(text: str) -> None设置推送文本。
Send a text user turn and ask for the reply.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
text | str | 文本（类型 `str`）。The text. |
agentscope/realtime/_xai/_model.py:155–167push_tool_result
async def push_tool_result(block: ToolResultBlock) -> None设置推送工具结果。
Send a function_call_output item.
| 名称Name | 类型Type | 说明Description |
|---|---|---|
block | ToolResultBlock | 内容块（类型 `ToolResultBlock`）。The block. |
agentscope/realtime/_xai/_model.py:169–187commit_turn
async def commit_turn() -> None返回提交轮次。
Commit the input buffer as one user turn.
agentscope/realtime/_xai/_model.py:189–191request_response
async def request_response() -> None返回请求响应。
Ask for a reply, cancelling one already in flight first.
agentscope/realtime/_xai/_model.py:197–201cancel_response
async def cancel_response() -> None返回取消响应。
Cancel the reply in flight, if any.
agentscope/realtime/_xai/_model.py:203–206嵌套类详情Nested Class Detail
Parameters
class Parameters参数，处理低延迟的实时语音与多模态交互。位于 agentscope.realtime 包，继承自 RealtimeModelBase.Parameters。
Tuneables surfaced to the UI. Declared in agentscope.realtime. Extends RealtimeModelBase.Parameters.