NVIDIA / NVIDIA/NeMo-Retriever
[DOC]: improve the error handling
Open
Nobody has claimed this yet.
doc
- Dominant language
- Python
- Stars
- 3k
- Forks
- 349
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 116
Description
How would you describe the priority of this documentation request
None
Please provide a link or source to the relevant docs
Describe the problems in the documentation
The errors and responses to different APIs need to be improved from the NV-ingest microservice as well as the NV-ingest client to allow users to better understand which part of the code is causing the error in order to troubleshoot
(Optional) Propose a correction or improvement
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with client/client_examples/examples/python_client_usage.ipynb and review how errors and API responses are presented. Then trace the related NV-ingest microservice and client behavior to identify the affected APIs. Done should mean users can tell which component caused an error and how to troubleshoot it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100