docs(api): document GraphIngestor and ServiceIngestor SDK contract (NVBug 6628849) - #2577
Draft
kheiss-uwzoo wants to merge 1 commit into
Draft
docs(api): document GraphIngestor and ServiceIngestor SDK contract (NVBug 6628849)#2577kheiss-uwzoo wants to merge 1 commit into
kheiss-uwzoo wants to merge 1 commit into
Conversation
…VBug 6628849) Point the API Reference at the concrete objects create_ingestor() returns and the public generation types.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
create_ingestor()return types by run mode:GraphIngestorforinprocessandbatch,ServiceIngestorforservice.Ingestorinterface.Fixes NVBug 6628849.
Test plan
mkdocs build --stricton this diff (local leftover untracked pages are not in this change)GraphIngestor,ServiceIngestor,Retriever.answer()types, and generation operatorscreate_ingestor()is no longer described as graph-only on the published pagepre-draft: leakage, mkdocs --strict, ::a, ::p, ::r on the diff vs main
Base: upstream/main
Files: docs/docs/extraction/nemo-retriever-api-reference.md, docs/docs/extraction/workflow-document-ingestion.md
see [CTAs)see [CTAs; faq/overview/multimodal-extractionnimOperator/nvcr.io/nim/installFfmpegunchangedingestor/core.py,graph_ingestor.py,service_ingestor.py,models/llm,operators/generation); generatedcreate_ingestorsummary hidden because source docstring is still graph-onlyGraphIngestorin method listCode drift (not in this docs PR):
nemo_retriever/src/nemo_retriever/ingestor/core.pycreate_ingestor()docstring still says Graph-only ingestion factory, and the annotation still returnsIngestor.PR: #2577