{"id":27999,"library":"nv-ingest-client","title":"nv-ingest-client","description":"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.","status":"active","version":"26.3.0","language":"python","source_language":"en","source_url":"https://github.com/NVIDIA/nv-ingest","tags":["nvidia","ingestion","document-processing","client"],"install":[{"cmd":"pip install nv-ingest-client","lang":"bash","label":"Install from PyPI"}],"dependencies":[],"imports":[{"note":"IngestClient lives in the client submodule, not top-level package.","wrong":"from nv_ingest_client import IngestClient","symbol":"IngestClient","correct":"from nv_ingest_client.client import IngestClient"},{"note":"","wrong":"","symbol":"IngestClientConfig","correct":"from nv_ingest_client.client import IngestClientConfig"}],"quickstart":{"code":"import os\nfrom nv_ingest_client.client import IngestClient, IngestClientConfig\n\n# Configure client\nconfig = IngestClientConfig(\n    host=os.environ.get('NV_INGEST_HOST', 'localhost'),\n    port=os.environ.get('NV_INGEST_PORT', '8000')\n)\nclient = IngestClient(config)\n\n# Ingest a document\nresult = client.ingest_file(\"example.pdf\")\nprint(result)","lang":"python","description":"Minimal example to instantiate IngestClient and ingest a PDF."},"warnings":[{"fix":"Use 'from nv_ingest_client.client import IngestClient'.","message":"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.","severity":"breaking","affected_versions":">=26.0.0"},{"fix":"Pass the 'timeout' parameter to IngestClientConfig (e.g., timeout=10).","message":"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.","severity":"gotcha","affected_versions":"all"},{"fix":"Use 'client.ingest_document('example.pdf')' instead.","message":"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.","severity":"deprecated","affected_versions":">=26.0.0"}],"env_vars":null,"last_verified":"2026-05-09T00:00:00.000Z","next_check":"2026-08-07T00:00:00.000Z","problems":[{"fix":"Run: pip install nv-ingest-client","cause":"Package not installed or installed under old name 'nv-ingest' (note hyphen vs underscore).","error":"ModuleNotFoundError: No module named 'nv_ingest_client'"},{"fix":"Use: from nv_ingest_client.client import IngestClient","cause":"Incorrect import path. IngestClient is in the client submodule.","error":"AttributeError: module 'nv_ingest_client' has no attribute 'IngestClient'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}