update

src/util.jl

@@ -122,47 +122,53 @@ This function takes in a vector of dictionaries and outputs a single string wher
 
 # Arguments
   - `vecd::Vector`
-    a vector of dictionaries
+    A vector of dictionaries containing chat messages
   - `withkey::Bool` 
-    whether to include the key in the output text. Default is true
+    Whether to include the name as a prefix in the output text. Default is true
+  - `range::Union{Nothing,UnitRange,Int}` 
+    Optional range of messages to include. If nothing, includes all messages
 
-# Return
-  a string with the formatted dictionaries
+# Returns
+  A formatted string where each line contains either:
+  - If withkey=true: "name> message\n"
+  - If withkey=false: "message\n"
 
 # Example
-```jldoctest
+
 julia> using Revise
 julia> using GeneralUtils
 julia> vecd = [Dict(:name => "John", :text => "Hello"), Dict(:name => "Jane", :text => "Goodbye")]
 julia> GeneralUtils.vectorOfDictToText(vecd, withkey=true)
 "John> Hello\nJane> Goodbye\n"
 ```
-# Signature
 """
-function chatHistoryToText(vecd::Vector; withkey=true)::String
+function chatHistoryToText(vecd::Vector; withkey=true, range=nothing)::String
   # Initialize an empty string to hold the final text
   text = ""
   
+  # Get the elements within the specified range, or all elements if no range provided
+  elements = isnothing(range) ? vecd : vecd[range]
+  
   # Determine whether to include the key in the output text or not
   if withkey
-      # Loop through each dictionary in the input vector
-      for d in vecd
-          # Extract the 'name' and 'text' keys from the dictionary
-          name = d[:name]
-          _text = d[:text]
-          
-          # Append the formatted string to the text variable
-          text *= "$name> $_text \n"
+    # Loop through each dictionary in the input vector
+    for d in elements
+        # Extract the 'name' and 'text' keys from the dictionary
+        name = d[:name]
+        _text = d[:text]
+        
+        # Append the formatted string to the text variable
+        text *= "$name:> $_text \n"
       end
   else
-      # Loop through each dictionary in the input vector
-      for d in vecd
-          # Iterate over all key-value pairs in the dictionary
-          for (k, v) in d
-              # Append the formatted string to the text variable
-              text *= "$v \n"
-          end
-      end
+    # Loop through each dictionary in the input vector
+    for d in elements
+        # Iterate over all key-value pairs in the dictionary
+        for (k, v) in d
+            # Append the formatted string to the text variable
+            text *= "$v \n"
+        end
+    end
   end
   
   # Return the final text
@@ -191,6 +197,35 @@ end
 
 
 
+""" Create a dictionary representing an event with optional details.
+
+# Arguments
+  - `event_description::Union{String, Nothing}`
+    A description of the event
+  - `timestamp::Union{DateTime, Nothing}`
+    The time when the event occurred
+  - `subject::Union{String, Nothing}`
+    The subject or entity associated with the event
+  - `thought::Union{AbstractDict, Nothing}`
+    Any associated thoughts or metadata
+  - `actionname::Union{String, Nothing}`
+    The name of the action performed (e.g., "CHAT", "CHECKINVENTORY")
+  - `actioninput::Union{String, Nothing}`
+    Input or parameters for the action
+  - `location::Union{String, Nothing}`
+    Where the event took place
+  - `equipment_used::Union{String, Nothing}`
+    Equipment involved in the event
+  - `material_used::Union{String, Nothing}`
+    Materials used during the event
+  - `outcome::Union{String, Nothing}`
+    The result or consequence of the event after action execution
+  - `note::Union{String, Nothing}`
+    Additional notes or comments
+
+# Returns
+  A dictionary with event details as symbol-keyed key-value pairs
+"""
 function eventdict(;
   event_description::Union{String, Nothing}=nothing,
   timestamp::Union{DateTime, Nothing}=nothing,
@@ -220,9 +255,33 @@ function eventdict(;
 end
 
 
-function createTimeline(memory::T1; skiprecent::Integer=0) where {T1<:AbstractVector}
-  events = memory[1:end-skiprecent]
+""" Create a formatted timeline string from a sequence of events.
 
+# Arguments
+  - `events::T1`
+    Vector of event dictionaries containing subject, actioninput and optional outcome fields
+    Each event dictionary should have the following keys:
+    - :subject - The subject or entity performing the action
+    - :actioninput - The action or input performed by the subject
+    - :outcome - (Optional) The result or outcome of the action
+
+# Returns
+  - `timeline::String`
+    A formatted string representing the events with their subjects, actions, and optional outcomes
+    Format: "{subject}> {actioninput} {outcome}\n" for each event
+
+# Example
+
+events = [
+  Dict(:subject => "User", :actioninput => "Hello", :outcome => nothing),
+  Dict(:subject => "Assistant", :actioninput => "Hi there!", :outcome => "with a smile")
+]
+timeline = createTimeline(events)
+# User> Hello
+# Assistant> Hi there! with a smile
+
+"""
+function createTimeline(events::T1) where {T1<:AbstractVector}
   timeline = ""
   for (i, event) in enumerate(events)
     if event[:outcome] === nothing
@@ -236,8 +295,6 @@ function createTimeline(memory::T1; skiprecent::Integer=0) where {T1<:AbstractVe
 end
 
 
-
-
 # """ Convert a single chat dictionary into LLM model instruct format.
 
 # # Llama 3 instruct format example