Module: TurnKit

Defined in:
lib/turnkit.rb,
lib/turnkit/id.rb,
lib/turnkit/run.rb,
lib/turnkit/cost.rb,
lib/turnkit/tool.rb,
lib/turnkit/turn.rb,
lib/turnkit/agent.rb,
lib/turnkit/clock.rb,
lib/turnkit/error.rb,
lib/turnkit/event.rb,
lib/turnkit/skill.rb,
lib/turnkit/store.rb,
lib/turnkit/usage.rb,
lib/turnkit/budget.rb,
lib/turnkit/client.rb,
lib/turnkit/record.rb,
lib/turnkit/result.rb,
lib/turnkit/message.rb,
lib/turnkit/version.rb,
lib/turnkit/workflow.rb,
lib/turnkit/tool_call.rb,
lib/turnkit/compaction.rb,
lib/turnkit/prompt_data.rb,
lib/turnkit/tool_runner.rb,
lib/turnkit/conversation.rb,
lib/turnkit/memory_store.rb,
lib/turnkit/output_audit.rb,
lib/turnkit/model_request.rb,
lib/turnkit/output_policy.rb,
lib/turnkit/rails/railtie.rb,
lib/turnkit/system_prompt.rb,
lib/turnkit/adapters/codex.rb,
lib/turnkit/prompt_context.rb,
lib/turnkit/sub_agent_tool.rb,
lib/turnkit/tool_execution.rb,
lib/turnkit/adapters/ruby_llm.rb,
lib/turnkit/message_projection.rb,
lib/turnkit/prompt_contribution.rb,
lib/turnkit/stores/active_record_store.rb,
lib/turnkit/generators/turnkit/install_generator.rb

Defined Under Namespace

Modules: Adapters, Clock, Compaction, Generators, Id, PromptData, Record Classes: ActiveRecordStore, Agent, Budget, BudgetError, Client, CompactionError, ConfigError, Conversation, Cost, Error, Event, LiveContextContribution, MemoryStore, Message, MessageProjection, ModelAccessError, ModelRequest, OutputAudit, OutputPolicy, PromptBuildContext, PromptContribution, Railtie, Result, Run, Skill, Store, StoreError, SubAgentTool, SystemPrompt, Tool, ToolCall, ToolContext, ToolError, ToolExecution, ToolRunner, ToolValidationError, Turn, Usage, Workflow

Constant Summary collapse

VERSION = 
"0.2.10"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.available_skills ⇒ Object

Returns the value of attribute available_skills.



59
60
61
 
# File 'lib/turnkit.rb', line 59

def available_skills
  @available_skills
end

.client ⇒ Object

Returns the value of attribute client.



52
53
54
 
# File 'lib/turnkit.rb', line 52

def client
  @client
end

.compaction ⇒ Object

Returns the value of attribute compaction.



56
57
58
 
# File 'lib/turnkit.rb', line 56

def compaction
  @compaction
end

.context_contributors ⇒ Object

Returns the value of attribute context_contributors.



60
61
62
 
# File 'lib/turnkit.rb', line 60

def context_contributors
  @context_contributors
end

.conversation_record_class ⇒ Object

Returns the value of attribute conversation_record_class.



63
64
65
 
# File 'lib/turnkit.rb', line 63

def conversation_record_class
  @conversation_record_class
end

.cost_calculator ⇒ Object

Returns the value of attribute cost_calculator.



58
59
60
 
# File 'lib/turnkit.rb', line 58

def cost_calculator
  @cost_calculator
end

.cost_limit ⇒ Object

Returns the value of attribute cost_limit.



55
56
57
 
# File 'lib/turnkit.rb', line 55

def cost_limit
  @cost_limit
end

.cost_rates ⇒ Object

Returns the value of attribute cost_rates.



58
59
60
 
# File 'lib/turnkit.rb', line 58

def cost_rates
  @cost_rates
end

.default_model ⇒ Object

Returns the value of attribute default_model.



52
53
54
 
# File 'lib/turnkit.rb', line 52

def default_model
  @default_model
end

.logger ⇒ Object

Returns the value of attribute logger.



52
53
54
 
# File 'lib/turnkit.rb', line 52

def logger
  @logger
end

.max_depth ⇒ Object

Returns the value of attribute max_depth.



53
54
55
 
# File 'lib/turnkit.rb', line 53

def max_depth
  @max_depth
end

.max_iterations ⇒ Object

Returns the value of attribute max_iterations.



53
54
55
 
# File 'lib/turnkit.rb', line 53

def max_iterations
  @max_iterations
end

.max_tool_executions ⇒ Object

Returns the value of attribute max_tool_executions.



53
54
55
 
# File 'lib/turnkit.rb', line 53

def max_tool_executions
  @max_tool_executions
end

.max_tool_executions_by_name ⇒ Object

Returns the value of attribute max_tool_executions_by_name.



54
55
56
 
# File 'lib/turnkit.rb', line 54

def max_tool_executions_by_name
  @max_tool_executions_by_name
end

.message_record_class ⇒ Object

Returns the value of attribute message_record_class.



64
65
66
 
# File 'lib/turnkit.rb', line 64

def message_record_class
  @message_record_class
end

.model_prompt_contributors ⇒ Object

Returns the value of attribute model_prompt_contributors.



61
62
63
 
# File 'lib/turnkit.rb', line 61

def model_prompt_contributors
  @model_prompt_contributors
end

.on_event ⇒ Object

Returns the value of attribute on_event.



62
63
64
 
# File 'lib/turnkit.rb', line 62

def on_event
  @on_event
end

.output_policy_model ⇒ Object

Returns the value of attribute output_policy_model.



57
58
59
 
# File 'lib/turnkit.rb', line 57

def output_policy_model
  @output_policy_model
end

.output_policy_thinking ⇒ Object

Returns the value of attribute output_policy_thinking.



57
58
59
 
# File 'lib/turnkit.rb', line 57

def output_policy_thinking
  @output_policy_thinking
end

.prompt_behavior ⇒ Object

Returns the value of attribute prompt_behavior.



59
60
61
 
# File 'lib/turnkit.rb', line 59

def prompt_behavior
  @prompt_behavior
end

.prompt_cache ⇒ Object

Returns the value of attribute prompt_cache.



55
56
57
 
# File 'lib/turnkit.rb', line 55

def prompt_cache
  @prompt_cache
end

.prompt_data_max_chars ⇒ Object

Returns the value of attribute prompt_data_max_chars.



60
61
62
 
# File 'lib/turnkit.rb', line 60

def prompt_data_max_chars
  @prompt_data_max_chars
end

.prompt_sections ⇒ Object

Returns the value of attribute prompt_sections.



59
60
61
 
# File 'lib/turnkit.rb', line 59

def prompt_sections
  @prompt_sections
end

.store ⇒ Object

Returns the value of attribute store.



52
53
54
 
# File 'lib/turnkit.rb', line 52

def store
  @store
end

.system_prompt_contributors ⇒ Object

Returns the value of attribute system_prompt_contributors.



61
62
63
 
# File 'lib/turnkit.rb', line 61

def system_prompt_contributors
  @system_prompt_contributors
end

.timeout ⇒ Object

Returns the value of attribute timeout.



53
54
55
 
# File 'lib/turnkit.rb', line 53

def timeout
  @timeout
end

.tool_execution_record_class ⇒ Object

Returns the value of attribute tool_execution_record_class.



64
65
66
 
# File 'lib/turnkit.rb', line 64

def tool_execution_record_class
  @tool_execution_record_class
end

.turn_record_class ⇒ Object

Returns the value of attribute turn_record_class.



63
64
65
 
# File 'lib/turnkit.rb', line 63

def turn_record_class
  @turn_record_class
end

Class Method Details

.audit_output(output, constraints: [], context: {}) ⇒ Object 



114
115
116
 
# File 'lib/turnkit.rb', line 114

def self.audit_output(output, constraints: [], context: {})
  OutputAudit.check(output, constraints: constraints, context: context)
end

.configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:

  • _self (TurnKit) —

    the object that the method was called on



88
89
90
 
# File 'lib/turnkit.rb', line 88

def self.configure
  yield self
end

.max_spend ⇒ Object 



100
101
102
 
# File 'lib/turnkit.rb', line 100

def self.max_spend
  cost_limit
end

.max_spend=(value) ⇒ Object 



104
105
106
 
# File 'lib/turnkit.rb', line 104

def self.max_spend=(value)
  self.cost_limit = value
end

.model ⇒ Object 



92
93
94
 
# File 'lib/turnkit.rb', line 92

def self.model
  default_model
end

.model=(value) ⇒ Object 



96
97
98
 
# File 'lib/turnkit.rb', line 96

def self.model=(value)
  self.default_model = value
end

.reconcile_stale!(before: Clock.now - (timeout || 300)) ⇒ Object 



108
109
110
111
112
 
# File 'lib/turnkit.rb', line 108

def self.reconcile_stale!(before: Clock.now - (timeout || 300))
  store.find_stale_turns(before: before).each do |turn|
    store.update_turn(turn.fetch("id"), "status" => "stale", "completed_at" => Clock.now)
  end
end