Class: Riffer::StreamEvents::TokenUsageDone

Inherits:

Base

• Object
• Base
• Riffer::StreamEvents::TokenUsageDone

Defined in:

lib/riffer/stream_events/token_usage_done.rb,
sig/generated/riffer/stream_events/token_usage_done.rbs

Overview

Final token usage for the response, emitted when the LLM finishes.

Instance Attribute Summary

• #token_usage ⇒ Riffer::Providers::TokenUsage readonly

  The token usage data for this response.

Attributes inherited from Base

#role

Instance Method Summary

• #initialize(token_usage:, role: :assistant) ⇒ TokenUsageDone constructor

  -- : (token_usage: Riffer::Providers::TokenUsage, ?role: Symbol) -> void.

• #to_h ⇒ Hash[Symbol, untyped]

  -- : () -> Hash[Symbol, untyped].

Constructor Details

#initialize(token_usage:, role: :assistant) ⇒ TokenUsageDone

-- : (token_usage: Riffer::Providers::TokenUsage, ?role: Symbol) -> void

Parameters:

• token_usage: (Riffer::Providers::TokenUsage)
• role: (Symbol) (defaults to: :assistant)

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

def initialize(token_usage:, role: :assistant)
  super(role: role)
  @token_usage = token_usage
end

Instance Attribute Details

#token_usage ⇒ Riffer::Providers::TokenUsage (readonly)

The token usage data for this response.

Returns:

• (Riffer::Providers::TokenUsage)

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

def token_usage
  @token_usage
end

Instance Method Details

#to_h ⇒ Hash[Symbol, untyped]

-- : () -> Hash[Symbol, untyped]

Returns:

• (Hash[Symbol, untyped])

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

def to_h
  {role: @role, token_usage: @token_usage.to_h}
end