nv_ingest.api.v1 package#

Submodules#

nv_ingest.api.v1.health module#

async nv_ingest.api.v1.health.get_live_state() → dict[source]#
async nv_ingest.api.v1.health.get_ready_state() → dict[source]#

nv_ingest.api.v1.ingest module#

async nv_ingest.api.v1.ingest.convert_pdf(
ingest_service: Annotated[IngestServiceMeta, Depends(_get_ingest_service)],
files: List[UploadFile] = File(PydanticUndefined),
job_id: str = Form(PydanticUndefined),
extract_text: bool = Form(True),
extract_images: bool = Form(True),
extract_tables: bool = Form(True),
extract_charts: bool = Form(False),
extract_infographics: bool = Form(False),
) → Dict[str, str][source]#
async nv_ingest.api.v1.ingest.fetch_job(
job_id: str,
ingest_service: Annotated[IngestServiceMeta, Depends(_get_ingest_service)],
)[source]#

Fetches job result, checking job state before attempting data retrieval.

Distinguishes non-existent jobs (404) from expired results (410).

async nv_ingest.api.v1.ingest.get_status(
ingest_service: Annotated[IngestServiceMeta, Depends(_get_ingest_service)],
job_id: str,
)[source]#
async nv_ingest.api.v1.ingest.submit_job(
request: Request,
response: Response,
job_spec: MessageWrapper,
ingest_service: Annotated[IngestServiceMeta, Depends(_get_ingest_service)],
)[source]#
async nv_ingest.api.v1.ingest.submit_job_curl_friendly(
ingest_service: Annotated[IngestServiceMeta, Depends(_get_ingest_service)],
file: UploadFile = File(PydanticUndefined),
)[source]#

A multipart/form-data friendly Job submission endpoint that makes interacting with the nv-ingest service through tools like Curl easier.

nv_ingest.api.v1.ingest.trace_id_to_uuid(trace_id: str) → str[source]#

Convert a 32-character OpenTelemetry trace ID to a UUID-like format.

Module contents#