Backplane.AiProtocol.StreamEvent (backplane_ai_protocol v1.7.2)

Copy Markdown

One ordered provider stream observation.

index is the provider item/tool index. call_id is the canonical call identity and native_id preserves a distinct provider identity. Argument deltas remain raw JSON bytes.

Summary

Types

kind()

@type kind() ::
  :text_delta
  | :reasoning_delta
  | :content
  | :tool_call_start
  | :tool_call_delta
  | :tool_call_done
  | :provider_state
  | :usage
  | :terminal
  | :error

t()

@type t() :: %Backplane.AiProtocol.StreamEvent{
  arguments_delta: term(),
  call_id: term(),
  completeness: term(),
  content: term(),
  content_index: term(),
  error: term(),
  extensions: term(),
  index: term(),
  name: term(),
  native_id: term(),
  provider_state: term(),
  stop_reason: term(),
  text: term(),
  type: kind(),
  usage: term()
}