Class: Llmemory::LongTerm::FileBased::Memory

Inherits:
Object
  • Object
show all
Includes:
MemoryModule
Defined in:
lib/llmemory/long_term/file_based/memory.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MemoryModule

#forget_log, #forget_log_store, #read

Constructor Details

#initialize(user_id:, storage: nil, llm: nil, extractor: nil, forget_log_store: nil) ⇒ Memory

Returns a new instance of Memory.



16
17
18
19
20
21
22
 
# File 'lib/llmemory/long_term/file_based/memory.rb', line 16

def initialize(user_id:, storage: nil, llm: nil, extractor: nil, forget_log_store: nil)
  @user_id = user_id
  @storage = storage || Storages.build
  @forget_log_store = forget_log_store
  @llm = llm || Llmemory::LLM.client
  @extractor = extractor || Llmemory::Extractors::FactExtractor.new(llm: @llm)
end

Instance Attribute Details

#storage ⇒ Object (readonly)

Returns the value of attribute storage.



147
148
149
 
# File 'lib/llmemory/long_term/file_based/memory.rb', line 147

def storage
  @storage
end

#user_id ⇒ Object (readonly)

Returns the value of attribute user_id.



147
148
149
 
# File 'lib/llmemory/long_term/file_based/memory.rb', line 147

def user_id
  @user_id
end

Instance Method Details

#forget(ids:, reason: nil, mode: :soft) ⇒ Object

Removes items/resources by id and records the removal in the audit log. Note: file-based storages currently implement archive_* as physical removal — mode: :soft and mode: :hard are functionally equivalent here. Kept for API uniformity.



135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/llmemory/long_term/file_based/memory.rb', line 135

def forget(ids:, reason: nil, mode: :soft)
  requested = Array(ids).map(&:to_s)
  existing = (@storage.get_all_items(@user_id) + @storage.get_all_resources(@user_id))
    .map { |r| (r[:id] || r["id"]).to_s }
  removed = requested & existing
  @storage.archive_items(@user_id, removed)
  @storage.archive_resources(@user_id, removed)
  forget_log.record(@user_id, memory_type: "file_based", ids: removed, reason: reason)
  Llmemory::Instrumentation.instrument(:memory_forget, memory_type: "file_based", user_id: @user_id, count: removed.size, mode: mode)
  removed.size
end

#list(user_id: nil, limit: nil, offset: nil) ⇒ Object 



123
124
125
 
# File 'lib/llmemory/long_term/file_based/memory.rb', line 123

def list(user_id: nil, limit: nil, offset: nil)
  @storage.list_items(user_id: user_id || @user_id, limit: limit, offset: offset)
end

#memorize(conversation_text) ⇒ Object 



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
 
# File 'lib/llmemory/long_term/file_based/memory.rb', line 24

def memorize(conversation_text)
  text = Llmemory.configuration.noise_filter_enabled ? NoiseFilter.filter?(conversation_text) : conversation_text.to_s
  return true if text.strip.empty?

  resource_id = save_resource(text)
  append_to_daily_log(text) if Llmemory.configuration.daily_logs_enabled && @storage.respond_to?(:save_daily_log_entry)
  items = @extractor.extract_items(text)
  contents = items.map do |item|
    item.is_a?(Hash) ? (item["content"] || item[:content]).to_s : item.to_s
  end
  classifications = @extractor.classify_items(contents)
  updates_by_category = {}

  items.each do |item|
    content = item.is_a?(Hash) ? (item["content"] || item[:content]) : item.to_s
    importance = (item["importance"] || item[:importance] || 0.7).to_f
    cat = classifications[content] || @extractor.classify_item(content)
    updates_by_category[cat] ||= []
    updates_by_category[cat] << content.to_s
    save_item(category: cat, item: item, source_resource_id: resource_id, importance: importance)
  end

  updates_by_category.each do |category, new_memories|
    existing_summary = @storage.load_category(@user_id, category)
    updated_summary = @extractor.evolve_summary(existing: existing_summary, new_memories: new_memories)
    @storage.save_category(@user_id, category, updated_summary)
  end

  true
end

#remember_fact(content:, category: "general", importance: 0.6, provenance: nil) ⇒ Object

Stores a single fact produced outside the extraction flow (e.g. by reflection over episodes), preserving caller-supplied provenance so the insight remains traceable to its source. Returns the item id.



101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/llmemory/long_term/file_based/memory.rb', line 101

def remember_fact(content:, category: "general", importance: 0.6, provenance: nil)
  return nil if content.to_s.strip.empty?
  @storage.save_item(
    @user_id,
    category: category.to_s,
    content: content.to_s,
    source_resource_id: nil,
    importance: importance,
    provenance: provenance
  )
end

#retrieve(query) ⇒ Object 



55
56
57
58
 
# File 'lib/llmemory/long_term/file_based/memory.rb', line 55

def retrieve(query)
  candidates = search_candidates(query, top_k: 20)
  Llmemory::Retrieval::ContextAssembler.new.assemble(candidates)
end

#search_candidates(query, user_id: nil, top_k: 20) ⇒ Object 



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
 
# File 'lib/llmemory/long_term/file_based/memory.rb', line 60

def search_candidates(query, user_id: nil, top_k: 20)
  uid = user_id || @user_id
  items = @storage.search_items(uid, query)
  resources = @storage.search_resources(uid, query)
  daily_logs = load_daily_logs_for_retrieval(uid) if Llmemory.configuration.daily_logs_enabled && @storage.respond_to?(:load_daily_logs)
  category_summaries = load_category_summaries_as_candidates(uid, query)
  out = []

  category_summaries.each do |c|
    out << c.merge(evergreen: true)
  end

  items.first(top_k).each do |i|
    out << {
      id: i[:id] || i["id"],
      text: i[:content] || i["content"],
      timestamp: i[:created_at] || i["created_at"],
      score: 1.0,
      importance: (i[:importance] || i["importance"] || 1.0).to_f,
      evergreen: i[:evergreen] || i["evergreen"]
    }
  end
  resources.first([top_k - out.size, 0].max).each do |r|
    out << {
      id: r[:id] || r["id"],
      text: r[:text] || r["text"],
      timestamp: r[:created_at] || r["created_at"],
      score: 0.9
    }
  end
  if daily_logs
    daily_logs.each do |log|
      out << { text: log[:content], timestamp: log[:date].to_time, score: 0.85 }
    end
  end
  out
end

#stats(user_id: nil) ⇒ Object 



127
128
129
 
# File 'lib/llmemory/long_term/file_based/memory.rb', line 127

def stats(user_id: nil)
  { items: @storage.count_items(user_id: user_id || @user_id) }
end

#write(payload, **_meta) ⇒ Object

--- MemoryModule uniform interface ---



115
116
117
118
119
120
121
 
# File 'lib/llmemory/long_term/file_based/memory.rb', line 115

def write(payload, **_meta)
  result = nil
  Llmemory::Instrumentation.instrument(:memory_write, memory_type: "file_based", user_id: @user_id) do
    result = memorize(payload)
  end
  result
end