nv-ingest-client

26.3.0 verified Sat May 09 auth: no python

nv-ingest-client is a Python client for NVIDIA's nv-ingest service, enabling ingestion and preprocessing of documents (PDF, DOCX, etc.) into structured data. Current version is 26.3.0, with active development and weekly releases. The primary use case is sending documents to the service and receiving annotated results.

pip install nv-ingest-client

Common errors

error ModuleNotFoundError: No module named 'nv_ingest_client' ↓

cause Package not installed or installed under old name 'nv-ingest' (note hyphen vs underscore).

fix

Run: pip install nv-ingest-client

error AttributeError: module 'nv_ingest_client' has no attribute 'IngestClient' ↓

cause Incorrect import path. IngestClient is in the client submodule.

fix

Use: from nv_ingest_client.client import IngestClient

Warnings

breaking Version 26.x renamed the main package from 'nv_ingest' to 'nv_ingest_client'. Old imports like 'from nv_ingest.client import IngestClient' will break. ↓

fix Use 'from nv_ingest_client.client import IngestClient'.

gotcha The client requires a running nv-ingest service. Connecting to a non-existent host or port will hang for the default timeout (60s). Always set a timeout. ↓

fix Pass the 'timeout' parameter to IngestClientConfig (e.g., timeout=10).

deprecated The 'ingest_file' method is deprecated in favor of 'ingest_document' for async workflows. 'ingest_file' still works but may be removed in a future version. ↓

fix Use 'client.ingest_document('example.pdf')' instead.

Imports

IngestClient

wrong

from nv_ingest_client import IngestClient

correct

from nv_ingest_client.client import IngestClient

IngestClient lives in the client submodule, not top-level package.

IngestClientConfig

from nv_ingest_client.client import IngestClientConfig

Quickstart

Minimal example to instantiate IngestClient and ingest a PDF.

import os
from nv_ingest_client.client import IngestClient, IngestClientConfig

# Configure client
config = IngestClientConfig(
    host=os.environ.get('NV_INGEST_HOST', 'localhost'),
    port=os.environ.get('NV_INGEST_PORT', '8000')
)
client = IngestClient(config)

# Ingest a document
result = client.ingest_file("example.pdf")
print(result)