Class: Riffer::StreamEvents::Base

Inherits:

Object

• Object
• Riffer::StreamEvents::Base

Defined in:

lib/riffer/stream_events/base.rb

Overview

Base class for all streaming events in the Riffer framework.

Subclasses must implement the to_h method.

Direct Known Subclasses

GuardrailModification, GuardrailTripwire, ReasoningDelta, ReasoningDone, TextDelta, TextDone, TokenUsageDone, ToolCallDelta, ToolCallDone

Instance Attribute Summary

• #role ⇒ Object readonly

  The message role (typically :assistant).

Instance Method Summary

• #initialize(role: :assistant) ⇒ Base constructor

  : (?role: Symbol) -> void.

• #to_h ⇒ Object

  Converts the event to a hash.

Constructor Details

#initialize(role: :assistant) ⇒ Base

: (?role: Symbol) -> void

# File 'lib/riffer/stream_events/base.rb', line 12

def initialize(role: :assistant)
  @role = role
end

Instance Attribute Details

#role ⇒ Object (readonly)

The message role (typically :assistant).

# File 'lib/riffer/stream_events/base.rb', line 9

def role
  @role
end

Instance Method Details

#to_h ⇒ Object

Converts the event to a hash.

Raises NotImplementedError if not implemented by subclass.

: () -> Hash[Symbol, untyped]

Raises:

• (NotImplementedError)

# File 'lib/riffer/stream_events/base.rb', line 21

def to_h
  raise NotImplementedError, "Subclasses must implement #to_h"
end