View Source ExOpenAI.Components.RealtimeConversationItemMessageUser (ex_openai.ex v2.0.0-beta2)

A user message item in a Realtime conversation.

Fields

  • :content - required - [{:%{}, [], [{{:optional, [], [:audio]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:optional, [], [:detail]}, {:|, [], [{:|, [], [:auto, :low]}, :high]}}, {{:optional, [], [:image_url]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:optional, [], [:text]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:optional, [], [:transcript]}, {{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}}, {{:optional, [], [:type]}, {:|, [], [{:|, [], [:input_text, :input_audio]}, :input_image]}}]}]
    The content of the message.

  • :id - optional - String.t()
    The unique ID of the item. This may be provided by the client or generated by the server.

  • :object - optional - :"realtime.item"
    Identifier for the API object being returned - always realtime.item. Optional when creating a new item.
    Allowed values: "realtime.item"

  • :role - required - :user
    The role of the message sender. Always user.
    Allowed values: "user"

  • :status - optional - :completed | :incomplete | :in_progress
    The status of the item. Has no effect on the conversation.
    Allowed values: "completed", "incomplete", "in_progress"

  • :type - required - :message
    The type of the item. Always message.
    Allowed values: "message"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.RealtimeConversationItemMessageUser{
  content: [
    %{
      optional(:audio) => String.t(),
      optional(:detail) => (:auto | :low) | :high,
      optional(:image_url) => String.t(),
      optional(:text) => String.t(),
      optional(:transcript) => String.t(),
      optional(:type) => (:input_text | :input_audio) | :input_image
    }
  ],
  id: String.t() | nil,
  object: :"realtime.item" | nil,
  role: :user,
  status: ((:completed | :incomplete) | :in_progress) | nil,
  type: :message
}