turnkit 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c02ad5eef683595c702a33806438f414ed2da9e18c607a8b314bba4ae442404
-  data.tar.gz: 4da3877b7c20aecae1dd77e6df4497bb64a3909d28419fb1413feb37fa5fa298
+  metadata.gz: 75121664c1e081304931fbf125db92a9abc8b9062f920c7e33f7759b52ce51ec
+  data.tar.gz: ccabe905d199d955d281c936a019995a3bd9bc29c0fc009160ea924de4605835
 SHA512:
-  metadata.gz: b5de4c365826d8a4154d2ee013fe0f7289796b91b63eb34ad81693993eb55b8f8d0282f8415e7798f9eb698d2f6f4aa52b79949e1c89c0c64effe506cf26ef0b
-  data.tar.gz: b168324cf4f97485ce7854006565441fd0fe67e1f84835805d98d67f27a2a793fe2ce8bd27a6939c6ccbf3cc92023bc93c8aff5e8049fb0b2991a50548d211d6
+  metadata.gz: ff0fa50aabb4c4b4fd9ea6f3ae78b62a4b020522a083f96605028dca2f4ca50a4fb6a9b98b36070e070d38a36b205ebf343823b520f5b0e5b4fe7a06b643cdce
+  data.tar.gz: beec35d2fc1f51cc6fe674d12d72e0ec1b44722bdcfab28019e9ab2d2ae313c684125989647e6d5d389f80b2df5f98dd33aa3c154e0af7da0885d2b8bec0221c

data/CHANGELOG.md

@@ -1,9 +1,10 @@
 # Changelog
 
-## 0.2.3 - 2026-06-06
+## 0.2.4 - 2026-06-06
 
 - Add Anthropic prompt cache support for stable system prompt sections.
-- Track cache write tokens and aggregate model costs on turns.
+- Track cache write tokens and expose model cost totals for turns, conversations, and agents.
+- Calculate costs from RubyLLM model registry pricing with custom rate and calculator overrides.
 - Refresh README usage examples for prompt caching and usage tracking.
 
 ## 0.2.0 - 2026-06-04

data/README.md

@@ -37,14 +37,20 @@ agent = TurnKit::Agent.new(
   name: "helper",
   instructions: "Answer briefly."
 )
+```
+
+Ask a question:
 
+```ruby
 turn = agent.conversation.ask("Explain Ruby blocks in one sentence.")
 puts turn.output_text
 ```
 
 ## Usage
 
-Choose a model:
+### Models
+
+Set the default model:
 
 ```ruby
 TurnKit.default_model = "claude-sonnet-4-5"
@@ -56,10 +62,14 @@ Use OpenAI:
 export OPENAI_API_KEY=...
 ```
 
+Set an OpenAI model:
+
 ```ruby
 TurnKit.default_model = "gpt-4.1-mini"
 ```
 
+### Conversations
+
 Create a conversation:
 
 ```ruby
@@ -67,14 +77,24 @@ agent = TurnKit::Agent.new(
   name: "writer",
   instructions: "Write clear release notes."
 )
+```
 
+Add context:
+
+```ruby
 conversation = agent.conversation(subject: "v1 launch")
 conversation.say("Mention faster tool execution.")
+```
+
+Run the agent:
 
+```ruby
 turn = conversation.run!
 puts turn.output_text
 ```
 
+### Tools
+
 Create a tool:
 
 ```ruby
@@ -93,7 +113,7 @@ class SaveReport < TurnKit::Tool
 end
 ```
 
-Use a tool:
+Use the tool:
 
 ```ruby
 agent = TurnKit::Agent.new(
@@ -101,40 +121,115 @@ agent = TurnKit::Agent.new(
   instructions: "Save reports when asked.",
   tools: [SaveReport]
 )
+```
+
+Ask for tool use:
 
+```ruby
 turn = agent.conversation.ask("Save a short status report.")
 puts turn.output_text
 ```
 
-Add skills:
+### Skills
+
+Load a skill:
 
 ```ruby
 skill = TurnKit::Skill.from_file("skills/research.md")
+```
+
+Use the skill:
 
+```ruby
 agent = TurnKit::Agent.new(
   name: "researcher",
   skills: [skill]
 )
 ```
 
-Delegate to sub-agents:
+### Sub-agents
+
+Create a sub-agent:
 
 ```ruby
 writer = TurnKit::Agent.new(
   name: "writer",
   description: "Draft concise copy."
 )
+```
+
+Delegate to it:
 
+```ruby
 editor = TurnKit::Agent.new(
   name: "editor",
   sub_agents: [writer]
 )
+```
 
+Ask the parent agent:
+
+```ruby
 turn = editor.conversation.ask("Ask the writer for three headlines.")
 puts turn.output_text
 ```
 
-Use prompt caching:
+### Usage and costs
+
+Inspect token usage:
+
+```ruby
+turn.usage.total_tokens
+conversation.usage.total_tokens
+agent.usage.total_tokens
+```
+
+Inspect costs:
+
+```ruby
+turn.cost.total
+conversation.cost.total
+agent.cost.total
+```
+
+Use RubyLLM registry prices by default.
+
+Override model rates:
+
+```ruby
+TurnKit.cost_rates = {
+  "my-model" => {
+    input: 0.25,
+    output: 1.00,
+    cached_input: 0.05,
+    cache_creation: 0.25
+  }
+}
+```
+
+Override cost calculation:
+
+```ruby
+TurnKit.cost_calculator = ->(usage, model) do
+  {
+    input: usage.input_tokens * 0.25 / 1_000_000.0,
+    output: usage.output_tokens * 1.00 / 1_000_000.0
+  }
+end
+```
+
+Limit turn cost:
+
+```ruby
+agent = TurnKit::Agent.new(
+  name: "analyst",
+  cost_limit: 0.25
+)
+```
+
+### Prompt caching
+
+Enable prompt caching:
 
 ```ruby
 TurnKit.prompt_cache = :auto
@@ -159,14 +254,9 @@ agent = TurnKit::Agent.new(
 )
 ```
 
-Inspect usage:
-
-```ruby
-record = TurnKit.store.load_turn(turn.id)
-record.fetch("usage")
-```
+### Custom clients
 
-Return usage from custom clients:
+Create a client:
 
 ```ruby
 class MyClient < TurnKit::Client
@@ -185,22 +275,20 @@ class MyClient < TurnKit::Client
 end
 ```
 
-Split instructions inside custom clients:
+Use the client:
 
 ```ruby
-stable, dynamic = TurnKit::SystemPrompt.split_cache_boundary(instructions)
+TurnKit.client = MyClient.new
 ```
 
-Send `stable` with provider cache controls.
-
-Send `dynamic` as normal prompt content.
-
-Use a custom client:
+Split cache sections:
 
 ```ruby
-TurnKit.client = MyClient.new
+stable, dynamic = TurnKit::SystemPrompt.split_cache_boundary(instructions)
 ```
 
+### Rails
+
 Install Rails persistence:
 
 ```sh
@@ -217,7 +305,6 @@ Configure Rails:
 
 ```ruby
 TurnKit.store = TurnKit::ActiveRecordStore.new
-TurnKit.default_model = "claude-sonnet-4-5"
 ```
 
 Reconcile stale turns:
@@ -237,6 +324,8 @@ TurnKit.timeout = 300
 TurnKit.max_depth = 3
 TurnKit.max_tool_executions = 100
 TurnKit.cost_limit = nil
+TurnKit.cost_rates = {}
+TurnKit.cost_calculator = nil
 TurnKit.prompt_cache = :auto
 ```
 
@@ -259,11 +348,11 @@ agent = TurnKit::Agent.new(
 | `store` | Set the conversation store. |
 | `max_iterations` | Limit model calls per turn. |
 | `timeout` | Limit seconds per root turn. |
-| `max_depth` | Limit sub-agent nesting. |
 | `max_tool_executions` | Limit tool calls per root turn. |
 | `cost_limit` | Limit cost per root turn. |
+| `cost_rates` | Override prices by model. |
+| `cost_calculator` | Override cost calculation. |
 | `prompt_cache` | Use provider prompt caching. |
-| `prompt_sections` | Set default prompt sections. |
 
 ## Contributing
 

data/lib/turnkit/adapters/ruby_llm.rb

@@ -122,7 +122,8 @@ module TurnKit
             input_tokens: token_value(response, :input_tokens),
             output_tokens: token_value(response, :output_tokens),
             cached_tokens: token_value(response, :cached_tokens),
-            cache_write_tokens: token_value(response, :cache_creation_tokens)
+            cache_write_tokens: token_value(response, :cache_creation_tokens),
+            cost: response_cost(response)
           )
           Result.new(
             text: response.respond_to?(:content) ? response.content.to_s : response.to_s,
@@ -135,6 +136,12 @@ module TurnKit
         def token_value(response, method)
           response.respond_to?(method) ? response.public_send(method).to_i : 0
         end
+
+        def response_cost(response)
+          return unless response.respond_to?(:cost)
+
+          response.cost&.total
+        end
     end
   end
 end

data/lib/turnkit/agent.rb

@@ -41,6 +41,14 @@ module TurnKit
       Conversation.new(agent: self, record: record, store: store, model: model || effective_model, subject: subject, metadata: metadata)
     end
 
+    def cost
+      Cost.from_records(effective_store.list_turns(agent_name: name))
+    end
+
+    def usage
+      Usage.from_records(effective_store.list_turns(agent_name: name))
+    end
+
     def effective_model
       model || TurnKit.default_model
     end

data/lib/turnkit/budget.rb

@@ -32,10 +32,14 @@ module TurnKit
     end
 
     def add_usage!(usage)
-      return unless usage&.cost && cost_limit
+      add_cost!(usage&.cost)
+    end
+
+    def add_cost!(cost)
+      return unless cost && cost_limit
 
       @mutex.synchronize do
-        @cost += usage.cost.to_f
+        @cost += cost.to_f
         raise Error, "cost limit reached" if @cost > cost_limit
       end
     end

data/lib/turnkit/conversation.rb

@@ -48,6 +48,14 @@ module TurnKit
       store.list_messages(id).map { |attrs| Message.new(attrs) }
     end
 
+    def usage
+      Usage.from_records(store.list_turns(conversation_id: id))
+    end
+
+    def cost
+      Cost.from_records(store.list_turns(conversation_id: id))
+    end
+
     def messages_for_turn(turn)
       store.list_messages(id, through_sequence: turn.context_message_sequence, turn_id: turn.id).map { |attrs| Message.new(attrs) }
     end

data/lib/turnkit/cost.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module TurnKit
+  class Cost
+    COMPONENTS = %i[input output cache_read cache_write].freeze
+    PER_MILLION = 1_000_000.0
+
+    attr_reader :input, :output, :cache_read, :cache_write
+
+    def self.aggregate(costs)
+      costs = costs.compact
+      return new unless costs.any?
+
+      if costs.any? { |cost| COMPONENTS.any? { |component| !cost.public_send(component).nil? } }
+        values = COMPONENTS.to_h do |component|
+          amounts = costs.filter_map { |cost| cost.public_send(component) }
+          [ component, amounts.any? ? amounts.sum : nil ]
+        end
+        return new(**values)
+      end
+
+      totals = costs.map(&:total)
+      return new(total: totals.sum) if totals.none?(&:nil?)
+
+      new
+    end
+
+    def self.from_usage(usage, model: nil)
+      return new(total: usage.cost) if usage.cost
+
+      custom = custom_cost(usage, model)
+      return custom if custom
+
+      rates = TurnKit.cost_rates[model.to_s] || TurnKit.cost_rates[model&.to_sym]
+      rates ? from_rates(usage, rates) : from_ruby_llm(usage, model)
+    end
+
+    def self.from_records(records)
+      aggregate(records.map { |record| from_record(record) })
+    end
+
+    def self.from_record(record)
+      attrs = record.transform_keys(&:to_s)
+      usage = attrs["usage"] || {}
+      return from_hash(usage["cost_details"] || usage[:cost_details]) if usage["cost_details"] || usage[:cost_details]
+      return new(total: attrs["cost"]) if attrs["cost"]
+
+      from_usage(Usage.from_h(usage), model: attrs["model"])
+    end
+
+    def self.from_rates(usage, rates)
+      rates = rates.transform_keys(&:to_sym)
+      new(
+        input: amount(usage.input_tokens, rates[:input] || rates[:input_per_million]),
+        output: amount(usage.output_tokens, rates[:output] || rates[:output_per_million]),
+        cache_read: amount(usage.cached_tokens, rates[:cache_read] || rates[:cached_input] || rates[:cache_read_input_per_million] || rates[:cached_input_per_million]),
+        cache_write: amount(usage.cache_write_tokens, rates[:cache_write] || rates[:cache_creation] || rates[:cache_write_input_per_million] || rates[:cache_creation_input_per_million]),
+        strict: true
+      )
+    end
+
+    def self.from_ruby_llm(usage, model)
+      require "ruby_llm"
+
+      model_info = ::RubyLLM.models.find(model) if model
+      return new unless model_info
+
+      if defined?(::RubyLLM::Cost)
+        tokens = ::RubyLLM::Tokens.new(
+          input: usage.input_tokens,
+          output: usage.output_tokens,
+          cached: usage.cached_tokens,
+          cache_creation: usage.cache_write_tokens
+        )
+        from_hash(::RubyLLM::Cost.new(tokens: tokens, model: model_info).to_h)
+      else
+        from_rates(
+          usage,
+          input: model_info.input_price_per_million,
+          output: model_info.output_price_per_million,
+          cached_input: model_info.pricing&.text_tokens&.cached_input
+        )
+      end
+    rescue LoadError, StandardError
+      new
+    end
+
+    def self.from_hash(hash)
+      hash = hash.transform_keys(&:to_sym)
+      new(
+        input: hash[:input],
+        output: hash[:output],
+        cache_read: hash[:cache_read] || hash[:cached_input],
+        cache_write: hash[:cache_write] || hash[:cache_creation],
+        total: hash[:total]
+      )
+    end
+
+    def self.custom_cost(usage, model)
+      return unless TurnKit.cost_calculator
+
+      value = TurnKit.cost_calculator.call(usage, model)
+      case value
+      when nil
+        nil
+      when Cost
+        value
+      when Hash
+        from_hash(value)
+      else
+        new(total: value)
+      end
+    end
+
+    def self.amount(tokens, price)
+      return nil if tokens.to_i.positive? && price.nil?
+      return 0.0 if tokens.to_i.zero?
+
+      tokens.to_i * price.to_f / PER_MILLION
+    end
+
+    def initialize(input: nil, output: nil, cache_read: nil, cache_write: nil, total: nil, strict: false)
+      @input = number(input)
+      @output = number(output)
+      @cache_read = number(cache_read)
+      @cache_write = number(cache_write)
+      @total = number(total)
+      @strict = strict
+    end
+
+    def total
+      return @total if @total
+      return nil if @strict && COMPONENTS.any? { |component| public_send(component).nil? }
+
+      values = COMPONENTS.filter_map { |component| public_send(component) }
+      values.empty? ? nil : values.sum
+    end
+
+    def to_h
+      {
+        "input" => input,
+        "output" => output,
+        "cache_read" => cache_read,
+        "cache_write" => cache_write,
+        "total" => total
+      }.compact
+    end
+
+    private
+      def number(value)
+        value.nil? ? nil : value.to_f
+      end
+  end
+end

data/lib/turnkit/memory_store.rb

@@ -68,11 +68,12 @@ module TurnKit
       end
     end
 
-    def list_turns(root_turn_id: nil, conversation_id: nil)
+    def list_turns(root_turn_id: nil, conversation_id: nil, agent_name: nil)
       @mutex.synchronize do
         rows = @turns.values
         rows = rows.select { |turn| turn["root_turn_id"] == root_turn_id } if root_turn_id
         rows = rows.select { |turn| turn["conversation_id"] == conversation_id } if conversation_id
+        rows = rows.select { |turn| turn["agent_name"] == agent_name } if agent_name
         rows.sort_by { |turn| [ turn["created_at"].to_f, turn["id"] ] }.map { |turn| duplicate(turn) }
       end
     end

data/lib/turnkit/store.rb

@@ -12,7 +12,7 @@ module TurnKit
     def create_turn(_attributes) = raise(NotImplementedError)
     def load_turn(_id) = raise(NotImplementedError)
     def update_turn(_id, _attributes) = raise(NotImplementedError)
-    def list_turns(root_turn_id: nil, conversation_id: nil) = raise(NotImplementedError)
+    def list_turns(root_turn_id: nil, conversation_id: nil, agent_name: nil) = raise(NotImplementedError)
 
     def create_tool_execution(_attributes) = raise(NotImplementedError)
     def load_tool_execution(_id) = raise(NotImplementedError)

data/lib/turnkit/stores/active_record_store.rb

@@ -89,10 +89,11 @@ module TurnKit
       turn_hash(record)
     end
 
-    def list_turns(root_turn_id: nil, conversation_id: nil)
+    def list_turns(root_turn_id: nil, conversation_id: nil, agent_name: nil)
       scope = turn_class.all
       scope = scope.where(root_turn_uid: root_turn_id) if root_turn_id
       scope = scope.where(conversation_uid: conversation_id) if conversation_id
+      scope = scope.where(agent_name: agent_name) if agent_name
       scope.order(:created_at, :uid).map { |record| turn_hash(record) }
     end
 

data/lib/turnkit/turn.rb

@@ -42,9 +42,10 @@ module TurnKit
           instructions: agent.system_prompt_for(turn: self, conversation: conversation),
           metadata: { turn_id: id, conversation_id: conversation.id }
         )
+        result_cost = Cost.from_usage(result.usage, model: result.model || model)
 
-        budget.add_usage!(result.usage)
-        add_usage!(result.usage)
+        budget.add_cost!(result_cost.total)
+        add_usage!(result.usage, cost: result_cost)
         persist_assistant_message(result)
 
         if result.tool_calls?
@@ -79,6 +80,14 @@ module TurnKit
       @record["output_text"].to_s
     end
 
+    def usage
+      Usage.from_h(@record["usage"] || {})
+    end
+
+    def cost
+      Cost.from_record(@record)
+    end
+
     def tool_executions
       store.list_tool_executions(turn_id: id).map { |attrs| ToolExecution.new(attrs) }
     end
@@ -117,7 +126,7 @@ module TurnKit
         update!(status: "completed", output_text: message, completed_at: Clock.now)
       end
 
-      def add_usage!(usage)
+      def add_usage!(usage, cost: nil)
         current = @record["usage"] || {}
         totals = {
           "input_tokens" => current["input_tokens"].to_i + usage.input_tokens,
@@ -126,11 +135,18 @@ module TurnKit
           "cache_write_tokens" => current["cache_write_tokens"].to_i + usage.cache_write_tokens,
           "total_tokens" => current["total_tokens"].to_i + usage.total_tokens
         }
+        totals["cost_details"] = aggregate_cost(current["cost_details"], cost).to_h if cost&.total
         attributes = { usage: totals, heartbeat_at: Clock.now }
-        attributes[:cost] = @record["cost"].to_f + usage.cost.to_f if usage.cost
+        attributes[:cost] = @record["cost"].to_f + cost.total if cost&.total
         update!(attributes)
       end
 
+      def aggregate_cost(current, cost)
+        return cost unless current
+
+        Cost.aggregate([ Cost.from_hash(current), cost ])
+      end
+
       def update!(attributes)
         @record = store.update_turn(id, attributes)
         @started_at = @record["started_at"]

data/lib/turnkit/usage.rb

@@ -4,6 +4,35 @@ module TurnKit
   class Usage
     attr_reader :input_tokens, :output_tokens, :cached_tokens, :cache_write_tokens, :cost
 
+    def self.aggregate(usages)
+      usages = usages.compact
+      costs = usages.map(&:cost).compact
+      cost = costs.sum if costs.any?
+      new(
+        input_tokens: usages.sum(&:input_tokens),
+        output_tokens: usages.sum(&:output_tokens),
+        cached_tokens: usages.sum(&:cached_tokens),
+        cache_write_tokens: usages.sum(&:cache_write_tokens),
+        cost: cost
+      )
+    end
+
+    def self.from_records(records)
+      aggregate(records.map { |record| from_h(record.fetch("usage", {})) })
+    end
+
+    def self.from_h(hash)
+      attrs = hash.transform_keys(&:to_s)
+      cost = attrs["cost"] unless attrs["cost"].is_a?(Hash)
+      new(
+        input_tokens: attrs["input_tokens"],
+        output_tokens: attrs["output_tokens"],
+        cached_tokens: attrs["cached_tokens"],
+        cache_write_tokens: attrs["cache_write_tokens"],
+        cost: cost
+      )
+    end
+
     def initialize(input_tokens: 0, output_tokens: 0, cached_tokens: 0, cache_write_tokens: 0, cost: nil)
       @input_tokens = input_tokens.to_i
       @output_tokens = output_tokens.to_i

data/lib/turnkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TurnKit
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/lib/turnkit.rb

@@ -10,6 +10,7 @@ require_relative "turnkit/version"
 require_relative "turnkit/error"
 require_relative "turnkit/id"
 require_relative "turnkit/clock"
+require_relative "turnkit/cost"
 require_relative "turnkit/budget"
 require_relative "turnkit/agent"
 require_relative "turnkit/client"
@@ -42,6 +43,7 @@ module TurnKit
     attr_accessor :default_model, :client, :store, :logger
     attr_accessor :max_iterations, :timeout, :max_depth, :max_tool_executions
     attr_accessor :cost_limit, :prompt_cache
+    attr_accessor :cost_rates, :cost_calculator
     attr_accessor :prompt_sections, :prompt_behavior, :available_skills
     attr_accessor :prompt_data_max_chars, :context_contributors
     attr_accessor :system_prompt_contributors, :model_prompt_contributors
@@ -57,6 +59,7 @@ module TurnKit
   self.max_depth = 3
   self.max_tool_executions = 100
   self.prompt_cache = :auto
+  self.cost_rates = {}
   self.prompt_sections = SystemPrompt::DEFAULT_SECTIONS.dup
   self.prompt_data_max_chars = 20_000
   self.available_skills = []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turnkit
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Sam Couch
@@ -43,6 +43,7 @@ files:
 - lib/turnkit/client.rb
 - lib/turnkit/clock.rb
 - lib/turnkit/conversation.rb
+- lib/turnkit/cost.rb
 - lib/turnkit/error.rb
 - lib/turnkit/generators/turnkit/install/templates/conversation.rb
 - lib/turnkit/generators/turnkit/install/templates/create_turnkit_tables.rb