nv_ingest.api package

Subpackages

• nv_ingest.api.v1 package
  • Submodules
  • nv_ingest.api.v1.health module
    • get_live_state()
    • get_ready_state()
  • nv_ingest.api.v1.ingest module
    • convert_pdf()
    • fetch_job()
    • get_status()
    • submit_job()
    • submit_job_curl_friendly()
    • trace_id_to_uuid()
  • nv_ingest.api.v1.metrics module
    • metrics()
  • Module contents
• nv_ingest.api.v2 package
  • Submodules
  • nv_ingest.api.v2.ingest module
    • fetch_job_v2()
    • get_pdf_page_count()
    • get_pdf_split_page_count()
    • get_qos_tier_for_page_count()
    • split_pdf_to_chunks()
    • submit_job_v2()
  • Module contents

Submodules

nv_ingest.api.main module

nv_ingest.api.tracing module

HTTP endpoint tracing utilities.

nv_ingest.api.tracing.traced_endpoint(

name: str | None = None,

) → Callable[[F], F]

Wrap a FastAPI endpoint with a span whose name defaults to the function name.

The decorator preserves the wrapped callable’s signature so FastAPI can continue to perform dependency injection and generate OpenAPI documentation correctly.

Module contents

nv_ingest.api package.

nv_ingest.api.traced_endpoint(

name: str | None = None,

) → Callable[[F], F]

Wrap a FastAPI endpoint with a span whose name defaults to the function name.

The decorator preserves the wrapped callable’s signature so FastAPI can continue to perform dependency injection and generate OpenAPI documentation correctly.