From b795de1a4c0885ef275757c36fae2adbb43dd738 Mon Sep 17 00:00:00 2001 From: Mason Daugherty Date: Thu, 25 Sep 2025 14:05:09 -0400 Subject: [PATCH] init --- docs/docs/reference/errors.md | 3 - docs/docs/reference/index.md | 44 +--- docs/docs/reference/langchain_core/index.md | 25 ++ .../langchain_core/language-models.md | 9 + docs/docs/reference/{ => langgraph}/cache.md | 2 +- .../reference/{ => langgraph}/channels.md | 0 .../reference/{ => langgraph}/checkpoints.md | 0 docs/docs/reference/{ => langgraph}/config.md | 2 +- .../reference/{ => langgraph}/constants.md | 0 docs/docs/reference/langgraph/errors.md | 3 + docs/docs/reference/{ => langgraph}/func.md | 2 +- docs/docs/reference/{ => langgraph}/graphs.md | 2 +- docs/docs/reference/langgraph/index.md | 30 +++ docs/docs/reference/{ => langgraph}/pregel.md | 2 +- .../docs/reference/{ => langgraph}/runtime.md | 2 - docs/docs/reference/{ => langgraph}/store.md | 3 +- docs/docs/reference/{ => langgraph}/types.md | 0 docs/mkdocs.yml | 233 +++++++++--------- 18 files changed, 193 insertions(+), 169 deletions(-) delete mode 100644 docs/docs/reference/errors.md create mode 100644 docs/docs/reference/langchain_core/index.md create mode 100644 docs/docs/reference/langchain_core/language-models.md rename docs/docs/reference/{ => langgraph}/cache.md (70%) rename docs/docs/reference/{ => langgraph}/channels.md (100%) rename docs/docs/reference/{ => langgraph}/checkpoints.md (100%) rename docs/docs/reference/{ => langgraph}/config.md (71%) rename docs/docs/reference/{ => langgraph}/constants.md (100%) create mode 100644 docs/docs/reference/langgraph/errors.md rename docs/docs/reference/{ => langgraph}/func.md (74%) rename docs/docs/reference/{ => langgraph}/graphs.md (97%) create mode 100644 docs/docs/reference/langgraph/index.md rename docs/docs/reference/{ => langgraph}/pregel.md (97%) rename docs/docs/reference/{ => langgraph}/runtime.md (99%) rename docs/docs/reference/{ => langgraph}/store.md (52%) rename docs/docs/reference/{ => langgraph}/types.md (100%) diff --git a/docs/docs/reference/errors.md b/docs/docs/reference/errors.md deleted file mode 100644 index d6ddf3c9c..000000000 --- a/docs/docs/reference/errors.md +++ /dev/null @@ -1,3 +0,0 @@ -# Errors - -::: langgraph.errors \ No newline at end of file diff --git a/docs/docs/reference/index.md b/docs/docs/reference/index.md index a2bf4acb0..e69ea52e8 100644 --- a/docs/docs/reference/index.md +++ b/docs/docs/reference/index.md @@ -1,6 +1,6 @@ --- title: Reference -description: API reference for LangGraph +description: API reference search: boost: 0.5 --- @@ -13,44 +13,4 @@ search: # 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. - -!!! 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. \ No newline at end of file +Welcome to the reference docs! diff --git a/docs/docs/reference/langchain_core/index.md b/docs/docs/reference/langchain_core/index.md new file mode 100644 index 000000000..7b887862c --- /dev/null +++ b/docs/docs/reference/langchain_core/index.md @@ -0,0 +1,25 @@ +--- +title: LangChain Core Reference +description: API reference for LangChain Core +search: + boost: 0.5 +--- + + + +# 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. diff --git a/docs/docs/reference/langchain_core/language-models.md b/docs/docs/reference/langchain_core/language-models.md new file mode 100644 index 000000000..8256d9cea --- /dev/null +++ b/docs/docs/reference/langchain_core/language-models.md @@ -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 diff --git a/docs/docs/reference/cache.md b/docs/docs/reference/langgraph/cache.md similarity index 70% rename from docs/docs/reference/cache.md rename to docs/docs/reference/langgraph/cache.md index 05d65af59..96e93a2a9 100644 --- a/docs/docs/reference/cache.md +++ b/docs/docs/reference/langgraph/cache.md @@ -2,4 +2,4 @@ ::: langgraph.cache.base ::: langgraph.cache.memory -::: langgraph.cache.sqlite \ No newline at end of file +::: langgraph.cache.sqlite diff --git a/docs/docs/reference/channels.md b/docs/docs/reference/langgraph/channels.md similarity index 100% rename from docs/docs/reference/channels.md rename to docs/docs/reference/langgraph/channels.md diff --git a/docs/docs/reference/checkpoints.md b/docs/docs/reference/langgraph/checkpoints.md similarity index 100% rename from docs/docs/reference/checkpoints.md rename to docs/docs/reference/langgraph/checkpoints.md diff --git a/docs/docs/reference/config.md b/docs/docs/reference/langgraph/config.md similarity index 71% rename from docs/docs/reference/config.md rename to docs/docs/reference/langgraph/config.md index 0834fa531..11fadfec5 100644 --- a/docs/docs/reference/config.md +++ b/docs/docs/reference/langgraph/config.md @@ -2,4 +2,4 @@ options: members: - get_store - - get_stream_writer \ No newline at end of file + - get_stream_writer diff --git a/docs/docs/reference/constants.md b/docs/docs/reference/langgraph/constants.md similarity index 100% rename from docs/docs/reference/constants.md rename to docs/docs/reference/langgraph/constants.md diff --git a/docs/docs/reference/langgraph/errors.md b/docs/docs/reference/langgraph/errors.md new file mode 100644 index 000000000..bb27e4327 --- /dev/null +++ b/docs/docs/reference/langgraph/errors.md @@ -0,0 +1,3 @@ +# Errors + +::: langgraph.errors diff --git a/docs/docs/reference/func.md b/docs/docs/reference/langgraph/func.md similarity index 74% rename from docs/docs/reference/func.md rename to docs/docs/reference/langgraph/func.md index c77fc85a0..249bd0958 100644 --- a/docs/docs/reference/func.md +++ b/docs/docs/reference/langgraph/func.md @@ -2,4 +2,4 @@ options: members: - task - - entrypoint \ No newline at end of file + - entrypoint diff --git a/docs/docs/reference/graphs.md b/docs/docs/reference/langgraph/graphs.md similarity index 97% rename from docs/docs/reference/graphs.md rename to docs/docs/reference/langgraph/graphs.md index e7473cbf8..d7533cc25 100644 --- a/docs/docs/reference/graphs.md +++ b/docs/docs/reference/langgraph/graphs.md @@ -39,4 +39,4 @@ ::: langgraph.graph.message options: members: - - add_messages \ No newline at end of file + - add_messages diff --git a/docs/docs/reference/langgraph/index.md b/docs/docs/reference/langgraph/index.md new file mode 100644 index 000000000..659fc5553 --- /dev/null +++ b/docs/docs/reference/langgraph/index.md @@ -0,0 +1,30 @@ +--- +title: LangGraph Reference +description: API reference for LangGraph +search: + boost: 0.5 +--- + + + +# 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. diff --git a/docs/docs/reference/pregel.md b/docs/docs/reference/langgraph/pregel.md similarity index 97% rename from docs/docs/reference/pregel.md rename to docs/docs/reference/langgraph/pregel.md index 3bc7db105..f1e7ca644 100644 --- a/docs/docs/reference/pregel.md +++ b/docs/docs/reference/langgraph/pregel.md @@ -38,4 +38,4 @@ - aget_graph - get_subgraphs - aget_subgraphs - - with_config \ No newline at end of file + - with_config diff --git a/docs/docs/reference/runtime.md b/docs/docs/reference/langgraph/runtime.md similarity index 99% rename from docs/docs/reference/runtime.md rename to docs/docs/reference/langgraph/runtime.md index f326e78b8..18de105ba 100644 --- a/docs/docs/reference/runtime.md +++ b/docs/docs/reference/langgraph/runtime.md @@ -14,5 +14,3 @@ options: members: - get_runtime - - diff --git a/docs/docs/reference/store.md b/docs/docs/reference/langgraph/store.md similarity index 52% rename from docs/docs/reference/store.md rename to docs/docs/reference/langgraph/store.md index 1f9a33245..cf9dcd92c 100644 --- a/docs/docs/reference/store.md +++ b/docs/docs/reference/langgraph/store.md @@ -1,6 +1,5 @@ # Storage ::: langgraph.store.base - -::: langgraph.store.postgres \ No newline at end of file +::: langgraph.store.postgres diff --git a/docs/docs/reference/types.md b/docs/docs/reference/langgraph/types.md similarity index 100% rename from docs/docs/reference/types.md rename to docs/docs/reference/langgraph/types.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 9bf95b065..88cd88a65 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -167,7 +167,7 @@ plugins: allow_inspection: true heading_level: 2 show_bases: true - show_source: false + show_source: false summary: true inherited_members: true selection: @@ -187,126 +187,129 @@ plugins: nav: - Get started: - - index.md - - Quickstarts: - - Start with a prebuilt agent: agents/agents.md - - Build a custom workflow: - - concepts/why-langgraph.md - - 1. Build a basic chatbot: tutorials/get-started/1-build-basic-chatbot.md - - 2. Add tools: tutorials/get-started/2-add-tools.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 - - 5. Customize state: tutorials/get-started/5-customize-state.md - - 6. Time travel: tutorials/get-started/6-time-travel.md - - Run a local server: tutorials/langgraph-platform/local-server.md - - General concepts: - - Workflows & agents: tutorials/workflows.md - - Agent architectures: concepts/agentic_concepts.md + - index.md + - Quickstarts: + - Start with a prebuilt agent: agents/agents.md + - Build a custom workflow: + - concepts/why-langgraph.md + - 1. Build a basic chatbot: tutorials/get-started/1-build-basic-chatbot.md + - 2. Add tools: tutorials/get-started/2-add-tools.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 + - 5. Customize state: tutorials/get-started/5-customize-state.md + - 6. Time travel: tutorials/get-started/6-time-travel.md + - Run a local server: tutorials/langgraph-platform/local-server.md + - General concepts: + - Workflows & agents: tutorials/workflows.md + - Agent architectures: concepts/agentic_concepts.md - Guides: - - guides/index.md - - Agent development: - - Overview: agents/overview.md - - Run an agent: agents/run_agents.md - - LangGraph APIs: - - Graph API: - - Overview: concepts/low_level.md - - Use the Graph API: how-tos/graph-api.md - - Functional API: - - Overview: concepts/functional_api.md - - Use the Functional API: how-tos/use-functional-api.md - - Runtime: concepts/pregel.md - - Core capabilities: - - Streaming: - - Overview: concepts/streaming.md - - Stream outputs: how-tos/streaming.md - - Persistence: - - Overview: concepts/persistence.md - - Durable execution: - - Overview: concepts/durable_execution.md - - Memory: - - Overview: concepts/memory.md - - Add memory: how-tos/memory/add-memory.md - - Context: - - Add context: agents/context.md - - Models: - - Configure model: agents/models.md - - Tools: - - Overview: concepts/tools.md - - Call tools: how-tos/tool-calling.md - - Human-in-the-loop: - - Overview: concepts/human_in_the_loop.md - - Add human intervention: how-tos/human_in_the_loop/add-human-in-the-loop.md - - Time travel: - - Overview: concepts/time-travel.md - - Use time travel: how-tos/human_in_the_loop/time-travel.md - - Subgraphs: - - Overview: concepts/subgraphs.md - - Use subgraphs: how-tos/subgraph.md - - Multi-agent: - - Overview: concepts/multi_agent.md - - Prebuilt implementation: agents/multi-agent.md - - Custom implementation: how-tos/multi_agent.md - - MCP: - - Overview: concepts/mcp.md - - Use MCP: agents/mcp.md - - Tracing: - - Overview: concepts/tracing.md - - Enable tracing: how-tos/enable-tracing.md - - Evaluate performance: agents/evals.md + - guides/index.md + - Agent development: + - Overview: agents/overview.md + - Run an agent: agents/run_agents.md + - LangGraph APIs: + - Graph API: + - Overview: concepts/low_level.md + - Use the Graph API: how-tos/graph-api.md + - Functional API: + - Overview: concepts/functional_api.md + - Use the Functional API: how-tos/use-functional-api.md + - Runtime: concepts/pregel.md + - Core capabilities: + - Streaming: + - Overview: concepts/streaming.md + - Stream outputs: how-tos/streaming.md + - Persistence: + - Overview: concepts/persistence.md + - Durable execution: + - Overview: concepts/durable_execution.md + - Memory: + - Overview: concepts/memory.md + - Add memory: how-tos/memory/add-memory.md + - Context: + - Add context: agents/context.md + - Models: + - Configure model: agents/models.md + - Tools: + - Overview: concepts/tools.md + - Call tools: how-tos/tool-calling.md + - Human-in-the-loop: + - Overview: concepts/human_in_the_loop.md + - Add human intervention: how-tos/human_in_the_loop/add-human-in-the-loop.md + - Time travel: + - Overview: concepts/time-travel.md + - Use time travel: how-tos/human_in_the_loop/time-travel.md + - Subgraphs: + - Overview: concepts/subgraphs.md + - Use subgraphs: how-tos/subgraph.md + - Multi-agent: + - Overview: concepts/multi_agent.md + - Prebuilt implementation: agents/multi-agent.md + - Custom implementation: how-tos/multi_agent.md + - MCP: + - Overview: concepts/mcp.md + - Use MCP: agents/mcp.md + - Tracing: + - Overview: concepts/tracing.md + - Enable tracing: how-tos/enable-tracing.md + - Evaluate performance: agents/evals.md - Reference: - - reference/index.md - - LangGraph: - - Graphs: reference/graphs.md - - Functional API: reference/func.md - - Pregel: reference/pregel.md - - Checkpointing: reference/checkpoints.md - - Storage: reference/store.md - - Caching: reference/cache.md - - Types: reference/types.md - - Runtime: reference/runtime.md - - Config: reference/config.md - - Errors: reference/errors.md - - Constants: reference/constants.md - - Channels: reference/channels.md - - Prebuilt: - - Agents: reference/agents.md - - Supervisor: reference/supervisor.md - - Swarm: reference/swarm.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 + - reference/index.md + - LangGraph: + - Overview: reference/langgraph/index.md + - Graphs: reference/langgraph/graphs.md + - Functional API: reference/langgraph/func.md + - Pregel: reference/langgraph/pregel.md + - Checkpointing: reference/langgraph/checkpoints.md + - Storage: reference/langgraph/store.md + - Caching: reference/langgraph/cache.md + - Types: reference/langgraph/types.md + - Runtime: reference/langgraph/runtime.md + - Config: reference/langgraph/config.md + - Errors: reference/langgraph/errors.md + - Constants: reference/langgraph/constants.md + - Channels: reference/langgraph/channels.md + - LangChain Core: + - Overview: reference/langchain_core/index.md + - Language Models: reference/langchain_core/language-models.md + - Prebuilt: + - Agents: reference/agents.md + - Supervisor: reference/supervisor.md + - Swarm: reference/swarm.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/index.md - - Template applications: concepts/template_applications.md # TODO: make tutorial - - Agentic RAG: tutorials/rag/langgraph_agentic_rag.md - - Agent Supervisor: tutorials/multi_agent/agent_supervisor.md - - SQL agent: tutorials/sql/sql-agent.md - - Prebuilt chat UI: agents/ui.md - - Graph runs in LangSmith: how-tos/run-id-langsmith.md + - examples/index.md + - Template applications: concepts/template_applications.md # TODO: make tutorial + - Agentic RAG: tutorials/rag/langgraph_agentic_rag.md + - Agent Supervisor: tutorials/multi_agent/agent_supervisor.md + - SQL agent: tutorials/sql/sql-agent.md + - Prebuilt chat UI: agents/ui.md + - Graph runs in LangSmith: how-tos/run-id-langsmith.md - Additional resources: - - additional-resources/index.md - - agents/prebuilt.md # NOTE: prebuilt.md is auto-generated by `make build-prebuilt` - - LangGraph Academy course: https://academy.langchain.com/courses/intro-to-langgraph - - Case studies: adopters.md - - concepts/faq.md - - llms.txt: llms-txt-overview.md - - LangChain Forum: https://forum.langchain.com/ - - Troubleshooting: - - Errors: - - troubleshooting/errors/index.md - - troubleshooting/errors/GRAPH_RECURSION_LIMIT.md - - troubleshooting/errors/INVALID_CONCURRENT_GRAPH_UPDATE.md - - troubleshooting/errors/INVALID_GRAPH_NODE_RETURN_VALUE.md - - troubleshooting/errors/MULTIPLE_SUBGRAPHS.md - - troubleshooting/errors/INVALID_CHAT_HISTORY.md - - troubleshooting/errors/INVALID_LICENSE.md - + - additional-resources/index.md + - agents/prebuilt.md # NOTE: prebuilt.md is auto-generated by `make build-prebuilt` + - LangGraph Academy course: https://academy.langchain.com/courses/intro-to-langgraph + - Case studies: adopters.md + - concepts/faq.md + - llms.txt: llms-txt-overview.md + - LangChain Forum: https://forum.langchain.com/ + - Troubleshooting: + - Errors: + - troubleshooting/errors/index.md + - troubleshooting/errors/GRAPH_RECURSION_LIMIT.md + - troubleshooting/errors/INVALID_CONCURRENT_GRAPH_UPDATE.md + - troubleshooting/errors/INVALID_GRAPH_NODE_RETURN_VALUE.md + - troubleshooting/errors/MULTIPLE_SUBGRAPHS.md + - troubleshooting/errors/INVALID_CHAT_HISTORY.md + - troubleshooting/errors/INVALID_LICENSE.md markdown_extensions: - abbr @@ -371,7 +374,7 @@ extra: validation: # https://www.mkdocs.org/user-guide/configuration/ # We are still raising for omitted files because they determine the breadcrumbs for pages. - omitted_files: info + omitted_files: info absolute_links: warn unrecognized_links: warn anchors: warn @@ -383,4 +386,4 @@ extra_css: - stylesheets/version_admonitions.css - stylesheets/logos.css - stylesheets/sticky_navigation.css - - stylesheets/agent_graph_widget.css \ No newline at end of file + - stylesheets/agent_graph_widget.css