Codex.Realtime.ModelInputs (Codex SDK v0.7.2)

Copy Markdown View Source

Input message types for sending events to the realtime model.

These structs represent commands that can be sent to the realtime WebSocket connection, such as sending audio, user input, or tool outputs.

Summary

Types

send_event()

Functions

send_audio(audio, commit \\ false)

Create a send audio event.

send_interrupt(force \\ false)

Create a send interrupt event.

send_raw_message(message)

Create a send raw message event.

send_session_update(settings)

Create a send session update event.

send_tool_output(tool_call, output, start_response \\ true)

Create a send tool output event.

send_user_input(input)

Create a send user input event.

to_json(arg1)

Convert send event to JSON for WebSocket.

Types

send_event()

@type send_event() ::
  Codex.Realtime.ModelInputs.SendRawMessage.t()
  | Codex.Realtime.ModelInputs.SendUserInput.t()
  | Codex.Realtime.ModelInputs.SendAudio.t()
  | Codex.Realtime.ModelInputs.SendToolOutput.t()
  | Codex.Realtime.ModelInputs.SendInterrupt.t()
  | Codex.Realtime.ModelInputs.SendSessionUpdate.t()

Functions

send_audio(audio, commit \\ false)

@spec send_audio(binary(), boolean()) :: Codex.Realtime.ModelInputs.SendAudio.t()

Create a send audio event.

send_interrupt(force \\ false)

@spec send_interrupt(boolean()) :: Codex.Realtime.ModelInputs.SendInterrupt.t()

Create a send interrupt event.

send_raw_message(message)

@spec send_raw_message(map()) :: Codex.Realtime.ModelInputs.SendRawMessage.t()

Create a send raw message event.

send_session_update(settings)

@spec send_session_update(Codex.Realtime.Config.SessionModelSettings.t()) ::
  Codex.Realtime.ModelInputs.SendSessionUpdate.t()

Create a send session update event.

send_tool_output(tool_call, output, start_response \\ true)

@spec send_tool_output(
  Codex.Realtime.ModelEvents.ToolCallEvent.t(),
  String.t(),
  boolean()
) ::
  Codex.Realtime.ModelInputs.SendToolOutput.t()

Create a send tool output event.

send_user_input(input)

@spec send_user_input(String.t() | map()) ::
  Codex.Realtime.ModelInputs.SendUserInput.t()

Create a send user input event.

to_json(arg1)

@spec to_json(send_event()) :: map() | [map()]

Convert send event to JSON for WebSocket.