fix(docling): detect chunked response by shape, not request payload (#16921)

Fixes #16917.

## Problem

`deepdoc/parser/docling_parser.py::_parse_pdf_remote` decides whether
the
response is chunked based on which payload was sent, not on what came
back.
Docling Serve silently drops unknown fields such as `do_chunking`
(Pydantic
`extra="ignore"`) and returns a standard `{"document": ..., "status":
...}`
conversion response. The code then:

1. sets `is_chunked_response = True` from the request shape,
2. logs `Successfully used native chunking on: <endpoint>`,
3. extracts 0 chunks from `response_json.get("results", [])`,
4. logs `Native chunks received: 0`,
5. falls through to the existing `md_content` fallback.

The `md_content` fallback path is fine. The misleading log lines are the
problem: operators see "Successfully used native chunking" immediately
followed by "Native chunks received: 0" and "No chunk built", which
looks
like an internal regression rather than a server contract gap.

## Fix

Decide chunked-vs-standard from the **response shape**, not the request:

```python
response_is_chunk = self._looks_like_chunk_response(response_json)
is_chunked_response = chunk_flag and response_is_chunk
```

`_looks_like_chunk_response` returns True iff the response is a
non-empty
list or a dict with a non-empty `results` or `chunks` list. A standard
conversion response (`{"document": ..., "status": ...}`) does not match,
so
a server that ignored the chunking flag is correctly classified as
standard
even when the request payload asked for chunking.

When chunking was requested but the server returned a standard response,
log a single WARNING ("Server ignored chunking request on <endpoint>;
treating response as standard conversion.") instead of the INFO success
line. The misleading "Prioritizes native chunking endpoints" docstring
is
replaced with what the code actually does.

## Tests

`test/unit_test/deepdoc/parser/test_docling_parser_remote.py` (6 tests,
all passing):

- `test_remote_chunked_200_standard_payload_falls_back` (existing —
still
  passes; the `md_content` path is unchanged)
- `test_chunk_shape_helper_recognises_chunk_payloads`
- `test_chunk_shape_helper_rejects_standard_payloads`
- `test_remote_chunked_request_with_results_list_is_treated_as_chunked`
- `test_remote_top_level_list_response_is_treated_as_chunked`
- `test_remote_chunked_request_with_ignored_flag_does_not_log_success`

```
$ uv run pytest test/unit_test/deepdoc/parser/test_docling_parser_remote.py -v
============================== 6 passed in 0.26s ==============================
```

## Files changed

- `deepdoc/parser/docling_parser.py` (+35 / -5)
- `test/unit_test/deepdoc/parser/test_docling_parser_remote.py` (+89 /
-4)

## Backward compatibility

- All four payload/endpoint combinations continue to be tried in the
same order.
- The bundled-docling happy path (`parse_pdf`, not `_parse_pdf_remote`)
is
  untouched.
- A server that returns a real chunked response to a chunked request
still
goes down the chunked branch. A server that returns a standard response
  to a chunked request now goes down the standard branch with
  `is_chunked_response=False` instead of misleadingly logging success.

## Follow-up (out of scope)

Calling the real Docling-Serve native chunk endpoints
(`/v1/chunk/hybrid/source`, `/v1/chunk/hierarchical/source`) with
`HybridChunkerOptions` is a larger feature change and warrants its own
PR after this lands.

Co-authored-by: Harsh23Kashyap <harsh@example.com>
This commit is contained in:
Harsh Kashyap
2026-07-16 06:59:09 +05:30
committed by GitHub
parent df5c8e73fc
commit 5c96fa51f0
2 changed files with 127 additions and 6 deletions

View File

@@ -347,6 +347,26 @@ class DoclingParser(RAGFlowPdfParser):
return docs
return []
@staticmethod
def _looks_like_chunk_response(payload: Any) -> bool:
"""Return True iff ``payload`` looks like a chunking endpoint response.
A chunk response is either a non-empty top-level list or a dict that
carries a non-empty ``results`` or ``chunks`` list. A standard
conversion response (``{"document": ..., "status": ...}``) does not
match, so a server that silently ignored the ``do_chunking`` flag is
correctly classified as standard even when the request payload asked
for chunking.
"""
if isinstance(payload, list):
return bool(payload)
if isinstance(payload, dict):
for key in ("results", "chunks"):
value = payload.get(key)
if isinstance(value, list) and value:
return True
return False
def _parse_pdf_remote(
self,
filepath: str | PathLike[str],
@@ -360,9 +380,13 @@ class DoclingParser(RAGFlowPdfParser):
"""
Parses a PDF document using a remote Docling server.
Prioritizes native chunking endpoints (/v1/chunk/source, /v1alpha/chunk/source)
to prevent token overflow, with a graceful fallback to standard conversion
endpoints if chunking is unavailable.
Sends the document with chunking options first, then falls back to a
standard conversion payload if the server rejects the chunking parameters.
The chunked-vs-standard parsing decision is made from the **response
shape**, not the request shape: Docling Serve silently drops unknown
fields such as ``do_chunking`` and returns a standard conversion
response, so the response is treated as standard even when chunking
was requested.
"""
server_url = self._effective_server_url(docling_server_url)
if not server_url:
@@ -437,10 +461,16 @@ class DoclingParser(RAGFlowPdfParser):
)
if resp.status_code < 300:
response_json = resp.json()
is_chunked_response = chunk_flag
response_is_chunk = self._looks_like_chunk_response(response_json)
is_chunked_response = chunk_flag and response_is_chunk
if chunk_flag:
if chunk_flag and response_is_chunk:
self.logger.info(f"[Docling] Successfully used native chunking on: {endpoint}")
elif chunk_flag:
self.logger.warning(
f"[Docling] Server ignored chunking request on {endpoint}; "
"treating response as standard conversion."
)
else:
self.logger.info(f"[Docling] Chunking unavailable, fell back to standard: {endpoint}")
break

View File

@@ -1,6 +1,7 @@
from __future__ import annotations
import importlib.util
import logging
import sys
import types
from pathlib import Path
@@ -15,8 +16,9 @@ class _Response:
status_code = 200
text = ""
def __init__(self, payload):
def __init__(self, payload, status_code: int = 200):
self._payload = payload
self.status_code = status_code
def json(self):
return self._payload
@@ -74,3 +76,92 @@ def test_remote_chunked_200_standard_payload_falls_back(monkeypatch):
assert sections == [("# Parsed\n\nbody", "")]
assert tables == []
assert calls[0][0]["options"]["do_chunking"] is True
@pytest.mark.p2
def test_chunk_shape_helper_recognises_chunk_payloads(monkeypatch):
"""A response that is chunk-shaped (list, or dict with non-empty results/chunks)
is classified as chunked regardless of which payload was sent."""
module = _load_docling_parser(monkeypatch)
assert module.DoclingParser._looks_like_chunk_response(
[{"text": "chunk-1"}]
) is True
assert module.DoclingParser._looks_like_chunk_response(
{"results": [{"text": "chunk-1"}, {"text": "chunk-2"}]}
) is True
assert module.DoclingParser._looks_like_chunk_response(
{"chunks": [{"text": "chunk-1"}]}
) is True
@pytest.mark.p2
def test_chunk_shape_helper_rejects_standard_payloads(monkeypatch):
"""A standard conversion response, empty containers, and non-payload types
are correctly classified as not-chunked."""
module = _load_docling_parser(monkeypatch)
standard = {"document": {"md_content": "body"}, "status": "success"}
assert module.DoclingParser._looks_like_chunk_response(standard) is False
assert module.DoclingParser._looks_like_chunk_response({}) is False
assert module.DoclingParser._looks_like_chunk_response({"results": []}) is False
assert module.DoclingParser._looks_like_chunk_response({"chunks": []}) is False
assert module.DoclingParser._looks_like_chunk_response([]) is False
assert module.DoclingParser._looks_like_chunk_response("not-a-payload") is False
assert module.DoclingParser._looks_like_chunk_response(None) is False
assert module.DoclingParser._looks_like_chunk_response(42) is False
@pytest.mark.p2
def test_remote_chunked_request_with_results_list_is_treated_as_chunked(monkeypatch):
"""A server that returns a ``results`` list (Docling Serve's native chunk
shape) is treated as chunked and each chunk becomes a section."""
module = _load_docling_parser(monkeypatch)
def fake_post(_url, json, timeout):
return _Response({"results": [{"text": "alpha"}, {"text": "beta"}]})
monkeypatch.setattr(module.requests, "post", fake_post)
parser = module.DoclingParser(docling_server_url="http://docling.local")
sections, tables = parser._parse_pdf_remote("sample.pdf", binary=b"%PDF", parse_method="raw")
assert sections == [("alpha", ""), ("beta", "")]
assert tables == []
@pytest.mark.p2
def test_remote_top_level_list_response_is_treated_as_chunked(monkeypatch):
"""A server that returns a top-level JSON array of chunks is treated
as chunked (matches the existing implicit assumption in the code)."""
module = _load_docling_parser(monkeypatch)
def fake_post(_url, json, timeout):
return _Response([{"text": "first"}, {"text": "second"}])
monkeypatch.setattr(module.requests, "post", fake_post)
parser = module.DoclingParser(docling_server_url="http://docling.local")
sections, _ = parser._parse_pdf_remote("sample.pdf", binary=b"%PDF", parse_method="raw")
assert sections == [("first", ""), ("second", "")]
@pytest.mark.p2
def test_remote_chunked_request_with_ignored_flag_does_not_log_success(monkeypatch, caplog):
"""When Docling Serve silently drops the ``do_chunking`` flag and returns
a standard conversion response, RAGFlow must not log a chunking-success
message and must log a warning instead."""
module = _load_docling_parser(monkeypatch)
def fake_post(_url, json, timeout):
return _Response({"document": {"md_content": "real content"}, "status": "success"})
monkeypatch.setattr(module.requests, "post", fake_post)
parser = module.DoclingParser(docling_server_url="http://docling.local")
with caplog.at_level(logging.DEBUG, logger="DoclingParser"):
sections, _ = parser._parse_pdf_remote("sample.pdf", binary=b"%PDF", parse_method="raw")
assert sections == [("real content", "")]
flat = " ".join(record.getMessage() for record in caplog.records)
assert "Successfully used native chunking" not in flat
assert "Server ignored chunking request" in flat