mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-08-07 08:01:13 +08:00
Fixes #17202 (and complements #12109). ## Problem `RAGFlowTxtParser.parser_txt` (`deepdoc/parser/txt_parser.py:36-47`) and `rag.nlp.naive_merge` (`rag/nlp/__init__.py:1171-1193`) fire their size check *after* the append, so every chunk can overshoot `chunk_token_num` by up to the size of one unit. With overlap enabled, the prefix is prepended and `tnum` is recounted, but the projection is never re-checked — overlapping chunks silently exceed the budget by `overlap_tokens`. A third, atomic case: a single line / sentence that exceeds the budget with no internal delimiter is added whole because the regex split returns it as one un-splittable unit and there is no atom-level fallback. `RAGFlowHtmlParser.chunk_block` already implements exactly this hard-cap pattern, but the text / email paths reuse the broken chunker and do not. Measured on a live dataset (336 `.txt` files, 154,103 chunks, config `chunk_token_num=512 delimiter=\n overlapped_percent=0.1`): 56.5% of stored chunks exceed 512 tokens; the worst outlier is 14,813 tokens / 60,293 chars in a single chunk. Symptom downstream: rerank failures on the >2048-token outliers (ref. #12109) and silent embedding truncation on every oversize chunk. ## Fix Mirror the proven pattern in `RAGFlowHtmlParser.chunk_block`: 1. **Proactive projected-total check** in `TxtParser.parser_txt` and in `naive_merge.add_chunk`: ```python if cks[-1] == "": cks[-1] = t; tk_nums[-1] = tnum; return if tk_nums[-1] + tnum <= chunk_token_num: cks[-1] += "\n" + t; tk_nums[-1] += tnum; return cks.append(t); tk_nums.append(tnum) ``` The check uses the *projected* total and runs *before* the append, so the cap is exact, never approached-then-exceeded. 2. **Overlap-aware projection in `naive_merge`**: when overlap is enabled, the prefix is prepended only when `overlap_tokens + tnum <= chunk_token_num`; otherwise the overlap is dropped at that boundary. The naive_merge-with-images mirror gets the same treatment. Custom-delimiter behaviour is preserved per the existing test suite. 3. **Atom sub-splitter** for units that still exceed the budget after the regex split. Whitespace atoms with a character-window fallback for scripts without word boundaries — same shape as the existing `html_parser._split_oversized_block`, so behaviour matches for HTML vs `.txt` vs PDF atomic-oversize. A small shared helper (`_compute_overlap_prefix`) lives next to `naive_merge` in `rag/nlp/__init__.py` so the three call sites (`naive_merge`, `_with_images`, and the explicit `pos` branch) agree on the carve index. ## Result on the dataset above | | Before | After | |---|---|---| | Chunks > 512 tokens | 56.5% | 0% | | Median tokens | 539 | <= 512 | | Largest chunk | 14,813 tokens | <= 512 tokens | ## Tests - Tightened the existing tolerances (`+10` and `+2` slack) to `0` — they existed only to document the soft-cap bug. - Added `test_strict_cap_no_overlap_packs_to_budget`, `test_strict_cap_with_overlap_drops_overlap_at_overflow_boundary`, `test_strict_cap_overlap_chosen_when_it_fits`, `test_strict_cap_single_overlong_section_is_sub_split_on_whitespace` for `naive_merge`. - Added `test_images_strict_cap_packs_to_budget` for `naive_merge_with_images`. - New `test/unit_test/deepdoc/parser/test_txt_parser.py` covers `parser_txt` strict cap and atom sub-split. Uses the same path-loading pattern as the existing `test_html_parser.py` to avoid pulling the deep import chain into a test-time-only venv. All 22 unit tests pass on the host venv: ``` test_naive_merge.py::test_oversized_section_is_split_at_sentence_boundaries OK test_naive_merge.py::test_small_sections_are_merged_not_oversplit OK test_naive_merge.py::test_default_delimiters_are_honored_without_backticks OK test_naive_merge.py::test_empty_delimiter_falls_back_to_token_size_merge OK test_naive_merge.py::test_overlap_prefix_is_counted_in_token_budget OK test_naive_merge.py::test_custom_delimiter_ignores_chunk_size OK test_naive_merge.py::test_custom_delimiter_does_not_size_merge OK test_naive_merge.py::test_images_oversized_section_is_split OK test_naive_merge.py::test_images_custom_delimiter_preserved OK test_naive_merge.py::test_images_plain_string_input OK test_naive_merge.py::test_images_mismatched_lengths_returns_empty OK test_naive_merge.py::test_images_shared_lazyimage_not_stacked_… OK test_naive_merge.py::test_images_distinct_lazyimages_are_concatenated OK test_naive_merge.py::test_strict_cap_no_overlap_packs_to_budget OK test_naive_merge.py::test_strict_cap_with_overlap_drops_… OK test_naive_merge.py::test_strict_cap_single_overlong_section_… OK test_naive_merge.py::test_strict_cap_overlap_chosen_when_it_fits OK test_naive_merge.py::test_images_strict_cap_packs_to_budget OK test_txt_parser.py::test_no_overshoot_when_packing_short_lines OK test_txt_parser.py::test_no_overshoot_at_chunk_boundary OK test_txt_parser.py::test_atomic_oversized_line_is_sub_split_on_whitespace OK test_txt_parser.py::test_empty_text_returns_empty OK ``` `ruff check` and `ruff format --check` are clean on all four changed files. ## Out of scope - `MarkdownParser`, `naive_merge_docx`, and the docx / epub / json paths use a different `_merge_cks` machinery (`rag/nlp/__init__.py:1574`) that already enforces the budget. They are unchanged. - The `chunk_block` call sites in `deepdoc/parser/html_parser.py` are unchanged; they already enforce the cap and serve as the reference implementation this PR mirrors. Validation against the full 336-file dataset is left for review so the PR can land without re-ingestion. --------- Co-authored-by: skbs-eng <skbs-eng@users.noreply.github.com> Co-authored-by: kiloconnect[bot] <240665456+kiloconnect[bot]@users.noreply.github.com>
267 lines
8.3 KiB
Go
267 lines
8.3 KiB
Go
//
|
|
// Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
package chunker
|
|
|
|
import (
|
|
"context"
|
|
"strings"
|
|
"testing"
|
|
"unicode/utf8"
|
|
|
|
"ragflow/internal/ingestion/component/schema"
|
|
)
|
|
|
|
// wordCount is a deterministic tokenizer stand-in used only via
|
|
// splitOversizedUnitWith in unit-level helper tests.
|
|
func wordCount(s string) int {
|
|
s = strings.TrimSpace(s)
|
|
if s == "" {
|
|
return 0
|
|
}
|
|
return len(strings.Fields(s))
|
|
}
|
|
|
|
func charCount(s string) int { return utf8.RuneCountInString(s) }
|
|
|
|
func TestSplitOversizedUnit_WhitespacePacksToBudget(t *testing.T) {
|
|
// 100 words, budget 30 → must yield multiple pieces, each ≤ 30 words.
|
|
text := strings.TrimSpace(strings.Repeat("word ", 100))
|
|
pieces := splitOversizedUnitWith(text, 30, wordCount)
|
|
if len(pieces) < 2 {
|
|
t.Fatalf("want multiple pieces, got %d: %#v", len(pieces), pieces)
|
|
}
|
|
total := 0
|
|
for _, p := range pieces {
|
|
n := wordCount(p)
|
|
if n > 30 {
|
|
t.Errorf("piece exceeds budget: tokens=%d text=%q", n, p)
|
|
}
|
|
total += n
|
|
}
|
|
if total != 100 {
|
|
t.Errorf("word count not preserved: got %d want 100", total)
|
|
}
|
|
}
|
|
|
|
func TestSplitOversizedUnit_UnbrokenAtomFallsBackToCharWindows(t *testing.T) {
|
|
// Unbroken run with char-as-token counting — must sub-split on runes.
|
|
atom := strings.Repeat("a", 80)
|
|
pieces := splitOversizedUnitWith(atom, 50, charCount)
|
|
if len(pieces) < 2 {
|
|
t.Fatalf("want >=2 pieces for unbroken atom, got %d", len(pieces))
|
|
}
|
|
joined := strings.Join(pieces, "")
|
|
if joined != atom {
|
|
t.Errorf("content not preserved: got %q", joined)
|
|
}
|
|
for _, p := range pieces {
|
|
if charCount(p) > 50 {
|
|
t.Errorf("piece exceeds budget: %d runes in %q", charCount(p), p)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestSplitOversizedUnit_WithinBudgetUnchanged(t *testing.T) {
|
|
text := "hello world"
|
|
pieces := splitOversizedUnitWith(text, 100, wordCount)
|
|
if len(pieces) != 1 || pieces[0] != text {
|
|
t.Fatalf("within-budget text must be returned as-is, got %#v", pieces)
|
|
}
|
|
}
|
|
|
|
func TestComputeOverlapPrefix_StripsTagsAndCounts(t *testing.T) {
|
|
prev := strings.Repeat("word ", 20) + "@@1\t2.3## tail"
|
|
overlap, n := computeOverlapPrefix(prev, 30)
|
|
if strings.Contains(overlap, "@@") || strings.Contains(overlap, "##") {
|
|
t.Errorf("overlap must strip parser tags, got %q", overlap)
|
|
}
|
|
if n <= 0 {
|
|
t.Errorf("overlap token count must be >0, got %d", n)
|
|
}
|
|
if tokenizeStr(overlap) != n {
|
|
t.Errorf("reported tokens %d != tokenizeStr(overlap) %d", n, tokenizeStr(overlap))
|
|
}
|
|
}
|
|
|
|
func TestMergeByTokenSizeFromJSON_StrictCapNoOvershoot(t *testing.T) {
|
|
// Eight 25-token-ish sections under a 50-token budget must pack without
|
|
// any chunk exceeding the budget (Python test_strict_cap_no_overlap).
|
|
const budget = 50
|
|
sections := make([]schema.ChunkDoc, 0, 8)
|
|
for i := 0; i < 8; i++ {
|
|
text := strings.TrimSpace(strings.Repeat("w ", 25))
|
|
sections = append(sections, schema.ChunkDoc{
|
|
Text: text, DocType: "text", CKType: "text", TKNums: intPtr(tokenizeStr(text)),
|
|
})
|
|
}
|
|
got := mergeByTokenSizeFromJSON([][]schema.ChunkDoc{sections}, budget, 0)
|
|
merged := got[0]
|
|
if len(merged) < 3 {
|
|
t.Fatalf("want >=3 chunks, got %d", len(merged))
|
|
}
|
|
for i, ck := range merged {
|
|
n := tokenizeStr(ck.Text)
|
|
if n > budget {
|
|
t.Errorf("chunk %d exceeds budget: tokens=%d text_len=%d", i, n, len(ck.Text))
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestMergeByTokenSizeFromJSON_OverlapDroppedAtOverflow(t *testing.T) {
|
|
// With a tight budget, overlap must never push a chunk over the cap.
|
|
const budget = 25
|
|
sections := make([]schema.ChunkDoc, 0, 20)
|
|
for i := 0; i < 20; i++ {
|
|
text := strings.TrimSpace(strings.Repeat("w ", 10))
|
|
sections = append(sections, schema.ChunkDoc{
|
|
Text: text, DocType: "text", CKType: "text", TKNums: intPtr(tokenizeStr(text)),
|
|
})
|
|
}
|
|
got := mergeByTokenSizeFromJSON([][]schema.ChunkDoc{sections}, budget, 20)
|
|
for i, ck := range got[0] {
|
|
if n := tokenizeStr(ck.Text); n > budget {
|
|
t.Errorf("chunk %d exceeds budget with overlap: tokens=%d", i, n)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestMergeByTokenSizeFromJSON_OversizedUnitIsSubSplit(t *testing.T) {
|
|
// A single unit larger than the budget must be atom-split before merge.
|
|
const budget = 30
|
|
long := strings.TrimSpace(strings.Repeat("word ", 100))
|
|
items := [][]schema.ChunkDoc{{
|
|
{Text: long, DocType: "text", CKType: "text", TKNums: intPtr(tokenizeStr(long))},
|
|
}}
|
|
got := mergeByTokenSizeFromJSON(items, budget, 0)
|
|
if len(got[0]) < 2 {
|
|
t.Fatalf("oversized unit must yield multiple chunks, got %d", len(got[0]))
|
|
}
|
|
for i, ck := range got[0] {
|
|
if n := tokenizeStr(ck.Text); n > budget {
|
|
t.Errorf("chunk %d exceeds budget: tokens=%d", i, n)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestMergeByTokenSize_TextPathStrictCap(t *testing.T) {
|
|
// End-to-end text path: long multi-paragraph input under a tight budget.
|
|
const budget = 40
|
|
var b strings.Builder
|
|
for i := 0; i < 30; i++ {
|
|
b.WriteString(strings.TrimSpace(strings.Repeat("word ", 15)))
|
|
b.WriteString("\n\n")
|
|
}
|
|
comp, err := NewTokenChunker(map[string]any{
|
|
"delimiter_mode": "token_size",
|
|
"chunk_token_size": budget,
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("NewTokenChunker: %v", err)
|
|
}
|
|
tc := comp.(*TokenChunkerComponent)
|
|
out := tc.mergeByTokenSize(b.String(), nil)
|
|
chunks, _ := out["chunks"].([]map[string]any)
|
|
if len(chunks) < 2 {
|
|
t.Fatalf("want multiple chunks, got %d", len(chunks))
|
|
}
|
|
for i, ck := range chunks {
|
|
text, _ := ck["text"].(string)
|
|
if n := tokenizeStr(text); n > budget {
|
|
t.Errorf("chunk %d exceeds budget: tokens=%d", i, n)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestMergeByTokenSize_UnbrokenAtomStrictCap(t *testing.T) {
|
|
// Unbroken dense string (no whitespace / sentence delim) must still
|
|
// hard-cap via the character-window fallback inside splitOversizedUnit.
|
|
const budget = 20
|
|
// Use many distinct ASCII letters so cl100k does not collapse the whole
|
|
// run into a handful of tokens.
|
|
var b strings.Builder
|
|
for i := 0; i < 400; i++ {
|
|
b.WriteByte(byte('a' + i%26))
|
|
}
|
|
text := b.String()
|
|
if tokenizeStr(text) <= budget {
|
|
t.Skipf("tokenizer collapsed unbroken atom to %d tokens (<= budget)", tokenizeStr(text))
|
|
}
|
|
comp, err := NewTokenChunker(map[string]any{
|
|
"delimiter_mode": "token_size",
|
|
"chunk_token_size": budget,
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("NewTokenChunker: %v", err)
|
|
}
|
|
tc := comp.(*TokenChunkerComponent)
|
|
out := tc.mergeByTokenSize(text, nil)
|
|
chunks, _ := out["chunks"].([]map[string]any)
|
|
if len(chunks) < 2 {
|
|
t.Fatalf("want multiple chunks for unbroken atom, got %d (total_tokens=%d)", len(chunks), tokenizeStr(text))
|
|
}
|
|
var joined strings.Builder
|
|
for i, ck := range chunks {
|
|
s, _ := ck["text"].(string)
|
|
joined.WriteString(s)
|
|
if n := tokenizeStr(s); n > budget {
|
|
t.Errorf("chunk %d exceeds budget: tokens=%d text=%q", i, n, s)
|
|
}
|
|
}
|
|
// mergeByTokenSize prefixes "\n" on sections; stripping newlines recovers
|
|
// the original unbroken atom.
|
|
if strings.ReplaceAll(joined.String(), "\n", "") != text {
|
|
t.Errorf("content not preserved after stripping newlines: got %q", joined.String())
|
|
}
|
|
}
|
|
|
|
func TestInvokeTextPayload_StrictCapEndToEnd(t *testing.T) {
|
|
const budget = 32
|
|
var b strings.Builder
|
|
for i := 0; i < 20; i++ {
|
|
b.WriteString(strings.TrimSpace(strings.Repeat("alpha ", 12)))
|
|
b.WriteByte('\n')
|
|
}
|
|
comp, err := NewTokenChunker(map[string]any{
|
|
"delimiter_mode": "token_size",
|
|
"chunk_token_size": budget,
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("NewTokenChunker: %v", err)
|
|
}
|
|
out, err := comp.Invoke(context.Background(), nil, map[string]any{
|
|
"name": "doc.txt",
|
|
"output_format": "text",
|
|
"text": b.String(),
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("Invoke: %v", err)
|
|
}
|
|
if errMsg, _ := out["_ERROR"].(string); errMsg != "" {
|
|
t.Fatalf("Invoke error payload: %s", errMsg)
|
|
}
|
|
chunks, _ := out["chunks"].([]map[string]any)
|
|
if len(chunks) == 0 {
|
|
t.Fatalf("expected chunks, got %#v", out)
|
|
}
|
|
for i, ck := range chunks {
|
|
text, _ := ck["text"].(string)
|
|
if n := tokenizeStr(text); n > budget {
|
|
t.Errorf("chunk %d exceeds budget: tokens=%d", i, n)
|
|
}
|
|
}
|
|
}
|