Skip to content

docs(extraction): document audio sentence segments with asr_params (NVBug 6620974) - #2612

Draft
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/6620974-concepts-asr-params
Draft

docs(extraction): document audio sentence segments with asr_params (NVBug 6620974)#2612
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/6620974-concepts-asr-params

Conversation

@kheiss-uwzoo

@kheiss-uwzoo kheiss-uwzoo commented Aug 28, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Fixes NVBug 6620974: the Concepts chunking bullet documented extract_audio_params={"segment_audio": True}, which GraphIngestor.extract_audio() rejects (AudioChunkParams extra-forbidden).
  • Replaces that form with the supported API: asr_params=ASRParams(segment_audio=True) on .extract_audio(...), and points to the runnable example on Speech and audio extraction.
  • Docs-only. A snippet-validation CI test from the bug's recommended fix is not in this PR; that belongs in a separate eng change.

Test plan

  • Compare extract_audio() signature and ASRParams.segment_audio against graph_ingestor.py and common/params/models.py.
  • Confirm audio-video.md already uses asr_params=ASRParams(..., segment_audio=True).
  • Confirm extract_audio_params appears only as a rejected kwarg in test_ingest_interface.py.
  • python -m mkdocs build --strict --config-file mkdocs.yml from docs/ (pass after excluding untracked leftover pages that are not in this diff).
  • Reviewer: confirm the Concepts bullet matches the public Python API on current main.

pre-draft: leakage, mkdocs --strict, ::a, ::p, ::r on the diff vs main

Base: upstream/main
Files: docs/docs/extraction/concepts.md

Check Result
Leakage (page roles + see [ CTAs) PASS — no see [ CTAs; no nimOperator / nvcr.io/nim / installFfmpeg on concepts.md. Repo leakage script was not present; manual rg used.
Allowed paths PASS — 1 documentation file
mkdocs --strict PASS — exit 0 after excluding untracked leftover custom-metadata.md and user-defined-stages.md (those fail strict locally and are not in this diff). First local run aborted with 4 leftover-page warnings.
::a audit PASS — 1 changed claim; extract_audio(asr_params=ASRParams(segment_audio=True)) matches graph_ingestor.py:645-656, ASRParams.segment_audio in models.py:405, and test_audio_pipeline_batch.py:99-108 (95%)
::p polish none needed — one-line glossary API correction; did not restructure Concepts
::r style 95% — no blocking issues on the changed sentence (refer to, code in backticks, descriptive link, periods)

Code drift (not in this docs PR): none for this claim. The bug also recommended a documentation contract test that executes or signature-validates public Python snippets; that is eng/CI work and stays out of this docs PR.

PR: #2612

@kheiss-uwzoo
kheiss-uwzoo requested a review from jperez999 August 28, 2026 20:16
@kheiss-uwzoo kheiss-uwzoo self-assigned this Aug 28, 2026
@kheiss-uwzoo kheiss-uwzoo added doc Improvements or additions to documentation 26.08.1 labels Aug 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

26.08.1 doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant