AI.Stream.Event (AI SDK v0.0.1-rc.0)
View SourceDefines standard event types for streaming interactions with AI models.
These structured event types represent different kinds of data that can be emitted during a streaming interaction, allowing for standardized handling across different providers.
Summary
Types
@type t() :: AI.Stream.Event.TextDelta.t() | AI.Stream.Event.ToolCall.t() | AI.Stream.Event.Finish.t() | AI.Stream.Event.Metadata.t() | AI.Stream.Event.Error.t()
Functions
@spec from_tuple(tuple_format()) :: t()
Converts a tuple format to an Event struct.
Examples
iex> AI.Stream.Event.from_tuple({:text_delta, "Hello"})
%AI.Stream.Event.TextDelta{content: "Hello"}
@spec to_tuple(t()) :: tuple_format()
Converts an Event struct to a tuple format.
Examples
iex> event = %AI.Stream.Event.TextDelta{content: "Hello"}
iex> AI.Stream.Event.to_tuple(event)
{:text_delta, "Hello"}