Class: Event

Inherits:
ApplicationRecord show all
Includes:
Broadcasting
Defined in:
app/models/event.rb

Overview

A persisted record of something that happened during a session. Events are the single source of truth for conversation history —there is no separate chat log, only events attached to a session.

Defined Under Namespace

Modules: Broadcasting

Constant Summary collapse

TYPES = 
%w[system_message user_message agent_message tool_call tool_response].freeze
LLM_TYPES = 
%w[user_message agent_message].freeze
CONTEXT_TYPES = 
%w[system_message user_message agent_message tool_call tool_response].freeze
PENDING_STATUS = 
"pending"
ROLE_MAP = 
{"user_message" => "user", "agent_message" => "assistant"}.freeze
BYTES_PER_TOKEN =

Heuristic: average bytes per token for English prose.

4

Constants included from Broadcasting

Broadcasting::ACTION_CREATE, Broadcasting::ACTION_UPDATE

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#event_type ⇒ String

Returns one of TYPES: system_message, user_message, agent_message, tool_call, tool_response.

Returns:

  • (String) —

    one of TYPES: system_message, user_message, agent_message, tool_call, tool_response



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'app/models/event.rb', line 18

class Event < ApplicationRecord
  include Event::Broadcasting

  TYPES = %w[system_message user_message agent_message tool_call tool_response].freeze
  LLM_TYPES = %w[user_message agent_message].freeze
  CONTEXT_TYPES = %w[system_message user_message agent_message tool_call tool_response].freeze
  PENDING_STATUS = "pending"

  ROLE_MAP = {"user_message" => "user", "agent_message" => "assistant"}.freeze

  # Heuristic: average bytes per token for English prose.
  BYTES_PER_TOKEN = 4

  belongs_to :session

  validates :event_type, presence: true, inclusion: {in: TYPES}
  validates :payload, presence: true
  validates :timestamp, presence: true

  after_create :schedule_token_count, if: :llm_message?

  # @!method self.llm_messages
  #   Events that represent conversation turns sent to the LLM API.
  #   @return [ActiveRecord::Relation]
  scope :llm_messages, -> { where(event_type: LLM_TYPES) }

  # @!method self.context_events
  #   Events included in the LLM context window (messages + tool interactions).
  #   @return [ActiveRecord::Relation]
  scope :context_events, -> { where(event_type: CONTEXT_TYPES) }

  # @!method self.pending
  #   User messages queued during active agent processing, not yet sent to LLM.
  #   @return [ActiveRecord::Relation]
  scope :pending, -> { where(status: PENDING_STATUS) }

  # @!method self.deliverable
  #   Events eligible for LLM context (excludes pending messages).
  #   NULL status means delivered/processed — the only excluded value is "pending".
  #   @return [ActiveRecord::Relation]
  scope :deliverable, -> { where(status: nil) }

  # Maps event_type to the Anthropic Messages API role.
  # @return [String] "user" or "assistant"
  def api_role
    ROLE_MAP.fetch(event_type)
  end

  # @return [Boolean] true if this event represents an LLM conversation turn
  def llm_message?
    event_type.in?(LLM_TYPES)
  end

  # @return [Boolean] true if this event is part of the LLM context window
  def context_event?
    event_type.in?(CONTEXT_TYPES)
  end

  # @return [Boolean] true if this is a pending message not yet sent to the LLM
  def pending?
    status == PENDING_STATUS
  end

  # Heuristic token estimate: ~4 bytes per token for English prose.
  # Tool events are estimated from the full payload JSON since tool_input
  # and tool metadata contribute to token count. Messages use content only.
  #
  # @return [Integer] estimated token count (at least 1)
  def estimate_tokens
    text = if event_type.in?(%w[tool_call tool_response])
      payload.to_json
    else
      payload["content"].to_s
    end
    [(text.bytesize / BYTES_PER_TOKEN.to_f).ceil, 1].max
  end

  private

  def schedule_token_count
    CountEventTokensJob.perform_later(id)
  end
end

#payload ⇒ Hash

Returns event-specific data (content, tool_name, tool_input, etc.).

Returns:

  • (Hash) —

    event-specific data (content, tool_name, tool_input, etc.)



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'app/models/event.rb', line 18

class Event < ApplicationRecord
  include Event::Broadcasting

  TYPES = %w[system_message user_message agent_message tool_call tool_response].freeze
  LLM_TYPES = %w[user_message agent_message].freeze
  CONTEXT_TYPES = %w[system_message user_message agent_message tool_call tool_response].freeze
  PENDING_STATUS = "pending"

  ROLE_MAP = {"user_message" => "user", "agent_message" => "assistant"}.freeze

  # Heuristic: average bytes per token for English prose.
  BYTES_PER_TOKEN = 4

  belongs_to :session

  validates :event_type, presence: true, inclusion: {in: TYPES}
  validates :payload, presence: true
  validates :timestamp, presence: true

  after_create :schedule_token_count, if: :llm_message?

  # @!method self.llm_messages
  #   Events that represent conversation turns sent to the LLM API.
  #   @return [ActiveRecord::Relation]
  scope :llm_messages, -> { where(event_type: LLM_TYPES) }

  # @!method self.context_events
  #   Events included in the LLM context window (messages + tool interactions).
  #   @return [ActiveRecord::Relation]
  scope :context_events, -> { where(event_type: CONTEXT_TYPES) }

  # @!method self.pending
  #   User messages queued during active agent processing, not yet sent to LLM.
  #   @return [ActiveRecord::Relation]
  scope :pending, -> { where(status: PENDING_STATUS) }

  # @!method self.deliverable
  #   Events eligible for LLM context (excludes pending messages).
  #   NULL status means delivered/processed — the only excluded value is "pending".
  #   @return [ActiveRecord::Relation]
  scope :deliverable, -> { where(status: nil) }

  # Maps event_type to the Anthropic Messages API role.
  # @return [String] "user" or "assistant"
  def api_role
    ROLE_MAP.fetch(event_type)
  end

  # @return [Boolean] true if this event represents an LLM conversation turn
  def llm_message?
    event_type.in?(LLM_TYPES)
  end

  # @return [Boolean] true if this event is part of the LLM context window
  def context_event?
    event_type.in?(CONTEXT_TYPES)
  end

  # @return [Boolean] true if this is a pending message not yet sent to the LLM
  def pending?
    status == PENDING_STATUS
  end

  # Heuristic token estimate: ~4 bytes per token for English prose.
  # Tool events are estimated from the full payload JSON since tool_input
  # and tool metadata contribute to token count. Messages use content only.
  #
  # @return [Integer] estimated token count (at least 1)
  def estimate_tokens
    text = if event_type.in?(%w[tool_call tool_response])
      payload.to_json
    else
      payload["content"].to_s
    end
    [(text.bytesize / BYTES_PER_TOKEN.to_f).ceil, 1].max
  end

  private

  def schedule_token_count
    CountEventTokensJob.perform_later(id)
  end
end

#timestamp ⇒ Integer

Returns nanoseconds since epoch (Process::CLOCK_REALTIME).

Returns:

  • (Integer) —

    nanoseconds since epoch (Process::CLOCK_REALTIME)



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'app/models/event.rb', line 18

class Event < ApplicationRecord
  include Event::Broadcasting

  TYPES = %w[system_message user_message agent_message tool_call tool_response].freeze
  LLM_TYPES = %w[user_message agent_message].freeze
  CONTEXT_TYPES = %w[system_message user_message agent_message tool_call tool_response].freeze
  PENDING_STATUS = "pending"

  ROLE_MAP = {"user_message" => "user", "agent_message" => "assistant"}.freeze

  # Heuristic: average bytes per token for English prose.
  BYTES_PER_TOKEN = 4

  belongs_to :session

  validates :event_type, presence: true, inclusion: {in: TYPES}
  validates :payload, presence: true
  validates :timestamp, presence: true

  after_create :schedule_token_count, if: :llm_message?

  # @!method self.llm_messages
  #   Events that represent conversation turns sent to the LLM API.
  #   @return [ActiveRecord::Relation]
  scope :llm_messages, -> { where(event_type: LLM_TYPES) }

  # @!method self.context_events
  #   Events included in the LLM context window (messages + tool interactions).
  #   @return [ActiveRecord::Relation]
  scope :context_events, -> { where(event_type: CONTEXT_TYPES) }

  # @!method self.pending
  #   User messages queued during active agent processing, not yet sent to LLM.
  #   @return [ActiveRecord::Relation]
  scope :pending, -> { where(status: PENDING_STATUS) }

  # @!method self.deliverable
  #   Events eligible for LLM context (excludes pending messages).
  #   NULL status means delivered/processed — the only excluded value is "pending".
  #   @return [ActiveRecord::Relation]
  scope :deliverable, -> { where(status: nil) }

  # Maps event_type to the Anthropic Messages API role.
  # @return [String] "user" or "assistant"
  def api_role
    ROLE_MAP.fetch(event_type)
  end

  # @return [Boolean] true if this event represents an LLM conversation turn
  def llm_message?
    event_type.in?(LLM_TYPES)
  end

  # @return [Boolean] true if this event is part of the LLM context window
  def context_event?
    event_type.in?(CONTEXT_TYPES)
  end

  # @return [Boolean] true if this is a pending message not yet sent to the LLM
  def pending?
    status == PENDING_STATUS
  end

  # Heuristic token estimate: ~4 bytes per token for English prose.
  # Tool events are estimated from the full payload JSON since tool_input
  # and tool metadata contribute to token count. Messages use content only.
  #
  # @return [Integer] estimated token count (at least 1)
  def estimate_tokens
    text = if event_type.in?(%w[tool_call tool_response])
      payload.to_json
    else
      payload["content"].to_s
    end
    [(text.bytesize / BYTES_PER_TOKEN.to_f).ceil, 1].max
  end

  private

  def schedule_token_count
    CountEventTokensJob.perform_later(id)
  end
end

#token_count ⇒ Integer

Returns cached token count for this event’s payload (0 until counted).

Returns:

  • (Integer) —

    cached token count for this event’s payload (0 until counted)



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'app/models/event.rb', line 18

class Event < ApplicationRecord
  include Event::Broadcasting

  TYPES = %w[system_message user_message agent_message tool_call tool_response].freeze
  LLM_TYPES = %w[user_message agent_message].freeze
  CONTEXT_TYPES = %w[system_message user_message agent_message tool_call tool_response].freeze
  PENDING_STATUS = "pending"

  ROLE_MAP = {"user_message" => "user", "agent_message" => "assistant"}.freeze

  # Heuristic: average bytes per token for English prose.
  BYTES_PER_TOKEN = 4

  belongs_to :session

  validates :event_type, presence: true, inclusion: {in: TYPES}
  validates :payload, presence: true
  validates :timestamp, presence: true

  after_create :schedule_token_count, if: :llm_message?

  # @!method self.llm_messages
  #   Events that represent conversation turns sent to the LLM API.
  #   @return [ActiveRecord::Relation]
  scope :llm_messages, -> { where(event_type: LLM_TYPES) }

  # @!method self.context_events
  #   Events included in the LLM context window (messages + tool interactions).
  #   @return [ActiveRecord::Relation]
  scope :context_events, -> { where(event_type: CONTEXT_TYPES) }

  # @!method self.pending
  #   User messages queued during active agent processing, not yet sent to LLM.
  #   @return [ActiveRecord::Relation]
  scope :pending, -> { where(status: PENDING_STATUS) }

  # @!method self.deliverable
  #   Events eligible for LLM context (excludes pending messages).
  #   NULL status means delivered/processed — the only excluded value is "pending".
  #   @return [ActiveRecord::Relation]
  scope :deliverable, -> { where(status: nil) }

  # Maps event_type to the Anthropic Messages API role.
  # @return [String] "user" or "assistant"
  def api_role
    ROLE_MAP.fetch(event_type)
  end

  # @return [Boolean] true if this event represents an LLM conversation turn
  def llm_message?
    event_type.in?(LLM_TYPES)
  end

  # @return [Boolean] true if this event is part of the LLM context window
  def context_event?
    event_type.in?(CONTEXT_TYPES)
  end

  # @return [Boolean] true if this is a pending message not yet sent to the LLM
  def pending?
    status == PENDING_STATUS
  end

  # Heuristic token estimate: ~4 bytes per token for English prose.
  # Tool events are estimated from the full payload JSON since tool_input
  # and tool metadata contribute to token count. Messages use content only.
  #
  # @return [Integer] estimated token count (at least 1)
  def estimate_tokens
    text = if event_type.in?(%w[tool_call tool_response])
      payload.to_json
    else
      payload["content"].to_s
    end
    [(text.bytesize / BYTES_PER_TOKEN.to_f).ceil, 1].max
  end

  private

  def schedule_token_count
    CountEventTokensJob.perform_later(id)
  end
end

#tool_use_id ⇒ String?

Returns Anthropic-assigned ID correlating tool_call and tool_response.

Returns:

  • (String, nil) —

    Anthropic-assigned ID correlating tool_call and tool_response



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'app/models/event.rb', line 18

class Event < ApplicationRecord
  include Event::Broadcasting

  TYPES = %w[system_message user_message agent_message tool_call tool_response].freeze
  LLM_TYPES = %w[user_message agent_message].freeze
  CONTEXT_TYPES = %w[system_message user_message agent_message tool_call tool_response].freeze
  PENDING_STATUS = "pending"

  ROLE_MAP = {"user_message" => "user", "agent_message" => "assistant"}.freeze

  # Heuristic: average bytes per token for English prose.
  BYTES_PER_TOKEN = 4

  belongs_to :session

  validates :event_type, presence: true, inclusion: {in: TYPES}
  validates :payload, presence: true
  validates :timestamp, presence: true

  after_create :schedule_token_count, if: :llm_message?

  # @!method self.llm_messages
  #   Events that represent conversation turns sent to the LLM API.
  #   @return [ActiveRecord::Relation]
  scope :llm_messages, -> { where(event_type: LLM_TYPES) }

  # @!method self.context_events
  #   Events included in the LLM context window (messages + tool interactions).
  #   @return [ActiveRecord::Relation]
  scope :context_events, -> { where(event_type: CONTEXT_TYPES) }

  # @!method self.pending
  #   User messages queued during active agent processing, not yet sent to LLM.
  #   @return [ActiveRecord::Relation]
  scope :pending, -> { where(status: PENDING_STATUS) }

  # @!method self.deliverable
  #   Events eligible for LLM context (excludes pending messages).
  #   NULL status means delivered/processed — the only excluded value is "pending".
  #   @return [ActiveRecord::Relation]
  scope :deliverable, -> { where(status: nil) }

  # Maps event_type to the Anthropic Messages API role.
  # @return [String] "user" or "assistant"
  def api_role
    ROLE_MAP.fetch(event_type)
  end

  # @return [Boolean] true if this event represents an LLM conversation turn
  def llm_message?
    event_type.in?(LLM_TYPES)
  end

  # @return [Boolean] true if this event is part of the LLM context window
  def context_event?
    event_type.in?(CONTEXT_TYPES)
  end

  # @return [Boolean] true if this is a pending message not yet sent to the LLM
  def pending?
    status == PENDING_STATUS
  end

  # Heuristic token estimate: ~4 bytes per token for English prose.
  # Tool events are estimated from the full payload JSON since tool_input
  # and tool metadata contribute to token count. Messages use content only.
  #
  # @return [Integer] estimated token count (at least 1)
  def estimate_tokens
    text = if event_type.in?(%w[tool_call tool_response])
      payload.to_json
    else
      payload["content"].to_s
    end
    [(text.bytesize / BYTES_PER_TOKEN.to_f).ceil, 1].max
  end

  private

  def schedule_token_count
    CountEventTokensJob.perform_later(id)
  end
end

Class Method Details

.context_events ⇒ ActiveRecord::Relation

Events included in the LLM context window (messages + tool interactions).

Returns:

  • (ActiveRecord::Relation) 


47
 
# File 'app/models/event.rb', line 47

scope :context_events, -> { where(event_type: CONTEXT_TYPES) }

.deliverable ⇒ ActiveRecord::Relation

Events eligible for LLM context (excludes pending messages). NULL status means delivered/processed — the only excluded value is “pending”.

Returns:

  • (ActiveRecord::Relation) 


58
 
# File 'app/models/event.rb', line 58

scope :deliverable, -> { where(status: nil) }

.llm_messages ⇒ ActiveRecord::Relation

Events that represent conversation turns sent to the LLM API.

Returns:

  • (ActiveRecord::Relation) 


42
 
# File 'app/models/event.rb', line 42

scope :llm_messages, -> { where(event_type: LLM_TYPES) }

.pending ⇒ ActiveRecord::Relation

User messages queued during active agent processing, not yet sent to LLM.

Returns:

  • (ActiveRecord::Relation) 


52
 
# File 'app/models/event.rb', line 52

scope :pending, -> { where(status: PENDING_STATUS) }

Instance Method Details

#api_role ⇒ String

Maps event_type to the Anthropic Messages API role.

Returns:

  • (String) —

    “user” or “assistant”



62
63
64
 
# File 'app/models/event.rb', line 62

def api_role
  ROLE_MAP.fetch(event_type)
end

#context_event? ⇒ Boolean

Returns true if this event is part of the LLM context window.

Returns:

  • (Boolean) —

    true if this event is part of the LLM context window



72
73
74
 
# File 'app/models/event.rb', line 72

def context_event?
  event_type.in?(CONTEXT_TYPES)
end

#estimate_tokens ⇒ Integer

Heuristic token estimate: ~4 bytes per token for English prose. Tool events are estimated from the full payload JSON since tool_input and tool metadata contribute to token count. Messages use content only.

Returns:

  • (Integer) —

    estimated token count (at least 1)



86
87
88
89
90
91
92
93
 
# File 'app/models/event.rb', line 86

def estimate_tokens
  text = if event_type.in?(%w[tool_call tool_response])
    payload.to_json
  else
    payload["content"].to_s
  end
  [(text.bytesize / BYTES_PER_TOKEN.to_f).ceil, 1].max
end

#llm_message? ⇒ Boolean

Returns true if this event represents an LLM conversation turn.

Returns:

  • (Boolean) —

    true if this event represents an LLM conversation turn



67
68
69
 
# File 'app/models/event.rb', line 67

def llm_message?
  event_type.in?(LLM_TYPES)
end

#pending? ⇒ Boolean

Returns true if this is a pending message not yet sent to the LLM.

Returns:

  • (Boolean) —

    true if this is a pending message not yet sent to the LLM



77
78
79
 
# File 'app/models/event.rb', line 77

def pending?
  status == PENDING_STATUS
end