Function import_cloud_document

openkb/indexer.py:339–367

Import an already-indexed PageIndex Cloud document by ``doc_id``. Fetches structure + OCR'd page content from the cloud (no local PDF) and writes the same wiki artifacts as :func:`index_long_document`. Requires ``PAGEINDEX_API_KEY``. ``path_key`` is the synthetic identity key (``pag

(doc_id: str, kb_dir: Path, path_key: str)

def import_cloud_document(doc_id: str, kb_dir: Path, path_key: str) -> CloudImportResult:
    """Import an already-indexed PageIndex Cloud document by ``doc_id``.

    Fetches structure + OCR'd page content from the cloud (no local PDF) and
    writes the same wiki artifacts as :func:`index_long_document`. Requires
    ``PAGEINDEX_API_KEY``. ``path_key`` is the synthetic identity key
    (``pageindex-cloud:<doc_id>``) used to resolve a collision-resistant
    wiki name.

    Writes immediately. Callers that need to snapshot before writing (e.g. the
    crash-safe CLI path) should call :func:`prepare_cloud_import` then
    :func:`_write_long_doc_artifacts`, so the snapshot can cover only this
    doc&#x27;s paths.
    """
    cloud = prepare_cloud_import(doc_id, kb_dir, path_key)
    _write_long_doc_artifacts(
        cloud.tree,
        cloud.all_pages,
        cloud.doc_name,
        cloud.doc_id,
        kb_dir,
        description=cloud.description,
    )
    return CloudImportResult(
        doc_id=cloud.doc_id,
        doc_name=cloud.doc_name,
        name=cloud.cloud_name,
        description=cloud.description,
    )