Fix separators (#55)

svilupp · Jan 21, 2024 · 362aa86 · 362aa86 · svilupp · Jan 21, 2024
1 parent d81a2d3
commit 362aa86
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+## [0.8.1]
+
+### Fixed
+- Fixed `split_by_length` to not mutate `separators` argument (appeared in RAG use cases where we repeatedly apply splits to different documents)
+
 ## [0.8.0]
 
 ### Added

diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "PromptingTools"
 uuid = "670122d1-24a8-4d70-bfce-740807c42192"
 authors = ["J S @svilupp and contributors"]
-version = "0.8.0"
+version = "0.8.1"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

diff --git a/src/utils.jl b/src/utils.jl
@@ -151,12 +151,13 @@ chunks = split_by_length(text, [","], max_length=10000)
 """
 function split_by_length(text, separators::Vector{String}; max_length)
     @assert !isempty(separators) "`separators` can't be empty"
-    separator = popfirst!(separators)
+    separators_ = copy(separators)
+    separator = popfirst!(separators_)
     chunks = split_by_length(text; separator, max_length)
 
-    isempty(separators) && return chunks
+    isempty(separators_) && return chunks
     ## Iteratively split by separators
-    for separator in separators
+    for separator in separators_
         chunks = mapreduce(text_ -> split_by_length(text_; max_length, separator),
             vcat,
             chunks)

diff --git a/test/utils.jl b/test/utils.jl
@@ -67,12 +67,22 @@ end
     # empty separators
     text = "Some text without separators."
     @test_throws AssertionError split_by_length(text, String[], max_length = 10)
+
     # edge cases
     text = "Short text"
     separators = ["\n\n", ". ", "\n"]
     chunks = split_by_length(text, separators, max_length = 50)
     @test length(chunks) == 1
     @test chunks[1] == text
+
+    # do not mutate separators input
+    text = "Paragraph 1\n\nParagraph 2. Sentence 1. Sentence 2.\nParagraph 3"
+    separators = ["\n\n", ". ", "\n"]
+    sep_length = length(separators)
+    chunks = split_by_length(text, separators, max_length = 20)
+    chunks = split_by_length(text, separators, max_length = 20)
+    chunks = split_by_length(text, separators, max_length = 20)
+    @test length(separators) == sep_length
 end
 
 @testset "extract_handlebar_variables" begin