Class: LLM::Buffer

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/llm/buffer.rb

Overview

LLM::Buffer provides an Enumerable object that tracks messages in a conversation thread.

Instance Method Summary collapse

Constructor Details

#initialize(provider) ⇒ LLM::Buffer

Parameters:



13
14
15
16
 
# File 'lib/llm/buffer.rb', line 13

def initialize(provider)
  @provider = provider
  @messages = []
end

Instance Method Details

#<<(item) ⇒ void Also known as: push

This method returns an undefined value.

Parameters:



67
68
69
70
 
# File 'lib/llm/buffer.rb', line 67

def <<(item)
  @messages << item
  self
end

#[](index) ⇒ LLM::Message?

Returns a message, or nil

Parameters:

  • index (Integer, Range) —

    The message index

Returns:



78
79
80
 
# File 'lib/llm/buffer.rb', line 78

def [](index)
  @messages[index]
end

#concat(ary) ⇒ Object

Append an array

Parameters:



22
23
24
 
# File 'lib/llm/buffer.rb', line 22

def concat(ary)
  @messages.concat(ary)
end

#each {|LLM::Message| ... } ⇒ void

This method returns an undefined value.

Yields:

  • (LLM::Message) —

    Yields each message in the conversation thread



30
31
32
33
34
35
36
 
# File 'lib/llm/buffer.rb', line 30

def each(...)
  if block_given?
    @messages.each { yield(_1) }
  else
    enum_for(:each, ...)
  end
end

#empty? ⇒ Boolean

Returns true when the buffer is empty

Returns:

  • (Boolean) 


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

def empty?
  @messages.empty?
end

#find ⇒ LLM::Message?

Find a message (in descending order)

Returns:



50
51
52
 
# File 'lib/llm/buffer.rb', line 50

def find(...)
  reverse_each.find(...)
end

#inspect ⇒ String

Returns:

  • (String) 


84
85
86
87
 
# File 'lib/llm/buffer.rb', line 84

def inspect
  "#<#{self.class.name}:0x#{object_id.to_s(16)} " \
  "message_count=#{@messages.size}>"
end

#last(n = nil) ⇒ LLM::Message, ...

Returns the last message(s) in the buffer

Parameters:

  • n (Integer, nil) (defaults to: nil) —

    The number of messages to return

Returns:



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

def last(n = nil)
  n.nil? ? @messages.last : @messages.last(n)
end

#unread ⇒ Array<LLM::Message>

Returns an array of unread messages

Returns:

See Also:



43
44
45
 
# File 'lib/llm/buffer.rb', line 43

def unread
  reject(&:read?)
end