Skip to content

Update langcache documentation#586

Open
justin-cechmanek wants to merge 11 commits intomainfrom
feat/update-langcache-docs
Open

Update langcache documentation#586
justin-cechmanek wants to merge 11 commits intomainfrom
feat/update-langcache-docs

Conversation

@justin-cechmanek
Copy link
Copy Markdown
Collaborator

@justin-cechmanek justin-cechmanek commented Apr 15, 2026

Note

Low Risk
Primarily documentation and generated notebook output updates; only a minor docstring change in code with no functional behavior changes.

Overview
Adds first-class documentation for the LangCache-managed semantic cache backend, including a new how-to notebook (13_langcache_semantic_cache.ipynb) covering setup, attributes/TTL, async usage, delete operations, and current limitations.

Updates existing docs to surface the new option: docs/api/cache.rst now documents LangCacheSemanticCache, docs/concepts/extensions.md explains Redis-hosted vs LangCache-managed tradeoffs, and the how-to index links to the new guide. Minor tweaks include notebook output refreshes and small docstring wording cleanup in redisvl/extensions/cache/llm/langcache.py, plus a uv.lock version bump to redisvl 0.17.1.

Reviewed by Cursor Bugbot for commit 02835a8. Bugbot is set up for automated code reviews on this repo. Configure here.

Copilot AI review requested due to automatic review settings April 15, 2026 19:19
@justin-cechmanek justin-cechmanek linked an issue Apr 15, 2026 that may be closed by this pull request
@jit-ci
Copy link
Copy Markdown

jit-ci bot commented Apr 15, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds end-user documentation for using RedisVL’s LangCacheSemanticCache (managed LangCache backend) and wires it into the docs navigation and API reference.

Changes:

  • Add a new user guide notebook covering LangCache-backed semantic caching and usage patterns.
  • Update docs navigation and concepts docs to reference the new LangCache guide and distinguish Redis-backed vs managed LangCache caching.
  • Update API docs to include LangCacheSemanticCache and refresh the lockfile metadata.

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
uv.lock Updates locked metadata (incl. redisvl version) and alters the greenlet wheel list.
redisvl/extensions/cache/llm/langcache.py Docstring formatting tweaks for distance_threshold behavior in check/acheck.
docs/user_guide/how_to_guides/index.md Adds the LangCache semantic cache notebook to the How-To index and quick reference.
docs/user_guide/13_langcache_semantic_cache.ipynb New notebook documenting LangCache as an LLM cache backend.
docs/concepts/extensions.md Adds a “Redis vs LangCache managed service” section under Semantic Cache.
docs/api/cache.rst Adds Sphinx API section for LangCacheSemanticCache.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/user_guide/13_langcache_semantic_cache.ipynb Outdated
Comment thread docs/user_guide/13_langcache_semantic_cache.ipynb Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 15, 2026 19:38
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 6 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Keep local notebook (NBVAL_SKIP on LangCache cells, 18 cells including pip install).
Apply incoming copy edit: capitalize 'You can set up' in prerequisites.
Clear outputs on skipped code cells.

Made-with: Cursor
Copilot AI review requested due to automatic review settings April 15, 2026 21:35
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 7 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/user_guide/13_langcache_semantic_cache.ipynb Outdated
Comment thread docs/user_guide/03_llmcache.ipynb
Comment thread docs/user_guide/03_llmcache.ipynb
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 15, 2026 23:00
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 7 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/user_guide/03_llmcache.ipynb
Comment thread docs/user_guide/03_llmcache.ipynb
@tylerhutcherson
Copy link
Copy Markdown
Collaborator

@justin-cechmanek if you can address the test failing here, we can merge.

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.

Document LangCacheSemanticCache in the public docs

3 participants