mirror of
https://github.com/VectifyAI/PageIndex.git
synced 2026-07-15 21:11:05 +02:00
Verified 12 findings from an xhigh-effort review of the prior review-fix
batch; all confirmed real. Most trace back to one root cause: the
build_index() text-stripping fix (8f536cb) correctly stopped Markdown from
leaking full text by default, but broke every path that assumed text could
be re-read later.
Correctness:
- LocalBackend._fill_node_text (get_document(include_text=True)) only handled
PDF's start_index/end_index convention; Markdown nodes use line_num and got
silently empty text. Now handles both.
- get_page_content's Markdown fallback (triggered when a StorageEngine
legitimately returns None from get_pages()) read from the now-text-stripped
structure. It now re-derives from the source file, mirroring the PDF
fallback, so it no longer depends on structure text at all.
- add_document's PDF-only text-stripping branch (with the stale "markdown
needs text in structure for fallback retrieval" comment) is now dead/wrong
since build_index() already applies if_add_node_text uniformly — removed.
- _validate_llm_provider's keyless-provider allowlist was missing several
local LiteLLM providers (xinference, llamafile, triton, oobabooga,
openai_like, docker_model_runner, custom, custom_openai, petals) that need
no API key just like ollama/lm_studio; expanded.
- The three agent-tool closures (get_document, get_document_structure,
get_page_content) had three different not-found patterns; two bypassed the
backend's DocumentNotFoundError entirely. Extracted LocalBackend.
_require_document as the single existence check every method/tool now uses.
- examples/agentic_vectorless_rag_demo.py's hand-rolled Agent() didn't apply
the litellm/ prefix normalization the SDK does internally, so its own
documented "any LiteLLM provider" claim broke for non-openai models.
- cloud delete_collection's cache eviction removed the "folders unavailable"
None sentinel too, forcing a wasted re-fetch; now only pops on a real id.
Cleanup / altitude:
- build_index() skips the remove_structure_text walk entirely when text was
never added (content_based + if_add_node_summary=False + if_add_node_text=
False) instead of a guaranteed no-op tree walk.
- page_index()'s locals()-capture-as-kwargs (fragile by construction) replaced
with an explicit dict of the named parameters.
- run_pageindex.py's _cli_bool and the page_index_md.py legacy shim's
_coerce_bool were duplicate, diverging implementations; both now bind
directly to the canonical pageindex.index.page_index_md._coerce_bool.
- retrieve.py's _get_md_page_content delegated its own traversal instead of
calling the canonical get_md_page_content; now a one-line delegation.
- FileTypeError's docstring now calls out the except-ordering gotcha from
also subclassing ValueError.
17 new regression tests (tests/test_review_fixes_2.py) plus 2 updated in
tests/test_legacy_shims.py for the simplified md_to_tree shim. Full suite:
210 passed, 2 skipped.
Claude-Session: https://claude.ai/code/session_01Kx5DgKbhK1N8autqXH8SmS
52 lines
1.4 KiB
Python
52 lines
1.4 KiB
Python
class PageIndexError(Exception):
|
|
"""Base exception for all PageIndex SDK errors."""
|
|
pass
|
|
|
|
|
|
class CollectionNotFoundError(PageIndexError):
|
|
"""Collection does not exist."""
|
|
pass
|
|
|
|
|
|
class DocumentNotFoundError(PageIndexError):
|
|
"""Document ID not found."""
|
|
pass
|
|
|
|
|
|
class IndexingError(PageIndexError):
|
|
"""Indexing pipeline failure."""
|
|
pass
|
|
|
|
|
|
class PageIndexAPIError(PageIndexError):
|
|
"""PageIndex cloud API returned an error.
|
|
|
|
Kept for compatibility with the pageindex 0.2.x cloud SDK.
|
|
"""
|
|
pass
|
|
|
|
|
|
class CloudAPIError(PageIndexAPIError):
|
|
"""Cloud API returned error.
|
|
|
|
``status_code`` carries the HTTP status when the error came from an HTTP
|
|
response (None for transport-level failures), so callers can branch on it
|
|
instead of parsing the message.
|
|
"""
|
|
|
|
def __init__(self, message: str, status_code: int | None = None):
|
|
super().__init__(message)
|
|
self.status_code = status_code
|
|
|
|
|
|
class FileTypeError(PageIndexError, ValueError):
|
|
"""Unsupported file type.
|
|
|
|
Also subclasses ValueError so pre-SDK ``except ValueError`` around indexing
|
|
(0.2.x raised ValueError for an unsupported file format) still catches it.
|
|
Note: because of this, an ``except ValueError`` clause ahead of an
|
|
``except FileTypeError`` clause in the same try block will catch it first —
|
|
if you need FileTypeError-specific handling, put that except before (or
|
|
instead of) a bare ValueError one.
|
|
"""
|
|
pass
|