Skip to content

Document the need to set the NVIDIA_API_KEY in the Redis example#1678

Merged
rapids-bot[bot] merged 1 commit intoNVIDIA:release/1.5from
dagardner-nv:david-redis-example
Feb 27, 2026
Merged

Document the need to set the NVIDIA_API_KEY in the Redis example#1678
rapids-bot[bot] merged 1 commit intoNVIDIA:release/1.5from
dagardner-nv:david-redis-example

Conversation

@dagardner-nv
Copy link
Contributor

@dagardner-nv dagardner-nv commented Feb 27, 2026

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added API key setup instructions to the Redis memory example documentation, including environment variable configuration steps.

Signed-off-by: David Gardner <dagardner@nvidia.com>
@dagardner-nv dagardner-nv self-assigned this Feb 27, 2026
@dagardner-nv dagardner-nv added the doc Improvements or additions to documentation label Feb 27, 2026
@dagardner-nv dagardner-nv requested a review from a team as a code owner February 27, 2026 17:18
@dagardner-nv dagardner-nv added the non-breaking Non-breaking change label Feb 27, 2026
@coderabbitai
Copy link

coderabbitai bot commented Feb 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3d91186 and 417b84f.

📒 Files selected for processing (1)
  • examples/memory/redis/README.md

Walkthrough

Documentation was updated to include two "Set Up API Keys" sections in the Redis memory example README. Each section instructs users to obtain an NVIDIA API key and export it as the NVIDIA_API_KEY environment variable, with corresponding code snippets and references to the quick-start guide.

Changes

Cohort / File(s) Summary
Documentation Updates
examples/memory/redis/README.md
Added two "Set Up API Keys" sections with instructions for obtaining and exporting NVIDIA API key as an environment variable.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: adding documentation about setting the NVIDIA_API_KEY in the Redis example. It is concise (66 characters), descriptive, and uses imperative mood as required.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

@willkill07
Copy link
Member

/merge

@rapids-bot rapids-bot bot merged commit 7e01a19 into NVIDIA:release/1.5 Feb 27, 2026
17 checks passed
Charlie-Yi-2002 pushed a commit to Charlie-Yi-2002/NeMo-Agent-Toolkit that referenced this pull request Mar 5, 2026
…VIDIA#1678)

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing/index.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.




## Summary by CodeRabbit

## Release Notes

* **Documentation**
  * Added API key setup instructions to the Redis memory example documentation, including environment variable configuration steps.

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: NVIDIA#1678
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants