Skip to content

Add docs for segment_audio param#1818

Open
ChrisJar wants to merge 1 commit intoNVIDIA:mainfrom
ChrisJar:segment-docs
Open

Add docs for segment_audio param#1818
ChrisJar wants to merge 1 commit intoNVIDIA:mainfrom
ChrisJar:segment-docs

Conversation

@ChrisJar
Copy link
Copy Markdown
Collaborator

@ChrisJar ChrisJar commented Apr 8, 2026

Description

closes #1772

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.
  • If adjusting docker-compose.yaml environment variables have you ensured those are mimicked in the Helm values.yaml file.

@ChrisJar ChrisJar requested review from a team as code owners April 8, 2026 03:23
@ChrisJar ChrisJar requested a review from edknv April 8, 2026 03:23
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 8, 2026

Greptile Summary

This PR documents the segment_audio parameter for audio extraction, adding it to the extract() docstring in interface.py and to three documentation pages. It also fixes a missing extract_method="audio" argument in the audio code examples in nv-ingest-python-api.md and python-api-reference.md.

The changes are accurate and internally consistent: the note in audio.md correctly explains that segment_audio only affects hosted Parakeet services (NIM or NVCF), not the local Hugging Face fallback.

Confidence Score: 5/5

Safe to merge — documentation-only changes with no logic modifications.

All changes are documentation and docstring additions. The content is accurate, internally consistent, and fixes a pre-existing omission (extract_method="audio" in two code examples). No P0/P1 issues identified.

No files require special attention.

Vulnerabilities

No security concerns identified.

Important Files Changed

Filename Overview
client/src/nv_ingest_client/client/interface.py Adds extract_audio_params entry to the extract() NumPy-style docstring; no logic changes.
docs/docs/extraction/audio.md Adds segment_audio: True to both the local NIM and NVCF code examples, plus an explanatory note; content is correct and consistent.
docs/docs/extraction/nv-ingest-python-api.md Adds missing extract_method="audio" and extract_audio_params to the audio code example, plus prose explaining segment_audio.
docs/docs/extraction/python-api-reference.md Same corrections as nv-ingest-python-api.md: adds extract_method="audio", extract_audio_params, and explanatory prose.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[".extract with extract_audio_params"] --> B{Backend type?}
    B -->|Parakeet ASR NIM| C{segment_audio=True?}
    B -->|NVCF endpoint| C
    B -->|HuggingFace fallback| D[Full transcript - segment_audio ignored]
    C -->|Yes| E[One element per ASR segment]
    C -->|No| F[Single transcript element]
Loading

Reviews (1): Last reviewed commit: "Add docs for segment_audio param" | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEA]: Enable configuration of audio segmentation

1 participant