langchain-ai/docs
1
0
Fork 0
mirror of https://github.com/langchain-ai/docs.git synced 2026-07-21 11:55:23 -04:00
Code Issues 490 Packages Projects Releases Wiki Activity

[GH-ISSUE #3736] [deepagents] Document when and why to use the cache parameter #2755

New Issue
Open
opened 2026-06-05 17:26:38 -04:00 by yindo · 0 comments
yindo commented 2026-06-05 17:26:38 -04:00
Owner
Copy Link
Copy Source

Originally created by @AdemBoukhris457 on GitHub (Apr 25, 2026).
Original GitHub issue: https://github.com/langchain-ai/docs/issues/3736

Type of issue

request for content

Language

Python

Description

Summary

create_deep_agent / createDeepAgent expose a cache argument (see config snippet in Customize Deep Agents), but the Deep Agents docs do not explain what it is, how it differs from checkpointer / store, or when readers should set it.

Current state

  • Snippet: create-deep-agent-config-options-py.mdx (and JS equivalent if present) lists cache: BaseCache | None = None with no surrounding prose.
  • API: In deepagents graph.py, cache is described briefly as “The cache to use for the agent” and “Passed through to [create_agent][langchain.agents.create_agent].”

Gap

Readers need a short user-facing explanation:

  1. cache is LangGraph-style graph / node cache backing (e.g. InMemoryCache, SqliteCache) used with node cache_policy, not conversation persistence.
  2. Contrast with checkpointer (thread state / resume / HITL), store (cross-thread app storage, e.g. StoreBackend), and Anthropic prompt caching (middleware / message cache_control) so the names are not conflated.
  3. When to leave it None: typical deep agent usage without custom node cache policies.
  4. When to set it: advanced cases aligning with LangGraph node caching (deterministic expensive nodes, TTL, shared cache backend).
  5. Caveat: mis-keyed or over-broad caching can serve stale results for non-deterministic work.

Suggested fix

Add a Note or small subsection on the Customization page (near the config-options snippet or a “Persistence and storage” callout) with 1–2 paragraphs + a link to LangGraph Node caching and, if applicable, LangChain create_agent docs for the same parameter.

Acceptance criteria

  • User-facing Deep Agents docs describe cache purpose and how it differs from checkpointer and store.
  • Docs state that default None is fine for common setups.
  • Link out to LangGraph (and/or LangChain) authoritative docs for BaseCache / CachePolicy.
Originally created by @AdemBoukhris457 on GitHub (Apr 25, 2026). Original GitHub issue: https://github.com/langchain-ai/docs/issues/3736 ### Type of issue request for content ### Language Python ### Description ## Summary `create_deep_agent` / `createDeepAgent` expose a `cache` argument (see config snippet in [Customize Deep Agents](/oss/deepagents/customization)), but the Deep Agents docs do not explain what it is, how it differs from `checkpointer` / `store`, or when readers should set it. ## Current state - **Snippet:** `create-deep-agent-config-options-py.mdx` (and JS equivalent if present) lists `cache: BaseCache | None = None` with no surrounding prose. - **API:** In **deepagents** `graph.py`, `cache` is described briefly as “The cache to use for the agent” and “Passed through to [`create_agent`][langchain.agents.create_agent].” ## Gap Readers need a short **user-facing** explanation: 1. **`cache` is LangGraph-style graph / node cache backing** (e.g. `InMemoryCache`, `SqliteCache`) used with **node `cache_policy`**, not conversation persistence. 2. **Contrast with** `checkpointer` (thread state / resume / HITL), `store` (cross-thread app storage, e.g. StoreBackend), and **Anthropic prompt caching** (middleware / message `cache_control`) so the names are not conflated. 3. **When to leave it `None`:** typical deep agent usage without custom node cache policies. 4. **When to set it:** advanced cases aligning with [LangGraph node caching](/oss/langgraph/graph-api#node-caching) (deterministic expensive nodes, TTL, shared cache backend). 5. **Caveat:** mis-keyed or over-broad caching can serve stale results for non-deterministic work. ## Suggested fix Add a **Note** or small subsection on the Customization page (near the config-options snippet or a “Persistence and storage” callout) with 1–2 paragraphs + a link to LangGraph **Node caching** and, if applicable, LangChain `create_agent` docs for the same parameter. ## Acceptance criteria - [ ] User-facing Deep Agents docs describe `cache` purpose and how it differs from `checkpointer` and `store`. - [ ] Docs state that default `None` is fine for common setups. - [ ] Link out to LangGraph (and/or LangChain) authoritative docs for `BaseCache` / `CachePolicy`.
yindo added the externaldeepagents labels 2026-06-05 17:26:38 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
deepagents
docs-infra
external
external
help wanted
integration
internal
internal
javascript
js/ts
langchain
langgraph
langsmith
needs-title
pull-request
Mirrored from GitHub Pull Request
 python
reference
No Label deepagents external
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#2755
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?