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

Represents a message delta i.e. any changed fields on a message during streaming.

Fields

  • :delta - required - {:%{}, [], [{{:optional, [], [:content]}, {:list, [], [{:|, [], [{:|, [], [{:|, [], [{{:., [], [ExOpenAI.Components.MessageDeltaContentImageFileObject, :t]}, [], []}, {{:., [], [ExOpenAI.Components.MessageDeltaContentTextObject, :t]}, [], []}]}, {{:., [], [ExOpenAI.Components.MessageDeltaContentRefusalObject, :t]}, [], []}]}, {{:., [], [ExOpenAI.Components.MessageDeltaContentImageUrlObject, :t]}, [], []}]}]}}, {{:optional, [], [:role]}, {:|, [], [:user, :assistant]}}]}
    The delta containing the fields that have changed on the Message.

  • :id - required - String.t()
    The identifier of the message, which can be referenced in API endpoints.

  • :object - required - :"thread.message.delta"
    The object type, which is always thread.message.delta.
    Allowed values: "thread.message.delta"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.MessageDeltaObject{
  delta: %{
    optional(:content) => [
      ((ExOpenAI.Components.MessageDeltaContentImageFileObject.t()
        | ExOpenAI.Components.MessageDeltaContentTextObject.t())
       | ExOpenAI.Components.MessageDeltaContentRefusalObject.t())
      | ExOpenAI.Components.MessageDeltaContentImageUrlObject.t()
    ],
    optional(:role) => :user | :assistant
  },
  id: String.t(),
  object: :"thread.message.delta"
}