nv_ingest_client package

Subpackages

• nv_ingest_client.cli package
  • Subpackages
    • nv_ingest_client.cli.util package
      • Submodules
      • nv_ingest_client.cli.util.click module
      • nv_ingest_client.cli.util.processing module
      • nv_ingest_client.cli.util.system module
      • Module contents
  • Module contents
• nv_ingest_client.client package
  • Submodules
  • nv_ingest_client.client.client module
    • DataDecodeException
    • NvIngestClient
      • add_job()
      • add_task()
      • consume_completed_parent_trace_ids()
      • create_job()
      • create_jobs_for_batch()
      • create_task()
      • enable_telemetry()
      • fetch_job_result()
      • fetch_job_result_async()
      • fetch_job_result_cli()
      • get_telemetry()
      • job_count()
      • process_jobs_concurrently()
      • process_jobs_concurrently_async()
      • register_parent_trace_id()
      • reset_telemetry()
      • submit_job()
      • submit_job_async()
      • summarize_telemetry()
  • nv_ingest_client.client.ingest_job_handler module
    • IngestJobHandler
      • run()
  • nv_ingest_client.client.interface module
    • Ingestor
      • all_tasks()
      • buffers()
      • cancelled_jobs()
      • caption()
      • completed_jobs()
      • dedup()
      • embed()
      • extract()
      • failed_jobs()
      • files()
      • filter()
      • get_status()
      • ingest()
      • ingest_async()
      • load()
      • pdf_split_config()
      • remaining_jobs()
      • save_to_disk()
      • split()
      • store()
      • store_embed()
      • udf()
      • vdb_upload()
    • LazyLoadedList
      • get_all_items()
    • ensure_job_specs()
    • get_max_filename_length()
    • safe_filename()
  • Module contents
    • Ingestor
      • all_tasks()
      • buffers()
      • cancelled_jobs()
      • caption()
      • completed_jobs()
      • dedup()
      • embed()
      • extract()
      • failed_jobs()
      • files()
      • filter()
      • get_status()
      • ingest()
      • ingest_async()
      • load()
      • pdf_split_config()
      • remaining_jobs()
      • save_to_disk()
      • split()
      • store()
      • store_embed()
      • udf()
      • vdb_upload()
    • LazyLoadedList
      • get_all_items()
    • NvIngestClient
      • add_job()
      • add_task()
      • consume_completed_parent_trace_ids()
      • create_job()
      • create_jobs_for_batch()
      • create_task()
      • enable_telemetry()
      • fetch_job_result()
      • fetch_job_result_async()
      • fetch_job_result_cli()
      • get_telemetry()
      • job_count()
      • process_jobs_concurrently()
      • process_jobs_concurrently_async()
      • register_parent_trace_id()
      • reset_telemetry()
      • submit_job()
      • submit_job_async()
      • summarize_telemetry()
• nv_ingest_client.primitives package
  • Subpackages
    • nv_ingest_client.primitives.jobs package
      • Submodules
      • nv_ingest_client.primitives.jobs.job_spec module
      • nv_ingest_client.primitives.jobs.job_state module
      • Module contents
    • nv_ingest_client.primitives.tasks package
      • Submodules
      • nv_ingest_client.primitives.tasks.audio_extraction module
      • nv_ingest_client.primitives.tasks.caption module
      • nv_ingest_client.primitives.tasks.chart_extraction module
      • nv_ingest_client.primitives.tasks.dedup module
      • nv_ingest_client.primitives.tasks.embed module
      • nv_ingest_client.primitives.tasks.extract module
      • nv_ingest_client.primitives.tasks.filter module
      • nv_ingest_client.primitives.tasks.infographic_extraction module
      • nv_ingest_client.primitives.tasks.ocr_extraction module
      • nv_ingest_client.primitives.tasks.split module
      • nv_ingest_client.primitives.tasks.store module
      • nv_ingest_client.primitives.tasks.table_extraction module
      • nv_ingest_client.primitives.tasks.task_base module
      • nv_ingest_client.primitives.tasks.task_factory module
      • nv_ingest_client.primitives.tasks.udf module
      • nv_ingest_client.primitives.tasks.vdb_upload module
      • Module contents
  • Module contents
    • BatchJobSpec
      • _file_type_to_job_spec
      • add_job_spec()
      • add_task()
      • file_types
      • from_buffers()
      • from_dataset()
      • from_files()
      • from_job_specs()
      • job_specs
      • tasks
      • to_dict()
    • JobSpec
      • _payload
      • _tasks
      • _source_id
      • _job_id
      • _extended_options
      • to_dict()
      • add_task()
      • document_type
      • job_id
      • payload
      • source_id
      • source_name
      • to_dict()
    • Task
      • to_dict()
• nv_ingest_client.util package
  • Subpackages
    • nv_ingest_client.util.file_processing package
      • Submodules
      • nv_ingest_client.util.file_processing.extract module
      • Module contents
    • nv_ingest_client.util.vdb package
      • Submodules
      • nv_ingest_client.util.vdb.adt_vdb module
      • nv_ingest_client.util.vdb.lancedb module
      • nv_ingest_client.util.vdb.milvus module
      • nv_ingest_client.util.vdb.opensearch module
      • Module contents
  • Submodules
  • nv_ingest_client.util.dataset module
    • get_dataset_files()
    • get_dataset_statistics()
  • nv_ingest_client.util.document_analysis module
    • analyze_document_chunks()
  • nv_ingest_client.util.image_disk_utils module
    • save_images_from_ingestor_results()
    • save_images_from_response()
    • save_images_to_disk()
  • nv_ingest_client.util.milvus module
  • nv_ingest_client.util.process_json_files module
    • ingest_json_results_to_blob()
  • nv_ingest_client.util.processing module
    • IngestJobFailure
    • check_schema()
    • format_validation_error()
    • handle_future_result()
    • highlight_error_in_original()
  • nv_ingest_client.util.system module
    • ensure_directory_with_permissions()
    • has_permissions()
  • nv_ingest_client.util.transport module
    • infer_microservice()
  • nv_ingest_client.util.util module
    • ClientConfigSchema
    • apply_pdf_split_config_to_job_specs()
    • balanced_groups_flat_order()
    • check_ingest_result()
    • create_job_specs_for_batch()
    • create_job_specs_for_buffers()
    • filter_function_kwargs()
    • generate_matching_files()
    • get_content()
    • load_data_from_path()
  • nv_ingest_client.util.zipkin module
    • AsyncZipkinClient
      • fetch()
      • get_metrics()
    • collect_traces_from_zipkin()
    • write_results_to_output_directory()
  • Module contents

Submodules

nv_ingest_client.nv_ingest_cli module

Module contents