docs(cli): correct agentic query JSON contract (NVBug 6657480) - #2573
Open
kheiss-uwzoo wants to merge 1 commit into
Open
docs(cli): correct agentic query JSON contract (NVBug 6657480)#2573kheiss-uwzoo wants to merge 1 commit into
kheiss-uwzoo wants to merge 1 commit into
Conversation
Dense and agentic CLI paths use different serializers. Document the shipped hit keys, name result_source, and describe the annotation-only degraded case.
Contributor
Greptile SummaryCorrects the documented agentic-query JSON contract to distinguish local CLI output from the service and MCP response envelope.
|
| Filename | Overview |
|---|---|
| docs/docs/extraction/agentic-retrieval-concept.md | Correctly distinguishes agentic CLI results from the five-field dense CLI projection. |
| docs/docs/extraction/workflow-agentic-retrieval.md | Accurately documents the separate CLI and service/MCP result shapes, including unresolved-hit behavior. |
| nemo_retriever/README.md | Updates the agentic retrieval example with the correct ranking annotations and absent-key behavior. |
| nemo_retriever/docs/cli/README.md | Clarifies that agentic mode is not output-compatible with the compact classic CLI projection. |
Reviews (1): Last reviewed commit: "docs(cli): correct agentic query JSON co..." | Re-trigger Greptile
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
retriever querystill projects five fields (modality,page_number,score,source,text). Agentic mode prints the internal hit dictionary plusdoc_id,rank, andresult_source.sourceback todoc_id.nemo_retriever/README.md, the CLI README (MkDocs quickstart snippet), and the published agentic concept and workflow pages.Test plan
--agenticJSON keys on the same LanceDB table.rehydrated_agentic_hit(None, ...)returns onlydoc_id,rank, andresult_source.pre-draft: leakage, mkdocs --strict, ::a, ::p, ::r on the diff vs main
Base: upstream/main
Files:
docs/docs/extraction/agentic-retrieval-concept.md,docs/docs/extraction/workflow-agentic-retrieval.md,nemo_retriever/README.md,nemo_retriever/docs/cli/README.mdsee [CTAs)see [CTAs;faq.md/overview.md/multimodal-extraction.mdunchanged. The leakage script vsorigin/mainscanned 31 files (forkorigin/mainis behindupstream/main) and flagged untracked leftovercustom-metadata.md, which is not in this diff.custom-metadata.mdanduser-defined-stages.md. Those pages are not in this diff. Changed pages produced no warnings.cli/query/app.py:86-92,tests/test_root_query_cli.py:43). Agentic CLI dumpsrehydrated_agentic_hit()(query/workflow.py,cli/query/app.py:287,tests/test_agentic_eval.py:176). Degraded CLI is annotation-only (agentic.py:577,test_agentic_eval.py:196). Service unresolved hits use nulls andsource=doc_id(service/agentic_query.py:26-72,test_service_agentic_query.py:121). DORIvalidate_code_blocks/verify_docs/detect_driftpassed on all 4 files.result_sourcesentence.Code drift (not in this docs PR):
nemo_retriever/src/nemo_retriever/query/workflow.py:222still claims the same fields as densequery_documents.nemo_retriever/src/nemo_retriever/query/agentic.py:571still says agentic output matches classic retrieval.PR: this draft