Class: Riffer::StreamEvents::Base

Inherits:

Object

Object
Riffer::StreamEvents::Base

show all

Defined in:: lib/riffer/stream_events/base.rb,
sig/generated/riffer/stream_events/base.rbs

Overview

Base class for all streaming events. Subclasses must implement to_h.

Direct Known Subclasses

FinishReasonDone, GuardrailModification, GuardrailTripwire, Interrupt, ReasoningDelta, ReasoningDone, SkillActivation, TextDelta, TextDone, TokenUsageDone, ToolCallDelta, ToolCallDone, WebSearchDone, WebSearchStatus

Instance Attribute Summary collapse

#role ⇒ Symbol readonly
The message role (typically :assistant).

Instance Method Summary collapse

#initialize(role: :assistant) ⇒ Base constructor
-- : (?role: Symbol) -> void.
#to_h ⇒ Hash[Symbol, untyped]
Converts the event to a hash.

Constructor Details

#initialize(role: :assistant) ⇒ `Base`

-- : (?role: Symbol) -> void

Parameters:

role: (Symbol) (defaults to: :assistant)



11
12
13

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

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

Instance Attribute Details

#role ⇒ `Symbol` (readonly)

The message role (typically :assistant).

Returns:

(Symbol)



7
8
9

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

def role
  @role
end

Instance Method Details

#to_h ⇒ `Hash[Symbol, untyped]`

Converts the event to a hash.

: () -> Hash[Symbol, untyped]

Returns:

(Hash[Symbol, untyped])



18
19
20

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

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