From 3dbb12758ff45664fe8ce3bc55384b99f316965e Mon Sep 17 00:00:00 2001 From: Kurt Heiss Date: Fri, 24 Apr 2026 15:59:03 -0700 Subject: [PATCH] Fixing file issues for doc build --- docs/docs/extraction/air-gapped-deployment.md | 2 +- docs/docs/extraction/chunking.md | 2 +- docs/docs/extraction/content-metadata.md | 11 +++++++---- docs/docs/extraction/scaling-modes.md | 2 +- docs/docs/extraction/user-defined-functions.md | 4 ++-- docs/mkdocs.yml | 2 +- 6 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/docs/extraction/air-gapped-deployment.md b/docs/docs/extraction/air-gapped-deployment.md index 1536f5bcc9..5e55b59687 100644 --- a/docs/docs/extraction/air-gapped-deployment.md +++ b/docs/docs/extraction/air-gapped-deployment.md @@ -71,7 +71,7 @@ If your process forbids live `helm install` from URLs, use `helm pull` on the st ## Pinning versions and digests - Tags — Align Compose `*_TAG` / Helm `image.tag` fields with the same release line you qualified (for example `26.3.0` for the ingest image, NIM tags from `docker-compose.yaml` / `nimOperator` in `values.yaml`). -- Digests — After `docker pull nvcr.io/...:tag`, run `docker inspect --format='{{index .RepoDigests 0}}' image:tag` (or use crane / skopeo; see tooling below) and record `repository@sha256:...`. Prefer deploying with digests in highly regulated environments; keep a mapping table from digest → human-readable tag for operations. +- Digests — After `docker pull nvcr.io/...:tag`, run `docker inspect --format='{% raw %}{{index .RepoDigests 0}}{% endraw %}' image:tag` (or use crane / skopeo; see tooling below) and record `repository@sha256:...`. Prefer deploying with digests in highly regulated environments; keep a mapping table from digest → human-readable tag for operations. ## Mirroring images into a private registry diff --git a/docs/docs/extraction/chunking.md b/docs/docs/extraction/chunking.md index 540b147ca4..c1e2d03dcd 100644 --- a/docs/docs/extraction/chunking.md +++ b/docs/docs/extraction/chunking.md @@ -108,4 +108,4 @@ If you are building the container yourself and want to pre-download this model, - [Use the Python API](nv-ingest-python-api.md) - [NeMo Retriever Library V2 API Guide](v2-api-guide.md) -- [Environment Variables](environment-variables.md) +- [Environment Variables](environment-config.md) diff --git a/docs/docs/extraction/content-metadata.md b/docs/docs/extraction/content-metadata.md index cb4bec7fa0..9ee38cfb58 100644 --- a/docs/docs/extraction/content-metadata.md +++ b/docs/docs/extraction/content-metadata.md @@ -164,7 +164,8 @@ Describes the structural location of content within a document. | `span` | `int` | `-1` | Span identifier within a line, for finer granularity. | | `nearby_objects` | `NearbyObjectsSchema` | `NearbyObjectsSchema()` | Information about objects (text, images, structured data) near the current content. See [NearbyObjectsSchema](#nearbyobjectsschema). | -### `NearbyObjectsSchema` (Currently Unused) {#nearbyobjectsschema} + +### `NearbyObjectsSchema` (Currently Unused) Container for different types of nearby objects. | Field | Type | Default Value | Description | @@ -243,7 +244,8 @@ Specific metadata for audio content. | `audio_transcript` | `str` | `""` | Transcript of the audio content. | | `audio_type` | `str` | `""` | Type or format of the audio (e.g., `mp3`, `wav`). | -### `ErrorMetadataSchema` (Currently Unused) {#errormetadataschema} + +### `ErrorMetadataSchema` (Currently Unused) Metadata describing errors encountered during processing. | Field | Type | Default Value | Description | @@ -253,7 +255,8 @@ Metadata describing errors encountered during processing. | `source_id` | `str` | `""` | Identifier of the source item that caused the error, if applicable. | | `error_msg` | `str` | *Required* | The error message. | -### `InfoMessageMetadataSchema` (Currently Unused) {#infomessagemetadataschema} + +### `InfoMessageMetadataSchema` (Currently Unused) Informational messages related to processing. | Field | Type | Default Value | Description | @@ -374,4 +377,4 @@ For the full file, refer to the [data folder](https://github.com/NVIDIA/nv-inges ## Related Topics -- [Environment Variables](environment-variables.md) +- [Environment Variables](environment-config.md) diff --git a/docs/docs/extraction/scaling-modes.md b/docs/docs/extraction/scaling-modes.md index 8fc4684a17..b9d34cb1ad 100644 --- a/docs/docs/extraction/scaling-modes.md +++ b/docs/docs/extraction/scaling-modes.md @@ -102,4 +102,4 @@ Open `docker-compose.yaml` and locate: - [Prerequisites](prerequisites.md) - [Support Matrix](support-matrix.md) -- [Troubleshooting](troubleshooting.md) +- [Troubleshooting](troubleshoot.md) diff --git a/docs/docs/extraction/user-defined-functions.md b/docs/docs/extraction/user-defined-functions.md index e9ba7dffa1..8782c42c77 100644 --- a/docs/docs/extraction/user-defined-functions.md +++ b/docs/docs/extraction/user-defined-functions.md @@ -264,7 +264,7 @@ def enhance_metadata(control_message: IngestControlMessage) -> IngestControlMess return control_message ``` -> **📖 For detailed metadata schema documentation, see:** [metadata_documentation.md](metadata_documentation.md) +> **📖 For detailed metadata schema documentation, see:** [Metadata reference](content-metadata.md) ### UDF Targeting @@ -537,7 +537,7 @@ For detailed guidance on creating custom NIM integrations, including: - Error handling and debugging - Performance best practices -See the comprehensive [**NimClient Usage Guide**](nimclient_usage.md). +See the comprehensive [**NimClient Usage Guide**](nimclient.md). ### Error Handling diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 7bc580f0e0..283b427e6e 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -93,7 +93,7 @@ nav: - Generate Your NGC Keys: extraction/ngc-api-key.md - Environment Variables: extraction/environment-config.md - Metadata Reference: extraction/content-metadata.md - - API Reference: extraction/api-docs + - API Reference: extraction/python-api-reference.md - Troubleshoot: extraction/troubleshoot.md - FAQ: extraction/faq.md - Contribute: extraction/contributing.md