Spectre.Inference.StreamEvent (Spectre v0.3.2)

Copy Markdown View Source

Fenced public event yielded by Spectre.Inference.Stream.

Delta payloads are provisional until the complete response has passed the normal reply sanitizer and any configured guard. Consumers must not treat a provisional delta as a committed user-visible reply.

Summary

Types

kind()
t()

Functions

new(kind, opts)
terminal?(stream_event)

Types

kind()

@type kind() :: atom()

t()

@type t() :: %Spectre.Inference.StreamEvent{
  at: term(),
  attempt_id: term(),
  content_class: term(),
  control_revision: term(),
  dispatch_id: term(),
  generation: term(),
  inference_id: term(),
  invocation_id: term(),
  kind: term(),
  metadata: term(),
  payload: term(),
  run_revision: term(),
  sequence: term(),
  stream_epoch: term(),
  usage: term(),
  usage_quality: term()
}

Functions

new(kind, opts)

@spec new(
  kind(),
  keyword()
) :: t()

terminal?(stream_event)

@spec terminal?(t()) :: boolean()