LlmCall.StreamEvent (llm_call v0.1.0)

Copy Markdown View Source

A normalized streaming event.

delta is a closed union of LlmCall.StreamDelta structs, so callers never pattern-match provider JSON. raw holds the provider event only when LlmCall.Config.capture_raw is :all.

Summary

Types

delta()

@type delta() ::
  nil
  | %LlmCall.StreamDelta.Text{text: String.t()}
  | %LlmCall.StreamDelta.ToolCall{
      arguments: String.t() | nil,
      id: String.t() | nil,
      index: index(),
      name: String.t() | nil
    }
  | %LlmCall.StreamDelta.Thinking{signature: String.t() | nil, text: String.t()}
  | %LlmCall.StreamDelta.MessageDelta{
      stop_reason: LlmCall.stop_reason() | nil,
      usage: LlmCall.Usage.t() | nil
    }
  | %LlmCall.StreamDelta.Raw{data: map()}

index()

@type index() :: non_neg_integer() | nil

raw()

@type raw() :: map() | nil

t()

@type t() :: %LlmCall.StreamEvent{
  delta: delta(),
  index: index(),
  raw: raw(),
  type: type()
}

type()

@type type() ::
  :message_start
  | :content_start
  | :text_delta
  | :tool_call_start
  | :tool_call_delta
  | :tool_call_stop
  | :thinking_delta
  | :content_stop
  | :message_delta
  | :message_stop
  | :error