nv_ingest_api.internal.schemas package

Subpackages

• nv_ingest_api.internal.schemas.extract package
  • Submodules
  • nv_ingest_api.internal.schemas.extract.extract_audio_schema module
    • AudioConfigSchema
      • validate_endpoints()
      • Config
      • audio_endpoints
      • audio_infer_protocol
      • auth_token
      • function_id
      • model_config
      • segment_audio
      • ssl_cert
      • use_ssl
      • validate_endpoints()
    • AudioExtractorSchema
      • Config
      • audio_extraction_config
      • max_queue_size
      • model_config
      • n_workers
      • raise_on_failure
  • nv_ingest_api.internal.schemas.extract.extract_chart_schema module
    • ChartExtractorConfigSchema
      • validate_endpoints()
      • auth_token
      • model_config
      • nim_batch_size
      • paddle_endpoints
      • paddle_infer_protocol
      • validate_endpoints()
      • workers_per_progress_engine
      • yolox_endpoints
      • yolox_infer_protocol
    • ChartExtractorSchema
      • check_positive()
      • endpoint_config
      • max_queue_size
      • model_config
      • n_workers
      • raise_on_failure
  • nv_ingest_api.internal.schemas.extract.extract_docx_schema module
    • DocxConfigSchema
      • validate_endpoints()
      • auth_token
      • model_config
      • validate_endpoints()
      • yolox_endpoints
      • yolox_infer_protocol
    • DocxExtractorSchema
      • docx_extraction_config
      • max_queue_size
      • model_config
      • n_workers
      • raise_on_failure
  • nv_ingest_api.internal.schemas.extract.extract_image_schema module
    • ImageConfigSchema
      • validate_endpoints()
      • auth_token
      • model_config
      • validate_endpoints()
      • yolox_endpoints
      • yolox_infer_protocol
    • ImageExtractorSchema
      • image_extraction_config
      • max_queue_size
      • model_config
      • n_workers
      • raise_on_failure
  • nv_ingest_api.internal.schemas.extract.extract_infographic_schema module
    • InfographicExtractorConfigSchema
      • validate_endpoints()
      • auth_token
      • model_config
      • nim_batch_size
      • paddle_endpoints
      • paddle_infer_protocol
      • validate_endpoints()
      • workers_per_progress_engine
    • InfographicExtractorSchema
      • check_positive()
      • endpoint_config
      • max_queue_size
      • model_config
      • n_workers
      • raise_on_failure
  • nv_ingest_api.internal.schemas.extract.extract_pdf_schema module
    • NemoRetrieverParseConfigSchema
      • validate_endpoints()
      • auth_token
      • model_config
      • nemoretriever_parse_endpoints
      • nemoretriever_parse_infer_protocol
      • nemoretriever_parse_model_name
      • timeout
      • validate_endpoints()
      • workers_per_progress_engine
      • yolox_endpoints
      • yolox_infer_protocol
    • PDFExtractorSchema
      • max_queue_size
      • model_config
      • n_workers
      • nemoretriever_parse_config
      • pdfium_config
      • raise_on_failure
    • PDFiumConfigSchema
      • validate_endpoints()
      • auth_token
      • model_config
      • nim_batch_size
      • validate_endpoints()
      • workers_per_progress_engine
      • yolox_endpoints
      • yolox_infer_protocol
  • nv_ingest_api.internal.schemas.extract.extract_pptx_schema module
    • PPTXConfigSchema
      • validate_endpoints()
      • auth_token
      • model_config
      • validate_endpoints()
      • yolox_endpoints
      • yolox_infer_protocol
    • PPTXExtractorSchema
      • max_queue_size
      • model_config
      • n_workers
      • pptx_extraction_config
      • raise_on_failure
  • nv_ingest_api.internal.schemas.extract.extract_table_schema module
    • TableExtractorConfigSchema
      • validate_endpoints()
      • auth_token
      • model_config
      • nim_batch_size
      • paddle_endpoints
      • paddle_infer_protocol
      • validate_endpoints()
      • workers_per_progress_engine
      • yolox_endpoints
      • yolox_infer_protocol
    • TableExtractorSchema
      • check_positive()
      • endpoint_config
      • max_queue_size
      • model_config
      • n_workers
      • raise_on_failure
  • Module contents
• nv_ingest_api.internal.schemas.message_brokers package
  • Submodules
  • nv_ingest_api.internal.schemas.message_brokers.message_broker_client_schema module
    • MessageBrokerClientSchema
      • broker_params
      • client_type
      • connection_timeout
      • host
      • max_backoff
      • max_retries
      • model_config
      • port
  • nv_ingest_api.internal.schemas.message_brokers.request_schema module
    • PopRequestSchema
      • command
      • model_config
      • queue_name
      • timeout
    • PushRequestSchema
      • command
      • message
      • model_config
      • queue_name
      • timeout
    • SizeRequestSchema
      • command
      • model_config
      • queue_name
  • nv_ingest_api.internal.schemas.message_brokers.response_schema module
    • ResponseSchema
      • model_config
      • response
      • response_code
      • response_reason
      • trace_id
      • transaction_id
  • Module contents
• nv_ingest_api.internal.schemas.meta package
  • Submodules
  • nv_ingest_api.internal.schemas.meta.base_model_noext module
    • BaseModelNoExt
      • model_config
  • nv_ingest_api.internal.schemas.meta.ingest_job_schema module
    • IngestJobSchema
      • job_id
      • job_payload
      • model_config
      • tasks
      • tracing_options
    • IngestTaskAudioExtraction
      • auth_token
      • function_id
      • grpc_endpoint
      • http_endpoint
      • infer_protocol
      • model_config
      • segment_audio
      • ssl_cert
      • use_ssl
    • IngestTaskCaptionSchema
      • api_key
      • endpoint_url
      • model_config
      • model_name
      • prompt
    • IngestTaskChartExtraction
      • model_config
      • params
    • IngestTaskDedupParams
      • filter
      • model_config
    • IngestTaskDedupSchema
      • content_type
      • model_config
      • params
    • IngestTaskEmbedSchema
      • api_key
      • endpoint_url
      • filter_errors
      • model_config
      • model_name
    • IngestTaskExtractSchema
      • case_insensitive_document_type()
      • document_type
      • method
      • model_config
      • params
    • IngestTaskFilterParamsSchema
      • filter
      • max_aspect_ratio
      • min_aspect_ratio
      • min_size
      • model_config
    • IngestTaskFilterSchema
      • content_type
      • model_config
      • params
    • IngestTaskInfographicExtraction
      • model_config
      • params
    • IngestTaskSchema
      • case_insensitive_task_type()
      • check_task_properties_type()
      • model_config
      • raise_on_failure
      • task_properties
      • type
    • IngestTaskSplitSchema
      • check_chunk_overlap()
      • chunk_overlap
      • chunk_size
      • model_config
      • params
      • tokenizer
    • IngestTaskStoreEmbedSchema
      • model_config
      • params
    • IngestTaskStoreSchema
      • images
      • method
      • model_config
      • params
      • structured
    • IngestTaskTableExtraction
      • model_config
      • params
    • IngestTaskVdbUploadSchema
      • bulk_ingest
      • bulk_ingest_path
      • filter_errors
      • model_config
      • params
    • JobPayloadSchema
      • content
      • document_type
      • model_config
      • source_id
      • source_name
    • TracingOptionsSchema
      • model_config
      • trace
      • trace_id
      • ts_send
    • validate_ingest_job()
  • nv_ingest_api.internal.schemas.meta.metadata_schema module
    • AudioMetadataSchema
      • audio_transcript
      • audio_type
      • model_config
    • ChartMetadataSchema
      • caption
      • model_config
      • table_content
      • table_content_format
      • table_format
      • table_location
      • table_location_max_dimensions
      • uploaded_image_uri
    • ContentHierarchySchema
      • block
      • line
      • model_config
      • nearby_objects
      • page
      • page_count
      • span
    • ContentMetadataSchema
      • description
      • end_time
      • hierarchy
      • model_config
      • page_number
      • start_time
      • subtype
      • type
    • ErrorMetadataSchema
      • error_msg
      • model_config
      • source_id
      • status
      • task
    • ImageMetadataSchema
      • caption
      • clamp_non_negative()
      • height
      • image_location
      • image_location_max_dimensions
      • image_type
      • model_config
      • structured_image_type
      • text
      • uploaded_image_url
      • validate_image_type()
      • width
    • InfoMessageMetadataSchema
      • filter
      • message
      • model_config
      • status
      • task
    • MetadataSchema
      • audio_metadata
      • chart_metadata
      • check_metadata_type()
      • content
      • content_metadata
      • content_url
      • debug_metadata
      • embedding
      • error_metadata
      • image_metadata
      • info_message_metadata
      • model_config
      • raise_on_failure
      • source_metadata
      • table_metadata
      • text_metadata
    • NearbyObjectsSchema
      • images
      • model_config
      • structured
      • text
    • NearbyObjectsSubSchema
      • bbox
      • content
      • model_config
      • type
    • SourceMetadataSchema
      • access_level
      • collection_id
      • date_created
      • last_modified
      • model_config
      • partition_id
      • source_id
      • source_location
      • source_name
      • source_type
      • summary
      • validate_fields()
    • TableMetadataSchema
      • caption
      • model_config
      • table_content
      • table_content_format
      • table_format
      • table_location
      • table_location_max_dimensions
      • uploaded_image_uri
    • TextMetadataSchema
      • keywords
      • language
      • model_config
      • summary
      • text_location
      • text_location_max_dimensions
      • text_type
    • validate_metadata()
  • Module contents
• nv_ingest_api.internal.schemas.mutate package
  • Submodules
  • nv_ingest_api.internal.schemas.mutate.mutate_image_dedup_schema module
    • ImageDedupSchema
      • model_config
      • raise_on_failure
  • Module contents
• nv_ingest_api.internal.schemas.store package
  • Submodules
  • nv_ingest_api.internal.schemas.store.store_embedding_schema module
    • EmbeddingStorageSchema
      • model_config
      • raise_on_failure
  • nv_ingest_api.internal.schemas.store.store_image_schema module
    • ImageStorageModuleSchema
      • images
      • model_config
      • raise_on_failure
      • structured
  • Module contents
• nv_ingest_api.internal.schemas.transform package
  • Submodules
  • nv_ingest_api.internal.schemas.transform.transform_image_caption_schema module
    • ImageCaptionExtractionSchema
      • api_key
      • endpoint_url
      • model_config
      • model_name
      • prompt
      • raise_on_failure
  • nv_ingest_api.internal.schemas.transform.transform_image_filter_schema module
    • ImageFilterSchema
      • cpu_only
      • model_config
      • raise_on_failure
  • nv_ingest_api.internal.schemas.transform.transform_text_embedding_schema module
    • TextEmbeddingSchema
      • api_key
      • batch_size
      • embedding_model
      • embedding_nim_endpoint
      • encoding_format
      • httpx_log_level
      • input_type
      • model_config
      • raise_on_failure
      • truncate
  • nv_ingest_api.internal.schemas.transform.transform_text_splitter_schema module
    • TextSplitterSchema
      • check_chunk_overlap()
      • chunk_overlap
      • chunk_size
      • model_config
      • raise_on_failure
      • tokenizer
  • Module contents

Module contents