Compare commits

...
Author SHA1 Message Date
Mason Daugherty b795de1a4c init 2025-09-25 14:05:09 -04:00
18 changed files with 193 additions and 169 deletions
-3
View File
@@ -1,3 +0,0 @@
# Errors
::: langgraph.errors
+2 -42
View File
@@ -1,6 +1,6 @@
--- ---
title: Reference title: Reference
description: API reference for LangGraph description: API reference
search: search:
boost: 0.5 boost: 0.5
--- ---
@@ -13,44 +13,4 @@ search:
# Reference # Reference
Welcome to the LangGraph reference docs! These pages detail the core interfaces you will use when building with LangGraph. Each section covers a different part of the ecosystem. Welcome to the reference docs!
!!! tip
If you are just getting started, see [LangGraph basics](../concepts/why-langgraph.md) for an introduction to the main concepts and usage patterns.
## LangGraph
The core APIs for the LangGraph open source library.
- [Graphs](graphs.md): Main graph abstraction and usage.
- [Functional API](func.md): Functional programming interface for graphs.
- [Pregel](pregel.md): Pregel-inspired computation model.
- [Checkpointing](checkpoints.md): Saving and restoring graph state.
- [Storage](store.md): Storage backends and options.
- [Caching](cache.md): Caching mechanisms for performance.
- [Types](types.md): Type definitions for graph components.
- [Config](config.md): Configuration options.
- [Errors](errors.md): Error types and handling.
- [Constants](constants.md): Global constants.
- [Channels](channels.md): Message passing and channels.
## Prebuilt components
Higher-level abstractions for common workflows, agents, and other patterns.
- [Agents](agents.md): Built-in agent patterns.
- [Supervisor](supervisor.md): Orchestration and delegation.
- [Swarm](swarm.md): Multi-agent collaboration.
- [MCP Adapters](mcp.md): Integrations with external systems.
## LangGraph Platform
Tools for deploying and connecting to the LangGraph Platform.
- [SDK (Python)](../cloud/reference/sdk/python_sdk_ref.md): Python SDK for interacting with instances of the LangGraph Server.
- [SDK (JS/TS)](../cloud/reference/sdk/js_ts_sdk_ref.md): JavaScript/TypeScript SDK for interacting with instances of the LangGraph Server.
- [RemoteGraph](remote_graph.md): `Pregel` abstraction for connecting to LangGraph Server instances.
See the [LangGraph Platform reference](https://docs.langchain.com/langgraph-platform/reference-overview) for more reference documentation.
@@ -0,0 +1,25 @@
---
title: LangChain Core Reference
description: API reference for LangChain Core
search:
boost: 0.5
---
<style>
.md-sidebar {
display: block !important;
}
</style>
# LangChain Core Reference
LangChain Core provides the foundational abstractions and base classes for the LangChain ecosystem. It includes core components like:
- **Language Models**: Base classes for chat models and language models
- **Runnables**: The foundational abstraction for building composable chains
- **Output Parsers**: Classes for parsing and formatting model outputs
- **Document Loaders and Vectorstores**: Core interfaces for data handling
- **Callbacks and Tracing**: System for observability and debugging
- **Prompts**: Template classes for prompt management
This API reference provides comprehensive documentation for all public classes and functions in LangChain Core.
@@ -0,0 +1,9 @@
# Language Models
The core language model interfaces provided by LangChain Core.
::: langchain_core.language_models
options:
show_if_no_docstring: true
show_root_heading: true
show_root_full_path: false
+3
View File
@@ -0,0 +1,3 @@
# Errors
::: langgraph.errors
+30
View File
@@ -0,0 +1,30 @@
---
title: LangGraph Reference
description: API reference for LangGraph
search:
boost: 0.5
---
<style>
.md-sidebar {
display: block !important;
}
</style>
# LangGraph Reference
Welcome to the LangGraph reference docs! These pages detail the core interfaces you will use when building with LangGraph. Each section covers a different part of the ecosystem.
The core APIs for the LangGraph open source library:
- [Graphs](graphs.md): Main graph abstraction and usage.
- [Functional API](func.md): Functional programming interface for graphs.
- [Pregel](pregel.md): Pregel-inspired computation model.
- [Checkpointing](checkpoints.md): Saving and restoring graph state.
- [Storage](store.md): Storage backends and options.
- [Caching](cache.md): Caching mechanisms for performance.
- [Types](types.md): Type definitions for graph components.
- [Config](config.md): Configuration options.
- [Errors](errors.md): Error types and handling.
- [Constants](constants.md): Global constants.
- [Channels](channels.md): Message passing and channels.
@@ -14,5 +14,3 @@
options: options:
members: members:
- get_runtime - get_runtime
@@ -2,5 +2,4 @@
::: langgraph.store.base ::: langgraph.store.base
::: langgraph.store.postgres ::: langgraph.store.postgres
+115 -112
View File
@@ -187,126 +187,129 @@ plugins:
nav: nav:
- Get started: - Get started:
- index.md - index.md
- Quickstarts: - Quickstarts:
- Start with a prebuilt agent: agents/agents.md - Start with a prebuilt agent: agents/agents.md
- Build a custom workflow: - Build a custom workflow:
- concepts/why-langgraph.md - concepts/why-langgraph.md
- 1. Build a basic chatbot: tutorials/get-started/1-build-basic-chatbot.md - 1. Build a basic chatbot: tutorials/get-started/1-build-basic-chatbot.md
- 2. Add tools: tutorials/get-started/2-add-tools.md - 2. Add tools: tutorials/get-started/2-add-tools.md
- 3. Add memory: tutorials/get-started/3-add-memory.md - 3. Add memory: tutorials/get-started/3-add-memory.md
- 4. Add human-in-the-loop: tutorials/get-started/4-human-in-the-loop.md - 4. Add human-in-the-loop: tutorials/get-started/4-human-in-the-loop.md
- 5. Customize state: tutorials/get-started/5-customize-state.md - 5. Customize state: tutorials/get-started/5-customize-state.md
- 6. Time travel: tutorials/get-started/6-time-travel.md - 6. Time travel: tutorials/get-started/6-time-travel.md
- Run a local server: tutorials/langgraph-platform/local-server.md - Run a local server: tutorials/langgraph-platform/local-server.md
- General concepts: - General concepts:
- Workflows & agents: tutorials/workflows.md - Workflows & agents: tutorials/workflows.md
- Agent architectures: concepts/agentic_concepts.md - Agent architectures: concepts/agentic_concepts.md
- Guides: - Guides:
- guides/index.md - guides/index.md
- Agent development: - Agent development:
- Overview: agents/overview.md - Overview: agents/overview.md
- Run an agent: agents/run_agents.md - Run an agent: agents/run_agents.md
- LangGraph APIs: - LangGraph APIs:
- Graph API: - Graph API:
- Overview: concepts/low_level.md - Overview: concepts/low_level.md
- Use the Graph API: how-tos/graph-api.md - Use the Graph API: how-tos/graph-api.md
- Functional API: - Functional API:
- Overview: concepts/functional_api.md - Overview: concepts/functional_api.md
- Use the Functional API: how-tos/use-functional-api.md - Use the Functional API: how-tos/use-functional-api.md
- Runtime: concepts/pregel.md - Runtime: concepts/pregel.md
- Core capabilities: - Core capabilities:
- Streaming: - Streaming:
- Overview: concepts/streaming.md - Overview: concepts/streaming.md
- Stream outputs: how-tos/streaming.md - Stream outputs: how-tos/streaming.md
- Persistence: - Persistence:
- Overview: concepts/persistence.md - Overview: concepts/persistence.md
- Durable execution: - Durable execution:
- Overview: concepts/durable_execution.md - Overview: concepts/durable_execution.md
- Memory: - Memory:
- Overview: concepts/memory.md - Overview: concepts/memory.md
- Add memory: how-tos/memory/add-memory.md - Add memory: how-tos/memory/add-memory.md
- Context: - Context:
- Add context: agents/context.md - Add context: agents/context.md
- Models: - Models:
- Configure model: agents/models.md - Configure model: agents/models.md
- Tools: - Tools:
- Overview: concepts/tools.md - Overview: concepts/tools.md
- Call tools: how-tos/tool-calling.md - Call tools: how-tos/tool-calling.md
- Human-in-the-loop: - Human-in-the-loop:
- Overview: concepts/human_in_the_loop.md - Overview: concepts/human_in_the_loop.md
- Add human intervention: how-tos/human_in_the_loop/add-human-in-the-loop.md - Add human intervention: how-tos/human_in_the_loop/add-human-in-the-loop.md
- Time travel: - Time travel:
- Overview: concepts/time-travel.md - Overview: concepts/time-travel.md
- Use time travel: how-tos/human_in_the_loop/time-travel.md - Use time travel: how-tos/human_in_the_loop/time-travel.md
- Subgraphs: - Subgraphs:
- Overview: concepts/subgraphs.md - Overview: concepts/subgraphs.md
- Use subgraphs: how-tos/subgraph.md - Use subgraphs: how-tos/subgraph.md
- Multi-agent: - Multi-agent:
- Overview: concepts/multi_agent.md - Overview: concepts/multi_agent.md
- Prebuilt implementation: agents/multi-agent.md - Prebuilt implementation: agents/multi-agent.md
- Custom implementation: how-tos/multi_agent.md - Custom implementation: how-tos/multi_agent.md
- MCP: - MCP:
- Overview: concepts/mcp.md - Overview: concepts/mcp.md
- Use MCP: agents/mcp.md - Use MCP: agents/mcp.md
- Tracing: - Tracing:
- Overview: concepts/tracing.md - Overview: concepts/tracing.md
- Enable tracing: how-tos/enable-tracing.md - Enable tracing: how-tos/enable-tracing.md
- Evaluate performance: agents/evals.md - Evaluate performance: agents/evals.md
- Reference: - Reference:
- reference/index.md - reference/index.md
- LangGraph: - LangGraph:
- Graphs: reference/graphs.md - Overview: reference/langgraph/index.md
- Functional API: reference/func.md - Graphs: reference/langgraph/graphs.md
- Pregel: reference/pregel.md - Functional API: reference/langgraph/func.md
- Checkpointing: reference/checkpoints.md - Pregel: reference/langgraph/pregel.md
- Storage: reference/store.md - Checkpointing: reference/langgraph/checkpoints.md
- Caching: reference/cache.md - Storage: reference/langgraph/store.md
- Types: reference/types.md - Caching: reference/langgraph/cache.md
- Runtime: reference/runtime.md - Types: reference/langgraph/types.md
- Config: reference/config.md - Runtime: reference/langgraph/runtime.md
- Errors: reference/errors.md - Config: reference/langgraph/config.md
- Constants: reference/constants.md - Errors: reference/langgraph/errors.md
- Channels: reference/channels.md - Constants: reference/langgraph/constants.md
- Prebuilt: - Channels: reference/langgraph/channels.md
- Agents: reference/agents.md - LangChain Core:
- Supervisor: reference/supervisor.md - Overview: reference/langchain_core/index.md
- Swarm: reference/swarm.md - Language Models: reference/langchain_core/language-models.md
- MCP Adapters: reference/mcp.md - Prebuilt:
- LangGraph Platform: - Agents: reference/agents.md
- SDK (Python): cloud/reference/sdk/python_sdk_ref.md - Supervisor: reference/supervisor.md
- SDK (JS/TS): https://langchain-ai.github.io/langgraphjs/reference/modules/sdk.html - Swarm: reference/swarm.md
- RemoteGraph: reference/remote_graph.md - MCP Adapters: reference/mcp.md
- LangGraph Platform:
- SDK (Python): cloud/reference/sdk/python_sdk_ref.md
- SDK (JS/TS): https://langchain-ai.github.io/langgraphjs/reference/modules/sdk.html
- RemoteGraph: reference/remote_graph.md
- Examples: - Examples:
- examples/index.md - examples/index.md
- Template applications: concepts/template_applications.md # TODO: make tutorial - Template applications: concepts/template_applications.md # TODO: make tutorial
- Agentic RAG: tutorials/rag/langgraph_agentic_rag.md - Agentic RAG: tutorials/rag/langgraph_agentic_rag.md
- Agent Supervisor: tutorials/multi_agent/agent_supervisor.md - Agent Supervisor: tutorials/multi_agent/agent_supervisor.md
- SQL agent: tutorials/sql/sql-agent.md - SQL agent: tutorials/sql/sql-agent.md
- Prebuilt chat UI: agents/ui.md - Prebuilt chat UI: agents/ui.md
- Graph runs in LangSmith: how-tos/run-id-langsmith.md - Graph runs in LangSmith: how-tos/run-id-langsmith.md
- Additional resources: - Additional resources:
- additional-resources/index.md - additional-resources/index.md
- agents/prebuilt.md # NOTE: prebuilt.md is auto-generated by `make build-prebuilt` - agents/prebuilt.md # NOTE: prebuilt.md is auto-generated by `make build-prebuilt`
- LangGraph Academy course: https://academy.langchain.com/courses/intro-to-langgraph - LangGraph Academy course: https://academy.langchain.com/courses/intro-to-langgraph
- Case studies: adopters.md - Case studies: adopters.md
- concepts/faq.md - concepts/faq.md
- llms.txt: llms-txt-overview.md - llms.txt: llms-txt-overview.md
- LangChain Forum: https://forum.langchain.com/ - LangChain Forum: https://forum.langchain.com/
- Troubleshooting: - Troubleshooting:
- Errors: - Errors:
- troubleshooting/errors/index.md - troubleshooting/errors/index.md
- troubleshooting/errors/GRAPH_RECURSION_LIMIT.md - troubleshooting/errors/GRAPH_RECURSION_LIMIT.md
- troubleshooting/errors/INVALID_CONCURRENT_GRAPH_UPDATE.md - troubleshooting/errors/INVALID_CONCURRENT_GRAPH_UPDATE.md
- troubleshooting/errors/INVALID_GRAPH_NODE_RETURN_VALUE.md - troubleshooting/errors/INVALID_GRAPH_NODE_RETURN_VALUE.md
- troubleshooting/errors/MULTIPLE_SUBGRAPHS.md - troubleshooting/errors/MULTIPLE_SUBGRAPHS.md
- troubleshooting/errors/INVALID_CHAT_HISTORY.md - troubleshooting/errors/INVALID_CHAT_HISTORY.md
- troubleshooting/errors/INVALID_LICENSE.md - troubleshooting/errors/INVALID_LICENSE.md
markdown_extensions: markdown_extensions:
- abbr - abbr