Skip to content

feat:compatible with Pageindex SDK#238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KylinMountain merged 5 commits into from
May 11, 2026
Merged

feat:compatible with Pageindex SDK #238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fcac29d
feat:compatible with Pageindex SDK
Apr 21, 2026
37ae545
corner cases fixed
Apr 21, 2026
882b9fb
fix: mock behavior of old SDK
Apr 29, 2026
c2735d7
fix: close streaming response and warn on empty api_key
KylinMountain May 11, 2026
ca51bd3
chore: mark legacy SDK methods with @deprecated and docstring pointers
KylinMountain May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pageindex/__init__.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
from .events import QueryEvent
from .errors import (
PageIndexError,
PageIndexAPIError,
CollectionNotFoundError,
DocumentNotFoundError,
IndexingError,
Expand All@@ -32,6 +33,7 @@
"StorageEngine",
"QueryEvent",
"PageIndexError",
"PageIndexAPIError",
"CollectionNotFoundError",
"DocumentNotFoundError",
"IndexingError",
Expand Down
146 changes: 144 additions & 2 deletions pageindex/client.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
# pageindex/client.py
from __future__ import annotations
from pathlib import Path
from typing import Any, Iterator

from typing_extensions import deprecated

from .collection import Collection
from .config import IndexConfig
from .errors import PageIndexAPIError
from .parser.protocol import DocumentParser

_LEGACY_SDK_MSG = (
"Legacy compatibility — new code should prefer the Collection-based API "
"(PageIndexClient.collection(...))."
)
_legacy_sdk = deprecated(_LEGACY_SDK_MSG, category=PendingDeprecationWarning)


def _normalize_retrieve_model(model: str) -> str:
"""Preserve supported Agents SDK prefixes and route other provider paths via LiteLLM."""
Expand DownExpand Up@@ -39,21 +50,34 @@ class PageIndexClient:
# Or use LocalClient / CloudClient for explicit mode selection
"""

def __init__(self, api_key: str = None, model: str = None,
BASE_URL = "https://api.pageindex.ai"

def __init__(self, api_key: str | None = None, model: str = None,
retrieve_model: str = None, storage_path: str = None,
storage=None, index_config: IndexConfig | dict = None):
if api_key:
if api_key == "":
import logging
logging.getLogger(__name__).warning(
"PageIndexClient received an empty api_key; falling back to local mode. "
"Pass api_key=None to silence this warning, or provide a real key for cloud mode."
)
api_key = None
if api_key is not None:
self._init_cloud(api_key)
else:
self._init_local(model, retrieve_model, storage_path, storage, index_config)

def _init_cloud(self, api_key: str):
from .backend.cloud import CloudBackend
from .cloud_api import LegacyCloudAPI
self._backend = CloudBackend(api_key=api_key)
self._legacy_cloud_api = LegacyCloudAPI(api_key=api_key, base_url=self.BASE_URL)

def _init_local(self, model: str = None, retrieve_model: str = None,
storage_path: str = None, storage=None,
index_config: IndexConfig | dict = None):
self._legacy_cloud_api = None

# Build IndexConfig: merge model/retrieve_model with index_config
overrides = {}
if model:
Expand DownExpand Up@@ -123,6 +147,124 @@ def register_parser(self, parser: DocumentParser) -> None:
raise PageIndexError("Custom parsers are not supported in cloud mode")
self._backend.register_parser(parser)

def _require_cloud_api(self):
if self._legacy_cloud_api is None:
from .errors import PageIndexAPIError
raise PageIndexAPIError(
"This method is part of the pageindex 0.2.x cloud SDK API. "
"Initialize with api_key to use it."
)
return self._legacy_cloud_api

# ── pageindex 0.2.x cloud SDK compatibility (prefer Collection API for new code) ──
@_legacy_sdk
def submit_document(
self,
file_path: str,
mode: str | None = None,
beta_headers: list[str] | None = None,
folder_id: str | None = None,
) -> dict[str, Any]:
"""Legacy SDK compatibility — prefer ``client.collection(...).add(path)``."""
return self._require_cloud_api().submit_document(
file_path=file_path,
mode=mode,
beta_headers=beta_headers,
folder_id=folder_id,
)

@_legacy_sdk
def get_ocr(self, doc_id: str, format: str = "page") -> dict[str, Any]:
"""Legacy SDK compatibility — prefer ``collection.get_page_content(doc_id, pages)``."""
return self._require_cloud_api().get_ocr(doc_id=doc_id, format=format)

@_legacy_sdk
def get_tree(self, doc_id: str, node_summary: bool = False) -> dict[str, Any]:
"""Legacy SDK compatibility — prefer ``collection.get_document_structure(doc_id)``."""
return self._require_cloud_api().get_tree(doc_id=doc_id, node_summary=node_summary)

@_legacy_sdk
def is_retrieval_ready(self, doc_id: str) -> bool:
"""Legacy SDK compatibility — Collection API handles readiness internally."""
return self._require_cloud_api().is_retrieval_ready(doc_id=doc_id)

@_legacy_sdk
def submit_query(self, doc_id: str, query: str, thinking: bool = False) -> dict[str, Any]:
"""Legacy SDK compatibility — prefer ``collection.query(question, doc_ids=[doc_id])``."""
return self._require_cloud_api().submit_query(
doc_id=doc_id,
query=query,
thinking=thinking,
)

@_legacy_sdk
def get_retrieval(self, retrieval_id: str) -> dict[str, Any]:
"""Legacy SDK compatibility — Collection API returns answers synchronously."""
return self._require_cloud_api().get_retrieval(retrieval_id=retrieval_id)

@_legacy_sdk
def chat_completions(
self,
messages: list[dict[str, str]],
stream: bool = False,
doc_id: str | list[str] | None = None,
temperature: float | None = None,
stream_metadata: bool = False,
enable_citations: bool = False,
) -> dict[str, Any] | Iterator[str] | Iterator[dict[str, Any]]:
"""Legacy SDK compatibility — prefer ``collection.query(...)``."""
return self._require_cloud_api().chat_completions(
messages=messages,
stream=stream,
doc_id=doc_id,
temperature=temperature,
stream_metadata=stream_metadata,
enable_citations=enable_citations,
)

@_legacy_sdk
def get_document(self, doc_id: str) -> dict[str, Any]:
"""Legacy SDK compatibility — prefer ``collection.get_document(doc_id)``."""
return self._require_cloud_api().get_document(doc_id=doc_id)

@_legacy_sdk
def delete_document(self, doc_id: str) -> dict[str, Any]:
"""Legacy SDK compatibility — prefer ``collection.delete_document(doc_id)``."""
return self._require_cloud_api().delete_document(doc_id=doc_id)

@_legacy_sdk
def list_documents(
self,
limit: int = 50,
offset: int = 0,
folder_id: str | None = None,
) -> dict[str, Any]:
"""Legacy SDK compatibility — prefer ``collection.list_documents()``."""
return self._require_cloud_api().list_documents(
limit=limit,
offset=offset,
folder_id=folder_id,
)

@_legacy_sdk
def create_folder(
self,
name: str,
description: str | None = None,
parent_folder_id: str | None = None,
) -> dict[str, Any]:
"""Legacy SDK compatibility — prefer ``client.collection(name)`` (auto-creates)."""
return self._require_cloud_api().create_folder(
name=name,
description=description,
parent_folder_id=parent_folder_id,
)

@_legacy_sdk
def list_folders(self, parent_folder_id: str | None = None) -> dict[str, Any]:
"""Legacy SDK compatibility — prefer ``client.list_collections()``."""
return self._require_cloud_api().list_folders(parent_folder_id=parent_folder_id)


class LocalClient(PageIndexClient):
"""Local mode — indexes and queries documents on your machine.
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat:compatible with Pageindex SDK by saccharin98 · Pull Request #238 · VectifyAI/PageIndex · GitHub
Skip to content
feat:compatible with Pageindex SDK#238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 5 commits into

from

May 11, 2026
 Merged


feat:compatible with Pageindex SDK
#238
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
fcac29d

feat:compatible with Pageindex SDK

Apr 21, 2026
37ae545

corner cases fixed

Apr 21, 2026
882b9fb

fix: mock behavior of old SDK

Apr 29, 2026
c2735d7

fix: close streaming response and warn on empty api_key


KylinMountain May 11, 2026
ca51bd3

chore: mark legacy SDK methods with @deprecated and docstring pointers


KylinMountain May 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
pageindex/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
from .events import QueryEvent
from .errors import (
 PageIndexError,
 PageIndexAPIError,
 CollectionNotFoundError,
 DocumentNotFoundError,
 IndexingError,
Expand All@@ -32,6 +33,7 @@
 "StorageEngine",
 "QueryEvent",
 "PageIndexError",
 "PageIndexAPIError",
 "CollectionNotFoundError",
 "DocumentNotFoundError",
 "IndexingError",
Expand Down

146 changes: 144 additions & 2 deletions
pageindex/client.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
# pageindex/client.py
from __future__ import annotations
from pathlib import Path
from typing import Any, Iterator

from typing_extensions import deprecated

from .collection import Collection
from .config import IndexConfig
from .errors import PageIndexAPIError
from .parser.protocol import DocumentParser

_LEGACY_SDK_MSG = (
 "Legacy compatibility — new code should prefer the Collection-based API "
 "(PageIndexClient.collection(...))."
)
_legacy_sdk = deprecated(_LEGACY_SDK_MSG, category=PendingDeprecationWarning)


def _normalize_retrieve_model(model: str) -> str:
 """Preserve supported Agents SDK prefixes and route other provider paths via LiteLLM."""
Expand DownExpand Up@@ -39,21 +50,34 @@ class PageIndexClient:
 # Or use LocalClient / CloudClient for explicit mode selection
 """

 def __init__(self, api_key: str = None, model: str = None,
 BASE_URL = "https://api.pageindex.ai"

 def __init__(self, api_key: str | None = None, model: str = None,
 retrieve_model: str = None, storage_path: str = None,
 storage=None, index_config: IndexConfig | dict = None):
 if api_key:
 if api_key == "":
 import logging
 logging.getLogger(__name__).warning(
 "PageIndexClient received an empty api_key; falling back to local mode. "
 "Pass api_key=None to silence this warning, or provide a real key for cloud mode."
 )
 api_key = None
 if api_key is not None:
 self._init_cloud(api_key)
 else:
 self._init_local(model, retrieve_model, storage_path, storage, index_config)

 def _init_cloud(self, api_key: str):
 from .backend.cloud import CloudBackend
 from .cloud_api import LegacyCloudAPI
 self._backend = CloudBackend(api_key=api_key)
 self._legacy_cloud_api = LegacyCloudAPI(api_key=api_key, base_url=self.BASE_URL)

 def _init_local(self, model: str = None, retrieve_model: str = None,
 storage_path: str = None, storage=None,
 index_config: IndexConfig | dict = None):
 self._legacy_cloud_api = None

 # Build IndexConfig: merge model/retrieve_model with index_config
 overrides = {}
 if model:
Expand DownExpand Up@@ -123,6 +147,124 @@ def register_parser(self, parser: DocumentParser) -> None:
 raise PageIndexError("Custom parsers are not supported in cloud mode")
 self._backend.register_parser(parser)

 def _require_cloud_api(self):
 if self._legacy_cloud_api is None:
 from .errors import PageIndexAPIError
 raise PageIndexAPIError(
 "This method is part of the pageindex 0.2.x cloud SDK API. "
 "Initialize with api_key to use it."
 )
 return self._legacy_cloud_api

 # ── pageindex 0.2.x cloud SDK compatibility (prefer Collection API for new code) ──
 @_legacy_sdk
 def submit_document(
 self,
 file_path: str,
 mode: str | None = None,
 beta_headers: list[str] | None = None,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(...).add(path)``."""
 return self._require_cloud_api().submit_document(
 file_path=file_path,
 mode=mode,
 beta_headers=beta_headers,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def get_ocr(self, doc_id: str, format: str = "page") -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_page_content(doc_id, pages)``."""
 return self._require_cloud_api().get_ocr(doc_id=doc_id, format=format)

 @_legacy_sdk
 def get_tree(self, doc_id: str, node_summary: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document_structure(doc_id)``."""
 return self._require_cloud_api().get_tree(doc_id=doc_id, node_summary=node_summary)

 @_legacy_sdk
 def is_retrieval_ready(self, doc_id: str) -> bool:
 """Legacy SDK compatibility — Collection API handles readiness internally."""
 return self._require_cloud_api().is_retrieval_ready(doc_id=doc_id)

 @_legacy_sdk
 def submit_query(self, doc_id: str, query: str, thinking: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.query(question, doc_ids=[doc_id])``."""
 return self._require_cloud_api().submit_query(
 doc_id=doc_id,
 query=query,
 thinking=thinking,
 )

 @_legacy_sdk
 def get_retrieval(self, retrieval_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — Collection API returns answers synchronously."""
 return self._require_cloud_api().get_retrieval(retrieval_id=retrieval_id)

 @_legacy_sdk
 def chat_completions(
 self,
 messages: list[dict[str, str]],
 stream: bool = False,
 doc_id: str | list[str] | None = None,
 temperature: float | None = None,
 stream_metadata: bool = False,
 enable_citations: bool = False,
 ) -> dict[str, Any] | Iterator[str] | Iterator[dict[str, Any]]:
 """Legacy SDK compatibility — prefer ``collection.query(...)``."""
 return self._require_cloud_api().chat_completions(
 messages=messages,
 stream=stream,
 doc_id=doc_id,
 temperature=temperature,
 stream_metadata=stream_metadata,
 enable_citations=enable_citations,
 )

 @_legacy_sdk
 def get_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document(doc_id)``."""
 return self._require_cloud_api().get_document(doc_id=doc_id)

 @_legacy_sdk
 def delete_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.delete_document(doc_id)``."""
 return self._require_cloud_api().delete_document(doc_id=doc_id)

 @_legacy_sdk
 def list_documents(
 self,
 limit: int = 50,
 offset: int = 0,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.list_documents()``."""
 return self._require_cloud_api().list_documents(
 limit=limit,
 offset=offset,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def create_folder(
 self,
 name: str,
 description: str | None = None,
 parent_folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(name)`` (auto-creates)."""
 return self._require_cloud_api().create_folder(
 name=name,
 description=description,
 parent_folder_id=parent_folder_id,
 )

 @_legacy_sdk
 def list_folders(self, parent_folder_id: str | None = None) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.list_collections()``."""
 return self._require_cloud_api().list_folders(parent_folder_id=parent_folder_id)


class LocalClient(PageIndexClient):
 """Local mode — indexes and queries documents on your machine.
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat:compatible with Pageindex SDK by saccharin98 · Pull Request #238 · VectifyAI/PageIndex · GitHub
Skip to content
feat:compatible with Pageindex SDK#238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 5 commits into

from

May 11, 2026
 Merged


feat:compatible with Pageindex SDK
#238
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
fcac29d

feat:compatible with Pageindex SDK

Apr 21, 2026
37ae545

corner cases fixed

Apr 21, 2026
882b9fb

fix: mock behavior of old SDK

Apr 29, 2026
c2735d7

fix: close streaming response and warn on empty api_key


KylinMountain May 11, 2026
ca51bd3

chore: mark legacy SDK methods with @deprecated and docstring pointers


KylinMountain May 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
pageindex/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
from .events import QueryEvent
from .errors import (
 PageIndexError,
 PageIndexAPIError,
 CollectionNotFoundError,
 DocumentNotFoundError,
 IndexingError,
Expand All@@ -32,6 +33,7 @@
 "StorageEngine",
 "QueryEvent",
 "PageIndexError",
 "PageIndexAPIError",
 "CollectionNotFoundError",
 "DocumentNotFoundError",
 "IndexingError",
Expand Down

146 changes: 144 additions & 2 deletions
pageindex/client.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
# pageindex/client.py
from __future__ import annotations
from pathlib import Path
from typing import Any, Iterator

from typing_extensions import deprecated

from .collection import Collection
from .config import IndexConfig
from .errors import PageIndexAPIError
from .parser.protocol import DocumentParser

_LEGACY_SDK_MSG = (
 "Legacy compatibility — new code should prefer the Collection-based API "
 "(PageIndexClient.collection(...))."
)
_legacy_sdk = deprecated(_LEGACY_SDK_MSG, category=PendingDeprecationWarning)


def _normalize_retrieve_model(model: str) -> str:
 """Preserve supported Agents SDK prefixes and route other provider paths via LiteLLM."""
Expand DownExpand Up@@ -39,21 +50,34 @@ class PageIndexClient:
 # Or use LocalClient / CloudClient for explicit mode selection
 """

 def __init__(self, api_key: str = None, model: str = None,
 BASE_URL = "https://api.pageindex.ai"

 def __init__(self, api_key: str | None = None, model: str = None,
 retrieve_model: str = None, storage_path: str = None,
 storage=None, index_config: IndexConfig | dict = None):
 if api_key:
 if api_key == "":
 import logging
 logging.getLogger(__name__).warning(
 "PageIndexClient received an empty api_key; falling back to local mode. "
 "Pass api_key=None to silence this warning, or provide a real key for cloud mode."
 )
 api_key = None
 if api_key is not None:
 self._init_cloud(api_key)
 else:
 self._init_local(model, retrieve_model, storage_path, storage, index_config)

 def _init_cloud(self, api_key: str):
 from .backend.cloud import CloudBackend
 from .cloud_api import LegacyCloudAPI
 self._backend = CloudBackend(api_key=api_key)
 self._legacy_cloud_api = LegacyCloudAPI(api_key=api_key, base_url=self.BASE_URL)

 def _init_local(self, model: str = None, retrieve_model: str = None,
 storage_path: str = None, storage=None,
 index_config: IndexConfig | dict = None):
 self._legacy_cloud_api = None

 # Build IndexConfig: merge model/retrieve_model with index_config
 overrides = {}
 if model:
Expand DownExpand Up@@ -123,6 +147,124 @@ def register_parser(self, parser: DocumentParser) -> None:
 raise PageIndexError("Custom parsers are not supported in cloud mode")
 self._backend.register_parser(parser)

 def _require_cloud_api(self):
 if self._legacy_cloud_api is None:
 from .errors import PageIndexAPIError
 raise PageIndexAPIError(
 "This method is part of the pageindex 0.2.x cloud SDK API. "
 "Initialize with api_key to use it."
 )
 return self._legacy_cloud_api

 # ── pageindex 0.2.x cloud SDK compatibility (prefer Collection API for new code) ──
 @_legacy_sdk
 def submit_document(
 self,
 file_path: str,
 mode: str | None = None,
 beta_headers: list[str] | None = None,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(...).add(path)``."""
 return self._require_cloud_api().submit_document(
 file_path=file_path,
 mode=mode,
 beta_headers=beta_headers,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def get_ocr(self, doc_id: str, format: str = "page") -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_page_content(doc_id, pages)``."""
 return self._require_cloud_api().get_ocr(doc_id=doc_id, format=format)

 @_legacy_sdk
 def get_tree(self, doc_id: str, node_summary: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document_structure(doc_id)``."""
 return self._require_cloud_api().get_tree(doc_id=doc_id, node_summary=node_summary)

 @_legacy_sdk
 def is_retrieval_ready(self, doc_id: str) -> bool:
 """Legacy SDK compatibility — Collection API handles readiness internally."""
 return self._require_cloud_api().is_retrieval_ready(doc_id=doc_id)

 @_legacy_sdk
 def submit_query(self, doc_id: str, query: str, thinking: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.query(question, doc_ids=[doc_id])``."""
 return self._require_cloud_api().submit_query(
 doc_id=doc_id,
 query=query,
 thinking=thinking,
 )

 @_legacy_sdk
 def get_retrieval(self, retrieval_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — Collection API returns answers synchronously."""
 return self._require_cloud_api().get_retrieval(retrieval_id=retrieval_id)

 @_legacy_sdk
 def chat_completions(
 self,
 messages: list[dict[str, str]],
 stream: bool = False,
 doc_id: str | list[str] | None = None,
 temperature: float | None = None,
 stream_metadata: bool = False,
 enable_citations: bool = False,
 ) -> dict[str, Any] | Iterator[str] | Iterator[dict[str, Any]]:
 """Legacy SDK compatibility — prefer ``collection.query(...)``."""
 return self._require_cloud_api().chat_completions(
 messages=messages,
 stream=stream,
 doc_id=doc_id,
 temperature=temperature,
 stream_metadata=stream_metadata,
 enable_citations=enable_citations,
 )

 @_legacy_sdk
 def get_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document(doc_id)``."""
 return self._require_cloud_api().get_document(doc_id=doc_id)

 @_legacy_sdk
 def delete_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.delete_document(doc_id)``."""
 return self._require_cloud_api().delete_document(doc_id=doc_id)

 @_legacy_sdk
 def list_documents(
 self,
 limit: int = 50,
 offset: int = 0,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.list_documents()``."""
 return self._require_cloud_api().list_documents(
 limit=limit,
 offset=offset,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def create_folder(
 self,
 name: str,
 description: str | None = None,
 parent_folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(name)`` (auto-creates)."""
 return self._require_cloud_api().create_folder(
 name=name,
 description=description,
 parent_folder_id=parent_folder_id,
 )

 @_legacy_sdk
 def list_folders(self, parent_folder_id: str | None = None) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.list_collections()``."""
 return self._require_cloud_api().list_folders(parent_folder_id=parent_folder_id)


class LocalClient(PageIndexClient):
 """Local mode — indexes and queries documents on your machine.
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat:compatible with Pageindex SDK by saccharin98 · Pull Request #238 · VectifyAI/PageIndex · GitHub
Skip to content
feat:compatible with Pageindex SDK#238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 5 commits into

from

May 11, 2026
 Merged


feat:compatible with Pageindex SDK
#238
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
fcac29d

feat:compatible with Pageindex SDK

Apr 21, 2026
37ae545

corner cases fixed

Apr 21, 2026
882b9fb

fix: mock behavior of old SDK

Apr 29, 2026
c2735d7

fix: close streaming response and warn on empty api_key


KylinMountain May 11, 2026
ca51bd3

chore: mark legacy SDK methods with @deprecated and docstring pointers


KylinMountain May 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
pageindex/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
from .events import QueryEvent
from .errors import (
 PageIndexError,
 PageIndexAPIError,
 CollectionNotFoundError,
 DocumentNotFoundError,
 IndexingError,
Expand All@@ -32,6 +33,7 @@
 "StorageEngine",
 "QueryEvent",
 "PageIndexError",
 "PageIndexAPIError",
 "CollectionNotFoundError",
 "DocumentNotFoundError",
 "IndexingError",
Expand Down

146 changes: 144 additions & 2 deletions
pageindex/client.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
# pageindex/client.py
from __future__ import annotations
from pathlib import Path
from typing import Any, Iterator

from typing_extensions import deprecated

from .collection import Collection
from .config import IndexConfig
from .errors import PageIndexAPIError
from .parser.protocol import DocumentParser

_LEGACY_SDK_MSG = (
 "Legacy compatibility — new code should prefer the Collection-based API "
 "(PageIndexClient.collection(...))."
)
_legacy_sdk = deprecated(_LEGACY_SDK_MSG, category=PendingDeprecationWarning)


def _normalize_retrieve_model(model: str) -> str:
 """Preserve supported Agents SDK prefixes and route other provider paths via LiteLLM."""
Expand DownExpand Up@@ -39,21 +50,34 @@ class PageIndexClient:
 # Or use LocalClient / CloudClient for explicit mode selection
 """

 def __init__(self, api_key: str = None, model: str = None,
 BASE_URL = "https://api.pageindex.ai"

 def __init__(self, api_key: str | None = None, model: str = None,
 retrieve_model: str = None, storage_path: str = None,
 storage=None, index_config: IndexConfig | dict = None):
 if api_key:
 if api_key == "":
 import logging
 logging.getLogger(__name__).warning(
 "PageIndexClient received an empty api_key; falling back to local mode. "
 "Pass api_key=None to silence this warning, or provide a real key for cloud mode."
 )
 api_key = None
 if api_key is not None:
 self._init_cloud(api_key)
 else:
 self._init_local(model, retrieve_model, storage_path, storage, index_config)

 def _init_cloud(self, api_key: str):
 from .backend.cloud import CloudBackend
 from .cloud_api import LegacyCloudAPI
 self._backend = CloudBackend(api_key=api_key)
 self._legacy_cloud_api = LegacyCloudAPI(api_key=api_key, base_url=self.BASE_URL)

 def _init_local(self, model: str = None, retrieve_model: str = None,
 storage_path: str = None, storage=None,
 index_config: IndexConfig | dict = None):
 self._legacy_cloud_api = None

 # Build IndexConfig: merge model/retrieve_model with index_config
 overrides = {}
 if model:
Expand DownExpand Up@@ -123,6 +147,124 @@ def register_parser(self, parser: DocumentParser) -> None:
 raise PageIndexError("Custom parsers are not supported in cloud mode")
 self._backend.register_parser(parser)

 def _require_cloud_api(self):
 if self._legacy_cloud_api is None:
 from .errors import PageIndexAPIError
 raise PageIndexAPIError(
 "This method is part of the pageindex 0.2.x cloud SDK API. "
 "Initialize with api_key to use it."
 )
 return self._legacy_cloud_api

 # ── pageindex 0.2.x cloud SDK compatibility (prefer Collection API for new code) ──
 @_legacy_sdk
 def submit_document(
 self,
 file_path: str,
 mode: str | None = None,
 beta_headers: list[str] | None = None,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(...).add(path)``."""
 return self._require_cloud_api().submit_document(
 file_path=file_path,
 mode=mode,
 beta_headers=beta_headers,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def get_ocr(self, doc_id: str, format: str = "page") -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_page_content(doc_id, pages)``."""
 return self._require_cloud_api().get_ocr(doc_id=doc_id, format=format)

 @_legacy_sdk
 def get_tree(self, doc_id: str, node_summary: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document_structure(doc_id)``."""
 return self._require_cloud_api().get_tree(doc_id=doc_id, node_summary=node_summary)

 @_legacy_sdk
 def is_retrieval_ready(self, doc_id: str) -> bool:
 """Legacy SDK compatibility — Collection API handles readiness internally."""
 return self._require_cloud_api().is_retrieval_ready(doc_id=doc_id)

 @_legacy_sdk
 def submit_query(self, doc_id: str, query: str, thinking: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.query(question, doc_ids=[doc_id])``."""
 return self._require_cloud_api().submit_query(
 doc_id=doc_id,
 query=query,
 thinking=thinking,
 )

 @_legacy_sdk
 def get_retrieval(self, retrieval_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — Collection API returns answers synchronously."""
 return self._require_cloud_api().get_retrieval(retrieval_id=retrieval_id)

 @_legacy_sdk
 def chat_completions(
 self,
 messages: list[dict[str, str]],
 stream: bool = False,
 doc_id: str | list[str] | None = None,
 temperature: float | None = None,
 stream_metadata: bool = False,
 enable_citations: bool = False,
 ) -> dict[str, Any] | Iterator[str] | Iterator[dict[str, Any]]:
 """Legacy SDK compatibility — prefer ``collection.query(...)``."""
 return self._require_cloud_api().chat_completions(
 messages=messages,
 stream=stream,
 doc_id=doc_id,
 temperature=temperature,
 stream_metadata=stream_metadata,
 enable_citations=enable_citations,
 )

 @_legacy_sdk
 def get_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document(doc_id)``."""
 return self._require_cloud_api().get_document(doc_id=doc_id)

 @_legacy_sdk
 def delete_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.delete_document(doc_id)``."""
 return self._require_cloud_api().delete_document(doc_id=doc_id)

 @_legacy_sdk
 def list_documents(
 self,
 limit: int = 50,
 offset: int = 0,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.list_documents()``."""
 return self._require_cloud_api().list_documents(
 limit=limit,
 offset=offset,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def create_folder(
 self,
 name: str,
 description: str | None = None,
 parent_folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(name)`` (auto-creates)."""
 return self._require_cloud_api().create_folder(
 name=name,
 description=description,
 parent_folder_id=parent_folder_id,
 )

 @_legacy_sdk
 def list_folders(self, parent_folder_id: str | None = None) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.list_collections()``."""
 return self._require_cloud_api().list_folders(parent_folder_id=parent_folder_id)


class LocalClient(PageIndexClient):
 """Local mode — indexes and queries documents on your machine.
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat:compatible with Pageindex SDK by saccharin98 · Pull Request #238 · VectifyAI/PageIndex · GitHub
Skip to content
feat:compatible with Pageindex SDK#238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 5 commits into

from

May 11, 2026
 Merged


feat:compatible with Pageindex SDK
#238
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
fcac29d

feat:compatible with Pageindex SDK

Apr 21, 2026
37ae545

corner cases fixed

Apr 21, 2026
882b9fb

fix: mock behavior of old SDK

Apr 29, 2026
c2735d7

fix: close streaming response and warn on empty api_key


KylinMountain May 11, 2026
ca51bd3

chore: mark legacy SDK methods with @deprecated and docstring pointers


KylinMountain May 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
pageindex/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
from .events import QueryEvent
from .errors import (
 PageIndexError,
 PageIndexAPIError,
 CollectionNotFoundError,
 DocumentNotFoundError,
 IndexingError,
Expand All@@ -32,6 +33,7 @@
 "StorageEngine",
 "QueryEvent",
 "PageIndexError",
 "PageIndexAPIError",
 "CollectionNotFoundError",
 "DocumentNotFoundError",
 "IndexingError",
Expand Down

146 changes: 144 additions & 2 deletions
pageindex/client.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
# pageindex/client.py
from __future__ import annotations
from pathlib import Path
from typing import Any, Iterator

from typing_extensions import deprecated

from .collection import Collection
from .config import IndexConfig
from .errors import PageIndexAPIError
from .parser.protocol import DocumentParser

_LEGACY_SDK_MSG = (
 "Legacy compatibility — new code should prefer the Collection-based API "
 "(PageIndexClient.collection(...))."
)
_legacy_sdk = deprecated(_LEGACY_SDK_MSG, category=PendingDeprecationWarning)


def _normalize_retrieve_model(model: str) -> str:
 """Preserve supported Agents SDK prefixes and route other provider paths via LiteLLM."""
Expand DownExpand Up@@ -39,21 +50,34 @@ class PageIndexClient:
 # Or use LocalClient / CloudClient for explicit mode selection
 """

 def __init__(self, api_key: str = None, model: str = None,
 BASE_URL = "https://api.pageindex.ai"

 def __init__(self, api_key: str | None = None, model: str = None,
 retrieve_model: str = None, storage_path: str = None,
 storage=None, index_config: IndexConfig | dict = None):
 if api_key:
 if api_key == "":
 import logging
 logging.getLogger(__name__).warning(
 "PageIndexClient received an empty api_key; falling back to local mode. "
 "Pass api_key=None to silence this warning, or provide a real key for cloud mode."
 )
 api_key = None
 if api_key is not None:
 self._init_cloud(api_key)
 else:
 self._init_local(model, retrieve_model, storage_path, storage, index_config)

 def _init_cloud(self, api_key: str):
 from .backend.cloud import CloudBackend
 from .cloud_api import LegacyCloudAPI
 self._backend = CloudBackend(api_key=api_key)
 self._legacy_cloud_api = LegacyCloudAPI(api_key=api_key, base_url=self.BASE_URL)

 def _init_local(self, model: str = None, retrieve_model: str = None,
 storage_path: str = None, storage=None,
 index_config: IndexConfig | dict = None):
 self._legacy_cloud_api = None

 # Build IndexConfig: merge model/retrieve_model with index_config
 overrides = {}
 if model:
Expand DownExpand Up@@ -123,6 +147,124 @@ def register_parser(self, parser: DocumentParser) -> None:
 raise PageIndexError("Custom parsers are not supported in cloud mode")
 self._backend.register_parser(parser)

 def _require_cloud_api(self):
 if self._legacy_cloud_api is None:
 from .errors import PageIndexAPIError
 raise PageIndexAPIError(
 "This method is part of the pageindex 0.2.x cloud SDK API. "
 "Initialize with api_key to use it."
 )
 return self._legacy_cloud_api

 # ── pageindex 0.2.x cloud SDK compatibility (prefer Collection API for new code) ──
 @_legacy_sdk
 def submit_document(
 self,
 file_path: str,
 mode: str | None = None,
 beta_headers: list[str] | None = None,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(...).add(path)``."""
 return self._require_cloud_api().submit_document(
 file_path=file_path,
 mode=mode,
 beta_headers=beta_headers,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def get_ocr(self, doc_id: str, format: str = "page") -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_page_content(doc_id, pages)``."""
 return self._require_cloud_api().get_ocr(doc_id=doc_id, format=format)

 @_legacy_sdk
 def get_tree(self, doc_id: str, node_summary: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document_structure(doc_id)``."""
 return self._require_cloud_api().get_tree(doc_id=doc_id, node_summary=node_summary)

 @_legacy_sdk
 def is_retrieval_ready(self, doc_id: str) -> bool:
 """Legacy SDK compatibility — Collection API handles readiness internally."""
 return self._require_cloud_api().is_retrieval_ready(doc_id=doc_id)

 @_legacy_sdk
 def submit_query(self, doc_id: str, query: str, thinking: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.query(question, doc_ids=[doc_id])``."""
 return self._require_cloud_api().submit_query(
 doc_id=doc_id,
 query=query,
 thinking=thinking,
 )

 @_legacy_sdk
 def get_retrieval(self, retrieval_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — Collection API returns answers synchronously."""
 return self._require_cloud_api().get_retrieval(retrieval_id=retrieval_id)

 @_legacy_sdk
 def chat_completions(
 self,
 messages: list[dict[str, str]],
 stream: bool = False,
 doc_id: str | list[str] | None = None,
 temperature: float | None = None,
 stream_metadata: bool = False,
 enable_citations: bool = False,
 ) -> dict[str, Any] | Iterator[str] | Iterator[dict[str, Any]]:
 """Legacy SDK compatibility — prefer ``collection.query(...)``."""
 return self._require_cloud_api().chat_completions(
 messages=messages,
 stream=stream,
 doc_id=doc_id,
 temperature=temperature,
 stream_metadata=stream_metadata,
 enable_citations=enable_citations,
 )

 @_legacy_sdk
 def get_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document(doc_id)``."""
 return self._require_cloud_api().get_document(doc_id=doc_id)

 @_legacy_sdk
 def delete_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.delete_document(doc_id)``."""
 return self._require_cloud_api().delete_document(doc_id=doc_id)

 @_legacy_sdk
 def list_documents(
 self,
 limit: int = 50,
 offset: int = 0,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.list_documents()``."""
 return self._require_cloud_api().list_documents(
 limit=limit,
 offset=offset,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def create_folder(
 self,
 name: str,
 description: str | None = None,
 parent_folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(name)`` (auto-creates)."""
 return self._require_cloud_api().create_folder(
 name=name,
 description=description,
 parent_folder_id=parent_folder_id,
 )

 @_legacy_sdk
 def list_folders(self, parent_folder_id: str | None = None) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.list_collections()``."""
 return self._require_cloud_api().list_folders(parent_folder_id=parent_folder_id)


class LocalClient(PageIndexClient):
 """Local mode — indexes and queries documents on your machine.
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat:compatible with Pageindex SDK by saccharin98 · Pull Request #238 · VectifyAI/PageIndex · GitHub
Skip to content
feat:compatible with Pageindex SDK#238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 5 commits into

from

May 11, 2026
 Merged


feat:compatible with Pageindex SDK
#238
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
fcac29d

feat:compatible with Pageindex SDK

Apr 21, 2026
37ae545

corner cases fixed

Apr 21, 2026
882b9fb

fix: mock behavior of old SDK

Apr 29, 2026
c2735d7

fix: close streaming response and warn on empty api_key


KylinMountain May 11, 2026
ca51bd3

chore: mark legacy SDK methods with @deprecated and docstring pointers


KylinMountain May 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
pageindex/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
from .events import QueryEvent
from .errors import (
 PageIndexError,
 PageIndexAPIError,
 CollectionNotFoundError,
 DocumentNotFoundError,
 IndexingError,
Expand All@@ -32,6 +33,7 @@
 "StorageEngine",
 "QueryEvent",
 "PageIndexError",
 "PageIndexAPIError",
 "CollectionNotFoundError",
 "DocumentNotFoundError",
 "IndexingError",
Expand Down

146 changes: 144 additions & 2 deletions
pageindex/client.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
# pageindex/client.py
from __future__ import annotations
from pathlib import Path
from typing import Any, Iterator

from typing_extensions import deprecated

from .collection import Collection
from .config import IndexConfig
from .errors import PageIndexAPIError
from .parser.protocol import DocumentParser

_LEGACY_SDK_MSG = (
 "Legacy compatibility — new code should prefer the Collection-based API "
 "(PageIndexClient.collection(...))."
)
_legacy_sdk = deprecated(_LEGACY_SDK_MSG, category=PendingDeprecationWarning)


def _normalize_retrieve_model(model: str) -> str:
 """Preserve supported Agents SDK prefixes and route other provider paths via LiteLLM."""
Expand DownExpand Up@@ -39,21 +50,34 @@ class PageIndexClient:
 # Or use LocalClient / CloudClient for explicit mode selection
 """

 def __init__(self, api_key: str = None, model: str = None,
 BASE_URL = "https://api.pageindex.ai"

 def __init__(self, api_key: str | None = None, model: str = None,
 retrieve_model: str = None, storage_path: str = None,
 storage=None, index_config: IndexConfig | dict = None):
 if api_key:
 if api_key == "":
 import logging
 logging.getLogger(__name__).warning(
 "PageIndexClient received an empty api_key; falling back to local mode. "
 "Pass api_key=None to silence this warning, or provide a real key for cloud mode."
 )
 api_key = None
 if api_key is not None:
 self._init_cloud(api_key)
 else:
 self._init_local(model, retrieve_model, storage_path, storage, index_config)

 def _init_cloud(self, api_key: str):
 from .backend.cloud import CloudBackend
 from .cloud_api import LegacyCloudAPI
 self._backend = CloudBackend(api_key=api_key)
 self._legacy_cloud_api = LegacyCloudAPI(api_key=api_key, base_url=self.BASE_URL)

 def _init_local(self, model: str = None, retrieve_model: str = None,
 storage_path: str = None, storage=None,
 index_config: IndexConfig | dict = None):
 self._legacy_cloud_api = None

 # Build IndexConfig: merge model/retrieve_model with index_config
 overrides = {}
 if model:
Expand DownExpand Up@@ -123,6 +147,124 @@ def register_parser(self, parser: DocumentParser) -> None:
 raise PageIndexError("Custom parsers are not supported in cloud mode")
 self._backend.register_parser(parser)

 def _require_cloud_api(self):
 if self._legacy_cloud_api is None:
 from .errors import PageIndexAPIError
 raise PageIndexAPIError(
 "This method is part of the pageindex 0.2.x cloud SDK API. "
 "Initialize with api_key to use it."
 )
 return self._legacy_cloud_api

 # ── pageindex 0.2.x cloud SDK compatibility (prefer Collection API for new code) ──
 @_legacy_sdk
 def submit_document(
 self,
 file_path: str,
 mode: str | None = None,
 beta_headers: list[str] | None = None,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(...).add(path)``."""
 return self._require_cloud_api().submit_document(
 file_path=file_path,
 mode=mode,
 beta_headers=beta_headers,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def get_ocr(self, doc_id: str, format: str = "page") -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_page_content(doc_id, pages)``."""
 return self._require_cloud_api().get_ocr(doc_id=doc_id, format=format)

 @_legacy_sdk
 def get_tree(self, doc_id: str, node_summary: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document_structure(doc_id)``."""
 return self._require_cloud_api().get_tree(doc_id=doc_id, node_summary=node_summary)

 @_legacy_sdk
 def is_retrieval_ready(self, doc_id: str) -> bool:
 """Legacy SDK compatibility — Collection API handles readiness internally."""
 return self._require_cloud_api().is_retrieval_ready(doc_id=doc_id)

 @_legacy_sdk
 def submit_query(self, doc_id: str, query: str, thinking: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.query(question, doc_ids=[doc_id])``."""
 return self._require_cloud_api().submit_query(
 doc_id=doc_id,
 query=query,
 thinking=thinking,
 )

 @_legacy_sdk
 def get_retrieval(self, retrieval_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — Collection API returns answers synchronously."""
 return self._require_cloud_api().get_retrieval(retrieval_id=retrieval_id)

 @_legacy_sdk
 def chat_completions(
 self,
 messages: list[dict[str, str]],
 stream: bool = False,
 doc_id: str | list[str] | None = None,
 temperature: float | None = None,
 stream_metadata: bool = False,
 enable_citations: bool = False,
 ) -> dict[str, Any] | Iterator[str] | Iterator[dict[str, Any]]:
 """Legacy SDK compatibility — prefer ``collection.query(...)``."""
 return self._require_cloud_api().chat_completions(
 messages=messages,
 stream=stream,
 doc_id=doc_id,
 temperature=temperature,
 stream_metadata=stream_metadata,
 enable_citations=enable_citations,
 )

 @_legacy_sdk
 def get_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document(doc_id)``."""
 return self._require_cloud_api().get_document(doc_id=doc_id)

 @_legacy_sdk
 def delete_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.delete_document(doc_id)``."""
 return self._require_cloud_api().delete_document(doc_id=doc_id)

 @_legacy_sdk
 def list_documents(
 self,
 limit: int = 50,
 offset: int = 0,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.list_documents()``."""
 return self._require_cloud_api().list_documents(
 limit=limit,
 offset=offset,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def create_folder(
 self,
 name: str,
 description: str | None = None,
 parent_folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(name)`` (auto-creates)."""
 return self._require_cloud_api().create_folder(
 name=name,
 description=description,
 parent_folder_id=parent_folder_id,
 )

 @_legacy_sdk
 def list_folders(self, parent_folder_id: str | None = None) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.list_collections()``."""
 return self._require_cloud_api().list_folders(parent_folder_id=parent_folder_id)


class LocalClient(PageIndexClient):
 """Local mode — indexes and queries documents on your machine.
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat:compatible with Pageindex SDK by saccharin98 · Pull Request #238 · VectifyAI/PageIndex · GitHub
Skip to content
feat:compatible with Pageindex SDK#238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 5 commits into

from

May 11, 2026
 Merged


feat:compatible with Pageindex SDK
#238
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
fcac29d

feat:compatible with Pageindex SDK

Apr 21, 2026
37ae545

corner cases fixed

Apr 21, 2026
882b9fb

fix: mock behavior of old SDK

Apr 29, 2026
c2735d7

fix: close streaming response and warn on empty api_key


KylinMountain May 11, 2026
ca51bd3

chore: mark legacy SDK methods with @deprecated and docstring pointers


KylinMountain May 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
pageindex/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
from .events import QueryEvent
from .errors import (
 PageIndexError,
 PageIndexAPIError,
 CollectionNotFoundError,
 DocumentNotFoundError,
 IndexingError,
Expand All@@ -32,6 +33,7 @@
 "StorageEngine",
 "QueryEvent",
 "PageIndexError",
 "PageIndexAPIError",
 "CollectionNotFoundError",
 "DocumentNotFoundError",
 "IndexingError",
Expand Down

146 changes: 144 additions & 2 deletions
pageindex/client.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
# pageindex/client.py
from __future__ import annotations
from pathlib import Path
from typing import Any, Iterator

from typing_extensions import deprecated

from .collection import Collection
from .config import IndexConfig
from .errors import PageIndexAPIError
from .parser.protocol import DocumentParser

_LEGACY_SDK_MSG = (
 "Legacy compatibility — new code should prefer the Collection-based API "
 "(PageIndexClient.collection(...))."
)
_legacy_sdk = deprecated(_LEGACY_SDK_MSG, category=PendingDeprecationWarning)


def _normalize_retrieve_model(model: str) -> str:
 """Preserve supported Agents SDK prefixes and route other provider paths via LiteLLM."""
Expand DownExpand Up@@ -39,21 +50,34 @@ class PageIndexClient:
 # Or use LocalClient / CloudClient for explicit mode selection
 """

 def __init__(self, api_key: str = None, model: str = None,
 BASE_URL = "https://api.pageindex.ai"

 def __init__(self, api_key: str | None = None, model: str = None,
 retrieve_model: str = None, storage_path: str = None,
 storage=None, index_config: IndexConfig | dict = None):
 if api_key:
 if api_key == "":
 import logging
 logging.getLogger(__name__).warning(
 "PageIndexClient received an empty api_key; falling back to local mode. "
 "Pass api_key=None to silence this warning, or provide a real key for cloud mode."
 )
 api_key = None
 if api_key is not None:
 self._init_cloud(api_key)
 else:
 self._init_local(model, retrieve_model, storage_path, storage, index_config)

 def _init_cloud(self, api_key: str):
 from .backend.cloud import CloudBackend
 from .cloud_api import LegacyCloudAPI
 self._backend = CloudBackend(api_key=api_key)
 self._legacy_cloud_api = LegacyCloudAPI(api_key=api_key, base_url=self.BASE_URL)

 def _init_local(self, model: str = None, retrieve_model: str = None,
 storage_path: str = None, storage=None,
 index_config: IndexConfig | dict = None):
 self._legacy_cloud_api = None

 # Build IndexConfig: merge model/retrieve_model with index_config
 overrides = {}
 if model:
Expand DownExpand Up@@ -123,6 +147,124 @@ def register_parser(self, parser: DocumentParser) -> None:
 raise PageIndexError("Custom parsers are not supported in cloud mode")
 self._backend.register_parser(parser)

 def _require_cloud_api(self):
 if self._legacy_cloud_api is None:
 from .errors import PageIndexAPIError
 raise PageIndexAPIError(
 "This method is part of the pageindex 0.2.x cloud SDK API. "
 "Initialize with api_key to use it."
 )
 return self._legacy_cloud_api

 # ── pageindex 0.2.x cloud SDK compatibility (prefer Collection API for new code) ──
 @_legacy_sdk
 def submit_document(
 self,
 file_path: str,
 mode: str | None = None,
 beta_headers: list[str] | None = None,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(...).add(path)``."""
 return self._require_cloud_api().submit_document(
 file_path=file_path,
 mode=mode,
 beta_headers=beta_headers,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def get_ocr(self, doc_id: str, format: str = "page") -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_page_content(doc_id, pages)``."""
 return self._require_cloud_api().get_ocr(doc_id=doc_id, format=format)

 @_legacy_sdk
 def get_tree(self, doc_id: str, node_summary: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document_structure(doc_id)``."""
 return self._require_cloud_api().get_tree(doc_id=doc_id, node_summary=node_summary)

 @_legacy_sdk
 def is_retrieval_ready(self, doc_id: str) -> bool:
 """Legacy SDK compatibility — Collection API handles readiness internally."""
 return self._require_cloud_api().is_retrieval_ready(doc_id=doc_id)

 @_legacy_sdk
 def submit_query(self, doc_id: str, query: str, thinking: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.query(question, doc_ids=[doc_id])``."""
 return self._require_cloud_api().submit_query(
 doc_id=doc_id,
 query=query,
 thinking=thinking,
 )

 @_legacy_sdk
 def get_retrieval(self, retrieval_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — Collection API returns answers synchronously."""
 return self._require_cloud_api().get_retrieval(retrieval_id=retrieval_id)

 @_legacy_sdk
 def chat_completions(
 self,
 messages: list[dict[str, str]],
 stream: bool = False,
 doc_id: str | list[str] | None = None,
 temperature: float | None = None,
 stream_metadata: bool = False,
 enable_citations: bool = False,
 ) -> dict[str, Any] | Iterator[str] | Iterator[dict[str, Any]]:
 """Legacy SDK compatibility — prefer ``collection.query(...)``."""
 return self._require_cloud_api().chat_completions(
 messages=messages,
 stream=stream,
 doc_id=doc_id,
 temperature=temperature,
 stream_metadata=stream_metadata,
 enable_citations=enable_citations,
 )

 @_legacy_sdk
 def get_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document(doc_id)``."""
 return self._require_cloud_api().get_document(doc_id=doc_id)

 @_legacy_sdk
 def delete_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.delete_document(doc_id)``."""
 return self._require_cloud_api().delete_document(doc_id=doc_id)

 @_legacy_sdk
 def list_documents(
 self,
 limit: int = 50,
 offset: int = 0,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.list_documents()``."""
 return self._require_cloud_api().list_documents(
 limit=limit,
 offset=offset,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def create_folder(
 self,
 name: str,
 description: str | None = None,
 parent_folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(name)`` (auto-creates)."""
 return self._require_cloud_api().create_folder(
 name=name,
 description=description,
 parent_folder_id=parent_folder_id,
 )

 @_legacy_sdk
 def list_folders(self, parent_folder_id: str | None = None) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.list_collections()``."""
 return self._require_cloud_api().list_folders(parent_folder_id=parent_folder_id)


class LocalClient(PageIndexClient):
 """Local mode — indexes and queries documents on your machine.
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat:compatible with Pageindex SDK by saccharin98 · Pull Request #238 · VectifyAI/PageIndex · GitHub
Skip to content
feat:compatible with Pageindex SDK#238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 5 commits into

from

May 11, 2026
 Merged


feat:compatible with Pageindex SDK
#238
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
fcac29d

feat:compatible with Pageindex SDK

Apr 21, 2026
37ae545

corner cases fixed

Apr 21, 2026
882b9fb

fix: mock behavior of old SDK

Apr 29, 2026
c2735d7

fix: close streaming response and warn on empty api_key


KylinMountain May 11, 2026
ca51bd3

chore: mark legacy SDK methods with @deprecated and docstring pointers


KylinMountain May 11, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
pageindex/__init__.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
from .events import QueryEvent
from .errors import (
 PageIndexError,
 PageIndexAPIError,
 CollectionNotFoundError,
 DocumentNotFoundError,
 IndexingError,
Expand All@@ -32,6 +33,7 @@
 "StorageEngine",
 "QueryEvent",
 "PageIndexError",
 "PageIndexAPIError",
 "CollectionNotFoundError",
 "DocumentNotFoundError",
 "IndexingError",
Expand Down

146 changes: 144 additions & 2 deletions
pageindex/client.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
# pageindex/client.py
from __future__ import annotations
from pathlib import Path
from typing import Any, Iterator

from typing_extensions import deprecated

from .collection import Collection
from .config import IndexConfig
from .errors import PageIndexAPIError
from .parser.protocol import DocumentParser

_LEGACY_SDK_MSG = (
 "Legacy compatibility — new code should prefer the Collection-based API "
 "(PageIndexClient.collection(...))."
)
_legacy_sdk = deprecated(_LEGACY_SDK_MSG, category=PendingDeprecationWarning)


def _normalize_retrieve_model(model: str) -> str:
 """Preserve supported Agents SDK prefixes and route other provider paths via LiteLLM."""
Expand DownExpand Up@@ -39,21 +50,34 @@ class PageIndexClient:
 # Or use LocalClient / CloudClient for explicit mode selection
 """

 def __init__(self, api_key: str = None, model: str = None,
 BASE_URL = "https://api.pageindex.ai"

 def __init__(self, api_key: str | None = None, model: str = None,
 retrieve_model: str = None, storage_path: str = None,
 storage=None, index_config: IndexConfig | dict = None):
 if api_key:
 if api_key == "":
 import logging
 logging.getLogger(__name__).warning(
 "PageIndexClient received an empty api_key; falling back to local mode. "
 "Pass api_key=None to silence this warning, or provide a real key for cloud mode."
 )
 api_key = None
 if api_key is not None:
 self._init_cloud(api_key)
 else:
 self._init_local(model, retrieve_model, storage_path, storage, index_config)

 def _init_cloud(self, api_key: str):
 from .backend.cloud import CloudBackend
 from .cloud_api import LegacyCloudAPI
 self._backend = CloudBackend(api_key=api_key)
 self._legacy_cloud_api = LegacyCloudAPI(api_key=api_key, base_url=self.BASE_URL)

 def _init_local(self, model: str = None, retrieve_model: str = None,
 storage_path: str = None, storage=None,
 index_config: IndexConfig | dict = None):
 self._legacy_cloud_api = None

 # Build IndexConfig: merge model/retrieve_model with index_config
 overrides = {}
 if model:
Expand DownExpand Up@@ -123,6 +147,124 @@ def register_parser(self, parser: DocumentParser) -> None:
 raise PageIndexError("Custom parsers are not supported in cloud mode")
 self._backend.register_parser(parser)

 def _require_cloud_api(self):
 if self._legacy_cloud_api is None:
 from .errors import PageIndexAPIError
 raise PageIndexAPIError(
 "This method is part of the pageindex 0.2.x cloud SDK API. "
 "Initialize with api_key to use it."
 )
 return self._legacy_cloud_api

 # ── pageindex 0.2.x cloud SDK compatibility (prefer Collection API for new code) ──
 @_legacy_sdk
 def submit_document(
 self,
 file_path: str,
 mode: str | None = None,
 beta_headers: list[str] | None = None,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(...).add(path)``."""
 return self._require_cloud_api().submit_document(
 file_path=file_path,
 mode=mode,
 beta_headers=beta_headers,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def get_ocr(self, doc_id: str, format: str = "page") -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_page_content(doc_id, pages)``."""
 return self._require_cloud_api().get_ocr(doc_id=doc_id, format=format)

 @_legacy_sdk
 def get_tree(self, doc_id: str, node_summary: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document_structure(doc_id)``."""
 return self._require_cloud_api().get_tree(doc_id=doc_id, node_summary=node_summary)

 @_legacy_sdk
 def is_retrieval_ready(self, doc_id: str) -> bool:
 """Legacy SDK compatibility — Collection API handles readiness internally."""
 return self._require_cloud_api().is_retrieval_ready(doc_id=doc_id)

 @_legacy_sdk
 def submit_query(self, doc_id: str, query: str, thinking: bool = False) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.query(question, doc_ids=[doc_id])``."""
 return self._require_cloud_api().submit_query(
 doc_id=doc_id,
 query=query,
 thinking=thinking,
 )

 @_legacy_sdk
 def get_retrieval(self, retrieval_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — Collection API returns answers synchronously."""
 return self._require_cloud_api().get_retrieval(retrieval_id=retrieval_id)

 @_legacy_sdk
 def chat_completions(
 self,
 messages: list[dict[str, str]],
 stream: bool = False,
 doc_id: str | list[str] | None = None,
 temperature: float | None = None,
 stream_metadata: bool = False,
 enable_citations: bool = False,
 ) -> dict[str, Any] | Iterator[str] | Iterator[dict[str, Any]]:
 """Legacy SDK compatibility — prefer ``collection.query(...)``."""
 return self._require_cloud_api().chat_completions(
 messages=messages,
 stream=stream,
 doc_id=doc_id,
 temperature=temperature,
 stream_metadata=stream_metadata,
 enable_citations=enable_citations,
 )

 @_legacy_sdk
 def get_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.get_document(doc_id)``."""
 return self._require_cloud_api().get_document(doc_id=doc_id)

 @_legacy_sdk
 def delete_document(self, doc_id: str) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.delete_document(doc_id)``."""
 return self._require_cloud_api().delete_document(doc_id=doc_id)

 @_legacy_sdk
 def list_documents(
 self,
 limit: int = 50,
 offset: int = 0,
 folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``collection.list_documents()``."""
 return self._require_cloud_api().list_documents(
 limit=limit,
 offset=offset,
 folder_id=folder_id,
 )

 @_legacy_sdk
 def create_folder(
 self,
 name: str,
 description: str | None = None,
 parent_folder_id: str | None = None,
 ) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.collection(name)`` (auto-creates)."""
 return self._require_cloud_api().create_folder(
 name=name,
 description=description,
 parent_folder_id=parent_folder_id,
 )

 @_legacy_sdk
 def list_folders(self, parent_folder_id: str | None = None) -> dict[str, Any]:
 """Legacy SDK compatibility — prefer ``client.list_collections()``."""
 return self._require_cloud_api().list_folders(parent_folder_id=parent_folder_id)


class LocalClient(PageIndexClient):
 """Local mode — indexes and queries documents on your machine.
Expand Down
Loading