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

Conversation item types for realtime sessions.

Items represent messages, tool calls, and their content in a realtime conversation.

Summary

Types

assistant_content()

input_content()

item()

message_item()

Functions

assistant_audio(audio \\ nil, transcript \\ nil)

Create assistant audio content.

assistant_message(item_id, content, opts \\ [])

Create an assistant message item.

assistant_text(text \\ nil)

Create assistant text content.

from_json(json)

Parse an item from JSON.

input_audio(audio \\ nil, transcript \\ nil)

Create input audio content.

input_image(image_url, detail \\ nil)

Create input image content.

input_text(text)

Create input text content.

system_message(item_id, content, opts \\ [])

Create a system message item.

to_json(content)

Convert an item or content to JSON-compatible map.

tool_call_item(opts)

Create a tool call item.

user_message(item_id, content, opts \\ [])

Create a user message item.

Types

assistant_content()

@type assistant_content() ::
  Codex.Realtime.Items.AssistantText.t()
  | Codex.Realtime.Items.AssistantAudio.t()

input_content()

@type input_content() ::
  Codex.Realtime.Items.InputText.t()
  | Codex.Realtime.Items.InputAudio.t()
  | Codex.Realtime.Items.InputImage.t()

item()

@type item() :: message_item() | Codex.Realtime.Items.RealtimeToolCallItem.t()

message_item()

@type message_item() ::
  Codex.Realtime.Items.SystemMessageItem.t()
  | Codex.Realtime.Items.UserMessageItem.t()
  | Codex.Realtime.Items.AssistantMessageItem.t()

Functions

assistant_audio(audio \\ nil, transcript \\ nil)

@spec assistant_audio(String.t() | nil, String.t() | nil) ::
  Codex.Realtime.Items.AssistantAudio.t()

Create assistant audio content.

assistant_message(item_id, content, opts \\ [])

@spec assistant_message(String.t(), [assistant_content()], keyword()) ::
  Codex.Realtime.Items.AssistantMessageItem.t()

Create an assistant message item.

assistant_text(text \\ nil)

@spec assistant_text(String.t() | nil) :: Codex.Realtime.Items.AssistantText.t()

Create assistant text content.

from_json(json)

@spec from_json(map()) :: {:ok, item()} | {:error, term()}

Parse an item from JSON.

input_audio(audio \\ nil, transcript \\ nil)

@spec input_audio(String.t() | nil, String.t() | nil) ::
  Codex.Realtime.Items.InputAudio.t()

Create input audio content.

input_image(image_url, detail \\ nil)

@spec input_image(String.t(), String.t() | nil) :: Codex.Realtime.Items.InputImage.t()

Create input image content.

input_text(text)

@spec input_text(String.t()) :: Codex.Realtime.Items.InputText.t()

Create input text content.

system_message(item_id, content, opts \\ [])

@spec system_message(String.t(), [Codex.Realtime.Items.InputText.t()], keyword()) ::
  Codex.Realtime.Items.SystemMessageItem.t()

Create a system message item.

to_json(content)

@spec to_json(item() | input_content() | assistant_content()) :: map()

Convert an item or content to JSON-compatible map.

tool_call_item(opts)

@spec tool_call_item(keyword()) :: Codex.Realtime.Items.RealtimeToolCallItem.t()

Create a tool call item.

user_message(item_id, content, opts \\ [])

@spec user_message(String.t(), [input_content()], keyword()) ::
  Codex.Realtime.Items.UserMessageItem.t()

Create a user message item.